6.13 Calendar

以下にCalendar定義と定義例を示します。Calendarの詳細については「予定表管理機能」、「スケジュール管理」を参照してください。

（表）Calendar定義

ラベル					デフォルト値	必須^※	説明
apiVersion:						Yes	APIバージョン 1.0を指定する
kind:						Yes	calendarを指定する
type:						Yes	resourceを指定する Ops Iの運用機能に追加する新しい定義であることを示す
name:						Yes	Calendar定義の内部名 nameは以下のルールに従う必要があります。本YAMLファイルのディレクトリ名を指定入力可能な文字は以下の通り半角英数字： a～z A～Z 0～9 半角の特殊文字： _ - 先頭文字が半角英数字かアンダーバー（_）その他の注意点は「YAMLファイル作成時の注意」2～4を参照
label:						Yes	YAMLファイルに記載する運用機能の表示名
includes:						No	このYAMLファイルで利用する関連YAMLファイルを記載メモ記載するYAMLファイルはこのYAMLファイル登録前にOps Iに登録されている必要があります。 includesラベルを指定することにより、他のYAMLファイルで定義した内容を取り込むことができます。
	- kind:					Yes	読み込むYAMLファイルの種類
	name:					Yes	読み込むYAMLファイルの内部名
description:						No	このYAMLファイルに対する詳細説明
workItems:						No	作業項目を定義
	- (workItem):
	name:					Yes	作業項目名。使用できる字数は、1～40文字。
	description:					No	作業項目の詳細説明
	isFolder:					Yes	以下を指定できる。 true：作業項目がフォルダ false：作業項目がフォルダではないためscheduleRuleの定義が必要。
	scheduleRule:					isFolderがfalseの場合必須	作業項目に設定する予定
		appointment:				Yes	作業項目の予定
			start:			Yes	作業項目の開始時刻
				dateTime:		Yes	"hh:MM:ss"形式で指定。ssは00を指定する。
				timeZone:		Yes	開始時刻のタイムゾーン
			duration:			Yes	作業に必要な時間（分）。1～2,147,483,647の整数を指定する。値はpatternのtypeによって最大値が異なる。patternのintervalで指定した値以下（単位は分に換算）を指定する。
		pattern:				isFolderがfalseの場合必須	作業項目の繰り返しのパターン詳細については「（表）作業項目の繰り返しのパターン」参照。
			type:		oneTime	Yes	作業項目の繰り返しのタイプ指定可能な値：daily、weekly、monthly、yearly、oneTime oneTimeを指定すると単一の作業、その他のtypeを指定すると定期的な作業になる。
			useDayOfMonth:			「（表）作業項目の繰り返しのパターン」参照	作業項目の予定で、日付を基準にするかを指定 true：日付を基準にする（Absolute） false：日付を基準としない（Relative）
			interval:				作業項目の実行の間隔単位と指定可能な値はtypeによって異なる。 daily：1～365日 weekly：1～52週 monthly：1～12月 yearly：1～99年
			plannedDayOfWeek:				作業項目を実行する曜日指定可能な値：Monday、Tuesday、Wednesday、Thursday、Friday、Saturday、Sunday
			plannedDayOfMonth:				作業項目を実行する日
				plannedDay:			作業項目を実行する基準からの日にち指定可能文字：1～31の整数
				isFromEnd:	false		基準として以下を指定できる。 true：月の最終日 false：月の開始日例：「月の最終日からX日前」と数える場合は"true"を指定
			plannedWeekOfMonth:				作業項目を実行する週指定可能な値：1、2、3、4、5、-1 "-1"は最終週を表す
			plannedMonthOfYear:				作業項目を実行する月指定可能な値：1～12の整数
	children:					No	isFolderで"true"を指定した場合に使用可能フォルダの配下の作業項目を定義する。
		- (workItem):					作業項目を定義する。

※入れ子関係にないラベルの必須が「No」の場合は、定義が必須ではありません。入れ子関係にあるラベルの場合は、下層ラベルの必須は、上層ラベルの必須が「Yes」である場合に適用されます。

各作業のスケジュールの実行パターンの詳細について以下に示します。
テーブルの各列には規則があり、"type"と"useDayOfMonth"の値の組み合わせによって繰り返しのパターンが指定されます。

（表）作業項目の繰り返しのパターン

pattern^※1		One time	daily	weekly	Absolute month	Relative month	Absolute year	Relative year
type:		oneTime	daily	weekly	monthly	monthly	yearly	yearly
useDayOfMonth:		×	×	×	true	false	true	false
interval:		×	◯	◯	◯	◯	◯	◯
plannedDayOfWeek:		×	×	◯^※2	×	◯	×	◯
plannedDayOfMonth:		×	×	×	◯	×	◯	×
	plannedDay:	×	×	×	◯	×	◯	×
	isFromEnd:	×	×	×	△	×	×	×
plannedWeekOfMonth:		×	×	×	×	◯	×	◯
plannedMonthOfYear:		×	×	×	×	×	◯	◯

（凡例）◯：必須項目、 △：任意項目（指定しない場合はデフォルト値falseが選択される）、×：指定不可

※1：繰り返しのパターンの詳細は「スケジュール管理」を参照してください。

※2：複数指定可能です。

＜定義例＞

apiVersion: 1.0
kind: calendar
type: resource
name: Template type_weekly1
label: test calendar template pattern type type_weekly1
description: test_calendar template description
workItems:
  - name: workItem_plannedDayOfWeek_multi_update
    description: workItem_plannedDayOfWeek_multi description
    isFolder: false
    scheduleRule:
        appointment:
            start:
                dateTime: "16:00:00"
                timeZone: "UTC+09:00_1"
            duration: 60
        pattern:
            type: weekly
            interval: 2
            plannedDayOfWeek: ["Friday"]