cpasetprof
- Organization of this page
Function
Configures profile items in the profile. Jobs use the configured profile items as variables to run.
Format
cpasetprof [{-a profile-key=value|-d profile-key|-c}]
Permission for execution
None
Arguments
- -a profile-key=value
-
Adds a key-value pair of a profile item to the profile.
- profile-key:
-
Specify a string consisting of alphanumeric characters, with a length of 32 bytes or less.
- value:
-
Specify a string with a length of 80 bytes or less. A value must not include a comma (,) or space ( ) in the ASCII table or line breaks (\n, CR+LF, or LF). If the encoding of the operating system's locale is not UTF-8, the length limit is applied to the UTF-8 converted string.
Specifying an existing key overwrites the existing value. You cannot add a new profile item when the maximum allowed number (16) of items already exists.
You can repeat the -a option as many times as needed unless the maximum allowed number is exceeded.
- -d profile-key
-
Deletes the specified profile item from the profile.
You can repeat the -d option. Note that, if a -d statement fails to delete a profile item, the process still continues with subsequent statements. In such a case, the command returns the highest value of all return values from failed statements.
- -c
-
Deletes the entire profile.
- No option
-
Running the command with no option lists all items from the profile. If there is no item to be listed, the command sends a message to standard output indicating that the profile has no item, and then returns the return value for success.
The output list is generated in the following format.
- <Example output>
prof1=user1 prof2=D:\work
Return values
|
0 |
Succeeded |
|
16 |
The profile item does not exist. |
|
40 |
Insufficient resources |
|
58 |
Invalid argument |
|
85 |
Exceeded the maximum allowed number of registered items. |
|
94 |
The system settings file (config.xml) has an error. |
|
104 |
The profile settings file is invalid. |
|
109 |
The system settings file (config.xml) does not exist. |
|
112 |
The profile settings file does not exist. |
|
125 |
System error |
|
126 |
Program error |
Environment requirements
This command can run regardless of whether the job execution service is running or stopped.
This command can run regardless of whether the message communication service is running or stopped.
Command stored in:
install-path\bin
Note that the command is stored in the following folder by default.
- In a 32-bit operating system:
-
%ProgramFiles%\Hitachi\JP1CPA\bin
- In a 64-bit operating system:
-
%ProgramFiles(x86)%\Hitachi\JP1CPA\bin