FieldServiceSettings | メタデータ API 開発者ガイド

Field Service 設定についての詳細は、Salesforce ヘルプの「Field Service の有効化」を参照してください。

パッケージマニフェストでは、Settings の名前を使用してすべての組織設定メタデータ型にアクセスします。詳細は「設定」を参照してください。

バージ��ン

FieldServiceSettings は、API バージョン 40.0 以降で使用できます。

項目

項目	項目の型	説明
apptAssistantExpiration	int	apptAssistantInfoUrl の有効期限。この期限を過ぎると、派遣作業員のロケーションと予想到着時刻が顧客に表示されなくなります。API バージョン 50.0 以降で利用できます。
apptAssistantInfoUrl	string	派遣作業員の予想到着時刻と追跡情報を顧客が確認できるようにする追跡 URL。API バージョン 50.0 以降で利用できます。
apptAssistantRadiusUnitValue	ApptAssistantRadiusUnit (string 型の列挙)	ジオフェンスの半径を指定するための単位。派遣作業員がこの領域に入ると、ラストマイル通知が自動的に送信されます。有効な値は、次のとおりです。キロメートルメートルマイルヤード API バージョン 50.0 以降で利用できます。
apptAssistantRadiusValue	int	サービス予定の住所からのジオフェンスの半径。この半径は、派遣作業員がサービス予定の住所に近づいたときに、顧客に通知を送信するために使用されます。API バージョン 50.0 以降で利用できます。
apptAssistantStatus	string	配送中の通知をトリガーするために使用されるサービス予定の状況。この値は、サービス予定の [状況] 項目のいずれかのオプションに一致する必要があります。派遣作業員がサービス予定でこの状況を選択すると、顧客は、配送中の通知と追跡の詳細を受信します。API バージョン 50.0 以降で利用できます。
canPopulateGoogleAddress	boolean	デスクトップとモバイルで、地理位置情報と地図データを Google と Apple に送信することを許可します。API バージョン 57.0 以降で利用できます。
canSendAppCenterCrashReports	boolean	Salesforce から Microsoft App Center にクラッシュレポートを送信することを許可します。API バージョン 57.0 以降で利用できます。
canStoreMobileAnalytics	boolean	サードパーティがモバイルアナリティクスを保存することを許可します。API バージョン 57.0 以降で利用できます。
deepLinkPublicSecurityKey	string	Field Service モバイルアプリケーションでディープリンクアクションにアクセスするユーザー用に公開セキュリティキーを提供します。セキュリティキーを使用してディープリンク URL を設定することでリダイレクト警告を非表示にします。その後、ディープリンク URL でセキュリティチェックが処理されます。API バージョン 54.0 以降で利用できます。
doesShareSaParentWoWithAr	boolean	サービス予定の親作業指示を、割り当てられたリソースと共有します。この設定は、doesShareSaWithAr が選択されていて、作業指示の共有アクセス権が「非公開」または「公開/参照のみ」に設定されている場合にのみ適用されます。割り当てられたリソースが技術者の場合、作業指示の「参照・更新」アクセス権が付与されます。割り当てられたリソースが [クルー] 種別の場合、クルーリーダーには「参照・更新」アクセス権が、クルーメンバーには「参照」アクセス権が付与されます。サービス予定の親が作業指示品目の場合、割り当てられたリソースには関連付けられた作業指示のアクセス権が付与されます。
doesShareSaWithAr	boolean	派遣されたサービス予定を、割り当てられたリソースと共有します。この設定は、サービス予定の共有アクセス権が「非公開」または「公開/参照のみ」に設定されている場合にのみ適用されます。割り当てられたリソースが技術者の場合、サービス予定の「参照・更新」アクセス権が付与されます。割り当てられたリソースが [クルー] 種別の場合、クルーリーダーには「参照・更新」アクセス権が、クルーメンバーには「参照」アクセス権が付与されます。
enableFloatingWorkOrder	boolean	組織で流動的な作業指示を有効にします。前の作業指示の完了に基づいて、流動的な定期的ケイデンスにより作業指示を作成できます。
enablePopulateWorkOrderAddress	boolean	メンテナンス計画から作業指示を生成する際に、住所が入力されるようにします。
enableWorkOrders	boolean	組織で作業指示を有効にします。この設定を使用すると、Field Service が有効かどうかにかかわらず、ユーザーは作業指示オブジェクトを使用できます。Field Service が有効な場合、作業指示を無効にすることはできません。
enableWorkPlansAutoGeneration	boolean	作業指示または作業指示品目が新規作成されたときに作業プランとその作業手順を自動的に生成することを許可します。生成される作業プランと作業手順は、[作業プラン選択ルール] で指定された一致条件によって変化します。API バージョン 52.0 以降で利用できます。
enableWorkStepManualStatusUpdate	boolean	作業ステップの状況を手動で更新できます。状況を更新するよう提案するメッセージが表示され、ユーザーは受け入れるか延期することができます。
fieldServiceNotificationsOrgPref	boolean	Salesforce モバイルアプリケーションと Lightning Experience のユーザー向けのアプリケーション内通知を有効化します。ユーザーが所有またはフォローしている作業指示や作業指示品目に対して次のいずれかのアクションが発生すると、通知が送信されます。テキストまたはファイル投稿が追加された追跡項目が更新されたレコード所有者が変更された関連するサービス予定のリソース割り当てが変更された作業指示のフィード追跡設定ですべての関連オブジェクトを追跡するオプションが選択されている場合、作業指示の子レコード (サービス予定など) が作成または削除されたときにもユーザーに通知されます。
fieldServiceOrgPref	boolean	Field Service が有効かどうかを示します。
isGeoCodeSyncEnabled	boolean	サービスリソースのロケーションを在庫オブジェクトに同期します。
isLocationHistoryEnabled	boolean	サービスリソースのロケーション履歴を追跡します。
mobileFeedbackEmails	string	ユーザーが Field Service モバイルアプリケーションからフィードバックを残す場合のフィードバックメールの送信先のメールアドレスを保存します。API バージョン 54.0 以降で利用できます。
o2EngineEnabled	boolean	Field Service の拡張スケジュールおよび最適化を有効にします。デフォルト値は false です。API バージョン 55.0 以降で利用できます。
objectMappingItem	ObjectMappingItem	作業プランまたは作業ステップを生成するための組織のカスタム項目の対応付けを表します。カスタム項目は、WorkPlanTemplate から WorkPlan、WorkStepTemplate から WorkStep、または WorkPlanTemplateEntry から WorkStep に対応付けることができます。API バージョン 52.0 以降で利用できます。
optimizationServiceAccess	boolean	最適化サービスが Salesforce 組織のデータにアクセスできるようにします。
serviceAppointmentsDueDateOffsetOrgValue	int	自動作成するサービス予定の期日を作成日の何日後とするかを示します。作業種別には、作業種別を使用して新しい作業指示または作業指示品目にサービス予定を自動的に追加するオプションも含まれます。
workOrderDurationSource	WorkOrderDurationSource (string 型の列挙)	作業指示の期間値の参照元。可能な値は次のとおりです。 WorkType TotalFromWorkPlan Custom API バージョン 55.0 以降で利用できます。
workOrderLineItemSearchFields	string	作業指示品目に関するナレッジ記事を推奨するために検索エンジンでスキャンする作業指示品目項目。
workOrderSearchFields	string	作業指示に関するナレッジ記事を推奨するために検索エンジンでスキャンする作業指示項目。

ObjectMappingItem

作業プランまたは作業ステップを生成するための組織のカスタム項目の対応付けを表します。カスタム項目は、WorkPlanTemplate から WorkPlan、WorkStepTemplate から WorkStep、または WorkPlanTemplateEntry から WorkStep に対応付けることができます。API バージョン 52.0 以降で利用できます。

項目名	項目の型	説明
mappingType	string	オブジェクトの対応付けの種別。有効な値は、次のとおりです。 `WorkPlans_WorkPlanTemplate_WorkPlan` — WorkPlanTemplate を WorkPlan に対応付けます。 `WorkPlans_WorkStepTemplate_WorkStep` — WorkStepTemplate を WorkStep に対応付けます。 `WorkPlans_WorkPlanTemplateEntry_WorkStep` — WorkPlanTemplateEntry を WorkStep に対応付けます。
objectMapping	ObjectMapping	オブジェクトの対応付けの詳細。

ObjectMapping

入力オブジェクトの項目と出力オブジェクトの項目との対応を表します。

項目名	項目の型	説明
inputObject	string	必須。対応付けの参照元項目を含むオブジェクト種別の名前。有効な値は、次のとおりです。 `WorkPlanTemplate` `WorkStepTemplate` `WorkPlanTemplateEntry`
mappingFields	[ObjectMappingField]	必須。参照元オブジェクト項目と参照先オブジェクト項目の対応付け。
outputObject	string	必須。参照元項目からデータを受信するオブジェクト種別の名前。有効な値は、次のとおりです。 `WorkPlan` `WorkStep`

ObjectMappingField

入力オブジェクトの項目名、および出力オブジェクトの対応する項目名。

項目名	項目の型	説明
inputField	string	必須。参照元データを提供するカスタム項目の名前。この項目は、inputObject で指定されたオブジェクトから取得されます。
outputField	string	必須。inputField で指定された参照元項目からデータを受信するカスタム項目の名前。この項目は、outputObject で指定されたオブジェクトから取得されます。

宣言的なメタデータの定義のサンプル

このサンプルファイルでは、カスタマイズできるフィールドサービス設定のサブセットが示されています。

1<?xml version="1.0" encoding="UTF-8"?>
2<FieldServiceSettings xmlns="http://soap.sforce.com/2006/04/metadata">
3   <doesAllowEditSaForCrew>false</doesAllowEditSaForCrew>
4   <doesShareSaParentWoWithAr>false</doesShareSaParentWoWithAr>
5   <doesShareSaWithAr>false</doesShareSaWithAr>
6   <enableWorkOrders>false</enableWorkOrders>
7   <enableWorkPlansAutoGeneration>true</enableWorkPlansAutoGeneration>
8   <fieldServiceNotificationsOrgPref>false</fieldServiceNotificationsOrgPref>
9   <fieldServiceOrgPref>true</fieldServiceOrgPref>
10   <isGeoCodeSyncEnabled>false</isGeoCodeSyncEnabled>
11   <isLocationHistoryEnabled>false</isLocationHistoryEnabled>
12   <o2EngineEnabled>false</o2EngineEnabled>
13   <objectMappingItem>
14      <mappingType>WorkPlans_WorkPlanTemplate_WorkPlan</mappingType>
15      <objectMapping>
16         <inputObject>WorkPlanTemplate</inputObject>
17         <mappingFields>
18            <inputField>WorkPlanTemplate_CustomNumberField__c</inputField>
19            <outputField>WorkPlan_CustomNumberField__c</outputField>
20         </mappingFields>
21         <mappingFields>
22            <inputField>WorkPlanTemplate_CustomTextField__c</inputField>
23            <outputField>WorkPlan_CustomPicklistField__c</outputField>
24         </mappingFields>
25         <outputObject>WorkPlan</outputObject>
26      </objectMapping>
27   </objectMappingItem>
28   <objectMappingItem>
29      <mappingType>WorkPlans_WorkStepTemplate_WorkStep</mappingType>
30      <objectMapping>
31         <inputObject>WorkStepTemplate</inputObject>
32         <mappingFields>
33            <inputField>WokStepTemplate_CustomNumberField__c</inputField>
34            <outputField>WokStep_CustomNumberField__c</outputField>
35         </mappingFields>
36         <mappingFields>
37            <inputField>WokStepTemplate_CustomTextField__c</inputField>
38            <outputField>WokStep_CustomTextField__c</outputField>
39         </mappingFields>
40         <outputObject>WorkStep</outputObject>
41      </objectMapping>
42   </objectMappingItem>
43   <objectMappingItem>
44      <mappingType>WorkPlans_WorkPlanTemplateEntry_WorkStep</mappingType>
45      <objectMapping>
46         <inputObject>WorkPlanTemplateEntry</inputObject>
47         <mappingFields>
48            <inputField>WorkPlanTemplateEntry_CustomDateField__c</inputField>
49            <outputField>WokStep_CustomDateField__c</outputField>
50         </mappingFields>
51         <outputObject>WorkStep</outputObject>
52      </objectMapping>
53   </objectMappingItem>
54   <optimizationServiceAccess>false</optimizationServiceAccess>
55   <serviceAppointmentsDueDateOffsetOrgValue>7</serviceAppointmentsDueDateOffsetOrgValue>
56   <workOrderLineItemSearchFields>Subject</workOrderLineItemSearchFields>
57   <workOrderSearchFields>Subject</workOrderSearchFields>
58</FieldServiceSettings>

マニフェストファイル内のワイルドカードのサポート

package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) は、機能設定のメタデータ型には適用されません。ワイルドカードは、個々の設定ではなくすべての設定を取得するときにのみ適用されます。詳細は、「設定」を参照してください。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。