The following are the commands used in the Jobscheduler function.
Commands executed with system administrator privileges
The following commands and the related control statements provided with Jobscheduler and executed with the system administrator privileges are discussed in the sections from 4.1 to 4.7 in this chapter.
jobschsethol command
Registers, changes and deletes holidays in the calendar.
Specifies holiday information.
jobschsetcal command
Registers, changes and deletes a schedule pattern.
Specifies a schedule pattern.
jobschcod command
Changes the day change time and reschedules groups and job nets.
jobschsetproject command
Registers, changes and deletes project information.
Sets up project information.
jobschgetoutput command
Acquires the job output of a job net.
jobschinit command
Initializes the schedule information of Jobscheduler.
stemSchDelete
Deletes projects including the information within the projects.
jobschsetauthinfo command [Windows][Linux]
Register/delete/reference the credential of the cloud service to be connected by the REST execution job.
Credential control statement
This control statement sets credential.
Commands executed with the general users privileges
The following commands and the related control statements provided with Jobscheduler and executed with the general users privileges are discussed in the sections from 4.8 to 4.22. Also note that projects that can be operated by each command are determined by the access rights set to respective project.
Point
When the Extended User Management function is enabled, the access right authentication depends on the OS user that executed the following commands:
If the OS user is a system administrator (user belonging to the Administrators group in Windows or superuser in UNIX), the commands are executed with the Operation Manager administrator privileges (has update rights for all projects).
If the OS user is a project owner, the commands are executed with the assumption that the owner has update rights over their projects.
If the OS user is neither a system administrator nor a project owner, the OS user that executed the commands is included in the OS users corresponding to all Operation Manager users that have access rights to the project, and the commands are executed if the user has the privileges. If the OS user that executed the commands corresponds to more than one Operation Manager user, the OS user will be given the most powerful privileges (update rights > change and operation rights > reference rights) among the privileges that the corresponding Operation Manager users have. If the corresponding Operation Manager user has both change rights and operation rights, then the OS user will also have both privileges. You can check the OS user permissions for each project with the mpprjcmdacl command. For the detail, refer to the "2.16 mpprjcmdacl Command [UNIX]".
jobschsetnet command
jobschsetgrp command
jobschctljob command
jobschcontrol command
jobschctlgrp command
jobschoperate command
jobschmove command
jobschmsgclear command
jobschmsgevent command
jobschprint command
jobschprintcsv command
jobschdeftocsv command
jobschcsvtodef command
jobschchecktime command
jobschchecklog command
chkfile/jobschchkfile command
jobschnetmemo command
jobschchkmsgevt command
jobschchknetvar command
jobschsleep command
jobschsetnet command
Registers, changes, deletes, and copies job nets. Can also be used to register or delete the startup days/message events/temporary changes information for the job net.
Sets registration information of job nets.
Sets registration information of jobs.
Sets job net startup days.
Sets message events.
Sets temporary change information of job nets.
jobschsetgrp command
Registers, changes and deletes groups.
Sets group registration information.
Sets registration information of the job net in a group.
jobschctljob command
Controls jobs.
jobschcontrol command
Controls job nets.
jobschctlgrp command
Controls groups.
jobschoperate command
Controls (Pause All, Continue All, Disable All, Enable All) all job nets and groups in a project.
jobschmove command
Changes the registration order of groups/job nets.
jobschmsgclear command
Waits once again for already generated message events.
jobschmsgevent command
Generates message events.
jobschcancelnet command [Windows]
Deletes the job net from the job net execution queue.
jobschdeftocsv command
Converts the registration information for the job net, group, holidays in the calendar and schedule pattern from the control statement format into the CSV format. The conversion results are output to the standard output (stdout).
jobschcsvtodef command
Converts the registration information for the job net, group, holidays in the calendar and schedule pattern from the CSV format into the control statement format. The conversion results are output to the standard output (stdout).
jobschchecktime command
Waits until the specified time comes.
jobschchecklog command
Checks whether a log file in text format contains a specific regular expression.
chkfile/jobschchkfile command
Checks the existence of files, and waits for files to be created/updated/deleted/resized.
jobschnetmemo command
Registers/deletes memo to/from a job net. Also outputs and searches the contents of the memo.
jobschchkmsgevt command
Called by Wait for Message Event jobs.
jobschchknetvar command
Called by jobs that check the values of job net variables.
jobschsleep command
Waits for the specified time period.
jobschrestexec command [Windows][Linux]
Executes, waits for completion, or forcibly terminates jobs (API) on a cloud service for which a REST interface is provided.
Commands for migration from earlier versions
In the section 4.23, the command used for migration from the earlier versions is discussed.
jobschconvert command
Converts the Jobscheduler database from the earlier version to the type that can be used in the current version.
About This Control Statement
When you create a control statement, use an editor, such as Notepad. A file containing control statements is referred to as a definition file.
The synopsis and notes for control statements are described below.
Synopsis
Write a control statement in the following format:
KEYWORD <- The keyword representing the control statement operand1 Followed by a parameter <- An option and associated parameter operand2 Followed by a parameter ...... operandn Followed by a parameter ; <- End of the control statement
Cautions
A unit of control statement starts with a keyword that represents the control statement and ends with a semicolon (;).
Enter one keyword or one option per line using a line break.
Insert one space character between an operand and a parameter.
Any incorrect specification causes registration of the control statement to fail.
Comments can also be included. Use the hash "#" symbol to enter comments. Any text after the hash "#" symbol will be treated as a comment.
