csccompodeploy (Deploying HCSC components)
- Organization of this page
Format
csccompodeploy [-h]
-user login-user-ID
-pass login-password
{-csc HCSC-server-name|-cluster cluster-name}
{-name service-ID|reception-ID
|-all [-errskip]
|-namelist file-name-specifying-HCSC-components [-errskip]}
Function
Deploys HCSC components on the HCSC server that is already set up.
By setting up default values for mandatory options, such as the login user ID, in the HCSC-Manager command definition file, you can omit the specification of these values in this command.
If an error occurs in one of the execution-target HCSC components (including errors generated during invocation of HCSC components, such as communication failure), you can use the error skip function to skip that HCSC component and continue processing. You cannot use the error skip function from the operating window in the operating environment or from the batch execution function (for example, starting HCSC components deployed on the server) in the development environment.
For details on how to use this command, see the following locations in the Service Platform Setup and Operation Guide according to the purpose of use:
-
3.1.8 Deploying a service adapter
-
3.1.13 Deploying a business process
-
3.1.14 Deploying a user-defined reception
Arguments
-h
Displays the usage of commands. When you specify this option, all other options are ignored even if specified.
-user login-user-ID ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))
Specifies the user ID that is used to log in to HCSC-Manager.
-pass login-password ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))
Specifies the password that is used to log in to HCSC-Manager.
-csc HCSC-server-name ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 8 characters))
Specifies the HCSC server on which the HCSC components are to be deployed.
-cluster cluster-name ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 8 characters))
Specifies the cluster name where the HCSC components are to be deployed in a batch. Note that an error occurs if you specify the -cluster option when the cluster type is HA.
-name service-ID|reception-ID ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 8 characters))
Specifies the service ID or reception ID of the HCSC components to be deployed.
-all
Deploys all the undeployed HCSC components. When you specify this option along with -csc, all the undeployed HCSC components within the HCSC server will be deployed. When you specify this option along with -cluster, all the undeployed HCSC components within that cluster will be deployed.
The following table lists the order in which the HCSC components are deployed when you specify this option. When -errskip is not specified along with this option, if an error occurs during processing, the deployment processing will stop even if all the HCSC components are not deployed.
|
Deployment order |
Type of HCSC components |
Deployment order within HCSC components |
|---|---|---|
|
1 |
Service adapters |
Ascending order of service IDs |
|
2 |
Business processes |
Ascending order of business process names |
|
3 |
User-defined receptions |
The following priority applies:
|
-errskip
Continues processing even if some of the specified HCSC components cannot be deployed (error skip function). Specify this option along with -all or -namelist.
With the error skip function enabled, if errors occur in HCSC components, messages are output to the HCSC-Manager log and console according to the following procedure:
-
When an error occurs in an HCSC component, the relevant error message is output and the processing continues.
-
After processing of all the HCSC components terminates, a warning message indicating the number of HCSC components that caused errors is output.
You can omit the specification of this option in this command by defining this option in the HCSC-Manager command definition file (csccmd.properties) to always enable the error skip function. For details about how to define the HCSC-Manager command definition file, see 6.5.2 HCSC-Manager command definition file.
-namelist file-name-specifying-HCSC-components ~ ((1 to 200 bytes))
Uses the HCSC component-specification file to specify the HCSC components to be deployed. Specify this file with an absolute or relative path. If the file does not exist, the command ends abnormally. For details on the HCSC component-specification file, see 6.5.5 HCSC component-specification file.
Note that the deployment order of the specified HCSC components and the processing in the event of an error are the same as those for the -all option.
Example of input
- (1) To deploy all the service adapters on a single HCSC server
csccompodeploy -user login-user-ID -pass login-password -csc HCSC-server-name -all
- (2) To deploy the specified service adapter on a single HCSC server
csccompodeploy -user login-user-ID -pass login-password -csc HCSC-server-name -name service-ID-of-service-adapter
- (3) To deploy all the HCSC components on the HCSC server CSCSrv1, and continue processing even if some HCSC components cannot be deployed
csccompodeploy -csc CSCSrv1 -all -errskip
- (4) To deploy the HCSC components specified in the HCSC component-specification file hcsccomponent.txt on HCSC server CSCSrv1, and continue processing even if some HCSC components cannot be deployed:
csccompodeploy -csc CSCSrv1 -namelist hcsccomponent.txt -errskip
Return values
|
Return value |
Meaning |
|---|---|
|
0 |
The command terminated normally. |
|
1 |
The command terminated abnormally. |
|
2 |
A communication timeout occurred. |
|
3 |
An exclusion error occurred. |
|
9 |
An error occurred when checking the execution permission. |
If -errskip is specified, the return value is 0 because processing continues even if an error occurs during processing of an HCSC component. However, if an error such as an invalid combination of options occurs other than during invocation of an HCSC component, the return value might be other than 0.
Notes
-
If multiple clients simultaneously execute this command for one HCSC server, a processing error (exclusion error, or abnormal end due to repeated operations for a component) might occur. If an error occurs, re-execute the command using one of the following methods:
-
Specify the -all option to redeploy HCSC components
-
Specify the -name option to deploy HCSC components individually
-