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.

Commands beginning with csc
These commands are executed from the operating environment. These commands enable you to set up the HCSC server, perform basic operations, and manage the repository and users. Some of the commands communicate with Management Server to manage the HCSC server. Therefore, even if a command is terminated forcibly, the processing might continue.
Commands beginning with csm or csa
These commands are executed from the execution environment. These commands enable you to manage various accounts and view the transmission log.

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.

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
Environment	Major classification	Minor classification	Command	Description	Classification of processing
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
		Service management	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
		Environment management	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
		Server setup	cscsvunsetup	Unsets up an HCSC server.	A
		HCSC component setup	csccompodeploy	Allocates HCSC components.	A
		HCSC component setup	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
		Set and obtain server definition	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
		Set and obtain an HCSC component definition	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
		Server operations	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
		Standard and user-defined reception	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: 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
			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
	Tools	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

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.

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
Command to be executed	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

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).

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
HCSC-Manager definition file	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

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.