jssformdef (registers an Item form definition file)
- Organization of this page
Description
This command registers an Item form definition file that has been customized by a user.
Format
jssformdef -f Item-form-definition-file-name [-n]
Required execution permission
Administrator permissions
Storage folder
IM-SS-path\bin\
Arguments
-f Item-form-definition-file-name
Specifies the name of an Item form definition file. You can use an absolute path or a relative path to specify the file name. For details about Item form definition files, see Item form definition file (Optional) in Chapter 12. Definition Files.
-n
Specifies whether to apply the Item form definition file that is registered by using this command to an Item form for a process. If you specify the -n option, the registered Item form definition file is not applied to an Item form for a process. If you do not specify the -n option, the registered Item form definition file is applied to the Item form identified by the Item form ID specified in the Item form definition file.
Also note that if you specify the -n option, you can execute the jssformdef command without stopping the JP1/Service Support service and the JP1/Service Support - Web Service service. If you do not specify the -n option, you need to inactivate those services in advance.
Return values
Return value |
Meaning |
---|---|
0 |
Normal end |
1 |
Abnormal end |
Prerequisites for executing the command
-
For details about which services need to be active or inactive when this command is executed, see Status of services when commands are executed in Chapter 11. Commands.
-
While the jssformdef command is being executed, do not execute other JP1/IM - Service Support commands.
Remarks
-
If you use Ctrl+C to cancel the jssformdef command while the command is being executed, the Item form definition file might not be registered. For this reason, do not cancel the command during execution by using Ctrl+C. If you happen to do so, wait for a while and re-execute the command.
-
Make sure that the input file you specify is created with a character encoding that is compatible with the system locale of the machine on which JP1/IM - Service Support is installed. The character encodings that can be used are as follows:
-
In a Japanese environment: UTF-8
-
In an English environment: UTF-8
-
In a Chinese environment: UTF-8
-
Example
The following example shows how to register a customized Item form definition file (c:\customize\form01.xml).
jssformdef -f c:\customize\form01.xml