ajsembdbbuild

Organization of this page

Format
Description
Execution privileges
Storage directory
Arguments
Notes
Actions to be taken if an error occurs
Return values

Format

ajsembdbbuild
     [-l|-m|-s]
     {
      {-d data-area-directory
        [,system-area-directory-1
         [,system-area-directory-2]]
      } [-lh logical-host-name] |
      {{-r|-f}
       {-d data-area-directory
         [,system-area-directory-1
          [,system-area-directory-2]] |
       }
       -ld work-area-directory
       -mh logical-host-name
       -eh primary-node-physical-host-name
      }
     }
     [-p port-number]
     [-i embedded-database-practical-directory]
     [-bs -bl unload-log-file-creation-directory |
      -br -bl unload-log-file-creation-directory ]
     [-rs]
     [-c]
     [-lc character-code-set-type]
     [-id setup-identifier]
     [-ext_db]
     [-ext_log]
     [-conf embedded-database-settings-file-name]
     [-b]

Format 1 (standard setup on a physical host)

ajsembdbbuild
     [-l|-m|-s]
     -d data-area-directory
       [,system-area-directory-1]
     [-lh logical-host-name] |
     [-p port-number]
     [-i embedded-database-practical-directory]
     [-rs]
     [-c]
     [-lc character-code-set-type]
     [-id setup-identifier]
     [-ext_db]
     [-ext_log]
     [-conf embedded-database-settings-file-name]

Format 2 (setup for creating a backup and obtaining an unload log file periodically on a physical host)

ajsembdbbuild
     [-l|-m|-s]
     -d data-area-directory
       ,system-area-directory-1
         [,system-area-directory-2]
     [-lh logical-host-name] |
     [-p port-number]
     [-i embedded-database-practical-directory]
     {-bs -bl unload-log-file-creation-directory|
      -br -bl unload-log-file-creation-directory}
     [-rs]
     [-c]
     [-lc character-code-set-type]
     [-id setup-identifier]
     [-ext_db]
     [-ext_log]
     [-conf embedded-database-settings-file-name]

Format 3 (standard setup on a logical host)

ajsembdbbuild
     [-l|-m|-s]
     {-r|-f}
     -d data-area-directory
       [,system-area-directory-1]
     -ld work-area-directory
     -mh logical-host-name
     -eh primary-node-physical-host-name
     [-p port-number]
     -i embedded-database-practical-directory
     [-rs]
     [-c]
     [-lc character-code-set-type]
     [-id setup-identifier]
     [-ext_db]
     [-ext_log]
     [-conf embedded-database-settings-file-name]

Format 4 (setup for creating a backup and obtaining an unload log file periodically on a logical host)

ajsembdbbuild
     [-l|-m|-s]
     {-r|-f}
     -d data-area-directory
       ,system-area-directory-1
         [,system-area-directory-2]
     -ld work-area-directory
     -mh logical-host-name
     -eh primary-node-physical-host-name
     [-p port-number]
     -i embedded-database-practical-directory
     {-bs -bl unload-log-file-creation-directory |
      -br -bl unload-log-file-creation-directory}
     [-rs]
     [-c]
     [-lc character-code-set-type]
     [-id setup-identifier]
     [-ext_db]
     [-ext_log]
     [-conf embedded-database-settings-file-name]

Format 5 (setup for configuring an embedded database on a secondary node by using the embedded database settings file created on the primary node)

ajsembdbbuild
     -conf embedded-database-settings-file-name

Format 6 (setup for enabling the backup enhancement function on the physical host)

ajsembdbbuild
     [-l|-m|-s]
     -d data-area-directory
       [,system-area-directory-1]
     [-p port-number]
     [-i embedded-database-practical-directory]
     [-id setup-identifier]
     [-ext_db]
     [-ext_log]
     [-conf embedded-database-settings-file-name]
     -b

Format 7 (setup for enabling the backup enhancement function on the logical host)

ajsembdbbuild
     [-l|-m|-s]
     -d data-area-directory
       [,system-area-directory-1]
     -ld work-area-directory
     -mh logical-host-name
     -eh primary-node-physical-host-name
     [-p port-number]
     [-i embedded-database-practical-directory]
     [-id setup-identifier]
     [-ext_db]
     [-ext_log]
     [-conf embedded-database-settings-file-name]
     -b

To Page Top

Description

The ajsembdbbuild command creates the embedded database environment for JP1/AJS3, and starts the embedded database in the environment.

When you create the environment for cluster operation, execute this command on both the executing host and the standby host.

You must enable the IP address to which the name of the disk to be used and the applicable host name resolve. Note that when you execute the command on the standby host, you do not need to enable this IP address.

In Windows, the JP1/AJS3 Database_JFn (n indicates a character from 0 to 9 or from A to Z) service of the embedded database to be configured must be in running status.

To Page Top

Execution privileges

In Windows: Administrators privileges

In UNIX: Superuser privileges

To Page Top

Storage directory

In Windows:: JP1/AJS3 - Manager-installation-folder\tools\
In UNIX:: /opt/jp1ajs2/tools/

To Page Top

Arguments

`-l|-m|-s`

Selects one of the following three database models.

-l

Selects the large-scale system model, as shown below.

When the value of the DEFLENTYPE environment settings parameter is byte:
- Total number of units: About 48,000 to 240,000
- Number of jobs executed per day and total number of jobnets: 30,000 to 120,000
- Approximate disk capacity: 20,700 MB^#
When the value of the DEFLENTYPE environment settings parameter is sjis:
- Total number of units: About 38,400 to 192,000
- Number of jobs executed per day and total number of jobnets: 24,000 to 96,000
- Approximate disk capacity: 20,700 MB^#
-m

Selects the medium-scale system model, as shown below.

When the value of the DEFLENTYPE environment settings parameter is byte:
- Total number of units: About 5,000 to 48,000
- Number of jobs executed per day and total number of jobnets: 5,000 to 30,000
- Approximate disk capacity: 4,200 MB^#
When the value of the DEFLENTYPE environment settings parameter is sjis:
- Total number of units: About 4,000 to 38,400
- Number of jobs executed per day and total number of jobnets: 4,000 to 24,000
- Approximate disk capacity: 4,200 MB^#
-s

Selects the small-scale system model, as shown below.

When the value of the DEFLENTYPE environment settings parameter is byte:
- Total number of units: Up to about 5,000
- Number of jobs executed per day and total number of jobnets: Up to 5,000
- Approximate disk capacity: 520 MB^#
When the value of the DEFLENTYPE environment settings parameter is sjis:
- Total number of units: Up to about 4,000
- Number of jobs executed per day and total number of jobnets: Up to 4,000
- Approximate disk capacity: 520 MB^#

The default is -l (large-scale system).

#:: To enable the backup enhancement function, add approximately 500 megabytes of disk space.

`-d` `data-area-directory` `[,system-area-directory-1` `[,system-area-directory-2]]`

Specify the names of the directories to be used as the data area and system area of the embedded database.

data-area-directory

Specifies the directory containing the data area of the embedded database. The data area of the embedded database is allocated in this directory and holds the body of the JP1/AJS3 scheduler database.

If you do not specify system-area-directory-1 described later, the directory specified here also contains the system area of the embedded database for storing system files.
system-area-directory-1

If you want to use the system log (specify the -bs option), you must also specify system-area-directory-1. The system area of the embedded database is allocated in this directory for the storage of system files.
system-area-directory-2

If you want to use the system log and duplex the system files (specify the -br option), you must also specify system-area-directory-2. Specifying the -br option creates duplicate system files.

Hitachi recommends that you place each of the above directories on a different volume to improve reliability.

When you create an environment for cluster operation (-r or -f option), specify the directories on the shared disk.

The name of each directory must be an absolute path of 50 bytes or less. If a name contains space characters, enclose the entire path in double quotation marks (" ").

When you specify multiple directories, enclose the entire value of the -d option in double quotation marks (" "). Do not enclose each separate directory name in double quotation marks (" ").

Do not specify any directory used by another embedded database.

`-lh` `logical-host-name`

You do not need to specify this option.

When you operate a logical host in a non-cluster environment, specify the -mh, -eh, -ld, and -r options.

`-r`

Specify this option when you configure the environment of the executing host in a cluster configuration or of the logical host in a non-cluster configuration. At the same time, you also need to specify a logical host name (-mh option) and the work area directory (-ld option).

The shared disk for storing the data area and the system area of the embedded database must be mounted on the executing host. In addition, the target logical host must be available for access.

`-f`

Specify this option to create the environment for the standby host in a cluster configuration. You also need to specify a logical host name (-mh option) and the embedded database work area directory (-ld option) at the same time.

When you specify this option, only the embedded database is set. The data area is not created and the embedded database is not started. However, make sure that the specification of the data area and the system area of the embedded database (-d option) is the same as the environment for the executing host.

`-ld` `work-area-directory`

Specify this option when you create an environment for logical host (-r or -f option). As the work area to be used by the embedded database, specify the name of a directory on the physical host. Do not specify a directory on the shared disk.

The name of the directory must be an absolute path of 50 bytes or less. If the name contains space characters, enclose the entire path in double quotation marks (" ").

Secure 40 MB of free space in the file system of the directory to be specified.

Do not specify any directory used by another embedded database.

`-mh` `logical-host-name`

Specify this option when you create an environment for logical host (-r or -f option). Specify a logical host name. You can specify a character string of 1 to 32 bytes.

`-eh` `primary-node-physical-host-name`

Specify this option when you create an environment for logical host (-r or -f option). Specify the host name (host name output by using the hostname command) that is recognized as the TCP/IP host name by the operating system on the executing host.

Note that you must specify the physical host name of the primary node for this option even when you are creating the environment for the standby host (-f option). You can specify a character string of 1 to 63 bytes.

`-p` `port-number`

Specify the port number to be used for the embedded database. You can specify a number from 5001 to 65535.

You must specify a port number that is not being used in the system. If other JP1 products are using the embedded database, make sure that you do not specify a port number that these products use.

Note that in Windows, if you specify a port number that has already been used, the following problems might occur:

JP1/AJS3 terminates abnormally or cannot operate normally.
The program that uses the duplicate port number terminates abnormally or cannot operate normally.

If you omit this option, the system assumes 22220.

`-i` `embedded-database-practical-directory`

Specify the name of the directory to be used as the embedded database practical directory.

If you are not sure about the name of the embedded database installation directory, execute the following command to check the name:

ajsembdbidlist -v

For details on the ajsembdbidlist command, see ajsembdbidlist in 2. Commands Used during Setup.

Use absolute paths to specify the names of directories. If the name of a directory contains space characters, enclose the entire path in double quotation marks (" ").

When you create an environment for cluster operation (-r or -f option), do not specify a directory on the shared disk.

You can omit this option for UNIX. If you omit the option, the system assumes /opt/jp1ajs2/embdb/_JF0.

Do not specify any directory used by another embedded database.

`-bs`

Specify this option if you use the system log and do not duplex the system files.

If you specify this option without specifying the -bl option, an error occurs.

`-br`

Specify this option if you use the system log and duplex the system files.

If you specify this option without specifying the -bl option, an error occurs.

`-bl` `unload-log-file-creation-directory`

Specify a directory in which the unload log file will be created. If you do not specify the -bs or -br option together with the -bl option, an error occurs.

The command results in an error if you specify the -bl option with the -b option.

The directory name you can specify in this option must be an absolute path name that is no more than 50 bytes. If the name contains space characters, enclose the entire path in double quotation marks (" ").

Do not specify any directory used by another embedded database.

For details on how to acquire the unload log file of the embedded database, see F.1(1) Restoring the scheduler database from unload log files in the JP1/Automatic Job Management System 3 System Design (Configuration) Guide.

`-rs`

You do not need to specify this option. If you specify it, processing ends without configuring the embedded database.

`-c`

Specify this option when you have upgraded JP1/AJS3. This option updates the configuration files used by the embedded database to the latest ones. Do not specify this option for a new installation, or if you do not want to update the configuration files.

Note that if you update configuration files, they are overwritten.

If JP1/AJS3 is upgraded from JP1/AJS2 Version 8 or earlier, you must specify this option when you execute the command for the first time after the upgrading.

`-lc` `character-code-set-type` (UNIX only)

This option no longer needs to be specified.

The character code set specified for this option is ignored, and JP1/AJS3 - Manager automatically sets the character code set.

`-id` `setup-identifier`

Use four characters, _JFn (n is 0 to 9 or A to Z), to specify the setup identifier for identifying the embedded database.

Make sure that you specify the setup identifier specified for the -id option of the ajsembdbidlist command.

If you omit this option, the system assumes _JF0. This option is ignored when you specify the -rs options.

To check the registered setup identifiers and embedded database practical directories, execute the ajsembdbidlist command.

For details on the ajsembdbidlist command, see ajsembdbidlist in 2. Commands Used during Setup.

`-ext_db`

Specify this option if you want to use the database area auto-increment function.

To check whether the auto-increment function is used, execute the following commands:

Data area:

pddbst -k phys -f -r AJS2DATA

pddbst -k phys -f -r AJS2DATA2^#

Index area:

pddbst -k phys -f -r AJS2INDX

pddbst -k phys -f -r AJS2INDX2^#

#:

This check is unnecessary if the backup enhancement function is not used.

The Auto Extend Use value indicates whether the function is used:

USE: The auto-increment function is used.

NOUSE: The auto-increment function is not used.

Note that before you execute the pddbst command from a command prompt, you need to set environment variables from the same command prompt. For details about the environment variables you must set, see the table that describes them in 9.2.3(2) Using a script to reorganize the database in the JP1/Automatic Job Management System 3 Administration Guide.

`-ext_log`

Specify this option if you want to use the system log auto-increment function.

To check whether the auto-increment function is enabled, use the following command:

ajsembdbstatus -l -id embedded-database-setup-ID

For details on the ajsembdbstatus command, see ajsembdbstatus in 3. Commands Used for Normal Operations.

`-conf` `embedded-database-settings-file-name`

Specify the embedded database settings file. An embedded database is configured with the same settings as the embedded database that was configured when the specified embedded database settings file was output.

If this option is specified together with other options, the options specified in the embedded database settings file take precedence.

When this option is specified, the -d, -ld, -mh, -eh, -r, -f and -b options can be omitted.

If the embedded database settings file that was output when the logical host was built is specified, but the -r or -f option is omitted, the -f option is assumed.

If the contents of the embedded database settings file are invalid, the KAVS2130-E message is output, and the command ends abnormally.

To use an embedded database settings file that was output in an environment using a different character encoding, convert the character codes.

If you specify this option, the directory structure must match the environment of the embedded database that was configured when the embedded database settings file specified as the argument was output. Accordingly, create beforehand the directories specified for the -d, -ld, and -bl options of the ajsembdbbuild command by which the environment of the embedded database was configured when the embedded database settings file was output.

The embedded database settings file is output to the following location.

In Windows:: embedded-database-practical-directory\conf\ajsdbst\ajsembdb-setup-identifier.conf
In UNIX:: embedded-database-practical-director/conf/ajsdbst/ajsembdb-setup-identifier.conf

`-b`

Specify if you build an embedded DB where the backup enhancement function is enabled. If this specification is omitted, an embedded DB is built where the backup enhancement function is disabled.

The command results in an error if you specify the -b option with the -bl option.

If you specified this option, also specify the -b option in the ajsembdbsetup command. For details about the ajsembdbsetup command, see ajsembdbsetup in 2. Commands Used during Setup.

To Page Top

Notes

When you re-create the embedded database environment, execute the ajsembdbunset command to initialize the information about the embedded database environment and then execute the ajsembdbbuild command. To delete the embedded database environment, execute the ajsembdbunset command as well.

Note that when you execute the ajsembdbunset command, the information about the embedded database environment is forcibly initialized even if the scheduler service is accessing the embedded database. Use caution when you execute the ajsembdbunset command.

For details on the ajsembdbunset command, see ajsembdbunset in 2. Commands Used during Setup.
The ajsembdbbuild command is incorporated into a script. For this reason, specifying an excessively long character string or an invalid character string or value may result in an unexpected error. In the options, therefore, specify the character strings and numeric values defined in DBMS and JP1/AJS3.
When executing the ajsembdbbuild command, you must set the maximum file size available in the OS file system at a value greater than 2 gigabytes, or set it at infinity.

For AIX, in particular, note that the file size limit is set at a default of 1 gigabyte.
Even if the directory name specified in the -bl option is incorrect, the embedded database system may complete the startup process. When you specify the -bl option, see the Windows event log or syslog to check if an error message for the embedded database KFPS01150-E has been output.
Do not use multi-byte characters or special symbols for path names such as the path name of the embedded database practical directory.
If the ajsembdbbuild command outputs either of the following messages and terminates, execute the ajsembdbunset command with the -i option specified to delete the environment, and then re-execute the ajsembdbbuild command:
- KAVS2124-E Failed in construction of EmbedDB server.
- KAVS2122-E A temporary file already exists.
Do not execute ajsembdbbuild command repeatedly in quick succession. If you do so, the following problems might occur:
- The message output is invalid. For example, an invalid message is output or a message that should be output is not output.
- The ajsembdbbuild command results in an error.
- The configuration definition information becomes invalid, disabling further operation of JP1/AJS3.
Before you execute this command, register in the hosts file or DNS the name of the host on which you are creating the embedded database environment. In a cluster system, register both the physical and logical host names of the primary node.
If you register the name of the host on which the embedded database environment has been set up in the jp1hosts or jp1hosts2 definition file, that name does not become effective as the host name used for the embedded database.
Do not use aliases as the name of the host on which the embedded database environment has been set up.
For hosts on which the embedded database environment has been set up, specify a physical host name by using 1 to 63 bytes, and specify a logical host name by using 1 to 32 bytes.

To Page Top

Actions to be taken if an error occurs

If a problem occurs during execution of the ajsembdbbuild command, the return code, error message, and termination message are output in this order to the standard output and standard error output. Troubleshoot the problem according to the following table, and then re-execute the command.

Code	Message ID	Cause	Action taken
1	KFPX29601	The `-d` option is specified incorrectly.	Revise the arguments specified in `-d` option.
3	KFPX29603	The specified directory is not an embedded database practical directory.	Specify an embedded database practical directory in the `-i` option.
4	KFPX29604	No embedded database practical directory is specified.
5	KFPX29605	A port number is duplicated.	Specify a port number in the `-p` option so that it does not duplicate another port number.
6	KFPX29606	System common definition is incorrect.	This error occurs when you modify setup files such as the system common definition manually. Correct the cause of the error. If the length of the specified absolute path name exceeds 50 bytes, specify an absolute path name that is no more than 50 bytes.
7	KFPX29607	The file does not exist.	Review the `ajsembdbbuild` command execution environment. Revise the arguments specified in `-ld` option.
8	KFPX29608	The file could not be opened.
9	KFPX29609	The file could not be read.
10	KFPX29610	A file could not be created.
11	KFPX29611	A directory could not be created.	Review the arguments specified in `-d`, `-bl`, and `-ld` options. If the AJS administrator is executing the command, make sure the AJS administrator has execution privileges.
12	KFPX29612	The table and system area is insufficient.	Review the `ajsembdbbuild` command execution environment. Revise the arguments specified in `-ld` option.
13	KFPX29613
14	KFPX29614
15	KFPX29615
16	KFPX29616	An error occurred during the creation of a table and system area.	Review the `ajsembdbbuild` command execution environment. Revise the arguments specified in `-bl` option. If the maximum file size available for the OS file system has a setting equal to or less than 2 gigabytes, you must change the setting to a value greater than 2 gigabytes, or set it at infinity.
17	KFPX29617	An error occurred during system area initialization.	Review the `ajsembdbbuild` command execution environment. Revise the arguments specified in `-ld` option.
18	KFPX29618	An error occurred during embedded database start or table area initialization.	Review the command execution environment. Confirm that communication can be established with the IP address that was resolved from the specified host name. Revise the argument specified in `-bl` option. Required resources for the embedded database are insufficient. For details, see 3.2.5 Estimating the values for kernel parameters in the JP1/Automatic Job Management System 3 System Design (Configuration) Guide.
19	KFPX29619	An internal error occurred in the embedded database.	Back up the embedded database practical directory and contact the system administrator.
20	KFPX29620	An error occurred during temporary file creation.	Review the `ajsembdbbuild` command execution environment. Revise the arguments specified in `-bl` option.
21	KFPX29621	The file format is incorrect.	This error occurs if you modify setup files such as the system common definition manually. Correct the cause of the error.
22	KFPX29622	System area specification is incorrect.
23	KFPX29623	An internal error in the embedded database.	Save the directory specified as the embedded database practical directory, and contact the system administrator.
24	KFPX29624 KFPS00031	The embedded database environment has been created.	Execute the `ajsembdbunset` command to delete the embedded database environment, and then perform setup.
25	KFPX29625	Insufficient memory.	Allocate sufficient memory and then again set up the environment.
26	KFPX29626	An internal error occurred in the embedded database.	Back up the embedded database practical directory, and then contact the system administrator.
27	KFPX29627	An internal error occurred in the embedded database.
--	KFPS00031	The embedded database environment has been created.	Execute the `ajsembdbunset` command to delete the previous embedded database environment.
--	KFPS05089	The directory specified in the `-i` option does not exist.	Specify the embedded database practical directory.
--	Bad directory specified in -i option	The embedded database practical directory specified in `-i` option is invalid.	Specify the correct embedded database practical directory in `-i` option.
--	There is an error in the specification of the setup identifier.	The specified setup identifier is incorrect. Alternatively, the specified setup identifier is already registered.	Check the specification of the setup identifier and re-execute the script. Use four characters, `_JFn` (`n` is from 0 to 9 or from A to Z), to specify the setup identifier. Use the `ajsembdbidlist` command to check the registered setup identifiers.
--	Failed to register the configuration definition.	Registering the configuration definition failed.	Execute the `ajsembdbunset` command to delete the embedded database environment. After deleting the environment, check the execution permission for the `ajsembdbbuild` command and re-execute the `ajsembdbbuild` command.
--	KAVS2130-E	The embedded database settings file is incorrect. Alternatively, there is no permission to access the file specified in the `-conf` option.	Specify the file correctly and re-execute the command. If the AJS administrator is executing the command, make sure the AJS administrator has execution privileges.

Legend:: --: No code number.

To Page Top

Return values

0	Normal end
Values other than 0	Abnormal end

To Page Top

ajsembdbbuild

Format

Format 1 (standard setup on a physical host)

Format 2 (setup for creating a backup and obtaining an unload log file periodically on a physical host)

Format 3 (standard setup on a logical host)

Format 4 (setup for creating a backup and obtaining an unload log file periodically on a logical host)

Format 5 (setup for configuring an embedded database on a secondary node by using the embedded database settings file created on the primary node)

Format 6 (setup for enabling the backup enhancement function on the physical host)

Format 7 (setup for enabling the backup enhancement function on the logical host)

Description

Execution privileges

Storage directory

Arguments

-l|-m|-s

-d data-area-directory [,system-area-directory-1 [,system-area-directory-2]]

-lh logical-host-name

-r

-f

-ld work-area-directory

-mh logical-host-name

-eh primary-node-physical-host-name

-p port-number

-i embedded-database-practical-directory

-bs

-br

-bl unload-log-file-creation-directory

-rs

-c

-lc character-code-set-type (UNIX only)

-id setup-identifier

-ext_db

-ext_log

-conf embedded-database-settings-file-name

-b

Notes

Actions to be taken if an error occurs

Return values

`-l|-m|-s`

`-d` `data-area-directory` `[,system-area-directory-1` `[,system-area-directory-2]]`

`-lh` `logical-host-name`

`-r`

`-f`

`-ld` `work-area-directory`

`-mh` `logical-host-name`

`-eh` `primary-node-physical-host-name`

`-p` `port-number`

`-i` `embedded-database-practical-directory`

`-bs`

`-br`

`-bl` `unload-log-file-creation-directory`

`-rs`

`-c`

`-lc` `character-code-set-type` (UNIX only)

`-id` `setup-identifier`

`-ext_db`

`-ext_log`

`-conf` `embedded-database-settings-file-name`

`-b`