Hitachi

uCosminexus Service Platform Reference Guide


5.1.1 List of commands

The following tables list and describe the commands used in the operating environment and those used in the execution environment.

Organization of this subsection

(1) List of commands used in the operating environment

The commands used in the operating environment are stored in the following location:

service-platform-installation-directory\CSC\bin

The following table lists and describes the commands used in the operating environment.

Table 5‒1: List of commands used in the operating environment of a service platform

Classification of function

Command

Description

Classification of processing

Major classification

Minor classification

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.

A

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:

  • 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

File 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

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.

(2) List of commands used in the execution environment

The commands used in the execution environment are stored in the following locations:

Commands beginning with csaftp
service-platform-installation-directory\CSC\custom-adapter\FTP\bin
Other commands
service-platform-installation-directory\CSC\bin

The following table lists and describes the commands used in the execution environment.

Table 5‒2: List of commands used in the execution environment of a service platform

Classification of function

Command

Description

Classification of processing

Major classification

Minor classification

FTP integration

Register, update, and obtain users

csaftpuseradd

Registers a new user in an FTP adapter.

B

csaftpuserdel

Deletes a user registered in the FTP adapter.

B

csaftpuserls

Displays the users registered in the FTP adapter.

C

csmftpaddusr

Registers a new user in an FTP inbound adapter.

B

csmftpdelusr

Deletes a user registered in the FTP inbound adapter.

B

csmftplsusr

Displays the users registered in FTP inbound adapter.

C

Transmission log

csmftplshistory

Displays the transmission log of the FTP inbound adapter.

C

Mail integration

Register, update, and obtain users

csmmailaddusr

Registers and updates 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

Public key authentication

Register, update, and obtain private key information

csakeyadd

Registers (or updates) private key information in the public key authentication information.

B

csakeydel

Deletes the private key information registered in the public key authentication information.

B

csakeyls

Displays the private key information registered in the public key authentication information.

C

Password authentication

Register, update, and obtain users

csauseradd

Registers (or updates) a user and password in the password authentication information.

B

csauserdel

Deletes a user and password registered in the password authentication information.

B

csauserls

Displays the users and passwords registered in authentication information.

C

Legend:

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.