jsssetup.bat (sets up JP1/IM - Service Support)
- Organization of this page
Description
This command sets up JP1/IM - Service Support. To run this command, go to the Start menu and click Programs, JP1_Integrated Management - Service Support, and JP1_IM-SS Command Prompt. Then execute the command. The arguments you can specify depend on the JP1/IM - Service Support product being used.
Format
- For JP1/IM - Service Support (Standard):
jsssetup.bat {-s {S | M | L | LL} [-t] | [-s {S | M | L | LL}] -vup [-t] | -r} [-q]- For JP1/IM - Service Support Advanced Edition:
jsssetup.bat {-s {S | M | L | LL | XL} [-t] | [-s {S | M | L | LL | XL}] -vup [-t] | -r} [-q]
Required execution permission
Administrator permissions
Storage folder
IM-SS-path\tools\
Arguments
-s {S | M | L | LL | XL}
Specifies the size of the Item management database. Use half-width uppercase characters to specify S, M, L, LL, or XL.
The following table describes the size for each value.
|
Specified value |
Size |
|---|---|
|
S |
5 gigabytes |
|
M |
30 gigabytes |
|
L |
71 gigabytes |
|
LL |
152 gigabytes |
|
XL# |
162 gigabytes |
- #
-
This value can be specified only when JP1/IM - Service Support Advanced Edition is used.
When you specify the -s option, all the setup processing is executed and the existing Item management database is initialized. If you have changed the folder containing the Item management database or the port number of the Item management database, the setup is performed with the latest information.
For details about how to change the folder for storing the Item management database or the port number of the Item management database, see 6.3.2 Setup procedure for new installation.
For details about the criteria for determining the size of the Item management database, see the Release Notes.
-t
Registers emails as Items. When you specify the -t option, the master system and the temporary receipt process work board, which are required to register emails as Items, are created. If you do not specify the -t option, the master system and the temporary receipt process work board are not created.
If you want to create the master system and the temporary receipt process work board after you execute the jsssetup.bat command, use the jsscreatesysandpwb command (creates the master system and the temporary receipt process work board). For details about the jsscreatesysandpwb command, see jsscreatesysandpwb (creates the master system and the temporary receipt process work board) in Chapter 11. Commands.
-vup
Upgrades the version of JP1/IM - Service Support (Standard) from version 10-10 to 10-50. This option is specified during setup after overwrite installation is performed. This option can also be used when you upgrade the product from JP1/IM - Service Support (Standard) whose version is earlier than 10-10 to JP1/IM - Service Support Advanced Edition. Specify this option only when you upgrade the version of JP1/IM - Service Support from an earlier version, or when you upgrade the product from JP1/IM - Service Support (Standard) to JP1/IM - Service Support Advanced Edition.
When you specify the -vup option, the database is not initialized and the environment settings of the WWW container server are not updated. Only the features extended by version upgrade or product upgrade are updated. The folder containing the Item management database and the port number of the database remain as they were for the previous setup.
The setup processes the database differently depending on the version number of JP1/IM - Service Support before the upgrade and whether either the -s option or the -vup option is specified, or both are specified. The following table describes the details.
|
Option specified in the command |
Action performed by setup |
|
|---|---|---|
|
-s option only |
The database is initialized at the specified size. |
|
|
-s option and -vup option |
Specifies the database size that is the same as the size before version upgrade of JP1/IM - Service Support. |
An error message (KNAB26151-W) is output, and the database is expanded to the same size as before version upgrade. |
|
Specifies the database size that differs from the size before version upgrade of JP1/IM - Service Support. |
An error message (KNAB26151-W) is output, and the database is expanded to the same size as before version upgrade. |
|
|
-vup option only |
The database is expanded to the same size as before version upgrade. |
|
-r
Sets up JP1/IM - Service Support after overwrite installation of the same version of JP1/IM - Service Support. Do not specify the -r option when you set up JP1/IM - Service Support after a new installation, version upgrade, or product upgrade.
When you specify the -r option, the database is not initialized and the environment settings of the WWW container server are not updated. The folder containing the Item management database and the port number of the database remain as they were for the previous setup.
-q
Initializes the database without displaying a confirmation message.
If you do not specify the -q option, the system displays a message to ask whether to permit initialization of the database.
Return values
|
Return value |
Meaning |
|---|---|
|
0 |
Normal end |
|
1 |
Abnormal end |
Prerequisites for executing the command
-
Make sure that you execute the jsssetup.bat command after a new installation or overwrite installation of JP1/IM - Service Support.
-
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.
-
When you execute the jsssetup.bat command with the -vup option to perform version upgrade or product upgrade of JP1/IM - Service Support, the JP1/Service Support - DB Server service must be active.
-
While the jsssetup.bat command is being executed, do not execute other JP1/IM - Service Support commands.
-
When you set up JP1/IM - Service Support for the first time, do not specify the -r option.
-
When you execute the jsssetup.bat command to upgrade the version of JP1/IM - Service Support (Standard) from 10-10 to 10-50, or to upgrade the product from JP1/IM - Service Support to JP1/IM - Service Support Advanced Editon10-50, the following available space is required on the drive on which the Item management database is stored, depending on the size of the Item management database:
-
For the S-size Item management database: 0.2 GB
-
For the M-size Item management database: 0.9 GB
-
For the L-size Item management database: 1.4 GB
-
For the LL-size Item management database: 2.9 GB
-
In JP1/IM - Service Support (Standard) 10-10, there is no XL-size setting for the Item management database.
-
-
When the jsssetup.bat command is executed, a temporary file is created. Therefore, about 400 MB of available space is required for the installation folder for JP1/IM - Service Support, excluding the available space required for version upgrade or product upgrade.
Remarks
-
When you execute the jsssetup.bat command, multiple child processes start within the system. Even if you cancel the jsssetup.bat command by using Ctrl+C, the child processes continue running. For this reason, do not cancel the jsssetup.bat command during execution by using Ctrl+C. If you happen to do so, wait for a while and re-execute the command.
-
If the jsssetup.bat command ends abnormally, the JP1/Service Support service might be active. Before you re-execute the jsssetup.bat command, make sure that you inactivate the JP1/Service Support service.
-
When you execute the jsssetup.bat command, a KNAB22018-W warning message or a KNAB26148-W warning message might appear. If either of these messages appears, JP1/IM - Service Support is already set up. Take the action described in the explanation of the KNAB22018-W or KNAB26148-W message.
-
When JP1/IM - Service Support Advanced Edition is not used, executing the jsssetup.bat command with XL specified for the -s option causes an error.
-
When the jsssetup.bat command is executed, the required memory size depends on the size of the Item management database. For details about the required memory size, see the release notes.
Example
The following example shows how to set up JP1/IM - Service Support. The size of the Item management database is M. A confirmation message appears before initialization of the Item management database.
jsssetup.bat -s M