Types of commands

Three types of commands are used in the operating and execution environments of a service platform. Each type is stored in a separate directory.

To run an HCSC server in Windows Vista or later or Windows Server 2008 or later, log in with administrator privileges.

When the database to be used is HiRDB and the JDBC driver is HiRDB Type4 JDBC Driver, specify the path of HiRDB Type4 JDBC Driver in the HCSC-Messaging command definition file.

When the database to be used is Oracle, specify the path of Oracle JDBC Thin Driver in the HCSC-Messaging command definition file.

Note
A user who has administrator permissions executes the commands used in the operating and execution environments of a service platform. For details on changing the Service Coordinator Administrator in UNIX, see Appendix A. How to Change the Service Coordinator Administrator in the Service Platform System Setup and Operation Guide.

List of commands

The following table lists and describes the commands used in the operating and execution environments of a service platform.

Table 5-1 List of commands used in the operating and execution environments of a service platform

EnvironmentClassification of functionCommandDescriptionClassification of processing
Major classificationMinor classification
Operating environmentManagementUser managementcscpasswdChanges the user information according to specified conditions.A
Repository managementcscreplsOutputs the repository information to the standard output.C
cscrepdiffDisplays the difference between the current repository information and exported repository information in the standard output.C
cscrepcheckVerifies whether a repository can be imported.C
cscrepctlOutputs the information from the repository to a ZIP file, and expands the information stored in the ZIP format to the repository.A
cscrepupdateUpdates the operating environment repositories.A
Service managementcscsvclsOutputs the service information to the standard output. This command also examines the values to be specified in the arguments of the cscsvcctl command.C
cscsvcctlOutputs or inputs the service-information change definition file. This command also changes the service information related to service adapters.A
Environment managementcscenvbackupBacks up the files required to restore the HCSC-Manager environment.C
cscenvrestoreRestores the environment by using the backup files of the HCSC-Manager environment.A
SetupServer setupcscsvsetupSets up an HCSC server.A
cscsvunsetupUnsets up an HCSC server.A
HCSC component setupcsccompodeployAllocates HCSC components.A
csccompoundeployDeletes the allocated HCSC components.A
Set and obtain server definitioncscsvconfig
(Specifying set in the -operation option)
Updates the definition information for HCSC servers.B
cscsvconfig
(Specifying get in the -operation option)
Obtains the definition information for HCSC servers.C
Obtain, set, and delete a definition filecsccmctl (Specifying get in the -operation option)Obtains the definition files set up in the development environment.D
csccmctl (Specifying set in the -operation option)Sets up the definition files in the operating environment.A
csccmctl (Specifying reset in the -operation option)Deletes the definition files set up in the operating environment.A
Set and obtain an HCSC component definitioncsccompoconfig
(Specifying set in the -operation option)
Updates the definition information of a user-defined reception.B
csccompoconfig
(Specifying get in the -operation option)
Obtains the definition information of a user-defined reception.C
Easy setupcscsetupEasily sets up a system that can be applied to the production environment.A
OperationServer operationscscsvstartStarts an HCSC server.B
cscsvstopStops an HCSC server.B
HCSC component operationscsccompostartStarts HCSC components.B
csccompostopStops HCSC components.B
cscprecachePre-caches the format and data transformation definitions.C
Standard and user-defined receptioncscrcptnstartStarts the standard and user-defined receptions.B
cscrcptnstopStops the standard and user-defined receptions.B
Status checkcscstatusDisplays the status for HCSC servers, standard receptions, and HCSC components.C
Operation checkcscresinfoDisplays the operation information for the HCSC server resources.C
General purposecscutilExecutes the following operations:
  • Starts and stops HCSC servers
  • Starts and stops HCSC components, and obtains information
  • Starts and stops standard receptions
  • Obtains the HCSC server setup information and HCSC server information
  • Obtains user-defined reception information
D
cscpiselectSearches the business process information according to specified conditions and outputs the result in a CSV or TSV format.C
cscpideleteDeletes the business process execution logs according to specified conditions.C
cscpireexecRe-executes a running business process according to specified conditions.C
cscapputilOperates the applications that are managed by an HCSC server.C
FTP integrationFolder operationscscfsclsReferences the files in the common folder.C
cscfscrmDeletes the files from the common folder.B
cscfswlsReferences the work folder.C
cscfswrmDeletes the work folder.B
ToolsVersion upgradecscenvupdateUpgrades the version of a specified HCSC server in the execution environment.A
Message trackingcscmsgtkStarts message tracking and displays the message tracking prompt.E
Execution environmentFTP integrationRegister, update, and obtain usercsaftpuseraddRegisters a user in an FTP adapter.B
csaftpuserdelDeletes the user registered in the FTP adapter.B
csaftpuserlsDisplays the user registered in the FTP adapter.C
csmftpaddusrRegisters a user in an FTP inbound adapter.B
csmftpdelusrDeletes the user registered in the FTP inbound adapter.B
csmftplsusrDisplays the user registered in the FTP inbound adapter.C
Transmission logcsmftplshistoryDisplays the transmission log of the FTP inbound adapter.C
Mail integrationRegister, update, and obtain usercsmmailaddusrRegisters and updates the user information in the mail adapter account definition file.B
csmmaildelusrDeletes the user information registered in the mail adapter account definition file.B
csmmaillsusrDisplays the user information registered in the mail adapter account definition file.C
Legend:
A: Repository update commands (the commands that update the repository, when executed).
B: Server update commands (the commands that update the information or the status of HCSC servers, when executed).
C: Reference commands (the commands that only reference the information, when executed). The HCSC server and the repository are not updated.
D: The server update commands or reference commands are executed depending on the options.
E: The commands that are not applicable to the repository update, server update, and reference commands.

Concurrent execution of commands

If other operations are running when you execute a command, you might not be able to execute the command. The following table describes whether you can execute a command when other operations are running.

Table 5-2 Executability of a command when other operations are running

Command to be executedCurrently running operation or current status
Repository update commands are being executedServer update commands are being executedReference commands are being executedUser is logged in to the windowWindow operation is running (Update)
Repository update commandsNNNNN
Server update commandsNNYYN
Reference commandsNYYYY
Legend:
Y: Command can be executed.
N: Command cannot be executed. If these commands are executed concurrently with the repository update commands and commands including repository operations (reference and update), an exclusion error occurs with the return code 3.
Note
The cscutil command includes the server update command functions (such as starting and stopping HCSC servers), and the reference command functions (such as obtaining the HCSC server information).
If you execute the cscutil command when other operations are running, the executability of this command will differ depending on the functions to be executed (which option is specified).

Command timeout functionality

The timeout functionality is used when there is no response from the executed command. The following table describes the timeout functionality provided by HCSC. For details on definition files, see 6.5 Files used for HCSC server operations.

Table 5-3 Timeout functionality provided by HCSC

Definition filePropertyType of timeout functionality
HCSC-Manager definition filecscmng.manager.identifier-name-of-manager.timeoutCommunication timeout
cscmng.server.HCSC-server-name.hws.svstop.timeoutMonitoring time
HCSC server runtime definition filecsc-command-timeoutCommunication timeout
csc-precache-timeoutCommunication timeout
startcsc-timeoutMonitoring time
stopcsc-timeoutMonitoring time
j2ee-stopapp-timeoutMonitoring time
receptionstop-monitor-timerCommunication timeout,
monitoring time
csc-receptionstop-timeoutCommunication timeout
Legend:
Communication timeout:
Detects a communication error.
Monitoring time:
Stands by until a particular target reaches the expected status with the extension of a command execution.
The timeout values of the properties classified as monitoring time must be tuned according to the extension of the system (increase in HCSC components).
Note
The command timeout functionality does not guarantee that the control returns to the command client when the timeout value is exceeded.
The rewinding process might be executed when an error occurs depending on the command, so the processing from when the specified time is exceeded until the result is reported to the client might take longer than the set value.

Command cancellation functionality

The cancellation functionality releases the resources by a certain time. By specifying a cancellation condition (which is time), you can cancel the processing while a command is being executed. A command, whose execution is cancelled using the cancellation functionality, outputs a warning message and returns the exit code 10.

HCSC provides the following cancellation functionality: