csccompostart (Starting HCSC components)
- Organization of this page
Format
csccompostart [-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]}
[-nogc]
Function
Starts HCSC components.
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:
-
5.3.6 Starting Service Adapters
-
5.3.7 Starting Business Processes
-
5.3.8 Starting user-defined receptions
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 name of the HCSC components to be started.
-cluster cluster-name ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 8 characters))
Specifies the name of the cluster where the HCSC components will be started in a batch. 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 started. When you specify this option along with the -cluster option, all the HCSC components with the same service ID within the cluster will start.
-all
Starts all the stopped HCSC components within the specified range. When you specify this option along with the -csc option, all the stopped HCSC components within the specified HCSC server will start. When you specify this option along with the -cluster option, all the stopped HCSC components within the specified cluster will start.
The following table lists the order in which the HCSC components are started when you specify this option. When -errskip is not specified along with this option, if an error occurs during processing, the start processing will stop even if all the HCSC components have not started.
|
Starting order |
Types of HCSC components |
Starting 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 start (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 started. 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 starting order of the specified HCSC components and the processing in the event of an error are the same as those for the -all option.
-nogc
Starts the components without generating Full GC. However, the specification of this option does not control Full GC generated automatically by Java VM or Full GC issued by an abnormal J2EE server processing.
Execute the javagc command to explicitly generate Full GC when an HCSC component starts. For details on the javagc command, see javagc (forcibly perform GC) in the manual uCosminexus Application Server Command Reference Guide.
Examples of input
- (1) To start BP1 existing on the HCSC server HCSC
csccompostart -user admin -pass admin -csc HCSC -name BP1
- (2) To start all the HCSC components existing on the HCSC server HCSC in a batch
csccompostart -user admin -pass admin -csc HCSC -all
- (3) To start BP1 on each HCSC server in the cluster Cluster in a batch
csccompostart -user admin -pass admin -cluster Cluster -name BP1
- (4) To start all the HCSC components existing in the cluster Cluster in a batch
csccompostart -user admin -pass admin -cluster Cluster -all
- (5) To start BP1 existing on the HCSC server CSCSrv1 in a batch and without generating Full GC
csccompostart -user admin -pass admin -csc CSCSrv1 -name BP1 -nogc
- (6) To start the HCSC components specified in the HCSC component-specification file hcsccomponent.txt, from among the HCSC components on the HCSC server CSCSrv1, in a batch
csccompostart -user admin -pass admin -csc CSCSrv1 -namelist hcsccomponent.txt
- (7) To start all HCSC components existing on the HCSC server CSCSrv1, and continue processing even if some HCSC components cannot start
csccompostart -csc CSCSrv1 -all -errskip
- (8) To start the HCSC components specified in the HCSC component-specification file hcsccomponent.txt, from among the HCSC components on the HCSC server CSCSrv1, and continue processing even if some HCSC components cannot start
csccompostart -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
-
Execute this command for the stopped HCSC components. If multiple HCSC components are specified, the command is executed only for the running HCSC components. The processing will be skipped for HCSC components that are not running.
-
The HCSC server must be running when you execute the command.
-
If an error occurs when you specify the options -cluster or -all, check the results with the cscstatus command, eliminate the cause of the error, and then re-execute the command.
-
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 start HCSC components
-
Specify the -name option to start HCSC components individually
-