メタデータ API 開発者ガイドsalesforcedevjp.s3.amazonaws.com/developer/docs/api_meta/...はじめに第 1 章メタデータ API についてメタデータ API を使用して、組織のカスタムオブジェクト定義やページレイアウトなどのカスタマイズ情報を取

Version 31.0: Summer ’14

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

最終更新日: 2014/7/23

© Copyright 2000–2014 salesforce.com, inc. All rights reserved. Salesforce.com およびその他の名称や商標は、salesforce.com, inc. の登録商標です。本ドキュメントに記載されたその他の商標は、各社に所有権があります。

目次

はじめに.............................................................................................................................................1

第 1 章: メタデータ API について...............................................................................................1サポート対象の Salesforce のエディション..............................................................................................................2

開発プラットフォーム...............................................................................................................................................2

標準への準拠...............................................................................................................................................................3

メタデータ API サポートポリシー...........................................................................................................................3

関連リソース...............................................................................................................................................................4

第 2 章: クイックスタート..........................................................................................................5前提条件.......................................................................................................................................................................5

ステップ 1: 組織の Web サービス WSDL の生成または取得...............................................................................6

ステップ 2: 開発プラットフォームへの WSDL ファイルのインポート.............................................................6

ステップ 3: Java サンプルコードの説明...................................................................................................................7

メタデータ API の使用.....................................................................................................................15

第 3 章: メタデータのリリースと取得......................................................................................15Zip ファイルの使用..................................................................................................................................................15

package.xml マニフェストファイルのサンプル.....................................................................................................17

リリースでのテストの実行.....................................................................................................................................22

ユーザ参照の保持.....................................................................................................................................................23

第 4 章: CRUD ベースのメタデータ開発..................................................................................25

第 5 章: エラー処理...................................................................................................................29セッション終了のエラー処理.................................................................................................................................29

参照...................................................................................................................................................30

第 6 章: ファイルベースのコール.............................................................................................30deploy()........................................................................................................................................................................30

checkDeployStatus()........................................................................................................................................37cancelDeploy().................................................................................................................................................38

retrieve()......................................................................................................................................................................40RetrieveRequest...............................................................................................................................................44checkRetrieveStatus()......................................................................................................................................45

第 7 章: CRUD ベースのコール................................................................................................47createMetadata()..........................................................................................................................................................48readMetadata()............................................................................................................................................................49updateMetadata()........................................................................................................................................................51upsertMetadata().........................................................................................................................................................53

i

目次

deleteMetadata()..........................................................................................................................................................55renameMetadata().......................................................................................................................................................57create().........................................................................................................................................................................58delete().........................................................................................................................................................................60update().......................................................................................................................................................................62

第 8 章: ユーティリティコール.................................................................................................65checkStatus()...............................................................................................................................................................65describeMetadata()......................................................................................................................................................66listMetadata()..............................................................................................................................................................67

ListMetadataQuery.........................................................................................................................................68

第 9 章: Result オブジェクト.....................................................................................................69AsyncResult.................................................................................................................................................................69CancelDeployResult....................................................................................................................................................73DeployResult...............................................................................................................................................................73DescribeMetadataResult.............................................................................................................................................80ReadResult..................................................................................................................................................................81RetrieveResult.............................................................................................................................................................81SaveResult...................................................................................................................................................................84DeleteResult................................................................................................................................................................84UpsertResult................................................................................................................................................................84Error............................................................................................................................................................................85

第 10 章: メタデータ型.............................................................................................................86Metadata コンポーネントおよびメタデータ型.....................................................................................................95

サポートされていないメタデータ型......................................................................................................................96

メタデータ API リリースの特殊な動作.................................................................................................................97AnalyticSnapshot.........................................................................................................................................................99ArticleType................................................................................................................................................................101

ArticleType レイアウト...............................................................................................................................104ArticleType CustomField..............................................................................................................................106

ApexClass..................................................................................................................................................................109ApexComponent.......................................................................................................................................................111ApexPage...................................................................................................................................................................112ApexTrigger..............................................................................................................................................................114AppMenu..................................................................................................................................................................115ApprovalProcess........................................................................................................................................................118AssignmentRules.......................................................................................................................................................129AuthProvider.............................................................................................................................................................132AutoResponseRules...................................................................................................................................................134CallCenter.................................................................................................................................................................136Community (Zone)...................................................................................................................................................138ConnectedApp..........................................................................................................................................................141CustomApplication...................................................................................................................................................149

ii

目次

CustomApplicationComponent................................................................................................................................164CustomLabels............................................................................................................................................................165CustomObject...........................................................................................................................................................167

ActionOverride..............................................................................................................................................174BusinessProcess.............................................................................................................................................176CompactLayout.............................................................................................................................................177CustomField..................................................................................................................................................179FieldSet..........................................................................................................................................................188ListView........................................................................................................................................................189NamedFilter..................................................................................................................................................192

Picklist (連動選択リストを含む)................................................................................................................195RecordType...................................................................................................................................................201SearchLayouts................................................................................................................................................203SharingReason...............................................................................................................................................206SharingRecalculation.....................................................................................................................................207ValidationRule...............................................................................................................................................207Weblink.........................................................................................................................................................209

メタデータのデータ型...............................................................................................................................213CustomObjectTranslation.........................................................................................................................................215CustomPageWebLink...............................................................................................................................................223CustomPermission....................................................................................................................................................227CustomSite................................................................................................................................................................228CustomTab...............................................................................................................................................................233Dashboard.................................................................................................................................................................236DataCategoryGroup..................................................................................................................................................251Document..................................................................................................................................................................256EmailTemplate..........................................................................................................................................................258EntitlementProcess....................................................................................................................................................262EntitlementTemplate................................................................................................................................................266EscalationRules.........................................................................................................................................................267ExternalDataSource...................................................................................................................................................270FlexiPage...................................................................................................................................................................272Flow...........................................................................................................................................................................274Folder........................................................................................................................................................................297

FolderShare...................................................................................................................................................299Group........................................................................................................................................................................301HomePageComponent..............................................................................................................................................302HomePageLayout......................................................................................................................................................304InstalledPackage........................................................................................................................................................305Layout.......................................................................................................................................................................306Letterhead.................................................................................................................................................................324LiveChatAgentConfig...............................................................................................................................................326LiveChatButton........................................................................................................................................................330LiveChatDeployment................................................................................................................................................333

iii

目次

Metadata...................................................................................................................................................................334MetadataWithContent..............................................................................................................................................335MilestoneType..........................................................................................................................................................336Network.....................................................................................................................................................................337Package......................................................................................................................................................................345PermissionSet............................................................................................................................................................347Portal.........................................................................................................................................................................353PostTemplate............................................................................................................................................................356Profile........................................................................................................................................................................357Queue........................................................................................................................................................................370QuickAction..............................................................................................................................................................371RemoteSiteSetting.....................................................................................................................................................375Report........................................................................................................................................................................376ReportType...............................................................................................................................................................401Role...........................................................................................................................................................................405RoleOrTerritory........................................................................................................................................................406SamlSsoConfig..........................................................................................................................................................408Scontrol.....................................................................................................................................................................411

設定...........................................................................................................................................................................413AccountSettings.............................................................................................................................................414ActivitiesSettings...........................................................................................................................................415AddressSettings.............................................................................................................................................419BusinessHoursSettings..................................................................................................................................423CaseSettings..................................................................................................................................................427ChatterAnswersSettings................................................................................................................................433CompanySettings..........................................................................................................................................435ContractSettings............................................................................................................................................436EntitlementSettings.......................................................................................................................................437ForecastingSettings........................................................................................................................................439IdeasSettings..................................................................................................................................................443KnowledgeSettings........................................................................................................................................444LiveAgentSettings.........................................................................................................................................448MobileSettings..............................................................................................................................................449OpportunitySettings......................................................................................................................................452OrderSettings................................................................................................................................................453ProductSettings.............................................................................................................................................455QuoteSettings................................................................................................................................................455SecuritySettings.............................................................................................................................................456

SharedTo...................................................................................................................................................................462SharingRules.............................................................................................................................................................464

BaseSharingRule............................................................................................................................................468CriteriaBasedSharingRule.............................................................................................................................469OwnerSharingRule........................................................................................................................................475

SharingSet.................................................................................................................................................................480

iv

目次

SiteDotCom..............................................................................................................................................................483Skill...........................................................................................................................................................................484StaticResource...........................................................................................................................................................486Territory....................................................................................................................................................................487Translations...............................................................................................................................................................488Workflow..................................................................................................................................................................494

付録.................................................................................................................................................508

付録 A: CustomObjectTranslation の言語サポート — 完全サポート対象言語........................508

付録 B: CustomObjectTranslation の言語サポート — エンドユーザ言語...............................513

用語集.............................................................................................................................................519

v

目次

はじめに

第 1 章メタデータ API について

メタデータ APIを使用して、組織のカスタムオブジェクト定義やページレイアウトなどのカスタマイズ情報を取得、リリース、作成、更新、または削除します。APIはカスタマイズを管理し、データ自体ではなくメタデータモデルを管理できるツールを構築するためのものです。取引先またはリードなどのレコードを作成、取得、更新、または削除するには、SOAP API または REST API データを使用します。Force.com IDE または Force.com 移行ツールを使用すると、最も簡単にメタデータ API の機能にアクセスできます。これらのツールはメタデータ API の上位に構築され、メタデータ API との連携タスクを簡略化するために標準 Eclipse および Ant ツールを使用します。Eclipse プラットフォームで開発された Force.com IDE は、統合された開発環境に慣れているプログラマに快適な環境を提供し、IDE 内でコード記述、コンパイル、テスト、リリースのすべてを行うことができます。Force.com 移行ツールは、スクリプトまたはコマンドラインユーティリティを使用してローカルディレクトリと Salesforce 組織間でメタデータを移動する場合に最適です。Force.comIDE または Force.com 移行ツールについての詳細は、developer.force.com を参照してください。メタデータ APIの基礎となるコールは、独自のクライアントアプリケーションを構築する必要があるユーザが直接使用できるよう公開されています。このガイドでは、メタデータ APIを直接使用する方法について詳しく説明します。メタデータ API を使用して、組織の情報 (メタデータ) の設定とカスタマイズを管理できます。次に例を示します。• 組織のカスタマイズを XML メタデータファイルとしてエクスポートします。「Zip ファイルの使用」および

「retrieve()」を参照してください。• 組織間で設定の変更を移行します。「deploy()」および「retrieve()」を参照してください。• XML メタデータファイルを使用して組織の既存のカスタマイズを変更します。「deploy()」および

「retrieve()」を参照してください。• 組織のカスタマイズをプログラムで管理します。「CRUD ベースのメタデータ開発」を参照してください。

1

http://developerforcejp.s3.amazonaws.com/developer/docs/api/index.htm

http://developerforcejp.s3.amazonaws.com/developer/docs/api_rest/index.htm

http://developer.force.com

Developer Edition または Sandbox でテスト組織のメタデータを変更し、Enterprise Edition、Unlimited Edition、または Performance Edition でテスト済みの変更を本番組織にリリースできます。また、カスタムオブジェクト、カスタム項目およびその他のコンポーネントを使用して新しい組織を入力するスクリプトも作成できます。

関連リンクメタデータのリリースと取得CRUD ベースのメタデータ開発Metadata コンポーネントおよびメタデータ型

サポート対象の Salesforce のエディションメタデータ API を使用するには、Enterprise Edition、Unlimited Edition、Performance Edition、または DeveloperEdition を使用する必要があります。既存の Salesforce のお客様が Enterprise Edition、Unlimited Edition、またはPerformance Edition にアップグレードする場合は、担当者にご連絡ください。本番組織の厳密なレプリカである Sandbox を使用することを強くお勧めします。Enterprise Edition、UnlimitedEdition、および Performance Edition には無料の開発者 Sandbox が付属しています。詳細は、http://www.salesforce.com/platform/cloud-infrastructure/sandbox.jspを参照してください。また、ユーザは Enterprise Edition で使用できるすべての機能へのアクセスを提供する Developer Edition 組織を使用できます。ただし、ユーザ数およびストレージ容量には制限があります。Developer Edition 組織は、本番組織のコピーではありませんが、組織のデータに影響を与えることなくソリューションを構築およびテストできる環境を提供します。Developer Edition のアカウントは、http://developer.force.com/joinから無料で入手できます。

メモ: メタデータコンポーネントは、メタデータ API がメタデータコンポーネントに対して動作するように組織で参照可能になっている必要があります。また、ユーザはメタデータコンポーネントへのアクセス権を持つには、「API の有効化」権限も必要です。

開発プラットフォームメタデータ API では、ファイルベースおよび CRUD ベースの開発の両方をサポートしています。

ファイルベースの開発宣言型またはファイルベースの非同期のメタデータ API である deploy()操作および retrieve()操作では、フォルダのセットでコンポーネントを保持する .zipファイルおよび package.xmlという名前のマニフェストファイルをリリースまたは取得します。詳細は、「メタデータのリリースと取得」 (ページ 15)を参照してください。Force.com IDE または Force.com 移行ツールを使用すると、最も簡単にファイルベースの機能にアクセスできます。

CRUD ベースの開発CRUD メタデータ API コールは、Enterprise WSDL の同期 API コールによるオブジェクトに対する動作と同様にメタデータコンポーネントに対して動作します。Enterprise WSDL についての詳細は、『SOAP API 開発者ガイド』を参照してください。

2

サポート対象の Salesforce のエディションメタデータ API について

http://www.salesforce.com/platform/cloud-infrastructure/sandbox.jsp

http://developer.force.com/join

http://www.salesforce.com/apidoc


標準への準拠メタデータ API は、次の仕様に準拠するよう実装されています。

Web サイト標準名http://www.w3.org/TR/2000/NOTE-SOAP-20000508/Simple Object Access Protocol (SOAP)

1.1

http://www.w3.org/TR/2001/NOTE-wsdl-20010315Web Service Description Language(WSDL) 1.1

http://www.ws-i.org/Profiles/BasicProfile-1.1-2004-08-24.htmlWS-I Basic Profile 1.1

メタデータ API サポートポリシーSalesforce.com ではメタデータ API の以前のバージョンをサポートしています。ただし、新しいクライアントアプリケーションでは、より豊富な機能と優れた効率性の利点を十分に生かすには、最新バージョンの Force.comメタデータ API の WSDL ファイルを使用する必要があります。

後方互換性Salesforce.com では、Force.com プラットフォームを使用している場合の後方互換性を容易にできるよう努めています。新しい Salesforce リリースは、次の 2 つのコンポーネントで構成されています。• salesforce.com システムにある新しいリリースのプラットフォームソフトウェア• 新しいバージョンの API

たとえば、Spring '07 リリースには API バージョン 9.0 が、Summer '07 リリースには API バージョン 10.0 が含まれていました。プラットフォームソフトウェアのリリースにわたって、各APIバージョンのサポートを維持しています。指定されたAPIバージョンを処理するよう作成されたアプリケーションが、今後のプラットフォームソフトウェアのリリースで同じバージョンの API を継続して処理するよう、API には後方互換性があります。あるバージョンの API に対して作成されたアプリケーションが将来の API バージョンを使用することは保証されません。APIが拡張し続けているため、メソッド署名およびデータ表示の変更が必要な場合が多くあります。ただし、変更を新しい API バージョンに移行する必要がある場合、バージョン間の API の一貫性は最小限に保持されます。たとえば、Spring '07 リリースに付属するAPIバージョン 9.0 を使用して作成されたアプリケーションは、Summer'07 リリースのAPIバージョン 9.0、また今後のリリースにも対応し続けます。ただし、アプリケーションを変更せずに、同じアプリケーションで API バージョン 10.0 を使用することはできません。

API の有効期限Salesforce.com では、最初のリリース日から最低 3 年 API バージョンをサポートします。API の品質およびパフォーマンスを充実させ、改善するために、3 年を超えるバージョンのサポートは停止される場合があります。

3

標準への準拠メタデータ API について

http://www.w3.org/TR/2000/NOTE-SOAP-20000508/

http://www.w3.org/TR/2001/NOTE-wsdl-20010315

http://www.ws-i.org/Profiles/BasicProfile-1.1-2004-08-24.html

APIバージョンに廃止の予定がある場合、サポートが終了する最低 1 年前までに事前通知されます。Salesforce.comは、廃止予定の API バージョンを使用するお客様に直接通知します。

関連リソースsalesforce.com 開発者 Web サイトでは、開発者ツールキット、サンプルコード、サンプル SOAP メッセージ、コミュニティベースのサポート、およびその他のリソースの完全パッケージを提供して、開発プロジェクトを支援します。詳細は、https://wiki.developerforce.com/index.php/Getting_Startedを参照してください。http://developer.force.com/joinからは、Developer Edition のアカウントを無料で取得できます。以下の Web サイトにアクセスすると、Salesforce アプリケーションの詳細情報を入手できます。• Developer Force では、開発者にとって有益な情報を提供しています。• Salesforce.com では、Salesforce アプリケーションの詳細情報が提供されています。• Force.com AppExchange では、Salesforce 向けに作成されたアプリケーションにアクセスできます。• Salesforce.com Community では、Salesforce のお客様の成功を実現するサービスが提供されています。

4

関連リソースメタデータ API について

https://wiki.developerforce.com/index.php/Getting_Started


https://wiki.developerforce.com/index.php/Tools

http://www.salesforce.com

http://sites.force.com/appexchange

http://www.salesforce.com/community

第 2 章クイックスタート

Force.com IDE または Force.com 移行ツールを使用すると、最も簡単にメタデータ API の機能にアクセスできます。これらのツールはメタデータ API の上位に構築され、メタデータ API との連携タスクを簡略化するために標準 Eclipse および Ant ツールを使用します。Eclipse プラットフォームで開発された Force.com IDE は、統合された開発環境に慣れているプログラマに快適な環境を提供し、IDE 内でコード記述、コンパイル、テスト、リリースのすべてを行うことができます。Force.com 移行ツールは、スクリプトまたはコマンドラインユーティリティを使用してローカルディレクトリと Salesforce 組織間でメタデータを移動する場合に最適です。Force.comIDE または Force.com 移行ツールについての詳細は、developer.force.com を参照してください。ただし、メタデータ API の基礎となるコールは、独自のクライアントアプリケーションを構築する必要があるユーザが直接使用できるよう公開されています。このクイックスタートでは、組織のカスタマイズを管理するためにメタデータ APIを直接使用するアプリケーションの作成を開始するのに必要なすべての情報について説明します。このクイックスタートでは、ファイルベースの開発を開始する方法について説明します。CRUD ベースの開発の例については、「同期コールを使用した CRUD ベース開発用の Java サンプル」を参照してください。

前提条件メタデータ API を使用し始める前に、次の前提条件を必ず実行してください。• 開発環境を作成します。

本番組織の厳密なレプリカである Sandbox を使用することを強くお勧めします。Enterprise Edition、UnlimitedEdition、および Performance Edition には無料の開発者 Sandbox が付属しています。詳細は、http://www.salesforce.com/platform/cloud-infrastructure/sandbox.jspを参照してください。また、ユーザは Enterprise Edition で使用できるすべての機能へのアクセスを提供する Developer Edition 組織を使用できます。ただし、ユーザ数およびストレージ容量には制限があります。Developer Edition 組織は、本番組織のコピーではありませんが、組織のデータに影響を与えることなくソリューションを構築およびテストできる環境を提供します。Developer Edition のアカウントは、http://developer.force.com/joinから無料で入手できます。

• 「API の有効化」および「すべてのデータの編集」権限を持つユーザを特定します。これらの権限はメタデータ API コールにアクセスするために必要です。

• SOAP クライアントをインストールします。メタデータ API は、Visual Studio® .NET や Force.com Web ServiceConnector (WSC) などに限らず、現在の SOAP 開発環境で動作します。このドキュメントでは、WSC および JDK 6 (Java Platform Standard Edition Development Kit 6) に基づく Java の例を使用しています。サンプルを実行するには、まずmvnrepository.com/artifact/com.force.api/force-wsc/から最

5


http://www.salesforce.com/platform/cloud-infrastructure/sandbox.jsp


http://mvnrepository.com/artifact/com.force.api/force-wsc/

新の force-wsc JAR ファイルとその連動関係 (連動関係リストはバージョンを選択したときにページに表示されます) をダウンロードします。

メモ: 開発プラットフォームは、SOAP の実装によって異なります。特定の開発プラットフォームにおける実装の相違点により、メタデータ APIの一部またはすべての機能にアクセスできないことがあります。

ステップ 1: 組織の Web サービス WSDL の生成または取得メタデータ API コールにアクセスするには、Web Service Description Language (WSDL) ファイルが必要です。WSDL ファイルは、使用できる Web サービスを定義します。開発プラットフォームではこの WSDL を使用してスタブコードを生成し、WSDL が定義する Web サービスにアクセスします。組織の Salesforce システム管理者から WSDL ファイルを取得することも、WSDL ダウンロードページへのアクセス権限がある場合は Salesforceユーザインターフェースで自分で生成することもできます。WSDL の詳細は、http://www.w3.org/TR/wsdl

を参照してください。メタデータ API コールにアクセスするには、Enterprise WSDL および Partner WSDL で定義されている login()

コールを使用して Web サービスを使用するための認証を行う必要があります。そのため、これらの WSDL の 1つを取得する必要もあります。「すべてのデータの編集」権限を持つユーザなら誰でも WSDL ファイルをダウンロードし、Salesforce プラットフォームを統合および拡張できます (システム管理者プロファイルにこの権限が与えられます)。ステップ 3: Java サンプルコードの説明 (ページ 7)のサンプルコードでは Enterprise WSDL を使用していますが、Partner WSDL でも同様に適切に機能します。組織のメタデータおよび Enterprise WSDL ファイルを生成する手順は、次のとおりです。

1. Salesforce 取引先にログインします。「すべてのデータの編集」権限を持つ管理者またはユーザとしてログインします。

2. [設定] から、[開発] > [API] をクリックします。3. [メタデータ WSDL の生成] をクリックして、ファイルシステムに XML WSDL ファイルを保存します。4. [Enterprise WSDL の生成] をクリックして、ファイルシステムに XML WSDL ファイルを保存します。

ステップ 2: 開発プラットフォームへの WSDL ファイルのインポートWSDL ファイルを作成したら、開発環境でクライアント Web サービスアプリケーションの構築に必要なオブジェクトを生成できるよう、WSDL ファイルを開発プラットフォームにインポートする必要があります。このセクションでは、WSC のサンプルについて説明します。その他の開発環境の指示については、プラットフォームの製品マニュアルを参照してください。

メモ: WSDL ファイルをインポートするプロセスは、メタデータファイルおよび Enterprise WSDL ファイルの場合と同じです。

Java 環境での使用方法 (WSC)

Java 環境は、サーバ側オブジェクトのプロキシとして機能する Java オブジェクトを使用して、API にアクセスします。APIを使用する前に、まず組織の WSDL ファイルからこれらのオブジェクトを生成する必要があります。

6

ステップ 1: 組織の Web サービス WSDL の生成または取得

クイックスタート

http://www.w3.org/TR/wsdl

SOAP クライアントには、このプロセスで使用する独自のツールがあります。WSC では、wsdlcユーティリティを使用します。

メモ: wsdlcを実行する前に、システムに WSC JAR ファイルがインストール済みであり、クラスパスで参照されている必要があります。mvnrepository.com/artifact/com.force.api/force-wsc/ から最新の force-wscJAR ファイルとその連動関係 (連動関係リストはバージョンを選択したときにページに表示されます) をダウンロードできます。

wsdlcの基本構文は、次のとおりです。

java -classpath pathToWsc;pathToWscDependencies com.sforce.ws.tools.wsdlcpathToWsdl/WsdlFilename pathToOutputJar/OutputJarFilename

たとえば、Window の場合、次のようになります。

java –classpath force-wsc-30.0.0.jar;ST4-4.0.7.jar;antlr-runtime-3.5.jarcom.sforce.ws.tools.wsdlc metadata.wsdl metadata.jar

Mac OS X および UNIX では、クラスパスの項目間にセミコロンではなくコロンを使用します。

java –classpath force-wsc-30.0.0.jar:ST4-4.0.7.jar:antlr-runtime-3.5.jarcom.sforce.ws.tools.wsdlc metadata.wsdl metadata.jar

wsdlcは、クライアントアプリケーションの作成で使用する JAR ファイル、Java ソースコード、およびバイトコードファイルを生成します。Enterprise WSDL でもこのプロセスを繰り返し、enterprise.JAR ファイルを作成します。

ステップ 3: Java サンプルコードの説明WSDL ファイルをインポートすると、メタデータ API を使用するクライアントアプリケーションの構築を開始できます。このサンプルは、独自のコードを記述するための出発点として適しています。サンプルを実行する前に、プロジェクトとコードを次のように変更します。

1. WSC JAR、その連動関係、および WSDL から生成した JAR ファイルを含めます。

メモ: WSC には他の連動関係がありますが、次のサンプルでは Rhino (js-1.7R2.jar) のみが必要です。これは、mvnrepository.com/artifact/rhino/js からダウンロードできます。

2. 自分のユーザ名とパスワードを使って、MetadataLoginUtil.login()メソッドの USERNAME 変数とPASSWORD 変数を更新します。現在の IP アドレスが組織の信頼済み IP 範囲内にない場合は、セキュリティトークンをパスワードに追加する必要があります。

3. Sandbox を使用している場合は、必ずログイン URL を変更してください。

ログインユーティリティJava ユーザは、ConnectorConfigを使用して、Enterprise API、Partner API、および Metadata SOAP API に接続できます。MetadataLoginUtilは ConnectorConfigオブジェクトを作成し、Enterprise WSDL の login メソッドを使用してログインします。次に、sessionIdと metadataServerUrlを取得して ConnectorConfigを作成し、メタデータ API のエンドポイントに接続します。ConnectorConfigは WSC で定義されています。

7

ステップ 3: Java サンプルコードの説明クイックスタート

http://mvnrepository.com/artifact/com.force.api/force-wsc/

http://mvnrepository.com/artifact/rhino/js

MetadataLoginUtilクラスは、サンプルの他の部分からログインコードを抽象化するため、Salesforce API ごとに変更を行わずにこのコードの一部を再利用できます。

import com.sforce.soap.enterprise.EnterpriseConnection;import com.sforce.soap.enterprise.LoginResult;import com.sforce.soap.metadata.MetadataConnection;import com.sforce.ws.ConnectionException;import com.sforce.ws.ConnectorConfig;

/*** Login utility.*/public class MetadataLoginUtil {

public static MetadataConnection login() throws ConnectionException {final String USERNAME = "[email protected]";// This is only a sample. Hard coding passwords in source files is a bad practice.

final String PASSWORD = "password";final String URL = "https://login.salesforce.com/services/Soap/c/31.0";final LoginResult loginResult = loginToSalesforce(USERNAME, PASSWORD, URL);return createMetadataConnection(loginResult);

}

private static MetadataConnection createMetadataConnection(final LoginResult loginResult) throws ConnectionException {

final ConnectorConfig config = new ConnectorConfig();config.setServiceEndpoint(loginResult.getMetadataServerUrl());config.setSessionId(loginResult.getSessionId());return new MetadataConnection(config);

}

private static LoginResult loginToSalesforce(final String username,final String password,final String loginUrl) throws ConnectionException {

final ConnectorConfig config = new ConnectorConfig();config.setAuthEndpoint(loginUrl);config.setServiceEndpoint(loginUrl);config.setManualLogin(true);return (new EnterpriseConnection(config)).login(username, password);

}}

ファイルベース開発用の Java のサンプルコードサンプルコードは、ログインユーティリティを使用してログインします。次に、取得、リリース、および終了のメニューを表示します。retrieve()コールおよび deploy()コールは両方とも components.zipという名前の .zip ファイルを処理します。retrieve()コールは組織のコンポーネントを components.zipに取得し、deploy()コールはcomponents.zipのコンポーネントを組織にリリースします。コンピュータにサンプルを保存して実行する場合は、後でリリースできるcomponents.zipファイルを含めることができるように、まず取得オプションを実行します。retrieve コールの後、サンプルは、操作が完了するまでcheckRetrieveStatus()コールをループします。同様に、deploy コールの後、サンプルは、操作が完了するまで checkDeployStatus()チェックをループします。retrieve()コールは、マニフェストファイルを使用して組織から取得するコンポーネントを決定します。package.xmlマニフェストファイルのサンプルは次のとおりです。マニフェストファイルの構造についての詳

8


細は、「Zip ファイルの使用」を参照してください。このサンプルでは、マニフェストファイルはすべてのカスタムオブジェクト、カスタムタブ、およびページレイアウトを取得します。

<?xml version="1.0" encoding="UTF-8"?><Package xmlns="http://soap.sforce.com/2006/04/metadata">

<types><members>*</members><name>CustomObject</name>

</types><types>

<members>*</members><name>CustomTab</name>

</types><types>

<members>*</members><name>Layout</name>

</types><version>31.0</version>

</Package>

API コールに続く、エラー処理コードに注意してください。

import java.io.*;import java.nio.channels.Channels;import java.nio.channels.FileChannel;import java.nio.channels.ReadableByteChannel;import java.rmi.RemoteException;import java.util.*;

import javax.xml.parsers.*;

import org.w3c.dom.*;import org.xml.sax.SAXException;

import com.sforce.soap.metadata.*;

/*** Sample that logs in and shows a menu of retrieve and deploy metadata options.*/public class FileBasedDeployAndRetrieve {

private MetadataConnection metadataConnection;

private static final String ZIP_FILE = "components.zip";

// manifest file that controls which components get retrievedprivate static final String MANIFEST_FILE = "package.xml";

private static final double API_VERSION = 29.0;

// one second in millisecondsprivate static final long ONE_SECOND = 1000;

// maximum number of attempts to deploy the zip fileprivate static final int MAX_NUM_POLL_REQUESTS = 50;

private BufferedReader reader = new BufferedReader(new InputStreamReader(System.in));

public static void main(String[] args) throws Exception {FileBasedDeployAndRetrieve sample = new FileBasedDeployAndRetrieve();sample.run();

}

public FileBasedDeployAndRetrieve() {}

9


private void run() throws Exception {this.metadataConnection = MetadataLoginUtil.login();

// Show the options to retrieve or deploy until user exitsString choice = getUsersChoice();while (choice != null && !choice.equals("99")) {

if (choice.equals("1")) {retrieveZip();

} else if (choice.equals("2")) {deployZip();

} else {break;

}// show the options againchoice = getUsersChoice();

}}

/** Utility method to present options to retrieve or deploy.*/private String getUsersChoice() throws IOException {

System.out.println(" 1: Retrieve");System.out.println(" 2: Deploy");System.out.println("99: Exit");System.out.println();System.out.print("Enter 1 to retrieve, 2 to deploy, or 99 to exit: ");// wait for the user input.String choice = reader.readLine();return choice != null ? choice.trim() : "";

}

private void deployZip() throws Exception {byte zipBytes[] = readZipFile();DeployOptions deployOptions = new DeployOptions();deployOptions.setPerformRetrieve(false);deployOptions.setRollbackOnError(true);AsyncResult asyncResult = metadataConnection.deploy(zipBytes, deployOptions);DeployResult result = waitForDeployCompletion(asyncResult.getId());if (!result.isSuccess()) {

printErrors(result, "Final list of failures:\n");throw new Exception("The files were not successfully deployed");

}System.out.println("The file " + ZIP_FILE + " was successfully deployed\n");

}

/** Read the zip file contents into a byte array.*/private byte[] readZipFile() throws Exception {

byte[] result = null;// We assume here that you have a deploy.zip file.// See the retrieve sample for how to retrieve a zip file.File zipFile = new File(ZIP_FILE);if (!zipFile.exists() || !zipFile.isFile()) {

throw new Exception("Cannot find the zip file for deploy() on path:"+ zipFile.getAbsolutePath());

}

FileInputStream fileInputStream = new FileInputStream(zipFile);try {

ByteArrayOutputStream bos = new ByteArrayOutputStream();byte[] buffer = new byte[4096];int bytesRead = 0;while (-1 != (bytesRead = fileInputStream.read(buffer))) {

bos.write(buffer, 0, bytesRead);}

result = bos.toByteArray();

10


} finally {fileInputStream.close();

}return result;

}

/** Print out any errors, if any, related to the deploy.* @param result - DeployResult*/private void printErrors(DeployResult result, String messageHeader) {

DeployDetails details = result.getDetails();StringBuilder stringBuilder = new StringBuilder();if (details != null) {

DeployMessage[] componentFailures = details.getComponentFailures();for (DeployMessage failure : componentFailures) {

String loc = "(" + failure.getLineNumber() + ", " +failure.getColumnNumber();

if (loc.length() == 0 &&!failure.getFileName().equals(failure.getFullName()))

{loc = "(" + failure.getFullName() + ")";

}stringBuilder.append(failure.getFileName() + loc + ":"

+ failure.getProblem()).append('\n');}RunTestsResult rtr = details.getRunTestResult();if (rtr.getFailures() != null) {

for (RunTestFailure failure : rtr.getFailures()) {String n = (failure.getNamespace() == null ? "" :

(failure.getNamespace() + ".")) + failure.getName();stringBuilder.append("Test failure, method: " + n + "." +

failure.getMethodName() + " -- " + failure.getMessage() +" stack " + failure.getStackTrace() + "\n\n");

}}if (rtr.getCodeCoverageWarnings() != null) {

for (CodeCoverageWarning ccw : rtr.getCodeCoverageWarnings()) {stringBuilder.append("Code coverage issue");if (ccw.getName() != null) {

String n = (ccw.getNamespace() == null ? "" :(ccw.getNamespace() + ".")) + ccw.getName();stringBuilder.append(", class: " + n);

}stringBuilder.append(" -- " + ccw.getMessage() + "\n");

}}

}if (stringBuilder.length() > 0) {

stringBuilder.insert(0, messageHeader);System.out.println(stringBuilder.toString());

}}

private void retrieveZip() throws Exception {RetrieveRequest retrieveRequest = new RetrieveRequest();// The version in package.xml overrides the version in RetrieveRequestretrieveRequest.setApiVersion(API_VERSION);setUnpackaged(retrieveRequest);

AsyncResult asyncResult = metadataConnection.retrieve(retrieveRequest);RetrieveResult result = waitForRetrieveCompletion(asyncResult);

if (result.getStatus() == RetrieveStatus.Failed) {throw new Exception(result.getErrorStatusCode() + " msg: " +

result.getErrorMessage());} else if (result.getStatus() == RetrieveStatus.Succeeded) {// Print out any warning messages

11


StringBuilder stringBuilder = new StringBuilder();if (result.getMessages() != null) {

for (RetrieveMessage rm : result.getMessages()) {stringBuilder.append(rm.getFileName() + " - " + rm.getProblem() + "\n");

}}if (stringBuilder.length() > 0) {

System.out.println("Retrieve warnings:\n" + stringBuilder);}

System.out.println("Writing results to zip file");File resultsFile = new File(ZIP_FILE);FileOutputStream os = new FileOutputStream(resultsFile);

try {os.write(result.getZipFile());

} finally {os.close();

}}

}

private DeployResult waitForDeployCompletion(String asyncResultId) throws Exception {int poll = 0;long waitTimeMilliSecs = ONE_SECOND;DeployResult deployResult;boolean fetchDetails;do {

Thread.sleep(waitTimeMilliSecs);// double the wait time for the next iteration

waitTimeMilliSecs *= 2;if (poll++ > MAX_NUM_POLL_REQUESTS) {

throw new Exception("Request timed out. If this is a large set of metadata components, "

+"ensure that MAX_NUM_POLL_REQUESTS is sufficient.");

}// Fetch in-progress details once for every 3 pollsfetchDetails = (poll % 3 == 0);

deployResult = metadataConnection.checkDeployStatus(asyncResultId, fetchDetails);

System.out.println("Status is: " + deployResult.getStatus());if (!deployResult.isDone() && fetchDetails) {

printErrors(deployResult, "Failures for deployment in progress:\n");}

}while (!deployResult.isDone());

if (!deployResult.isSuccess() && deployResult.getErrorStatusCode() != null) {throw new Exception(deployResult.getErrorStatusCode() + " msg: " +

deployResult.getErrorMessage());}

if (!fetchDetails) {// Get the final result with details if we didn't do it in the last attempt.deployResult = metadataConnection.checkDeployStatus(asyncResultId, true);

}

return deployResult;}

private RetrieveResult waitForRetrieveCompletion(AsyncResult asyncResult) throwsException {

// Wait for the retrieve to completeint poll = 0;long waitTimeMilliSecs = ONE_SECOND;String asyncResultId = asyncResult.getId();

12


RetrieveResult result = null;do {

Thread.sleep(waitTimeMilliSecs);// Double the wait time for the next iterationwaitTimeMilliSecs *= 2;if (poll++ > MAX_NUM_POLL_REQUESTS) {

throw new Exception("Request timed out. If this is a large set " +"of metadata components, check that the time allowed " +"by MAX_NUM_POLL_REQUESTS is sufficient.");

}result = metadataConnection.checkRetrieveStatus(

asyncResultId);System.out.println("Retrieve Status: " + result.getStatus());

} while (!result.isDone());

return result;}

private void setUnpackaged(RetrieveRequest request) throws Exception {// Edit the path, if necessary, if your package.xml file is located elsewhereFile unpackedManifest = new File(MANIFEST_FILE);System.out.println("Manifest file: " + unpackedManifest.getAbsolutePath());

if (!unpackedManifest.exists() || !unpackedManifest.isFile()) {throw new Exception("Should provide a valid retrieve manifest " +

"for unpackaged content. Looking for " +unpackedManifest.getAbsolutePath());

}

// Note that we use the fully quualified class name because// of a collision with the java.lang.Package classcom.sforce.soap.metadata.Package p = parsePackageManifest(unpackedManifest);request.setUnpackaged(p);

}

private com.sforce.soap.metadata.Package parsePackageManifest(File file)throws ParserConfigurationException, IOException, SAXException {

com.sforce.soap.metadata.Package packageManifest = null;List<PackageTypeMembers> listPackageTypes = new ArrayList<PackageTypeMembers>();DocumentBuilder db =

DocumentBuilderFactory.newInstance().newDocumentBuilder();InputStream inputStream = new FileInputStream(file);Element d = db.parse(inputStream).getDocumentElement();for (Node c = d.getFirstChild(); c != null; c = c.getNextSibling()) {

if (c instanceof Element) {Element ce = (Element) c;NodeList nodeList = ce.getElementsByTagName("name");if (nodeList.getLength() == 0) {

continue;}String name = nodeList.item(0).getTextContent();NodeList m = ce.getElementsByTagName("members");List<String> members = new ArrayList<String>();for (int i = 0; i < m.getLength(); i++) {

Node mm = m.item(i);members.add(mm.getTextContent());

}PackageTypeMembers packageTypes = new PackageTypeMembers();packageTypes.setName(name);packageTypes.setMembers(members.toArray(new String[members.size()]));listPackageTypes.add(packageTypes);

}}packageManifest = new com.sforce.soap.metadata.Package();PackageTypeMembers[] packageTypesArray =

new PackageTypeMembers[listPackageTypes.size()];packageManifest.setTypes(listPackageTypes.toArray(packageTypesArray));packageManifest.setVersion(API_VERSION + "");return packageManifest;

13


}}

14


メタデータ API の使用

第 3 章メタデータのリリースと取得

メタデータを Salesforce 組織とローカルファイルシステム間で移動するには、deploy()コールと retrieve()

コールを使用します。ファイルシステムに XML ファイルを取得すると、ソースコード制御システムでの変更管理、コードまたは設定・定義のコピーと貼り付け、コンポーネントへの変更の diff 出力、およびその他多数のファイルベース開発操作の実行を行えるようになります。これらの変更は、随時別の Salesforce 組織にリリースできます。

メモ: Force.com IDE および Force.com 移行ツールは、deploy()コールと retrieve()コールを使用して、メタデータを移動します。これらのツールを使用する場合、メタデータ API を使用した操作をバックグラウンドでシームレスに行えます。そのため、ほとんどの開発者は、deploy()とretrieve()を直接コールするコードを作成するよりも、これらのツールを使用するほうがより簡単だと考えます。

XML ファイルのデータは、英語 (米国) ロケールで書式設定されます。こうすることによって、異なる言語を使用する組織間でデータを移行するときに、ロケールに依存する日付項目などの項目が一貫して解釈されます。組織は、ユーザに表示するための複数の言語をサポートできます。deploy()コールと retrieve()コールは、主に、次の開発状況で使用されます。• sandbox組織でのカスタムアプリケーション (またはカスタマイズ) の開発。開発およびテストが完了すると、

アプリケーションまたはカスタマイズはメタデータ API を使用して本番組織にリリースされます。• Developer Edition 組織でのアプリケーションのチーム開発。開発とテストが完了すると、Force.com AppExchange

を介してアプリケーションを配布できます。

関連リンクMetadata コンポーネントおよびメタデータ型サポートされていないメタデータ型

Zip ファイルの使用deploy()コールと retrieve()コールは、.zip ファイルをリリースおよび取得するために使用されます。.zipファイル内には、取得またはリリースする項目の一覧を示すプロジェクトマニフェスト (package.xml)やフォルダに整理された 1 つ以上の XML コンポーネントが含まれます。

15

メモ: コンポーネントは、メタデータ型のインスタンスです。たとえば、CustomObjectはカスタムオブジェクトのメタデータ型で、MyCustomObject__cコンポーネントはカスタムオブジェクトのインスタンスです。

.zip で取得またはリリースされるファイルは、組織内にあるパッケージ化されていないコンポーネント (標準オブジェクトなど)、または指定したパッケージ内にあるパッケージコンポーネントである場合があります。

メモ: メタデータ API は、一度に最大 5,000 個のファイルまたは最大 400 MB をリリースおよび取得できます。特定のファイルサイズ制限が適用されていない場合は、非常に大きいファイルではメモリ不足エラーが発生する可能性があります。

各 .zip ファイルには、プロジェクトマニフェスト、package.xmlという名前のファイル、およびコンポーネントを含むディレクトリのセットが含まれます。マニフェストファイルは、.zip ファイルで取得またはリリースしようとしているコンポーネント、およびリリースまたは取得で使用される API バージョンを定義します。package.xmlファイルのサンプルを次に示します。members要素に fullName項目値を指定して、メタデータ型の個別のコンポーネントを取得できます。または、<members>*</members>を使用して、メタデータ型のすべてのコンポーネントを取得することもできます。


<types><members>MyCustomObject__c</members><name>CustomObject</name>

</types><types>


</types><types>

<members>Standard</members><name>Profile</name>


</Package>

次の要素は、package.xmlに定義されている場合があります。• <fullName>には、サーバ側パッケージの名前が含まれます。<fullName>が存在しない場合、これは、クラ

イアント側の unpackagedパッケージです。• <types>には、取得またはリリースされるメタデータ型の名前 (CustomObjectなど) および指定メンバー

(myCustomObject__cなど) が含まれます。マニフェストファイルには複数の <types>要素が含まれる場合があり、各指定コンポーネントあたり 1 つのエントリと個々のメンバーあたり 1 つのエントリがあります。

• <members>には、MyCustomObject__cなど、コンポーネントの fullNameが含まれます。listMetadata()

コールは、個々のコンポーネントを取得する場合に、特定のメタデータ型のコンポーネントの fullNameを特定する場合に役立ちます。多くのメタデータ型の場合、各メンバーを個別に書き出す代わりに、members

の値をワイルドカード文字 * (アスタリスク) に置き換えることができます。ワイルドカード文字を使用できるメタデータ型のリストについては、メタデータ型の「ワイルドカード (*) を使用できるか」の列を参照してください。

メモ: SecuritySettings コンポーネントの種類を取得する場合には、<members>要素で Security を指定し、name 要素で Settings を指定します。

16

Zip ファイルの使用メタデータのリリースと取得

• <name>には、CustomObjectまたはProfileなどのメタデータ型が含まれます。ディレクトリの各メタデータ型には 1 つの名前が定義されています。Metadata を拡張するすべてのメタデータ型は有効な値です。入力される名前は、メタデータ API WSDL に定義されているメタデータ型に一致する必要があります。リストについては、「メタデータ型」を参照してください。

• <version>は、.zip ファイルをリリースまたは取得するときに使用される API のバージョン番号です。現在のところ、有効な値は 31.0です。

異なるメタデータのサブセットを使用する方法を説明した package.xmlマニフェストファイルのその他のサンプルは、「package.xmlマニフェストファイルのサンプル」を参照してください。項目を削除するには、同じ手順を実行します。ただし、destructiveChanges.xmlという名前のマニフェストファイルの削除も含めてください。ごみ箱をスキップするには、「purgeOnDelete」を参照してください。destructiveChanges.xmlの形式はpackage.xmlと同じです。ただし、ワイルドカードはサポートされていません。

メモ: 組織に存在しない複数のコンポーネントがファイルに含まれる場合でも、指定した項目のうち組織に存在する項目は削除されます。

削除対象の単一のカスタムオブジェクトを指定しているサンプルの destructiveChanges.xmlファイルを次に示します。



</types></Package>

この破壊的な変更をリリースするためには、リリースするコンポーネントがリストされておらず、API バージョンを含み、destructiveChanges.xmlと同じディレクトリ内にある package.xmlファイルも必要です。


<version>31.0</version></Package>

関連リンクメタデータ型

package.xmlマニフェストファイルのサンプルこのセクションには、異なるメタデータのサブセットを使用する方法を説明するpackage.xmlマニフェストファイルのサンプルが含まれます。マニフェストファイルには、複数の <types>要素を含めることができるため、1つのバッチですべてのメタデータを使用する場合は、個々のサンプルを 1 つの package.xmlマニフェストファイルに組み入れることができます。マニフェストファイルの構造についての詳細は、「Zip ファイルの使用」を参照してください。次のサンプルがリストされています。• 標準オブジェクト

17

package.xml マニフェストファイルのサンプルメタデータのリリースと取得

• すべてのカスタムオブジェクト• 標準選択リスト項目• カスタム項目および標準項目• 標準オブジェクトのリストビュー• パッケージ• セキュリティ設定• 割り当てルール、自動レスポンスルール、エスカーレーションルール• 管理コンポーネントへのアクセス

標準オブジェクトこのpackage.xmlマニフェストファイルのサンプルでは、標準の Account オブジェクトの使用方法を示します。標準オブジェクトの取得またはリリースには、カスタマイズできない標準項目を除き、すべてのカスタム項目および標準項目が含まれます。すべてのカスタム項目がサポートされます。カスタマイズできる標準項目 (ヘルプテキストを追加したり、履歴追跡や Chatter フィード追跡を有効にできる標準項目) のみがポートされます。システム項目 (CreatedById、LastModifiedDateなど)、自動採番項目を含む、その他の標準項目はサポートされません。


<types><members>Account</members><name>CustomObject</name>


</Package>

CustomObject タイプのメンバーとして標準の Account オブジェクトを指定することによって、どのようにそれを使用するかを確認してください。ただし、アスタリスクワイルドカードを使用してすべての標準オブジェクトを使用することはできません。それぞれの標準オブジェクトを名前で指定する必要があります。

すべてのカスタムオブジェクトこの package.xmlマニフェストファイルのサンプルでは、すべてのカスタムオブジェクトの使用方法を示します。




</Package>

このマニフェストファイルは、すべてのカスタムオブジェクトを取得またはリリースするために使用できます。これには、すべての標準オブジェクトは含まれません。

18


標準選択リスト項目この package.xmlマニフェストファイルのサンプルでは、標準の Account オブジェクトの [業種]選択リスト項目を使用する方法を示します。


<types><members>Account.Industry</members><name>CustomField</name>


</Package>

<members>項目の objectName.picklistField構文において、objectNameは Accountなどのオブジェクトの名前で、picklistFieldは [業種]などの標準選択リスト項目名です。このサンプルのマニフェストファイル package.xmlでは、OpportunityTeamMember オブジェクトのTeamMemberRole選択リストの項目値を使用して、商談チーム内の役割 (取引先チーム内の役割と同じ選択リストの値) を取得する方法を示します。これらの値を取得するには、組織でチームセリングを有効にする必要があります。


<types><members>OpportunityTeamMember.TeamMemberRole</members><name>CustomField</name>


</Package>

メモ: 取得およびリリースできるのは、カスタム項目と標準選択リスト項目および標準参照項目のみで、他の標準項目はできません。

カスタム項目および標準項目この package.xmlマニフェストファイルのサンプルでは、カスタムオブジェクトおよび標準オブジェクトのカスタム項目や標準オブジェクトの標準項目の使用方法を示します。


<types><members>MyCustomObject__c.MyCustomField__c</members><name>CustomField</name>

</types><types>

<members>Account.SLA__c</members><members>Account.Phone</members><name>CustomField</name>


</Package>

<members>項目の objectName.field構文において、objectNameは、Account などのオブジェクトの名前で、fieldは、サービスレベル契約オプションを表すSLA選択リスト項目などのカスタム項目または標準項目の名前です。MyCustomObject カスタムオブジェクトの MyCustomFieldカスタム項目は、その完全名

19


MyCustomObject__c.MyCustomField__cによって一意に識別されます。同様に、Account 標準オブジェクトのPhone標準項目は、その完全名 Account.Phoneによって一意に識別されます。すべてのカスタム項目がサポートされます。カスタマイズできる標準項目 (ヘルプテキストを追加したり、履歴追跡や Chatter フィード追跡を有効にできる標準項目) のみがポートされます。システム項目 (CreatedById、LastModifiedDateなど)、自動採番項目を含む、その他の標準項目はサポートされません。

標準オブジェクトのリストビュー標準オブジェクトのリストビューを取得する最も簡単な方法は、オブジェクトを取得することです。リストビューは、取得されたコンポーネントに含まれます。「標準オブジェクト」 (ページ 18)を参照してください。また、オブジェクトのすべての詳細情報を取得しない場合は、個々のリストビューを使用することもできます。この package.xmlマニフェストファイルのサンプルでは、標準の Account オブジェクトのリストビューの使用方法を示します。


<types><members>Account.AccountTeam</members><name>ListView</name>


</Package>

<members>項目の objectName.listViewUniqueName構文において、objectNameは、Account などのオブジェクトの名前で、listViewUniqueNameは、リストビューの[ビューの一意の名前]です。リストビューを取得すると、コンポーネントは、objects/Account.objectに保存されます。

パッケージパッケージを取得するには、retrieve()をコールするときに、RetrieveRequestのpackageNames項目にパッケージの名前を設定します。package.xmlマニフェストファイルは、取得された.zipファイルに自動的に格納されます。package.xmlの <fullName>要素には、取得されたパッケージの名前が含まれます。<members>要素にアスタリスクワイルドカードを使用して特定のメタデータ型のすべてのコンポーネントを取得する場合、取得されたコンテンツには管理パッケージのコンポーネントは含まれません。管理パッケージのコンポーネントを取得する最も簡単な方法は、前述のように、RetrieveRequestのpackageNames

項目にパッケージの名前を設定することによって完全なパッケージを取得する方法です。次の package.xmlマニフェストファイルのサンプルでは、パッケージの個々のコンポーネントを取得する代替方法を示します。


<types><members>myns__MyCustomObject__c</members><name>CustomObject</name>


</Package>

<members>項目の namespacePrefix__objectName構文において、namespacePrefixは、パッケージの名前空間プレフィックスで、objectNameはオブジェクトの名前です。名前空間プレフィックスは、パッケージおよびそのコンテンツとその他の公開者のパッケージを区別する 1 ～ 15 文字の英数字で構成される識別子です。名前空間プレフィックスについての詳細は、Salesforceオンラインヘルプの「名前空間プレフィックスの登録」を参照してください。

20


セキュリティ設定この package.xmlマニフェストファイルのサンプルでは、組織のセキュリティ設定の使用方法を示します。SecuritySettings コンポーネントの種類を取得する場合には、<members>要素で Security を指定し、name 要素でSettings を指定します。


<types><members>Security</members><name>Settings</name>


</Package>

割り当てルール、自動レスポンスルール、エスカーレーションルール割り当てルール、自動レスポンスルール、およびエスカレーションルールでは、オブジェクト種別の一連のまたは個別のルールにアクセスするために、さまざまなpackage.xml型名が使用されます。たとえば、package.xml

マニフェストファイルの次のサンプルは、組織のケースとリードのみの割り当てルールにアクセスする方法を示しています。


<types><members>Case</members><members>Lead</members><name>AssignmentRules</name>


</Package>

package.xmlマニフェストファイルの次のサンプルは、Case の「samplerule」割り当てルールとリードの「newrule」割り当てルールのみにアクセスする方法を示しています。型名はAssignmentRulesではなく、AssignmentRule

です。


<types><members>Case.samplerule</members><members>Lead.newrule</members><name>AssignmentRule</name>


</Package>

同様に、個々の自動レスポンスルールとエスカレーションルールにアクセスする場合は、AutoResponseRules

と EscalationRulesの代わりに AutoResponseRuleと EscalationRuleを使用します。

管理コンポーネントへのアクセスAPIバージョン 29.0 以降では、プロファイルと権限セットで、次の管理コンポーネントのアクセス設定を取得およびリリースできるようになりました。• Apex クラス• アプリケーション• カスタム項目権限

21


• カスタムオブジェクト権限• カスタムタブの設定• 外部データソース• レコードタイプ• Visualforce ページ管理コンポーネントの権限を取得してリリースする場合は、名前空間とそれに続く 2 つのアンダースコアを指定します。ワイルドカードはサポートされていません。たとえば、MyNamespaceという名前空間とJobRequest__cというカスタムオブジェクトを使用して、管理パッケージをインストールするとします。パッケージの JobRequest__cのオブジェクト権限を、カスタムプロファイル MyProfile に対して設定するには、.profileファイルに次のコードを追加します。リリースするには、次のコードを使用します。

<objectPermissions><allowCreate>true</allowCreate><allowDelete>true</allowDelete><allowEdit>true</allowEdit><allowRead>true</allowRead><viewAllRecords>false</viewAllRecords><modifyAllRecords>false</modifyAllRecords><object>MyNamespace__JobRequest__c</object>

</objectPermissions>

取得するには、次のコードを使用します。

<types><members>MyNamespace__JobRequest__c</members><name>CustomObject</name>

</types><types>

<members>MyProfile</members><name>Profile</name>

</types>

リリースでのテストの実行本番組織へのリリースの場合、インストール済みの管理パッケージから作成されたテストを除く組織のすべてのテストは、自動的に実行されます。テストのいずれかが失敗した場合は、リリース全体がロールバックされます。リリースに次のメタデータ型のコンポーネントが含まれている場合は、テストはすべて自動的に実行されます。• ApexClass

• ApexComponent

• ApexPage

• ApexTrigger

• ArticleType

• BaseSharingRule

• CriteriaBasedSharingRule

• CustomDataType

• CustomField

22

リリースでのテストの実行メタデータのリリースと取得

• CustomObject

• DataCategoryGroup

• Flow

• InstalledPackage

• NamedFilter

• OwnerSharingRule

• PermissionSet

• Profile

• Queue

• RecordType

• RemoteSiteSetting

• Role

• SharingReason

• Territory

• Validation Rules

• Workflow

たとえば、次のリリースではテストは実行されません。• 1 個の CustomApplication コンポーネント• 100 個の Report コンポーネントおよび 40 個の Dashboard コンポーネント

次のリリースではすべてのテストが自動的に実行されます。• 1 個の CustomField コンポーネント• 1 個の ApexComponent コンポーネントおよび 1 個の ApexClass コンポーネント• 5 個の CustomField コンポーネントおよび 1 個の ApexPage コンポーネント• 100 個の Report コンポーネント、40 個の Dashboard コンポーネント、および 1 個の CustomField コンポーネ

ント

関連リンクdeploy()

ユーザ参照の保持ユーザ項目は、メタデータのリリース中に保持されます。ワークフローメール通知の受信者やダッシュボード実行ユーザなど、リリース時にコンポーネントで特定のユーザを参照すると、リリース中にユーザ名を比較することにより対象組織で一致するユーザが Salesforce によって検索されます。たとえば、データを Sandbox にコピーする場合、ユーザ名を含む本番組織の項目は Sandbox 名を含むように変更されます。testという名前のSandboxの場合、ユーザ名[email protected]は[email protected]になります。Sandbox のメタデータを別の組織にリリースする場合、ユーザ名に含まれる testは無視されます。リリース時のユーザ参照では、Salesforce で次の順に処理が行われます。

1. ソース環境とターゲット環境でユーザ名が比較され、組織のドメイン名が適用されます。

23

ユーザ参照の保持メタデータのリリースと取得

2. 一致するユーザ名が複数存在すると、一致する名前が一覧表示され、ソース環境のいずれか 1 つのユーザ名を変更するよう要求されます。

3. ソース環境のユーザ名がターゲット環境に存在しない場合はエラーが表示され、ユーザ名を削除するかターゲット環境のユーザに解決するまでリリースは停止します。

24

ユーザ参照の保持メタデータのリリースと取得

第 4 章CRUD ベースのメタデータ開発

組織またはアプリケーションの設定・定義コンポーネントを作成、更新、または削除するには、CRUD ベースのメタデータコールを使用します。これらの設定コンポーネントには、カスタムオブジェクト、カスタム項目、およびその他の設定メタデータが含まれます。メタデータコールは、コンポーネントの作成、更新、または削除について、Salesforceユーザインターフェースの動作を模倣します。適用されるすべてのルールは、これらのコールにも適用されます。メタデータコールは、コアの同期 API コールとは次の点で異なります。• メタデータ API コールは、別の WSDL で使用できます。WSDL をダウンロードするには、Salesforce にログ

インし、[設定] で [開発] > [API] をクリックして、[メタデータ WSDL のダウンロード] リンクをクリックします。

• ログイン後、SOAP API 以外の URL を持つメタデータ API エンドポイントにメタデータ API コールを送信する必要があります。SOAP API login()コールによって返される LoginResult から metadataServerUrlを取得します。SOAP API についての詳細は、『SOAP API 開発者ガイド』を参照してください。

• メタデータコールには、同期と非同期があります。API バージョン 30.0 以降では、CRUD コールは同期で、API コアコールと同様に 1 つのコールで結果が返されます。以前の API バージョンでは、作成、更新、および削除は非同期のみであるため、結果は 1 つのコールですぐに返されません。

• 対応するコアの SOAP API 同期コールに対応付けられた同期メタデータコールがあります。◊ createMetadata()は、create() SOAP API コールに対応付けられます。◊ updateMetadata()は、update() SOAP API コールに対応付けられます。◊ deleteMetadata()は、delete() SOAP API コールに対応付けられます。

メモ: メタデータ API は、メタデータコンポーネントの取得とリリースを行う retrieve()コールとdeploy()コールもサポートしています。詳細は、「メタデータのリリースと取得」を参照してください。

同期コールを使用した CRUD ベース開発用の Java サンプルこのセクションでは、CRUD ベースのコールを使用する Java クライアントアプリケーションのサンプルについて説明します。このサンプルアプリケーションでは、次の主要なタスクを実行します。1. MetadataLoginUtil.javaクラスを使用し、Metadata 接続を作成します。詳細は、「ステップ 3: Java サンプ

ルコードの説明」を参照してください。2. カスタムオブジェクトを作成するには、createMetadata()をコールします。このコールは、1 つのコール

で結果を返します。

25


3. 返される SaveResultオブジェクトを調べて、操作に成功したかどうかを確認し、成功していなかった場合はコンポーネント名、エラーメッセージ、および状況コードを出力に書き込みます。


/*** Sample that logs in and creates a custom object through the metadata API*/public class CRUDSampleCreate {



public CRUDSampleCreate() {}

public static void main(String[] args) throws Exception {CRUDSampleCreate crudSample = new CRUDSampleCreate();crudSample.runCreate();

}

/*** Create a custom object. This method demonstrates usage of the* create() and checkStatus() calls.** @param uniqueName Custom object name should be unique.*/private void createCustomObjectSync(final String uniqueName) throws Exception {

final String label = "My Custom Object";CustomObject co = new CustomObject();co.setFullName(uniqueName);co.setDeploymentStatus(DeploymentStatus.Deployed);co.setDescription("Created by the Metadata API Sample");co.setEnableActivities(true);co.setLabel(label);co.setPluralLabel(label + "s");co.setSharingModel(SharingModel.ReadWrite);

// The name field appears in page layouts, related lists, and elsewhere.CustomField nf = new CustomField();nf.setType(FieldType.Text);nf.setDescription("The custom object identifier on page layouts, related lists

etc");nf.setLabel(label);nf.setFullName(uniqueName);customObject.setNameField(nf);

SaveResult[] results = metadataConnection.createMetadata(new Metadata[] { co });

for (SaveResult r : results) {if (r.isSuccess()) {

System.out.println("Created component: " + r.getFullName());} else {

System.out.println("Errors were encountered while creating "

+ r.getFullName());for (Error e : r.getErrors()) {

System.out.println("Error message: " + e.getMessage());System.out.println("Status code: " + e.getStatusCode());

}}

}}

private void runCreate() throws Exception {metadataConnection = MetadataLoginUtil.login();

26

CRUD ベースのメタデータ開発

// Custom objects and fields must have __c suffix in the full name.final String uniqueObjectName = "MyCustomObject__c";createCustomObjectSync(uniqueObjectName);

}}

非同期コールを使用した CRUD ベース開発用の Java サンプル重要: このセクションのサンプルでは、非同期 create() CRUD コールを使用します。非同期 CRUDコールは API バージョン 31.0 で使用できなくなりました。それより前の API バージョンでのみ使用できます。

このセクションでは、非同期 CRUD ベースのコールを使用する Java クライアントアプリケーションのサンプルについて説明します。このサンプルアプリケーションでは、次の主要なタスクを実行します。1. MetadataLoginUtil.javaクラスを使用し、Metadata 接続を作成します。詳細は、「ステップ 3: Java サンプ

ルコードの説明」を参照してください。2. 新しいカスタムオブジェクトを作成するには、create()をコールします。

Salesforceでは、作成しようとしたコンポーネントごとにAsyncResultオブジェクトが返されます。AsyncResultオブジェクトは、操作がキューから完了またはエラー状態に移行するたびに、状況情報で更新されます。

3. AsyncResult の状況値が create 操作が完了したことを示すまで、ループで checkStatus()をコールします。API コールに続く、エラー処理コードに注意してください。


/*** Sample that logs in and creates a custom object through the metadata api*/public class CRUDSample {



public CRUDSample() {}

public static void main(String[] args) throws Exception {CRUDSample crudSample = new CRUDSample();crudSample.runCreate();

}

/*** Create a custom object. This method demonstrates usage of the* create() and checkStatus() calls.** @param uniqueName Custom object name should be unique.*/private void createCustomObject(final String uniqueName) throws Exception {

final String label = "My Custom Object";CustomObject customObject = new CustomObject();customObject.setFullName(uniqueName);customObject.setDeploymentStatus(DeploymentStatus.Deployed);customObject.setDescription("Created by the Metadata API Sample");customObject.setLabel(label);customObject.setPluralLabel(label + "s");customObject.setSharingModel(SharingModel.ReadWrite);

// The name field appears in page layouts, related lists, and elsewhere.CustomField nf = new CustomField();

27


nf.setType(FieldType.Text);nf.setDescription("The custom object identifier on page layouts, related lists

etc");nf.setLabel(label);nf.setFullName(uniqueName);customObject.setNameField(nf);

AsyncResult[] asyncResults = metadataConnection.create(new CustomObject[]{customObject});

if (asyncResults == null) {System.out.println("The object was not created successfully");return;

}

long waitTimeMilliSecs = ONE_SECOND;

// After the create() call completes, we must poll the results of the checkStatus()

// call until it indicates that the create operation has completed.do {

printAsyncResultStatus(asyncResults);waitTimeMilliSecs *= 2;Thread.sleep(waitTimeMilliSecs);asyncResults = metadataConnection.checkStatus(new

String[]{asyncResults[0].getId()});} while (!asyncResults[0].isDone());

printAsyncResultStatus(asyncResults);}

private void printAsyncResultStatus(AsyncResult[] asyncResults) throws Exception {if (asyncResults == null || asyncResults.length == 0 || asyncResults[0] == null)

{throw new Exception("The object status cannot be retrieved");

}

AsyncResult asyncResult = asyncResults[0]; //we are creating only 1 metadata object

if (asyncResult.getStatusCode() != null) {System.out.println("Error status code: " +

asyncResult.getStatusCode());System.out.println("Error message: " + asyncResult.getMessage());

}

System.out.println("Object with id:" + asyncResult.getId() + " is " +asyncResult.getState());

}

private void runCreate() throws Exception {metadataConnection = MetadataLoginUtil.login();// Custom objects and fields must have __c suffix in the full name.final String uniqueObjectName = "MyCustomObject__c";createCustomObject(uniqueObjectName);

}}

28


第 5 章エラー処理

メタデータ APIコールは、クライアントアプリケーションがランタイムエラーを識別し解決するために使用できるエラー情報を返します。メタデータ API は次のタイプのエラー処理を提供します。• メタデータ API は認証のために Enterprise WSDL または Partner WSDL を使用するため、不正なフォームの

メッセージ、失敗した認証、または同様の問題によるエラーのためにこれらの WSDL で定義されている SOAPエラーメッセージを使用します。各 SOAP エラーには関連付けられた ExceptionCode があります。詳細は、『SOAP API 開発者ガイド』の「エラー処理」を参照してください。

• 非同期 create()、update()、および delete()でのエラーについては、関連付けられているコンポーネントの AsyncResult オブジェクトの statusCode項目のエラー状況コードを参照してください。

• 同期 CRUD コールでのエラーについては、該当する結果オブジェクトの errors項目で返される配列内の各エラーに対応する Error オブジェクトの statusCode項目のエラー状況コードを参照してください。たとえば、createMetadata()の結果オブジェクトは、SaveResult です。

• deploy()でのエラーについては、関連付けられているコンポーネントの DeployMessage オブジェクトのproblem項目および success項目を参照してください。

• retrieve()でのエラーについては、関連付けられているコンポーネントの RetrieveMessage オブジェクトのproblem項目を参照してください。

サンプルコードについては、「ステップ 3: Java サンプルコードの説明」 (ページ 7)を参照してください。

セッション終了のエラー処理login()コールでサインオンする場合、新しいクライアントセッションが開始し、対応する一意のセッションID が生成されます。セッションは、Salesforce アプリケーションの [セキュリティのコントロール] の設定領域で指定されている時間 (デフォルトは 2 時間) が経過すると、自動的に期限切れになります。セッションが終了すると、例外コード INVALID_SESSION_ID が返されます。この場合、login()コールを再度呼び出す必要があります。login()についての詳細は、『SOAP API 開発者ガイド』を参照してください。

29



参照

第 6 章ファイルベースのコール

XML コンポーネントをリリースまたは取得するには、次のファイルベースのコールを使用します。• deploy()

• retrieve()

deploy()

ファイル表現のコンポーネントを使用して、組織のファイル表現のコンポーネントを作成、更新、または削除します。

構文

AsyncResult = metadatabinding.deploy(base64 zipFile, DeployOptions deployOptions)

使用方法このコールを使用して、ファイル表現のコンポーネントを取得し、ファイル表現のコンポーネントが表すコンポーネントを作成、更新、または削除することにより、組織にファイル表現のコンポーネントをリリースします。


API バージョン 29.0 では、Salesforceは、リリース状況プロパティを改善し、deploy()コール後にリリースに関する情報を取得するために checkStatus()を使用する要件を削除しました。Salesforce では、API バージョン28.0 以前で deploy()を使用する場合の checkStatus()の使用を引き続きサポートします。API バージョン 29.0 以降の場合、次の手順に従って、パッケージ化されたコンポーネントまたはパッケージ化されていないコンポーネントをリリース (作成または更新) します。1. deploy()コールを発行して、非同期リリースを開始すると、AsyncResult オブジェクトが返されます。id項

目の値をメモし、次のステップで使用します。2. checkDeployStatus()コールの発行を、返される DeployResult の done項目がコールの完了を示す trueに

なるまでループします。DeployResult オブジェクトには、deploy()コールを使用して開始された進行中また

30

は完了済みのリリースに関する情報が含まれます。checkDeployStatus()をコールするとき、最初のステップの AsyncResult オブジェクトから id値を渡します。

API バージョン 28.0 以前の場合、次の手順に従って、パッケージ化されたコンポーネントまたはパッケージ化されていないコンポーネントをリリース (作成または更新) します。1. deploy()コールを発行して、非同期リリースを開始すると、AsyncResult オブジェクトが返されます。コー

ルが完了すると、done項目に trueが含まれます。ほとんどの場合、コールはすぐに完了しないため最初の結果に記述されません。完了している場合、返されたid項目の値を書き留め、次のステップを省略します。

2. コールが完了していない場合、前のステップでdeploy()コールから返されたAsyncResultオブジェクトのid

項目の値を使用して、ループで checkStatus()コールを発行します。done項目に trueが含まれるまで、返される AsyncResult オブジェクトを確認します。deploy()コールを完了するまでにかかる時間は、リリースされる zip ファイルのサイズによって異なるため、zip ファイルのサイズが大きくなるほど、反復間の待機時間をより長くする必要があります。

3. 最初のステップで返された id値を使用して、checkDeployStatus()コールを発行し、deploy()コールの結果を取得します。

項目を削除するには、同じ手順を実行します。ただし、destructiveChanges.xmlという名前のマニフェストファイルの削除も含めてください。ごみ箱をスキップするには、「purgeOnDelete」を参照してください。destructiveChanges.xmlの形式はpackage.xmlと同じです。ただし、ワイルドカードはサポートされていません。

メモ: 組織に存在しない複数のコンポーネントがファイルに含まれる場合でも、指定した項目のうち組織に存在する項目は削除されます。

削除対象の単一のカスタムオブジェクトを指定しているサンプルの destructiveChanges.xmlファイルを次に示します。



</types></Package>

この破壊的な変更をリリースするためには、リリースするコンポーネントがリストされておらず、API バージョンを含み、destructiveChanges.xmlと同じディレクトリ内にある package.xmlファイルも必要です。


<version>31.0</version></Package>

処理中または過去 30 日間で完了したリリースの状況を追跡するには、[設定] で [リリース状況] または [リリース] > [リリース状況] をクリックします。進行中またはキュー内のリリースは、リリースの横にある [キャンセル]をクリックしてキャンセルできます。リリースが完全にキャンセルされるまで、リリースの状況は Cancel Requestedになります。キャンセルされたリリースは、[失敗] セクションにリストされます。

権限クライアントアプリケーションは、「すべてのデータの編集」権限でログインしている必要があります。

31

deploy()ファイルベースのコール

引数

説明型名前Base 64 で符号化されたバイナリデータクライアントアプリケーションは、バイナリデータを base64 に符号化する必要があります。

base64zipFile

リリースするパッケージまたはファイルを特定するためのオプションをカプセル化します。

DeployOptionsdeployOptions

DeployOptions

このコールでは次のリリースオプションを選択できます。

説明型名前ファイルが package.xmlでは指定されているが、.zipファイルにはない場合でもリリースを継続するか (true)、否か (false) を指定します。本番組織へのリリースでは、この引数を設定することはできません。

booleanallowMissingFiles

ファイルが.zipファイルにはあるが、package.xml

で指定されていない場合、ファイルを自動的にパッbooleanautoUpdatePackage

ケージに追加するか (true)、否か (false) を指定します。.zipファイルを含む package.xmlが更新された場合は、retrieve()が自動的に発行されます。本番組織へのリリースでは、この引数を設定することはできません。

Apexクラスおよびトリガをリリースの一部として組織に保存するか (false)、否か (true) を示します。

booleancheckOnly

デフォルトはfalseです。発行済みのエラーまたはメッセージもすべて生成されます。このパラメータは、Salesforce Ant ツールの checkOnlyパラメータと似ています。警告を無視してリリースの正常な完了を許可するか(true)、否か (false) を示します。デフォルトはfalseです。警告の DeployMessage オブジェクトには次の値が含まれます。

booleanignoreWarnings

• problemType—Warning

• problem — 警告のテキスト警告が発生し、ignoreWarningsが trueに設定されている場合は、DeployMessage の success項目はtrueです。ignoreWarningsが falseに設定されている場合、successは falseに設定され、警告はエラーとして処理されます。

32


説明型名前この項目は API バージョン 18.0 以降で使用できます。バージョン 18.0 より前では、警告とエラーは区別されていませんでした。すべての問題はエラーとして処理され、リリースの成功を妨げていました。

retrieve()コールをリリース直後に実行するか(true)、否か (false) を示します。リリース直後のものをすべて取得するには trueに設定します。

booleanperformRetrieve

trueの場合、destructiveChanges.xmlマニフェストファイルの削除されたコンポーネントはごみ箱

booleanpurgeOnDelete

に保存されません。代わりに、即座に削除の対象となります。この項目は API バージョン 22.0 以降で使用できます。このオプションは Developer Edition 組織またはSandbox 組織でのみ機能しますが、本番組織では機能しません。

エラーが発生した場合、ロールバックを完了するか(true)、否か (false) を示します。falseの場合、

booleanrollbackOnError

エラーなしで実行できるアクションのセットはすべて実行され、残りのアクションではエラーが返されます。本番組織にリリースする場合は、このパラメータは trueに設定されている必要があります。デフォルトは、falseです。trueの場合、組織で定義されているすべての Apexテストが実行されます。本番組織へのリリースの場合、インストール済みの管理パッケージから作成されたテストを除くすべて

booleanrunAllTests

のテストは、この引数に関係なく自動的に実行されます。rollbackOnErrorパラメータが true に設定されているときにテストのいずれかが失敗した場合は、リリース全体がロールバックされます。

リリース時に実行される Apex テストのリスト。クラス名 (1 インスタンスあたり 1 つの名前) を指定し

string[]runTests

ます。また、クラス名にはドット付きの名前空間を指定することもできます。たとえば、3 つのテストを実行するには、次のコードを使用します。

<runTests>positive_test</runTests><runTests>negative_test</runTests><runTests>namespace.third_test</runTests>

rollbackOnErrorパラメータがtrueに設定されているときにこれらのテストのいずれかが失敗した場

33


説明型名前合は、リリースがロールバックされ、組織への変更は行われません。

指定された .zipファイルが指し示すディレクトリ構造が 1 つのパッケージを持つか (true)、パッケージのセットを持つか (false)) を示します。

booleansinglePackage

応答AsyncResult

サンプルコード —Java

このサンプルでは、zip ファイルでコンポーネントをリリースする方法を示します。zip ファイルの取得方法についての詳細は、retrieve()のサンプルコードを参照してください。

package com.doc.samples;

import java.io.*;

import java.rmi.RemoteException;

import com.sforce.soap.metadata.AsyncResult;import com.sforce.soap.metadata.DeployDetails;import com.sforce.soap.metadata.MetadataConnection;import com.sforce.soap.metadata.DeployOptions;import com.sforce.soap.metadata.DeployResult;import com.sforce.soap.metadata.DeployMessage;import com.sforce.soap.metadata.RunTestsResult;import com.sforce.soap.metadata.RunTestFailure;import com.sforce.soap.metadata.CodeCoverageWarning;import com.sforce.soap.enterprise.LoginResult;import com.sforce.soap.enterprise.EnterpriseConnection;import com.sforce.ws.ConnectionException;import com.sforce.ws.ConnectorConfig;

/*** Deploy a zip file of metadata components.* Prerequisite: Have a deploy.zip file that includes a package.xml manifest file that* details the contents of the zip file.*/public class DeploySample {

// binding for the metadata WSDL used for making metadata API callsprivate MetadataConnection metadataConnection;

static BufferedReader rdr = new BufferedReader(new InputStreamReader(System.in));

private static final String ZIP_FILE = "deploy.zip";

// one second in millisecondsprivate static final long ONE_SECOND = 1000;// maximum number of attempts to deploy the zip fileprivate static final int MAX_NUM_POLL_REQUESTS = 50;

public static void main(String[] args) throws Exception {final String USERNAME = "[email protected]";// This is only a sample. Hard coding passwords in source files is a bad practice.

final String PASSWORD = "password";final String URL = "https://login.salesforce.com/services/Soap/c/29.0";

DeploySample sample = new DeploySample(USERNAME, PASSWORD, URL);

34


sample.deployZip();}

public DeploySample(String username, String password, String loginUrl)throws ConnectionException {

createMetadataConnection(username, password, loginUrl);}

public void deployZip()throws RemoteException, Exception

{byte zipBytes[] = readZipFile();DeployOptions deployOptions = new DeployOptions();deployOptions.setPerformRetrieve(false);deployOptions.setRollbackOnError(true);AsyncResult asyncResult = metadataConnection.deploy(zipBytes, deployOptions);String asyncResultId = asyncResult.getId();

// Wait for the deploy to completeint poll = 0;long waitTimeMilliSecs = ONE_SECOND;DeployResult deployResult = null;boolean fetchDetails;do {

Thread.sleep(waitTimeMilliSecs);// double the wait time for the next iterationwaitTimeMilliSecs *= 2;if (poll++ > MAX_NUM_POLL_REQUESTS) {

throw new Exception("Request timed out. If this is a large set " +"of metadata components, check that the time allowed by " +"MAX_NUM_POLL_REQUESTS is sufficient.");

}

// Fetch in-progress details once for every 3 pollsfetchDetails = (poll % 3 == 0);

deployResult = metadataConnection.checkDeployStatus(asyncResultId, fetchDetails);

System.out.println("Status is: " + deployResult.getStatus());if (!deployResult.isDone() && fetchDetails) {

printErrors(deployResult, "Failures for deployment in progress:\n");}

}while (!deployResult.isDone());

if (!deployResult.isSuccess() && deployResult.getErrorStatusCode() != null) {throw new Exception(deployResult.getErrorStatusCode() + " msg: " +

deployResult.getErrorMessage());}

if (!fetchDetails) {// Get the final result with details if we didn't do it in the last attempt.deployResult = metadataConnection.checkDeployStatus(asyncResultId, true);

}

if (!deployResult.isSuccess()) {printErrors(deployResult, "Final list of failures:\n");throw new Exception("The files were not successfully deployed");

}

System.out.println("The file " + ZIP_FILE + " was successfully deployed");}

/*** Read the zip file contents into a byte array.* @return byte[]* @throws Exception - if cannot find the zip file to deploy*/private byte[] readZipFile()

throws Exception

35


{// We assume here that you have a deploy.zip file.// See the retrieve sample for how to retrieve a zip file.File deployZip = new File(ZIP_FILE);if (!deployZip.exists() || !deployZip.isFile())

throw new Exception("Cannot find the zip file to deploy. Looking for " +deployZip.getAbsolutePath());

FileInputStream fos = new FileInputStream(deployZip);ByteArrayOutputStream bos = new ByteArrayOutputStream();int readbyte = -1;while ((readbyte = fos.read()) != -1) {

bos.write(readbyte);}fos.close();bos.close();return bos.toByteArray();

}

/*** Print out any errors, if any, related to the deploy.* @param result - DeployResult*/private void printErrors(DeployResult result, String messageHeader){

DeployDetails deployDetails = result.getDetails();

StringBuilder errorMessageBuilder = new StringBuilder();if (deployDetails != null) {

DeployMessage[] componentFailures = deployDetails.getComponentFailures();for (DeployMessage message : componentFailures) {

String loc = (message.getLineNumber() == 0 ? "" :("(" + message.getLineNumber() + "," +

message.getColumnNumber() + ")"));if (loc.length() == 0

&& !message.getFileName().equals(message.getFullName())) {loc = "(" + message.getFullName() + ")";

}errorMessageBuilder.append(message.getFileName() + loc + ":" +

message.getProblem()).append('\n');}RunTestsResult rtr = deployDetails.getRunTestResult();if (rtr.getFailures() != null) {

for (RunTestFailure failure : rtr.getFailures()) {String n = (failure.getNamespace() == null ? "" :

(failure.getNamespace() + ".")) + failure.getName();errorMessageBuilder.append("Test failure, method: " + n + "." +

failure.getMethodName() + " -- " +failure.getMessage() + " stack " +failure.getStackTrace() + "\n\n");

}}if (rtr.getCodeCoverageWarnings() != null) {

for (CodeCoverageWarning ccw : rtr.getCodeCoverageWarnings()) {errorMessageBuilder.append("Code coverage issue");if (ccw.getName() != null) {

String n = (ccw.getNamespace() == null ? "" :(ccw.getNamespace() + ".")) + ccw.getName();

errorMessageBuilder.append(", class: " + n);}errorMessageBuilder.append(" -- " + ccw.getMessage() + "\n");

}}

}

if (errorMessageBuilder.length() > 0) {errorMessageBuilder.insert(0, messageHeader);System.out.println(errorMessageBuilder.toString());

36


}}

private void createMetadataConnection(final String username,final String password,final String loginUrl) throws ConnectionException {

final ConnectorConfig loginConfig = new ConnectorConfig();loginConfig.setAuthEndpoint(loginUrl);loginConfig.setServiceEndpoint(loginUrl);loginConfig.setManualLogin(true);LoginResult loginResult = (new EnterpriseConnection(loginConfig)).login(

username, password);

final ConnectorConfig metadataConfig = new ConnectorConfig();metadataConfig.setServiceEndpoint(loginResult.getMetadataServerUrl());metadataConfig.setSessionId(loginResult.getSessionId());this.metadataConnection = new MetadataConnection(metadataConfig);

}

}

checkDeployStatus()cancelDeploy()

関連リンクリリースでのテストの実行

checkDeployStatus()

宣言的なメタデータコール deploy()の状況を確認します。

構文

DeployResult = metadatabinding.checkDeployStatus(ID id, includeDetails boolean);

使用方法checkDeployStatusは、パッケージコンポーネントまたはパッケージ化されていないコンポーネントを組織にリリースするためのプロセスの一部として使用されます。1. deploy()コールを発行して、非同期リリースを開始すると、AsyncResult オブジェクトが返されます。id項

目の値をメモし、次のステップで使用します。2. checkDeployStatus()コールの発行を、返される DeployResult の done項目がコールの完了を示す trueに

なるまでループします。DeployResult オブジェクトには、deploy()コールを使用して開始された進行中または完了済みのリリースに関する情報が含まれます。checkDeployStatus()をコールするとき、最初のステップの AsyncResult オブジェクトから id値を渡します。

API バージョン 29.0 では、Salesforceは、リリース状況プロパティを改善し、deploy()コール後にリリースに関する情報を取得するために checkStatus()を使用する要件を削除しました。Salesforce では、API バージョン28.0 以前で deploy()を使用する場合の checkStatus()の使用を引き続きサポートします。

37

checkDeployStatus()ファイルベースのコール


このコールの使用例は、deploy()のサンプルコードを参照してください。

引数

説明型名前deploy()コールまたは後続の checkDeployStatus()コールによって返される AsyncResult オブジェクトから取得した ID。

IDid

DeployResult オブジェクトが DeployDetails 情報を含むか (true)、否か (false)を設定します。デフォルトは、falseです。API バージョン 29.0 以降で利用できます。

booleanincludeDetails

応答DeployResult

cancelDeploy()

まだ完了していないリリースをキャンセルします。

構文

CancelDeployResult = metadatabinding.cancelDeploy(string id)

使用方法deploy()操作によって開始された組織内のリリースをキャンセルするには、cancelDeploy()操作を使用します。これには、Force.com 移行ツールおよび Force.com IDE によって開始されたリリースが含まれます。リリースは、キュー内で開始待ちの場合や進行中の場合があります。この操作は、キャンセルするリリースの ID を取り、CancelDeployResult オブジェクトを返します。リリースがキュー内にあり、まだ開始していない場合、cancelDeploy()をコールすると即座にリリースがキャンセルされます。リリースがすでに開始し、進行中の場合、すぐにはキャンセルされないこともあるため、checkDeployStatus()をコールしてキャンセル状況をチェックする必要があります。リリースをキャンセルするには、次の手順を実行します。1. キャンセルするリリースの ID を取得します。たとえば、deploy()コールで AsyncResultオブジェクトの

id項目から ID を取得できます。または、Salesforce ユーザインターフェースで、[設定] から [リリース状況]または [リリース] > [リリース状況] をクリックし、API で開始されたリリースの ID を確認しても ID を取得できます。

2. cancelDeploy()コールを発行して、キャンセルプロセスを開始します。このコールは、CancelDeployResult

オブジェクトを返します。3. 返された CancelDeployResultの done項目の値をチェックします。done項目値が trueの場合、リリース

はすでにキャンセルされており、作業は完了しています。done項目値がfalseの場合、キャンセルは進行中であるため、次の手順に従ってキャンセル状況をチェックします。a. すでに取得したリリース ID を使用して checkDeployStatus()をコールします。

38

cancelDeploy()ファイルベースのコール

b. 返された DeployResult オブジェクト内の status項目をチェックします。状況が Cancelingの場合、キャンセルは依然として進行中であるため、手順 a と b を繰り返します。状況が Canceledの場合、リリースはすでにキャンセルされており、作業は完了しています。

deploy()操作は次の API 障害を発生させます。「Invalid deploy ID」というメッセージを含む INVALID_ID_FIELD

指定された ID 引数が有効なリリースに対応していません。

「Deployment already completed」というメッセージを含む INVALID_ID_FIELD

指定されたリリースはすでに完了しています。

バージョンAPI バージョン 30.0 以降で利用できます。


引数

説明型名前キャンセルするリリースの ID。stringid

応答CancelDeployResult


次のサンプルでは、リリースのキャンセル方法を示します。このサンプルは、特定のリリース ID を渡してcancelDeploy()をコールします。次に、キャンセルが完了したかどうかをチェックし、まだの場合はcheckDeployStatusのコールをループします。

public void cancelDeploy(String asyncId) throws Exception {// Issue the deployment cancellation requestCancelDeployResult result = metadataConnection.cancelDeploy(asyncId);

// If the deployment cancellation completed, write a message to the output.if (result.isDone()) {

System.out.println("Your deployment was canceled successfully!");}else {

// The deployment cancellation is still in progress, so get a new statusDeployResult deployResult = metadataConnection.checkDeployStatus(asyncId, false);

// Check whether the deployment is done. If not done, this means// that the cancellation is still in progress and the status is Canceling.

while (!deployResult.isDone()) {// Assert that the deployment status is Cancelingassert deployResult.getStatus() == DeployStatus.Canceling;// Wait 2 secondsThread.sleep(2000);// Get the deployment status againdeployResult = metadataConnection.checkDeployStatus(asyncId, false);

39

cancelDeploy()ファイルベースのコール

}

// The deployment is done. Write the status to the output.// (When the deployment is done, the cancellation should have completed// and the status should be Canceled. However, in very rare cases,// the deployment can complete before it is canceled.)System.out.println("Final deploy status = >" + deployResult.getStatus());

}}

retrieve()

このコールは、組織内の XML ファイル表現のコンポーネントを取得します。

構文

AsyncResult = metadatabinding.retrieve(RetrieveRequest retrieveRequest)

使用方法組織内のファイル表現のコンポーネントを取得するには、このコールを使用します。


API バージョン 31.0 以降では、retrieve()コールを実行するプロセスが簡略化されました。取得操作の状況を取得する場合、retrieve()をコールしてからcheckStatus()をコールする必要がなくなりました。代わりに、checkRetrieveStatus()のみをコールします。取得操作が進行中の場合、取得操作が完了するまでcheckRetrieveStatus()を再コールします。checkStatus()コールは、API バージョン 30.0 以前では引き続きサポートされますが、API バージョン 31.0 以降では使用できません。APIバージョン 31.0 以降の場合、次の手順に従って、パッケージ化されたコンポーネントまたはパッケージ化されていないコンポーネントを取得します。1. retrieve()コールを発行し、非同期的な取得を開始すると、AsyncResult オブジェクトが返されます。id項

目の値をメモし、次のステップで使用します。2. checkRetrieveStatus()コールを発行して、最初のステップの AsyncResult オブジェクトから id値を渡し

ます。返された RetrieveResult の done項目の値をチェックします。trueの場合、コールが完了して、次のステップに進むことを意味します。それ以外の場合は、done項目が trueになるまで、このステップを繰り返して checkRetrieveStatus()を再度コールします。

3. 前のステップの checkRetrieveStatus()への最後のコールで返された RetrieveResult から zip ファイル(zipFile項目) および他の必要な項目を取得します。

APIバージョン 30.0 以前の場合、次の手順に従って、パッケージ化されたコンポーネントまたはパッケージ化されていないコンポーネントを取得します。1. retrieve()コールを発行し、非同期的な取得を開始すると、AsyncResult オブジェクトが返されます。コー

ルが完了すると、done項目に trueが含まれます。ほとんどの場合、コールはすぐに完了しないため、結果に記述されません。完了している場合、返された id項目の値を書き留め、次のステップを省略します。

2. コールが完了していない場合、前のステップで retrieve()コールから返された AsyncResult オブジェクトのid項目の値を使用して、ループでcheckStatus()コールを発行します。done項目にtrueが含まれるまで、返されるAsyncResultオブジェクトを確認します。retrieve()コールを完了するまでにかかる時間は、リリー

40

retrieve()ファイルベースのコール

スされる zip ファイルのサイズによって異なるため、zip ファイルのサイズが大きいほど、反復中の待機時間をより長く設定します。

3. 最初のステップで返された id値を使用して、checkRetrieveStatus()コールを発行し、retrieve()コールの結果を取得します。

マニフェストファイルの例は、「package.xmlマニフェストファイルのサンプル」を参照してください。


引数

説明型名前取得するパッケージまたはファイルを決定するためのオプションをカプセル化します。

RetrieveRequestretrieveRequest

応答AsyncResult


このサンプルでは、コンポーネントを zip ファイルにして取得する方法を示します。zip ファイルのリリース方法の詳細は、deploy()のサンプルコードを参照してください。

package com.doc.samples;

import java.io.*;import java.util.*;import java.nio.ByteBuffer;import java.nio.channels.*;import java.rmi.RemoteException;import javax.xml.parsers.DocumentBuilder;import javax.xml.parsers.DocumentBuilderFactory;import javax.xml.parsers.ParserConfigurationException;import org.w3c.dom.Element;import org.w3c.dom.Node;import org.w3c.dom.NodeList;import org.xml.sax.SAXException;

import com.sforce.soap.metadata.AsyncResult;import com.sforce.soap.metadata.MetadataConnection;import com.sforce.soap.enterprise.EnterpriseConnection;import com.sforce.soap.metadata.RetrieveMessage;import com.sforce.soap.metadata.RetrieveRequest;import com.sforce.soap.metadata.RetrieveResult;import com.sforce.soap.metadata.RetrieveStatus;import com.sforce.soap.enterprise.LoginResult;import com.sforce.ws.ConnectionException;import com.sforce.ws.ConnectorConfig;import com.sforce.soap.metadata.PackageTypeMembers;

public class RetrieveSample {

// Binding for the metadata WSDL used for making metadata API callsprivate MetadataConnection metadataConnection;

static BufferedReader rdr = new BufferedReader(new InputStreamReader(System.in));

41


// one second in millisecondsprivate static final long ONE_SECOND = 1000;// maximum number of attempts to retrieve the resultsprivate static final int MAX_NUM_POLL_REQUESTS = 50;

// manifest file that controls which components get retrievedprivate static final String MANIFEST_FILE = "package.xml";

private static final double API_VERSION = 31.0;

public static void main(String[] args) throws Exception {final String USERNAME = "[email protected]";// This is only a sample. Hard coding passwords in source files is a bad practice.

final String PASSWORD = "password";final String URL = "https://login.salesforce.com/services/Soap/c/31.0";

RetrieveSample sample = new RetrieveSample(USERNAME, PASSWORD, URL);sample.retrieveZip();

}

public RetrieveSample(String username, String password, String loginUrl)throws ConnectionException {

createMetadataConnection(username, password, loginUrl);}

private void retrieveZip() throws RemoteException, Exception{

RetrieveRequest retrieveRequest = new RetrieveRequest();// The version in package.xml overrides the version in RetrieveRequestretrieveRequest.setApiVersion(API_VERSION);setUnpackaged(retrieveRequest);

// Start the retrieve operationAsyncResult asyncResult = metadataConnection.retrieve(retrieveRequest);String asyncResultId = asyncResult.getId();

// Wait for the retrieve to completeint poll = 0;long waitTimeMilliSecs = ONE_SECOND;RetrieveResult result = null;do {

Thread.sleep(waitTimeMilliSecs);// Double the wait time for the next iterationwaitTimeMilliSecs *= 2;if (poll++ > MAX_NUM_POLL_REQUESTS) {

throw new Exception("Request timed out. If this is a large set " +"of metadata components, check that the time allowed " +"by MAX_NUM_POLL_REQUESTS is sufficient.");

}result = metadataConnection.checkRetrieveStatus(

asyncResultId);System.out.println("Retrieve Status: " + result.getStatus());

} while (!result.isDone());

if (result.getStatus() == RetrieveStatus.Failed) {throw new Exception(result.getErrorStatusCode() + " msg: " +

result.getErrorMessage());} else if (result.getStatus() == RetrieveStatus.Succeeded) {

// Print out any warning messagesStringBuilder buf = new StringBuilder();if (result.getMessages() != null) {

for (RetrieveMessage rm : result.getMessages()) {buf.append(rm.getFileName() + " - " + rm.getProblem());

}}if (buf.length() > 0) {

System.out.println("Retrieve warnings:\n" + buf);

42


}

// Write the zip to the file systemSystem.out.println("Writing results to zip file");ByteArrayInputStream bais = new ByteArrayInputStream(result.getZipFile());File resultsFile = new File("retrieveResults.zip");FileOutputStream os = new FileOutputStream(resultsFile);try {

ReadableByteChannel src = Channels.newChannel(bais);FileChannel dest = os.getChannel();copy(src, dest);

System.out.println("Results written to " + resultsFile.getAbsolutePath());

} finally {os.close();

}}

}

/*** Helper method to copy from a readable channel to a writable channel,* using an in-memory buffer.*/private void copy(ReadableByteChannel src, WritableByteChannel dest)

throws IOException{

// Use an in-memory byte bufferByteBuffer buffer = ByteBuffer.allocate(8092);while (src.read(buffer) != -1) {

buffer.flip();while(buffer.hasRemaining()) {

dest.write(buffer);}buffer.clear();

}}

private void setUnpackaged(RetrieveRequest request) throws Exception{

// Edit the path, if necessary, if your package.xml file is located elsewhereFile unpackedManifest = new File(MANIFEST_FILE);System.out.println("Manifest file: " + unpackedManifest.getAbsolutePath());

if (!unpackedManifest.exists() || !unpackedManifest.isFile())throw new Exception("Should provide a valid retrieve manifest " +

"for unpackaged content. " +"Looking for " + unpackedManifest.getAbsolutePath());

// Note that we populate the _package object by parsing a manifest file here.// You could populate the _package based on any source for your// particular application.com.sforce.soap.metadata.Package p = parsePackage(unpackedManifest);request.setUnpackaged(p);

}

private com.sforce.soap.metadata.Package parsePackage(File file) throws Exception {try {

InputStream is = new FileInputStream(file);List<PackageTypeMembers> pd = new ArrayList<PackageTypeMembers>();DocumentBuilder db =

DocumentBuilderFactory.newInstance().newDocumentBuilder();Element d = db.parse(is).getDocumentElement();for (Node c = d.getFirstChild(); c != null; c = c.getNextSibling()) {

if (c instanceof Element) {Element ce = (Element)c;//NodeList namee = ce.getElementsByTagName("name");if (namee.getLength() == 0) {

43


// notcontinue;

}String name = namee.item(0).getTextContent();NodeList m = ce.getElementsByTagName("members");List<String> members = new ArrayList<String>();for (int i = 0; i < m.getLength(); i++) {

Node mm = m.item(i);members.add(mm.getTextContent());

}PackageTypeMembers pdi = new PackageTypeMembers();pdi.setName(name);pdi.setMembers(members.toArray(new String[members.size()]));pd.add(pdi);

}}com.sforce.soap.metadata.Package r = new com.sforce.soap.metadata.Package();r.setTypes(pd.toArray(new PackageTypeMembers[pd.size()]));r.setVersion(API_VERSION + "");return r;

} catch (ParserConfigurationException pce) {throw new Exception("Cannot create XML parser", pce);

} catch (IOException ioe) {throw new Exception(ioe);

} catch (SAXException se) {throw new Exception(se);

}}

private void createMetadataConnection(final String username,final String password, final String loginUrl)throws ConnectionException {

final ConnectorConfig loginConfig = new ConnectorConfig();loginConfig.setAuthEndpoint(loginUrl);loginConfig.setServiceEndpoint(loginUrl);loginConfig.setManualLogin(true);LoginResult loginResult = (new EnterpriseConnection(loginConfig)).login(

username, password);

final ConnectorConfig metadataConfig = new ConnectorConfig();metadataConfig.setServiceEndpoint(loginResult.getMetadataServerUrl());metadataConfig.setSessionId(loginResult.getSessionId());this.metadataConnection = new MetadataConnection(metadataConfig);

}

//The sample client application retrieves the user's login credentials.// Helper function for retrieving user input from the consoleString getUserInput(String prompt) {

System.out.print(prompt);try {

return rdr.readLine();}catch (IOException ex) {

return null;}

}

}

RetrieveRequestretrieve()コールで指定される RetrieveRequest オブジェクトは、次のプロパティで構成されます。

44

RetrieveRequestファイルベースのコール

説明型名前必須。retrieve 要求のAPIバージョン。APIバージョンによって、各メタデータ型で取得される項目が決

doubleapiVersion

まります。たとえば、API バージョン 14.0 のCustomTabには icon項目が追加されました。バージョン 13.0 以前のコンポーネントを取得する場合、このコンポーネントにはicon項目は含まれません。

メモ: API バージョン 31.0 以降では、package.xmlで指定された API バージョンが retrieve()コールに使用され、apiVersion項目のバージョンを上書きします。package.xmlにバージョンが指定されていない場合は、この項目のバージョンが使用されます。

取得するパッケージ名のリスト。パッケージ化されていないコンポーネントのみを取得する場合、ここ

string[]packageNames

で名前を指定しないでください。同じ retrieve でパッケージ化されたコンポーネントとパッケージ化されていないコンポーネントを取得できます。取得するのが 1 つのパッケージのみか (true)、否か(false)) を指定します。falseの場合、複数のパッケージが取得されます。

booleansinglePackage

取得するファイル名のリスト。このプロパティに値が指定されている場合、packageNamesを null、

string[]specificFiles

singlePackageを trueに設定する必要があります。取得するパッケージに含まれていないコンポーネントのリスト。

Packageunpackaged

checkRetrieveStatus()

宣言的なメタデータコール retrieve()の状況を確認し、zip ファイルのコンテンツを返します。

構文

RetrieveResult = metadatabinding.checkRetrieveStatus(ID id);

使用方法checkRetrieveStatus()を使用して、メタデータ retrieve()操作の進行状況を確認します。このメソッドが返す RetrieveResult オブジェクトは、非同期 retrieve()コールが完了したタイミングを示します。取得が完了

45

checkRetrieveStatus()ファイルベースのコール

している場合、RetrieveResult には zip ファイルコンテンツが含まれます。retrieve()コールを使用してメタデータコンポーネントを取得するには、次のプロセスを使用します。1. retrieve()コールを発行し、非同期的な取得を開始すると、AsyncResult オブジェクトが返されます。id項

目の値をメモし、次のステップで使用します。2. checkRetrieveStatus()コールを発行して、最初のステップの AsyncResult オブジェクトから id値を渡し

ます。返された RetrieveResult の done項目の値をチェックします。trueの場合、コールが完了して、次のステップに進むことを意味します。それ以外の場合は、done項目が trueになるまで、このステップを繰り返して checkRetrieveStatus()を再度コールします。

3. 前のステップの checkRetrieveStatus()への最後のコールで返された RetrieveResult から zip ファイル(zipFile項目) および他の必要な項目を取得します。

API バージョン 31.0 以降では、retrieve()コールを実行するプロセスが簡略化されました。取得操作の状況を取得する場合、retrieve()をコールしてからcheckStatus()をコールする必要がなくなりました。代わりに、checkRetrieveStatus()のみをコールします。取得操作が進行中の場合、取得操作が完了するまでcheckRetrieveStatus()を再コールします。checkStatus()コールは、API バージョン 30.0 以前では引き続きサポートされますが、API バージョン 31.0 以降では使用できません。


このコールの使用例は、retrieve()のサンプルコードを参照してください。

引数

説明型名前retrieve()コールによって返される RetrieveResult オブジェクト、またはcheckStatus()コールによって返される後続の AsyncResult オブジェクトから取得した ID。

IDid

応答RetrieveResult

46

checkRetrieveStatus()ファイルベースのコール

第 7 章CRUD ベースのコール

Enterprise WSDL の同期 API コールのオブジェクトに対する動作と同様にメタデータコンポーネントを使用するには、次の CRUD ベースのコールを使用します。

createMetadata()

組織に 1 つ以上の新しいメタデータコンポーネントを同期して追加します。readMetadata()

組織から 1 つ以上のメタデータコンポーネントを同期して返します。updateMetadata()

組織の 1 つ以上のメタデータコンポーネントを同期して更新します。upsertMetadata()

組織の 1 つ以上のメタデータコンポーネントを同期して作成または更新します。deleteMetadata()

組織から 1 つ以上のメタデータコンポーネントを同期して削除します。renameMetadata()

組織内のメタデータコンポーネントの名前を同期して変更します。create()

非推奨。組織に 1 つ以上の新しいメタデータコンポーネントを非同期で追加します。このコールは API バージョン 31.0 で削除されました。それより前のバージョンでのみ使用できます。代わりにcreateMetadata()を使用します。

delete()

非推奨。組織から 1 つ以上のコンポーネントを非同期に削除します。このコールは API バージョン 31.0 で削除されました。それより前のバージョンでのみ使用できます。代わりに deleteMetadata()を使用します。

update()

非推奨。組織の 1 つ以上のコンポーネントを非同期に更新します。このコールは API バージョン 31.0 で削除されました。それより前のバージョンでのみ使用できます。代わりに、updateMetadata()またはrenameMetadata()を使用します。

47

createMetadata()

組織に 1 つ以上の新しいメタデータコンポーネントを同期して追加します。

構文

SaveResult[] = metadatabinding.createMetadata(Metadata[] metadata);

使用方法createMetadata()コールは、メタデータを拡張するすべてのコンポーネントの作成に使用します。同一コール内のすべてのコンポーネントは、同じ種類である必要があります。詳細は、「Metadata コンポーネントおよびメタデータ型」を参照してください。このコールは同期して実行されます。つまり、コールは、操作が完了したときにのみ戻ります。

バージョンAPI バージョン 30.0 以降で使用できます。


必須項目必須項目は、作成されるメタデータコンポーネントによって決まります。特定のコンポーネントの種類についての詳細は、「Metadata コンポーネントおよびメタデータ型」を参照してください。

有効なデータ値項目のデータ型に対して有効な値を入力する必要があります。たとえば、整数項目については整数を入力します(英字は不可)。クライアントアプリケーションでは、使用しているプログラム言語および開発ツールに指定されたデータ形式ルールに従ってください (開発ツールは、SOAP メッセージのデータ型の適切な対応付けを処理します)。

文字列値文字列項目に値を格納する場合、前後にある空白はAPIが切り捨てます。たとえば、label項目の値に"MyObject

"と入力されると、その値はデータベースに "MyObject"として保存されます。

メタデータコンポーネント作成の基本手順メタデータコンポーネントを作成するには、次のプロセスを使用します。1. 配列を設計し、作成するコンポーネントを挿入します。すべてのコンポーネントは同じ種類である必要があ

ります。2. 引数にコンポーネント配列を渡し、createMetadata()をコールします。3. 作成しようとしたコンポーネントごとに SaveResultオブジェクトが返されます。このオブジェクトには、

操作が成功したかどうか、作成されたコンポーネントの名前、操作が成功しなかった場合は返されたエラーに関する情報が含まれます。

48

createMetadata()CRUD ベースのコール


public void createCustomObjectSync() {try {

CustomObject co = new CustomObject();String name = "MyCustomObject1";co.setFullName(name + "__c");co.setDeploymentStatus(DeploymentStatus.Deployed);co.setDescription("Created by the Metadata API");co.setEnableActivities(true);co.setLabel(name + " Object");co.setPluralLabel(co.getLabel() + "s");co.setSharingModel(SharingModel.ReadWrite);

CustomField nf = new CustomField();nf.setType(FieldType.Text);nf.setLabel(co.getFullName() + " Name");co.setNameField(nf);

SaveResult[] results = metadataConnection.createMetadata(new Metadata[] { co });


System.out.println("Created component: " + r.getFullName());} else {

System.out.println("Errors were encountered while creating "



}}

}} catch (ConnectionException ce) {

ce.printStackTrace();}

}

引数

説明型名前1 つ以上のメタデータコンポーネントの配列。Metadata[]metadata

上限: 10。1 つの種類のコンポーネントの配列を送信する必要があります。たとえば、10個のカスタムオブジェクトの配列または 10 個のプロファイルの配列を送信できますが、両方の種類を混ぜて送信することはできません。

応答SaveResult[]

readMetadata()

組織から 1 つ以上のメタデータコンポーネントを同期して返します。

49

readMetadata()CRUD ベースのコール

構文

ReadResult = metadataConnection.readMetadata(string metadataType, string[] fullNames);

使用方法readMetadata()コールは、メタデータを拡張するすべてのコンポーネントの取得に使用します。同一コール内のすべてのコンポーネントは、同じ種類である必要があります。詳細は、「Metadata コンポーネントおよびメタデータ型」を参照してください。このコールは同期して実行されます。つまり、コールは、操作が完了したときにのみ戻ります。



メタデータコンポーネント読み込みの基本手順メタデータコンポーネントを読み込むには、次のプロセスを使用します。1. 読み込むコンポーネントのメタデータ型と、読み込む各コンポーネントのfullNameを判別します。fullName

項目についての詳細は、「Metadata」を参照してください。1 つのコールで読み込めるのは同じ型のコンポーネントのみです。

2. readMetadata()コールを呼び出します。最初の引数で、メタデータ型の名前を渡します。メタデータ型は、describeMetadata()コールで返された値のいずれかと一致する必要があります。2 つ目の引数で、取得するコンポーネントに対応する完全名の配列を渡します。完全名は、listMetadata()コールで返された完全名の 1 つ以上と一致する必要があります。

3. Metadataコンポーネントの配列が含まれる ReadResultが返されます。返された各 Metadataオブジェクトを、コールで指定したメタデータ型にキャストしてコンポーネントのプロパティを取得します。


public void readCustomObjectSync() {try {

ReadResult readResult = metadataConnection.readMetadata("CustomObject", new String[] {

"MyCustomObject1__c", "MyCustomObject2__c" });Metadata[] mdInfo = readResult.getRecords();System.out.println("Number of component info returned: "

+ mdInfo.length);for (Metadata md : mdInfo) {

if (md != null) {CustomObject obj = (CustomObject) md;System.out.println("Custom object full name: "

+ obj.getFullName());System.out.println("Label: " + obj.getLabel());System.out.println("Number of custom fields: "

+ obj.getFields().length);System.out.println("Sharing model: "

+ obj.getSharingModel());} else {

System.out.println("Empty metadata.");}

}

50

readMetadata()CRUD ベースのコール

} catch (ConnectionException ce) {ce.printStackTrace();

}}

引数

説明型名前読み込むコンポーネントのメタデータ型。stringmetadataType

読み込むコンポーネントの完全名の配列。上限: 10。

string[]fullNames

1 つの種類のコンポーネントの配列を送信する必要があります。たとえば、10個のカスタムオブジェクトの配列または 10 個のプロファイルの配列を送信できますが、両方の種類を混ぜて送信することはできません。

応答ReadResult

updateMetadata()

組織の 1 つ以上のメタデータコンポーネントを同期して更新します。

構文

SaveResult[] = metadataConnection.updateMetadata(Metadata[] metadata);

使用方法updateMetadata()コールは、メタデータを拡張するすべてのコンポーネントの更新に使用します。同一コール内のすべてのコンポーネントは、同じ種類である必要があります。詳細は、「Metadata コンポーネントおよびメタデータ型」を参照してください。このコールは同期して実行されます。つまり、コールは、操作が完了したときにのみ戻ります。



必須項目コンポーネント内のすべての必須項目に値を指定する必要があります。

51

updateMetadata()CRUD ベースのコール

有効な項目値項目のデータ型に対して有効な値を入力する必要があります。たとえば、整数項目については整数を入力します(英字は不可)。クライアントアプリケーションでは、使用しているプログラム言語および開発ツールに指定されたデータ形式ルールに従ってください (開発ツールは、SOAP メッセージのデータ型の適切な対応付けを処理します)。

文字列値String 項目に値を保存する場合、API は先頭および末尾の空白文字を削除します。たとえば、label項目の値に"MyObject "と入力されると、その値はデータベースに "MyObject"として保存されます。

メタデータコンポーネント更新の基本手順メタデータコンポーネントを更新するには、次のプロセスを使用します。1. 更新するコンポーネントの配列を作成します。すべてのコンポーネントは同じ種類である必要があります。2. updateMetadata()コールを呼び出し、更新するメタデータコンポーネントの配列を渡します。

更新しようとしたコンポーネントごとに SaveResultオブジェクトが返されます。このオブジェクトには、操作が成功したかどうか、更新されたコンポーネントの名前、操作が成功しなかった場合は返されたエラーに関する情報が含まれます。


public void updateCustomObjectSync() {try {

CustomObject co = new CustomObject();String name = "MyCustomObject1";co.setFullName(name + "__c");co.setDeploymentStatus(DeploymentStatus.Deployed);co.setDescription("Updated description");co.setLabel(name + " Object Update");co.setPluralLabel(co.getLabel() + "s");co.setSharingModel(SharingModel.ReadWrite);

// Name field with a type and label is requiredCustomField cf = new CustomField();cf.setType(FieldType.Text);cf.setLabel(co.getFullName() + " Name");co.setNameField(cf);

SaveResult[] results = metadataConnection.updateMetadata(new Metadata[] { co });


System.out.println("Updated component: " + r.getFullName());} else {

System.out.println("Errors were encountered while updating "



}}


ce.printStackTrace();

52

updateMetadata()CRUD ベースのコール

}}

引数

説明型名前更新する 1 つ以上のメタデータコンポーネントの配列。上限: 10。

Metadata[]metadata

1 つの種類のコンポーネントの配列を送信する必要があります。たとえば、10 個のカスタムオブジェクトの配列または 10個のプロファイルの配列を送信できますが、両方の種類を混ぜて送信することはできません。

応答SaveResult[]

upsertMetadata()

組織の 1 つ以上のメタデータコンポーネントを同期して作成または更新します。

構文

UpsertResult[] = metadataConnection.upsertMetadata(Metadata[] metadata);

使用方法upsertMetadata()コールは、メタデータを拡張するすべてのコンポーネントの作成または更新に使用します。同一コール内のすべてのコンポーネントは、同じ種類である必要があります。詳細は、「Metadata コンポーネントおよびメタデータ型」を参照してください。指定されたコンポーネントがすでに組織に存在する場合、upsertMetadata()コールはこれらのコンポーネントを更新します。存在しない場合、upsertMetadata()はこれらのコンポーネントを作成します。コンポーネントは fullname項目によって照合されます。このコールは同期して実行されます。つまり、コールは、操作が完了した後にのみ戻ります。




53

upsertMetadata()CRUD ベースのコール

有効な項目値整数項目については整数 (英字は不可)、項目のデータ型に対して有効な値を入力する必要があります。クライアントアプリケーションでは、プログラム言語および開発ツールで指定されているデータ形式ルールに従ってください。(開発ツールは、SOAP メッセージのデータ型の適切な対応付けを処理します)。

文字列値String 項目に値を保存する場合、API は先頭および末尾の空白文字を削除します。たとえば、label項目の値に" MyObject "と入力されると、その値はデータベースに "MyObject"として保存されます。

メタデータコンポーネント更新/挿入の基本手順メタデータコンポーネントを更新/挿入するには、次のプロセスを使用します。1. 作成または更新するコンポーネントに対応するメタデータオブジェクトの配列を作成します。すべてのコン

ポーネントは同じ種類である必要があります。2. upsertMetadata()を呼び出し、前のステップで作成したメタデータコンポーネントの配列を渡します。

upsertMetadata()コールは、UpsertResultオブジェクトの配列を返します。更新/挿入した各コンポーネントに対して UpsertResultが返されます。その中には、更新/挿入操作に関する情報 (操作が成功したかどうか、更新/挿入されたコンポーネントの名前、コンポーネントが作成されたかどうかを示すフラグ、操作が成功しなかった場合に返されるエラー) が含まれます。


public void upsertMetadataSample() {try {

// Create custom object to upsertCustomObject co = new CustomObject();String name = "MyCustomObject";co.setFullName(name + "__c");co.setDeploymentStatus(DeploymentStatus.Deployed);co.setDescription("Upserted by the Metadata API");co.setEnableActivities(true);co.setLabel(name + " Object");co.setPluralLabel(co.getLabel() + "s");co.setSharingModel(SharingModel.ReadWrite);

CustomField nf = new CustomField();nf.setType(FieldType.Text);nf.setLabel("CustomField1");co.setNameField(nf);

// Upsert the custom objectUpsertResult[] results = metadataConnection

.upsertMetadata(new Metadata[] { co });

for (UpsertResult r : results) {if (r.isSuccess()) {

System.out.println("Success!");if (r.isCreated()) {

System.out.println("Created component: "+ r.getFullName());

} else {System.out.println("Updated component: "

+ r.getFullName());}

} else {System.out.println("Errors were encountered while upserting "

54

upsertMetadata()CRUD ベースのコール



}}



}

引数

説明型名前作成または更新する 1 つ以上のメタデータコンポーネントの配列。上限: 10。

Metadata[]metadata

1 つの種類のコンポーネントの配列を送信する必要があります。たとえば、10 個のカスタムオブジェクトの配列または 10個のプロファイルの配列を送信できますが、両方の種類を混ぜて送信することはできません。

応答UpsertResult[]

deleteMetadata()

組織から 1 つ以上のメタデータコンポーネントを同期して削除します。

構文

DeleteResult[] = metadataConnection.delete(string metadataType, string[] fullNames);

使用方法deleteMetadata()コールは、メタデータを拡張するすべてのコンポーネントの削除に使用します。同一コール内のすべてのコンポーネントは、同じ種類である必要があります。詳細は、「Metadata コンポーネントおよびメタデータ型」を参照してください。このコールは同期して実行されます。つまり、コールは、操作が完了したときにのみ戻ります。



55

deleteMetadata()CRUD ベースのコール

ルールとガイドラインコンポーネントを削除する場合は、次のルールやガイドラインを考慮する必要があります。• 指定したコンポーネント内の個別のコンポーネントを削除するには、実行するのに十分なアクセス権を使用

してクライアントアプリケーションにログインする必要があります。詳細は、『SOAP API 開発者ガイド』の「データアクセスに影響する要素」を参照してください。

• また、コンポーネントの親コンポーネントにアクセスする権限も必要となる場合があります。• 参照整合性を確保するために、このコールはカスケード削除をサポートします。親コンポーネントを削除す

ると、各子コンポーネントが削除可能な場合は、その子コンポーネントは自動的に削除されます。

メタデータコンポーネント削除の基本手順メタデータコンポーネントを削除するには次のプロセスを使用します。1. 削除するコンポーネントのメタデータ型と、削除する各コンポーネントの fullNameを判別します。1 つの

コールで削除できるのは同じ型のコンポーネントのみです。完全名は、listMetadata()コールで返された完全名の 1 つ以上と一致する必要があります。fullName項目についての詳細は、「Metadata」を参照してください。

2. deleteMetadata()コールを呼び出します。最初の引数で、メタデータ型の名前を渡します。2 つ目の引数で、削除するコンポーネントに対応する完全名の配列を渡します。削除しようとするコンポーネントごとに、DeleteResultオブジェクトが返されます。このオブジェクトには、操作が成功したかどうか、削除されたコンポーネントの名前、操作が成功しなかった場合は返されたエラーに関する情報が含まれます。


public void deleteCustomObjectSync() {try {

DeleteResult[] results = metadataConnection.deleteMetadata("CustomObject", new String[] { "MyCustomObject1__c",

"MyCustomObject2__c" });for (DeleteResult r : results) {

if (r.isSuccess()) {System.out.println("Deleted component: " + r.getFullName());

} else {System.out

.println("Errors were encountered while deleting "+ r.getFullName());

for (Error e : r.getErrors()) {System.out.println("Error message: " + e.getMessage());System.out.println("Status code: " + e.getStatusCode());

}}



}

引数

説明型名前削除するコンポーネントのメタデータ型。stringmetadataType

56

deleteMetadata()CRUD ベースのコール


説明型名前削除するコンポーネントの完全名の配列。上限: 10。

string[]fullNames

1 つの種類のコンポーネントの配列を送信する必要があります。たとえば、10個のカスタムオブジェクトの配列または 10 個のプロファイルの配列を送信できますが、両方の種類を混ぜて送信することはできません。

応答DeleteResult[]

renameMetadata()

組織内のメタデータコンポーネントの名前を同期して変更します。

構文

SaveResult = metadataConnection.renameMetadata(string metadataType, String oldFullname,String newFullname);

使用方法renameMetadata()コールを使用して、組織の 1 つのメタデータコンポーネントの名前を変更します。このコールは同期して実行されます。つまり、コールは、操作が完了したときにのみ戻ります。このコールは、Metadata を拡張するいずれかのオブジェクトの名前を変更するために使用できます。詳細は、「Metadata コンポーネントおよびメタデータ型」を参照してください。



メタデータコンポーネントの名前変更の基本手順メタデータコンポーネントの名前を変更するには、次のプロセスを使用します。1. 名前を変更するコンポーネントのメタデータ型、現在の完全名、および新しい完全名を判別します。fullName

項目についての詳細は、「Metadata」を参照してください。2. renameMetadata()コールを呼び出します。最初の引数で、メタデータ型の名前を渡します。2 つ目の引数

として以前の完全名、最後の引数として新しい完全名を渡します。SaveResultオブジェクトが返されます。このオブジェクトには、操作が成功したかどうか、名前が変更されたコンポーネントの名前 (名前の変更が成功した場合は新しい名前)、操作が成功しなかった場合は返されたエラーに関する情報が含まれます。

57

renameMetadata()CRUD ベースのコール


public void renameCustomObjectSync() {try {

SaveResult[] results = metadataConnection.renameMetadata("CustomObject", "MyCustomObject1__c","MyCustomObject1New__c");

for (SaveResult r : results) {if (r.isSuccess()) {System.out.println("Renamed component: " + r.getName());}else {System.out.println("Errors were encountered while renaming " + r.getName());for(Error e : r.getErrors()) {System.out.println("Error message: " + e.getMessage());System.out.println("Status code: " + e.getStatusCode());}}}


} catch (InterruptedException ie) {ie.printStackTrace();

}}

引数

説明型名前名前を変更するコンポーネントのメタデータ型。stringmetadataType

コンポーネントの現在の完全名。stringoldFullName

コンポーネントの新しい完全名。stringnewFullName

応答SaveResult

create()

非推奨。組織に 1 つ以上の新しいメタデータコンポーネントを非同期で追加します。このコールはAPIバージョン 31.0 で削除されました。それより前のバージョンでのみ使用できます。代わりに createMetadata()を使用します。このコールは、Metadataを拡張するオブジェクトを作成するために使用できます。詳細は、「Metadata コンポーネントおよびメタデータ型」 (ページ 95)を参照してください。

構文

AsyncResult[] = metadatabinding.create(Metadata[] metadata);

使用方法このコールを使用して、組織に 1 つ以上のメタデータコンポーネントを追加します。

58

create()CRUD ベースのコール

バージョンこのコールは、API バージョン 30.0 以前でのみ使用できます。このコールは、API バージョン 31.0 以降では使用できません。代わりに、createMetadata()を使用します。


必須項目必須項目は、作成されるメタデータコンポーネントによって決まります。特定のコンポーネントの種類についての詳細は、「Metadata コンポーネントおよびメタデータ型」 (ページ 95)を参照してください。

有効なデータ値項目のデータ型に対して有効な値を入力する必要があります。たとえば、整数項目については整数を入力します(英字は不可)。クライアントアプリケーションでは、使用しているプログラム言語および開発ツールに指定されたデータ形式ルールに従ってください (開発ツールは、SOAP メッセージのデータ型の適切な対応付けを処理します)。

文字列値文字列項目に値を格納する場合、前後にある空白はAPIが切り捨てます。たとえば、label項目の値に"MyObject

"と入力されると、その値はデータベースに "MyObject"として保存されます。

メタデータコンポーネント作成の基本手順メタデータコンポーネントを作成するには、次のプロセスを使用します。1. 配列を設計し、作成するコンポーネントを挿入します。すべてのコンポーネントは同じ種類である必要があ

ります。2. 引数にコンポーネント配列を渡し、create()をコールします。3. 作成しようとするコンポーネントごとにAsyncResultオブジェクトが返されます。このオブジェクトは、操作

がキューから完了またはエラー状態に移行すると、状況情報で更新されます。AsyncResult の状況値がすべての create 操作が完了したことを示すまで、checkStatus()コールをループします。checkStatus()コールの反復間の待機時間を 1 秒間で開始して、以降の各コール実行時にはその待機時間を 2 倍の秒数に指定します。


create()コールを使用した Java のサンプルコードについては、「ステップ 3: Java サンプルコードの説明」 (ページ 7)を参照してください。

引数

説明型名前1 つ以上のメタデータコンポーネントの配列。Metadata[]metadata


59

create()CRUD ベースのコール

応答AsyncResult[]

関連リンクcreateMetadata()update()delete()checkStatus()

delete()

非推奨。組織から 1 つ以上のコンポーネントを非同期に削除します。このコールは API バージョン 31.0 で削除されました。それより前のバージョンでのみ使用できます。代わりに deleteMetadata()を使用します。このコールは、Metadataを拡張するいずれかのオブジェクトを削除するために使用できます。詳細は、「Metadataコンポーネントおよびメタデータ型」 (ページ 95)を参照してください。

構文

AsyncResult[] = metadataConnection.delete(Metadata[] metadata);

使用方法このコールを使用して、組織から 1 つ以上のコンポーネントを削除します。

バージョンこのコールは、API バージョン 30.0 以前でのみ使用できます。このコールは、API バージョン 31.0 以降では使用できません。代わりに、deleteMetadata()を使用します。


ルールとガイドラインコンポーネントを削除する場合は、次のルールやガイドラインを考慮する必要があります。• 指定したコンポーネント内の個別のコンポーネントを削除するには、実行するのに十分なアクセス権を使用

してクライアントアプリケーションにログインする必要があります。詳細は、『SOAP API 開発者ガイド』の「データアクセスに影響する要素」を参照してください。

• また、コンポーネントの親コンポーネントにアクセスする権限も必要となる場合があります。• 参照整合性を確保するために、このコールはカスケード削除をサポートします。親コンポーネントを削除す

ると、各子コンポーネントが削除可能な場合は、その子コンポーネントは自動的に削除されます。

メタデータコンポーネント削除の基本手順メタデータコンポーネントを削除するには次のプロセスを使用します。

60

delete()CRUD ベースのコール


1. 削除する各コンポーネントの fullNameを確認します。fullName項目についての詳細は、「Metadata」を参照してください。1 つのコールで削除できるのは同じ型のコンポーネントのみです。

2. delete()コールを呼び出し、fullNameが指定されているメタデータコンポーネントの配列を渡します。3. 削除しようとするコンポーネントごとにAsyncResultオブジェクトが返されます。このオブジェクトは、操作

がキューから完了またはエラー状態に移行すると、状況情報で更新されます。AsyncResult の状況値がすべての delete 操作が完了したことを示すまで、ループで checkStatus()をコールします。checkStatus()コールの反復間の待機時間を 1 秒間で開始して、以降の各コール実行時にはその待機時間を 2 倍の秒数に指定します。


public void deleteCustomObject() {try {CustomObject co = new CustomObject();co.setFullName("MyCustomObject__c");AsyncResult[] ars = metadataConnection.create(new Metadata[]

{co});AsyncResult asyncResult = ars[0];long waitTimeMilliSecs = 1000;while (!asyncResult.isDone()) {Thread.sleep(waitTimeMilliSecs);// double the wait time for the next iterationwaitTimeMilliSecs *= 2;asyncResult = mdConnection.checkStatus(new String[] {asyncResult.getId()})[0];

System.out.println("Status is: " + asyncResult.getState());}



}}

引数

説明型名前1 つ以上のメタデータコンポーネントの配列。Metadata オブジェクトのfullName項目の設定のみが必要です。

Metadata[]metadata


応答AsyncResult[]

関連リンクdeleteMetadata()create()update()checkStatus()

61

delete()CRUD ベースのコール

update()

非推奨。組織の 1 つ以上のコンポーネントを非同期に更新します。このコールは API バージョン 31.0 で削除されました。それより前のバージョンでのみ使用できます。代わりに、updateMetadata()またはrenameMetadata()

を使用します。このコールは、Metadataを拡張するオブジェクトを更新するために使用できます。詳細は、「Metadata コンポーネントおよびメタデータ型」 (ページ 95)を参照してください。

構文

AsyncResult[] = metadataConnection.update(UpdateMetadata[] metadata);

使用方法このコールを使用して、1 つ以上のコンポーネントの更新します。このコールは SQL の ALTER TABLEステートメントに類似しています。

バージョンこのコールは、API バージョン 30.0 以前でのみ使用できます。このコールは、API バージョン 31.0 以降では使用できません。メタデータコンポーネントを更新する場合は、代わりに updateMetadata()を、メタデータコンポーネントの名前を変更する場合は renameMetadata()を使用します。



有効な項目値項目のデータ型に対して有効な値を入力する必要があります。たとえば、整数項目については整数を入力します(英字は不可)。クライアントアプリケーションでは、使用しているプログラム言語および開発ツールに指定されたデータ形式ルールに従ってください (開発ツールは、SOAP メッセージのデータ型の適切な対応付けを処理します)。

文字列値String 項目に値を保存する場合、API は先頭および末尾の空白文字を削除します。たとえば、label項目の値に"MyObject "と入力されると、その値はデータベースに "MyObject"として保存されます。

メタデータコンポーネント更新の基本手順メタデータコンポーネントを更新するには、次のプロセスを使用します。1. UpdateMetadataコンポーネントの配列を作成し、更新するコンポーネントを挿入します。すべてのコンポー

ネントは同じ種類である必要があります。2. update()コールを呼び出し、更新するメタデータコンポーネントの配列を渡します。

62

update()CRUD ベースのコール

3. 更新しようとするコンポーネントごとにAsyncResultオブジェクトが返されます。このオブジェクトは、操作がキューから完了またはエラー状態に移行すると、状況情報で更新されます。AsyncResult の状況値が、すべての更新操作が完了したことを示すまで、ループで checkStatus()をコールします。checkStatus()コールの反復間の待機時間を 1 秒間で開始して、以降の各コール実行時にはその待機時間を 2 倍の秒数に指定します。


public void updateCustomObject() {try {CustomObject co = new CustomObject();String name = "MyCustomObject";co.setFullName(name + "__c");co.setDeploymentStatus(DeploymentStatus.Deployed);co.setDescription("Created by the Metadata API");co.setEnableActivities(true);co.setLabel(name + " Object");co.setPluralLabel(co.getLabel() + "s");co.setSharingModel(SharingModel.ReadWrite);

CustomField nf = new CustomField();nf.setType(FieldType.Text);nf.setLabel(co.getFullName() + " Name");

co.setNameField(nf);

UpdateMetadata updateMetadata = new UpdateMetadata();updateMetadata.setMetadata(co);updateMetadata.setCurrentName("TheCurrentName");

AsyncResult[] ars = metadataConnection.update(new UpdateMetadata[]{ updateMetadata });

AsyncResult asyncResult = ars[0];// set initial wait time to one second in millisecondslong waitTimeMilliSecs = 1000;while (!asyncResult.isDone()) {Thread.sleep(waitTimeMilliSecs);// double the wait time for the next iterationwaitTimeMilliSecs *= 2;asyncResult = metadataConnection.checkStatus(new String[] {asyncResult.getId()})[0];

System.out.println("Status is: " + asyncResult.getState());}

if (asyncResult.getState() != AsyncRequestState.Completed) {System.out.println(asyncResult.getStatusCode() + " msg: " +

asyncResult.getMessage());}



}}

引数

説明型名前更新しようとするコンポーネントを表す、1 つ以上のUpdateMetadata データ構造の配列。上限: 10。

UpdateMetadata[]metadata

63


説明型名前1 つの種類のコンポーネントの配列を送信する必要があります。たとえば、10 個のカスタムオブジェクトの配列または 10個のプロファイルの配列を送信できますが、両方の種類を混ぜて送信することはできません。

UpdateMetadata

1 つ以上の UpdateMetadata オブジェクトが metadata引数で定義されます。このオブジェクトは、Metadata を拡張するオブジェクトを更新するために使用できます。詳細は、「Metadata コンポーネントおよびメタデータ型」(ページ 95)を参照してください。各 UpdateMetadata オブジェクトには、次の項目があります。

説明データ型項目更新前のコンポーネントまたは項目の API 名。たとえば、Foo という名前の CustomObject を更新する場合、この項目

stringcurrentName

の値はFoo__cになります。この値はこのコールによって名前が変更される可能性があるため提供されるものであり、その値は対応付けに使用されます。更新するコンポーネントまたは項目の完全な仕様。Metadatametadata

応答AsyncResult[]

関連リンクupdateMetadata()create()delete()checkStatus()

64


第 8 章ユーティリティコール

ファイルベースまたは CRUD ベースのコールを使用するのに役立つ情報を収集するには、次のユーティリティコールを使用します。• checkStatus()

• describeMetadata()

• listMetadata()

checkStatus()

非推奨。非同期メタデータコールcreate()、update()、またはdelete()の状況、または宣言的なメタデータコール retrieve()の状況を確認します。このコールは API バージョン 31.0 で削除されました。それより前のバージョンでのみ使用できます。

メモ: API バージョン 29.0 以降では、deploy()コール後にリリースに関する情報を取得するためにcheckStatus()をコールする必要がなくなりました。同様に、API バージョン 31.0 では、retrieve()

コール後に checkStatus()をコールする必要がなくなりました。checkStatus()コールは、checkDeployStatus() (リリース操作) およびcheckRetrieveStatus() (取得操作) に置き換えられました。

構文

AsyncResult[] = metadatabinding.checkStatus(ID[] ids);

使用方法このコールを使用して、非同期メタデータコールまたは宣言的なメタデータコールが完了したかどうかを確認します。

バージョンこのコールは、API バージョン 30.0 以前でのみ使用できます。このコールは、API バージョン 31.0 以降では使用できません。


このコールを使用した Java のサンプルコードについては、「ステップ 3: Java サンプルコードの説明」 (ページ7)を参照してください。

65

引数

説明型名前1 つ以上の ID の配列。各 ID は、AsyncResult 内で返され、作成、更新、削除、リリース、または取得されているコンポーネントに対応します。

ID[]ids

応答AsyncResult[]

describeMetadata()

このコールは組織を説明するメタデータを取得します。この情報には Apex クラスおよびトリガ、カスタムオブジェクト、標準オブジェクトのカスタム項目、アプリケーションを定義するタブセット、および他の多くのコンポーネントが含まれています。

構文

DescribeMetadataResult[] = metadataConnection.describeMetadata(double apiVersion);

引数

説明型名前31.0 など、メタデータが必要な API バージョン。doubleapiVersion



public void describeMetadata() {try {double apiVersion = 21.0;// Assuming that the SOAP binding has already been established.DescribeMetadataResult res =

metadataConnection.describeMetadata(apiVersion);StringBuffer sb = new StringBuffer();if (res != null && res.getMetadataObjects().length > 0) {for (DescribeMetadataObject obj : res.getMetadataObjects()) {sb.append("***************************************************\n");sb.append("XMLName: " + obj.getXmlName() + "\n");sb.append("DirName: " + obj.getDirectoryName() + "\n");sb.append("Suffix: " + obj.getSuffix() + "\n");sb.append("***************************************************\n");

}} else {sb.append("Failed to obtain metadata types.");

}System.out.println(sb.toString());


}}

66

describeMetadata()ユーティリティコール

応答DescribeMetadataResult

listMetadata()

このコールは組織のメタデータコンポーネントに関するプロパティ情報を取得します。queriesパラメータで指定されている条件に一致したコンポーネントのデータが返されます。queries配列には各コールに対する最大 3つの ListMetadataQuery クエリを含めることができます。このコールは、CustomObject や ApexClass などの最上位の型、および CustomField や RecordType などの子の型の両方のすべてのメタデータ型をサポートします。

構文

FileProperties[] = metadataConnection.listMetadata(ListMetadataQuery[] queries, doubleasOfVersion);

使用方法このコールは、retrieve()コールの package.xmlの個々のコンポーネントを識別する場合、または組織の特定のメタデータ型の概要が必要な場合に役立ちます。たとえば、組織の CustomObject コンポーネントまたはLayoutコンポーネントのすべての名前のリストが返されるようにこのコールを使用できます。さらに、この情報を使用して後続のretrieve()コールを実行し、これらのコンポーネントのサブセットが返されるようにすることができます。package.xmlの使用についての詳細は、「メタデータのリリースと取得」 (ページ 15)を参照してください。

メモ: これは、結果が 1 つのコールで返される同期コールです。これは、結果を取得するために少なくとも 1 つの後続のコールが必要な retrieve()などの非同期コールと異なります。



以下のサンプルコードでは、カスタムオブジェクトの情報を表示します。このコードは、SOAP バインドがすでに確立されていることを前提としています。

public void listMetadata() {try {ListMetadataQuery query = new ListMetadataQuery();query.setType("CustomObject");//query.setFolder(null);double asOfVersion = 31.0;// Assuming that the SOAP binding has already been established.FileProperties[] lmr = metadataConnection.listMetadata(

new ListMetadataQuery[] {query}, asOfVersion);if (lmr != null) {for (FileProperties n : lmr) {System.out.println("Component fullName: " + n.getFullName());System.out.println("Component type: " + n.getType());

}}


67

listMetadata()ユーティリティコール

}}

引数

説明型名前目的のコンポーネントを指定するオブジェクトのリスト。ListMetadataQuery[]queries

要求のリストを表示するメタデータの API バージョン。この項目に値を指定しない場合、ログイン時に指定したデフォルトの API バージョンになり

doubleasOfVersion

ます。この項目を使用してデフォルトを上書きし、他の API バージョンを設定できます。これにより、たとえば、ログイン時に指定したAPIバージョンより後のバージョンで追加されたメタデータ型のメタデータのリストを表示できます。この項目は API バージョン 18.0 以降で使用できます。

応答FileProperties

ListMetadataQuerylistMetadata()コールで指定されている ListMetadataQuery パラメータは次のプロパティで構成されています。

説明型名前コンポーネントに関連付けられたフォルダ。この項目は、Dashboard、Document、EmailTemplate、また

stringfolder

はReportなどのフォルダを使用するコンポーネントでは必須です。必須。CustomObject、CustomField、またはApexClassなどのメタデータ型。

stringtype

68

ListMetadataQueryユーティリティコール

第 9 章Result オブジェクト

ファイルベースまたは CRUD ベースのコールの結果を取得するには、次のオブジェクトを使用します。

AsyncResult

リリースまたは取得の ID が含まれます。API バージョン 28.0 以前では、非同期メタデータコールの状況情報が含まれています。

CancelDeployResult

リリースのキャンセルに関する情報 (キャンセルが完了したかどうかとリリース ID) が含まれます。DeployResult

関連付けられた deploy()コールの成功または失敗に関する情報が含まれます。DescribeMetadataResult

宣言型メタデータを使用する開発者に役立つ、組織に関する情報が含まれます。ReadResult

readMetadataコールの結果情報が含まれます。RetrieveResult

関連付けられた retrieve()コールの成功または失敗に関する情報が含まれます。SaveResult

createMetadata、updateMetadata、または renameMetadataコールの結果情報が含まれます。DeleteResult

deleteMetadataコールの結果情報が含まれます。UpsertResult

関連付けられた upsertMetadata()コールの結果に関する情報が含まれます。Error

同期 CRUD (createMetadata()、updateMetadata()、または deleteMetadata()) 操作中に発生したエラーを表します。

AsyncResultリリースまたは取得の ID が含まれます。API バージョン 28.0 以前では、非同期メタデータコールの状況情報が含まれています。

69

API バージョン 31.0 以前API バージョン 31.0 では、メタデータを取得するプロセスが簡略化され、取得プロパティが RetrieveResult に移動しました。また、非同期 create()、update()、および delete()コールが削除されました。そのため、AsyncResult の id項目のみが使用されます。id項目は、リリースまたは取得の ID です。AsyncResult は、次の非同期コールによって返されます。• deploy()

• retrieve()

AsyncResult では、次の項目が使用されています。

説明型名前必須。リリースまたは取得されるコンポーネントの ID。IDid

AsyncResult の id以外のすべての項目は、API バージョン 31.0 で廃止されました。次の項目は存在しますが、使用されません。• done

• message

• state

• statusCode

API バージョン 29.0 および 30.0

API バージョン 29.0 では、Salesforce はリリースに関する情報を取得するプロセスを改善するために AsyncResultオブジェクトからDeployResultオブジェクトにいくつかのプロパティを移動し、いくつかの新しいプロパティを追加しました。これらの変更についての詳細は、「deploy()」を参照してください。API バージョン 29.0 および 30.0 では、API バージョン 28.0 以前と同じ非同期コールで AsyncResult が返されますが、項目は異なります。

説明型名前必須。コールが完了したか (true)、否か (false) を示します。booleandone

必須。作成、更新、削除、リリース、または取得されるコンポーネントの ID。

IDid

返される statusCode項目に対応するメッセージ (存在する場合)。

stringmessage

必須。AsyncRequestStateオブジェクトの値は、次の 4 つの値のいずれかです。

AsyncRequestState(string 型の列挙)

state

• Queued: このコールは開始していません。キューで待機しています。

• InProgress: このコールは開始していますが、完了していません。

• Completed: このコールは完了しました。• Error: エラーが発生しました。詳細は、「statusCode」を参

照してください。

70

AsyncResultResult オブジェクト

説明型名前create()、update()、または delete()コール中にエラーが発生した場合、状況コードが返され、その状況コードに対応するメッセージが message項目に返されます。各 StatusCode の値の説明については、『SOAP API 開発者ガイド』の「StatusCode」を参照してください。

StatusCode(string 型の列挙)

statusCode

API バージョン 28.0 以前API バージョン 28.0 以前では、AsyncResult は、次の非同期コールによって返されます。• deploy()

• retrieve()

• create()

• update()

• delete()

各オブジェクトに対して checkStatus()コールを発行し、そのオブジェクトのコールが完了するタイミングを検出します。Salesforce は、コール完了時またはエラー発生時に、各 AsyncResult オブジェクトを更新します。同様に、deploy()およびretrieve()コールは AsyncResult を使用しますが、リリースまたは取得の状況情報をさらに取得するには、それぞれのコールの後にcheckDeployStatus()またはcheckRetrieveStatus()を使用する必要があります。AsyncResult には次の項目があります。

説明型名前組織で一切の変更を行わず、リリースされたファイルの有効性を確認するためにこのリリースが使用されているか (true)、否か

booleancheckOnly

(false) を示します。確認のみのリリースでは、いずれのコンポーネントもリリースせず、組織の変更も一切行いません。この項目はAPIバージョン 16.0 以降で使用でき、deploy()コールのみに関連します。必須。コールが完了したか (true)、否か (false) を示します。booleandone

必須。作成、更新、削除、リリース、または取得されるコンポーネントの ID。

IDid

返される statusCode項目に対応するメッセージ (存在する場合)。

stringmessage

このリリース中にエラーを生成したコンポーネントの数。この項目はAPIバージョン 16.0 以降で使用でき、deploy()コールのみに関連します。

intnumberComponentErrors

このリリースについて、リリースされたコンポーネントの数。この項目は、numberComponentsTotal項目と併せて、リリースの

intnumberComponentsDeployed

進行状況を示します。この項目は API バージョン 16.0 以降で使用でき、deploy()コールのみに関連します。リリースのコンポーネントの合計数。この項目は、numberComponentsDeployed項目と併せて、リリースの進行状

intnumberComponentsTotal

71



説明型名前況を示します。この項目はAPIバージョン 16.0 以降で使用でき、deploy()コールのみに関連します。このリリース中にエラーを生成した Apex テストの数。この項目はAPIバージョン 16.0 以降で使用でき、deploy()コールのみに関連します。

intnumberTestErrors

このリリースの完了した Apex テスト数。この項目は、numberTestsTotal項目と併せて、リリースのテストの進行状況

intnumberTestsCompleted

を示します。この項目は API バージョン 16.0 以降で使用でき、deploy()コールのみに関連します。リリースの Apex テストの合計数。この項目は、numberTestsCompleted項目と併せて、リリースのテストの進

intnumberTestsTotal

行状況を示します。この項目の値は、リリースされるコンポーネントのテストが開始されるまで正確ではありません。この項目はAPI バージョン 16.0 以降で使用でき、deploy()コールのみに関連します。この項目は API バージョン 13.0 以降ではサポートされていません。後方互換性を確保するためにのみ提供されています。この項目は API バージョン 17.0 で削除されました。コールが完了するまでにかかるおおよその秒数を示します。これは推定のみです。checkStatus()をコールする前に少し待って、

intsecondsToWait

操作が完了したかを確認するのが合理的なアプローチです。以降の checkStatus()コールの各反復については、操作が完了するまでの待機時間を 2 倍にします。

必須。AsyncRequestStateオブジェクトの値は、次の 4 つの値のいずれかです。

AsyncRequestState(string 型の列挙)

state

• Queued: このコールは開始していません。キューで待機しています。

• InProgress: このコールは開始していますが、完了していません。

• Completed: このコールは完了しました。• Error: エラーが発生しました。詳細は、「statusCode」を参

照してください。

リリースされているコンポーネント、または実行している Apexテストクラスを示します。この項目は API バージョン 16.0 以降で使用でき、deploy()コールのみに関連します。

stringstateDetail

stateDetail項目が最後に更新された日時。この項目はAPIバージョン 16.0 以降で使用でき、deploy()コールのみに関連します。

dateTimestateDetailLastModifiedDate

72


説明型名前create()、update()、delete()、またはdeploy()コール中にエラーが発生した場合、状況コードが返され、その状況コードに対応するメッセージが message項目に返されます。各 StatusCode の値の説明については、『SOAP API 開発者ガイド』の「StatusCode」を参照してください。

StatusCode(string 型の列挙)

statusCode

CancelDeployResultリリースのキャンセルに関する情報 (キャンセルが完了したかどうかとリリース ID) が含まれます。非同期メタデータコール cancelDeploy()は、CancelDeployResultオブジェクトを返します。

バージョンAPI バージョン 30.0 以降で利用できます。CancelDeployResultには次のプロパティがあります。

説明型名前cancelDeploy()で開始されたリリースのキャンセルが完了したか(true)、否か (false) を示します。リリースが開始しておらず、まだキュー内にある場合、cancelDeploy()コールでリリースは即座にキャンセルされ、この

booleandone

項目は trueを返します。それ以外でキャンセルが進行中の場合、この項目は falseを返します。

キャンセルされるリリースの ID。IDid

DeployResult関連付けられた deploy()コールの成功または失敗に関する情報が含まれます。非同期メタデータコール checkDeployStatus()は DeployResult オブジェクトを返します。API バージョン 29.0 では、Salesforce はリリースに関する情報を取得するプロセスを改善するために AsyncResult(ページ 69) オブジェクトから DeployResult オブジェクトにいくつかのプロパティを移動しました。これらの変更についての詳細は、「deploy()」 (ページ 30) を参照してください。API バージョン 29.0 以降では、DeployResult オブジェクトには次のプロパティがあります。

説明型名前リリースされるコンポーネントの ID。IDid

リリースをキャンセルしたユーザの ID。この項目は API バージョン 30.0 以降で使用できます。

IDcanceledBy

73

CancelDeployResultResult オブジェクト


説明型名前

リリースをキャンセルしたユーザの氏名。この項目は API バージョン 30.0 以降で使用できます。

stringcanceledByName

組織で一切の変更を行わず、リリースされたファイルの有効性を確認するためにこのリリースが使用されているか (true)、否か (false)

booleancheckOnly

を示します。確認のみのリリースでは、いずれのコンポーネントもリリースせず、組織の変更も一切行いません。リリースプロセスの終了時期を示すタイムスタンプ。dateTimecompletedDate

リリースを作成したユーザの ID。この項目は API バージョン 30.0 以降で使用できます。

IDcreatedBy

リリースを作成したユーザの氏名。この項目は API バージョン 30.0 以降で使用できます。

stringcreatedByName

deploy()コールの受信時期を示すタイムスタンプ。dateTimecreatedDate

checkDeployStatus()コールの includeDetailsパラメータがtrueに設定されている場合は、進行中または終了済みのリリースの詳細を示します。

DeployDetails[]details

指定された idに対する deploy()コールの処理がサーバで完了したかどうかを示します。

booleandone

errorStatusCode項目に値がある場合は、それに対応するメッセージ。

stringerrorMessage

deploy()コール中にエラーが発生した場合、状況コードが返され、その状況コードに対応するメッセージがerrorMessage項目に返されます。各 StatusCode の値の説明については、『SOAP API 開発者ガイド』の「StatusCode」を参照してください。

stringerrorStatusCode

省略可能。デフォルトはfalseです。リリース中に警告が発生しても処理を続行するかどうかを指定します。本番組織へのリリースでは、この引数を trueに設定することはできません。

booleanignoreWarnings

リリースプロセスの最後の更新時期を示すタイムスタンプ。dateTimelastModifiedDate

このリリース中にエラーを生成したコンポーネントの数。intnumberComponentErrors

リリースプロセスでリリースされたコンポーネントの数。リリースの進行状況を見積もるには、この値をnumberComponentsTotal値で使用します。

intnumberComponentsDeployed

リリースのコンポーネントの合計数。リリースの進行状況を見積もるには、この値を numberComponentsDeployed値で使用します。

intnumberComponentsTotal

このリリース中にエラーを生成した Apex テストの数。intnumberTestErrors

74

DeployResultResult オブジェクト


説明型名前このリリースで完了した Apex テストの数。リリースのテストの進行状況を見積もるには、この値を numberTestsTotal値で使用します。

intnumberTestsCompleted

このリリースの Apex テストの合計数。リリースのテストの進行状況を見積もるには、この値を numberTestsCompleted値で使用し

intnumberTestsTotal

ます。この項目の値は、リリースされるコンポーネントのテストが開始されるまで正確ではありません。Apex テストがこのリリースの一部として実行されたか (true)、否か (false) を示します。テストは、リリースの一部として自動的に

booleanrunTestsEnabled

実行されるか、deploy()コールの DeployOptionsで実行するように設定できます。テストがいつ自動的に実行されるかについては、「リリースでのテストの実行」を参照してください。この項目は API バージョン 30.0 以降で使用できます。

省略可能。デフォルトは true です。エラーが発生した場合、ロールバックを完了するか (true)、否か (false) を示します。falseの場

booleanrollbackOnError

合、エラーなしで実行できるアクションのセットはすべて実行され、残りのアクションではエラーが返されます。本番組織にリリースする場合は、このパラメータは trueに設定されている必要があります。リリースプロセスの開始時期を示すタイムスタンプ。dateTimestartDate

リリースされているコンポーネント、または実行している Apex テストクラスを示します。

stringstateDetail

リリースの現在の状況を示します。有効な値は、次のとおりです。DeployStatus(string型の列挙)

status

• Pending

• InProgress

• Succeeded

• SucceededPartial

• Failed

• Canceling

• Canceled

リリースが正常に行われたか (true)、否か (false) を示します。booleansuccess

DeployDetails

deploy()コールでincludeDetailsパラメータがtrueに設定されている場合、これらの項目では、DeployResultオブジェクトの details項目の詳細情報を提供します。

メモ: リリースが引き続き処理中である場合、DeployDetails オブジェクトにはcomponentFailuresデータのみが含まれます。リリースプロセスの完了後に、その他の項目にリリース全体のデータが入力されます。

75


説明型名前各コンポーネントのリリースエラーを含む 1 つ以上の DeployMessageオブジェクト。

DeployMessage[]componentFailures

各コンポーネントの成功したリリースの詳細を含む 1 つ以上のDeployMessage オブジェクト。

DeployMessage[]componentSuccesses

deploy()コールに performRetrieveパラメータが指定されていた場合、deploy()プロセスの完了直後に retrieve()コールが実行されます。この項目にはその取得の結果が含まれます。

RetrieveResultretrieveResult

deploy()コールで runAllTestsパラメータまたは runTestsパラメータがテストを実行するように設定されている場合、この項目には

RunTestsResultrunTestResult

それらのテストの結果が含まれます。リリースが引き続き処理中である場合、この項目にはエラーデータのみが含まれます。リリースプロセスの完了後は、この項目にリリース全体のデータが入力されます。

API バージョン 28.0 以前の場合、DeployResult オブジェクトには次のプロパティがあります。

説明型名前リリースされるコンポーネントの ID。IDid

deploy()コールの成功または失敗の情報が含まれます。DeployMessage[]messages

deploy()コールにperformRetrieveパラメータが指定されていた場合、deploy()プロセスの完了直後に retrieve()コールが実行されます。この項目にはその取得の結果が含まれます。

RetrieveResultretrieveResult

deploy()コールで runAllTestsパラメータまたは runTestsパラメータがテストを実行するように設定されている場合、この項目にはそれらのテストの結果が含まれます。

RunTestsResultrunTestResult

リリースが正常に行われたか (true)、否か (false) を示します。booleansuccess

DeployMessage

各 DeployResult オブジェクトには 1 つ以上の DeployMessage オブジェクトが含まれます。各 DeployMessage オブジェクトにはリリース .zipファイルのコンポーネントのリリースの成功または失敗の情報が含まれます。

説明型名前trueの場合、このリリースの結果としてコンポーネントが変更されました。falseの場合、リリースされたコンポーネントは組織内にすでにある対応するコンポーネントと同じものです。

booleanchanged

各コンポーネントはテキストファイルで表されます。リリース中にエラーが発生した場合、この項目はエラーが発生したテキストファイルの列を表します。

intcolumnNumber

このリリースでのコンポーネントのメタデータ型。この項目は API バージョン 30.0 以降で使用できます。

stringcomponentType

76


説明型名前trueの場合、このリリースの結果としてコンポーネントが作成されました。falseの場合、このリリースの結果としてコンポーネントが削除されたか、または変更されたかのいずれかです。

booleancreated

このリリースの結果としてコンポーネントが作成された日時。この項目は API バージョン 30.0 以降で使用できます。

dateTimecreatedDate

trueの場合、このリリースの結果としてコンポーネントが削除されました。falseの場合、このリリースの結果としてコンポーネントが新規作成されたか、または変更されたかのいずれかです。

booleandeleted

このコンポーネントのリリースに使用される .zipファイル内のファイルの名前。

stringfileName

コンポーネントの完全名です。Metadata から継承されるこの項目は、このメタデータ型の WSDL では定義されません。作成時、更新時、または削除時に指定する必要があり

stringfullName

ます。コールにおけるこの項目の例を確認するには、「create()」を参照してください。

リリースされるコンポーネントの ID。IDid

各コンポーネントはテキストファイルで表されます。リリース中にエラーが発生した場合、この項目はエラーが発生したテキストファイルの行番号を表します。

intlineNumber

エラーまたは警告が発生した場合、この項目にはコンパイルの失敗を引き起こした問題の説明が含まれます。

stringproblem

問題の種別を示します。問題の詳細は problem項目で追跡されます。有効な値は、次のとおりです。

DeployProblemType(string 型の列挙)

problemType

• Warning

• Error

この項目は API バージョン 18.0 以降で使用できます。バージョン 18.0より前では、警告とエラーは区別されていませんでした。すべての問題はエラーとして処理され、リリースの成功を妨げていました。

コンポーネントのリリースが正常に行われたか (true)、否か (false) を示します。

booleansuccess

RunTestsResult

コールは、指定された Apex のコンパイルが成功したか否か、単体テストが正常に完了したか否かについての情報を返します。RunTestsResult オブジェクトには、次のプロパティがあります。

説明型名前単体テストのコードカバー率の詳細を含む 1 つ以上のCodeCoverageResult オブジェクトの配列。

CodeCoverageResult[]codeCoverage

77


説明型名前テストの実行について警告する 1 つ以上のコード範囲の配列。結果には、実行された行の合計数、実行されなかったコードの数、行、列の位置が含まれています。

CodeCoverageWarning[]codeCoverageWarnings

単体テストの失敗があれば、それについての情報を含む 1 つ以上の RunTestFailure オブジェクトの配列。

RunTestFailure[]failures

単体テストの失敗数。intnumFailures

実行された単体テストの数。intnumTestsRun

成功についての情報があればその情報を含む 1 つ以上のRunTestSuccesses オブジェクトの配列。

RunTestSuccess[]successes

テストの実行に費やした累積時間の合計。パフォーマンスの監視に役立つ場合があります。

doubletotalTime

CodeCoverageResult

このオブジェクトを含む RunTestsResult オブジェクト。指定された Apex のコンパイルと単体テストの実行が正常に行われたかどうかの情報が含まれています。

説明型名前このプロパティには、テストされた各クラスまたはトリガについて、また、テストされたコードの各部分について、DML ステートメント

CodeLocation[]dmlInfo

の場所、コードが実行された回数、これらのコールに費やした累積時間の合計が含まれています。パフォーマンスの監視に役立つ場合があります。

CodeLocation の ID。ID は組織内で一意です。IDid

テストされた各クラスまたはトリガについて、コードが一切カバーされていない場合、テストされていないコードの行および列、コードが実行された回数。

CodeLocation[]locationsNotCovered

テストされた各クラスまたはトリガについて、メソッド呼び出しの場所、コードが実行された回数、これらのコールに費やした累積時間の合計。パフォーマンスの監視に役立つ場合があります。

CodeLocation[]methodInfo

カバーされているクラスまたはトリガの名前。stringname

指定されている場合、単体テストを含む名前空間。stringnamespace

コードの場所の合計数。intnumLocations

テストされた各クラスまたはトリガについて、コードの SOQL ステートメントの場所、コードが実行された回数、これらのコールに費やした累積時間の合計。パフォーマンスの監視に役立つ場合があります。

CodeLocation[]soqlInfo

使用しません。以前のサポートされていないリリースでは、クラスまたはパッケージを指定していました。

stringtype

78


CodeCoverageWarning

このオブジェクトは RunTestsResult オブジェクトに含まれ、警告を生成した Apex クラスに関する情報を保持します。このオブジェクトには次のプロパティがあります。

説明型名前CodeLocation の ID。ID は組織内で一意です。IDid

生成された警告のメッセージ。stringmessage

指定されている場合、単体テストを含む名前空間。stringname

指定されている場合、単体テストを含む名前空間。stringnamespace

RunTestFailure

RunTestsResult オブジェクトは、単体テスト実行時の失敗に関する情報を返します。このオブジェクトには次のプロパティがあります。

説明型名前失敗を生成したクラスの ID。IDid

失敗のメッセージ。stringmessage

失敗したメソッドの名前。stringmethodName

失敗したクラスの名前。stringname

指定されている場合、クラスを含む名前空間。stringnamespace

失敗についてのスタック追跡。stringstackTrace

失敗した処理についてテストの実行に費やした時間。パフォーマンスの監視に役立つ場合があります。

doubletime

使用しません。以前のサポートされていないリリースでは、クラスまたはパッケージを指定していました。

stringtype

RunTestSuccess

RunTestsResult オブジェクトは、単体テスト実行時の成功に関する情報を返します。このオブジェクトには次のプロパティがあります。

説明型名前成功を生成したクラスの ID。IDid

成功したメソッドの名前。stringmethodName

成功したクラスの名前。stringname

79


説明型名前指定されている場合、単体テストを含む名前空間。stringnamespace

この操作についてテストの実行に費やした時間。パフォーマンスの監視に役立つ場合があります。

doubletime

CodeLocation

RunTestsResult オブジェクトは、多数の項目にこのオブジェクトを含みます。このオブジェクトには次のプロパティがあります。

説明型名前テストされた Apex の列の場所。intcolumn

テストされた Apex の行の場所。intline

テスト実行時に Apex が実行された回数。intnumExecutions

この場所で費やした累積時間の合計。パフォーマンスの監視に役立つ場合があります。

doubletime

DescribeMetadataResult宣言型メタデータを使用する開発者に役立つ、組織に関する情報が含まれます。describeMetadata()コールは DescribeMetadataResult オブジェクトを返します。各 DescribeMetadataResult オブジェクトには次のプロパティがあります。

説明型名前1 つ以上のメタデータコンポーネントおよびその属性。DescribeMetadataObject[]metadataObjects

組織の名前空間。管理パッケージを含めることができる DeveloperEdition 組織用にのみ指定します。管理パッケージには作成時に指定される名前空間があります。

stringorganizationNamespace

rollbackOnErrorが許容されるか (true)、否か (false) を示します。この値は常に次のようになります。

booleanpartialSaveAllowed

• 本番組織では false。• testRequiredの反対。

テストが必要か (true)、否か (false) を示します。この値は常に partialSaveAllowedの反対です。

booleantestRequired

80

DescribeMetadataResultResult オブジェクト

DescribeMetadataObject

このオブジェクトは、DescribeMetadataResult の一部として返されます。各 DescribeMetadataObject には次のプロパティがあります。

説明型名前このコンポーネントの子サブコンポーネントのリスト。string[]childXmlNames

このコンポーネントを含む .zipファイルのディレクトリの名前。stringdirectoryName

コンポーネントがフォルダ内にあるか (true)、否か (false) を示します。たとえば、ドキュメント、メールテンプレート、およびレポートはフォルダに保存されます。

booleaninFolder

コンポーネントに付随するメタデータファイルが必要かどうかを示します。たとえば、ドキュメント、クラス、Sコントロールは追加のメタデータファイルを必要とするコンポーネントです。

booleanmetaFile

このコンポーネントのファイルサフィックス。stringsuffix

このコンポーネントのメタデータファイルのルート要素の名前。また、この名前は、マニフェストファイル package.xmlの Packages > types >name項目にも表示されます。

stringxmlName

ReadResultreadMetadataコールの結果情報が含まれます。


プロパティ

説明型名前readMetadata()から返されたメタデータコンポーネントの配列。

Metadata[]records

RetrieveResult関連付けられた retrieve()コールの成功または失敗に関する情報が含まれます。メタデータ retrieve()コールは RetrieveResult オブジェクトを返します。各 RetrieveResult オブジェクトには、次の項目があります。

説明型名前必須。retrieve()コールが完了したか (true)、否か (false) を示します。この項目は、API バージョン 31.0 以降で使用できます。

booleandone

81

ReadResultResult オブジェクト

説明型名前retrieve()コール中にエラーが発生した場合、この項目にはこのエラーを説明するメッセージが含まれます。この項目は API バージョン 31.0 以降で使用できます。

stringerrorMessage

retrieve()コール中にエラーが発生した場合、この項目にはこのエラーの状況コードが含まれます。この項目は API バージョン 31.0 以降で使用できます。各 StatusCode の値の説明については、『SOAP API 開発者ガイド』の「StatusCode」を参照してください。

StatusCodeerrorStatusCode

.zipファイルの各コンポーネントのプロパティとマニフェストファイルpackage.xmlに関する情報が含まれます。コンポーネントごとに 1 つのオブジェクトが返されます。

FileProperties[]fileProperties

取得されるコンポーネントの ID。IDid

retrieve()コールの成功または失敗に関する情報が含まれます。RetrieveMessage[]messages

retrieve()コールの状況。有効な値は、次のとおりです。RetrieveStatus(string 型の列挙)

status

• Pending

• InProgress

• Succeeded

• Failed

この項目は API バージョン 31.0 以降で使用できます。

retrieve()コールが正常に終了したか (true)、否か (false) を示します。この項目は API バージョン 31.0 以降で使用できます。

booleansuccess

retrieve 要求で返された zip ファイル。Base 64 で符号化されたバイナリデータ API コールを行う前に、クライアントアプリケーションはバイナリ添

base64BinaryzipFile

付データを base64 に符号化する必要があります。応答を受信したら、クライアントアプリケーションは、base64 データをバイナリに復号化する必要があります。この変換は、通常 SOAP クライアントによって処理されます。

FileProperties

このコンポーネントには、.zipファイルの各コンポーネントのプロパティとマニフェストファイルpackage.xml

に関する情報が含まれます。コンポーネントごとに 1 つのオブジェクトが返されます。このコンポーネントには、.zipファイル内の関連付けられたメタデータファイルに関する情報は含まれず、コンポーネントファイルとマニフェストファイルに関する情報のみが含まれます。FileProperties には次のプロパティが含まれます。

説明型名前必須。ファイルを作成したユーザの ID。stringcreatedById

必須。ファイルを作成したユーザの名前。stringcreatedByName

必須。ファイルが作成された日時。dateTimecreatedDate

82

RetrieveResultResult オブジェクト


説明型名前必須。ファイルの名前。stringfileName

必須。API アクセスの一意の識別子として使用される、ファイルの開発者名。値は fileNameに基づいていますが、許容される文

stringfullName

字はより制限されます。fullNameには、アンダースコアと英数字のみを使用できます。一意であること、最初は文字であること、空白は使用しない、最後にアンダースコアを使用しない、2つ続けてアンダースコアを使用しないという制約があります。必須。ファイルの ID。stringid

必須。ファイルを最後に更新したユーザの ID。stringlastModifiedById

必須。ファイルを最後に更新したユーザの名前。stringlastModifiedByName

必須。ファイルが最後に更新された日時。dateTimelastModifiedDate

指定されたコンポーネントがパッケージに含まれている場合、そのコンポーネントの管理可能な状態を示します。

ManageableState (string型の列挙)

manageableState

• beta

• deleted

• deprecated

• installed

• released

• unmanaged

Force.com AppExchange パッケージのコンポーネントの管理可能性の状態に関する詳細は、Salesforce オンラインヘルプの「管理パッケージのリリースの計画」を参照してください。

コンポーネントの名前空間プレフィックス (ある場合)。stringnamespacePrefix

必須。CustomObject、CustomField、またはApexClassなどのメタデータ型。

stringtype

RetrieveMessage

RetrieveResultはこのオブジェクトを返します。このオブジェクトには、retrieve()コールの成功または失敗に関する情報が含まれます。問題ごとに 1 つのオブジェクトが返されます。

説明型名前取得された .zipファイルに含まれる、問題が発生したファイルの名前。stringfileName

発生した問題の説明。stringproblem

関連リンクretrieve()

83

RetrieveResultResult オブジェクト

SaveResultcreateMetadata、updateMetadata、または renameMetadataコールの結果情報が含まれます。


プロパティ

説明型名前操作が成功しなかった場合に返されるエラーの配列。Error[]errors

処理されたコンポーネントの完全名。stringfullName

操作が成功したか (true)、否か (false) を示します。booleansuccess

DeleteResultdeleteMetadataコールの結果情報が含まれます。


プロパティ

説明型名前操作が成功しなかった場合に返されるエラーの配列。Error[]errors

削除されたコンポーネントの完全名。stringfullName

削除が成功したか (true)、否か (false) を示します。booleansuccess

UpsertResult関連付けられた upsertMetadata()コールの結果に関する情報が含まれます。


84

SaveResultResult オブジェクト

プロパティ

説明型名前更新/挿入操作の結果、コンポーネントが作成されたか (true)、否か (false) を示します。falseで更新/挿入操作が成功した場合は、コンポーネントが更新されたことを意味します。

booleancreated

操作が成功しなかった場合に返されたエラーの配列。Error[]errors

操作が成功した場合に作成または更新されたコンポーネントの完全名。

stringfullName

操作が成功したか (true)、否か (false) を示します。booleansuccess

Error同期 CRUD (createMetadata()、updateMetadata()、または deleteMetadata()) 操作中に発生したエラーを表します。


プロパティ

説明型名前エラー条件に影響を与えた項目の名前を含む配列。string[]fields

エラーメッセージテキスト。stringmessage

エラーに対応する状況コード。各 StatusCode の値の説明については、『SOAP API 開発者ガイド』の「StatusCode」を参照してください。

StatusCodestatusCode

85

ErrorResult オブジェクト


第 10 章メタデータ型

メタデータ APIでは、カスタマイズできるユーザインターフェースのすべてにアクセスを許可するわけではありません。次の表には、メタデータ APIを使用して取得またはリリースできるすべてのメタデータ型、型の取得時の package.xmlにおけるワイルドカード (*) 記号の使用の可否、および各型の詳細ページへのリンクが記載されています。ワイルドカード使用についての詳細は、「Zip ファイルの使用」 (ページ 15)を参照してください。メタデータ型は、必ずしも関連するデータ型に直接対応するわけではないため、情報がアクセス可能である場合でも、期待通りに構成されるとは限りません。たとえば連動選択リストは、別のメタデータ型ではなく、選択リストの型として公開されます。

説明ワイルドカード (*)を使用できるか

メタデータ型

取引先チーム、取引先所有者レポート、[階層の表示] リンクの組織の取引先設定を表します。

はいAccountSettings

標準オブジェクトまたはカスタムオブジェクトの override アクションを表します。これを使用して、override アクションを作成、更新、編集、または削除します。

いいえActionOverride

組織の活動設定と、カレンダー用のユーザインターフェース設定を表します。

はいActivitiesSettings

国選択リストと州選択リストの設定を表します。はいAddressSettings

分析スナップショットを表します。分析スナップショットにより、履歴データに関するレポートを作成できます。承認された

いいえAnalyticSnapshot

ユーザは、表形式のレポートやサマリーレポートの結果をカスタムオブジェクトの項目に保存することができ、それらの項目を対象オブジェクト上の対応する項目に割り当てることができます。その上で、レポートをいつ実行してそのカスタムオブジェクトの項目にレポートのデータを読み込むかをスケジューリングできます。分析スナップショットでは、一般のSalesforceでのレコード操作と同様のレポートデータ操作を実行できます。Apex クラスを表します。Apex クラスは、Apex オブジェクトを作成するためのテンプレート、つまり設計図です。クラスは、

はいApexClass

他のクラス、ユーザ定義メソッド、変数、例外型、および静的初期化コードで構成されます。Visualforce コンポーネントを表します。はいApexComponent

1 つの Visualforce ページを表します。はいApexPage

86


メタデータ型

Apex トリガを表します。トリガは、オブジェクトレコードがデータベースに挿入される前や、レコードが削除された後など、

はいApexTrigger

特定のデータ操作言語 (DML) 行動が発生する前後に実行されるApex コードです。Force.comアプリケーションメニューまたはSalesforce1ナビゲーションメニューを表します。

はいAppMenu

承認プロセスに関連付けられたメタデータを表します。承認プロセスは、Salesforce でレコードを承認する場合に、組織で使用

はい(説明を参照)

ApprovalProcess

できる自動化されたプロセスです。承認プロセスでは、承認するレコードの条件と各承認ステップの承認者を指定します。各承認ステップは、その承認プロセスの対象レコードすべてに適用することも、システム管理者が定義した特定の条件を満たすレコードのみに適用することもできます。承認プロセスでは、レコードの承認、却下、取り消しまたは最初の承認申請時に実施するアクションも指定します。ワイルドカード (*) 記号を使用して、すべてのオブジェクトのすべての承認プロセスを取得できます。ワイルドカードは承認プロセスのサブセットの取得には使用できません。Lead.*のような構文はサポートされません。

記事タイプに関連付けられたメタデータを表します。はいArticleType

適切なユーザまたはキューに自動的にケースを転送できる割り当てルールを表します。

はいAssignmentRules

組織の認証プロバイダを表します。認証プロバイダは Facebook©

や Janrain© などの外部サービスプロバイダのログイン情報を使はいAuthProvider

用して、Salesforce 組織にユーザがログインできるようにします。提出されたレコードの属性に基づいてリードまたはケース登録に自動メールレスポンスを送信する条件を設定する自動レスポンスルールを表します。

はいAutoResponseRules

条件に基づく共有ルールおよび所有者に基づく共有ルールの基本コンテナを表します。ワイルドカードのサポートについては、CriteriaBasedSharingRuleおよび OwnerSharingRule のエントリを参照してください。

(説明を参照)BaseSharingRule

エンタイトルメント、エンタイトルメントテンプレート、キャンペーン、ケースの営業時間および休日の設定管理に使用するメタデータを表します。

はいBusinessHoursSettings

BusinessProcessメタデータ型によって、ユーザのプロファイルに基づいて異なる選択リスト値を表示できます。

いいえBusinessProcess

Salesforce をサードパーティのコンピュータテレフォニーインテグレーション (CTI) システムと統合するために使用されるコールセンター定義を表します。

はいCallCenter

87

メタデータ型


メタデータ型

デフォルトのケース所有者、有効化されるケース関連機能、各種ケース活動に使用されるメールテンプレートなど、組織のケース設定を表します。

はいCaseSettings

Chatter アンサーの設定管理に使用するメタデータを表します。はいChatterAnswersSettings

組織内の複数の機能に影響するグローバル設定を表します。はいCompanySettings

アイデアオブジェクトまたはChatter アンサーオブジェクトを含むゾーンを表します。ゾーンは、アイデア、アンサー、および

はいCommunity (Zone)

Chatter アンサー機能で共有されるため、このどこからでもゾーンを表示および作成できます。コンパクトレイアウトに関連付けられたメタデータを表します。はいCompactLayout

接続アプリケーション設定を表します。接続アプリケーションは、API を使用して Salesforce と統合します。接続アプリケー

はいConnectedApp

ションでは、標準の SAML および OAuth プロトコルを使用して認証して、シングルサインオンを提供し、Salesforce API を使用してトークンを提供します。標準の OAuth 機能に加え、接続アプリケーションでは、システム管理者はさまざまなセキュリティポリシーを設定したり、対応するアプリケーションを使用できるユーザを明示的に制御したりできます。契約の設定を表します。はいContractSettings

条件に基づく共有ルールを表します。CriteriaBasedSharingRuleを使用すると、特定の条件に基づいたレコードの共有を行えま


CriteriaBasedSharingRule

す。取引先、キャンペーン、ケース、取引先責任者、カスタムオブジェクト、リード、商談の特定の条件に基づく共有ルールのメタデータが含まれます。ワイルドカード (*) は、カスタムオブジェクトを除くすべての型でサポートされます。

CustomApplication はカスタムアプリケーションまたは標準アプリケーションを表します。API バージョン 29.0 以前では、

はいCustomApplication

CustomApplication はカスタムアプリケーションのみを表します。アプリケーションは、説明とロゴを使用したタブ参照のリストです。Salesforce コンソールとしてマークされているCustomApplicationに割り当てられたカスタムコンソールコンポーネント (Visualforce

はいCustomApplicationComponent

ページ) を表します。カスタムコンソールコンポーネントは、Salesforce コンソールアプリケーションの機能を拡張します。項目に関連付けられたメタデータを表します。標準オブジェクトおよびカスタムオブジェクトのカスタム項目の定義または標

いいえCustomField

準オブジェクトの標準項目の定義を作成、更新、削除するには、このメタデータ型を使用します。

88

メタデータ型


メタデータ型

異なる言語、国、および通貨にローカライズして使用できるカスタム表示ラベルを表します。名前でカスタム表示ラベルを取得する場合は、CustomLabels ではなくこの型を使用します。

いいえCustomLabel

このメタデータ型を使用して、異なる言語、国、および通貨で使用するためにローカライズできるカスタム表示ラベルを作成できます。

はいCustomLabels

組織に固有のデータを保存するカスタムオブジェクトを表します。また、このメタデータ型を使用して、取引先などの標準オブジェクトのカスタマイズを行うこともできます。override アクショ

(説明を参照)CustomObject

ン、ビジネスプロセス、カスタム項目、項目セット、リストビュー、名前付き条件 (ルックアップ検索条件)、選択リスト (連動選択リストを含む)、レコードタイプ、検索レイアウト、共有の理由、共有再適用、入力規則、Web リンク、項目種別が含まれます。ワイルドカード (*) は、項目セットとレコードタイプではサポートされますが、他のコンポーネントではサポートされません。

このメタデータ型を使用して、カスタムオブジェクトをさまざまな言語に翻訳できます。

はいCustomObjectTranslation

ホームページコンポーネントに定義された Web リンクを表します。

はいCustomPageWebLink

カスタム機能へのアクセス権限を付与する権限を表します。はいCustomPermission

Force.com サイトを表します。Force.com サイトでは、公開 Webサイトとアプリケーションを作成できます。それらは Salesforce

はいCustomSite

組織と直接統合されるため、ユーザがログインする場合にユーザ名やパスワードは必要ありません。カスタムタブを表します。カスタムタブとは、カスタムオブジェクトのデータや、アプリケーションに埋め込まれている他の

はいCustomTab

Web コンテンツを表示するために作成するユーザインターフェースコンポーネントのことです。タブにカスタムオブジェクトが表示されているとき、タブ名はカスタムオブジェクト名と同じになります。ページ、Sコントロール、または URL タブの場合は任意の名前です。ダッシュボードを表します。ダッシュボードは、総計値とパフォーマンスを一目で理解できるように表示されたデータの視覚的表現です。

いいえDashboard

データカテゴリグループを表します。はいDataCategoryGroup

ドキュメントを表します。すべてのドキュメントは、sampleFolder/TestDocumentなどのドキュメントフォルダ内にある必要があります。

いいえDocument

89

メタデータ型


メタデータ型

メールテンプレートを表します。いいえEmailTemplate

エンタイトルメントプロセスの設定を表します。はいEntitlementProcess

組織のエンタイトルメント設定を表します。はいEntitlementSettings

エンタイトルメントテンプレートを表します。エンタイトルメントテンプレートは、商品にすばやく追加できる、事前定義さ

はいEntitlementTemplate

れたカスタマサポートの条件です。たとえば、ユーザが顧客に提供される商品にエンタイトルメントを容易に追加できるようWeb サポートまたは電話サポートのエンタイトルメントテンプレートを作成できます。外部データソースに関連付けられたメタデータを表します。外部データソースを作成して、Salesforce の外部にあるデータソースとのインテグレーションに関する接続の詳細を管理します。

はいExternalDataSource

項目セットを表します。項目セットとは、項目をグループ化したものです。たとえば、ユーザの名、ミドルネーム、姓、肩書を示す項目を 1 つの項目セットにして持つことができます。

はいFieldSet

フレキシブルページに関連付けられたメタデータを表します。フレキシブルページは、Salesforce1 ナビゲーションメニューの

はいFlexiPage

メニュー項目として表示されるモバイルアプリケーションのホームページです。フローに関連付けられたメタデータを表します。フローを使用すると、ユーザが一連の画面を移動してデータベース内のレコー

はいFlow

ドをクエリおよび更新するアプリケーションを作成できます。また、ユーザ入力に基づいてロジックを実行して分岐機能を提供し、動的なアプリケーションを構築できます。フォルダを表します。フォルダには、ドキュメント、メールテンプレート、レポート、またはダッシュボードが含まれます。

いいえFolder

取得またはリリースするフォルダの種類 (Document、EmailTemplate、Report、Dashboard) を指定する必要があります。拡張分析フォルダの共有設定を表します。レポートまたはダッシュボードを含むフォルダへの閲覧者、エディタまたはマネー

いいえFolderShare

ジャアクセス権を他のユーザに付与することにより、レポートまたはダッシュボードへのアクセスを制御できます。コラボレーション売上予測設定オプションを表します。はいForecastingSettings

ユーザ、ロールおよびその他のグループを含めることができる公開グループのセットを表します。

はいGroup

ホームページコンポーネントに関連付けられたメタデータを表します。[ホーム] タブにサイドバーリンク、会社のロゴ、ダッ

はいHomePageComponent

シュボードのスナップショット、作成したカスタムコンポーネントなどのコンポーネントを含めるようにカスタマイズできます。

90

メタデータ型


メタデータ型

ホームページのレイアウトに関連付けられたメタデータを表します。ホームページのレイアウトをカスタマイズし、ユーザの

はいHomePageLayout

プロファイルに基づいてユーザにレイアウトを割り当てることができます。アイデアの設定管理に使用するメタデータを表します。はいIdeasSettings

インストールまたはアンインストールするパッケージを表します。現在インストールされているパッケージの新バージョンをリリースすると、パッケージがアップグレードされます。

はいInstalledPackage

Salesforce ナレッジの設定管理に使用するメタデータを表します。

はいKnowledgeSettings

ページレイアウトに関連付けられたメタデータを表します。はいLayout

メールテンプレートのレターヘッドの書式設定オプションを表します。レターヘッドは、HTML メールテンプレートのデザイ

いいえLetterhead

ンを定義します。レターヘッドからは、使用するロゴ、ページの色、およびテキスト設定を HTML メールテンプレートに継承できます。ListView では取引先責任者、取引先、またはカスタムオブジェクトなどのレコードの条件設定済みリストを表示できます。

いいえListView

Live Agent が有効化されているかどうかなどの、組織の LiveAgent 設定を表します。

はいLiveAgentSettings

エージェントに割り当て可能なチャット数や、チャットサウンドを有効化するかどうかなど、組織の Live Agent リリースの設定を表します。

はいLiveChatAgentConfig

ボタンの表示ラベルやライブチャットの開始前に表示されるチャット前フォームなど、エージェントとチャットするために

はいLiveChatButton

顧客がクリックするボタンやチャットウィンドウの Live Agentリリースの設定を表します。リリースのブランド画像や、チャットのトランスクリプトを自動的に保存するかどうかなど、特定の Live Agent リリースの設定を表します。

はいLiveChatDeployment

これはすべてのメタデータ型の基本クラスです。このオブジェクトを編集することはできません。コンポーネントは、メタデータ型のインスタンスです。

いいえMetadata

これは、ドキュメントまたはメールテンプレートなどのコンテンツが含まれるすべてのメタデータ型の基本型で、

いいえMetadataWithContent

マイルストンの名前と説明を表します。これらをエンタイトルメントプロセスで使用して、ケースの重要なステップを追跡できます。

はいMilestoneType

Chatter 設定や、Mobile Lite が有効化されているかどうかなどの、組織のモバイル設定を表します。

はいMobileSettings

91

メタデータ型


メタデータ型

このコンポーネントはAPIバージョン 30.0 で削除され、後方互換性の目的でのみ提供されています。ルックアップ検索条件に

いいえNamedFilter

関連付けられたメタデータは、CustomField コンポーネントのlookupFilter項目によって表されるようになりました。ルックアップ検索条件に関連付けられたメタデータを表します。ルックアップ検索条件の定義を作成、更新、または削除するには、このメタデータ型を使用します。コミュニティを表します。コミュニティとは、従業員、顧客、パートナーがつながることのできるブランド空間です。ビジネ

はいNetwork

スニーズに合ったコミュニティを複数カスタマイズおよび作成し、コミュニティ間をシームレスに移行できます。SalesforceCommunitiesには Network コンポーネントを使用します。Chatterアンサーおよびアイデアを含むゾーンを作成する場合は、Community (Zone) コンポーネントを使用します。商談の自動更新や類似商談条件検索などの機能に関する組織の設定を表します。

いいえOpportunitySettings

注文の設定を表します。はいOrderSettings

所有権ベースの共有ルールを表します。OwnerSharingRule を使用すると、対象のユーザグループのアクセスレベルを指定する


OwnerSharingRule

ルールを使用して、あるユーザのセットが所有するレコードを他のユーザのセットと共有することができます。取引先、キャンペーン、ケース、取引先責任者、カスタムオブジェクト、リード、取引先テリトリー、商談の特定の所有者共有ルールのメタデータが含まれます。ワイルドカード (*) は、カスタムオブジェクトを除くすべての型でサポートされます。

retrieve()コールの一部として取得するメタデータコンポーネントを指定するため、またはコンポーネントのパッケージを定義するために使用されます。

いいえPackage

ユーザのプロファイルを変更せずに、追加権限の許可に使用する権限のセットを表します。アクセスの許可に権限セットを使用できますが、アクセスの拒否には使用できません。

はいPermissionSet

カスタムオブジェクトのカスタム項目、または取引先などの標準オブジェクトのカスタム項目または標準項目の選択リスト (または連動選択リスト) の定義を表します。

いいえPicklist (連動選択リストを含む)

Portal メタデータ型はパートナーポータルまたはカスタマーポータルを表します。

はいPortal

[Chatter での承認] の承認投稿テンプレートに関連付けられたメタデータを表します。承認投稿テンプレートでは、Chatterフィー

はいPostTemplate

ドに表示される承認申請投稿に含まれる情報をカスタマイズできます。

92

メタデータ型


メタデータ型

数量スケジュール、収益スケジュール、および有効フラグと価格の相互作用の組織の設定を表します。

いいえProductSettings

ユーザプロファイルを表します。プロファイルは、Salesforce 内でさまざまな機能を実行するためのユーザの権限を定義します。

はいProfile

処理する前にアイテムを置いておく領域を表します。はいQueue

Chatterパブリッシャーで使用可能となるオブジェクトに対して指定された作成または更新アクションを表します。たとえば、

はいQuickAction

取引先の詳細ページで、ユーザがそのページのChatterフィードからその取引先に関連する取引先責任者を作成するアクションを作成できます。QuickActionは、カスタム項目が許可されたオブジェクトで作成できます。商品およびサービスの提案された価格を示す見積を有効または無効にします。

いいえQuoteSettings

レコードタイプに関連付けられたメタデータを表します。レコードタイプを使用すると、異なるビジネスプロセス、選択リスト

はいRecordType

の値、およびページレイアウトを、異なるユーザに提供できます。リモートサイトの設定を表します。Sコントロールやカスタムボタンで XmlHttpRequest を使用し、Visualforceページ、Apex呼び

はいRemoteSiteSetting

出し、または JavaScript コードで外部サイトを呼び出せるようにするには、[リモートサイトの設定] ページにそのサイトを登録しておく必要があります。これを行わないと、呼び出しは失敗します。カスタムレポートを表します。いいえReport

カスタムレポートタイプに関連付けられたメタデータを表します。カスタムレポートタイプを使用すると、ユーザがレポート

はいReportType

を作成またはカスタマイズできるフレームワークを構築できます。組織内のロールを表します。はいRole

SAML シングルサインオン設定を表します。はいSamlSsoConfig

非推奨。Salesforce ユーザインターフェースの Sコントロールに対応する、Scontrol コンポーネントを表します。

はいScontrol

オブジェクトの検索レイアウトに関連付けられたメタデータを表します。検索結果、検索条件項目、ルックアップダイアログ、

いいえSearchLayouts

およびタブホームページの最近のレコードリストに表示される項目をカスタマイズできます。組織のセキュリティ設定を表します。セキュリティ設定は、ネットワークアクセス用の信頼できる IP 範囲、パスワードとログイ

はいSecuritySettings

ンの要件、およびセッション終了とセキュリティ設定を定義します。

93

メタデータ型


メタデータ型

カスタムオブジェクトに共有が実装された理由を示すために使用される Apex の共有の理由を表します。

いいえSharingReason

特定のカスタムオブジェクトのApexによる共有管理を再適用する Apex クラスを表します。

いいえSharingRecalculation

共有ルールのセットを表します。SharingRules を使用すると、対象ユーザグループのアクセスレベルを指定するルールを使用して、レコードをユーザのセットと共有できます。ワイルドカードのサポートについては、CriteriaBasedSharingRuleおよび OwnerSharingRule のエントリを参照してください。

(説明を参照)SharingRules

共有セットを表します。共有セットでは、アクセス権の対応付けを定義して、ポータルユーザまたはコミュニティユーザに、

はいSharingSet

取引先または取引先責任者に関連付けられたオブジェクトへのアクセス権を付与します。リリース用のサイトを表します。MetadataWithContent型を拡張し、その fullName項目と content項目を継承します。

はいSiteDotCom

スキル名や、スキルを割り当てるエージェントなど、Live Agentでエージェントにチャットを転送するために使用するスキルの設定を表します。

はいSkill

静的リソースファイルを表します。多くの場合は、ZIP ファイル内のコードライブラリです。

はいStaticResource

組織内のテリトリーを表します。はいTerritory

将来の使用のために予約されています。シノニムグループ (ユーザの検索で同義とされる語または句の集合) のセットを表しま

N/ASynonymDictionary

す。シノニムグループを定義して、頭字語、商品名のバリエーション、および組織に固有のその他の用語の検索結果を最適化できます。このメタデータ型を使用して、さまざまな使用言語の翻訳を処理できます。

はいTranslations

入力規則を表します。入力規則は、ユーザがレコードに入力したデータが有効で保存可能かどうかを確認するために使用され

いいえValidationRule

ます。入力規則には、1 つ以上の項目のデータを評価する数式が含まれ、trueまたはfalseの値を返します。入力規則には、無効なデータによりルールが trueの値を返すときに、クライアントアプリケーションがユーザに表示できるエラーメッセージも含まれます。カスタムオブジェクトに定義された Web リンクを表します。いいえWeblink

ワークフロールールに関連付けられたメタデータを表します。ワークフロールールは、指定された条件に該当するときに、ワー

はいWorkflow

クフローアクションを実行します。ワークフローアクションは、ワークフロールールで指定された条件をレコードが満たすとた

94

メタデータ型


メタデータ型

だちに実行するか、タイムトリガを設定して特定の日に実行するように設定することができます。

Metadata コンポーネントおよびメタデータ型Metadata コンポーネントは、API のオブジェクトのような sObject には基づいていません。代わりに、Metadataを拡張する ApexClass および CustomObject などのメタデータ型に基づいています。コンポーネントは、メタデータ型のインスタンスです。たとえば、CustomObjectはカスタムオブジェクトのメタデータ型で、MyCustomObject__cコンポーネントはカスタムオブジェクトのインスタンスです。メタデータ型は、メタデータ WSDL では、Metadata の complexType を拡張する任意の complexType として識別できます。メタデータ型である complexType には、WSDL 定義に次の要素が含まれます。

<xsd:extension base="tns:Metadata">

CustomObjectおよびBusinessProcessはMetadataを拡張するため、これらはメタデータ型です。一方、ActionOverrideは Metadata を拡張しないためメタデータ型ではありません。メタデータ型のコンポーネントは個々にリリースまたは取得できます。たとえば、個々の BusinessProcess コンポーネントは取得できますが、個々のActionOverrideコンポーネントは取得できません。ActionOverrideコンポーネントは、このコンポーネントを含むCustomObjectコンポーネントを取得することによってのみ取得できます。メタデータコンポーネントは、非同期のメタデータ API コールまたは宣言型 (つまり、ファイルベースの) メタデータ API コールによって操作できます。ほとんどのコンポーネントは Force.com IDE を使用してアクセスできます。例外は、オブジェクトの説明に記述されています。

項目のデータ型各コンポーネントの項目には固有のデータ型があります。これらのデータ型は WSDL で定義されているその他のコンポーネント、または、強く型付けされたプログラミング言語で一般的に使用されている stringなどのプリミティブデータ型に対応している場合があります。これら項目のデータ型は、クライアントアプリケーションと API との間で交換される SOAP メッセージで使用されます。クライアントアプリケーションを記述するときは、プログラム言語および開発環境で定義されているデータ型のルールに従ってください。開発ツールでは、プログラミング言語のデータ型の対応付けをこの SOAPデータ型で処理します。プリミティブデータ型の詳細は、『SOAP API 開発者ガイド』を参照してください。

列挙項目一部のコンポーネント項目は列挙であるデータ型を持ちます。列挙は、APIでの選択リストと同じです。項目の有効な値は、同じデータ型を持つ指定可能な値のセットに厳密に制限されます。これらの値のリストは、各列挙

95

Metadata コンポーネントおよびメタデータ型メタデータ型


項目の項目の説明列に示されます。string型の列挙項目の例については、「sortBy」を参照してください。以下の XML では WSDL の string 型の列挙の定義のサンプルを示します。

<xsd:simpleType name="DashboardComponentFilter"><xsd:restriction base="xsd:string">

<xsd:enumeration value="RowLabelAscending"/><xsd:enumeration value="RowLabelDescending"/><xsd:enumeration value="RowValueAscending"/><xsd:enumeration value="RowValueDescending"/>

</xsd:restriction></xsd:simpleType>

サポートされているコール個々のコンポーネントセクションで別途指定されていない限り、すべてのメタデータ型はメインコールでサポートされています。メインのメタデータ API コールは、create()、delete()、update()、deploy()、retrieve()、listMetadata()、およびdescribeMetadata()です。checkStatus()などのその他のすべてのコールは、メインコールの 1 つと併用されるためユーティリティコールとみなされます。

サポートされていないメタデータ型Salesforce 組織でカスタマイズできるコンポーネントの一部をメタデータ API では使用できません。次のコンポーネントはメタデータ API では取得またはリリースできません。また、これらのコンポーネントへの変更は組織ごとに手動で行う必要があります。• 取引先チーム• 活動ボタンの上書き• 分析設定• カスタマイズ可能な標準項目での自動採番• キャンペーンの影響• ケース取引先責任者の役割• ケースフィードのレイアウト• ケースチーム内の役割• コンソールレイアウト• 通貨の換算レート• データカテゴリの表示設定• 代理管理者• ディビジョン• メールサービス• 会計年度• HTML ドキュメントと添付ファイルの設定• リードの設定• 差し込み印刷テンプレート• モバイル管理• モバイルユーザとデバイス• オフラインブリーフケース設定• 商談の大規模商談アラート• 商談アップデートリマインダー• 組織のメールアドレス

96

サポートされていないメタデータ型メタデータ型

• パートナー管理• 定義済みのケースチーム• 商品スケジュール設定• 公開およびリソースカレンダー• 見積テンプレート• Salesforce to Salesforce• 選択リスト項目と参照項目を除く標準項目• 検索設定• セルフサービスポータルのフォントと色• セルフサービスポータルの設定• セルフサービスポータルユーザ• セルフサービス公開ソリューション• セルフサービス Web-to-ケース• 組織の共有設定の共有• Site.com• ソーシャル取引先/取引先責任者の設定• ソリューションカテゴリ• ソリューション設定• タグ設定• テリトリー割り当てルール• ユーザインターフェース設定 (ActivitiesSettings (ページ 415) でサポートされているカレンダー機能を除く)• 個人取引先ページレイアウトの Web リンク• Web-to-リード

メタデータ API リリースの特殊な動作リリースの特定の種類と内容に関する重要な考慮事項変更を組織にリリースする場合、成功するために必要なすべての変更が含まれるように、リリースの個々のコンポーネントがどのように動作するのかを考慮します。次の情報を参考にして、リリースに含めるものや、対象組織での変更の表示方法を決定してください。Apex クラスおよび Apex トリガ

Apex コードへの変更をリリースする前に、スケジュールされた Apex ジョブをキャンセルします。リリース後にジョブを再スケジュールします。

承認プロセス• メタデータ API と共に Salesforce ナレッジ記事の承認プロセスを使用するには、記事タイプをリリース

する必要があります。承認プロセスの記事バージョン (_kav) の場合、サポートされるアクションの種別は、ナレッジアクション、メールアラート、項目自動更新、アウトバウンドメッセージになります。

• 承認プロセスで、カスタム項目を含む投稿テンプレートを参照している場合、変更セットに追加する前にこれらの投稿テンプレートを送信側組織に再保存する必要があります。[設定] から、[作成] > [ワークフローと承認申請] > [テンプレートの投稿] をクリックします。各投稿テンプレートで、[編集]、[保存]の順にクリックします。

• メタデータには、有効承認プロセスの順序は含まれません。場合によっては、リリース後に対象組織で承認プロセスを並び替える必要があります。

97

メタデータ API リリースの特殊な動作メタデータ型

• 変更セットに以前に含まれており別の組織でリリース済みの承認プロセスの [一意の名前]を変更し、変更セット経由で承認プロセスを再送信する場合は、他の組織でリリースされる時点で新しい承認プロセスが作成されます。以前にリリースされた承認プロセスは、変更されません。

カスタム項目API バージョン 30.0 以降、新しいカスタム項目をリリースする場合、プロファイル項目権限の editable

項目と readable項目のデフォルト値は falseです。デフォルト値を上書きするには、新規項目の項目権限をプロファイルに含めます。

カスタムオブジェクトAPI バージョン 29.0 では、メタデータ API を使用してオブジェクトの sharingModelを変更することはできません。対象組織に対するこのような変更は、ユーザインターフェースを使用して手動で行う必要があります。API バージョン 30.0 以降、メタデータ API とユーザインターフェースを使用して、内部ユーザ向けにオブジェクトの sharingModelを変更できます。

Apex クラスおよび Apex トリガApex コードへの変更をリリースする前に、スケジュールされた Apex ジョブをキャンセルします。リリース後にジョブを再スケジュールします。

接続アプリケーション• メタデータ API で consumerKeyを設定することはできません。これは、情報提供を目的とした取得操

作に含まれます。接続アプリケーションを別の組織に移動する場合、組織にリリースする前にconsumerKey

を .zip ファイルから削除する必要があります。移行先の組織で新しいキーが生成されます。• 接続アプリケーションのモバイル設定は、変更セットでサポートされていないため、手動で移行する必

要があります。

ページレイアウトページレイアウトの割り当てを含むリリースでは、対象組織にある既存のすべてのページレイアウトの割り当てが、.zip ファイルで指定された割り当てに置き換えられます。組織の既存のページレイアウトの割り当てが .zip ファイルに含まれていない場合、それらのページレイアウトはなくなります。すべての必要なレコードタイプの全ページレイアウトを .zip ファイルに必ず含めるようにしてください。

共有どのオブジェクトを更新するかに関係なく、メタデータ API では、オブジェクトの sharingModel項目の更新と新しい共有ルールの追加を同時に行うことはサポートされていません。たとえば、組織の共有設定が公開である場合、共有ルールを追加し、その後で sharingModelを更新することができます。共有の再適用は1 度のみとなります。

ワークフローメタデータ API では、フロートリガのテストモードはサポートされていません。システム管理者がワークフロールールを起動したときにフロートリガで最新のフローバージョンを実行する場合は、リリース後にユーザインターフェースでテストモードを有効にします。

98

メタデータ API リリースの特殊な動作メタデータ型

AnalyticSnapshot分析スナップショットを表します。分析スナップショットにより、履歴データに関するレポートを作成できます。承認されたユーザは、表形式のレポートやサマリーレポートの結果をカスタムオブジェクトの項目に保存することができ、それらの項目を対象オブジェクト上の対応する項目に割り当てることができます。その上で、レポートをいつ実行してそのカスタムオブジェクトの項目にレポートのデータを読み込むかをスケジューリングできます。分析スナップショットでは、一般の Salesforce でのレコード操作と同様のレポートデータ操作を実行できます。

宣言的なメタデータファイルのサフィックスおよびディレクトリの場所Force.com の AnalyticSnapshot コンポーネントは、対応するパッケージディレクトリの analyticSnapshotsディレクトリに保存されます。ファイル名は、分析スナップショットの一意の名前に一致し、拡張子は.analyticsnapshotです。

バージョンForce.com の AnalyticSnapshot コンポーネントは、API バージョン 16.0 以降で使用できます。

項目

説明データ型項目分析スナップショットの説明。stringdescription

APIアクセスに使用される分析スナップショット名。名前には、英数字、およびアンダースコア (_) 文字の

stringfullName

みを使用できます。また、最初は文字とし、最後にアンダースコアを使用したり、連続した 2 つのアンダースコア文字を含めたりすることはできません。この項目は、Metadata コンポーネントから継承されています。ソースレポートからのデータ抽出レベルを指定する列。サマリーレポートのみに適用されます。

stringgroupColumn

分析スナップショットの対応付けのリスト。有効な値については、「AnalyticSnapshotMapping」を参照してください。

AnalyticSnapshotMapping[]mappings

必須。分析スナップショットの表示名。stringname

分析スナップショットを実行するために使用されるロールと共有設定を所有するユーザのユーザ名。

stringrunningUser

必須。データの抽出元であるレポート。stringsourceReport

必須。データの挿入先であるカスタムオブジェクト。stringtargetObject

AnalyticSnapshotMapping

AnalyticSnapshotMapping は、分析スナップショットの対応付けを定義します。有効な値は、次のとおりです。

99

AnalyticSnapshotメタデータ型

説明データ型項目各レポート項目が集計されるかどうか、および集計方法を定義するリスト。有効な値については、「ReportSummaryType」を参照してください。

ReportSummaryType[](string 型の列挙)

aggregateType

sourceField は、次のいずれかです。stringsourceField

• targetObject で targetField に対応付ける sourceReport の項目。

• sourceReport の項目の概要 (サマリーレポートのみ)• 分析スナップショットの JobName、RunningUser、または

ExecutionTime などの項目 (ユーザインターフェースで設定)

注意: sourceField は、指定する sourceType に対応している必要があります。

分析スナップショットのレポート形式を定義するリスト。有効な値については、「ReportJobSourceTypes」を参照してください。

ReportJobSourceTypes[](string 型の列挙)

sourceType

この特定の sourceField の挿入先である targetObject の項目。stringtargetField

ReportJobSourceTypes

分析スナップショットのレポート形式を定義する string 型の列挙。有効な値は、次のとおりです。

説明列挙値sourceField に JobName、RunningUser、または ExecutionTime などのスナップショット固有の情報が含まれる場合は、このオプションを使用します。

snapshot

sourceReport の項目の集計 (合計、平均、最小、最大) を参照する場合は、このオプションを使用します。

summary

sourceReport から使用可能な列を参照する場合は、このオプションを使用します。

tabular

宣言的なメタデータの定義のサンプル分析スナップショットの XML 定義のサンプルを以下に示します。

<?xml version="1.0" encoding="UTF-8"?><AnalyticSnapshot xmlns="http://soap.sforce.com/2006/04/metadata">

<description>my description</description><groupColumn>INDUSTRY</groupColumn><mappings>

<aggregateType>Average</aggregateType><sourceField>SALES</sourceField><sourceType>summary</sourceType><targetField> myObject __c.Name</targetField>

</mappings><mappings>

<sourceField>ExecutionTime</sourceField><sourceType>snapshot</sourceType><targetField> myObject __c.field3__c</targetField>

</mappings>

100

AnalyticSnapshotメタデータ型

<mappings><sourceField>INDUSTRY</sourceField><sourceType>tabular</sourceType><targetField>testObject__c.Name</targetField>

</mappings><name>my snapshot</name ><runningUser>[email protected]</runningUser><sourceReport>myFolder/mytSummaryReport</sourceReport><targetObject>myObject__c</targetObject>

</AnalyticSnapshot>

関連リンクReport

ArticleType記事タイプに関連付けられたメタデータを表します。Salesforce ナレッジのすべての記事は 1 つの記事タイプに割り当てられます。記事のタイプは、記事が含むコンテンツのタイプ、外観、および記事にアクセスできるユーザを特定します。たとえば、単純な FAQ の記事タイプには、Questionおよび Answerの 2 つのカスタム項目があり、記事マネージャが FAQ の記事の作成または更新時にそこにデータを入力します。より複雑な記事タイプでは、複数のセクションに分かれた多数の項目が必要な場合があります。レイアウトおよびテンプレートを使用することで、管理者は特定のコンテンツに対して最も効果的な方法で記事タイプを構築できます。記事タイプへのユーザのアクセスは権限によって制御されます。各記事タイプについて、管理者は「作成」、「参照」、「編集」、または「削除」権限をユーザに与えることができます。たとえば、記事マネージャが内部ユーザには FAQを参照、作成、編集できるようにするけれども、パートナーユーザには FAQ の参照のみを可能にする場合などです。Salesforce オンラインヘルプの「記事タイプの管理」および『SOAP API 開発者ガイド』の「記事」を参照してください。

宣言的なメタデータファイルのサフィックスおよびディレクトリの場所ArticleType はカスタムオブジェクトとして定義され、objectsフォルダに保存されます。ArticleType のサフィックスには __kavを使用します (カスタムオブジェクトの場合の __c の代わりに)。ArticleType 項目名にはその他のカスタムオブジェクトと同様に__cサフィックスを使用し、属する記事タイプの名前を使ってドット修飾する必要があります。次のサンプル package.xmlファイルでこれを示します。


<fullName>articlefilemetadata</fullName><apiAccessLevel>Unrestricted</apiAccessLevel>

<types><members>newarticle__kav.description__c</members><name>CustomField</name>

</types><types>

<members>newarticle__kav</members><name>CustomObject</name>

</types>

</Package>

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

101

ArticleTypeメタデータ型


項目

説明データ型項目名さまざまなチャネルで記事を表示するために使用する記事タイプテンプレートを表します。Salesforce オンラインヘルプ

articleTypeChannelDisplayarticleTypeChannelDisplay

の「記事タイプテンプレートの割り当て」を参照してください。カスタムオブジェクトまたはカスタム項目のリリース状況を表す文字列。有効な値は、次のとおりです。

DeploymentStatus (string 型の列挙)

deploymentStatus

• InDevelopment

• Deployed

記事タイプの説明。最大 1000 文字です。stringdescription

記事タイプの 1 つ以上の項目を表します。CustomField[]fields

名詞の性別を示します。これは、語の性別に基づいて、異なる処理が必要となる言語に使用されます。

Gendergender

Salesforce ユーザインターフェース全体でオブジェクトを表す表示ラベル。

stringlabel

label値の複数形です。stringpluralLabel

名詞が母音、子音、または特殊文字で開始されているかを示します。これは、語の最初の文字に基づいて、異なる処理が

StartsWith (string型の列挙)startsWith

必要となる言語に使用されます。有効な値は、「StartsWith」にリストされています。

articleTypeChannelDisplay

チャネルで記事を表示するために使用される記事タイプテンプレートを決定します。別途記載がない限り、すべての項目は作成可能、除外可能で、null にすることもできます。

説明データ型項目名特定のチャネルに適用する記事タイプテンプレートを示します。

articleTypeTemplatesarticleTypeTemplates

articleTypeTemplates

特定のチャネルで使用する記事タイプテンプレートを設定します。指定されていない場合、デフォルトの記事タイプテンプレートが適用されます。

説明データ型項目名記事タイプテンプレートが適用されるチャネルを指定します。

stringchannel

• AllChannels: 使用できるすべてのチャネル• App: Salesforce ナレッジの [記事] タブ• Pkb: 公開知識ベース• Csp: カスタマーポータル

102


説明データ型項目名• Prm: パートナーポータルチャネルについての詳細は、Salesforce オンラインヘルプの「Salesforce ナレッジの用語」を参照してください。

カスタム記事タイプテンプレートとして使用されるカスタムVisualforce ページの名前を表します。template 項目で Page

を選択する場合にこの項目を使用します。

stringpage

特定のチャネルに使用する記事タイプテンプレートを示します。

stringtemplate

• Page: カスタム Visualforce ページ。この値を指定する場合、page項目をVisualforceページ名で設定する必要があります。

• Tab: タブとしてレイアウトに定義したセクションを表示します。

• Toc: 目次としてレイアウトに定義したセクションを表示します。

宣言的なメタデータの定義のサンプル記事タイプの定義のサンプルを以下に示します。

<?xml version="1.0" encoding="UTF-8"?><CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">

<articleTypeChannelDisplay><articleTypeTemplates>

<channel>App</channel><template>Tab</template>

</articleTypeTemplates><articleTypeTemplates>

<channel>Prm</channel><template>Tab</template>


<channel>Csp</channel><template>Tab</template>


<channel>Pkb</channel><template>Toc</template>

</articleTypeTemplates></articleTypeChannelDisplay><deploymentStatus>Deployed</deploymentStatus><description>Article type with custom fields</description><fields>

<fullName>description__c</fullName><label>Description</label><length>48</length><type>Text</type>

</fields><label>newarticle</label>

103


<pluralLabel>newarticles</pluralLabel></CustomObject>

関連リンクArticleType レイアウトArticleType CustomField

ArticleType レイアウト記事タイプのページレイアウトに関連付けられたメタデータを表します。記事タイプレイアウトは、ユーザが記事にデータを入力するときに参照および編集できる項目と、ユーザが記事を参照するときに表示されるセクションも決定します。記事の形式 (たとえばレイアウトセクションをサブタブ、またはリンクのある 1 つのページとして表示するかどうか) は、記事タイプテンプレートで定義します。各記事タイプには 1 つのレイアウトのみ使用できますが、記事タイプの 4 つのチャネルのそれぞれに異なるテンプレートを選択できます。詳細は、Salesforceオンラインヘルプの「記事タイプの管理」および>『SOAP API 開発者ガイド』の「記事」を参照してください。

ファイルのサフィックスおよびディレクトリの場所ArticleType レイアウトは、対応するパッケージディレクトリの layoutsディレクトリに保存されます。プレフィックスは、記事タイプの API 名に一致する必要があります。拡張子は .layoutです。

バージョンArticleType レイアウトは、API バージョン 19.0 以降で使用できます。

項目

説明データ型項目名記事項目を含むレイアウトのメインセクション。ここでの順序はレイアウトの順序を決定します。

LayoutSection[]layoutSections

LayoutSection

LayoutSection は、ArticleType レイアウトのセクションを表します。

説明データ型項目名このセクションの表示ラベルがカスタムであるか標準 (組み込み) であるかを示します。カスタム表示ラベルは任意のテ

booleancustomLabel

キストですが、翻訳する必要があります。標準表示ラベルには、「システム情報」など、自動的に翻訳される、定義済みの有効な値セットが含まれます。表示ラベル。customLabelフラグに基づいて標準またはカスタムのいずれかとなります。

stringlabel

レイアウトの列です。スタイルによって異なります。Salesforce ナレッジでは、記事タイプレイアウトで 1 つの列のみがサポートされています。

LayoutColumn[]layoutColumns

104

ArticleType レイアウトメタデータ型


説明データ型項目名レイアウトのスタイル。Salesforce ナレッジでは、1 つの列ページを表示する OneColumn値のみがサポートされています。

LayoutSectionStyle(string 型の列挙)

style

LayoutColumn

LayoutColumn は、レイアウトセクション内の列の項目を表します。

説明データ型項目名列内の個々の項目 (上から下の順序)LayoutItem[]layoutItems

LayoutItem

LayoutItem は、レイアウト項目を定義する有効な値を表します。

説明データ型項目名MyField__cなどの項目名の参照。stringfield

宣言的なメタデータの定義のサンプルArticleType ページレイアウトの定義を次に示します。

<?xml version="1.0" encoding="UTF-8"?><Layout xmlns="http://soap.sforce.com/2006/04/metadata">

<layoutSections><customLabel>true</customLabel><label>Description</label><layoutColumns>

<layoutItems><field>description__c</field>

</layoutItems><layoutItems>

<field>dateTime__c</field></layoutItems>

</layoutColumns><style>OneColumn</style>

</layoutSections><layoutSections>

<label>Data Sheet</label><layoutColumns>

<layoutItems><field>file__c</field>

</layoutItems></layoutColumns><style>OneColumn</style>

</layoutSections></Layout>

関連リンクArticleTypeArticleType CustomField

105

ArticleType レイアウトメタデータ型

ArticleType CustomField記事タイプカスタム項目に関連付けられたメタデータを表します。記事タイプカスタム項目の定義を作成、更新、または削除するには、このメタデータ型を使用します。Metadataメタデータ型を拡張し、その fullName項目を継承します。カスタム項目を作成または更新するときには必ず完全名を指定する必要があります。たとえば、カスタムオブジェクトのカスタム項目は次のように表されます。

MyArticleType__kav.MyCustomField__c

宣言的なメタデータファイルのサフィックスおよびディレクトリの場所カスタム項目は記事タイプの一部として定義されます。ArticleType 項目名にはその他のカスタムオブジェクトと同様に__cサフィックスを使用し、属する記事タイプの名前を使ってドット修飾する必要があります。詳細は、「ArticleType」を参照してください。

カスタムオブジェクトまたは標準オブジェクトのカスタム項目の取得カスタムオブジェクトまたは標準オブジェクトを取得するとき、そのオブジェクトに関連付けられるものすべてが返されます。ただし、package.xmlで明示的にオブジェクトと項目の名前を指定することによって、オブジェクトのカスタム項目のみを取得することもできます。package.xml内の次の定義は、それぞれに 1 つのカスタム項目の定義を含む、objects/MyCustomObject__c.object、objects/Account.object__c.object、および objects/MyArticleType__kav.objectファイルを取得します。

<types><members>MyCustomObject__c.MyCustomField__c</members><members>Account.MyCustomAccountField__c</members><members>MyArticleType__kav.MyOtherCustomField__c</members><name>CustomField</name>

</types>

バージョンArticleType カスタム項目は、API バージョン 19.0 以降で使用できます。

ArticleType の項目別途記載がない限り、すべての項目は作成可能、除外可能で、null にすることもできます。

説明データ型項目名指定されている場合、項目のデフォルト値を表します。

stringdefaultValue

参照関係の削除オプションを提供します。有効な値は、次のとおりです。SetNull

これはデフォルトです。参照レコードが削除されると、参照項目は消去されます。

DeleteConstraint (string型の列挙)

deleteConstraint

106

ArticleType CustomFieldメタデータ型

説明データ型項目名

Restrict

レコードが参照関係にある場合に、そのレコードが削除されないように防止します。

Cascade

参照レコードも関連付けられた参照項目も削除します。

参照関係についての詳細は、Salesforceヘルプの「オブジェクトリレーションの概要」を参照してください。

項目の説明。stringdescription

指定されている場合、項目の数式を表します。stringformula

数式内の空白の処理方法を示します。有効な値は、BlankAsBlankおよび BlankAsZeroです。

TreatBlanksAs (string型の列挙)

formulaTreatBlankAs

Metadataから継承されるこの項目は、このメタデータ型の WSDL では定義されません。作成時、更新

stringfullName

時、または削除時に指定する必要があります。コールにおけるこの項目の例を確認するには、「create()」を参照してください。この値は nullにできません。

項目レベルのヘルプの内容を表します。詳細は、Salesforceヘルプの「項目レベルのヘルプの定義」を参照してください。

stringinlineHelpText

項目の表示ラベル。[記事タイプ] の標準項目の [タイトル]、[URL 名]、[概要] などの表示ラベルを更新することはできません。

stringlabel

項目の長さ。intlength

指定されている場合、項目は選択リストで、この項目は選択リスト値および表示ラベルを列挙します。

Picklist (連動選択リストを含む)

picklist

指定されている場合、この項目に含まれる別のオブジェクトへの参照を示します。

stringreferenceTo

リレーションの表示ラベル。stringrelationshipLabel

指定されている場合、一対多のリレーションの値を示します。たとえば、YourObject へのリレーション

stringrelationshipName

を持っていた MyObject オブジェクトでは、そのリレーション名は YourObjects となります。作成時に項目への値の入力が必須であるか (true)、否か (false) を示します。

booleanrequired

107


説明データ型項目名必須。項目のデータ型を示します。有効な値は、次のとおりです。

FieldTypetype

• Checkbox (バージョン 30.0 以降で使用可能)• Currency

• ArticleCurrency

• Date

• DateTime

• Email

• File

• Formula

• Html

• Lookup

• Number

• Percent

• Phone

• Picklist

• DependentPicklist

• MultiselectPicklist

• Text

• TextArea

• LongTextArea

• URL

項目に表示される線の数を示します。intvisibleLines

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

<?xml version="1.0" encoding="UTF-8"?><CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">....<fields>

<fullName>Comments__c</fullName><description>add your comments about this object here</description><label>Comments</label><length>32000</length><type>LongTextArea</type><visibleLines>30</visibleLines>

</fields>....</CustomObject>

関連リンクArticleType

ArticleType レイアウト

108


ApexClassApex クラスを表します。Apex クラスは、Apex オブジェクトを作成するためのテンプレート、つまり設計図です。クラスは、他のクラス、ユーザ定義メソッド、変数、例外型、および静的初期化コードで構成されます。詳細は、『Force.com Apex コード開発者ガイド』を参照してください。このメタデータ型は、MetadataWithContentコンポーネントを拡張し、その項目を共有します。

メモ: Apex クラスに 1 つ以上の有効なスケジュール済みジョブがある場合は、このクラスへの更新をリリースすることはできません。

サポートされているコールdeploy()、retrieve()、describeMetadata()、listMetadata()

メモ: このメタデータ型は、create()、delete()、および update()コールでサポートされていません。

宣言的なメタデータファイルのサフィックスおよびディレクトリの場所クラスファイルのファイルサフィックスは、.clsです。付随するメタデータファイルには、ClassName-meta.xml

という名前が付けられます。Apex クラスは、対応するパッケージディレクトリの classesフォルダに保存されます。

バージョンAPI クラスは API バージョン 10.0 以降で使用できます。

項目このメタデータ型には、次の項目が含まれます。

説明データ型項目名このクラスの API バージョン。すべてのクラスには、作成時に指定された API バージョンが割り当てられています。

doubleapiVersion

Apex クラスの定義。Base 64 で符号化されたバイナリデータ APIコールを行う前に、クライアントアプリケーションはバイナリ添

base64content

付データを base64 に符号化する必要があります。応答を受信したら、クライアントアプリケーションは、base64 データをバイナリに復号化する必要があります。この変換は、通常 SOAP クライアントによって処理されます。この項目は、MetadataWithContentコンポーネントから継承されます。Apex クラス名。名前には、英数字、およびアンダースコア (_) 文字のみを使用できます。また、最初は文字とし、最後にアンダー

stringfullName

スコアを使用したり、連続した 2 つのアンダースコア文字を含めたりすることはできません。この項目は、Metadata コンポーネントから継承されています。

109

ApexClassメタデータ型

http://developerforcejp.s3.amazonaws.com/developer/docs/apexcode/index.htm

説明データ型項目名この Apex クラスによって参照される、インストール済みの管理パッケージバージョンのリスト

PackageVersion[]packageVersions

Apex クラスの現在の状況。有効な文字列値は次のとおりです。ApexCodeUnitStatus(string 型の列挙)

status

• Active -クラスは有効です。• Deleted - クラスには削除のマークが付いています。管理パッ

ケージの更新時にクラスを削除できるため、管理パッケージに利用すると便利です。

メモ: ApexCodeUnitStatus には Inactiveオプションが含まれますが、ApexTrigger のみでサポートされており、ApexClass ではサポートされていません。

PackageVersion

PackageVersion は、管理パッケージのバージョンを識別します。パッケージバージョンは、パッケージでアップロードされる一連のコンポーネントを特定する番号です。バージョン番号の形式はmajorNumber.minorNumber.patchNumber (例: 2.1.3) です。メジャー番号とマイナー番号は、毎回のメジャーリリース時に指定した値に増えます。patchNumberは、パッチリリースにのみ生成および更新されます。APIバージョン 16.0 以降で使用できます。

説明データ型項目名必須。パッケージコンテキストでは、名前空間プレフィックスとは AppExchange にある自社パッケージとそのコンテンツを他の開

stringnamespace

発者のパッケージと区別するための 1 ～ 15 文字の英数字で構成される識別子です。名前空間プレフィックスでは、大文字小文字は区別されません。たとえば、ABC と abc は一意として認識されません。名前空間プレフィックスは、すべての Salesforce 組織にわたって必ずグローバルに一意なものを指定します。名前空間プレフィックスを使用することで、自社の管理パッケージのみを管理できるようになります。名前空間についての詳細は、Salesforce オンラインヘルプの「名前空間プレフィックスの登録」を参照してください。

必須。パッケージバージョンのメジャー番号。パッケージバージョン番号は、majorNumber.minorNumber形式です。

intmajorNumber

必須。パッケージバージョンのマイナー番号。パッケージバージョン番号は、majorNumber.minorNumber形式です。

intminorNumber

宣言的なメタデータの定義のサンプル次のサンプルでは、MyhelloWorld.clsクラスと、対応する MyHelloWorld.cls-meta.xmlメタデータファイルを作成します。

110

ApexClassメタデータ型

MyHelloWorld.clsファイル:

public class MyHelloWorld {// This method updates the Hello field on a list// of accounts.public static void addHelloWorld(Account[] accs){for (Account a:accs){if (a.Hello__c != 'World')a.Hello__c = 'World';}}}

MyHelloWorld.cls-meta.xml:

<?xml version="1.0" encoding="UTF-8"?><ApexClass xmlns="http://soap.sforce.com/2006/04/metadata">

<apiVersion>31.0</apiVersion></ApexClass>

関連リンクApexTrigger

ApexComponentVisualforce コンポーネントを表します。詳細は、Salesforce オンラインヘルプの「Visualforce の概要」を参照してください。このメタデータ型は、MetadataWithContent コンポーネントを拡張し、その項目を共有します。

宣言的なメタデータファイルのサフィックスおよびディレクトリの場所ページファイルのファイルサフィックスは、 .componentです。付随するメタデータファイルには、ComponentName-meta.xmlという名前が付けられます。Visualforce コンポーネントは、対応するパッケージディレクトリの componentsフォルダに保存されます。

バージョンVisualforce コンポーネントは、API バージョン 12.0 以降で使用できます。


説明データ型項目名この Visualforce コンポーネントの API バージョン。どのコンポーネントにも、作成時に API バージョンが指定されます。この項目は API バージョン 16.0 以降で使用できます。

doubleapiVersion

コンポーネントのコンテンツ。Base 64 で符号化されたバイナリデータ API コールを行う前に、クライアントアプリケーションは

base64Binarycontent

バイナリ添付データを base64 に符号化する必要があります。応答を受信したら、クライアントアプリケーションは、base64 データ

111

ApexComponentメタデータ型

説明データ型項目名をバイナリに復号化する必要があります。この変換は、通常 SOAPクライアントによって処理されます。この項目は、MetadataWithContent コンポーネントから継承されます。コンポーネントの機能の説明。stringdescription

API アクセスの一意の識別子として使用されるコンポーネントの開発者名。fullNameには、アンダースコアと英数字のみを使用で

stringfullName

きます。一意であること、最初は文字であること、空白は使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。この項目は、Metadataコンポーネントから継承されています。必須。このコンポーネントの表示ラベル。stringlabel

この Visualforce コンポーネントによって参照される、インストール済みの管理パッケージバージョンのリスト。


メモ: パッケージコンポーネントと Visualforce カスタムコンポーネントの概念は大きく異なります。パッケージは、カスタムオブジェクト、Apex クラスとトリガ、カスタムページおよびカスタムコンポーネントなどの、多くの要素で構成されます。

関連リンクApexPage

ApexPage1 つの Visualforce ページを表します。詳細は、Salesforce オンラインヘルプの「Visualforce の概要」を参照してください。このメタデータ型は、MetadataWithContent コンポーネントを拡張し、その項目を共有します。

宣言的なメタデータファイルのサフィックスおよびディレクトリの場所ページファイルのファイルサフィックスは、.pageです。付随するメタデータファイルには、PageName-meta.xml

という名前が付けられます。Visualforce ページは、対応するパッケージディレクトリの pagesフォルダに保存されます。

バージョンVisualforce ページは、API バージョン 11.0 以降で使用できます。


112

ApexPageメタデータ型

説明データ型項目名必須。このページの API バージョン。すべてのクラスには、作成時に指定された API バージョンが割り当てられ

doubleapiVersion

ています。この項目は API バージョン 15.0 以降で使用できます。この項目を 15.0 より小さい数値に設定すると、15.0 に変更されます。ページコンテンツ。Base 64 で符号化されたバイナリデータ API コールを行う前に、クライアントアプリケーショ

base64Binarycontent

ンはバイナリ添付データを base64 に符号化する必要があります。応答を受信したら、クライアントアプリケーションは、base64 データをバイナリに復号化する必要があります。この変換は、通常 SOAP クライアントによって処理されます。この項目は、MetadataWithContentコンポーネントから継承されます。ページが実行する内容の説明。stringdescription

APIアクセスの一意の識別子として使用されるページの開発者名。fullNameには、アンダースコアと英数字のみを

stringfullName

使用できます。一意であること、最初は文字であること、空白は使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。この項目は、Metadata コンポーネントから継承されています。Visualforceページに関連付けられているVisualforceタブをSalesforce1アプリケーションで使用できるかどうかを示し

booleanavailableInTouch

ます (Salesforce Touchでのこの項目の使用は廃止されました)。この項目は、API バージョン 27.0 以降で使用できます。Visualforce ページで上書きされる標準オブジェクトタブは、そのページにこの項目を設定しても、Salesforce1でサポートされません。Visualforce ページの代わりに、オブジェクトのデフォルトの Salesforce1 ページが表示されます。

ページの GET要求に CSRF 確認トークンが必要かどうかを示します。この項目は API バージョン 28.0 以降で使用できます。この項目の値をfalseからtrueに変更した場合は、ページへのリンクに CSRF トークンを追加しないとページにアクセスできなくなります。

booleanconfirmationTokenRequired

必須。このページの表示ラベル。stringlabel

この Visualforce ページによって参照される、インストールされた管理パッケージバージョンのリスト。


113

ApexPageメタデータ型

宣言的なメタデータの定義のサンプル次のサンプルではMyPage.pageページ、および対応するMyPage.page-meta.xmlメタデータファイルを作成します。SampleApexPage.pageファイル:

<apex:page><h1>Congratulations</h1>This is your new Page.</apex:page>

SampleApexPage.page-meta.xml:

<?xml version="1.0" encoding="UTF-8"?><ApexPage xmlns="http://soap.sforce.com/2006/04/metadata">

<description>This is a sample Visualforce page.</description><label>SampleApexPage</label>

</ApexPage>

関連リンクApexComponent

ApexTriggerApex トリガを表します。トリガは、オブジェクトレコードがデータベースに挿入される前や、レコードが削除された後など、特定のデータ操作言語 (DML) 行動が発生する前後に実行される Apex コードです。詳細は、Salesforce オンラインヘルプの「Apex トリガの管理」を参照してください。このメタデータ型は、MetadataWithContent コンポーネントを拡張し、その項目を共有します。

サポートされているコールdeploy()、retrieve()、describeMetadata()、listMetadata()

メモ: このメタデータ型は、create()、delete()、および update()コールでサポートされていません。

宣言的なメタデータファイルのサフィックスおよびディレクトリの場所トリガファイルのファイルサフィックスは .triggerです。付随するメタデータファイルには、TriggerName-meta.xmlという名前が付けられます。Apex トリガは、対応するパッケージディレクトリの triggersフォルダに保存されます。

バージョントリガは、API バージョン 10.0 以降で使用できます。


114

ApexTriggerメタデータ型

説明データ型項目名必須。このトリガの API バージョン。どのトリガにも、作成時にAPI バージョンが指定されます。

doubleapiVersion

Apex トリガの定義。この項目は、MetadataWithContent コンポーネントから継承されます。

base64content

Apex トリガ名。名前には、英数字、およびアンダースコア (_) 文字のみを使用できます。また、最初は文字とし、最後にアンダー

stringfullName

スコアを使用したり、連続した 2 つのアンダースコア文字を含めたりすることはできません。この項目は、Metadata コンポーネントから継承されています。この Apex トリガによって参照される、インストールされた管理パッケージバージョンのリスト。


必須。Apexトリガの現在の状況。有効な文字列値は次のとおりです。

ApexCodeUnitStatus(string 型の列挙)

status

• Active - トリガは有効です。• Inactive - トリガは無効ですが、削除されてはいません。• Deleted - トリガには削除のマークが付いています。管理パッ

ケージの更新時にトリガを削除できるため、管理パッケージの場合に便利です。

宣言的なメタデータの定義のサンプル次のサンプルでは、MyhelloWorld.triggerトリガと、対応する MyHelloWorld.trigger-meta.xmlメタデータファイルを作成します。MyHelloWorld.triggerファイル:

trigger helloWorldAccountTrigger on Account (before insert) {

Account[] accs = Trigger.new;

MyHelloWorld.addHelloWorld(accs);}

MyHelloWorld.trigger-meta.xml:

<?xml version="1.0" encoding="UTF-8"?><ApexTrigger xmlns="http://soap.sforce.com/2006/04/metadata">

<apiVersion>31.0</apiVersion></ApexTrigger>

関連リンクApexClass

AppMenuForce.com アプリケーションメニューまたは Salesforce1 ナビゲーションメニューを表します。

115

AppMenuメタデータ型

ファイルのサフィックスおよびディレクトリの場所各 AppMenu コンポーネントは、対応するパッケージディレクトリのフォルダ内の 1 つのファイルに保存されます。ファイル名には、Feature.appMenuという形式が使用されます。• AppSwitcher.appMenuという名前のファイルに 1 つのアプリケーションスイッチャのアプリケーションメ

ニューファイルが保存されます。• Salesforce1.appMenuという名前のファイルに 1 つの Salesforce1アプリケーションメニューファイルが保存

されます。appMenusフォルダにはこれら 2 つのファイルがあります。.appMenuファイルは、AppMenu コンポーネントごとにファイルが 1 つしかないため、他の名前付きコンポーネントとは異なります。アプリケーションメニューファイルの作成や削除はできません。

バージョンAppMenu コンポーネントは、API バージョン 30.0 以降で使用できます。

項目

説明データ型項目名アプリケーションメニュー内のメニュー項目のリスト。AppMenuItem[]appMenuItems

AppMenuItem

アプリケーションメニュー内のメニュー項目を表します。

説明項目のデータ型項目名項目の API 名。stringname

この項目で表されるアプリケーションの種別。AppSwitcher.appMenuの有効値は次のとおりです。

stringtype

• ConnectedApp

• CustomApplication

• ServiceProvider

Salesforce1.appMenuの有効値は次のとおりです。• CustomApplication

• CustomTab

• StandardAppMenuItem。この項目には次の名前を使用できます。◊ MyDay

◊ Feed

◊ ToDo

◊ Dashboards

◊ Search

◊ People (Chatter が有効な場合にのみ使用可能)◊ Groups (Chatter が有効な場合にのみ使用可能)

116


宣言的なメタデータの定義のサンプル次に、AppSwitcher.appMenu ファイルの例を示します。

<?xml version="1.0" encoding="UTF-8"?><AppMenu xmlns="http://soap.sforce.com/2006/04/metadata">

<appMenuItems><appMenuItem>

<name>standard__Sales</name><type>CustomApplication</type>

</appMenuItem><appMenuItem>

<name>standard__Support</name><type>CustomApplication</type>


<name>CustomApp1</name><type>CustomApplication</type>


<name>CustomApp2</name><type>CustomApplication</type>


<name>ConnectedApp1</name><type>ConnectedApp</type>

</appMenuItem></appMenuItems>

</AppMenu>

前の定義を参照する package.xmlの例を次に示します。


<types><members>AppSwitcher</members><name>AppMenu</name>

</types>

Salesforce1.appMenuコンポーネントの例を次に示します。

<?xml version="1.0" encoding="UTF-8"?><AppMenu xmlns="http://soap.sforce.com/2006/04/metadata">

<appMenuItems><appMenuItem>

<name>StandardItem1</name><type>StandardAppMenuItem</type>






<name>CustomTab1</name><type>CustomTab</type>

</appMenuItem></appMenuItems>

</AppMenu>

117




<types><members>Salesforce1</members><name>AppMenu</name>

</types>

組織の使用可能なすべてのアプリケーションメニューメタデータをリリースまたは取得するために使用される、パッケージマニフェストの例を次に示します。


<types><members>*</members><name>AppMenu</name>


</Package>

使用方法Force.comアプリケーションメニューに表示されるメニュー項目のリストを並び替えるには、AppSwitcher.appMenu

を使用します。AppSwitcher.appMenuにアプリケーションメニュー項目を追加したり、AppSwitcher.appMenu

からアプリケーションメニュー項目を削除したりすることはできません。アプリケーションメニュー項目を並び替え、追加、または削除することによって Salesforce1 ナビゲーションメニューに表示されるメニュー項目のリストをカスタマイズするには、Salesforce1.appMenuを使用します。

ApprovalProcess承認プロセスに関連付けられたメタデータを表します。承認プロセスは、Salesforce でレコードを承認する場合に、組織で使用できる自動化されたプロセスです。承認プロセスでは、承認するレコードの条件と各承認ステップの承認者を指定します。各承認ステップは、その承認プロセスの対象レコードすべてに適用することも、システム管理者が定義した特定の条件を満たすレコードのみに適用することもできます。承認プロセスでは、レコードの承認、却下、取り消しまたは最初の承認申請時に実施するアクションも指定します。Metadataメタデータ型を拡張し、その fullName項目を継承します。

メモ:

• メタデータ API と共に Salesforce ナレッジ記事の承認プロセスを使用するには、記事タイプをリリースする必要があります。承認プロセスの記事バージョン (_kav) の場合、サポートされるアクションの種別は、ナレッジアクション、メールアラート、項目自動更新、アウトバウンドメッセージになります。

• メールドラフトの送信アクションおよび承認プロセスは、Metadata API ではサポートされません。• メタデータには、有効承認プロセスの順序は含まれません。場合によっては、リリース後に対象組織

で承認プロセスを並び替える必要があります。• 組織に承認プロセスを実装する前に、Salesforceヘルプの「承認プロセスの考慮事項」を参照してくだ

さい。

118

ApprovalProcessメタデータ型

ファイルのサフィックスおよびディレクトリの場所ApprovalProcess コンポーネントのサフィックスは .approvalProcessで、approvalProcessesフォルダに保存されます。

バージョンApprovalProcess コンポーネントは、API バージョン 28.0 以降で使用できます。

項目

説明項目のデータ型項目名必須。承認プロセスがアクティブかどうか。承認プロセスを有効にした後に、その承認プロセスのステップの追加、削除、または順序の変更や、プ

booleanactive

ロセスの却下またはスキップの動作の変更はできません (プロセスを無効にしてもこれらの操作を行うことはできません)。

申請者に承認申請の取り消しを許可するかどうか。falseに設定されている場合、システム管理者のみが承認申請を取り消すことができます。

booleanallowRecall

必須。レコードの承認申請が許可されているユーザの配列。

ApprovalSubmitter[]allowedSubmitters

承認者がレコードを承認または却下する承認ページに表示する項目を指定します。デフォルトでは、次の項目が表示されます。

ApprovalPageFieldapprovalPageFields

• [名前]項目• [所有者]項目 (子オブジェクトを除く)

Salesforce1で通知を有効にしている場合、承認者がモバイルデバイスでこの項目のリストを参照可能になります。ユーザがレコードの承認または却下を決定する必要がある項目のみを選択してください。

承認ステップ定義の配列。ApprovalStep[]approvalStep

承認プロセスを説明します。stringdescription

承認申請に使用するメールテンプレートを指定します。指定されていない場合は、デフォルトのメールテンプレートが使用されます。承認プロセスによってユーザへ承認申請が割り当てられると、Salesforce からそのユーザに対して承認

stringemailTemplate

申請メールが送信されます。メールには Salesforceの承認ページへのリンクが記載されています。このリンクでは、ユーザが申請を承認または却下し、コメントを追加できます。

119


説明項目のデータ型項目名ユーザは Salesforce にログインせずに、モバイルデバイスのブラウザを含む任意のブラウザから承認

booleanenableMobileDeviceAccess

ページの外部バージョンにアクセスできるかどうか。ユーザインターフェースの[セキュリティ設定]

に対応します。trueに設定されている場合、承認ステップにtype

adhocの承認者を含めることはできません。falseに設定されている場合、承認者は Salesforceにログインして承認ページにアクセスする必要があります。

承認プロセスの対象となるレコードを決定します。承認プロセスをすべてのレコードに許可する場合は、この項目を除外します。

ApprovalEntryCriteriaentryCriteria

レコードに対するすべての承認申請が終了したときに実行するワークフローアクションを指定します。

ApprovalActionfinalApprovalActions

必要なすべての承認が終了した後でレコードをロックしたままにするかどうか。デフォルト: false。

booleanfinalApprovalRecordLock

レコードが最終却下状態に移行した後で実行するワークフローアクションを指定します。

ApprovalActionfinalRejectionActions

最終的に却下された後でレコードをロックしたままにするかどうか。デフォルト: false。

booleanfinalRejectionRecordLock

レコードの最初の承認申請時に実行するワークフローアクションを指定します。

ApprovalActioninitialSubmissionActions

必須。承認プロセスの名前。stringlabel

承認ステップに承認者を自動割り当てするために使用できる、標準またはカスタムユーザ階層項目を指定します。この項目を除外すると、承認ステップでユーザ階層項目を使用して承認者の自動割り当てができなくなります。

NextAutomatedApprovernextAutomatedApprover

Chatter での承認に使用する投稿テンプレート。Chatter投稿承認通知は、フィード追跡が有効になっているオブジェクトに関連付けられている承認プロセスでのみ使用可能です。

stringpostTemplate

未承認の申請を取り下げたときに実行するワークフローアクションを指定します。

ApprovalActionrecallActions

未承認のレコードを編集できるユーザを指定します。レコードは承認申請されると自動的にロックさ

RecordEditabilityType(string 型の列挙)

recordEditability

れ、承認プロセス中に他のユーザがそのレコードを

120


説明項目のデータ型項目名編集するのを防ぎます。有効な値は、次のとおりです。• AdminOnly — 未承認のレコードを編集できる

ユーザは、次のとおりです。◊ 「すべてのデータの編集」権限を持つユーザ◊ 指定のオブジェクトに対してオブジェクトレ

ベルで「すべての編集」権限を持つユーザ• AdminOrCurrentApprover — 未承認のレコード

を編集できるユーザは、次のとおりです。◊ 「すべてのデータの編集」権限を持つユーザ◊ 指定のオブジェクトに対してオブジェクトレ

ベルで「すべての編集」権限を持つユーザ◊ 指定のオブジェクトに対して、ユーザ権限お

よび組織の共有設定を介してレコードへの編集アクセス権を持つ、割り当て済みの承認者

承認申請の詳細を承認者が表示できレコードを承認または却下できる承認ページに、[承認履歴] 関連リ

booleanshowApprovalHistory

ストを追加するかどうか。[承認履歴] 関連リストは、レコードの承認プロセスを追跡します。[承認履歴] 関連リストをレコード詳細ページおよび編集ページにも追加する場合は、Salesforce ユーザインターフェースを使用して指定のオブジェクトのページレイアウトをカスタマイズします。

ApprovalSubmitter

レコードの承認を申請できるユーザまたはユーザセットを表します。

説明項目のデータ型項目名レコードの承認を申請できる特定のユーザまたはユーザセットを識別します。次のタイプが指定されsubmitter項目が無視される場合を除き、この項目は必須です。

stringsubmitter

• owner

• creator

• allInternalUsers

例:

<allowedSubmitters><type>allInternalUsers</type>

</allowedSubmitters><allowedSubmitters>

<submitter>myGroup</submitter><type>group</type>

</allowedSubmitters>

121


説明項目のデータ型項目名必須。レコードの承認を申請できるユーザまたはユーザセットの種別。有効な値は、次のとおりです。

ProcessSubmitterType(string 型の列挙)

type

• group

• role

• user

• roleSubordinates

• roleSubordinatesInternal

• owner

• creator

• partnerUser

• customerPortalUser

• portalRole

• portalRoleSubordinates

• allInternalUsers — 組織内のすべての Salesforce ユーザ。

ApprovalPageField

承認申請の詳細を承認者が表示できレコードを承認または却下できる承認ページに表示するために選択された項目を表します。

説明項目のデータ型項目名承認者がレコードを承認または却下する承認ページに表示する項目の配列。

string[]field

ApprovalStep

承認プロセスのステップを表します。承認ステップでは、承認申請をさまざまなユーザに割り当て、承認プロセスにおける承認のつながりを定義します。各承認ステップでは、その承認ステップに進むために必要なレコードの条件、そのレコードの申請を承認できるユーザ、および代理承認者による承認を許可するかどうかを指定します。承認プロセスの最初の承認ステップでは、レコードがこのステップの条件を満たさない場合に実施するアクションを指定します。その後のステップでは、却下時のアクションを指定することができます。

メモ:

• 承認プロセス定義の ApprovalStepエントリの順序によって、承認ステップの実行順序が決まります。

• 承認プロセスを有効にした後に、その承認プロセスのステップの追加、削除、または順序の変更や、プロセスの却下またはスキップの動作の変更はできません (プロセスを無効にしてもこれらの操作を行うことはできません)。

• ステップは、最大 30 に制限されています。

説明項目のデータ型項目名承認プロセスのこのステップで代理承認者を許可するかどうか。代理承認者は、割り当てられた承認者

booleanallowDelegate

により承認申請の承認代理として任命されたユーザです。

122


説明項目のデータ型項目名承認プロセスのこのステップでレコードが承認されたときに実行するワークフローアクションを指定します。

ApprovalActionapprovalActions

承認プロセスのこのステップに割り当てられた承認者を指定します。

ApprovalStepApproverassignedApprover

承認ステップを説明します。stringdescription

承認プロセスのこのステップの対象となるレコードを決定します。

ApprovalEntryCriteriaentryCriteria

開始条件を満たさないレコードに対する処理を指定します。有効な値は、次のとおりです。

StepCriteriaNotMetType(string 型の列挙)

ifCriteriaNotMet

• ApproveRecord — 申請を承認し、最終承認時のアクションをすべて実行します。

• RejectRecord — 申請を却下し、最終却下時のアクションをすべて実行します。このオプションは、承認プロセスの最初のステップでのみ表示されます。

• GotoNextStep — 次の承認ステップにスキップします。最初の承認ステップでこのオプションを選択し、レコードが他のステップの開始条件を満たさない場合、レコードは却下されます。

必須。承認ステップの名前。stringlabel

必須。承認ステップの一意の名前。アンダースコアと英数字のみを含むこと、最初は文字であること、

stringname

空白は使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。一意性は、特定の承認プロセス内でのみ必要です。承認プロセスの最初のステップを除き必須。承認プロセスの最初のステップでない場合に、承認者がこ

ApprovalStepRejectBehaviorrejectBehavior

の承認ステップで申請を却下したときの処理を指定します。承認プロセスの最初のステップで承認者が申請を却下した場合、却下時の処理はfinalRejectionActionsによって決まります。

承認プロセスのこのステップでレコードが却下されたときに実行するワークフローアクションを指定します。

ApprovalActionrejectionActions

ApprovalAction

承認プロセスの結果として発生するアクションを表します。

123


説明項目のデータ型項目名実行するワークフローアクションの配列。WorkflowActionReference[]action

ApprovalStepApprover

承認ステップに割り当てられた承認者を表します。承認者は、ステップごとに最大 25 人に制限されています。

説明項目のデータ型項目名承認プロセスのこのステップに割り当てられた承認者の配列。

Approver[]approver

ステップに複数の承認者が割り当てられている場合の、承認または却下の処理方法を指定します。有効な値は、次のとおりです。

RoutingType(string 型の列挙)

whenMultipleApprovers

• Unanimous — (デフォルト) このステップのすべての承認者から全員の承認を得る必要があります。いずれかの承認者が申請を却下すると、このステップの承認申請は却下されます。

• FirstResponse — 最初の返答に基づいて承認または却下します。

Approver

承認ステップに割り当てられた承認者を表します。メモ: 承認者を指定するときには、次の点に注意してください。• 割り当てられる承認者に、承認申請対象レコードの参照アクセス権を必ず付与してください。たとえ

ば、経費カスタムオブジェクトの参照アクセス権がないユーザは、経費承認申請を参照できません。• パートナーユーザに承認申請を割り当てることはできません。• 承認者にキューを割り当てた承認プロセスでは、メール承認は使用できません。• 承認者は、メールを使用して承認申請を承認または却下できる「API の有効化」システム権限が必要

です。• 1 つのステップで承認申請を同じユーザに複数回割り当てることもできますが、Salesforce はそのよう

な冗長性を認識すると、そのユーザに対して 1 つの承認しか申請しません。• レコードが承認ステップに進んだ後は、そのステップの承認者は変更されません。これは、承認プロ

セスが前のステップに戻されたときに、承認者を指定するユーザ項目が変更されている場合でも同様です。たとえば、承認プロセスの最初のステップでユーザのマネージャに承認を申請しているとします。2 番目のステップで承認申請が却下され最初のステップに戻された場合、承認申請は、ユーザのマネージャが現在変わっている場合でも、前回この申請を受け取ったマネージャに割り当てられます。

• 承認者にキューを割り当てた場合:

◊ すべてのキューメンバーが、そのキューに割り当てられた承認申請を承認または却下できます。◊ 承認申請メールは、キューのメールアドレスに送信されます。メンバーにメールを送信するように

キューが設定されている場合、キューメンバーにも承認申請メールが送信されます。ただし、承認ユーザ設定で承認申請メールを受信しないように設定しているキューメンバーには送信されません。

124


◊ 承認申請がキューに割り当てられると、各キューのメンバーの代理承認者も承認申請のメール通知を受信します。

◊ キューへのメール通知は外部利用者を対象としたものではないため、メールテンプレート内の差し込み項目 {!ApprovalRequest.External_URL}のインスタンスは、相当する内部 URL として送信されます。

◊ Salesforce1 での承認申請通知は、キューには送信されません。個人ユーザが Salesforce1 で承認申請通知を受信できるように、キューを伴う各承認ステップで、割り当てられた承認者としてそれらの個人ユーザを追加することをお勧めします。割り当てられた承認者としてキューと個人ユーザの両方を設定するには、承認ステップで [自動的にキューに割り当てる]の代わりに [自動的に承認者に割り当てる]を選択します。

◊ 承認申請が却下されて前の承認者に戻され、前の承認者がキューであった場合は、キューではなく承認したユーザに割り当てられます。

◊ [承認履歴] 関連リストの [割り当て先]列にキュー名が表示され、その承認申請を承認または却下した実際のユーザが [承認者]列に表示されます。

説明項目のデータ型項目名割り当てられた承認者を特定します。typeが次のいずれかでnameが無視される場合を除き、この項目は必須です。

stringname

• adhoc

• userHierarchyField

指定された nameと組み合わせて、割り当てられた承認者を特定します。有効な値は、次のとおりです。

NextOwnerType(string 型の列挙)

type

• adhoc — ステップの承認者を手動で選択する必要があります。最初のステップの場合は、申請者が承認者を選択します。2 番目以降のステップの場合は、前のステップの承認者が承認者を選択します。この値の場合は、name項目を除外します。

• user — 組織内のユーザ。この値の場合は、name項目にユーザ名を入力します。

• userHierarchyField — 標準またはカスタムユーザ階層項目 (標準[マネージャ]項目など) で指定されたユーザ。この値の場合は、name項目を除外します。ユーザ階層項目は、承認プロセスのnextAutomatedApproverで定義されている必要があります。

• relatedUserField — 申請されたレコードのユーザ参照項目 ([最終更新者]項目など) で指定されたユーザ。この値の場合は、name項目にユーザ参照項目の名前を入力します。

• queue — 自動的にキューに割り当てます。この値の場合は、name項目にキューの名前を入力します。

ApprovalEntryCriteria

レコードが承認プロセスまたは承認ステップに進むための条件を表します。検索条件または数式のいずれかを指定します。両方は指定できません。

125


説明項目のデータ型項目名criteriaItemsの検索条件ロジック。formulaを入力する場合は、この項目を除外します。

stringbooleanFilter

レコードが承認プロセスまたは承認ステップに進むための検索条件。承認プロセスでは、検索条件の valueFieldエントリをサポートしていません。

FilterItem[]criteriaItems

レコードが承認プロセスまたは承認ステップに進むためにレコードを true と評価する数式。

stringformula

ApprovalStepRejectBehavior

承認プロセスの最初のステップでない場合に、承認者がこの承認ステップで申請を却下したときの処理を表します。承認プロセスの最初のステップの場合、却下時の処理は承認プロセスの最終却下時のアクションによって決まります。

説明項目のデータ型項目名有効な値は、次のとおりです。StepRejectBehaviorType

(string 型の列挙)type

• RejectRequest — これまでに承認されたステップに関係なく、申請を自動的に最終却下します。Salesforceは、このステップのすべての却下時のアクションと、最終却下時のすべてのアクションを実行します。

• BackToPrevious — 申請を自動的に却下し、承認申請を前の承認者に戻します。Salesforce は、このステップのすべての却下時のアクションを実行します。承認プロセスの最初のステップでは無効です。

NextAutomatedApprover

承認プロセスの次の承認者として使用するユーザ階層項目を表します。定義されていると、階層項目で指定されたユーザを、1 つ以上の承認ステップで承認者として自動的に割り当てることができます。

説明項目のデータ型

項目名

必須。申請者のユーザレコードではなく、レコード所有者のユーザレコードで指定された userHierarchyFieldを承

booleanuseApproverFieldOfRecordOwner

認者として最初に実行される承認ステップで使用すべきかどうか。残りのすべてのステップでは、前のステップの承認者のユーザレコードで指定された userHierarchyField

が使用されます。必須。承認者として割り当てるユーザを指定する値を持つ、標準またはカスタムユーザ階層項目。たとえば、標準 [マ

stringuserHierarchyField

ネージャ]階層項目を使用して、従業員の有給休暇申請の承認者を割り当てることができます。割り当てられる承認者に、承認申請対象レコードの参照アクセス権を必ず付与してください。たとえば、経費カスタ

126



項目名

ムオブジェクトの参照アクセス権がないユーザは、経費承認申請を参照できません。

宣言的なメタデータの定義のサンプル次に、ApprovalProcess コンポーネントの例を示します。

<?xml version="1.0" encoding="UTF-8"?><ApprovalProcess xmlns="http://soap.sforce.com/2006/04/metadata">

<active>false</active><allowRecall>false</allowRecall><allowedSubmitters>

<type>owner</type></allowedSubmitters><allowedSubmitters>

<submitter>USSalesRep</submitter><type>role</type>


<submitter>MarketingGroup</submitter><type>group</type>


<submitter>[email protected]</submitter><type>user</type>

</allowedSubmitters><approvalPageFields>

<field>Name</field><field>Owner</field><field>MyLeadCustomField__c</field><field>Address</field>

</approvalPageFields><approvalStep>

<allowDelegate>false</allowDelegate><approvalActions>

<action><name>LeadApprovedTask1</name><type>Task</type>

</action><action>

<name>LeadApprovedTask2</name><type>Task</type>

</action></approvalActions><assignedApprover>

<approver><type>adhoc</type>

</approver></assignedApprover><label>Step1</label><name>Step1</name><rejectionActions>

<action><name>LeadRejectedTask</name><type>Task</type>

</action></rejectionActions>

</approvalStep><approvalStep>

<allowDelegate>false</allowDelegate><assignedApprover>

<approver><type>userHierarchyField</type>

127


</approver></assignedApprover><entryCriteria>

<criteriaItems><field>Lead.CreatedDate</field><operation>greaterThan</operation><value>3/25/2013</value>

</criteriaItems><criteriaItems>

<field>User.IsActive</field><operation>notEqual</operation><value>true</value>

</criteriaItems></entryCriteria><ifCriteriaNotMet>ApproveRecord</ifCriteriaNotMet><label>Step2</label><name>Step2</name><rejectBehavior>

<type>RejectRequest</type></rejectBehavior>

</approvalStep><approvalStep>

<allowDelegate>true</allowDelegate><assignedApprover>

<approver><name>MarketingTeamQueue</name><type>queue</type>

</approver><approver>

<name>LastModifiedBy</name><type>relatedUserField</type>

</approver><approver>

<name>[email protected]</name><type>user</type>

</approver><whenMultipleApprovers>FirstResponse</whenMultipleApprovers>

</assignedApprover><entryCriteria>

<formula>CONTAINS( MyLeadCustomField__c , 'Salesforce')</formula></entryCriteria><label>Step3</label><name>Step3</name><rejectBehavior>

<type>BackToPrevious</type></rejectBehavior>

</approvalStep><emailTemplate>MyFolder/LeadsNewassignmentnotification</emailTemplate><enableMobileDeviceAccess>false</enableMobileDeviceAccess><entryCriteria>

<criteriaItems><field>Lead.AnnualRevenue</field><operation>greaterThan</operation><value>10500</value>


<field>Lead.MyLeadCustomField__c</field><operation>equals</operation><value>Salesforce</value>

</criteriaItems></entryCriteria><finalApprovalActions>

<action><name>LeadEmailContacted</name><type>Alert</type>

</action></finalApprovalActions><finalApprovalRecordLock>true</finalApprovalRecordLock><finalRejectionActions>

128


<action><name>ProcessRejectedMessageAction</name><type>OutboundMessage</type>

</action></finalRejectionActions><finalRejectionRecordLock>false</finalRejectionRecordLock><initialSubmissionActions>

<action><name>LeadFieldUpdate</name><type>FieldUpdate</type>

</action><action>

<name>NewLeadEmail</name><type>Alert</type>

</action></initialSubmissionActions><label>SampleProcess</label><nextAutomatedApprover>

<useApproverFieldOfRecordOwner>false</useApproverFieldOfRecordOwner><userHierarchyField>customlookupuserfield__c</userHierarchyField>

</nextAutomatedApprover><postTemplate>MyPostTemplate</postTemplate><recallActions>

<action><name>ProcessRecalledMessageAction</name><type>OutboundMessage</type>

</action></recallActions><recordEditability>AdminOnly</recordEditability><showApprovalHistory>false</showApprovalHistory>

</ApprovalProcess>

AssignmentRules適切なユーザまたはキューに自動的にケースを転送できる割り当てルールを表します。該当するすべてのオブジェクト、特定のオブジェクト、または特定のオブジェクトの特定のルールのルールメタデータにアクセスできます。すべてのオブジェクトのすべての割り当てルールにアクセスする package.xml構文は次のとおりです。

<types><members>*</members><name>AssignmentRules</name>

</types>

特定のオブジェクトのすべてのルールでは、ワイルドカードを使用しない類似の構文が使用されます。たとえば、Case オブジェクトのすべての割り当てルールでは、次の構文が使用されます。

<types><members>Case</members><name>AssignmentRules</name>

</types>

オブジェクトの特定の割り当てルールにもアクセスできます。次の例では、Case オブジェクトの「samplerule」および「newrule」割り当てルールのみにアクセスできます。この例では、型名の構文はAssignmentRulesではなく、AssignmentRuleです。

<types><members>Case.samplerule</members><members>Case.newrule</members>

129

AssignmentRulesメタデータ型

<name>AssignmentRule</name></types>

ファイルのサフィックスおよびディレクトリの場所オブジェクトの割り当てルールのサフィックスは .assignmentRulesで、assignmentRulesフォルダに保存されます。たとえば、すべての Case 割り当てルールは、Case.assignmentRulesファイルに保存されます。

バージョンAssignmentRules コンポーネントは、API バージョン 27.0 以降で使用できます。

項目

説明項目のデータ型項目名指定した割り当てルールの定義を表します。AssignmentRule[]assignmentRule

AssignmentRule

ルールが有効であるかどうか、およびその定義を指定します。ルールは AssignmentRules コンテナ内に表示される順序で処理されます。

説明項目のデータ型項目名割り当てルールが有効であるか (true)、否か(false) を示します。

booleanactive

Metadata から継承されるこの項目は、このメタデータ型の WSDL では定義されません。作成時、

stringfullname

更新時、または削除時に指定する必要があります。コールにおけるこの項目の例を確認するには、「create()」を参照してください。この値は nullにできません。

割り当てルールの種類と説明を表します。RuleEntry[]ruleEntry

RuleEntry

ルールで使用される項目を表します。

説明項目のデータ型項目名項目が割り当てられるユーザまたはキューの名前。

stringassignedTo

有効な値は、次のとおりです。AssignToLookupValueType

(string 型の列挙)assignedToType

• User

• Queue

ルールに指定されている高度な絞り込み条件。stringbooleanFilter

割り当て条件を定義するリストの項目。FilterItem[]criteriaItems

130


説明項目のデータ型項目名入力規則数式。stringformula

メモ: formulaと criteriaItemsのいずれかを指定します。両方の項目は指定できません。

割り当てが完了したらケースチームをリセットするか (true)、または前のチームを置き換える代

booleanoverrideExistingTeams

わりに現在のチームをケースに追加するか (false)を指定します。ケースチームの名前。0 回以上発生する場合があります。

string[]team

指定した受信者に自動送信されるメールで使用されるテンプレートを指定します。

stringtemplate

宣言的なメタデータの定義のサンプルCase オブジェクトの 2 つの割り当てルールを示すファイルの例を次に示します。

<AssignmentRules xmlns="http://soap.sforce.com/2006/04/metadata"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

<assignmentRule><fullName>samplerule</fullName><active>false</active><ruleEntry>

<assignedTo>[email protected]</assignedTo><assignedToType>User</assignedToType><criteriaItems>

<field>Case.IsEscalated</field><operation>equals</operation><value>True</value>

</criteriaItems><template>emailtemplate</template>

</ruleEntry></assignmentRule><assignmentRule>

<fullName>Another samplerule</fullName><active>false</active><ruleEntry>

<assignedTo>[email protected]</assignedTo><assignedToType>User</assignedToType><criteriaItems>

<field>Case.IsEscalated</field><operation>equals</operation><value>False</value>

</criteriaItems><template>emailtemplate</template>

</ruleEntry></assignmentRule>

</AssignmentRules>

131


AuthProvider組織の認証プロバイダを表します。認証プロバイダは Facebook©や Janrain©などの外部サービスプロバイダのログイン情報を使用して、Salesforce 組織にユーザがログインできるようにします。Metadata メタデータ型を拡張し、その fullName項目を継承します。

ファイルのサフィックスおよびディレクトリの場所認証プロバイダは authprovidersディレクトリに保存されます。ファイル名は URL サフィックスに一致し、拡張子は.authproviderです。たとえば、URL サフィックスがFacebookProviderという認証プロバイダは、authproviders/FacebookProvider.authproviderに保存されます。

バージョン認証プロバイダは、API バージョン 27.0 以降で使用できます。

特別なアクセスルールこのオブジェクトにアクセスできるのは、「アプリケーションのカスタマイズ」権限および「認証プロバイダの管理」権限のあるユーザのみです。

項目

説明項目のデータ型項目名providerTypeが OpenIdConnectである場合にのみ必須です。OAuth 認証エンドポイント URL。OpenID Connect 認証

stringauthorizeUrl

プロバイダでのみ使用されます。API バージョン 29.0 以降で利用できます。必須。サードパーティのシングルサインオンプロバイダに登録されているアプリケーションの鍵。

stringconsumerKey

必須。サードパーティのシングルサインオンプロバイダに登録されているアプリケーションのコンシューマの秘密。この

stringconsumerSecret

項目は更新できません。create()を使用する場合、この項目は暗号化する必要があります。テキスト形式から暗号化形式のコンシューマの秘密を作成する手順は、次のとおりです。1. consumerSecretプレーンテキスト値を使用して認証プロ

バイダを作成します。2. 認証プロバイダを保存します。3. 認証プロバイダコンポーネントを含む送信変更セットを作

成します。新規変更セットの .xml ファイルには<consumerSecret>++XYZ++</consumerSecret>という形式の入力があります。++XYZ++ は暗号化された秘密です。providerTypeが OpenIdConnectである場合にのみ必須です。フローの開始時に指定されていない場合に、認証要求で

stringdefaultScopes

132

AuthProviderメタデータ型

説明項目のデータ型項目名送信される範囲。OpenID Connect 認証プロバイダでのみ使用されます。API バージョン 29.0 以降で利用できます。必須。プログラムから認証プロバイダを参照するときに使用します。

stringDeveloperName

エラーのレポートに使用するプロバイダのカスタムエラーURL。

stringerrorUrl

Apexハンドラクラスを実行するユーザ。このユーザは「ユーザの管理」権限を持っている必要があります。登録ハンドラクラスを指定した場合は、ユーザが必要です。

stringexecutionUserId

必須。わかりやすいプロバイダ名。stringfriendlyName

providerTypeが OpenIdConnectの場合にのみ使用できます。この値には、認証トークンのソースを https: URI形式

stringidTokenIssuer

で指定します。OpenID Connect 認証プロバイダでのみ使用されます。指定されている場合、Salesforceは返されたid_token

値を検証します。OpenID Connect 仕様では、id_token値と一緒にaccess_token値を返す必要があります。APIバージョン 30.0 以降で利用できます。必須。使用するサードパーティのシングルサインオンプロバイダ。有効な値は、次のとおりです。

AuthProviderType

(string 型の列挙)providerType

• Facebook

• Salesforce

• Janrain

• OpenIdConnect (API バージョン 29.0 以降で使用可能)

メモ: この型には、次の項目に値が必要です。◊ authorizeUrl

◊ defaultScopes

◊ tokenUrl

◊ userInfoUrl

• 通常、MicrosoftACS Microsoft アクセスコントロールサービスは、SharePoint® Online などの Microsoft Office 365 サービスの認証を提供します (API バージョン 31.0 以降で使用可能)。

Auth.RegistrationHandlerインターフェースを実装する既存の Apex クラス。

stringregistrationHandler

providerTypeが OpenIdConnectの場合にのみ必須です。trueの場合、アクセストークンはクエリ文字列ではなくヘッ

booleansendAccessTokenInHeader

ダーで userInfoUrlに送信されます。OpenID Connect 認証プロバイダでのみ使用されます。API バージョン 30.0 以降で利用できます。

133

AuthProviderメタデータ型

説明項目のデータ型項目名providerTypeが OpenIdConnectの場合にのみ必須です。trueの場合、クライアントログイン情報はクエリ文字列では

booleansendClientCredentialsInHeader

なくヘッダーで tokenUrlに送信されます。ログイン情報には、標準の OpenID Connect 基本ログイン情報ヘッダー形式Basic <token>が使用されます。ここで<token>は、base64符号化文字列 "clientkey:clientsecret"です。OpenIDConnect 認証プロバイダでのみ使用されます。APIバージョン30.0 以降で利用できます。providerTypeが OpenIdConnectである場合にのみ必須です。OAuth トークンエンドポイント URL。OpenID Connect

stringtokenUrl

認証プロバイダでのみ使用されます。API バージョン 29.0 以降で利用できます。providerTypeが OpenIdConnectである場合にのみ必須です。OpenID Connect エンドポイント URL。OpenID Connect

stringuserInfoUrl

認証プロバイダでのみ使用されます。API バージョン 29.0 以降で利用できます。


<?xml version="1.0" encoding="UTF-8"?><AuthProvider xmlns="http://soap.sforce.com/2006/04/metadata">

<consumerKey>yourappkey</consumerKey><consumerSecret>PwdVxXjzu3NCZ3MD4He+wA==</consumerSecret><executionUser>[email protected]</executionUser><friendlyName>FacebookAuthProvider</friendlyName><providerType>Facebook</providerType><registrationHandler>RegistrationHandler</registrationHandler>

</AuthProvider>

前の AuthProvider 定義を参照するパッケージマニフェストの例を次に示します。


<types><members>AuthProvider</members><name>FacebookProvider</name>


</Package>

AutoResponseRules提出されたレコードの属性に基づいてリードまたはケース登録に自動メールレスポンスを送信する条件を設定する自動レスポンスルールを表します。該当するすべてのオブジェクト、特定のオブジェクト、または特定のオブジェクトの特定のルールのルールメタデータにアクセスできます。すべてのオブジェクトのすべての自動レスポンスルールにアクセスする package.xml構文は次のとおりです。

<types><members>*</members>

134

AutoResponseRulesメタデータ型

<name>AutoResponseRules</name></types>

特定のオブジェクトのすべてのルールでは、ワイルドカードを使用しない類似の構文が使用されます。たとえば、Case オブジェクトのすべての自動レスポンスルールでは、次の構文が使用されます。

<types><members>Case</members><name>AutoResponseRules</name>

</types>

オブジェクトの特定の自動レスポンスルールにもアクセスできます。次の例では、Case オブジェクトの「samplerule」および「newrule」自動レスポンスルールのみにアクセスできます。この例では、型名の構文はAutoResponseRulesではなく、AutoResponseRuleです。

<types><members>Case.samplerule</members><members>Case.newrule</members><name>AutoResponseRule</name>

</types>

ファイルのサフィックスおよびディレクトリの場所オブジェクトの AutoResponseRules のサフィックスは .autoResponseRulesで、autoResponseRulesフォルダに保存されます。たとえば、すべてのケース自動レスポンスルールは、Case.autoResponseRulesファイルに保存されます。

バージョンAutoResponseRules コンポーネントは、API バージョン 27.0 以降で使用できます。

項目

説明項目のデータ型項目名指定した自動レスポンスルールの定義を表します。AutoResponseRule[]autoresponseRule

AutoResponseRule

ルールが有効であるかどうかと、ルールで処理される項目の順序を表します。

説明項目のデータ型項目名自動レスポンスルールが有効であるか (true)、否か (false) を示します。

booleanactive


stringfullname


135

AutoResponseRulesメタデータ型

説明項目のデータ型項目名自動レスポンスルールの種類と説明を表します。RuleEntry[]ruleEntry

RuleEntry


説明項目のデータ型項目名ルールに指定されている高度な絞り込み条件。stringbooleanFilter

割り当て条件を定義するリストの項目。FilterItem[]criteriaItems

入力規則数式。stringformula


reply-to ヘッダーに表示されるメールアドレス。stringreplyToEmail

メール通知を送信する個人またはキューのメールアドレス。

stringsenderEmail

メール通知を送信する個人またはキューの名前。stringsenderName

指定した受信者に自動送信されるメールで使用されるテンプレートを指定します。

stringtemplate

宣言的なメタデータの定義のサンプルAutoResponseRules コンポーネントの例を次に示します。

<AutoResponseRules xmlns="http://soap.sforce.com/2006/04/metadata"><autoResponseRule>

<fullName>ajbdeploytest2</fullName><active>false</active><ruleEntry>

<criteriaItems><field>Case.Description</field><operation>contains</operation><value>testing</value>

</criteriaItems><senderEmail>[email protected]</senderEmail><senderName>tester name j</senderName><replyToEmail>test@@test.org</replyToEmail><template>emailtemplate</template>

</ruleEntry></autoResponseRule>

</AutoResponseRules>

CallCenterSalesforceをサードパーティのコンピュータテレフォニーインテグレーション (CTI) システムと統合するために使用されるコールセンター定義を表します。

136

CallCenterメタデータ型

ファイルのサフィックスおよびディレクトリの場所CallCenter コンポーネントのサフィックスは callCenterで、callCentersフォルダに保存されます。

バージョンCallCenter コンポーネントは、API バージョン 27.0 以降で使用できます。

項目

説明項目のデータ型項目名省略可能な項目。CTI 4 アダプタを示す URL。stringadapterUrl

このコールセンターの表示名。stringdisplayName

コールセンター設定ページのdisplayName項目の表示ラベル。

stringdisplayNameLabel

コールセンター設定ページの internalName項目の表示ラベル。

stringinternalNameLabel

このコールセンターのバージョン。stringversion

このコールセンターに定義されたカスタム設定項目。CallCenterSection[]sections

CallCenterSection

説明項目のデータ型項目名セクションを説明する表示ラベル、名前、値が表示されます。

CallCenterItem[] (ページ 137)items

セクションの表示ラベル。stringlabel

セクションの名前。stringname

CallCenterItem

説明項目のデータ型項目名カスタム設定項目の表示ラベル。stringlabel

カスタム設定項目の名前。stringname

カスタム設定項目の値。int または URLvalue

宣言的なメタデータの定義のサンプルCallCenter コンポーネントの例を次に示します。

<?xml version="1.0" encoding="UTF-8"?><CallCenter xmlns="http://soap.sforce.com/2006/04/metadata">

<adapterUrl>http://localhost:11000</adapterUrl><displayName>Demo Call Center Adapter</displayName><displayNameLabel>Display Name</displayNameLabel><internalNameLabel>Internal Name</internalNameLabel><sections>

137

CallCenterメタデータ型

<items><label>Description</label><name>reqDescription</name><value>Demo Call Center Adapter</value>

</items><items>

<label>CTI Connector ProgId</label><name>reqProgId</name><value>DemoAdapter.DemoAdapter.1</value>

</items><items>

<label>Version</label><name>reqVersion</name><value>3.0</value>

</items><items>

<label>CTI Adapter URL</label><name>reqAdapterUrl</name><value>http://localhost:11000</value>

</items><label>General Information</label><name>reqGeneralInfo</name>

</sections><sections>

<items><label>Outside Prefix</label><name>reqOutsidePrefix</name><value>1</value>

</items><items>

<label>Long Distance Prefix</label><name>reqLongDistPrefix</name><value>1</value>

</items><items>

<label>International Prefix</label><name>reqInternationalPrefix</name><value>01</value>

</items><label>Dialing Options</label><name>reqDialingOptions</name>

</sections><version>4</version>

</CallCenter>

Community (Zone)メモ: Summer '13 リリース以降では、Chatter アンサーおよびアイデア「コミュニティ」の名前が「ゾーン」に変わりました。API バージョン 28 では、API オブジェクトの表示ラベルが Zoneに変わりましたが、API 種別は Communityのままです。

アイデアオブジェクトまたは Chatter アンサーオブジェクトを含むゾーンを表します。ゾーンは、アイデア、アンサー、および Chatter アンサー機能で共有されるため、このどこからでもゾーンを表示および作成できます。Metadata メタデータ型を拡張し、その fullName項目を継承します。

メモ: enableChatterAnswersが falseに設定されている場合、communityFeedPage、emailFooterDocument、emailHeaderDocument、enablePrivateQuestions、emailNotificationUrl、および site項目に指定した値は無視され、保存されません。

138

Community (Zone)メタデータ型

ファイルのサフィックスおよびディレクトリの場所ゾーンのサフィックスは communityで、communitiesフォルダに保存されます。

バージョンCommunity (Zone) コンポーネントは、API バージョン 27.0 以降で使用できます。

項目

説明項目のデータ型項目名ゾーンが有効であるか (true)、否か (false) を示します。booleanactive

ゾーンのフィードがホストされる Visualforce ページ。この項目は、組織でChatter アンサーが有効になっている場合に使用できます。

stringcommunityFeedPage

ゾーンの説明。stringdescription

組織のブランド情報をメール通知のフッターに組み込むテキストファイルまたは HTML ファイル。この項目は、組織

stringemailFooterDocument

で Chatter アンサーが有効になっている場合に使用できます。組織のブランド情報をメール通知のヘッダーに組み込むテキストファイルまたは HTML ファイル。この項目は、組織

stringemailHeaderDocument

で Chatter アンサーが有効になっている場合に使用できます。メール通知に含まれる URL。この項目は、組織で Chatterアンサーが有効になっている場合に使用できます。この項

stringemailNotificationUrl

目は API バージョン 28.0 以降のportalEmailNotificationUrlに置き換わるものです。ゾーンで Chatter アンサーが有効化されているか (true)、否か (false) を示します。この項目は、組織で Chatter アンサーが有効になっている場合に使用できます。

booleanenableChatterAnswers

Chatter アンサーの質問をケースにエスカレーションできるか (true)、否か (false) を示します。この項目は、組織でChatter アンサーが有効になっている場合に使用できます。

booleanenablePrivateQuestions

ゾーンのエキスパートの役割を果たす公開グループの名前。この項目は、組織でアイデアまたはアンサーが有効になっている場合に使用できます。

stringexpertsGroup

ゾーンが表示されるポータルの名前。stringportal

メール通知に含まれるポータル URL。この項目は、組織でChatter アンサーが有効になっている場合に使用できます。

stringportalEmailNotificationUrl

この項目は API バージョン 28.0 以降のemailNotificationUrlに置き換わるものです。定義する各評価レベルの名前とポイントを定義する項目。評価レベルは、1 ゾーンにつき 25 個まで作成できます。

ReputationLevelsreputationLevels

139


説明項目のデータ型項目名ゾーンをすべてのポータルで使用できるか (true)、いずれのポータルでも使用できないか (false) を示します。

booleanshowInPortal

ゾーンのサイトの名前。この項目は、組織で Chatter アンサーが有効になっている場合に使用できます。

stringsite

ReputationLevels

フィードでユーザの写真の上にマウスを置くと表示されるポイントと評価レベルを表します。

説明項目のデータ型項目名Chatter アンサーの評価レベルを説明する名前と値のペアが含まれます。API バージョン 28.0 以降で利用できます。

ChatterAnswersReputationLevel[]

chatterAnswersReputationLevels

アイデアの評価レベルを説明する名前と値のペアが含まれます。API バージョン 28.0 以降で利用できます。

IdeaReputationLevelideaReputationLevels

ChatterAnswersReputationLevel

Chatter アンサーの評価名およびそのレベルのポイント数を表します。

説明項目のデータ型項目名評価レベルの名前。たとえば「エキスパート」など。stringname

評価レベルの最小ポイント数。intvalue

IdeaReputationLevel

アイデアの評価名およびそのレベルのポイント数を表します。API バージョン 28.0 以降で利用できます。

説明項目のデータ型項目名評価レベルの名前。たとえば「エキスパート」など。stringname

評価レベルの最小ポイント数。intvalue

宣言的なメタデータの定義のサンプル次に、Community (Zone) コンポーネントの定義を示します。

<?xml version="1.0" encoding="UTF-8"?><Community xmlns="http://soap.sforce.com/2006/04/metadata">

<active>true</active><communityFeedPage>communityWithHeaderAndFooter_main</communityFeedPage><description>Metadata Test</description><emailFooterDocument>sampleFolder/emailFooter.html</emailFooterDocument><emailHeaderDocument>sampleFolder/emailHeader.html</emailHeaderDocument><enableChatterAnswers>true</enableChatterAnswers><enablePrivateQuestions>true</enablePrivateQuestions><expertsGroup>CommunityExperts</expertsGroup><portal>Customer Portal</portal>

140


<emailNotificationUrl>http://yourURL</emailNotificationUrl><reputationLevels>

<chatterAnswersReputationLevels><name>Newbie</name><value>0</value>

</chatterAnswersReputationLevels><chatterAnswersReputationLevels>

<name>Smartie</name><value>500</value>


<name>Pro</name><value>2000</value>


<name>All Star</name><value>5000</value>

</chatterAnswersReputationLevels><ideaReputationLevels>

<name>Observer</name><value>0</value>

</ideaReputationLevels><ideaReputationLevels>

<name>Contributor</name><value>100</value>


<name>Influencer</name><value>400</value>


<name>Thought Leader</name><value>1500</value>

</ideaReputationLevels></reputationLevels><showInPortal>true</showInPortal><site>ChatterAnswersSite</site>

</Community>

ConnectedApp接続アプリケーション設定を表します。接続アプリケーションは、API を使用して Salesforce と統合します。接続アプリケーションでは、標準の SAML および OAuth プロトコルを使用して認証して、シングルサインオンを提供し、Salesforce API を使用してトークンを提供します。標準の OAuth 機能に加え、接続アプリケーションでは、システム管理者はさまざまなセキュリティポリシーを設定したり、対応するアプリケーションを使用できるユーザを明示的に制御したりできます。Metadata メタデータ型を拡張し、その fullName項目を継承します。

ファイルのサフィックスおよびディレクトリの場所ConnectedApp コンポーネントのサフィックスは.connectedappで、connectedappsフォルダに保存されます。

バージョンConnectedApp コンポーネントは、API バージョン 29.0 以降で使用できます。

項目

説明項目のデータ型項目名接続アプリケーションのカスタム属性。ConnectedAppAttributeattributes

141

ConnectedAppメタデータ型

説明項目のデータ型項目名キャンバスアプリケーションとして公開されている場合の接続アプリケーションの設定オプション。

ConnectedAppCanvasConfigcanvasConfig

salesforce.comがアプリケーション提供者またはそのサポートチームへの連絡に使用するメールアドレス。

stringcontactEmail

salesforce.comから連絡する必要がある場合に使用する電話番号。

stringcontactPhone

アプリケーションの説明 (省略可能)。stringdescription

将来の使用のために予約されています。stringiconUrl

アプリケーションについての詳細が記載された Web ページの URL (省略可能)。

stringinfoUrl

接続アプリケーションでのユーザの認証を必要とせずにアプリケーションにアクセス可能な IP アドレスの範囲を指定します。

ConnectedAppIpRangeipRanges

アプリケーションの名前。stringlabel

アプリケーションのロゴ (省略可能)。このロゴは、認証時にユーザに表示されるアプリケーションリストおよび同意

stringlogoUrl

ページのアプリケーションのエントリに表示されます。URL には HTTPS を使用し、ロゴは 125×200 ピクセル (高さ×幅) 以下にする必要があります。デフォルトは雲のロゴです。モバイルデバイスからアプリケーションにアクセスするときに、認証後、ユーザはこの URL に転送されます。URL

stringmobileStartUrl

を指定しない場合、ユーザは認証完了後アプリケーションのデフォルトのスタートページに転送されます。作成中の接続アプリケーションがキャンバスアプリケーションである場合は、この項目に値を入力する必要はありません。[キャンバスアプリケーションの URL] 項目には、接続アプリケーションからコールされる URL が含まれます。アプリケーションが Salesforce と通信する方法を指定します。

ConnectedAppOauthConfigoauthConfig

アプリケーションによるシングルサインオンの使用方法を制御します。

ConnectedAppSamlConfigsamlConfig

モバイルデバイスからのアクセスでない場合、認証後、ユーザはこの URL に転送されます。URL を指定しない場

stringstartUrl

合、ユーザは認証完了後アプリケーションのデフォルトのスタートページに転送されます。モバイルデバイスからアプリケーションにアクセスする場合、mobileStartUrlを参照してください。作成中の接続アプリケーションがキャンバスアプリケーションである場合は、この項目に値を入力する必要はありません。[キャンバスアプリケーションの URL] 項目には、接続アプリケーションからコールされる URL が含まれます。

142


ConnectedAppAttribute

SAML と ConnectedApp を併用する場合にカスタム属性を構成する項目名を表します。これらの値は、特定のサービスプロバイダに合わせて調整する必要があります。

説明項目のデータ型項目名属性の値。stringformula

属性の識別子。stringkey

ConnectedAppCanvasConfig

キャンバスアプリケーションとして公開されている場合の接続アプリケーションの設定オプション。

説明項目のデータ型項目名キャンバスアプリケーションで OAuth 認証フローを開始する方法を示します。有効な値は、次のとおりです。

AccessMethod (string 型の列挙)

accessMethod

• Get — OAuth 認証が使用され、サードパーティアプリケーションがユーザ情報にアクセスすることを許可するように求められます。このアクセスメソッドを使用する場合、キャンバスアプリケーションで OAuth 認証フローが開始されるようにする必要があります。

• Post — OAuth 認証を使用しますが、システム管理者がキャンバスアプリケーションをインストールする場合、キャンバスアプリケーションはユーザのアクセスを暗黙的に許可します。したがって、サードパーティがユーザ情報にアクセスすることを許可するように求められることはありません。このアクセスメソッドを使用する場合、認証は直接キャンバスアプリケーションの URL に post 送信されます。

キャンバスアプリケーションとして公開されたサードパーティアプリケーションの URL。

stringcanvasUrl

Canvas.CanvasLifecycleHandler Apex クラスの名前 (カスタムパラメータの制御にこのクラスを実装している場合)。この項目は API バージョン 31.0 以降で使用できます。

stringlifecycleClass

キャンバスアプリケーションを表示できる場所を示します。有効な値は、次のとおりです。

CanvasLocationOptions (string型の列挙)

locations

• Aura — 今後の使用のために予約されています。• AppLauncher — 今後の使用のために予約されていま

す。• Chatter — キャンバスアプリケーションを Chatter タ

ブのアプリケーションナビゲーションリストに表示できます。

• ChatterFeed — キャンバスアプリケーションを Chatterフィード項目として表示できます。

143


説明項目のデータ型項目名• MobileNav — キャンバスアプリケーションをSalesforce1

アプリケーションのモバイルカードに表示できます。この値は、API バージョン 31.0 以降で使用できます。

• None — キャンバスアプリケーションをキャンバスアプリケーションのプレビューアでのみ表示できます。

• OpenCTI — キャンバスアプリケーションを通話制御ツールに表示できます。

• PageLayout — キャンバスアプリケーションをページレイアウトに表示できます。Salesforce1アプリケーションで表示されるとき、キャンバスアプリケーションはレコード詳細ページに表示されます。この値は、APIバージョン 31.0 以降で使用できます。

• Publisher — キャンバスアプリケーションをグローバルアクションとして表示できます。

• ServiceDesk — キャンバスアプリケーションをSalesforce コンソールのフッターまたはサイドバーに表示できます。

• UserProfile — 今後の使用のために予約されています。

• Visualforce — キャンバスアプリケーションをVisualforce ページに表示できます。

キャンバスアプリケーションのパブリッシャーで [共有]ボタンとヘッダーを非表示にするかどうかを示します。有効な値は、次のとおりです。

CanvasOptions (string 型の列挙)

options

• HideShare — 関連するキャンバスアプリケーションのパブリッシャーで [共有] ボタンが非表示になります。

• HideHeader — 関連するキャンバスアプリケーションのパブリッシャーでヘッダーが非表示になります。

API バージョン 30.0 以降で利用できます。

SAML シングルサインオン (SSO) を使用している場合、SSO フローを開始するプロバイダを示します。

SamlInitiationMethod (string型の列挙)

samlInitiationMethod

• IdpInitiated — ID プロバイダが開始します。Salesforceは、SSO フローを開始するための初期要求を行います。

• SpInitiated — サービスプロバイダが開始します。キャンバスアプリケーションは、呼び出された後に SSOフローを開始します。

• None — キャンバスアプリケーションは SAML SSO を使用していません。


ConnectedAppIpRange

ユーザの認証を必要とせずにアプリケーションにアクセス可能な IP アドレスのリスト。

144


説明項目のデータ型項目名この項目は、この範囲に対応するネットワークの部分など、範囲の目的を識別するために使用します。この項目はAPI バージョン 31.0 以降で使用できます。

stringdescription

IP 範囲の最初のアドレス (指定した値を含む)。stringstartAddress

IP 範囲の最後のアドレス (指定した値を含む)。stringendAddress

ConnectedAppOauthConfig

ConnectedApp のカスタム属性を構成する項目名を表します。

説明項目のデータ型項目名Salesforce が OAuth 時にアプリケーションにコールバックするエンドポイントです。これは、OAuth redirect_uriです。

stringcallbackUrl

アプリケーションが証明書を使用する場合の PEM エンコード証明書文字列。

stringcertificate

Salesforceで識別するためのコンシューマにより使用される値。OAuth 2.0 では client_idとして参照されます。

stringconsumerKey

この範囲は、接続アプリケーションを実行するユーザによって付与される権限です。メタデータをリリースする場合の有効値は次のとおりです。

ConnectedAppOauthAccessScope(string 型の列挙)

scopes

• Address — ログインユーザの住所へのアクセスを許可します (Basicをリリースする場合と同じ動作)。

• Api — API を介したログインユーザのアカウントへのアクセスを許可します。

• Basic — ID URL サービスへのアクセスを許可します(Address、Email、Phone、Profileをリリースする場合と同じ動作)。

• Chatter — Chatter REST API リソースへのアクセスのみを許可します。

• CustomApplications — Visualforce を使用したカスタムアプリケーションなどのカスタムアプリケーションへのアクセスを提供します。

• CustomPermissions — 接続アプリケーションに関連付けられている組織のカスタム権限へのアクセスを許可し、現在のユーザで各権限が有効かどうかを示します。

メモ: カスタム権限は、現在、開発者プレビューとして利用できます。

• Email — ログインユーザのメールアドレスへのアクセスを許可します (Basicをリリースする場合と同じ動作)。

145


説明項目のデータ型項目名• Full — ログインユーザがアクセスできるすべてのデー

タへのアクセスを許可します。• OfflineAccess — ユーザがオフラインのときにアプリ

ケーションがユーザのデータを操作し、更新トークンを取得することを許可します (RefreshTokenをリリースする場合と同じ動作)。

• OpenID — ログインユーザの OpenID Connect アプリケーションの一意の識別子へのアクセスを許可します。

• Phone — ログインユーザの電話番号値へのアクセスを許可します (Basicをリリースする場合と同じ動作)。

• Profile — ログインユーザのプロファイルへのアクセスを許可します (Basicをリリースする場合と同じ動作)。

• RefreshToken — 更新トークンを受信できる場合に、それを返すことを指定します (OfflineAccessをリリースする場合と同じ動作)。

• Web — Web で access_tokenを使用することを許可します。これにはvisualforceも含まれ、Visualforceページへのアクセスが許可されます。

メタデータを取得する場合の有効値は次のとおりです。• Api — API を介したログインユーザのアカウントへの

アクセスを許可します。• Basic — ID URL サービスへのアクセスを許可し、

Address、Email、Phone、Profileを含めます。• Chatter — Chatter REST API リソースへのアクセスの

みを許可します。• CustomApplications — Visualforce を使用したカスタ

ムアプリケーションなどのカスタムアプリケーションへのアクセスを提供します。

• Full — ログインユーザがアクセスできるすべてのデータへのアクセスを許可します。

• OpenID — ログインユーザの OpenID Connect アプリケーションの一意の識別子へのアクセスを許可します。

• RefreshToken — 更新トークンを受信できる場合に、それを返すように指定します。OfflineAccessを許可する場合と同じです。

• Web — Web で access_tokenを使用することを許可します。これにはvisualforceも含まれ、Visualforceページへのアクセスが許可されます。

ConnectedAppSamlConfig

アプリケーションによるシングルサインオンの使用方法を指定します。

146


説明項目のデータ型項目名サービスプロバイダから取得するアサーションコンシューマサービス URL。

stringacsUrl

アプリケーションが証明書を使用する場合の PEM エンコード証明書文字列。

stringcertificate

サービスプロバイダから取得するエンティティ ID。stringentityUrl

サービスプロバイダへの SAML アサーションの暗号化に使用する証明書の名前。この証明書は、組織の [証明書と

stringencryptionCertificate

鍵の管理] リストに保存されます。API バージョン 30.0 以降で利用できます。Salesforceが ID プロバイダの場合、SAML 設定ではサービスプロバイダへの SAML アサーションの暗号化に使用す

SamlEncryptionType

(string 型の列挙)

encryptionType

る暗号化メソッドを指定できます。サービスプロバイダは、SAML アサーション内の暗号化メソッドを検出して復号化できるようにします。有効な値は、次のとおりです。• AES_128 – 128 ビットの鍵。• AES_256 – 256 ビットの鍵。• Triple_Des — トリプル DES アルゴリズム。API バージョン 30.0 以降で利用できます。SAML レスポンスを送信する URI。サービスプロバイダがこれを使用してレスポンスを送信する ID プロバイダを特定できます。API バージョン 29.0 以降で利用できます。

stringissuer

サービスプロバイダ (SP) が要求する、ユーザのシングルサインオン識別子の形式を示します。APIバージョン 29.0以降で利用できます。有効な値は、次のとおりです。

SamlNameIdFormatType(string 型の列挙)

samlNameIdFormat

• Unspecified — 形式は指定されません。これはデフォルトです。

• EmailAddress — 件名種別がユーザの名前または統合ID (SP の内部の ID) である場合に使用します。

• Persistent — ユーザ ID および永続 ID の件名種別と併用します。

• Transient — 件名種別がカスタム属性である場合に使用し、ユーザがログインするたびに変更される可能性があります。

samlSubjectTypeが CustomAttrである場合、ここにカスタム値を含めます。それ以外の場合は、空のままにします。API バージョン 29.0 以降で利用できます。

stringsamlSubjectCustomAttr

ユーザのシングルサインオン識別子。有効な値は、次のとおりです。

SamlSubjectType (string 型の列挙)

samlSubjectType

• Username — Salesforce ユーザ名。• FederationId — サービスプロバイダでのユーザの識

別子。この値はサービスプロバイダから取得します。• UserId — Salesforce ユーザ識別子。

147


説明項目のデータ型項目名• PersistentID — ID プロバイダおよびサービスプロバ

イダに固有の永続的で不透明な識別子。• CustomAttr — samlSubjectCustomAttrのカスタム

項目値から取得する識別子。

宣言的なメタデータの定義のサンプル組織の ConnectedApp メタデータをリリースまたは取得するために使用される、パッケージマニフェストの例を次に示します。


<types><members>PortalTestApp</members><name>ConnectedApp</name>


</Package>

ConnectedApp コンポーネントの例を次に示します。

<?xml version="1.0" encoding="UTF-8"?><ConnectedApp xmlns="http://soap.sforce.com/2006/04/metadata"><fullName>AConnectedApp</fullName><attributes><formula>$User.CompanyName</formula><key>companyName</key>

</attributes><contactEmail>[email protected]</contactEmail><mobileStartUrl>https://m.connectedapp.company.com</mobileStartUrl><label>A ConnectedApp</label><oauthConfig><callbackUrl>https://callback.company.com</callbackUrl><scopes>Basic</scopes><scopes>Chatter</scopes>

</oauthConfig><samlConfig><acsUrl>http://acs.company.com</acsUrl><entityUrl>http://samlentityId.company.com</entityUrl><samlSubjectType>Username</samlSubjectType>

</samlConfig><startUrl>https://connectedapp.company.com</startUrl><ipRanges><endAddress>10.0.0.46</endAddress><startAddress>10.0.0.42</startAddress>

</ipRanges><ipRanges><endAddress>10.0.0.32</endAddress><startAddress>10.0.0.25</startAddress>

</ipRanges></ConnectedApp>

使用方法メタデータ API を使用して SAML が有効な接続アプリケーションを作成し、プロバイダに [Idp-init のログイン URL]を設定する必要がある場合、次の 2 つのオプションがあります。

148


appパラメータにサービスプロバイダアプリケーション ID を次の形式で使用できます。この値は、Salesforceユーザインターフェースに表示されます。[設定] から、[アプリケーションを管理する] > [接続アプリケーション]をクリックし、接続アプリケーションの名前をクリックしてその詳細ページを表示します。

https://<Salesforce_base_URL>/idp/login?app=<app_id>

または、メタデータ APIのみを使用して接続アプリケーションを設定する場合、サービスプロバイダアプリケーションの apiNameパラメータを次の形式で使用できます。apiNameパラメータは、メタデータ型から継承された fullNameです。

https://<Salesforce_base_URL>/idp/login?apiName=<fullName>

CustomApplicationCustomApplication はカスタムアプリケーションまたは標準アプリケーションを表します。API バージョン 29.0以前では、CustomApplication はカスタムアプリケーションのみを表します。アプリケーションは、説明とロゴを使用したタブ参照のリストです。Metadata メタデータ型を拡張し、その fullName項目を継承します。

ファイルのサフィックスおよびディレクトリの場所カスタムアプリケーションおよび標準アプリケーションのサフィックスは .appで、applicationsフォルダに保存されます。

メモ: プロジェクトでこのメタデータ型のコンポーネントを取得すると、同じパッケージで取得されたProfile コンポーネントおよび PermissionSet コンポーネントにこのコンポーネントが表示されるようになります。

バージョンカスタムアプリケーションは API バージョン 10.0 以降で使用できます。標準アプリケーションは API バージョン 30.0 以降で使用できます。

項目

説明データ型項目名Salesforce コンソールアプリケーションに割り当てられたカスタムコンソールコンポーネント(Visualforce ページ) を表します。

CustomApplicationComponentscustomApplicationComponents

このアプリケーションが選択されたときに開く標準タブまたはカスタムタブの fullName。

stringdefaultLandingTab

アプリケーションの説明テキスト (省略可能)。stringdescription

Salesforce コンソールアプリケーションにおける詳細ページの更新方法を決定します。

stringdetailPageRefreshMethod

isServiceCloudConsoleが trueである場合は必須です。有効な値は、次のとおりです。• none

149

CustomApplicationメタデータ型

説明データ型項目名• autoRefresh• flag


Salesforce コンソールアプリケーション内からユーザがアクセスできる外部ドメイン。たとえ

DomainWhitelistdomainWhitelist

ば、www.yourdomain.comのように指定します。この項目は API バージョン 25.0 以降で使用できます。Salesforce コンソールアプリケーションでキーボードショートカットが有効化されており、

booleanenableKeyboardShortcuts

ユーザがマウスを使用せずにキーの組み合わせを押してアクションを実行できるかどうかを示します。キーボードショートカットを有効化すると、デフォルトのいくつかのショートカットをカスタマイズできます。カスタムショートカットを作成するには、事前に開発者がaddEventListener()メソッドを使用してショートカットのアクションを Salesforce コンソール統合ツールキットに定義しておく必要があります。コンソールの外部から実行されるアクションのキーボードショートカットを作成することはできません。isServiceCloudConsole

が trueである場合は必須です。この項目は API バージョン 28.0 以降で使用できます。

Salesforce コンソールアプリケーションで、マルチモニターコンポーネントが有効かどうかを

booleanenableMultiMonitorComponents

示します。マルチモニターコンポーネントを使用すると、ユーザがコンソールの各部分をブラウザから画面上の場所に移動できます。isServiceCloudConsoleが trueである場合は必須です。この項目は API バージョン 30.0 以降で使用できます。

アプリケーションが Salesforce コンソールアプリケーションであるかを示します。詳細は、

booleanisServiceCloudConsole

Salesforce オンラインヘルプの「Salesforce コンソールの概要」を参照してください。Salesforce コンソールアプリケーションのキーボードショートカットを表します。キーボード

KeyboardShortcutskeyboardShortcuts

ショートカットにより、ユーザはマウスを使用

150


説明データ型項目名せずにキーの組み合わせを押してアクションを実行できます。この項目は API バージョン 28.0 以降で使用できます。

アプリケーションの内部名。labelに基づきますが、有効性のために空白と特殊文字はエス

stringfullName

ケープ処理されます。fullNameには、アンダースコアと英数字のみを使用できます。一意であること、最初は文字であること、空白は使用しない、最後にアンダースコアを使用しない、2つ続けてアンダースコアを使用しないという制約があります。この項目は、Metadataコンポーネントから継承されています。アプリケーションの名前。stringlabel

Salesforce コンソールアプリケーションにおけるリストの表示方法を表します。

ListPlacementlistPlacement

isServiceCloudConsoleが trueである場合は必須です。Salesforce コンソールアプリケーションにおけるリストの更新方法を決定します。

stringlistRefreshMethod

isServiceCloudConsoleが trueである場合は必須です。有効な値は、次のとおりです。• none• refreshList• refreshListRows


Salesforce コンソールで Live Agent を使用するための設定を表します。

LiveAgentConfig (ページ 158)liveAgentConfig

アプリケーションの画像ドキュメントへの参照(省略可能)。

stringlogo

Salesforce コンソールアプリケーションの転送通知を表します。転送通知とは、リストおよび

PushNotificationspushNotifications

詳細ページにあるビジュアルインジケータであり、ユーザのセッション中にレコードまたは項目が変更されると表示されます。たとえば、2つのサポートエージェントが同じケースで作業している場合に一方のエージェントが[優先度]

を変更すると、もう一方のエージェントに転送通知が表示されるため、そのエージェントは変更を認識でき、同じ作業を行わなくてすみます。

151


説明データ型項目名この項目は API バージョン 28.0 以降で使用できます。

コンソールのユーザがブラウザを閉じたり、Salesforce からログアウトしたりしても、再度

booleansaveUserSessions

ログインしたときに以前に開いていたタブが表示されるようにするため、Salesforce コンソールアプリケーションでユーザセッションを自動的に保存するかどうかを示します。isServiceCloudConsoleが trueである場合は必須です。この項目は API バージョン 28.0 以降で使用できます。

このアプリケーションに含まれるタブのリスト。API バージョン 12.0 では、[ホーム]、[取

string[]tab

引先]、および [レポート] などの組み込みタブの fullNameがタブの名前になります (Homeなど)。API バージョン 13.0 以降では、組み込みタブには standard-というプレフィックスが追加されます。たとえば、[取引先] タブを参照するには、standard-Accountを使用します。Salesforce コンソールアプリケーションでレコードをどのように開くかを表します。

WorkspaceMappingsworkspaceMappings

isServiceCloudConsoleが trueである場合は必須です。この項目は API バージョン 25.0以降で使用できます。

CustomApplicationComponents

Salesforce コンソールアプリケーションに割り当てられたカスタムコンソールコンポーネント (Visualforce ページ)を表します。API バージョン 25.0 以降で利用できます。

説明データ型項目名Salesforce コンソールアプリケーションのフッターにおけるカスタムコンソールコンポーネントの整列方法を決定します。

stringalignment

Salesforce コンソールアプリケーションに割り当てられたカスタムコンソールコンポーネントの名前。

stringcustomApplicationComponent

CustomShortcut

Salesforce コンソールアプリケーションに割り当てられたカスタムキーボードショートカットを表します。カスタムショートカットを作成するには、事前に開発者が addEventListener()メソッドを使用してショートカットのアクションを Salesforce コンソール統合ツールキットに定義しておく必要があります。コンソールの外部から

152


実行されるアクションのキーボードショートカットを作成することはできません。APIバージョン 28.0 以降で利用できます。

説明データ型項目名必須。ユーザがキーボードショートカットを押したときにコンソールで実行されるアクション。

stringaction

必須。キーボードショートカットが有効であるか (true)、否か (false) を示します。

booleanactive

必須。キーボードショートカットをトリガするためにユーザが押すキーの組み合わせ。キーボードショートカットでは大

stringkeyCommand

文字と小文字が区別されませんが、見やすくするためSalesforce ユーザインターフェースの設定ページには大文字で表示されます。各キーコマンドには、修飾子キーを最大 4 つ、その後に非修飾子キーを 1 つ含めることができます。修飾子キーと非修飾子キーは、+キーで区切られます。修飾子キーの順序は任意ですが、キーコマンドシーケンスの最後に非修飾子キーを指定する必要があります。たとえば、SHIFT+CTRL+ALT+META

+Aです。有効な修飾子キーは、次のとおりです。• SHIFT

• CTRL

• ALT

• META (Mac での COMMAND キーを表す)

有効な非修飾子キーは、A ～ Z の文字と 0 ～ 9 の数字です。その他の有効なキーは、次のとおりです。• TAB

• ENTER

• PAUSE/BREAK

• CAPS LOCK

• ESC

• SPACE

• PAGE UP

• PAGE DOWN

• END

• HOME

• LEFT ARROW

• UP ARROW

• RIGHT ARROW

• DOWN ARROW

• PRINT SCREEN

• INSERT

• DELETE

• RIGHT WINDOW

• NUMPAD 0

153


説明データ型項目名• NUMPAD 1

• NUMPAD 2

• NUMPAD 3

• NUMPAD 4

• NUMPAD 5

• NUMPAD 6

• NUMPAD 7

• NUMPAD 8

• NUMPAD 9

• MULTIPLY

• ADD

• SUBTRACT

• DECIMAL POINT

• DIVIDE

• F1

• F2

• F3

• F4

• F5

• F6

• F7

• F8

• F9

• F10

• F11

• F12

• NUM LOCK

• SCROLL LOCK

• ;

• =

• ,

• —

• .

• /

• ‘

• [

• ]

• \

• '

キーボードショートカットの説明テキスト (省略可能)。stringdescription

必須。Salesforce コンソールインテグレーションツールキットを使用して、開発者がカスタムショートカット関数をコンソールに追加するときに使用できるコード。

stringeventName

154


DefaultShortcut

Salesforce コンソールアプリケーションにデフォルトで割り当てられたキーボードショートカットを表します。コンソールのキーボードショートカットを有効にすると、タブの開閉、タブ間の移動、およびレコードの保存など、いくつかのデフォルトショートカットをカスタマイズに使用できるようになります。APIバージョン 28.0 以降で利用できます。

説明データ型項目名必須。ユーザがキーボードショートカットを押したときにコンソールで実行されるアクション。有効な値は、次のとおりです。

stringaction

• FOCUS_CONSOLE

• FOCUS_NAVIGATOR_TAB

• FOCUS_DETAIL_VIEW

• FOCUS_PRIMARY_TAB_PANEL

• FOCUS_SUBTAB_PANEL

• FOCUS_LIST_VIEW

• FOCUS_FIRST_LIST_VIEW

• FOCUS_SEARCH_INPUT

• MOVE_LEFT

• MOVE_RIGHT

• UP_ARROW

• DOWN_ARROW

• OPEN_TAB_SCROLLER_MENU

• OPEN_TAB

• CLOSE_TAB

• ENTER

• EDIT

• SAVE

デフォルトのキーボードショートカットの一覧および説明は、Salesforce オンラインヘルプの「Salesforce コンソールのデフォルトのキーボードショートカット」を参照してください。

必須。キーボードショートカットが有効であるか (true)、否か (false) を示します。

booleanactive

必須。キーボードショートカットをトリガするためにユーザが押すキーの組み合わせ。キーボードショートカットでは大

stringkeyCommand

文字と小文字が区別されませんが、見やすくするためSalesforce ユーザインターフェースの設定ページには大文字で表示されます。各キーコマンドには、修飾子キーを最大 4 つ、その後に非修飾子キーを 1 つ含めることができます。修飾子キーと非修飾子キーは、+キーで区切られます。修飾子キーの順序は任意ですが、キーコマンドシーケンスの最後に非修飾子キーを指定する必要があります。たとえば、SHIFT+CTRL+ALT+META

+Aです。

155


説明データ型項目名有効な修飾子キーは、次のとおりです。• SHIFT

• CTRL

• ALT

• META (Mac での COMMAND キーを表す)

有効な非修飾子キーは、A ～ Z の文字と 0 ～ 9 の数字です。その他の有効なキーは、次のとおりです。• TAB

• ENTER

• PAUSE/BREAK

• CAPS LOCK

• ESC

• SPACE

• PAGE UP

• PAGE DOWN

• END

• HOME

• LEFT ARROW

• UP ARROW

• RIGHT ARROW

• DOWN ARROW

• PRINT SCREEN

• INSERT

• DELETE

• RIGHT WINDOW

• NUMPAD 0

• NUMPAD 1

• NUMPAD 2

• NUMPAD 3

• NUMPAD 4

• NUMPAD 5

• NUMPAD 6

• NUMPAD 7

• NUMPAD 8

• NUMPAD 9

• MULTIPLY

• ADD

• SUBTRACT

• DECIMAL POINT

• DIVIDE

• F1

• F2

• F3

• F4

• F5

156


説明データ型項目名• F6

• F7

• F8

• F9

• F10

• F11

• F12

• NUM LOCK

• SCROLL LOCK

• ;

• =

• ,

• —

• .

• /

• ‘

• [

• ]

• \

• '

DomainWhitelist

Salesforce コンソールアプリケーション内からユーザがアクセスできる外部ドメインを表します。たとえば、www.yourdomain.comです。API バージョン 25.0 以降で利用できます。

説明データ型項目名この Salesforce コンソールアプリケーション内からユーザがアクセスできる外部ドメイン。

stringdomain

KeyboardShortcuts

Salesforce コンソールアプリケーションに割り当てられたキーボードショートカットを表します。isServiceCloudConsoleが trueである場合は必須です。API バージョン 28.0 以降で利用できます。

説明データ型項目名Salesforce コンソールアプリケーションに割り当てられたカスタムキーボードショートカットを表します。カスタム

KeyboardShortcuts[]customShortcut

ショートカットを作成するには、事前に開発者がaddEventListener()メソッドを使用してショートカットのアクションを Salesforce コンソール統合ツールキットに定義しておく必要があります。コンソールの外部から実行されるアクションのキーボードショートカットを作成することはできません。Salesforce コンソールアプリケーションにデフォルトで割り当てられたキーボードショートカットを表します。コンソー

KeyboardShortcuts[]defaultShortcut

157


説明データ型項目名ルのキーボードショートカットを有効にすると、タブの開閉、タブ間の移動、およびレコードの保存など、いくつかのデフォルトショートカットをカスタマイズに使用できるようになります。デフォルトのキーボードショートカットの一覧および説明は、Salesforce オンラインヘルプの「Salesforce コンソールのデフォルトのキーボードショートカット」を参照してください。

ListPlacement

Salesforce コンソールアプリケーションにおけるリストの表示方法を表します。isServiceCloudConsoleがtrue

である場合は必須です。API バージョン 25.0 以降で利用できます。

説明データ型項目名リストの高さ (ピクセルまたはパーセント単位)。location

が top の場合は必須です。intheight

必須。画面上のリストの位置。有効な値は、次のとおりです。

stringlocation

• full• top• left

必須。heightまたはwidthがピクセル単位かパーセント単位かを表します。

stringunits

リストの幅 (ピクセルまたはパーセント単位)。locationがleft の場合は必須です。

intwidth

LiveAgentConfig

Salesforce コンソールで Live Agent を使用するための組織の設定を表します。

説明項目のデータ型項目名組織でLive Agentが有効化されているか (true)、否か (false)を指定します。

booleanenableLiveChat

エージェントがチャットを受け入れたときに Salesforce コンソールで新しい [取引先] サブタブを自動的に開くか (true)、否か (false) を指定します。

booleanopenNewAccountSubtab

エージェントがチャットを受け入れたときに Salesforce コンソールで新しい [ケース] サブタブを自動的に開くか (true)、否か (false) を指定します。

booleanopenNewCaseSubtab

158


説明項目のデータ型項目名エージェントがチャットを受け入れたときに Salesforce コンソールで新しい [取引先責任者] サブタブを自動的に開くか(true)、否か (false) を指定します。

booleanopenNewContactSubtab

エージェントがチャットを受け入れたときに Salesforce コンソールで新しい [リード] サブタブを自動的に開くか (true)、否か (false) を指定します。

booleanopenNewLeadSubtab

エージェントがチャットを受け入れたときに Salesforce コンソールで新しい Visualforce ページをサブタブとして自動的に開くか (true)、否か (false) を指定します。

booleanopenNewVFPageSubtab

エージェントがチャットを受け入れたときに Salesforce コンソールのサブタブで Visualforce ページを開くことを指定します。

PagesToOpen (ページ 159)

pagesToOpen

Salesforce コンソールで Live Agent を使用するときにナレッジコンポーネントを表示するか (true)、否か (false) を指定します。

booleanshowKnowledgeArticles

PagesToOpen

エージェントがチャット要求を受け入れたときに Salesforce コンソールのサブタブで開く Visualforce ページを表します。API バージョン 28.0 以降で利用できます。

説明項目のデータ型項目名エージェントがチャットを受け入れたときに Salesforce コンソールのサブタブで開く Visualforce ページの名前。

stringpagesToOpen

PushNotifications

ユーザのセッション中にレコードまたは項目が変更されると表示される、リストおよび詳細ページにあるビジュアルインジケータである転送通知のセットを表します。isServiceCloudConsoleが trueの場合に使用できます。API バージョン 28.0 以降で利用できます。

説明項目のデータ型項目名転送通知のセット。PushNotification[]pushNotification

PushNotification

ユーザのセッション中にレコードまたは項目が変更された場合に、リストおよび詳細ページにあるビジュアルインジケータをSalesforce コンソールアプリケーションに表示するかどうかを表します。isServiceCloudConsole

が trueの場合に使用できます。API バージョン 28.0 以降で利用できます。

説明項目のデータ型項目名必須。選択されたオブジェクトに対して転送通知をトリガする 1 つまたは複数の項目の名前。

stringfieldNames

159


説明項目のデータ型項目名必須。転送通知をトリガするオブジェクトの名前。stringobjectName

WorkspaceMappings

Salesforce コンソールアプリケーションでレコードをどのように開くかを表します。isServiceCloudConsoleがtrueである場合は必須です。API バージョン 25.0 以降で利用できます。

説明データ型項目名Salesforce コンソールアプリケーションで特定のタブのレコードをどのように開くかを表します。CustomApplication に指定された各タブで必須です。

WorkspaceMappingmapping

WorkspaceMapping

Salesforce コンソールアプリケーションで特定のタブのレコードをどのように開くかを表します。CustomApplicationに指定された各タブで必須です。API バージョン 25.0 以降で利用できます。

説明データ型項目名tabをサブタブとして表示する主タブを指定する項目の名前。指定されていない場合、tabは主タブとして開きます。

stringfieldName

必須。タブの名前。stringtab

アプリケーションの取得組織のアプリケーションを取得するには、package.xmlマニフェストファイルで CustomApplication 型の名前を使用します。すべてのアプリケーションを取得することも、package.xmlの types セクションに取得するアプリケーションを指定することもできます。組織のすべてのアプリケーション (カスタムアプリケーションおよび標準アプリケーション) を取得するには、ワイルドカード文字 (*) を次のように指定します。

<types><members>*</members><name>CustomApplication</name>

</types>

メモ: API バージョン 29.0 以前では、ワイルドカードを使用するとすべてのカスタムアプリケーションのみが返され、標準アプリケーションは返されません。

カスタムアプリケーションを取得するには、アプリケーション名を指定します。

<types><members>MyCustomApp</members><name>CustomApplication</name>

</types>

160


標準アプリケーションを取得するには、アプリケーション名にstandard__プレフィックスを追加します。たとえば、Chatter 標準アプリケーションを取得するには、standard__Chatterと指定します。

<types><members>standard__Chatter</members><name>CustomApplication</name>

</types>

インストール済みパッケージに含まれるアプリケーションを取得するには、アプリケーション名の前にパッケージ名前空間プレフィックスとアンダースコア 2 個を続けて追加します。たとえば、パッケージ名前空間がmyInstalledPackageNSで、アプリケーション名が PackageAppの場合、次のようにmyInstalledPackageNS__PackageAppと指定します。

<types><members>myInstalledPackageNS__PackageApp</members><name>CustomApplication</name>

</types>

宣言的なメタデータの定義のサンプルカスタムアプリケーションの定義を次に示します。

<?xml version="1.0" encoding="UTF-8"?><CustomApplication xmlns="http://soap.sforce.com/2006/04/metadata">

<defaultLandingTab>Myriad_Publishing__c</defaultLandingTab><description>App to manage Myriad Publishing</description><label>Myriad</label><logo>MyriadFolder/Myriad_Logo.jpg</logo><tab>standard-Chatter</tab><tab>standard-File</tab><tab>Myriad_Publishing__c</tab><tab>standard-report</tab><tab>standard-Dashboard</tab>

</CustomApplication>

標準アプリケーション (Chatter) の定義を次に示します。


<defaultLandingTab>standard-home</defaultLandingTab><label>Collaboration</label><tab>standard-Chatter</tab><tab>standard-UserProfile</tab><tab>standard-OtherUserProfile</tab><tab>standard-CollaborationGroup</tab><tab>standard-File</tab>

</CustomApplication>

宣言的なメタデータの定義のサンプル — Salesforce コンソールisServiceCloudConsoleが trueであるカスタムアプリケーションの定義を次に示します。


<customApplicationComponents><alignment>left</alignment><customApplicationComponent>MyComponent</customApplicationComponent>

</customApplicationComponents><defaultLandingTab>standard-home</defaultLandingTab>

161


<detailPageRefreshMethod>autoRefresh</detailPageRefreshMethod><isServiceCloudConsole>true</isServiceCloudConsole><keyboardShortcuts>

<customShortcut><action>MyCustomShortcutAction</action><active>true</active><keyCommand>X</keyCommand><description>Custom Shortcut example</description><eventName>myCustomShortcutExample</eventName>

</customShortcut><defaultShortcut><action>FOCUS_CONSOLE</action><active>true</active><keyCommand>ESC</keyCommand>

</defaultShortcut><defaultShortcut><action>FOCUS_NAVIGATOR_TAB</action><active>true</active><keyCommand>V</keyCommand>

</defaultShortcut><defaultShortcut><action>FOCUS_DETAIL_VIEW</action><active>true</active><keyCommand>SHIFT+S</keyCommand>

</defaultShortcut><defaultShortcut><action>FOCUS_PRIMARY_TAB_PANEL</action><active>true</active><keyCommand>P</keyCommand>

</defaultShortcut><defaultShortcut><action>FOCUS_SUBTAB_PANEL</action><active>true</active><keyCommand>S</keyCommand>

</defaultShortcut><defaultShortcut><action>FOCUS_LIST_VIEW</action><active>true</active><keyCommand>N</keyCommand>

</defaultShortcut><defaultShortcut><action>FOCUS_FIRST_LIST_VIEW</action><active>true</active><keyCommand>SHIFT+F</keyCommand>

</defaultShortcut><defaultShortcut><action>FOCUS_SEARCH_INPUT</action><active>true</active><keyCommand>R</keyCommand>

</defaultShortcut><defaultShortcut><action>MOVE_LEFT</action><active>true</active><keyCommand>LEFT ARROW</keyCommand>

</defaultShortcut><defaultShortcut><action>MOVE_RIGHT</action><active>true</active><keyCommand>RIGHT ARROW</keyCommand>

</defaultShortcut><defaultShortcut><action>UP_ARROW</action><active>true</active><keyCommand>UP ARROW</keyCommand>

</defaultShortcut><defaultShortcut><action>DOWN_ARROW</action><active>true</active><keyCommand>DOWN ARROW</keyCommand>

162


</defaultShortcut><defaultShortcut><action>OPEN_TAB_SCROLLER_MENU</action><active>true</active><keyCommand>D</keyCommand>

</defaultShortcut><defaultShortcut><action>OPEN_TAB</action><active>true</active><keyCommand>T</keyCommand>

</defaultShortcut><defaultShortcut><action>CLOSE_TAB</action><active>true</active><keyCommand>C</keyCommand>

</defaultShortcut><defaultShortcut><action>ENTER</action><active>true</active><keyCommand>ENTER</keyCommand>

</defaultShortcut><defaultShortcut><action>EDIT</action><active>true</active><keyCommand>E</keyCommand>

</defaultShortcut><defaultShortcut><action>SAVE</action><active>true</active><keyCommand>CTRL+S</keyCommand>

</defaultShortcut></keyboardShortcuts><label>MyConsole</label><listPlacement>

<location>left</location><units>percent</units><width>20</width>

</listPlacement><listRefreshMethod>refreshList</listRefreshMethod><pushNotifications>

<pushNotification><fieldNames>CreatedBy</fieldNames><objectName>Campaign</objectName>

</pushNotification><pushNotification><fieldNames>CustomField1__c</fieldNames><objectName>CustomObject1__c</objectName>

</pushNotification></pushNotifications><saveUserSessions>false</saveUserSessions><tab>standard-Case</tab><tab>standard-Account</tab><tab>standard-Contact</tab><tab>standard-Contract</tab><workspaceMappings>

<mapping><tab>standard-Case</tab>

</mapping><mapping>

<fieldName>AccountId</fieldName><tab>standard-Contract</tab>

</mapping><mapping>

<tab>standard-Contract</tab></mapping><mapping>

<fieldName>ParentId</fieldName><tab>standard-Account</tab>

</mapping>

163


</workspaceMappings></CustomApplication>

関連リンクCustomTab

CustomApplicationComponentSalesforce コンソールとしてマークされている CustomApplication に割り当てられたカスタムコンソールコンポーネント (Visualforceページ) を表します。カスタムコンソールコンポーネントは、Salesforce コンソールアプリケーションの機能を拡張します。Salesforceオンラインヘルプの「カスタムコンソールコンポーネントの概要」を参照してください。

ファイルのサフィックスおよびディレクトリの場所カスタムアプリケーションコンポーネントのサフィックスは .customApplicationComponentで、customApplicationComponentsフォルダに保存されます。

バージョンカスタムアプリケーションは API バージョン 25.0 以降で使用できます。

項目

説明データ型項目名ボタンのアイコンをホストするページのアドレス。stringbuttonIconUrl

ボタンの外観の定義に使用されるインラインスタイル。stringbuttonStyle

カスタムコンソールコンポーネントの起動に使用されるボタンの表示ラベル。

stringbuttonText

Salesforce コンソールに表示されるボタンの幅 (ピクセル単位)。

intbuttonWidth

カスタムコンソールコンポーネントを表示するために使用されるウィンドウの高さ (ピクセル単位)。

intheight

必須。ユーザがカスタムコンソールコンポーネントの高さを変更できるか (false)、否か (true) を示します。

booleanisHeightFixed

必須。カスタムコンソールコンポーネントがユーザに非表示であるか (true)、否か (false) を示します。

booleanisHidden

必須。ユーザがコンポーネントの幅を変更できるか(false)、否か (true) を示します。

booleanisWidthFixed

必須。カスタムコンソールコンポーネントを表すVisualforceページの名前。

stringvisualforcePage

カスタムコンソールコンポーネントを表示するために使用されるウィンドウの幅 (ピクセル単位)。

intwidth

164

CustomApplicationComponentメタデータ型

宣言的なメタデータの定義のサンプルカスタムアプリケーションコンポーネントの定義を次に示します。

<?xml version="1.0" encoding="UTF-8"?><CustomApplicationComponent xmlns="http://soap.sforce.com/2006/04/metadata">

<buttonIconUrl>http://www.salesforce.com</buttonIconUrl><buttonStyle>buttonStyleCSS</buttonStyle><buttonText>buttonText</buttonText><buttonWidth>200</buttonWidth><height>200</height><isHeightFixed>false</isHeightFixed><isHidden>false</isHidden><isWidthFixed>false</isWidthFixed><visualforcePage>MyVisualforcePage</visualforcePage><width>50</width>

</CustomApplicationComponent>

CustomLabelsこのメタデータ型を使用して、異なる言語、国、および通貨で使用するためにローカライズできるカスタム表示ラベルを作成できます。Metadataメタデータ型を拡張し、その fullName項目を継承します。カスタム表示ラベルは、ApexクラスまたはVisualforceページからアクセスできる、最長 1,000 文字のカスタムテキスト値です。詳細は、Salesforce オンラインヘルプの「カスタム表示ラベルの概要」を参照してください。

宣言的なメタデータファイルのサフィックスおよびディレクトリの場所マスタカスタム表示ラベルの値は、CustomLabels.labelsファイルに保存されます。翻訳は、Translation-localeCode.translationという名前形式のファイルに保存されます。localeCodeは、翻訳言語のロケールコードです。サポートされるロケールコードのリストは、「言語」 (ページ 488) に示しています。カスタム表示ラベルの翻訳は、対応するパッケージディレクトリの labelsフォルダに保存されます。

バージョンCustomLabels コンポーネントは、API バージョン 14.0 以降で使用できます。

項目

説明データ型項目必須。カスタム表示ラベルバンドルの名前。Metadata から継承されるこの項目は、このメタデータ型の WSDL では定義されません。作成時、更新

stringfullName

時、または削除時に指定する必要があります。コールにおけるこの項目の例を確認するには、「create()」を参照してください。

カスタム表示ラベルのリスト。CustomLabel[]labels

CustomLabel

このメタデータ型は、カスタム表示ラベルを表します。Metadataメタデータ型を拡張し、その fullName項目を継承します。

165

CustomLabelsメタデータ型

説明データ型項目表示ラベルのカテゴリのカンマ区切りのリスト。この項目は、カスタム表示ラベルのリストビューを作

stringcategories

成するときに、検索条件として使用できます。最大255 文字です。必須。カスタム表示ラベルの名前。Metadata から継承されるこの項目は、このメタデータ型の WSDL では定義されません。作成時、更新

stringfullName


必須。翻訳されたカスタム表示ラベルの言語。stringlanguage

必須。このコンポーネントが保護されるか (true)、否か (false) を示します。保護コンポーネントは、

booleanprotected

インストールする組織で作成されたコンポーネントによってリンク設定したり参照したりすることはできません。必須。このカスタム表示ラベルを識別するための、認識しやすい用語。この説明は差し込み項目で使用されます。

stringshortDescription

必須。翻訳済みのカスタム表示ラベル。最大 1000 文字です。

stringvalue

使用方法組織で定義されているすべてのカスタム表示ラベルを取得するには、package.xmlマニフェストファイルのメンバーに対して CustomLabels とワイルドカード文字 (*) を使用します。CustomLabels では、名前による 1 つ以上のカスタム表示ラベルの取得はサポートされません。名前で特定の表示ラベルを取得するには、CustomLabel を使用し、メンバーとして表示ラベル名を指定します。

宣言的なメタデータの定義のサンプルカスタム表示ラベルコンポーネントの XML 定義のサンプルを次に示します。

<?xml version="1.0" encoding="UTF-8"?><CustomLabels xmlns="http://soap.sforce.com/2006/04/metadata">

<labels><fullName>quoteManual</fullName><label>This is a manual quote.</label><language>en_US</language><protected>false</protected><shortDescription>Manual Quote</shortDescription>

</labels><labels>

<fullName>quoteAuto</fullName><label>This is an automatically generated quote.</label><language>en_US</language><protected>false</protected><shortDescription>Automatic Quote</shortDescription>

</labels></CustomLabels>

166

CustomLabelsメタデータ型

次のサンプルマニフェストファイルは、CustomLabels 型を使用して、組織のすべてのカスタム表示ラベルを取得します。


<fullName>MyPkg</fullName><types><members>*</members><name>CustomLabels</name>


</Package>

次のサンプルマニフェストファイルでは、名前で 2 つのカスタム表示ラベルを取得します。単数形の CustomLabelが使用されています。


<fullName>MyPkg</fullName><types><members>quoteManual</members><members>quoteAuto</members><name>CustomLabel</name>


</Package>

関連リンクTranslations

CustomObject組織に固有のデータを保存するカスタムオブジェクトを表します。Metadataメタデータ型を拡張し、そのfullName

項目を継承します。カスタムオブジェクトを作成または更新するときに関連するすべての項目を指定する必要があります。オブジェクトの単一の項目を更新することはできません。カスタムオブジェクトの詳細については、Salesforce オンラインヘルプの「カスタムオブジェクトの概要」を参照してください。また、このメタデータ型を使用して、取引先などの標準オブジェクトのカスタマイズを行うこともできます。「標準オブジェクト」 (ページ 18)の例を参照してください。すべてのメタデータコンポーネントには fullName項目があり、すべてのカスタムオブジェクトで完全に指定されている必要があります。たとえば、次は、完全に指定されている名前です。

AccountMyCustomObject__c

カスタムオブジェクトを作成する Java のサンプルコードについては、「ステップ 3: Java サンプルコードの説明」(ページ 7)を参照してください。

167

CustomObjectメタデータ型

宣言的なメタデータファイルのサフィックスおよびディレクトリの場所カスタムオブジェクト名には、自動的に __c が追加されます。カスタムオブジェクト (または標準オブジェクト)ファイルのファイルサフィックスは .objectです。カスタムオブジェクトと標準オブジェクトは、対応するパッケージディレクトリの objectsフォルダに保存されます。


バージョンカスタムオブジェクトは API バージョン 10.0 以降で使用できます。

項目別途記載がない限り、すべての項目は作成可能、除外可能で、null にすることもできます。

説明データ型項目名標準またはカスタムオブジェクトの override アクションのリスト。この項目は API バージョン 18.0 以降で使用できます。

ActionOverride[]actionOverrides

オブジェクトに関連付けられたビジネスプロセスのリスト。この項目は API バージョン 17.0 以降で使用できます。

BusinessProcess[]businessProcesses

このカスタムオブジェクトに割り当てられたコンパクトレイアウト。この項目は API バージョン 29.0 以降で使用できます。

stringcompactLayoutAssignment

オブジェクトに関連付けられたコンパクトレイアウトのリスト。この項目は API バージョン 29.0 以降で使用できます。

CompactLayout[]compactLayouts

このカスタムオブジェクトがヘルプコンテンツをカスタマイズした場合に、ヘルプコンテンツが含

stringcustomHelp

まれる Sコントロール。この項目は API バージョン 14.0 以降で使用できます。このカスタムオブジェクトがヘルプコンテンツをカスタマイズした場合に、ヘルプコンテンツが含

stringcustomHelpPage

まれるVisualforceページ。この項目はAPIバージョン 16.0 以降で使用できます。

168


説明データ型項目名この項目が存在する場合、このコンポーネントはカスタムオブジェクトではなくカスタム設定です。

CustomSettingsType (string型の列挙)

customSettingsType

この項目はカスタム設定の型を返します。有効な文字列値は次のとおりです。• List — キャッシュに保存された静的データで、

アプリケーションの一部としてアクセスされます。組織全体で使用できます。

• Hierarchy — キャッシュに保存された静的データで、アプリケーションの一部としてアクセスされます。ユーザ、プロファイル、または組織の階層に基づいて使用できます。これはデフォルト値です。


この項目が存在する場合、このコンポーネントはカスタムオブジェクトではなくカスタム設定です。

CustomSettingsVisibility(string 型の列挙)

customSettingsVisibility

この項目はカスタム設定の表示を返します。有効な文字列値は次のとおりです。• Public — カスタム設定がパッケージ化されて

いる場合、すべての登録組織がアクセスできます。

• Protected — カスタム設定が管理パッケージに含まれる場合、開発組織のみがアクセスできます。登録組織はアクセスできません。これはデフォルト値です。


カスタムオブジェクトのリリース状況を示します。DeploymentStatus (string型の列挙)

deploymentStatus

将来の使用のために予約されています。booleandeprecated

オブジェクトの説明。最大 1000 文字です。stringdescription

活動のカスタムオブジェクトが有効になっているか (true)、否か (false) を示します。

booleanenableActivities

有効な場合、カスタムオブジェクトは、利用状況の追跡のためのエンタープライズアプリケーションオブジェクトとして分類されます。有効な場合、enableSharingおよびenableStreamingApiも有効にする必要があります。

booleanenableBulkApi


169


説明データ型項目名ディビジョンのカスタムオブジェクトが有効になっているか (true)、否か (false) を示します。ディ

booleanenableDivisions

ビジョンオブジェクトについての詳細は、『SOAPAPI 開発者ガイド』を参照してください。拡張ルックアップのカスタムオブジェクトが有効になっているか (true)、否か (false) を示します。

booleanenableEnhancedLookup

API バージョン 28.0 以降では、この項目をAccount、Contact、および User オブジェクトにも使用できます。拡張ルックアップにより、ルックアップダイアログインターフェースが更新され、検索結果の絞り込み、並び替え、およびページ操作と検索結果列のカスタマイズが可能になります。拡張ルックアップについての詳細は、Salesforce オンラインヘルプの「拡張ルックアップの有効化」を参照してください。フィード追跡のカスタムオブジェクトが有効になっているか (true)、否か (false) を示します。詳細

booleanenableFeeds

は、Salesforceオンラインヘルプの「Chatterフィード追跡のカスタマイズ」を参照してください。この項目は API バージョン 18.0 以降で使用できます。

履歴追跡のカスタムオブジェクトが有効になっているか (true)、否か (false) を示します。APIバー

booleanenableHistory

ジョン 29.0 以降では標準オブジェクトにも使用できます。レポートのカスタムオブジェクトが有効になっているか (true)、否か (false) を示します。

booleanenableReports

有効な場合、カスタムオブジェクトは、利用状況の追跡のためのエンタープライズアプリケーションオブジェクトとして分類されます。有効な場合、enableBulkApiおよびenableStreamingApiも有効にする必要があります。

booleanenableSharing


有効な場合、カスタムオブジェクトは、利用状況の追跡のためのエンタープライズアプリケーションオブジェクトとして分類されます。有効な場合、enableBulkApiおよびenableSharingも有効にする必要があります。

booleanenableStreamingApi


170




説明データ型項目名ポータルユーザやコミュニティユーザなど、外部ユーザのアクセスレベルを決定する、カスタムオ

SharingModel(string 型の列挙)

externalSharingModel

ブジェクトの外部組織の共有設定を示します。この項目は、次のオブジェクトでサポートされます。• 取引先と、それに関連する契約および納入商品• ケース• 取引先責任者• 商談• カスタムオブジェクト• ユーザこの項目は API バージョン 31.0 以降で使用できます。

オブジェクトの 1 つ以上の項目を表します。CustomField[]fields

このオブジェクトに存在する項目セットを定義します。

FieldSetfieldSets


stringfullName



Gendergender

この項目は、Salesforce for Wealth Management でのみ使用できるリレーショングループという機能を

booleanhousehold

サポートします。詳細は、Salesforce オンラインヘルプの「Salesforce for Wealth Management の概要」を参照してください。将来の使用のために予約されています。HistoryRetentionPolicyhistoryRetentionPolicy


stringlabel

オブジェクトに関連付けられた 1 つ以上のリストビューを表します。

ListView[]listViews

ルックアップ検索条件に関連付けられたメタデータを表します。ルックアップ検索条件の定義を作

NamedFilter[]namedFilter

成、更新、または削除するには、このメタデータ型を使用します。この項目は API バージョン 17.0 以降で使用できます。

171


説明データ型項目名この項目は API バージョン 30.0 で削除されました。それより前のバージョンでのみ使用できます。ルックアップ検索条件に関連付けられたメタデータは、CustomFieldコンポーネントのlookupFilter

項目によって表されるようになりました。

必須。このオブジェクトの名前が保存されている項目。すべてのカスタムオブジェクトには名前が

CustomFieldnameField

必要です。この名前は、通常文字列型または自動採番型です。カスタムオブジェクトのレコードに付けられる識別子。この名前は、ページレイアウト、関連リスト、ルックアップダイアログ、検索結果、およびタブホームページの主要リストに表示されます。デフォルトでは、カスタムオブジェクトのページレイアウトに必須項目としてこの項目が追加されます。すべてのカスタムオブジェクトには名前が必要です。この名前は、通常文字列型または自動採番型です。

label値の複数形です。stringpluralLabel

このオブジェクトに定義された 1 つ以上のレコードタイプの配列。

RecordType[]recordTypes

フィード追跡のレコードタイプが有効になっているか (true)、否か (false) を示します。この項目

booleanrecordTypeTrackFeedHistory

を trueに設定するには、関連付けられたCustomObject の enableFeeds項目も trueに設定されている必要があります。詳細は、Salesforce オンラインヘルプの「Chatter フィード追跡のカスタマイズ」を参照してください。この項目は API バージョン 19.0 以降で使用できます。

このレコードタイプの履歴追跡が有効になっているか (true)、否か (false) を示します。

booleanrecordTypeTrackHistory

recordTypeTrackHistoryを true に設定するには、関連付けられたカスタムオブジェクトのenableHistory項目も trueに設定されている必要があります。この項目は API バージョン 19.0 以降で使用できます。

カスタムオブジェクトの検索レイアウト関連リスト情報。

SearchLayoutssearchLayouts

172


説明データ型項目名このカスタムオブジェクトの組織の共有設定を示します。

SharingModel(string 型の列挙)

sharingModel

メモ: API バージョン 29.0 以前を使用する場合、この項目は参照のみであり、メタデータ APIを使用して設定できないため、Salesforceユーザインターフェースを使用する必要があります。API バージョン 30.0 以降を使用する場合、この項目はAPIおよびSalesforceユーザインターフェースを使用して内部ユーザ向けに設定できます。

カスタムオブジェクトが共有されている理由。SharingReason[]sharingReasons

カスタムオブジェクトに関連付けられたカスタム共有の再適用のリスト。

SharingRecalculation[]sharingRecalculations

名詞が母音、子音、または特殊文字で開始されているかを示します。これは、語の最初の文字に基

StartsWith (string 型の列挙)

startsWith

づいて、異なる処理が必要となる言語に使用されます。有効な値は、「StartsWith」にリストされています。このオブジェクトの 1 つ以上の入力規則の配列。ValidationRule[]validationRules

このオブジェクトに定義された 1 つ以上の Web リンクの配列。

Weblink[]webLinks

宣言的なメタデータのその他のコンポーネントCustomObject の定義には、カスタムオブジェクトで宣言的なメタデータについて定義されているその他のコンポーネントが含まれる場合があります。CustomObject に定義されているコンポーネントは、次のとおりです。• ActionOverride• BusinessProcess• CompactLayout• CustomField• FieldSet• HistoryRetentionPolicy• ListView• RecordType• SearchLayouts• SharingReason• SharingRecalculation• ValidationRule• Weblink

173




<deploymentStatus>Deployed</deploymentStatus><description>just a test object with one field for eclipse ide testing</description><fields>

<fullName>Comments__c</fullName><description>add your comments about this object here</description>

<inlineHelpText>This field contains comments made about this object</inlineHelpText>

<label>Comments</label><length>32000</length><type>LongTextArea</type><visibleLines>30</visibleLines>

</fields><label>MyFirstObject</label><nameField>

<label>MyFirstObject Name</label><type>Text</type>

</nameField><pluralLabel>MyFirstObjects</pluralLabel><sharingModel>ReadWrite</sharingModel>

</CustomObject>

関連リンクCustomFieldMetadata

Picklist (連動選択リストを含む)SearchLayoutsWeblinkCustomObjectTranslationListViewCompactLayout

ActionOverride標準オブジェクトまたはカスタムオブジェクトの override アクションを表します。これを使用して、override アクションを作成、更新、編集、または削除します。ActionOverrideには、これを含むCustomObjectにアクセスすることによってのみアクセスできます。

宣言的なメタデータファイルのサフィックスおよびディレクトリの場所override アクションは標準オブジェクトまたはカスタムオブジェクトの一部として定義されます。

バージョンoverride アクションは、API バージョン 18.0 以降で使用できます。Summer ’13 以降では、override アクションを標準オブジェクトとカスタムオブジェクトの両方に適用できます。以前は、カスタムオブジェクトのみに適用できました。


174

ActionOverrideメタデータ型

説明データ型項目名必須。使用できる値は、上書きできるアクションと同じです。

stringactionName

• accept

• clone

• delete

• edit

• list

• new

• tab

• view

override に関連付けるすべてのコメント。stringcomment

scontrolまたは visualforceに typeが設定されている場合は、この項目を設定します。override として使用する Sコ

stringcontent

ントロールまたはVisualforceページの名前を参照します。インストールされたコンポーネントを参照するには、Component_ namespace__Component_nameの形式を使用します。この override アクションによって作成された新しいレコードをレコードタイプ選択ページに転送されないようにするに

booleanskipRecordTypeSelect

は、この項目を trueに設定します。この項目は、actionNameが "create" 種別 (newなど) で、typeがvisualforceに設定されている場合にのみ有効です。この項目は、API バージョン 21.0 以降で使用できます。必須。override アクションの種別を表します。有効な値は、「ActionOverrideType」に記述されています。

ActionOverrideType(string型の列挙)

type

ActionOverrideType

ActionOverrideTypeは、使用する override アクションの種別を定義する string型の列挙です。有効な値は、次のとおりです。• default — override はインストールされたパッケージが提供するカスタム override を使用します。利用できる

ものがない場合、標準の Salesforce の動作が使用されます。• scontrol — override は Sコントロールの動作を使用します。• standard — override は通常の Salesforce の動作を使用します。• visualforce — override は Visualforce ページの動作を使用します。

宣言的なメタデータの定義のサンプルアクションを次のように定義することができます。

<CustomObject xmlns="http://soap.sforce.com/2006/04/metadata"><actionOverrides>

<actionName>edit</actionName><type>visualforce</type><content>myEditVFPage</content><comment>This edit action is a lot safer.</comment>

175

ActionOverrideメタデータ型

</actionOverrides></CustomObject>

上記の定義では、retrieve()をコールすると次のコードが表示されます。


<actionName>edit</actionName><type>default</type>


登録者が上述のメタデータを使用してパッケージをインストールした場合、XML を編集することによってその動作を上書きできます。たとえば、通常の Salesforce の動作が必要な場合は、次のコードを使用します。


<actionName>edit</actionName><type>standard</type>


関連リンクCustomObject

BusinessProcessBusinessProcess メタデータ型によって、ユーザのプロファイルに基づいて異なる選択リスト値を表示できます。Metadata メタデータ型を拡張し、その fullName項目を継承します。複数のビジネスプロセスを使用すると、セールス、サポート、およびリードのライフサイクルを個別に追跡できます。セールス、サポート、リード、またはソリューションのプロセスは、レコードタイプに割り当てられます。レコードタイプは、ビジネスプロセスに関連付けられるユーザプロファイルを決定します。詳細は、Salesforceオンラインヘルプの「複数のビジネスプロセスの管理」を参照してください。

宣言的なメタデータファイルのサフィックスおよびディレクトリの場所ビジネスプロセスは、カスタムオブジェクトまたは標準オブジェクトの定義の一部として定義されます。詳細は、「CustomObject」を参照してください。

バージョンBusinessProcess コンポーネントは、API バージョン 17.0 以降で使用できます。

項目

説明データ型項目ビジネスプロセスの説明。stringdescription

APIアクセスの一意の識別子として使用される名前。fullNameには、アンダースコアと英数字のみを使用

stringfullName

176

BusinessProcessメタデータ型

説明データ型項目できます。一意であること、最初は文字であること、空白は使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。この項目は、Metadata コンポーネントから継承されています。ビジネスプロセスが有効であるか (true)、否か(false) を示します。

booleanisActive

パッケージが作成された開発組織の名前空間。stringnamespacePrefix

このビジネスプロセスに関連付けられた選択リスト値のリスト。

PicklistValue[]values

宣言的なメタデータの定義のサンプルリードビジネスプロセスの XML 定義のサンプルを以下に示します。

<?xml version="1.0" encoding="UTF-8"?><CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">....

<businessProcesses><fullName>HardwareLeadProcess</fullName><description>Lead Process for hardware division</description><isActive>true</isActive><values>

<fullName>Closed - Converted</fullName><default>false</default>

</values><values>

<fullName>CustomLeadStep1</fullName><default>false</default>

</values><values>

<fullName>CustomLeadStep2</fullName><default>false</default>

</values><values>

<fullName>Open - Not Contacted</fullName><default>false</default>

</values><values>

<fullName>Working - Contacted</fullName><default>true</default>

</values></businessProcesses>

....</CustomObject>


CompactLayoutコンパクトレイアウトに関連付けられたメタデータを表します。Metadataメタデータ型を拡張し、そのfullName

項目を継承します。

177

CompactLayoutメタデータ型

コンパクトレイアウトは、レコードの重要な項目を一目で確認できるよう表示するためにSalesforce1で使用されます。コンパクトレイアウトは、スペースが限られていて、レコードをすばやく認識することが重要なタッチスクリーンモバイルデバイスでレコードを表示するために設計されています。コンパクトレイアウトでは、次を除くすべての項目種別がサポートされています。• テキストエリア• ロングテキストエリア• リッチテキストエリア• 複数選択リストコンパクトレイアウトについての詳細は、Salesforceヘルプの「コンパクトレイアウトの概要」を参照してください。

ファイルのサフィックスおよびディレクトリの場所コンパクトレイアウトは、カスタムオブジェクトまたは標準オブジェクトの定義の一部として定義されます。詳細は、「CustomObject」を参照してください。

バージョンCompactLayout コンポーネントは、API バージョン 29.0 以降で使用できます。

項目

説明項目のデータ型項目名コンパクトレイアウトに割り当てられた項目。項目の順序は、コンパクトレイアウトを定義するときに項目に付与される優先度付けを表します。

stringfields


stringlabel

宣言的なメタデータの定義のサンプルCompactLayout コンポーネントの例を次に示します。


<actionName>Accept</actionName><type>Default</type>

</actionOverrides><actionOverrides>

<actionName>Clone</actionName><type>Default</type>


<actionName>Delete</actionName><type>Default</type>


<actionName>Edit</actionName><type>Default</type>


<actionName>List</actionName><type>Default</type>

178

CompactLayoutメタデータ型


<actionName>New</actionName><type>Default</type>


<actionName>Tab</actionName><type>Default</type>


<actionName>View</actionName><type>Default</type>

</actionOverrides><compactLayouts>

<fullName>testCompactLayout</fullName><compactLayoutItems>textfield__c</compactLayoutItems><label>testCompactLayoutLabel</label>

</compactLayouts><defaultCompactLayoutAssignment>SYSTEM</defaultCompactLayoutAssignment><deploymentStatus>Deployed</deploymentStatus><enableActivities>false</enableActivities><enableFeeds>false</enableFeeds><enableHistory>false</enableHistory><enableReports>false</enableReports><fields>

<fullName>textfield__c</fullName><externalId>false</externalId><label>textfield</label><length>255</length><required>false</required><type>Text</type><unique>false</unique>

</fields><label>customObj</label><nameField>

<label>customObj Name</label><type>Text</type>

</nameField><pluralLabel>customObjs</pluralLabel><recordTypes>

<fullName>RT1</fullName><active>true</active><label>RT1</label><compactLayoutAssignment>testCompactLayout</compactLayoutAssignment>

</recordTypes><recordTypes>

<fullName>RT2</fullName><active>true</active><label>RT2</label>

</recordTypes><searchLayouts/><sharingModel>ReadWrite</sharingModel>

</CustomObject>

CustomField項目に関連付けられたメタデータを表します。標準オブジェクトおよびカスタムオブジェクトのカスタム項目の定義または標準オブジェクトの標準項目の定義を作成、更新、削除するには、このメタデータ型を使用します。Metadata メタデータ型を拡張し、その fullName項目を継承します。カスタマイズできる標準項目 (ヘルプテキストを追加したり、履歴追跡や Chatter フィード追跡を有効にできる標準項目) のみがポートされます。システム項目 (CreatedById、LastModifiedDateなど)、自動採番項目を含む、その他の標準項目はサポートされません。

179

CustomFieldメタデータ型

項目を作成または更新するときには必ず完全名を指定する必要があります。たとえば、カスタムオブジェクトのカスタム項目は次のように表されます。

MyCustomObject__c.MyCustomField__c

標準オブジェクトのカスタム項目の例を次に示します。

Account.MyAcctCustomField__c

次に、標準オブジェクトの標準項目の例を示します。

Account.Phone

宣言的なメタデータファイルのサフィックスおよびディレクトリの場所カスタム項目はユーザ定義項目で、カスタムオブジェクトまたは標準オブジェクトの定義の一部です。詳細は、「CustomObject」を参照してください。標準項目は、標準オブジェクトで事前に定義されています。


カスタムオブジェクトまたは標準オブジェクトの項目の取得カスタムオブジェクトまたは標準オブジェクトを取得するとき、カスタマイズできない標準項目を除き、そのオブジェクトに関連付けられるものすべてが返されます。package.xmlで明示的にオブジェクトと項目の名前を指定することによって、オブジェクトの特定の項目のみを取得することもできます。package.xmlの次の定義では、それぞれ要求された項目定義を含む、objects/MyCustomObject__c.objectファイルとobjects/Account.objectファイルを作成します。

<types><members>MyCustomObject__c.MyCustomField__c</members><members>Account.MyCustomAccountField__c</members><members>Account.Phone</members><name>CustomField</name>

</types>

バージョンカスタム項目および標準項目は API バージョン 10.0 以降で使用できます。


説明データ型項目名この項目が大文字と小文字を区別するかどうかを示します (区別する場合は true、しない場合はfalse)。

booleancaseSensitive

指定されている場合、項目のデフォルト値を表します。

stringdefaultValue

180


説明データ型項目名参照関係の削除オプションを提供します。有効な値は、次のとおりです。SetNull

これはデフォルトです。参照レコードが削除されると、参照項目は消去されます。

DeleteConstraint (string型の列挙)

deleteConstraint

Restrict

レコードが参照関係にある場合に、そのレコードが削除されないように防止します。

Cascade

参照レコードも関連付けられた参照項目も削除します。

参照関係についての詳細は、Salesforceヘルプの「オブジェクトリレーションの概要」を参照してください。

将来の使用のために予約されています。booleandeprecated

項目の説明。stringdescription

表示形式。stringdisplayFormat

項目が外部 ID 項目であるか (true)、否か (false)を示します。

booleanexternalId

指定されている場合、項目の数式を表します。stringformula

数式内の空白の処理方法を示します。有効な値は、BlankAsBlankおよび BlankAsZeroです。

TreatBlanksAs (string型の列挙)

formulaTreatBlankAs


stringfullName


項目がインデックス付けされるかどうかを示します。この項目が一意である場合、またはexternalId

booleanindexed

が true に設定されている場合、isIndexed値は trueに設定されます。バージョン 14.0 では、この項目は廃止され、後方互換性の目的でのみ提供されています。項目レベルのヘルプの内容を表します。詳細は、Salesforceヘルプの「項目レベルのヘルプの定義」を参照してください。

stringinlineHelpText

181


説明データ型項目名カスタムオブジェクトの主従関係の子レコードの親を、他の親レコードに変更できるかどうかを示します。デフォルト値は、falseです。この項目は API バージョン 25.0 以降で使用できます。

booleanreparentableMasterDetail

項目の表示ラベル。取引先の Industry項目など、標準選択リスト項目の表示ラベルを更新することはできません。

stringlabel

項目の長さ。intlength

ルックアップ検索条件に関連付けられたメタデータを表します。ルックアップ検索条件の定義を作成、

LookupFilterlookupFilter

更新、または削除するには、このメタデータ型を使用します。この項目は API バージョン 30.0 以降で使用できます。

暗号化された項目では、マスクとして使用される文字を指定します。有効な値は、EncryptedFieldMaskChar に列挙されています。暗号化項目についての詳細は、Salesforce ヘルプの「暗号化カスタム項目について」を参照してください。

EncryptedFieldMaskChar(string 型の列挙)

maskChar

暗号化されたテキスト項目の場合、マスクされる文字とマスクされない文字の形式を項目で指定しま

EncryptedFieldMaskType(string 型の列挙)

maskType

す。有効な値は、EncryptedFieldMaskType に列挙されています。暗号化項目についての詳細は、Salesforceヘルプの「暗号化カスタム項目について」を参照してください。指定されている場合、項目は選択リストで、この項目は選択リスト値および表示ラベルを列挙します。

picklistpicklist

既存の行が挿入されるか (true)、否か (false) を示します。

booleanpopulateExistingRows

数値の精度。精度は、数字の桁数です。たとえば、数値 256.99 の精度は 5 です。

intprecision

指定されている場合、この項目に含まれる別のオブジェクトへの参照を示します。

stringreferenceTo

リレーションの表示ラベル。stringrelationshipLabel

指定されている場合、一対多のリレーションの値を示します。たとえば、YourObject へのリレーション

stringrelationshipName

を持っていた MyObject オブジェクトでは、そのリレーション名は YourObjects となります。

182


説明データ型項目名この項目はすべての主従関係で有効ですが、連結オブジェクト場合、値はゼロ以外のみです。連結オブ

intrelationshipOrder

ジェクトには、2 つの主従関係があり、多対多リレーションにある関連付けテーブルに類似しています。連結オブジェクトは 1 つの親オブジェクトを主オブジェクト (0) として、他方を第 2 オブジェクト (1) として定義する必要があります。主または第 2 の定義は、連結オブジェクトの削除動作およびデザインとレコード所有者の継承に影響します。詳細は、Salesforce ヘルプを参照してください。有効な値は 0 または 1 で、0 は常に、連結オブジェクトではないオブジェクトの値です。

作成時に項目への値の入力が必須であるか (true)、否か (false) を示します。

booleanrequired

項目のスケール。スケールは、数字の小数点の右側の桁数です。たとえば、数値 256.99 のスケールは 2です。

intscale

指定されている場合、項目の開始番号を示します。intstartingNumber

マークアップを削除するには true、維持するにはfalseを設定します。リッチテキストエリアをロングテキストエリアに変換するときに使用されます。

booleanstripMarkup

集計されている詳細行の項目を表します。この項目は、summaryOperation値が countでない限り、null にできません。

stringsummarizedField

この項目が集計項目である場合、項目の検索条件のセットを表します。この項目は、検索条件が一致する場合、子で集計されます。

FilterItem[]summaryFilterItems

親と子のリレーションを定義する、子の主従項目を表します。

stringsummaryForeignKey

実行される加算演算を表します。有効な値は、SummaryOperations に列挙されています。

SummaryOperations(string 型の列挙)

summaryOperation

フィード追跡の項目が有効になっているか (true)、否か (false) を示します。この項目を trueに設定

booleantrackFeedHistory

するには、関連付けられた CustomObject のenableFeeds項目も trueに設定されている必要があります。詳細は、Salesforce ヘルプの「Chatterフィード追跡のカスタマイズ」を参照してください。この項目は API バージョン 18.0 以降で使用できます。

183


説明データ型項目名項目の履歴追跡が有効になっているか (true)、否か(false) を示します。API バージョン 30.0 以降で

booleantrackHistory

は、標準オブジェクト項目 (選択リスト項目と参照項目のみ) でも使用可能になりました。trackHistoryを trueに設定するには、関連付けられた標準オブジェクトまたはカスタムオブジェクトの enableHistory項目も trueに設定されている必要があります。詳細は、Salesforceヘルプの「項目履歴管理」を参照してください。

項目の履歴トレンドデータがキャプチャされているか (true)、否か (false) を示します。少なくとも 1

booleantrackTrending

つの項目でこの属性が trueであると、オブジェクトが履歴トレンド用に有効化されます。API バージョン 29.0 以降で使用できます。詳細は、Salesforceヘルプの「履歴変更のレポート」を参照してください。

これは、チェックボックス項目にのみ関連します。設定されている場合、true 値はインデックスに組み

booleantrueValueIndexed

込まれます。この項目は API バージョン 14.0 で廃止され、後方互換性の目的でのみ提供されています。項目のデータ型を示します。有効な値は、FieldTypeに列挙されています。標準オブジェクトの標準項目の場合、type項目は省略可能です。選択リストやルックアップなどの一

FieldTypetype

部の標準項目種別ではこの項目が含まれますが、その他の種別では含まれません。カスタム項目ではtype項目が含まれます。

項目が一意であるか (true)、否か (false) を示します。

booleanunique

項目に表示される線の数を示します。intvisibleLines

子レコードを作成、編集、または削除するためにマスタレコードに必要な最低限の共有アクセスレベル

booleanwriteRequiresMasterRead

を設定します。この項目は、主従または連結オブジェクトカスタム項目のデータ型にのみ適用されます。• true —「参照」アクセス権を持つユーザは、マ

スタレコード権限を使用して子レコードを作成、編集、または削除できます。この設定により、共有の制限が緩和されます。

184


説明データ型項目名• false —「参照・更新」アクセス権を持つユー

ザは、マスタレコード権限を使用して子レコードを作成、編集、または削除できます。この設定はtrueより制限的であり、デフォルト値となっています。

連結オブジェクトの場合、2 つの親からの最も厳しい制限のあるアクセス権が適用されます。たとえば、両方の主従項目に trueが設定されているが、ユーザが 1 つのマスタレコードに対して「参照」アクセス権があり、他方のマスタレコードに対して「参照・更新」アクセス権がある場合、ユーザは子レコードを作成、編集、または削除することはできません。

項目は、追加のデータ型を使用します。詳細は、「メタデータのデータ型」 (ページ 213)を参照してください。

EncryptedFieldMaskChar

このデータ型は、maskCharで使用されます。asteriskまたは Xという 2 つの有効な値を持つ文字列です。暗号化項目についての詳細は、Salesforce オンラインヘルプの「暗号化カスタム項目について」を参照してください。

EncryptedFieldMaskType

このデータ型は、maskTypeで使用されます。有効な値は、次のとおりです。all

項目内のすべての文字が非表示になります。このオプションは、Salesforce の [すべての文字をマスク]オプションと同等です。

creditCard

最初の 12 桁が非表示になり、最後の 4 桁が表示されます。このオプションは、Salesforceの[クレジットカード番号]オプションと同等です。

ssn

最初の 5 桁が非表示になり、最後の 4 桁が表示されます。このオプションは、Salesforce の [社会保障番号]

オプションと同等です。lastFour

最後の 4 桁を除くすべての文字が非表示になります。このオプションは、Salesforce の [最後の 4 桁を表示]

オプションと同等です。sin

最後の 4 桁を除くすべての文字が非表示になります。このオプションは、Salesforce の [社会保険番号]オプションと同等です。

185


nino

すべての文字が非表示になります。項目が 9 桁の場合には、Salesforce により、各ペアの文字の後に空白が自動的に挿入されます。このオプションは、Salesforce の [国民保険番号]オプションと同等です。

暗号化項目についての詳細は、Salesforceオンラインヘルプの「暗号化カスタム項目について」を参照してください。

LookupFilter

ルックアップ検索条件に関連付けられたメタデータを表します。API バージョン 30.0 で削除された NamedFilterコンポーネントにこれが置き換わります。LookupFilter は、API バージョン 30.0 以降で使用できます。

説明データ型項目必須。ルックアップ検索条件が有効かどうかを示します。booleanactive

高度な検索条件を指定します。高度な検索条件の詳細は、Salesforce ヘルプの「検索条件ロジックを最大限に活用」を参照してください。

stringbooleanFilter

この検索条件の機能の説明。stringdescription

ルックアップ検索条件が失敗した場合に表示されるエラーメッセージ。

stringerrorMessage

必須。検索条件のセット。1 つのルックアップ検索条件につき FilterItem を 10 個まで入れることができます。

FilterItem[]filterItems

ページに表示される情報メッセージ。ある項目がルックアップ検索条件で除外されている理由など、ユーザにとってわかりにくい内容を説明するために使用します。

stringinfoMessage

必須。ルックアップ検索条件が省略可能かどうかを示します。

booleanisOptional

ルックアップ検索条件は、追加のデータ型を使用します。詳細は、「メタデータのデータ型」を参照してください。

FilterItem

一連の検索条件の 1 つのエントリを表します。

説明データ型項目検索条件に指定された項目を表します。stringfield

この検索条件項目の絞り込み操作を表します。有効な値は、FilterOperation に列挙されています。

FilterOperation(string 型の列挙)

operation

操作される検索条件項目の値を表します。たとえば、検索条件が my_number_field__c > 1である場合、value

の値は 1です。

stringvalue

186


説明データ型項目検索条件の最終列に項目または項目値が含まれるかを指定します。承認プロセスでは、検索条件の valueFieldエントリをサポートしていません。

stringvalueField

FilterOperation

これは、さまざまな絞り込み操作をリストする string 型の列挙です。有効な値は、次のとおりです。• equals

• notEqual

• lessThan

• greaterThan

• lessOrEqual

• greaterOrEqual

• contains

• notContain

• startsWith

• includes

• excludes

SummaryOperations

summaryOperationのデータ型を表します。有効な値は、次のとおりです。• Count

• Min

• Max

• Sum

宣言的なメタデータの定義のサンプル次の例は、Comments__cという名前のカスタム項目の項目定義を示します。

<?xml version="1.0" encoding="UTF-8"?><CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">....<fields>

<fullName>Comments__c</fullName><description>Add your comments about this object here</description><inlineHelpText>This field contains help text for this object</inlineHelpText><label>Comments</label><length>32000</length><type>LongTextArea</type><visibleLines>30</visibleLines>


187


次の Account 標準オブジェクトの 2 つの項目の定義を示します。1 つはカスタム項目(MyCustomAccountField__c)、もう 1 つは履歴追跡が有効になっている標準項目 (Phone) です。


<fields><fullName>MyCustomAccountField__c</fullName><description>A custom field on the Account standard object.</description><externalId>false</externalId><inlineHelpText>Some help text.</inlineHelpText><label>MyCustomAccountField</label><length>100</length><required>false</required><trackFeedHistory>false</trackFeedHistory><trackHistory>false</trackHistory><type>Text</type><unique>false</unique>

</fields><fields>

<fullName>Phone</fullName><trackFeedHistory>false</trackFeedHistory><trackHistory>true</trackHistory>

</fields></CustomObject>


Picklist (連動選択リストを含む)MetadataNamedFilter

FieldSet項目セットを表します。項目セットとは、項目をグループ化したものです。たとえば、ユーザの名、ミドルネーム、姓、肩書を示す項目を 1 つの項目セットにして持つことができます。項目セットは、Visualforce ページで動的に参照できます。そのページを管理パッケージに追加すれば、システム管理者は項目セット内の項目の追加、削除、並び替えを行って、コードを変更せずに Visualforce ページ上に表示する項目を変更できます。

バージョンFieldSet コンポーネントは、API バージョン 21.0 以降で使用できます。

項目

説明データ型項目項目セットのすべての使用可能な項目を含む配列。FieldSetItem[]availableFields

必須。開発者が記載する項目セットに関する説明。これは必須です。

stringdescription

Visualforceページ上に表示されているすべての項目を含む配列。項目が表示される順序により、ページ上の表示順序が決まります。

FieldSetItem[]displayedFields

188

FieldSetメタデータ型

説明データ型項目必須。項目セットの参照に使用する表示ラベル。stringlabel

FieldSetItem

FieldSetItem は項目セットの個別の項目を表します。

説明データ型項目必須。標準オブジェクトまたはカスタムオブジェクトの項目名。

stringfield

参照のみ。項目が管理パッケージと未管理パッケージのどちらを使用して項目セットに追加されたかを示します。

booleanisFieldManaged

参照のみ。項目が必須であるか (true)、否か (false)を示します。

booleanisRequired

宣言的なメタデータの定義のサンプルFieldSet コンポーネントの XML 定義のサンプルを以下に示します。


<fieldSets><fullName>FieldSetNames</fullName><availableFields>

<field>MiddleName__c</field></availableFields><availableFields>

<field>Title__c</field></availableFields><description>FieldSet containing how to properly address someone</description><displayedFields>

<field>FirstName__c</field></displayedFields><displayedFields>

<field>LastName__c</field></displayedFields><label>FieldSet Names</label>

</fieldSets></CustomObject>

ListViewListView では取引先責任者、取引先、またはカスタムオブジェクトなどのレコードの条件設定済みリストを表示できます。Metadata メタデータ型を拡張し、その fullName項目を継承します。Salesforce オンラインヘルプの「カスタムリストビューの作成」を参照してください。

メモ: 自分にのみ表示する [表示の制限]オプションが設定されているリストビューにはメタデータ APIではアクセスできません。これらの各リストビューは特定のユーザに関連付けられます。

189

ListViewメタデータ型

宣言的なメタデータファイルのサフィックスおよびディレクトリの場所リストビューは CustomObject コンポーネント内に保存されます。コンポーネントは、取引先などのカスタムオブジェクトまたは標準オブジェクトを表すことができます。

バージョンカスタムオブジェクトの ListView コンポーネントは、API バージョン 14.0 以降で使用できます。取引先などの標準オブジェクトの ListView コンポーネントは、API バージョン 17.0 以降で使用できます。

項目

説明データ型項目この項目は検索条件の詳細オプションを表します。検索条件の詳細オプションでは、複数の検索条件行

stringbooleanFilter

項目に対する AND Boolean 演算子と OR Boolean 演算子の組み合わせを使用する検索条件を作成できます。たとえば、(1 AND 2) OR 3では最初の 2 つの検索条件行項目または 3 番目の検索条件行項目に一致するレコードが検索されます。Salesforce オンラインヘルプの「検索条件ロジックを最大限に活用」を参照してください。リストビューの項目のリスト。各カスタム項目にMyCustomField__cなどのオブジェクト名を基準にした項目名が指定されます。

string[]columns

組織がディビジョンを使用してデータを分類しており、「ディビジョンの使用」権限を持っている場合

stringdivision

は、リストビュー内のレコードがこのディビジョンに一致する必要があります。この項目は、すべてのレコードを検索する場合にのみ利用できます。この項目は API バージョン 17.0 以降で使用できます。

必須。この項目は、所有者でレコードを絞り込むか、すべてのレコードを表示するかを示します。

FilterScope (string型の列挙)filterScope

検索条件行項目のリスト。ListViewFilter[]filters

必須。Metadata から継承されるこの項目は、このメタデータ型の WSDL では定義されません。作成時、

stringfullName

更新時、または削除時に指定する必要があります。コールにおけるこの項目の例を確認するには、「create()」を参照してください。必須。リストビューの名前。stringlabel

組織がトランスレーションワークベンチを使用し、startsWithまたはcontains演算子を使用している

Languagelanguage

場合、条件検索に使用する言語。検索用語として入力した値は検索条件の言語と同じ言語である必要が

190


説明データ型項目あります。Salesforce オンラインヘルプの「検索条件の入力」を参照してください。有効な言語の値の一覧は、「Translations」を参照してください。この項目は API バージョン 17.0 以降で使用できます。

キューの名前。キューへのアクセス権を持つユーザがオブジェクトを監視および管理できるように、オ

stringqueue

ブジェクトがキューに割り当てられている場合があります。キューを作成すると、対応するリストビューが自動的に作成されます。Salesforce オンラインヘルプの「キューの作成」を参照してください。リストビューの共有アクセス権。この項目は API バージョン 17.0 以降で使用できます。

SharedTosharedTo

ListViewFilter

ListViewFilter は検索条件行項目を表します。

説明データ型項目必須。検索条件に指定された項目を表します。stringfilter

必須。equalsなど、検索条件で使用する演算。有効な値は、「FilterOperation」にリストされています。

FilterOperation (string 型の列挙)

operation

操作される検索条件項目の値を表します。たとえば、検索条件がmy_number_field__c > 1である場合、valueの値は 1です。

stringvalue

FilterScope

これは、レコードの検索条件を表す string 型の列挙です。有効な値のリストを下の表に示します。

説明列挙値すべての商談などのすべてのレコード。Everything

私の商談など、リストビューを実行しているユーザが所有しているレコード。Mine

キューに割り当てられているレコード。Queue

代理 ToDo などアクションを他のユーザが代理で行うレコード。このオプションは、API バージョン 17.0 以降で使用できます。

Delegated

リストビューを参照するユーザのテリトリーのレコード。このオプションは、組織でテリトリー管理が有効になっている場合に使用できます。このオプションは、API バージョン 17.0 以降で使用できます。

MyTerritory

191


説明列挙値リストビューを参照するユーザのチームのテリトリーのレコード。このオプションは、組織でテリトリー管理が有効になっている場合に使用できます。このオプションは、API バージョン 17.0 以降で使用できます。

MyTeamTerritory

チームに割り当てられているレコード。このオプションは、API バージョン17.0 以降で使用できます。

Team

宣言的なメタデータの定義のサンプルカスタムオブジェクトのリストビューの XML 定義のサンプルを以下に示します。

<?xml version="1.0" encoding="UTF-8"?><CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">. . .

<listViews><fullName>All_Mileages</fullName><filterScope>all</filterScope><label>All Mileages</label>

</listViews><listViews>

<fullName>My_Mileages</fullName><booleanFilter>1 AND 2</booleanFilter><columns>NAME</columns><columns>CREATED_DATE</columns><filterScope>mine</filterScope><filters>

<field>NAME</field><operation>equals</operation><value>Eric Bristow</value>

</filters><filters>

<field>City__c</field><operation>equals</operation><value>Paris</value>

</filters><label>My Mileages</label>

</listViews>. . .</CustomObject>


package.xml マニフェストファイルのサンプル

NamedFilter

メモ: このコンポーネントは API バージョン 30.0 で削除されました。それより前の API バージョンでのみ使用できます。ルックアップ検索条件に関連付けられたメタデータは、CustomFieldコンポーネントのlookupFilter項目によって表されるようになりました。

ルックアップ検索条件に関連付けられたメタデータを表します。ルックアップ検索条件の定義を作成、更新、または削除するには、このメタデータ型を使用します。Metadataメタデータ型を拡張し、その fullName項目を継承します。このメタデータ型は、標準項目のルックアップ検索条件のカスタマイズを行う場合にも使用できます。

192

NamedFilterメタデータ型

メモ: namedFilter は、関連付けられたルックアップ項目の対象オブジェクトの子として表示されます。

宣言的なメタデータファイルのサフィックスおよびディレクトリの場所ルックアップ検索条件は、カスタムオブジェクト定義または標準オブジェクト定義の一部として定義されます。詳細は、「CustomObject」を参照してください。


バージョンルックアップ検索条件は、API バージョン 17.0 以降で使用できます。


説明データ型項目名必須。ルックアップ検索条件が有効かどうかを示します。

booleanactive

高度な検索条件を指定します。高度な検索条件の詳細は、Salesforce オンラインヘルプの「検索条件ロジックを最大限に活用」を参照してください。

stringbooleanFilter

この検索条件の機能の説明。stringdescription

ルックアップ検索条件が失敗した場合に表示されるエラーメッセージ。

stringerrorMessage

必須。ルックアップ検索条件に関連付けられたカスタム項目または標準項目のfullName。各ルックアッ

stringfield

プ検索条件に 1 つのリレーション項目を関連付けることができます。その逆も可能です。

メモ: ルックアップ検索条件に関連付けられた項目の更新はできません。

必須。検索条件のセット。FilterItems[]filterItems

ページに表示される情報メッセージ。ある項目がルックアップ検索条件で除外されている理由など、

stringinfoMessage

ユーザにとってわかりにくい内容を説明するために使用します。Metadataから継承されるこの項目は、このメタデータ型の WSDL では定義されません。作成時、更新

stringfullName


193


説明データ型項目名この値は nullにできません。

必須。ルックアップ検索条件が省略可能かどうかを示します。

booleanisOptional

必須。ルックアップ検索条件の名前。ユーザインターフェースでこの項目を作成する場合、名前は自

stringname

動的に割り当てられます。メタデータ APIを使用してこの項目を作成する場合、name項目を含める必要があります。このルックアップ検索条件を使用するルックアップ項目が含まれるオブジェクト。ルックアップ検索条

stringsourceObject

件がソースオブジェクトの項目を参照する場合、この項目を設定します。

ルックアップ検索条件は、追加のデータ型を使用します。詳細は、「メタデータのデータ型」を参照してください。

FilterItems

FilterItems には次のプロパティが含まれます。

説明データ型項目検索条件に指定された項目を表します。stringfield

この検索条件項目の絞り込み操作を表します。有効な値は、FilterOperation に列挙されています。

FilterOperation(string 型の列挙)

operation

操作される検索条件項目の値を表します。たとえば、検索条件が my_number_field__c > 1である場合、value

の値は 1です。

stringvalue

FilterOperation

これは、さまざまな絞り込み操作をリストする string 型の列挙です。有効な値は、次のとおりです。• equals

• notEqual

• lessThan

• greaterThan

• lessOrEqual

• greaterOrEqual

• contains

• notContain

• startsWith

• includes

• excludes

194




<namedfilters><fullName>nf_Acc</fullName><active>true</active><booleanFilter>1 OR 2</booleanFilter><field>Account.lk__c</field><filterItems>

<field>Account.Phone</field><operation>notEqual</operation><value>x</value>

</filterItems><filterItems>

<field>Account.Fax</field><operation>notEqual</operation><value>y</value>

</filterItems><name>Acc</name><sourceObject>Account</sourceObject>

</namedfilters>....</CustomObject>


Picklist (連動選択リストを含む)MetadataCustomField

Picklist (連動選択リストを含む)カスタムオブジェクトのカスタム項目、または取引先などの標準オブジェクトのカスタム項目または標準項目の選択リスト (または連動選択リスト) の定義を表します。

バージョンカスタムオブジェクトのカスタム項目の選択リストは、APIバージョン 12.0 以降で使用できます。取引先などの標準オブジェクトのカスタム項目または標準項目の選択リストは、API バージョン 16.0 以降で使用できます。API バージョン 27.0 以降では、カスタム項目のリリースに必要な場合は、選択リストの値が削除されます。

宣言的なメタデータファイルのサフィックスおよびディレクトリの場所選択リストの定義は、カスタムオブジェクトと選択リストの定義が関連付けられた項目に含まれます。

項目選択リストには次の項目が含まれます。

説明データ型項目名これが連動選択リストである場合、制御項目のfullName。連動選択リストは、制御選択リストまたはチェックボック

stringcontrollingField

195

Picklist (連動選択リストを含む)メタデータ型

説明データ型項目名スと連動して動作し、使用可能なオプションに検索条件を適用します。制御項目で選択した値は、連動項目に使用できる値に影響します。この項目は API バージョン 14.0 以降で使用できます。必須。選択リストの値のセットを表します。PicklistValue[]picklistValues

必須。値を並び替えるか (true)、否か (false) を示します。booleansorted

PicklistValue

このメタデータ型では選択リストの値を定義し、この値がデフォルト値であるかどうかを指定します。Metadataメタデータ型を拡張し、その fullName項目を継承します。選択リストの値を使用する場合は、次の点に注意してください。• 標準オブジェクトを取得する場合、カスタマイズされた選択リスト値のみでなく、すべての選択リスト値が

取得されます。• 標準選択リスト項目への変更をリリースする場合、必要に応じて選択リストの値を追加、更新、削除するこ

とができます。• 選択リストの値を無効として設定することはできませんが、選択リストの値が欠落しているときにupdate()

コールを呼び出すと、欠落している値が無効になります。

説明データ型項目名この値によりユーザが見積 PDF をメール送信できるか(true)、否か (false) を示します。この項目は見積のStatus

booleanallowEmail

項目にのみ関連します。この項目は API バージョン 18.0 以降で使用できます。この値が完了の状況に関連付けられるか (true)、否か(false) を示します。この項目はケースおよび ToDo の標準

booleanclosed

項目のStatusにのみ関連します。この項目はAPIバージョン 16.0 以降で使用できます。レポートおよびダッシュボードのグラフで色が使用されている場合、選択リスト値に割り当てられている色を示しま

stringcolor

す。色は、16 進形式で表記されます (#FF6600 など)。色が指定されていない場合、グラフ作成時に動的に割り当てられます。この項目は API バージョン 17.0 以降で使用できます。この選択リスト値にリンクしている制御項目の値のリスト。制御項目は、チェックボックスまたは選択リストにするこ

string[]controllingFieldValues

とができます。この項目は API バージョン 14.0 以降で使用できます。リストの値は項目のデータ型によって異なります。• Checkbox: checkedまたは unchecked。• Picklist: 制御項目の選択リスト値の fullName。

この値が取引開始済みの状況に関連付けられるか (true)、否か (false) を示します。この項目はリードの標準項目の

booleanconverted

196


説明データ型項目名[リード状況]にのみ関連します。詳細は、Salesforce オンラインヘルプの「取引の開始」を参照してください。この項目は API バージョン 16.0 以降で使用できます。この値がセルフサービスポータルで使用可能か (true)、否か (false) を示します。この項目はケースの標準項目の[原因]にのみ関連します。セルフサービスは、顧客にオンラインサポートチャネルを提供します。これにより、顧客は、カスタマサービス担当

booleancssExposed

者に連絡しなくても各自の疑問を解消できます。セルフサービスについての詳細は、Salesforce オンラインヘルプの「セルフサービスの設定」を参照してください。

メモ: Spring '12 リリースから、新しい組織ではセルフサービスポータルを利用できなくなります。既存の組織は、引き続きセルフサービスポータルを使用できます。


必須。この値が指定されている選択リストのデフォルトの選択リスト値であるか (true)、否か (false) を示します。

booleandefault

カスタム選択リスト値の説明。この項目は商談の標準項目の Stageにのみ関連します。カスタマイズされている選択

stringdescription

リスト値に関する説明を記載すると、これを作成した理由の履歴を追跡できるので便利です。この項目はAPIバージョン 16.0 以降で使用できます。この値が売上予測分類に関連付けられるか (true)、否か(false) を示します。この項目は商談の標準項目の Stage

ForecastCategories(string 型の列挙)

forecastCategory

にのみ関連します。以下に示した有効な文字列値を含む、売上予測分類についての詳細は、Salesforce オンラインヘルプの「売上予測分類の使用」を参照してください。• Omitted• Pipeline• BestCase• Forecast• Closed


API アクセスの一意の識別子として使用される名前。fullNameには、アンダースコアと英数字のみを使用できま

stringfullName

す。一意であること、最初は文字であること、空白は使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。この項目は、Metadata コンポーネントから継承されています。この値が優先度が高い項目であるか (true)、否か (false)を示します。この項目は ToDo の標準項目の Priorityに

booleanhighPriority

197


説明データ型項目名のみ関連します。ToDo についての詳細は、Salesforce オンラインヘルプの「ToDo の作成」を参照してください。この項目は API バージョン 16.0 以降で使用できます。この値が確度割合であるか (true)、否か (false) を示します。この項目は商談の標準項目のStageにのみ関連します。

intprobability

商談についての詳細は、Salesforce オンラインヘルプの「商談の概要」を参照してください。この項目は API バージョン 16.0 以降で使用できます。パートナーの相手側から見たロールの名前に対応する選択リスト値。ロールが「下請け」の場合、相手側から見たロー

stringreverseRole

ルは「元請け」となります。Salesforce でパートナーロールを取引先に割り当てると、相手側から見たパートナーとの関係が作成され、両方の取引先で他方をパートナーとして表示できます。この項目は、パートナーロールにのみ関連します。詳細は、Salesforceオンラインヘルプの「パートナーの項目」を参照してください。この項目は API バージョン 18.0 以降で使用できます。この値がレビュー済み状況に関連付けられるか (true)、否か (false) を示します。この項目はソリューションの標準

booleanreviewed

項目のStatusにのみ関連します。商談についての詳細は、Salesforce オンラインヘルプの「ソリューションの作成」を参照してください。この項目は API バージョン 16.0 以降で使用できます。この値が完了または成立の状況に関連付けられるか (true)、否か (false) を示します。この項目は商談の標準項目の

booleanwon

Stageにのみ関連します。この項目は API バージョン 16.0以降で使用できます。

Java のサンプル次のサンプルでは選択リストを使用します。レコードタイプおよびプロファイルを含む選択リストを使用する完全なサンプルについては、「Profile」 (ページ 357)を参照してください。

public void setPicklistValues() {// Create a picklistPicklist expenseStatus = new Picklist();PicklistValue unsubmitted = new PicklistValue();unsubmitted.setFullName("Unsubmitted");PicklistValue submitted = new PicklistValue();submitted.setFullName("Submitted");PicklistValue approved = new PicklistValue();approved.setFullName("Approved");PicklistValue rejected = new PicklistValue();rejected.setFullName("Rejected");expenseStatus.setPicklistValues(new PicklistValue[]

{unsubmitted, submitted, approved, rejected});

CustomField expenseStatusField = new CustomField();

198


expenseStatusField.setFullName("ExpenseReport__c.ExpenseStatus__c");

expenseStatusField.setLabel("Expense Report Status");expenseStatusField.setType(FieldType.Picklist);expenseStatusField.setPicklist(expenseStatus);try {AsyncResult[] ars =metadataConnection.create(new Metadata[] {expenseStatusField});


}}

宣言的なメタデータの定義のサンプル次のサンプルでは、カスタムオブジェクトの連動選択リストを含む選択リストの使用例を示します。isAmerican__c

チェックボックスでは manufacturer__c選択リストに表示されるメーカーのリストを制御します。また、manufacturer__cチェックボックスでは model__c選択リストに表示されるモデルのリストを制御します。


<deploymentStatus>Deployed</deploymentStatus><enableActivities>true</enableActivities><fields>

<fullName>isAmerican__c</fullName><defaultValue>false</defaultValue><label>American Only</label><type>Checkbox</type>

</fields><fields>

<fullName>manufacturer__c</fullName><label>Manufacturer</label><picklist>

<controllingField>isAmerican__c</controllingField><picklistValues>

<fullName>Chrysler</fullName><controllingFieldValues>checked</controllingFieldValues><default>false</default>

</picklistValues><picklistValues>

<fullName>Ford</fullName><controllingFieldValues>checked</controllingFieldValues><default>false</default>


<fullName>Honda</fullName><controllingFieldValues>unchecked</controllingFieldValues><default>false</default>


<fullName>Toyota</fullName><controllingFieldValues>unchecked</controllingFieldValues><default>false</default>

</picklistValues><sorted>false</sorted>

</picklist><type>Picklist</type>

</fields><fields>

<fullName>model__c</fullName><label>Model</label><picklist>

<controllingField>manufacturer__c</controllingField><picklistValues>

<fullName>Mustang</fullName><controllingFieldValues>Ford</controllingFieldValues>

199


<default>false</default></picklistValues><picklistValues>

<fullName>Taurus</fullName><controllingFieldValues>Ford</controllingFieldValues><default>false</default>


<fullName>PT Cruiser</fullName><controllingFieldValues>Chrysler</controllingFieldValues><default>false</default>


<fullName>Pacifica</fullName><controllingFieldValues>Chrysler</controllingFieldValues><default>false</default>


<fullName>Accord</fullName><controllingFieldValues>Honda</controllingFieldValues><default>false</default>


<fullName>Civic</fullName><controllingFieldValues>Honda</controllingFieldValues><default>false</default>


<fullName>Prius</fullName><controllingFieldValues>Toyota</controllingFieldValues><default>false</default>


<fullName>Camry</fullName><controllingFieldValues>Toyota</controllingFieldValues><default>false</default>

</picklistValues><sorted>false</sorted>

</picklist><type>Picklist</type>


次のサンプルでは、商談の標準項目の Stageの使用例を示します。


<fields><fullName>StageName</fullName><picklist>

<picklistValues><fullName>Prospecting</fullName><default>false</default><forecastCategory>Pipeline</forecastCategory><probability>10</probability>


<fullName>Qualification</fullName><default>false</default><forecastCategory>Pipeline</forecastCategory><probability>10</probability>


<fullName>Needs Analysis</fullName><default>false</default><forecastCategory>Pipeline</forecastCategory>

200


<probability>20</probability></picklistValues>...

</picklist></fields>

<CustomObject>

RecordTypeレコードタイプに関連付けられたメタデータを表します。レコードタイプを使用すると、異なるビジネスプロセス、選択リストの値、およびページレイアウトを、さまざまなユーザに提供できます。詳細は、Salesforceオンラインヘルプの「レコードタイプの概要」を参照してください。このメタデータ型は、カスタムオブジェクトのレコードタイプの定義を作成、更新または削除するために使用します。Metadata メタデータ型を拡張し、そのfullName項目を継承します。


バージョンレコードタイプは API バージョン 12.0 以降で使用できます。

項目

説明データ型項目必須。レコードタイプが有効かどうかを示します。booleanactive

このレコードタイプに関連付けられたビジネスプロセスのfullName。リード、商談、ソリューショ

stringbusinessProcess

ン、およびケースのレコードタイプではこの項目は必須項目です。それ以外の場合は使用できません。「BusinessProcess」 (ページ 176)を参照してください。この項目はAPIバージョン 17.0 以降で使用できます。

レコードタイプに割り当てられているコンパクトレイアウトを表します。この項目はAPIバージョン 29.0 以降で使用できます。

stringcompactLayoutAssignment

レコードタイプの説明。最大 255 文字です。stringdescription

レコードタイプの名前。fullNameには、アンダースコアと英数字のみを使用できます。一意である

stringfullName

こと、最初は文字であること、空白は使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。この項目が、使用できなくなったバージョン

201

RecordTypeメタデータ型

説明データ型項目14.0 より前の文字を含んでいた場合は、それらの文字はこの項目から削除され、その項目の以前の値は label項目に保存されていました。この項目はMetadata コンポーネントから継承するため、この項目はこのコンポーネントの WSDLで定義されません。作成時、更新時、または削除時に指定する必要があります。コールにおけるこの項目の例を確認するには、「create()」を参照してください。この値は nullにできません。

必須。レコードタイプの説明ラベル。fullName

項目で使用できる文字のリストは、バージョンstringlabel

14.0 以降削減されています。この項目には、バージョン 14.0 以前の fullName項目に含まれている値が含まれます。選択リストの値のセットを表します。RecordTypePicklistValue[]picklistValues

RecordTypePicklistValue

RecordTypePicklistValue は、レコードタイプを定義する選択リストおよび有効な値の組み合わせを表します。

説明データ型項目名必須。選択リストの名前。stringpicklist

選択リストの 1 つ以上の選択リストの値。定義されている各値は、このコンポーネントを含むレコードタイプで使用できます。

PicklistValuevalues

Java のサンプル次のサンプルでは 2 つのレコードタイプを使用します。プロファイルおよび選択リストを含む完全なサンプルについては、「Profile」 (ページ 357)を参照してください。

public void recordTypeSample() {try {// Employees and managers have different access// to the state of the expense sheetRecordType edit = new RecordType();edit.setFullName("ExpenseReport__c.Edit");edit.setLabel("ExpenseReport__c.Label");PicklistValue unsubmitted = new PicklistValue();unsubmitted.setFullName("Unsubmitted");PicklistValue submitted = new PicklistValue();submitted.setFullName("Submitted");RecordTypePicklistValue editStatuses =

new RecordTypePicklistValue();editStatuses.setPicklist("ExpenseStatus__c");editStatuses.setValues(

new PicklistValue[] {unsubmitted, submitted});edit.setPicklistValues(

new RecordTypePicklistValue[] {editStatuses});

202

RecordTypeメタデータ型

AsyncResult[] arsEdit =metadataConnection.create(new Metadata[] {edit});

RecordType approve = new RecordType();approve.setFullName("ExpenseReport__c.Approve");PicklistValue approved = new PicklistValue();approved.setFullName("Approved");PicklistValue rejected = new PicklistValue();rejected.setFullName("Rejected");RecordTypePicklistValue approveStatuses =

new RecordTypePicklistValue();approveStatuses.setPicklist("ExpenseStatus__c");approveStatuses.setValues(

new PicklistValue[] {approved, rejected});approve.setPicklistValues(

new RecordTypePicklistValue[] {approveStatuses});AsyncResult[] arsApprove =metadataConnection.create(new Metadata[] {approve});


}}

宣言的なメタデータの定義のサンプルカスタムオブジェクトのレコードタイプの定義を以下に示します。

<CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">. . .

<recordTypes><fullName>My First Recordtype</fullName>

</recordTypes>. . .</CustomObject>

SearchLayoutsオブジェクトの検索レイアウトに関連付けられたメタデータを表します。検索結果、検索条件項目、ルックアップダイアログ、およびタブホームページの最近のレコードリストに表示される項目をカスタマイズできます。詳細は、Salesforceオンラインヘルプの「検索レイアウトのカスタマイズ」および「カスタムオブジェクト用の検索レイアウトのカスタマイズ」を参照してください。

バージョンカスタムオブジェクト用の検索レイアウトは、API バージョン 14.0 以降で使用できます。標準オブジェクト (行動と ToDo を除く) の検索レイアウトを変更する機能は、API バージョン 27.0 以降で使用できます。

項目

説明データ型項目オブジェクトに関連付けられたタブの、最近のオブジェクト名リストビューに表示される項目のリ

string[]customTabListAdditionalFields

スト。name項目は必須で、常に最初の列ヘッダーとして表示されるため、このリストに含まれません。その他のすべての項目は含まれます。各カス

203

SearchLayoutsメタデータ型

説明データ型項目タム項目に MyCustomField__cなどのオブジェクト名を基準にした項目名が指定されます。検索レイアウトから除外される標準ボタンのリスト。

string[]excludedStandardButtons

オブジェクトのリストビューで使用できるボタンのリスト。この項目は、Salesforceユーザインターフェースのオブジェクト詳細ページに表示される [検索レイ

string[]listViewButtons

アウト] 関連リストの [オブジェクト名リストビュー]に含まれる [表示されるボタン] の値に相当します。詳細は、Salesforceオンラインヘルプの「ルックアップダイアログ検索」を参照してください。

オブジェクトのルックアップダイアログに表示される項目のリスト。name項目は必須で、常に最初

string[]lookupDialogsAdditionalFields

の列ヘッダーとして表示されるため、このリストに含まれません。その他のすべての項目は含まれます。各カスタム項目に MyCustomField__cなどのオブジェクト名を基準にした項目名が指定されます。Salesforceオブジェクトには、多くの場合、リレーションで 2 つのレコードを互いに関連付けるルックアップ項目が 1 つ以上含まれます。たとえば、取引先責任者レコードには、その取引先責任者とその取引先責任者が関連付けられた組織との間のリレーションを表す[取引先]ルックアップ項目があります。ルックアップ検索ダイアログを使用すると、編集中のレコードに関連付けられたレコードを検索しやすくなります。ルックアップ検索条件項目を使用すると、オブジェクト内のカスタマイズされた項目のリストによってルックアップ検索を絞り込むことができます。この項目は、アプリケーションユーザインターフェースのオブジェクト詳細ページに表示される[検索レイアウト] 関連リストの [ルックアップダイアログ]に相当します。詳細は、Salesforce オンラインヘルプの「ルックアップダイアログ検索」を参照してください。

オブジェクトの拡張ルックアップの絞り込みに使用できる項目のリスト。拡張ルックアップは、必

string[]lookupFilterFields

要に応じてシステム管理者が有効にできます。各カスタム項目に MyCustomField__cなどのオブジェクト名を基準にした項目名が指定されます。

204


説明データ型項目この項目は、アプリケーションユーザインターフェースのオブジェクト詳細ページに表示される[検索レイアウト] 関連リストの [ルックアップ検索条件項目]に相当します。詳細は、Salesforce オンラインヘルプの「ルックアップダイアログ検索」を参照してください。

オブジェクトのルックアップダイアログに表示される電話関連項目のリスト。name項目は必須で、

string[]lookupPhoneDialogsAdditionalFields

常に最初の列ヘッダーとして表示されるため、このリストに含まれません。その他のすべての項目は含まれます。各カスタム項目にMyCustomField__cなどのオブジェクト名を基準にした項目名が指定されます。このリストにより、項目をソフトフォンダイアルパッドと統合できます。詳細は、Salesforceオンラインヘルプの「CTI 1.0 および 2.0 ソフトフォンについて」を参照してください。この項目は、アプリケーションユーザインターフェースのオブジェクト詳細ページに表示される[検索レイアウト] 関連リストの [ルックアップ電話ダイアログ]に相当します。

オブジェクトの検索の絞り込みに使用できる項目のリスト。各カスタム項目に MyCustomField__c

string[]searchFilterFields

などのオブジェクト名を基準にした項目名が指定されます。この項目は、アプリケーションユーザインターフェースのオブジェクト詳細ページに表示される[検索レイアウト] 関連リストの [検索条件項目]に相当します。

オブジェクトの検索結果に表示される項目のリスト。name項目は必須で、常に最初の列ヘッダーと

string[]searchResultsAdditionalFields

して表示されるため、このリストに含まれません。その他のすべての項目は含まれます。各カスタム項目に MyCustomField__cなどのオブジェクト名を基準にした項目名が指定されます。この項目は、アプリケーションユーザインターフェースのオブジェクト詳細ページに表示される[検索レイアウト] 関連リストの [検索結果]に相当します。

オブジェクトの検索結果で使用できるカスタムボタンのリスト。ボタンに関連付けられたアクショ

string[]searchResultsCustomButtons

ンは、検索結果で返される任意のレコードに適用できます。

205


宣言的なメタデータの定義のサンプルオブジェクトの検索レイアウトの定義のサンプルを以下に示します。

<?xml version="1.0" encoding="UTF-8"?><CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">. . .

<searchLayouts><listViewButtons>New</listViewButtons><listViewButtons>Accept</listViewButtons><listViewButtons>ChangeOwner</listViewButtons><lookupDialogsAdditionalFields>firstQuote__c</lookupDialogsAdditionalFields><lookupDialogsAdditionalFields>finalQuote__c</lookupDialogsAdditionalFields><searchResultsAdditionalFields>CREATEDBY_USER</searchResultsAdditionalFields>

</searchLayouts>. . .</CustomObject>


SharingReasonカスタムオブジェクトに共有が実装された理由を示すために使用されるApexの共有の理由を表します。Apexによる共有管理により、開発者はApex を使用して、プログラムでカスタムオブジェクトを共有できます。Apex による共有管理を使用してカスタムオブジェクトを共有した場合は、「すべてのデータの編集」権限を持つユーザのみが、カスタムオブジェクトのレコードの共有を追加または変更できます。共有アクセス権は、レコード所有者が変わっても維持されます。詳細は、Salesforceオンラインヘルプの「共有設定の概要」を参照してください。SharingReasonを使用して、カスタムオブジェクトの共有の理由定義を作成、更新、または削除できます。Metadataメタデータ型を拡張し、その fullName項目を継承します。

バージョン共有の理由は、API バージョン 14.0 以降で使用できます。

項目

説明データ型項目必須。共有の理由の名前。__c サフィックスが、カスタム共有の理由に追加されます。Metadata から継承されるこの項目は、このメタデータ型のWSDL では定義されません。作成時、更新時、または削除

stringfullName

時に指定する必要があります。コールにおけるこの項目の例を確認するには、「create()」を参照してください。

必須。共有の理由を説明する表示ラベル。最大 40 文字です。stringlabel

206

SharingReasonメタデータ型

宣言的なメタデータの定義のサンプルカスタムオブジェクトの共有の理由の定義を次に示します。


<sharingReasons><fullName>recruiter__c</fullName><label>Recruiter</label>

</sharingReasons>. . .</CustomObject>

SharingRecalculation特定のカスタムオブジェクトの Apex による共有管理を再適用する Apex クラスを表します。詳細は、Salesforceオンラインヘルプの「Apex による共有管理の再適用」を参照してください。

バージョン共有の再適用は、API バージョン 14.0 以降で使用できます。

項目

説明データ型項目必須。カスタムオブジェクトのApex共有を再適用するApexクラス。このクラスは、Database.Batchableインターフェースを実装している必要があります。

stringclassName

宣言的なメタデータの定義のサンプルカスタムオブジェクトでの共有の再適用の定義を次に示します。


<sharingRecalculations><className>RecruiterRecalculation</className>

</sharingRecalculations>. . .</CustomObject>

ValidationRule入力規則を表します。入力規則は、ユーザがレコードに入力したデータが有効で保存可能かどうかを確認するために使用されます。入力規則には、1 つ以上の項目のデータを評価する数式が含まれ、trueまたは falseの値を返します。入力規則には、無効なデータによりルールがtrueの値を返すときに、クライアントアプリケーションがユーザに表示できるエラーメッセージも含まれます。Metadataメタデータ型を拡張し、その fullName項目を継承します。

207

SharingRecalculationメタデータ型

APIバージョン 20.0 の時点で、入力規則には複合項目を設定できません。複合項目の例には、住所、姓名、連動選択リスト、連動ルックアップがあります。

バージョン入力規則は、API バージョン 12.0 以降で使用できます。

項目

説明データ型項目名必須。この入力規則が有効であるか (true)、否か (false)を示します。

booleanactive

入力規則の説明。stringdescription

必須。入力規則数式ページに記載された入力規則数式。Salesforce オンラインヘルプの「入力規則の定義」を参照してください。

stringerrorConditionFormula

アプリケーション内の項目の完全に指定された名前。この項目に値を入力すると、errorMessageの値が指定した項目の

stringerrorDisplayField

横に表示されます。値を指定しない場合、ページ上部にエラーメッセージが表示されます。必須。入力規則が失敗した場合に表示されるメッセージ。メッセージは 255 文字以下にする必要があります。

stringerrorMessage

有効性のために空白と特殊文字がエスケープされた、入力規則の内部名。名前には、英数字、およびアンダースコア (_)

stringfullName

文字のみを使用できます。また、最初は文字とし、最後にアンダースコアを使用したり、連続した 2 つのアンダースコア文字を含めたりすることはできません。この項目はMetadata コンポーネントから継承するため、この項目はこのコンポーネントの WSDL で定義されません。作成時、更新時、または削除時に指定する必要があります。コールにおけるこの項目の例を確認するには、「create()」を参照してください。

宣言的なメタデータの定義のサンプルカスタムオブジェクトの入力規則の XML 定義のサンプルを以下に示します。


<deploymentStatus>Deployed</deploymentStatus><fields>

<fullName>Mommy_Cat__c</fullName><label>Mommy Cat</label><referenceTo>Cat__c</referenceTo><relationshipName>Cats</relationshipName><type>Lookup</type>

</fields><label>Cat</label><nameField>

<label>Cat Name</label>

208

ValidationRuleメタデータ型

<type>Text</type></nameField><pluralLabel>Cats</pluralLabel><sharingModel>ReadWrite</sharingModel><validationRules>

<fullName>CatsRule</fullName><active>true</active><errorConditionFormula>OR(Name = 'Milo',Name =

'Moop')</errorConditionFormula><validationMessage>Name must be that of one of my cats</validationMessage>

</validationRules></CustomObject>

Weblinkカスタムオブジェクトに定義された Web リンクを表します。Metadata メタデータ型を拡張し、その fullName


バージョンWeb リンクは、API バージョン 12.0 以降で使用できます。

項目Web リンクの定義には次の項目が含まれます。

説明データ型項目名必須。Web リンクをオンラインでのみ使用できるか(online)、オフラインでも使用できるか (offline) を示します。

WebLinkAvailability (string型の列挙)

availability

Web リンクの説明。stringdescription

この Web リンクの表示方法を表します。有効な値は次のとおりです。

WebLinkDisplayType (string型の列挙)

displayType

• ハイパーリンクの link。• ボタンの button。• 関連リストに添付されるボタンの massAction。

必須。デフォルトの文字コード設定は Unicode (UTF-8) です。リンクの対象が異なる形式のデータを必要とする場合は、デ

Encoding (string 型の列挙)encodingKey

フォルトの文字コード設定を変更します。この指定は、内容のソースが URL の場合に使用できます。使用できる値は次のとおりです。• UTF-8: UI の「Unicode (UTF-8)」• ISO-8859-1: UI の「米国一般および西ヨーロッパ

(ISO-8859-1, ISO-LATIN-1)」• Shift_JIS: UI の「日本語 (Shift-JIS)」• ISO-2022-JP: UI の「日本語 (JIS)」• EUC-JP: UI の「日本語 (EUC)」

209

Weblinkメタデータ型

説明データ型項目名• ks_c_5601-1987: UI の韓国語 (ks_c_5601–1987)」• Big5: UI の「繁体字中国語 (Big5)」• GB2312: UI の「簡体字中国語 (GB2312)」• BIG5-HKSCS: UI の「繁体字中国語香港(Big5–HKSCS)」• x-SJIS_0213: UI の「日本語 (Shift-JIS_2004)」

有効性のために空白と特殊文字がエスケープされた Web リンクの名前。名前には、英数字、およびアンダースコア (_)

stringfullName

文字のみを使用できます。また、最初は文字とし、最後にアンダースコアを使用したり、連続した 2 つのアンダースコア文字を含めたりすることはできません。この項目はMetadataコンポーネントから継承するため、この項目はこのコンポーネントの WSDL で定義されません。作成時、更新時、または削除時に指定する必要があります。コールにおけるこの項目の例を確認するには、「create()」を参照してください。

openTypeがnewWindowである場合、ウィンドウにブラウザメニューを表示するか (true)、否か (false) を示します。そうでない場合、この項目は指定しないでください。

booleanhasMenubar

openTypeがnewWindowである場合、ウィンドウにスクロールバーを表示するか (true)、否か (false) を示します。そうでない場合、この項目は指定しないでください。

booleanhasScrollbars

openTypeがnewWindowである場合、ウィンドウにブラウザツールバーを表示するか (true)、否か (false) を示します。そうでない場合、この項目は指定しないでください。

booleanhasToolbar

Web リンクによって開かれたウィンドウの高さ (ピクセル単位)。openTypeが newWindowである場合は必須です。そうでない場合は、指定できません。

intheight

openTypeがnewWindowである場合、ウィンドウのサイズを変更できるか (true)、否か (false) を示します。そうでない場合、この項目は指定しないでください。

booleanisResizable

必須。この Web リンクのコンテンツが URL、Sコントロール、JavaScript コードブロック、または Visualforce ページによって指定されているかどうかを表します。有効な値は次のとおりです。

WebLinkType (string型の列挙)

linkType

• url

• sControl

• javascript

• page

• flow — 今後の使用のために予約されています。

Web リンクのマスタラベル。stringmasterLabel

210


説明データ型項目名必須。このボタンがクリックされたときのコンテンツの表示に使用されるウィンドウのスタイルを指定します。有効な値は次のとおりです。

WebLinkWindowType(string 型の列挙)

openType

• newWindow

• sidebar

• noSidebar

• replace

• onClickJavaScript

linkTypeの値が pageである場合、この項目は Visualforceページを表します。そうでない場合、この項目は指定しないでください。

stringpage

openTypeがnewWindowである場合、新規ウィンドウの表示方法を示します。そうでない場合、この項目は指定しないでください。有効な値は次のとおりです。

WebLinkPosition (string 型の列挙)

position

• fullScreen

• none

• topLeft

必須。この下位コンポーネントが保護されるか (true)、否か(false) を示します。保護される下位コンポーネントは、イ

booleanprotected

ンストールする組織で作成されたコンポーネントまたは下位コンポーネントによってリンク設定したり参照したりすることはできません。openTypeがmassActionである場合、このボタンのアクションを実行するために個々の行を選択する必要があるか

booleanrequireRowSelection

(true)、否か (false) を示します。そうでない場合、この項目は指定しないでください。linkTypeの値が sControlである場合、この項目は Sコントロールの名前を表します。そうでない場合、この項目は指定しないでください。

stringscontrol

openTypeがnewWindowである場合、ウィンドウにブラウザのロケーションバーを表示するか否かを示します。そうでない場合、この項目は指定しないでください。

booleanshowsLocation

openTypeがnewWindowである場合、ウィンドウにブラウザのステータスバーを表示するか否かを示します。そうでない場合、この項目は指定しないでください。

booleanshowsStatus

linkTypeがurlである場合、これは URL 値です。linkType

の値が javascriptである場合、これは JavaScript コンテンstringurl

ツです。値がこのいずれでもない場合、この項目は指定しないでください。

211


説明データ型項目名コンテンツは、XML 解析ルールと同じ方法でエスケープする必要があります。

Web リンクによって開かれたウィンドウの幅 (ピクセル単位)。openTypeがnewWindowである場合は必須です。そうでない場合は、指定できません。

intwidth

Java のサンプル次の Java のサンプルは、Web リンクの項目のサンプル値を示します。

public void webLinkSample(String name) throws Exception {WebLink weblink = new WebLink();// name variable represents the full name of the object// on which to create the weblink, for example, customObject__cweblink.setFullName(name + ".googleButton");weblink.setUrl("http://www.google.com");weblink.setAvailability(WebLinkAvailability.online);weblink.setLinkType(WebLinkType.url);weblink.setEncodingKey(Encoding.fromString("UTF-8"));weblink.setOpenType(WebLinkWindowType.newWindow);weblink.setHeight(600);weblink.setWidth(600);weblink.setShowsLocation(false);weblink.setHasScrollbars(true);weblink.setHasToolbar(false);weblink.setHasMenubar(false);weblink.setShowsStatus(false);weblink.setIsResizable(true);weblink.setPosition(WebLinkPosition.none);weblink.setMasterLabel("google");weblink.setDisplayType(WebLinkDisplayType.link);

AsyncResult[] asyncResults = metadataConnection.create(new WebLink[]{weblink});// After the create() call completes, we must poll the results of checkStatus()//

}

宣言的なメタデータの定義のサンプルカスタムオブジェクト内の Web リンクの定義を次に示します。関連するサンプルについては、「HomePageComponent」「宣言的なメタデータの定義のサンプル」および「HomePageLayout」の「宣言的なメタデータの定義のサンプル」を参照してください。


<webLinks><fullName>googleButton</fullName><availability>online</availability><displayType>link</displayType><encodingKey>UTF-8</encodingKey><hasMenubar>false</hasMenubar><hasScrollbars>true</hasScrollbars><hasToolbar>false</hasToolbar><height>600</height><isResizable>true</isResizable>

212


<linkType>url</linkType><masterLabel>google</masterLabel><openType>newWindow</openType><position>none</position><protected>false</protected><showsLocation>false</showsLocation><showsStatus>false</showsStatus><url>http://www.google.com</url><width>600</width>

</webLinks>....</CustomObject>

関連リンクHomePageComponentHomePageLayoutCustomPageWebLink

メタデータのデータ型これらのデータ型は、『SOAP API 開発者ガイド』で説明されているデータ型を拡張します。

項目に含まれる内容オブジェクトデータ型カスタム項目を表します。カスタムオブ

ジェクトカスタム項目

CustomField

参照関係の削除オプションを表す文字列。有効な値は、次のとおりです。カスタム項目DeleteConstraint

• SetNull

• Restrict

• Cascade

カスタムオブジェクトまたはカスタム項目のリリース状況を表す文字列。有効な値は、次のとおりです。

カスタムオブジェクトカスタム項目

DeploymentStatus

• InDevelopment

• Deployed

カスタム項目の型を示します。有効な値は、次のとおりです。カスタム項目FieldType

• AutoNumber

• Lookup

• MasterDetail

• Checkbox

• Currency

• Date

• DateTime

• Email

• EncryptedText

• Number1

213

メタデータのデータ型メタデータ型


項目に含まれる内容オブジェクトデータ型• Percent

• Phone

• Picklist

• MultiselectPicklist

• Summary

• Text

• TextArea

• LongTextArea

• Summary

• Url

• Hierarchy

• File

• CustomDataType

• Html

• Geolocation

1Numberカスタム項目は内部的には double 型の項目として表されます。Number

項目のスケールを 0 に設定すると int と同様に動作する double を使用できます。名詞の性別を示します。これは、語の性別に基づいて、異なる処理が必要となる言語に使用されます。有効な値は、次のとおりです。

カスタムオブジェクト

Gender

• Masculine

• Feminine

• Neuter

• Euter (スウェーデン語)

• Common (オランダ語)

選択リストから選択できる表示ラベルおよび値のセットである選択リストを表す。

カスタム項目Picklist (連動選択リストを含む)

カスタムオブジェクトの共有モデルを表します。オブジェクトに応じて、有効な値は次のようになります。

カスタムオブジェクト

SharingModel

• Private

• Read

• ReadWrite

• ReadWriteTransfer

• FullAccess

• ControlledByParent

たとえば、ユーザオブジェクトは、値 Privateおよび Readをサポートします。取引先責任者、商談、およびカスタムオブジェクトは、値 Private、Read、および ReadWriteをサポートします。

214

メタデータのデータ型メタデータ型

項目に含まれる内容オブジェクトデータ型名詞が母音、子音、または特殊文字で開始されているかを示します。これは、語の最初の文字に基づいて、異なる処理が必要となる言語に使用されます。有効な値は、次のとおりです。

カスタムオブジェクトカスタム項目

StartsWith

• Consonant

• Vowel

• Special (z または s と子音で始まる名詞に対して)

空白の処理方法を示します。有効な値は、次のとおりです。カスタム項目TreatBlanksAs

• BlankAsBlank

• BlankAsZero

CustomObjectTranslationこのメタデータ型を使用して、カスタムオブジェクトをさまざまな言語に翻訳できます。Metadataメタデータ型を拡張し、その fullName項目を継承します。コンポーネントの表示ラベルを翻訳する機能は、トランスレーションワークベンチの一部です。詳細は、Salesforceオンラインヘルプの「トランスレーションワークベンチの設定」を参照してください。

宣言的なメタデータファイルのサフィックスおよびディレクトリの場所翻訳は、customObjectName__c-lang.objectTranslationという形式のファイルに保存されます。customObjectName__cは、カスタムオブジェクト名で、langは翻訳言語です。ドイツ語の翻訳のサンプルファイル名は、myCustomObject__c-de.objectTranslationです。カスタムオブジェクトの翻訳は、対応するパッケージディレクトリの objectTranslationsフォルダに保存されます。

バージョンCustomObjectTranslation コンポーネントは、API バージョン 14.0 以降で使用できます。

項目

説明データ型項目冠詞、複数形、所有格、大文字/小文字に関するカスタムオブジェクトのさまざまな組み合わせ。

ObjectNameCaseValue[]caseValues

カスタムオブジェクトに関連付けられたカスタム項目の翻訳のリスト。

CustomFieldTranslation[]fields

customObjectName-langという形式のカスタムオブジェクトの名前と翻訳言語。customObjectNameはカスタムオブジェクト名で、langは翻訳言語です。Metadata から継承されるこの項目は、このメタデータ型の WSDL では定義されません。作成時、更新

stringfullName

時、または削除時に指定する必要があります。コー

215

CustomObjectTranslationメタデータ型

説明データ型項目ルにおけるこの項目の例を確認するには、「create()」を参照してください。


Gendergender

ページレイアウトの翻訳のリスト。LayoutTranslation[]layouts

名前項目の表示ラベル。最大 765 文字です。stringnameFieldLabel

カスタムオブジェクトに関連付けられたルックアップ検索条件のエラーメッセージの翻訳のリスト。この項目は API バージョン 30.0 で削除されました。それより前のバージョンでのみ使用できます。ルッ

NamedFilterTranslation[]namedFilters

クアップ検索条件に関連付けられた翻訳メタデータは、CustomFieldTranslation サブタイプのlookupFilter項目によって表されるようになりました。

アクションの翻訳のリスト。QuickActionTranslation[]quickActions

レコードタイプの翻訳のリスト。RecordTypeTranslation[]recordTypes

共有の理由の翻訳のリスト。SharingReasonTranslation[]sharingReasons

名詞が母音、子音、または特殊文字で開始されているかを示します。これは、語の最初の文字に基づいて、異なる処理が必要となる言語に使用されます。


入力規則の翻訳のリスト。ValidationRuleTranslation[]validationRules

Web リンクの翻訳のリスト。WebLinkTranslation[]webLinks

ワークフロー ToDo の翻訳のリスト。WorkflowTaskTranslation[]workflowTasks

CustomFieldTranslation

CustomFieldTranslation には、カスタム項目の翻訳の詳細が含まれます。詳細は、「CustomField」を参照してください。

メモ: すべての言語で、CustomFieldTranslation の項目に使用可能なすべての値がサポートされているわけではありません。言語固有のサポートされる値については、「CustomObjectTranslation の言語サポート — 完全サポート対象言語」および「CustomObjectTranslation の言語サポート — エンドユーザ言語」の付録を参照してください。

説明データ型項目冠詞、複数形、所有格、大文字/小文字に関するカスタムオブジェクトのさまざまな組み合わせ。API バージョン 29.0 以降で利用できます。

ObjectNameCaseValue[]caseValues

カスタム項目の説明の翻訳。stringdescription

216


説明データ型項目名詞の性別を示します。これは、語の性別に基づいて、異なる処理が必要となる言語に使用されます。API バージョン 29.0 以降で利用できます。

Gendergender

この項目の項目レベルのヘルプでフロート表示テキストとして表示されるテキストの翻訳。

stringhelp

表示ラベルの翻訳。最大 765 文字です。stringlabel

ルックアップ検索条件に関連付けられた翻訳メタデータを表します。この項目は API バージョン 30.0 以降で使用できます。

LookupFilterTranslationlookupFilter

必須。MyField__cなどの、カスタムオブジェクトに関連する項目の名前。

stringname

選択リスト値の翻訳のリスト。「PicklistValue」を参照してください。

PicklistValueTranslation[]picklistValues

参照関係の表示ラベルの翻訳。参照関係により、項目を別の項目に関連付けることができます。リレー

stringrelationshipLabel

ション項目により、ユーザは他の項目によって定義された値のリストからオプションを選択できます。最大 765 文字です。名詞が母音、子音、または特殊文字で開始されているかを示します。これは、語の最初の文字に基づい


て、異なる処理が必要となる言語に使用されます。API バージョン 29.0 以降で利用できます。

LayoutTranslation

LayoutTranslation には、ページレイアウトの翻訳の詳細が含まれます。詳細は、「項目」を参照してください。

説明データ型項目必須。レイアウト名。stringlayout

stringlayoutType

レイアウトセクションの翻訳の配列。LayoutSectionTranslation[]sections

LayoutSectionTranslation

LayoutSectionTranslation には、ページレイアウトセクションの翻訳の詳細が含まれます。詳細は、「LayoutSection」を参照してください。

説明データ型項目必須。表示ラベルの翻訳。最大 765 文字です。stringlabel

必須。セクション名。stringsection

217


LookupFilterTranslation

LookupFilterTranslation は、カスタムオブジェクトに関連付けられたルックアップ検索条件のエラーメッセージの翻訳を表示します。NamedFilterTranslation にこれが置き換わります。LookupFilterTranslation は、API バージョン 30.0 以降で使用できます。

説明データ型項目ルックアップ検索条件が失敗した場合に表示されるエラーメッセージ。

stringerrorMessage

ページに表示される情報メッセージ。ある項目がルックアップ検索条件で除外されている理由など、ユー

stringinformationalMessage

ザにとってわかりにくい内容を説明するために使用します。

NamedFilterTranslation

NamedFilterTranslation は API バージョン 30.0 で削除されました。それより前の API バージョンでのみ使用できます。NamedFilterTranslation は、カスタムオブジェクトに関連付けられるルックアップ検索条件エラーメッセージの翻訳のリストを示します。詳細は、「NamedFilter」を参照してください。

説明データ型項目ルックアップ検索条件が失敗した場合に表示されるエラーメッセージ。

stringerrorMessage

ページに表示される情報メッセージ。ある項目がルックアップ検索条件で除外されている理由など、ユー

stringinformationalMessage

ザにとってわかりにくい内容を説明するために使用します。必須。ルックアップ検索条件の名前。ユーザインターフェースでこの項目を作成する場合、名前は自動的

stringname

に割り当てられます。メタデータ API を使用してこの項目を作成する場合、name項目を含める必要があります。

ObjectNameCaseValue

ObjectNameCaseValue は、さまざまな文法的なコンテキストで使用できるように、カスタムオブジェクト名の複数の格と定義をサポートします。

メモ: すべての言語で、ObjectNameCaseValue の項目に使用可能なすべての値がサポートされているわけではありません。言語固有のサポートされる値については、「CustomObjectTranslation の言語サポート— 完全サポート対象言語」および「CustomObjectTranslation の言語サポート — エンドユーザ言語」の付録を参照してください。

説明データ型項目英語には、定冠詞 (the) と不定冠詞 (a、an) の 2 種類の冠詞があります。これらの冠詞の使用は、主に、

Article (string 型の列挙)article

218


説明データ型項目グループの任意のメンバーを参照しているか、グループの特定のメンバーを参照しているかによって異なります。有効な値は、次のとおりです。• Definite

• Indefinite

• None

カスタムオブジェクト名の格。有効な値は、次のとおりです。

CaseType (string 型の列挙)caseType

• Ablative

• Accusative

• Adessive

• Allative

• Causalfinal

• Dative

• Delative

• Distributive

• Elative

• Essive

• Essiveformal

• Genitive

• Illative

• Inessive

• Instrumental

• Lative

• Locative

• Nominative

• Objective

• Partitive

• Prepositional

• Subjective

• Sublative

• Superessive

• Termanative

• Translative

• Vocative

value項目が複数であるか (true)、単数であるか(false) を示します。

booleanplural

言語の所有格は、所有の関係を示すために使用される文法上の格です。有効な値は、次のとおりです。

Possessive (string 型の列挙)possessive

• First

• None

• Second

必須。この文法的なコンテキストでの値または表示ラベル。

stringvalue

219


PicklistValueTranslation

PicklistValueTranslation には、選択リスト値の翻訳の詳細が含まれます。詳細は、「Picklist (連動選択リストを含む)」を参照してください。

説明データ型項目必須。アプリケーションの設定ページに定義された選択リスト値は、マスタラベルになります。マスタ

stringmasterLabel

ラベルは、翻訳された表示ラベルが使用できないすべての場所に表示されます。必須。値の翻訳。stringtranslation

QuickActionTranslation

QuickActionTranslation には、ユーザインターフェースのアクションの表示ラベルの詳細が含まれています。詳細は、「QuickAction」を参照してください。


必須。クイックアクション名。stringname

RecordTypeTranslation

RecordTypeTranslation には、レコードタイプ名の翻訳の詳細が含まれます。詳細は、「RecordType」を参照してください。


必須。レコードタイプ名。stringname

SharingReasonTranslation

SharingReasonTranslation には、共有の理由の翻訳の詳細が含まれます。詳細は、「SharingReason」を参照してください。

説明データ型項目必須。共有の理由の翻訳。stringlabel

必須。共有の理由名。stringname

ValidationRuleTranslation

ValidationRuleTranslation には、入力規則の翻訳の詳細が含まれます。詳細は、「ValidationRule」を参照してください。

説明データ型項目必須。入力規則の失敗に関連付けられたエラーメッセージの翻訳。

stringerrorMessage

220


説明データ型項目必須。入力規則名。stringname

WebLinkTranslation

WebLinkTranslation には、Web リンクの翻訳の詳細が含まれます。詳細は、「Weblink」を参照してください。

説明データ型項目必須。Web リンク表示ラベルの翻訳。最大 765 文字です。

stringlabel

必須。Web リンク名。stringname

WorkflowTaskTranslation

WorkflowTaskTranslation には、ワークフロー ToDo の翻訳の詳細が含まれます。詳細は、「Workflow」を参照してください。

説明データ型項目ワークフロー ToDo の説明の翻訳。stringdescription

必須。ワークフロー ToDo 名。stringname

ワークフロー ToDo の件名の翻訳。stringsubject

宣言的なメタデータの定義のサンプル次のサンプルはドイツ語の Description__c オブジェクトに関する CustomObjectTranslation の XML 定義であり、1 つのカスタム項目 Summary__c が含まれています。この定義を含むファイルの名前と場所は、objectTranslations/Description__c-de.objectTranslationとなります。

<?xml version="1.0" encoding="UTF-8"?><CustomObjectTranslation xmlns="http://soap.sforce.com/2006/04/metadata">

<caseValues><caseType>Nominative</caseType><plural>false</plural><value>Beschreibung</value>

</caseValues><caseValues>

<caseType>Nominative</caseType><plural>true</plural><value>Beschreibungen</value>


<caseType>Accusative</caseType><plural>false</plural><value>Beschreibung</value>


<caseType>Accusative</caseType><plural>true</plural><value>Beschreibungen</value>


<caseType>Genitive</caseType><plural>false</plural><value>Beschreibung</value>

221



<caseType>Genitive</caseType><plural>true</plural><value>Beschreibungen</value>


<caseType>Dative</caseType><plural>false</plural><value>Beschreibung</value>


<caseType>Dative</caseType><plural>true</plural><value>Beschreibungen</value>

</caseValues><fields>

<label>Zusammenfassung</label><name>Summary__c</name>

</fields><gender>Feminine</gender><nameFieldLabel>Beschreibungen</nameFieldLabel>

</CustomObjectTranslation>

次のサンプルは取引先オブジェクトに関する CustomObjectTranslation の XML 定義であり、取引先名をドイツ語のクライアント名 (Kunde) に変更するものです。取引先オブジェクトには 1 つの標準項目 account_number と、1つのカスタム項目 Account_Code__c があります。この定義を含むファイルの名前と場所は、objectTranslations/Account-de.objectTranslationとなります。

<?xml version="1.0" encoding="UTF-8"?><CustomObjectTranslation xmlns="http://soap.sforce.com/2006/04/metadata">

<caseValues><caseType>Nominative</caseType><plural>false</plural><value>Kunde</value>


<caseType>Nominative</caseType><plural>true</plural><value>Kunden</value>


<caseType>Accusative</caseType><plural>false</plural><value>Kunden</value>


<caseType>Accusative</caseType><plural>true</plural><value>Kunden</value>


<caseType>Genitive</caseType><plural>false</plural><value>Kunden</value>


<caseType>Genitive</caseType><plural>true</plural><value>Kunden</value>


<caseType>Dative</caseType><plural>false</plural><value>Kunden</value>

</caseValues>

222


<caseValues><caseType>Dative</caseType><plural>true</plural><value>Kunden</value>

</caseValues><fields>

<caseValues><caseType>Nominative</caseType><plural>false</plural><value>Kundennummer</value>


<caseType>Nominative</caseType><plural>true</plural><value>Kundennummern</value>

</caseValues><gender>Feminine</gender><name>account_number</name>

</fields><fields>

<label>Kunden-Code</label><name>Account_Code__c</name>

</fields><gender>Masculine</gender>

</CustomObjectTranslation>

関連リンクCustomObjectTranslations

CustomPageWebLinkホームページコンポーネントに定義された Web リンクを表します。Metadata メタデータ型を拡張し、そのfullName項目を継承します。その他のすべての Web リンクは、CustomObjectにWeblinkとして保存されます。

宣言的なメタデータファイルのサフィックスおよびディレクトリの場所1 つの Web リンクの定義あたり 1 つのファイルがあり、対応するパッケージディレクトリの weblinksフォルダに保存されます。ファイルのサフィックスは、.weblinkです。

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

項目CustomPageWebLink の定義には、次の項目があります。

説明データ型項目名必須。Web リンクをオンラインでのみ使用できるか(online)、オフラインでも使用できるか (offline) を示します。

WebLinkAvailability (string型の列挙)

availability

Web リンクの説明。stringdescription

223

CustomPageWebLinkメタデータ型

説明データ型項目名この Web リンクの表示方法を表します。有効な値は次のとおりです。

WebLinkDisplayType (string型の列挙)

displayType

• ハイパーリンクの link。• ボタンの button。• 関連リストに添付されるボタンの massAction。

必須。デフォルトの文字コード設定は Unicode (UTF-8) です。リンクの対象が異なる形式のデータを必要とする場合は、デ


フォルトの文字コード設定を変更します。この指定は、内容のソースが URL の場合に使用できます。使用できる値は次のとおりです。• UTF-8: UI の「Unicode (UTF-8)」• ISO-8859-1: UI の「米国一般および西ヨーロッパ

(ISO-8859-1, ISO-LATIN-1)」• Shift_JIS: UI の「日本語 (Shift-JIS)」• ISO-2022-JP: UI の「日本語 (JIS)」• EUC-JP: UI の「日本語 (EUC)」• ks_c_5601-1987: UI の韓国語 (ks_c_5601–1987)」• Big5: UI の「繁体字中国語 (Big5)」• GB2312: UI の「簡体字中国語 (GB2312)」• BIG5-HKSCS: UI の「繁体字中国語香港(Big5–HKSCS)」• x-SJIS_0213: UI の「日本語 (Shift-JIS_2004)」


stringfullName

す。一意であること、最初は文字であること、空白は使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。openTypeがnewWindowである場合、ウィンドウにブラウザメニューを表示するか (true)、否か (false) を示します。そうでない場合、この項目は指定しないでください。

booleanhasMenubar

openTypeがnewWindowである場合、ウィンドウにスクロールバーを表示するか (true)、否か (false) を示します。そうでない場合、この項目は指定しないでください。

booleanhasScrollbars

openTypeがnewWindowである場合、ウィンドウにブラウザツールバーを表示するか (true)、否か (false) を示します。そうでない場合、この項目は指定しないでください。

booleanhasToolbar

Web リンクによって開かれたウィンドウの高さ (ピクセル単位)。openTypeが newWindowである場合は必須です。そうでない場合は、指定できません。

intheight

224


説明データ型項目名openTypeがnewWindowである場合、ウィンドウのサイズを変更できるか (true)、否か (false) を示します。そうでない場合、この項目は指定しないでください。

booleanisResizable

必須。この Web リンクのコンテンツが URL、Sコントロール、JavaScript コードブロック、または Visualforce ページによって指定されているかどうかを表します。有効な値は次のとおりです。

WebLinkType (string型の列挙)

linkType

• url

• sControl

• javascript

• page

• flow — 今後の使用のために予約されています。

Web リンクのマスタラベル。stringmasterLabel

必須。このボタンがクリックされたときのコンテンツの表示に使用されるウィンドウのスタイルを指定します。有効な値は次のとおりです。

WebLinkWindowType(string 型の列挙)

openType

• newWindow

• sidebar

• noSidebar

• replace

• onClickJavaScript

linkTypeの値が pageである場合、この項目は Visualforceページを表します。そうでない場合、この項目は指定しないでください。

stringpage

openTypeがnewWindowである場合、新規ウィンドウの表示方法を示します。そうでない場合、この項目は指定しないでください。有効な値は次のとおりです。

WebLinkPosition (string 型の列挙)

position

• fullScreen

• none

• topLeft

必須。このコンポーネントが保護されるか (true)、否か(false) を示します。保護コンポーネントは、インストール

booleanprotected

する組織で作成されたコンポーネントによってリンク設定したり参照したりすることはできません。openTypeがmassActionである場合、このボタンのアクションを実行するために個々の行を選択する必要があるか

booleanrequireRowSelection

(true)、否か (false) を示します。そうでない場合、この項目は指定しないでください。

225


説明データ型項目名linkTypeの値が sControlである場合、この項目は Sコントロールの名前を表します。そうでない場合、この項目は指定しないでください。

stringscontrol

openTypeがnewWindowである場合、ウィンドウにブラウザのロケーションバーを表示するか否かを示します。そうでない場合、この項目は指定しないでください。

booleanshowsLocation

openTypeがnewWindowである場合、ウィンドウにブラウザのステータスバーを表示するか否かを示します。そうでない場合、この項目は指定しないでください。

booleanshowsStatus

linkTypeがurlである場合、これは URL 値です。linkType

の値が javascriptである場合、これは JavaScript コンテンstringurl

ツです。値がこのいずれでもない場合、この項目は指定しないでください。コンテンツは、XML 解析ルールと同じ方法でエスケープする必要があります。

Web リンクによって開かれたウィンドウの幅 (ピクセル単位)。openTypeがnewWindowである場合は必須です。そうでない場合は、指定できません。

intwidth

宣言的なメタデータの定義のサンプルWeb リンクの定義を次に示します。関連するサンプルについては、「HomePageComponent」の「宣言的なメタデータの定義のサンプル」および「HomePageLayout」の「宣言的なメタデータの定義のサンプル」を参照してください。

<?xml version="1.0" encoding="UTF-8"?><CustomPageWebLink xmlns="http://soap.sforce.com/2006/04/metadata">

<availability>online</availability><displayType>button</displayType><encodingKey>UTF-8</encodingKey<hasMenubar>false</hasMenubar><hasScrollbars>true</hasScrollbars><hasToolbar>false</hasToolbar><height>600</height><isResizable>true</isResizable><linkType>url</linkType><masterLabel>detailPageButon</masterLabel><openType>newWindow</openType><position>none</position><protected>false</protected><showsLocation>false</showsLocation><showsStatus>false</showsStatus>

226


<url>http://google.com</url></CustomPageWebLink>

関連リンクHomePageComponentHomePageLayoutWeblink

CustomPermissionカスタム機能へのアクセス権限を付与する権限を表します。Metadataメタデータ型を拡張し、その fullName項目を継承します。

メモ: カスタム権限は、現在、開発者プレビューとして利用できます。

ファイルのサフィックスおよびディレクトリの場所CustomPermission コンポーネントのサフィックスは .customPermissionであり、customPermissionsフォルダに保存されます。

バージョンCustomPermission コンポーネントは、API バージョン 31.0 以降で使用できます。

項目

説明データ型項目名この権限に関連付けられた接続アプリケーションの名前。最大 80 文字です。

stringconnectedApp

カスタム権限の説明。最大 255 文字です。stringdescription

必須。カスタム権限の表示ラベル。最大 80 文字です。stringlabel

宣言的なメタデータの定義のサンプルCustomPermission コンポーネントの例を次に示します。

<?xml version="1.0" encoding="UTF-8"?><CustomPermission xmlns="http://soap.sforce.com/2006/04/metadata">

<connectedApp>Acme</connectedApp><description>Read and edit access for the email field.</description><label>Acme_Account_Email_Fls</label>

</CustomPermission>

227

CustomPermissionメタデータ型

次の package.xmlの例では、以前の定義と、接続アプリケーションに関連付けられている他のカスタム権限を参照します。


<types><members>Acme</members><name>ConnectedApp</name>

</types><types>

<members>Acme_Account_Email_Fls</members><members>Acme_Account_Phone_Fls</members><members>Acme_Account_Read</members><name>CustomPermission</name>

</types><types>

<members>Acme_Account_Email_Fls</members><members>Acme_Account_Full_Access</members><members>Acme_Account_Phone_Fls</members><members>Acme_Account_Read</members><name>PermissionSet</name>


</Package>

CustomSiteForce.com サイトを表します。Force.com サイトでは、公開 Web サイトとアプリケーションを作成できます。それらは Salesforce 組織と直接統合されるため、ユーザがログインする場合にユーザ名やパスワードは必要ありません。詳細は、Salesforce オンラインヘルプの「Force.com サイトの概要」を参照してください。

メモ: CustomSite は、現在、シンジケーションフィードをサポートしていません。

Metadata メタデータ型を拡張し、その fullName項目を継承します。

宣言的なメタデータファイルのサフィックスおよびディレクトリの場所Force.com CustomSite コンポーネントは、対応するパッケージディレクトリの sitesディレクトリに保存されます。ファイル名はサイト名に一致し、拡張子は .siteです。

バージョンForce.com CustomSite コンポーネントは、API バージョン 14.0 以降で使用できます。

項目

説明データ型項目必須。サイトが有効かどうかを決定します。booleanactive

標準ホームページが一般ユーザに表示されるかどうかを決定します。これは、API バージョン 15.0 の新項目です。

booleanallowHomePage

228

CustomSiteメタデータ型

説明データ型項目標準のアイデアページが一般ユーザに表示されるかどうかを決定します。これは、APIバージョン 15.0 の新項目です。

booleanallowStandardIdeasPages

標準ルックアップページが一般ユーザに表示されるかどうかを決定します。これは、APIバージョン 15.0 の新項目です。

booleanallowStandardLookups

標準検索ページが一般ユーザに表示されるかどうかを決定します。これは、APIバージョン 15.0 の新項目です。

booleanallowStandardSearch

サイトに関連付けられている追跡コード。このコードは、サイトに対するページリクエス

stringanalyticsTrackingCode

トデータを追跡するために、Google Analyticsなどのサービスで使用されます。この項目はAPI バージョン 17.0 以降で使用できます。ゲストユーザが許可されていないページにアクセスしようとすると表示されるVisualforceページの名前。

stringauthorizationRequiredPage

サイトがその割り当て帯域幅を超えると表示される Visualforce ページの名前。

stringbandwidthExceededPage

ポータルまたは Chatter アンサーのいずれかのパスワードをポータルユーザが変更しよう

stringchangePasswordPage

とすると表示されるVisualforceページの名前(有効になっている場合)。仮パスワードを記載したメールが送信されたことをユーザに知らせるために表示される

stringchatterAnswersForgotPasswordConfirmPage

Visualforceページの名前。この項目は、組織で Chatter アンサーが有効になっている場合に使用できます。この項目は API バージョン 27.0 以降で使用できます。ユーザがリンクをクリックして忘れたパスワードを取得する場合に表示される

stringchatterAnswersForgotPasswordPage

Visualforceページの名前。この項目は、組織で Chatter アンサーが有効になっている場合に使用できます。この項目は API バージョン 27.0 以降で使用できます。ユーザがヘルプリンクをクリックすると表示される Visualforce ページの名前。この項目

stringchatterAnswersHelpPage

は、組織で Chatter アンサーが有効になっている場合に使用できます。この項目は APIバージョン 27.0 以降で使用できます。ユーザがポータルにログインできるようにするために表示される Visualforce ページの名

stringchatterAnswersLoginPage

前。この項目は、組織で Chatter アンサーが

229


説明データ型項目有効になっている場合に使用できます。この項目は API バージョン 27.0 以降で使用できます。ユーザを登録してポータルにアクセスできるようにするために表示されるVisualforceペー

stringchatterAnswersRegistrationPage

ジの名前。この項目は API バージョン 27.0以降で使用できます。必須。クリックジャック保護レベルを設定します。選択肢は次のとおりです。

SiteClickjackProtectionLevel(string 型の列挙)

clickjackProtectionLevel

• AllowAllFraming — すべてのページでフレーム化を許可 (保護なし)

• SameOriginOnly — 公開元が同じページのみでフレーム化を許可 (推奨)

• NoFraming — すべてのページでフレーム化を許可しない (最大保護)

この項目は API バージョン 30.0 以降で使用できます。サイトに関連付けられたルートカスタムURL。CustomSite を保存またはリリースす

SiteWebAddress[]customWebAddresses

ると、サイト内のすべてのルートカスタムURL がこのリストのルートカスタム URL に置き換えられます。ルート以外のパスプレフィックスを使用するカスタム URL はこのリストには含まれず、CustomSite を保存またはリリースしても影響を受けません。この項目は API バージョン 21.0 以降で使用できます。サイトの説明。stringdescription

サイトにアクセスしているときに、ブラウザのアドレス項目に表示されるアイコンに使用

stringfavoriteIcon

されるファイルの名前。サイト全体のお気に入りアイコンを設定します。ゲストユーザが存在しないページにアクセスしようとすると表示されるVisualforceページの名前。

stringfileNotFoundPage

エラー時に、他に指定されていない場合に表示される Visualforce ページの名前。

stringgenericErrorPage

参照のみ。ゲストユーザに関連付けられたプロファイルの名前。

stringguestProfile

サイトがメンテナンスのためにダウンしている場合に表示される Visualforce ページの名前。

stringinMaintenancePage

230


説明データ型項目無効なサイトのホームページとして設定されている Visualforce ページの名前。

stringinactiveIndexPage

必須。有効なサイトのホームページとして設定されている Visualforce ページの名前。

stringindexPage

Salesforce ユーザインターフェースでのサイトの表示ラベル名。

stringmasterLabel

ログインアクセス用にこのサイトに関連付けられたポータルの名前。

stringportal

必須。組織のセキュリティ設定を上書きし、サイトから関連付けられたポータルにログイ

stringrequireInsecurePortalAccess

ンする場合に HTTP を排他的に使用するかどうかを決定します。Web クローラで使用されるrobots.txtファイルに表示されるVisualforceページの名前。

stringrobotsTxtPage

Salesforceサーバのダウン時にキャッシュサーバから表示される静的リソースの名前。静的

stringserverIsDown

リソースは、1 MB 以下の公開 zip ファイルで、zip ファイルのルートレベルにmaintenance.htmlという名前のページが含まれている必要があります。画像や CSSファイルなどの、zip ファイル内のその他のリソースは、ディレクトリ構造上の制限はありません。この項目は API バージョン 17.0以降で使用できます。サイトに設定されているすべての URL リダイレクトルールの配列。この項目はAPIバージョン 20.0 以降で使用できます。

SiteRedirectMapping[]siteRedirectMapping

サイト管理者のユーザ名。stringsiteAdmin

サイトテンプレートとして使用されるVisualforce ページの名前。

stringsiteTemplate

サイトがVisualforceであるか (Force.comサイト)、Site.comサイトであるかを特定します。組織で Salesforce Communities が有効になっている場合は、ChatterNetwork (Force.comサ

siteTypesiteType

イト) または ChatterNetworkPicasso (Site.com)サイトとなる場合もあります。これは、APIバージョン 27.0 の新項目です。必須。参照のみ。サイトのカスタムサブドメインプレフィックス。たとえば、サイト URL

stringsubdomain

がmycompany.force.com/partnersである

231


説明データ型項目場合、mycompany.force.comがサブドメインです。サイトを他のサイトと区別する、サイトのURL 上のパスの最初の部分。たとえば、サ

stringurlPathPrefix

イト URL がmycompany.force.com/partnersである場合、partnersが urlPathPrefix です。

SiteRedirectMapping

SiteRedirectMapping は、Force.com サイトの URL リダイレクトルールを表します。詳細は、Salesforce オンラインヘルプの「Force.com サイトの URL リダイレクト」を参照してください。

説明データ型項目リダイレクトの種別。使用可能なstring 値は次のとおりです。

SiteRedirect (string 型の列挙)action

• Permanent• Temporary

リダイレクトの状況 (有効または無効)。

booleanisActive

リダイレクトする URL。相対 URLである必要がありますが、.htmlや

stringsource

.phpなど、任意の有効な種類の拡張子にできます。ユーザのアクセス先とする新しいURL。相対 URL または http://や

stringtarget

https://プレフィックスを含む完全修飾 URL にすることができます。

SiteWebAddress

Force.com サイトの Web アドレスを表します。

説明データ型項目この項目はメタデータ APIバージョン31.0では表示されますが、機能し

stringcertificate

ないため、空白のままにする必要があります。Web サイトのドメイン。www.acme.com 形式で指定します。

stringdomainName

これはプライマリドメインであるか(true)、否かを示します。falseの

booleanprimary

場合は、プライマリドメインではありません。

232


宣言的なメタデータの定義のサンプルサイトの XML 定義のサンプルを以下に示します。

<?xml version="1.0" encoding="UTF-8"?><CustomSite xmlns="http://soap.sforce.com/2006/04/metadata">

<active>true</active><allowHomePage>true</allowHomePage><allowStandardIdeasPages>true</allowStandardIdeasPages><allowStandardLookups>true</allowStandardLookups><allowStandardSearch>true</allowStandardSearch><authorizationRequiredPage>Unauthorized</authorizationRequiredPage><bandwidthExceededPage>BandwidthExceeded</bandwidthExceededPage><changePasswordPage>ChangePassword</changePasswordPage>

<chatterAnswersForgotPasswordConfirmPage>ChatterAnswersForgotPasswordConfirm</chatterAnswersForgotPasswordConfirmPage>

<chatterAnswersForgotPasswordPage>ChatterAnswersForgotPassword</chatterAnswersForgotPasswordPage>

<chatterAnswersHelpPage>ChatterAnswersHelp</chatterAnswersHelpPage><chatterAnswersLoginPage>ChatterAnswersLogin</chatterAnswersLoginPage>

<chatterAnswersRegistrationPage>ChatterAnswersRegistration</chatterAnswersRegistrationPage>

<clickjackProtectionLevel>SameOriginOnly</clickjackProtectionLevel><customWebAddresses><domainName>www.testing123.com</domainName><primary>true</primary>

</customWebAddress><favoriteIcon>myFavIcon</favoriteIcon><fileNotFoundPage>FileNotFound</fileNotFoundPage><genericErrorPage>Exception</genericErrorPage><inMaintenancePage>InMaintenance</inMaintenancePage><serverIsDown>MyServerDownResource</serverIsDown><indexPage>UnderConstruction</indexPage><masterLabel>customSite</masterLabel><portal>Customer Portal</portal><requireInsecurePortalAccess>false</requireInsecurePortalAccess><siteAdmin>[email protected]</siteAdmin><siteTemplate>SiteTemplate</siteTemplate><subdomain>myco</subdomain>

</CustomSite>

関連リンクPortal

CustomTabカスタムタブを表します。カスタムタブとは、カスタムオブジェクトのデータや、アプリケーションに埋め込まれている他の Web コンテンツを表示するために作成するユーザインターフェースコンポーネントのことです。タブにカスタムオブジェクトが表示されているとき、タブ名はカスタムオブジェクト名と同じになります。ページ、Sコントロール、または URL タブの場合は任意の名前です。詳細は、Salesforce オンラインヘルプの「カスタムタブとは?」を参照してください。Metadata メタデータ型を拡張し、その fullName項目を継承します。

ファイルのサフィックスおよびディレクトリの場所ファイルのサフィックスは、.tabです。タブごとに 1 つのファイルがあり、対応するパッケージディレクトリの tabsフォルダに保存されます。

233

CustomTabメタデータ型


バージョンタブは、API バージョン 10.0 以降で使用できます。


説明データ型項目名このタブがカスタムオブジェクトを表示するか (true)、否か (false) を示します。trueに設定されている場合、タブの名前はカスタムオブジェクトの名前と一致します。次の項目のいずれか 1 つのみに値が設定されている必要があります。

booleancustomObject

• customObject

• flexiPage

• page

• scontrol

• url

タブの説明テキスト (省略可能)。stringdescription

このタブに表示するフレキシブルページの名前。次の項目のいずれか 1 つのみに値が設定されている必要があります。

stringflexiPage

• customObject

• flexiPage

• page

• scontrol

• url

タブフレームの高さ (ピクセル単位)。Sコントロールおよびページタブでは必須です。

intframeHeight

タブの名前。この項目の値は、タブの種類と API バージョンに応じて異なります。

stringfullName

• カスタムオブジェクトタブの場合、fullNameは開発者が割り当てたカスタムオブジェクトの名前です (たとえば、MyCustomObject__c など)。カスタムオブジェクトタブの場合、この名前はカスタムオブジェクト名と同じである必要があり、customObjectは trueに設定されている必要があります。

• Web タブの場合、fullNameは開発者が割り当てたタブの名前です (たとえば、MyWebTab など)。

234


説明データ型項目名fullNameには、アンダースコアと英数字のみを使用できます。一意であること、最初は文字であること、空白は使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。この項目は、Metadata コンポーネントから継承されています。

タブにサイドバーパネルが表示されるかを示します。booleanhasSidebar

タブがどの標準タブスタイルも使用していない場合における、タブの画像ドキュメントへの参照 (省略可能)。これは、API バージョン 14.0 の新項目です。

stringicon

タブの表示ラベルです (Web タブのみ)。stringlabel

必須。カスタムタブが Mobile Edition で使用できるか(true)、否か (false) を示します。

booleanmobileReady

必須。カスタムタブの配色とアイコンのタブスタイル。たとえば、"'Custom70: Handsaw," は、のこぎりアイコンです。

stringmotif

このタブに表示する Visualforce ページの名前。次の項目のいずれか 1 つのみに値が設定されている必要があります。

stringpage

• customObject

• flexiPage

• page

• scontrol

• url

このタブに表示する Sコントロールの名前。次の項目のいずれか 1 つのみに値が設定されている必要があります。

stringscontrol

• customObject

• flexiPage

• page

• scontrol

• url

ユーザがタブをクリックしたときに内容を紹介するスプラッシュページとして使用されるカスタムリンク。HomePageComponent を参照します。

stringsplashPageLink

このタブに埋め込む外部 Web ページの URL。次の項目のいずれか 1 つのみに値が設定されている必要があります。

stringurl

• customObject

• flexiPage

• page

• scontrol

235


説明データ型項目名• url

デフォルトの文字コード設定は Unicode (UTF-8) です。情報を渡す URL が別形式のデータを必要とする場合は、この設

Encoding (string型の列挙)

urlEncodingKey

定を変更します。このオプションは、タブの種類で値 URL

が選択されている場合に使用できます。

宣言的なメタデータの定義のサンプルタブの定義を次に示します。

<?xml version="1.0" encoding="UTF-8"?><CustomTab xmlns="http://soap.sforce.com/2006/04/metadata">

<description>Myriad Publishing</description><frameHeight>600</frameHeight><mobileReady>true</mobileReady><motif>Custom53: Bell</motif><url>http://www.myriadpubs.com</url><urlEncodingKey>UTF-8</urlEncodingKey>

</CustomTab>

関連リンクCustomApplication

Dashboardダッシュボードを表します。ダッシュボードは、総計値とパフォーマンスを一目で理解できるように表示されたデータの視覚的表現です。Metadataメタデータ型を拡張し、そのfullName項目を継承します。詳細は、Salesforceオンラインヘルプの「アクセシビリティモードでのダッシュボードの編集」を参照してください。

宣言的なメタデータファイルのサフィックスおよびディレクトリの場所ダッシュボードは、対応するパッケージディレクトリのdashboardsディレクトリに保存されます。ファイル名はダッシュボードのタイトルに一致し、拡張子は .dashboardです。

ダッシュボードの取得package.xmlではダッシュボードにワイルドカード (*) 記号を使用できません。明示的な名前を package.xml

に入力するためにダッシュボードのリストを取得するには、listMetadata()をコールし、DashboardFolder

をデータ型として渡します。DashboardFolder はdescribeMetadata()ではデータ型として返されません。ダッシュボードは、inFolderの関連付けられている属性が true に設定された describeMetadata()から返されます。この属性が true に設定されている場合は、DashboardFolder など、「Folder」という単語を含むコンポーネント名を使用してデータ型を作成できます。次の例では、package.xml内のフォルダを示します。


<types><members>MyDBFolder/MyDBName</members><name>Dashboard</name>

236

Dashboardメタデータ型

</types><types>

<members>MyDocumentFolder/MyDocumentName</members><name>Document</name>

</types><types>

<members>unfiled$public/MarketingProductInquiryResponse</members><members>unfiled$public/SalesNewCustomerEmail</members><name>EmailTemplate</name>

</types><types>

<members>MyReportFolder/MyReportName</members><name>Report</name>


</Package>

バージョンDashboard コンポーネントは、API バージョン 14.0 以降で使用できます。

項目

説明データ型項目必須。ダッシュボードでは、グラフにグラデーションの色の変化を適用できます。この項目は、グラデー

stringbackgroundEndColor

ションの 2 つ目の色を定義し、backgroundStartColorは、最初の色を定義します。背景で単色を使用する場合、またはグラデーションの色の変化を使用しない場合は、この項目とbackgroundStartColorに同じ色を選択してください。色は、16 進形式で表記されます (#FF6600 など)。必須。backgroundStartColor項目とbackgroundEndColor項目で定義される、グラデー

ChartBackgroundDirection(string 型の列挙)

backgroundFadeDirection

ションの色の変化の方向。有効な値は、次のとおりです。• diagonal

• leftToRight

• topToBottom

必須。ダッシュボードのグラフでのグラデーションの色の変化の開始色。詳細は、

stringbackgroundStartColor

「backgroundEndColor」を参照してください。色は、16 進形式で表記されます (#FF6600 など)。ダッシュボードの検索条件のリスト。この項目は API バージョン 23.0 以降で使用できます。

DashboardFilters[]dashboardFilters

ダッシュボードの表示設定を設定する方法を決定します。有効な値は、次のとおりです。

DashboardType (string 型の列挙)

dashboardType

• SpecifiedUser — すべてのユーザは、個々のセキュリティ設定に関係なく、runningUser項目に

237


説明データ型項目指定された、1 人の特定の実行ユーザのアクセスレベルでデータを表示します。

• LoggedInUser — 各ログインユーザは、個々のアクセスレベルに従ってデータを表示します。

• MyTeamUser — マネージャは、ロール階層におけるその部下の視点でダッシュボードを参照するように選択できます。この値は、API バージョン20.0 以降で使用できます。


ダッシュボードの説明。最大 255 文字です。stringdescription

Metadata から継承されるこの項目は、このメタデータ型の WSDL では定義されません。作成時、更新

stringfullName

時、または削除時に指定する必要があります。コールにおけるこの項目の例を確認するには、「create()」を参照してください。この項目は、フォルダとダッシュボードのタイトルを指定します。たとえば、folderSales/California

です。

必須。ダッシュボードの左セクションまたは列。DashboardComponentSectionleftSection

ダッシュボードの中央セクションまたは列。DashboardComponentSectionmiddleSection

必須。ダッシュボードの右セクションまたは列。DashboardComponentSectionrightSection

ダッシュボードに表示されるデータを決定するために使用されるロールと共有設定を所有するユーザのユーザ名。ダッシュボードをリリースするときに、この項目の値が定義されていないか有効なユーザに対応してい

stringrunningUser

ない場合、項目にはリリースを実行するユーザのユーザ名が入力されます。ダッシュボードは常に特定のユーザのセキュリティ設定を使用して実行されるため、各ユーザのセキュリティ設定に関係なく、ダッシュボードを参照するすべてのユーザにまったく同一のデータが表示されます。

ヒント: 機密データの不適切な開示を避けるには、適切なユーザにのみ表示されるフォルダにダッシュボードを保存します。

必須。ダッシュボードの各グラフのテキストの色。色は、16 進形式で表記されます (#FF6600 など)。

stringtextColor

必須。ダッシュボードのタイトル。stringtitle

238


説明データ型項目必須。各サッシュボードコンポーネントのタイトルの色。色は、16 進形式で表記されます (#FF6600 など)。

stringtitleColor

必須。タイトルテキストの文字のサイズ。たとえば、12 という値は 12pt のテキストを示します。

inttitleSize

DashboardComponentSection

DashboardComponentSection は、ダッシュボードの 1 つのセクションまたは列を表します。

説明データ型項目必須。ダッシュボードの列のサイズ。有効な値についての詳細は、「DashboardComponentSize」を参照してください。

DashboardComponentSize(string 型の列挙)

columnSize

ダッシュボード列のDashboardComponentオブジェクトのリスト。

DashboardComponent[]components

DashboardComponentSize

DashboardComponentSize は、異なるサイズカテゴリをリストする string型の列挙です。有効な値のリストを下の表に示します。

説明列挙値中サイズのコンポーネント。medium

最小サイズのコンポーネント。narrow

最大サイズのコンポーネント。wide

DashboardComponent

データを表示する異なるコンポーネントまたは要素のグループで構成されるダッシュボード。各コンポーネントは、経営指標または重要業績評価指標 (KPI) を表示するためのデータソースとして、カスタムレポートまたはカスタム Sコントロールを使用できます。複数のダッシュボードコンポーネントを作成し、最大 3 列のダッシュボード 1 つにすべてを表示できます。

説明データ型項目棒グラフまたは折れ線グラフの手動または自動設定の軸範囲。有効な値は、次のとおりです。

ChartRangeType (string型の列挙)chartAxisRange

• auto

• manual

表示する最大軸範囲。これは、chartAxisRange

項目について manualの軸範囲が選択された棒グラフと折れ線グラフにのみ適用されます。

doublechartAxisRangeMax

239


説明データ型項目表示する最小軸範囲。これは、chartAxisRange

項目について manualの軸範囲が選択された棒グラフと折れ線グラフにのみ適用されます。

doublechartAxisRangeMin

グラフデータの集計項目を指定します。isAutoSelectFromReportが falseに設定されている場合は必須です。この項目は API バージョン 25.0 以降で使用できます。

ChartSummarychartSummary

必須。ダッシュボードコンポーネントの種類。有効な値は、次のとおりです。

DashboardComponentType (string型の列挙)

componentType

• Bar

• BarGrouped

• BarStacked

• BarStacked100

• Column

• ColumnGrouped

• ColumnLine

• ColumnLineGrouped

• ColumnLineStacked

• ColumnLineStacked100

• ColumnStacked

• ColumnStacked100

• Donut

• Funnel

• Gauge

• Line

• lineCumulative

• LineGrouped

• lineGroupedCumulative

• Metric

• Pie

• Scatter

• ScatterGrouped

• Scontrol

• Table

ダッシュボードの検索条件列のリスト。各レポートベースのコンポーネントには、検索条件

DashboardFilterColumns[]dashboardFilterColumns

が適用される列を定義するダッシュボード検索条件列が必要です。この項目は API バージョン 23.0 以降で使用できます。

カスタマイズされたダッシュボードテーブルコンポーネントの列のリストを表します。

DashboardTableColumn[]dashboardTableColumn

240


説明データ型項目グラフの単位。有効な値は、次のとおりです。ChartUnits (string 型の列挙)displayUnits

• Auto

• Integer

• Hundreds

• Thousands

• Millions

• Billions

• Trillions

グラフで、ユーザがダッシュボードコンポーネントをクリックしたときに移動先となる URL

stringdrillDownUrl

を指定します。このオプションを使用して、別のダッシュボード、レポート、レコード詳細ページ、または Web インターフェースを使用するその他のシステムにユーザを送信します。この項目は、drillEnabled項目とdrillToDetailEnabled項目より優先されます。ユーザがダッシュボードコンポーネントをクリックしたときに、完全なソースレポートまた

booleandrillEnabled

は絞り込まれたソースレポートにユーザを移動するかどうかを指定します。完全なソースレポートにドリルするにはfalseを設定し、ユーザがクリックした項目によって絞り込まれたソースレポートにドリルするには trueを設定します。trueに設定すると、ユーザは、個々のグループ、軸の値、または凡例のエントリをクリックできます。これは、drillToDetailEnabled項目より優先されます。この項目は API バージョン 17.0 以降で使用できます。

有効である場合、ユーザがテーブルまたはグラフのレコード名、レコード所有者、またはフィー

booleandrillToDetailEnabled

ド投稿をクリックすると、レコード詳細ページに移動します。trueに設定すると、ユーザは軸、凡例値、グラフ要素、およびテーブルエントリをクリックできます。drillDownUrl項目とdrillEnabled項目は、この項目より優先されます。この項目は API バージョン 20.0 以降で使用できます。グラフにマウスを重ねたとき、値、表示ラベル、およびパーセントを表示するかどうかを指

booleanenableHover

定します。詳細のフロート表示はグラフの種類によって異なります。パーセントは、円グラフ、ドーナツグラフ、およびじょうごグラフの

241


説明データ型項目みに適用されます。この項目はAPIバージョン17.0 以降で使用できます。合計の 3% 以下のグループをすべて 1 つの「その他」系列または区分グループにまとめるかど

booleanexpandOthers

うかを指定します。円グラフ、ドーナツグラフ、およびじょうごグラフのみに適用されます。グラフにすべての値を個別に表示する場合はtrueを設定し、小さなグループを「その他」にまとめるにはfalseに設定します。この項目は API バージョン 17.0 以降で使用できます。ダッシュボードコンポーネントの下部に表示されるフッター。最大 255 文字です。

stringfooter

ゲージの最大値。ゲージは、ゴール達成までの距離を表示するために使用されます。自動車の速度計のようなものです。

doublegaugeMax

ゲージの最小値。doublegaugeMin

データのグループ化の基準となる項目を指定します。このデータは、縦棒グラフの場合は X 軸に、横棒グラフの場合は Y 軸に表示されます。この項目は API バージョン 25.0 以降で使用できます。

stringgroupingColumn

ダッシュボードコンポーネントの上部に表示されるヘッダー。最大 80 文字です。

stringheader

ダッシュボードの indicatorMiddleColorとindicatorLowColorを区切る値。

doubleindicatorBreakpoint1

ダッシュボードの indicatorHighColorとindicatorMiddleColorを区切る値。

doubleindicatorBreakpoint2

ゲージで高い数値の範囲を表す色。stringindicatorHighColor

ゲージで低い数値の範囲を表す色。stringindicatorLowColor

ゲージで中位の数値の範囲を表す色。stringindicatorMiddleColor

グラフに対する凡例の位置。有効な値は、次のとおりです。

ChartLegendPosition (string 型の列挙)

legendPosition

• Bottom

• OnChart

• Right

横棒グラフでの横軸、縦棒グラフでの縦軸、または積み上げ棒グラフでの選択した軸の上位グ

intmaxValuesDisplayed

ループに含める要素の最大数。たとえば、上位5 名の営業担当者のみを表示する場合は、所有

242


説明データ型項目者別の合計商談額を表す商談レポートを作成し、この項目に「5」と入力します。指標を説明した表示ラベル metricがcomponentType項目の値である場合に関連します。

stringmetricLabel

コンポーネントに関連付けられた Visualforceページ。

stringpage

Visualforceページの表示の高さ (ピクセル単位)。intpageHeightInPixels

コンポーネントに関連付けられたレポートの名前。

stringreport

scontrolがcomponentType項目の値である場合に、コンポーネントに関連付けられる Sコン

stringscontrol

トロール。詳細は、Salesforceオンラインヘルプの「カスタム Sコントロールの定義」を参照してください。Sコントロールの表示の高さ (ピクセル単位)。intscontrolHeightInPixels

円グラフ、ドーナツグラフ、およびじょうごグラフのゲージ、系列、および区分の領域にパー

booleanshowPercentage

セント値を表示するか (true)、否か (false) を示します。ユーザまたはグループの名前項目によってソースレポートがグループ化されている横棒グラフ

booleanshowPicturesOnCharts

コンポーネントに、最大 20 レコードの Chatter写真を表示します。写真を含むレコードが 20件より多くある場合は、写真ではなくレコード名が表示されます。写真を表示するには、[グルーピング表示]で[なし]に設定します。[ドリルダウン先]オプションを[レコード詳細ページ]に設定すると、写真をクリックしたときにユーザプロファイルやグループページに直接移動できます。写真を表示するには、Chatterを有効にする必要があります。組織の設定に応じて、テーブルやグラフで写真が表示されない場合があります。ユーザまたはグループの名前項目によってソースレポートがグループ化されている横棒グラフ

booleanshowPicturesOnTables

コンポーネントに、最大 20 レコードの Chatter写真を表示します。写真を含むレコードが 20件より多くある場合は、写真ではなくレコード名が表示されます。写真を表示するには、[グルーピング表示]で[なし]に設定します。[ドリルダウン先]オプションを[レコード詳細ページ]に設定すると、写真をクリックしたときにユー

243


説明データ型項目ザプロファイルやグループページに直接移動できます。写真を表示するには、Chatterを有効にする必要があります。組織の設定に応じて、テーブルやグラフで写真が表示されない場合があります。ゲージとドーナツグラフですべての系列の合計を表示するか (true)、否か (false) を示します。

booleanshowTotal

グラフの個々のレコードまたはグループの値が表示されるか (true)、否か (false) を示します。

booleanshowValues

ダッシュボードコンポーネントの並び替えオプション。

DashboardComponentFilter (string型の列挙)

sortBy

ダッシュボードコンポーネントのタイトル。最大 40 文字です。

stringtitle

ソースレポートに定義されたグラフをこのdashboard コンポーネントで使用するかどうかを

booleanuseReportChart

指定します。ソースレポートのグラフの設定によって、ダッシュボードでのグラフの表示方法が決定します。また、ダッシュボードに定義したグラフ設定はすべて上書きされます。ソースレポートに組み合わせグラフを定義した場合、このオプションを使用して、このダッシュボードで組み合わせグラフを使用します。

DashboardFilters

DashboardFilters は、ダッシュボードの検索条件を表します。

説明データ型項目[検索条件を追加] ダイアログの[検索条件オプション]

セクションで選択できる項目のリスト。DashboardFilterOptions[]dashboardFilterOptions

必須。検索条件の表示ラベル。stringname

DashboardFilterColumns

DashboardFilterColumns は、ダッシュボードの検索条件列を表します。

説明データ型項目必須。検索条件のレポート列コード。stringcolumn

DashboardFilterOptions

DashboardFilterOptions は、ダッシュボードの検索条件オプションを表します。

244


説明データ型項目必須。この検索条件項目の絞り込み操作を表します。有効な値は、DashboardFilterOperation に列挙されて

DashboardFilterOperation


operator

います。この項目は API バージョン 24.0 以降で使用できます。APIバージョン 23.0 での有効な値は、FilterOperationに列挙されています。

必須。[検索条件を追加]ダイアログの [検索条件オプション]領域の値。この項目は API バージョン 23.0で使用できます。

stringvalue

必須。[検索条件を追加]ダイアログの [検索条件オプション]領域の 1 つ以上の値。この項目は API バージョン 24.0 以降で使用できます。

string[]values

DashboardFilterOperation

これは、ダッシュボードの絞り込み操作をリストする string 型の列挙です。有効な値は、次のとおりです。• equals

• notEqual

• lessThan

• greaterThan

• lessOrEqual

• greaterOrEqual

• contains

• notContain

• startsWith

• includes

• excludes

• between

メモ: "between" 演算子には、2 つのオペランドが必要です ("between MinimumValue, MaximumValue"など)。また、最小値にはその値自体が含まれますが、最大値にはその値自体は含まれません。その他すべてのダッシュボード絞り込み操作では、1 つのオペランドのみが必要です。

DashboardTableColumn

DashboardTableColumn は、ダッシュボードのカスタマイズされたテーブルコンポーネントの列を表します。

説明データ型項目テーブル列の集計種別を指定します。ReportSummaryType[]

(string 型の列挙)aggregateType

必須。テーブルで使用する列の表示ラベル。stringcolumn

ダッシュボードテーブルに集計可能な各列の合計を表示します。この項目は API バージョン 19.0 以降で使用できます。

booleanshowTotal

245


説明データ型項目ダッシュボードテーブルコンポーネントの並び替えオプション。テーブルあたり 1 つの列で並び替えます。

DashboardComponentFilter(string 型の列挙)

sortBy

DashboardComponentFilter

DashboardComponentFilter は、ダッシュボードコンポーネントの並び替え値をリストする string 型の列挙です。有効な値は、次のとおりです。

説明列挙値表示ラベルを基準にしてアルファベット順に並び替えます。RowLabelAscending

表示ラベルを基準にしてアルファベット降順に並び替えます。RowLabelDescending

値を基準にして最小値から最大値の順に並び替えます。RowValueAscending

値を基準にして最大値から最小値の順に並び替えます。RowValueDescending

宣言的なメタデータの定義のサンプル — 条件設定済みダッシュボード条件設定済みダッシュボードの XML 定義のサンプルを以下に示します。この例がサポートされているのは、APIバージョン 24.0 以降です。ファイル名はダッシュボードのタイトルに一致し、拡張子は .dashboardです。

<?xml version="1.0" encoding="UTF-8"?><Dashboard xmlns="http://soap.sforce.com/2006/04/metadata">

<backgroundEndColor>#FFFFFF</backgroundEndColor><backgroundFadeDirection>Diagonal</backgroundFadeDirection><backgroundStartColor>#FFFFFF</backgroundStartColor><dashboardFilters>

<dashboardFilterOptions><operator>equals</operator><values>Media</values>

</dashboardFilterOptions><dashboardFilterOptions>

<operator>lessThan</operator><values>Working</values>


<operator>between</operator><values>ABC</values><values>XYZ</values>

</dashboardFilterOptions><name>Industry</name>

</dashboardFilters><dashboardFilters>

<dashboardFilterOptions><operator>equals</operator><values>Analyst,Partner</values>


<operator>startsWith</operator><values>Integrator</values>

</dashboardFilterOptions><name>Account Type</name>

</dashboardFilters><dashboardType>SpecifiedUser</dashboardType><leftSection>

<columnSize>Medium</columnSize><components>

246


<chartAxisRange>Auto</chartAxisRange><componentType>Bar</componentType><dashboardFilterColumns>

<column>INDUSTRY</column></dashboardFilterColumns><dashboardFilterColumns>

<column>TYPE</column></dashboardFilterColumns><displayUnits>Auto</displayUnits><drillEnabled>false</drillEnabled><drillToDetailEnabled>false</drillToDetailEnabled><enableHover>false</enableHover><expandOthers>false</expandOthers><legendPosition>Bottom</legendPosition><report>unfiled$public/SampleReportofAccounts</report><showPercentage>false</showPercentage><showPicturesOnCharts>false</showPicturesOnCharts><showValues>false</showValues><sortBy>RowLabelAscending</sortBy><useReportChart>false</useReportChart>

</components></leftSection><middleSection>


<chartAxisRange>Auto</chartAxisRange><componentType>Funnel</componentType><dashboardFilterColumns>

<column>ACCOUNT_INDUSTRY</column></dashboardFilterColumns><dashboardFilterColumns>

<column>ACCOUNT.TYPE</column></dashboardFilterColumns><displayUnits>Auto</displayUnits><drillEnabled>false</drillEnabled><drillToDetailEnabled>false</drillToDetailEnabled><enableHover>false</enableHover><expandOthers>false</expandOthers><legendPosition>Bottom</legendPosition><report>unfiled$public/SampleReportofCases</report><showPercentage>false</showPercentage><showValues>true</showValues><sortBy>RowLabelAscending</sortBy><useReportChart>false</useReportChart>

</components></middleSection><rightSection>


<chartAxisRange>Auto</chartAxisRange><componentType>Column</componentType><dashboardFilterColumns>

<column>INDUSTRY</column></dashboardFilterColumns><dashboardFilterColumns>

<column>ACCOUNT_TYPE</column></dashboardFilterColumns><displayUnits>Auto</displayUnits><drillEnabled>false</drillEnabled><drillToDetailEnabled>false</drillToDetailEnabled><enableHover>false</enableHover><expandOthers>false</expandOthers><legendPosition>Bottom</legendPosition><report>unfiled$public/SampleReportofOpportunities</report><showPercentage>false</showPercentage><showValues>false</showValues><sortBy>RowLabelAscending</sortBy><useReportChart>false</useReportChart>

</components>

247


</rightSection><runningUser>admin@TESTORGNUM</runningUser><textColor>#000000</textColor><title>My Dashboard</title><titleColor>#000000</titleColor><titleSize>12</titleSize>

</Dashboard>

宣言的なメタデータの定義のサンプル — 条件設定解除されたダッシュボード条件設定が解除されたダッシュボードの XML 定義のサンプルを次に示します。ファイル名はダッシュボードのタイトルに一致し、拡張子は .dashboardです。

<?xml version="1.0" encoding="UTF-8"?><Dashboard xmlns="http://soap.sforce.com/2006/04/metadata">

<backgroundEndColor>#FFFFFF</backgroundEndColor><backgroundFadeDirection>LeftToRight</backgroundFadeDirection><backgroundStartColor>#FFFFFF</backgroundStartColor><description>Dashboard with all possible chart types</description><leftSection>


<chartAxisRange>Auto</chartAxisRange><componentType>BarStacked100</componentType><displayUnits>Auto</displayUnits><drillEnabled>true</drillEnabled><enableHover>true</enableHover><report>testFolder/sourceRep</report><sortBy>RowLabelAscending</sortBy>

</components><components>

<componentType>Table</componentType><dashboardTableColumn>

<column>CLOSE_DATE</column><sortBy>RowLabelAscending</sortBy>

</dashboardTableColumn><dashboardTableColumn>

<aggregateType>Sum</aggregateType><column>AMOUNT</column><showTotal>true</showTotal>

</dashboardTableColumn><dashboardTableColumn>

<column>STAGE_NAME</column></dashboardTableColumn><dashboardTableColumn>

<column>PROBABILITY</column><aggregateType>Maximum</aggregateType>

</dashboardTableColumn><displayUnits>Integer</displayUnits><header>Opportunities Table</header><indicatorHighColor>#54C254</indicatorHighColor><indicatorLowColor>#C25454</indicatorLowColor><indicatorMiddleColor>#C2C254</indicatorMiddleColor><maxValuesDisplayed>10</maxValuesDisplayed><report>testFolder/sourceRep</report>


<chartAxisRange>Auto</chartAxisRange><componentType>Bar</componentType><displayUnits>Auto</displayUnits><drillEnabled>true</drillEnabled><enableHover>true</enableHover><report>testFolder/sourceRep</report><sortBy>RowLabelAscending</sortBy>


<chartAxisRange>Auto</chartAxisRange>

248


<componentType>Column</componentType><displayUnits>Auto</displayUnits><drillEnabled>true</drillEnabled><legendPosition>Bottom</legendPosition><report>testFolder/sourceRep</report><sortBy>RowLabelAscending</sortBy><useReportChart>true</useReportChart>


<chartAxisRange>Auto</chartAxisRange><componentType>Funnel</componentType><displayUnits>Auto</displayUnits><drillEnabled>true</drillEnabled><enableHover>true</enableHover><expandOthers>true</expandOthers><legendPosition>Bottom</legendPosition><report>testFolder/sourceRep</report><sortBy>RowLabelAscending</sortBy>

</components></leftSection><middleSection>


<chartAxisRange>Auto</chartAxisRange><componentType>ColumnStacked100</componentType><displayUnits>Auto</displayUnits><drillEnabled>true</drillEnabled><enableHover>true</enableHover><report>testFolder/sourceRep</report><sortBy>RowLabelAscending</sortBy>


<chartAxisRange>Auto</chartAxisRange><componentType>ColumnStacked</componentType><displayUnits>Auto</displayUnits><drillEnabled>true</drillEnabled><enableHover>true</enableHover><report>testFolder/sourceRep</report><sortBy>RowLabelAscending</sortBy>


<chartAxisRange>Auto</chartAxisRange><componentType>ColumnStacked</componentType><displayUnits>Auto</displayUnits><drillEnabled>true</drillEnabled><enableHover>true</enableHover><report>testFolder/sourceRep</report><sortBy>RowLabelAscending</sortBy>


<chartAxisRange>Auto</chartAxisRange><componentType>ColumnGrouped</componentType><displayUnits>Auto</displayUnits><drillEnabled>true</drillEnabled><enableHover>true</enableHover><report>testFolder/sourceRep</report><sortBy>RowLabelAscending</sortBy>


<chartAxisRange>Auto</chartAxisRange><componentType>Column</componentType><displayUnits>Auto</displayUnits><drillEnabled>true</drillEnabled><enableHover>true</enableHover><report>testFolder/sourceRep</report><sortBy>RowLabelAscending</sortBy>

</components></middleSection><rightSection>

249



<chartAxisRange>Auto</chartAxisRange><componentType>Bar</componentType><displayUnits>Auto</displayUnits><drillEnabled>true</drillEnabled><enableHover>true</enableHover><report>testFolder/sourceRep</report><sortBy>RowLabelAscending</sortBy>


<chartAxisRange>Auto</chartAxisRange><componentType>Pie</componentType><displayUnits>Auto</displayUnits><drillEnabled>true</drillEnabled><enableHover>true</enableHover><expandOthers>true</expandOthers><report>testFolder/sourceRep</report><sortBy>RowLabelAscending</sortBy>


<chartAxisRange>Auto</chartAxisRange><componentType>LineGroupedCumulative</componentType><displayUnits>Auto</displayUnits><drillEnabled>true</drillEnabled><enableHover>true</enableHover><report>testFolder/sourceRep</report><sortBy>RowLabelAscending</sortBy>


<chartAxisRange>Auto</chartAxisRange><componentType>LineGrouped</componentType><displayUnits>Auto</displayUnits><drillEnabled>true</drillEnabled><enableHover>true</enableHover><report>testFolder/sourceRep</report><sortBy>RowLabelAscending</sortBy>


<chartAxisRange>Auto</chartAxisRange><componentType>LineCumulative</componentType><displayUnits>Auto</displayUnits><drillEnabled>true</drillEnabled><enableHover>true</enableHover><report>testFolder/sourceRep</report><sortBy>RowLabelAscending</sortBy>


<chartAxisRange>Auto</chartAxisRange><componentType>Donut</componentType><displayUnits>Auto</displayUnits><drillEnabled>true</drillEnabled><enableHover>true</enableHover><expandOthers>true</expandOthers><report>testFolder/sourceRep</report><sortBy>RowLabelAscending</sortBy>

</components></rightSection><runningUser>admin@TESTORGNUM</runningUser><textColor>#000000</textColor><title>Db Title</title><titleColor>#000000</titleColor>

250


<titleSize>12</titleSize></Dashboard>

関連リンクFolderReport

DataCategoryGroupデータカテゴリグループを表します。Metadata メタデータ型を拡張し、その fullName項目を継承します。

警告: メタデータ API を使用して、組織から別の組織にカテゴリ変更をリリースすると、XML ファイルで指定されていないカテゴリとレコードカテゴリが完全に削除されます。Salesforce.com では、Sandboxから本番組織に変更をリリースするのではなく、[設定] の [カスタマイズ] > [データカテゴリ] をクリックして、組織内のデータカテゴリとレコードの関連付けを手動で作成することをお勧めします。詳細は、「使用方法」を参照してください。

データカテゴリグループでは次を行えます。• データの分類と絞り込み。• ユーザ間でのデータの共有。

各データカテゴリグループには、階層的にまとめることのできる項目またはデータカテゴリが含まれます。下の例は、Geographyデータカテゴリグループとそのデータカテゴリを示します。

GeographyWorldwide

North AmericaUnited States of AmericaCanadaMexico

EuropeAsia

メモ: データカテゴリグループ、データカテゴリ、親カテゴリ、およびサブカテゴリについての詳細は、Salesforce オンラインヘルプの「データカテゴリとは?」を参照してください。

ファイルのサフィックスおよびディレクトリの場所ファイルのサフィックスは、.datacategorygroupです。各データカテゴリグループに 1 つのファイルがあり、対応するパッケージディレクトリの datacategorygroupsフォルダに保存されます。

バージョンデータカテゴリグループは API バージョン 18.0 以降で使用できます。


251

DataCategoryGroupメタデータ型

説明データ型項目名必須。カテゴリグループの状況。このカテゴリグループが有効であるか (true)、否か (false) を示します。

booleanactive

必須。データカテゴリグループ内の最上位レベルのカテゴリ。

DataCategorydataCategory

データカテゴリグループの説明。stringdescription

必須。データカテゴリグループの一意の名前。データカテゴリグループを作成するとき、fullName項目とファイル名

stringfullName

(サフィックスを含まない) が一致している必要があります。fullNameには、アンダースコアと英数字のみを使用できます。一意であること、最初は文字であること、空白は使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。この項目は、Metadata コンポーネントから継承されています。必須。Salesforce のオブジェクトを表す表示ラベル。stringlabel

データカテゴリグループと関連付けられたオブジェクト。ObjectUsageobjectUsage

DataCategory

データカテゴリグループの項目 (またはデータカテゴリ) を表します。データカテゴリは、他のデータカテゴリのリストを再帰的に含めることができます。

説明データ型項目名サブデータカテゴリの再帰的リスト。たとえば、一大陸内の国のリストです。各データカテゴリグループに最大 100

DataCategory[]dataCategory

個のカテゴリを作成し、各データカテゴリグループ階層に最大 5 つのレベルを設定できます。必須。Salesforce ユーザインターフェースでのデータカテゴリの表示ラベル。

stringlabel

必須。APIアクセスの一意の識別子として使用されるデータカテゴリの開発者名。名前には、英数字、およびアンダー

stringname

スコア (_) 文字のみを使用できます。また、最初は文字とし、最後にアンダースコアを使用したり、連続した 2 つのアンダースコア文字を含めたりすることはできません。

重要: この項目の値は一度定義されると、後で変更できません。

警告: 組織にすでに存在するカテゴリグループをリリースすると、XML ファイルで定義されていないカテゴリは、組織から完全に削除されます。詳細は、「使用方法」を参照してください。

252


ObjectUsage

データカテゴリグループに関連付けることができるオブジェクトを表します。この関連付けによって、データカテゴリを使用したオブジェクトの分類および絞り込みが可能になります。

説明データ型項目名データカテゴリグループに関連付けることができるオブジェクト名のリスト。有効な値は、次のとおりです。

string[]object

• KnowledgeArticleVersion — 記事を関連付けます。データカテゴリグループの記事への関連付けについての詳細は、Salesforceオンラインヘルプの「Salesforce ナレッジのカテゴリグループ割り当ての変更」を参照してください。

• Question — 質問を関連付けます。Questionオブジェクトを最大 1 つのカテゴリグループに関連付けることができます。データカテゴリグループの質問への関連付けについての詳細は、Salesforceオンラインヘルプの「データカテゴリのアンサーへの割り当て」を参照してください。

警告: 組織にすでに存在するカテゴリグループをリリースすると、XML ファイルで定義されていないオブジェクトの関連付けは、組織から完全に削除されます。組織のカテゴリグループに関連付けられたすべてのレコードを必ず XML ファイルで指定するようにしてください。詳細は、「使用方法」を参照してください。

宣言的なメタデータの定義のサンプルこれは、Geographyデータカテゴリグループとそのデータカテゴリの定義のサンプルです。

<?xml version="1.0" encoding="UTF-8"?><DataCategoryGroup xmlns="http://soap.sforce.com/2006/04/metadata">

<label>Geography</label><description>Geography structure of service center locations</description><fullName>geo</fullName>

<dataCategory> <name>WW</name> <label>Worldwide</label><dataCategory> <name>AMER</name> <label>North America</label>

<dataCategory><name>USA</name><label>United States of America</label>

</dataCategory><dataCategory>

<name>CAN</name><label>Canada</label>


<name>MEX</name><label>Mexico</label>

</dataCategory></dataCategory><dataCategory> <name>EMEA</name> <label>Europe, Middle East, Africa</label>

<dataCategory><name>FR</name>

253


<label>France</label></dataCategory><dataCategory>

<name>SP</name><label>Spain</label>


<name>UK</name><label>United-Kingdom</label>

</dataCategory></dataCategory><dataCategory>

<name>APAC</name><label>Asia</label>

</dataCategory></dataCategory>

<objectUsage><object>KnowledgeArticleVersion </object>

<objectUsage></DataCategoryGroup>

使用方法カテゴリグループ XML ファイルをリリースするとき、メタデータ APIは、対象の組織にそのカテゴリグループが存在するかどうかを確認します。カテゴリグループが存在しない場合は作成されます。カテゴリグループがすでに存在する場合、メタデータ API は次を実行します。• XML ファイルで定義されている新しいカテゴリまたはオブジェクトを追加する。• XML ファイルで定義されていないすべてのカテゴリを削除する。削除されるカテゴリに関連付けられたレ

コードは、その親カテゴリに再度関連付けられます。• XML ファイルで定義されていないオブジェクトの関連付けをすべて削除する。• カテゴリが XML ファイルに指定された階層位置とは異なる位置に存在する場合、そのカテゴリを移動する。

メモ: カテゴリが新しい親カテゴリに移動すると、新しい親カテゴリの表示を許可されていないユーザは再配置されたカテゴリを表示できません。

メモ: カテゴリの削除、カテゴリの再位置付け、およびレコードカテゴリと表示設定への影響については、Salesforceオンラインヘルプの「データカテゴリの削除」および「データカテゴリの変更および配置」を参照してください。

メタデータ API を使用して、組織から別の組織にカテゴリ変更をリリースすると、XML ファイルで指定されていないカテゴリとレコードカテゴリが完全に削除されます。Salesforce.comでは、Sandboxから本番組織に変更をリリースするのではなく、[設定] の [カスタマイズ] > [データカテゴリ] をクリックして、組織内のデータカテゴリとレコードの関連付けを手動で作成することをお勧めします。次の例では、Geographyデータカテゴリグループの階層の XML 表現を、このデータカテゴリグループがすでに定義されている組織にリリースするとどのようになるかを説明します。組織には、USカテゴリが含まれますが、XML ファイルには、同じ階層位置に USAカテゴリが含まれます。メタデータ API リリースプロセスは、組織から USカテゴリを削除し、すべてのレコードの関連付けを USから親 AMERカテゴリに移動します。また、USAカテゴリを AMERの下に追加します。以前に USのカテゴリに分類されていたすべてのレコードは、AMERカテゴリに関連付けられます。

254


次の例では、データカテゴリグループのカテゴリを削除または移動し、その XML 表現を sandboxから、このデータカテゴリグループをすでに定義している本番組織にリリースするとどのようになるかを説明しています。階層1 は、sandbox 組織の最初のデータカテゴリグループを示します。階層 2 では、EUカテゴリを EMEAの下に追加し、FR、SP、および UKを EUの下に移動しています。階層 3 では、FRを削除し、そのレコードをその新しい親EUに関連付けています。最後に、変更を sandbox から本番組織にリリースします。

255


メタデータ APIは、sandbox組織に適用される変更の順序を識別しません。変更をある組織から別の組織にリリースするだけです。リリース中、最初に FRカテゴリの削除を検出し、本番組織からそのカテゴリを削除します。次に、すべてのレコードの関連付けを FRから、本番組織でその親である EMEAに移動します。メタデータ APIは、EUカテゴリを追加し、SPと UKをその下に移動します。両方の組織のカテゴリグループの階層は同一のように見えますが、本番組織のレコードカテゴリは sandbox 組織とは異なります。最初に階層 1 で FRに関連付けられていたレコードは、sandbox 組織では EUに関連付けられますが、本番組織では EMEAに関連付けられています。

Documentドキュメントを表します。すべてのドキュメントは、sampleFolder/TestDocumentなどのドキュメントフォルダ内にある必要があります。このメタデータ型は、MetadataWithContent コンポーネントを拡張し、その項目を共有します。現在、ユーザは Force.com IDE を使用してドキュメントのメタデータをローカルファイルシステムにエクスポートできません。

ドキュメントの取得package.xmlではドキュメントにワイルドカード (*) 記号を使用できません。明示的な名前を package.xmlに入力するためにドキュメントのリストを取得するには、listMetadata()をコールし、DocumentFolderをデータ型として渡します。DocumentFolder は describeMetadata()ではデータ型として返されません。ドキュメントは、inFolderの関連付けられている属性が true に設定された describeMetadata()から返されます。この属性が true に設定されている場合は、DocumentFolder など、「Folder」という単語を含むコンポーネント名を使用してデータ型を作成できます。次の例では、package.xml内のフォルダを示します。



</types><types>


</types><types>


</types><types>



</Package>

各ドキュメントには、DocumentFilename-meta.xmlという名前の付随するメタデータファイルがドキュメントフォルダ内に作成されます。たとえば、sampleFolder フォルダにあるドキュメント TestDocument.pngの場合は、パッケージの documents/sampleFolderに TestDocument.png-meta.xmlがあります。

256

Documentメタデータ型

バージョンドキュメントは、API バージョン 10.0 以降で使用できます。APIバージョン 17.0 以降では、ごみ箱に移動したドキュメントを含むフォルダを削除できます。フォルダを削除すると、ごみ箱内の関連ドキュメントをはすべて完全に削除されます。API バージョン 18.0 以降では、ドキュメントに拡張子が不要です。


説明データ型項目名ドキュメントのコンテンツ。Base 64 で符号化されたバイナリデータ API コールを行う前に、クライアントアプリケー

base64content

ションはバイナリ添付データを base64 に符号化する必要があります。応答を受信したら、クライアントアプリケーションは、base64 データをバイナリに復号化する必要があります。この変換は、通常 SOAP クライアントによって処理されます。この項目は、MetadataWithContentコンポーネントから継承されます。ドキュメントの説明。このドキュメントを他のドキュメントと区別するための説明を入力します。

stringdescription

フォルダ名を含む、ドキュメントの名前。バージョン 17.0以前では、fullNameにドキュメント拡張子が含まれていま

stringfullName

した。バージョン 18.0 以降では、fullNameにはファイル拡張子が含まれていません。fullNameには、アンダースコアと英数字のみを使用できます。一意であること、最初は文字であること、空白は使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。この項目が、使用できなくなったバージョン 14.0 より前の文字を含んでいた場合は、それらの文字はこの項目から削除され、その項目の以前の値はname項目に保存されていました。この項目は、Metadata コンポーネントから継承されています。必須。ドキュメントが機密文書であるか (true)、否か(false) を示します。この項目と publicはどちらか 1 つの

booleaninternalUseOnly

みを true に設定でき、両方をtrueに設定することはできません。ドキュメントを説明するための 1 つ以上の語が含まれます。検索時には、この項目の語に一致するかどうかの確認が実行されます。

stringkeywords

fullName項目で使用できる文字のリストは、バージョン14.0 以降削減されています。この項目には、バージョン 14.0

stringname

以前の fullName項目に含まれている値が含まれます。この項目は、fullName項目の値にその項目で受け入れらない文字が含まれる場合にのみ入力されます。

257

Documentメタデータ型

説明データ型項目名必須。ドキュメントが HTML メールテンプレートに使用できる画像であり、メールで参照する場合に Salesforceユーザ

booleanpublic

名とパスワードが必要でないか (true)、否か (false) を示します。その画像を、カスタムアプリケーションロゴまたはカスタムタブアイコンとして使用し、その両方を参照するのに Salesforceユーザ名とパスワードが必要な場合は、この項目を falseに設定します。この項目とinternalUseOnlyはどちらか 1 つのみを true に設定でき、両方を trueに設定することはできません。

宣言的なメタデータの定義のサンプルドキュメントの定義を次に示します。

<?xml version="1.0" encoding="UTF-8"?><Document xmlns="http://soap.sforce.com/2006/04/metadata">

<internalUseOnly>false</internalUseOnly><name>Q2 Campaign Analysis</name><public>false</public><description>Analyze Q2 campaign effectiveness</description>

</Document>

関連リンクFolder

EmailTemplateメールテンプレートを表します。このメタデータ型は、MetadataWithContent コンポーネントを拡張し、その項目を共有します。

ファイルのサフィックスおよびディレクトリの場所テンプレートファイルのファイルサフィックスは .emailです。付随するメタデータファイルには、EmailTemplateName-meta.xmlという名前が付けられます。EmailTemplate コンポーネントは、対応するパッケージディレクトリの emailフォルダに保存されます。たとえば、sampleFolder フォルダにある SampleTemplate という名前のメールテンプレートの場合は、パッケージのemail/sampleFolderに SampleTemplate-meta.xmlがあります。

メールテンプレートの取得package.xmlではメールテンプレートにワイルドカード (*) 記号を使用できません。明示的な名前をpackage.xml

に入力するためにメールテンプレートのリストを取得するには、listMetadata()をコールし、EmailTemplate

をデータ型として渡します。次の例では、package.xml内のフォルダを示します。


<types>

258

EmailTemplateメタデータ型

<members>MyDBFolder/MyDBName</members><name>Dashboard</name>

</types><types>


</types><types>


</types><types>



</Package>

バージョンメールテンプレートは API バージョン 12.0 以降で使用できます。


説明データ型項目名これがVisualforceメールテンプレートである場合は、APIバージョン。どの Visualforce メールテンプレートにも作成時に指定された

doubleapiVersion

API バージョンがあります。この項目は API バージョン 16.0 以降で使用できます。組織のドキュメントへの参照のリスト。これらのドキュメントは、メールテンプレートの添付ファイルとして含まれています。各ド

string[]attachedDocuments

キュメントは、MyFolder/MyDocument.txtなどのパスで参照されます。メールテンプレートの添付ファイルのリスト。Attachment[]attachments

必須。メール送信時にこのテンプレートがユーザに提供されるか(true)、否か (false) を示します。

booleanavailable

メールテンプレートのコンテンツ。Base 64 で符号化されたバイナリデータ API コールを行う前に、クライアントアプリケーション

base64Binarycontent

はバイナリ添付データを base64 に符号化する必要があります。応答を受信したら、クライアントアプリケーションは、base64 データをバイナリに復号化する必要があります。この変換は、通常SOAP クライアントによって処理されます。この項目には次のものが含まれています。• typeがtextに設定されている場合は、メール本文のバイナリ

コンテンツ• typeが htmlに設定されている場合は、HTML メールコンテ

ンツ• typeが customに設定されている場合は、HTML 本文

259


説明データ型項目名• typeが visualforceに設定されている場合は、Visualforce の

本文この項目は、MetadataWithContentコンポーネントから継承されます。

メールテンプレートの説明。これはテンプレートを作成した理由を説明するのに役立ちます。

stringdescription

必須。デフォルトの文字コード設定は Unicode (UTF-8) です。テンプレートが別形式のデータを必要とする場合は、この設定を変更します。使用できる値は次のとおりです。

Encoding (string 型の列挙)

encodingKey

• UTF-8: UI の「Unicode (UTF-8)」• ISO-8859-1: UI の「米国一般および西ヨーロッパ (ISO-8859-1,

ISO-LATIN-1)」• Shift_JIS: UI の「日本語 (Shift-JIS)」• ISO-2022-JP: UI の「日本語 (JIS)」• EUC-JP: UI の「日本語 (EUC)」• ks_c_5601-1987: UI の韓国語 (ks_c_5601–1987)」• Big5: UI の「繁体字中国語 (Big5)」• GB2312: UI の「簡体字中国語 (GB2312)」• BIG5-HKSCS: UI の「繁体字中国語香港(Big5–HKSCS)」• x-SJIS_0213: UI の「日本語 (Shift-JIS_2004)」

API アクセスの一意の識別子として使用されるメールテンプレートの開発者名。fullNameには、アンダースコアと英数字のみを使

stringfullName

用できます。一意であること、最初は文字であること、空白は使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。この項目が、使用できなくなったバージョン 14.0 より前の文字を含んでいた場合は、それらの文字はこの項目から削除され、その項目の以前の値は name項目に保存されていました。この項目は、Metadata コンポーネントから継承されています。このメールテンプレートに関連付けられたレターヘッド名。type

が htmlに設定されている場合のみ有効です。stringletterhead

必須。メールテンプレート名。fullName項目で使用できる文字のリストは、バージョン 14.0 以降削減されています。この項目には、

stringname

バージョン 14.0 以前の fullName項目に含まれている値が含まれます。このメールテンプレートによって参照されるコンポーネントを含むすべての管理パッケージのパッケージバージョンのリスト。この項目は、Visualforce メールテンプレートにのみ関連します。


260


説明データ型項目名必須。テンプレートのスタイル。この項目は、typeが htmlに設定されている場合にのみ表示されます。使用できるスタイルの値は次のとおりです。

EmailTemplateStyle(string 型の列挙)

style

• none

• freeForm

• formalLetter

• promotionRight

• promotionLeft

• newsletter

• products

メールの件名。stringsubject

typeが htmlまたは customに設定されている場合は、メール本文のテキスト。

stringtextOnly

必須。メールテンプレートの種類。有効な値は、次のとおりです。

EmailTemplateType(string 型の列挙)

type

• text - すべてのユーザがテキストメールテンプレートを作成または削除できます。

• html - システム管理者および「HTML テンプレートの編集」権限を持つユーザは、レターヘッドを基にして HTML メールテンプレートを作成できます。

• custom - システム管理者および「HTML テンプレートの編集」権限を持つユーザは、レターヘッドを使用しないカスタムのHTML メールテンプレートを作成できます。HTML の知識があるか、メールテンプレートに挿入する HTML コードを用意しておく必要があります。

• visualforce - システム管理者および「アプリケーションのカスタマイズ」権限を持つユーザは、Visualforce を使用してメールテンプレートを作成できます。

Attachment

Attachment は添付ファイルを表します。

説明データ型項目必須。添付ファイルのコンテンツ。Base 64 で符号化されたバイナリデータ API コールを行う前に、クラ

base64Binarycontent

イアントアプリケーションはバイナリ添付データをbase64 に符号化する必要があります。応答を受信したら、クライアントアプリケーションは、base64 データをバイナリに復号化する必要があります。この変換は、通常 SOAP クライアントによって処理されます。必須。添付ファイル名。stringname

261


宣言的なメタデータの定義のサンプルメールテンプレートの XML 定義のサンプルを以下に示します。

<?xml version="1.0" encoding="UTF-8"?><EmailTemplate xmlns="http://soap.sforce.com/2006/04/metadata">

<available>true</available><description>Sample Email Template</description><encodingKey>ISO-8859-1</encodingKey><name>Sample Email Template</name><style>none</style><subject>Sample email subject</subject><textOnly>Your case has been resolved.</textOnly><type>custom</type>

</EmailTemplate>

関連リンクLetterhead

EntitlementProcessエンタイトルメントプロセスの設定を表します。Metadataメタデータ型を拡張し、その fullName項目を継承します。

ファイルのサフィックスおよびディレクトリの場所EntitlementProcess の値は、entitlementProcessesディレクトリ内のファイルに保存されます。各ファイルの名前には、プロセスの名前とサフィックス .entitlementProcessが使用されます。各ファイルには、1 つのエンタイトルメントプロセス、またはエンタイトルメントのバージョニングが有効化されている場合はエンタイトルメントプロセスの 1 つのバージョンが含まれます。ファイル名は、エンタイトルメントプロセス名の最後にバージョンを付加した名前になります (該当する場合)。たとえば、「gold_support」という名前のエンタイトルメントプロセスの場合は、「gold_support_v2.entitlementProcess」のようになります。このファイル名は、SOAP APIを使用して公開されるslaProcess.NameNorm項目に対応します。このファイル名は、ユーザインターフェースの表示内容を表す name項目とは異なり、バージョニングが有効化されている場合は、同じエンタイトルメントプロセスの複数のバージョンで共有されます。

バージョンエンタイトルメントプロセスは、API バージョン 27.0 以降で使用できます。

項目

説明項目のデータ型項目名エンタイトルメントプロセスが有効であるか(true)、有効でないか (false) を示します。

booleanactive

エンタイトルメントプロセスに適用される営業時間。この項目は API バージョン 30.0 以降で使用できます。

stringbusinessHours

262

EntitlementProcessメタデータ型

説明項目のデータ型項目名エンタイトルメントプロセスの説明。stringdescription

ケースのカスタム日付/時間項目に基づいてケースのプロセスが開始されるマイルストンプロセ

stringentryStartDateField

スの場合、使用される日付と時間を指定します。有効な値は、次のとおりです。• SlaStartDate (エンタイトルメントプロセスの

開始日)• CreatedDate (ケースのオープン日)• ClosedDate (ケースのクローズ日)• LastModifiedDate (ケースの最終更新日)• StopStartDate (ケースの停止日)

カスタム条件が一致したときにケースのプロセスが終了するマイルストンプロセスに条件ロ

stringexitCriteriaBooleanFilter

ジックを追加する場合、その条件ロジックを指定します。カスタム条件が一致したときにケースのプロセスが終了するマイルストンプロセスの場合、その条件を指定します。

FilterItem[]exitCriteriaFilterItems

カスタム数式の評価が true になったときにケースのプロセスが終了するマイルストンプロセスの場合、その数式を指定します。

stringexitCriteriaFormula

エンタイトルメントプロセスがデフォルトのバージョンであるか (true)、否か (false) を示します。この項目は API バージョン 28.0 以降で使用できます。

booleanisVersionDefault

エンタイトルメントプロセスのマイルストンを表します。

EntitlementProcessMilestoneItem[]milestones

ユーザインターフェースに表示されるエンタイトルメントプロセスの名前。

stringname

このエンタイトルメントプロセスに属するバージョンの順序を示します。この項目の内容は、

stringversionMaster

エンタイトルメントプロセスのすべてのバージョンで同じであれば、任意の値が有効です。この項目は API バージョン 28.0 以降で使用できます。

エンタイトルメントプロセスバージョンの説明。この項目は API バージョン 28.0 以降で使用できます。

stringversionNotes

263


説明項目のデータ型項目名エンタイトルメントプロセスのバージョン番号。1 以上である必要があります。この項目は API バージョン 28.0 以降で使用できます。

intversionNumber

EntitlementProcessMilestoneItem

エンタイトルメントプロセスのマイルストン項目を表します。

項目

説明項目のデータ型項目名マイルストンに適用される営業時間。この項目は API バージョン 30.0 以降で使用できます。

stringbusinessHours

条件が一致したときにのみ適用されるマイルストンに条件ロジックを追加する場合、その条件ロジックを指定します。

stringcriteriaBooleanFilter

条件が一致したときにのみ適用されるマイルストンの場合、その条件を指定します。

FilterItem[]milestoneCriteriaFilterItems

数式の評価が true になったときにのみ適用されるマイルストンの場合、その数式を指定します。

stringmilestoneCriteriaFormula

マイルストンの名前。stringmilestoneName

トリガ時間の計算に使用する Apex クラスの名前。この項目は API バージョン 30.0 以降で使用できます。

stringminutesCustomClass

ケースのエンタイトルメントプロセスが開始してから、マイルストンが発生するまでの分数。

intminutesToComplete

マイルストンが完了するとトリガされるアクション。

WorkflowActionReference[]successActions

エンタイトルメントプロセスのマイルストンのタイムトリガ。

EntitlementProcessMilestoneTimeTrigger[]timeTriggers

マイルストンが開始されるタイミング。マイルストン条件が一致したとき (true)、または

booleanuseCriteriaStartTime

ケースのエンタイトルメントプロセスが開始されたとき (false)。

EntitlementProcessMilestoneTimeTrigger

エンタイトルメントプロセスのマイルストンのタイムトリガを表します。

264


項目

説明項目のデータ型項目名タイムトリガに達したときに、その時点でマイルストンが完了してない場合に実行されるアクション。

WorkflowActionReference[]actions

タイムトリガが有効になってから、マイルストンの目標完了日までの時間。これは、負または正の値になる場合

inttimeLength

があります。負の値は、目標完了日に達していないことを示し、警告のタイムトリガに相当します。正の値は、目標完了日が過ぎたことを示し、違反のタイムトリガに相当します。ワークフローがトリガされるタイミングを判断するために使用される単位の種類を指定します。有効な値は、次のとおりです。

MilestoneTimeUnits(string 型の列挙)

workflowTimeTriggerUnit

• Minutes

• Hours

• Days

宣言的なメタデータの定義のサンプルこれは、エンタイトルメントプロセスのサンプルです。

<?xml version="1.0" encoding="UTF-8"?><EntitlementProcess xmlns="http://soap.sforce.com/2006/04/metadata">

<active>true</active><description>eppersone</description><entryStartDateField>SlaStartDate</entryStartDateField><exitCriteriaBooleanFilter>1 OR 2</exitCriteriaBooleanFilter><exitCriteriaFilterItems>

<field>Case.IsClosed</field><operation>equals</operation><value>true</value>

</exitCriteriaFilterItems><exitCriteriaFilterItems>

<field>Case.Description</field><operation>startsWith</operation><value>foo</value>

</exitCriteriaFilterItems><milestones>

<milestoneName>m1</milestoneName><minutesToComplete>1</minutesToComplete><successActions>

<name>emailBob</name><type>Alert</type>

</successActions><timeTriggers>

<actions><name>emailAlice</name><type>Alert</type>

</actions><actions>

<name>setEscalateToTrue</name><type>FieldUpdate</type>

</actions><timeLength>1</timeLength><workflowTimeTriggerUnit>Minutes</workflowTimeTriggerUnit>

</timeTriggers><timeTriggers>

265


<actions><name>setStopToTrue</name><type>FieldUpdate</type>

</actions><timeLength>2</timeLength><workflowTimeTriggerUnit>Minutes</workflowTimeTriggerUnit>

</timeTriggers><useCriteriaStartTime>false</useCriteriaStartTime>

</milestones><milestones>

<milestoneCriteriaFilterItems><field>Case.Priority</field><operation>equals</operation><value>High</value>

</milestoneCriteriaFilterItems><milestoneName>m2</milestoneName><minutesToComplete>120</minutesToComplete><useCriteriaStartTime>true</useCriteriaStartTime><successActions>

<name>emailBob</name><type>Alert</type>

</successActions></milestones>

</EntitlementProcess>

EntitlementTemplateエンタイトルメントテンプレートを表します。エンタイトルメントテンプレートは、商品にすばやく追加できる、事前定義されたカスタマサポートの条件です。たとえば、ユーザが顧客に提供される商品にエンタイトルメントを容易に追加できるよう Web サポートまたは電話サポートのエンタイトルメントテンプレートを作成できます。EntitlementTemplate は Metadata メタデータ型を拡張し、その fullName項目を継承します。

宣言的なメタデータファイルのサフィックスおよびディレクトリの場所EntitlementTemplate コンポーネントは、対応するパッケージディレクトリの entitlementTemplatesディレクトリに保存されます。ファイル名はエンタイトルメントテンプレートの一意の名前に一致し、拡張子は.entitlementTemplateです。

バージョンForce.com の EntitlementTemplate コンポーネントは、API バージョン 18.0 以降で使用できます。

項目

説明データ型項目エンタイトルメントのサポートされている営業時間。stringbusinessHours

エンタイトルメントがサポートするケース数を制限します。

intcasesPerEntitlement

エンタイトルメントプロセスのエンタイトルメントへの追加

stringentitlementProcess

このテンプレートから作成されたエンタイトルメントでケース数を制限する場合は、true。それ以外の場合は、false。

booleanisPerIncident

266

EntitlementTemplateメタデータ型

説明データ型項目エンタイトルメントが有効な日数。intterm

Web サポート、電話サポートなど、エンタイトルメントのタイプ。

stringtype

宣言的なメタデータの定義のサンプルエンタイトルメントテンプレートの XML 定義のサンプルを以下に示します。

<?xml version="1.0" encoding="UTF-8"?><EntitlementTemplate xmlns="http://soap.sforce.com/2006/04/metadata">

<businessHours>AlternateBusinessHours</businessHours><casesPerEntitlement>12</casesPerEntitlement><entitlementProcess>Process1</entitlementProcess><isPerIncident>true</isPerIncident><term>33</term><type>Phone Support</type>

</EntitlementTemplate>

EscalationRulesケースが一定の期間内に解決されない場合に自動的にエスカレーションを行うための、ケースのエスカレーションルールを表します。該当するすべてのオブジェクト、特定のオブジェクト、または特定のオブジェクトの特定のルールのルールメタデータにアクセスできます。すべてのオブジェクトのすべてのエスカレーションルールにアクセスする package.xml構文は次のとおりです。

<types><members>*</members><name>EscalationRules</name>

</types>

特定のオブジェクトのすべてのルールでは、ワイルドカードを使用しない類似の構文が使用されます。たとえば、Case オブジェクトのすべてのエスカレーションルールでは、次の構文が使用されます。

<types><members>Case</members><name>EscalationRules</name>

</types>

オブジェクトの特定のエスカレーションルールにもアクセスできます。次の例では、Case オブジェクトの「samplerule」および「newrule」エスカレーションルールのみにアクセスできます。この例では、型名の構文はEscalationRulesではなく、EscalationRuleです。

<types><members>Case.samplerule</members><members>Case.newrule</members><name>EscalationRule</name>

</types>

267

EscalationRulesメタデータ型

ファイルのサフィックスおよびディレクトリの場所オブジェクトの EscalationRules のサフィックスは .escalationRulesで、escalationRulesフォルダに保存されます。たとえば、すべての Case エスカレーションルールは、Case.escalationRulesファイルに保存されます。

バージョンEscalationRules コンポーネントは、API バージョン 27.0 以降で使用できます。

項目

説明項目のデータ型項目名1 つのエスカレーションルールを表し、有効かどうかを示します。エスカレーションルールは EscalationRules コンテナ内に表示される順序で処理されます。

EscalationRule[]escalationRule

EscalationRule

説明項目のデータ型項目名エスカレーションルールが有効であるか (true)、否か (false) を示します。

booleanactive


stringfullname


エスカレーションルールのルールエントリの定義が含まれます。

RuleEntry[]ruleEntry

RuleEntry


説明項目のデータ型項目名ルールに指定されている高度な絞り込み条件。stringbooleanFilter

エスカレーションアクションが実行される時間。businessHoursSourceが Staticに設定されている場合のみ指定します。

stringbusinessHours

有効な値は、次のとおりです。BusinessHoursSourceType

(string 型の列挙)businessHoursSource

• None

• Case

• Static

割り当て条件を定義するリストの項目。FilterItemcriteriaItems

268


説明項目のデータ型項目名レコードが変更されるとエスカレーションが無効化されるか (true)、否か (false) を示します。

booleandisableEscalationWhenModified

エスカレーション条件が一致すると実行されるアクション。

EscalationAction[]

(ページ 269)

escalationAction

エスカレーションの開始時間を示します。有効な値は、次のとおりです。

EscalationStartTimeType

(string 型の列挙)escalationStartTime

• CaseCreation

• CaseLastModified

入力規則数式。stringformula


EscalationAction

エスカレーションルールで実行されるアクションを説明します。

説明項目のデータ型項目名項目が割り当てられるユーザまたはキューの名前。

stringassignedTo

エスカレーションルールで指定された新しい所有者に自動送信されるメールで使用するテンプレートを指定します。

stringassignedToTemplate

有効な値は、次のとおりです。AssignToLookupValueType


• User

• Queue

エスカレーションが発生するまでの分数。intminutesToEscalation

ケースがエスカレーションされたときにケース所有者に通知するか (true)、否か (false) を示します。

booleannotifyCaseOwner

通知するユーザのメールアドレスを指定します。stringnotifyEmail

通知するユーザを指定します。stringnotifyTo

通知メールに使用するテンプレートを指定します。

stringnotifyToTemplate

宣言的なメタデータの定義のサンプルEscalationRules コンポーネントの例を次に示します。

<EscalationRules xmlns="http://soap.sforce.com/2006/04/metadata"><escalationRule>

269


<fullName>samplerule</fullName><active>false</active><ruleEntry>

<businessHours>test</businessHours><businessHoursSource>Static</businessHoursSource><criteriaItems>

<field>Case.Description</field><operation>contains</operation><value>test</value>

</criteriaItems><escalationAction>

<assignedTo>[email protected]</assignedTo><assignedToTemplate>emailtemplatename</assignedToTemplate><assignedToType>User</assignedToType><minutesToEscalation>1440</minutesToEscalation><notifyCaseOwner>false</notifyCaseOwner>

</escalationAction><escalationStartTime>CaseLastModified</escalationStartTime>

</ruleEntry></escalationRule>

</EscalationRules>

ExternalDataSourceメモ: 外部オブジェクトを介して Salesforce で SharePoint データなどの外部データソースにアクセスできるSunlight サーチは、現在はベータ機能として提供されています。フィードバックと提案は、IdeaExchangeからお寄せください。組織でのこの機能の有効化については、salesforce.com にお問い合わせください。

外部データソースに関連付けられたメタデータを表します。外部データソースを作成して、Salesforceの外部にあるデータソースとのインテグレーションに関する接続の詳細を管理します。Metadataメタデータ型を拡張し、その fullName項目を継承します。

ファイルのサフィックスおよびディレクトリの場所ExternalDataSourceコンポーネントは、対応するパッケージディレクトリの dataSourcesディレクトリに保存されます。ExternalDataSourceコンポーネントには拡張子 .dataSourceがあり、サフィックスは外部データソースの名前です。

バージョンExternalDataSource コンポーネントは、API バージョン 28.0 以降で使用できます。

項目

説明項目のデータ型項目名外部データソースに接続するための鍵。stringapiKey

SharePoint 2010 と 2007 でのみ使用できます。セキュリティ証明書が必要な場合は、証明書のルックアップアイコンを

stringcertificate

クリックして、Salesforce で作成された有効な証明書をすべて検索します。データソースの構成に使用されるカスタム文字列。stringcustomConfiguration

データソースに接続する URL。stringendpoint

270

ExternalDataSourceメタデータ型

https://success.salesforce.com/ideaView?id=08730000000BrHGAA0

説明項目のデータ型項目名リストビューなどの Salesforceユーザインターフェースに表示される、データソースのわかりやすい名前。たとえば、Acme Team Marketing Site や Acme SharePoint などです。

stringlabel

更新済みの OAuth トークン。指定された期間に、既存のエンドユーザの新しいアクセストークンを取得するために使用します。

stringoauthRefreshToken

アクセストークンの範囲。特定のユーザデータへのアクセス権を指定する権限セットが、スペースで区切られた文字列のリストとして示されています。

stringoauthScope

権限サーバによって発行されるアクセストークン。stringoauthToken

外部ソースにアクセスするために Salesforceで使用するパスワード。使用するログイン情報に、データソースへのアク

stringpassword

セス、検索の実行、外部データに関する情報の復帰を行うための十分な権限があることを確認してください。アクセスの設定方法によっては、システム管理者のパスワードの指定を必要とする場合があります。Salesforce 外のデータソースの認証に使用する ID タイプ。外部データソースの [設定] ページと [編集] ページでは、こ

ExternalPrincipal

Type (string 型の列挙)

principalType

れらの選択は [ID 種別] 項目から行われます。有効な値は、次のとおりです。• Anonymous

• PerUser

• NamedUser

Salesforce 外のデータソースへのアクセスに必要なプロトコル。外部データソースが SharePoint の場合、[基本認証] を選択します。有効な値は、次のとおりです。

AuthenticationProtocol (string型の列挙)

protocol

• NoAuthentication

• Oauth

• Password

API バージョン 29.0 以降で使用できます。サーバ URL またはデフォルトの外部リポジトリです。

stringremoteIdentifier

SharePoint Online に使用します。メタデータにアクセスできない場合、この項目を使用してテーブルとデフォルトのテーブル項目を作成します。

stringrepository

接続先であるデータソースのタイプ。有効な値は、次のとおりです。

stringtype

• OData

• Sharepoint

• SharepointOnline

271

ExternalDataSourceメタデータ型

説明項目のデータ型項目名外部ソースにアクセスするために Salesforceで使用するユーザ名。使用するログイン情報に、データソースへのアクセ

stringusername

ス、検索の実行、情報の復帰を行うための十分な権限があることを確認してください。アクセスの設定方法によっては、システム管理者のユーザ名の指定を必要とする場合があります。使用しているデータソースのバージョン番号。stringversion

FlexiPageフレキシブルページに関連付けられたメタデータを表します。フレキシブルページは、Salesforce1 ナビゲーションメニューのメニュー項目として表示されるモバイルアプリケーションのホームページです。Metadataメタデータ型を拡張し、そのfullName項目を継承します。フレキシブルページについての詳細は、Salesforceヘルプを参照してください。

メモ: FlexiPage コンポーネントは、Salesforce1 でのみサポートされています。Salesforce1 についての詳細は、Salesforce ヘルプを参照してください。

ファイルのサフィックスおよびディレクトリの場所FlexiPage コンポーネントのサフィックスは .flexipageであり、flexipagesフォルダに保存されます。

バージョンFlexiPage コンポーネントは、API バージョン 29.0 以降で使用できます。

項目

説明項目のデータ型項目名フレキシブルページの説明テキスト (省略可能)。stringdescription

必須。ページの領域。必ず 1 つの領域がある必要があります。

FlexiPageRegion[]flexiPageRegions

必須。[設定] に表示されるこの FlexiPage の表示ラベル。

stringmasterLabel

ページレイアウトに関連付けられたアクションのリスト。

QuickActionListquickActionList

FlexiPageRegion

FlexiPageRegionはページ領域のプロパティを表します。FlexiPageごとに 1 つの範囲があります。範囲には、エンティティセットを範囲とすることができる、レコードリストコンポーネントまたは最近使ったデータコンポーネントを含めることができます。

272

FlexiPageメタデータ型

説明項目のデータ型項目名コンポーネントインスタンスのプロパティと名前。ComponentInstance[]componentInstances

必須。FlexiPage 範囲の一意の名前。mainである必要があります。

stringname

ComponentInstance

フィルタリストなど、ページ内のコンポーネントのインスタンス。

説明項目のデータ型項目名コンポーネントインスタンスの単一プロパティの値。コンポーネントインスタンスにはプロパティがない場合もあります。

ComponentInstanceProperty[]componentInstanceProperties

必須。コンポーネントの単一インスタンスの名前。

stringcomponentName

ComponentInstanceProperty

コンポーネントインスタンスの単一プロパティの値。

説明項目のデータ型項目名コンポーネントインスタンス内で一意のプロパティ名。

stringname

プロパティの参照または値。stringvalue

宣言的なメタデータの定義のサンプル次に、ユーザの出張、経費報告、および他の関連データを追跡する出張アプリケーションのサンプル XMLFlexiPage コンポーネント定義を示します。

<?xml version="1.0" encoding="UTF-8"?><FlexiPage xmlns="http://soap.sforce.com/2006/04/metadata">

<flexiPageRegions><description>Page to view recent trips</description>

<componentInstances><componentInstanceProperties>

<name>entityName</name><value>Trips__c</value>

</componentInstanceProperties><componentInstanceProperties>

<name>filterName</name><value>My_Trips</value>

</componentInstanceProperties><componentName>flexipage:filterListCard</componentName>

</componentInstances><componentInstances>

<componentInstanceProperties><name>entityName</name><value>Expense_Report__c</value>

</componentInstanceProperties><componentInstanceProperties>

<name>filterName</name><value>My_Reports</value>

273

FlexiPageメタデータ型

</componentInstanceProperties><componentName>flexipage:filterListCard</componentName>

</componentInstances><componentInstances>

<componentInstanceProperties><name>entityNames</name><value>User,Trips__c,Expense__c,Receipt__c</value>

</componentInstanceProperties><componentName>flexipage:recentItems</componentName>

</componentInstances><name>main</name>

</flexiPageRegions><masterLabel>My Travel, Inc.</masterLabel><quickActionList>

<quickActionListItems><quickActionName>customAction1</quickActionName>

</quickActionListItems><quickActionListItems>

<quickActionName>customAction2</quickActionName></quickActionListItems>

</quickActionList></FlexiPage>

FlexiPage コンポーネント定義を参照するサンプルの package.xmlファイルを次に示します。


<fullName>Travel, Inc.</fullName><types>

<members>TravelIncFlexiPage</members><name>CustomTab</name>

</types><types>

<members>TravelIncFlexiPage</members><name>FlexiPage</name>

</types><types>

<members>TravelIncQuickActions</members><name>QuickAction</name>


</Package>

Flowフローに関連付けられたメタデータを表します。フローを使用すると、ユーザが一連の画面を移動してデータベース内のレコードをクエリおよび更新するアプリケーションを作成できます。また、ユーザ入力に基づいてロジックを実行して分岐機能を提供し、動的なアプリケーションを構築できます。対応する UI ベースのフロー作成ツールの詳細は、Salesforce ヘルプの「Flow Designer の概要」を参照してください。ファイルベースのメタデータ API を使用してフローを操作する場合、次の点に留意してください。• 管理パッケージからインストールされたフローへのアクセスには、メタデータ API を使用できません。• フローファイル名には空白を含めないでください。含めるとリリース時にエラーが発生します。先頭と末尾

の空白は許可されますが、リリース時に削除されます。• メタデータ API を使用してフローをリリースするときには、有効なフローまたはかつて有効だったフローは

上書きできません。• フローの新バージョンを作成するには、ファイルに新しいバージョン番号を指定してリリースします。

274

Flowメタデータ型

宣言的なメタデータファイルのサフィックスおよびディレクトリの場所フローは、対応するパッケージディレクトリの Flowディレクトリに保存されます。ファイル名はフローの一意の完全名と一致し、拡張子は .flowです。

バージョンフローメタデータ API は、API バージョン 24.0 以降で使用できます。

Flow

このメタデータ型はフローの有効な定義を表します。Metadataメタデータ型を拡張し、その fullName項目を継承します。

説明データ型項目名アクションへのコールを定義するノードの配列。この項目は API バージョン 31.0 以降で使用できます。

FlowActionCall[]actionCalls

Apex プラグインへのコールを定義するノードの配列。

FlowApexPluginCall[]apexPluginCalls

割り当てノードの配列。FlowAssignment[]assignments

静的選択オプションの配列。FlowChoice[]choices

定数の配列。FlowConstant[]constants

決定ノードの配列。FlowDecision[]decisions

フローの説明。stringdescription

データベースルックアップに基づく選択オプションのセットを構成する配列。

FlowDynamicChoiceSet[]dynamicChoiceSets

数式の配列。FlowFormula[]formulas

必須。Metadata コンポーネントから継承されます。メタデータ API 内のファイルの名前。fullNameは、ハイフンで区切られた 2 つの部分で構成されます。

stringfullName

• アンダースコアと英数字のみで構成されるフローの一意の名前。組織全体で一意であること、最初は文字であること、空白は使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。

• フローのバージョン番号。たとえば、「sampleFlow-3」は、一意の名前がsampleFlow であるフローのバージョン 3 であることを示します。

必須。フローの表示ラベル。stringlabel

275


説明データ型項目名コレクションを反復処理するためのノードの配列。この項目は API バージョン 30.0 以降で使用できます。

FlowLoop[]loops

将来の使用のために予約されています。FlowMetadataValueprocessMetadataValues

プロセス種別。有効な値は、次のとおりです。FlowProcessType (string 型の列挙)

processType

• AutoLaunchedFlow — 有効なバージョン (有効なバージョンがない場合は最新バージョン) がトリガ対応のフロー

• Flow — 制限対象の要素またはリソースが 1 つ以上含まれるため、有効なバージョン (有効なバージョンがない場合は最新バージョン) がトリガ対応ではないフロー

• Workflow — 将来の使用のために予約バージョン間で processType を FlowからAutoLaunchedFlow (またはその逆) に変更できます。この項目は API バージョン 31.0 以降で使用できます。

データベース内のレコードを作成するためのノードの配列。

FlowRecordCreate[]recordCreates

データベース内のレコードを削除するためのノードの配列。

FlowRecordDelete[]recordDeletes

データベース内のレコードを検索するためのノードの配列。

FlowRecordLookup[]recordLookups

データベース内のレコードを更新するためのノードの配列。

FlowRecordUpdate[]recordUpdates

画面ノードの配列。FlowScreen[]screens

フローの開始点となるノードまたは要素を指定します。

stringstartElementReference

ステップノードの配列。FlowStep[]steps

サブフローの配列です。この項目は API バージョン25.0 以降で使用できます。

FlowSubflow[]subflows

テキストテンプレートの配列。FlowTextTemplate[]textTemplates

変数定義の配列。FlowVariable[]variables

FlowActionCall

フローからアクションへのコールを定義します。FlowNode を拡張し、その項目のすべてを継承します。API バージョン 31.0 以降で利用できます。

276


説明データ型項目名必須。アクションの名前。同じactionTypeのアクション間で一意である必要があります。

stringactionName

必須。アクションの種別。有効な値は、次のとおりです。

InvocableActionType (string型の列挙)actionType

• chatterPost — 「Chatter に投稿」アクション

• emailAlert — ワークフローメールアラートアクション

• emailSimple — 「メールを送信」アクション• quickAction — クイックアクション• submit — 「承認申請」アクション

このアクションコールの後に実行するノードを指定します。

FlowConnectorconnector

アクションコールの結果がエラーの場合に実行するノードを指定します。

FlowConnectorfaultConnector

フローからアクションへの入力パラメータの配列。

FlowActionCallInputParameter[]inputParameters

アクションからフローへの出力パラメータの配列。

FlowActionCallOutputParameter[]outputParameters

FlowActionCallInputParameter

フローからアクションへの入力パラメータを定義します。API バージョン 31.0 以降で使用できます。

説明データ型項目名必須。入力パラメータの一意の名前。stringname

入力パラメータの値を定義します。FlowElementReferenceOrValuevalue

FlowActionCallOutputParameter

アクションからフローへの出力パラメータを定義します。API バージョン 31.0 以降で使用できます。

説明データ型項目名必須。出力パラメータ値を割り当てる変数を指定します。

stringassignToReference

必須。出力パラメータの一意の名前。stringname

FlowApexPluginCall

フローから Apex プラグインへのコールを定義します。FlowNode を拡張し、その項目のすべてを継承します。

説明データ型項目名必須。Apex クラスの名前。stringapexClass

277


説明データ型項目名この Apex プラグインコールの後に実行するノードを指定します。


Apex プラグインコールの結果がエラーの場合に実行するノードを指定します。


フローから Apex プラグインへの入力パラメータの配列。

FlowApexPluginCallInputParameter[]inputParameters

Apex プラグインからフローへの出力パラメータの配列。

FlowApexPluginCallOutputParameter[]outputParameters

FlowApexPluginCallInputParameter

フローから Apex プラグインへの入力パラメータを定義します。

説明データ型項目名必須。入力パラメータの一意の名前。stringname

入力パラメータの値を定義します。FlowElementReferenceOrValuevalue

FlowApexPluginCallOutputParameter

Apex プラグインからフローへの出力パラメータを定義します。

説明データ型項目名必須。出力パラメータ値を割り当てる変数を指定します。

stringassignToReference

必須。出力パラメータの一意の名前。stringname

FlowAssignment

フロー内の変数の値を動的に変更できる割り当てノードを定義します。FlowNode を拡張し、その項目のすべてを継承します。

説明データ型項目名インデックス 0 から開始して特定の順序で実行される、割り当て操作の配列。

FlowAssignmentItem[]assignmentItems

この割り当てノードの後に実行するノードを指定します。


FlowAssignmentItem

変数に適用する操作を定義します。

説明データ型項目名必須。指定した演算子を適用する変数への参照。stringassignToReference

278


説明データ型項目名必須。assignToReference 項目での変数参照に適用する操作。有効な値は、次のとおりです。

FlowAssignmentOperator (string型の列挙)

operator

• Assign – assignToReference 項目の変数に指定値を割り当てます。

• Add – assignToReference 項目の変数に指定値を追加します。

• Subtract – assignToReference 項目の変数から指定値を減算します。

assignToReference 項目の変数参照に演算子で適用する値を定義します。

FlowElementReferenceOrValuevalue

FlowChoice

選択肢リソースは、フロー全体で参照または再利用できるスタンドアロンの選択オプションです。FlowElementを拡張し、その項目のすべてを継承します。

説明データ型項目名必須。画面に表示する選択肢の表示ラベル。stringchoiceText

必須。有効な値は、次のとおりです。FlowDataType (string 型の列挙)dataType

• Currency

• Date

• Number

• String

• Boolean

選択肢が選択されたときに選択肢でユーザ入力を許可できるようにします。複数選択肢項目ではサポートされません。

FlowChoiceUserInputuserInput

割り当て、Apex プラグインへのコール、レコード要素など、フロー実行時に使用される実際の値。nullの場合、この選択肢の値は常に null になります。


FlowChoiceUserInput

ユーザが選択肢を選択したときに表示されるユーザ入力項目を、選択肢に含められるようにします。ユーザ入力は複数選択肢項目ではサポートされません。

説明データ型項目名ユーザが選択肢を選択したときに、ユーザに項目への入力を要求するかどうかを示します。

booleanisRequired

実行時にユーザに入力を要求するために表示されるテキスト。差し込み項目がサポートされます。

stringpromptText

実行時にユーザ入力の検証に使用されるルール。FlowInputValidationRulevalidationRule

279


FlowCondition

ルールの条件を定義します。

説明データ型項目名必須。条件式の左側として機能する要素の一意の名前。

stringleftValueReference

必須。有効な値は、次のとおりです。FlowComparisonOperator (string型の列挙)

operator

• EqualTo

• NotEqualTo

• GreaterThan

• LessThan

• GreaterThanOrEqualTo

• LessThanOrEqualTo

• StartsWith

• EndsWith

• Contains

• IsNull

• WasSet — この値は、APIバージョン 30.0 以降で使用できます。

• WasSelected — 左側に選択肢が必要です。• WasVisited — 左側にノードが必要です。

条件式の右側の要素の一意の名前または実際の値(テキストや数値など)。

FlowElementReferenceOrValuerightValue

FlowConnector

コネクタは、フローのノードの実行順序を決定します。コネクタは、後続ノードを定義してそれにリンクします。

説明データ型項目名必須。現在のノードの完了後に実行するノード。stringtargetReference

FlowConstant

定数リソースは、フロー全体で使用できる固定値を定義します。FlowElement を拡張し、その項目のすべてを継承します。

説明データ型項目名必須。有効な値は、次のとおりです。FlowDataType (string 型の列挙)dataType

• Currency

• Date

• Number

• String

• Boolean

280


説明データ型項目名定数のデフォルト値。この項目には、差し込み項目を設定できません。また、$GlobalConstant.EmptyString

を除き、別のリソースを参照することもできません。


FlowDecision

一連のルールを評価し、最初に true と評価されたルールに基づいてフロー実行を転送する決定ノード。FlowNodeを拡張し、その項目のすべてを継承します。

説明データ型項目名true と評価されたルールがない場合に実行するノードを指定します。

FlowConnectordefaultConnector

デフォルトコネクタの表示ラベル。stringdefaultConnectorLabel

決定用のルールの配列。ルールはリストされた順序で評価され、最初に true となったルールのコネクタが使用

FlowRule[]rules

されます。true のルールがない場合、デフォルトのコネクタが使用されます。Cloud Flow Designerでは、ルールは「結果」と呼ばれます。

FlowDynamicChoiceSet

実行時に sObject からデータを検索して動的に選択肢のセットを生成します。FlowElement を拡張し、その項目のすべてを継承します。

メモ: フロー内で Geolocation 型の sObject カスタム項目を参照することはできません。たとえば、レコード検索条件内、入力または出力項目の割り当て内で、または動的選択肢の表示項目、値項目、並び替え項目として Geolocation 項目を使用することはできません。


• Currency

• Date

• Number

• String

• Boolean

必須。ユーザに選択肢表示ラベルとして表示するsObject の項目。たとえば、取引先では、動的に生成される選択肢をデータベースから取得したレコードの取引先名

stringdisplayField

として表示する場合、DisplayField "Name" を使用します。

データベースから取得したレコードに適用する検索条件の配列。たとえば、指定日以降に作成され

FlowRecordFilter[]filters

281


説明データ型項目名た取引先のみを含めるように取引先を絞り込む場合などがあります。生成される選択肢のセットに含まれる選択肢の最大数です。最大数とデフォルトの数は 200 です。sortFieldとsortOrderも指定されている場合、レコードは、limitが適用される前に並び替えられます。

intlimit


必須。データベースから項目情報を取得して、生成された選択肢のセットに使用する sObject。たと

stringobject

えば、データベースの取引先レコードの情報から選択肢を動的に生成するには、"Account" を使用します。ユーザが選択したレコードの項目をフローの他の場所で使用できる変数に割り当てる配列。たとえ

FlowOutputFieldAssignment[]outputAssignments

ば、ユーザが動的に生成された選択オプションのリストから取引先名を選択した場合、outputAssignments はユーザが選択した取引先からの ID と AnnualRevenue を指定した変数に割り当てることができます。検索条件を満たすレコードを並び替えるために使用される項目です。この項目が指定されていない場合、返されるレコードは並び替えられません。SOAP API に明記されているとおり、Sort API項目プロパティを持つ項目でのみ、レコードを並び替えることができます。

stringsortField


レコードの並び替え順です。この項目が指定されていない場合、結果は並び替えられません。有効な値は、次のとおりです。

SortOrder (string 型の列挙)sortOrder

• Asc — 昇順• Desc — 降順この項目は API バージョン 25.0 以降で使用できます。

選択肢の保存値。ユーザに選択オプションとして表示される値 (DisplayField) とは異なる場合があり

stringvalueField

ます。たとえば、DisplayField が取引先の "Name"で、valueField が取引先の "Id" になる場合があります。

282



FlowElement

すべてのフロー要素の基本クラス。これは抽象クラスです。

説明データ型項目名フロー要素の説明。stringdescription

必須。フロー要素の一意の名前。stringname

FlowElementReferenceOrValue

既存の要素または指定した特定の値への参照を定義します。必ずいずれか 1 つの項目のみを指定してください。

説明データ型項目名boolean 値を指定するにはこの項目を使用します。異なるデータ型または要素参照を指定する場合はこの項目を使用しないでください。

booleanbooleanValue

dateTime 値を指定するにはこの項目を使用します。異なるデータ型または要素参照を指定する場合はこの項目を使用しないでください。この項目は API バージョン 30.0 以降で使用できます。

dateTimedateTimeValue

date 値を指定するにはこの項目を使用します。異なるデータ型または要素参照を指定する場合はこの項目を使用しないでください。

datedateValue

既存の要素の名前を指定するにはこの項目を使用します。要素参照の代わりに値を指定する場合はこの項目を使用しないでください。

stringelementReference

double 値を指定するにはこの項目を使用します。異なるデータ型または要素参照を指定する場合はこの項目を使用しないでください。

doublenumberValue

string 値を指定するにはこの項目を使用します。異なるデータ型または要素参照を指定する場合はこの項目を使用しないでください。

stringstringValue

FlowFormula

フローの関数と要素を使用して数値を計算します。FlowElement を拡張し、その項目のすべてを継承します。

説明データ型項目名数式のデータ型。有効な値は、次のとおりです。FlowDataType (string 型

の列挙)dataType

• Boolean

• Currency

• Date

• DateTime

• Number

• String

dataTypeは、数式で定義されていない場合、デフォルトの Numberになります。この項目は API バージョン 31.0 以降で使用できます。

283


説明データ型項目名必須。Salesforce の数式。返される値は数値である必要があります。Salesforce ヘルプの「フロー数式の概要」を参照してください。

stringexpression

返される値のスケール。特に、小数点以下の桁数。intscale

FlowInputFieldAssignment

リソースまたは静的値に基づいてレコード項目の値を割り当てます。メモ: フロー内で Geolocation 型の sObject カスタム項目を参照することはできません。たとえば、レコード検索条件内、入力または出力項目の割り当て内で、または動的選択肢の表示項目、値項目、並び替え項目として Geolocation 項目を使用することはできません。

説明データ型項目名必須。レコードの作成または更新中に値が割り当てられる項目の名前。

stringfield

項目に割り当てられる値。FlowElementReferenceOrValuevalue

FlowInputValidationRule

入力規則は、ユーザが入力したデータが指定された要件を満たすことを検証します。入力規則の評価が false の場合、指定されたエラーメッセージが表示されます。

説明データ型項目名必須。formulaExpressionが false と評価されたときに表示するエラーメッセージ。

stringerrorMessage

必須。ユーザ入力の検証に使用される boolean 数式。Salesforce ヘルプの「フロー数式の概要」を参照してください。

stringformulaExpression

FlowLoop

コレクションを反復処理するためのコンストラクタ。FlowNode を拡張し、その項目のすべてを継承します。FlowLoop は、API バージョン 30.0 以降で使用できます。

説明データ型項目名コレクション内のエントリごとにフローの移動先となる要素を指し示します。フローはコレクション内の次の値を処理するためにここに移動します。

FlowConnectornextValueConnector

コレクションのすべてのエントリのループが終了したときに移動先となる要素を指し示します。

FlowConnectornoMoreValuesConnector

必須。ループ対象のコレクション。stringcollectionReference

必須。nextValueConnectorの対象に移動する前に、コレクション内の現在の値が割り当てられる変数。

stringassignNextValueToReference

284


説明データ型項目名有効な値は、次のとおりです。iterationOrder

(string型の列挙)iterationOrder

• Asc — 値がリストされている順序で (最初から最後へ)、コレクションを反復処理します。

• Desc — 値がリストされている順序と逆に (最後から最初へ)、コレクションを反復処理します。

FlowNode

ノードは、フローダイアグラムに表示される要素の種別です。FlowElement を拡張し、その項目のすべてを継承します。

説明データ型項目名必須。ノードの名前。この一意ではない表示ラベルは、FlowElementから継承される、ノードの一意の名前とは異なります。

stringlabel

必須。ノードの水平位置 (左からのピクセル数)。intlocationX

必須。ノードの垂直位置 (上からのピクセル数)。intlocationY

FlowOutputFieldAssignment

レコード項目の値を、レコードからフローの他の場所で使用できる変数に割り当てます。レコードは、レコードの検索で選択される場合と、ユーザの選択によって選択される場合があります。

メモ: フロー内で Geolocation 型の sObject カスタム項目を参照することはできません。たとえば、レコード検索条件内、入力または出力項目の割り当て内で、または動的選択肢の表示項目、値項目、並び替え項目として Geolocation 項目を使用することはできません。

説明データ型項目名必須。レコード項目の値を保存する変数への参照。stringassignToReference

必須。レコードの検索の後に値が割り当てられる項目の名前。

stringfield

FlowRecordCreate

フローからの値を使用してデータベース内に新しいレコードを作成します。FlowNodeを拡張し、そのプロパティのすべてを継承します。

メモ: フローレコードの作成、ルックアップ、更新、および削除操作は、CRUD ベースのメタデータコールである create()、retrieve()、update()、および delete()とは異なります。フローレコードメソッドは、フロー内からレコード操作に適用されるため、CRUD 設定エンティティへのメタデータコールの実行とは異なります。フロー内で Geolocation 型の sObject カスタム項目を参照することはできません。たとえば、レコード検索条件内、入力または出力項目の割り当て内で、または動的選択肢の表示項目、値項目、並び替え項目として Geolocation 項目を使用することはできません。

285


説明データ型項目名レコードの作成後に ID を保存する変数への参照。

stringassignRecordIdToReference

レコードの作成後に実行するノードを指定します。


レコードを作成しようとしてエラーになった場合に実行するノードを指定します。


作成中のレコードの指定された項目に値を割り当てる配列。

FlowInputFieldAssignment[]inputAssignments

必須。この要素によって作成されるレコードのsObject

stringobject

項目値が新しいレコードの項目への入力に使用される sObject 変数を指定します。

stringinputReference

FlowRecordDelete

データベース内の 1 つ以上のレコードを削除します。FlowNode を拡張し、その項目のすべてを継承します。メモ: フローレコードの作成、ルックアップ、更新、および削除操作は、CRUD ベースのメタデータコールである create()、retrieve()、update()、および delete()とは異なります。フローレコードメソッドは、フロー内からレコード操作に適用されるため、CRUD 設定エンティティへのメタデータコールの実行とは異なります。フロー内で Geolocation 型の sObject カスタム項目を参照することはできません。たとえば、レコード検索条件内、入力または出力項目の割り当て内で、または動的選択肢の表示項目、値項目、並び替え項目として Geolocation 項目を使用することはできません。

説明データ型項目名レコードの削除後に実行するノードを指定します。FlowConnectorconnector

レコードを削除しようとしてエラーになった場合に実行するノードを指定します。


データベースから削除されるレコードの選択に使用される条件を指定する配列。たとえば、指定日以降に活動のない取引先を削除する場合などがあります。


必須。レコードが削除されるオブジェクトの名前。stringobject

レコード ID がデータベース内で削除するレコードの識別に使用される sObject 変数を指定します。


FlowRecordFilter

データベースのレコードを検索する条件を設定します。メモ: フロー内で Geolocation 型の sObject カスタム項目を参照することはできません。たとえば、レコード検索条件内、入力または出力項目の割り当て内で、または動的選択肢の表示項目、値項目、並び替え項目として Geolocation 項目を使用することはできません。

286


説明データ型項目名必須。レコードの絞り込みに使用される項目。stringfield

必須。有効な値は、次のとおりです。FlowRecordFilterOperator (string型の列挙)

operator

• EqualTo

• NotEqualTo

• GreaterThan

• LessThan

• GreaterThanOrEqualTo

• LessThanOrEqualTo

• StartsWith

• EndsWith

• Contains

• IsNull

レコードを絞り込むために、項目および演算子と一緒に使用される参照または値。


FlowRecordLookup

データベース内のレコードを検索し、その項目の値をフローで使用または保存します。FlowNode を拡張し、その項目のすべてを継承します。


説明データ型項目名レコードが見つからない場合にすべての値をnull

に設定することを指定します。この項目は APIバージョン 30.0 以降で使用できます。

booleanassignNullValuesIfNoRecordFound

レコードルックアップの完了後に実行するノードを指定します。


レコードを検索しようとしてエラーになった場合に実行するノードを指定します。


データベースからのレコードの選択に使用する条件を指定する配列。検索条件で複数のレコードが返された場合、指定された sortFieldと sortOrderに基づいて並び


替えられます。その後で、並び替えられたリストの最初のレコードが選択されます。

287


説明データ型項目名sortFieldまたは sortOrderが指定されていない場合、最初に返されたレコードが選択されます。ただし、レコードが返される順序は決まっていません。

返すレコードの最大数。受信するデータ量を制限します。この項目はAPIバージョン 30.0 以降で使用できます。

intlimit

必須。レコードの選択元となる sObject の名前。stringobject

選択されたレコードの項目を、フローの他の場所で使用できる変数に割り当てる配列。

FlowOutputFieldAssignment[]outputAssignments

クエリされた項目の値が保存される sObject 変数を指定します。

stringoutputReference

選択されたレコードから指定された sObject 変数に保存される項目を指定する配列。

string[]queriedFields

検索条件を満たすレコードを並び替えるために使用される項目です。この項目が指定されていない場合、返されるレコードは並び替えられません。SOAP APIに明記されているとおり、Sort API 項目プロパティを持つ項目でのみ、レコードを並び替えることができます。

stringsortField

この項目はAPIバージョン 25.0 以降で使用できます。

レコードの並び替え順です。この項目が指定されていない場合、結果は並び替えられません。有効な値は、次のとおりです。


• Asc — 昇順• Desc — 降順この項目はAPIバージョン 25.0 以降で使用できます。

FlowRecordUpdate

データベース内のレコードを検索し、フローからの値で更新します。FlowNode を拡張し、その項目のすべてを継承します。


288



説明データ型項目名レコード更新の完了後に実行するノードを指定します。


レコードを更新しようとしてエラーになった場合に実行するノードを指定します。


データベース内で更新するレコードの選択に使用される条件を指定する配列。


更新されるレコードの指定項目に値を割り当てる配列。

FlowInputFieldAssignment[]inputAssignments

必須。レコードが更新される sObject の名前。stringobject

項目値がレコードの項目の更新に使用される sObject変数を指定します。


FlowRule

ルールが true と評価できる条件とロジックを定義します。FlowElement を拡張し、その項目のすべてを継承します。

説明データ型項目名"and" または "or" のいずれかの値にできます。"and" に設定すると、ルールの条件がすべて true と評価された場

stringconditionLogic

合にのみルールが true と評価されます。"or" に設定した場合、ルールの条件のいずれかが true と評価された場合にルールが true と評価されます。ルールの条件の配列。FlowCondition[]conditions

決定でこのルールが最初に true と評価されたルールである場合に実行するノードを指定します。


必須。コネクタの表示ラベル。stringlabel

FlowScreen

画面は、ユーザから情報を収集してユーザに情報を表示する機能を提供します。FlowNode を拡張し、その項目のすべてを継承します。

説明データ型項目名実行時に [前へ] ボタンを画面に表示するか (true)、非表示にするか (false) を示します。true の場合、[前へ] ボタ

booleanallowBack

ンは、ユーザがフローパスで前の画面にアクセスした場合にのみ表示されます。クレジットカードトランザクションなど、前の画面に再アクセスした場合に繰り返してはいけないアクションが起動されてしまう場合は、false に設定します。この項目は API バージョン 26.0 以降で使用できます。

289


説明データ型項目名デフォルトは true です。allowBackと allowFinishのいずれかを false に設定できますが、両方を設定することはできません。

実行時に [完了] ボタンを画面に表示するか (true)、非表示にするか (false) を示します。true の場合、[完了] ボタ

booleanallowFinish

ンは、画面要素がフローパスの最後である場合にのみ表示されます。ユーザが前の画面に戻ってフローを続行または完了させる必要がある場合は、これを false に設定します。たとえば、ユーザに前の画面に戻って修正するように指示する画面に [完了] ボタンは表示しません。この項目は API バージョン 26.0 以降で使用できます。デフォルトは true です。allowBackと allowFinishのいずれかを false に設定できますが、両方を設定することはできません。

画面ノードの後に実行するノードを指定します。FlowConnectorconnector

画面に表示する項目の配列。FlowScreenField[]fields

エンドユーザが [このフォームのヘルプ] リンクをクリックした場合に表示されるテキスト。API バージョン 26.0 以降で差し込み項目をサポートします。

stringhelpText

FlowScreenField

画面上の設定可能な項目。FlowElement を拡張し、その項目のすべてを継承します。

説明データ型項目名FlowChoices またはFlowDynamicChoiceSets への参照の配

string[]choiceReferences

列。作成される選択オプションは、この配列で指定した順序で表示されます。インデックス 0 の要素が最上位の選択オプションになります。次の型の画面項目でサポートされています。• RadioButtons• DropdownBox• MultiSelectCheckboxes• MultiSelectPicklist

複数選択チェックボックスおよび複数選択リスト項目は、APIバージョン 26.0以降で使用できます。

290


説明データ型項目名必須。この画面項目のデータ型。InputField、RadioButtons、および

FlowDataType (string 型の列挙)dataType

DropdownBox 型の画面項目でのみサポートされます。有効な値は、次のとおりです。• Currency

• Date

• Number

• String

• Boolean

boolean の InputField は、実行時にチェックボックス項目として表示されます。チェックボックス入力項目は、API バージョン 26.0 以降で使用できます。複数選択チェックボックスおよび複数選択リスト項目では、string データ型のみがサポートされます。複数選択項目は、API バージョン 26.0 以降で使用できます。

画面項目のデフォルト値として使用される FlowChoice 要素の名前。次の型の画面項目でサポートされています。

stringdefaultSelectedChoiceReference

• RadioButtons• DropdownBox• MultiSelectCheckboxes• MultiSelectPicklist

DropDownBox データ型についてのみ、defaultSelectedChoiceReference が空かnull の場合、choiceReferences のインデックス 0 での参照がデフォルト値として使用されます。複数選択チェックボックスおよび複数選択リスト項目では、デフォルト値として FlowChoice 要素を 1 つのみ指定できます。複数選択項目は、APIバージョン 26.0 以降で使用できます。

この画面項目がユーザに入力を要求したときにデフォルトで使用される値。

FlowElementReferenceOrValuedefaultValue

InputField、LargeTextArea、およびPasswordField でのみサポートされます。画面に表示される項目の表示ラベル。差し込み項目がサポートされます。

stringfieldText

291


説明データ型項目名必須。有効な値は、次のとおりです。FlowScreenFieldType (string型の

列挙)fieldType

• DisplayText

• InputField

• LargeTextArea

• PasswordField

• RadioButtons

• DropdownBox

• MultiSelectCheckboxes

• MultiSelectPicklist

実行時、各複数選択項目には、その項目値がユーザが選択した選択肢の値をセミコロンで区切った結合値として保存されます。選択した選択肢の値内のセミコロンは、複数選択項目値に追加されるときに削除されます。複数選択チェックボックスおよび複数選択リスト項目は、APIバージョン 26.0以降で使用できます。

必須。エンドユーザが画面項目のヘルプアイコン ( ) をクリックした場合に表示されるテキスト。API バージョン 26.0 以降で差し込み項目をサポートします。

stringhelpText

ユーザが選択肢を選択する必要があるか、または入力する必要があるかを示

booleanisRequired

します。DisplayText または boolean のinputField ではサポートされません。データ型が number または currency の場合のこの画面項目のスケール。スケー

intscale

ルは、小数点以下の桁数を設定します。この画面項目が InputField、LargeTextArea、または PasswordField 型

FlowInputValidationRulevalidationRule

の場合、ユーザ入力の検証に使用されるルール。

FlowStep

フローの作成時にプレースホルダとして機能するステップ。FlowNode を拡張し、その項目のすべてを継承します。

説明データ型項目名ステップノードの後に実行するノードを指定します。FlowConnector[]connectors

292


FlowSubflow

サブフロー要素は、実行時にコールする別のフローを参照します。サブフロー要素を含むフローは、マスタフローとして参照されます。FlowSubflowは、FlowNodeを拡張し、その項目のすべてを継承します。APIバージョン 25.0 以降で使用できます。

説明データ型項目名サブフローの後に実行するノードを指定します。


実行時にコールするフローを参照します。値はフローの一意の名前である必要があり、ハイフ

stringflowName

ンやバージョン番号を付記することはできません。参照されるフローは、Cloud Flow Designerで作成されたものである必要があります。参照されるフローの開始時に設定される入力変数割り当ての配列。

FlowSubflowInputAssignment[]inputAssignments

参照されるフローの終了時に設定される出力変数割り当ての配列。

FlowSubflowOutputAssignment[]outputAssignments

FlowSubflowInputAssignment

参照されるフローの変数にマスタフローの要素または値を割り当てます。入力割り当ては、参照されるフローをサブフローがコールするときに行われます。API バージョン 25.0 以降で使用できます。

説明データ型項目名必須。参照されるフロー内の変数の一意の名前。

stringname

変数に割り当てる値を定義します。FlowElementReferenceOrValuevalue

FlowSubflowOutputAssignment

参照されるフローの変数の値をマスタフローの変数に割り当てます。出力割り当ては、参照されるフローの実行が終了するときに行われます。API バージョン 25.0 以降で使用できます。

説明データ型項目名必須。マスタフローの変数の一意の名前。stringassignToReference

必須。参照されるフロー内の変数の一意の名前。stringname

FlowTextTemplate

フロー全体で使用できるテキストテンプレートを定義します。FlowElement を拡張し、その項目のすべてを継承します。

説明データ型項目名テンプレートの実際のテキスト。差し込み項目がサポートされます。

stringtext

293


FlowVariable

フロー内で使用する更新可能な値を作成できるようにする変数。FlowVariable は FlowElement を拡張し、その項目のすべてを継承します。


• Currency

• Date

• Number

• String

• Boolean

• sObject

• DateTime — このデータ型は、APIバージョン 30.0以降で使用できます。

変数がオブジェクトのコレクションかどうかを示します。この項目はAPIバージョン 30.0 以降で使用できます。デフォルト値は Falseです。

booleanisCollection

URL パラメータ、Visualforce コントローラ、またはサブフロー入力を使用して、フローの開始時に変数を設

booleanisInput

定できるかを示します。この項目は API バージョン25.0 以降で使用できます。デフォルト値は次のとおりです。• False: API バージョン 25 以降または Cloud Flow

Designer の Summer '12 以降で作成された変数の場合

• True: API バージョン 24.0 または Cloud FlowDesigner の Summer '12 より前のバージョンで作成された変数の場合

警告: 既存の変数の入力または出力アクセスを無効にすると、URL パラメータ、Visualforceコントローラ、およびサブフローによってフローをコールし、変数にアクセスするアプリケーションとページの機能に影響する可能性があります。

Visualforce コントローラやその他のフローから変数の値にアクセスできるかどうかを示します。この項目はAPI バージョン 25.0 以降で使用できます。デフォルト値は次のとおりです。

booleanisOutput

• False: API バージョン 25.0 以降または Cloud FlowDesigner の Summer '12 以降で作成された変数の場合

294


説明データ型項目名• True: API バージョン 24.0 または Cloud Flow

Designer の Summer '12 より前のバージョンで作成された変数の場合

警告: 既存の変数の入力または出力アクセスを無効にすると、URL パラメータ、Visualforceコントローラ、およびサブフローによってフローをコールし、変数にアクセスするアプリケーションとページの機能に影響する可能性があります。

フロー内のレコードを表す sObject 変数の場合、この項目によってオブジェクト種別が識別されます。

stringobjectType

データ型が number または currency の場合のこの変数のスケール。

intscale

この変数のデフォルト値。FlowElementReferenceOrValuevalue

宣言的なメタデータの定義のサンプルフローの XML 定義のサンプルを以下に示します。

<?xml version="1.0" encoding="UTF-8"?><Flow xmlns="http://soap.sforce.com/2006/04/metadata">

<choices><name>Bad</name><choiceText>Bad</choiceText><dataType>Number</dataType><value>

<numberValue>0.0</numberValue></value>

</choices><choices>

<name>Excellent</name><choiceText>Excellent</choiceText><dataType>Number</dataType><value>


</choices><choices>

<name>Fair</name><choiceText>Fair</choiceText><dataType>Number</dataType><value>


</choices><choices>

<name>Good</name><choiceText>Good</choiceText><dataType>Number</dataType><value>


</choices><description>Simple Flow app to calculate a Tip according to corporate

policies</description><formulas>

295


<name>fTipAmount</name><dataType>Number</dataType><expression>{!Bill_Amount} * {!Service_Quality} / 100</expression><scale>0</scale>

</formulas><formulas>

<name>fTotalAmount</name><dataType>Number</dataType><expression>{!fTipAmount} + {!Bill_Amount}</expression><scale>0</scale>

</formulas><label>Tip Calculator App</label><screens>

<name>Simple_Tip_Calculator</name><label>Simple Tip Calculator</label><locationX>513</locationX><locationY>112</locationY><connector>

<targetReference>TipAmount</targetReference></connector><fields>

<name>Bill_Amount</name><dataType>Currency</dataType><fieldText>Bill Amount</fieldText><fieldType>InputField</fieldType><isRequired>false</isRequired><scale>2</scale>

</fields><fields>

<name>Service_Quality</name><choiceReferences>Excellent</choiceReferences><choiceReferences>Good</choiceReferences><choiceReferences>Fair</choiceReferences><choiceReferences>Bad</choiceReferences><dataType>Number</dataType><fieldText>Service Quality</fieldText><fieldType>RadioButtons</fieldType><isRequired>false</isRequired><scale>2</scale>

</fields></screens><screens>

<name>TipAmount</name><label>Tip Amount</label><locationX>518</locationX><locationY>266</locationY><fields>

<name>TipSUmmary</name><fieldText><TEXTFORMAT

LEADING="2"><PALIGN="LEFT"><FONTFACE="Arial"STYLE="font-size:12px"COLOR="#000000"LETTERSPACING="0"KERNING="0">If you think the quality ofservice is <FONTKERNING="1">{!Service_Quality},</FONT>for a meal of {!Bill_Amount} you should tip{!fTipAmount}, so the total recommended amount should be{!fTotalAmount}</FONT></P></TEXTFORMAT></fieldText>

<fieldType>DisplayText</fieldType></fields>

</screens><startElementReference>Simple_Tip_Calculator</startElementReference>

</Flow>

296


Folderフォルダを表します。Metadata メタデータ型を拡張し、その fullName項目を継承します。Salesforce には、現在次の 4 つのフォルダの種類があります。• ドキュメントフォルダ• メールテンプレートフォルダ• レポートフォルダ• ダッシュボードフォルダ

ファイルのサフィックスおよびディレクトリの場所フォルダは、パッケージの対応するコンポーネントディレクトリに保存されます。これらのディレクトリにはそれぞれdocuments、email、reports、dashboardsという名前が付いています。フォルダは、ファイルのコンテナであるため、テキストファイル表記がありません。各フォルダには、同じディレクトリレベルにFolderName-meta.xmlという名前の付随するメタデータファイルが作成されます。FolderName-meta.xmlメタデータファイルには、accessTypeなど、そのフォルダのメタデータ情報が含まれます。たとえば、sampleFolderという名前のドキュメントフォルダの場合は、パッケージのdocumentsフォルダ内にsampleFolder-meta.xml

があります。

バージョンフォルダは、API バージョン 11.0 以降で使用できます。


説明データ型項目名必須。このフォルダのアクセス権の種類。有効な値は、次のとおりです。

FolderAccessTypes(string 型の列挙)

accessType

• Shared。このフォルダには、指定されたユーザのセットのみがアクセス可能です。

• Public。このフォルダには、ポータルユーザを含むすべてのユーザがアクセス可能です。

• PublicInternal。このフォルダには、ポータルユーザを除くすべてのユーザがアクセス可能です。この設定は、パートナーポータルまたはカスタマーポータルが有効な組織のレポートおよびダッシュボードフォルダにのみ使用できます。

• Hidden。このフォルダは、すべてのユーザに対して非表示になります。


stringfullName

す。一意であること、最初は文字であること、空白は使用しない、最後にアンダースコアを使用しない、2 つ続けてア

297

Folderメタデータ型

説明データ型項目名ンダースコアを使用しないという制約があります。この項目は、Metadata コンポーネントから継承されています。必須。ドキュメントフォルダの名前。stringname

PublicがaccessTypeの値である場合、この項目はすべてのユーザがフォルダのコンテンツに対して持つアクセス権の種類を示します。使用できる値は次のとおりです。

PublicFolderAccess(string 型の列挙)

publicFolderAccess

• ReadOnly。すべてのユーザがフォルダのコンテンツを読み取ることができますが、コンテンツを変更することはできません。

• ReadWrite。すべてのユーザがフォルダのコンテンツを読み取りと変更を行うことができます。

フォルダの共有アクセス権。Salesforce オンラインヘルプの「共有に関する考慮事項」を参照してください。

SharedTosharedTo

宣言的なメタデータの定義のサンプルドキュメントが含まれるドキュメントフォルダのパッケージマニフェスト定義を次に示します。


<fullName>basic</fullName><types>

<members>sampleFolder</members><members>sampleFolder/TestDocument.txt</members><name>Document</name>


</Package>

sampleFolder ドキュメントフォルダの sampleFolder-meta.xmlメタデータファイルの例を次に示します。

<?xml version="1.0" encoding="UTF-8"?><DocumentFolder xmlns="http://soap.sforce.com/2006/04/metadata">

<accessType>Public</accessType><name>sampleFolder</name><publicFolderAccess>ReadWrite</publicFolderAccess>

</DocumentFolder>

関連リンクDashboardDocumentEmailTemplateReport

298

Folderメタデータ型

FolderShare拡張分析フォルダの共有設定を表します。レポートまたはダッシュボードを含むフォルダへの閲覧者、エディタまたはマネージャアクセス権を他のユーザに付与することにより、レポートまたはダッシュボードへのアクセスを制御できます。

ファイルのサフィックスおよびディレクトリの場所FolderShare オブジェクトは、reportsディレクトリと dashboardsディレクトリに保存されます。ディレクトリに含まれるレポートフォルダまたはダッシュボードフォルダごとに、FolderName-meta.xmlという名前のメタデータファイルがあります。FolderName-meta.xmlメタデータファイルには、accessLevelなど、そのフォルダのメタデータ情報が含まれます。たとえば、reportsディレクトリに myReportsFolderというレポートフォルダがある場合、myReportsFolderと同じレベルに myReportsFolder-meta.xmlファイルもあります。

バージョンFolderShare コンポーネントは、API バージョン 28 以降で使用できます。

項目

説明項目のデータ型項目名必須。フォルダで実行できるアクションの組み合わせを指定します。有効な値は、次のとおりです。

FolderShareAccessLevel (string型の列挙)

accessLevel

• View。レポートの実行やダッシュボードの更新はできますが、それらを編集することはできません。すべてのユーザは、共有されているレポートフォルダとダッシュボードフォルダに対して、少なくとも閲覧者アクセス権を持っています (ユーザによっては、より幅広いアクセスが可能なシステム管理者権限を持っている場合もあります)。

• EditAllContents。ユーザは、フォルダ内のレポートまたはダッシュボードを表示および変更でき、同等のアクセス権を持つ他のフォルダとの間を移動させることもできます。

• Manage。閲覧者とエディタに許可されたすべての操作を実行でき、フォルダへの他のユーザからのアクセスも制御できます。

必須。フォルダに対して指定されたアクセス権を持つユーザ、グループ、またはロールを指定します。

stringsharedTo

必須。フォルダを共有するエンティティの種別を指定します。有効な値は、次のとおりです。

FolderSharedToType (string 型の列挙)

sharedToType

• Group。指定された公開グループに属するユーザに、フォルダに指定されたアクセス権が付与されます。

• Manager。API バージョン 29.0 以降で利用できます。• ManagerAndSubordinatesInternal。API バージョン

29.0 以降で利用できます。

299

FolderShareメタデータ型

説明項目のデータ型項目名• Role。指定されたロールを持つユーザに、フォルダに

指定されたアクセス権が付与されます。• RoleAndSubordinates。指定されたロール持つユーザ

と、その下位ロールを持つユーザに、フォルダに指定されたアクセス権が付与されます。

• RoleAndSubordinatesInternal。公開ポータルユーザである場合を除き、指定されたロール持つユーザと、その下位ロールを持つユーザに、フォルダに指定されたアクセス権が付与されます。

• Organization。すべての内部ユーザに、フォルダに指定されたアクセス権が付与されます。

• Territory。指定されたテリトリーに属するユーザに、フォルダに指定されたアクセス権が付与されます。

• TerritoryAndSubordinates。指定されたテリトリーに属するユーザと、その下位テリトリーに属するユーザに、フォルダに指定されたアクセス権が付与されます。

• AllPrmUsers。すべての PRM ポータルユーザに、フォルダに指定されたアクセス権が付与されます。

• User。指定された個々のユーザに、フォルダに指定されたアクセス権が付与されます。

• PartnerUser。パートナーポータルの指定された個々のユーザに、フォルダに指定されたアクセス権が付与されます。

• AllCspUsers。すべてのカスタマーサクセスポータルユーザに、フォルダに指定されたアクセス権が付与されます。

• CustomerPortalUser。カスタマーポータルの指定された個々のユーザに、フォルダに指定されたアクセス権が付与されます。

• PortalRole。指定されたロールを持つポータルユーザに、フォルダに指定されたアクセス権が付与されます。

• PortalRoleAndSubordinates。指定されたロール持つポータルユーザと、その下位ロールを持つポータルユーザに、フォルダに指定されたアクセス権が付与されます。

宣言的なメタデータの定義のサンプル次に、ダッシュボードフォルダの FolderShare コンポーネントの例を示します。

<?xml version="1.0" encoding="UTF-8"?><DashboardFolder xmlns="http://soap.sforce.com/2006/04/metadata"><folderShares>

<accessLevel>View</accessLevel><sharedTo>R1</sharedTo><sharedToType>Role</sharedToType>

300

FolderShareメタデータ型

</folderShares></DashboardFolder>

次に、レポートフォルダの FolderShare コンポーネントの例を示します。

<?xml version="1.0" encoding="UTF-8"?><ReportFolder xmlns="http://soap.sforce.com/2006/04/metadata"><folderShares>

<accessLevel>View</accessLevel><sharedTo>R1</sharedTo><sharedToType>Role</sharedToType>

</folderShares></ReportFolder>

Groupユーザ、ロールおよびその他のグループを含めることができる公開グループのセットを表します。

宣言的なメタデータファイルのサフィックスおよびディレクトリの場所グループコンポーネントのファイルサフィックスは .groupで、コンポーネントは対応するパッケージディレクトリの groupsディレクトリに保存されます。

バージョングループコンポーネントは、API バージョン 24.0 以降で使用できます。

項目このメタデータ型はグループを定義する有効な値を表します。

説明データ型項目名グループのメンバーと共有されたレコードに、マネージャがアクセスできるか (true)、否か (false) を示します。この項目は公開グループにのみ使用できます。

booleandoesIncludeBosses

API アクセスの一意の識別子。fullNameには、アンダースコアと英数字のみを使用できます。一意であること、最初は

stringfullName

文字であること、空白は使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。この項目は、Metadata コンポーネントから継承されています。ユーザインターフェースの [グループ名] に対応します。必須。グループの名前。ユーザインターフェースの [表示ラベル] に対応します。

stringname

301

Groupメタデータ型

宣言的なメタデータの定義のサンプルグループの定義を次に示します。

<?xml version="1.0" encoding="UTF-8"?><Group xmlns="http://soap.sforce.com/2006/04/metadata">

<doesIncludeBosses>true</doesIncludeBosses><fullName>admin</fullName><name>test</name>

</Group>

HomePageComponentホームページコンポーネントに関連付けられたメタデータを表します。[ホーム] タブにサイドバーリンク、会社のロゴ、ダッシュボードのスナップショット、作成したカスタムコンポーネントなどのコンポーネントを含めるようにカスタマイズできます。詳細は、Salesforceオンラインヘルプの「[ホーム] タブのページレイアウトのカスタマイズ」を参照してください。Metadata メタデータ型を拡張し、その fullName項目を継承します。ホームページコンポーネントの定義を作成、更新または削除するために使用します。

宣言的なメタデータファイルのサフィックスおよびディレクトリの場所ホームページコンポーネントのファイルのサフィックスは .homePageComponentで、コンポーネントは対応するパッケージディレクトリの homepagecomponentsディレクトリに保存されます。

バージョンホームページコンポーネントは、API バージョン 12.0 以降で使用できます。

HomePageComponent

このメタデータ型はホームページコンポーネントを定義する有効な値を表します。

説明データ型項目名これが HTML ページコンポーネントである場合、これはHTML の本文です。

stringbody

名前には、英数字、およびアンダースコア (_) 文字のみを使用できます。また、最初は文字とし、最後にアンダースコア

stringfullName

を使用したり、連続した 2 つのアンダースコア文字を含めたりすることはできません。この項目はMetadata コンポーネントから継承するため、この項目はこのコンポーネントの WSDL で定義されません。作成時、更新時、または削除時に指定する必要があります。コールにおけるこの項目の例を確認するには、「create()」を参照してください。

Visualforceエリアコンポーネントで必須。コンポーネントの高さ (ピクセル単位) を示します。この項目は API バージョン 31.0 以降で使用できます。

intheight

302

HomePageComponentメタデータ型

説明データ型項目名pageComponentTypeがlinksの場合は、カスタムページリンクの 0 個以上の名前を指定できます。

string[]links

• ObjectWebLink

• CustomPageWebLink

この項目はVisualforceエリアコンポーネントでのみ使用可能で、コンポーネントに関連付けられているVisualforceページの API 名を示します。この項目は API バージョン 31.0 以降で使用できます。

stringpage

必須。有効な値は、次のとおりです。PageComponentType(string 型の列挙)

pageComponentType

• links

• htmlArea

• imageOrNote

• visualforcePage (この値は API バージョン 31.0 以降で使用できます)。

この項目はVisualforceエリアコンポーネントでのみ使用可能で、コンポーネントがラベル付きで表示されるか (true)、否か (false) を指定します。この項目は API バージョン 31.0 以降で使用できます。

booleanshowLabel

この項目はVisualforceエリアコンポーネントでのみ使用可能で、コンポーネントがスクロールバー付きで表示されるか(true)、否か (false) を指定します。この項目は API バージョン 31.0 以降で使用できます。

booleanshowScrollbars

この項目は HTML および Visualforce エリアコンポーネントでのみ使用可能で、これが幅の狭いまたは広いホームページ

PageComponentWidth(string 型のenumeration)

width

コンポーネントであるかどうかを示します。有効な値は、次のとおりです。• narrowComponents

• wideComponents

宣言的なメタデータの定義のサンプルホームページコンポーネントの定義を次に示します。関連するサンプルについては、「HomePageLayout」の「宣言的なメタデータの定義のサンプル」および「Weblink」の「宣言的なメタデータの定義のサンプル」を参照してください。

<?xml version="1.0" encoding="UTF-8"?><HomePageComponent xmlns="http://soap.sforce.com/2006/04/metadata"><height>200</height><page>MyVisualforcePage</page><pageComponentType>visualforcePage</pageComponentType><showLabel>true</showLabel><showScrollbars>true</showScrollbars>

303

HomePageComponentメタデータ型

<width>wideComponents</width></HomePageComponent>

関連リンクHomePageLayoutWeblink

HomePageLayoutホームページのレイアウトに関連付けられたメタデータを表します。ホームページのレイアウトをカスタマイズし、ユーザのプロファイルに基づいてユーザにレイアウトを割り当てることができます。詳細は、Salesforceオンラインヘルプの「[ホーム] タブのページレイアウトのカスタマイズ」を参照してください。

ファイルのサフィックスおよびディレクトリの場所ホームページのレイアウトは、対応するパッケージディレクトリの homePageLayoutsディレクトリに保存されます。拡張子は .homePageLayoutです。

バージョンホームページコンポーネントは、API バージョン 12.0 以降で使用できます。Metadata メタデータ型を拡張し、その fullName項目を継承します。

項目このメタデータ型はホームページのレイアウトを定義する有効な値を表します。

説明データ型項目名名前には、英数字、およびアンダースコア (_) 文字のみを使用できます。また、最初は文字とし、最後にアンダースコア

stringfullName

を使用したり、連続した 2 つのアンダースコア文字を含めたりすることはできません。この項目はMetadata コンポーネントから継承するため、この項目はこのコンポーネントの WSDL で定義されません。作成時、更新時、または削除時に指定する必要があります。コールにおけるこの項目の例を確認するには、「create()」を参照してください。

ホームページの左側の幅の狭い列の要素のリスト。string[]narrowComponents

ホームページの右側の幅の広い列の要素のリスト。string[]wideComponents

304

HomePageLayoutメタデータ型

宣言的なメタデータの定義のサンプルホームページのレイアウトの定義を次に示します。関連するサンプルについては、「HomePageComponent」の「宣言的なメタデータの定義のサンプル」 (ページ303)および「Weblink」の「宣言的なメタデータの定義のサンプル」 (ページ 212)を参照してください。

<?xml version="1.0" encoding="UTF-8"?><HomePageLayout xmlns="http://soap.sforce.com/2006/04/metadata">

<narrowComponents>google</narrowComponents></HomePageLayout>

関連リンクHomePageComponentWeblink

InstalledPackageインストールまたはアンインストールするパッケージを表します。現在インストールされているパッケージの新バージョンをリリースすると、パッケージがアップグレードされます。

メモ: 他のメタデータ型とともにパッケージをリリースすることはできません。このため、マニフェストファイルで指定されているメタデータ型は InstalledPackageのみである必要があります。

ファイルのサフィックスおよびディレクトリの場所パッケージは、installedPackagesディレクトリに、パッケージの名前空間プレフィックスが付いたファイル名で指定されます。ファイルの拡張子は .installedPackageです。

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

項目

説明項目のデータ型項目名パッケージのバージョン番号。形式はmajorNumber.minorNumber.patchNumber (2.1.3 など) です。

stringversionNumber

パッケージのパスワードを指定する項目 (省略可能)。stringpassword

宣言的なメタデータの定義のサンプル次の例は、インストールまたはアンインストールするパッケージを指定します。

<?xml version="1.0" encoding="UTF-8"?><InstalledPackage xmlns="http://soap.sforce.com/2006/04/metadata"><versionNumber>1.0</versionNumber><password>optional_password</password>

</InstalledPackage>

305

InstalledPackageメタデータ型

Layoutページレイアウトに関連付けられたメタデータを表します。詳細は、Salesforceオンラインヘルプの「ページレイアウトの管理」を参照してください。Metadata メタデータ型を拡張し、その fullName項目を継承します。

メモ: アイデアレイアウトを編集する場合、package.xmlファイルでこのアイデアレイアウトを名前で指定する必要があります。package.xmlでは、次のコードを使用してアイデアレイアウトを取得します。

<types><members>Idea-Idea Layout</members><name>Layout</name>

</types>

ファイルのサフィックスおよびディレクトリの場所レイアウトは、対応するパッケージディレクトリの layoutsディレクトリに保存されます。拡張子は .layout

です。メモ: プロジェクトでこのメタデータ型のコンポーネントを取得すると、同じパッケージで取得されたProfile コンポーネントおよび PermissionSet コンポーネントにこのコンポーネントが表示されるようになります。

バージョンレイアウトは、API バージョン 13.0 以降で使用できます。

項目このメタデータ型は、ページレイアウトを定義する有効な値を表します。

説明データ型項目名このレイアウトのカスタムボタン。各ボタンは、同一オブジェクト上の Weblink への参照です。

string[]customButtons

たとえば、ButtonLink は「ButtonLink」という名前の同一の標準オブジェクトまたはカスタムオブジェクトの Web リンクを参照します。ページレイアウト上にあるカスタムコンソールコンポーネント (Visualforce ページ、参照項目、ま

CustomConsoleComponentscustomConsoleComponents

たは関連リスト。Force.com Canvas アプリケーションは使用不可) を表します。カスタムコンソールコンポーネントは、Salesforce コンソールにのみ表示されます。showEmailCheckboxが設定されている場合にのみ該当します。そのチェックボックスのデフォルト値を示します。

booleanemailDefault

306

Layoutメタデータ型

説明データ型項目名このレイアウトから除外する標準ボタンのリスト。たとえば、

string[]excludeButtons

<excludeButtons>Delete</excludeButtons>

ではこのレイアウトから [削除] ボタンを除外します。フィードベースのページレイアウトのフィードビューを定義する値を表します。フィードベース

FeedLayoutfeedLayout

のレイアウトは、取引先、ケース、取引先責任者、リード、商談、およびカスタムオブジェクトで使用できます。フィードビューと詳細ビューが含まれます。レイアウトヘッダーは現在タギングのみに使用されており、タギングが有効になっている場合にの

LayoutHeader[] (string 型の列挙)

headers

み UI に表示されます。詳細は、Salesforceオンラインヘルプの「タグの概要」を参照してください。有効な string 値は次のとおりです。• PersonalTagging — タグはユーザには非公

開です。• PublicTagging — レコードにアクセスでき

る他のすべてのユーザがタグを参照できます。

項目、Sコントロール、およびカスタムリンクを含むレイアウトのメインセクション。ここでの順序はレイアウトの順序を決定します。

LayoutSection[]layoutSections

ミニレイアウトは、[コンソール] タブ、詳細のフロート表示、行動のフロート表示でのレコードのミニビューで使用されます。

MiniLayoutminiLayout

OpportunityProduct レイアウトで表示される特殊な複数行レイアウト項目の項目。その他の点で

string[]multilineLayoutFields

は、これらは、miniLayoutFieldsのminiLayoutと似ています。ページレイアウトに関連付けられたアクションのリスト。この項目は API バージョン 28.0 以降で使用できます。

QuickActionListquickActionList

ページレイアウトの関連コンテンツセクション。この項目は API バージョン 29.0 以降で使用できます。

RelatedContentrelatedContent

レイアウトの関連リスト。ユーザインターフェースに表示される順序で表示されます。

RelatedListItem[]relatedLists

コンソールのミニビューに表示される関連オブジェクトのリスト。データベース用語では、これ

string[]relatedObjects

らはレイアウトのオブジェクトの外部キー項目です。詳細は、Salesforceオンラインヘルプの「エー

307


説明データ型項目名ジェントコンソールのミニビューの関連オブジェクトの選択」を参照してください。showRunAssignmentRulesCheckboxが設定されている場合にのみ該当します。そのチェックボックスのデフォルト値を示します。

booleanrunAssignmentRulesDefault

ケース、CaseClose、および ToDo レイアウトでのみ使用可能。設定されている場合、メールを表示するためのチェックボックスが表示されます。

booleanshowEmailCheckbox

設定されている場合、強調表示パネルがSalesforceコンソールのページに表示されます。この項目は、API バージョン 22.0 以降で使用できます。

booleanshowHighlightsPanel

設定されている場合、相互関係ログが Salesforceコンソールのページに表示されます。この項目は、API バージョン 22.0 以降で使用できます。

booleanshowInteractionLogPanel

ケースレイアウトでのみ使用可能。設定されている場合、ナレッジサイドバーがSalesforce コンソー

booleanshowKnowledgeComponent

ルのケースに表示されます。この項目は、APIバージョン 20.0 以降で使用できます。リードオブジェクトおよび Case オブジェクトでのみ使用可能。設定されている場合、割り当て

booleanshowRunAssignmentRulesCheckbox

ルールを表示するためのチェックボックスがページに表示されます。CaseCloseレイアウトでのみ使用可能。設定されている場合、組み込みのソリューション情報セクションがページに表示されます。

booleanshowSolutionSection

ケースレイアウトでのみ使用可能。設定されている場合、[登録 & ファイルを添付] ボタンは、カ

booleanshowSubmitAndAttachButton

スタムポータルのポータルユーザのケース編集ページに表示されます。

CustomConsoleComponents

ページレイアウト上にあるカスタムコンソールコンポーネント (Visualforce ページ、参照項目、または関連リスト。Force.com Canvasアプリケーションは使用不可) を表します。カスタムコンソールコンポーネントは、Salesforceコンソールにのみ表示されます。API バージョン 25.0 以降で利用できます。

説明データ型項目名Salesforce コンソールの主タブにあるカスタムコンソールコンポーネントを表します。API バージョン 25.0 以降で利用できます。

PrimaryTabComponentsprimaryTabComponents

Salesforce コンソールのサブタブにあるカスタムコンソールコンポーネントを表します。API バージョン 25.0 以降で利用できます。

SubtabComponentssubtabComponents

308


PrimaryTabComponents

Salesforce コンソールの主タブにあるカスタムコンソールコンポーネントを表します。API バージョン 25.0 以降で利用できます。

説明データ型項目名ページレイアウトのセクション上にあるカスタムコンソールコンポーネント (Visualforce ページ、参照項目、または関連

ConsoleComponent[]component

リスト。Force.com Canvas アプリケーションは使用不可) を表します。カスタムコンソールコンポーネントは、Salesforceコンソールにのみ表示されます。この項目は、APIバージョン 29.0 以前で使用できます。Salesforce コンソールのサイドバー上に複数のカスタムコンソールコンポーネントを表示するための場所とスタイルを表

Container[]containers

します。4 つの場所 (左、右、上、および下) のそれぞれに最大 5 つのコンポーネントを指定できます。この項目は APIバージョン 30.0 以降で使用できます。

ConsoleComponent

ページレイアウトのセクション上にあるカスタムコンソールコンポーネント (Visualforce ページ、参照項目、または関連リスト。Force.com Canvasアプリケーションは使用不可) を表します。カスタムコンソールコンポーネントは、Salesforce コンソールにのみ表示されます。API バージョン 25.0 以降で利用できます。

説明データ型項目名location が top または bottom のコンポーネントで必須です。カスタムコンソールコンポーネントの高さです。ピクセル単

intheight

位で、0 より大きく 999 より小さい値に指定する必要があります。必須。ページレイアウトのカスタムコンソールコンポーネントの位置。有効な値は、right、left、top、および bottom で

stringlocation

す。コンポーネントには、ページレイアウトあたり 1 つのlocation を指定できます。必須。カスタムコンソールコンポーネントの一意の名前。たとえば、ConsoleComponentPage です。

stringvisualforcePage

location が left または right のコンポーネントで必須です。カスタムコンソールコンポーネントの幅です。ピクセル単位

intwidth

で、0 より大きく 999 より小さい値に指定する必要があります。

Container

Salesforce コンソールのサイドバーに複数のカスタムコンソールコンポーネントを表示するための場所とスタイルを表します。たとえば、コンソールの右のサイドバーには、積み上げ、タブ、またはアコーディオンのスタイルで複数のコンポーネントを表示できます。API バージョン 30.0 以降で利用できます。

309


説明データ型項目名location が top または bottom のコンポーネントで必須です。コンポーネントのコンテナの高さ。単位 (ピクセルまたはパーセント) は、unit項目によって決まります。

intheight

必須。コンポーネントのコンテナの場所。使用できる値は次のとおりです。

stringregion

• right

• left

• top

• bottom

コンポーネントのコンテナに表示する特定のカスタムコンソールコンポーネントを表します。

SidebarComponent[]sidebarComponent

必須。複数のコンポーネントを表示するコンテナのスタイル。使用できる値は次のとおりです。

stringstyle

• stack — 複数のフレームを含むコンテンツ領域。• tabs — 複数のパネルのリストを含む単一コンテンツ領

域。• accordian — 折りたたみ可能なコンテンツ領域。

必須。コンポーネントのコンテナの高さまたは幅の単位 (ピクセルまたはパーセント)。ピクセル値は、ピクセル数 (500など) で、0 より大きく 999より小さい値である必要があります。パーセント値は、パー

stringunit

セント記号を含み (20%など)、0 より大きく、100 より小さい値である必要があります。

location が right または left のコンポーネントで必須です。コンポーネントのコンテナの幅。単位 (ピクセルまたはパーセント) は、unit項目によって決まります。

intwidth

SidebarComponent

Salesforce コンソールのサイドバーのいずれかでマルチコンポーネントをホストするコンテナに表示する特定のカスタムコンソールコンポーネントを表します。4 つのコンテナの場所 (左、右、上、および下) のそれぞれに最大5 つのコンポーネントを指定できます。API バージョン 30.0 以降で利用できます。

説明データ型項目名コンポーネントの種類を指定します。有効な値は、KnowledgeOne、Lookup、Milestones、RelatedList、お

stringcomponentType

よび Topicsです。この項目は API バージョン 31.0 以降で使用できます。location が top または bottom のコンポーネントで必須です。コンテナ内のコンポーネントの高さ。単位 (ピクセルまたはパーセント) は、unit項目によって決まります。

intheight

310


説明データ型項目名コンソールユーザに表示されるコンポーネントの名前。スタイルがタブまたはアコーディオンのコンテナに含まれるコンポーネントに使用できます。

stringlabel

コンポーネントが参照項目の場合、項目の名前。stringlookup

コンポーネントが Visualforce ページの場合、Visualforce ページの名前。

stringpage

コンポーネントが関連リストの場合、リストの名前。この項目は API バージョン 31.0 以降で使用できます。

RelatedList[]relatedlists

必須。コンテナ内のコンポーネントの高さまたは幅の単位(ピクセルまたはパーセント)。ピクセル値は、ピクセル数 (500など) で、0 より大きく 999より小さい値である必要があります。パーセント値は、パー

stringunit

セント記号を含み (20%など)、0 より大きく、100 より小さい値である必要があります。

location が right または left のコンポーネントで必須です。コンテナ内のコンポーネントの幅。単位 (ピクセルまたはパーセント) は、unit項目によって決まります。

intwidth

RelatedList

Salesforce コンソールのサイドバーにある関連リストのカスタムコンポーネントを表します。APIバージョン 31.0以降で使用できます。

説明データ型項目名trueに設定されている場合、コンポーネントとして表示される関連リストが詳細ページで非表示になり、重複する情報が表示されなくなります。

booleanhideOnDetail

コンソールユーザに表示されるコンポーネントの名前。stringname

SubtabComponents

Salesforce コンソールのサブタブにあるカスタムコンソールコンポーネントを表します。API バージョン 25.0 以降で利用できます。

説明データ型項目名ページレイアウトのセクション上にあるカスタムコンソールコンポーネント (Visualforce ページ、参照項目、または関連

ConsoleComponent[]component

リスト。Force.com Canvas アプリケーションは使用不可) を表します。カスタムコンソールコンポーネントは、Salesforceコンソールにのみ表示されます。この項目は、APIバージョン 29.0 以前で使用できます。Salesforce コンソールのサイドバー上に複数のカスタムコンソールコンポーネントを表示するための場所とスタイルを表

Container[]containers

311


説明データ型項目名します。4 つの場所 (左、右、上、および下) のそれぞれに最大 5 つのコンポーネントを指定できます。この項目は APIバージョン 30.0 以降で使用できます。

FeedLayout

フィードベースのページレイアウトのフィードビューを定義する値を表します。フィードベースのレイアウトは、取引先、ケース、取引先責任者、リード、商談、およびカスタムオブジェクトで使用できます。フィードビューと詳細ビューが含まれます。API バージョン 30.0 以降で利用できます。

説明データ型項目名ページの読み込み時にパブリッシャーを自動的に折りたたむか (true)、否か (false) を指定します。

booleanautocollapsePublisher

レイアウト内でフィード条件リストが含まれる場所。有効な値は、次のとおりです。

FeedLayoutFilterPosition(string 型の列挙)

feedFilterPosition

• centerDropDown — 中央列にドロップダウンリストとして表示。

• leftFixed — 左列に固定リストとして表示。• leftFloat — 左列にフロート表示リストとして表示。

フィード条件リストに表示される個々の条件。FeedLayoutFilter[]feedFilters

フィードをページ上の使用可能な領域いっぱいまで横に展開するか (true)、否か (false) を指定します。

booleanfullWidthFeed

サイドバーが非表示か (true)、否か (false) を示します。booleanhideSidebar

フィードビューの左列に表示される個々のコンポーネント。FeedLayoutComponent[]leftComponents

フィードビューの右列に表示される個々のコンポーネント。FeedLayoutComponent[]rightComponents

FeedLayoutComponent

フィードベースのページレイアウトのフィードビュー内のコンポーネントを表します。APIバージョン 30.0 以降で利用できます。

説明データ型項目名必須。コンポーネントの種類。有効な値は、次のとおりです。

FeedLayoutComponentType(string 型の列挙)

componentType

• HelpAndToolLinks — ページのヘルプトピック、ページレイアウト、およびページの印刷用表示にリンクするアイコン。ケースレイアウトでのみ使用できます。

• CustomButtons — カスタムボタン。• Following — [フォロー] ボタン (レコードを表示してい

るユーザがまだレコードをフォローしていない場合) と[フォロー中] インジケータ (レコードを表示しているユーザがレコードをフォローしている場合) 間で切り替わるアイコン。

312


説明データ型項目名• Followers — レコードをフォローしているユーザのリス

ト。• CustomLinks — カスタムリンク。• Milestones — マイルストントラッカー。これにより、

ユーザはケースのマイルストンの状況を表示できます。ケースレイアウトでのみ使用できます。

• Topics — レコードに関連するトピックのリスト。• Visualforce — カスタム Visualforce コンポーネント。

コンポーネントの高さ (ピクセル単位)。standardComponentsには適用されません。

intheight

カスタムコンポーネントとして使用されている Visualforceページの名前。

stringpage

FeedLayoutFilter

フィードベースのページレイアウトのフィードビュー内のフィード条件オプションを表します。1 つの条件には、standardFilterまたは feedItemTypeセットのみが含まれる必要があります。API バージョン 30.0 以降で利用できます。

説明データ型項目名条件の種別。有効な値は、次のとおりです。FeedLayoutFilterType

(string 型の列挙)feedFilterType

• AllUpdates — レコードに対するすべてのフィード項目を表示します。

• FeedItemType — レコードに対する特定の種別の活動についてのみフィード項目を表示します。

表示するフィード項目の種別。有効な値は、次のとおりです。

stringFeedItemType

• ActivityEvent — ケースに関連付けられている ToDoと行動に対する活動に関連するフィード項目。ケースレイアウトでのみ使用できます。

• AdvancedTextPost – フィードに投稿されたグループへのお知らせに関連するフィード項目。この値は、APIバージョン 31.0 以降で使用できます。

• AnnouncementPost – 使用されません。• ApprovalPost — フィードに送信された承認に関連する

フィード項目。• AttachArticleEvent — ケースへの記事の添付に関連す

る活動に関するフィード項目。ケースレイアウトでのみ使用できます。

• BasicTemplateFeedItem — 使用されません。• CallLogPost — 「活動の記録」アクションからの活動

に関するフィード項目。活動 (ToDo と行動) をサポートするオブジェクトのレイアウトでのみ使用できます。

313


説明データ型項目名• CanvasPost — キャンバスアプリケーションによるフィー

ドへの投稿に関するフィード項目。• CaseCommentPost — 「ケースメモ」アクションからの

活動に関するフィード項目。ケースレイアウトでのみ使用できます。

• ChangeStatusPost — 「状況の変更」アクションからの活動に関するフィード項目。ケースレイアウトでのみ使用できます。

• ChatTranscriptPost — ケースへの Live Agent チャットトランスクリプトの添付に関連する活動に関するフィード項目。ケースレイアウトでのみ使用できます。

• CollaborationGroupCreated — 公開グループの作成に関連するフィード項目。

• CollaborationGroupUnarchived — 使用されません。• ContentPost — 投稿へのファイルの添付に関連する

フィード項目。• CreatedRecordEvent — パブリッシャーからのレコード

の作成に関連するフィード項目。• DashboardComponentSnapshot — フィードへのダッシュ

ボードスナップショットの投稿に関連するフィード項目。• EmailMessageEvent — 「メール」アクションからの活

動に関するフィード項目。ケースレイアウトでのみ使用できます。

• FacebookPost — 使用されません。• LinkPost — 投稿への URL の添付に関連するフィード

項目。• MilestoneEvent — ケースのマイルストンの状況への変

更に関するフィード項目。ケースレイアウトでのみ使用できます。

• PollPost — フィードへのアンケートの投稿に関連するフィード項目。

• ProfileSkillPost — ユーザの Chatter プロファイルに追加されるスキルに関連するフィード項目。この値は、API バージョン 31.0 以降で使用できます。

• QuestionPost — フィードへの質問の投稿に関連するフィード項目。

• ReplyPost — 「ポータル」アクションからの活動に関するフィード項目。ケースレイアウトでのみ使用できます。

• RypplePost — Work.com での感謝バッジの作成に関連するフィード項目。

• SocialPost — 「ソーシャル投稿」アクションからのTwitter での活動に関するフィード項目。

• TextPost — パブリッシャーからのテキスト投稿の作成に関するフィード項目。

314


説明データ型項目名• TrackedChange — 追跡対象の項目に対する単一の変更、

または変更の集合に関連するフィード項目。• UserStatus — 使用されません。

MiniLayout

[コンソール] タブ、詳細のフロート表示、および行動のフロート表示でのレコードのミニビューを表します。

説明データ型項目名ミニレイアウトの項目。UI に表示する順序で表示されます。ここに表示される項目はメインレイアウトに表示されます。

string[]fields

ミニ関連リスト。UI に表示される順序で表示されます。ミニ関連リストでの並び替えは設定できません。ここに表示される項目はメインレイアウトに表示されます。

RelatedListItem[]relatedLists

LayoutSection

LayoutSection は [カスタムリンク] セクションなど、ページレイアウトのセクションを表します。

説明データ型項目名このセクションの表示ラベルがカスタムであるか標準 (組み込み) であるかを示します。カスタム表示ラベルは任意のテ

booleancustomLabel

キストですが、翻訳する必要があります。標準表示ラベルには、「システム情報」など、自動的に翻訳される、定義済みの有効な値セットが含まれます。このセクションを詳細ページに表示するかどうかを制御します。UI では、この設定はセクションの詳細ダイアログのチェックボックスに対応します。

booleandetailHeading

このセクションを編集ページに表示するかどうかを制御します。

booleaneditHeading

表示ラベル。customLabelフラグに基づいて標準またはカスタムのいずれかとなります。

stringlabel

レイアウトの列です。スタイルによって異なります。1 列、2 列、または 3 列が含まれ、左から右に並べられます。

LayoutColumn[]layoutColumns

レイアウトのスタイルは次のとおりです。LayoutSectionStyle(string 型の列挙)

style

• TwoColumnsTopToBottom - 2 列。タブは上から下に並べられます。

• TwoColumnsLeftToRight - 2 列。タブは左から右に並べられます。

• OneColumn - 1 列。• CustomLinks - カスタムリンクのみを含む。

将来の使用のために予約されています。SummaryLayoutsummaryLayout

315


LayoutColumn

LayoutColumn は、レイアウトセクション内の列の項目を表します。

説明データ型項目名列内の個々の項目 (上から下の順序)LayoutItem[]layoutItems

この項目は Salesforce 用に予約されています。この項目は一部の SOAP ライブラリに関する問題を解決します。この項目に入力された値はすべて無視されます。

stringreserved

LayoutItem

LayoutItem は、レイアウト項目を定義する有効な値を表します。項目には、component、customLink、field、scontrol、page、reportChartComponent のいずれか 1 つのみを含める必要があります。

説明データ型項目名項目の動作を決定します。有効な string 値は次のとおりです。

UiBehavior (string 型の列挙)behavior

• Edit — レイアウト項目を編集できますが、必須ではありません。

• Required — レイアウト項目を編集できます。必須です。

• Readonly — レイアウト項目は参照のみです。

キャンバスアプリケーションへの参照。この項目は API バージョン 31.0 以降で使用できます。

stringcanvas

コンポーネントへの参照。値はsfa:socialCardである必要があります。この項目は API バージョン 30.0 以降で使用できます。これは、RelatedContentItem内で

stringcomponent

のみ使用できます。sfa:socialCardは、取引先責任者、取引先、およびリードのページレイアウトでのみサポートされます。

customLinkの参照。これは、CustomLink

layoutSection内でのみ使用できます。stringcustomLink

このレイアウト項目が空白スペースであるかどうかを制御します。

booleanemptySpace

Descriptionまたは MyField__cなどのレイアウトオブジェクトを基準にした項目名の参照。

stringfield

ピクセル単位の高さ (Sコントロールおよびページのみ)。

intheight

316


説明データ型項目名Visualforce ページへの参照。stringpage

標準またはカスタムオブジェクトページに追加できるレポートグラフを参照します。

ReportChartComponentLayoutItemreportChartComponent

Sコントロールへの参照。stringscontrol

表示ラベルを表示するかどうか (Sコントロールおよびページのみ)。

booleanshowLabel

スクロールバーを表示するかどうか (Sコントロールおよびページのみ)。

booleanshowScrollbars

ピクセルまたはパーセント単位の幅 (Sコントロールおよびページのみ)。ピクセル値は 500

stringwidth

など、単なるピクセル数です。パーセント値には、20%などのようにパーセント記号を含める必要があります。

ReportChartComponentLayoutItem

標準ページまたはカスタムページのレポートグラフの設定を示します。

説明データ型項目名グラフを表示するときにキャッシュデータを使用するかどうかを示します。属性が trueに設定されている場合、データ

booleancacheData

は 24 時間キャッシュされます。属性が falseに設定されている場合、ページが更新されるたびにレポートが実行されます。この項目は API バージョン 29.0 以降で使用できます。

レポートグラフを絞り込んでページに関連するデータを返すために使用する項目の一意の開発名。これを設定すると、

stringcontextFilterableField

ページの親オブジェクトまたはレポートタイプの親オブジェクトの ID 項目によってグラフデータが絞り込まれます。グラフが関連データを返すようにするには、レポートタイプの親オブジェクトとページの親オブジェクトが一致する必要があります。基本となるレポートでエラーが発生した場合にのみ入力されるエラー文字列。この項目は API バージョン 31.0 以降で使用できます。

stringerror

エラーのあるグラフをユーザに表示するかどうかを制御します。エラーがあり、この属性が設定されていない場合、グラ

booleanhideOnError

フにはエラー以外のデータは表示されません。エラーはさまざまな理由で発生します。たとえば、グラフで使用する項目へのアクセス権がユーザにない場合や、グラフがレポートから削除された場合などがあります。エラー時にページでグラフを非表示にするには、この属性を trueに設定します。

317


説明データ型項目名この項目は API バージョン 29.0 以降で使用できます。

trueの場合、レポートグラフが絞り込まれて、ページに関連するデータが返されます。

booleanincludeContext

グラフを含むレポートの一意の開発名。stringreportName

trueの場合、レポートからグラフにタイトルが適用されます。

booleanshowTitle

値が指定されていない場合、グラフサイズは中になります。有効な値は次のとおりです。

ReportChartComponentSize


size

• SMALL

• MEDIUM

• LARGE

QuickActionList

QuickActionList はページレイアウトに関連付けられたアクションのリストを表します。API バージョン 28.0 以降で利用できます。

説明データ型項目名0 個以上の QuickActionList オブジェクトの配列。QuickActionListItem[]quickActionListItems

QuickActionListItem

QuickActionListItem は QuickActionList リストのアクションを表します。API バージョン 28.0 以降で利用できます。

説明項目のデータ型項目名アクションの API 名。stringquickActionName

RelatedContent

RelatedContent は、ページレイアウトの [モバイルカード] セクションを示します。API バージョン 29.0 以降で使用できます。

説明項目のデータ型項目名ページレイアウトの [モバイルカード] セクションにあるレイアウト項目のリスト。

RelatedContentItem[]relatedContentItems

RelatedContentItem

RelatedContentItem は、RelatedContentItem リストの個々の項目を表します。API バージョン 29.0 以降で利用できます。

説明項目のデータ型項目名[モバイルカード] セクションの個々の LayoutItem。LayoutItemlayoutItem

318


RelatedListItem

RelatedListItem はページレイアウトの関連リストを表します。

説明データ型項目名関連リストで使用するカスタムボタンのリスト。詳細は、Salesforce オンラインヘルプの「カスタムボタンとリンクの定義」を参照してください。

string[]customButtons

除外される関連リストのボタンのリスト。string[]excludeButtons

関連リストで表示される項目のリスト。関連リストの標準項目の取得では、API名ではなく項目の別名が使用されます。たとえば、[Fax]、[携帯]、および [自

string[]fields

宅電話]項目は、Phone2、Phone3、および Phone4 としてそれぞれ取得されます。

必須。関連リストの名前。stringrelatedList

並び替えに使用される項目の名前。stringsortField

sortFieldが設定されている場合、sortOrder項目が並び替え順を決定します。

SortOrder (string 型の列挙)

sortOrder

• Asc - 昇順での並び替え• Desc - 降順での並び替え

SummaryLayout

ケースフィードが有効化されているときにページレイアウト上部のグリッドでキー項目を集計する、強調表示パネルの外観を制御します。API バージョン 25.0 以降で利用できます。

説明項目のデータ型項目名必須。レイアウト表示ラベルの名前。stringmasterLabel

必須。強調表示パネルの列数。1 ～ 4 (この値は範囲に含まれる) である必要があります。

intsizeX

必須。各列の行数。1 または 2 である必要があります。intsizeY

将来の使用のために予約されています。指定されている場合、設定内容はユーザに表示されません。

intsizeZ

ケースフィードが有効化されているときに、個々の項目の外観および強調表示パネルのグリッド内の列と行の位置を制御します。少なくとも 1 つは必須項目です。

SummaryLayoutItem[]summaryLayoutItems

強調表示パネルのスタイル。有効な string 値は次のとおりです。

SummaryLayoutStyle(string 型の列挙)

summaryLayoutStyle

• Default• QuoteTemplate• DefaultQuoteTemplate• CaseInteraction

319


説明項目のデータ型項目名• QuickActionLayoutLeftRight (API バージョン 28.0 以降で

使用可能)• QuickActionLayoutTopDown (API バージョン 28.0 以降で

使用可能)

SummaryLayoutItem

ケースフィードが有効化されているときに、個々の項目の外観および強調表示パネルのグリッド内の列と行の位置を制御します。強調表示パネルのグリッドごとに 2 つの項目を指定できます。APIバージョン 25.0 以降で利用できます。

説明項目のデータ型項目名項目がカスタムリンクの場合は、customLinkが参照先です。

stringcustomLink

ページレイアウトを基準にした項目名の参照。詳細ページにも存在する標準項目またはカスタム項目である必要があります。

stringfield

必須。強調表示パネルのグリッドにおける項目の列の位置。sizeXの範囲内である必要があります。

intposX

必須。強調表示パネルグリッドにおける項目の行の位置。sizeYの範囲内である必要があります。

intposY

将来の使用のために予約されています。指定されている場合、設定内容はユーザに表示されません。

intposZ

宣言的なメタデータの定義のサンプルページレイアウトの定義を次に示します。


<customConsoleComponents><primaryTabComponents>

<container><region>left</region><style>Stack</style><unit>Pixel</unit><width>101</width><sidebarComponent>

<width>60</width><page>simplepage1</page><unit>Percentage</unit>

</sidebarComponent><sidebarComponent>

<width>40</width><page>Hello_World</page><unit>Percentage</unit>

</sidebarComponent></container>

</primaryTabComponents><subtabComponents>

<component><location>top</location>

320


<visualforcePage>ConsoleComponentPage2</visualforcePage><height>200</height>

</component></subtabComponents></customConsoleComponents><customButtons>ButtonLink</customButtons><layoutSections>

<editHeading>true</editHeading><label>Information</label><layoutColumns>

<layoutItems><behavior>Required</behavior><field>Name</field>


<height>180</height><scontrol>LayoutSControl</scontrol><showLabel>true</showLabel><showScrollbars>true</showScrollbars><width>50%</width>


<reportChartComponent><contextFilterableField>CUST_ID</contextFilterableField><includeContext>true</includeContext><reportName>Open_Accounts_by_Cases</reportName><showTitle>false</showTitle><size>LARGE</size>

<reportChartComponent></layoutItems>

</layoutColumns><layoutColumns>

<layoutItems><behavior>Edit</behavior><field>OwnerId</field>


<behavior>Edit</behavior><field>CurrencyIsoCode</field>

</layoutItems></layoutColumns><style>TwoColumnsTopToBottom</style>


<editHeading>true</editHeading><label>System Information</label><layoutColumns>

<layoutItems><behavior>Readonly</behavior><field>CreatedById</field>


<behavior>Readonly</behavior><field>Alpha1__c</field>


<height>200</height><page>mcanvasPage</page><showLabel>true</showLabel><showScrollbars>false</showScrollbars><width>100%</width>

</layoutItems></layoutColumns><layoutColumns>

<layoutItems><behavior>Readonly</behavior><field>LastModifiedById</field>


321


<behavior>Edit</behavior><field>TextArea__c</field>



<customLabel>true</customLabel><detailHeading>true</detailHeading><label>Custom Links</label><layoutColumns>

<layoutItems><customLink>CustomWebLink</customLink>

</layoutItems></layoutColumns><style>CustomLinks</style>

</layoutSections><quickActionList>

<quickActionListItems><quickActionName>FeedItem.TextPost</quickActionName>

</quickActionListItems><quickActionListItems>

<quickActionName>FeedItem.ContentPost</quickActionName></quickActionListItems><quickActionListItems>

<quickActionName>FeedItem.LinkPost</quickActionName></quickActionListItems><quickActionListItems>

<quickActionName>FeedItem.PollPost</quickActionName></quickActionListItems>

</quickActionList><relatedContent>

<relatedContentItems><layoutItem>

<component>sfa:socialPanel</component></layoutItem>

<relatedContentItems></relatedContent><miniLayoutFields>Name</miniLayoutFields><miniLayoutFields>OwnerId</miniLayoutFields><miniLayoutFields>CurrencyIsoCode</miniLayoutFields><miniLayoutFields>Alpha1__c</miniLayoutFields><miniLayoutFields>TextArea__c</miniLayoutFields><miniRelatedLists>

<relatedList>RelatedNoteList</relatedList></miniRelatedLists><relatedLists>

<fields>StepStatus</fields><fields>CreatedDate</fields><fields>OriginalActor</fields><fields>Actor</fields><fields>Comments</fields><fields>Actor.Alias</fields><fields>OriginalActor.Alias</fields><relatedList>RelatedProcessHistoryList</relatedList>

</relatedLists><relatedLists>

<relatedList>RelatedNoteList</relatedList></relatedLists>

</Layout>

<summaryLayout>を使用したレイアウトの例を次に示します。


<layoutSections><editHeading>true</editHeading>

322


<label>System Information</label><layoutColumns>

<layoutItems><behavior>Readonly</behavior><field>CreatedById</field>


<behavior>Required</behavior><field>Name</field>

</layoutItems></layoutColumns><layoutColumns>

<layoutItems><behavior>Readonly</behavior><field>LastModifiedById</field>


</layoutSections><summaryLayout>

<masterLabel>Great Name</masterLabel><sizeX>4</sizeX><sizeY>2</sizeY><summaryLayoutItems>

<posX>0</posX><posY>0</posY><field>Name</field>

</summaryLayoutItems></summaryLayout>

</Layout>

フィードベースのレイアウトの例を次に示します。

<Layout>...

<feedLayout><leftComponents>

<componentType>customLinks</componentType></leftComponents><rightComponents>

<componentType>follow</componentType></rightComponents><rightComponents>

<componentType>followers</componentType></rightComponents><rightComponents>

<componentType>visualforce</componentType><page>accountCustomWidget</page><height>200</height>

</rightComponents><hideSidebar>true</hideSidebar><feedFilterPosition>centerDropDown</feedFilterPosition><feedFilters>

<feedFilerType>allUpdates</feedFilerType></feedFilters><feedFilters>

<feedFilerType>feedItemType</feedFilerType><feedItemType>CallLogPost</feedItemType>

</feedFilters><feedFilters>

<feedFilerType>feedItemType</feedFilerType><feedItemType>TextPost</feedItemType>

</feedFilters></feedLayout>

...</Layout>

323


Letterheadメールテンプレートのレターヘッドの書式設定オプションを表します。レターヘッドは、HTML メールテンプレートのデザインを定義します。レターヘッドからは、使用するロゴ、ページの色、およびテキスト設定をHTML メールテンプレートに継承できます。詳細は、Salesforce オンラインヘルプの「レターヘッドの作成」を参照してください。Metadata メタデータ型を拡張し、その fullName項目を継承します。

ファイルのサフィックスおよびディレクトリの場所レターヘッドのファイルのサフィックスは .letterで、コンポーネントは対応するパッケージディレクトリのletterheadディレクトリに保存されます。

バージョンレターヘッドは、API バージョン 12.0 以降で使用できます。

項目ロゴ、横位置および縦位置の配置を除き、これらのすべての項目が必須です。

説明データ型項目名必須。メールテンプレート内など、このレターヘッドを使用できるか (true)、否か (false) を示します。

booleanavailable

必須。背景色。#FF6600などの 16 進数で指定します。

stringbackgroundColor

必須。本文の色。16 進数で指定します。stringbodyColor

必須。下部区切り線のスタイル。使用できるスタイルの値は次のとおりです。

LetterheadLine (string 型の列挙)bottomLine

• color。線の色。string値として 16 進数で指定します。

• height。線の高さ。int値として指定します。

このレターヘッドが他のレターヘッドとどのように異なるかを説明したテキスト。

stringdescription

nameに基づくレターヘッドの内部名。ただし、有効性のために空白文字と特殊文字はエスケープ処理されます。

stringfullName

必須。フッターのスタイル。LetterheadHeaderFooterfooter

必須。ヘッダーのスタイル。LetterheadHeaderFooterheader

必須。レターヘッドの中間にある境界線のスタイル。使用できるスタイルの値は次のとおりです。

LetterheadLinemiddleLine



324

Letterheadメタデータ型

説明データ型項目名必須。レターヘッドの名前。stringname

必須。ヘッダーの下の上部区切り横線のスタイル。使用できるスタイルの値は次のとおりです。

LetterheadLinetopLine



LetterheadHeaderFooter

LetterheadHeaderFooter ではヘッダーまたはフッターのプロパティを表します。

説明データ型項目必須。ヘッダーまたはフッターの背景色。16 進形式で指定します。

stringbackgroundColor

必須。ヘッダーまたはフッターの高さ。DashboardComponent[]height

ヘッダーまたはフッターの横方向の配置。有効な値は、次のとおりです。

LetterheadHorizontalAlignment(string 型の列挙)

horizontalAlignment

• None

• Left

• Center

• Right

MyFolder/MyDocument.gifなどのドキュメントへの参照であるロゴ。

stringlogo

ヘッダーまたはフッターの縦方向の配置。有効な値は、次のとおりです。

LetterheadVerticalAlignment(string 型の列挙)

verticalAlignment

• None

• Top

• Middle

• Bottom

LetterheadLine

LetterheadLine は線のプロパティを表します。

説明データ型項目必須。線の色。16 進形式で指定します。stringcolor

必須。線の高さ。intheight


<?xml version="1.0" encoding="UTF-8"?><Letterhead xmlns="http://soap.sforce.com/2006/04/metadata">

<available>true</available>

325

Letterheadメタデータ型

<backgroundColor>#CCCCCC</backgroundColor><bodyColor>#33FF33</bodyColor><bottomLine>

<color>#3333FF</color><height>5</height>

</bottomLine><description>INITIAL</description><footer>

<backgroundColor>#FFFFFF</backgroundColor><height>100</height><horizontalAlignment>Left</horizontalAlignment><verticalAlignment>Top</verticalAlignment>

</footer><header>

<backgroundColor>#FFFFFF</backgroundColor><height>100</height><horizontalAlignment>Left</horizontalAlignment><verticalAlignment>Top</verticalAlignment>

</header><middleLine>

<color>#AAAAFF</color><height>5</height>

</middleLine><name>SimpleLetterheadLabel</name><topLine>

<color>#FF99FF</color><height>5</height>

</topLine></Letterhead>

LiveChatAgentConfigエージェントに割り当て可能なチャット数や、チャットサウンドを有効化するかどうかなど、組織の Live Agentリリースの設定を表します。Metadata メタデータ型を拡張し、その fullName項目を継承します。

ファイルのサフィックスおよびディレクトリの場所LiveChatAgentConfig設定は、liveChatAgentConfigsディレクトリの<developer_name>.liveChatAgentConfig

ファイルで参照されます。

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

項目

説明項目のデータ型項目名Live Agent ユーザへのエージェント設定の割り当て方法を指定します。エージェント設定は、ユー

AgentConfigAssignmentsassignments

ザのセットまたはプロファイルのセットに割り当てることができます。エージェントとのチャットの開始時に顧客に表示される挨拶を指定します。

stringautoGreeting

エージェントが一度に参加できるチャットの最大数を指定します。

intcapacity

326

LiveChatAgentConfigメタデータ型

説明項目のデータ型項目名チャットタブが点滅して、参加しているチャットに回答するように注意が促されるまでに、エージェ

intcriticalWaitTime

ントが回答するまでに待機できる秒数を指定します。エージェントがメッセージを顧客に送信する前にスーパーバイザがその内容を確認できるか (true)、否か (false) を示します。

booleanenableAgentSneakPeek

エージェントが顧客とのチャットに参加しないときに、エージェントを「退席中」として表示するか (true)、否か (false) を示します。

booleanenableAutoAwayOnDecline

エージェントのファイル転送が有効か (true)、否か (false) を示します。API バージョン 31.0 以降で使用できます。

booleanenableAgentFileTransfer

エージェントのチャット転送が有効か (true)、否か (false) を示します。API バージョン 31.0 以降で使用できます。

booleanenableChatTransfer

エージェントが Live Agent からログアウトするときに、音を鳴らすか (true)、否か (false) を示します。

booleanenableLogoutSound

受信チャット通知をエージェントに表示するか(true)、否か (false) を示します。

booleanenableNotifications

顧客がエージェントとのチャットを要求するときに、音を鳴らすか (true)、否か (false) を示します。

booleanenableRequestSound

顧客のメッセージのプレビューをエージェントのLive Agent ウィンドウに顧客タイプとして表示す

booleanenableSneakPeek

るか (true)、否か (false) を示します。API バージョン 29.0 以降で利用できます。エージェントのデフォルトのチャット設定の名前を指定します。

stringlabel

スーパーバイザパネルの [エージェント状況] リストを絞り込むための Live Agent の状況を指定します。有効な値は、次のとおりです。

SupervisorAgentStatusFilter(string 型の列挙)

supervisorDefaultAgentStatusFilter

• オンライン• Away

• オフライン

API バージョン 29.0 以降で利用できます。

スーパーバイザパネルの [エージェント状況] リストを絞り込むためのデフォルトのボタンを指定します。API バージョン 29.0 以降で利用できます。

stringsupervisorDefaultButtonFilter

327


説明項目のデータ型項目名スーパーバイザパネルの [エージェント状況] リストを絞り込むためのデフォルトのスキルを指定します。API バージョン 29.0 以降で利用できます。

stringsupervisorDefaultSkillFilter

割り当て済みの Live Agent 設定で指定されたとおりに、スーパーバイザに割り当てられるエージェ

SupervisorAgentConfigSkillssupervisorSkills

ントスキルを指定します。API バージョン 29.0 以降で利用できます。エージェントがチャットの転送先にできるチャットボタンのリストを指定します。API バージョン31.0 以降で使用できます。

AgentConfigButtonstransferableButtons

エージェントがチャットの転送先にできるスキルグループのリストを指定します。API バージョン31.0 以降で使用できます。

AgentConfigSkillstransferableSkills

AgentConfigAssignments

組織のプロファイルとユーザの Live Agent 設定への割り当てを表します。

項目

説明項目のデータ型項目名特定のエージェント設定に関連付けられたプロファイルを指定します。

AgentConfigProfileAssignmentsprofiles

特定のエージェント設定に関連付けられたユーザを指定します。

AgentConfigUserAssignmentsusers

AgentConfigButtons

Live Agent 設定に関連付けられているエージェントが、チャットの転送先にできるチャットボタンを表します。

項目

説明項目のデータ型項目名エージェントがチャットの転送先にできるチャットボタンを指定します。

string[]button

AgentConfigProfileAssignments

特定の Live Agent 設定に関連付けられたプロファイルを表します。

項目

説明項目のデータ型項目名特定のエージェント設定に関連付けられたプロファイルのカスタム名を指定します。

stringprofile

328


AgentConfigSkills

Live Agent 設定に関連付けられているエージェントが、チャットの転送先にできるスキルグループを表します。

項目

説明項目のデータ型項目名エージェントがチャットの転送先にできるスキルグループを指定します。

string[]skill

AgentConfigUserAssignments

特定の Live Agent 設定に関連付けられたユーザを表します。

項目

説明項目のデータ型項目名特定のエージェント設定に関連付けられたユーザのユーザ名を指定します。

stringuser

SupervisorAgentConfigSkills

スーパーバイザのLive Agent設定に関連付けられたエージェントスキルを表します。API バージョン 29.0 以降で利用できます。

項目

説明項目のデータ型項目名スーパーバイザパネルの [エージェント状況] リストを絞り込むことができるエージェントスキルを指定します。

stringskill

宣言的なメタデータの定義のサンプルこれは、liveChatAgentConfigファイルのサンプルです。

<?xml version="1.0" encoding="UTF-8"?><LiveChatAgentConfig xmlns="http://soap.sforce.com/2006/04/metadata">

<label>My Agent Configuration 1</label><autoGreeting>Hi, how can I help you?</autoGreeting><capacity>5</capacity><enableAutoAwayOnDecline>true</enableAutoAwayOnDecline><enableLogoutSound>true</enableLogoutSound><enableNotifications>true</enableNotifications><enableRequestSound>true</enableRequestSound><enableSneakPeek>true</enableSneakPeek><assignments>

<profiles><profile>standard</profile>

</profiles><users>

<user>[email protected]</user></users>

329


</assignments></LiveChatAgentConfig>

LiveChatButtonボタンの表示ラベルやライブチャットの開始前に表示されるチャット前フォームなど、エージェントとチャットするために顧客がクリックするボタンやチャットウィンドウの Live Agent リリースの設定を表します。Metadataメタデータ型を拡張し、その fullName項目を継承します。

ファイルのサフィックスおよびディレクトリの場所LiveChatButton設定は、liveChatButtonsディレクトリの<developer_name>.liveChatButtonファイルに保存されます。

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

項目

説明項目のデータ型項目名ページがLive Agentチャットウィンドウと異なる場合に、チャットをホストするページを指定します。

stringchatPage

キューが有効化されているか (true)、否か (false) を示します。

booleanenableQueue

ボタンに表示するテキストを指定します。

stringlabel

すべてのエージェントがチャット要求を拒否した場合に、対応可能なエージェン

intnumberOfReroutingAttempts

トにチャット要求を再転送できる回数を指定します。この項目は、API バージョン 30.0 以降で使用できます。エージェントがチャットに対応できない場合にボタンに表示する画像を指定します。

stringofflineImage

エージェントがチャットに対応できる場合にボタンに表示する画像を指定します。

stringonlineImage

受信チャット要求のカスタム転送が有効か (true)、否か (false) を示します。こ

booleanoptionsCustomRoutingIsEnabled

の項目は、API バージョン 30.0 以降で使用できます。

330

LiveChatButtonメタデータ型

説明項目のデータ型項目名顧客が以前のチャット招待を受諾した後に、新しいチャット招待をトリガするか(true)、否か (false) を示します。

booleanoptionsHasInviteAfterAccept

顧客が以前のチャット招待を辞退した後に、新しいチャット招待をトリガするか(true)、否か (false) を示します。

booleanoptionsHasInviteAfterReject

すべての対応可能なエージェントから拒否されたチャット要求を、対応可能な

booleanoptionsHasRerouteDeclinedRequest

エージェントに再転送する必要があるか(true)、否か (false) を示します。この項目は、API バージョン 30.0 以降で使用できます。チャット要求を割り当てられたエージェントが、チャット要求を自動的に受け入

booleanoptionsIsAutoAccept

れる必要があるか (true)、否か (false)を示します。[[チャット] ボタンおよび自動招待] で、routingTypeがMostAvailableまたは LeastActiveに設定されている場合。この項目は、APIバージョン 30.0 以降で使用できます。特定の時間が経過した後に、チャット招待が自動的に顧客の画面から消えるよう

booleanoptionsIsInviteAutoRemove

に設定するか (true)、否か (false) を示します。キューに許可されるチャット要求の最大数を指定します。

intoverallQueueLength

必要なスキルを持つエージェントに対してキューが許可されるチャット要求の最大数を指定します。

intperAgentQueueLength

チャットの終了時に顧客が転送されるチャット後フォームの名前を指定します。

stringpostChatPage

チャットの終了時に顧客が転送されるチャット後フォームの URL を指定します。

stringpostChatUrl

チャットの開始前に顧客が転送されるチャット前フォームの名前を指定します。

stringpreChatFormPage

チャットの開始時に顧客が転送されるチャット前フォームの URL を指定します。

stringpreChatFormUrl

331


説明項目のデータ型項目名チャット要求が別のエージェントに転送されるまでに、エージェントが受信

intpushTimeOut

チャット要求への回答に費やすことのできる秒数を指定します。顧客がボタンを押したときに受信チャットをエージェントに転送する方法を指定します。有効な値は、次のとおりです。

LiveChatButtonRoutingType (string 型の列挙)

routingType

• Choice

• LeastActive

• MostAvailable

カスタムチャットボタンの画像またはカスタムチャットページをホストするForce.com サイトを指定します。

stringsite

メモ: Live Agent で Force.com サイトを使用するには、組織で「CustomDomain」権限が有効化されている必要があります。

ボタンに関連付けられたスキルを指定します。チャットするために顧客がボタン

LiveChatButtonSkillsskills

をクリックすると、そのスキルを持つエージェントに自動的に転送されます。ボタンに関連付けられたチャットウィンドウの言語設定を指定します。

LanguagewindowLanguage

LiveChatButtonSkills

チャットボタンに関連付けられたスキルを表します。

項目

説明項目のデータ型項目名スキルの名前を指定します。stringskill

宣言的なメタデータの定義のサンプルこれは、liveChatButtonファイルのサンプルです。

<?xml version="1.0" encoding="UTF-8"?><LiveChatButton xmlns="http://soap.sforce.com/2006/04/metadata">

<label>My Button 1</label><chatPage>ChatterAnswersLogin</chatPage><enableQueue>true</enableQueue><offlineImage>MyOfflineButton</offlineImage><onlineImage>MyOnlineButton</onlineImage><perAgentQueueLength>5</perAgentQueueLength>

332


<postchatPage>AnswersHome</postchatPage><prechatFormPage>AccountVF</prechatFormPage><pushTimeOut>300</pushTimeOut><routingType>LeastActive</routingType><site>LiveAgentSite</site><skills>

<skill>Skill1</skill><skill>Skill2</skill>

</skills></LiveChatButton>

メモ: メタデータ API を使用してチャットボタンを更新する場合、必ず同じチャットボタンコードを使用するすべての Web ページを更新してください。

LiveChatDeploymentリリースのブランド画像や、チャットのトランスクリプトを自動的に保存するかどうかなど、特定の Live Agentリリースの設定を表します。Metadata メタデータ型を拡張し、その fullName項目を継承します。

ファイルのサフィックスおよびディレクトリの場所LiveChatDeploymentの値は、liveChatDeploymentsディレクトリの <developer_name>.liveChatDeployment

ファイルに保存されます。

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

項目

説明項目のデータ型項目名リリースのブランド画像を指定します。stringbrandingImage

リリースをホストできるドメインのリストを指定します。

LiveChatDeploymentDomainWhiteListdomainWhiteList

リリースのチャット前 API が有効になっているか (true)、否か (false) を示します。

booleanenablePrechatApi

チャットの終了後にチャットのトランスクリプトを自動的に保存するか(true)、否か (false) を示します。

booleanenableTranscriptSave

リリースの名前を指定します。stringlabel

顧客がモバイルデバイスからリリースにアクセスするときに表示される、リリースのブランド画像を指定します。

stringmobileBrandingImage

333

LiveChatDeploymentメタデータ型

説明項目のデータ型項目名リリースの画像をホストするサイトを指定します。

stringsite

メモ: Live Agent で Force.comサイトを使用するには、組織で「CustomDomain」権限が有効化されている必要があります。

リリースに関連付けられたウィンドウのタイトルを指定します。

stringwindowTitle

LiveChatDeploymentDomainWhiteList

Live Agent リリースのドメインホワイトリストを表します。

項目

説明項目のデータ型項目名リリースをホストできるドメインを指定します。stringdomain

宣言的なメタデータの定義のサンプルこれは、liveChatDeploymentファイルのサンプルです。

<?xml version="1.0" encoding="UTF-8"?><LiveChatDeployment xmlns="http://soap.sforce.com/2006/04/metadata">

<label>My Deployment 1</label><brandingImage>pkb_image_bannerBg</brandingImage><mobileBrandingImage>pkb_image_bgBottom</mobileBrandingImage><domainWhiteList>

<domain>mydomain</domain><domain>test</domain>

</domainWhiteList><enableTranscriptSave>true</enableTranscriptSave><site>GL_Knowledge_Base</site><windowTitle>My window title</windowTitle>

</LiveChatDeployment>

メモ: メタデータ API を使用してリリースを更新する場合、必ず同じリリースコードを使用するすべての Web ページを更新してください。

Metadataこれはすべてのメタデータ型の基本クラスです。このオブジェクトを編集することはできません。コンポーネントは、メタデータ型のインスタンスです。Metadata は、すべての標準オブジェクトを表す sObject に類似しています。Metadata は、メタデータ API ですべてのコンポーネントと項目を表します。各コンポーネントを ID で識別するのではなく、各カスタムオブジェクトまたはカスタム項目には一意のfullNameがあります。この名前は、Salesforceユーザインターフェースでカス

334

Metadataメタデータ型

タムオブジェクトやカスタム項目を作成するときのために、標準オブジェクト名とは異なるものにする必要があります。

バージョンMetadata コンポーネントは、API バージョン 10.0 以降で使用できます。

項目

説明データ型項目名必須。コンポーネントの名前。項目の場合、名前には親オブジェクトを指定する必要があります。たとえば、

stringfullName

Account.FirstNameなどです。fullNameを設定する場合は、__c サフィックスをカスタムオブジェクト名とカスタム項目名に付加する必要があります。たとえば、カスタムオブジェクトのカスタム項目では fullNameがMyCustomObject__c.MyCustomField__cのようになります。

関連リンクCustomObjectCustomFieldMetadataWithContent

MetadataWithContentこれは、ドキュメントまたはメールテンプレートなどのコンテンツが含まれるすべてのメタデータ型の基本型で、Metadata を拡張します。このオブジェクトを編集することはできません。

バージョンMetadataWithContent コンポーネントは、API バージョン 14.0 以降で使用できます。

項目

説明データ型項目名Base 64 で符号化されたバイナリデータ API コールを行う前に、クライアントアプリケーションはバイナリ添付データを

base64Binarycontent

base64 に符号化する必要があります。応答を受信したら、クライアントアプリケーションは、base64 データをバイナリに復号化する必要があります。この変換は、通常 SOAP クライアントによって処理されます。必須。コンポーネントの名前。fullNameには、アンダースコアと英数字のみを使用できます。一意であること、最初は

stringfullName

文字であること、空白は使用しない、最後にアンダースコア

335

MetadataWithContentメタデータ型

説明データ型項目名を使用しない、2 つ続けてアンダースコアを使用しないという制約があります。この項目はMetadata コンポーネントから継承するため、この項目はこのコンポーネントの WSDL で定義されません。作成時、更新時、または削除時に指定する必要があります。コールにおけるこの項目の例を確認するには、「create()」を参照してください。

関連リンクMetadata

MilestoneTypeマイルストンの名前と説明を表します。これらをエンタイトルメントプロセスで使用して、ケースの重要なステップを追跡できます。Metadata メタデータ型を拡張し、その fullName項目を継承します。

ファイルのサフィックスおよびディレクトリの場所マイルストンタイプは、対応するパッケージディレクトリのmilestoneTypesディレクトリに保存されます。拡張子は .milestoneTypeです。

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

項目

説明項目のデータ型項目名マイルストンの説明。stringdescription

マイルストンの繰り返しのタイプ。API バージョン 29.0 以降で利用できます。有効な値は、次のとおりです。

MilestoneTypeRecurrenceType

(string 型の列挙)RecurrenceType

• none — マイルストンの繰り返しがないことを指定します。マイルストンは、エンタイトルメントプロセスが終了するまでに 1 回のみ発生します。

• recursIndependently — マイルストンが独立して繰り返すことを指定します。

• recursChained — マイルストンが順次繰り返すことを指定します。

336

MilestoneTypeメタデータ型

宣言的なメタデータの定義のサンプルこれは、マイルストンタイプのサンプルです。

<?xml version="1.0" encoding="UTF-8"?><MilestoneType xmlns="http://soap.sforce.com/2006/04/metadata">

<description>First Response Time</description></MilestoneType>

MilestoneType コンポーネント定義を参照するサンプルの package.xmlファイルを次に示します。


<types><members>* or a valid name of a milestone type</members><name>MilestoneType</name>


</Package>

Networkコミュニティを表します。コミュニティとは、従業員、顧客、パートナーがつながることのできるブランド空間です。ビジネスニーズに合ったコミュニティを複数カスタマイズおよび作成し、コミュニティ間をシームレスに移行できます。Salesforce Communities には Network コンポーネントを使用します。Chatter アンサーおよびアイデアを含むゾーンを作成する場合は、Community (Zone) コンポーネントを使用します。Metadata メタデータ型を拡張し、その fullName項目を継承します。

宣言的なメタデータファイルのサフィックスおよびディレクトリの場所Network コンポーネントは、対応するパッケージディレクトリの networksディレクトリに保存されます。ファイル名はコミュニティ名に一致し、拡張子は .networkです。

バージョンこのオブジェクトは、API バージョン 28.0 以降で使用できます。

項目

説明項目のデータ型項目コミュニティのユーザが投稿またはコメントを不適切としてフラグ付けできるかどうかを決定

booleanallowMembersToFlag

します。フラグが付けられた項目は、レビューのためにコミュニティモデレータに送信されます。API バージョン 29.0 以降で利用できます。コミュニティで使用する配色、ヘッダー、フッター。

Brandingbranding

ケースコメントがケースに追加されたか変更された場合に、コミュニティメンバーに通知するときに使用されるメールテンプレート。

stringcaseCommentEmailTemplate

337

Networkメタデータ型

説明項目のデータ型項目パスワードがリセットされたことをユーザに通知するときに使用されるメールテンプレート。

stringchangePasswordTemplate

コミュニティの説明。stringdescription

コミュニティメールの送信元となるメールアドレス。

stringemailSenderAddress

コミュニティメールの送信元となる名前。stringemailSenderName

ゲストユーザがログインせずにコミュニティの公開 Chatter グループにアクセスできるかどうかを指定します。

booleanenableGuestChatter

ユーザが他のユーザをコミュニティに招待できるかどうかを指定します。

booleanenableInvitation

コミュニティメンバーが、トピックに関する知識のあるユーザを表示し、その知識についてユー

booleanenableKnowledgeable

ザを支持できるかどうかを決定します。API バージョン 30.0 以降で使用できます。コミュニティメンバーが非公開メッセージを送受信できるかどうかを決定します。API バージョン 30.0 以降で使用できます。

booleanenablePrivateMessages

コミュニティのメンバーに対する評価が計算および表示されるかどうかを決定します。API バージョン 31.0 以降で使用できます。有効な場合、reputationLevelsとreputationPointsRulesが使用されます。デー

booleanenableReputation

タファイルに reputationLevelsとreputationPointsRulesのどちらも定義されていない場合、デフォルト値が使用されます。

ユーザがパスワードを忘れたときに使用されるメールテンプレート。

stringforgotPasswordTemplate

コミュニティへのアクセス権を持つプロファイルおよび権限セット。これらのプロファイルま

NetworkMemberGroupsnetworkMemberGroups

たは権限セットを持つユーザは、コミュニティのメンバーです。

メモ: コミュニティにも関連付けられている権限セットが (顧客グループの)Chatter顧客に割り当てられている場合、その Chatter 顧客はコミュニティに追加されません。

EmailSenderAddressの新しい値として入力され、まだ未確認のメールアドレス。ユーザが送

stringnewSenderAddress

信元メールアドレスの変更を要求し、確認メー

338


説明項目のデータ型項目ルに正常に応答すると、NewSenderAddressの値でEmailSenderAddressの値が上書きされます。これが、コミュニティメールの送信元メールアドレスになります。コミュニティにリンクしている Site.com サイトの名前。

stringpicassoSite

メンバーが特定のアクションを実行してポイントを獲得したときに、メンバーに割り当てられる評価レベル。

ReputationLevelDefinitionsreputationLevels

メンバーが特定の定義済みアクションを実行したときに獲得するポイント。

ReputationPointsRulesreputationPointsRules

セルフ登録するユーザに割り当てられるプロファイル。この値は、コミュニティで

stringselfRegProfile

selfRegistrationが有効になっている場合にのみ使用されます。API バージョン 29.0 以降で利用できます。コミュニティでセルフ登録が可能かどうかを指定します。

booleanselfRegistration

新しいユーザがコミュニティに追加されたときに、お知らせメールを送信するかどうかを指定します。

booleansendWelcomeEmail

コミュニティに関連付けられているCustomSite。stringsite

コミュニティの状況。選択可能な値は次のとおりです。

NetworkStatus[]status

• Live — コミュニティがオンラインで、メンバーはアクセスできます。

• DownForMaintenance — コミュニティは以前は公開されていましたが、オフラインになっています。「コミュニティの作成およびカスタマイズ」権限を持つメンバーは、プロファイルまたはメンバー種別に関係なくオフラインのコミュニティの設定に引き続きアクセスできます。メンバーはオフラインのコミュニティにはアクセスできませんが、ユーザインターフェースのドロップダウンには引き続き[CommunityName (オフライン)]と表示されます。

• UnderConstruction — コミュニティがまだ公開されていません。「コミュニティの作成およびカスタマイズ」権限を持つユーザは、プロファイルがコミュニティに関連付けられていれば、この状況のコミュニティにアクセスできます。

339


説明項目のデータ型項目コミュニティの公開後は、再びこの状況になることはありません。

コミュニティで使用できるタブ。これらのタブは、コミュニティを作成したユーザが選択します。

NetworkTabSettabs

サイトを他のサイトと区別する、サイトの URL上のパスの最初の部分。たとえば、サイト URL

stringurlPathPrefix

が mycompany.force.com/partnersである場合、partnersは urlPathPrefixになります。新しいコミュニティメンバーにお知らせメールを送信するときに使用されるメールテンプレート。

stringwelcomeTemplate

Branding

コミュニティに適用されるブランド設定と配色を表します。

説明項目のデータ型項目コミュニティログインページのフッターに表示されるテキスト。

stringloginFooterText

外部ユーザに対してコミュニティログインページに表示されるロゴ。

stringloginLogo

コミュニティページのフッターに表示される画像。.html ファイルである必要があります。

stringpageFooter

コミュニティページのヘッダーに表示される画像。.html、.gif、.jpg、.pngファイルを使用できます。

stringpageHeader

有効なタブに使用される色。stringprimaryColor

primaryColorで使用されるフォントの色。

stringprimaryComplementColor

コミュニティのページの背景色。stringquaternaryColor

quaternaryColorで使用されるフォントの色。

stringquaternaryComplementColor

リストとテーブルの上境界線に使用される色。

stringsecondaryColor

編集ページと詳細ページのセクションヘッダーの背景色。

stringtertiaryColor

tertiaryColorで使用されるフォントの色。

stringtertiaryComplementColor

340


説明項目のデータ型項目ヘッダーの背景色。stringzeronaryColor

zeronaryColorで使用されるフォントの色。

stringzeronaryComplementColor

NetworkMemberGroup

コミュニティに割り当てられたプロファイルおよび権限セットを表します。いずれかのプロファイルまたは権限セットを持つユーザは、(顧客グループの) Chatter 顧客でない限り、コミュニティのメンバーです。

説明項目のデータ型項目コミュニティに割り当てられた権限セット。

stringpermissionSet

メモ: コミュニティにも関連付けられている権限セットが (顧客グループの) Chatter顧客に割り当てられている場合、その Chatter 顧客はコミュニティに追加されません。

コミュニティの一部であるプロファイル。

stringprofile

ReputationLevelDefinitions

コミュニティ内で特定の定義されたアクションを実行することでメンバーが達成できる評価レベルを表します。

説明項目のデータ型項目評価レベルを表します。ReputationLevel[]level

ReputationLevel

評価レベルの名前と下限値を表します。上限値はアプリケーションによって計算されます。

説明項目のデータ型項目評価レベルの名前。この項目は省略可能です。指定されていない場合、デフォルトが使用さ

stringlabel

れます。次の 10 個のデフォルトレベルがあります。• レベル 1• レベル 2• レベル 3• レベル 4

341


説明項目のデータ型項目• レベル 5• レベル 6• レベル 7• レベル 8• レベル 9• レベル 10

必須。この評価レベルの範囲の下限値。たとえば、この評価レベルがポ

doublelowerThreshold

イント 1 ～ 50 の場合、1 がlowerThresholdです。

ReputationPointsRules

コミュニティのポイントシステムのポイントルールを表します。

説明項目のデータ型項目行動とそれに関連付けられたポイントを表します。

ReputationPointsRule[]pointsRule

ReputationPointsRule

ポイントルールの行動と関連付けられたポイント値を表します。アクションを実行したユーザは、関連付けられたポイントを獲得します。

説明項目のデータ型項目必須。ポイントを獲得するためにメンバーが実行する必要がある行動の種別。次の値を使用できます。

stringeventType

• FeedItemWriteAPost

• FeedItemWriteAComment

• FeedItemReceiveAComment

• FeedItemLikeSomething

• FeedItemReceiveALike

• FeedItemMentionSomeone

• FeedItemSomeoneMentionsYou

• FeedItemShareAPost

• FeedItemSomeoneSharesYourPost

必須。行動を実行してメンバーが取得するポイント数。行動ごとのデ

intpoints

フォルトのポイント数は次のとおりです。• FeedItemWriteAPost +1• FeedItemWriteAComment: +1• FeedItemReceiveAComment: +5• FeedItemLikeSomething: +1

342


説明項目のデータ型項目• FeedItemReceiveALike: +5• FeedItemMentionSomeone: +1• FeedItemSomeoneMentionsYou: +5• FeedItemShareAPost: +1• FeedItemSomeoneSharesYourPost:

+5

NetworkTabSet

説明項目のデータ型項目コミュニティの一部であるカスタムタブ。

stringcustomTab

コミュニティの [ホーム] タブ。メンバーがログインすると、このページが最初に表示されます。

stringdefaultTab

コミュニティの一部である標準タブ。

stringstandardTab

宣言的なメタデータの定義のサンプル次に、ネットワークの XML 定義のサンプルを示します。

<?xml version="1.0" encoding="UTF-8"?><Network xmlns="http://soap.sforce.com/2006/04/metadata">

<allowMembersToFlag>true</allowMembersToFlag><branding>

<loginFooterText>salesforce.com</loginFooterText><loginLogo>Communities_Shared_Document_Folder/header2_png.png</loginLogo><pageFooter>Branding/footer_html.html</pageFooter><pageHeader>Branding/header_Image.jpg</pageHeader><primaryColor>#AF5800</primaryColor><primaryComplementColor>#FFFFFF</primaryComplementColor><quaternaryColor>#286FB8</quaternaryColor><quaternaryComplementColor>#FFFFFF</quaternaryComplementColor><secondaryColor>#000000</secondaryColor><tertiaryColor>#FFFFFF</tertiaryColor><tertiaryComplementColor>#222222</tertiaryComplementColor><zeronaryColor>#0A3764</zeronaryColor><zeronaryComplementColor>#FFFFFF</zeronaryComplementColor>

</branding>

<changePasswordTemplate>unfiled$public/CommunityChangePasswordEmailTemplate</changePasswordTemplate>

<description>Metadata Community</description><emailSenderAddress>[email protected]</emailSenderAddress><emailSenderName>Admin User</emailSenderName><enableInvitation>false</enableInvitation><enableKnowledgeable>true</enableKnowledgeable><enablePrivateMessages>true</enablePrivateMessages><enableReputation>true</enableReputation>

<forgotPasswordTemplate>unfiled$public/CommunityForgotPasswordEmailTemplate</forgotPasswordTemplate>

<networkMemberGroups><permissionSet>Admin</permissionSet><permissionSet>Standard</permissionSet>

343


<permissionSet>ReadOnly</permissionSet><profile>Admin</profile><profile>Standard</profile><profile>ReadOnly</profile>

</networkMemberGroups><reputationLevels>

<level><label>Beginner</label><lowerThreshold>0</lowerThreshold>

</level><level>

<label>Apprentice</label><lowerThreshold>51</lowerThreshold>

</level><level>

<label>Getting There</label><lowerThreshold>101</lowerThreshold>

</level><level>

<label>Skilled</label><lowerThreshold>151</lowerThreshold>

</level><level>

<label>Expert</label><lowerThreshold>201</lowerThreshold>

</level><level>

<label>Mentor</label><lowerThreshold>251</lowerThreshold>

</level><level>

<label>Guru</label><lowerThreshold>301</lowerThreshold>

</level></reputationLevels><reputationPointsRules>

<pointsRule><eventType>FeedItemWriteAPost</eventType><points>5</points>

</pointsRule><pointsRule>

<eventType>FeedItemWriteAComment</eventType><points>3</points>


<eventType>FeedItemReceiveAComment</eventType><points>10</points>


<eventType>FeedItemLikeSomething</eventType><points>3</points>


<eventType>FeedItemReceiveALike</eventType><points>5</points>


<eventType>FeedItemMentionSomeone</eventType><points>5</points>


<eventType>FeedItemSomeoneMentionsYou</eventType><points>10</points>


<eventType>FeedItemShareAPost</eventType><points>5</points>


344


<eventType>FeedItemSomeoneSharesYourPost</eventType><points>10</points>

</pointsRule></reputationPointsRules><selfRegistration>false</selfRegistration><sendWelcomeEmail>true</sendWelcomeEmail><site>Network_11</site><status>UnderConstruction</status><tabs>

<defaultTab>Chatter</defaultTab><standardTab>Chatter</standardTab><standardTab>Account</standardTab><standardTab>Campaign</standardTab><standardTab>Case</standardTab><standardTab>Console</standardTab><standardTab>Contact</standardTab><standardTab>Contract</standardTab><standardTab>Dashboard</standardTab><standardTab>JigsawSearch</standardTab><standardTab>File</standardTab><standardTab>CollaborationGroup</standardTab><standardTab>home</standardTab><standardTab>Idea</standardTab><standardTab>Lead</standardTab><standardTab>Opportunity</standardTab><standardTab>Product2</standardTab><standardTab>UserProfile</standardTab><standardTab>report</standardTab><standardTab>Solution</standardTab>

</tabs><urlPathPrefix>network1</urlPathPrefix><welcomeTemplate>unfiled$public/CommunityWelcomeEmailTemplate</welcomeTemplate>

</Network>

関連リンクCommunity (Zone)

Packageretrieve()コールの一部として取得するメタデータコンポーネントを指定するため、またはコンポーネントのパッケージを定義するために使用されます。

説明型名前パッケージコンポーネントは、ダイナミック ApexおよびAPI経由でインストールされている組織にあ

APIAccessLevel (string 型の列挙)

apiAccessLevel

る標準オブジェクトやカスタムオブジェクトにアクセスできます。パッケージをインストールするシステム管理者は、セキュリティの向上のために、インストール後のこうしたアクセスの制限を望む場合もあります。有効な値は、次のとおりです。• Unrestricted — パッケージのコンポーネントに、

コンポーネントが要求を API に送信するときにログインしているユーザと同じ標準オブジェクトへの API アクセス権があります。

345

Packageメタデータ型

説明型名前• Restricted — コンポーネントがアクセスできる標

準オブジェクトをシステム管理者が選択できます。さらに、制限されたパッケージ内のコンポーネントは、ユーザの権限で現在のパッケージ内のカスタムオブジェクトへのアクセスが許可される場合には、それらのオブジェクトにのみアクセスできます。

詳細は、Salesforceオンラインヘルプの「パッケージの API および動的 Apex アクセスについて」を参照してください。

パッケージの簡単な説明。stringdescription

APIアクセスの一意の識別子として使用されるパッケージ名。fullNameには、アンダースコアと英数

stringfullName

字のみを使用できます。一意であること、最初は文字であること、空白は使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。この項目は、Metadata コンポーネントから継承されています。パッケージが作成された開発組織の名前空間。stringnamespacePrefix

パッケージにアクセスできるオブジェクトと使用可能なアクセス権の種類 (作成、参照、更新、削除) を示します。

ProfileObjectPermissions[]objectPermissions

パッケージのインストールの説明に使用する Webリンク。

stringsetupWeblink

取得するコンポーネントの種類。PackageTypeMembers[]types

必須。コンポーネントの種類のバージョン。stringversion

PackageTypeMembers

パッケージで取得されるコンポーネントの名前と種類を指定するために使用します。

説明型名前<name>要素で指定されている全種類のメタデータコンポーネントを取得する、1 つ以上の名前を指定

stringmembers

したコンポーネント、またはワイルドカード文字(*)。標準オブジェクトを取得するには、そのオブジェクトを名前で指定します。たとえば、<members>Account</members>では標準の Accountオブジェクトを取得します。

取得するメタデータコンポーネントの種類。たとえば、<name>CustomObject</name>では<members>

stringname

346

Packageメタデータ型

説明型名前要素で指定されている 1 つ以上のカスタムオブジェクトを取得します。

関連リンクpackage.xml マニフェストファイルのサンプル

PermissionSetユーザのプロファイルを変更せずに、追加権限の許可に使用する権限のセットを表します。アクセスの許可に権限セットを使用できますが、アクセスの拒否には使用できません。Metadataメタデータ型を拡張し、そのfullName

項目を継承します。APIバージョン 29.0 以降では、プロファイルと権限セットの次の管理コンポーネントのアクセス設定を取得およびリリースできます。• Apex クラス• アプリケーション• カスタム項目権限• カスタムオブジェクト権限• カスタムタブの設定• 外部データソース• レコードタイプ• Visualforce ページ

詳細は、「package.xmlマニフェストファイルのサンプル」 (ページ21)の「管理コンポーネントへのアクセス」を参照してください。

宣言的なメタデータファイルのサフィックスおよびディレクトリの場所権限セットはpermissionsetsディレクトリに保存されます。ファイル名は権限セットのAPI名に一致し、拡張子は .permissionsetです。たとえば、User_Management_Perms という名前の権限セットはpermissionsets/User_Management_Perms.permissionsetに保存されます。

バージョン権限セットは API バージョン 22.0 以降で使用できます。

項目

説明データ型項目この権限セットに割り当てられているユーザに表示されるアプリケーションを示します。API

PermissionSetApplicationVisibility[]applicationVisibilities

バージョン 29.0 以降で使用できます。APIバージョン 29.0 では、この項目はカスタムアプリケーションのみをサポートします。API バー

347

PermissionSetメタデータ型

説明データ型項目ジョン 30.0 以降、この項目は標準アプリケーションとカスタムアプリケーションの両方をサポートします。この権限セットに割り当てられているユーザが実行できるメソッドを持つ最上位の Apex クラ

PermissionSetApexClassAccess[]classAccesses

スを示します。APIバージョン 23.0 以降で利用できます。この権限セットに割り当てられているユーザが利用可能なカスタム権限を示します。APIバージョン 31.0 以降で使用できます。

PermissionSetCustomPermissions[]customPermissions

権限セットの説明。最大 255 文字です。stringdescription

この権限セットに割り当てられているユーザが使用できる、ID 種別 [ユーザ]を持つデータ

PermissionSetExternalDataSourceAccess[]

externalDataSourceAccesses

ソースを示します。API バージョン 27.0 以降で利用できます。ベータ版リリース内の外部データソース。この権限セットに割り当てられているユーザがアクセスできる項目、および使用可能なアクセ

PermissionSetFieldPermissions[]fieldPermissions

ス権の種類 (参照可能または編集可能) を示します。APIバージョン 23.0 以降で利用できます。権限セットの表示ラベル。最大 80 文字です。stringlabel

この権限セットに割り当てられているユーザがアクセスできるオブジェクト、および使用可能

PermissionSetObjectPermissions[]objectPermissions

なアクセス権の種類 (作成、参照、編集、削除など) を示します。API バージョン 23.0 以降で利用できます。この権限セットに割り当てられているユーザが実行できる Visualforce ページを示します。APIバージョン 23.0 以降で利用できます。

PermissionSetApexPageAccess[]pageAccesses

この権限セットに割り当てられているユーザに表示されるレコードタイプを示します。API

PermissionSetRecordTypeVisibility[]recordTypeVisibilities

バージョン 29.0 以降で利用できます。無効なレコードタイプの場合、この項目は取得またはリリースされません。この権限セットのタブ表示設定を示します。API バージョン 26.0 以降で利用できます。

PermissionSetTabSetting[]tabSettings

権限セットの[ユーザライセンス]。ユーザライセンスによって、ユーザがアクセスできる機能

stringuserLicense

の基準が決まります。各ユーザには必ず 1 つのユーザライセンスが割り当てられます。アプリケーション権限またはシステム権限(「API の有効化」など) と、この権限セットで

PermissionSetUserPermission[]userPermissions

348


説明データ型項目有効化されているかどうかを指定します。APIバージョン 28.0 以前では、有効であるか無効であるかに関係なく、この項目ですべてのユーザ権限が取得されます。APIバージョン 29.0 以降では、有効なユーザ権限のみが取得されます。

PermissionSetApplicationVisibility

PermissionSetApplicationVisibility は、この権限セットに割り当てられているユーザにアプリケーションが表示されるかどうかを決定します。

説明データ型項目名必須。アプリケーションの名前。stringapplication

必須。この権限セットに割り当てられているユーザにこのアプリケーションが表示されるか (true)、否か (false) を示します。

booleanvisible

PermissionSetApexClassAccess

PermissionSetApexClassAccessは権限セットに割り当てられているユーザのApexクラスのアクセス権を表します。

説明データ型項目必須。Apex クラス名。stringapexClass

必須。この権限セットに割り当てられているユーザが最上位クラスのメソッドを実行できるか (true)、否か(false) を示します。

booleanenabled

PermissionSetCustomPermissions

PermissionSetCustomPermissions は権限セットに割り当てられているユーザのカスタムアクセス権限を表します。取得できるのは有効なカスタム権限のみです。

説明データ型項目名必須。カスタム権限が有効化されているか (true)、否か(false) を示します。

booleanenabled

必須。カスタム権限名。stringname

PermissionSetExternalDataSourceAccess

PermissionSetExternalDataSourceAccessは、ID 種別[ユーザ]を持つユーザのデータソースアクセス権を表します。API バージョン 27.0 以降で利用できます。ベータ版リリース内の外部データソース。

349


説明データ型項目必須。データソースが有効化されているか (true)、否か (false) を示します。

booleanenabled

外部データソースの名前。stringexternalDataSource

PermissionSetFieldPermissions

PermissionSetFieldPermissions は権限セットに割り当てられているユーザの項目権限を表します。API バージョン30.0 以降では、必須項目の権限の取得やリリースはできません。

説明データ型項目必須。この権限セットに割り当てられているユーザが項目を編集できるか (true)、否か (false) を示します。

booleaneditable

必須。項目のAPI名 (Warehouse__c.Description__cなど)。

stringfield

この権限セットに割り当てられているユーザが項目を参照できるか (true)、否か (false) を示します。

booleanreadable

PermissionSetObjectPermissions

PermissionSetObjectPermissions は権限セットのオブジェクト権限を表します。権限ごとにこれらの要素の 1 つを使用します。

説明データ型項目必須。この権限セットに割り当てられているユーザがobject項目で参照されているオブジェクトを作成できるか (true)、否か (false) を示します。

booleanallowCreate

必須。この権限セットに割り当てられているユーザがobject項目で参照されているオブジェクトを削除できるか (true)、否か (false) を示します。

booleanallowDelete

必須。この権限セットに割り当てられているユーザがobject項目で参照されているオブジェクトを編集できるか (true)、否か (false) を示します。

booleanallowEdit

必須。この権限セットに割り当てられているユーザがobject項目で参照されているオブジェクトを参照できるか (true)、否か (false) を示します。

booleanallowRead

必須。オブジェクトの共有設定に関係なく、この権限セットに割り当てられているユーザが object項目で

booleanmodifyAllRecords

参照されているオブジェクトを参照、編集、または削除できるか (true)、否か (false) を示します。これには非公開レコード (親オブジェクトを持たないレコード)を含みます。これは「すべてのデータの編集」ユーザ権限と似ていますが、個別のオブジェクトレベルに限定されます。

350


説明データ型項目必須。オブジェクトの API 名 (Warehouse__cなど)。stringobject

必須。オブジェクトの共有設定に関係なく、この権限セットに割り当てられているユーザが object項目で

booleanviewAllRecords

参照されているオブジェクトを参照できるか (true)、否か (false) を示します。これには非公開レコード (親オブジェクトを持たないレコード) を含みます。これは「すべてのデータの参照」ユーザ権限と似ていますが、個別のオブジェクトレベルに限定されます。

PermissionSetApexPageAccess

PermissionSetApexPageAccess は権限セットに割り当てられているユーザの Visualforce ページのアクセス権を表します。

説明データ型項目必須。Visualforce ページ名。stringapexPage

必須。この権限セットに割り当てられているユーザがVisualforceページを実行できるか (true)、否か (false)を示します。

booleanenabled

PermissionSetRecordTypeVisibility

PermissionSetRecordTypeVisibility は、この権限セットのレコードタイプが表示されるかどうかを表します。

説明項目のデータ型項目必須。Account.MyRecordTypeなどのレコードタイプ名。

stringrecordType

必須。レコードタイプがこの権限セットに割り当てられているユーザに表示されるか (true)、否か (false)を示します。

booleanvisible

PermissionSetTabSetting

PermissionSetTabSetting は権限セットのタブ設定を表します。

説明データ型項目必須。タブ名。stringtab

必須。タブの表示設定を示します。有効な値は、次のとおりです。

PermissionSetTabVisibility(string 型の列挙)

visibility

• Available — このタブは [すべてのタブ] ページで利用できます。各ユーザは、どのアプリケーションでもタブが表示されるように表示をカスタマイズできます。

351


説明データ型項目• None — このタブは [すべてのタブ] ページでは利用

できず、どのアプリケーションにも表示されません。

• Visible — タブは [すべてのタブ] ページで利用でき、関連付けられているアプリケーションの表示タブに表示されます。各ユーザは、表示をカスタマイズしてタブを非表示にしたり、その他のアプリケーションで表示したりできます。

PermissionSetUserPermission

PermissionSetUserPermission は権限セットのアプリケーション権限またはシステム権限を表します。権限ごとにこれらの要素の 1 つを使用します。

説明データ型項目必須。権限が有効化されるか (true)、無効化されるか(false) を示します。

booleanenabled

必須。権限の名前。stringname

宣言的なメタデータの定義のサンプル権限セットを追加または変更するときは、すべての権限を含める必要はありません。含める必要があるのは、追加または変更する権限のみです。

<?xml version="1.0" encoding="UTF-8"?><PermissionSet xmlns="http://soap.sforce.com/2006/04/metadata">

<description>Grants all rights needed for an HR administrator to manageemployees.</description>

<label>HR Administration</label><userLicense>Salesforce</userLicense><applicationVisibilities>

<application>JobApps__Recruiting</application><visible>true</visible>

</applicationVisibilities><userPermissions>

<enabled>true</enabled><name>APIEnabled</name>

</userPermissions><objectPermissions>

<allowCreate>true</allowCreate><allowDelete>true</allowDelete><allowEdit>true</allowEdit><allowRead>true</allowRead><viewAllRecords>true</viewAllRecords><modifyAllRecords>true</modifyAllRecords><object>Job_Request__c</object>

</objectPermissions><fieldPermissions>

<editable>true</editable><field>Job_Request__c.Salary__c</field><readable>true</readable>

</fieldPermissions><pageAccesses>

<apexPage>Job_Request_Web_Form</apexPage><enabled>true</enabled>

</pageAccesses>

352


<classAccesses><apexClass>Send_Email_Confirmation</apexClass><enabled>true</enabled>

</classAccesses><tabSettings>

<tab>Job_Request__c</tab><visibility>Available</visibility>

</tabSettings><recordTypeVisibilities>

<recordType>Recruiting.DevManager</recordType><visible>true</visible>

</recordTypeVisibilities></PermissionSet>

組織の PermissionSet メタデータを取得するために使用される package.xml マニフェストの例を次に示します。権限セットを取得する場合、割り当てられた権限付きの関連コンポーネントも取得する必要があります。たとえば、カスタムオブジェクトの objectPermissionsおよび fieldPermissionsを取得するには、CustomObjectコンポーネントも取得する必要があります。


<types><members>Job_Request__c</members><name>CustomTab</name>

</types><types>

<members>Job_Request__c</members><name>CustomObject</name>

</types><types>

<members>JobApps__Recruiting</members><name>CustomApplication</name>

</types><types>

<members>Recruiting.DevManager</members><name>RecordType</name>

</types><types>

<members>*</members><name>PermissionSet</name>


</Package>

PortalPortal メタデータ型はパートナーポータルまたはカスタマーポータルを表します。Metadata を拡張し、そのfullName項目を継承します。このメタデータ型を使用するには、組織でパートナーポータルまたはカスタマーポータルが有効になっている必要があります。詳細は、Salesforceオンラインヘルプの「パートナーポータルの概要」および「カスタマーポータルの有効化」を参照してください。

宣言的なメタデータファイルのサフィックスおよびディレクトリの場所Force.com Portal コンポーネントは、対応するパッケージディレクトリのportalsディレクトリに保存されます。ファイル名はポータル名に一致し、拡張子は .portalです。

バージョンForce.com Portal コンポーネントは、API バージョン 15.0 以降で使用できます。

353

Portalメタデータ型

項目

説明データ型項目必須。このポータルが有効であるかどうかを示します。

booleanactive

ポータルの管理者として指定するユーザの氏名。stringadmin

ポータルの HTML メッセージのデフォルト言語。米国英語では en_US など、言語の略語を使用します。

stringdefaultLanguage

ポータルの説明。stringdescription

必須。設定済みのテンプレートを使用してポータルからメールを送信するときに使用されるメールアドレス (パスワードをリセットする場合など) 。

stringemailSenderAddress

必須。設定済みのテンプレートを使用してポータルからメールを送信するときに表示する名前 (パスワードをリセットする場合など)。

stringemailSenderName

カスタマーポータルで、ポータルユーザが自分のケースをクローズすることを許可します。

booleanenableSelfCloseCase

このポータルのフッターとして使用されるファイル。stringfooterDocument

ユーザが [パスワードを忘れた場合] リンクをクリックしたときに使用するメールテンプレート。

stringforgotPassTemplate

必須。ポータルの名前。Metadata から継承されるこの項目は、このメタデータ型の WSDL では定義されません。作成時、更新

stringfullName


このポータルのヘッダーとして使用されるファイル。stringheaderDocument

このポータルでセルフ登録が有効かどうかを決定します。

booleanisSelfRegistrationActivated

このポータルのログインページのヘッダーとして使用されるファイル。

stringloginHeaderDocument

このポータルのロゴとして使用されるファイル。stringlogoDocument

ログアウト時のユーザのリダイレクト先の URL。stringlogoutUrl

新規ケースコメントの自動通知に使用されるメールテンプレート。

stringnewCommentTemplate

パスワードリセットの自動通知に使用されるメールテンプレート。

stringnewPassTemplate

新規ユーザ作成時の自動通知に使用されるメールテンプレート。

stringnewUserTemplate

354


説明データ型項目所有者変更時の自動通知に使用されるメールテンプレート。

stringownerNotifyTemplate

セルフ登録ページの URL。stringselfRegNewUserUrl

セルフ登録したユーザのデフォルトのプロファイル。stringselfRegUserDefaultProfile

セルフ登録したユーザのデフォルトのロール。有効な値は、次のとおりです。

PortalRoles (string型の列挙)selfRegUserDefaultRole

• Executive• Manager• User• PersonAccount

セルフ登録の自動通知に使用されるメールテンプレート。

stringselfRegUserTemplate

このポータルでアクションに対する確認メッセージを表示するか、否かを決定します。

booleanshowActionConfirmation

このポータルの CSS スタイルシートとして使用される Document オブジェクト。

stringstylesheetDocument

必須。このポータルのタイプ。有効な値は、次のとおりです。

PortalType (string型の列挙)type

• CustomerSuccess• Partner

宣言的なメタデータの定義のサンプルポータルの XML 定義のサンプルを以下に示します。

<?xml version="1.0" encoding="UTF-8"?><Portal xmlns="http://soap.sforce.com/2006/04/metadata">

<active>true</active><description>Customer Portal</description><emailSenderName>[email protected]</emailSenderName><enableSelfCloseCase>false</enableSelfCloseCase><forgotPassTemplate>unfiled$public/ChangePwdEmail</forgotPassTemplate><isSelfRegistrationActivated>false</isSelfRegistrationActivated><newPassTemplate>unfiled$public/ChangePwdEmail</newPassTemplate><newUserTemplate>unfiled$public/NewUserEmail</newUserTemplate><selfRegUserTemplate>unfiled$public/SelfRegUserEmail</selfRegUserTemplate><showActionConfirmation>false</showActionConfirmation><type>CustomerSuccess</type>

</Portal>

関連リンクCustomSite

355


PostTemplate[Chatter での承認] の承認投稿テンプレートに関連付けられたメタデータを表します。承認投稿テンプレートでは、Chatter フィードに表示される承認申請投稿に含まれる情報をカスタマイズできます。Metadata メタデータ型を拡張し、その fullName項目を継承します。

メモ:

• 承認が有効化されており、Chatterフィード追跡がサポートされているオブジェクトに限り、承認投稿テンプレートを作成できます。オブジェクトのフィード追跡が有効になっていない場合は、投稿テンプレートを承認プロセスに関連付けることはできません。

• カスタム項目を削除すると、その項目が参照するすべての承認投稿テンプレートから削除されます。既存の投稿は影響を受けません。カスタム項目を復元すると、[選択可能な項目] リストには復元されますが、以前にその項目が含まれていた承認投稿テンプレートには復元されません。

• カスタムオブジェクトを削除 (または復元) すると、関連付けられている承認投稿テンプレートと、Chatterフィードにすでに存在する、そのオブジェクトの承認申請投稿も削除 (または復元) されます。

• カスタムオブジェクトの名前を変更すると、そのオブジェクトに関連付けられている承認投稿テンプレートもそれに応じて更新されます。

• 1 つ以上の承認プロセスに対応するカスタム承認投稿テンプレートを作成できますが、承認プロセスにカスタム投稿テンプレートを関連付ける前に [Chatter での承認] を有効にする必要があります。

ファイルのサフィックスおよびディレクトリの場所PostTemplate コンポーネントのサフィックスは .postTemplateで、postTemplatesフォルダに保存されます。

バージョンPostTemplate コンポーネントは、API バージョン 29.0 以降で使用できます。

項目


項目名

必須。指定されたオブジェクトのデフォルト投稿テンプレートとするかどうかを指定します。trueに設定すると、同じオブジェクトに関連付けられた投稿テンプレートを指定していない承認プロセスでこの投稿テンプレートが使用されます。

booleandefault

オブジェクトにデフォルト投稿テンプレートが設定されていない場合、そのオブジェクトの承認プロセスに独自の投稿テンプレートが指定されていない限り、各承認プロセスでシステムのデフォルト投稿テンプレートが使用されます。

投稿テンプレートの説明 (省略可能)。stringdescription

356

PostTemplateメタデータ型


項目名

必須。承認申請投稿に含める最大 4 つの項目の配列。承認オブジェクトを主従関係の従オブジェクトに設定した場合、[所有者]項目は、承認ページレイアウトまたは承認投稿テンプレートに使用できません。

string[]fields

必須。投稿テンプレートの名前。この一意ではない表示ラベルは、投稿テンプレートの一意の名前とは異なります。

stringlabel

宣言的なメタデータの定義のサンプルPostTemplate コンポーネントの例を次に示します。

<PostTemplate xmlns="http://soap.sforce.com/2006/04/metadata"><default>false</default><fields>NumberOfEmployees</fields><fields>NumberofLocations__c</fields><fields>PartnerAccount</fields><fields>LeadCustomFieldNumber__c</fields><label>My Lead Post Template</label>

</PostTemplate>

上記の PostTemplate コンポーネントを参照するパッケージマニフェストの例を次に示します。


<types><members>Lead.leadtemplate</members><name>PostTemplate</name>


</Package>

Profileユーザプロファイルを表します。プロファイルは、Salesforce内でさまざまな機能を実行するためのユーザの権限を定義します。Metadata メタデータ型を拡張し、その fullName項目を継承します。APIバージョン 29.0 以降では、プロファイルと権限セットの次の管理コンポーネントのアクセス設定を取得およびリリースできます。• Apex クラス• アプリケーション• カスタム項目権限• カスタムオブジェクト権限• カスタムタブの設定• 外部データソース• レコードタイプ• Visualforce ページ

357

Profileメタデータ型

詳細は、「package.xmlマニフェストファイルのサンプル」 (ページ21)の「管理コンポーネントへのアクセス」を参照してください。

宣言的なメタデータファイルのサフィックスおよびディレクトリの場所ファイルのサフィックスは、.profileです。各プロファイルに 1 つのファイルがあり、対応するパッケージディレクトリの profilesフォルダに保存されます。

バージョンプロファイルは、API バージョン 10.0 以降で使用できます。

項目メタデータ APIで返されるプロファイルのコンテンツは、RetrieveRequestメッセージ内で要求されるコンテンツによって異なります。たとえば、プロファイルには、プロファイルと同じRetrieveRequestで返されたカスタムオブジェクトに含まれている項目の項目レベルのセキュリティのみが含まれます。プロファイルの定義には次の項目が含まれます。

説明データ型項目名このプロファイルに割り当てられているユーザに表示されるアプリケーションを示します。

ProfileApplicationVisibility[]applicationVisibilities

APIバージョン 29.0 以前では、この項目はカスタムアプリケーションのみをサポートします。APIバージョン 30.0 以降、この項目は標準アプリケーションとカスタムアプリケーションの両方をサポートします。このプロファイルに割り当てられているユーザが実行できるメソッドを持つ最上位の Apex クラスを示します。

ProfileApexClassAccess[]classAccesses

プロファイルがカスタムプロファイルか(true)、標準プロファイルか (false) を示します。APIバージョン 30.0 以降で利用できます。

booleancustom

このプロファイルに割り当てられているユーザが利用可能なカスタム権限を示します。APIバージョン 31.0 以降で使用できます。

ProfileCustomPermissions[]customPermissions

プロファイルの説明。最大 255 文字です。APIバージョン 30.0 以降で利用できます。

stringdescription

このプロファイルに割り当てられたユーザが使用できる、ID 種別が [ユーザ]のデータソース

ProfileExternalDataSourceAccess[]externalDataSourceAccesses

を示します。API バージョン 27.0 以降で利用できます。ベータ版リリース内の外部データソース。このプロファイルに割り当てられているユーザに表示される項目、および使用可能なアクセス

ProfileFieldLevelSecurity[]fieldLevelSecurities

権の種類 (編集可能または非表示) を示します。

358


説明データ型項目名この項目は、APIバージョン 22.0 以前で使用できます。このプロファイルに割り当てられているユーザに表示される項目、および使用可能なアクセス

ProfileFieldLevelSecurity[]fieldPermissions

権の種類 (編集可能または参照可能) を示します。この項目は API バージョン 23.0 以降で使用できます。名前には、英数字、およびアンダースコア (_)文字のみを使用できます。また、最初は文字と

stringfullName

し、最後にアンダースコアを使用したり、連続した 2 つのアンダースコア文字を含めたりすることはできません。この項目はMetadataコンポーネントから継承するため、この項目はこのコンポーネントのWSDL で定義されません。作成時、更新時、または削除時に指定する必要があります。コールにおけるこの項目の例を確認するには、「create()」を参照してください。

このプロファイルで使用するレイアウトを示します。

ProfileLayoutAssignments[]layoutAssignments

このプロファイルを持つユーザがログインできる時間を示します。指定されていない場合、

ProfileLoginHours[]loginHours

ユーザのログイン時間はプロファイルによって制限されません。この項目は API バージョン 25.0 以降で使用できます。

特定のプロファイルを持つユーザがログインできる IP アドレスの範囲のリスト。この項目は API バージョン 17.0 以降で使用できます。

ProfileLoginIpRange[]loginIpRanges

このプロファイルに割り当てられているユーザがアクセスできるオブジェクト、および使用可

ProfileObjectPermissions[]objectPermissions

能なアクセス権の種類 (作成、参照、編集、削除など) を示します。API バージョン 28.0 以降、この項目はallowReadがtrueの場合にのみ取得されます。このプロファイルに割り当てられているユーザが実行できる Visualforce ページを示します。

ProfileApexPageAccess[]pageAccesses

このプロファイルに割り当てられているユーザのレコードタイプの表示設定を示します。API

ProfileRecordTypeVisibility[]recordTypeVisibilities

バージョン 29.0 以降では、無効なレコードタ

359


説明データ型項目名イプの場合、この項目は取得またはリリースされません。このプロファイルに割り当てられているユーザに表示されるレコードタイプ、および表示されるアプリケーション内のタブを示します。

ProfileTabVisibility[]tabVisibilities

プロファイルの[ユーザライセンス]。ユーザライセンスによって、ユーザがアクセスできる機

stringuserLicense

能の基準が決まります。各ユーザには必ず 1 つのユーザライセンスが割り当てられます。この項目は API バージョン 17.0 以降で使用できます。

ユーザ権限 (「API の有効化」など) を指定します。また、このプロファイルでその権限が有効

ProfileUserPermission[]userPermissions

化されているかどうかも指定します。この項目は、有効なユーザ権限のみを取得します。APIバージョン 29.0 以降で利用できます。

ProfileApplicationVisibility

ProfileApplicationVisibility はこのプロファイルに割り当てられているユーザにアプリケーションが表示されるかどうかを決定します。

説明データ型項目名必須。アプリケーションの名前。stringapplication

必須。アプリケーションがデフォルトのアプリケーションであるか (true)、否か (false) を示します。プロファイルごとに 1 つのアプリケーションのみを trueに設定できます。

booleandefault

必須。このプロファイルに割り当てられているユーザにこのアプリケーションが表示されるか (true)、否か (false) を示します。

booleanvisible

ProfileApexClassAccess

ProfileApexClassAccess は、このプロファイルに割り当てられているユーザが実行できるメソッドを持つ最上位のApex クラスを決定します。

説明データ型項目名必須。Apex クラス名。stringapexClass

必須。このプロファイルに割り当てられているユーザが最上位クラスのメソッドを実行できるか (true)、否か (false)を示します。

booleanenabled

360


ProfileCustomPermissions

ProfileCustomPermissions はプロファイルに割り当てられているユーザのカスタムアクセス権限を表します。取得できるのは有効なカスタム権限のみです。

説明データ型項目名必須。カスタム権限が有効化されているか (true)、否か(false) を示します。

booleanenabled

必須。カスタム権限名。stringname

ProfileExternalDataSourceAccess

ProfileExternalDataSourceAccess は、ID 種別が [ユーザ]のユーザのデータソースアクセスを表します。API バージョン 27.0 以降で利用できます。ベータ版リリース内の外部データソース。

説明データ型項目名必須。データソースが有効化されているか (true)、否か(false) を示します。

booleanenabled

外部データソースの名前。stringexternalDataSource

ProfileFieldLevelSecurity

ProfileFieldLevelSecurity は、プロファイルに割り当てられているユーザの項目レベルセキュリティを表します。API バージョン 30.0 以降では、必須項目の権限の取得やリリースはできません。

説明データ型項目名必須。この項目が編集可能か (true)、否か (false) を示します。API バージョン 30.0 以降、新しいカスタム項目をリリースするとき、この項目はデフォルトで falseになります。

booleaneditable

必須。項目の名前を示します。stringfield

この項目が非表示であるか (true)、否か (false) を示します。この項目は、APIバージョン 22.0 以前で使用できます。ポータルプロファイルの場合、これは API バージョン 19.0以降ではデフォルトで trueに設定されています。

booleanhidden

この項目が参照可能か (true)、否か (false) を示します。この項目は API バージョン 23.0 以降で使用できます。これは、hidden項目の代わりに使用されます。API バージョン 30.0 以降、新しいカスタム項目をリリースするとき、この項目はデフォルトで falseになります。

booleanreadable

ポータルプロファイルの場合、これはデフォルトで false

に設定されています。

361


ProfileLayoutAssignments

ProfileLayoutAssignments はプロファイルおよび特定のエンティティで使用するレイアウトを決定します。

説明データ型項目名必須。この特定のエンティティのレイアウトを示します。stringlayout

この項目は省略可能です。レコードのrecordTypeがレイアウトの割り当てルールに一致する場合、指定されているレイアウトを使用します。

stringrecordType

ProfileLoginHours

ProfileLoginHours は、特定のプロファイルを持つユーザがログインできる期間を制限します。

説明データ型項目名このプロファイルを持つユーザがログインできる曜日の開始時刻を指定します。特定の曜日の開始時刻が指定されている

stringweekdayStart

場合、その曜日の終了時刻も指定する必要があります。特定の曜日の Start を End より大きな値に設定することはできません。• weekdayの有効な値は、monday、tuesday、wednesday、

thursday、friday、saturday、または sundayです。たとえば、mondayStartは、月曜日のログイン期間の開始を示します。

• Start に使用できる値は、午前 0 時からの分数です。60 (1時間) で割り切れる値である必要があります。たとえば、300は、午前 5 時です。

このプロファイルを持つユーザがログアウトする必要のある曜日の時刻を指定します。

stringweekdayEnd

• weekdayの有効な値は、monday、tuesday、wednesday、thursday、friday、saturday、または sundayです。たとえば、mondayEndは、月曜日のログイン期間の終了時刻を指定します。

• End に使用できる値は、午前 0 時からの分数です。60 (1時間) で割り切れる値である必要があります。たとえば、1020は、午後 5 時です。

プロファイルから以前に設定されたログイン時間帯の制限を削除するには、開始時刻または終了時刻を含まない、空の loginHours タグを明示的に含める必要があります。

ProfileLoginIpRange

ProfileLoginIpRange IP は、特定のプロファイルを持つユーザがログインできる IP アドレスの範囲を定義します。

362


説明データ型項目名この項目は、この範囲に対応するネットワークの部分など、範囲の目的を識別するために使用します。この項目は APIバージョン 31.0 以降で使用できます。

stringdescription

必須。範囲の最後の IP アドレス。stringendAddress

必須。範囲の最初の IP アドレス。stringstartAddress

ProfileObjectPermissions

ProfileObjectPermissions は、オブジェクトへのユーザのアクセス権を表します。メモ: API バージョン 18.0 以降では、「すべてのデータの参照」または「すべてのデータの編集」が無効化されているすべてのプロファイルの新しいカスタムオブジェクトで、これらの権限は無効化されています。

説明データ型項目名このプロファイルに割り当てられているユーザがobject項目で参照されているオブジェクトを作成できるか (true)、否か (false) を示します。この項目は、バージョン 14.0 より前のバージョンではrevokeCreateという名前でロジックが逆でした。バージョ

booleanallowCreate

ン間での項目名の変更およびtrueからfalseへの更新およびその逆の処理も自動的に処理されます。そのため、既存のXML コンポーネントファイルを手動で編集する必要は一切ありません。バージョン間での項目名の変更および trueから falseへの更新およびその逆の処理も自動的に処理されます。そのため、既存の XML コンポーネントファイルを手動で編集する必要は一切ありません。

このプロファイルに割り当てられているユーザがobject項目で参照されているオブジェクトを削除できるか (true)、否か (false) を示します。この項目は、バージョン 14.0 より前のバージョンではrevokeDeleteという名前でロジックが逆でした。バージョ

booleanallowDelete

ン間での項目名の変更およびtrueからfalseへの更新およびその逆の処理も自動的に処理されます。そのため、既存のXML コンポーネントファイルを手動で編集する必要は一切ありません。

このプロファイルに割り当てられているユーザがobject項目で参照されているオブジェクトを編集できるか (true)、否か (false) を示します。この項目は、バージョン 14.0 より前のバージョンではrevokeEditという名前でロジックが逆でした。バージョン

booleanallowEdit

間での項目名の変更およびtrueからfalseへの更新およびその逆の処理も自動的に処理されます。そのため、既存の

363


説明データ型項目名XML コンポーネントファイルを手動で編集する必要は一切ありません。

このプロファイルに割り当てられているユーザがobject項目で参照されているオブジェクトを表示できるか (true)、否か (false) を示します。この項目は、バージョン 14.0 より前のバージョンではrevokeReadという名前でロジックが逆でした。バージョン

booleanallowRead

間での項目名の変更およびtrueからfalseへの更新およびその逆の処理も自動的に処理されます。そのため、既存のXML コンポーネントファイルを手動で編集する必要は一切ありません。

オブジェクトの共有設定に関係なく、このプロファイルに割り当てられているユーザがobject項目で参照されているオ

booleanmodifyAllRecords

ブジェクトを参照、編集、または削除できるか (true)、否か (false) を示します。これは、個別のオブジェクトレベルに限定されている「すべてのデータの編集」ユーザ権限と同じです。これは、API バージョン 15.0 の新項目です。

メモ: この項目はすべてのオブジェクトで利用できるわけではありません。これらの権限を現在サポートしているオブジェクトを確認するには、ユーザインターフェースのプロファイルを参照してください。「すべてのデータの編集」を持つプロファイルは、メタデータ API の modifyAllRecordsエントリを無視するため、プロファイルで「すべてのデータの編集」が有効化されている場合はエラーを返しません。

必須。MyCustomObject__cなど、このプロファイルで権限が変更されるオブジェクトの名前。

stringobject

オブジェクトの共有設定に関係なく、このプロファイルに割り当てられているユーザがobject項目で参照されているオ

booleanviewAllRecords

ブジェクトを参照できるか (true)、否か (false) を示します。これには非公開レコード (親オブジェクトを持たないレコード) を含みます。これは、個別のオブジェクトレベルに限定されている「すべてのデータの参照」ユーザ権限と同じです。これは、API バージョン 15.0 の新項目です。

メモ: この項目はすべてのオブジェクトで利用できるわけではありません。これらの権限を現在サポートしているオブジェクトを確認するには、ユーザインターフェースのプロファイルを参照してください。「すべてのデータの参照」を持つプロファイルは、メタデータ APIのviewAllRecordsエントリを無視するため、プロファイルで「すべてのデータの参照」が有効化されている場合はエラーを返しません。

364


ProfileApexPageAccess

ProfileApexPageAccess では、このプロファイルに割り当てられているユーザが実行できる Visualforce ページを決定します。

説明データ型項目名必須。Visualforce ページ名。stringapexPage

必須。このプロファイルに割り当てられているユーザがVisualforceページを実行できるか (true)、否か (false) を示します。

booleanenabled

ProfileRecordTypeVisibility

ProfileRecordTypeVisibility は、このプロファイルのレコードタイプの表示設定を表します。レコードタイプを使用すると、異なるビジネスプロセス、選択リストの値、およびページレイアウトを、さまざまなユーザに提供できます。

説明データ型項目名必須。レコードタイプがこのプロファイルとオブジェクトのペアのデフォルトであるか (true)、否か (false) を示しま

booleandefault

す。オブジェクトあたりに許可されるデフォルトは 1 つのみです。レコードタイプがこのプロファイルとオブジェクトのペアのデフォルトの個人取引先レコードタイプであるか (true)、

booleanpersonAccountDefault

否か (false) を示します。オブジェクトあたりに許可される個人取引先レコードタイプのデフォルトは 1 つのみです。この項目は、取引先または取引先責任者オブジェクトのレコードタイプにのみ関連します。個人取引先は、貴社が提供する金融サービス、オンラインショップ、または旅行代理店サービスの利用者など、貴社と取引がある個人の顧客を表します。個人取引先は、企業間取引モデルではなく、企業対消費者取引モデルのビジネス形態を持つ組織に適用できます。個人取引先についての詳細は、Salesforce オンラインヘルプの「個人取引先とは?」を参照してください。個人取引先は、Salesforce ではデフォルトで無効になっています。個人取引先の利用が必要な場合は、salesforce.comにお問い合わせください。

必須。Account.MyRecordTypeなどのレコードタイプ名。stringrecordType

必須。このレコードタイプがこのプロファイルに割り当てられているユーザに表示されるか (true)、否か (false) を示します。

booleanvisible

365


ProfileTabVisibility

ProfileTabVisibility はこのプロファイルのタブの表示設定を表します。バージョン 17.0 以降では、ProfileTabVisibilityは標準オブジェクトのタブの表示設定をサポートしています。マニフェストファイルには、プロファイルのタブの表示設定を取得するための標準タブに対応する標準オブジェクトを含める必要があります。

説明データ型項目名必須。タブの名前。stringtab

必須。タブの表示設定を示します。有効な値は、次のとおりです。

TabVisibility (string型の列挙)

visibility

• DefaultOff — このタブは [すべてのタブ] ページで利用できます。各ユーザは、どのアプリケーションでもタブが表示されるように表示をカスタマイズできます。

• DefaultOn — タブは [すべてのタブ] ページで利用でき、関連付けられているアプリケーションの表示タブに表示されます。各ユーザは、表示をカスタマイズしてタブを非表示にしたり、その他のアプリケーションで表示したりできます。

• Hidden — このタブは [すべてのタブ] ページでは利用できず、どのアプリケーションにも表示されません。

ProfileUserPermission

ProfileUserPermissionは、プロファイルのアプリケーション権限またはシステム権限を表します。権限ごとにこれらの要素の 1 つを使用します。

説明項目のデータ型項目必須。権限が有効化されるか (true)、無効化されるか(false) を示します。

booleanenabled

必須。権限名。stringname

Java のサンプル次のサンプルは、選択リスト、プロファイル、レコードタイプ、およびカスタムアプリケーションを使用します。

public void profileSample() {try {// Create an expense report record, tab and app...CustomObject expenseRecord = new CustomObject();expenseRecord.setFullName("ExpenseReport__c");expenseRecord.setLabel("Expense Report");expenseRecord.setPluralLabel("Expense Reports");

expenseRecord.setDeploymentStatus(DeploymentStatus.Deployed);expenseRecord.setSharingModel(SharingModel.ReadWrite);

CustomField nameField = new CustomField();nameField.setType(FieldType.AutoNumber);nameField.setLabel("Expense Report Number");nameField.setDisplayFormat("ER-{0000}");expenseRecord.setNameField(nameField);

366


AsyncResult[] arsExpenseRecord =metadataConnection.create(new Metadata[] {expenseRecord});

Picklist expenseStatus = new Picklist();PicklistValue unsubmitted = new PicklistValue();unsubmitted.setFullName("Unsubmitted");PicklistValue submitted = new PicklistValue();submitted.setFullName("Submitted");PicklistValue approved = new PicklistValue();approved.setFullName("Approved");PicklistValue rejected = new PicklistValue();rejected.setFullName("Rejected");expenseStatus.setPicklistValues(new PicklistValue[] {

unsubmitted, submitted, approved, rejected});

CustomField expenseStatusField = new CustomField();expenseStatusField.setFullName(

"ExpenseReport__c.ExpenseStatus__c");expenseStatusField.setLabel("Expense Report Status");expenseStatusField.setType(FieldType.Picklist);expenseStatusField.setPicklist(expenseStatus);AsyncResult[] arsStatusField =

metadataConnection.create(new Metadata[]{expenseStatusField});

CustomTab expenseTab = new CustomTab();expenseTab.setFullName("ExpenseReport__c");expenseTab.setMotif("Custom70: Handsaw");expenseTab.setCustomObject(true);AsyncResult[] arsTab =

metadataConnection.create(new Metadata[] {expenseTab});

CustomApplication application = new CustomApplication();application.setFullName("ExpenseForce");application.setTab(new String[] {expenseTab.getFullName()});AsyncResult[] arsApp =

metadataConnection.create(new Metadata[] {application});

// Employees and managers have the same app visibility...ProfileApplicationVisibility appVisibility =

new ProfileApplicationVisibility();appVisibility.setApplication("ExpenseForce");appVisibility.setVisible(true);

Profile employee = new Profile();employee.setFullName("Employee");employee.setApplicationVisibilities(

new ProfileApplicationVisibility[] {appVisibility});AsyncResult[] arsProfileEmp =metadataConnection.create(new Metadata[] {employee});

Profile manager = new Profile();manager.setFullName("Manager");manager.setApplicationVisibilities(

new ProfileApplicationVisibility[] {appVisibility});AsyncResult[] arsProfileMgr =

metadataConnection.create(new Metadata[] {manager});

// But employees and managers have different access// to the state of the expense sheetRecordType edit = new RecordType();edit.setFullName("ExpenseReport__c.Edit");RecordTypePicklistValue editStatuses =

new RecordTypePicklistValue();

367


editStatuses.setPicklist("ExpenseStatus__c");editStatuses.setValues(new PicklistValue[]

{unsubmitted, submitted});edit.setPicklistValues(new RecordTypePicklistValue[]

{editStatuses});AsyncResult[] arsRecTypeEdit =

metadataConnection.create(new Metadata[] {edit});

RecordType approve = new RecordType();approve.setFullName("ExpenseReport__c.Approve");RecordTypePicklistValue approveStatuses =

new RecordTypePicklistValue();approveStatuses.setPicklist("ExpenseStatus__c");approveStatuses.setValues(new PicklistValue[]

{approved, rejected});approve.setPicklistValues(new RecordTypePicklistValue[]

{approveStatuses});AsyncResult[] arsRecTypeApp =

metadataConnection.create(new Metadata[] {approve});} catch (ConnectionException ce) {ce.printStackTrace();

}}

宣言的なメタデータの定義のサンプルカスタムアプリケーション、カスタムオブジェクト、レコードタイプ、タブ、およびユーザ権限を持つ組織のプロファイルの定義を次に示します。

<?xml version="1.0" encoding="UTF-8"?><Profile xmlns="http://soap.sforce.com/2006/04/metadata">

<applicationVisibilities><application>PubApps__Myriad_Publishing</application><default>false</default><visible>true</visible>

</applicationVisibilities><custom>true</custom><objectPermissions>

<object>TestWeblinks__c</object></objectPermissions><recordTypeVisibilities>

<default>true</default><recordType>TestWeblinks__c.My First Recordtype</recordType><visible>true</visible>

</recordTypeVisibilities><tabVisibilities>

<tab>Myriad Publications</tab><visibility>DefaultOn</visibility>

</tabVisibilities><userPermissions>

<enabled>true</enabled><name>APIEnabled</name>

</userpermissions></Profile>

使用方法retrieve()コールを使用して組織内のプロファイルに関する情報を取得する場合、返される .profileファイルには retrieve 要求で参照されるその他のメタデータ型のセキュリティ設定のみが含まれます (常に取得されるユーザ権限、IP アドレス範囲、およびログイン時間は除く)。たとえば、以下のpackage.xmlファイルにはすべてのカスタムオブジェクトに一致するtypes要素が含まれています。そのため、返されたプロファイルには組織

368


のすべてのカスタムオブジェクトのオブジェクトおよび項目権限が含まれますが、Account などの標準オブジェクト、および標準項目の権限は含まれません。



</types><types>

<members>*</members><name>Profile</name>


</Package>

CustomObject のワイルドカード「*」は標準オブジェクトに一致しません。これは、意図しない大きな影響を及ぼすプロファイルの変更を避けるうえで役立ちます。Developer Edition 組織のいくつかのカスタムオブジェクトを作成し、その情報を retrieve() (取得) し、次にカスタムオブジェクトを本番組織に deploy() (リリース) する場合、Account などのすべての標準オブジェクトのプロファイルおよび項目レベルのセキュリティ、および標準項目は、標準オブジェクトまたは項目の個別の types要素を明示的に作成しない限り上書きされません。メタデータ APIでは、予期しないプロファイルの変更を回避するため、retrieve()コールに標準項目を含めることが意図的に若干困難になっています。ただし、Account などの標準オブジェクトのカスタム項目と標準項目のプロファイル権限を取得およびリリースすることはできます。次のpackage.xmlファイルでは、Account 標準項目とカスタム項目のプロファイル権限を返すことができます。CustomObject 型のメンバーとして標準の Account オブジェクトを指定することにより、types要素内でこのオブジェクトがどのように定義されるかに注目してください。


<types><members>Account</members><name>CustomObject</name>

</types><types>



</Package>

最後の package.xmlファイルでは、Account オブジェクトの MyCustomField__cカスタム項目のプロファイル権限を返すことができます。


<types><members>Account.MyCustomField__c</members><name>CustomField</name>

</types><types>



</Package>

369


Queue処理する前にアイテムを置いておく領域を表します。

宣言的なメタデータファイルのサフィックスおよびディレクトリの場所キューコンポーネントのファイルサフィックスは .queueで、コンポーネントは対応するパッケージディレクトリの queuesディレクトリに保存されます。このコンポーネントは、ケース、リード、サービス契約 (エンタイトルメントが有効である場合)、およびカスタムオブジェクトをサポートします。

バージョンキューコンポーネントは、API バージョン 24.0 以降で使用できます。

項目このメタデータ型はキューを定義する有効な値を表します。

説明データ型項目名新しいレコードがキューに追加されたときに、メールがキューメンバーに送信されるか (true)、否か (false) を示します。

booleandoesSendEmailToMembers

キューの所有者のメールアドレス。stringemail


stringfullName

文字であること、空白は使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。この項目は、Metadata コンポーネントから継承されています。ユーザインターフェースの [キュー名] に対応します。必須。キューの名前。ユーザインターフェースの [表示ラベル] に対応します。

stringname

サポートされているエンティティ種別を示します。QueueSobject[]queueSobject

QueueSobject

QueueSobject ではキューがサポートするエンティティ種別を表します。

説明データ型項目名有効な値は、次のとおりです。stringsobjectType

• Case

• Lead

• ServiceContract

• カスタムオブジェクト (たとえば、ObjA_c)

370

Queueメタデータ型

宣言的なメタデータの定義のサンプルケース、リードおよび ObjA という名前のカスタムオブジェクトをサポートするキューの定義を次に示します。

<?xml version="1.0" encoding="UTF-8"?><Queue xmlns="http://soap.sforce.com/2006/04/metadata">

<doesSendEmailToMembers>true</doesSendEmailToMembers><email>[email protected]</email><fullName>Your Name</fullName><name>memberQueue</name><queueSobject>

<sobjectType>Case</sobjectType></queueSobject><queueSobject>

<sobjectType>Lead</sobjectType></queueSobject><queueSobject>

<sobjectType>ObjA_c</sobjectType></queueSobject>

</Queue>

QuickActionChatter パブリッシャーで使用可能となるオブジェクトに対して指定された作成または更新アクションを表します。たとえば、取引先の詳細ページで、ユーザがそのページの Chatter フィードからその取引先に関連する取引先責任者を作成するアクションを作成できます。QuickAction は、カスタム項目が許可されたオブジェクトで作成できます。サポートされる親オブジェクトは、次のとおりです。• Account• Campaign• Case• Contact• Custom objects• Group• Lead• Opportunity

メモ: アプリケーションでは、QuickActionはアクションまたはパブリッシャーアクションと呼ばれます。

ファイルのサフィックスおよびディレクトリの場所QuickAction コンポーネントのサフィックスは quickActionで、quickActionsフォルダに保存されます。

バージョンQuickAction コンポーネントは、API バージョン 28.0 以降で使用できます。

項目

説明項目のデータ型項目名キャンバスアプリケーションを使用してカスタムアクションを作成する場合に、アプリケーションを特定します。ク

stringcanvas

371

QuickActionメタデータ型

説明項目のデータ型項目名イックアクション種別がCanvasの場合はキャンバスアプリケーションの完全修飾名を <namespace>__<dev_name>形式で返し、そうでない場合は null を返します。この項目はAPI バージョン 29.0 以降で使用できます。アクションの説明。stringdescription

QuickAction 内で上書きできる特定の項目。FieldOverridefieldOverrides

カスタムアクションを作成する場合、この値がアクションペインの高さ (ピクセル単位) になります。

intheight

アクションの識別に使用するアイコン。stringicon

このコンポーネントが保護されるか (true)、否か (false)を示します。保護コンポーネントは、インストールする組

booleanisProtected

織で作成されたコンポーネントによってリンク設定したり参照したりすることはできません。アクションを特定し、ユーザに表示します。これは、APIおよび管理パッケージに使用するデフォルトの識別子でもあります。

stringlabel

Visualforceページを使用してカスタムアクションを作成する場合に、ページを特定します。

stringpage

アクション中の項目のレイアウト。QuickActionLayoutquickActionLayout

アクションに使用する標準表示ラベルを指定します。有効な値は、次のとおりです。

QuickActionLabel(string 型の列挙)

standardLabel

• LogACall

• LogANote

• New (新しいレコード)• NewRecordType (表示ラベルが「新しいアイデア」など

のような場合)• Update

• UpdateRecordType

• NewChild (新しい子レコード)• NewChildRecordType

• CreateNew

• CreateNewRecordType (表示ラベルが「新しいアイデアを作成」などのような場合)

• SendEmail (この値は API バージョン 31.0 以降で使用できます)。

• QuickRecordType

• Quick (クイックレコード)

アクションを作成および実行する対象となるオブジェクト。たとえば、取引先の詳細ページで、ユーザがそのページのChatter フィードからその取引先に関連する取引先責任者を

stringtargetObject

372


説明項目のデータ型項目名作成するアクションを作成できます。この場合、取引先責任者が targetObjectになります。

アクションの親オブジェクト種別。ターゲットオブジェクトを親オブジェクトにリンクします。たとえば、ターゲッ

stringtargetParentField

トオブジェクトが取引先責任者であり、親オブジェクトが取引先である場合、取引先を使用します。作成するレコードタイプを指定します。有効な値は、次のとおりです。

stringtargetRecordType

• 法人取引先• 個人取引先• 主取引先

クイックアクションの種別。有効な値は、次のとおりです。QuickActionType(string 型の列挙)

type

• Create

• VisualforcePage

• Post

• SendEmail (この値は API バージョン 31.0 以降で使用できます)。

• LogACall

• SocialPost

• Canvas

• Update

カスタムアクションを作成する場合、この値がアクションペインの幅 (ピクセル単位) になります。

intwidth

FieldOverride

QuickAction での上書きを構成する項目名、各項目の数式およびリテラル値を表します。

説明項目のデータ型項目名上書きを許可する特定の項目の名前。stringfield

項目を上書きするときに使用する数式を指定します。stringformula

上書きなしの項目の値。stringliteralValue

QuickActionLayout

アクション中の項目のレイアウト。アクションレイアウトに追加できる項目数にハードリミットはありません。ただし、使いやすさを最適化するため、最大 8 項目をお勧めします。20 項目以上を追加すると、ユーザの効率が大幅に低下します。

説明項目のデータ型項目名使用するレイアウト構造の種別。有効な値は、次のとおりです。

LayoutSectionStyle(string 型の列挙)

layoutSectionStyle

• TwoColumnsTopToBottom

373


説明項目のデータ型項目名• TwoColumnsLeftToRight

• OneColumn

• CustomLinks

QuickActionLayout の列を指定します。QuickActionLayoutColumn[]quickActionLayoutColumns

QuickActionLayoutColumn

QuickActionLayout に定義される列です。

説明項目のデータ型項目名QuickActionLayoutColumn の行アイテムを指定します。QuickActionLayoutItem[]quickActionLayoutItems

QuickActionLayoutItem

項目で構成され QuickActionLayoutColumn 用に定義される行アイテムです。

説明項目のデータ型項目名このレイアウト項目が空白スペースであるか (true)、否か(false) を制御します。

booleanemptySpace

QuickActionLayoutItem の特定の項目を表します。アクションレイアウトに追加できる項目数にハードリミットはありま

stringfield

せん。ただし、使いやすさを最適化するため、最大 8 項目をお勧めします。20 項目以上を追加すると、ユーザの効率が大幅に低下します。QuickActionLayoutItem の特定の項目に関するユーザ入力動作を指定します。有効な値は、次のとおりです。

UiBehavior (string型の列挙)

uiBehavior

• Edit

• Required

• Readonly

宣言的なメタデータの定義のサンプル次に、QuickAction コンポーネントの例を示します。

<?xml version="1.0" encoding="UTF-8"?><QuickAction xmlns="http://soap.sforce.com/2006/04/metadata">

<description>testActionDefinitionTypesCreate</description><fieldOverrides>

<field>DoNotCall</field><formula>TRUE</formula>

</fieldOverrides><fieldOverrides>

<field>LeadSource</field><literalValue>Partner</literalValue>

</fieldOverrides><label>testActionDefinitionTypesCreate</label><quickActionLayout>

<layoutSectionStyle>TwoColumnsLeftToRight</layoutSectionStyle><quickActionLayoutColumns>

<quickActionLayoutItems>

374


<emptySpace>false</emptySpace><field>HomePhone</field><uiBehavior>Required</uiBehavior>

</quickActionLayoutItems><quickActionLayoutItems>

<emptySpace>true</emptySpace><uiBehavior>Edit</uiBehavior>


<emptySpace>false</emptySpace><field>Name</field><uiBehavior>Required</uiBehavior>


<emptySpace>false</emptySpace><field>AccountId</field><uiBehavior>Edit</uiBehavior>

</quickActionLayoutItems></quickActionLayoutColumns><quickActionLayoutColumns>

<quickActionLayoutItems><emptySpace>false</emptySpace><field>Description</field><uiBehavior>Edit</uiBehavior>

</quickActionLayoutItems></quickActionLayoutColumns>

</quickActionLayout><targetObject>Contact</targetObject><targetParentField>Account</targetParentField><type>Create</type>

</QuickAction>

RemoteSiteSettingリモートサイトの設定を表します。Sコントロールやカスタムボタンで XmlHttpRequest を使用し、Visualforceページ、Apex呼び出し、または JavaScript コードで外部サイトを呼び出せるようにするには、[リモートサイトの設定] ページにそのサイトを登録しておく必要があります。これを行わないと、呼び出しは失敗します。RemoteSiteSetting は Metadata メタデータ型を拡張し、その fullName項目を継承します。

宣言的なメタデータファイルのサフィックスおよびディレクトリの場所RemoteSiteSetting コンポーネントは、対応するパッケージディレクトリの remoteSiteSettingsディレクトリに保存されます。ファイル名はリモートサイトの設定の一意の名前に一致し、拡張子は .remoteSiteです。

バージョンRemoteSiteSetting コンポーネントは、API バージョン 19.0 以降で使用できます。

項目

説明データ型項目このリモートサイトの設定の使用目的を解説する説明。

stringdescription

必須。ユーザ接続が HTTP または HTTPS 経由であるかに関係なく、Salesforce 内のコードでリモートサ

booleandisableProtocolSecurity

イトにアクセスできるか (true)、否か (false)、を示

375

RemoteSiteSettingメタデータ型

説明データ型項目します。trueである場合、Salesforce 内のコードはHTTPS セッションから HTTP セッションに、またその逆方向にもデータを渡せます。

警告: セキュリティについて理解した上でtrueに設定してください。

名前には、英数字、およびアンダースコア (_) 文字のみを使用できます。また、最初は文字とし、最後に

stringfullName

アンダースコアを使用したり、連続した 2 つのアンダースコア文字を含めたりすることはできません。この項目はMetadata コンポーネントから継承するため、この項目はこのコンポーネントの WSDL で定義されません。作成時、更新時、または削除時に指定する必要があります。コールにおけるこの項目の例を確認するには、「create()」を参照してください。

必須。リモートサイトの設定が有効であるか (true)、否か (false) を示します。

booleanisActive

必須。リモートサイトの URL。stringurl

宣言的なメタデータの定義のサンプルリモートサイトの設定の XML 定義のサンプルを以下に示します。

<?xml version="1.0" encoding="UTF-8"?><RemoteSiteSetting xmlns="http://soap.sforce.com/2006/04/metadata">

<description>Used for Apex callout to mapping web service</description><disableProtocolSecurity>false</disableProtocolSecurity><isActive>true</isActive><url>https://www.maptestsite.net/mapping1</url>

</RemoteSiteSetting>

Reportカスタムレポートを表します。Metadata メタデータ型を拡張し、その fullName項目を継承します。このメタデータ型でサポートされるのはカスタムレポートのみです。標準レポートはサポートされません。

宣言的なメタデータファイルのサフィックスおよびディレクトリの場所レポートは、対応するパッケージディレクトリの reportsディレクトリに保存されます。ファイル名はレポートタイトルに一致し、拡張子は .reportです。

レポートの取得package.xmlではレポートにワイルドカード (*) 記号を使用できません。明示的な名前を package.xmlに入力するためにレポートのリストを取得するには、listMetadata()をコールし、ReportFolderをデータ型として渡します。ReportFolder は describeMetadata()ではデータ型として返されません。レポートは、inFolder

376

Reportメタデータ型

の関連付けられている属性が true に設定された describeMetadata()から返されます。この属性が true に設定されている場合は、ReportFolder など、「Folder」という単語を含むコンポーネント名を使用してデータ型を作成できます。次の例では、package.xml内のフォルダを示します。



</types><types>


</types><types>


</types><types>



</Package>

バージョンReport コンポーネントは、API バージョン 14.0 以降で使用できます。

項目次の情報は、レポートの作成と実行を十分に理解していることを前提としています。これらの項目についての詳細は、Salesforce オンラインヘルプの「レポートの作成」を参照してください。

説明データ型項目サマリーレポート、マトリックスレポート、および結合レポートのカスタム集計項目を定義するリスト。

ReportAggregate[]aggregates

すべてのブロックのレポートタイプが異なる可能性がある結合レポートの各ブロックを表します。

Report[]block

結合レポートの各ブロックの属性を定義します。

ReportBlockInfoblockInfo

レポートに使用されるバケット項目を定義します。この項目は API バージョン24.0 以降で使用できます。

ReportBucketField[]buckets

サマリーレポートとマトリックスレポートのグラフを定義します。

ReportChartchart

レポートサマリーデータの条件付き強調表示を指定するリスト。

ReportColorRange[]colorRanges

377


説明データ型項目レポートに表示される項目を指定するリスト。項目がレポートに表示される順序

ReportColumn[]columns

は、メタデータ API ファイルに表示される順序と同じです。クロス条件のオブジェクト、関連オブジェクト、条件 (「含む」または「含ま

ReportCrossFilter[]crossFilters

ない」) を定義します。この項目は APIバージョン 31.0 以降で使用できます。マルチ通貨を使用する場合、一部のレポートでは、適切な列を表示対象として

CurrencyIsoCode (string 型の列挙)currency

選択すると、換算された金額を表示できます。たとえば、商談レポートでは、[金額] (換算値) 列をレポートに含めることができます。この項目は、換算額を表示する通貨を定義する string型の列挙です。有効値: USD、GBP、JPYなど、ISO4217 標準で定義された有効な英字 3 文字の ISO 通貨コードである必要があります。レポート名と一緒に表示される一般情報を指定します。最大文字数は 255 文字です。

stringdescription

組織がディビジョンを使用してデータを分類しており、「ディビジョンの使用」

stringdivision

権限を持っている場合は、レポート内のレコードはこのディビジョンと一致する必要があります。この項目は API バージョン 17.0 以降で使用できます。

レポートの結果を、特定のデータを持つレコードに制限します。たとえば、次の

ReportFilterfilter

ようにレポートの結果を金額が 1,000 ドルを超える商談に制限できます。<filter><criteriaItems><column>AMOUNT</column>

<operator>greaterThan</operator>

<value>1000</value></criteriaItems></filter>

詳細は、Salesforce オンラインヘルプの「検索条件の入力」を参照してください。

378


説明データ型項目レポート形式を定義します。たとえば、小計のない単純なデータリストの場合はTabularを使用します。

ReportFormat (string 型の列挙)format

API アクセスの識別子として使用される、レポートの一意の開発者名。

stringfullName

fullNameには、アンダースコアと英数字のみを使用できます。一意であること、最初は文字であること、空白は使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。この項目は、Metadata コンポーネントから継承されています。マトリックスレポートでデータのグループ化と小計の基準となる項目を定義する

ReportGrouping[]groupingsAcross

リスト (行ヘッダー)。日付項目でグループ化する場合は、日、週、または月などの特定の期間を使用してデータをさらにグループ化できます。最大項目数は 2 です。サマリーレポートとマトリックスレポートの場合でグループ化と小計の基準とな

ReportGrouping[]groupingsDown

る項目を定義するリスト。サマリーレポートでは、複数の並び替え項目を選択してデータを並び替えできます。マトリックスレポートでは、列ヘッダーとなる集計項目を指定します。日付項目でグループ化する場合は、日、週、または月などの特定の期間を使用してデータをさらにグループ化できます。マトリックスレポートの最大値は 2 です。サマリーレポートの最大値は 3 です。履歴トレンドレポートデータをキャプチャする日付範囲を定義します。デフォルトは「任意の履歴日付」です。API バージョン 29 以降で利用できます。

ReportHistoricalSelectorhistoricalSelector

必須。レポート名。たとえば、Opportunity Pipelineのように設定します。

stringname

各レポートタイプに固有の設定、特にレポートを絞り込んで役に立つサブセット

ReportParam[]params

を取得できるようにするオプションを指定するリスト。たとえば、活動レポート

379


説明データ型項目タイプを使用すると、活動予定、完了した活動、またはその両方を表示するかどうかや、ToDo、行動、またはその両方を表示するかどうかを指定できます。有効な値はレポートタイプに応じて異なります。必須。レポート内のデータの型を定義します。たとえば、商談データのレポート

stringreportType

を作成するには、Opportunityを指定します。レポートドリルダウンのロール名。商談レポートや活動レポートなどの一部のレ

stringroleHierarchyFilter

ポートには [階層] リンクが表示され、そこからロール階層に基づいてさまざまなデータセットにドリルダウンできます。この項目は API バージョン 17.0 以降で使用できます。

レポートで返すことができる最大行数を定義します。

introwLimit

レポートの実行対象となるデータの範囲を定義します。たとえば、すべての商

stringscope

談、自分が所有する商談、所属するチームが所有する商談に対してレポートを実行するかどうかなどです。有効な値は、reportTypeによって異なります。たとえば、Account レポートの場合、次の値になります。• MyAccounts

• MyTeamsAccounts

• AllAccounts

マトリックス形式の履歴トレンドレポートの場合、trueに設定できます。API バージョン 29 以降で利用できます。

booleanshowCurrentDate

falseを指定すると、ヘッダー、小計、合計のみのレポートの折りたたみビューが表示されます。デフォルト: true

booleanshowDetails

レポートのデータの並び替え対象となる項目を指定します。並び替え順を指定するには、sortOrderを使用します。

stringsortColumn

380


説明データ型項目並び替え順を指定します。並び替え対象となる項目を指定するには、sortColumnを使用します。


レポートドリルダウンのテリトリー名。組織がテリトリー管理を使用している場

stringterritoryHierarchyFilter

合、一部のレポートには [階層] リンクが表示され、そこからテリトリー階層に基づいてさまざまなデータセットにドリルダウンできます。この項目は API バージョン 17.0 以降で使用できます。

レポートの結果を、指定した期間内のレコードに制限します。

ReportTimeFrameFiltertimeFrameFilter

レポートドリルダウンのユーザ名。商談レポートや活動レポートなどの一部のレ

stringuserFilter

ポートには [階層] リンクが表示され、そこからユーザ階層に基づいてさまざまなデータセットにドリルダウンできます。この項目は API バージョン 17.0 以降で使用できます。

ReportAggregate

ReportAggregate は、サマリーレポート、マトリックスレポート、および結合レポートのカスタム集計項目を定義します。これらの項目についての詳細は、Salesforceオンラインヘルプの「カスタム集計項目の作成」を参照してください。

説明データ型項目カスタム集計項目を表示する行のグループ化レベルを定義します。これは、API バージョン 15.0 の新項目です。

stringacrossGroupingContext

必須。カスタム集計項目。たとえば、AMOUNT:SUM

+ OPP_QUANTITY:SUMのようになります。stringcalculatedFormula

必須。カスタム集計項目の結果の書式設定および表示用のデータ型を指定します。

ReportAggregateDatatype(string 型の列挙)

datatype

カスタム集計項目の説明。最大 255 文字です。stringdescription

必須。カスタム集計項目の内部開発名。たとえば、FORMULA1などです。これは、条件付き強調表示な

stringdeveloperName

ど、他のレポートコンポーネントからカスタム集計項目を参照するために使用されます。

381


説明データ型項目カスタム集計項目を表示する列のグループ化レベルを定義します。この項目は API バージョン 15.0 以降で使用できます。

stringdownGroupingContext

必須。trueを指定すると、数式の結果がレポートに表示されます。falseを指定すると、結果がレポートに表示されません。

booleanisActive

カスタム集計項目が、結合レポートで使用できるクロスブロック集計項目であるかどうかを決定します。

booleanisCrossBlock

trueは、クロスブロックカスタム集計項目であることを示します。falseは、標準のカスタム集計項目であることを示します。この項目は API バージョン 25.0 以降で使用できます。

必須。カスタム集計項目の表示ラベル (名前)。stringmasterLabel

結合レポートでは必須。aggregateを追加できるブロックの reportTypeを指定します。

stringreportType

数式の結果は、指定された小数点以下の桁数に計算されます。有効な値は 0～ 18です。

intscale

ReportBlockInfo

ReportBlockInfo は、結合レポートのブロックを定義します。

説明データ型項目結合レポートブロックで使用されるカスタム集計項目を表す aggregatesをリストします。

ReportAggregateReference[]aggregateReferences

必須。blockIdは、各集計項目を含むブロックを識別するために、クロスブロックカスタム集計項目と

stringblockId

結合レポートのグラフで使用されます。blockIdは、自動的に割り当てられます。有効な値は、B1 から B5です。この項目は API バージョン 25.0 以降で使用できます。

必須。結合レポートのブロックの結合に使用されるエンティティを参照します。このエンティティによっ

stringjoinTable

て、複数のブロックにまたがってグローバルにグループ化可能な項目のリストが提供されます。

ReportAggregateReference

ReportAggregateReference は、結合レポートのカスタム集計項目に使用される開発者名を定義します。

382


説明データ型項目必須。結合レポートのブロックで使用されるカスタム集計項目を指定する、ReportAggregate のdeveloperName。

stringaggregate

ReportBucketField

ReportBucketField は、レポートで使用されるバケットを定義します。

説明データ型項目必須。バケットの種別を指定します。有効な値は次のとおりです。

ReportBucketFieldType(string 型の列挙)

bucketType

• text• number• picklist

必須。列リストやその他のレポートコンポーネント(並び替え、検索条件、リスト、グループ、グラフな

stringdeveloperName

ど) にバケット項目を表示するために <field>値として使用される一意の名前。BucketField_nameの形式にする必要があります。たとえば、BucketField_BusinessSizeです。必須。バケット項目の表示ラベル。最大 40 文字です。表示ラベルの先頭と末尾にある改行、タブ、複

stringmasterLabel

数の空白はすべて削除されます。表示ラベル内にあるこれらの文字は 1 文字の空白に変換されます。数値バケット項目のみが対象。空の値を 0 として扱うか (z)、否か (n) を指定します。

ReportBucketFieldNullTreatment(string 型の列挙)

nullTreatment

バケット化が解除された値のコンテナの表示ラベル。stringotherBucketLabel

必須。バケットが適用されるソース項目。たとえば、SALESまたは INDUSTRYです。

stringsourceColumnName

バケット項目で使用される 1 つのバケット値を定義します。

ReportBucketFieldValue(string 型の列挙)

values

メモ: この名前は複数形ですが、1 つのバケットを表します。典型的な使用方法では、バケット項目には複数のバケットが含まれます。

ReportBucketFieldValue

ReportBucketFieldValue は、バケット項目で使用されるバケット値を定義します。

383


説明データ型項目バケット項目内のバケットの値。有効な値は次のとおりです。

ReportBucketFieldSourceValue(string 型の列挙)

sourceValues

• sourceValue — 選択リスト項目およびテキストバケット項目に使用されます。選択リストの場合、バケット内の選択リスト項目を説明します。たとえば、TYPEのバケットの sourceValue は、Customerの場合があります。テキストの場合、バケット内の項目の文字列全体です。たとえば、ADDRESS_STATE1のバケットの sourceValue は、NYの場合があります。

• from — 数値バケット項目でのみ使用されます。数値バケット範囲の下限を示します (この値は範囲に含まれない)。この値は数値である必要があります。

• to — 数値バケット項目でのみ使用されます。数値バケット範囲の上限を示します (この値は範囲に含まれる)。この値は数値である必要があります。

数値バケットでは、最初の値にはtoのみ、最後の値にはfromのみが設定されている必要があります。それ以外のすべての値は、toと fromの両方が設定されている必要があります。

必須。バケット項目内の特定のバケット値の名前。stringvalue

ReportGrouping

ReportGrouping は、サマリーレポート、マトリックスレポート、および結合レポートでのデータのグループ化、小計算出、および並び替えの方法を定義します。

説明データ型項目並び替え基準になる集計値の種別。有効な値は、次のとおりです。

ReportAggrType (string型の列挙)

aggregateType

• Sum

• Average

• Maximum

• Minimum

• RowCount

日付項目でグループ化する場合、グループ化の基準となる期間。

UserDateGranularity (string型の列挙)

dateGranularity

必須。データの集計の基準となる項目。たとえば、CAMPAIGN_SOURCEのようになります。

stringfield

グルーピングの並び替えに使用する列、集計項目、またはカスタム集計項目の API 名。

stringsortByName

384


説明データ型項目必須。データを英数字の昇順と降順のどちらで並び替えるかを示します。

SortOrdersortOrder

グルーピングが列、集計項目、カスタム集計項目のどれを基準に並び替えられるかを示します。有効な値は、次のとおりです。

ReportSortType (string 型の列挙)

sortType

• Column

• Aggregate

• CustomSummaryFormula

ReportHistoricalSelector

ReportHistoricalSelector は、履歴データの日付の範囲を定義します。

説明項目のデータ型項目履歴条件に適用する相対 (N_DAYS_AGO:2形式) または絶対 (yyyy-MM-dd形式) 日付値を表します。指定

stringsnapshot

されていない場合、ユーザに表示されるすべての列に条件が適用されるとみなされます。API バージョン 29 以降で利用できます。

SortOrder

レポート項目でのデータの並び替え順序を定義する string 型の列挙です。有効な値は次のとおりです。

説明項目データを英数字の昇順に並び替えます。Asc

データを英数字の降順に並び替えます。Desc

UserDateGranularity

データのグループ化の基準となる期間を定義する string 型の列挙です。有効な値は次のとおりです。

説明列挙値日付によるグループ化なしNone

日別Day

週別Week

月別Month

四半期別Quarter

年別Year

会計四半期別。組織の四半期年度を設定できます。Salesforceオンラインヘルプの「会計年度の設定」を参照してください。

FiscalQuarter

会計年度別FiscalYear

385


説明列挙値カレンダー月別MonthInYear

カレンダー日別DayInMonth

会計期間別 (カスタム会計年度が有効な場合)FiscalPeriod

会計週別 (カスタム会計年度が有効な場合)FiscalWeek

ReportSummaryType

レポート項目の集計方法を定義する string 型の列挙です。有効な値は次のとおりです。

説明列挙値合計Sum

平均Average

最大値Maximum

最小値Minimum

この項目は集計されません。None

ReportColorRange

ReportColorRange は、レポートサマリーデータの条件付き強調表示を定義します。

説明データ型項目必須。columnNameで指定された項目の集計方法を定義します。たとえば、Sumです。

ReportSummaryType (string型の列挙)

aggregate

必須。値の範囲を色で表現する項目を指定します。stringcolumnName

必須。ミドルレンジの色をミドルレンジの色と分割する数値を指定します。

doublehighBreakpoint

必須。ハイレンジの数値として分類されたデータを表す色を指定します (HTML 形式)。この色は、highBreakpointを超える値に対応します。

stringhighColor

必須。ローレンジの色をハイレンジの色と分割する数値を指定します。

doublelowBreakpoint

必須。ローレンジの値 (lowBreakpoint値未満) として分類されたデータを表す色を指定します (HTML形式)。

stringlowColor

必須。ミドルレンジの値として分類されたデータを表す色を指定します (HTML 形式)。

stringmidColor

ReportColumn

ReportColumn は、レポート内での項目 (列) の表示方法を定義します。

386


説明データ型項目各レポート項目が集計されるかどうか、および集計方法を定義するリスト。

ReportSummaryType[](string 型の列挙)

aggregateTypes

必須。項目名。たとえば、AGEまたはOPPORTUNITY_NAMEなどです。

stringfield

履歴トレンドレポートの日付値と金額値が増加している場合、デフォルトの色をそれぞれ緑と赤に置き換えて表示します。API バージョン 29.0 以降で利用できます。

booleanreverseColors

履歴トレンドレポートに、現在と履歴の日付値と金額値の差を表示する列を追加します。API バージョン 29.0 以降で利用できます。

booleanshowChanges

ReportFilter

ReportFilter は、指定された項目に基づいてデータを絞り込み、レポートの結果を制限します。

説明データ型項目検索条件ロジックの条件を指定します。検索条件ロジックの詳細は、Salesforce オンラインヘルプの「検

stringbooleanFilter

索条件ロジックを最大限に活用」を参照してください。レポートデータの絞り込み条件 (履歴値の比較または日付の範囲の適用のいずれか)。<criteriaItems>

criteriaItems ReportFilterItem

ReportFilterItemcriteriaItems

<column>Opportunity.Opportunity__hd$Amount__hst</column>

<columnToColumn>false</columnToColumn>

<operator>equals</operator><snapshot>N_DAYS_AGO:90</snapshot><value>100</value>

</criteriaItems>

レポートで演算子 containsまたは startsWithを使用して選択リスト値を絞り込むときに使用される

Language (string 型の列挙)language

言語。有効な言語の値の一覧は、「Translations」を参照してください。

ReportFilterItem

ReportFilterItem は、指定された項目に基づいてデータを絞り込み、レポートの結果を制限します。

387


説明データ型項目必須。データの絞り込み対象となる項目。たとえば、AMOUNTのようになります。

stringcolumn

項目に履歴スナップショットからのデータが含まれることを示します。API バージョン 29 以降で利用できます。

booleancolumnToColumn

必須。データの絞り込みに使用する演算子(greaterThanなど) を定義する string 型の列挙。有

FilterOperation (string 型の列挙)

operator

効な値については、「FilterOperation」を参照してください。相対 (N_DAYS_AGO:2形式) または絶対 (yyyy-MM-dd形式) 日付値を表します。API バージョン 29 以降で利用できます。

stringsnapshot

データの絞り込みに使用する値。たとえば、1000などです。メタデータ API検索条件値は、レポートウィ

stringvalue

ザードに入力した検索条件値と一致しない場合があります。たとえば、メタデータ API では日付は常に米国の日付形式に変換され、非英語言語で入力された値は標準の米国英語の同等の形式に変換される可能性があります。

ReportFormat

レポート形式を定義する string 型の列挙です。有効な値は次のとおりです。

説明列挙値データをグリッドに集計します。関連する合計を比較するために使用します。Matrix

データをリスト、並び替え、および小計します。Summary

並び替えや小計なしでデータをリストします。Tabular

各レポートのデータをそれぞれのブロックに保存しているさまざまなレポートタイプからデータを結合します。

Joined

ReportParam

ReportParam は、レポートタイプに固有の設定、特に、レポートを特定の便利なサブセットに絞り込めるようにするオプションを表します。

説明データ型項目必須。固有の reportType設定を指定します。stringname

必須。設定値。stringvalue

388


ReportAggregateDatatype

カスタム集計項目結果の書式設定および表示用のデータ型を指定する string 型の列挙です。有効な値は次のとおりです。

列挙値currency

number

percent

ReportChart

ReportChart は、サマリーレポート、マトリックスレポート、および結合レポートのグラフを表します。

説明データ型項目背景のグラデーションの開始色を指定します (HTML形式)。

stringbackgroundColor1

背景のグラデーションの終了色を指定します (HTML形式)。

stringbackgroundColor2

背景のグラデーションの色の方向を指定します。グラデーションデザインの開始色を指定する

ChartBackgroundDirection(string 型の列挙)

backgroundFadeDir

backgroundColor1、および終了色を指定するbackgroundColor2と一緒に使用します。背景のデザインが必要ない場合は、両方に白を選択します。有効な値は次のとおりです。• diagonal

• leftToRight

• topToBottom

グラフに使用する集計を指定します。無効な集計は、通知なしで無視されます。有効な集計がない場合、

ChartSummary[]chartSummaries

デフォルトで RowCount が軸の値に使用されます。この項目は API バージョン 17.0 以降で使用できます。必須。グラフの種類を指定します。使用可能なグラフの種類は、レポートタイプに応じて異なります。

ChartType (string型の列挙)chartType

グラフにマウスを重ねたとき、値、表示ラベル、およびパーセントを表示するかどうかを指定します。

booleanenableHoverLabels

詳細のフロート表示はグラフの種類によって異なります。パーセントは、円グラフ、ドーナツグラフ、およびじょうごグラフのみに適用されます。この項目は API バージョン 17.0 以降で使用できます。合計の 3% 以下のグループをすべて 1 つの「その他」系列または区分グループにまとめるかどうかを指定

booleanexpandOthers

します。円グラフ、ドーナツグラフ、およびじょうごグラフのみに適用されます。グラフにすべての値

389


説明データ型項目を個別に表示する場合は trueを設定し、小さなグループを「その他」にまとめるには falseに設定します。この項目は API バージョン 17.0 以降で使用できます。データのグループ化の基準となる項目を指定します。このデータは、縦棒グラフの場合は X 軸に、横棒グラフの場合は Y 軸に表示されます。

stringgroupingColumn

必須。グラフに対する凡例の位置。有効な値は、次のとおりです。

ChartLegendPosition (string型の列挙)

legendPosition

• Bottom

• OnChart

• Right

必須。グラフをレポートの上部に表示するか、または下部に表示するかを指定します。

ChartPosition (string 型の列挙)

location

データのグループ化の基準となる項目を指定します(グループ化されるグラフの種類の場合に指定可能)。

stringsecondaryGroupingColumn

グラフに各軸の名前を表示するかどうかを指定します (棒グラフと折れ線グラフの場合に指定可能)。

booleanshowAxisLabels

円グラフ、ドーナツグラフ、およびじょうごグラフの系列および区分のパーセント値とゲージのパーセ

booleanshowPercentage

ント値を表示するか (true)、否か (false) を示します。ドーナツグラフとゲージの合計を表示するか (true)、否か (false) を示します。

booleanshowTotal

グラフの個々のレコードまたはグループの値が表示されるか (true)、否か (false) を示します。

booleanshowValues

必須。グラフのサイズを指定します。ReportChartSize (string型の列挙)

size

グラフデータの集計方法を定義します。たとえば、Sumです。API バージョン 17.0 以降ではサポートさ

ReportSummaryType (string型の列挙)

summaryAggregate

れません。「chartSummaries」を参照してください。終了値を定義します (手動で軸範囲を指定する場合に指定可能)。

doublesummaryAxisManualRangeEnd

開始値を定義します (手動で軸範囲を指定する場合に指定可能)。

doublesummaryAxisManualRangeStart

必須。軸範囲を手動と自動のどちらで指定するかを定義します (横棒グラフ、折れ線グラフ、縦棒グラフの場合に指定可能)。

ChartRangeType (string型の列挙)

summaryAxisRange

390


説明データ型項目必須。グラフデータの集計の基準となる項目を指定します。通常、この項目は Y 軸に表示されます。API

stringsummaryColumn

バージョン 17.0 以降ではサポートされません。「chartSummaries」を参照してください。グラフのテキストと表示ラベルの色 (HTML 形式)。stringtextColor

グラフのテキストと表示ラベルのサイズ。有効な値は次のとおりです。

inttextSize

• 8

• 9

• 10

• 12

• 14

• 18

• 24

• 36

最大サイズは 18 です。18 より大きい値は 18 ポイントで表示されます。

グラフのタイトル。最大 255 文字です。stringtitle

タイトルテキストの色 (HTML 形式)。stringtitleColor

タイトルテキストのサイズ。有効な値は次のとおりです。

inttitleSize

• 8

• 9

• 10

• 12

• 14

• 18

• 24

• 36

最大サイズは 18 です。18 より大きい値は 18 ポイントで表示されます。

ChartType

グラフの種類を定義する string型の列挙です。これらの各種類のグラフの詳細は、Salesforceオンラインヘルプの「グラフの種類」を参照してください。有効な値は次のとおりです。

列挙値None

HorizontalBar

HorizontalBarGrouped

HorizontalBarStacked

391


列挙値HorizontalBarStackedTo100

VerticalColumn

VerticalColumnGrouped

VerticalColumnStacked

VerticalColumnStackedTo100

Line

LineGrouped

LineCumulative

LineCumulativeGrouped

Pie

Donut

Funnel

Scatter

ScatterGrouped

VerticalColumnLine

VerticalColumnGroupedLine

VerticalColumnStackedLine

Plugin

将来の使用のために予約されています。この値は API バージョン 31.0 以降で使用できます。

ChartPosition

レポート内のグラフの位置を指定する string 型の列挙です。有効な値は次のとおりです。

列挙値CHART_TOP

CHART_BOTTOM

ChartSummary

ChartSummary は、グラフのデータの集計方法を定義します。有効な値は次のとおりです。

説明データ型項目集計値の集計方法 (Sum、Average、Min、Maxなど)を指定します。集計に使用される集計値を指定する

ReportSummaryTypeaggregate

には、column項目を使用します。RowCount またはカスタム集計項目にはこの項目を指定する必要はありません。

392


説明データ型項目グラフで使用する軸を指定します。軸に使用される集計値を指定するには、column項目を使用します。

ChartAxisaxisBinding

必須。グラフデータの集計項目を指定します。すべての列が無効な場合、デフォルトで RowCount が軸

stringcolumn

の値に使用されます。縦棒と横棒の組み合わせグラフの場合、最大 4 つの値を指定できます。

ChartAxis

グラフで使用する軸を指定する string 型の列挙です。有効な値は次のとおりです。

説明列挙値散布図の X 軸に使用する集計値。x

グラフの Y 軸。y

縦棒グラフに折れ線を追加した組み合わせグラフの 2 本目の Y 軸。y2

ReportChartSize

グラフのサイズを指定する string 型の列挙です。有効な値は次のとおりです。

列挙値Tiny

Small

Medium

Large

Huge

ChartRangeType

レポート形式を定義する string 型の列挙です。有効な値は次のとおりです。

列挙値Auto

Manual

ReportTimeFrameFilter

ReportTimeFrameFilter は、レポートの期間を表します。

説明データ型項目必須。データの絞り込み対象となる日付項目。たとえば、CLOSE_DATEのようになります。

stringdateColumn

393


説明データ型項目intervalが INTERVAL_CUSTOMの場合、カスタム期間の終了日を指定します。

dateendDate

必須。期間を指定します。UserDateInterval (string型の列挙)

interval

intervalが INTERVAL_CUSTOMの場合、カスタム期間の開始日を指定します。

datestartDate

ReportCrossFilter

ReportCrossFilter は、レポート内のクロス条件機能を表します。

説明データ型項目クロス条件のサブ条件を表します。最大 5 つのサブ条件を指定できます。この項目には次の属性が必要です。

ReportFilterItemcriteriaItems

• Column

• Operator

• Value

オブジェクトを含めるか、除外するかを示すアクション。有効値: withおよび without。

ObjectFilterOperator (string型の列挙)

operation

クロス条件に使用する親オブジェクト。stringprimaryTableColumn

クロス条件に使用する子オブジェクト。stringrelatedTable

親を結合するために使用する子オブジェクトの項目。stringrelatedTableJoinColumn

宣言的なメタデータの定義のサンプルクロス条件を使用してケース状況がクローズではないケースの Account レポートを作成するサンプル XML スニペット。

<crossFilters><criteriaItems>

<column>Status</column><operator>notequal</operator><value>Closed</value>

</criteriaItems><operation>with</operation><primaryTableColumn>ACCOUNT_ID</primaryTableColumn><relatedTable>Case</relatedTable><relatedTableJoinColumn>Account</relatedTableJoinColumn>

</crossFilters>

メモ: このサンプルは、API バージョン 23.0 を使用して生成されました。

UserDateInterval

期間を定義する string 型の列挙です。有効な値は次のとおりです。

394


説明列挙値今期 (会計四半期)INTERVAL_CURRENT

今期と翌期 (会計四半期)INTERVAL_CURNEXT1

今期と前期 (会計四半期)INTERVAL_CURPREV1

翌期 (会計四半期)INTERVAL_NEXT1

前期 (会計四半期)INTERVAL_PREV1

今期と翌 3 期 (会計四半期)INTERVAL_CURNEXT3

今期 (会計年度)INTERVAL_CURFY

前期 (会計年度)INTERVAL_PREVFY

過去 2 期 (会計年度)INTERVAL_PREV2FY

2 期前 (会計年度)INTERVAL_AGO2FY

翌期 (会計年度)INTERVAL_NEXTFY

今期と前期 (会計年度)INTERVAL_PREVCURFY

今期と過去 2 期 (会計年度)INTERVAL_PREVCUR2FY

今期と翌期 (会計年度)INTERVAL_CURNEXTFY

カスタム期間期間の開始日と終了日を指定するには、startDate

および endDate項目を使用します。INTERVAL_CUSTOM

昨日INTERVAL_YESTERDAY

今日INTERVAL_TODAY

明日INTERVAL_TOMORROW

先週 (カレンダー週)INTERVAL_LASTWEEK

今週 (カレンダー週)INTERVAL_THISWEEK

来週 (カレンダー週)INTERVAL_NEXTWEEK

先月 (カレンダー月)INTERVAL_LASTMONTH

今月 (カレンダー月)INTERVAL_THISMONTH

来月 (カレンダー月)INTERVAL_NEXTMONTH

今月と先月 (カレンダー月)INTERVAL_LASTTHISMONTH

今月と来月 (カレンダー月)INTERVAL_THISNEXTMONTH

今期 (カレンダー四半期)INTERVAL_CURRENTQ

今期と翌期 (カレンダー四半期)INTERVAL_CURNEXTQ

今期と前期 (カレンダー四半期)INTERVAL_CURPREVQ

翌期 (カレンダー四半期)INTERVAL_NEXTQ

前期 (カレンダー四半期)INTERVAL_PREVQ

今期と翌 3 期 (カレンダー四半期)INTERVAL_CURNEXT3Q

395


説明列挙値今年 (カレンダー年)INTERVAL_CURY

前年 (カレンダー年)INTERVAL_PREVY

過去 2 年 (カレンダー年)INTERVAL_PREV2Y

2 年前 (カレンダー年)INTERVAL_AGO2Y

来年 (カレンダー年)INTERVAL_NEXTY

今年と前年 (カレンダー年)INTERVAL_PREVCURY

今年と過去 2 年 (カレンダー年)INTERVAL_PREVCUR2Y

今年と来年 (カレンダー年)INTERVAL_CURNEXTY

過去 7 日間INTERVAL_LAST7





翌 7 日間INTERVAL_NEXT7





前会計週 (カスタム会計年度が有効な場合に指定可能)LAST_FISCALWEEK

今会計週 (カスタム会計年度が有効な場合に指定可能)THIS_FISCALWEEK

翌会計週 (カスタム会計年度が有効な場合に指定可能)NEXT_FISCALWEEK

前会計期間 (カスタム会計年度が有効な場合に指定可能)LAST_FISCALPERIOD

今会計期間 (カスタム会計年度が有効な場合に指定可能)THIS_FISCALPERIOD

翌会計期間 (カスタム会計年度が有効な場合に指定可能)NEXT_FISCALPERIOD

今会計期間と前会計期間 (カスタム会計年度が有効な場合に指定可能)

LASTTHIS_FISCALPERIOD

今会計期間と翌会計期間 (カスタム会計年度が有効な場合に指定可能)

THISNEXT_FISCALPERIOD

今期 (エンタイトルメント期間)CURRENT_ENTITLEMENT_PERIOD

前期 (エンタイトルメント期間)PREVIOUS_ENTITLEMENT_PERIOD

過去 2 期 (エンタイトルメント期間)PREVIOUS_TWO_ENTITLEMENT_PERIODS

2 期前 (エンタイトルメント期間)TWO_ENTITLEMENT_PERIODS_AGO

今期と前期 (エンタイトルメント期間)CURRENT_AND_PREVIOUS_ENTITLEMENT_PERIOD

396


説明列挙値今期と過去 2 期 (エンタイトルメント期間)CURRENT_AND_PREVIOUS_TWO_ENTITLEMENT_PERIODS

宣言的なメタデータの定義のサンプルサンプル XML レポート定義を次に示します。

<?xml version="1.0" encoding="UTF-8"?><Report xmlns="http://soap.sforce.com/2006/04/metadata">

<aggregates><acrossGroupingContext>CRT_Object__c$Id</acrossGroupingContext><calculatedFormula>PREVGROUPVAL(CRT_Object__c.Currency__c:AVG, CRT_Object__c.Id)

*PARENTGROUPVAL(CRT_Object__c.Number__c:MAX, CRT_Object__c.CreatedBy.Name,

COLUMN_GRAND_SUMMARY)/RowCount</calculatedFormula><datatype>number</datatype><developerName>FORMULA1</developerName><downGroupingContext>CRT_Object__c$CreatedBy</downGroupingContext><isActive>true</isActive><masterLabel>CurrCSF</masterLabel><scale>2</scale>

</aggregates><aggregates>

<acrossGroupingContext>CRT_Object__c$LastModifiedDate</acrossGroupingContext><calculatedFormula>IF(RowCount>10,

BLANKVALUE(ROUND(PREVGROUPVAL(CRT_Object__c.Currency__c:SUM,CRT_Object__c.LastModifiedDate),3),PARENTGROUPVAL(CRT_Object__c.Number__c:SUM, ROW_GRAND_SUMMARY,CRT_Object__c.Id)) , 1000)</calculatedFormula>

<datatype>number</datatype><developerName>FORMULA2</developerName><downGroupingContext>GRAND_SUMMARY</downGroupingContext><isActive>true</isActive><masterLabel>numCSF</masterLabel><scale>2</scale>

</aggregates><buckets>

<bucketType>number</bucketType><developerName>BucketField_BusinessSize</developerName><masterLabel>NumericBucket</masterLabel><nullTreatment>z</nullTreatment><sourceColumnName>SALES</sourceColumnName><values>

<sourceValues><to>10000</to>

</sourceValues><value>low</value>

</values><values>

<sourceValues><from>10000</from><to>25000</to>

</sourceValues><value>mid</value>

</values><values>

<sourceValues><from>25000</from>

</sourceValues><value>high</value>

</values></buckets><buckets>

<bucketType>text</bucketType><developerName>BucketField_Region</developerName>

397


<masterLabel>TextBucket</masterLabel><nullTreatment>n</nullTreatment><otherBucketLabel>Other</otherBucketLabel><sourceColumnName>ADDRESS1_STATE</sourceColumnName><values>

<sourceValues><sourceValue>CA</sourceValue>

</sourceValues><value>west</value>

</values><values>

<sourceValues><sourceValue>NY</sourceValue>

</sourceValues><sourceValues>

<sourceValue>Ontario</sourceValue></sourceValues><value>east</value>

</values></buckets><chart>

<backgroundColor1>#FFFFFF</backgroundColor1><backgroundColor2>#FFFFFF</backgroundColor2><backgroundFadeDir>Diagonal</backgroundFadeDir><chartSummaries>

<axisBinding>y</axisBinding><column>FORMULA1</column>

</chartSummaries><chartSummaries>

<axisBinding>y</axisBinding><column>FORMULA2</column>


<aggregate>Maximum</aggregate><axisBinding>y</axisBinding><column>CRT_Object__c$Number__c</column>


<axisBinding>y</axisBinding><column>RowCount</column>

</chartSummaries><chartType>VerticalColumn</chartType><groupingColumn>CRT_Object__c$LastModifiedDate</groupingColumn><legendPosition>Right</legendPosition><location>CHART_TOP</location><size>Medium</size><summaryAxisRange>Auto</summaryAxisRange><textColor>#000000</textColor><textSize>12</textSize><titleColor>#000000</titleColor><titleSize>18</titleSize>

</chart><columns>

<field>CRT_Object__c$Name</field></columns><columns>

<aggregateTypes>Average</aggregateTypes><field>CRT_Object__c$Currency__c</field>

</columns><columns>

<aggregateTypes>Maximum</aggregateTypes><field>CRT_Object__c$Number__c</field>

</columns><columns>

<field>BucketField__Region</field></columns><format>Matrix</format><groupingsAcross>

<dateGranularity>Day</dateGranularity>

398


<field>CRT_Object__c$Id</field><sortOrder>Asc</sortOrder>

</groupingsAcross><groupingsAcross>

<dateGranularity>Year</dateGranularity><field>CRT_Object__c$LastModifiedDate</field><sortOrder>Asc</sortOrder>

</groupingsAcross><groupingsDown>

<dateGranularity>Day</dateGranularity><field>CRT_Object__c$CreatedBy</field><sortOrder>Asc</sortOrder>

</groupingsDown><groupingsDown>

<dateGranularity>Day</dateGranularity><field>CRT_Object__c$Currency__c</field><sortOrder>Desc</sortOrder>

</groupingsDown><name>CrtMMVC</name><reportType>CRT1__c</reportType><scope>organization</scope><showDetails>false</showDetails><timeFrameFilter>

<dateColumn>CRT_Object__c$CreatedDate</dateColumn><interval>INTERVAL_CUSTOM</interval>

</timeFrameFilter></Report>

結合レポートの宣言的なメタデータの定義のサンプルサンプル XML レポート定義を次に示します。

<?xml version="1.0" encoding="UTF-8"?><Report xmlns="http://soap.sforce.com/2006/04/metadata">

<aggregates><calculatedFormula>B1#AMOUNT:SUM+B2#EMPLOYEES:SUM</calculatedFormula><datatype>number</datatype><developerName>FORMULA</developerName><isActive>true</isActive><isCrossBlock>true</isCrossBlock><masterLabel>Cross-Block CSF Example</masterLabel><scale>2</scale>

</aggregates>

<aggregates><calculatedFormula>AMOUNT:SUM</calculatedFormula><developerName>FORMULA2</developerName><isActive>true</isActive><isCrossBlock>false</isCrossBlock><masterLabel>Standard CSF Example</masterLabel><reportType>Opportunity</reportType><scale>2</scale>

</aggregates><block><blockInfo>



<aggregateReferences><aggregate>FORMULA2</aggregate>

</aggregateReference><blockId>B1</blockId><joinTable>a</joinTable>

399


</blockInfo><columns><field>TYPE</field>

</columns><format>Summary</format><name>Opportunities BLock 3</name><params><name>role_territory</name><value>role</value>

</params><params><name>terr</name><value>all</value>

</params><params><name>open</name><value>all</value>

</params><params><name>probability</name><value>0</value>

</params><params><name>co</name><value>1</value>

</params><reportType>Opportunity</reportType><scope>organization</scope><timeFrameFilter><dateColumn>CLOSE_DATE</dateColumn><interval>INTERVAL_CUSTOM</interval>

</timeFrameFilter></block><block><blockInfo>



<aggregateReferences><aggregate>FORMULA1</aggregate>

</aggregateReferences><blockId>B2</blockId><joinTable>a</joinTable>

</blockInfo><columns><field>USERS.NAME</field>

</columns><columns><field>TYPE</field>

</columns><columns>

<field>DUE_DATE</field></columns><columns><field>LAST_UPDATE</field>

</columns><columns><field>ADDRESS1_STATE</field>

</columns><format>Summary</format<name>Accounts block 5</name><params><name>terr</name><value>all</value>

</params><params><name>co</name><value>1</value>

</params>

400


<reportType>AccountList</reportType><scope>organization</scope><timeFrameFilter><dateColumn>CREATED_DATE</dateColumn><interval>INTERVAL_CUSTOM</interval>

</timeFrameFilter></block><blockInfo><blockId xsi:nil="true"/><joinTable>a</joinTable>

</blockInfo><chart>

<backgroundColor1>#FFFFFF</backgroundColor1><backgroundColor2>#FFFFFF</backgroundColor2><backgroundFadeDir>Diagonal</backgroundFadeDir><chartSummaries>

<axisBinding>y</axisBinding>

<column>B1#RowCount</column></chartSummaries><chartType>HorizontalBar</chartType><enableHoverLabels>false</enableHoverLabels><expandOthers>true</expandOthers><groupingColumn>ACCOUNT_NAME</groupingColumn><location>CHART_TOP</location><showAxisLabels>true</showAxisLabels><showPercentage>false</showPercentage><showTotal>false</showTotal><showValues>false</showValues><size>Medium</size><summaryAxisRange>Auto</summaryAxisRange><textColor>#000000</textColor><textSize>12</textSize><titleColor>#000000</titleColor><titleSize>18</titleSize>

</chart><format>MultiBlock</format><groupingsDown>

<dateGranularity>Day</dateGranularity><field>ACCOUNT_NAME</field><sortOrder>Asc</sortOrder>

</groupingsDown><name>mb_mbapi</name><reportType>Opportunity</reportType><showDetails>true</showDetails>

</Report>

関連リンクDashboard

ReportTypeカスタムレポートタイプに関連付けられたメタデータを表します。Metadataメタデータ型を拡張し、そのfullName

項目を継承します。カスタムレポートタイプを使用すると、ユーザがレポートを作成またはカスタマイズできるフレームワークを構築できます。詳細は、Salesforceオンラインヘルプの「カスタムレポートタイプの設定」を参照してください。

401

ReportTypeメタデータ型

宣言的なメタデータファイルのサフィックスおよびディレクトリの場所カスタムレポートタイプ定義のファイルサフィックスは .reportTypeです。カスタムレポートタイプごとに 1つのファイルがあります。レポートタイプは、対応するパッケージディレクトリの reportTypesディレクトリに保存されます。

バージョンカスタムレポートタイプは、API バージョン 14.0 以降で使用できます。

項目

説明データ型項目名エンティティで履歴トレンドが有効になった場合にレポートタイプが自動的に生成されることを示します。API バージョン 29 以降で利用できます。

booleanautogenerated

必須。カスタムレポートタイプの主オブジェクト。たとえば、Account などです。カスタムオブジェクトを含むすべて

stringbaseObject

のオブジェクトがサポートされます。初回作成後にこの項目を編集することはできません。必須。この項目は、レポートのカテゴリを制御します。有効な値は、次のとおりです。

ReportTypeCategory (string型の列挙)

category

• accounts

• opportunities

• forecasts

• cases

• leads

• campaigns

• activities

• busop

• products

• admin

• territory

• other

• content

必須。レポートタイプをユーザが使用できるか (true)、まだ開発中か (false) を示します。

booleandeployed

カスタムレポートタイプの説明。stringdescription

APIアクセスの一意の識別子として使用される、レポートタイプの開発者名。fullNameには、アンダースコアと英数字

stringfullName

のみを使用できます。一意であること、最初は文字であること、空白は使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。

402


説明データ型項目名baseObjectに結合されたオブジェクト。たとえば、Contactが主オブジェクトの Account に結合されている場合があります。

ObjectRelationshipjoin

必須。レポートタイプの表示ラベル。stringlabel

レポートタイプに使用できる列のグループ。列は厳密には必須ではありませんが、レポートでは列を使用したほうが便利です。

ReportLayoutSection[]sections

ObjectRelationship

ObjectRelationship は、別のオブジェクトへの結合を表します。詳細は、Salesforce オンラインヘルプの「カスタムレポートタイプへの子オブジェクトの追加」を参照してください。

説明データ型項目名この項目は、3 つ以上のオブジェクトを結合できるようにする再帰的参照です。最大 4 つのオブジェクトを、カスタムレポートタイ

ObjectRelationshipjoin

プ内で結合できます。3 つ以上のオブジェクトを結合する場合、結合の順序で内部結合より前に外部結合があると、その内部結合は許可されません。baseObjectは、relationshipで指定されたオブジェクトに最初に結合されます。その結果のデータセットがこの項目で指定された任意のオブジェクトと結合されます。必須。これが外部結合であるか (true)、否か (false) を示します。外部結合は、結合されたテーブルの結合列に一致する値が含まれていなくても行を返します。

booleanouterJoin

必須。主オブジェクトに結合されたオブジェクト。たとえば、Contact などです。

stringrelationship

ReportLayoutSection

ReportLayoutSection は、カスタムレポートタイプで使用される列のグループを表します。

説明データ型項目名このカスタムレポートタイプで定義された、クエリから返される列のリスト。

ReportTypeColumn[]columns

必須。レポートウィザードでのこの列のグループの表示ラベル。

stringmasterLabel

ReportTypeColumn

ReportTypeColumn は、カスタムレポートタイプ内の列を表します。

説明データ型項目名必須。この列がデフォルトで選択されるか (true)、否か (false)を示します。

booleancheckedByDefault

403


説明データ型項目名カスタマイズされた列名 (省略可能)。stringdisplayNameOverride

必須。レポート列に関連付けられた項目名。stringfield

必須。項目に関連付けられたテーブル。たとえば、Account などがあります。

stringtable

宣言的なメタデータの定義のサンプルカスタムレポートタイプの定義を以下に示します。Account が Contact に結合され、その結果のデータセットがAsset に結合されます。

<?xml version="1.0" encoding="UTF-8"?><ReportType xmlns="http://soap.sforce.com/2006/04/metadata">

<baseObject>Account</baseObject><category>accounts</category><deployed>true</deployed><description>Account linked to Contacts and Assets</description><join>

<join><outerJoin>false</outerJoin><relationship>Assets</relationship>

</join><outerJoin>false</outerJoin><relationship>Contacts</relationship>

</join><label>Account Contacts and Assets</label><sections>

<columns><checkedByDefault>true</checkedByDefault><field>obj_lookup__c.Id</field><table>Account</table>

</columns><columns>

<checkedByDefault>false</checkedByDefault><field>obj_lookup__c.Name</field><table>Account</table>

</columns><columns>

<checkedByDefault>false</checkedByDefault><field>Opportunity__c.Amount</field><table>Account</table>

</columns><columns>

<checkedByDefault>false</checkedByDefault><field>Owner.IsActive</field><table>Account</table>

</columns><masterLabel>Accounts</masterLabel>

</sections><sections>

<columns><checkedByDefault>false</checkedByDefault><field>Owner.Email</field><table>Account.Contacts</table>

</columns><columns>

<checkedByDefault>false</checkedByDefault><field>byr__c</field><table>Account.Contacts</table>

</columns><columns>

<checkedByDefault>true</checkedByDefault><field>ReportsTo.CreatedBy.Contact.Owner.MobilePhone</field>

404


<table>Account.Contacts</table></columns><masterLabel>Contacts</masterLabel>

</sections></ReportType>

使用方法カスタムレポートタイプは、API 名を使用して項目を参照します。履歴項目 (trackTrendingが trueに設定されている項目) の場合、Field2__c_hstのように API 名に hstが含まれます。

<sections><columns>

<checkedByDefault>false</checkedByDefault><field>Field2__c_hst</field><table>CustomTrendedObject__c.CustomTrendedObject__c_hst</table>

</columns><masterLabel>History</masterLabel>

</sections>

詳細は、「trackTrending」 (ページ 184)を参照してください。

Role組織内のロールを表します。

宣言的なメタデータファイルのサフィックスおよびディレクトリの場所ロールコンポーネントのファイルサフィックスは.roleで、コンポーネントは対応するパッケージディレクトリの rolesディレクトリに保存されます。

バージョンロールコンポーネントは、API バージョン 24.0 以降で使用できます。

項目このメタデータ型は、下位型 RoleOrTerritory (ページ 406) に拡張されます。

説明データ型項目名API アクセスの一意の識別子。fullNameには、アンダースコアと英数字のみを使用できます。一意であること、最初は

stringfullName

文字であること、空白は使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。この項目は、Metadata コンポーネントから継承されています。ユーザインターフェースの [ロール名] に対応します。階層でこのロールの上位にあるロール。stringparentRole

405

Roleメタデータ型

宣言的なメタデータの定義のサンプルロールの定義を次に示します。

<?xml version="1.0" encoding="UTF-8"?><Role xmlns="http://soap.sforce.com/2006/04/metadata">

<caseAccessLevel>Edit</caseAccessLevel><contactAccessLevel>Edit</contactAccessLevel><description>Sample Role</description><mayForecastManagerShare>false</mayForecastManagerShare><name>R22</name><opportunityAccessLevel>Read</opportunityAccessLevel>

</Role>

RoleOrTerritory共通の基本型と、ロールまたはテリトリーの有効値を表します。

バージョンRoleOrTerritory コンポーネントは、API バージョン 24.0 以降で使用できます。

メモ: RoleOrTerritory コンポーネントを直接作成することはできません。代わりに Role または Territoryメタデータ型を使用します。

項目

説明データ型項目名ユーザが、所有する取引先に関連付けられた他のユーザのケースにアクセスできるかどうかを指定します。有効な値は、次のとおりです。

stringcaseAccessLevel

• Read

• Edit

• None

組織のケースに対する共有モデルが「公開/参照・更新可能」の場合、この項目は表示されません。この項目に値が設定されていない場合、この項目値には [テリトリーの管理] ページ ([設定] から [テリトリーの管理] >[設定]) で指定されたデフォルトのアクセスレベルが使用されます。

ユーザが所有する取引先に関連付けられた他のユーザの取引先責任者に、ユーザがアクセスできるかどうかを指定します。有効な値は、次のとおりです。

stringcontactAccessLevel

• Read

• Edit

• None

406

RoleOrTerritoryメタデータ型

説明データ型項目名取引先責任者に対する組織の共有モデルが「公開/参照・更新可能」または「親レコードに連動」の場合、この項目は表示されません。この項目に値が設定されていない場合、この項目値には [テリトリーの管理] ページ ([設定] から [テリトリーの管理] >[設定]) で指定されたデフォルトのアクセスレベルが使用されます。

ロールまたはテリトリーの説明です。stringdescription


stringfullName

文字であること、空白は使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。この項目は、Metadata コンポーネントから継承されています。売上予測マネージャが手動で自身の売上予測を共有できるかどうかを示します。

booleanmayForecastManagerShare

必須。ロールまたはテリトリーの名前です。stringname

ユーザが所有する取引先に関連付けられた他のユーザの商談に、ユーザがアクセスできるかどうかを指定します。有効な値は、次のとおりです。

stringopportunityAccessLevel

• Read

• Edit

• None

組織の商談に対する共有モデルが「公開/参照・更新可能」の場合、この項目は表示されません。この項目に値が設定されていない場合、この項目値には [テリトリーの管理] ページ ([設定] から [テリトリーの管理] >[設定]) で指定されたデフォルトのアクセスレベルが使用されます。

宣言的なメタデータの定義のサンプルロールの定義を次に示します。

<?xml version="1.0" encoding="UTF-8"?><Role xmlns="http://soap.sforce.com/2006/04/metadata">

<caseAccessLevel>Edit</caseAccessLevel><contactAccessLevel>Edit</contactAccessLevel><description>Sample Role</description><mayForecastManagerShare>false</mayForecastManagerShare><name>R22</name><opportunityAccessLevel>Read</opportunityAccessLevel>

</Role>

407

RoleOrTerritoryメタデータ型

テリトリーの定義を次に示します。

<?xml version="1.0" encoding="UTF-8"?><Territory xmlns="http://soap.sforce.com/2006/04/metadata">

<accountAccessLevel>Edit</accountAccessLevel><caseAccessLevel>Edit</caseAccessLevel><contactAccessLevel>Edit</contactAccessLevel><description>Sample Territory</description><mayForecastManagerShare>false</mayForecastManagerShare><name>T22name</name><opportunityAccessLevel>Read</opportunityAccessLevel>

</Territory>

関連リンクRoleTerritory

SamlSsoConfigSAML シングルサインオン設定を表します。Metadata メタデータ型を拡張し、その fullName項目を継承します。シングルサインオンは、ネットワークユーザが、各リソースに個別にログインすることなく、認証済みのすべてのネットワークリソースにアクセスできるプロセスです。シングルサインオンを使用すると、企業ユーザのデータベースまたはクライアントアプリケーションに対してユーザ名とパスワードを検証できます。Salesforce管理の個別のユーザパスワードは必要ありません。

ファイルのサフィックスおよびディレクトリの場所SamlSsoConfig コンポーネントのサフィックスは .samlssoconfigで、samlssoconfigsフォルダに保存されます。

バージョンSamlSsoConfig コンポーネントは、API バージョン 28.0 以降で使用できます。

項目

説明項目のデータ型項目名ID プロバイダのアプリケーションの名前。ID プロバイダからこの情報を取得します。

stringattributeName

SAML 2.0 で identityLocationが Attributeに設定されている場合にのみ使用されます。値には、unspecified、

stringattributeNameIdFormat

emailAddress、persistentがあります。すべての規定値は、SAML 2.0 のアサーションとプロトコルの仕様書にある「Name Identifier Format Identifiers」の項に記載されています。受信 SAML アサーションの復号化に使用する証明書の名前。この証明書は、組織の [証明書と鍵の管理] リストに保存されます。API バージョン 30.0 以降で利用できます。

stringdecryptionCertificate

408

SamlSsoConfigメタデータ型

http://docs.oasis-open.org/security/saml/v2.0/saml-core-2.0-os.pdf

説明項目のデータ型項目名SAML ログイン時にエラーが発生した場合にユーザが移動する先のページの URL。この URL は、公開サイトの

stringerrorUrl

Visualforceページなど、公開されているページである必要があります。URL は相対または絶対のどちらでも使用できます。アサーション内のどこでユーザを識別するかを指定します。有効な値は、次のとおりです。

SamlIdentityLocationType(string 型の列挙)

identityLocation

• SubjectNameId — ID はアサーションの <Subject>ステートメント内にあります

• Attribute — ID はアサーションの <Attribute>の中の<AttributeValue>で指定されています。

ジャストインタイムのユーザプロビジョニング中にサービスプロバイダがユーザに対して使用する識別子。有効な値は、次のとおりです。

SamlIdentityType (string型の列挙)

identityMapping

• Username — ユーザの salesforce.com ユーザ名。• FederationId — ユーザオブジェクトの統合 ID。サービ

スプロバイダがユーザに対して使用する識別子。• UserId — ユーザの Salesforce 組織のユーザ ID。

ID プロバイダの ID 文字列。stringissuer

SAML 2.0 でのみ有効: Salesforce がログインシーケンスを開始する SAML 要求を送信する URL です。

stringloginUrl

SAML 2.0 専用: ユーザが [ログアウト] リンクをクリックしたときに移動先となる URL。デフォルトは、http://www.salesforce.comです。

stringlogoutUrl

この一意の名前は API および管理パッケージで使用されます。名前は文字で始まり、英数字とアンダースコアのみを使

stringname

用する必要があります。名前には、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。SAML 2.0 でのみ有効: ACS URL は、Web シングルサインオン OAuth アサーションフローで ID プロバイダとしてSalesforce を有効化して使用します。

stringoauthTokenEndpoint

[私のドメイン] を使用している場合は、ID プロバイダがSAML メッセージで要求するバインドメカニズムを選択します。値は次のとおりです。

booleanredirectBinding

• HTTP ポスト — HTTP POST バインドは、base64url エンコードされた HTML フォームを使用して SAML メッセージを送信します。

• HTTP リダイレクト — HTTP リダイレクトバインドは、URL パラメータ内で base64url エンコードおよび URL エンコードされた SAML メッセージを送信します。

409


説明項目のデータ型項目名Web シングルサインオンフローのログインに関連付けられている URL。

stringsalesforceLoginUrl

Salesforce によって生成された SAML 要求の発行者。または、SAML 着信レスポンスの予測される利用者。ドメイン

stringsamlEntityId

をリリースしていない場合、この値は常にhttps://saml.salesforce.comになります。ドメインをリリースしている場合、Salesforce ではカスタムドメイン名の使用をお勧めします。使用中の SAML バージョン。有効な値は、次のとおりです。SamlType (string型の列

挙)samlVersion

• SAML1_1 — SAML 1.1• SAML2_0 — SAML 2.0

trueの場合、ジャストインタイムのユーザプロビジョニングが有効になり、ユーザがはじめてログインするときにその

booleanuserProvisioning

場でユーザが作成されます。この機能を使用するには、identityMapping値に Federation IDを指定します。要求の検証に使用される証明書。ID プロバイダからこの情報を取得します。

stringvalidationCert

宣言的なメタデータの定義のサンプルSamlSsoConfig コンポーネントの例を次に示します。読みやすくするために検証の証明書文字列を切り捨てています。

<?xml version="1.0" encoding="UTF-8"?><SamlSsoConfig xmlns="http://soap.sforce.com/2006/04/metadata"><identityLocation>SubjectNameId</identityLocation><identityMapping>FederationId</identityMapping><issuer>https://my-idp.my.salesforce.com</issuer><loginUrl>https://my-idp.my.salesforce.com/idp/endpoint/HttpRedirect

</loginUrl><logoutUrl>https://www.salesforce.com</logoutUrl><name>SomeCompany</name><oauthTokenEndpoint>https://login.salesforce.com/services/oauth2/token?so=00DD0000000JxeI

</oauthTokenEndpoint><redirectBinding>true</redirectBinding><salesforceLoginUrl>https://login.salesforce.com?so=00DD0000000JxeI

</salesforceLoginUrl><samlEntityId>https://saml.salesforce.com/customPath

</samlEntityId><samlVersion>SAML2_0</samlVersion><userProvisioning>false</userProvisioning><validationCert>MIIEojCCA4qgAwIBAgIOATtxsoBFAAAAAD4...

</validationCert></SamlSsoConfig>

410


Scontrol重要: Sコントロールは、Visualforce ページに置き換えられました。組織で以前に Sコントロールを使用していない場合は、作成できません。既存の Sコントロールに影響はありません。今後も編集できます。

非推奨。Salesforce ユーザインターフェースの Sコントロールに対応する、Scontrol コンポーネントを表します。詳細は、Salesforce オンラインヘルプの「Sコントロールについて」を参照してください。このメタデータ型は、MetadataWithContent コンポーネントを拡張し、その項目を共有します。

宣言的なメタデータファイルのサフィックスおよびディレクトリの場所Sコントロールファイルのファイルサフィックスは .scfです。付随するメタデータファイルには、ScontrolName-meta.xmlという名前が付けられます。Scontrol コンポーネントは、対応するパッケージディレクトリの scontrolsフォルダに保存されます。

バージョンSコントロールは、API バージョン 10.0 以降で使用できます。


説明データ型項目名Sコントロールのコンテンツ。Base 64 で符号化されたバイナリデータ API コールを行う前に、クライアントアプリ

base64Binarycontent

ケーションはバイナリ添付データを base64 に符号化する必要があります。応答を受信したら、クライアントアプリケーションは、base64 データをバイナリに復号化する必要があります。この変換は、通常 SOAP クライアントによって処理されます。この項目は、MetadataWithContentコンポーネントから継承されます。必須。Sコントロールの使用目的を判断します。SControlContentSource (string型の

列挙)contentSource

• HTML: Sコントロールのコンテンツを contentに入力する場合、このオプションを選択します。

• URL: 外部 Web サイトへのリンクまたは URL をcontentに入力する場合、このオプションを選択します。

• Snippet: スニペットは、他の Sコントロールに組み込めるよう設計された Sコントロールです。Sコントロールスニペットのコンテンツを contentに入力する場合、このオプションを選択します。

Sコントロールを説明するテキストです (省略可能)。これは「すべてのデータの参照」権限を持つユーザ (システム管理者) にのみ表示されます。

stringdescription

411

Scontrolメタデータ型

説明データ型項目名必須。デフォルトの文字コード設定は Unicode (UTF-8) です。情報を渡す URL が別形式のデータを必要とする場合


は、この設定を変更します。このオプションは、contentSourceの値として URLを選択すると使用できます。この Sコントロールをカスタムリンクに追加した場合に表示されるファイルのコンテンツ。ファイルには、Java アプ

base64fileContent

レット、Active-X コントロール、またはその他の任意のコンテンツを含めることができます。このオプションは、contentSourceの値がHTMLの Sコントロールにのみ適用されます。Sコントロールにつける一意の名前です。この名前は、アンダースコアと英数字のみを含み、組織内で一意の名前に

stringfileName

する必要があります。最初は文字であること、空白は使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。この項目は、管理パッケージによってインストールされたコンポーネントでは変更できません。fileContent項目にも値がある場合にのみ該当します。これは、APIバージョン14.0 の新項目です。API アクセスの一意の識別子として使用される、Sコントロールの開発者名。fullNameには、アンダースコアと英

stringfullName

数字のみを使用できます。一意であること、最初は文字であること、空白は使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。この項目が、使用できなくなったバージョン 14.0 より前の文字を含んでいた場合は、それらの文字はこの項目から削除され、その項目の以前の値はname

項目に保存されていました。この項目は、Metadata コンポーネントから継承されています。必須。Sコントロールにつける一意の名前です。文字で始まり、英数字のみが含まれる必要があります。たとえば、example_s_controlなどです。

stringname

必須。Sコントロールがキャッシュをサポートしているか(true)、否か (false) を示します。キャッシュによりペー

booleansupportsCaching

ジを最適化し、ページの再読み込み時にページに含まれるSコントロールを記憶します。このオプションは、HTMLSコントロールにのみ適用されます。

宣言的なメタデータの定義のサンプル次のサンプルでは、Myriad_Publishing.scfという Sコントロールを作成し、Sコントロール内に指定されたWeb サイトへのリンクを作成します。対応する Myriad_Publishing.scf-meta.xmlメタデータファイルは、Sコントロールファイルの次に示します。

412

Scontrolメタデータ型

Myriad_Publishing.scfファイル:

http://www.myriadpubs.com

Myriad_Publishing.scf-meta.xml:

<?xml version="1.0" encoding="UTF-8"?><Scontrol xmlns="http://soap.sforce.com/2006/04/metadata">

<contentSource>URL</contentSource><description>s-control to open Myriad Publishing website.</description><encodingKey>UTF-8</encodingKey><name>Myriad Publishing</name><supportsCaching>true</supportsCaching>

</Scontrol>

設定機能に関連する、組織の設定を表します。たとえば、パスワードポリシー、セッションの設定、ネットワークアクセスコントロールはすべて、SecuritySettings コンポーネントの種類で使用できます。メタデータ API では、すべての機能設定が使用できるわけではありません。使用できない機能設定についての詳細は、「サポートされていないメタデータ型」 (ページ 96)を参照してください。Settings には、特定のコンポーネントメンバーまたはワイルドカードを使用してアクセスできます。たとえば、パッケージマニフェストファイルでは、次のセクションを使用して SecuritySettings にアクセスします。

<types><members>Security</members><name>Settings</name>

</types>

パッケージマニフェストで使用されるメンバー形式は、「Settings」というサフィックスを使用しないコンポーネントメタデータ型名です。前述の例では、「SecuritySettings」の代わりに「Security」が使用されます。

ファイルのサフィックスおよびディレクトリの場所各設定コンポーネントは、対応するパッケージディレクトリの settingsディレクトリ内の 1 つのファイルに保存されます。ファイル名には、設定機能.settingsという形式が使用されます。たとえば、SecuritySettings ファイルは、Security.settingsとなります。正確なファイル名を判断するには、個々の設定コンポーネントの「ファイルのサフィックスおよびディレクトリの場所」の情報を参照してください。

バージョンSettings は、API バージョン 27.0 以降で使用できます。設定コンポーネントが使用可能になった API バージョンを確認するには、個々の設定コンポーネントのバージョン情報を参照してください。

宣言的なメタデータの定義のサンプル組織の MobileSettngs のみをリリースまたは取得するために使用される、パッケージマニフェストの例を次に示します。


413

設定メタデータ型

<types><members>Mobile</members><name>Settings</name>


</Package>

組織の使用可能なすべての設定メタデータをリリースまたは取得するために使用される、パッケージマニフェストの例を次に示します。


<types><members>*</members><name>Settings</name>


</Package>

関連リンクAccountSettingsActivitiesSettingsAddressSettingsCaseSettingsChatterAnswersSettingsCompanySettingsContractSettingsEntitlementSettingsForecastingSettingsIdeasSettingsKnowledgeSettingsMobileSettingsSecuritySettings

AccountSettings取引先チーム、取引先所有者レポート、[階層の表示]リンクの組織の取引先設定を表します。Metadataメタデータ型を拡張し、その fullName項目を継承します。パッケージマニフェストでは、「Settings」の名前を使用してすべての組織設定メタデータ型にアクセスします。詳細は「設定」を参照してください。

ファイルのサフィックスおよびディレクトリの場所AccountSettings の値は、settingsフォルダのAccount.settingsファイルに保存されます。.settingsファイルは、各設定コンポーネントに設定ファイルが 1 つしかないため、他の名前つきのコンポーネントとは異なります。

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

414

AccountSettingsメタデータ型

項目

説明データ型項目名取引先所有者レポートをすべてのユーザが実行できるか(true)、否か (false) を示します。

booleanenableAccountOwnerReport

取引先チームが有効化されているか (true)、否か (false)を示します。メタデータ API を使用して、取引先チームを無効にすることはできません。

booleanenableAccountTeams

すべての法人取引先の詳細ページでデフォルトの [階層の表示] リンクが表示されているか (true)、非表示か (false) を示します。

booleanshowViewHierarchyLink

宣言的なメタデータの定義のサンプル次に、Account.settings ファイルの例を示します。

<?xml version="1.0" encoding="UTF-8"?><AccountSettings xmlns="http://soap.sforce.com/2006/04/metadata"><enableAccountOwnerReport>true</enableAccountOwnerReport><enableAccountTeams>true</enableAccountTeams><showViewHierarchyLink>true</showViewHierarchyLink></AccountSettings>

パッケージマニフェストの例組織の取引先設定メタデータをリリースまたは取得するために使用される、パッケージマニフェストの例を次に示します。

<?xml version="1.0" encoding="UTF-8"?><Package xmlns="http://soap.sforce.com/2006/04/metadata"><types><members>Account</members><name>Settings</name></types><version>29.0</version></Package>

関連リンク設定

ActivitiesSettings組織の活動設定と、カレンダー用のユーザインターフェース設定を表します。ActivitiesSettings コンポーネントの種類を使用して、次の活動設定を制御します。• グループ ToDo と定期的な ToDo、定期的な行動と複数日の行動、およびメール追跡を設定する• 複数の取引先責任者を ToDo および行動に関連付ける (Shared Activities)• ミーティング要請にカスタムロゴを表示する

415

ActivitiesSettingsメタデータ型

また、ActivitiesSettings コンポーネントの種類を使用して、フロート表示リンクやドラッグアンドドロップ編集などを含め、カレンダーのユーザインターフェース設定も制御できます。パッケージマニフェストでは、「Settings」の名前を使用してすべての組織設定メタデータ型にアクセスします。詳細は「設定」を参照してください。

ファイルのサフィックスおよびディレクトリの場所ActivitiesSettingsの値は、settingsディレクトリのActivities.settingsファイルに保存されます。.settings

ファイルは、各設定コンポーネントに設定ファイルが 1 つしかないため、他の名前つきのコンポーネントとは異なります。

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

項目次に示すすべてのタイプの設定は、[活動設定] ページまたは [ユーザインターフェース設定] ページで次のように制御されます。

説明項目のデータ型項目名組織に対してポップアップ活動アラームを有効化します。システム管理者は、この項目を [活動設定] ページで制御します。

booleanenableActivityReminders

日表示および週表示のカレンダービューで特定の時間枠をダブルクリックし、フロート表示に行動の詳細を入力する

booleanenableClickCreateEvents

ことによって、行動を作成できます。行動にマウスを置くとフロート表示が表示され、行動の詳細の参照や行動の削除をページを離れず行うことができます。システム管理者は、ミニページレイアウトを使用して、フロート表示される項目を設定します。定期的な行動または複数個人の行動はサポートしていません。システム管理者は、この項目を [ユーザインターフェース設定] ページで制御します。

リストビューからカレンダービューにレコードをドラッグし、フロート表示に行動の詳細を入力することによって、

booleanenableDragAndDropScheduling

レコードに関連する行動を作成できます。行動にマウスを置くとフロート表示が表示され、行動の詳細の参照や行動の削除をページを離れず行うことができます。システム管理者は、ミニページレイアウトを使用して、フロート表示される項目を設定します。システム管理者は、この項目を [ユーザインターフェース設定] ページで制御します。

416


説明項目のデータ型項目名組織で HTML メールテンプレートを使用している場合に、送信 HTML メールを追跡できます。システム管理者は、この項目を [活動設定] ページで制御します。

booleanenableEmailTracking

ユーザが新規 ToDo の独立したコピーを複数のユーザに割り当てることができます。システム管理者は、この項目を [活動設定] ページで制御します。

booleanenableGroupTasks

enableDragAndDropSchedulingおよびenableClickCreateEventsの機能をリストビューのカレンダーに拡張します。システム管理者は、この項目を [ユーザインターフェース設定] ページで制御します。

booleanenableListViewScheduling

開始から 24 時間以上が経過した後で終了する行動を作成できます。システム管理者は、この項目を [活動設定] ページで制御します。

booleanenableMultidayEvents

指定された間隔で繰り返される行動を作成できます。システム管理者は、この項目を [活動設定] ページで制御します。

booleanenableRecurringEvents

指定された間隔で繰り返される ToDo を作成できます。システム管理者は、この項目を [活動設定] ページで制御します。

booleanenableRecurringTasks

ユーザが最後に使用したカレンダービューへのショートカットリンクをサイドバーに表示します。システム管理者は、この項目を [活動設定] ページで制御します。

booleanenableSidebarCalendarShortcut

showCustomLogoMeetingRequestsが有効な場合に使用できます。カスタムロゴをアップロードします。システム管

stringmeetingRequestsLogo

理者は、[ドキュメント] タブで特定のフォルダにアップロードされたロゴのみを選択できます。システム管理者は、この項目を [活動設定] ページで制御します。

ミーティング要請のメールおよびミーティングの Web ページにカスタムロゴを表示します。ユーザが行動に招待する

booleanshowCustomLogoMeetingRequests

かミーティングを要請すると、招待者に対してロゴが表示されます。

417


説明項目のデータ型項目名システム管理者は、この項目を [活動設定] ページで制御します。

フロート表示テキストとしてではなく、画面上に行動の詳細を表示します。システム管理者は、この項目を [活動設定] ページで制御します。

booleanshowEventDetailsMultiUserCalendar

[ホーム] タブのカレンダーセクションで、次の処理が行われます。

booleanshowHomePageHoverLinksForEvents

• 行動の件名にマウスポインタを置くと、フロート表示リンクによって選択された行動の詳細がフロート表示されます (フロート表示リンクは他のカレンダービューで常に使用できます)。

• 行動の件名をクリックすると、行動の詳細ページが表示されます。

システム管理者は、ミニページレイアウトを使用して、フロート表示される項目を設定します。システム管理者は、この項目を [ユーザインターフェース設定] ページで制御します。

[ホーム] タブの [ToDo] セクションおよびカレンダーの日表示で、次の処理が行われます。

booleanshowMyTasksHoverLinks

• ToDo の件名にマウスポインタを置くと、選択されたToDo の詳細がフロート表示されます

• ToDo の件名をクリックすると、ToDo の詳細ページが表示されます。

システム管理者は、ミニページレイアウトを使用して、フロート表示される項目を設定します。システム管理者は、この項目を [ユーザインターフェース設定] ページで制御します。

ユーザが要請し、まだ確認していないミーティングの一覧を示す [要請済みミーティング] サブタブを、[ホーム] タブ

booleanshowRequestedMeetingsOnHomePage

の [カレンダー] セクションに表示します。この機能を無効にすると、[ホーム] タブのカレンダーから [新規ミーティング要請] ボタンが削除されます。システム管理者は、この項目を [活動設定] ページで制御します。

418


パッケージマニフェストの例組織の活動設定メタデータをリリースまたは取得するために使用される、パッケージマニフェストの例を次に示します。


<types><members>Activities</members><name>Settings</name>


</Package>

宣言的なメタデータの定義のサンプル活動設定ファイルの例を次に示します。

<?xml version="1.0" encoding="UTF-8"?><ActivitiesSettings xmlns="http://soap.sforce.com/2006/04/metadata">

<allowUsersToRelateMultipleContactsToTasksAndEvents>true</allowUsersToRelateMultipleContactsToTasksAndEvents>

<enableActivityReminders>true</enableActivityReminders><enableClickCreateEvents>true</enableClickCreateEvents><enableDragAndDropScheduling>true</enableDragAndDropScheduling><enableEmailTracking>true</enableEmailTracking><enableGroupTasks>true</enableGroupTasks><enableListViewScheduling>true</enableListViewScheduling><enableMultidayEvents>true</enableMultidayEvents><enableRecurringEvents>true</enableRecurringEvents><enableRecurringTasks>true</enableRecurringTasks><enableSidebarCalendarShortcut>true</enableSidebarCalendarShortcut><meetingRequestsLogo>Folder02/logo03.png</meetingRequestsLogo><showCustomLogoMeetingRequests>true</showCustomLogoMeetingRequests><showEventDetailsMultiUserCalendar>true</showEventDetailsMultiUserCalendar><showHomePageHoverLinksForEvents>true</showHomePageHoverLinksForEvents><showMyTasksHoverLinks>true</showMyTasksHoverLinks><showRequestedMeetingsOnHomePage>true</showRequestedMeetingsOnHomePage>

</ActivitiesSettings>

関連リンクDocument

AddressSettings国選択リストと州選択リストの設定を表します。[設定] で [データの管理] > [州/国選択リスト]をクリックしてテキストベースの値を標準の選択リスト値に変換できるように、AddressSettings コンポーネントの種類を使用して組織の都道府県および国データを設定します。詳細は、Salesforceオンラインヘルプの「州選択リストと国選択リストの概要」を参照してください。Metadata メタデータ型を拡張し、その fullName項目を継承します。パッケージマニフェストでは、「Settings」の名前を使用してすべての組織設定メタデータ型にアクセスします。詳細は「設定」を参照してください。

419

AddressSettingsメタデータ型

宣言的なメタデータファイルのサフィックスおよびディレクトリの場所AddressSettings の値は、settingsディレクトリの Address.settingsという 1 つのファイルに保存されます。.settingsファイルは、各設定コンポーネントに設定ファイルが 1 つしかないため、他の名前つきのコンポーネントとは異なります。

バージョンAddressSettings は、API バージョン 31.0 で使用できます。

CountriesAndStates

この複合メタデータ型は、選択リストに含まれる都道府県および国の有効な定義を表します。メモ: メタデータ API を使用して [州/国選択リスト] で既存の都道府県および国を編集できます。メタデータ API を使用して新規の都道府県または国を作成または削除することはできません。

説明データ型項目選択リストから選択可能な国。Country[]countries

Country

このメタデータ型は、選択リストに含まれる国の定義を提供します。

説明項目のデータ型項目API で値を使用できるかどうかを指定します。booleanactive

重要: Salesforce 組織で州/国選択リストを有効にした後に、active状況を falseに設定することはできません。

ISO 標準の都道府県または国コードに対応するテキストベースの都道府県および国の値。インテグレー

stringintegrationValue

ション値がレコード内の対応する ISO コードのテキスト列に入力されます。デフォルトのインテグレーション値は Salesforceによって指定されます。この値は、組織で以前使用した値と一致するように編集できます。これで外部システムとのインテグレーションが引き続き機能するようにできます。

重要: 組織で州/国選択リストを有効にする前にインテグレーション値を指定しない場合は、Salesforceによって指定されたデフォルト値がレコードで使用されます。インテグレーション値を後から変更すると、それ以降に作成または更新されるレコードでは、編集後の値が使用されます。

420


説明項目のデータ型項目retrieve()コールを発行すると、ISO 標準コードがこの項目に入力されます。standardの都道府県と国の isoCodeは編集できません。

stringisoCode

Salesforce の選択リストに表示されるラベル。この項目は API では参照のみですが、[設定] でラベルを編集できます。

stringlabel

Salesforce 組織の新規レコードに 1 つの国をデフォルト値として設定します。

booleanorgDefault

標準の都道府県と国は、Salesforce に含まれるものです。standard属性は編集できません。

booleanstandard

国の一部である都道府県。State[]states

Salesforce でユーザが国または都道府県を使用できるようにします。visibleである国または都道府県は、activeである必要もあります。

booleanvisible

State

このメタデータ型は、選択リストに含まれる都道府県の定義を提供します。

説明項目のデータ型項目API で値を使用できるかどうかを指定します。booleanactive

重要: Salesforce 組織で州/国選択リストを有効にした後に、active状況を falseに設定することはできません。

ISO 標準の都道府県または国コードに対応するテキストベースの都道府県および国の値。インテグレー

stringintegrationValue

ション値がレコード内の対応する ISO コードのテキスト列に入力されます。デフォルトのインテグレーション値は Salesforceによって指定されます。この値は、組織で以前使用した値と一致するように編集できます。これで外部システムとのインテグレーションが引き続き機能するようにできます。

重要: 組織で州/国選択リストを有効にする前にインテグレーション値を指定しない場合は、Salesforceによって指定されたデフォルト値がレコードで使用されます。インテグレーション値を後から変更すると、それ以降に作成または更新されるレコードでは、編集後の値が使用されます。

retrieve()コールを発行すると、ISO 標準コードがこの項目に入力されます。

stringisoCode

421


説明項目のデータ型項目Salesforce の選択リストに表示されるラベル。この項目は API では参照のみですが、[設定] でラベルを編集できます。

stringlabel

標準の都道府県と国は、Salesforce に含まれるものです。standard属性は編集できません。

booleanstandard

Salesforce でユーザが国または都道府県を使用できるようにします。visibleである国または都道府県は、activeである必要もあります。

booleanvisible

宣言的なメタデータの定義のサンプル組織で使用する米国およびカナダの州/国選択リストを設定する XML のサンプルを次に示します。また、グリーンランドの国も API でのみ使用できるようにします。この例は、API バージョン 31.0 でサポートされます。

<?xml version="1.0" encoding="UTF-8"?><AddressSettings xmlns="http://soap.sforce.com/2006/04/metadata"><countriesAndStates><countries><country><active>true</active><integrationValue>United States</integrationValue><isoCode>US</isoCode><label>United States</label><orgDefault>true</orgDefault><standard>true</standard><states><state><active>true</active><integrationValue>Alabama</integrationValue><isoCode>AL</isoCode><label>Alabama</label><standard>true</standard><visible>true</visible>

</state><state><active>true</active><integrationValue>Alaska</integrationValue><isoCode>AK</isoCode><label>Alaska</label><standard>true</standard><visible>true</visible>

</state></states><visible>true</visible>

</country><country><active>true</active><integrationValue>Canada</integrationValue><isoCode>CA</isoCode><label>Canada</label><orgDefault>false</orgDefault><states><state><active>true</active><integrationValue>Alberta</integrationValue><isoCode>AB</isoCode><label>Alberta</label><standard>true</standard><visible>true</visible>

</state>

422


<state><active>true</active><integrationValue>British Columbia</integrationValue><isoCode>BC</isoCode><label>British Columbia</label><standard>true</standard><visible>true</visible>

</state></states><visible>true</visible>

</country><country><active>true</active><integrationValue>Greenland</integrationValue><isoCode>GL</isoCode><label>Greenland</label><standard>true</standard><visible>false</visible>

</country></countries>

</countriesAndStates></AddressSettings>


BusinessHoursSettingsエンタイトルメント、エンタイトルメントテンプレート、キャンペーン、ケースの営業時間および休日の設定管理に使用するメタデータを表します。Metadata メタデータ型を拡張し、その fullName項目を継承します。パッケージマニフェストでは、「Settings」の名前を使用してすべての組織設定メタデータ型にアクセスします。詳細は「設定」を参照してください。

ファイルのサフィックスおよびディレクトリの場所営業時間および休日設定は、settingsディレクトリの businessHours.settingsという 1 つのファイルに保存されます。.settingsファイルは、各設定コンポーネントに設定ファイルが 1 つしかないため、他の名前つきのコンポーネントとは異なります。

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

項目

説明項目のデータ型項目名エンタイトルメント、エンタイトルメントテンプレート、キャンペーン、およびケースに適用する営業時間を表します。

BusinessHoursEntry[]businessHours

businessHoursの休日および使用方法を表します。

Holidays[]holidays

423

BusinessHoursSettingsメタデータ型

BusinessHoursEntry

エンタイトルメント、エンタイトルメントテンプレート、キャンペーン、およびケースに適用する営業時間を表します。

説明項目のデータ型項目名営業時間を定義する時間のタイムゾーン。stringtimeZoneId

営業時間の名前。この名前は一意にする必要があります。stringname

営業時間が有効かどうかを示します。stringactive

営業時間がデフォルトの営業時間に使用されるか否かを示します。

stringdefault

月曜日の営業時間の開始時刻。HH:mm:ss.SSSZ形式を使用します。

stringmondayStartTime

月曜日の営業時間の終了時刻。HH:mm:ss.SSSZ形式を使用します。00:00:00.000Zという値は、月曜日の午前 0 時を指定します。

stringmondayEndTime

火曜日の営業時間の開始時刻。HH:mm:ss.SSSZ形式を使用します。

stringtuesdayStartTime

火曜日の営業時間の終了時刻。HH:mm:ss.SSSZ形式を使用します。00:00:00.000Zという値は、火曜日の午前 0 時を指定します。

stringtuesdayEndTime

水曜日の営業時間の開始時刻。HH:mm:ss.SSSZ形式を使用します。

stringwednesdayStartTime

水曜日の営業時間の終了時刻。HH:mm:ss.SSSZ形式を使用します。00:00:00.000Zという値は、水曜日の午前 0 時を指定します。

stringwednesdayEndTime

木曜日の営業時間の開始時刻。HH:mm:ss.SSSZ形式を使用します。

stringthursdayStartTime

木曜日の営業時間の終了時刻。HH:mm:ss.SSSZ形式を使用します。00:00:00.000Zという値は、木曜日の午前 0 時を指定します。

stringthursdayEndTime

金曜日の営業時間の開始時刻。HH:mm:ss.SSSZ形式を使用します。

stringfridayStartTime

金曜日の営業時間の終了時刻。HH:mm:ss.SSSZ形式を使用します。00:00:00.000Zという値は、金曜日の午前 0 時を指定します。

stringfridayEndTime

土曜日の営業時間の開始時刻。HH:mm:ss.SSSZ形式を使用します。

stringsaturdayStartTime

土曜日の営業時間の終了時刻。HH:mm:ss.SSSZ形式を使用します。00:00:00.000Zという値は、土曜日の午前 0 時を指定します。

stringsaturdayEndTime

424


説明項目のデータ型項目名日曜日の営業時間の開始時刻。HH:mm:ss.SSSZ形式を使用します。

stringsundayStartTime

日曜日の営業時間の終了時刻。HH:mm:ss.SSSZ形式を使用します。00:00:00.000Zという値は、日曜日の午前 0 時を指定します。

stringsundayEndTime

休日businessHoursの休日および使用方法を表します。

説明項目のデータ型項目名休日の名前。この名前は一意にする必要はありません。stringname

休日の説明。stringdescription

休日が定期的であるかどうかを示します。stringisRecurring

休日の日付。不定期な休日に使用します。HH:mm:ss.SSSZ

形式を使用します。stringactivityDate

休日の繰り返しを開始する日付。yyyy-mm-dd形式を使用します。

stringrecurrenceStartDate

休日の繰り返しを終了する日付。yyyy-mm-dd形式を使用します。(省略可能)。

stringrecurrenceEndDate

休日の日付の開始時刻。HH:mm:ss.SSSZ形式を使用します。startTimeおよび endTimeは両方とも null であるか、

stringstartTime

両方とも null ではない必要があります。両方が null である場合、全日を示します。休日の日付の終了時刻。HH:mm:ss.SSSZ形式を使用します。startTimeおよび endTimeは両方とも null であるか、

stringendTime

両方とも null ではない必要があります。両方が null である場合、全日を示します。休日の繰り返し種別。有効な値は、RecursDaily、RecursEveryWeekday、RecursMonthly、RecursMonthlyNth、RecursWeekly、RecursYearly、RecursYealyNth です。

stringrecurrenceType

休日を繰り返す週、月または年の間隔。stringrecurrenceInterval

休日を繰り返す曜日。有効な値は Monday、Tuesday、Wednesday、Thursday、Friday、Saturday、Sunday です。

stringrecurrenceDayOfWeek

休日を繰り返す日付。有効な値は 1 ～ 31 です。stringrecurrenceDayOfMonth

有効な値は First、Second、Third、Fourth、Last です。recurrenceType RecursMonthlyNth および RecursYearlyNth で

stringrecurrenceInstance

のみ使用されます。たとえば、recurenceInstance 値が First である場合、休日は 3 か月ごとの第 1 月曜日に繰り返します。

425


説明項目のデータ型項目名有効な値は、January、February、March、April、May、June、July、August、September、October、November、December です。

stringrecurrenceMonthOfYear

この休日に適用される営業時間設定の名前。stringbusinessHours

宣言的なメタデータの定義のサンプルbusinesshours.settingsメタデータファイルの例を次に示します。

<?xml version="1.0" encoding="UTF-8"?><BusinessHoursSettings xmlns="http://soap.sforce.com/2006/04/metadata">

<businessHours><active>true</active><default>true</default><fridayEndTime>00:00:00.000Z</fridayEndTime><fridayStartTime>00:00:00.000Z</fridayStartTime><mondayEndTime>00:00:00.000Z</mondayEndTime><mondayStartTime>00:00:00.000Z</mondayStartTime><name>Default</name><saturdayEndTime>00:00:00.000Z</saturdayEndTime><saturdayStartTime>00:00:00.000Z</saturdayStartTime><sundayEndTime>00:00:00.000Z</sundayEndTime><sundayStartTime>00:00:00.000Z</sundayStartTime><thursdayEndTime>00:00:00.000Z</thursdayEndTime><thursdayStartTime>00:00:00.000Z</thursdayStartTime><timeZoneId>America/Los_Angeles</timeZoneId><tuesdayEndTime>00:00:00.000Z</tuesdayEndTime><tuesdayStartTime>00:00:00.000Z</tuesdayStartTime><wednesdayEndTime>00:00:00.000Z</wednesdayEndTime><wednesdayStartTime>00:00:00.000Z</wednesdayStartTime>

</businessHours><businessHours>

<active>true</active><default>false</default><fridayEndTime>00:00:00.000Z</fridayEndTime><fridayStartTime>00:00:00.000Z</fridayStartTime><mondayEndTime>15:00:00.000Z</mondayEndTime><mondayStartTime>09:00:00.000Z</mondayStartTime><name>bh1</name><saturdayEndTime>00:00:00.000Z</saturdayEndTime><saturdayStartTime>00:00:00.000Z</saturdayStartTime><sundayEndTime>00:00:00.000Z</sundayEndTime><sundayStartTime>00:00:00.000Z</sundayStartTime><thursdayEndTime>17:00:00.000Z</thursdayEndTime><thursdayStartTime>10:50:00.000Z</thursdayStartTime><timeZoneId>America/Los_Angeles</timeZoneId><tuesdayEndTime>13:00:00.000Z</tuesdayEndTime><tuesdayStartTime>09:00:00.000Z</tuesdayStartTime><wednesdayEndTime>15:00:00.000Z</wednesdayEndTime><wednesdayStartTime>09:00:00.000Z</wednesdayStartTime>

</businessHours><holidays>

<activityDate>2013-09-02</activityDate><businessHours>Default</businessHours><businessHours>bh1</businessHours><isRecurring>false</isRecurring><name>Labor Day</name>

</holidays><holidays>

<businessHours>bh1</businessHours><isRecurring>true</isRecurring><name>Thanksgiving</name><recurrenceDayOfMonth>21</recurrenceDayOfMonth>

426


<recurrenceMonthOfYear>November</recurrenceMonthOfYear><recurrenceStartDate>2013-11-21</recurrenceStartDate><recurrenceType>RecursYearly</recurrenceType>

</holidays></BusinessHoursSettings>

BusinessHoursSettings 定義を参照する package.xmlマニフェストの例は、次のとおりです。


<types><members>BusinessHours</members><name>Settings</name>


</Package>

CaseSettingsデフォルトのケース所有者、有効化されるケース関連機能、各種ケース活動に使用されるメールテンプレートなど、組織のケース設定を表します。パッケージマニフェストでは、「Settings」の名前を使用してすべての組織設定メタデータ型にアクセスします。詳細は「設定」を参照してください。

ファイルのサフィックスおよびディレクトリの場所CaseSettings の値は、settingsディレクトリの Case.settingsファイルに保存されます。.settingsファイルは、各設定コンポーネントに設定ファイルが 1 つしかないため、他の名前つきのコンポーネントとは異なります。

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

項目

説明項目のデータ型項目名ケース割り当て通知に使用するメールテンプレートを指定します。

stringcaseAssignNotificationTemplate

folderName/emailTemplateNameの形式を使用する必要があります。ケースクローズ通知に使用するメールテンプレートを指定します。

stringcaseCloseNotificationTemplate

folderName/emailTemplateNameの形式を使用する必要があります。ケースコメント通知に使用するメールテンプレートを指定します。

stringcaseCommentNotificationTemplate

folderName/emailTemplateNameの形式を使用する必要があります。

427

CaseSettingsメタデータ型

説明項目のデータ型項目名ケース作成通知に使用するメールテンプレートを指定します。folderName/emailTemplateNameの形式を使用する必要があります。

stringcaseCreateNotificationTemplate

ケース編集ページの [ケース状況] 項目に Closed

を表示するか (true)、否か (false) を示します。booleancloseCaseThroughStatusChange

割り当てルールで所有者を見つけられなかった場合に、ケースのデフォルトの所有者を指定します。

stringdefaultCaseOwner

デフォルトのケース所有者がユーザか、キューかを指定します。

stringdefaultCaseOwnerType

自動ケース更新の [ケース履歴] 関連リストに表示されるユーザを指定します。

stringdefaultCaseUser

• 割り当てルール• エスカレーションルール• オンデマンドメール-to-ケース• セルフサービスポータルでログインしたケース

組織のメール-to-ケース設定。EmailToCaseSettingsemailToCase

ケースフィードが有効化されているか (true)、否か (false) を示します。

booleanenableCaseFeed

ドラフトメールが有効化されているか (true)、否か (false) を示します。メールドラフトを有効に

booleanenableDraftEmails

すると、ケースフィードとメール-to-ケースも有効にする必要があります。エスカレーションルールの早期トリガが有効化されているか (true)、否か (false) を示します。

booleanenableEarlyEscalationRuleTriggers

デフォルトのメールテンプレートが有効化されているか (true)、否か (false) を示します。デフォ

booleanenableNewEmailDefaultTemplate

ルトのメールテンプレートは、ドラフトメールが有効になっている場合にのみ使用できます。ケースのページに [推奨記事] リストを表示するか(true)、否か (false) を示します。

booleanenableSuggestedArticlesApplication

enableSuggestedSolutions=falseの場合にのみ使用できます。カスタマーポータルのページに [推奨記事] リストを表示するか (true)、否か (false) を示します。

booleanenableSuggestedArticlesCustomerPortal

enableSuggestedSolutions=falseの場合にのみ使用できます。パートナーポータルのページに [推奨記事] リストを表示するか (true)、否か (false) を示します。

booleanenableSuggestedArticlesPartnerPortal

enableSuggestedSolutions=falseの場合にのみ使用できます。

428


説明項目のデータ型項目名ケースの詳細ページに [推奨ソリューションの参照] ボタンまたは [記事の検索] ボタンを表示する

booleanenableSuggestedSolutions

か (true)、否か (false) を示します。enableSuggestedArticlesApplication、enableSuggestedArticlesCustomerPortal、およびenableSuggestedArticlesPartnerPortal=falseの場合にのみ使用できます。割り当てルールを手動作成したレコードに適用するときに、既存のレコードタイプを使用するか

booleankeepRecordTypeOnAssignmentRule

(true)、既存のレコードタイプを割り当て先のデフォルトレコードタイプで上書きするか (false)を示します。ケースフィードで新規メールメッセージに使用されるデフォルトのメールテンプレートを定義する

stringnewEmailDefaultTemplateClass

Apex クラスを指定します。この項目はenableNewEmailDefaultTemplate=trueの場合にのみ表示されます。新しいコメントがケースに追加された場合に、セルフサービスポータルのメンバーではない取引先

booleannotifyContactOnCaseComment

責任者に通知できるようにするか (true)、否か(false) を示します。新規ケースが割り当てられた場合に、デフォルトのケース所有者に通知するか (true)、否か (false)を示します。

booleannotifyDefaultCaseOwner

コメントがケースに追加された場合に、ケース所有者に通知するか (true)、否か (false) を示します。

booleannotifyOwnerOnCaseComment

ユーザがケースの所有者を別のユーザに変更する場合に、ケースの[メールで通知する]チェックボッ

booleannotifyOwnerOnCaseOwnerChange

クスを自動的に選択されるようにするか (true) どうかを示します。ケースの編集ページの [保存して閉じる] ボタンと[ケース] 関連リストの [完了] リンクを非表示にするか (true)、表示するか (false) を示します。

booleanshowFewerCloseActions

ケースコメント、ケース添付ファイル、およびケース割り当てのメール通知がシステムアドレスから

booleanuseSystemEmailAddress

送信されるか (true)、またはケース通知がケースを更新するユーザまたは取引先責任者から送信されるように表示するのか (false) を示します。組織のWeb-to-ケース設定。WebToCaseSettingswebToCase

429


EmailToCaseSettings

組織のメール-to-ケース設定を表します。

項目

説明項目のデータ型項目名メール-to-ケースが有効化されているか (true)、否か (false) を示します。メール-to-ケースを有効にした後に無効にすることはできません。

booleanenableEmailToCase

HTML メールが有効化されているか (true)、否か(false) を示します。

booleanenableHtmlEmail

オンデマンドメール-to-ケースが有効化されているか (true)、否か (false) を示します。

booleanenableOnDemandEmailToCase

ケースのスレッド ID がメールの本文に挿入されるか (true)、否か (false) を示します。

booleanenableThreadIDInBody

ケースのスレッド ID がメールの件名に挿入されるか (true)、否か (false) を示します。

booleanenableThreadIDInSubject

ケースに関連する新規メールを受信したときに、ケースの所有者に通知が送信されるか (true)、否か (false) を示します。

booleannotifyOwnerOnNewCaseEmail

組織のメール-to-ケースの 1 日の上限を超えた後に受信したメールメッセージの処理方法を指定します。有効な値は、次のとおりです。

EmailToCaseOnFailureActionType(string 型の列挙)

overEmailLimitAction

• Bounce

• Discard

• Requeue

組織のメール-to-ケースのルーティングアドレス設定。

EmailToCaseRoutingAddress[]routingAddresses

無効な送信者から受信したメールメッセージの処理方法を指定します。有効な値は、次のとおりです。

EmailToCaseOnFailureActionType(string 型の列挙)

unauthorizedSenderAction

• Bounce

• Discard

EmailToCaseRoutingAddress

組織のメール-to-ケースのルーティングアドレスを表します。

430


項目

説明項目のデータ型項目名メール-to-ケースのルーティングアドレスの種類を指定します。有効な値は、次のとおりです。

EmailToCaseRoutingAddressType(string 型の列挙)

addressType

• EmailToCase — メール-to-ケースまたはオンデマンドメール-to-ケースに使用されるルーティングアドレス。

• Outlook — Outlook からケースを作成するために Salesforce for Outlookで使用されるルーティングアドレス。オンデマンドメール-to-ケースが有効になっている必要があります。

オンデマンドメール-to-ケースにメールを送信できるメールアドレスまたはドメインを指定します。

stringauthorizedSenders

カンマ区切りのリストで複数のエントリを指定できます。このルーティングアドレスから作成されたケースのデフォルトのケース発生源を指定します。

stringcaseOrigin

このルーティングアドレスから作成されたケースのデフォルトの所有者を指定します。所有者はSalesforce ユーザ名で指定します。

stringcaseOwner

デフォルトのケース所有者がユーザか、キューかを指定します。

stringcaseOwnerType

このルーティングアドレスから作成されたケースのデフォルトのケース優先度を指定します。

stringcasePriority

ケースがメールから作成されるときに、ケース所有者に ToDo が自動的に割り当てられるか (true)、否か (false) を示します。

booleancreateTask

ケースとして送信されるメールメッセージを転送するために使用されるメールアドレスを指定します。

stringemailAddress

メール-to-ケースのルーティングアドレスの名前を指定します。

stringroutingName

メールルーティングおよび封筒情報が保存されるか (true)、否か (false) を示します。

booleansaveEmailHeaders

メールがケースとして送信されるときにケース所有者に自動的に割り当てられる ToDo のデフォル

stringtaskStatus

ト状況を指定します。createTaskが trueに設定されている場合のみ適用されます。

WebToCaseSettings

組織のWeb-to-ケース設定を表します。

431


項目

説明項目のデータ型項目名この Web フォームから作成されたケースのデフォルトのケース発生源を指定します。enableWebToCaseが trueに設定されている場合のみ適用されます。

stringcaseOrigin

セルフサービスポータルから送信されたケースへのメールレスポンスに使用されるデフォルトのテンプレートを指定

stringdefaultResponseTemplate

します。enableWebToCaseが trueに設定されている場合のみ適用されます。Web-to-ケースが有効化されているか (true)、否か (false)を示します。

booleanenableWebToCase

宣言的なメタデータの定義のサンプルこれは、ケース設定ファイルのサンプルです。

<?xml version="1.0" encoding="UTF-8"?><CaseSettings xmlns="http://soap.sforce.com/2006/04/metadata">

<caseAssignNotificationTemplate>unfiled$public/SupportCaseAssignmentNotification

</caseAssignNotificationTemplate><caseCloseNotificationTemplate>

unfiled$public/SupportCaseCloseNotification</caseCloseNotificationTemplate><caseCommentNotificationTemplate>

unfiled$public/SupportCaseCommentNotification</caseCommentNotificationTemplate><caseCreateNotificationTemplate>

unfiled$public/SupportCaseCreateNotification</caseCreateNotificationTemplate><closeCaseThroughStatusChange>true</closeCaseThroughStatusChange><defaultCaseOwner>[email protected]</defaultCaseOwner><defaultCaseOwnerType>User</defaultCaseOwnerType><defaultCaseUser>[email protected]</defaultCaseUser><emailToCase>

<enableEmailToCase>true</enableEmailToCase><enableHtmlEmail>false</enableHtmlEmail><enableOnDemandEmailToCase>true</enableOnDemandEmailToCase><enableThreadIDInBody>true</enableThreadIDInBody><enableThreadIDInSubject>true</enableThreadIDInSubject><notifyOwnerOnNewCaseEmail>false</notifyOwnerOnNewCaseEmail><overEmailLimitAction>Bounce</overEmailLimitAction><routingAddresses>

<addressType>EmailToCase</addressType><authorizedSenders>[email protected]</authorizedSenders><caseOrigin>Email</caseOrigin><casePriority>Medium</casePriority><createTask>true</createTask><emailAddress>[email protected]</emailAddress><routingName>EmailToCaseRoutingAddress1</routingName><saveEmailHeaders>true</saveEmailHeaders><taskStatus>Not Started</taskStatus>

</routingAddresses><routingAddresses>

<addressType>Outlook</addressType><authorizedSenders>[email protected]</authorizedSenders><caseOrigin>Email</caseOrigin><caseOwner>[email protected]</caseOwner><caseOwnerType>User</caseOwnerType>

432


<casePriority>High</casePriority><routingName>OutlookRoutingAddress1</routingName>

</routingAddresses><unauthorizedSenderAction>Discard</unauthorizedSenderAction>

</emailToCase><enableCaseFeed>true</enableCaseFeed><enableDraftEmails>true</enableDraftEmails><enableEarlyEscalationRuleTriggers>true</enableEarlyEscalationRuleTriggers><enableNewEmailDefaultTemplate>true</enableNewEmailDefaultTemplate><enableSuggestedArticlesApplication>true</enableSuggestedArticlesApplication><enableSuggestedArticlesCustomerPortal>true</enableSuggestedArticlesCustomerPortal><enableSuggestedArticlesPartnerPortal>false</enableSuggestedArticlesPartnerPortal><enableSuggestedSolutions>false</enableSuggestedSolutions><keepRecordTypeOnAssignmentRule>true</keepRecordTypeOnAssignmentRule><newEmailDefaultTemplateClass>CaseTemplateController</newEmailDefaultTemplateClass><notifyContactOnCaseComment>true</notifyContactOnCaseComment><notifyDefaultCaseOwner>true</notifyDefaultCaseOwner><notifyOwnerOnCaseComment>true</notifyOwnerOnCaseComment><notifyOwnerOnCaseOwnerChange>false</notifyOwnerOnCaseOwnerChange><showFewerCloseActions>false</showFewerCloseActions><useSystemEmailAddress>true</useSystemEmailAddress><webToCase>

<caseOrigin>Web</caseOrigin><defaultResponseTemplate>unfiled$public/SupportCaseResponse</defaultResponseTemplate>

<enableWebToCase>true</enableWebToCase></webToCase>

</CaseSettings>


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

ファイルのサフィックスおよびディレクトリの場所Chatter アンサー設定は、settingsディレクトリの ChatterAnswers.settingsという 1 つのファイルに保存されます。.settingsファイルは、各設定コンポーネントに設定ファイルが 1 つしかないため、他の名前つきのコンポーネントとは異なります。

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

項目

説明項目のデータ型項目名フォローしている質問で最良の回答が選択された場合にユーザに通知するか (true)、否か (false) を示します。

booleanemailFollowersOnBestAnswer

433

ChatterAnswersSettingsメタデータ型

説明項目のデータ型項目名フォローしている質問に他のユーザが返答した場合にユーザに通知するか (true)、否か (false) を示します。

booleanemailFollowersOnReply

カスタマーサポートが質問に非公開で返答した場合にユーザに通知するか (true)、否か (false) を示します。

booleanemailOwnerOnPrivateReply

質問に他のユーザが返答した場合にユーザに通知するか(true)、否か (false) を示します。

booleanemailOwnerOnReply

メール通知に返信することで、ユーザが回答を投稿できるか (true)、否か (false) を示します。この項目は API バージョン 29.0 以降で使用できます。

booleanenableAnswerViaEmail

Chatter アンサーが組織で有効化されているか (true)、否か(false) を示します。

booleanenableChatterAnswers

ユーザが Facebook ログインを使用して Chatter アンサーコミュニティにサインインするか (true)、否か (false) を示

booleanenableFacebookSSO

します。この機能を有効にするには、組織のセキュリティのコントロールで Facebook 認証プロバイダを定義して有効にし、さらに組織内で認証プロバイダを有効にする必要があります。Chatter アンサーコミュニティのいずれかに質問を投稿する前に、ユーザが記事または質問で検索結果をフィルタでき

booleanenableInlinePublisher

るか (true)、否か (false) を示します。また、[タイトル]

および [内容]項目を質問に追加して、テキスト入力やスキャンを容易にすることができます。この項目は API バージョン 29.0 以降で使用できます。ユーザのプロファイルの写真の上にマウスを置くと評価が表示されるか (true)、否か (false) を示します。評価は、

booleanenableReputation

すべてのゾーンで有効になります。評価設定を有効にするには、組織で [評価] を有効にする必要があります。質問を投稿するときに、テキストを書式設定し、画像をアップロードするために、リッチテキストエディタが有効化さ

booleanenableRichTextEditor

れているか (true)、否か (false) を示します。リッチテキストエディタを有効にするには、[質問フローを最適化] を有効にする必要があります。既存の Facebook 認証プロバイダの名前。Chatter アンサーコミュニティでの Facebook シングルサインオンを実装するには、Facebook 認証プロバイダを選択する必要があります。

stringfacebookAuthProvider

Chatter アンサーをカスタマーポータルまたはパートナーポータルにタブとして追加できるか (true)、否か (false)を示します。

booleanshowInPortals

434

ChatterAnswersSettingsメタデータ型

宣言的なメタデータの定義のサンプルchatteranswers.settingsメタデータファイルの例を次に示します。

<?xml version="1.0" encoding="UTF-8"?><ChatterAnswersSettings xmlns="http://soap.sforce.com/2006/04/metadata">

<emailFollowersOnBestAnswer>true</emailFollowersOnBestAnswer><emailFollowersOnReply>true</emailFollowersOnReply><emailOwnerOnPrivateReply>true</emailOwnerOnPrivateReply><emailOwnerOnReply>true</emailOwnerOnReply><enableChatterAnswers>true</enableChatterAnswers><enableFacebookSSO>true</enableFacebookSSO><enableInlinePublisher>true</enableInlinePublisher><enableReputation>true</enableReputation><enableRichTextEditor>true</enableRichTextEditor><facebookAuthProvider>FacebookAuthProvider</facebookAuthProvider><showInPortals>true</showInPortals>

</ChatterAnswersSettings>

ChatterAnswersSettings 定義を参照する package.xmlマニフェストの例は、次のとおりです。


<types><members>ChatterAnswers</members><name>Settings</name>


</Package>


CompanySettings組織内の複数の機能に影響するグローバル設定を表します。パッケージマニフェストでは、「Settings」の名前を使用してすべての組織設定メタデータ型にアクセスします。詳細は「設定」を参照してください。

宣言的なメタデータファイルのサフィックスおよびディレクトリの場所CompanySettings の値は、対応するパッケージディレクトリの settingsディレクトリの Company.settingsという 1 つのファイルに保存されます。.settingsファイルは、各設定コンポーネントに設定ファイルが 1 つしかないため、他の名前つきのコンポーネントとは異なります。

バージョン組織プロファイルの設定は、API バージョン 27.0 以降で使用できます。

435

CompanySettingsメタデータ型

項目

説明項目のデータ型項目名年および開始月に基づく組織の会計年度設定。[カスタム会計年度] または [売上予測 (従来)] が有効になっ

FiscalYearSettingfiscalYear

ている場合は使用できません。会計年度設定を変更すると、目標および調整が消去される可能性があります。たとえば、開始月を変更すると、このデータは消去されます。

FiscalYearSetting

組織の会計年度設定を表します。

説明項目のデータ型項目この項目は、会計年度名を判断するために使用されます。有効な値は、endingMonthまたは

stringfiscalYearNameBasedOn

startingMonthです。たとえば、会計年度が 2012年 4 月から始まり、2013 年 3 月に終わる場合は、次のようになります。• この値が endingMonthのときは、会計年度名に

は 2013 が使用されます。• この値が startingMonthのときは、会計年度名

には 2012 が使用されます。

会計年度が基づく月。stringstartMonth

宣言的なメタデータの定義のサンプル — 会計年度設定会計年度設定の XML 定義のサンプルを以下に示します。この例がサポートされているのは、API バージョン27.0 以降です。

<?xml version="1.0" encoding="UTF-8"?><CompanySettings xmlns="http://soap.sforce.com/2006/04/metadata">

<fiscalYear><fiscalYearNameBasedOn>endingMonth</fiscalYearNameBasedOn><startMonth>January</startMonth>

</fiscalYear></CompanySettings>


ContractSettings契約の設定を表します。詳細は、Salesforceオンラインヘルプの「契約の設定のカスタマイズ」を参照してください。

436

ContractSettingsメタデータ型

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

ファイルのサフィックスおよびディレクトリの場所settingsディレクトリには、Contract.settingsという名前のファイルに保存される契約設定ファイルが 1つあります。.settingsファイルは、各設定コンポーネントに設定ファイルが 1 つしかないため、他の名前つきのコンポーネントとは異なります。

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

項目


項目名

契約の終了日が自動的に計算されるか (true)、否か (false)を示します。

booleanautoCalculateEndDate

契約の期限が切れるときに、取引先および取引先責任者にメール通知が自動的に送信されるか (true)、否か (false)を示します。

booleannotifyOwnersOnContractExpiration

宣言的なメタデータの定義のサンプルこれは、契約設定ファイルのサンプルです。

<?xml version="1.0" encoding="UTF-8"?><ContractSettings xmlns="http://soap.sforce.com/2006/04/metadata">

<autoCalculateEndDate>true</autoCalculateEndDate><notifyOwnersOnContractExpiration>false</notifyOwnersOnContractExpiration>

</ContractSettings>


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

ファイルのサフィックスおよびディレクトリの場所EntitlementSettings の値は、settingsディレクトリの Entitlements.settingsファイルに保存されます。.settingsファイルは、各設定コンポーネントに設定ファイルが 1 つしかないため、他の名前つきのコンポーネントとは異なります。

437

EntitlementSettingsメタデータ型

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

項目

説明項目のデータ型項目名ケースのエンタイトルメント関連ルックアップ検索条件が、ケースの取引先の有効なエンタイ

booleanassetLookupLimitedToActiveEntitlementsOnAccount

トルメントに関連する納入商品のみを返すか(true)、否か (false) を示します。ケースのエンタイトルメント関連ルックアップ検索条件が、ケースの取引先責任者の有効なエ

booleanassetLookupLimitedToActiveEntitlementsOnContact

ンタイトルメントに関連する納入商品のみを返すか (true)、否か (false) を示します。ケースのエンタイトルメント関連ルックアップ検索条件が、ケースの取引先に関連する納入商

booleanassetLookupLimitedToSameAccount

品のみを返すか (true)、否か (false) を示します。ケースのエンタイトルメント関連ルックアップ検索条件が、ケースの取引先責任者に関連する

booleanassetLookupLimitedToSameContact

納入商品のみを返すか (true)、否か (false) を示します。エンタイトルメントが有効化されているか(true)、否か (false) を示します。

booleanenableEntitlements

エンタイトルメントのバージョン管理が有効化されているか (true)、否か (false) を示します。この項目は API バージョン 28.0 以降で使用できます。

booleanenableEntitlementVersioning

ケースのエンタイトルメント関連ルックアップ検索条件が、有効なエンタイトルメントのみを返すか (true)、否か (false) を示します。

booleanentitlementLookupLimitedToActiveStatus

ケースのエンタイトルメント関連ルックアップ検索条件が、ケースの取引先に関連するエンタ

booleanentitlementLookupLimitedToSameAccount

イトルメントのみを返すか (true)、否か (false)を示します。ケースのエンタイトルメント関連ルックアップ検索条件が、ケースの納入商品に関連するエン

booleanentitlementLookupLimitedToSameAsset

タイトルメントのみを返すか (true)、否か(false) を示します。ケースのエンタイトルメント関連ルックアップ検索条件が、ケースの取引先担当者に関連する

booleanentitlementLookupLimitedToSameContact

エンタイトルメントのみを返すか (true)、否か(false) を示します。

438

EntitlementSettingsメタデータ型

宣言的なメタデータの定義のサンプルこれは、エンタイトルメント設定ファイルのサンプルです。

<?xml version="1.0" encoding="UTF-8"?><EntitlementSettings xmlns="http://soap.sforce.com/2006/04/metadata">

<assetLookupLimitedToActiveEntitlementsOnAccount>false

</assetLookupLimitedToActiveEntitlementsOnAccount><assetLookupLimitedToActiveEntitlementsOnContact>

false</assetLookupLimitedToActiveEntitlementsOnContact><assetLookupLimitedToSameAccount>

false</assetLookupLimitedToSameAccount><assetLookupLimitedToSameContact>

false</assetLookupLimitedToSameContact><enableEntitlements>

true</enableEntitlements><entitlementLookupLimitedToActiveStatus>

false</entitlementLookupLimitedToActiveStatus><entitlementLookupLimitedToSameAccount>

false</entitlementLookupLimitedToSameAccount><entitlementLookupLimitedToSameAsset>

false</entitlementLookupLimitedToSameAsset><entitlementLookupLimitedToSameContact>

false</entitlementLookupLimitedToSameContact>

</EntitlementSettings>


ForecastingSettingsコラボレーション売上予測設定オプションを表します。Metadataメタデータ型を拡張し、その fullName項目を継承します。

メモ: この情報は、コラボレーション売上予測にのみ適用されます。

ファイルのサフィックスおよびディレクトリの場所ForecastingSettingsの値は、対応するパッケージディレクトリのsettingsディレクトリのForecasting.settings

という 1 つのファイルに保存されます。.settingsファイルは、各設定コンポーネントに設定ファイルが 1 つしかないため、他の名前つきのコンポーネントとは異なります。

バージョンForecastingSettings コンポーネントは、API バージョン 28 以降で使用できます。ForecastingSettings 型の構造は、API バージョン 30.0 で大幅に変更されました。

439

ForecastingSettingsメタデータ型

項目

説明項目のデータ型項目名売上予測の表示に使用する通貨。組織のマスタ通貨または各売上予測所有者の個人設定の通貨のいずれかになります。

DisplayCurrency(string 型の列挙)

displayCurrency

これは、コラボレーション売上予測で使用され、設定で選択されるデフォルトの通貨です。組織で使用するために有効化されているいずれか 1 つの通貨を選択する必要があり、選択できるのは 1 つのみです。デフォルトは Corporateです。有効な値は、次のとおりです。• Corporate

• Personal

コラボレーション売上予測が有効化されているかどうかを示します。コラボレーション売上予測を有効にするにはtrue

に設定し、無効にするには falseに設定します。

booleanenableForecasts

警告: 売上予測を無効にすると、データが失われる可能性があります。機能を無効にする前に、オンラインヘルプを参照してください。

売上予測種別のリストです。項目値については、「ForecastingTypeSettings」を参照してください。売上予測種別の最大数は 4 です。

ForecastingTypeSettings[]forecastingTypeSettings

ForecastingTypeSettings

各売上予測種別の設定。組織では、最大 4 個の売上予測種別を有効にできます。最小の API バージョンがメタデータパッケージバージョン以下の、以前有効だった売上予測種別を除外すると、その目標と調整データが組織から削除されます。

警告: XML から売上予測種別項目を除外すると、その売上予測種別が無効になる場合があります。その売上予測種別が XML パッケージバージョンで指定されたリリースで使用可能だった場合、その売上予測種別は無効になり、その目標および調整データは削除されます。

説明項目のデータ型項目名これは、name項目で指定されている売上予測種別が有効かどうかを示します。

booleanactive

メモ: active項目を false に設定すると、その売上予測種別のすべての売上予測データ、調整、および目標が消去されます。activeを true に設定すると、[売上予測] タブの一部の値がすぐに表示されない場合があります。処理中アイコンが表示され、値が計算中であることを示します。

これは、売上予測の売上予測調整オプションを有効または無効にします。

AdjustmentsSettingsadjustmentsSettings

440


説明項目のデータ型項目名コラボレーション売上予測のデフォルトの期間と範囲の選択。

ForecastRangeSettingsforecastRangeSettings

売上予測種別の名前。売上予測種別ごとに特定の文字列が必要です。使用できる値は次のとおりです。

stringname

• OpportunityRevenue: 商談 - 収益• OpportunityQuantity: 商談 - 数量• OpportunitySplitRevenue: 商談収益分割 - 収益• OpportunityLineItemRevenue: 商品ファミリ - 収益• OpportunityLineItemQuantity: 商品ファミリ - 数量

売上予測種別の売上予測ページの商談ペインに表示するために選択された項目。[商談名]は必須項目です。15 項目まで選択できます。

OpportunityListFieldsSelectedSettingsopportunityListFieldsSelectedSettings

これは、売上予測の目標オプションを有効または無効にします。

QuotasSettingsquotasSettings

AdjustmentsSettings

コラボレーション売上予測の調整オプション。

説明項目のデータ型項目コラボレーション売上予測の調整を有効にするにはtrueに設定し、無効にするには falseに設定しま

booleanenableAdjustments

す。すべての売上予測種別には、同じenableAdjustments値が含まれている必要があります。

警告: 調整を無効にすると、コラボレーション売上予測調整データが消去されます。

ForecastRangeSettings

コラボレーション売上予測のデフォルトの期間と範囲の選択。ユーザは、過去または将来の 12 か月または 8 四半期までの売上予測が可能です。売上予測範囲に当月または四半期が含まれている場合、[売上予測] ページの積み上げ集計テーブルでデフォルトで選択されている期間は当月または当四半期です。含まれていない場合、最初の月または四半期が積み上げ集計テーブルでデフォルトで選択されます。すべての売上予測種別には、同じforecastRangeSettings項目値が含まれている必要があります。

警告: 期間の設定を [毎月] から [毎四半期] または [毎四半期] から [毎月] に変更するか、標準会計年度を変更すると、すべての調整および目標が消去されます。これらの変更により、売上予測の再計算がトリガされます。組織のデータ量に応じて、この再計算にかなりの時間がかかる場合があります。

441


説明項目のデータ型項目デフォルトで表示する開始月または開始四半期を示します。

intbeginning

デフォルトで表示する月数または四半期数を示します。最大月数は 12、最大四半期数は 8 です。

intdisplaying

使用する期間の種別を示します。有効な値は、次のとおりです。

PeriodTypes (string 型の列挙)

periodType

• Month

• Quarter

OpportunityListFieldsSelectedSettings

売上予測種別の売上予測ページの商談ペインに表示するために選択された項目。[商談名]は必須項目です。15項目まで選択できます。

説明項目のデータ型項目商談ペインに表示する項目名を指定します。stringfield

QuotasSettings

QuotasSettings は、コラボレーション売上予測で目標を使用できるかどうかを示します。

説明項目のデータ型項目目標を有効にするには、trueに設定します。すべての売上予測種別には、同じ showQuotas項目値が含まれている必要があります。

booleanshowQuotas

宣言的なメタデータの定義のサンプル次に、[商談 - 収益] および [商品ファミリ - 数量] 売上予測種別を有効にする ForecastingSettings コンポーネントの例を示します。

<?xml version="1.0" encoding="UTF-8"?><ForecastingSettings xmlns="http://soap.sforce.com/2006/04/metadata">

<enableForecasts>true</enableForecasts><forecastingTypeSettings>

<active>true</active><adjustmentsSettings>

<enableAdjustments>true</enableAdjustments></adjustmentsSettings><name>OpportunityRevenue</name><forecastRangeSettings>

<beginning>0</beginning><displaying>6</displaying><periodType>Month</periodType>

</forecastRangeSettings><opportunityListFieldsSelectedSettings>

<field>OPPORTUNITY.NAME</field></opportunityListFieldsSelectedSettings><quotasSettings>

<showQuotas>true</showQuotas>

442


</quotasSettings></forecastingTypeSettings><forecastingTypeSettings>

<active>false</active><adjustmentsSettings>

<enableAdjustments>true</enableAdjustments></adjustmentsSettings><name>OpportunityLineItemQuantity</name><forecastRangeSettings>

<beginning>0</beginning><displaying>6</displaying><periodType>Month</periodType>

</forecastRangeSettings><opportunityListFieldsSelectedSettings>

<field>OPPORTUNITY.NAME</field></opportunityListFieldsSelectedSettings><quotasSettings>

<showQuotas>true</showQuotas></quotasSettings>

</forecastingTypeSettings>


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

ファイルのサフィックスおよびディレクトリの場所IdeasSettings は、対応するパッケージディレクトリの settingsフォルダ内の Ideas.settingsという 1 つのファイルに保存されます。.settingsファイルは、各設定コンポーネントに設定ファイルが 1 つしかないため、他の名前つきのコンポーネントとは異なります。

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

アイデアアイデアおよびアイデアのテーマの設定を表します。

項目

説明項目のデータ型項目名アイデアのテーマが有効化されているか (true)、否か(false) を示します。

booleanenableIdeaThemes

アイデアが有効化されているか (true)、否か (false) を示します。

booleanenableIdeas

443

IdeasSettingsメタデータ型

説明項目のデータ型項目名評価が有効化されているか (true)、否か (false) を示します。組織で「アイデアの評価」権限が有効化されていない

booleanenableIdeasReputation

場合は、IdeasReputation を有効化できません。この項目はAPI バージョン 28.0 以降で使用できます。アイデアユーザプロファイルに Chatter ユーザプロファイルが使用されることを示します。enableChatterProfileが

booleanenableChatterProfile

trueである場合、ideasProfilePage値は指定しないでください。enableChatterProfileが falseである場合、ideasProfilePage値を指定します。指定しない場合、アイデアゾーンプロファイルが使用されます。この項目はAPIバージョン 29.0 以降で使用できます。enableChatterProfileがfalseの場合に、カスタムアイデアユーザプロファイルに使用する Visualforce ページの名

stringideasProfilePage

前。enableChatterProfileが falseである場合、ideasProfilePage値を指定します。指定しない場合、アイデアゾーンプロファイルが使用されます。この項目はAPIバージョン 29.0 以降で使用できます。[人気のあるアイデア] サブタブで、どのくらいの期間が経過すると古いアイデアの順位が下がるのかを示します。半

doublehalfLife

減期設定により、[人気のあるアイデア] サブタブで古いアイデアが順位を下げ、新しい投票を多く集めているアイデアに順位を譲るまでの日数が決められます。半減期が短いと、長い場合よりも早く古いアイデアがページの下の方に移動します。

宣言的なメタデータの定義のサンプルideas.settingsメタデータファイルの例を次に示します。

<?xml version="1.0" encoding="UTF-8"?><IdeasSettings xmlns="http://soap.sforce.com/2006/04/metadata">

<enableIdeaThemes>true</enableIdeaThemes><enableIdeas>true</enableIdeas><enableIdeasReputation>true</enableIdeasReputation><enableChatterProfile>false</enableChatterProfile><ideasProfilePage>name of Visualforce page</ideasProfilePage><halfLife>2.6</halfLife>

</IdeasSettings>


KnowledgeSettingsSalesforce ナレッジの設定管理に使用するメタデータを表します。Metadataメタデータ型を拡張し、そのfullName


444

KnowledgeSettingsメタデータ型


ファイルのサフィックスおよびディレクトリの場所KnowledgeSettingsの値は、settingsディレクトリの Knowledge.settingsという 1 つのファイルに保存されます。.settingsファイルは、各設定コンポーネントに設定ファイルが 1 つしかないため、他の名前つきのコンポーネントとは異なります。

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

項目

説明項目のデータ型項目名Salesforce ナレッジおよびアンサーの設定管理に使用するメタデータを表します。

KnowledgeAnswerSettingsanswers

Salesforce ナレッジおよびケースの設定管理に使用するメタデータを表します。

KnowledgeCaseSettingscases

必須。Salesforce ナレッジのデフォルトの言語。米国英語では en_US など、言語の略語を使用します。

stringdefaultLanguage

Salesforce ナレッジで有効化された言語のリスト。

KnowledgeLanguageSettingslanguages

Chatterを介したケースのデフレクションの追跡が有効か (true)、否か (false) を示します。

booleanenableChatterQuestionKBDeflection

ユーザが記事タブで記事の作成と編集ができるか (true)、否か (false) を示します。

booleanenableCreateEditOnArticlesTab

外部メディアへの接続が有効化されているか (true)、否か (false) を示します。

booleanenableExternalMediaContent

Salesforce ナレッジが有効化されているか(true)、否か (false) を示します。

booleanenableKnowledge

記事の概要がカスタマーポータルに表示されるか (true)、否か (false) を示します。

booleanshowArticleSummariesCustomerPortal

記事の概要が社内の知識ベースに表示されるか (true)、否か (false) を示します。

booleanshowArticleSummariesInternalApp

記事の概要がパートナーポータルに表示されるか (true)、否か (false) を示します。

booleanshowArticleSummariesPartnerPortal

445


説明項目のデータ型項目名検証状況が記事に表示されるか (true)、否か (false) を示します。

booleanshowValidationStatusField

KnowledgeAnswerSettings

Salesforce ナレッジおよびアンサーの設定管理に使用するメタデータを表します。


項目名

アンサーから記事が割り当てられるユーザ名を指定します。stringassignTo

アンサーから作成される記事のデフォルトの記事タイプ。記事タイプの API 名を使用します。

stringdefaultArticleType

ユーザがアンサーから記事を作成できるか (true)、否か(false) を示します。

booleanenableArticleCreation

KnowledgeCaseSettings

Salesforce ナレッジおよびケースの設定管理に使用するメタデータを表します。

説明項目のデータ型項目名ケースから記事の PDF を作成するために使用するプロファイル。

stringarticlePDFCreationProfile

Salesforce ナレッジおよびサイトの設定管理に使用するメタデータを表します。

KnowledgeSitesSettingsarticlePublicSharingSites

Chatter アンサーで Salesforce ナレッジおよびサイトの設定管理に使用するメタデータを表します。

KnowledgeSitesSettingsarticlePublicSharingSitesChatterAnswers

ケースから記事が割り当てられるユーザ名を指定します。

stringassignTo

カスタマイズに使用する Apex クラスを指定します。

stringcustomizationClass

ケースから作成される記事のデフォルトの記事タイプ。

stringdefaultContributionArticleType

リッチテキストエディタの種類を示します。有効な値は、次のとおりです。

KnowledgeCaseEditor(string 型の列挙)

editor

• simple

• standard

ユーザがケースから記事を作成できるか(true)、否か (false) を示します。

booleanenableArticleCreation

KnowledgeCaseSettings の他の項目を設定できるかどうかを制御します。

446


説明項目のデータ型項目名ケースから公開サイト (URL) 経由で記事を共有できるか (true)、否か (false) を示します。

booleanenableArticlePublicSharingSites

ケースから記事の PDF を作成するためにプロファイルが使用されるか (true)、否か(false) を示します。

booleanuseProfileForPDFCreation

KnowledgeSitesSettings

Salesforce ナレッジおよびサイトの設定管理に使用するメタデータを表します。


項目名

Salesforce ナレッジおよびサイトに使用するサイトを指定します。

string[]site

KnowledgeLanguageSettings

Salesforce ナレッジで有効化された言語のリスト。KnowledgeLanguageSettings は、API バージョン 28.0 以降で使用できます。

説明項目のデータ型項目名Salesforce ナレッジで有効化された言語の設定管理に使用するメタデータを表します。

KnowledgeLanguagelanguage

KnowledgeLanguage

Salesforce ナレッジで有効化された言語の設定管理に使用するメタデータを表します。KnowledgeLanguage は、API バージョン 28.0 以降で使用できます。

説明項目のデータ型項目名言語が有効化されているか (true)、否か(false) を示します。

booleanactive

その言語の記事のデフォルトの任命先。stringdefaultAssignee

デフォルトの任命先の種別を示します。有効な値は、次のとおりです。

KnowledgeLanguageLookupValueType(string 型の列挙)

defaultAssigneeType

• user

• queue

その言語の記事のデフォルトの校閲者。stringdefaultReviewer

デフォルトの校閲者の種別を示します。有効な値は、次のとおりです。

KnowledgeLanguageLookupValueType(string 型の列挙)

defaultReviewerType

• user

• queue

447


説明項目のデータ型項目名言語名のコード (英語の場合は en)。サポートされる言語およびそのコードの一覧は、

stringname

Salesforce オンラインヘルプの「Salesforce がサポートする言語は?」を参照してください。

宣言的なメタデータの定義のサンプルこれは、ナレッジ設定ファイルのサンプルです。

<?xml version="1.0" encoding="UTF-8"?><KnowledgeSettings xmlns="http://soap.sforce.com/2006/04/metadata">

<answers><enableArticleCreation>false</enableArticleCreation>

</answers><cases>

<articlePDFCreationProfile>partner portal knowledgeprofile</articlePDFCreationProfile>

<articlePublicSharingSites><site>KnowledgeSite</site><site>PKB2Site</site><site>ChatterAnswersSite</site>

</articlePublicSharingSites><articlePublicSharingSitesChatterAnswers>

<site>ChatterAnswersSite</site></articlePublicSharingSitesChatterAnswers><assignTo>[email protected]</assignTo><defaultContributionArticleType>Support</defaultContributionArticleType><editor>simple</editor><enableArticleCreation>true</enableArticleCreation><enableArticlePublicSharingSites>true</enableArticlePublicSharingSites><useProfileForPDFCreation>true</useProfileForPDFCreation>

</cases><defaultLanguage>ja</defaultLanguage><enableCreateEditOnArticlesTab>true</enableCreateEditOnArticlesTab><enableExternalMediaContent>true</enableExternalMediaContent><enableKnowledge>true</enableKnowledge><showArticleSummariesCustomerPortal>true</showArticleSummariesCustomerPortal><showArticleSummariesInternalApp>true</showArticleSummariesInternalApp><showArticleSummariesPartnerPortal>true</showArticleSummariesPartnerPortal><showValidationStatusField>true</showValidationStatusField>

</KnowledgeSettings>


LiveAgentSettingsLive Agent が有効化されているかどうかなどの、組織の Live Agent 設定を表します。Metadata メタデータ型を拡張し、その fullName項目を継承します。

ファイルのサフィックスおよびディレクトリの場所LiveAgentSettingsの値は、settingsディレクトリのLiveAgent.settingsファイルに保存されます。.settings

ファイルは、各設定コンポーネントに設定ファイルが 1 つしかないため、他の名前つきのコンポーネントとは異なります。

448

LiveAgentSettingsメタデータ型


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

項目

説明項目のデータ型項目名Live Agent が有効化されているか (true)、否か(false) を示します。

booleanenableLiveAgent

宣言的なメタデータの定義のサンプルこれは、Live Agent 設定ファイルのサンプルです。

<?xml version="1.0" encoding="UTF-8"?><LiveAgentSettings xmlns="http://soap.sforce.com/2006/04/metadata">

<enableLiveAgent>true</enableLiveAgent></LiveAgentSettings>

MobileSettingsChatter 設定や、Mobile Lite が有効化されているかどうかなどの、組織のモバイル設定を表します。詳細は、Salesforce オンラインヘルプの「Salesforce Classic デバイスの管理」および「Chatter Mobile for BlackBerry の概要」を参照してください。パッケージマニフェストでは、「Settings」の名前を使用してすべての組織設定メタデータ型にアクセスします。詳細は「設定」を参照してください。

宣言的なメタデータファイルのサフィックスおよびディレクトリの場所MobileSettings の値は、settingsディレクトリの Mobile.settingsという 1 つのファイルに保存されます。.settingsファイルは、各設定コンポーネントに設定ファイルが 1 つしかないため、他の名前つきのコンポーネントとは異なります。

メモ: MobileSettings は、API バージョン 25.0 および 26.0 では今後使用できません。

バージョンモバイル設定は、API バージョン 27.0 以降で使用できます。

項目

説明データ型項目Chatter Mobile デバイスの設定。ChatterMobileSettingschatterMobile

449

MobileSettingsメタデータ型

説明データ型項目モバイルデバイスのダッシュボードの設定。

DashboardMobileSettingsdashboardMobile

モバイルデバイスの一般的なユーザの設定。

SFDCMobileSettingssalesforceMobile

モバイルデバイスのタッチの設定。TouchMobileSettingstouchMobile (廃止)

ChatterMobileSettings

組織の Chatter Mobile 設定を表します。

説明データ型項目iPad デバイスで Chatter Mobile が有効化されているか (true)、否か(false) を示します。

booleanIPadAuthorized

iPhone デバイスで Chatter Mobile が有効化されているか (true)、否か(false) を示します。

booleanIPhoneAuthorized

Android デバイスでChatter Mobileが有効化されているか (true)、否か(false) を示します。

booleanandroidAuthorized

Blackberry デバイスで Chatter Mobileが有効化されているか (true)、否か(false) を示します。

booleanblackBerryAuthorized

組織で Chatter Mobile が有効化されているか (true)、否か (false) を示します。

booleanenableChatterMobile

メモ: これを trueに設定すると、その他のすべての設定を設定できます。この設定を trueから falseに変更して、さらに、その他いずれかの ChatterMobile 設定を変更しようと試みると、リリースはエラーで失敗します。

組織で Chatter 転送通知が有効化されているか (true)、否か (false) を示します。

booleanenablePushNotifications

何も操作を行っていないユーザに、ログアウトするか操作を続行するか

MobileSessionTimeout (string 型の列挙)

sessionTimeout

を尋ねるまでの時間。有効な値は、次のとおりです。

450


説明データ型項目• Never

• OneMinute

• FiveMinutes

• TenMinutes

• ThirtyMinutes

DashboardMobileSettings

組織のモバイルダッシュボード iPad アプリケーションの設定を表します。

説明データ型項目モバイルダッシュボード iPad アプリケーションが組織で有効化されてい

booleanenableDashboardIPadApp

るか (true)、否か (false) を示します。

SFDCMobileSettings

組織の一般的なモバイル設定を表します。

説明データ型項目ユーザをモバイルデバイスに永続的にリンクします。ユーザがシステム

booleanenableUserToDeviceLinking

管理者の介入なしでデバイスを切り替えることができないようにする場合のみ、このオプションを trueに設定します。組織でMobile Liteが有効化されているか (true)、否か (false) を示します。

booleanenableMobileLite

TouchMobileSettings

この項目は廃止されました。Salesforce Touch は、Salesforce1 アプリケーションにアップグレードされました。

説明データ型項目組織で Salesforce Touchモバイルブラウザアプリケーションが有効化され

booleanenableTouchBrowserIPad

ているか (true)、否か (false) を示します。組織で Salesforce Touchのダウンロード可能なアプリケーションが有効化

booleanenableTouchAppIPad

されているか (true)、否か (false)を示します。

451


宣言的なメタデータの定義のサンプルこれは、mobile.settingsメタデータファイルのサンプルです。

<?xml version="1.0" encoding="UTF-8"?><MobileSettings xmlns="http://soap.sforce.com/2006/04/metadata">

<chatterMobile><IPadAuthorized>true</IPadAuthorized><IPhoneAuthorized>true</IPhoneAuthorized><androidAuthorized>true</androidAuthorized><blackBerryAuthorized>true</blackBerryAuthorized><enableChatterMobile>true</enableChatterMobile><enablePushNotifications>true</enablePushNotifications><sessionTimeout>Never</sessionTimeout>

</chatterMobile><dashboardMobile>

<enableDashboardIPadApp>true</enableDashboardIPadApp></dashboardMobile><salesforceMobile>

<enableUserToDeviceLinking>false</enableUserToDeviceLinking><enableMobileLite>false</enableMobileLite>

</salesforceMobile><touchMobile>

<enableTouchBrowserIPad>false</enableTouchBrowserIPad><enableTouchAppIPad>true</enableTouchAppIPad>

</touchMobile></MobileSettings>


OpportunitySettings商談の自動更新や類似商談条件検索などの機能に関する組織の設定を表します。Metadata メタデータ型を拡張し、その fullName項目を継承します。

ファイルのサフィックスおよびディレクトリの場所OpportunitySettings の値は、対応するパッケージディレクトリのsettingsディレクトリのOpportunity.settings

という 1 つのファイルに保存されます。.settingsファイルは、各設定コンポーネントに設定ファイルが 1 つしかないため、他の名前つきのコンポーネントとは異なります。

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

項目

説明項目のデータ型項目名ユーザは商談でスケジュール済みの自動更新を有効化することができます。

booleanenableUpdateReminders

新しい商談に自動的にスケジュール済みの更新を使用します。

booleanautoActivateNewReminders

既存の商談に関連または類似する商談を表示できます。booleanenableFindSimilarOpportunities

452

OpportunitySettingsメタデータ型

説明項目のデータ型項目名類似商談のパラメータを定義します。multipicklistfindSimilarOppFilter

チームメンバーを商談に関連付けることができます。booleanenableOpportunityTeam

関連する商品を商談に追加することをユーザに要求します。booleanpromptToAddProducts

FindSimilarOppFilter

列全体または項目全体のどちらで照合するかを定義します。

説明項目のデータ型項目比較する列。stringsimilarOpportunitiesDisplayColumns

比較する項目。stringsimilarOpportunitiesMatchFields

宣言的なメタデータの定義のサンプル次に、パッケージファイルの例を示します。


<types><members>Opportunity</members><name>Settings</name>


</Package>

パッケージファイルは、次の Opportunity.settings ファイルを参照します。

<?xml version="1.0" encoding="UTF-8"?><OpportunitySettings xmlns="http://soap.sforce.com/2006/04/metadata">

<autoActivateNewReminders>true</autoActivateNewReminders><enableFindSimilarOpportunities>true</enableFindSimilarOpportunities><findSimilarOppFilter>

<similarOpportunitiesMatchFields>OPPORTUNITY.Account</similarOpportunitiesMatchFields>

<similarOpportunitiesMatchFields>OPPORTUNITY.OpportunityCompetitors</similarOpportunitiesMatchFields>

<similarOpportunitiesMatchFields>CustomField__c</similarOpportunitiesMatchFields>

<similarOpportunitiesDisplayColumns>CustomField__c</similarOpportunitiesDisplayColumns></findSimilarOppFilter><enableOpportunityTeam>true</enableOpportunityTeam><enableUpdateReminders>true</enableUpdateReminders><promptToAddProducts>false</promptToAddProducts>

</OpportunitySettings>

OrderSettings注文の設定を表します。Metadataメタデータ型を拡張し、その fullName項目を継承します。詳細は、Salesforceヘルプの「注文の設定のカスタマイズ」を参照してください。

453

OrderSettingsメタデータ型


ファイルのサフィックスおよびディレクトリの場所settingsフォルダ内の Order.settingsという名前のファイルに 1 つの OrderSettings コンポーネントが入っています。.settingsファイルは、各設定コンポーネントに設定ファイルが 1 つしかないため、他の名前つきのコンポーネントとは異なります。

バージョンOrderSettings コンポーネントは、API バージョン 30.0 以降で使用できます。

項目

説明項目のデータ型項目名組織のユーザが、数量が 0 未満の注文商品を追加できるか(true)、否か (false) を示します。この設定を有効にするには、enableOrdersをtrueに設定する必要があります。

booleanenableNegativeQuantity

組織で注文が有効化されているか (true)、否か (false) を示します。

booleanenableOrders

組織で削減注文が有効化されているか (true)、否か (false)を示します。詳細は、Salesforceヘルプの「削減注文の概要」を参照してください。この設定を有効にするには、enableOrdersをtrueに設定する必要があります。

booleanenableReductionOrders

宣言的なメタデータの定義のサンプルこれは、OrderSettings コンポーネントのサンプルです。

<?xml version="1.0" encoding="UTF-8"?><OrderSettings xmlns="http://soap.sforce.com/2006/04/metadata">

<enableOrders>true</enableOrders><enableReductionOrders>false</enableReductionOrders><enableNegativeQuantity>true</enableNegativeQuantity>

</OrderSettings>



<types><members>Order</members><name>Settings</name>


</Package>

454

OrderSettingsメタデータ型

ProductSettings数量スケジュール、収益スケジュール、および有効フラグと価格の相互作用の組織の設定を表します。Metadataメタデータ型を拡張し、その fullName項目を継承します。

ファイルのサフィックスおよびディレクトリの場所ProductSettings の値は、対応するパッケージディレクトリの settingsディレクトリの Product.settingsという 1 つのファイルに保存されます。.settingsファイルは、各設定コンポーネントに設定ファイルが 1 つしかないため、他の名前つきのコンポーネントとは異なります。

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

項目

説明項目のデータ型項目名商品レコード上の有効フラグを変更した場合、関連する価格の有効フラグも自動的に更新します。

booleanenableCascadeActivateToRelatedPrices

商品の数量スケジュールを有効化します。booleanenableQuantitySchedule

商品の収益スケジュールを有効化します。booleanenableRevenueSchedule



<types><members>Product</members><name>Settings</name>


</Package>

パッケージファイルは、次の Product.settings ファイルを参照します。

<?xml version="1.0" encoding="UTF-8"?><ProductSettings xmlns="http://soap.sforce.com/2006/04/metadata">

<enableCascadeActivateToRelatedPrices>true</enableCascadeActivateToRelatedPrices><enableQuantitySchedule>false</enableQuantitySchedule><enableRevenueSchedule>false</enableRevenueSchedule>

</ProductSettings>

QuoteSettings商品およびサービスの提案された価格を示す見積を有効または無効にします。Metadataメタデータ型を拡張し、その fullName項目を継承します。

455

ProductSettingsメタデータ型

ファイルのサフィックスおよびディレクトリの場所QuoteSettings の値は、対応するパッケージディレクトリの settingsディレクトリの Quote.settingsという1 つのファイルに保存されます。.settingsファイルは、各設定コンポーネントに設定ファイルが 1 つしかないため、他の名前つきのコンポーネントとは異なります。

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

項目

説明項目のデータ型項目名trueに設定されていると、ユーザは見積にアクセスできます。

booleanenableQuote



<types><members>Quote</members><name>Settings</name>


</Package>

パッケージファイルは、次の Quote.settings ファイルを参照します。

<?xml version="1.0" encoding="UTF-8"?><QuoteSettings xmlns="http://soap.sforce.com/2006/04/metadata">

<enableQuote>true</enableQuote></QuoteSettings>

SecuritySettings組織のセキュリティ設定を表します。セキュリティ設定は、ネットワークアクセス用の信頼できる IP 範囲、パスワードとログインの要件、およびセッション終了とセキュリティ設定を定義します。パッケージマニフェストでは、「Settings」の名前を使用してすべての組織設定メタデータ型にアクセスします。詳細は「設定」を参照してください。

宣言的なメタデータファイルのサフィックスおよびディレクトリの場所SecuritySettings の値は、settingsディレクトリの Security.settingsという 1 つのファイルに保存されます。.settingsファイルは、各設定コンポーネントに設定ファイルが 1 つしかないため、他の名前つきのコンポーネントとは異なります。

メモ: SecuritySettings は、API バージョン 25.0 および 26.0 では今後使用できません。

456

SecuritySettingsメタデータ型

バージョンセキュリティ設定は、API バージョン 27.0 以降で使用できます。

項目

説明データ型項目名信頼済み IP アドレスの範囲は、ユーザがコンピュータの有効化を要求せずに常にログインできる IP 範囲です。

NetworkAccessnetworkAccess

パスワードとログインの要件、および忘れたパスワードの取得をサポートする情報です。

PasswordPoliciespasswordPolicies

セッションの有効期限とセキュリティの設定。SessionSettingssessionSettings

NetworkAccess

ネットワークアクセスのための組織の信頼済み IP アドレス範囲を表します。

説明データ型項目信頼済み IP アドレスの範囲は、ユーザがコンピュータの有効化を要求せずに常にログインできる IP 範囲です。

IpRange[]ipRanges

メモ: IP 範囲を追加するには、すべての既存の IP 範囲と追加する IP 範囲を同時にリリースする必要があります。追加する IP 範囲のみリリースした場合、既存の IP 範囲がリリースする IP 範囲に置き換えられます。組織のすべての IP 範囲を削除するには、networkAccess 項目を空白のままにしてください (<networkAccess></networkAccess>)。

IpRange

ネットワークアクセスのための信頼済み IP アドレスの範囲を定義します。

説明データ型項目信頼済みアドレスの範囲の上限を定義する IP アドレス。

stringend

信頼済みアドレスの範囲の下限を定義する IP アドレス。

stringstart

PasswordPolicies

組織のパスワードとログインポリシーを表します。

457


説明データ型項目「API 限定ユーザ」権限を持つユーザがログインページの代わりにリダイレクトされる URL。

stringapiOnlyUserHomePageURL

必須。ユーザのパスワードとして使用できる文字の種別の要件。有効な値は、次のとおりです。

Complexity (string型の列挙)complexity

• NoRestriction — 任意のパスワード値を許可します。最も安全性の低いオプションです。

• AlphaNumeric — 少なくとも 1 つの英字と 1 つの数字を使用する必要があります。これはデフォルト値です。

• SpecialCharacters — 少なくとも 1 つの英字、1 つの数字、および ! # $ % - _ = + < >のうちの 1 文字を含む必要があります。

• UpperLowerCaseNumeric — 少なくとも 1 つの数字、1 つの英大文字、および 1 つの英小文字を使用する必要があります。この値は、API バージョン 31.0 以降で使用できます。

• UpperLowerCaseNumericSpecialCharacters —少なくとも 1 つの数字、1 つの英大文字、1 つの英小文字、および ! # $ % - _ = + < >のうちの 1 文字を含む必要があります。この値は、APIバージョン 31.0 以降で使用できます。

必須。すべてのユーザパスワードが失効し、変更する必要が生じるまでの期間。有効な値は、次のとおりです。

Expiration (string 型の列挙)expiration

• Never

• ThirtyDays

• SixtyDays

• NinetyDays。これはデフォルト値です。• SixMonths

• OneYear

パスワードの最小有効期限 (1 日) が必要か (true)、否か (false) を示します。この項目は API バージョン 31.0 以降で使用できます。

booleanminimumPasswordLifetime

ユーザがクリックして忘れたパスワードを取得できる URL。

stringpasswordAssistanceURL

パスワードをリセットするユーザに対して、「アカウントロックアウト」メールと [ID を確認] 画面の下部に表示されるテキスト。

stringpasswordAssistanceMessage

必須。新しく再設定されるパスワードが常に一意のパスワードになるように、保存されるユーザの過去

stringhistoryRestriction

のパスワードの数。保存されるパスワード数の有効な値は、0から24です。最大値 24 は、APIバージョ

458


説明データ型項目ン 31.0 以降に適用されます。以前のバージョンの最大値は 16 です。デフォルト値は、3です。必須。ロックアウトが解除されるまでの所要時間。有効な値は、次のとおりです。

LockoutInterval (string 型の列挙)

lockoutInterval

• FifteenMinutes。これはデフォルト値です。• ThirtyMinutes

• SixtyMinutes

• Forever (システム管理者のみがリセット可能)

必須。ログイン失敗が許される回数。この回数を超えると、そのユーザはロックアウトされ、ログインできなくなります。有効な値は、次のとおりです。

MaxLoginAttempts (string型の列挙)

maxLoginAttempts

• NoLimit

• ThreeAttempts

• FiveAttempts

• TenAttempts。これはデフォルト値です。

必須。パスワードに必要な最小限の文字数。有効な値は、次のとおりです。

MinPasswordLength (string型の列挙)

minPasswordLength

• FiveCharacters

• EightCharacters。これはデフォルト値です。• TenCharacters

• TwelveCharacters (この値はAPIバージョン 31.0以降で使用できます)。

パスワードに関連付けられた秘密の答えを非表示にするか (true)、否か (false) を示します。

booleanobscureSecretAnswer

メモ: 組織で、入力モードがひらがなに設定された Microsoft Input Method Editor (IME)を使用している場合、通常のテキスト項目にASCII 文字を入力すると日本語文字に変換されます。ただし、IME は伏せ字のテキストを含む項目では適切に動作しません。この機能を有効にした後で組織のユーザがパスワードまたはその他の値を正しく入力できない場合は、機能を無効にしてください。

必須。パスワードヒントの質問に対する回答にパスワードそのものを含めることができるかどうかについての制限。有効な値は、次のとおりです。

QuestionRestriction (string型の列挙)

questionRestriction

• None

• DoesNotContainPassword。これはデフォルト値です。

459


SessionSettings

組織のセッションの有効期限とセキュリティ設定を表します。

説明データ型項目セッションタイムアウトの警告ポップアップが無効化されるか (true)、有効化されるか (false) を示します。

booleandisableTimeoutWarning

設定以外のページの GET 要求のクロスサイトリクエストフォージェリ (CSRF) 保護が有効化されているか(true)、否か (false) を示します。

booleanenableCSRFOnGet

設定以外のページの POST 要求のクロスサイトリクエストフォージェリ (CSRF) 保護が有効化されているか (true)、否か (false) を示します。

booleanenableCSRFOnPost

ユーザのブラウザにユーザ名を保存して、ログインページの [ユーザ名]項目に自動入力できるようにするか (true)、否か (false) を示します。

booleanenableCacheAndAutocomplete

設定以外の Salesforceページでクリックジャック保護が有効化されるか (true)、無効化されるか (false)を示します。

booleanenableClickjackNonsetupSFDC

設定以外の顧客ページでクリックジャック保護が有効化されるか (true)、無効化されるか (false) を示します。

booleanenableClickjackNonsetupUser

設定ページでクリックジャック保護が有効化されるか (true)、無効化されるか (false) を示します。

booleanenableClickjackSetup

ユーザが Visualforce ページを使用している場合などに、クロスドメインセッション情報が GET 要求では

booleanenablePostForSessions

なく POST 要求を使用して交換されるかどうかを示します。このコンテキストでは、POST 要求は GET要求よりもセキュアです。API バージョン 31.0 以降で使用できます。ユーザが SMS 経由で 1 回限りの PIN を取得できるか (true)、否か (false) を示します。

booleanenableSMSIdentity

無効なユーザのセッションがタイムアウトすると、現在のセッションが無効になることを示します。ブ

booleanforceLogoutOnSessionTimeout

ラウザは自動的に更新されて、ログインページに戻ります。この状況が発生した場合に組織に再びアクセスするには、再ログインする必要があります。有効化 (true)、または無効化 (false) します。APIバージョン 31.0 以降で使用できます。別のユーザとしてログインしているシステム管理者が、セカンダリユーザとしてログアウトしてから元

booleanforceRelogin

のセッションに再度ログインする必要があるか(true)、否か (false) を示します。

460


説明データ型項目ユーザセッションが、ユーザがログインした IP アドレスにロックされるか (true)、否か (false) を示します。

booleanlockSessionsToIp

何も操作を行っていないユーザに、ログアウトするか操作を続行するかを尋ねるまでの時間。有効な値は、次のとおりです。

SessionTimeout (string 型の列挙)

sessionTimeout

• FifteenMinutes

• ThirtyMinutes

• SixtyMinutes

• TwoHours

• FourHours

• EightHours

• TwelveHours

宣言的なメタデータの定義のサンプルこれは、security.settingsメタデータファイルのサンプルです。

<?xml version="1.0" encoding="UTF-8"?><SecuritySettings xmlns="http://soap.sforce.com/2006/04/metadata">

<networkAccess><ipRanges>

<end>127.0.0.1</end><start>127.0.0.1</start>

</ipRanges></networkAccess><passwordPolicies>

<apiOnlyUserHomePageURL>http://www.altPage.com</apiOnlyUserHomePageURL><complexity>SpecialCharacters</complexity><expiration>OneYear</expiration><passwordAssistanceURL>http://www.acme.com/forgotpassword</passwordAssistanceURL><passwordAssistanceMessage>Forgot your password? Reset it

here.</passwordAssistanceMessage><historyRestriction>3</historyRestriction><lockoutInterval>ThirtyMinutes</lockoutInterval><maxLoginAttempts>ThreeAttempts</maxLoginAttempts><minPasswordLength>TenCharacters</minPasswordLength><questionRestriction>None</questionRestriction>

</passwordPolicies><sessionSettings>

<disableTimeoutWarning>true</disableTimeoutWarning><enableCSRFOnGet>false</enableCSRFOnGet><enableCSRFOnPost>false</enableCSRFOnPost><enableCacheAndAutocomplete>false</enableCacheAndAutocomplete><enableClickjackNonsetupSFDC>true</enableClickjackNonsetupSFDC><enableClickjackNonsetupUser>true</enableClickjackNonsetupUser><enableClickjackSetup>true</enableClickjackSetup><enableSMSIdentity>true</enableSMSIdentity><forceRelogin>true</forceRelogin><lockSessionsToIp>true</lockSessionsToIp><sessionTimeout>TwelveHours</sessionTimeout>

461


</sessionSettings></SecuritySettings>


SharedToSharedToでは、リストビューまたはフォルダの共有アクセス権を定義します。所有者に基づく共有ルールのターゲットおよびソースを指定するために使用できます。Salesforceオンラインヘルプの「共有に関する考慮事項」および「グループについて」を参照してください。

宣言的なメタデータファイルのサフィックスおよびディレクトリの場所SharedTo は ListView、Folder、およびOwnerSharingRule と一緒に使用します。

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

項目

説明データ型項目すべてのカスタマーポータルユーザを含むグループ。この項目は API バージョン 24.0 以降で使用できます。

stringallCustomerPortalUsers

すべての内部ユーザおよびポータル以外のユーザを含むグループ。この項目は API バージョン 24.0 以降で使用できます。

stringallInternalUsers

すべてのパートナーユーザを含むグループ。この項目は API バージョン 24.0 以降で使用できます。

stringallPartnerUsers

共有アクセス権を持つグループのリスト。groups項目の代わりにこの項目を使用します。この項目は API バージョン 22.0 以降で使用できます。

string[]group

共有アクセス権を持つグループのリスト。API バージョン 22.0 以降では代わりに group項目を使用します。

string[]groups

462

SharedToメタデータ型

説明データ型項目直属および非直属の部下に共有アクセス権が付与されるユーザのリスト。この項目は、API バージョン24.0 以降で使用できます。

string[]managerSubordinates

直属および非直属のマネージャに共有アクセス権が付与されるユーザのリスト。この項目は、API バージョン 24.0 以降で使用できます。

string[]managers

ポータルロールのすべてのユーザを含む共有アクセス権を持つグループのリスト。この項目は API バージョン 24.0 以降で使用できます。

string[]portalRole

ポータルロールのすべてのユーザまたはそのロールの下のユーザを含む共有アクセス権を持つグループのリスト。この項目は API バージョン 24.0 以降で使用できます。

string[]portalRoleandSubordinates

共有アクセス権を持つロールのリスト。roles項目の代わりにこの項目を使用します。この項目は API バージョン 22.0 以降で使用できます。

string[]role

共有アクセス権を持つロールのリスト。ロール階層でこれらの各ロールの下位にあるすべてのロールに

string[]roleAndSubordinates

も共有アクセス権があります。ポータル取引先が有効になっている場合、ロール階層のこれらの各ロールの下位にあるすべてのロールおよびポータル取引先にも共有アクセス権があります。rolesAndSubordinates項目の代わりにこの項目を使用します。この項目は API バージョン 22.0 以降で使用できます。

共有アクセス権を持つロールのリスト。ロール階層でこれらの各ロールの下位にあるすべてのロールにも共有アクセス権があります。この項目は API バージョン 22.0 以降で使用できます。

string[]roleAndSubordinatesInternal

共有アクセス権を持つロールのリスト。API バージョン 22.0 以降では代わりに role項目を使用します。

string[]roles

共有アクセス権を持つロールのリスト。ロール階層でこれらの各ロールの下位にあるすべてのロールに

string[]rolesAndSubordinates

も共有アクセス権があります。ポータル取引先が有

463

SharedToメタデータ型

説明データ型項目効になっている場合、ロール階層のこれらの各ロールの下位にあるすべてのロールおよびポータル取引先にも共有アクセス権があります。API バージョン 22.0 以降では代わりにroleAndSubordinates項目を使用します。

共有アクセス権を持つテリトリーのリスト。APIバージョン 22.0 以降では代わりに territory項目を使用します。

string[]territories

共有アクセス権を持つテリトリーのリスト。テリトリー階層でこれらの各テリトリーの下位にあるすべてのテリトリーにも共有アクセス権があります。API バージョン 22.0 以降では代わりにterritoryAndSubordinates項目を使用します。

string[]territoriesAndSubordinates

共有アクセス権を持つテリトリーのリスト。territories項目の代わりにこの項目を使用します。この項目は API バージョン 22.0 以降で使用できます。

string[]territory

共有アクセス権を持つテリトリーのリスト。テリトリー階層でこれらの各テリトリーの下位にあるすべ

string[]territoryAndSubordinates

てのテリトリーにも共有アクセス権があります。territoriesAndSubordinates項目の代わりにこの項目を使用します。この項目は API バージョン 22.0 以降で使用できます。

共有アクセス権を持つキューのリスト。リード、ケース、CustomObject 共有ルールにのみ適用します。この項目は API バージョン 24.0 以降で使用できます。

string[]queue

SharingRules共有ルールのセットを表します。SharingRules を使用すると、対象ユーザグループのアクセスレベルを指定するルールを使用して、レコードをユーザのセットと共有できます。Metadataメタデータ型を拡張し、そのfullName

項目を継承します。詳細は、Salesforce オンラインヘルプの「共有ルールの概要」を参照してください。

メモ: SharingRules コンポーネントを直接作成することはできません。代わりに、CustomObjectSharingRulesなど、拡張する型を使用します。このオブジェクトには、パッケージ化のサポートは含まれません。

464

SharingRulesメタデータ型

宣言的なメタデータファイルのサフィックスおよびディレクトリの場所SharingRules は、対応するエンティティディレクトリに保存され、ファイル名はエンティティ名と一致します。たとえば、accountSharingRulesディレクトリには取引先共有ルールの Account.sharingRulesファイルが含まれます。カスタムオブジェクトの SharingRules は、customObjectSharingRulesディレクトリに保存されます。このディレクトリには、ObjA__c.sharingRulesなど、拡張子が.sharingRulesのファイルが含まれます。ObjA はカスタムオブジェクト種別の開発者名を指します。

バージョンSharingRules コンポーネントは、API バージョン 24.0 以降で使用できます。

項目次の情報は、標準オブジェクトとカスタムオブジェクトの共有ルールの実装を理解していることを前提としています。これらの項目についての詳細は、Salesforceオンラインヘルプの「共有設定の概要」を参照してください。

説明データ型項目APIアクセスの一意の識別子。fullName

には、アンダースコアと英数字のみを使stringfullName

用できます。一意であること、最初は文字であること、空白は使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。この項目は、Metadataコンポーネントから継承されています。

AccountSharingRules

取引先の共有ルールを表します。SharingRules メタデータ型を拡張し、その fullName項目を継承します。

説明データ型項目ユーザの条件に基づくルールを定義するリスト。AccountCriteriaBasedSharingRule[]criteriaBasedRules

ユーザのメンバーシップに基づくルールを定義するリスト。

AccountOwnerSharingRule[]ownerRules

CampaignSharingRules

キャンペーンの共有ルールを表します。SharingRulesメタデータ型を拡張し、そのfullName項目を継承します。

説明データ型項目ユーザの条件に基づくルールを定義するリスト。CampaignCriteriaBasedSharingRule[]criteriaBasedRules


CampaignOwnerSharingRule[]ownerRules

CaseSharingRules

ケースの共有ルールを表します。SharingRules メタデータ型を拡張し、その fullName項目を継承します。

465


説明データ型項目ユーザの条件に基づくルールを定義するリスト。CaseCriteriaBasedSharingRule[]criteriaBasedRules


CaseOwnerSharingRule[]ownerRules

ContactSharingRules

取引先責任者の共有ルールを表します。SharingRulesメタデータ型を拡張し、そのfullName項目を継承します。

説明データ型項目ユーザの条件に基づくルールを定義するリスト。ContactCriteriaBasedSharingRule[]criteriaBasedRules


ContactOwnerSharingRule[]ownerRules

LeadSharingRules

リードの共有ルールを表します。SharingRules メタデータ型を拡張し、その fullName項目を継承します。

説明データ型項目ユーザの条件に基づくルールを定義するリスト。LeadCriteriaBasedSharingRule[]criteriaBasedRules


LeadOwnerSharingRule[]ownerRules

OpportunitySharingRules

商談の共有ルールを表します。SharingRules メタデータ型を拡張し、その fullName項目を継承します。

説明データ型項目ユーザの条件に基づくルールを定義するリスト。OpportunityCriteriaBasedSharingRule[]criteriaBasedRules


OpportunityOwnerSharingRule[]ownerRules

AccountTerritorySharingRules

取引先テリトリーの共有ルールを表します。SharingRules メタデータ型を拡張し、その fullName項目を継承します。

説明データ型項目ユーザのメンバーシップに基づくルールを定義するリスト。sharedFrom項目の許容値のリストは次のとおりです。

AccountTerritorySharingRule[]rules

• territory

• territoryAndSubordinates

466


CustomObjectSharingRules

カスタムオブジェクトの共有ルールを表します。SharingRules メタデータ型を拡張し、その fullName項目を継承します。

説明データ型項目ユーザの条件に基づくルールを定義するリスト。CustomObjectCriteriaBasedSharingRule[]criteriaBasedRules


CustomObjectOwnerSharingRule[]ownerRules

UserSharingRules

ユーザの共有ルールを表します。ユーザの共有ルールでは、グループのメンバーを別のグループのメンバーと共有できます。SharingRules メタデータ型を拡張し、その fullName項目を継承します。

説明項目のデータ型項目ユーザの条件に基づくルールを定義するリスト。UserCriteriaBasedSharingRule[]criteriaBasedRules


UserMembershipSharingRule[]membershipRules

宣言的なメタデータの定義のサンプル2 つの取引先所有者に基づく共有ルールの定義を次に示します。ファイル名は、accountSharingRulesディレクトリ下の Account.sharingRulesに対応します。この定義では、ownerRules が AccountOwnerSharingRule に対応します。

<?xml version="1.0" encoding="UTF-8"?><AccountSharingRules xmlns="http://soap.sforce.com/2006/04/metadata">

<ownerRules><fullName>G1Dev_G2New</fullName><sharedFrom>

<group>G1Dev</group></sharedFrom><sharedTo>

<group>G2New</group></sharedTo><accountAccessLevel>Read</caseAccessLevel><caseAccessLevel>None</caseAccessLevel><contactAccessLevel>Read</contactAccessLevel><name>G1Dev_G2New</name><opportunityAccessLevel>Edit</opportunityAccessLevel>

</ownerRules><ownerRules>

<fullName>G2New_R1New</fullName><sharedFrom>

<group>G2New</group></sharedFrom><sharedTo>

<roleAndSubordinates>R1New</roleAndSubordinates></sharedTo><accountAccessLevel>Edit</accountAccessLevel><caseAccessLevel>Read</caseAccessLevel><contactAccessLevel>Edit</contactAccessLevel><name>G2New_R1New</name><opportunityAccessLevel>None</opportunityAccessLevel>

</ownerRules></AccountSharingRules>

467


ユーザの条件に基づく共有ルールとユーザのメンバーシップに基づく共有ルールの定義を次に示します。ファイル名は、userSharingRulesディレクトリ下の User.sharingRulesに対応します。

<?xml version="1.0" encoding="UTF-8"?><UserSharingRules xmlns="http://soap.sforce.com/2006/04/metadata">

<criteriaBasedRules><fullName>shareUsers2</fullName><sharedTo>

<group>Asia_Division</group></sharedTo><criteriaItems>

<field>FirstName</field><operation>equals</operation><value>John</value>

</criteriaItems><name>shareUsers2</name><userAccessLevel>Read</userAccessLevel>

</criteriaBasedRules><membershipRules>

<fullName>shareUsers1</fullName><sharedTo>

<group>South_America_Division</group></sharedTo><sharedFrom>

<group>Asia_Division</group></sharedFrom><name>shareUsers1</name><userAccessLevel>Read</userAccessLevel>

</membershipRules></UserSharingRules>

package.xmlファイルのサンプルを次に示します。


<types><members>UserRule</members><name>UserCriteriaBasedSharingRule</name>

</types><types>

<members>*</members><name>UserMembershipSharingRule</name>


</Package>

BaseSharingRule条件に基づく共有ルールおよび所有者に基づく共有ルールの基本コンテナを表します。Metadataメタデータ型を拡張し、その fullName項目を継承します。

メモ: BaseSharingRule コンポーネントを直接作成することはできません。代わりに、CriteriaBasedSharingRuleまたは OwnerSharingRule メタデータ型でコンポーネントを使用します。

バージョンBaseSharingRule コンポーネントは、API バージョン 24.0 以降で使用できます。

468

BaseSharingRuleメタデータ型

項目これらの項目についての詳細は、Salesforce オンラインヘルプの「共有設定の概要」を参照してください。

説明データ型項目必須。レコードを共有するユーザを指定します。

SharedTosharedTo

APIアクセスの一意の識別子。fullName



CriteriaBasedSharingRule条件に基づく共有ルールを表します。CriteriaBasedSharingRule を使用すると、特定の条件に基づいたレコードの共有を行えます。BaseSharingRuleメタデータ型を拡張し、そのsharedTo項目を継承します。詳細は、Salesforceオンラインヘルプの「条件に基づく共有ルールの概要」を参照してください。

メモ: CriteriaBasedSharingRule コンポーネントを直接作成することはできません。代わりに子コンポーネントを使用してください。

宣言的なメタデータファイルのサフィックスおよびディレクトリの場所CriteriaBasedSharingRuleコンポーネントは、criteriaBasedRules項目のSharingRulesコンポーネント内に保存されます。

バージョンCriteriaBasedSharingRule コンポーネントは、API バージョン 24.0 以降で使用できます。


説明データ型項目共有ルールの条件を表すリスト。値は次のとおりです。


• field

• operation

• value

469

CriteriaBasedSharingRuleメタデータ型

AccountCriteriaBasedSharingRule

取引先の条件に基づく共有ルールを表します。CriteriaBasedSharingRuleメタデータ型を拡張し、そのcriteriaItems

項目を継承します。AccountCriteriaBasedSharingRule は、AccountSharingRules の criteriaBasedRules項目によって使用されます。

説明データ型項目必須。ユーザまたはグループが取引先に対して持つアクセスレベルを表す値。値は次のとおりです。

ShareAccessLevelNoNone

(string 型の列挙)accountAccessLevel

• Read

• Edit

• All

共有ルールの検索条件ロジックを表します。stringbooleanFilter

必須。ユーザまたはグループが取引先に関連付けられたケースに対して持つアクセスレベルを表す値。値は次のとおりです。

ShareAccessLevelNoAll

(string 型の列挙)caseAccessLevel

• None

• Read

• Edit

必須。ユーザまたはグループが取引先に関連付けられた取引先責任者に対して持つアクセスレベルを表す値。値は次のとおりです。


(string 型の列挙)contactAccessLevel

• None

• Read

• Edit

共有ルールの説明を表します。最大 1000 文字です。この項目は、API バージョン 29.0 以降で使用できます。

stringdescription

必須。共有ルールの名前。ユーザインターフェースの [表示ラベル] に対応します。

stringname

必須。ターゲットグループに許可される、関連付けられた商談に対するアクセスレベルを表す値。値は次のとおりです。


(string 型の列挙)opportunityAccessLevel

• None

• Read

• Edit

CampaignCriteriaBasedSharingRule

キャンペーンの条件に基づく共有ルールを表します。CriteriaBasedSharingRule メタデータ型を拡張し、そのcriteriaItems項目を継承します。CampaignCriteriaBasedSharingRule は、CampaignSharingRules の criteriaBasedRules項目によって使用されます。

470


説明データ型項目共有ルールの検索条件ロジックを表します。stringbooleanFilter


stringdescription

必須。ターゲットグループに許可される、キャンペーンに対するアクセスレベルを表す値。値は次のとおりです。


(string 型の列挙)campaignAccessLevel

• Read

• Edit

• All


stringname

CaseCriteriaBasedSharingRule

ケースの条件に基づく共有ルールを表します。CriteriaBasedSharingRuleメタデータ型を拡張し、そのcriteriaItems

項目を継承します。CaseCriteriaBasedSharingRule は、CaseSharingRules の criteriaBasedRules項目によって使用されます。



stringdescription

必須。許可されるケースに対するアクセスレベルを表す値。値は次のとおりです。

ShareAccessLevelReadEdit


• Read

• Edit


stringname

ContactCriteriaBasedSharingRule

取引先責任者の条件に基づく共有ルールを表します。CriteriaBasedSharingRule メタデータ型を拡張し、そのcriteriaItems項目を継承します。ContactCriteriaBasedSharingRule は、ContactSharingRules の criteriaBasedRules項目によって使用されます。


471


説明データ型項目共有ルールの説明を表します。最大 1000 文字です。この項目は、API バージョン 29.0 以降で使用できます。

stringdescription

必須。ターゲットグループ、ロール、またはユーザに許可される取引先責任者に対するアクセスレベルを表す値。値は次のとおりです。



• Read

• Edit


stringname

LeadCriteriaBasedSharingRule

リードの条件に基づく共有ルールを表します。CriteriaBasedSharingRuleメタデータ型を拡張し、そのcriteriaItems

項目を継承します。LeadCriteriaBasedSharingRule は、LeadSharingRules の criteriaBasedRules項目によって使用されます。



stringdescription

必須。許可されるアクセスのレベルを表す値。状況には次のものがあります。


(string 型の列挙)leadAccessLevel

• Read

• Edit


stringname

OpportunityCriteriaBasedSharingRule

商談の条件に基づく共有ルールを表します。CriteriaBasedSharingRuleメタデータ型を拡張し、そのcriteriaItems

項目を継承します。OpportunityCriteriaBasedSharingRuleは、OpportunitySharingRulesの criteriaBasedRules項目によって使用されます。



stringdescription

472


説明データ型項目必須。許可されるアクセスのレベルを表す値。状況には次のものがあります。



• Read

• Edit


stringname

CustomObjectCriteriaBasedSharingRule

カスタムオブジェクトの条件に基づく共有ルールを表します。CriteriaBasedSharingRule メタデータ型を拡張し、その criteriaItems項目を継承します。CustomObjectCriteriaBasedSharingRule は、CustomObjectSharingRules の criteriaBasedRules項目によって使用されます。

説明データ型項目必須。許可された共有の種別を表す値。値は次のとおりです。

stringaccessLevel

• Read

• Edit

• All

共有ルールの検索条件ロジックを表します。stringbooleanFilter


stringdescription


stringname

UserCriteriaBasedSharingRule

ユーザの条件に基づく共有ルールを表します。CriteriaBasedSharingRuleメタデータ型を拡張し、そのcriteriaItems

項目を継承します。UserCriteriaBasedSharingRule は、UserSharingRules の criteriaBasedRules項目によって使用されます。

説明項目のデータ型項目共有ルールの検索条件ロジックを表します。stringbooleanFilter


stringdescription


stringname

473


説明項目のデータ型項目必須。許可された共有の種別を表す値。値は次のとおりです。


(string 型の列挙)userAccessLevel

• Read

• Edit

宣言的なメタデータの定義のサンプル2 つの所有者に基づく共有ルールと、2 つの条件項目を含む 1 つの条件に基づく共有ルールの定義を次に示します。ファイル名は、accountSharingRules ディレクトリの下の Account.sharingRules ファイルに対応します。

<?xml version="1.0" encoding="UTF-8"?><AccountSharingRules xmlns="http://soap.sforce.com/2006/04/metadata"><ownerRules><fullName>G1Dev_G2New</fullName><sharedTo><group>G2New</group>

</sharedTo><sharedFrom><group>G1Dev</group>

</sharedFrom><accountAccessLevel>Read</accountAccessLevel><caseAccessLevel>None</caseAccessLevel><contactAccessLevel>Read</contactAccessLevel>

</ownerRules><fullName>G2New_R1New</fullName><sharedTo><roleAndSubordinates>R1New</roleAndSubordinates>

</sharedTo><sharedFrom><group>G2New</group>

</sharedFrom><accountAccessLevel>Edit</accountAccessLevel><caseAccessLevel>Read</caseAccessLevel><contactAccessLevel>Edit</contactAccessLevel><name>G2New_R1New</name><opportunityAccessLevel>None</opportunityAccessLevel>

</ownerRules><criteriaBasedRules><fullName>AccountCriteria</fullName><sharedTo><group>G1</group>

</sharedTo><criteriaItems><field>BillingCity</field><operation>equals</operation><value>San Francisco</value>

</criteriaItems><criteriaItems><field>MyChkBox__c</field><operation>notEqual</operation><value>False</value>

</criteriaItems><accountAccessLevel>Read</accountAccessLevel><booleanFilter>1 OR 2</booleanFilter><caseAccessLevel>None</caseAccessLevel><contactAccessLevel>Read</contactAccessLevel><name>AccountCriteria</name><opportunityAccessLevel>None</opportunityAccessLevel>

</criteriaBasedRules></AccountSharingRules>

474


OwnerSharingRule所有権ベースの共有ルールを表します。OwnerSharingRule を使用すると、対象のユーザグループのアクセスレベルを指定するルールを使用して、あるユーザのセットが所有するレコードを他のユーザのセットと共有することができます。BaseSharingRule メタデータ型を拡張し、その SharedTo 項目を継承します。詳細は、Salesforce オンラインヘルプの「共有ルールの概要」を参照してください。

メモ: OwnerSharingRule コンポーネントを直接作成することはできません。代わりに子コンポーネントを使用してください。

宣言的なメタデータファイルのサフィックスおよびディレクトリの場所OwnerSharingRules コンポーネントは ownerRules項目の SharingRulesコンポーネント内に保存されます。

バージョンOwnerSharingRules コンポーネントは、API バージョン 24.0 以降で使用できます。


説明データ型項目必須。レコードの所有者を指定します。SharedTosharedFrom

必須。レコードを共有するユーザを指定します。

SharedTosharedTo

APIアクセスの一意の識別子。fullName



AccountOwnerSharingRule

所有者以外のユーザと取引先を共有するためのルールを表します。これは、OwnerSharingRuleメタデータ型を拡張し、その fullName項目、sharedFrom項目、および sharedTo項目を継承します。AccountOwnerSharingRule は AccountSharingRules の ownerRules項目で使用されます。

説明データ型項目必須。グループまたはロールが取引先に対して持つアクセス権のレベルを表す値。値は次のとおりです。



• Read

• Edit

475

OwnerSharingRuleメタデータ型

説明データ型項目• All

必須。グループまたはロールが取引先に関連付けられたケースに対して持つアクセス権のレベルを表す値。値は次のとおりです。



• None

• Read

• Edit

必須。グループまたはロールが取引先に関連付けられた取引先責任者に対して持つアクセス権のレベルを表す値。値は次のとおりです。



• None

• Read

• Edit


stringdescription


stringname

必須。関連付けられた任意の商談に対してグループまたはロールに許可されているアクセス権のレベルを表す値。値は次のとおりです。



• None

• Read

• Edit

CampaignOwnerSharingRule

所有者以外のユーザとキャンペーンを共有するためのルールを表します。これは、OwnerSharingRuleメタデータ型を拡張し、その fullName項目、sharedFrom項目、および sharedTo項目を継承します。CampaignOwnerSharingRule は CampaignSharingRules の ownerRules項目で使用されます。

説明データ型項目キャンペーンに対してグループまたはロールに許可されているアクセス権のレベルを表す値。値は次のとおりです。


(string 型の列挙)campaignAccessLevel

• Read

• Edit

• All


stringdescription

476


説明データ型項目共有ルールの名前。ユーザインターフェースの [表示ラベル] に対応します。

stringname

CaseOwnerSharingRule

所有者以外のユーザとケースを共有するためのルールを表します。これは、OwnerSharingRuleメタデータ型を拡張し、その fullName項目、sharedFrom項目、および sharedTo項目を継承します。CaseOwnerSharingRule は CaseSharingRules の ownerRules項目によって使用されます。次の項目はすべて必須項目です。

説明データ型項目必須。ケースに対してグループまたはロールに許可されているアクセス権のレベルを表す値。値は次のとおりです。



• Read

• Edit


stringdescription


stringname

ContactOwnerSharingRule

所有者以外のユーザと取引先責任者を共有するためのルールを表します。これは、OwnerSharingRuleメタデータ型を拡張し、その fullName項目、sharedFrom項目、および sharedTo項目を継承します。ContactOwnerSharingRule は ContactSharingRules の ownerRules項目で使用されます。

説明データ型項目必須。取引先責任者に対してグループまたはロールに許可されているアクセス権のレベルを表す値。値は次のとおりです。



• Read

• Edit


stringdescription


stringname

477


LeadOwnerSharingRule

所有者以外のユーザとリードを共有するためのルールを表します。これは、OwnerSharingRuleメタデータ型を拡張し、その fullName項目、sharedFrom項目、および sharedTo項目を継承します。LeadOwnerSharingRule は LeadSharingRules の ownerRules項目で使用されます。

説明データ型項目必須。リードに対してグループまたはロールに許可されているアクセス権のレベルを表す値。値は次のとおりです。


(string 型の列挙)leadAccessLevel

• Read

• Edit


stringdescription

必須。必須。共有ルールの名前。ユーザインターフェースの [表示ラベル] に対応します。

stringname

OpportunityOwnerSharingRule

所有者以外のユーザと商談を共有するためのルールを表します。これは、OwnerSharingRuleメタデータ型を拡張し、その fullName項目、sharedFrom項目、および sharedTo項目を継承します。OpportunityOwnerSharingRule は OpportunitySharingRules の ownerRules項目で使用されます。

説明データ型項目必須。共有ルールの名前。ユーザインターフェースの [表示ラベル] に対応します。

stringname


stringdescription

必須。+商談に対してグループまたはロールに許可されているアクセス権のレベルを表す値。値は次のとおりです。



• Read

• Edit

AccountTerritorySharingRule

テリトリー内の取引先を共有するためのルールを表します。これは、OwnerSharingRuleメタデータ型を拡張し、その fullName項目、sharedFrom項目、および sharedTo項目を継承します。AccountTerritorySharingRule は AccountTerritorySharingRules の ownerRules項目で使用されます。

478


説明データ型項目必須。取引先テリトリーに対して Territory またはTerritoryAndSubordinates グループに許可されているアクセス権のレベルを表す値。値は次のとおりです。



• Read

• Edit

• All

必須。取引先のすべての子ケースに対して Territoryまたは TerritoryAndSubordinates グループに許可され



ているアクセス権のレベルを表す値。値は次のとおりです。• None

• Read

• Edit

必須。取引先のすべての関連取引先責任者に対してTerritory または TerritoryAndSubordinates グループに



許可されているアクセス権のレベルを表す値。値は次のとおりです。• None

• Read

• Edit


stringdescription


stringname

必須。取引先に関連付けられたすべての商談に対して Territory または TerritoryAndSubordinates グループ



に許可されているアクセス権のレベルを表す値。値は次のとおりです。• None

• Read

• Edit

CustomObjectOwnerSharingRule

カスタムオブジェクトの共有ルールを表します。これは、OwnerSharingRuleメタデータ型を拡張し、そのfullName

項目、sharedFrom項目、および sharedTo項目を継承します。CustomObjectOwnerSharingRule は CustomObjectSharingRules の ownerRules項目で使用されます。

479


説明データ型項目必須。カスタムオブジェクトに対してグループまたはロールに許可されているアクセス権のレベルを表す値。値は次のとおりです。

stringaccessLevel

• Read

• Edit

• All


stringdescription


stringname

UserMembershipSharingRule

グループのメンバーを別のグループのユーザと共有するための共有ルールを表します。これは、OwnerSharingRuleメタデータ型を拡張し、その fullName項目、sharedFrom項目、および sharedTo項目を継承します。UserMembershipSharingRule は、UserSharingRules (ページ 467) の ownerRules項目によって使用されます。

説明項目のデータ型項目共有ルールの説明を表します。最大 1000 文字です。この項目は、API バージョン 29.0 以降で使用できます。

stringdescription


stringname

必須。ユーザに対してグループまたはロールに許可されているアクセス権のレベルを表す値。値は次のとおりです。


(string 型の列挙)userAccessLevel

• Read

• Edit

SharingSet共有セットを表します。共有セットでは、アクセス権の対応付けを定義して、ポータルユーザまたはコミュニティユーザに、取引先または取引先責任者に関連付けられたオブジェクトへのアクセス権を付与します。Metadataメタデータ型を拡張し、その fullName項目を継承します。たとえば、ポータルユーザまたはコミュニティユーザに、その取引先レコードに関連するすべてのケースへのアクセス権を付与できます。同様に、ポータルユーザまたはコミュニティユーザに、そのユーザの取引先レコードで識別される親取引先に関連するすべてのケースへのアクセス権をユーザに付与できます。詳細は、Salesforceヘルプの「共有セットの概要」を参照してください。

480

SharingSetメタデータ型

ファイルのサフィックスおよびディレクトリの場所SharingSet コンポーネントのサフィックスは .sharingSetであり、sharingSetsフォルダに保存されます。

バージョンSharingSet コンポーネントは、API バージョン 30.0 以降で使用できます。

項目

説明項目のデータ型項目名共有セットのアクセス権の対応付けのリスト。AccessMapping[]accessMappings

共有セットの説明。最大 255 文字です。stringdescription

必須。API アクセスの一意の識別子。ユーザインターフェースの [共有セット名] に対応します。

stringname

対象オブジェクトへのアクセス権を付与されたユーザのプロファイル。有効な値は、次のとおりです。

string[]profiles

• 認証 Web サイト• カスタマーコミュニティユーザ• カスタマーコミュニティログインユーザ• 大規模カスタマーポータルユーザ• Overage Authenticated Website ユーザ• Overage High Volume Customer Portal ユーザ

AccessMapping

AccessMapping は、共有セットのアクセス権の対応付けを表します。これにより、ユーザに関連付けられた取引先または取引先責任者をルックアップして、対象オブジェクトへのアクセス権が付与されます。対象オブジェクト、または対象オブジェクトとそれに関連付けられたオブジェクトの両方 (取引先とその取引先責任者およびケースなど) へのアクセス権をポータルユーザに付与できれます。

説明項目のデータ型項目名ポータルユーザに付与された対象オブジェクトへのアクセスレベル。有効な値は、次のとおりです。

stringaccessLevel

• Read

• Edit

対象オブジェクトへのルックアップ。標準項目、カスタム項目、または ID がサポートされます。エンタイトルメントに関連付け

stringobjectField

られた取引先またはケースの場合は、Entitlement.Accountまたは Entitlement.Caseを使用します。ポータルユーザがアクセス権を得る対象オブジェクト。次のいずれかを示します。

stringobject

• Account

• Contact

• Case

481


説明項目のデータ型項目名• ServiceContract

• User

• カスタムオブジェクト (たとえば ObjA__c)

ポータルユーザには、アクセス権のある取引先のすべての注文エンタイトルメントおよび注文品目へのアクセス権が付与されます。

取引先または取引先責任者、あるいは、取引先や取引先責任者から取得された標準項目またはカスタム項目へのユーザのルック

stringuserField

アップ。ルックアップでは、ユーザまたはユーザのマネージャを使用できます。有効な値は、次のとおりです。• Account

• Account.Field

• Contact

• Contact.Field

• Manager.Account

• Manager.Contact

Fieldは、取引先または取引先責任者に基づく標準項目またはカスタム項目を表します。

宣言的なメタデータの定義のサンプルユーザの取引先責任者と一致する ReportsTo項目を持つすべての取引先責任者へのアクセス権をユーザに付与する SharingSet コンポーネントの例を次に示します。

<?xml version="1.0" encoding="UTF-8"?><SharingSet xmlns="http://soap.sforce.com/2006/04/metadata"><accessMappings><accessLevel>Read</accessLevel><objectField>ReportsTo</objectField><object>Contact</object><userField>Contact</userField>

</accessMappings><description>User Access Mapping</description><name>User</name><profiles>customer community user</profiles>

</SharingSet>

ユーザの取引先に関連付けられた、エンタイトルメントに関連するすべてのケースへのアクセス権をユーザに付与する SharingSet コンポーネントの例を次に示します。

<?xml version="1.0" encoding="UTF-8"?><SharingSet xmlns="http://soap.sforce.com/2006/04/metadata"><name>Case</name><accessMappings><accessLevel>Edit</accessLevel><objectField>Entitlement.Account</objectField><object>Case</object><userField>Account</userField>

</accessMappings></SharingSet>

482


SharingSet コンポーネントとアクセス権の対応付けのリストの例を次に示します。

<?xml version="1.0" encoding="UTF-8"?><SharingSet xmlns="http://soap.sforce.com/2006/04/metadata"><description>This is a basic sharing set with several access mappings.</description><name>Basic</name><profiles>customer community user</profiles><accessMappings><accessLevel>Read</accessLevel><objectField>Id</objectField><object>Account</object><userField>Account</userField>

</accessMappings><accessMappings><accessLevel>Edit</accessLevel><objectField>Account</objectField><object>Contact</object><userField>Account</userField>

</accessMappings><accessMappings><accessLevel>Edit</accessLevel><objectField>Contact</objectField><object>Case</object><userField>Contact</userField>

</accessMappings><accessMappings><accessLevel>Read</accessLevel><objectField>AccountLookup__c</objectField><object>HVPUAccessible__c</object><userField>Account</userField>

</accessMappings></SharingSet>


<Package xmlns="http://soap.sforce.com/2006/04/metadata"><fullName>SharingSetBasic</fullName><types><members>HVPUAccessible__c.AccountLookup__c</members><members>HVPUAccessible__c.ContactLookup__c</members><name>CustomField</name>

</types><types><members>HVPUAccessible__c</members><name>CustomObject</name>

</types><types><members>Basic</members><name>SharingSet</name>

<types><version>30.0</version>

</Package>

SiteDotComリリース用のサイトを表します。MetadataWithContent 型を拡張し、その fullName項目と content項目を継承します。

483

SiteDotComメタデータ型

宣言的なメタデータファイルのサフィックスおよびディレクトリの場所SiteDotCom コンポーネントは、対応するパッケージディレクトリの siteDotComSitesディレクトリに保存されます。メタデータ.xmlファイルのファイル名は、[sitename].site-meta.xmlです。サイトファイルのファイル名は、[sitename].siteです。

メモ: メタデータ API を使用してサイトを Sandbox から本番にリリースするときのファイルサイズには制限があります。.siteファイルのアセットは、40 MB を超えることはできません。サイトは作成されますが、アセットは新しいサイトで壊れて表示されます。アセットを修正するには、Sandbox環境からアセットを個別にエクスポートして、その後に新しいサイトにインポートします。

バージョンSiteDotComコンポーネントは、API バージョン 30.0 以降で使用できます。

項目

説明項目のデータ型項目リリースするサイトの名前。stringlabel

必須。サイトが Salesforce Communities サイトの ChatterNetworkPicassoサイトであ

(string 型の列挙)siteType

るか、Site.com サイトの Siteforceサイトであるかを示します。

宣言的なメタデータの定義のサンプルSiteDotCom のサンプル XML 定義を次に示します。

<?xml version="1.0" encoding="UTF-8"?><SiteDotCom xmlns="http://soap.sforce.com/2006/04/metadata">

<label>testsite</label><siteType>Siteforce</siteType>

</SiteDotCom>

<?xml version="1.0" encoding="UTF-8"?><SiteDotCom xmlns="http://soap.sforce.com/2006/04/metadata">

<label>testCommunity</label><siteType>ChatterNetworkPicasso</siteType>

</SiteDotCom>

Skillスキル名や、スキルを割り当てるエージェントなど、Live Agent でエージェントにチャットを転送するために使用するスキルの設定を表します。Metadata メタデータ型を拡張し、その fullName項目を継承します。

ファイルのサフィックスおよびディレクトリの場所Skill の値は、skillsディレクトリの <developer_name>.skillファイルに保存されます。

484

Skillメタデータ型

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

項目

説明項目のデータ型項目名Live Agent ユーザへのスキルの割り当て方法を指定します。スキルは、ユーザセットまたはプロファイルセットに割り当てることができます。

SkillAssignmentsassignments

スキルの名前を指定します。stringlabel

SkillAssignments

特定のスキルを割り当てるユーザおよびユーザプロファイルを表します。

項目

説明項目のデータ型項目名特定のスキルに関連付けられたプロファイルを指定します。

SkillProfileAssignmentsprofiles

特定のスキルに関連付けられたユーザを指定します。

SkillUserAssignmentsusers

SkillProfileAssignments

特定のスキルに関連付けられたプロファイルを表します。

項目

説明項目のデータ型項目名特定のスキルに関連付けられたプロファイルのカスタム名を指定します。

stringprofile

SkillUserAssignments

特定のスキルに関連付けられたユーザを表します。

項目

説明項目のデータ型項目名特定のスキルに関連付けられたユーザのユーザ名を指定します。

stringuser

485

Skillメタデータ型

宣言的なメタデータの定義のサンプルこれは、skillファイルのサンプルです。

<?xml version="1.0" encoding="UTF-8"?><Skill xmlns="http://soap.sforce.com/2006/04/metadata">

<label>My Skill 1</label><assignments>

<profiles><profile>LiveAgentOperator</profile><profile>LiveAgentSupervisor</profile>

</profiles><users>

<user>[email protected]</user></users>

</assignments></Skill>

StaticResource静的リソースファイルを表します。多くの場合は、ZIP ファイル内のコードライブラリです。このメタデータ型は、MetadataWithContent コンポーネントを拡張し、その項目を共有します。静的リソースにより、アーカイブ (.zip や .jar ファイルなど)、画像、スタイルシート、JavaScript、その他のファイルなど、Visualforce ページ内で参照できるコンテンツをアップロードできます。

ファイルのサフィックスおよびディレクトリの場所テンプレートファイルのファイルサフィックスは .resourceです。付随するメタデータファイルには、resource-meta.xmlという名前が付けられます。静的リソースコンポーネントは、対応するパッケージディレクトリの staticresourcesフォルダに保存されます。

バージョン静的リソースは、API バージョン 12.0 以降で使用できます。


説明データ型項目名必須。サードパーティ配信クライアントがコンテンツをキャッシュできるように、静的リソースが公開キャッシュタグでマークされ

StaticResourceCacheControl(string 型の列挙)

cacheControl

ているかどうかを示します。これは、API バージョン 14.0 の新項目です。有効な値は、次のとおりです。• Private• Public

静的リソースコンテンツ。Base 64 で符号化されたバイナリデータAPI コールを行う前に、クライアントアプリケーションはバイナ

base64Binarycontent

リ添付データを base64 に符号化する必要があります。応答を受信したら、クライアントアプリケーションは、base64 データをバイ

486

StaticResourceメタデータ型

説明データ型項目名ナリに復号化する必要があります。この変換は、通常 SOAP クライアントによって処理されます。この項目は、MetadataWithContentコンポーネントから継承されます。必須。ファイルのコンテンツタイプ。たとえば、text/plain などです。

stringcontentType

静的リソースの説明。stringdescription

静的リソース名。名前には、英数字、およびアンダースコア (_) 文字のみを使用できます。また、最初は文字とし、最後にアンダー

stringfullName

スコアを使用したり、連続した 2 つのアンダースコア文字を含めたりすることはできません。この項目はMetadata コンポーネントから継承するため、この項目はこのコンポーネントの WSDL で定義されません。作成時、更新時、または削除時に指定する必要があります。コールにおけるこの項目の例を確認するには、「create()」を参照してください。


<?xml version="1.0" encoding="UTF-8"?><StaticResource xmlns="http://soap.sforce.com/2006/04/metadata">

<contentType>text/plain</contentType><description>Test Resource</description>

</StaticResource>

Territory組織内のテリトリーを表します。

宣言的なメタデータファイルのサフィックスおよびディレクトリの場所テリトリーコンポーネントのファイルサフィックスは .territoryで、コンポーネントは対応するパッケージディレクトリの territoriesディレクトリに保存されます。

バージョンテリトリーコンポーネントは、API バージョン 24.0 以降で使用できます。

項目このメタデータ型は、下位型 RoleOrTerritory に拡張されます。

説明データ型項目名このテリトリーのユーザが、このテリトリーに割り当てられている (通常ならアクセスできない) 取引先にアクセスできるかどうかを指定します。有効な値は、次のとおりです。

stringaccountAccessLevel

• Read

• Edit

487

Territoryメタデータ型

説明データ型項目名• All

組織の取引先に対する共有モデルが「公開/参照・更新可能」の場合、有効な値は Editおよび Allのみです。この項目に値が設定されていない場合、この項目値には [テリトリーの管理] ページ ([設定] から [テリトリーの管理] >[設定]) で指定されたデフォルトのアクセスレベルが使用されます。この項目は API バージョン 31.0 以降で使用できます。


stringfullName

文字であること、空白は使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。この項目は、Metadata コンポーネントから継承されています。ユーザインターフェースの [テリトリー名] に対応します。テリトリー階層でこのテリトリーの上位にあるテリトリー。stringparentTerritory

宣言的なメタデータの定義のサンプルテリトリーの定義を次に示します。

<?xml version="1.0" encoding="UTF-8"?><Territory xmlns="http://soap.sforce.com/2006/04/metadata">

<accountAccessLevel>Edit</accountAccessLevel><caseAccessLevel>Edit</caseAccessLevel><contactAccessLevel>Edit</contactAccessLevel><description>Sample Territory</description><mayForecastManagerShare>false</mayForecastManagerShare><name>T22name</name><opportunityAccessLevel>Read</opportunityAccessLevel>

</Territory>

Translationsこのメタデータ型を使用して、さまざまな使用言語の翻訳を処理できます。Metadataメタデータ型を拡張し、その fullName項目を継承します。コンポーネントの表示ラベルを翻訳する機能は、トランスレーションワークベンチの一部です。詳細は、Salesforceオンラインヘルプの「トランスレーションワークベンチの設定」を参照してください。

言語Salesforce.comでは、完全サポート対象言語、エンドユーザ言語、プラットフォーム専用言語の 3 つのレベルの言語サポートが提供されています。すべての言語は、2 文字の言語コード (enなど) または 5 文字のロケールコード(en_AU など) で識別されます。Salesforce では、次の言語を完全にサポートしています。• 中国語 (簡体字): zh_CN

488

Translationsメタデータ型

• 中国語 (繁体字): zh_TW• デンマーク語: da• オランダ語: nl_NL• 英語: en_US• フィンランド語: fi• フランス語: fr• ドイツ語: de• イタリア語: it• 日本語: ja• 韓国語: ko• ポルトガル語 (ブラジル): pt_BR• ロシア語: ru• スペイン語: es• スペイン語 (メキシコ): es_MX*

* スペイン語 (メキシコ) は、顧客が定義した翻訳のスペイン語を使用します。• スウェーデン語: sv• タイ語: th*

* Salesforce インターフェースが完全にタイ語に翻訳されている場合でも、ヘルプは英語のままです。

Salesforceは、次のエンドユーザ言語をサポートしていますが、管理ページとオンラインヘルプは翻訳されていません。• アラビア語: ar• ブルガリア語: bg• チェコ語: cs• 英語 (UK): en_GB• ギリシャ語: el• ヘブライ語: iw• ハンガリー語: hu• インドネシア語: in• ノルウェー語: no• ポーランド語: pl• ルーマニア語: ro• トルコ語: tr• ウクライナ語: uk• ベトナム語: vi

プラットフォーム専用言語は、Salesforce プラットフォーム上で作成したカスタム機能（アプリケーション）をローカライズする場合に使用します。プラットフォームのみの言語を使用すると、Salesforceがデフォルトの翻訳を提供していない場合に、カスタム表示ラベル、カスタムオブジェクト、および項目の表示ラベルをローカライズできます。プラットフォームのみの言語は、アプリケーションで言語を選択できる場所のすべてで使用できますが、プラットフォームのみの言語を選択しても、アプリケーションのすべての表示ラベルはデフォルトの英語のままになります。Salesforce に対するすべてのカスタマイズは、プラットフォームのみの言語に翻訳できます。多くのオブ

489


ジェクト上にある標準項目名を翻訳する場合は名前の変更を使用します。情報テキストと項目以外の表示ラベルのテキストは翻訳できません。• アルバニア語: sq• アルメニア語: hy• バスク語: eu• ボスニア語: bs• ベンガル語: bn• クロアチア語: hr• 英語 (オーストラリア): en_AU• 英語 (カナダ): en_CA• 英語 (インド): en_IN• 英語 (マレーシア): en_MY• 英語 (フィリピン): en_PH• エストニア語: et• フランス語 (カナダ): fr_CA• グルジア語: ka• ドイツ語 (オーストリア): de_AT• ドイツ語 (スイス): de_CH• ヒンドゥー語: hi• アイスランド語: is• アイルランド語: ga• ラトビア語: lv• リトアニア語: lt• ルクセンブルク語: lb• マケドニア語: mk• マレー語 : ms• マルタ語: mt• ルーマニア語 (モルドバ): ro_MD• モンテネグロ語: sh_ME• ポルトガル語 (ヨーロッパ): pt_PT• ロマンシュ語: rm• セルビア語 (キリル文字): sr• セルビア語 (ラテン文字): sh• スロバキア語: sk• スロベニア語: sl• タガログ語: tl• タミル語: ta• ウルドゥー語: ur• ウェールズ語: cy

宣言的なメタデータファイルのサフィックスおよびディレクトリの場所翻訳はlocaleCode.translationの形式でファイルに保存されます。localeCodeは、翻訳言語のロケールコードです。たとえば、ドイツ語翻訳のファイル名はde.translationです。サポートされるロケールコードのリストは、「言語」に示しています。

490


カスタムオブジェクトの翻訳は、対応するパッケージディレクトリのtranslationsフォルダに保存されます。

バージョンTranslations コンポーネントは、API バージョン 14.0 以降で使用できます。

項目

説明データ型項目カスタムアプリケーション翻訳のリスト。CustomApplicationTranslation[]customApplications

カスタム表示ラベル翻訳のリスト。CustomLabelTranslation[]customLabels

ホームページコンポーネントで定義された Webリンクの翻訳のリスト。

CustomPageWebLinkTranslation[]customPageWebLinks

カスタムタブ翻訳のリスト。CustomTabTranslation[]customTabs

必須。言語コード。たとえば、ドイツ語の場合は deです。Metadata から継承されるこの項目は、このメタデータ型の WSDL では定義されません。作

stringfullName

成時、更新時、または削除時に指定する必要があります。コールにおけるこの項目の例を確認するには、「create()」を参照してください。

グローバル (オブジェクト固有ではない) クイックアクションのリスト。

GlobalQuickActionTranslation[]quickActions

レポートタイプ翻訳のリスト。ReportTypeTranslation[]reportTypes

Sコントロール翻訳のリスト。ScontrolTranslation[]scontrols

CustomApplicationTranslation

CustomApplicationTranslation には、カスタムアプリケーション翻訳の詳細が含まれます。詳細は、「CustomApplication」を参照してください。

説明データ型項目必須。翻訳されたカスタムアプリケーション名。最大 765 文字です。

stringlabel

必須。カスタムアプリケーションの名前。stringname

CustomLabelTranslation

CustomLabelTranslation には、カスタム表示ラベル翻訳の詳細が含まれます。詳細は、「CustomLabels」を参照してください。

説明データ型項目必須。翻訳されたカスタム表示ラベル名。最大 765文字です。

stringlabel

491


説明データ型項目必須。カスタム表示ラベル名。stringname

CustomPageWebLinkTranslation

CustomPageWebLinkTranslation には、ホームページコンポーネントで定義された Web リンクの翻訳の詳細が含まれます。詳細は、「CustomPageWebLink」を参照してください。

説明データ型項目必須。翻訳された Web リンク。stringlabel

必須。Web リンクの名前。stringname

CustomTabTranslation

CustomTabTranslation にはカスタムタブの翻訳の詳細が含まれます。詳細は、「CustomTab」を参照してください。

説明データ型項目必須。翻訳されたカスタムタブ名。stringlabel

必須。カスタムタブ名。stringname

GlobalQuickActionTranslation

GlobalQuickActionTranslation には、グローバルなクイックアクションの翻訳の詳細が含まれます。詳細は、「QuickAction」を参照してください。

説明データ型項目必須。グローバルに翻訳されたクイックアクション名。

stringlabel

必須。クイックアクション名。stringname

ReportTypeTranslation

ReportTypeTranslation にはカスタムレポートタイプの翻訳の詳細が含まれます。詳細は、「ReportType」を参照してください。

説明データ型項目翻訳されたレポートタイプの説明。stringdescription

翻訳されたレポートタイプ名。stringlabel

必須。レポートタイプの名前。stringname

レポートタイプセクションの翻訳のリスト。ReportTypeSectionTranslation[]sections

ReportTypeSectionTranslation

ReportTypeSectionTranslation には、レポートタイプセクションの翻訳の詳細が含まれます。

492


説明データ型項目レポートタイプ列翻訳のリスト。ReportTypeColumnTranslation[]columns

翻訳されたレポートタイプセクション名。stringlabel

必須。レポートタイプセクションの名前。stringname

ReportTypeColumnTranslation

ReportTypeColumnTranslation には、レポートタイプ列翻訳の詳細が含まれます。

説明データ型項目必須。翻訳されたレポートタイプ列名。stringlabel

必須。レポートタイプ列名。stringname

ScontrolTranslation

重要: Sコントロールは、Visualforce ページに置き換えられました。組織で以前に Sコントロールを使用していない場合は、作成できません。既存の Sコントロールに影響はありません。今後も編集できます。

ScontrolTranslation には、Sコントロールの翻訳の詳細が含まれます。詳細は、Salesforce オンラインヘルプの「Sコントロールについて」を参照してください。

説明データ型項目必須。翻訳された Sコントロール名。stringlabel

必須。Sコントロールの名前。stringname

宣言的なメタデータの定義のサンプル翻訳コンポーネントの XML 定義のサンプルを以下に示します。

<?xml version="1.0" encoding="UTF-8"?><Translations xmlns="http://soap.sforce.com/2006/04/metadata">

<customApplications><label>Angebot-Manager</label>

<name>Quote Manager</name></customApplications><customLabels><label>Dieses ist ein manuelles Angebot</label>

<name>quoteManual</name></customLabels>

</Translations>

使用方法retrieve()コールを使用して組織内の翻訳を取得する場合、.translationsフォルダ内に返されるファイルには package.xmlで参照されている他のメタデータ型の翻訳のみが含まれます。たとえば、次の package.xml

ファイルには、すべてのカスタムアプリケーション、カスタム表示ラベル、ホームページコンポーネントで定義された Web リンク、カスタムタブ、レポートタイプ、および Sコントロールに一致する types要素が含まれま

493


す。各メタデータ型は明示的に package.xmlにリストされているため、これらすべてのメタデータ型の翻訳が返されます。


<types><members>*</members><name>CustomApplication</name>

</types><types>

<members>*</members><name>CustomLabels</name>

</types><types>

<members>*</members><name>CustomPageWebLink</name>

</types><types>


</types><types>

<members>*</members><name>ReportType</name>

</types><types>

<members>*</members><name>Scontrol</name>

</types><types>

<members>*</members><name>Translations</name>


</Package>

関連リンクCustomLabels

Workflowワークフロールールに関連付けられたメタデータを表します。ワークフロールールは、指定された条件に該当するときに、ワークフローアクションを実行します。ワークフローアクションは、ワークフロールールで指定された条件をレコードが満たすとただちに実行するか、タイムトリガを設定して特定の日に実行するように設定することができます。詳細は、Salesforceヘルプの「ワークフローと承認申請の概要」を参照してください。Metadataメタデータ型を拡張し、その fullName項目を継承します。ワークフロールール定義の作成、更新、または削除にはこのメタデータ型を使用します。マニフェストファイルを使用する場合、次のコードを使用してすべてのワークフローコンポーネントを取得します。

<types><members>*</members><name>Workflow</name>

</types>

494

Workflowメタデータ型

宣言的なメタデータファイルのサフィックスおよびディレクトリの場所ワークフローファイルには、サフィックス .workflowが付けられます。ワークフローのある標準オブジェクトまたはカスタムオブジェクトごとに、1 つのファイルがあります。これらのファイルは、対応するパッケージのworkflowsディレクトリに保存されます。

バージョンワークフロールールは、API バージョン 13.0 以降で使用できます。

Workflow

このメタデータ型は、標準オブジェクトまたはカスタムオブジェクトに関連付けられたワークフロールールおよびアクションの有効な型を表します。

説明データ型項目名ワークフローに関連付けられたオブジェクトに関するすべてのアラートの配列。

WorkflowAlert[]alerts

ワークフローに関連付けられたオブジェクトに関するすべての項目自動更新の配列。

WorkflowFieldUpdate[]fieldUpdates

API アクセスの一意の識別子として使用される開発者名。fullNameには、アンダースコアと英数字のみ

stringfullName

を使用できます。一意であること、最初は文字であること、空白は使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。この項目は、Metadata コンポーネントから継承されています。ワークフローに関連付けられている Salesforce ナレッジワークフロー公開の配列。API バージョン 27.0 以降で利用できます。

WorkflowKnowledgePublish[]knowledgePublishes

ワークフローに関連付けられたオブジェクトに関するすべてのアウトバウンドメッセージの配列。

WorkflowOutboundMessage[]outboundMessages

ワークフローに関連付けられてたすべてのオブジェクトの配列。

WorkflowRule[]rules

ワークフローに関連付けられたオブジェクトに関するすべての ToDo の配列。

WorkflowTask[]tasks

WorkflowActionReference

WorkflowActionReference は、いずれかのワークフローアクションを表します。

説明データ型項目名必須。ワークフローアクションの名前。stringname

必須。次の種別のワークフローアクションを使用できます。

WorkflowActionType(string 型の列挙)

type

• Alert

• FieldUpdate

495


説明データ型項目名• OutboundMessage

• Task

WorkflowAlert

WorkflowAlert は、ワークフロールールに関連付けられたメールアラートを表します。

説明データ型項目名追加の CC メールアドレス。string[]ccEmails

必須。メールアラートの説明。APIバージョン 16.0以降で利用できます。

stringdescription

必須。APIアクセスの一意の識別子として使用される開発者名。fullNameには、アンダースコアと英

stringfullName

数字のみを使用できます。一意であること、最初は文字であること、空白は使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。この項目は、Metadata コンポーネントから継承されています。必須。このコンポーネントが保護されるか (true)、否か (false) を示します。保護コンポーネントは、

booleanprotected

インストールする組織で作成されたコンポーネントによってリンク設定したり参照したりすることはできません。メールの受信者。WorkflowEmailRecipient[]recipients

メールアラートの [送信者] 項目のアドレス。デフォルトの [送信者] 項目 (レコードを更新したユーザの

stringsenderAddress

メールアドレス) の代わりに、組織の標準のグローバルメールアドレス ([email protected]など)を使用できます。senderTypeがOrgWideEmailAddressに設定されている場合にのみ、この項目に値を指定できます。Salesforce ヘルプの「組織の共有アドレス」を参照してください。送信者の送信者および返信先アドレスとして使用されるメール。有効な値は次のとおりです。

ActionEmailSenderType (string型の列挙)

senderType

• CurrentUser — レコードを更新するユーザのメールアドレス。これは、デフォルト設定です。

• DefaultWorkflowUser — デフォルトワークフローユーザのメールアドレス。

• OrgWideEmailAddress —[email protected]など、組織の検証済みグローバルメールアドレス。

496


説明データ型項目名必須。EmailTemplate への名前指定参照。このメールテンプレートは zip ファイル内に存在する必要は

stringtemplate

ありませんが、メタデータ API には存在する必要があります。

WorkflowEmailRecipient

WorkflowEmailRecipient は、ワークフロールールに関連付けられたメールアラートの受信者を表します。

説明データ型項目名typeで参照される項目の名前。名前を指定した項目は、typeで指定されている型である必要があります。

stringfield

メールの受信者。選択した型に応じて、必須になる場合があります。

stringrecipient

EmailTemplate コンポーネントへの名前指定参照。有効な値は、次のとおりです。

ActionEmailRecipientTypes(string 型の列挙)

type

• accountOwner - メールはレコードの取引先所有者に送信されます (商談の取引先所有者など)。

• accountTeam - Account オブジェクトのみに適用されます。メールはその Account の取引先チーム全員に送信されます。

• campaignMemberDerivedOwner - 取引先責任者がキャンペーンに追加された場合、またはキャンペーンに応じて、メールがリードおよび取引先責任者所有者に送信されます。

• contactLookup - メールは、レコードの項目から検索された値を含む取引先責任者に送信されます。この値では、field項目が Contact を参照する必要があります。

• creator - メールはレコードの作成者に送信されます。

• customerPortalOwner - メールは特定のセルフサービスポータルユーザに送信されます。この値では、recipient 項目が User を (ユーザ名で) 参照する必要があります。セルフサービスポータルユーザのみが対象です。

• email - メールはレコードの項目から検索された値を含むメールアドレスに送信されます。この値では、field項目が email 項目を参照する必要があります。

• group - メールはグループ内の全ユーザに送信されます。この値では、recipient 項目が group を (グループ名で) 参照する必要があります。

497


説明データ型項目名• opportunityTeam - Opportunity オブジェクトの

みに適用されます。メールはその Opportunity の商談チーム全員に送信されます。

• owner - メールはレコードの所有者に送信されます。

• partnerUser - メールは特定のパートナーユーザに送信されます。この値では、recipient 項目がUser を (ユーザ名で) 参照する必要があります。パートナーユーザのみが対象です。

• portalRole - roleと似ていますが、ポータルロールのみが対象となります。

• portalRoleSubordinates - roleSubordinatesと似ていますが、ポータルロールのみが対象となります。

• role - メールはロールの全ユーザに送信されます。この値では、recipient 項目が (ロール階層内の) Role を (ロール名で) 参照する必要があります。

• roleSubordinates - メールは下位ロールの全ユーザに送信されます。この値では、recipient 項目が Role を参照する必要があります。

• roleSubordinatesInternal -roleSubordinatesと似ていますが、内部ポータルロールのみが対象となります。

• user - メールは特定のユーザに送信されます。この値では、recipient 項目が User を (ユーザ名で)参照する必要があります。

• userLookup - メールはレコードの項目から検索された値を含むユーザに送信されます。この値では、field項目がユーザの外部キー項目を参照する必要があります。

WorkflowFieldUpdate

WorkflowFieldUpdate は、ワークフローの項目自動更新を表します。項目自動更新を使用すると、ワークフロールールがトリガされたときに、自動的に項目値を指定した値に更新できます。詳細は、Salesforceヘルプの「項目自動更新の定義」を参照してください。

説明データ型項目名項目自動更新の説明。この情報は、項目自動更新を最初に設定したときの理由を追跡するのに役立ちます。

stringdescription

必須。更新する項目 (ワークフローのオブジェクト上の)。

stringfield

operation項目値が Formulaの場合、これは新しい項目値の計算に使用される数式に設定されます。

stringformula

498


説明データ型項目名必須。API アクセスの一意の識別子として使用される開発者名。fullNameには、アンダースコアと英数字

stringfullName

のみを使用できます。一意であること、最初は文字であること、空白は使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。この項目は、Metadataコンポーネントから継承されています。operation項目値が Literalの場合、これは項目のリテラル値です。

stringliteralValue

operation項目値が lookupValueの場合、これは参照されるルックアップ値です。

stringlookupValue

lookupValue項目値が参照するオブジェクトの種別。有効な値は、次のとおりです。

LookupValueType (string型の列挙)

lookupValueType

• Queue

• RecordType

• User

必須。コンポーネントの名前。APIバージョン 16.0 以降で使用できます。

stringname

必須。項目が更新された場合に割り当て先に通知します。

booleannotifyAssignee

必須。項目の更新に使用される値を計算する操作。有効な値は、次のとおりです。

FieldUpdateOperation(string 型の列挙)

operation

• Formula - 項目が数式に設定されることを示します。設定されている場合、数式は有効な数式である必要があります。

• Literal - 項目がリテラル値に設定されることを示します。設定されている場合、literalValue はこの項目にとって有効なリテラル値である必要があります。

• LookupValue - Literal と似ていますが、contact、user、account などの、オブジェクト参照用です。設定されている場合、lookupValue要素を設定する必要があります。現在の API では User のみがサポートされています。

• NextValue - 項目が次の値に設定されることを示します。これは、項目自動更新が選択リストを参照する場合にのみ許可されます。

• Null - 項目が null に設定されることを示します。• PreviousValue - 項目が前の値に設定されること

を示します。これは、項目自動更新が選択リストを参照する場合にのみ許可されます。

必須。このコンポーネントが保護されるか (true)、否か (false) を示します。保護コンポーネントは、イン

booleanprotected

499


説明データ型項目名ストールする組織で作成されたコンポーネントによってリンク設定したり参照したりすることはできません。この項目が true に設定されているときにこの項目が項目の値を更新すると、関連付けられたオブジェクトの

booleanreevaluateOnChange

すべてのワークフロールールが再評価されます。条件が項目値の変更結果と一致するすべてのワークフロールールがトリガされます。トリガされたワークフロールールのいずれかにより、ワークフロールールの再評価も有効にする他の項目自動更新が実行される場合、ドミノ効果が発生し、新規にトリガされた項目自動更新の結果としてより多くのワークフロールールを再評価できます。このワーフロールールの再評価およびトリガのカスケードは、それを開始した最初の項目自動更新の後、最大 5 回実行できます。

これは、子レコードで変更が検出された場合に設定されます。これが設定されている場合、親 (Case など) を

stringtargetObject

指し示す子オブジェクト (EmailMessage.ParentIdなど) の外部キー参照を指し示します。設定されると、数式は子オブジェクト (EmailMessageなど) に基づきます。この項目は、バージョン 14.0 より前ではsourceFieldという名前です。項目名の変更は、バージョン間で自動的に処理され、既存の XML コンポーネントファイルを手動で編集する必要はありません。

WorkflowKnowledgePublish

WorkflowKnowledgePublish は、Salesforce ナレッジ記事の公開アクションおよび情報を表します。APIバージョン27.0 以降で利用できます。

説明項目のデータ型項目名このルールが起動したときに実行可能な記事の公開アクション。有効な値は、次のとおりです。

KnowledgeWorkflowAction (string型の列挙)

action

• PublishAsNew: 記事を新規記事として公開します。

• Publish: 記事を公開済み記事のバージョンとして公開します。

簡単な記事の説明。stringdescription

Salesforce ユーザインターフェース全体で記事を表す表示ラベル。

stringlabel

記事の言語。stringlanguage

500


説明項目のデータ型項目名必須。このコンポーネントが保護されるか(true)、否か (false) を示します。保護コンポー

booleanprotected

ネントは、インストールする組織で作成されたコンポーネントによってリンク設定したり参照したりすることはできません。

WorkflowOutboundMessage

WorkflowOutboundMessage は、ワークフロールールに関連付けられたアウトバウンドメッセージを表します。アウトバウンドメッセージは、外部サービスなどの指定したエンドポイントに指定の情報を送信するワークフローおよび承認アクションです。アウトバウンドメッセージは、エンドポイントに対し、特定の項目内のデータをSOAP メッセージとして送信します。詳細は、Salesforceヘルプの「アウトバウンドメッセージの定義」を参照してください。

説明データ型項目名必須。アウトバウンドメッセージの API バージョン。アウトバウンドメッセージが作成されると、自動的に現在のAPI

doubleapiVersion

バージョンに設定されます。アウトバウンドメッセージの有効な API バージョンは 8.0 および 18.0 以降です。API バージョンは、Enterprise または Partner WSDL を使用したSalesforceへのAPIコールバックで使用されます。[API

バージョン]は、メタデータ API を使用してのみ変更できます。Salesforce ユーザインターフェースを使用して変更することはできません。この項目は API バージョン 18.0 以降で使用できます。

警告: apiVersionを、アウトバウンドメッセージに設定された fieldsのいずれもサポートしていないバージョンに変更した場合、更新された WSDL を消費するようにアウトバウンドメッセージリスナーを更新するまでメッセージは失敗します。[設定] からアウトバウンドメッセージの状況を監視するには、Salesforce で [監視] > [アウトバウンドメッセージ] をクリックします。

アウトバウンドメッセージを説明します。stringdescription

必須。アウトバウンドメッセージの送信先となるエンドポイント URL。

stringendpointUrl

送信対象の項目への名前指定参照。string[]fields

必須。APIアクセスの一意の識別子として使用される開発者名。fullNameには、アンダースコアと英数字のみを使用で

stringfullName

きます。一意であること、最初は文字であること、空白は使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。この項目は、Metadata コンポーネントから継承されています。

501


説明データ型項目名必須。アウトバウンドメッセージにSalesforceセッション IDを含める場合は設定します。APIコール発行の予定があり、ユーザ名とパスワードを含めたくない場合に便利です。

booleanincludeSessionId

必須。このメッセージの送信者となるユーザへの名前指定参照。

stringintegrationUser

必須。コンポーネントの名前。API バージョン 16.0 以降で使用できます。

stringname

必須。このコンポーネントが保護されるか (true)、否か(false) を示します。保護コンポーネントは、インストール

booleanprotected

する組織で作成されたコンポーネントによってリンク設定したり参照したりすることはできません。この項目は、配信不能メッセージキュー権限が有効な組織でのみ使用できます。設定されている場合、このアウトバウン

booleanuseDeadLetterQueue

ドメッセージは、通常の配信が失敗した場合に配信不能メッセージキューを使用します。

WorkflowRule

このメタデータ型はワークフロールールを表します。Metadataメタデータ型を拡張し、その fullName項目を継承します。

説明データ型項目名このルールが起動したら実行する必要があるアクションの参照の配列。


必須。このルールが有効かどうかを決定します。booleanactive

高度な検索条件の boolean 数式 ((1 AND 2) OR 3など) です。

stringbooleanFilter

このルールを起動する boolean 条件の配列。この項目か、formulaのいずれかが設定されている必要があります。


ワークフロールールの説明。stringdescription

このルールが最初に (この項目かcriteriaItemsに)設定されている必要がある数式条件。

stringformula

API アクセスの一意の識別子として使用される開発者名。fullNameには、アンダースコアと英数字のみ

stringfullName

を使用できます。一意であること、最初は文字であること、空白は使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。この項目は、Metadata コンポーネントから継承されています。

502


説明データ型項目名トリガが起動する条件。有効な値は、次のとおりです。

WorkflowTriggerTypes(string 型の列挙)

triggerType

• onAllChanges - すべての変更でワークフロールールが考慮されます。

• onCreateOnly - 作成でのみワークフロールールが考慮されます。

• onCreateOrTriggeringUpdate - 作成およびトリガする更新でのみワークフロールールが考慮されます。

指定間隔の前/後に実行する一連のワークフローアクション (項目自動更新、メールアラート、アウトバウンドメッセージ、ToDo) を表します。

WorkflowTimeTriggerworkflowTimeTriggers

WorkflowTask

このメタデータ型は、割り当てられたワークフロー ToDo を参照します。

説明データ型項目名ワークフロールールまたはアクションが割り当てられているユーザ、ロール、またはチームを指定

stringassignedTo

します。ここで指定した値に対応する項目は、指定された assignedToTypeと同じである必要があります。この型の有効な string 値は次のとおりです。ActionTaskAssignedToTypes


• accountCreator - 設定した場合、ToDo はレコードの取引先の作成者に割り当てられます。

• accountOwner - 設定した場合、ToDo はレコードの取引先の所有者 (Opportunity) に割り当てられます。

• accountTeam - WorkflowAlert 型と同じです。• creator - 設定した場合、ToDo はレコードの

作成者に割り当てられます。• opportunityTeam - WorkflowAlert 型と同じ

です。• owner - 設定した場合、ToDo はレコードの所

有者に割り当てられます。• partnerUser - 設定した場合、assignedTo

項目は User を (ユーザ名で) 参照します。パートナーユーザが対象です。

• portalRole - 設定した場合、assignedTo項目は Role を (ロール名で) 参照します。ポータルロールが対象です。

• role - 設定した場合、assignedTo項目は Roleを (ロール名で) 参照します。

503


説明データ型項目名• user - 設定した場合、assignedTo項目は User

を (ユーザ名で) 参照します。

このワークフロー ToDo の説明。stringdescription

必須。トリガ日または (省略可能な)offsetFromFieldで指定された日付からのオフセット (日数)。負の数値を設定できます。

intdueDateOffset

必須。APIアクセスの一意の識別子として使用される開発者名。fullNameには、アンダースコア

stringfullName

と英数字のみを使用できます。一意であること、最初は文字であること、空白は使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。この項目は、Metadata コンポーネントから継承されています。必須。ToDo が割り当てられたときにメール通知を送信する場合に設定します。

booleannotifyAssignee

dueDateの計算の基準となる date 項目の項目参照 (省略可能)。

stringoffsetFromField

必須。作成された ToDo に割り当てる優先度。stringpriority

必須。このコンポーネントが保護されるか(true)、否か (false) を示します。保護コンポー

booleanprotected

ネントは、インストールする組織で作成されたコンポーネントによってリンク設定したり参照したりすることはできません。必須。作成した ToDo を割り当てる状況。stringstatus

必須。ワークフロー ToDo の件名。ToDo が割り当てられたときにメール通知を送信する場合に使

stringsubject

用されます。API バージョン 16.0 以降で利用できます。

WorkflowTimeTrigger

指定間隔の前/後に実行する一連のワークフローアクション (項目自動更新、メールアラート、アウトバウンドメッセージ、ToDo) を表します。

説明データ型項目名このトリガが起動した場合に実行するアクションの参照の配列。


時間ベースのワークフローがトリガされる基準となるdate 型の項目名 ([作成日]、[最終更新日]、[ルール適用

stringoffsetFromField

日])、またはワークフロールールが定義されている、オブジェクトのカスタム日付項目。

504


説明データ型項目名ワークフローをトリガした後/トリガする前の時間 (数値)。負の値は、トリガが起動する前の時間の長さを表します。

stringtimeLength

時間ベースのワークフローがトリガされる前または後の時間の単位。有効な string 値は次のとおりです。

WorkflowTimeUnits(string 型の列挙)

workflowTimeTriggerUnit

• Hours

• Days

宣言的なメタデータの定義のサンプルワークフロールールの定義を次に示します。

<?xml version="1.0" encoding="UTF-8"?><Workflow xmlns="http://soap.sforce.com/2006/04/metadata">

<alerts><fullName>Another_alert</fullName><description>Another alert</description><protected>false</protected><recipients>

<type>accountOwner</type></recipients><recipients>

<field>Contact__c</field><type>contactLookup</type>

</recipients><recipients>

<field>Email__c</field><type>email</type>

</recipients><template>TestEmail/Email Test</template>

</alerts><fieldUpdates>

<fullName>Enum_Field_Update</fullName><description>Blah</description><field>EnumField__c</field><name>Enum Field Update</name><notifyAssignee>true</notifyAssignee><operation>NextValue</operation><protected>false</protected>

</fieldUpdates><fieldUpdates>

<fullName>Enum_Field_Update2</fullName><description>Blah</description><field>EnumField__c</field><literalValue>PLX2</literalValue><name>Enum Field Update2</name><notifyAssignee>true</notifyAssignee><operation>Literal</operation><protected>false</protected>


<fullName>Field_Update</fullName><description>TestField update desc</description><field>Name</field><formula>Name & "Updated"</formula><name>Field Update</name><notifyAssignee>false</notifyAssignee><operation>Formula</operation><protected>false</protected>


505


<fullName>Lookup_On_Contact</fullName><field>RealOwner__c</field><lookupValue>[email protected]</lookupValue><name>Lookup On Contact</name><notifyAssignee>false</notifyAssignee><operation>LookupValue</operation><protected>false</protected>

</fieldUpdates><outboundMessages>

<fullName>Another_Outbound_message</fullName><description>Another Random outbound.</description><endpointUrl>http://www.test.com</endpointUrl><fields>Email__c</fields><fields>Id</fields><fields>Name</fields><includeSessionId>true</includeSessionId><integrationUser>[email protected]</integrationUser><name>Another Outbound message</name><protected>false</protected>

</outboundMessages><rules>

<fullName>BooleanFilter</fullName><active>false</active><booleanFilter>1 AND 2 OR 3</booleanFilter><criteriaItems>

<field>CustomObjectForWorkflow__c.CreatedById</field><operation>notEqual</operation>


<field>CustomObjectForWorkflow__c.CreatedById</field><operation>notEqual</operation><value>abc</value>


<field>CustomObjectForWorkflow__c.CreatedById</field><operation>equals</operation><value>xyz</value>

</criteriaItems><triggerType>onCreateOrTriggeringUpdate</triggerType>

</rules><rules>

<fullName>Custom Rule1</fullName><actions>

<name>Another_alert</name><type>Alert</type>

</actions><actions>

<name>Enum_Field_Update2</name><type>FieldUpdate</type>

</actions><actions>

<fullName>Field_Update</name><type>FieldUpdate</type>

</actions><actions>

<name>Another_Outbound_message</name><type>OutboundMessage</type>

</actions><actions>

<name>Role_task_was_completed</name><type>Task</type>

</actions><active>true</active><criteriaItems>

<field>CustomObjectForWorkflow__c.Name</field><operation>startsWith</operation><value>ABC</value>

</criteriaItems><description>Custom Rule1 desc</description>

506


<triggerType>onCreateOrTriggeringUpdate</triggerType></rules><rules>

<fullName>IsChangedFunctionRule</fullName><active>true</active><description>IsChangedDesc</description><formula>ISCHANGED(Name)</formula><triggerType>onAllChanges</triggerType>

</rules><tasks>

<fullName>Another_task_was_completed</fullName><assignedToType>owner</assignedToType><description>Random Comment</description><dueDateOffset>20</dueDateOffset><notifyAssignee>true</notifyAssignee><priority>High</priority><protected>false</protected><status>Completed</status><subject>Another task was completed</subject>

</tasks><tasks>

<fullName>Role_task_was_completed</fullName><assignedTo>R11</assignedTo><assignedToType>role</assignedToType><dueDateOffset>-2</dueDateOffset><notifyAssignee>true</notifyAssignee><offsetFromField>CustomObjectForWorkflow__c.CreatedDate</offsetFromField><priority>High</priority><protected>false</protected><status>Completed</status><subject>Role task was completed</subject>

</tasks><tasks>

<fullName>User_task_was_completed</fullName><assignedTo>[email protected]</assignedTo><assignedToType>user</assignedToType><dueDateOffset>-2</dueDateOffset><notifyAssignee>true</notifyAssignee><offsetFromField>User.CreatedDate</offsetFromField><priority>High</priority><protected>false</protected><status>Completed</status><subject>User task was completed</subject>

</tasks></Workflow>

507


付録

付録A

CustomObjectTranslation の言語サポート — 完全サポート対象言語

すべての言語で、CustomObjectTranslationの項目で使用可能なすべての値がサポートされているわけではありません。この付録で、特定の言語でサポートされる項目値を確認してください。

メモ: Salesforce では、完全にサポートされる言語、エンドユーザ言語、およびプラットフォームのみの言語という 3 つのレベルの言語がサポートされています。この付録には、完全にサポートされている言語の情報が記載されています。詳細については、Salesforce ヘルプの「Salesforce がサポートする言語は?」を参照してください。

中国語 (簡体字)plural

true

false

中国語 (繁体字)plural

true

false

デンマーク語plural

true

false

508

オランダ語article

Definite

Indefinite

gender

Common

Neuter

plural

true

false

フィンランド語caseType

Ablative

Accusative

Adessive

Allative

Dative

Elative

Essive

Genitive

Illative

Inessive

Nominative

Partitive

Translative

plural

true

false

possessive

First

Second

フランス語article

Definite

Indefinite

509

付録 A: CustomObjectTranslation の言語サポート — 完全サポート対象言語

gender

Masculine

Feminine

plural

true

false

startsWith

Consonant

Vowel

ドイツ語article

Definite

Indefinite

caseType

Accusative

Dative

Genitive

Nominative

gender

Masculine

Feminine

Neuter

plural

true

false

イタリア語gender

Masculine

Feminine

plural

true

false

startsWith

Consonant

Vowel

510


Special

日本語plural

true

false

韓国語plural

true

false

ポルトガル語 (ブラジル)plural

true

false

article

Definite

Indefinite

ロシア語caseType

Accusative

Dative

Genitive

Instrumental

Nominative

Prepositional

gender

Masculine

Feminine

Neuter

plural

true

false

スペイン語article

Definite

511


Indefinite

gender

Masculine

Feminine

plural

true

false

タイ語plural

true

false

512


付録B

CustomObjectTranslation の言語サポート — エンドユーザ言語

すべての言語で、CustomObjectTranslationの項目で使用可能なすべての値がサポートされているわけではありません。この付録で、特定の言語でサポートされる項目値を確認してください。

メモ: Salesforce では、完全にサポートされる言語、エンドユーザ言語、およびプラットフォームのみの言語という 3 つのレベルの言語がサポートされています。この付録には、エンドユーザ言語の情報が記載されています。詳細については、Salesforce ヘルプの「Salesforce がサポートする言語は?」を参照してください。

アラビア語article

Definite

gender

Masculine

Feminine

plural

true

false

possessive

First

Second

ブルガリア語article

Definite

gender

Masculine

Feminine

Neuter

513

plural

true

false

チェコ語caseType

Accusative

Dative

Genitive

Instrumental

Locative

Nominative

gender

Masculine

Feminine

Neuter

plural

true

false

ギリシャ語article

Definite

Indefinite

caseType

Accusative

Genitive

Nominative

gender

Masculine

Feminine

Neuter

plural

true

false

514

付録 B: CustomObjectTranslation の言語サポート — エンドユーザ言語

ヘブライ語article

Definite

gender

Masculine

Feminine

plural

true

false

ハンガリー語article

Definite

Indefinite

caseType

Ablative

Accusative

Allative

Causalfinal

Dative

Delative

Distributive

Elative

Essiveformal

Illative

Inessive

Instrumental

Nominative

Sublative

Termanative

Translative

plural

true

false

possessive

First

Second

515


startsWith

Consonant

Vowel

インドネシア語plural

true

false

ノルウェー語article

Definite

Indefinite

gender

Masculine

Feminine

Neuter

plural

true

false

ポーランド語caseType

Accusative

Dative

Genitive

Instrumental

Locative

gender

Masculine

Feminine

Neuter

plural

true

false

516


ルーマニア語article

Definite

Indefinite

caseType

Dative

gender

Masculine

Feminine

Neuter

plural

true

false

スペイン語 (メキシコ)article

Definite

Indefinite

gender

Masculine

Feminine

plural

true

false

トルコ語caseType

Ablative

Accusative

Allative

Dative

Genitive

Lative

Nominative

possessive

First

Second

517


ウクライナ語caseType

Accusative

Dative

Genitive

Instrumental

Nominative

Prepositional

gender

Masculine

Feminine

Neuter

plural

true

false

ベトナム語plural

true

false

518


用語集

A |B |C |D |E |F |G |H |I |J |K |L |M |N |O |P |Q |R |S |T |U |V |W |X |Y |Z

AApex

Apex は、開発者が Force.com プラットフォームサーバでフローとトランザクションの制御ステートメントをForce.com APIへのコールと組み合わせて実行できるようにした、強く型付けされたオブジェクト指向のプログラミング言語です。Java に似た構文を使い、データベースのストアドプロシージャのように動作するApex を使用して、開発者は、ボタンクリック、関連レコードの更新、および Visualforce ページなどのほとんどのシステムでの行動に対しビジネスロジックを追加できます。Apex コードは、Web サービス要求、およびオブジェクトのトリガから開始できます。

Apex による共有管理開発者は、アプリケーションの動作をサポートする共有をプログラムで操作できるようになります。Apexによる共有管理は、カスタムオブジェクトでのみ有効です。

アプリケーション「App」と表記されることもあります。特定のビジネス要件を扱うタブ、レポート、ダッシュボードおよびVisualforce ページなどのコンポーネントの集合です。Salesforce では、セールスおよびコールセンターなどの標準アプリケーションを提供しています。お客様のニーズに合わせてこれらの標準アプリケーションをカスタマイズできます。また、アプリケーションをパッケージ化して、カスタム項目、カスタムタブ、カスタムオブジェクトなどの関連コンポーネントと共に AppExchange にアップロードできます。そのアプリケーションを AppExchange から他の Salesforce ユーザが利用できるようにすることもできます。

AppExchange

AppExchange は salesforce.com の共有インターフェースであり、Force.com プラットフォームのアプリケーションやサービスを参照および共有できます。

AppExchange のアップグレードアプリケーションのアップグレードは、新しいバージョンをインストールするプロセスです。

アプリケーションプログラムインターフェース (API)

コンピュータシステム、ライブラリ、またはアプリケーションが、その他のコンピュータプログラムがサービスを要求したりデータを交換したりできる機能を提供するインターフェースです。

非同期コール操作に長い時間がかかるため、直ちに結果を返さないコールです。メタデータ API と Bulk API のコールは非同期です。

519

BBoolean 演算子

Boolean 演算子をレポートプロファイルで使用して、2 つの値の間の論理関係を指定できます。たとえば、2 つの値の間で AND 演算子を使用すると、両方の値を含む検索結果が生成されます。同様に、2 つの値の間で OR 演算子を使用すると、どちらかの値を含む検索結果が生成されます。

Bulk API

REST ベースの Bulk API は、大規模データセットの処理用に最適化されています。Salesforce によりバックグラウンドで処理される複数のバッチを送信することにより、多数のレコードを非同期でクエリ、挿入、更新、更新/挿入または削除できます。「SOAP API」も参照してください。

Cクラス、Apex

Apexオブジェクトの作成でベースとして使用する一種のテンプレートです。他のクラス、ユーザ定義メソッド、変数、例外型、および静的初期化コードで構成されます。多くの場合、Apex クラスは、Java 内のその対応物に基づいています。

クライアントアプリケーションSalesforce ユーザインターフェースの外部で実行し、Force.com API または Bulk API のみを使用するアプリケーションです。通常、デスクトップまたはモバイルデバイス上で稼動します。これらのアプリケーションは、プラットフォームをデータソースとして扱い、設計されたツールおよびプラットフォームの開発モデルを使用します。

コンポーネント、メタデータコンポーネントは、メタデータ API のメタデータ型のインスタンスです。たとえば、CustomObject はカスタムオブジェクトのメタデータ型で、MyCustomObject__cコンポーネントはカスタムオブジェクトのインスタンスです。コンポーネントは XML ファイルに記述され、メタデータ API を使用するか、Force.comIDEやForce.com 移行ツールなど、API で構築されたツールを使用してリリースしたり、取得したりできます。

コンポーネント、Visualforce

<apex:detail>などの一連のタグを使用して Visualforce ページに追加できます。Visualforce には、多くの標準コンポーネントが含まれていますが、独自のカスタムコンポーネントを作成することもできます。

コンポーネントの参照、Visualforce

組織で使用できるVisualforceの標準コンポーネントおよびカスタムコンポーネントの説明。Visualforceページの開発フッターまたは『Visualforce 開発者ガイド』からコンポーネントライブラリにアクセスできます。

コントローラ、Visualforce

Visualforceページに実行する必要のあるデータおよびビジネスロジックを提供するApexクラス。Visualforceページは、デフォルトですべての標準オブジェクトまたはカスタムオブジェクトに付属する標準コントローラを使用、またはカスタムコントローラを使用できます。

制御項目対応する 1 つ以上の連動項目で使用可能な値を制御する、標準またはカスタムの選択リストやチェックボックスの項目です。

カスタムアプリケーション「アプリケーション」を参照してください。

520

用語集

http://developerforcejp.s3.amazonaws.com/developer/docs/pages/index.htm

カスタムリンクカスタムリンクとは管理者によって定義された URL。これを使用して、Salesforce データを外部 Web サイトとバックエンドのオフィスシステムと統合します。以前は Web リンクと呼ばれていました。

カスタムオブジェクト組織固有の情報を保存することが可能なカスタムレコード。

カスタム Sコントロール

メモ: Sコントロールは、Visualforceページに置き換えられました。2010 年以降、新しい組織同様、Sコントロールを作成したことのない組織は、Sコントロールを作成できなくなります。既存の Sコントロールに影響はありません。今後も編集できます。

カスタムリンクで使用するカスタム Web コンテンツ。カスタム Sコントロールには、Java アプレット、Active-X コントロール、Excel ファイル、カスタム HTML Web フォームなど、ブラウザに表示できるあらゆる種類のコンテンツを入れることができます。

Dデータベース

情報の編成された集合です。Force.com プラットフォームの基底となるアーキテクチャには、データが格納されているデータベースが含まれています。

データベーステーブル追跡する必要のある人物、物事、またはコンセプトに関する情報のリストで、行および列で表示されます。「オブジェクト」も参照してください。

データ操作言語 (DML)

Force.com プラットフォームデータベースからレコードを挿入、更新、削除する Apex のメソッドまたは操作。

小数点の位置数値、通貨、パーセント項目で、小数点の右に入力できる桁数合計です。たとえば、4.98 の場合は 2 となります。これ以上の桁の数値を入力した場合は、四捨五入されます。たとえば、[小数点の位置]が 2 の場合に 4.986 と入力すると、その数値は 4.99 となります。Salesforceでは、切り上げアルゴリズムを使用します。中間値は常に切り上げられます。たとえば、1.45 は 1.5 に切り上げられます。–1.45 は –1.5 に切り上げられます。

連動項目対応する制御項目で選択された値に基づいて、使用可能な値が表示される、カスタムの選択リストまたは複数選択の選択リストの項目。

Developer Force

Developer Force Web サイト ( developer.force.com) では、サンプルコード、ツールキット、オンライン開発者コミュニティなど、プラットフォーム開発者向けの幅広いリソースを提供しています。開発向けのForce.comプラットフォーム環境も、ここから入手できます。

ドキュメントライブラリドキュメントの保存場所です。これらのドキュメントは、取引先や取引先責任者、商談、またはその他のレコードに添付しません。

521

用語集


Eメールアラート

メールアラートは、メールテンプレートを使用してワークフロールールまたは承認プロセスによって生成され、Salesforce ユーザなど、指定された受信者に送信されるワークフローおよび承認アクションです。

Enterprise WSDL

Salesforce 組織のみでインテグレーションを構築する顧客や、Tibco、webMethods などのツールを使って強い型キャストが必要なインテグレーションを構築するパートナー向けの強い型付けの WSDL。EnterpriseWSDL の欠点は、組織のデータモデルに存在するすべての一意のオブジェクトおよび項目にバインドされているため、1 つの Salesforce 組織のスキーマだけを扱うという点です。

エンティティ関係図 (ERD)

データをエンティティ (または Force.com プラットフォームではオブジェクト) に整理し、それらのリレーションを定義することができるデータモデリングツールです。主要な Salesforce オブジェクトの ERD ダイアグラムについては、『SOAP API 開発者ガイド』を参照してください。

列挙項目列挙は、WSDL での選択項目と同じです。項目の有効な値は、同じデータ型を持つ指定可能な値のセットに厳密に制限されます。

F項目

テキストまたは通貨の値など、情報の特定の部分を保持するオブジェクトの一部です。

項目レベルセキュリティ項目が、ユーザに非表示、表示、参照のみ、または編集可能であるかどうかを決定する設定です。EnterpriseEdition、Unlimited Edition、Performance Edition、Developer Edition でのみ使用できます。

検索条件リストビューまたはレポートに含まれる項目を絞り込むための、特定の項目に対する条件。たとえば「都道府県」「次の文字列と一致する」「東京都」など。

Force.com

アプリケーションを構築する salesforce.com プラットフォームです。Force.com は、強力なユーザインターフェース、オペレーティングシステムおよびデータベースを結合して、企業全体でアプリケーションをカスタマイズおよび展開できます。

Force.com IDE

開発者が Eclipse 開発環境で Force.com アプリケーションを管理、作成、デバッグおよびリリースできるEclipse プラグイン。

Force.com 移行ツールローカルファイルシステムと Salesforce 組織との間で Force.com コンポーネントを移行する Apache の Ant 開発スクリプトを作成するためのツールキット。

外部キー値が別のテーブルの主キーと同じ項目です。外部キーは、別のテーブルの主キーのコピーとしてみなすことができます。2 つのテーブルのリレーションは、あるテーブルの外部キーの値と、別のテーブルの主キーの値が一致することによって成り立ちます。

522

用語集

http://developerforcejp.s3.amazonaws.com/developer/docs/api/index.htm

数式項目カスタム項目の一種。差し込み項目、式、またはその他の値に基づいて、値を自動的に計算します。

関数あらかじめ用意されている数式。入力パラメータを使用してカスタマイズできます。たとえば、DATE 関数は、年、月、および日付から日付データ型を作成します。

Gグレゴリオ暦

世界中で使用されている、12 か月構造に基づいたカレンダーです。

HHTTP デバッガ

AJAX Toolkitから送信される SOAP 要求を識別し、調査するために使用できるアプリケーションです。ローカルコンピュータで稼動するプロキシサーバとして動作し、各要求を調査および認証できます。

IID

「Salesforce レコード ID」を参照してください。

インライン Sコントロール


個別のページでなく、レコード詳細ページまたはダッシュボード内に表示される Sコントロールです。

インスタンス組織のデータをホストし、アプリケーションを実行する単一の論理サーバとして示されるソフトウェアおよびハードウェアのクラスタです。Force.com プラットフォームは複数のインスタンスで稼動しますが、1つの組織のデータは常に 1 つのインスタンスに一元管理されています。

インテグレーションユーザクライアントアプリケーションまたはインテグレーションのみに定義されたSalesforceユーザ。また、SOAPAPI コンテキストではログインユーザとも呼ばれます。

ISO コード国際標準化機構が定める国コードで、各国を 2 文字で表します。

J連結オブジェクト

2 つの主従関係を持つカスタムオブジェクトです。カスタム連結オブジェクトを使用して、2 つのオブジェクト間の「多対多」リレーションをモデル化できます。たとえば、「バグ」という名前のカスタムオブジェクトを作成し、1 つのバグを複数のケースに、また 1 つのケースを複数のバグに関連付けることができます。

523

用語集

K該当用語はありません。

Lライセンス管理アプリケーション (LMA)

無料の AppExchange アプリケーションで、AppExchange から管理パッケージ (アプリケーション) をダウンロードするすべてのユーザのセールスリードおよび取引先を追跡できます。

ライセンス管理組織 (LMO)

パッケージをインストールしたすべての Salesforceユーザを追跡できる、Salesforce組織です。ライセンス管理組織には、ライセンス管理アプリケーション (LMA) をインストールする必要があります。ライセンス管理アプリケーションは、パッケージがインストールまたはアンインストールされるたびに自動的に通知を受信するため、簡単にユーザにアップグレードを通知できます。Enterprise Edition、Unlimited Edition、Performance Edition、または Developer Edition の組織をライセンス管理組織として指定できます。詳細は、http://www.salesforce.com/docs/en/lma/index.htm を参照してください。

リストビュー特定の条件による項目 (取引先、または取引先責任者など) のリスト表示。Salesforce には、事前に定義されたビューがあります。エージェントコンソールでは、リストビューが、具体的な条件に基づいてレコードのリストビューを表示する最上位のフレームです。[コンソール] タブに表示して選択できるリストビューは、各オブジェクトのタブで定義されたリストビューと同じです。コンソール内でリストビューを作成することはできません。

ローカルプロジェクトプロジェクトマニフェスト (package.xml) および 1 つ以上のメタデータコンポーネントを含む .zipファイルです。

ログインユーザSOAP API コンテキストで、Salesforce にログインするために使用するユーザ名。クライアントアプリケーションは、ログインユーザの権限および共有設定に基づいて動作します。また、インテグレーションユーザとも呼ばれます。

参照項目別のレコードに対するリンク可能な値を含む項目の種別です。オブジェクトに別のオブジェクトとの参照関係または主従関係がある場合、ページレイアウトに参照項目を表示できます。たとえば、ケースに納入商品との参照関係がある場合、ケース詳細ページからルックアップダイアログを使用して納入商品を選択し、ケース詳細ページから納入商品の名前をクリックできます。

M管理パッケージ

ユニットとして AppExchange に投稿され、名前空間と、場合によりライセンス管理組織に関連付けられるアプリケーションコンポーネントの集合です。アップグレードをサポートするには、管理パッケージであることが必要です。組織は、他の多くの組織でダウンロードおよびインストールできる単一の管理パッケージを作成できます。管理パッケージは、未管理パッケージとは異なり、コンポーネントの一部がロックされていて、後でアップグレードできます。未管理パッケージには、ロックされたコンポーネントは含まれておらず、アップグレードはできません。また、管理パッケージでは、開発者の知的財産保護のため、登録している組織では特定のコンポーネント (Apex など) は隠されます。

524

用語集

http://www.salesforce.com/docs/en/lma/index.htm

マニフェストファイルプロジェクトマニフェストファイル (package.xml) には、メタデータ API、またはメタデータ API の上に構築された Force.com IDE または Force.com 移行ツールなどのクライアントを使用するときに取得またはリリースする XML コンポーネントがリストされます。

手動による共有レコード所有者がレコードにアクセス権を持たないユーザに参照権限および編集権限を与えることができるレコードレベルのアクセスルールです。

多対多リレーションリレーションの両端に多くの子があるリレーションです。多対多リレーションは、連結オブジェクトを使用して実装されます。

メタデータ組織およびいずれかの部署の構造、外観、機能に関する情報です。Force.com では、メタデータを記述するのに XML を使用します。

メタデータ WSDL

Force.com Metadata API コールを使用するユーザの WSDL。

マルチテナンシーすべてのユーザおよびアプリケーションが単一で共通のインフラストラクチャおよびコードベースを共有するアプリケーションモデルです。

N名前空間

パッケージコンテキストでは、ドメイン名と同様、AppExchangeにある自社パッケージとその内容を他の開発者のパッケージと区別するための 1 ～ 15 文字の英数字で構成される識別子です。Salesforceでは、Salesforce組織のすべての一意のコンポーネント名に自動的に名前空間プレフィックスとそれに続く 2 つのアンダースコア (__) を追加します。

ネイティブアプリケーションForce.com の設定 (メタデータ) 定義で排他的に開発されたアプリケーションです。ネイティブアプリケーションには、外部サービスまたは外部インフラストラクチャは必要ありません。

Oオブジェクト

Salesforce 組織に情報を保存するために使用するオブジェクト。オブジェクトは、保存する情報の種類の全体的な定義です。たとえば、Case オブジェクトを使用して、顧客からの問い合わせに関する情報を保存できます。各オブジェクトについて、組織は、そのデータ型の具体的なインスタンスに関する情報を保存する複数のレコードを保有します。たとえば、佐藤次郎さんから寄せられたトレーニングに関する問い合わせに関する情報を保存するケースレコードと、山田花子さんから寄せられたコンフィグレーションの問題に関する情報を保存するケースレコードなどです。

オブジェクトレベルのヘルプカスタムオブジェクトに提供できるカスタムヘルプのテキスト。カスタムオブジェクトレコードのホーム(概要)、詳細、編集ページ、リストビューや関連リストに表示されます。

525

用語集

オブジェクトレベルセキュリティ特定のユーザに対してオブジェクト全体を非表示にできる設定です。ユーザはそうしたデータの存在を知ることもできません。オブジェクトレベルセキュリティはオブジェクト権限で指定されます。

onClick JavaScript

ボタンまたはリンクをクリックすると実行される JavaScript コードです。

一対多リレーション1 つのオブジェクトが多数のオブジェクトに関連するリレーションです。たとえば、取引先に 1 つまたは複数の関連取引先責任者がある場合があります。

組織の共有設定ユーザが組織で持つデータアクセスのベースラインレベルを指定できる設定です。たとえば、オブジェクト権限によって有効化されている特定のオブジェクトの任意のレコードを参照できますが、編集するには別の権限が必要となるよう、組織の共有設定を設定できます。

アウトバウンドメッセージアウトバウンドメッセージは、外部サービスなどの指定したエンドポイントに指定の情報を送信するワークフロー、承認、およびマイルストンアクションです。アウトバウンドメッセージは、エンドポイントに対し、特定の項目内のデータを SOAP メッセージとして送信します。アウトバウンドメッセージは、Salesforceの設定メニューで設定します。その後で、外部エンドポイントを設定する必要があります。SOAP APIを使用して、メッセージのリスナーを作成できます。

フロート表示ユーザインターフェースの要素にマウスポインタを停止すると、フロート表示に追加情報が表示されます。フロート表示によって、マウスを移動したり、フロート表示外部をクリックしたり、または [閉じる] ボタンをクリックしたりすると、フロート表示が閉じられます。

所有者レコード (取引先責任者またはケースなど) が割り当てられる個別ユーザ。

Pパッケージ

AppExchangeを介して他の組織で使用可能なForce.comのコンポーネントおよびアプリケーションのグループです。AppExchangeにまとめてアップロードできるように、パッケージを使用してアプリケーションおよび関連するコンポーネントをバンドルします。

Partner WSDL

複数の Salesforce 組織にまたがって動作するインテグレーションや AppExchange アプリケーションを構築する場合に顧客、パートナー、ISV が使用する、弱い型付けの WSDL。この WSDL では、開発者が適切なオブジェクト表現でデータのマーシャリングを行います。通常、ここには XML の編集が含まれます。ただし、開発者は特定のデータモデルまたは Salesforce 組織に依存しません。強い型付けの Enterprise WSDL とは対照的です。

選択リストSalesforce オブジェクトの特定の項目で選択できる選択肢のリスト。たとえば、取引先の Industry項目など。ユーザは、項目に直接入力せずに、選択リストから 1 つの値を選択できます。「マスタ選択リスト」も参照してください。

526

用語集

選択リスト (複数選択)

Salesforce オブジェクトの特定の項目で選択できる選択肢のリストです。複数選択の選択リストを使用して1 つまたは複数の値を選択できます。ユーザは値をダブルクリックして選択するか、Ctrl キーを押したまま値をクリックしてスクロールリストから複数の値を選択し、矢印アイコンを使用して選択されたボックスに値を移動できます。

主キーリレーショナルデータベースのコンセプトです。リレーショナルデータベースの各テーブルには、データ値が一意にレコードを識別する項目があります。この項目を、主キーと呼びます。2 つのテーブルのリレーションは、あるテーブルの外部キーの値と、別のテーブルの主キーの値が一致することによって成り立ちます。

本番組織実際の本番データとそれらにアクセスするライブユーザを持っている Salesforce 組織。

Qキュー

処理する前にアイテムを置いておく領域です。Salesforce では、さまざまな機能やテクノロジーにキューを使用します。

クエリ文字列パラメータ通常 URL の「?」文字の後に指定されている名前 - 値のペアです。次に例を示します。

http://na1.salesforce.com/001/e?name=value

Rレコード

Salesforce オブジェクトの単一インスタンス。たとえば、「John Jones」は取引先責任者レコードの名前となります。

レコード名すべての Salesforce オブジェクトの標準項目。レコード名が Force.com アプリケーションに表示されると、値はレコードの詳細ビューへのリンクとして表示されます。レコード名は自由形式のテキストまたは自動採番項目です。[レコード名]には、必ずしも一意の値を割り当てる必要はありません。

レコードタイプレコードタイプとは、そのレコードの標準およびカスタムの選択リスト項目の一部またはすべてを含めることができる特定のレコードに使用可能な項目です。レコードタイプをプロファイルに関連付けて、含まれている選択リストの値のみがそのプロファイルのユーザに使用できるようにできます。

レコードレベルセキュリティデータを制御するメソッドで、特定のユーザがオブジェクトを参照および編集でき、ユーザが編集できるレコードを制限できます。

ごみ箱削除した情報を表示し、復元できるページです。ごみ箱には、サイドバー内のリンクからアクセスします。

527

用語集

関連オブジェクト特定のタイプのレコードがコンソールの詳細ビューに表示されている状況で、システム管理者がエージェントコンソールのミニビューへの表示を指定できるオブジェクトです。たとえば、システム管理者は、ケースが詳細ビューに表示されているときにミニビューに表示される項目として、関連する取引先、取引先責任者、納入商品などを指定できます。

リレーションページレイアウト内の関連リストおよびレポート内の詳細レベルを作成するために使われる、2 つのオブジェクトの間の接続です。両方のオブジェクトの特定の項目において一致する値を使用して、関連するデータにリンクします。たとえば、あるオブジェクトには会社に関連するデータが保存されていて、別のオブジェクトには人に関連するデータが保存されている場合、リレーションを使用すると、その会社で働いている人を検索できます。

リレーションクエリSOQL コンテキストで、オブジェクト間のリレーションを辿り、結果を識別および返すクエリです。親対子および子対親の構文は、SOQL クエリでは異なります。

レポートタイプレポートタイプは、主オブジェクトとその関連オブジェクトとの関係に基づいて、レポートで使用するレコードと項目のセットを定義するものです。レポートには、レポートタイプで定義された条件を満たすレコードのみが表示されます。Salesforceには、定義済みの標準レポートタイプのセットが用意されています。管理者がカスタムレポートタイプを作成することもできます。

ロール階層レコードレベルのセキュリティで使用される設定。ロール階層によって特定のレベルのロールを割り当てられたユーザは、組織の共有モデルとは関係なく、階層において自分よりも下位のユーザが所有しているデータ、および該当のユーザと共有しているデータに対する参照、編集権限を持つことになります。

積み上げ集計項目主従関係の子レコードの値の集計値を自動的に提供する項目の種別です。

SSaaS

「サービスとしてのソフトウェア (SaaS)」を参照してください。

Sコントロール


カスタムリンクで使用するカスタム Web コンテンツ。カスタム Sコントロールには、Java アプレット、Active-X コントロール、Excel ファイル、カスタム HTML Web フォームなど、ブラウザに表示できるあらゆる種類のコンテンツを入れることができます。

Salesforce レコード ID

Salesforce の 1 つのレコードを識別する 15 文字または 18 文字の一意の英数字文字列。

528

用語集

Salesforce SOA (サービス指向アーキテクチャ)

Apex 内から外部 Web サービスへのコールを実行できる Force.com の強力な機能です。

Sandbox 組織Salesforce 本番組織のほぼ同一コピーです。テストやトレーニングなどさまざまな目的のために、本番組織のデータとアプリケーションに影響を与えることなく、複数のSandboxをそれぞれの環境に作成できます。

セッション ID

ユーザがSalesforceに正常にログインした場合に返される認証トークンです。セッション ID を使用すると、ユーザがSalesforceで別のアクションを実行するときに毎回ログインする必要がなくなります。レコード IDまたは Salesforce ID と異なり、Salesforce レコードの一意の ID を示す用語です。

セッションタイムアウトログインしてからユーザが自動的にログアウトするまでの時間です。セッションは、前もって決定された非活動状態の期間の後、自動的に終了します。非活動状態の期間の長さは、Salesforceの [設定] から [セキュリティのコントロール] をクリックして設定できます。デフォルト値は 120 分 (2 時間) です。ユーザが Webインターフェースでアクションを実行または API コールを実行すると、非活動状態タイマーが 0 にリセットされます。

設定システム管理者が組織の設定およびForce.comアプリケーションをカスタマイズおよび定義できるメニューです。組織のユーザインターフェース設定に応じて、[設定] はユーザインターフェースのヘッダーでリンクになっている場合もあれば、ユーザ名の下でドロップダウンリストになっている場合もあります。

サイトForce.com サイトでは、公開 Web サイトとアプリケーションを作成できます。それらは Salesforce 組織と直接統合されるため、ユーザがログインする場合にユーザ名やパスワードは必要ありません。

スニペット

メモ: Sコントロールは、Visualforceページに置き換えられました。2010 年以降、新しい組織同様、Sコントロールを作成したことのない組織は、Sコントロールを作成できなくなります。既存の Sコントロールに影響はありません。引き続き編集できます。

スニペットは、他の Sコントロールに組み込めるよう設計された Sコントロールです。コードの一部で他のメソッドによって使用されるヘルパーメソッドと同様、スニペットを使用して、複数の Sコントロールで再利用できる HTML や JavaScript の 1 つのコピーを保持できます。

SOAP (Simple Object Access Protocol)

XML エンコードデータを渡す一定の方法を定義するプロトコル。

サービスとしてのソフトウェア (SaaS)

ソフトウェアアプリケーションがサービスとしてホストされ、顧客にインターネットを経由して提供される配信モデルです。SaaS ベンダは、アプリケーションおよび各顧客データの日常メンテナンス、操作およびサポートを行う責任があります。このサービスで、顧客が独自のハードウェア、ソフトウェア、そして関連 IT リソースを使用してアプリケーションをインストール、構成、保守する必要性を緩和します。SaaSモデルを使用して、あらゆる市場区分にサービスを配信することができます。

529

用語集

SOQL (Salesforce オブジェクトクエリ言語)

Force.com データベースからデータを選択する条件を指定するために使う、単純で強力なクエリ文字列を構築できるクエリ言語です。

SOSL (Salesforce オブジェクト検索言語)

Force.com API を使用して、テキストベースの検索を実行できるクエリ言語。

標準オブジェクトForce.com プラットフォームに含まれる組み込みオブジェクトです。アプリケーション独自の情報を格納するカスタムオブジェクトを作成することもできます。

システムログ開発者コンソールの一部。コードスニペットのデバッグに使用できる独立したウィンドウ。ウィンドウの下部にテストするコードを入力して、[実行] をクリックします。システムログの本文には、実行する行の長さや、作成されたデータベースコール数などのシステムリソース情報が表示されます。コードが完了しなかった場合は、コンソールにデバッグ情報が表示されます。

TTest メソッド

特定のコードが適切に動作しているかを確認する Apex クラスメソッドです。Test メソッドは引数を採用せず、データをデータベースにコミットしません。また、コマンドラインまたはForce.com IDEのようなApexIDE で runTests()システムメソッドによって実行できます。

トランスレーションワークベンチトランスレーションワークベンチを使用して、翻訳する言語を指定し、翻訳者を言語に割り当て、Salesforce組織に作成したカスタマイズの翻訳を作成し、管理対象パッケージから表示ラベルと翻訳を上書きすることができます。カスタム選択リスト値からカスタム項目にいたるすべてを翻訳し、海外のユーザがSalesforceのすべてを彼らの言語で使用できるようになりました。

トリガデータベースの特定の種別のレコードが挿入、更新、または削除される前後で実行する Apex スクリプトです。各トリガは、トリガが実行されるレコードへのアクセス権限を提供する一連のコンテキスト変数で実行し、すべてのトリガは一括モードで実行します。つまり、一度に 1 つずつレコードを処理するのではなく、複数のレコードを一度に処理します。

トリガコンテキスト変数トリガおよびトリガが起動するレコードに関する情報へのアクセス権を提供するデフォルトの変数です。

U

V入力規則

指定される基準に一致しない場合、レコードを保存しない規則です。Visualforce

開発者が、プラットフォームに作成されたアプリケーションのカスタムページおよびコンポーネントを容易に定義できる、単純で、タグベースのマークアップ言語。各タグが、ページのセクション、関連リスト、または項目など、大まかなコンポーネントときめの細かいコンポーネントのどちらにも対応しています。

530

用語集

コンポーネントは、標準の Salesforce ページと同じロジックを使用して制御することができます。また、開発者が独自のロジックを Apex で記述されたコントローラと関連付けることもできます。

WWeb コントロール

「URL Sコントロール」を参照してください。

Web サービス様々なプラットフォームで稼動、さまざまな言語で作成、またはお互い地理的に離れている場合であっても、2 つのアプリケーションがインターネットを経由してデータを容易に交換できるメカニズムです。

WebService メソッドサードパーティのアプリケーションのマッシュアップなど、外部システムによって使用できる Apex クラスメソッドまたは変数です。Web サービスメソッドは、グローバルクラスで定義する必要があります。

Web サービス API

Salesforce組織の情報へのアクセスを提供する Web サービスアプリケーションプログラミングインターフェース。「SOAP API」および「Bulk API」も参照してください。

Web タブユーザがアプリケーション内から外部 Web サイトを使用できるカスタムタブです。

ワークフローアクションワークフローアクション (メールアラート、項目自動更新、アウトバウンドメッセージ、ToDo など) は、ワークフロールールの条件が満たされると起動します。

ワークフローメールアラートワークフロールールが起動したときにメールを送信するワークフローアクションです。ワークフロー ToDoと異なり、アプリケーションユーザにのみ割り当てることができ、ワークフローアラートは有効なメールアドレスがある限り、ユーザまたは取引先責任者に送信できます。

ワークフロー項目自動更新ワークフロールールが起動したときに、レコードの特定の項目の値を変更するワークフローアクションです。

ワークフローアウトバウンドメッセージ別のクラウドコンピューティングアプリケーションなど、外部 Web サービスにデータを送信するワークフローアクションです。アウトバウンドメッセージは、主に複合アプリケーションで使用されます。

ワークフローキュー1 つ以上の時間ベースワークフローアクションがあるワークフロールールに基づいて起動するようスケジュールされている、ワークフローアクションのリストです。

ワークフロールールワークフロールールは、指定された条件に該当するときに、ワークフローアクションを実行します。ワークフローアクションは、ワークフロールールで指定された条件をレコードが満たすとただちに実行するか、タイムトリガを設定して特定の日に実行するように設定することができます。

531

用語集

ワークフロー ToDo

ワークフロールールが起動したときに ToDo をアプリケーションユーザに割り当てるワークフローアクション。

WSDL (Web Services Description Language) ファイルWeb サービスと送受信するメッセージの形式を説明する XML ファイルです。開発環境の SOAP クライアントは、Salesforce Enterprise WSDL または Partner WSDL を使用して、SOAP API で Salesforce と通信します。

XXML (拡張可能マークアップ言語)

構造化データの共有と移動を可能にするマークアップ言語です。メタデータ API を使用して取得またはリリースされるすべての Force.com コンポーネントは、XML 定義に従って表されます。

Y該当用語はありません。

ZZip ファイル

データ圧縮およびアーカイブの形式です。メタデータ API によって取得またはリリースされるファイルの集合です。「ローカルプロジェクト」も参照してください。

532

用語集