Start sequence definition file (Windows only)
- Organization of this page
Format
# Comment Name=any-name ServiceName=name-of-the-service-to-start-and-stop StartCommand=command-to-execute-at service-startup StopCommand=command-to-execute-at-service-stop Parallel=YES Wait=maximum-wait-time(in seconds)-for-completion-of-service-startup-processing StopWait=maximum-wait-time(in seconds)-for-completion-of-service-stop-processing Name=any-name ServiceName=name-of-the-service-to-start-and-stop StartCommand=command-to-execute-at service-startup StopCommand=command-to-execute-at-service-stop Parallel=YES Wait=maximum-wait-time(in seconds)-for-completion-of-service-startup-processing StopWait=maximum-wait-time(in seconds)-for-completion-of-service-stop-processing Name=any-name ServiceName=name-of-the-service-to-start-and-stop StartCommand=command-to-execute-at service-startup StopCommand=command-to-execute-at-service-stop Parallel=YES Wait=maximum-wait-time(in seconds)-for-completion-of-service-startup-processing StopWait=maximum-wait-time(in seconds)-for-completion-of-service-stop-processing ReadyCommand=command-to-execute-after-all-service-startup-processing-has-completed StopReadyCommand=command-to-execute-after-all-service-stop-processing-has-completed |
Parameters by type
- Required parameters:
-
None
- Custom parameters:
-
[ControlValue] section:
-
ForcedTerminateExec
[FrontOtherServiceXXX] and [Jp1XXX] sections:
-
Name
-
ServiceName
-
StartCommand
-
StopCommand
-
Parallel
-
Wait
-
StopWait
[Command] section:
-
ReadyCommand
-
StopReadyCommand
-
File name
JP1SVPRM.DAT (Start sequence definition file)
JP1SVPRM.DAT.MODEL (Start sequence definition file model file)
Storage destination directory
installation-folder\conf\boot\
Description
This file specifies the startup and stop sequences for the JP1 series product services, non-JP1 series product services, and the commands and batch files to be executed after the services have started or stopped.
Application of settings
Execute the cpysvprm command to create the start sequence definition file (JP1SVPRM.DAT). Restart Windows to apply the settings. For details on the cpysvprm command, see cpysvprm (Windows only) in 15. Commands.
Definition details
The parameters of the start sequence definition file (JP1SVPRM.DAT) are described below. In the start sequence definition file (JP1SVPRM.DAT), you can specify file names that are longer than 8 characters or include spaces. To insert a comment line, prefix the line with #. The characters following # and up to the next linefeed constitute a comment.
- [ControlValue]
-
Specify parameters in this section to perform a sequenced stop of services when a forced termination is performed from JP1/Power Monitor. You can specify just ForcedTerminateExec= in this section.
For a JP1/Power Monitor planned termination, JP1/Base always performs service stop processing as defined in the start sequence definition file (JP1SVPRM.DAT), even if you omit the [ControlValue] section.
- ForcedTerminateExec=
-
Specify YES to execute service stop processing at forced termination from JP1/Power Monitor. If you specify a value other than YES for this parameter or omit this parameter, JP1/Base will not perform service stop processing at a forced termination from JP1/Power Monitor.
- [FrontOtherServiceXXX]
-
In this section, write information about the non-JP1 services that you want to start before services provided by JP1 programs. In xxx, write any name using no more than 60 alphanumeric characters. Letters are not case sensitive.
- [Jp1XXX]
-
In this section, specify information about the services provided by JP1 products. xxx represents a product name. For services provided by JP1 products, xxx has been written in the supplied file JP1SVPRM.DAT.MODEL. You can also specify any name in xxx to add a service that is not included in the model file. Write no more than 60 alphanumeric characters. Letters are not case sensitive.
- [OtherServiceXXX]
-
In this section, write information about the non-JP1 services that you want to start after services provided by JP1 programs. In xxx, write any name using no more than 60 alphanumeric characters. Letters are not case sensitive.
- Name=
-
Specify this parameter in the [FrontOtherServicexxx], [Jp1xxx], and [OtherServicexxx] sections. You can write any identifier in Name=.
- ServiceName=
-
Specify this parameter in the [FrontOtherServicexxx], [Jp1xxx], and [OtherServicexxx] sections. Write the name of the service that you want to start and stop. If you omit this parameter, start and stop will not be controlled.
The service name written in this parameter might differ from the service name displayed in the Services dialog box, which opens from the Control Panel. For details, check with the manufacturer of the particular program.
- StartCommand=
-
Specify this parameter in the [FrontOtherServicexxx], [Jp1xxx], and [OtherServicexxx] sections. Specify a command to be executed at service startup. Only one command can be specified.
- StopCommand=
-
Specify this parameter in the [FrontOtherServicexxx], [Jp1xxx], and [OtherServicexxx] sections. Specify a command to be executed at service stop. If you omit this parameter, stop processing will not be performed. Only one command can be specified.
- Parallel=
-
Specify this parameter in the [FrontOtherServicexxx], [Jp1xxx], and [OtherServicexxx] sections. Specify YES to start the service in parallel, during start processing of another service. If you specify a value other than YES for this parameter or omit this parameter, start processing for this service will begin after completion of start processing for the preceding service.
The Parallel= parameter is enabled when the service start sequence is being controlled. When the service stop sequence is being controlled, stop processing for this service will begin after the completion of shutdown processing for the preceding service, regardless of the Parallel= parameter setting.
- Wait=
-
Specify this parameter in the [FrontOtherServicexxx], [Jp1xxx], and [OtherServicexxx] sections. Specify the maximum wait time (in seconds) for completion of service start processing. If start processing has not completed within the specified time, JP1/Base begins start processing for the next service. The specifiable range is from 1 to 86400 (seconds). The default is 60 (seconds).
- StopWait=
-
Specify this parameter in the [FrontOtherServicexxx], [Jp1xxx], and [OtherServicexxx] sections. Specify the maximum wait time (in seconds) for completion of service stop processing. If stop processing has not completed within the specified time, JP1/Base begins stop processing for the next service. The default is 60 (seconds). The specifiable range is 1 to 86400 seconds (24 hours).
- [Command]
-
In this section, write information about the command or batch file to be executed after all services have started or stopped. You can write simply ReadyCommand= or StopReadyCommand= in this section.
- ReadyCommand=
-
Write this parameter in the [Command] section. Specify a command to be executed after completion of start processing for all services. To execute multiple commands, prepare a batch file and specify the batch file name in ReadyCommand=.
- StopReadyCommand=
-
Write this parameter in the [Command] section. Specify a command to be executed after the processing for all of the services has completed. To execute multiple commands, prepare a batch file and specify the batch file name in StopReadyCommand=.
Notes
-
The square brackets enclosing section names are mandatory. Make sure that each section name is enclosed with square brackets when writing the start sequence definition file (JP1SVPRM.DAT).
-
Write each section name once only. If the start sequence definition file (JP1SVPRM.DAT) contains duplicate section names, only the first one is used.
-
Do not write duplicate names or command names in parameters within a section. If a section contains duplicate names or command names, the first one is valid.
-
Sections can be written in any order in the start sequence definition file (JP1SVPRM.DAT). However, processing within the [FrontOtherServicexxx], [Jp1xxx], and [OtherServicexxx] sections will be executed in the order written.
-
When writing information about services that are linked by dependency relationships, write the main service first, followed by the dependent services. If you write the dependent services before the main service, the main service will start automatically when the dependent services start. As a result, JP1/Base will not perform stop processing for the main service.
-
Only the services specified for ServiceName= in the [FrontOtherServicexxx], [Jp1xxx], and [OtherServicexxx] sections are subject to the definition. The startup sequence for multiple services cannot be controlled.
-
The command set in StopCommand= can only be used for a service that starts under the startup control (a service started by setting the StartCommand= parameter). Stop processing will not be executed, even if a command is set in StopCommand=, when the service is already active when the startup control begins.
-
Commands that require interactive operation or launch a GUI window cannot be specified in StartCommand=, StopCommand=, ReadyCommand=, or StopReadyCommand=.
If you specify such commands, the service will end abnormally.
-
Commands specified in StartCommand=, StopCommand=, ReadyCommand=, or StopReadyCommand= cannot access other machines in the network. If you specify a command that performs an operation for another machine in the network, an error will occur during execution.
-
To specify the full path of a command name that includes a space, enclose the command name with double quotation marks ("). If the path does not include a space, you do not have to used double quotation marks. You can specify an argument in a command.
-
The service stop sequence is not controlled if you quit by clicking the Windows Start menu and choosing Shut Down. To control the sequence in which services stop, you must execute shutdown from JP1/Power Monitor.
-
The service stop sequence cannot be controlled if you stop the JP1/Base Control Service manually, even if stop sequence control is defined in the start sequence definition file (JP1SVPRM.DAT).
-
If you want to start a particular service automatically or manually without using the JP1/Base Control Service, add comment delimiters to the service definition in the start sequence definition file (JP1SVPRM.DAT). Also, add comment delimiters to all the service definitions having dependencies with that service. Enter a hash mark (#) at the beginning of every line that is a definition of a service.
Having edited the start sequence definition file (JP1SVPRM.DAT) in this way, you can then work with that service in the Services dialog box that opens from the Control Panel in Windows. If you start the services automatically or manually without adding comment delimiters, the KAVA4003-E message might appear and the system might not operate correctly.
-
To specify a batch file that contains spaces for the parameters in the sections below, specify cmd/c "batch-file-name". Commands will not execute properly if batch files that contain spaces are specified as they normally are.
- [FrontOtherServicexxx], [Jp1xxx], and [OtherServicexxx] sections.
-
StartCommand parameter
StopCommand parameter
- [Command] sections.
-
ReadyCommand parameter
StopReadyCommand parameter
(example) StopCommand="cmd /c "D:\Program Files\HITACHI\JP1Base\conf\boot\stop_baseev.bat""
-
When specifying a command name and one or more arguments for the parameters in the sections shown below, enclose your specification in quotation marks (" ").
- [FrontOtherServiceXXX], [JP1XXX], and [OtherServiceXXX]sections.
-
StartCommand parameter
StopCommand parameter
- [Command]sections.
-
ReadyCommand parameter
StopReadyCommand parameter
(example) ReadyCommand=""D:\Program Files\ABC\start.exe" -start D:\temp\ABC\conf\start.conf"
Definition examples
# Enter the following definition to stop services in sequence when there is a forced termination from JP1/Power Monitor. [ControlValue] ForcedTerminateExec=YES # Specify the services you want to start before the JP1 services. [FrontOtherService1] Name=ABC ServiceName=ABC StartCommand="c:\Program Files\ABC\start.exe" -start StopCommand="c:\Program Files\ABC\start.exe" -stop [FrontOtherService2] Name=DEF ServiceName=def_serv # Specify the services provided by JP1 products. [Jp1BaseStart] Name=JP1/Base ServiceName=JP1Base StopCommand="jbs_spmd_stop.exe" [Jp1BaseEvent] Name=JP1/Base Event ServiceName=JP1_Base_Event : [Jp1Nps] Name=JP1/Nps ServiceName=JP1_NPS Wait=60 Parallel=YES # Specify the services you want to start after the JP1 services. [OtherService1] Name=XYZ ServiceName=XYZ # Specify the command to be executed after all services have stopped. [Command] StopReadyCommand=c:\sfiles\stop.exe