Setting and updating the service adapter definition files in the operating environment

The definition files obtained in the operating environment are set up in the operating environment with the -operation set option of the csccmctl command. If the definition files are already set up, the set contents are updated by re-executing the -operation set option.

This subsection describes how to set up and update the definition files of the following service adapters with the -operation set option of the csccmctl command:

DB adapter
TP1 adapter
File adapter
Object Access adapter
Message Queue adapter
FTP adapter
File operations adapter
Mail adapter
HTTP adapter
Custom adapter

Note that the definition files set up with this option are only enabled in the operating environment.

Organization of this subsection: (1) Example of command usage; (2) Points to be considered

(1) Example of command usage

The following is an example of using the command for setting and updating the service adapter definition files. For details on the csccmctl command, see "csccmctl (Managing the definition files) " in "Service Platform Reference Guide".

Example 1

To set or update the definition file "csccustomadapter.properties", which is allocated to a directory beneath "C:\tmp" and has the cluster name "CLS1" and service ID "ADP1", in the operating environment

 
csccmctl -cluster CLS1 -name ADP1 -targetfilename csccustomadapter.properties -basedir C:\tmp -operation set

Example 2

To set or update the communication definition file "adptp1_config.xml", which is set in the TP1 adapter allocated to a directory beneath "C:\tmp" and has the cluster name "CLS1" and service ID "ADP1", in the operating environment

 
csccmctl -cluster CLS1 -name ADP1 -targetfilename adptp1_config.xml -basedir C:\tmp -operation set

Note that the set up and updated definition contents are deleted in one of the following cases:

When the definition file is deleted with the -operation reset option
When all the HCSC servers in the cluster are unset
When the service adapter that set the definition file in the development environment is deleted, and a repository changed to another HCSC component is imported

(2) Points to be considered

Execute the -operation set option before deploying the HCSC components.
When you want to import the repository of a service adapter that has the same service ID, but different type as the service adapter that has the set and updated definition files and which was deleted by the csccompoundeploy command, you must use the -operation reset option to delete the definition file of the service adapter with the target service ID.
If the directory [-cluster specified value]-[-name specified value] does not exist beneath <repository root>/manager/custom, the directory is created internally in the command.
An error occurs in the following cases:
- If the file specified in the -targetfilename option does not exist
- If the directory up to the specified file does not exist
- If an attempt to read the file set in the -targetfilename option fails
- If the definition file contains a definition that is inappropriate for the contents to be defined in the operating environment

3.1.10 Setting and updating the service adapter definition files in the operating environment

(1) Example of command usage

(2) Points to be considered