メタデータ API 開発者ガイド
jBusinessHoursSettings
エンタイトルメント、エンタイトルメントテンプレート、キャンペーン、ケースの営業時間および休日の設定管理に使用するメタデータを表します。Metadata メタデータ型を拡張し、その fullName 項目を継承します。
パッケージマニフェストでは、「Settings」の名前を使用してすべての組織設定メタデータ型にアクセスします。詳細は「設定」を参照してください。
ファイルのサフィックスおよびディレクトリの場所
営業時間および休日設定は、settings ディレクトリの businessHours.settings という 1 つのファイルに保存されます。.settings ファイルは、各設定コンポーネントに設定ファイルが 1 つしかないため、他の名前つきのコンポーネントとは異なります。
バージョン
BusinessHoursSettings は、API バージョン 29.0 以降で使用できます。
項目
| 項目名 | データ型 | 説明 |
|---|---|---|
| businessHours | BusinessHoursEntry[] | エンタイトルメント、エンタイトルメントテンプレート、キャンペーン、およびケースに適用する営業時間を表します。 |
| holidays | Holidays[] | businessHours の休日および使用方法を表します。 |
BusinessHoursEntry
エンタイトルメント、エンタイトルメントテンプレート、キャンペーン、およびケースに適用する営業時間を表します。
| 項目名 | データ型 | 説明 |
|---|---|---|
| timeZoneId | string | 営業時間を定義する時間のタイムゾーン。 |
| name | string | 営業時間の名前。この名前は一意にする必要があります。 |
| active | string | 営業時間が有効かどうかを示します。 |
| default | string | 営業時間がデフォルトの営業時間に使用されるか否かを示します。 |
| mondayStartTime | string | 月曜日の営業時間の開始時刻。HH:mm:ss.SSSZ 形式を使用します。 |
| mondayEndTime | string | 月曜日の営業時間の終了時刻。HH:mm:ss.SSSZ 形式を使用します。00:00:00.000Z という値は、月曜日の午前 0 時を指定します。 |
| tuesdayStartTime | string | 火曜日の営業時間の開始時刻。HH:mm:ss.SSSZ 形式を使用します。 |
| tuesdayEndTime | string | 火曜日の営業時間の終了時刻。HH:mm:ss.SSSZ 形式を使用します。00:00:00.000Z という値は、火曜日の午前 0 時を指定します。 |
| wednesdayStartTime | string | 水曜日の営業時間の開始時刻。HH:mm:ss.SSSZ 形式を使用します。 |
| wednesdayEndTime | string | 水曜日の営業時間の終了時刻。HH:mm:ss.SSSZ 形式を使用します。00:00:00.000Z という値は、水曜日の午前 0 時を指定します。 |
| thursdayStartTime | string | 木曜日の営業時間の開始時刻。HH:mm:ss.SSSZ 形式を使用します。 |
| thursdayEndTime | string | 木曜日の営業時間の終了時刻。HH:mm:ss.SSSZ 形式を使用します。00:00:00.000Z という値は、木曜日の午前 0 時を指定します。 |
| fridayStartTime | string | 金曜日の営業時間の開始時刻。HH:mm:ss.SSSZ 形式を使用します。 |
| fridayEndTime | string | 金曜日の営業時間の終了時刻。HH:mm:ss.SSSZ 形式を使用します。00:00:00.000Z という値は、金曜日の午前 0 時を指定します。 |
| saturdayStartTime | string | 土曜日の営業時間の開始時刻。HH:mm:ss.SSSZ 形式を使用します。 |
| saturdayEndTime | string | 土曜日の営業時間の終了時刻。HH:mm:ss.SSSZ 形式を使用します。00:00:00.000Z という値は、土曜日の午前 0 時を指定します。 |
| sundayStartTime | string | 日曜日の営業時間の開始時刻。HH:mm:ss.SSSZ 形式を使用します。 |
| sundayEndTime | string | 日曜日の営業時間の終了時刻。HH:mm:ss.SSSZ 形式を使用します。00:00:00.000Z という値は、日曜日の午前 0 時を指定します。 |
休日
businessHours の休日および使用方法を表します。
| 項目名 | データ型 | 説明 |
|---|---|---|
| name | string | 休日の名前。この名前は一意にする必要はありません。 |
| description | string | 休日の説明。 |
| isRecurring | string | 休日が定期的であるかどうかを示します。 |
| activityDate | string | 休日の日付。不定期な休日に使用します。HH:mm:ss.SSSZ 形式を使用します。 |
| recurrenceStartDate | string | 休日の繰り返しを開始する日付。yyyy-mm-dd 形式を使用します。 |
| recurrenceEndDate | string | 休日の繰り返しを終了する日付。yyyy-mm-dd 形式を使用します。(省略可能)。 |
| startTime | string | 休日の日付の開始時刻。HH:mm:ss.SSSZ 形式を使用します。startTime および endTime は両方とも null であるか、両方とも null ではない必要があります。両方が null である場合、全日を示します。 |
| endTime | string | 休日の日付の終了時刻。HH:mm:ss.SSSZ 形式を使用します。startTime および endTime は両方とも null であるか、両方とも null ではない必要があります。両方が null である場合、全日を示します。 |
| recurrenceType | string | 休日の繰り返し種別。有効な値は、RecursDaily、RecursEveryWeekday、RecursMonthly、RecursMonthlyNth、RecursWeekly、RecursYearly、RecursYealyNth です。 |
| recurrenceInterval | string | 休日を繰り返す週、月または年の間隔。 |
| recurrenceDayOfWeek | string | 休日を繰り返す曜日。有効な値は Monday、Tuesday、Wednesday、Thursday、Friday、Saturday、Sunday です。 |
| recurrenceDayOfMonth | string | 休日を繰り返す日付。有効な値は 1 ～ 31 です。 |
| recurrenceInstance | string | 有効な値は First、Second、Third、Fourth、Last です。recurrenceType RecursMonthlyNth および RecursYearlyNth でのみ使用されます。たとえば、recurenceInstance 値が First である場合、休日は 3 か月ごとの第 1 月曜日に繰り返します。 |
| recurrenceMonthOfYear | string | 有効な値は、January、February、March、April、May、June、July、August、September、October、November、December です。 |
| businessHours | string | この休日に適用される営業時間設定の名前。 |
宣言的なメタデータの定義のサンプル
businesshours.settings メタデータファイルの例を次に示します。
1<?xml version="1.0" encoding="UTF-8"?>
2<BusinessHoursSettings xmlns="http://soap.sforce.com/2006/04/metadata">
3 <businessHours>
4 <active>true</active>
5 <default>true</default>
6 <fridayEndTime>00:00:00.000Z</fridayEndTime>
7 <fridayStartTime>00:00:00.000Z</fridayStartTime>
8 <mondayEndTime>00:00:00.000Z</mondayEndTime>
9 <mondayStartTime>00:00:00.000Z</mondayStartTime>
10 <name>Default</name>
11 <saturdayEndTime>00:00:00.000Z</saturdayEndTime>
12 <saturdayStartTime>00:00:00.000Z</saturdayStartTime>
13 <sundayEndTime>00:00:00.000Z</sundayEndTime>
14 <sundayStartTime>00:00:00.000Z</sundayStartTime>
15 <thursdayEndTime>00:00:00.000Z</thursdayEndTime>
16 <thursdayStartTime>00:00:00.000Z</thursdayStartTime>
17 <timeZoneId>America/Los_Angeles</timeZoneId>
18 <tuesdayEndTime>00:00:00.000Z</tuesdayEndTime>
19 <tuesdayStartTime>00:00:00.000Z</tuesdayStartTime>
20 <wednesdayEndTime>00:00:00.000Z</wednesdayEndTime>
21 <wednesdayStartTime>00:00:00.000Z</wednesdayStartTime>
22 </businessHours>
23 <businessHours>
24 <active>true</active>
25 <default>false</default>
26 <fridayEndTime>00:00:00.000Z</fridayEndTime>
27 <fridayStartTime>00:00:00.000Z</fridayStartTime>
28 <mondayEndTime>15:00:00.000Z</mondayEndTime>
29 <mondayStartTime>09:00:00.000Z</mondayStartTime>
30 <name>bh1</name>
31 <saturdayEndTime>00:00:00.000Z</saturdayEndTime>
32 <saturdayStartTime>00:00:00.000Z</saturdayStartTime>
33 <sundayEndTime>00:00:00.000Z</sundayEndTime>
34 <sundayStartTime>00:00:00.000Z</sundayStartTime>
35 <thursdayEndTime>17:00:00.000Z</thursdayEndTime>
36 <thursdayStartTime>10:50:00.000Z</thursdayStartTime>
37 <timeZoneId>America/Los_Angeles</timeZoneId>
38 <tuesdayEndTime>13:00:00.000Z</tuesdayEndTime>
39 <tuesdayStartTime>09:00:00.000Z</tuesdayStartTime>
40 <wednesdayEndTime>15:00:00.000Z</wednesdayEndTime>
41 <wednesdayStartTime>09:00:00.000Z</wednesdayStartTime>
42 </businessHours>
43 <holidays>
44 <activityDate>2013-09-02</activityDate>
45 <businessHours>Default</businessHours>
46 <businessHours>bh1</businessHours>
47 <isRecurring>false</isRecurring>
48 <name>Labor Day</name>
49 </holidays>
50 <holidays>
51 <businessHours>bh1</businessHours>
52 <isRecurring>true</isRecurring>
53 <name>Thanksgiving</name>
54 <recurrenceDayOfMonth>21</recurrenceDayOfMonth>
55 <recurrenceMonthOfYear>November</recurrenceMonthOfYear>
56 <recurrenceStartDate>2013-11-21</recurrenceStartDate>
57 <recurrenceType>RecursYearly</recurrenceType>
58 </holidays>
59</BusinessHoursSettings>BusinessHoursSettings 定義を参照する package.xml マニフェストの例は、次のとおりです。
1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3 <types>
4 <members>BusinessHours</members>
5 <name>Settings</name>
6 </types>
7 <version>29.0</version>
8</Package>