3.1.10 Setting and updating the HCSC component 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 section describes how to set and update the definition files of the following HCSC components by using 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
-
Command adapter
-
SFTP adapter
-
Custom adapter
-
SOAP reception
-
TP1/RPC reception
-
FTP reception
-
HTTP reception
-
Message queue reception
-
File event reception
-
Custom reception
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
The following shows examples of using the command to set or update the definition files of HCSC components. For details on the csccmctl command, see "csccmctl (Managing 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 an HCSC component whose definition file was set in the development environment is deleted or when the repository for which the HCSC component has been changed to another one is imported
(2) Points to be considered
-
Execute the -operation set option before deploying the HCSC components.
-
After the definition file for an HCSC component has been set or updated, you might want to use the csccompoundeploy command to delete the HCSC component. At the same time, you might also want to import the repository for a different kind of an HCSC component by using the same service ID or reception ID. In this case, you must use the -operation reset option to delete the definition file of the HCSC component with that service ID or reception 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
-