Description
This command registers, changes, and deletes holiday calendar information.
Synopsis
[To register or change information] |
Options
Specify the name of the file that stores the holiday information control statement.
Refer to "Holiday Information Control Statement" for details.
Specify the name of the holiday calendar (other than the system calendar "SYSTEM_CALENDAR") to be deleted.
Return Values
Normal termination
Abnormal termination
Command Location
[Windows]
<Systemwalker Runbook Automation Management Server installation directory>\bin |
[Linux]
/opt/FJSVswrbam/bin |
Privilege Required/Execution Environment
[Windows]
This command requires administrator privileges. When using a Windows Server 2008 or later operating system, run as an administrator.
This command can be executed on a Management Server.
[Linux]
This command requires system administrator (superuser) privileges.
This command can be executed on a Management Server.
Holiday Information Control Statement
The holiday information control statement is used to set up holiday information.
Synopsis
HOL ---------- (1) |
*1: Specify the calendarname operand immediately after the HOL keyword.
(*): Ensure these operands are specified.
(**): For operands marked (**), specify either or both operands.
Explanation of This Control Statement
(1) HOL
This is a keyword that indicates the start of the holiday information control statement.
(2) holiday calendar name
Specify the name of the holiday calendar (either the system calendar "SYSTEM_CALENDAR" or another holiday calendar) using no more than 24 bytes.
Spaces, user-defined characters, and the following characters (/ ? * ; , \ " < > | :) cannot be specified: If the name of an already existing holiday calendar is specified then the previous settings will be overwritten.
(3) year setting
Specify the years for which holidays are being set up, using four-digit numbers.
Up to three years' worth of holidays can be specified (for the current year, the next year, and the year after next). To specify holidays with the same pattern every year, specify "EVERY".
Specification example for year settings
If the current year is 2011, the following example shows how to specify this year and next year.
yearset 2011,2012 |
(4) month setting
Specify the months for which holidays are being set up, using numbers. Specify multiple months using the following format: "3,5,10,...".
To specify holidays with the same pattern every year, specify "EVERY".
(5) day setting
Specify the dates for which holidays are being set up, using numbers. Specify multiple dates using the following format: "1,2,15,...".
(6) day of the week setting
Specify the holiday in terms of "day of the week" units. Specify days of the week using the first three letters of the name of the day of the week. Specify multiple days of the week using the following format: "SUN,MON,TUE,WED,THU,FRI,SAT".
(7) days for which settings are canceled
Specify this operand to cancel the holiday settings for only specific days. Specify dates using the following format: "YYYY,MM,DD(,DD)". "EVERY" cannot be specified to cancel day settings.
Specification example for day settings cancellation
Specification examples are shown below.
To cancel the holiday settings for October 1, 2011
daycancel 2011,10,01 |
To cancel the holiday settings for October 1 and 15, 2011
daycancel 2011,10,01,15 |
To cancel the holiday settings for October 1 and November 20, 2011
daycancel 2011,10,01 |
To cancel the holiday settings for October 8, 2011 and November 25, 2012
daycancel 2011,10,08 |
Specification example for the holiday information control statement
The following example shows how to set up the following dates as holidays.
October 1, 2011
November 25, 2011
HOL |
Note
The holidays for a calendar can be registered, changed, or deleted only by system administrators (superusers or users that belong to the "Administrators" group).
Specify the "month settings" after the "year settings".
Specify the "day settings" and the "day of the week settings" after the "month settings".
To specify multiple holiday patterns, consider each combination of "year settings" and "month settings" to be a single holiday pattern, and then specify as many such combinations as required.
It is not possible to delete a calendar that the Schedule Definition is referring to.
This command recreates the holidays for a calendar by overwriting the existing settings. This means that information for holidays that have been set up will not take over. If necessary, set up these holidays in control statement again.
If a holiday calendar that the Schedule Definition is referring to is changed, the startup days for the Schedule Definition will be reset based on the modified holiday calendar. After changing a holiday calendar, check and correct the startup days for the Schedule Definition (the settings for specific days). ***To FJ: The following sentence may need to be deleted as it does not appear in the latest J manual*** Even if a reflection start date has been specified, the startup days for the Schedule Definition will be reset based on the modified calendar, regardless of the specified reflection start date.
This command simply makes a request to the server to change the holiday calendar. Even if the command finishes executing, there is no guarantee that the changes to the startup days for each Schedule Definition will have been reflected on the server. This means that the changes may not be reflected to the startup days for each Schedule Definition until some time after the command has finished.
If this command is used to register a holiday calendar with the same name as an already registered holiday calendar, the holiday calendar will be recreated by overwriting the existing holiday calendar. This means that the holiday calendar that has already been registered will be as specified by the newly created calendar control statement.
