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.
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
Environment | Classification of function | Command | Description | Classification of processing | |
---|---|---|---|---|---|
Major classification | Minor classification | ||||
Operating environment | Management | User management | cscpasswd | Changes the user information according to specified conditions. | A |
Repository management | cscrepls | Outputs the repository information to the standard output. | C | ||
cscrepdiff | Displays the difference between the current repository information and exported repository information in the standard output. | C | |||
cscrepcheck | Verifies whether a repository can be imported. | C | |||
cscrepctl | Outputs the information from the repository to a ZIP file, and expands the information stored in the ZIP format to the repository. | A | |||
cscrepupdate | Updates the operating environment repositories. | A | |||
Service management | cscsvcls | Outputs the service information to the standard output. This command also examines the values to be specified in the arguments of the cscsvcctl command. | C | ||
cscsvcctl | Outputs or inputs the service-information change definition file. This command also changes the service information related to service adapters. | A | |||
Environment management | cscenvbackup | Backs up the files required to restore the HCSC-Manager environment. | C | ||
cscenvrestore | Restores the environment by using the backup files of the HCSC-Manager environment. | A | |||
Setup | Server setup | cscsvsetup | Sets up an HCSC server. | A | |
cscsvunsetup | Unsets up an HCSC server. | A | |||
HCSC component setup | csccompodeploy | Allocates HCSC components. | A | ||
csccompoundeploy | Deletes the allocated HCSC components. | A | |||
Set and obtain server definition | cscsvconfig (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 file | csccmctl (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 definition | csccompoconfig (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 setup | cscsetup | Easily sets up a system that can be applied to the production environment. | A | ||
Operation | Server operations | cscsvstart | Starts an HCSC server. | B | |
cscsvstop | Stops an HCSC server. | B | |||
HCSC component operations | csccompostart | Starts HCSC components. | B | ||
csccompostop | Stops HCSC components. | B | |||
cscprecache | Pre-caches the format and data transformation definitions. | C | |||
Standard and user-defined reception | cscrcptnstart | Starts the standard and user-defined receptions. | B | ||
cscrcptnstop | Stops the standard and user-defined receptions. | B | |||
Status check | cscstatus | Displays the status for HCSC servers, standard receptions, and HCSC components. | C | ||
Operation check | cscresinfo | Displays the operation information for the HCSC server resources. | C | ||
General purpose | cscutil | Executes the following operations:
| D | ||
cscpiselect | Searches the business process information according to specified conditions and outputs the result in a CSV or TSV format. | C | |||
cscpidelete | Deletes the business process execution logs according to specified conditions. | C | |||
cscpireexec | Re-executes a running business process according to specified conditions. | C | |||
cscapputil | Operates the applications that are managed by an HCSC server. | C | |||
FTP integration | Folder operations | cscfscls | References the files in the common folder. | C | |
cscfscrm | Deletes the files from the common folder. | B | |||
cscfswls | References the work folder. | C | |||
cscfswrm | Deletes the work folder. | B | |||
Tools | Version upgrade | cscenvupdate | Upgrades the version of a specified HCSC server in the execution environment. | A | |
Message tracking | cscmsgtk | Starts message tracking and displays the message tracking prompt. | E | ||
Execution environment | FTP integration | Register, update, and obtain user | csaftpuseradd | Registers a user in an FTP adapter. | B |
csaftpuserdel | Deletes the user registered in the FTP adapter. | B | |||
csaftpuserls | Displays the user registered in the FTP adapter. | C | |||
csmftpaddusr | Registers a user in an FTP inbound adapter. | B | |||
csmftpdelusr | Deletes the user registered in the FTP inbound adapter. | B | |||
csmftplsusr | Displays the user registered in the FTP inbound adapter. | C | |||
Transmission log | csmftplshistory | Displays the transmission log of the FTP inbound adapter. | C | ||
Mail integration | Register, update, and obtain user | csmmailaddusr | Registers and updates the user information in the mail adapter account definition file. | B | |
csmmaildelusr | Deletes the user information registered in the mail adapter account definition file. | B | |||
csmmaillsusr | Displays the user information registered in the mail adapter account definition file. | C |
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 executed | Currently running operation or current status | ||||
---|---|---|---|---|---|
Repository update commands are being executed | Server update commands are being executed | Reference commands are being executed | User is logged in to the window | Window operation is running (Update) | |
Repository update commands | N | N | N | N | N |
Server update commands | N | N | Y | Y | N |
Reference commands | N | Y | Y | Y | Y |
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 file | Property | Type of timeout functionality |
---|---|---|
HCSC-Manager definition file | cscmng.manager.identifier-name-of-manager.timeout | Communication timeout |
cscmng.server.HCSC-server-name.hws.svstop.timeout | Monitoring time | |
HCSC server runtime definition file | csc-command-timeout | Communication timeout |
csc-precache-timeout | Communication timeout | |
startcsc-timeout | Monitoring time | |
stopcsc-timeout | Monitoring time | |
j2ee-stopapp-timeout | Monitoring time | |
receptionstop-monitor-timer | Communication timeout, monitoring time | |
csc-receptionstop-timeout | Communication timeout |
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: