3.1.8 Deploying a service adapter
This subsection describes the preconditions for deploying the service adapter in the execution environment, and explains how to deploy the service adapter.
Note that the series of processing to deploy and start the HCSC components in the HCSC server, can also be executed in the development environment in a batch. However, batch execution is performed during system development or from unit testing to integration testing. For details, see " 7.5 Batch execution of the processing for deploying and starting the HCSC components on the HCSC server" in "Service Platform Basic Development Guide".
- Organization of this subsection
(1) Preconditions
To deploy the service adapter, the following conditions must be satisfied:
-
The HCSC server in the deployment-destination execution environment is running
For details on how to check the status of the HCSC server, see "5.3.15 Checking the HCSC server information".
-
In the following cases, the HCSC server is restarted before deployment
-
When the service component type (MDB (WS-R) adapter or MDB and (DB queue) adapter) of the service adapter to be deployed is changed while retaining the same name as the service ID of the deleted MDB (WS-R) adapter or MDB and (DB queue) adapter
-
When the queue information (JMS message type, maximum number of messages, and RD area of the transmit queue creation destination) of the service adapter to be deployed is changed while retaining the same name as the service ID of the deleted MDB (WS-R) adapter
-
When the service adapter with a service ID that only has a case difference with the service ID of the is deleted MDB (WS-R) adapter or MDB and (DB queue) adapter, is deployed
If the service adapter is deployed without restarting the HCSC server, the information defined in the newly deployed service adapter is ignored and the operations might not be normal.
-
(2) How to deploy the service adapter
To deploy the service adapter, execute the csccompodeploy command in the operating environment.
For details on the csccompodeploy command, see "csccompodeploy (Deploying HCSC components)" in "Service Platform Reference Guide".
The execution format of the command differs depending on whether all the service adapters are deployed in a batch, or whether only the specified service adapter is deployed.
- Important note
-
When the service adapter is deployed, do not use the service ID of the service adapter that only has a difference of case with the service ID of the deployed service adapter and business process, or the reception ID of the user-defined reception. If such a name is used, the service adapter cannot be deployed.
(a) To deploy all the service adapters in a batch
Deploy all the service adapters on the HCSC server or cluster in a batch.
The execution format of the command differs depending on whether the service adapter deployment destination is a single HCSC server, or all the HCSC servers configuring the cluster.
- To deploy all the service adapters on a single HCSC server
-
Execute the command by specifying the name of the HCSC server and the -all option.
All the service adapters, which are not deployed, are deployed on the HCSC server specified in the -csc option (all the business processes and user-defined receptions that are not deployed are also deployed at the same time).
csccompodeploy -user <login user ID> -pass <login password> -csc <HCSC server name> -all
- To deploy all the service adapters on all the HCSC servers in the cluster
-
Execute the command by specifying the cluster name and the -all option.
All the service adapters, which are not deployed, are deployed on all the HCSC servers in the cluster specified in the -cluster option (all the business processes and user-defined receptions that are not deployed are also deployed at the same time).
csccompodeploy -user <login user ID> -pass <login password> -cluster <cluster name> -all
- Important note
-
If the service adapters, business processes, and user-defined receptions cannot be deployed because the -all option was specified, even if un-deployed service adapters, business processes, and user-defined receptions exist, they are ignored and the command terminates. After executing the command, use the cscrepls command to check the deployment status.
For details on the cscrepls command, see "cscrepls (Displaying the repository information) " in "Service Platform Reference Guide".
(b) To deploy the specified service adapter only
Deploy only the specified service adapter on the HCSC server or cluster.
The execution format of the command differs depending on whether the service adapter deployment destination is a single HCSC server, or all the HCSC servers configuring the cluster.
- To deploy the specified service adapter on a single HCSC server
-
Execute the command by specifying the name of the HCSC server and the service ID of the service adapter.
The service adapter specified in the -name option is deployed on the HCSC server specified in the -csc option.
csccompodeploy -user <login user ID> -pass <login password> -csc <HCSC server name> -name <Service ID of the service adapter>
With the cscrepls command, you can check the HCSC server name and service ID of the service adapter specified in the csccompodeploy command. For details on the cscrepls command, see "cscrepls (Displaying the repository information)" in "Service Platform Reference Guide".
- To deploy the specified service adapter on all the HCSC servers in the cluster
-
Execute the command by specifying the cluster name and the service ID of the service adapter.
The specified service adapter is deployed on all the HCSC servers in the cluster specified in the -cluster option.
csccompodeploy -user <login user ID> -pass <login password> -cluster <cluster name> -name <Service ID of the service adapter>