cscrepctl (Importing/Exporting)
- Organization of this page
Format
cscrepctl [-h]
-user login-user-ID
-pass login-password
{-import file-name [-overwrite]
[{-check|-compo
[{-name {service-ID|reception-ID-of-user-defined-reception-(invocation-target-selected)}
|-namelist file-name-specifying-HCSC-components}] [-nouoc]}]
|-export file-name
|-autoexport
|-delete {-name {service-ID|reception-ID-of-user-defined-reception-(invocation-target-selected)}
|-namelist file-name-specifying-HCSC-components}}
Function
Outputs the information from the repository to a ZIP file, and expands the information stored in the ZIP format to the repository. This command also enables you to delete the repository 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.
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:
-
4.2 Exporting Repository Information
-
4.3 Importing a repository
-
4.6 Adding, updating, and deleting a repository using component as a unit
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.
-import file-name ~ ((1 to 200 bytes))
Specifies the absolute or relative path for the ZIP file to be expanded.
-overwrite
Expands the HCSC components imported and stored in the ZIP format to the operating environment repository. This option is enabled when the -import option is specified.
When you specify the -overwrite option, all the HCSC components stored in a ZIP file, including those HCSC components that have not been changed, will be expanded to the operating environment repository.
If you omit the -overwrite option, only the changed HCSC components stored in the ZIP file will be expanded to the operating environment repository. At this time, the HCSC components existing in the current operating environment are used as the HCSC components that have not been changed.
-check
Checks whether the HCSC server configuration information is the same in the repository information for the current operating environment and the repository information to be imported. An error occurs if the HCSC server configuration information is different. This option is enabled when the -import option is specified. Do not specify this option for a standard import.
-compo
Imports the information for components.
-name {service-ID|reception-ID-of-user-defined-reception-(invocation-target-selected)} ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 8 characters))
Specifies one of the following for the HCSC component to be imported or deleted:
- service-ID
-
Specify the service ID of the business process or service adapter.
- reception-ID-of-user-defined-reception-(invocation-target-selected)
-
Specify the reception ID of the user-defined reception (invocation target selected).
If you omit this option when the -compo option is specified, all the HCSC components will be imported.
-namelist file-name-specifying-HCSC-components ~ ((1 to 200 bytes))
Specifies the HCSC components you intend to import or delete in the HCSC component-specification file.
Specifies the file in an absolute or relative path. If the file does not exist, the command terminates abnormally. For details on the HCSC component-specification file, see 6.5.5 HCSC component-specification file.
Note that the order of executing the specified HCSC components is not fixed.
-nouoc
Specify this option if you do not want to update UOC when each component is imported. UOC is the source, class, and library created independently by the user as a part of the HCSCTE project in the development environment.
You can specify this option only when you specify the -compo option.
-export file-name ~ ((1 to 200 bytes))
Specifies the name of the ZIP file to be output, expressed as an absolute or relative path. If the directory up to the specified file does not exist, the command terminates abnormally. If the specified file already exists, the file is overwritten. If the extension of the specified file is not .zip, then .zip is added.
-autoexport
Specify this option to output the ZIP file with the default file name. This option assigns the default file name in the following format:
-
For IPv4: aaabbbcccddd_YYYYMMDDhhmmss.zip
-
For IPv6: aaaabbbbccccddddeeeeffffgggghhhh_YYYYMMDDhhmmss.zip
- aaabbbcccddd:
-
Indicates the IPv4 address of the machine that executed the command.
- aaaabbbbccccddddeeeeffffgggghhhh:
-
Indicates the IPv6 address of the machine that executed the command.
- YYYYMMDDhhmmss:
-
Indicates the time of backup.
YYYY: Year, MM: Month, DD: Date, hh: Hour, mm: Minutes, ss: Seconds
You can specify the output destination in cscmng.properties (HCSC-Manager definition file). If the output destination is not specified, the ZIP file is output to the current directory.
-delete
Deletes the components with the specified service ID from the operating environment repository. After this option, specify the service ID you intend to delete in the options -name or -namelist.
If you delete a service by specifying this option, the services invoked from the other business processes are also deleted. Therefore, carefully select the service you intend to delete.
Examples of input
- (1) To expand the contents of repository.zip to a repository
cscrepctl -user admin -pass admin -import repository.zip
- (2) To output repository.zip containing the repository information to the current directory
cscrepctl -user admin -pass admin -export repository.zip
- (3) To output with the default file name
cscrepctl -user admin -pass admin -autoexport
- (4) To import the contents of repository.zip for each component
cscrepctl -user admin -pass admin -import repository.zip -compo
- (5) To import the HCSC component for which the service ID or the reception ID of the user-defined reception (invocation target selected) is 1
cscrepctl -user admin -pass admin -import repository.zip -compo -name 1
- (6) To import all the HCSC components specified in the HCSC component-specification file hcsccomponent.txt, from among the repository.zip contents
cscrepctl -user admin -pass admin -import repository.zip -compo -namelist hcsccomponent.txt
- (7) To delete the HCSC component for which the service ID or the reception ID of the user-defined reception (invocation target selected) is 1
cscrepctl -user admin -pass admin -delete -name 1
- (8) To delete all the HCSC components specified in the HCSC component-specification file hcsccomponent.txt
cscrepctl -user admin -pass admin -delete -namelist hcsccomponent.txt
Return values
|
Return value |
Meaning |
|---|---|
|
0 |
The command terminated normally. |
|
1 |
The command terminated abnormally. |
|
3 |
An exclusion error occurred. |
|
9 |
An error occurred when checking the execution permission. |
Notes
-
This command cannot be executed while the user is logged in to the operating environment.
-
When you import the repository information, make sure that no directory or file under the directory that has been set as a repository is referenced, and then execute the cscrepctl command.
-
An error might occur during the import process if the settings for the usage of the database and Reliable Messaging differ in the repository information for the current operating environment and the repository information to be imported.
-
An error might occur during the import process if the SOAP mode of the repository information for the current operating environment differs from that of the repository information to be imported.