Work with custom service properties files

We can use properties files to create or change custom service properties under a server.

Determine the changes to make to the custom service configuration or its configuration objects.

From the server profile bin directory, run wsadmin -lang jython

Using a properties file, we can create, modify, or delete a custom service object and its configuration properties.

Run administrative commands using wsadmin to create or modify a properties file for a custom service, validate the properties, and apply them to the configuration.

Action	Procedure
create	Set properties and then run the applyConfigProperties command.
modify	Edit properties and then run the applyConfigProperties command.
delete	Uncomment #DELETE=true and run the deleteConfigProperties command.
create Property	Set properties and then run the applyConfigProperties command.
delete Property	To delete one or more properties, run deleteConfigProperties with only those properties to delete in the properties file.

Optionally, we can use interactive mode with the commands:

AdminTask.command_name('-interactive')

• Create a custom service and its properties.

  1. Create a properties file for a CustomService object.

     Open an editor and create a custom service properties file. We can copy the example properties file in this step into an editor and modify the properties as needed for the situation.

     An example properties file for a CustomService object under a server follows. A property under CustomService with a name of myName and a value of myVal is shown in the example:

     #
     # SubSection 1.0 # CustomService
     #
     ResourceType=CustomService
     ImplementingResourceType=CustomService
     ResourceId=Cell=!{cellName}:Node=!{nodeName}:Server=!{serverName}:CustomService=displayName#mydisplayName
     AttributeInfo=customServices
     #DELETE=true
      #
     #Properties
     #
     displayName=mydisplayName # required
     classpath=myclasspath # required
     enable=false #boolean,default(false)
     externalConfigURL=null
     context=null
     description=null
     classname=mclass.name # required
     prerequisiteServices={} #ObjectName*(null)
      
     #
     # SubSection 1.0.1 # CustomService properties #
     ResourceType=CustomService
     ImplementingResourceType=CustomService
     ResourceId=Cell=!{cellName}:Node=!{nodeName}:Server=!{serverName}:CustomService=displayName#mydisplayName
     AttributeInfo=properties(name,value)
     #
      #
     #Properties
     #
     myName=myVal
      EnvironmentVariablesSection
      #Environment Variables
     cellName=WASCell06
     serverName=myServer
     nodeName=WASNode04

  2. Run the applyConfigProperties command to create a CustomService configuration.

     Running the applyConfigProperties command applies the properties file to the configuration. In this Jython example, the optional -reportFileName parameter produces a report named report.txt:

     AdminTask.applyConfigProperties(['-propertiesFileName myObjectType.props -reportFileName report.txt'])

• Modify an existing custom service.

  1. Obtain a properties file for the custom service to change.

     We can extract a properties file for a CustomService using the extractConfigProperties command.

  2. Open the properties file in an editor and change the properties as needed.

     Ensure that the environment variables in the properties file match the system.

  3. Run the applyConfigProperties command to change a custom service configuration.

• Delete the entire custom service object or its properties.

  To delete the entire object, specify DELETE=true in the header section of the properties file and run the deleteConfigProperties command; for example:

  AdminTask.deleteConfigProperties('[-propertiesFileName myObjectType.props -reportFileName report.txt]')

  To delete one or more properties, specify only those properties to delete in the properties file and run deleteConfigProperties.

Results

We can use the properties file to configure and manage the custom service object.

What to do next

Save the changes to the configuration.

Related tasks

Extracting properties files

Validating properties files

Create server, cluster, application, or authorization group objects using properties files and wsadmin scripting

Delete server, cluster, application, or authorization group objects using properties files

Create, modify, and delete configuration objects using one properties file

Properties file syntax

PropertiesBasedConfiguration (AdminTask)