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

メタデータ API 開発者ガイド
バージョン 32.0, Winter ’15
@salesforcedocs
最終更新日: 2014/11/5
© Copyright 2000–2014 salesforce.com, inc. All rights reserved. Salesforce およびその他の名称や商標は、salesforce.com,
inc. の登録商標です。本ドキュメントに記載されたその他の商標は、各社に所有権があります。
目次
はじめに
.........................................................1
第 1 章: メタデータ API について . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
サポート対象の Salesforce のエディション
開発プラットフォーム . . . . . . . . . . . . . . .
標準への準拠 . . . . . . . . . . . . . . . . . . . . . .
メタデータ API サポートポリシー . . . . . . .
関連リソース . . . . . . . . . . . . . . . . . . . . . .
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
2
2
2
3
4
第 2 章: クイックスタート . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
前提条件 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
ステップ 1: 組織の Web サービス WSDL の生成または取得 . . . . . . . . . . . . . . . . . . . . . . . . 6
ステップ 2: 開発プラットフォームへの WSDL ファイルのインポート . . . . . . . . . . . . . . . . 6
ステップ 3: Java サンプルコードの説明 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
メタデータ API の使用
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
第 3 章: メタデータのリリースと取得 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Zip ファイルの使用 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
package.xml マニフェストファイルのサンプル . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
リリースでのテストの実行 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
ユーザ参照の保持 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
第 4 章: CRUD ベースのメタデータ開発 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
第 5 章: エラー処理 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
セッション終了のエラー処理 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
参照
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
第 6 章: ファイルベースのコール . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
deploy() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
checkDeployStatus() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
cancelDeploy() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
retrieve() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
RetrieveRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
checkRetrieveStatus() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
第 7 章: CRUD ベースのコール . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
createMetadata() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
目次
readMetadata() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
updateMetadata() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
upsertMetadata() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
deleteMetadata() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
renameMetadata() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
create() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
delete() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
update() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
第 8 章: ユーティリティコール . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
checkStatus() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
describeMetadata() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
listMetadata() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
ListMetadataQuery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
第 9 章: Result オブジェクト . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
AsyncResult . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
CancelDeployResult . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
DeployResult . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
DescribeMetadataResult . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
ReadResult . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
RetrieveResult . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
SaveResult . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
DeleteResult . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
UpsertResult . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
Error . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
第 10 章: メタデータ型 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
Metadata コンポーネントおよびメタデータ型 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
サポートされていないメタデータ型 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
メタデータ API リリースの特殊な動作 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
AnalyticSnapshot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
ArticleType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
ArticleType レイアウト . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
ArticleType CustomField . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
ApexClass . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
ApexComponent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
ApexPage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
ApexTrigger . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
AppMenu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
ApprovalProcess . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
AssignmentRules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
AuthProvider . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
AutoResponseRules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
目次
CallCenter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
Community (Zone) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
ConnectedApp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
CorsWhitelistOrigin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179
CustomApplication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
CustomApplicationComponent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
CustomLabels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
CustomObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
ActionOverride . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213
BusinessProcess . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
CompactLayout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217
CustomField . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219
FieldSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230
ListView . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231
NamedFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235
Picklist (連動選択リストを含む) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238
RecordType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245
SearchLayouts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247
SharingReason . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251
SharingRecalculation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252
ValidationRule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252
Weblink . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254
メタデータのデータ型 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259
CustomObjectTranslation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261
CustomPageWebLink . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271
CustomPermission . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275
CustomSite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277
CustomTab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283
Dashboard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286
DataCategoryGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304
Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310
EmailTemplate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313
EntitlementProcess . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317
EntitlementTemplate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 322
EscalationRules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323
ExternalDataSource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 327
FlexiPage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 330
Flow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 333
Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 362
FolderShare . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 364
Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 367
HomePageComponent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 368
HomePageLayout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 370
InstalledPackage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371
目次
Layout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 372
Letterhead . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 394
LiveChatAgentConfig . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 397
LiveChatButton . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 402
LiveChatDeployment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 406
ManagedTopics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 408
Metadata . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 410
MetadataWithContent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 410
MilestoneType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 411
Network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 412
Package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 423
PermissionSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 425
Portal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 433
PostTemplate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 435
Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 437
Queue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 452
QuickAction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 453
RemoteSiteSetting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 459
Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 460
ReportType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 490
Role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 494
RoleOrTerritory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 495
SamlSsoConfig . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 498
Scontrol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 501
設定 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 503
AccountSettings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 505
ActivitiesSettings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 507
AddressSettings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 511
BusinessHoursSettings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 516
CaseSettings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 520
ChatterAnswersSettings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 528
CompanySettings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 530
ContractSettings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 532
EntitlementSettings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 532
ForecastingSettings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 535
IdeasSettings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 539
KnowledgeSettings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 541
LiveAgentSettings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 545
MobileSettings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 546
OpportunitySettings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 550
OrderSettings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 551
ProductSettings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 552
QuoteSettings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 553
SecuritySettings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 554
目次
Territory2Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 561
SharedTo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 562
SharingRules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 565
BaseSharingRule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 570
CriteriaBasedSharingRule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 571
OwnerSharingRule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 577
SharingSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 584
SiteDotCom . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 588
Skill . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 589
StaticResource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 591
SynonymDictionary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 592
Territory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 594
Territory2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 596
Territory2Model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 601
Territory2Rule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 603
Territory2Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 606
Translations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 607
Workflow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 614
XOrgHub . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 629
XOrgHubSharedObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 630
付録
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 632
付録 A: CustomObjectTranslation の言語サポート — 完全サポート対
象言語 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 632
付録 B: CustomObjectTranslation の言語サポート — エンドユーザ言
語 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 637
用語集
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 643
はじめに
第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.com IDE または
Force.com 移行ツールについての詳細は、developer.salesforce.com を参照してください。
メタデータ API の基礎となるコールは、独自のクライアントアプリケーションを構築する必要があるユーザが
直接使用できるよう公開されています。このガイドでは、メタデータ API を直接使用する方法について詳しく
説明します。
メタデータ API を使用して、組織の情報 (メタデータ) の設定とカスタマイズを管理できます。次に例を示しま
す。
• 組織のカスタマイズを XML メタデータファイルとしてエクスポートします。「Zip ファイルの使用」および
「retrieve()」を参照してください。
• 組織間で設定の変更を移行します。「deploy()」および「retrieve()」を参照してください。
• XML メタデータファイルを使用して組織の既存のカスタマイズを変更します。「deploy()」および
「retrieve()」を参照してください。
• 組織のカスタマイズをプログラムで管理します。「CRUD ベースのメタデータ開発」を参照してください。
Developer Edition または Sandbox でテスト組織のメタデータを変更し、Enterprise Edition、Unlimited Edition、または
Performance Edition でテスト済みの変更を本番組織にリリースできます。また、カスタムオブジェクト、カスタ
ム項目およびその他のコンポーネントを使用して新しい組織を入力するスクリプトも作成できます。
関連トピック:
メタデータのリリースと取得
CRUD ベースのメタデータ開発
Metadata コンポーネントおよびメタデータ型
1
メタデータ API について
サポート対象の Salesforce のエディション
サポート対象の Salesforce のエディション
メタデータ API を使用するには、Enterprise Edition、Unlimited Edition、Performance Edition、または Developer Edition を
使用する必要があります。既存の Salesforce のお客様が Enterprise Edition、Unlimited Edition、または Performance Edition
にアップグレードする場合は、担当者にご連絡ください。
本番組織の厳密なレプリカである Sandbox を使用することを強くお勧めします。Enterprise Edition、Unlimited Edition、
および Performance Edition には無料の開発者 Sandbox が付属しています。詳細は、
http://www.salesforce.com/platform/cloud-infrastructure/sandbox.jspを参照してください。
また、ユーザは Enterprise Edition で使用できるすべての機能へのアクセスを提供する Developer Edition 組織を使用
できます。ただし、ユーザ数およびストレージ容量には制限があります。Developer Edition 組織は、本番組織の
コピーではありませんが、組織のデータに影響を与えることなくソリューションを構築およびテストできる環
境を提供します。Developer Edition のアカウントは、http://developer.salesforce.com/signup から無料
で入手できます。
メモ: メタデータコンポーネントは、メタデータ API がメタデータコンポーネントに対して動作するよう
に組織で参照可能になっている必要があります。また、ユーザはメタデータコンポーネントへのアクセ
ス権を持つには、「API の有効化」権限も必要です。
開発プラットフォーム
メタデータ API では、ファイルベースおよび CRUD ベースの開発の両方をサポートしています。
ファイルベースの開発
宣言型またはファイルベースの非同期のメタデータ API である deploy() 操作および retrieve() 操作では、
フォルダのセットでコンポーネントを保持する .zip ファイルおよび package.xml という名前のマニフェス
トファイルをリリースまたは取得します。詳細は、「メタデータのリリースと取得」 (ページ 16)を参照して
ください。Force.com IDE または Force.com 移行ツールを使用すると、最も簡単にファイルベースの機能にアクセ
スできます。
CRUD ベースの開発
CRUD メタデータ API コールは、Enterprise WSDL の同期 API コールによるオブジェクトに対する動作と同様にメタ
データコンポーネントに対して動作します。Enterprise WSDL についての詳細は、『SOAP API 開発者ガイド』を参
照してください。
標準への準拠
メタデータ API は、次の仕様に準拠するよう実装されています。
標準名
Web サイト
Simple Object Access Protocol (SOAP) 1.1
http://www.w3.org/TR/2000/NOTE-SOAP-20000508/
2
メタデータ API について
標準名
メタデータ API サポートポリシー
Web サイト
Web Service Description Language (WSDL) http://www.w3.org/TR/2001/NOTE-wsdl-20010315
1.1
WS-I Basic Profile 1.1
http://www.ws-i.org/Profiles/BasicProfile-1.1-2004-08-24.html
メタデータ 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 年を超えるバージョンのサポートは停止される場合があります。
APIバージョンに廃止の予定がある場合、サポートが終了する最低 1 年前までに事前通知されます。Salesforce.com
は、廃止予定の API バージョンを使用するお客様に直接通知します。
3
メタデータ API について
関連リソース
関連リソース
salesforce.com 開発者 Web サイトでは、開発者ツールキット、サンプルコード、サンプル SOAP メッセージ、コ
ミュニティベースのサポート、およびその他のリソースの完全パッケージを提供して、開発プロジェクトを支
援します。詳細は、https://developer.salesforce.com/page/Getting_Started を参照してください。
http://developer.salesforce.com/signup からは、Developer Edition のアカウントを無料で取得できます。
以下の Web サイトにアクセスすると、Salesforce アプリケーションの詳細情報を入手できます。
• Developer Force では、開発者にとって有益な情報を提供しています。
• Salesforce.com では、Salesforce アプリケーションの詳細情報が提供されています。
• Force.com AppExchange では、Salesforce 向けに作成されたアプリケーションにアクセスできます。
• Salesforce.com Community では、Salesforce のお客様の成功を実現するサービスが提供されています。
4
第2章
クイックスタート
Force.com IDEまたはForce.com 移行ツールを使用すると、最も簡単にメタデータ APIの機能にアクセスできます。
これらのツールはメタデータ API の上位に構築され、メタデータ API との連携タスクを簡略化するために標準
Eclipse および Ant ツールを使用します。Eclipse プラットフォームで開発された Force.com IDE は、統合された開発
環境に慣れているプログラマに快適な環境を提供し、IDE 内でコード記述、コンパイル、テスト、リリースの
すべてを行うことができます。Force.com 移行ツールは、スクリプトまたはコマンドラインユーティリティを使
用してローカルディレクトリと Salesforce 組織間でメタデータを移動する場合に最適です。Force.com IDE または
Force.com 移行ツールについての詳細は、developer.salesforce.com を参照してください。
ただし、メタデータ API の基礎となるコールは、独自のクライアントアプリケーションを構築する必要がある
ユーザが直接使用できるよう公開されています。このクイックスタートでは、組織のカスタマイズを管理する
ためにメタデータ API を直接使用するアプリケーションの作成を開始するのに必要なすべての情報について説
明します。このクイックスタートでは、ファイルベースの開発を開始する方法について説明します。CRUD ベー
スの開発の例については、「同期コールを使用した CRUD ベース開発用の Java サンプル」を参照してください。
前提条件
メタデータ API を使用し始める前に、次の前提条件を必ず実行してください。
• 開発環境を作成します。
本番組織の厳密なレプリカである Sandbox を使用することを強くお勧めします。Enterprise Edition、Unlimited
Edition、および Performance Edition には無料の開発者 Sandbox が付属しています。詳細は、
http://www.salesforce.com/platform/cloud-infrastructure/sandbox.jspを参照してくださ
い。
また、ユーザは Enterprise Edition で使用できるすべての機能へのアクセスを提供する Developer Edition 組織を
使用できます。ただし、ユーザ数およびストレージ容量には制限があります。Developer Edition 組織は、本
番組織のコピーではありませんが、組織のデータに影響を与えることなくソリューションを構築およびテ
ストできる環境を提供します。Developer Edition のアカウントは、
http://developer.salesforce.com/signup から無料で入手できます。
• 「API の有効化」および「すべてのデータの編集」権限を持つユーザを特定します。これらの権限はメタ
データ API コールにアクセスするために必要です。
• SOAP クライアントをインストールします。メタデータ API は、Visual Studio® .NET や Force.com Web Service Connector
(WSC) などに限らず、現在の SOAP 開発環境で動作します。
このドキュメントでは、WSC および JDK 6 (Java Platform Standard Edition Development Kit 6) に基づく Java の例を使
用しています。サンプルを実行するには、まず mvnrepository.com/artifact/com.force.api/force-wsc/ から最新の
5
クイックスタート
ステップ 1: 組織の Web サービス WSDL の生成または取
得
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 ファイルの
場合と同じです。
6
クイックスタート
ステップ 3: Java サンプルコードの説明
Java 環境での使用方法 (WSC)
Java 環境は、サーバ側オブジェクトのプロキシとして機能する Java オブジェクトを使用して、API にアクセス
します。API を使用する前に、まず組織の WSDL ファイルからこれらのオブジェクトを生成する必要がありま
す。
SOAP クライアントには、このプロセスで使用する独自のツールがあります。WSC では、wsdlc ユーティリティ
を使用します。
メモ: wsdlc を実行する前に、システムに WSC JAR ファイルがインストール済みであり、クラスパスで参
照されている必要があります。mvnrepository.com/artifact/com.force.api/force-wsc/ から最新の force-wsc JAR ファ
イルとその連動関係 (連動関係リストはバージョンを選択したときにページに表示されます) をダウンロー
ドできます。
wsdlc の基本構文は、次のとおりです。
java -classpath pathToWsc;pathToWscDependencies com.sforce.ws.tools.wsdlc
pathToWsdl/WsdlFilename pathToOutputJar/OutputJarFilename
たとえば、Window の場合、次のようになります。
java –classpath force-wsc-30.0.0.jar;ST4-4.0.7.jar;antlr-runtime-3.5.jar
com.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.jar
com.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 を変更してください。
7
クイックスタート
ステップ 3: Java サンプルコードの説明
ログインユーティリティ
Java ユーザは、ConnectorConfig を使用して、Enterprise API、Partner API、および Metadata SOAP API に接続でき
ます。MetadataLoginUtil は ConnectorConfig オブジェクトを作成し、Enterprise WSDL の login メソッドを
使用してログインします。次に、sessionId と metadataServerUrl を取得して ConnectorConfig を作成
し、メタデータ API のエンドポイントに接続します。ConnectorConfig は WSC で定義されています。
MetadataLoginUtil クラスは、サンプルの他の部分からログインコードを抽象化するため、Salesforce API ご
とに変更を行わずにこのコードの一部を再利用できます。
import
import
import
import
import
com.sforce.soap.enterprise.EnterpriseConnection;
com.sforce.soap.enterprise.LoginResult;
com.sforce.soap.metadata.MetadataConnection;
com.sforce.ws.ConnectionException;
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/32.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);
}
}
8
クイックスタート
ステップ 3: Java サンプルコードの説明
ファイルベース開発用の Java のサンプルコード
サンプルコードは、ログインユーティリティを使用してログインします。次に、取得、リリース、および終了
のメニューを表示します。
retrieve() コールおよび deploy() コールは両方とも components.zip という名前の .zip ファイルを処理
します。retrieve() コールは組織のコンポーネントを components.zip に取得し、deploy() コールは
components.zip のコンポーネントを組織にリリースします。コンピュータにサンプルを保存して実行する
場合は、後でリリースできる components.zip ファイルを含めることができるように、まず取得オプション
を実行します。retrieve コールの後、サンプルは、操作が完了するまで checkRetrieveStatus() コールをルー
プします。同様に、deploy コールの後、サンプルは、操作が完了するまで checkDeployStatus() チェック
をループします。
retrieve() コールは、マニフェストファイルを使用して組織から取得するコンポーネントを決定します。
package.xml マニフェストファイルのサンプルは次のとおりです。マニフェストファイルの構造についての
詳細は、「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>32.0</version>
</Package>
API コールに続く、エラー処理コードに注意してください。
import
import
import
import
import
import
java.io.*;
java.nio.channels.Channels;
java.nio.channels.FileChannel;
java.nio.channels.ReadableByteChannel;
java.rmi.RemoteException;
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.
9
クイックスタート
ステップ 3: Java サンプルコードの説明
*/
public class FileBasedDeployAndRetrieve {
private MetadataConnection metadataConnection;
private static final String ZIP_FILE = "components.zip";
// manifest file that controls which components get retrieved
private static final String MANIFEST_FILE = "package.xml";
private static final double API_VERSION = 29.0;
// one second in milliseconds
private static final long ONE_SECOND = 1000;
// maximum number of attempts to deploy the zip file
private 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() {
}
private void run() throws Exception {
this.metadataConnection = MetadataLoginUtil.login();
// Show the options to retrieve or deploy until user exits
String choice = getUsersChoice();
while (choice != null && !choice.equals("99")) {
if (choice.equals("1")) {
retrieveZip();
} else if (choice.equals("2")) {
deployZip();
} else {
break;
}
// show the options again
choice = 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");
10
クイックスタート
ステップ 3: Java サンプルコードの説明
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();
} finally {
fileInputStream.close();
}
return result;
}
/*
* Print out any errors, if any, related to the deploy.
* @param result - DeployResult
*/
11
クイックスタート
ステップ 3: Java サンプルコードの説明
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 RetrieveRequest
retrieveRequest.setApiVersion(API_VERSION);
setUnpackaged(retrieveRequest);
AsyncResult asyncResult = metadataConnection.retrieve(retrieveRequest);
RetrieveResult result = waitForRetrieveCompletion(asyncResult);
12
クイックスタート
ステップ 3: Java サンプルコードの説明
if (result.getStatus() == RetrieveStatus.Failed) {
throw new Exception(result.getErrorStatusCode() + " msg: " +
result.getErrorMessage());
} else if (result.getStatus() == RetrieveStatus.Succeeded) {
// Print out any warning messages
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 polls
fetchDetails = (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");
}
13
クイックスタート
ステップ 3: Java サンプルコードの説明
}
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) throws
Exception {
// Wait for the retrieve to complete
int poll = 0;
long waitTimeMilliSecs = ONE_SECOND;
String asyncResultId = asyncResult.getId();
RetrieveResult result = null;
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, 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 elsewhere
File 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 class
com.sforce.soap.metadata.Package p = parsePackageManifest(unpackedManifest);
14
クイックスタート
ステップ 3: Java サンプルコードの説明
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;
}
}
15
メタデータ API の使用
第3章
メタデータのリリースと取得
メタデータ (XML ファイル) を 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 コンポーネントが含まれます。
メモ: コンポーネントは、メタデータ型のインスタンスです。たとえば、CustomObject はカスタムオブ
ジェクトのメタデータ型で、MyCustomObject__c コンポーネントはカスタムオブジェクトのインスタ
ンスです。
.zip で取得またはリリースされるファイルは、組織内にあるパッケージ化されていないコンポーネント (標準オ
ブジェクトなど)、または指定したパッケージ内にあるパッケージコンポーネントである場合があります。
16
メタデータのリリースと取得
Zip ファイルの使用
メモ: メタデータ API は、一度に最大 5,000 個のファイルまたは最大 400 MB をリリースおよび取得できま
す。特定のファイルサイズ制限が適用されていない場合は、非常に大きいファイルではメモリ不足エラー
が発生する可能性があります。
各 .zip ファイルには、プロジェクトマニフェスト、package.xml という名前のファイル、およびコンポーネ
ントを含むディレクトリのセットが含まれます。マニフェストファイルは、.zip ファイルで取得またはリリー
スしようとしているコンポーネント、およびリリースまたは取得で使用される API バージョンを定義します。
package.xml ファイルのサンプルを次に示します。members 要素に fullName 項目値を指定して、メタデー
タ型の個別のコンポーネントを取得できます。または、<members>*</members> を使用して、メタデータ型
のすべてのコンポーネントを取得することもできます。
<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<types>
<members>MyCustomObject__c</members>
<name>CustomObject</name>
</types>
<types>
<members>*</members>
<name>CustomTab</name>
</types>
<types>
<members>Standard</members>
<name>Profile</name>
</types>
<version>32.0</version>
</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 を指定します。
• <name> には、CustomObject または Profile などのメタデータ型が含まれます。ディレクトリの各メタ
データ型には 1 つの名前が定義されています。Metadataを拡張するすべてのメタデータ型は有効な値です。
入力される名前は、メタデータ API WSDL に定義されているメタデータ型に一致する必要があります。リス
トについては、「メタデータ型」を参照してください。
17
メタデータのリリースと取得
package.xml マニフェストファイルのサンプル
• <version> は、.zip ファイルをリリースまたは取得するときに使用される API のバージョン番号です。現在
のところ、有効な値は 32.0 です。
異なるメタデータのサブセットを使用する方法を説明した package.xml マニフェストファイルのその他のサ
ンプルは、「package.xml マニフェストファイルのサンプル」を参照してください。
項目を削除するには、同じ手順を実行します。ただし、destructiveChanges.xml という名前のマニフェス
トファイルの削除も含めてください。ごみ箱をスキップするには、「purgeOnDelete」 を参照してくださ
い。
destructiveChanges.xml の形式は package.xml と同じです。ただし、ワイルドカードはサポートされて
いません。
メモ: 組織に存在しない複数のコンポーネントがファイルに含まれる場合でも、指定した項目のうち組織
に存在する項目は削除されます。
削除対象の単一のカスタムオブジェクトを指定しているサンプルの destructiveChanges.xml ファイルを
次に示します。
<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<types>
<members>MyCustomObject__c</members>
<name>CustomObject</name>
</types>
</Package>
この破壊的な変更をリリースするためには、リリースするコンポーネントがリストされておらず、API バージョ
ンを含み、destructiveChanges.xml と同じディレクトリ内にある package.xml ファイルも必要です。
<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<version>32.0</version>
</Package>
関連トピック:
メタデータ型
package.xml マニフェストファイルのサンプル
このセクションには、異なるメタデータのサブセットを使用する方法を説明する package.xml マニフェスト
ファイルのサンプルが含まれます。マニフェストファイルには、複数の <types> 要素を含めることができる
ため、1 つのバッチですべてのメタデータを使用する場合は、個々のサンプルを 1 つの package.xml マニフェ
ストファイルに組み入れることができます。マニフェストファイルの構造についての詳細は、「Zip ファイル
の使用」を参照してください。次のサンプルがリストされています。
• 標準オブジェクト
• すべてのカスタムオブジェクト
• 標準選択リスト項目
• カスタム項目および標準項目
18
メタデータのリリースと取得
package.xml マニフェストファイルのサンプル
• 標準オブジェクトのリストビュー
• パッケージ
• セキュリティ設定
• 割り当てルール、自動レスポンスルール、エスカーレーションルール
• 管理コンポーネントへのアクセス
標準オブジェクト
この package.xml マニフェストファイルのサンプルでは、標準の Account オブジェクトの使用方法を示しま
す。標準オブジェクトの取得またはリリースには、カスタマイズできない標準項目を除き、すべてのカスタム
項目および標準項目が含まれます。すべてのカスタム項目がサポートされます。カスタマイズできる標準項目
(ヘルプテキストを追加したり、履歴追跡や Chatter フィード追跡を有効にできる標準項目) のみがポートされま
す。システム項目 (CreatedById、LastModifiedDate など)、自動採番項目を含む、その他の標準項目はサ
ポートされません。
<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<types>
<members>Account</members>
<name>CustomObject</name>
</types>
<version>32.0</version>
</Package>
CustomObject タイプのメンバーとして標準の Account オブジェクトを指定することによって、どのようにそれを
使用するかを確認してください。ただし、アスタリスクワイルドカードを使用してすべての標準オブジェクト
を使用することはできません。それぞれの標準オブジェクトを名前で指定する必要があります。
すべてのカスタムオブジェクト
この package.xml マニフェストファイルのサンプルでは、すべてのカスタムオブジェクトの使用方法を示し
ます。
<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<types>
<members>*</members>
<name>CustomObject</name>
</types>
<version>32.0</version>
</Package>
このマニフェストファイルは、すべてのカスタムオブジェクトを取得またはリリースするために使用できま
す。これには、すべての標準オブジェクトは含まれません。
19
メタデータのリリースと取得
package.xml マニフェストファイルのサンプル
標準選択リスト項目
この package.xml マニフェストファイルのサンプルでは、標準の Account オブジェクトの [業種] 選択リスト
項目を使用する方法を示します。
<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<types>
<members>Account.Industry</members>
<name>CustomField</name>
</types>
<version>32.0</version>
</Package>
<members> 項目の objectName.picklistField 構文において、objectName は Account などのオブジェ
クトの名前で、picklistField は [業種] などの標準選択リスト項目名です。
このサンプルのマニフェストファイル package.xml では、OpportunityTeamMember オブジェクトの
TeamMemberRole 選択リストの項目値を使用して、商談チーム内の役割 (取引先チーム内の役割と同じ選択リ
ストの値) を取得する方法を示します。これらの値を取得するには、組織でチームセリングを有効にする必要
があります。
<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<types>
<members>OpportunityTeamMember.TeamMemberRole</members>
<name>CustomField</name>
</types>
<version>32.0</version>
</Package>
メモ: 取得およびリリースできるのは、カスタム項目と標準選択リスト項目および標準参照項目のみで、
他の標準項目はできません。
カスタム項目および標準項目
この package.xml マニフェストファイルのサンプルでは、カスタムオブジェクトおよび標準オブジェクトの
カスタム項目や標準オブジェクトの標準項目の使用方法を示します。
<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<types>
<members>MyCustomObject__c.MyCustomField__c</members>
<name>CustomField</name>
</types>
<types>
<members>Account.SLA__c</members>
<members>Account.Phone</members>
<name>CustomField</name>
</types>
<version>32.0</version>
</Package>
20
メタデータのリリースと取得
package.xml マニフェストファイルのサンプル
<members> 項目の objectName.field 構文において、objectName は、Account などのオブジェクトの名前
で、field は、サービスレベル契約オプションを表す SLA 選択リスト項目などのカスタム項目または標準項
目の名前です。MyCustomObject カスタムオブジェクトの MyCustomField カスタム項目は、その完全名
MyCustomObject__c.MyCustomField__c によって一意に識別されます。同様に、Account 標準オブジェクト
の Phone 標準項目は、その完全名 Account.Phone によって一意に識別されます。
すべてのカスタム項目がサポートされます。カスタマイズできる標準項目 (ヘルプテキストを追加したり、履
歴追跡や Chatter フィード追跡を有効にできる標準項目) のみがポートされます。システム項目 (CreatedById、
LastModifiedDate など)、自動採番項目を含む、その他の標準項目はサポートされません。
標準オブジェクトのリストビュー
標準オブジェクトのリストビューを取得する最も簡単な方法は、オブジェクトを取得することです。リスト
ビューは、取得されたコンポーネントに含まれます。「標準オブジェクト」 (ページ19)を参照してください。
また、オブジェクトのすべての詳細情報を取得しない場合は、個々のリストビューを使用することもできま
す。この package.xml マニフェストファイルのサンプルでは、標準の Account オブジェクトのリストビュー
の使用方法を示します。
<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<types>
<members>Account.AccountTeam</members>
<name>ListView</name>
</types>
<version>32.0</version>
</Package>
<members> 項目の objectName.listViewUniqueName 構文において、objectName は、Account などのオブ
ジェクトの名前で、listViewUniqueName は、リストビューの[ビューの一意の名前]です。リストビューを
取得すると、コンポーネントは、objects/Account.object に保存されます。
パッケージ
パッケージを取得するには、retrieve() をコールするときに、RetrieveRequest の packageNames 項目にパッ
ケージの名前を設定します。package.xml マニフェストファイルは、取得された .zip ファイルに自動的に
格納されます。package.xml の <fullName> 要素には、取得されたパッケージの名前が含まれます。
<members> 要素にアスタリスクワイルドカードを使用して特定のメタデータ型のすべてのコンポーネントを
取得する場合、取得されたコンテンツには管理パッケージのコンポーネントは含まれません。
管理パッケージのコンポーネントを取得する最も簡単な方法は、前述のように、RetrieveRequestの packageNames
項目にパッケージの名前を設定することによって完全なパッケージを取得する方法です。次の package.xml
マニフェストファイルのサンプルでは、パッケージの個々のコンポーネントを取得する代替方法を示します。
<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<types>
<members>myns__MyCustomObject__c</members>
<name>CustomObject</name>
</types>
21
メタデータのリリースと取得
package.xml マニフェストファイルのサンプル
<version>32.0</version>
</Package>
<members> 項目の namespacePrefix__objectName 構文において、namespacePrefix は、パッケージの
名前空間プレフィックスで、objectName はオブジェクトの名前です。名前空間プレフィックスは、パッケー
ジおよびそのコンテンツとその他の公開者のパッケージを区別する 1 ～ 15 文字の英数字で構成される識別子
です。名前空間プレフィックスについての詳細は、Salesforceオンラインヘルプの「名前空間プレフィックスの
登録」を参照してください。
セキュリティ設定
この package.xml マニフェストファイルのサンプルでは、組織のセキュリティ設定の使用方法を示します。
SecuritySettings コンポーネントの種類を取得する場合には、<members> 要素で Security を指定し、name 要素で
Settings を指定します。
<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<types>
<members>Security</members>
<name>Settings</name>
</types>
<version>32.0</version>
</Package>
割り当てルール、自動レスポンスルール、エスカーレーションルー
ル
割り当てルール、自動レスポンスルール、およびエスカレーションルールでは、オブジェクト種別の一連のま
たは個別のルールにアクセスするために、さまざまな package.xml 型名が使用されます。たとえば、
package.xml マニフェストファイルの次のサンプルは、組織のケースとリードのみの割り当てルールにアク
セスする方法を示しています。
<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<types>
<members>Case</members>
<members>Lead</members>
<name>AssignmentRules</name>
</types>
<version>32.0</version>
</Package>
package.xml マニフェストファイルの次のサンプルは、Case の「samplerule」割り当てルールとリードの
「newrule」割り当てルールのみにアクセスする方法を示しています。型名は AssignmentRules ではなく、
AssignmentRule です。
<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<types>
<members>Case.samplerule</members>
22
メタデータのリリースと取得
package.xml マニフェストファイルのサンプル
<members>Lead.newrule</members>
<name>AssignmentRule</name>
</types>
<version>32.0</version>
</Package>
同様に、個々の自動レスポンスルールとエスカレーションルールにアクセスする場合は、AutoResponseRules
と EscalationRules の代わりに AutoResponseRule と EscalationRule を使用します。
管理コンポーネントへのアクセス
API バージョン 29.0 以降では、プロファイルと権限セットで、次の管理コンポーネントのアクセス設定を取得
およびリリースできるようになりました。
• Apex クラス
• アプリケーション
• カスタム項目権限
• カスタムオブジェクト権限
• カスタムタブの設定
• 外部データソース
• レコードタイプ
• 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>
23
メタデータのリリースと取得
リリースでのテストの実行
<name>Profile</name>
</types>
権限セットとプロファイルを取得する場合、権限と設定に関連するコンポーネントも取得する必要がありま
す。たとえば、アプリケーション表示設定を取得する場合、関連付けられたアプリケーションも取得する必要
があり、オブジェクトまたは項目権限を取得する場合は、関連付けられたオブジェクトも取得する必要があり
ます。
リリースでのテストの実行
本番組織へのリリースの場合、インストール済みの管理パッケージから作成されたテストを除く組織のすべて
のテストは、自動的に実行されます。テストのいずれかが失敗した場合は、リリース全体がロールバックされ
ます。
リリースに次のメタデータ型のコンポーネントが含まれている場合は、テストはすべて自動的に実行されま
す。
• ApexClass
• ApexComponent
• ApexPage
• ApexTrigger
• ArticleType
• BaseSharingRule
• CriteriaBasedSharingRule
• CustomDataType
• CustomField
• CustomObject
• DataCategoryGroup
• Flow
• InstalledPackage
• NamedFilter
• OwnerSharingRule
• PermissionSet
• Profile
• Queue
• RecordType
• RemoteSiteSetting
• Role
• SharingReason
• Territory
• Validation Rules
• Workflow
たとえば、次のリリースではテストは実行されません。
24
メタデータのリリースと取得
ユーザ参照の保持
• 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. ソース環境とターゲット環境でユーザ名が比較され、組織のドメイン名が適用されます。
2. 一致するユーザ名が複数存在すると、一致する名前が一覧表示され、ソース環境のいずれか 1 つのユーザ
名を変更するよう要求されます。
3. ソース環境のユーザ名がターゲット環境に存在しない場合はエラーが表示され、ユーザ名を削除するかター
ゲット環境のユーザが解決されるまでリリースが停止します。
25
第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 つのコー
ルで結果を返します。
26
CRUD ベースのメタデータ開発
3. 返される SaveResult オブジェクトを調べて、操作に成功したかどうかを確認し、成功していなかった場
合はコンポーネント名、エラーメッセージ、および状況コードを出力に書き込みます。
import com.sforce.soap.metadata.*;
/**
* Sample that logs in and creates a custom object through the metadata API
*/
public class CRUDSampleCreate {
private MetadataConnection metadataConnection;
// one second in milliseconds
private static final long ONE_SECOND = 1000;
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());
27
CRUD ベースのメタデータ開発
} 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();
// 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 コールに続く、エラー処理コードに注意してください。
import com.sforce.soap.metadata.*;
/**
* Sample that logs in and creates a custom object through the metadata api
*/
public class CRUDSample {
private MetadataConnection metadataConnection;
// one second in milliseconds
private static final long ONE_SECOND = 1000;
public CRUDSample() {
}
28
CRUD ベースのメタデータ開発
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();
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);
}
29
CRUD ベースのメタデータ開発
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);
}
}
30
第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 開発者ガイド』を参照してください。
31
参照
第6章
ファイルベースのコール
XML コンポーネントをリリースまたは取得するには、次のファイルベースのコールを使用します。
• deploy()
• retrieve()
deploy()
ファイル表現のコンポーネントを使用して、組織のファイル表現のコンポーネントを作成、更新、または削除
します。
構文
AsyncResult = metadatabinding.deploy(base64 zipFile, DeployOptions deployOptions)
使用方法
このコールを使用して、ファイル表現のコンポーネントを取得し、ファイル表現のコンポーネントが表すコン
ポーネントを作成、更新、または削除することにより、組織にファイル表現のコンポーネントをリリースしま
す。
メモ: メタデータ API は、一度に最大 5,000 個のファイルまたは最大 400 MB をリリースおよび取得できま
す。特定のファイルサイズ制限が適用されていない場合は、非常に大きいファイルではメモリ不足エラー
が発生する可能性があります。
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() コールを使用して開始された進行中
または完了済みのリリースに関する情報が含まれます。checkDeployStatus() をコールするとき、最初
のステップの AsyncResult オブジェクトから id 値を渡します。
32
ファイルベースのコール
deploy()
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 ファイルを
次に示します。
<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<types>
<members>MyCustomObject__c</members>
<name>CustomObject</name>
</types>
</Package>
この破壊的な変更をリリースするためには、リリースするコンポーネントがリストされておらず、API バージョ
ンを含み、destructiveChanges.xml と同じディレクトリ内にある package.xml ファイルも必要です。
<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<version>32.0</version>
</Package>
処理中または過去 30 日間で完了したリリースの状況を追跡するには、[設定] で [リリース状況] または [リリー
ス] > [リリース状況] をクリックします。
進行中またはキュー内のリリースは、リリースの横にある[キャンセル]をクリックしてキャンセルできます。
リリースが完全にキャンセルされるまで、リリースの状況は Cancel Requested になります。キャンセルさ
れたリリースは、[失敗] セクションにリストされます。
33
ファイルベースのコール
deploy()
権限
クライアントアプリケーションは、「すべてのデータの編集」権限でログインしている必要があります。
引数
名前
型
説明
zipFile
base64
Base 64 で符号化されたバイナリデータ クライアントアプリケーションは、バ
イナリデータを base64 に符号化する必要があります。
deployOptions DeployOptions リリースするパッケージまたはファイルを特定するためのオプションをカプ
セル化します。
DeployOptions
このコールでは次のリリースオプションを選択できます。
名前
型
説明
allowMissingFiles
boolean
ファイルが package.xml では指定されている
が、.zip ファイルにはない場合でもリリースを継
続するか (true)、否か (false) を指定します。
本番組織へのリリースでは、この引数を設定する
ことはできません。
autoUpdatePackage
ファイルが .zip ファイルにはあるが、
package.xml で指定されていない場合、ファイル
を自動的にパッケージに追加するか (true)、否か
(false) を指定します。.zip ファイルを含む
package.xml が更新された場合は、retrieve()
が自動的に発行されます。
boolean
本番組織へのリリースでは、この引数を設定する
ことはできません。
checkOnly
boolean
Apex クラスおよびトリガをリリースの一部として
組織に保存するか (false)、否か (true) を示しま
す。デフォルトは false です。発行済みのエラー
またはメッセージもすべて生成されます。このパ
ラメータは、Salesforce Ant ツールの checkOnly パ
ラメータと似ています。
34
ファイルベースのコール
deploy()
名前
型
説明
ignoreWarnings
boolean
警告を無視してリリースの正常な完了を許可する
か (true)、否か (false) を示します。デフォルト
は false です。
警告の DeployMessage オブジェクトには次の値が含
まれます。
• problemType—Warning
• problem — 警告のテキスト
警告が発生し、ignoreWarnings が true に設定
されている場合は、DeployMessage の success 項目
は true です。ignoreWarnings が false に設
定されている場合、success は false に設定さ
れ、警告はエラーとして処理されます。
この項目は API バージョン 18.0 以降で使用できま
す。バージョン 18.0 より前では、警告とエラーは
区別されていませんでした。すべての問題はエラー
として処理され、リリースの成功を妨げていまし
た。
performRetrieve
boolean
retrieve() コールをリリース直後に実行するか
(true)、否か (false) を示します。リリース直後の
ものをすべて取得するには true に設定します。
purgeOnDelete
boolean
true の場合、destructiveChanges.xml マニ
フェストファイルの削除されたコンポーネントは
ごみ箱に保存されません。代わりに、即座に削除
の対象となります。
この項目は API バージョン 22.0 以降で使用できま
す。
このオプションは Developer Edition 組織またはSandbox
組織でのみ機能しますが、本番組織では機能しま
せん。
rollbackOnError
boolean
エラーが発生した場合、ロールバックを完了する
か (true)、否か (false) を示します。false の場
合、エラーなしで実行できるアクションのセット
はすべて実行され、残りのアクションではエラー
が返されます。本番組織にリリースする場合は、
このパラメータは true に設定されている必要が
あります。デフォルトは、false です。
35
ファイルベースのコール
deploy()
名前
型
説明
runAllTests
boolean
true の場合、組織で定義されているすべてのApex
テストが実行されます。
本番組織へのリリースの場合、インストール済み
の管理パッケージから作成されたテストを除くす
べてのテストは、この引数に関係なく自動的に実
行されます。rollbackOnError パラメータが true
に設定されているときにテストのいずれかが失敗
した場合は、リリース全体がロールバックされま
す。
runTests
リリース時に実行される Apex テストのリスト。ク
ラス名 (1 インスタンスあたり 1 つの名前) を指定し
ます。また、クラス名にはドット付きの名前空間
を指定することもできます。たとえば、3 つのテス
トを実行するには、次のコードを使用します。
string[]
<runTests>positive_test</runTests>
<runTests>negative_test</runTests>
<runTests>namespace.third_test</runTests>
rollbackOnError パラメータが true に設定さ
れているときにこれらのテストのいずれかが失敗
した場合は、リリースがロールバックされ、組織
への変更は行われません。
singlePackage
boolean
指定された .zip ファイルが指し示すディレクト
リ構造が 1 つのパッケージを持つか (true)、パッ
ケージのセットを持つか (false)) を示します。
応答
AsyncResult
サンプルコード —Java
このサンプルでは、zip ファイルでコンポーネントをリリースする方法を示します。zip ファイルの取得方法に
ついての詳細は、retrieve() のサンプルコードを参照してください。
package com.doc.samples;
import java.io.*;
import java.rmi.RemoteException;
import com.sforce.soap.metadata.AsyncResult;
36
ファイルベースのコール
import
import
import
import
import
import
import
import
import
import
import
import
deploy()
com.sforce.soap.metadata.DeployDetails;
com.sforce.soap.metadata.MetadataConnection;
com.sforce.soap.metadata.DeployOptions;
com.sforce.soap.metadata.DeployResult;
com.sforce.soap.metadata.DeployMessage;
com.sforce.soap.metadata.RunTestsResult;
com.sforce.soap.metadata.RunTestFailure;
com.sforce.soap.metadata.CodeCoverageWarning;
com.sforce.soap.enterprise.LoginResult;
com.sforce.soap.enterprise.EnterpriseConnection;
com.sforce.ws.ConnectionException;
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 calls
private MetadataConnection metadataConnection;
static BufferedReader rdr = new BufferedReader(new InputStreamReader(System.in));
private static final String ZIP_FILE = "deploy.zip";
// one second in milliseconds
private static final long ONE_SECOND = 1000;
// maximum number of attempts to deploy the zip file
private 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);
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);
37
ファイルベースのコール
deploy()
AsyncResult asyncResult = metadataConnection.deploy(zipBytes, deployOptions);
String asyncResultId = asyncResult.getId();
// Wait for the deploy to complete
int poll = 0;
long waitTimeMilliSecs = ONE_SECOND;
DeployResult deployResult = null;
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, check that the time allowed by " +
"MAX_NUM_POLL_REQUESTS is sufficient.");
}
// Fetch in-progress details once for every 3 polls
fetchDetails = (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
38
ファイルベースのコール
deploy()
{
// 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) {
39
ファイルベースのコール
checkDeployStatus()
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());
}
}
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);
}
}
このセクションの内容:
1. checkDeployStatus()
2. cancelDeploy()
関連トピック:
リリースでのテストの実行
checkDeployStatus()
宣言的なメタデータコール deploy() の状況を確認します。
40
ファイルベースのコール
cancelDeploy()
構文
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() の使用を引き続きサポートします。
サンプルコード —Java
このコールの使用例は、deploy() のサンプルコードを参照してください。
引数
名前
型
説明
id
ID
deploy() コールまたは後続の checkDeployStatus() コールによって返さ
れる AsyncResult オブジェクトから取得した ID。
includeDetails boolean
DeployResult オブジェクトが DeployDetails 情報を含むか (true)、否か (false) を
設定します。デフォルトは、false です。API バージョン 29.0 以降で利用でき
ます。
応答
DeployResult
cancelDeploy()
まだ完了していないリリースをキャンセルします。
41
ファイルベースのコール
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() をコールします。
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 以降で利用できます。
権限
クライアントアプリケーションは、「すべてのデータの編集」権限でログインしている必要があります。
42
ファイルベースのコール
cancelDeploy()
引数
名前
型
説明
id
string
キャンセルするリリースの ID。
応答
CancelDeployResult
サンプルコード —Java
次のサンプルでは、リリースのキャンセル方法を示します。このサンプルは、特定のリリース ID を渡して
cancelDeploy() をコールします。次に、キャンセルが完了したかどうかをチェックし、まだの場合は
checkDeployStatus のコールをループします。
public void cancelDeploy(String asyncId) throws Exception {
// Issue the deployment cancellation request
CancelDeployResult 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 status
DeployResult 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 Canceling
assert deployResult.getStatus() == DeployStatus.Canceling;
// Wait 2 seconds
Thread.sleep(2000);
// Get the deployment status again
deployResult = metadataConnection.checkDeployStatus(asyncId, false);
}
// 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());
}
}
43
ファイルベースのコール
retrieve()
retrieve()
このコールは、組織内の XML ファイル表現のコンポーネントを取得します。
構文
AsyncResult = metadatabinding.retrieve(RetrieveRequest retrieveRequest)
使用方法
組織内のファイル表現のコンポーネントを取得するには、このコールを使用します。
メモ: メタデータ API は、一度に最大 5,000 個のファイルまたは最大 400 MB をリリースおよび取得できま
す。特定のファイルサイズ制限が適用されていない場合は、非常に大きいファイルではメモリ不足エラー
が発生する可能性があります。
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() コールを完了するまでにかかる時
間は、リリースされる zip ファイルのサイズによって異なるため、zip ファイルのサイズが大きいほど、反
復中の待機時間をより長く設定します。
44
ファイルベースのコール
retrieve()
3. 最初のステップで返された id 値を使用して、checkRetrieveStatus() コールを発行し、retrieve()
コールの結果を取得します。
マニフェストファイルの例は、「package.xml マニフェストファイルのサンプル」を参照してください。
権限
クライアントアプリケーションは、「すべてのデータの編集」権限でログインしている必要があります。
引数
名前
型
説明
retrieveRequest RetrieveRequest 取得するパッケージまたはファイルを決定するためのオプションをカプセル
化します。
応答
AsyncResult
サンプルコード —Java
このサンプルでは、コンポーネントを 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;
45
ファイルベースのコール
retrieve()
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 calls
private MetadataConnection metadataConnection;
static BufferedReader rdr = new BufferedReader(new InputStreamReader(System.in));
// one second in milliseconds
private static final long ONE_SECOND = 1000;
// maximum number of attempts to retrieve the results
private static final int MAX_NUM_POLL_REQUESTS = 50;
46
ファイルベースのコール
retrieve()
// manifest file that controls which components get retrieved
private 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 RetrieveRequest
retrieveRequest.setApiVersion(API_VERSION);
setUnpackaged(retrieveRequest);
47
ファイルベースのコール
retrieve()
// Start the retrieve operation
AsyncResult asyncResult = metadataConnection.retrieve(retrieveRequest);
String asyncResultId = asyncResult.getId();
// Wait for the retrieve to complete
int poll = 0;
long waitTimeMilliSecs = ONE_SECOND;
RetrieveResult result = null;
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, 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) {
48
ファイルベースのコール
retrieve()
// Print out any warning messages
StringBuilder 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);
}
// Write the zip to the file system
System.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();
}
}
49
ファイルベースのコール
retrieve()
}
/**
* 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 buffer
ByteBuffer 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 elsewhere
File unpackedManifest = new File(MANIFEST_FILE);
System.out.println("Manifest file: " + unpackedManifest.getAbsolutePath());
if (!unpackedManifest.exists() || !unpackedManifest.isFile())
50
ファイルベースのコール
retrieve()
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) {
// not
continue;
}
51
ファイルベースのコール
retrieve()
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);
}
}
52
ファイルベースのコール
retrieve()
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 console
String getUserInput(String prompt) {
System.out.print(prompt);
try {
return rdr.readLine();
}
catch (IOException ex) {
return null;
}
53
ファイルベースのコール
RetrieveRequest
}
}
RetrieveRequest
retrieve() コールで指定される RetrieveRequest オブジェクトは、次のプロパティで構成されます。
名前
型
説明
apiVersion
double
必須。retrieve 要求の API バージョン。API バージョ
ンによって、各メタデータ型で取得される項目が
決まります。たとえば、API バージョン 14.0 の
CustomTab には icon 項目が追加されました。
バージョン 13.0 以前のコンポーネントを取得する
場合、このコンポーネントには icon 項目は含ま
れません。
メモ: API バージョン 31.0 以降では、
package.xml で指定された API バージョン
が retrieve() コールに使用され、
apiVersion 項目のバージョンを上書きしま
す。package.xml にバージョンが指定され
ていない場合は、この項目のバージョンが使
用されます。
packageNames
string[]
取得するパッケージ名のリスト。パッケージ化さ
れていないコンポーネントのみを取得する場合、
ここで名前を指定しないでください。同じ retrieve
でパッケージ化されたコンポーネントとパッケー
ジ化されていないコンポーネントを取得できます。
singlePackage
boolean
取得するのが 1 つのパッケージのみか (true)、否
か (false)) を指定します。false の場合、複数の
パッケージが取得されます。
specificFiles
string[]
取得するファイル名のリスト。このプロパティに
値が指定されている場合、packageNames を
null、singlePackage を true に設定する必要
があります。
unpackaged
Package
取得するパッケージに含まれていないコンポーネ
ントのリスト。
54
ファイルベースのコール
checkRetrieveStatus()
checkRetrieveStatus()
宣言的なメタデータコール retrieve() の状況を確認し、zip ファイルのコンテンツを返します。
構文
RetrieveResult = metadatabinding.checkRetrieveStatus(ID id);
使用方法
checkRetrieveStatus() を使用して、メタデータ retrieve() 操作の進行状況を確認します。このメソッ
ドが返す RetrieveResult オブジェクトは、非同期 retrieve() コールが完了したタイミングを示します。取得が
完了している場合、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 以降では使用できません。
サンプルコード —Java
このコールの使用例は、retrieve() のサンプルコードを参照してください。
引数
名前
型
説明
id
ID
retrieve() コールによって返される RetrieveResult オブジェクト、または
checkStatus() コールによって返される後続の AsyncResult オブジェクトから
取得した ID。
応答
RetrieveResult
55
第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() を使用します。
createMetadata()
組織に 1 つ以上の新しいメタデータコンポーネントを同期して追加します。
56
CRUD ベースのコール
createMetadata()
構文
SaveResult[] = metadatabinding.createMetadata(Metadata[] metadata);
使用方法
createMetadata() コールは、メタデータを拡張するすべてのコンポーネントの作成に使用します。同一コー
ル内のすべてのコンポーネントは、同じ種類である必要があります。詳細は、「Metadata コンポーネントおよ
びメタデータ型」を参照してください。
このコールは同期して実行されます。つまり、コールは、操作が完了したときにのみ戻ります。
バージョン
API バージョン 30.0 以降で使用できます。
権限
クライアントアプリケーションは、「すべてのデータの編集」権限でログインしている必要があります。
必須項目
必須項目は、作成されるメタデータコンポーネントによって決まります。特定のコンポーネントの種類につい
ての詳細は、「Metadata コンポーネントおよびメタデータ型」を参照してください。
有効なデータ値
項目のデータ型に対して有効な値を入力する必要があります。たとえば、整数項目については整数を入力しま
す (英字は不可)。クライアントアプリケーションでは、使用しているプログラム言語および開発ツールに指定
されたデータ形式ルールに従ってください (開発ツールは、SOAP メッセージのデータ型の適切な対応付けを処
理します)。
文字列値
文字列項目に値を格納する場合、前後にある空白は API が切り捨てます。たとえば、label 項目の値に
"MyObject " と入力されると、その値はデータベースに "MyObject" として保存されます。
メタデータコンポーネント作成の基本手順
メタデータコンポーネントを作成するには、次のプロセスを使用します。
1. 配列を設計し、作成するコンポーネントを挿入します。すべてのコンポーネントは同じ種類である必要が
あります。
2. 引数にコンポーネント配列を渡し、createMetadata() をコールします。
57
CRUD ベースのコール
createMetadata()
3. 作成しようとしたコンポーネントごとに SaveResult オブジェクトが返されます。このオブジェクトに
は、操作が成功したかどうか、作成されたコンポーネントの名前、操作が成功しなかった場合は返された
エラーに関する情報が含まれます。
サンプルコード —Java
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 });
for (SaveResult r : results) {
if (r.isSuccess()) {
System.out.println("Created component: " + r.getFullName());
} else {
58
CRUD ベースのコール
readMetadata()
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());
}
}
}
} catch (ConnectionException ce) {
ce.printStackTrace();
}
}
引数
名前
型
説明
metadata
Metadata[]
1 つ以上のメタデータコンポーネントの配列。
上限: 10。
1 つの種類のコンポーネントの配列を送信する必要があります。たとえば、
10 個のカスタムオブジェクトの配列または 10 個のプロファイルの配列を送
信できますが、両方の種類を混ぜて送信することはできません。
応答
SaveResult[]
readMetadata()
組織から 1 つ以上のメタデータコンポーネントを同期して返します。
59
CRUD ベースのコール
readMetadata()
構文
ReadResult = metadataConnection.readMetadata(string metadataType, string[] fullNames);
使用方法
readMetadata() コールは、メタデータを拡張するすべてのコンポーネントの取得に使用します。同一コー
ル内のすべてのコンポーネントは、同じ種類である必要があります。詳細は、「Metadata コンポーネントおよ
びメタデータ型」を参照してください。
このコールは同期して実行されます。つまり、コールは、操作が完了したときにのみ戻ります。
バージョン
API バージョン 30.0 以降で使用できます。
権限
クライアントアプリケーションは、「すべてのデータの編集」権限でログインしている必要があります。
メタデータコンポーネント読み込みの基本手順
メタデータコンポーネントを読み込むには、次のプロセスを使用します。
1. 読み込むコンポーネントのメタデータ型と、読み込む各コンポーネントの fullName を判別します。
fullName 項目についての詳細は、「Metadata」を参照してください。1 つのコールで読み込めるのは同じ
型のコンポーネントのみです。
2. readMetadata() コールを呼び出します。最初の引数で、メタデータ型の名前を渡します。メタデータ型
は、describeMetadata() コールで返された値のいずれかと一致する必要があります。2 つ目の引数で、
取得するコンポーネントに対応する完全名の配列を渡します。完全名は、listMetadata() コールで返さ
れた完全名の 1 つ以上と一致する必要があります。
3. Metadata コンポーネントの配列が含まれる ReadResult が返されます。返された各 Metadata オブジェ
クトを、コールで指定したメタデータ型にキャストしてコンポーネントのプロパティを取得します。
サンプルコード —Java
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) {
60
CRUD ベースのコール
updateMetadata()
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.");
}
}
} catch (ConnectionException ce) {
ce.printStackTrace();
}
}
引数
名前
型
metadataType string
fullNames
string[]
説明
読み込むコンポーネントのメタデータ型。
読み込むコンポーネントの完全名の配列。
上限: 10。
1 つの種類のコンポーネントの配列を送信する必要があります。たとえば、
10 個のカスタムオブジェクトの配列または 10 個のプロファイルの配列を送
信できますが、両方の種類を混ぜて送信することはできません。
応答
ReadResult
updateMetadata()
組織の 1 つ以上のメタデータコンポーネントを同期して更新します。
構文
SaveResult[] = metadataConnection.updateMetadata(Metadata[] metadata);
61
CRUD ベースのコール
updateMetadata()
使用方法
updateMetadata() コールは、メタデータを拡張するすべてのコンポーネントの更新に使用します。同一コー
ル内のすべてのコンポーネントは、同じ種類である必要があります。詳細は、「Metadata コンポーネントおよ
びメタデータ型」を参照してください。
このコールは同期して実行されます。つまり、コールは、操作が完了したときにのみ戻ります。
バージョン
API バージョン 30.0 以降で使用できます。
権限
クライアントアプリケーションは、「すべてのデータの編集」権限でログインしている必要があります。
必須項目
コンポーネント内のすべての必須項目に値を指定する必要があります。
有効な項目値
項目のデータ型に対して有効な値を入力する必要があります。たとえば、整数項目については整数を入力しま
す (英字は不可)。クライアントアプリケーションでは、使用しているプログラム言語および開発ツールに指定
されたデータ形式ルールに従ってください (開発ツールは、SOAP メッセージのデータ型の適切な対応付けを処
理します)。
文字列値
String 項目に値を保存する場合、API は先頭および末尾の空白文字を削除します。たとえば、label 項目の値に
"MyObject " と入力されると、その値はデータベースに "MyObject" として保存されます。
メタデータコンポーネント更新の基本手順
メタデータコンポーネントを更新するには、次のプロセスを使用します。
1. 更新するコンポーネントの配列を作成します。すべてのコンポーネントは同じ種類である必要があります。
2. updateMetadata() コールを呼び出し、更新するメタデータコンポーネントの配列を渡します。
更新しようとしたコンポーネントごとに SaveResult オブジェクトが返されます。このオブジェクトに
は、操作が成功したかどうか、更新されたコンポーネントの名前、操作が成功しなかった場合は返された
エラーに関する情報が含まれます。
62
CRUD ベースのコール
updateMetadata()
サンプルコード —Java
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 required
CustomField cf = new CustomField();
cf.setType(FieldType.Text);
cf.setLabel(co.getFullName() + " Name");
co.setNameField(cf);
SaveResult[] results = metadataConnection
.updateMetadata(new Metadata[] { co });
for (SaveResult r : results) {
if (r.isSuccess()) {
System.out.println("Updated component: " + r.getFullName());
} else {
System.out
.println("Errors were encountered while updating "
63
CRUD ベースのコール
upsertMetadata()
+ r.getFullName());
for (Error e : r.getErrors()) {
System.out.println("Error message: " + e.getMessage());
System.out.println("Status code: " + e.getStatusCode());
}
}
}
} catch (ConnectionException ce) {
ce.printStackTrace();
}
}
引数
名前
型
説明
metadata
Metadata[]
更新する 1 つ以上のメタデータコンポーネントの配列。
上限: 10。
1 つの種類のコンポーネントの配列を送信する必要がありま
す。たとえば、10 個のカスタムオブジェクトの配列または
10 個のプロファイルの配列を送信できますが、両方の種類
を混ぜて送信することはできません。
応答
SaveResult[]
upsertMetadata()
組織の 1 つ以上のメタデータコンポーネントを同期して作成または更新します。
構文
UpsertResult[] = metadataConnection.upsertMetadata(Metadata[] metadata);
64
CRUD ベースのコール
upsertMetadata()
使用方法
upsertMetadata() コールは、メタデータを拡張するすべてのコンポーネントの作成または更新に使用しま
す。同一コール内のすべてのコンポーネントは、同じ種類である必要があります。詳細は、「Metadata コン
ポーネントおよびメタデータ型」を参照してください。
指定されたコンポーネントがすでに組織に存在する場合、upsertMetadata() コールはこれらのコンポーネ
ントを更新します。存在しない場合、upsertMetadata() はこれらのコンポーネントを作成します。コンポー
ネントは fullname 項目によって照合されます。このコールは同期して実行されます。つまり、コールは、
操作が完了した後にのみ戻ります。
バージョン
API バージョン 31.0 以降で使用できます。
権限
クライアントアプリケーションは、「すべてのデータの編集」権限でログインしている必要があります。
必須項目
コンポーネント内のすべての必須項目に値を指定する必要があります。
有効な項目値
整数項目については整数 (英字は不可)、項目のデータ型に対して有効な値を入力する必要があります。クライ
アントアプリケーションでは、プログラム言語および開発ツールで指定されているデータ形式ルールに従って
ください。(開発ツールは、SOAP メッセージのデータ型の適切な対応付けを処理します)。
文字列値
String 項目に値を保存する場合、API は先頭および末尾の空白文字を削除します。たとえば、label 項目の値に
" MyObject " と入力されると、その値はデータベースに "MyObject" として保存されます。
メタデータコンポーネント更新/挿入の基本手順
メタデータコンポーネントを更新/挿入するには、次のプロセスを使用します。
1. 作成または更新するコンポーネントに対応するメタデータオブジェクトの配列を作成します。すべてのコ
ンポーネントは同じ種類である必要があります。
2. upsertMetadata() を呼び出し、前のステップで作成したメタデータコンポーネントの配列を渡します。
upsertMetadata() コールは、UpsertResult オブジェクトの配列を返します。更新/挿入した各コンポー
ネントに対して UpsertResult が返されます。その中には、更新/挿入操作に関する情報 (操作が成功した
かどうか、更新/挿入されたコンポーネントの名前、コンポーネントが作成されたかどうかを示すフラグ、
操作が成功しなかった場合に返されるエラー) が含まれます。
65
CRUD ベースのコール
upsertMetadata()
サンプルコード —Java
public void upsertMetadataSample() {
try {
// Create custom object to upsert
CustomObject 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 object
UpsertResult[] results = metadataConnection
.upsertMetadata(new Metadata[] { co });
for (UpsertResult r : results) {
if (r.isSuccess()) {
System.out.println("Success!");
if (r.isCreated()) {
66
CRUD ベースのコール
upsertMetadata()
System.out.println("Created component: "
+ r.getFullName());
} else {
System.out.println("Updated component: "
+ r.getFullName());
}
} else {
System.out
.println("Errors were encountered while upserting "
+ r.getFullName());
for (Error e : r.getErrors()) {
System.out.println("Error message: " + e.getMessage());
System.out.println("Status code: " + e.getStatusCode());
}
}
}
} catch (ConnectionException ce) {
ce.printStackTrace();
}
}
引数
名前
型
説明
metadata
Metadata[]
作成または更新する 1 つ以上のメタデータコンポーネント
の配列。
上限: 10。
1 つの種類のコンポーネントの配列を送信する必要がありま
す。たとえば、10 個のカスタムオブジェクトの配列または
67
CRUD ベースのコール
名前
deleteMetadata()
型
説明
10 個のプロファイルの配列を送信できますが、両方の種類
を混ぜて送信することはできません。
応答
UpsertResult[]
deleteMetadata()
組織から 1 つ以上のメタデータコンポーネントを同期して削除します。
構文
DeleteResult[] = metadataConnection.delete(string metadataType, string[] fullNames);
使用方法
deleteMetadata() コールは、メタデータを拡張するすべてのコンポーネントの削除に使用します。同一コー
ル内のすべてのコンポーネントは、同じ種類である必要があります。詳細は、「Metadata コンポーネントおよ
びメタデータ型」を参照してください。
このコールは同期して実行されます。つまり、コールは、操作が完了したときにのみ戻ります。
バージョン
API バージョン 30.0 以降で使用できます。
権限
クライアントアプリケーションは、「すべてのデータの編集」権限でログインしている必要があります。
ルールとガイドライン
コンポーネントを削除する場合は、次のルールやガイドラインを考慮する必要があります。
• 指定したコンポーネント内の個別のコンポーネントを削除するには、実行するのに十分なアクセス権を使
用してクライアントアプリケーションにログインする必要があります。詳細は、『SOAP API 開発者ガイド』
の「データアクセスに影響する要素」を参照してください。
• また、コンポーネントの親コンポーネントにアクセスする権限も必要となる場合があります。
• 参照整合性を確保するために、このコールはカスケード削除をサポートします。親コンポーネントを削除
すると、各子コンポーネントが削除可能な場合は、その子コンポーネントは自動的に削除されます。
68
CRUD ベースのコール
deleteMetadata()
メタデータコンポーネント削除の基本手順
メタデータコンポーネントを削除するには次のプロセスを使用します。
1. 削除するコンポーネントのメタデータ型と、削除する各コンポーネントの fullName を判別します。1 つの
コールで削除できるのは同じ型のコンポーネントのみです。完全名は、listMetadata() コールで返され
た完全名の 1 つ以上と一致する必要があります。fullName 項目についての詳細は、「Metadata」を参照し
てください。
2. deleteMetadata() コールを呼び出します。最初の引数で、メタデータ型の名前を渡します。2 つ目の引
数で、削除するコンポーネントに対応する完全名の配列を渡します。
削除しようとするコンポーネントごとに、DeleteResult オブジェクトが返されます。このオブジェクト
には、操作が成功したかどうか、削除されたコンポーネントの名前、操作が成功しなかった場合は返され
たエラーに関する情報が含まれます。
サンプルコード —Java
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());
}
}
}
} catch (ConnectionException ce) {
ce.printStackTrace();
}
}
引数
名前
型
metadataType string
fullNames
string[]
説明
削除するコンポーネントのメタデータ型。
削除するコンポーネントの完全名の配列。
上限: 10。
69
CRUD ベースのコール
名前
renameMetadata()
型
説明
1 つの種類のコンポーネントの配列を送信する必要があります。たとえば、
10 個のカスタムオブジェクトの配列または 10 個のプロファイルの配列を送
信できますが、両方の種類を混ぜて送信することはできません。
応答
DeleteResult[]
renameMetadata()
組織内のメタデータコンポーネントの名前を同期して変更します。
構文
SaveResult = metadataConnection.renameMetadata(string metadataType, String oldFullname,
String newFullname);
使用方法
renameMetadata() コールを使用して、組織の 1 つのメタデータコンポーネントの名前を変更します。この
コールは同期して実行されます。つまり、コールは、操作が完了したときにのみ戻ります。
このコールは、Metadata を拡張するいずれかのオブジェクトの名前を変更するために使用できます。詳細は、
「Metadata コンポーネントおよびメタデータ型」を参照してください。
バージョン
API バージョン 30.0 以降で利用できます。
権限
クライアントアプリケーションは、「すべてのデータの編集」権限でログインしている必要があります。
メタデータコンポーネントの名前変更の基本手順
メタデータコンポーネントの名前を変更するには、次のプロセスを使用します。
1. 名前を変更するコンポーネントのメタデータ型、現在の完全名、および新しい完全名を判別します。
fullName 項目についての詳細は、「Metadata」を参照してください。
2. renameMetadata() コールを呼び出します。最初の引数で、メタデータ型の名前を渡します。2 つ目の引
数として以前の完全名、最後の引数として新しい完全名を渡します。
70
CRUD ベースのコール
renameMetadata()
SaveResult オブジェクトが返されます。このオブジェクトには、操作が成功したかどうか、名前が変更
されたコンポーネントの名前 (名前の変更が成功した場合は新しい名前)、操作が成功しなかった場合は返
されたエラーに関する情報が含まれます。
サンプルコード —Java
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 (ConnectionException ce) {
ce.printStackTrace();
} catch (InterruptedException ie) {
ie.printStackTrace();
}
}
引数
名前
型
metadataType string
説明
名前を変更するコンポーネントのメタデータ型。
oldFullName
string
コンポーネントの現在の完全名。
newFullName
string
コンポーネントの新しい完全名。
応答
SaveResult
71
CRUD ベースのコール
create()
create()
非推奨。組織に 1 つ以上の新しいメタデータコンポーネントを非同期で追加します。このコールはAPIバージョ
ン 31.0 で削除されました。それより前のバージョンでのみ使用できます。代わりに createMetadata() を使
用します。
このコールは、Metadataを拡張するオブジェクトを作成するために使用できます。詳細は、「Metadata コンポー
ネントおよびメタデータ型」 (ページ 115)を参照してください。
構文
AsyncResult[] = metadatabinding.create(Metadata[] metadata);
使用方法
このコールを使用して、組織に 1 つ以上のメタデータコンポーネントを追加します。
バージョン
このコールは、API バージョン 30.0 以前でのみ使用できます。このコールは、API バージョン 31.0 以降では使用
できません。代わりに、createMetadata() を使用します。
権限
クライアントアプリケーションは、「すべてのデータの編集」権限でログインしている必要があります。
必須項目
必須項目は、作成されるメタデータコンポーネントによって決まります。特定のコンポーネントの種類につい
ての詳細は、「Metadata コンポーネントおよびメタデータ型」 (ページ 115)を参照してください。
有効なデータ値
項目のデータ型に対して有効な値を入力する必要があります。たとえば、整数項目については整数を入力しま
す (英字は不可)。クライアントアプリケーションでは、使用しているプログラム言語および開発ツールに指定
されたデータ形式ルールに従ってください (開発ツールは、SOAP メッセージのデータ型の適切な対応付けを処
理します)。
文字列値
文字列項目に値を格納する場合、前後にある空白は API が切り捨てます。たとえば、label 項目の値に
"MyObject " と入力されると、その値はデータベースに "MyObject" として保存されます。
72
CRUD ベースのコール
create()
メタデータコンポーネント作成の基本手順
メタデータコンポーネントを作成するには、次のプロセスを使用します。
1. 配列を設計し、作成するコンポーネントを挿入します。すべてのコンポーネントは同じ種類である必要が
あります。
2. 引数にコンポーネント配列を渡し、create() をコールします。
3. 作成しようとするコンポーネントごとに AsyncResult オブジェクトが返されます。このオブジェクトは、操
作がキューから完了またはエラー状態に移行すると、状況情報で更新されます。AsyncResultの状況値がすべ
ての create 操作が完了したことを示すまで、checkStatus() コールをループします。checkStatus() コー
ルの反復間の待機時間を 1 秒間で開始して、以降の各コール実行時にはその待機時間を 2 倍の秒数に指定
します。
サンプルコード —Java
create() コールを使用した Java のサンプルコードについては、「ステップ 3: Java サンプルコードの説明」
(ページ 7)を参照してください。
引数
名前
型
説明
metadata
Metadata[]
1 つ以上のメタデータコンポーネントの配列。
上限: 10。
1 つの種類のコンポーネントの配列を送信する必要があります。たとえば、
10 個のカスタムオブジェクトの配列または 10 個のプロファイルの配列を送
信できますが、両方の種類を混ぜて送信することはできません。
応答
AsyncResult[]
関連トピック:
createMetadata()
update()
delete()
checkStatus()
73
CRUD ベースのコール
delete()
delete()
非推奨。組織から 1 つ以上のコンポーネントを非同期に削除します。このコールは API バージョン 31.0 で削除
されました。それより前のバージョンでのみ使用できます。代わりに deleteMetadata() を使用します。
このコールは、Metadataを拡張するいずれかのオブジェクトを削除するために使用できます。詳細は、「Metadata
コンポーネントおよびメタデータ型」 (ページ 115)を参照してください。
構文
AsyncResult[] = metadataConnection.delete(Metadata[] metadata);
使用方法
このコールを使用して、組織から 1 つ以上のコンポーネントを削除します。
バージョン
このコールは、API バージョン 30.0 以前でのみ使用できます。このコールは、API バージョン 31.0 以降では使用
できません。代わりに、deleteMetadata() を使用します。
権限
クライアントアプリケーションは、「すべてのデータの編集」権限でログインしている必要があります。
ルールとガイドライン
コンポーネントを削除する場合は、次のルールやガイドラインを考慮する必要があります。
• 指定したコンポーネント内の個別のコンポーネントを削除するには、実行するのに十分なアクセス権を使
用してクライアントアプリケーションにログインする必要があります。詳細は、『SOAP API 開発者ガイド』
の「データアクセスに影響する要素」を参照してください。
• また、コンポーネントの親コンポーネントにアクセスする権限も必要となる場合があります。
• 参照整合性を確保するために、このコールはカスケード削除をサポートします。親コンポーネントを削除
すると、各子コンポーネントが削除可能な場合は、その子コンポーネントは自動的に削除されます。
メタデータコンポーネント削除の基本手順
メタデータコンポーネントを削除するには次のプロセスを使用します。
1. 削除する各コンポーネントの fullName を確認します。fullName 項目についての詳細は、「Metadata」を
参照してください。1 つのコールで削除できるのは同じ型のコンポーネントのみです。
2. delete() コールを呼び出し、fullName が指定されているメタデータコンポーネントの配列を渡します。
74
CRUD ベースのコール
delete()
3. 削除しようとするコンポーネントごとに AsyncResult オブジェクトが返されます。このオブジェクトは、操
作がキューから完了またはエラー状態に移行すると、状況情報で更新されます。AsyncResultの状況値がすべ
ての delete 操作が完了したことを示すまで、ループで checkStatus() をコールします。checkStatus()
コールの反復間の待機時間を 1 秒間で開始して、以降の各コール実行時にはその待機時間を 2 倍の秒数に
指定します。
サンプルコード —Java
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 iteration
waitTimeMilliSecs *= 2;
asyncResult = mdConnection.checkStatus(
new String[] {asyncResult.getId()})[0];
System.out.println("Status is: " + asyncResult.getState());
}
} catch (ConnectionException ce) {
ce.printStackTrace();
} catch (InterruptedException ie) {
ie.printStackTrace();
}
}
引数
名前
型
説明
metadata
Metadata[]
1 つ以上のメタデータコンポーネントの配列。Metadata オブジェクトの
fullName 項目の設定のみが必要です。
上限: 10。
1 つの種類のコンポーネントの配列を送信する必要があります。たとえば、
10 個のカスタムオブジェクトの配列または 10 個のプロファイルの配列を送
信できますが、両方の種類を混ぜて送信することはできません。
75
CRUD ベースのコール
update()
応答
AsyncResult[]
関連トピック:
deleteMetadata()
create()
update()
checkStatus()
update()
非推奨。組織の 1 つ以上のコンポーネントを非同期に更新します。このコールは API バージョン 31.0 で削除さ
れました。それより前のバージョンでのみ使用できます。代わりに、updateMetadata() または
renameMetadata() を使用します。
このコールは、Metadataを拡張するオブジェクトを更新するために使用できます。詳細は、「Metadata コンポー
ネントおよびメタデータ型」 (ページ 115)を参照してください。
構文
AsyncResult[] = metadataConnection.update(UpdateMetadata[] metadata);
使用方法
このコールを使用して、1 つ以上のコンポーネントの更新します。このコールは SQL の ALTER TABLE ステー
トメントに類似しています。
バージョン
このコールは、API バージョン 30.0 以前でのみ使用できます。このコールは、API バージョン 31.0 以降では使用
できません。メタデータコンポーネントを更新する場合は、代わりに updateMetadata() を、メタデータコ
ンポーネントの名前を変更する場合は renameMetadata() を使用します。
権限
クライアントアプリケーションは、「すべてのデータの編集」権限でログインしている必要があります。
必須項目
コンポーネント内のすべての必須項目に値を指定する必要があります。
76
CRUD ベースのコール
update()
有効な項目値
項目のデータ型に対して有効な値を入力する必要があります。たとえば、整数項目については整数を入力しま
す (英字は不可)。クライアントアプリケーションでは、使用しているプログラム言語および開発ツールに指定
されたデータ形式ルールに従ってください (開発ツールは、SOAP メッセージのデータ型の適切な対応付けを処
理します)。
文字列値
String 項目に値を保存する場合、API は先頭および末尾の空白文字を削除します。たとえば、label 項目の値に
"MyObject " と入力されると、その値はデータベースに "MyObject" として保存されます。
メタデータコンポーネント更新の基本手順
メタデータコンポーネントを更新するには、次のプロセスを使用します。
1. UpdateMetadata コンポーネントの配列を作成し、更新するコンポーネントを挿入します。すべてのコン
ポーネントは同じ種類である必要があります。
2. update() コールを呼び出し、更新するメタデータコンポーネントの配列を渡します。
3. 更新しようとするコンポーネントごとに AsyncResult オブジェクトが返されます。このオブジェクトは、操
作がキューから完了またはエラー状態に移行すると、状況情報で更新されます。AsyncResultの状況値が、す
べての更新操作が完了したことを示すまで、ループで checkStatus() をコールします。checkStatus()
コールの反復間の待機時間を 1 秒間で開始して、以降の各コール実行時にはその待機時間を 2 倍の秒数に
指定します。
サンプルコード —Java
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");
77
CRUD ベースのコール
update()
AsyncResult[] ars = metadataConnection.update(new UpdateMetadata[]
{ updateMetadata });
AsyncResult asyncResult = ars[0];
// set initial wait time to one second in milliseconds
long waitTimeMilliSecs = 1000;
while (!asyncResult.isDone()) {
Thread.sleep(waitTimeMilliSecs);
// double the wait time for the next iteration
waitTimeMilliSecs *= 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());
}
} catch (InterruptedException ie) {
ie.printStackTrace();
} catch (ConnectionException ce) {
ce.printStackTrace();
}
}
引数
名前
型
説明
metadata
UpdateMetadata[]
更新しようとするコンポーネントを表す、1 つ以上の
UpdateMetadata データ構造の配列。
上限: 10。
1 つの種類のコンポーネントの配列を送信する必要がありま
す。たとえば、10 個のカスタムオブジェクトの配列または
10 個のプロファイルの配列を送信できますが、両方の種類
を混ぜて送信することはできません。
UpdateMetadata
1 つ以上の UpdateMetadata オブジェクトが metadata 引数で定義されます。このオブジェクトは、Metadata を拡
張するオブジェクトを更新するために使用できます。詳細は、「Metadata コンポーネントおよびメタデータ
型」 (ページ 115)を参照してください。各 UpdateMetadata オブジェクトには、次の項目があります。
78
CRUD ベースのコール
update()
項目
データ型
説明
currentName
string
更新前のコンポーネントまたは項目の API 名。たとえば、
Foo という名前の CustomObject を更新する場合、この項目の
値は Foo__c になります。この値はこのコールによって名
前が変更される可能性があるため提供されるものであり、
その値は対応付けに使用されます。
metadata
Metadata
更新するコンポーネントまたは項目の完全な仕様。
応答
AsyncResult[]
関連トピック:
updateMetadata()
create()
delete()
checkStatus()
79
第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
このコールを使用した Java のサンプルコードについては、「ステップ 3: Java サンプルコードの説明」 (ページ
7)を参照してください。
80
ユーティリティコール
describeMetadata()
引数
名前
型
説明
ids
ID[]
1 つ以上の ID の配列。各 ID は、AsyncResult 内で返され、作成、更新、削除、リ
リース、または取得されているコンポーネントに対応します。
応答
AsyncResult[]
describeMetadata()
このコールは組織を説明するメタデータを取得します。この情報には Apex クラスおよびトリガ、カスタムオ
ブジェクト、標準オブジェクトのカスタム項目、アプリケーションを定義するタブセット、および他の多くの
コンポーネントが含まれています。
構文
DescribeMetadataResult[] = metadataConnection.describeMetadata(double apiVersion);
引数
名前
型
説明
apiVersion
double
32.0 など、メタデータが必要な API バージョン。
権限
クライアントアプリケーションは、「すべてのデータの編集」権限でログインしている必要があります。
サンプルコード —Java
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");
81
ユーティリティコール
listMetadata()
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());
} catch (ConnectionException ce) {
ce.printStackTrace();
}
}
応答
DescribeMetadataResult
listMetadata()
このコールは組織のメタデータコンポーネントに関するプロパティ情報を取得します。queries パラメータ
で指定されている条件に一致したコンポーネントのデータが返されます。queries 配列には各コールに対す
る最大 3 つの ListMetadataQuery クエリを含めることができます。このコールは、CustomObject や ApexClass などの
最上位の型、および CustomField や RecordType などの子の型の両方のすべてのメタデータ型をサポートします。
構文
FileProperties[] = metadataConnection.listMetadata(ListMetadataQuery[] queries, double
asOfVersion);
使用方法
このコールは、retrieve() コールの package.xml の個々のコンポーネントを識別する場合、または組織の
特定のメタデータ型の概要が必要な場合に役立ちます。たとえば、組織の CustomObject コンポーネントまたは
Layout コンポーネントのすべての名前のリストが返されるようにこのコールを使用できます。さらに、この情
報を使用して後続の retrieve() コールを実行し、これらのコンポーネントのサブセットが返されるように
することができます。package.xml の使用についての詳細は、「メタデータのリリースと取得」 (ページ 16)
を参照してください。
メモ: これは、結果が 1 つのコールで返される同期コールです。これは、結果を取得するために少なくと
も 1 つの後続のコールが必要な retrieve() などの非同期コールと異なります。
権限
クライアントアプリケーションは、「すべてのデータの編集」権限でログインしている必要があります。
82
ユーティリティコール
ListMetadataQuery
サンプルコード —Java
以下のサンプルコードでは、カスタムオブジェクトの情報を表示します。このコードは、SOAP バインドがす
でに確立されていることを前提としています。
public void listMetadata() {
try {
ListMetadataQuery query = new ListMetadataQuery();
query.setType("CustomObject");
//query.setFolder(null);
double asOfVersion = 32.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());
}
}
} catch (ConnectionException ce) {
ce.printStackTrace();
}
}
引数
名前
型
説明
queries
ListMetadataQuery[] 目的のコンポーネントを指定するオブジェクトのリスト。
asOfVersion
double
要求のリストを表示するメタデータの API バージョン。この項目に値を指
定しない場合、ログイン時に指定したデフォルトの API バージョンになり
ます。この項目を使用してデフォルトを上書きし、他の API バージョンを
設定できます。これにより、たとえば、ログイン時に指定した API バー
ジョンより後のバージョンで追加されたメタデータ型のメタデータのリ
ストを表示できます。この項目は API バージョン 18.0 以降で使用できま
す。
応答
FileProperties
ListMetadataQuery
listMetadata() コールで指定されている ListMetadataQuery パラメータは次のプロパティで構成されています。
83
ユーティリティコール
ListMetadataQuery
名前
型
説明
folder
string
コンポーネントに関連付けられたフォルダ。この
項目は、Dashboard、Document、EmailTemplate、Report
などのフォルダを使用するコンポーネントでは必
須です。
type
string
必須。CustomObject、CustomField、または
ApexClass などのメタデータ型。
84
第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 以前では、非同期メタデータコールの状況情報が
含まれています。
85
Result オブジェクト
AsyncResult
API バージョン 31.0 以前
API バージョン 31.0 では、メタデータを取得するプロセスが簡略化され、取得プロパティが RetrieveResult に移動
しました。また、非同期 create()、update()、および delete() コールが削除されました。そのため、
AsyncResult の id 項目のみが使用されます。id 項目は、リリースまたは取得の ID です。
AsyncResult は、次の非同期コールによって返されます。
• deploy()
• retrieve()
AsyncResult では、次の項目が使用されています。
名前
型
説明
id
ID
必須。リリースまたは取得されるコンポーネントの ID。
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 が返されますが、
項目は異なります。
名前
型
説明
done
boolean
必須。コールが完了したか (true)、否か (false) を示します。
id
ID
必須。作成、更新、削除、リリース、または取得されるコン
ポーネントの ID。
message
string
返される statusCode 項目に対応するメッセージ (存在する場
合)。
state
AsyncRequestState 必須。AsyncRequestState オブジェクトの値は、次の 4 つの
(string 型の列
値のいずれかです。
挙)
• Queued: このコールは開始していません。キューで待機して
います。
86
Result オブジェクト
名前
AsyncResult
型
説明
• InProgress: このコールは開始していますが、完了してい
ません。
• Completed: このコールは完了しました。
• Error: エラーが発生しました。詳細は、「statusCode」を
参照してください。
statusCode
StatusCode
(string 型の列
挙)
create()、update()、または delete() コール中にエラーが
発生した場合、状況コードが返され、その状況コードに対応す
るメッセージが message 項目に返されます。
各 StatusCode の値の説明については、『SOAP API 開発者ガイド』
の「StatusCode」を参照してください。
API バージョン 28.0 以前
API バージョン 28.0 以前では、AsyncResult は、次の非同期コールによって返されます。
• deploy()
• retrieve()
• create()
• update()
• delete()
各オブジェクトに対して checkStatus() コールを発行し、そのオブジェクトのコールが完了するタイミング
を検出します。Salesforce は、コール完了時またはエラー発生時に、各 AsyncResult オブジェクトを更新します。
同様に、deploy() および retrieve() コールは AsyncResult を使用しますが、リリースまたは取得の状況情報
をさらに取得するには、それぞれのコールの後に checkDeployStatus() または checkRetrieveStatus()
を使用する必要があります。
AsyncResult には次の項目があります。
名前
型
説明
checkOnly
boolean
組織で一切の変更を行わず、リリースされたファイルの有効性
を確認するためにこのリリースが使用されているか (true)、否
か (false) を示します。確認のみのリリースでは、いずれのコ
ンポーネントもリリースせず、組織の変更も一切行いません。
この項目は API バージョン 16.0 以降で使用でき、deploy() コー
ルのみに関連します。
done
boolean
必須。コールが完了したか (true)、否か (false) を示します。
id
ID
必須。作成、更新、削除、リリース、または取得されるコン
ポーネントの ID。
87
Result オブジェクト
AsyncResult
名前
型
説明
message
string
返される statusCode 項目に対応するメッセージ (存在する場
合)。
numberComponentErrors int
このリリース中にエラーを生成したコンポーネントの数。この
項目は API バージョン 16.0 以降で使用でき、deploy() コールの
みに関連します。
numberComponentsDeployed int
このリリースについて、リリースされたコンポーネントの数。
この項目は、numberComponentsTotal 項目と併せて、リリー
スの進行状況を示します。この項目は API バージョン 16.0 以降
で使用でき、deploy() コールのみに関連します。
numberComponentsTotal int
リリースのコンポーネントの合計数。この項目は、
numberComponentsDeployed 項目と併せて、リリースの進行
状況を示します。この項目は API バージョン 16.0 以降で使用で
き、deploy() コールのみに関連します。
numberTestErrors
int
このリリース中にエラーを生成したApexテストの数。この項目
は API バージョン 16.0 以降で使用でき、deploy() コールのみに
関連します。
numberTestsCompleted
int
このリリースの完了した Apex テスト数。この項目は、
numberTestsTotal 項目と併せて、リリースのテストの進行状
況を示します。この項目はAPIバージョン 16.0 以降で使用でき、
deploy() コールのみに関連します。
numberTestsTotal
int
リリースの Apex テストの合計数。この項目は、
numberTestsCompleted 項目と併せて、リリースのテストの
進行状況を示します。この項目の値は、リリースされるコン
ポーネントのテストが開始されるまで正確ではありません。こ
の項目は API バージョン 16.0 以降で使用でき、deploy() コール
のみに関連します。
secondsToWait
int
この項目は API バージョン 13.0 以降ではサポートされていませ
ん。後方互換性を確保するためにのみ提供されています。この
項目は API バージョン 17.0 で削除されました。
コールが完了するまでにかかるおおよその秒数を示します。こ
れは推定のみです。checkStatus() をコールする前に少し待っ
て、操作が完了したかを確認するのが合理的なアプローチで
す。以降の checkStatus() コールの各反復については、操作
が完了するまでの待機時間を 2 倍にします。
state
AsyncRequestState 必須。AsyncRequestState オブジェクトの値は、次の 4 つの
(string 型の列
値のいずれかです。
挙)
• Queued: このコールは開始していません。キューで待機して
います。
88
Result オブジェクト
CancelDeployResult
名前
型
説明
• InProgress: このコールは開始していますが、完了してい
ません。
• Completed: このコールは完了しました。
• Error: エラーが発生しました。詳細は、「statusCode」を
参照してください。
string
stateDetail
stateDetailLastModifiedDate dateTime
リリースされているコンポーネント、または実行しているApex
テストクラスを示します。この項目は API バージョン 16.0 以降
で使用でき、deploy() コールのみに関連します。
stateDetail 項目が最後に更新された日時。この項目は API
バージョン 16.0 以降で使用でき、deploy() コールのみに関連
します。
StatusCode
(string 型の列
挙)
statusCode
create()、update()、delete()、または deploy() コール
中にエラーが発生した場合、状況コードが返され、その状況
コードに対応するメッセージが message 項目に返されます。
各 StatusCode の値の説明については、『SOAP API 開発者ガイド』
の「StatusCode」を参照してください。
CancelDeployResult
リリースのキャンセルに関する情報 (キャンセルが完了したかどうかとリリース ID) が含まれます。
非同期メタデータコール cancelDeploy() は、CancelDeployResult オブジェクトを返します。
バージョン
API バージョン 30.0 以降で利用できます。
CancelDeployResult には次のプロパティがあります。
名前
型
説明
done
boolean
cancelDeploy() で開始されたリリースのキャンセルが完了した
か (true)、否か (false) を示します。
リリースが開始しておらず、まだキュー内にある場合、
cancelDeploy() コールでリリースは即座にキャンセルされ、こ
の項目は true を返します。それ以外でキャンセルが進行中の場
合、この項目は false を返します。
id
ID
キャンセルされるリリースの ID。
89
Result オブジェクト
DeployResult
DeployResult
関連付けられた deploy() コールの成功または失敗に関する情報が含まれます。
非同期メタデータコール checkDeployStatus() は DeployResult オブジェクトを返します。
API バージョン 29.0 では、Salesforce はリリースに関する情報を取得するプロセスを改善するために AsyncResult
(ページ 85) オブジェクトから DeployResult オブジェクトにいくつかのプロパティを移動しました。これらの変
更についての詳細は、「deploy()」 (ページ 32) を参照してください。
API バージョン 29.0 以降では、DeployResult オブジェクトには次のプロパティがあります。
名前
型
説明
id
ID
リリースされるコンポーネントの ID。
canceledBy
ID
リリースをキャンセルしたユーザの ID。
この項目は API バージョン 30.0 以降で使用できます。
canceledByName
string
リリースをキャンセルしたユーザの氏名。
この項目は API バージョン 30.0 以降で使用できます。
checkOnly
boolean
組織で一切の変更を行わず、リリースされたファイルの有効性を
確認するためにこのリリースが使用されているか (true)、否か
(false) を示します。確認のみのリリースでは、いずれのコンポー
ネントもリリースせず、組織の変更も一切行いません。
completedDate
dateTime
リリースプロセスの終了時期を示すタイムスタンプ。
createdBy
ID
リリースを作成したユーザの ID。
この項目は API バージョン 30.0 以降で使用できます。
createdByName
string
リリースを作成したユーザの氏名。
この項目は API バージョン 30.0 以降で使用できます。
createdDate
dateTime
deploy() コールの受信時期を示すタイムスタンプ。
details
DeployDetails[]
checkDeployStatus() コールの includeDetails パラメータ
が true に設定されている場合は、進行中または終了済みのリリー
スの詳細を示します。
done
boolean
指定された id に対する deploy() コールの処理がサーバで完了
したかどうかを示します。
errorMessage
string
errorStatusCode 項目に値がある場合は、それに対応するメッ
セージ。
90
Result オブジェクト
DeployResult
名前
型
説明
errorStatusCode
string
deploy() コール中にエラーが発生した場合、状況コードが返さ
れ、その状況コードに対応するメッセージが errorMessage 項
目に返されます。
各 StatusCode の値の説明については、『SOAP API 開発者ガイド』の
「StatusCode」を参照してください。
ignoreWarnings
boolean
省略可能。デフォルトは false です。リリース中に警告が発生
しても処理を続行するかどうかを指定します。本番組織へのリ
リースでは、この引数を true に設定することはできません。
lastModifiedDate
dateTime
リリースプロセスの最後の更新時期を示すタイムスタンプ。
numberComponentErrors int
このリリース中にエラーを生成したコンポーネントの数。
numberComponentsDeployed int
リリースプロセスでリリースされたコンポーネントの数。リリー
スの進行状況を見積もるには、この値を numberComponentsTotal
値で使用します。
numberComponentsTotal int
リリースのコンポーネントの合計数。リリースの進行状況を見積
もるには、この値を numberComponentsDeployed 値で使用しま
す。
numberTestErrors
int
このリリース中にエラーを生成した Apex テストの数。
numberTestsCompleted int
このリリースで完了したApexテストの数。リリースのテストの進
行状況を見積もるには、この値を numberTestsTotal 値で使用
します。
numberTestsTotal
int
このリリースのApexテストの合計数。リリースのテストの進行状
況を見積もるには、この値を numberTestsCompleted 値で使用
します。この項目の値は、リリースされるコンポーネントのテス
トが開始されるまで正確ではありません。
runTestsEnabled
boolean
Apex テストがこのリリースの一部として実行されたか (true)、否
か (false) を示します。テストは、リリースの一部として自動的
に実行されるか、deploy() コールの DeployOptions で実行す
るように設定できます。テストがいつ自動的に実行されるかにつ
いては、「リリースでのテストの実行」を参照してください。
この項目は API バージョン 30.0 以降で使用できます。
rollbackOnError
boolean
省略可能。デフォルトは true です。エラーが発生した場合、ロー
ルバックを完了するか (true)、否か (false) を示します。false
の場合、エラーなしで実行できるアクションのセットはすべて実
行され、残りのアクションではエラーが返されます。本番組織に
リリースする場合は、このパラメータは true に設定されている
必要があります。
91
Result オブジェクト
DeployResult
名前
型
説明
startDate
dateTime
リリースプロセスの開始時期を示すタイムスタンプ。
stateDetail
string
リリースされているコンポーネント、または実行しているApexテ
ストクラスを示します。
status
DeployStatus
リリースの現在の状況を示します。有効な値は、次のとおりで
(string 型の列挙) す。
• Pending
• InProgress
• Succeeded
• SucceededPartial
• Failed
• Canceling
• Canceled
boolean
success
リリースが正常に行われたか (true)、否か (false) を示します。
DeployDetails
deploy() コールで includeDetails パラメータが true に設定されている場合、これらの項目では、
DeployResult オブジェクトの details 項目の詳細情報を提供します。
メモ: リリースが引き続き処理中である場合、DeployDetails オブジェクトには componentFailures デー
タのみが含まれます。リリースプロセスの完了後に、その他の項目にリリース全体のデータが入力され
ます。
名前
型
説明
componentFailures DeployMessage[]
各コンポーネントのリリースエラーを含む 1 つ以上の DeployMessage
オブジェクト。
componentSuccesses DeployMessage[]
各コンポーネントの成功したリリースの詳細を含む 1 つ以上の
DeployMessage オブジェクト。
retrieveResult
RetrieveResult
deploy() コールに performRetrieve パラメータが指定されてい
た場合、deploy() プロセスの完了直後に retrieve() コールが実
行されます。この項目にはその取得の結果が含まれます。
runTestResult
RunTestsResult
deploy() コールで runAllTests パラメータまたは runTests パラ
メータがテストを実行するように設定されている場合、この項目に
はそれらのテストの結果が含まれます。リリースが引き続き処理中
である場合、この項目にはエラーデータのみが含まれます。リリー
スプロセスの完了後は、この項目にリリース全体のデータが入力さ
れます。
92
Result オブジェクト
DeployResult
API バージョン 28.0 以前の場合、DeployResult オブジェクトには次のプロパティがあります。
名前
型
説明
id
ID
リリースされるコンポーネントの ID。
messages
DeployMessage[]
deploy() コールの成功または失敗の情報が含まれます。
retrieveResult RetrieveResult
deploy() コールに performRetrieve パラメータが指定されていた場
合、deploy() プロセスの完了直後に retrieve() コールが実行されま
す。この項目にはその取得の結果が含まれます。
runTestResult RunTestsResult
deploy() コールで runAllTests パラメータまたは runTests パラメー
タがテストを実行するように設定されている場合、この項目にはそれら
のテストの結果が含まれます。
success
boolean
リリースが正常に行われたか (true)、否か (false) を示します。
DeployMessage
各 DeployResult オブジェクトには 1 つ以上の DeployMessage オブジェクトが含まれます。各 DeployMessage オブジェ
クトにはリリース .zip ファイルのコンポーネントのリリースの成功または失敗の情報が含まれます。
名前
型
説明
changed
boolean
true の場合、このリリースの結果としてコンポーネントが変更され
ました。false の場合、リリースされたコンポーネントは組織内にす
でにある対応するコンポーネントと同じものです。
columnNumber
int
各コンポーネントはテキストファイルで表されます。リリース中にエ
ラーが発生した場合、この項目はエラーが発生したテキストファイル
の列を表します。
componentType
string
このリリースでのコンポーネントのメタデータ型。
この項目は API バージョン 30.0 以降で使用できます。
created
boolean
true の場合、このリリースの結果としてコンポーネントが作成され
ました。false の場合、このリリースの結果としてコンポーネントが
削除されたか、または変更されたかのいずれかです。
createdDate
dateTime
このリリースの結果としてコンポーネントが作成された日時。
この項目は API バージョン 30.0 以降で使用できます。
deleted
boolean
true の場合、このリリースの結果としてコンポーネントが削除され
ました。false の場合、このリリースの結果としてコンポーネントが
新規作成されたか、または変更されたかのいずれかです。
fileName
string
このコンポーネントのリリースに使用される .zip ファイル内のファ
イルの名前。
93
Result オブジェクト
DeployResult
名前
型
説明
fullName
string
コンポーネントの完全名です。
Metadataから継承されるこの項目は、このメタデータ型の WSDL では定
義されません。作成時、更新時、または削除時に指定する必要があり
ます。コールにおけるこの項目の例を確認するには、「create()」
を参照してください。
id
ID
リリースされるコンポーネントの ID。
lineNumber
int
各コンポーネントはテキストファイルで表されます。リリース中にエ
ラーが発生した場合、この項目はエラーが発生したテキストファイル
の行番号を表します。
problem
string
エラーまたは警告が発生した場合、この項目にはコンパイルの失敗を
引き起こした問題の説明が含まれます。
problemType
DeployProblemType 問題の種別を示します。問題の詳細は problem 項目で追跡されます。
(string 型の列挙) 有効な値は、次のとおりです。
• Warning
• Error
この項目は API バージョン 18.0 以降で使用できます。バージョン 18.0
より前では、警告とエラーは区別されていませんでした。すべての問
題はエラーとして処理され、リリースの成功を妨げていました。
success
boolean
コンポーネントのリリースが正常に行われたか (true)、否か (false)
を示します。
RunTestsResult
コールは、指定された Apex のコンパイルが成功したか否か、単体テストが正常に完了したか否かについての
情報を返します。
RunTestsResult オブジェクトには、次のプロパティがあります。
名前
型
説明
codeCoverage
CodeCoverageResult[]
単体テストのコードカバー率の詳細を含む 1 つ以上の
CodeCoverageResult オブジェクトの配列。
codeCoverageWarnings CodeCoverageWarning[] テストの実行について警告する 1 つ以上のコード範囲の配列。
結果には、実行された行の合計数、実行されなかったコードの
数、行、列の位置が含まれています。
failures
RunTestFailure[]
単体テストの失敗があれば、それについての情報を含む 1 つ以
上の RunTestFailure オブジェクトの配列。
numFailures
int
単体テストの失敗数。
94
Result オブジェクト
DeployResult
名前
型
説明
numTestsRun
int
実行された単体テストの数。
successes
RunTestSuccess[]
成功についての情報があればその情報を含む 1 つ以上の
RunTestSuccesses オブジェクトの配列。
totalTime
double
テストの実行に費やした累積時間の合計。パフォーマンスの監
視に役立つ場合があります。
CodeCoverageResult
このオブジェクトを含む RunTestsResult オブジェクト。指定された Apex のコンパイルと単体テストの実行が正
常に行われたかどうかの情報が含まれています。
名前
型
説明
dmlInfo
CodeLocation[]
このプロパティには、テストされた各クラスまたはトリガについて、
また、テストされたコードの各部分について、DML ステートメント
の場所、コードが実行された回数、これらのコールに費やした累積
時間の合計が含まれています。パフォーマンスの監視に役立つ場合
があります。
id
ID
CodeLocation の ID。ID は組織内で一意です。
locationsNotCovered CodeLocation[]
テストされた各クラスまたはトリガについて、コードが一切カバー
されていない場合、テストされていないコードの行および列、コー
ドが実行された回数。
methodInfo
CodeLocation[]
テストされた各クラスまたはトリガについて、メソッド呼び出しの
場所、コードが実行された回数、これらのコールに費やした累積時
間の合計。パフォーマンスの監視に役立つ場合があります。
name
string
カバーされているクラスまたはトリガの名前。
namespace
string
指定されている場合、単体テストを含む名前空間。
numLocations
int
コードの場所の合計数。
soqlInfo
CodeLocation[]
テストされた各クラスまたはトリガについて、コードの SOQL ステー
トメントの場所、コードが実行された回数、これらのコールに費や
した累積時間の合計。パフォーマンスの監視に役立つ場合がありま
す。
type
string
使用しません。以前のサポートされていないリリースでは、クラス
またはパッケージの指定に使用されていました。
95
Result オブジェクト
DeployResult
CodeCoverageWarning
このオブジェクトは RunTestsResult オブジェクトに含まれ、警告を生成した Apex クラスに関する情報を保持し
ます。
このオブジェクトには次のプロパティがあります。
名前
型
説明
id
ID
CodeLocation の ID。ID は組織内で一意です。
message
string
生成された警告のメッセージ。
name
string
指定されている場合、単体テストを含む名前空間。
namespace
string
指定されている場合、単体テストを含む名前空間。
RunTestFailure
RunTestsResult オブジェクトは、単体テスト実行時の失敗に関する情報を返します。
このオブジェクトには次のプロパティがあります。
名前
型
説明
id
ID
失敗を生成したクラスの ID。
message
string
失敗のメッセージ。
methodName
string
失敗したメソッドの名前。
name
string
失敗したクラスの名前。
namespace
string
指定されている場合、クラスを含む名前空間。
stackTrace
string
失敗についてのスタック追跡。
time
double
失敗した処理についてテストの実行に費やした時間。パフォーマン
スの監視に役立つ場合があります。
type
string
使用しません。以前のサポートされていないリリースでは、クラス
またはパッケージの指定に使用されていました。
RunTestSuccess
RunTestsResult オブジェクトは、単体テスト実行時の成功に関する情報を返します。
このオブジェクトには次のプロパティがあります。
名前
型
説明
id
ID
成功を生成したクラスの ID。
96
Result オブジェクト
DescribeMetadataResult
名前
型
説明
methodName
string
成功したメソッドの名前。
name
string
成功したクラスの名前。
namespace
string
指定されている場合、単体テストを含む名前空間。
time
double
この操作についてテストの実行に費やした時間。パフォーマンスの
監視に役立つ場合があります。
CodeLocation
RunTestsResult オブジェクトは、多数の項目にこのオブジェクトを含みます。
このオブジェクトには次のプロパティがあります。
名前
型
説明
column
int
テストされた Apex の列の場所。
line
int
テストされた Apex の行の場所。
numExecutions
int
テスト実行時に Apex が実行された回数。
time
double
この場所で費やした累積時間の合計。パフォーマンスの監視に役立
つ場合があります。
DescribeMetadataResult
宣言型メタデータを使用する開発者に役立つ、組織に関する情報が含まれます。
describeMetadata() コールは DescribeMetadataResult オブジェクトを返します。
各 DescribeMetadataResult オブジェクトには次のプロパティがあります。
名前
型
説明
metadataObjects
DescribeMetadataObject[] 1 つ以上のメタデータコンポーネントおよびその属性。
organizationNamespace string
組織の名前空間。管理パッケージを含めることができる Developer
Edition 組織用にのみ指定します。管理パッケージには作成時に指
定される名前空間があります。
partialSaveAllowed boolean
rollbackOnError が許容されるか (true)、否か (false) を示し
ます。
この値は常に次のようになります。
• 本番組織では false。
• testRequired の反対。
97
Result オブジェクト
ReadResult
名前
型
説明
testRequired
boolean
テストが必要か (true)、否か (false) を示します。
この値は常に partialSaveAllowed の反対です。
DescribeMetadataObject
このオブジェクトは、DescribeMetadataResult の一部として返されます。各 DescribeMetadataObject には次のプロパ
ティがあります。
名前
型
説明
childXmlNames string[]
このコンポーネントの子サブコンポーネントのリスト。
directoryName string
このコンポーネントを含む .zip ファイルのディレクトリの名前。
inFolder
boolean
コンポーネントがフォルダ内にあるか (true)、否か (false) を示しま
す。たとえば、ドキュメント、メールテンプレート、およびレポートは
フォルダに保存されます。
metaFile
boolean
コンポーネントに付随するメタデータファイルが必要かどうかを示しま
す。たとえば、ドキュメント、クラス、Sコントロールは追加のメタデー
タファイルを必要とするコンポーネントです。
suffix
string
このコンポーネントのファイルサフィックス。
xmlName
string
このコンポーネントのメタデータファイルのルート要素の名前。また、
この名前は、マニフェストファイル package.xml の Packages > types
> name 項目にも表示されます。
ReadResult
readMetadata コールの結果情報が含まれます。
バージョン
API バージョン 30.0 以降で利用できます。
プロパティ
名前
型
説明
records
Metadata[]
readMetadata() から返されたメタデータコンポーネントの配
列。
98
Result オブジェクト
RetrieveResult
RetrieveResult
関連付けられた retrieve() コールの成功または失敗に関する情報が含まれます。
メタデータ retrieve() コールは RetrieveResult オブジェクトを返します。
各 RetrieveResult オブジェクトには、次の項目があります。
名前
型
説明
done
boolean
必須。retrieve() コールが完了したか (true)、否か (false) を示しま
す。この項目は、API バージョン 31.0 以降で使用できます。
errorMessage
string
retrieve() コール中にエラーが発生した場合、この項目にはこのエ
ラーを説明するメッセージが含まれます。この項目はAPIバージョン 31.0
以降で使用できます。
errorStatusCode StatusCode
retrieve() コール中にエラーが発生した場合、この項目にはこのエ
ラーの状況コードが含まれます。この項目は API バージョン 31.0 以降で
使用できます。
各 StatusCode の値の説明については、『SOAP API 開発者ガイド』の
「StatusCode」を参照してください。
fileProperties FileProperties[]
.zip ファイルの各コンポーネントのプロパティとマニフェストファイ
ル package.xml に関する情報が含まれます。コンポーネントごとに 1
つのオブジェクトが返されます。
id
ID
取得されるコンポーネントの ID。
messages
RetrieveMessage[]
retrieve() コールの成功または失敗に関する情報が含まれます。
status
RetrieveStatus (string retrieve() コールの状況。有効な値は、次のとおりです。
型の列挙)
• Pending
• InProgress
• Succeeded
• Failed
この項目は API バージョン 31.0 以降で使用できます。
success
boolean
retrieve() コールが正常に終了したか (true)、否か (false) を示しま
す。この項目は API バージョン 31.0 以降で使用できます。
zipFile
base64Binary
retrieve 要求で返された zip ファイル。Base 64 で符号化されたバイナリデー
タ API コールを行う前に、クライアントアプリケーションはバイナリ添
付データを base64 に符号化する必要があります。応答を受信したら、ク
ライアントアプリケーションは、base64 データをバイナリに復号化する
必要があります。この変換は、通常 SOAP クライアントによって処理さ
れます。
99
Result オブジェクト
RetrieveResult
FileProperties
このコンポーネントには、.zip ファイルの各コンポーネントのプロパティとマニフェストファイル
package.xml に関する情報が含まれます。コンポーネントごとに 1 つのオブジェクトが返されます。このコ
ンポーネントには、.zip ファイル内の関連付けられたメタデータファイルに関する情報は含まれず、コン
ポーネントファイルとマニフェストファイルに関する情報のみが含まれます。FileProperties には次のプロパティ
が含まれます。
名前
型
説明
createdById
string
必須。ファイルを作成したユーザの ID。
createdByName
string
必須。ファイルを作成したユーザの名前。
createdDate
dateTime
必須。ファイルが作成された日時。
fileName
string
必須。ファイルの名前。
fullName
string
必須。APIアクセスの一意の識別子として使用される、ファイル
の開発者名。値は fileName に基づいていますが、許容される
文字はより制限されます。fullName には、アンダースコアと
英数字のみを使用できます。一意であること、最初は文字であ
ること、空白は使用しない、最後にアンダースコアを使用しな
い、2 つ続けてアンダースコアを使用しないという制約があり
ます。
id
string
必須。ファイルの ID。
lastModifiedById string
必須。ファイルを最後に更新したユーザの ID。
lastModifiedByName string
必須。ファイルを最後に更新したユーザの名前。
lastModifiedDate dateTime
必須。ファイルが最後に更新された日時。
manageableState
ManageableState (string 指定されたコンポーネントがパッケージに含まれている場合、
型の列挙)
そのコンポーネントの管理可能な状態を示します。
• beta
• deleted
• deprecated
• installed
• released
• unmanaged
Force.com AppExchange パッケージのコンポーネントの管理可能性
の状態に関する詳細は、Salesforceオンラインヘルプの「管理パッ
ケージのリリースの計画」を参照してください。
namespacePrefix
string
コンポーネントの名前空間プレフィックス (ある場合)。
100
Result オブジェクト
SaveResult
名前
型
説明
type
string
必須。CustomObject、CustomField、または ApexClass な
どのメタデータ型。
RetrieveMessage
RetrieveResult はこのオブジェクトを返します。このオブジェクトには、retrieve() コールの成功または失敗
に関する情報が含まれます。問題ごとに 1 つのオブジェクトが返されます。
名前
型
説明
fileName
string
取得された .zip ファイルに含まれる、問題が発生したファイルの名
前。
problem
string
発生した問題の説明。
関連トピック:
retrieve()
SaveResult
createMetadata、updateMetadata、または renameMetadata コールの結果情報が含まれます。
バージョン
API バージョン 30.0 以降で利用できます。
プロパティ
名前
型
説明
errors
Error[]
操作が成功しなかった場合に返されるエラーの配列。
fullName
string
処理されたコンポーネントの完全名。
success
boolean
操作が成功したか (true)、否か (false) を示します。
DeleteResult
deleteMetadata コールの結果情報が含まれます。
101
Result オブジェクト
UpsertResult
バージョン
API バージョン 30.0 以降で利用できます。
プロパティ
名前
型
説明
errors
Error[]
操作が成功しなかった場合に返されるエラーの配列。
fullName
string
削除されたコンポーネントの完全名。
success
boolean
削除が成功したか (true)、否か (false) を示します。
UpsertResult
関連付けられた upsertMetadata() コールの結果に関する情報が含まれます。
バージョン
API バージョン 31.0 以降で利用できます。
プロパティ
名前
型
説明
created
boolean
更新/挿入操作の結果、コンポーネントが作成されたか (true)、
否か (false) を示します。false で更新/挿入操作が成功した場
合は、コンポーネントが更新されたことを意味します。
errors
Error[]
操作が成功しなかった場合に返されたエラーの配列。
fullName
string
操作が成功した場合に作成または更新されたコンポーネントの
完全名。
success
boolean
操作が成功したか (true)、否か (false) を示します。
Error
同期 CRUD (createMetadata()、updateMetadata()、または deleteMetadata()) 操作中に発生したエラー
を表します。
102
Result オブジェクト
Error
バージョン
API バージョン 30.0 以降で利用できます。
プロパティ
名前
型
説明
fields
string[]
エラー条件に影響を与えた項目の名前を含む配列。
message
string
エラーメッセージテキスト。
statusCode
StatusCode
エラーに対応する状況コード。
各 StatusCode の値の説明については、『SOAP API 開発者ガイド』
の「StatusCode」を参照してください。
103
第 10 章
メタデータ型
メタデータ API では、カスタマイズできるユーザインターフェースのすべてにアクセスを許可するわけではあ
りません。次の表には、メタデータ API を使用して取得またはリリースできるすべてのメタデータ型、型の取
得時の package.xml におけるワイルドカード (*) 記号の使用の可否、および各型の詳細ページへのリンクが
記載されています。ワイルドカード使用についての詳細は、「Zip ファイルの使用」 (ページ 16)を参照してく
ださい。メタデータ型は、必ずしも関連するデータ型に直接対応するわけではないため、情報がアクセス可能
である場合でも、期待通りに構成されるとは限りません。たとえば連動選択リストは、別のメタデータ型では
なく、選択リストの型として公開されます。
メタデータ型
ワイルドカード (*) 説明
を使用できるか
AccountSettings
はい
取引先チーム、取引先所有者レポート、[階層の表示]リンクの
組織の取引先設定を表します。
ActionOverride
いいえ
標準オブジェクトまたはカスタムオブジェクトの override アク
ションを表します。これを使用して、override アクションを作
成、更新、編集、または削除します。
ActivitiesSettings
はい
組織の活動設定と、カレンダー用のユーザインターフェース
設定を表します。
AddressSettings
はい
国選択リストと州選択リストの設定を表します。
AnalyticSnapshot
いいえ
分析スナップショットを表します。分析スナップショットに
より、履歴データに関するレポートを作成できます。承認さ
れたユーザは、表形式のレポートやサマリーレポートの結果
をカスタムオブジェクトの項目に保存することができ、それ
らの項目を対象オブジェクト上の対応する項目に割り当てる
ことができます。その上で、レポートをいつ実行してそのカ
スタムオブジェクトの項目にレポートのデータを読み込むか
をスケジューリングできます。分析スナップショットでは、
一般の Salesforce でのレコード操作と同様のレポートデータ操
作を実行できます。
ApexClass
はい
Apex クラスを表します。Apex クラスは、Apex オブジェクトを
作成するためのテンプレート、つまり設計図です。クラスは、
他のクラス、ユーザ定義メソッド、変数、例外型、および静
的初期化コードで構成されます。
ApexComponent
はい
Visualforce コンポーネントを表します。
104
メタデータ型
メタデータ型
ワイルドカード (*) 説明
を使用できるか
ApexPage
はい
1 つの Visualforce ページを表します。
ApexTrigger
はい
Apex トリガを表します。トリガは、オブジェクトレコードが
データベースに挿入される前や、レコードが削除された後な
ど、特定のデータ操作言語 (DML) 行動が発生する前後に実行さ
れる Apex コードです。
AppMenu
はい
Force.com アプリケーションメニューまたは Salesforce1 ナビゲー
ションメニューを表します。
ApprovalProcess
はい
承認プロセスに関連付けられたメタデータを表します。承認
プロセスは、Salesforceでレコードを承認する場合に、組織で使
用できる自動化されたプロセスです。承認プロセスでは、承
認するレコードの条件と各承認ステップの承認者を指定しま
す。各承認ステップは、その承認プロセスの対象レコードす
べてに適用することも、システム管理者が定義した特定の条
件を満たすレコードのみに適用することもできます。承認プ
ロセスでは、レコードの承認、却下、取り消しまたは最初の
承認申請時に実施するアクションも指定します。
(説明を参照)
ワイルドカード (*) 記号を使用して、すべてのオブジェクトの
すべての承認プロセスを取得できます。ワイルドカードは承
認プロセスのサブセットの取得には使用できません。Lead.*
のような構文はサポートされません。
ArticleType
はい
記事タイプに関連付けられたメタデータを表します。
AssignmentRules
はい
適切なユーザまたはキューに自動的にケースを転送できる割
り当てルールを表します。
AuthProvider
はい
組織の認証プロバイダを表します。認証プロバイダは Facebook©
や Janrain© などの外部サービスプロバイダのログイン情報を使
用して、Salesforce 組織にユーザがログインできるようにしま
す。
AutoResponseRules
はい
提出されたレコードの属性に基づいてリードまたはケース登
録に自動メールレスポンスを送信する条件を設定する自動レ
スポンスルールを表します。
(説明を参照)
条件に基づく共有ルールおよび所有者に基づく共有ルールの
基本コンテナを表します。
BaseSharingRule
ワイルドカードのサポートについては、CriteriaBasedSharingRule
および OwnerSharingRule のエントリを参照してください。
105
メタデータ型
メタデータ型
BusinessHoursSettings
ワイルドカード (*) 説明
を使用できるか
はい
エンタイトルメント、エンタイトルメントテンプレート、キャ
ンペーン、ケースの営業時間および休日の設定管理に使用す
るメタデータを表します。
いいえ
BusinessProcess メタデータ型によって、ユーザのプロファイル
に基づいて異なる選択リスト値を表示できます。
CallCenter
はい
Salesforceをサードパーティのコンピュータテレフォニーインテ
グレーション (CTI) システムと統合するために使用されるコー
ルセンター定義を表します。
CaseSettings
はい
デフォルトのケース所有者、有効化されるケース関連機能、
各種ケース活動に使用されるメールテンプレートなど、組織
のケース設定を表します。
ChatterAnswersSettings
はい
Chatter アンサーの設定管理に使用するメタデータを表します。
CompanySettings
はい
組織内の複数の機能に影響するグローバル設定を表します。
Community (Zone)
はい
アイデアオブジェクトまたは Chatter アンサーオブジェクトを
含むゾーンを表します。ゾーンは、アイデア、アンサー、お
よび Chatter アンサー機能で共有されるため、このどこからで
もゾーンを表示および作成できます。
CompactLayout
はい
コンパクトレイアウトに関連付けられたメタデータを表しま
す。
ConnectedApp
はい
接続アプリケーション設定を表します。接続アプリケーショ
ンは、API を使用して Salesforce と統合します。接続アプリケー
ションでは、標準の SAML および OAuth プロトコルを使用して、
認証、シングルサインオンの提供、SalesforceAPIで使用するトー
クンの提供を行います。接続アプリケーションでは、標準の
OAuth 機能に加え、システム管理者がさまざまなセキュリティ
ポリシーを設定したり、対応するアプリケーションを使用で
きるユーザを明示的に制御したりできます。
ContractSettings
はい
契約の設定を表します。
CorsWhitelistOrigin
はい
CORS ホワイトリストのオリジンを表します。
CriteriaBasedSharingRule
はい
条件に基づく共有ルールを表します。CriteriaBasedSharingRule を
使用すると、特定の条件に基づいたレコードの共有を行えま
す。取引先、キャンペーン、ケース、取引先責任者、カスタ
ムオブジェクト、リード、商談の特定の条件に基づく共有ルー
ルのメタデータが含まれます。
BusinessProcess
(説明を参照)
ワイルドカード (*) は、カスタムオブジェクトを除くすべての
型でサポートされます。
106
メタデータ型
メタデータ型
ワイルドカード (*) 説明
を使用できるか
CustomApplication
はい
CustomApplication はカスタムアプリケーションまたは標準アプ
リケーションを表します。API バージョン 29.0 以前では、
CustomApplication はカスタムアプリケーションのみを表します。
アプリケーションは、説明とロゴを使用したタブ参照のリス
トです。
CustomApplicationComponent
はい
Salesforce コンソールとしてマークされている CustomApplication
に割り当てられたカスタムコンソールコンポーネント (Visualforce
ページ) を表します。カスタムコンソールコンポーネントは、
Salesforce コンソールアプリケーションの機能を拡張します。
CustomField
いいえ
項目に関連付けられたメタデータを表します。標準オブジェ
クト、カスタムオブジェクト、および外部オブジェクトのカ
スタム項目の定義または標準オブジェクトの標準項目の定義
を作成、更新、削除するには、このメタデータ型を使用しま
す。
CustomLabel
いいえ
異なる言語、国、および通貨にローカライズして使用できる
カスタム表示ラベルを表します。名前でカスタム表示ラベル
を取得する場合は、CustomLabels ではなくこの型を使用します。
CustomLabels
はい
このメタデータ型を使用して、異なる言語、国、および通貨
で使用するためにローカライズできるカスタム表示ラベルを
作成できます。
CustomObject
(説明を参照)
組織に固有のデータを保存するカスタムオブジェクト、また
は Salesforce の外部に保存されているデータに対応付けられる
外部オブジェクトを表します。
また、このメタデータ型を使用して、取引先などの標準オブ
ジェクトのカスタマイズを行うこともできます。override アク
ション、ビジネスプロセス、カスタム項目、項目セット、リ
ストビュー、名前付き条件 (ルックアップ検索条件)、選択リス
ト (連動選択リストを含む)、レコードタイプ、検索レイアウ
ト、共有の理由、共有再適用、入力規則、Web リンク、項目種
別が含まれます。
ワイルドカード (*) は、項目セットとレコードタイプではサポー
トされますが、他のコンポーネントではサポートされません。
CustomObjectTranslation
はい
このメタデータ型を使用して、カスタムオブジェクトをさま
ざまな言語に翻訳できます。
CustomPageWebLink
はい
ホームページコンポーネントに定義された Web リンクを表し
ます。
CustomPermission
はい
カスタム機能へのアクセス権限を付与する権限を表します。
107
メタデータ型
メタデータ型
ワイルドカード (*) 説明
を使用できるか
CustomSite
はい
Force.com サイトを表します。Force.com サイトでは、公開 Web
サイトとアプリケーションを作成できます。それらはSalesforce
組織と直接統合されるため、ユーザがログインする場合にユー
ザ名やパスワードは必要ありません。
CustomTab
はい
カスタムタブを表します。カスタムタブとは、カスタムオブ
ジェクトのデータや、アプリケーションに埋め込まれている
他の Web コンテンツを表示するために作成するユーザインター
フェースコンポーネントのことです。タブにカスタムオブジェ
クトが表示されているとき、タブ名はカスタムオブジェクト
名と同じになります。ページ、Sコントロール、または URL タ
ブの場合は任意の名前です。
Dashboard
いいえ
ダッシュボードを表します。ダッシュボードは、総計値とパ
フォーマンスを一目で理解できるように表示されたデータの
視覚的表現です。
DataCategoryGroup
はい
データカテゴリグループを表します。
Document
いいえ
ドキュメントを表します。すべてのドキュメントは、
sampleFolder/TestDocument などのドキュメントフォルダ
内にある必要があります。
EmailTemplate
いいえ
メールテンプレートを表します。
EntitlementProcess
はい
エンタイトルメントプロセスの設定を表します。
EntitlementSettings
はい
組織のエンタイトルメント設定を表します。
EntitlementTemplate
はい
エンタイトルメントテンプレートを表します。エンタイトル
メントテンプレートは、商品にすばやく追加できる、事前定
義されたカスタマサポートの条件です。たとえば、ユーザが
顧客に提供される商品にエンタイトルメントを容易に追加で
きるよう Web サポートまたは電話サポートのエンタイトルメ
ントテンプレートを作成できます。
ExternalDataSource
はい
外部データソースに関連付けられたメタデータを表します。
外部データソースを作成して、Salesforce の外部にあるデータ
ソースとのインテグレーションに関する接続の詳細を管理し
ます。
FieldSet
はい
項目セットを表します。項目セットとは、項目をグループ化
したものです。たとえば、ユーザの名、ミドルネーム、姓、
肩書を示す項目を 1 つの項目セットにして持つことができま
す。
108
メタデータ型
メタデータ型
ワイルドカード (*) 説明
を使用できるか
FlexiPage
はい
フレキシブルページに関連付けられたメタデータを表します。
フレキシブルページは、Salesforce1 ナビゲーションメニューの
メニュー項目として表示されるモバイルアプリケーションの
ホームページです。
Flow
はい
フローに関連付けられたメタデータを表します。フローを使
用すると、ユーザが一連の画面を移動してデータベース内の
レコードをクエリおよび更新するアプリケーションを作成で
きます。また、ユーザ入力に基づいてロジックを実行して分
岐機能を提供し、動的なアプリケーションを構築できます。
Folder
いいえ
フォルダを表します。フォルダには、ドキュメント、メール
テンプレート、レポート、またはダッシュボードが含まれま
す。取得またはリリースするフォルダの種類 (Document、
EmailTemplate、Report、Dashboard) を指定する必要があります。
FolderShare
いいえ
拡張分析フォルダの共有設定を表します。レポートまたはダッ
シュボードを含むフォルダへの閲覧者、エディタまたはマネー
ジャアクセス権を他のユーザに付与することにより、レポー
トまたはダッシュボードへのアクセスを制御できます。
ForecastingSettings
はい
コラボレーション売上予測設定オプションを表します。
Group
はい
ユーザ、ロールおよびその他のグループを含めることができ
る公開グループのセットを表します。
HomePageComponent
はい
ホームページコンポーネントに関連付けられたメタデータを
表します。[ホーム] タブにサイドバーリンク、会社のロゴ、
ダッシュボードのスナップショット、作成したカスタムコン
ポーネントなどのコンポーネントを含めるようにカスタマイ
ズできます。
HomePageLayout
はい
ホームページのレイアウトに関連付けられたメタデータを表
します。ホームページのレイアウトをカスタマイズし、ユー
ザのプロファイルに基づいてユーザにレイアウトを割り当て
ることができます。
IdeasSettings
はい
アイデアの設定管理に使用するメタデータを表します。
InstalledPackage
はい
インストールまたはアンインストールするパッケージを表し
ます。現在インストールされているパッケージの新バージョ
ンをリリースすると、パッケージがアップグレードされます。
KnowledgeSettings
はい
Salesforce ナレッジの設定管理に使用するメタデータを表しま
す。
Layout
はい
ページレイアウトに関連付けられたメタデータを表します。
109
メタデータ型
メタデータ型
ワイルドカード (*) 説明
を使用できるか
Letterhead
いいえ
メールテンプレートのレターヘッドの書式設定オプションを
表します。レターヘッドは、HTML メールテンプレートのデザ
インを定義します。レターヘッドからは、使用するロゴ、ペー
ジの色、およびテキスト設定を HTML メールテンプレートに継
承できます。
ListView
いいえ
ListView では取引先責任者、取引先、またはカスタムオブジェ
クトなどのレコードの条件設定済みリストを表示できます。
LiveAgentSettings
はい
Live Agentが有効化されているかどうかなどの、組織のLive Agent
設定を表します。
LiveChatAgentConfig
はい
エージェントに割り当て可能なチャット数や、チャットサウ
ンドを有効化するかどうかなど、組織の Live Agent リリースの
設定を表します。
LiveChatButton
はい
ボタンの表示ラベルやライブチャットの開始前に表示される
チャット前フォームなど、エージェントとチャットするため
に顧客がクリックするボタンやチャットウィンドウのLive Agent
リリースの設定を表します。
LiveChatDeployment
はい
リリースのブランド画像や、チャットのトランスクリプトを
自動的に保存するかどうかなど、特定の Live Agent リリースの
設定を表します。
ManagedTopics
はい
コミュニティで管理されているナビゲーショントピックと主
要トピックを表します。
Metadata
いいえ
これはすべてのメタデータ型の基本クラスです。このオブジェ
クトを編集することはできません。コンポーネントは、メタ
データ型のインスタンスです。
MetadataWithContent
いいえ
これは、ドキュメントまたはメールテンプレートなどのコン
テンツが含まれるすべてのメタデータ型の基本型で、
MilestoneType
はい
マイルストンの名前と説明を表します。これらをエンタイト
ルメントプロセスで使用して、ケースの重要なステップを追
跡できます。
MobileSettings
はい
Chatter設定や、Mobile Liteが有効化されているかどうかなどの、
組織のモバイル設定を表します。
いいえ
このコンポーネントは API バージョン 30.0 で削除され、後方互
換性の目的でのみ提供されています。ルックアップ検索条件
に関連付けられたメタデータは、CustomFieldコンポーネントの
lookupFilter 項目によって表されるようになりました。
NamedFilter
110
メタデータ型
メタデータ型
ワイルドカード (*) 説明
を使用できるか
ルックアップ検索条件に関連付けられたメタデータを表しま
す。ルックアップ検索条件の定義を作成、更新、または削除
するには、このメタデータ型を使用します。
Network
OpportunitySettings
はい
コミュニティを表します。コミュニティとは、従業員、顧客、
パートナーがつながることのできるブランド空間です。ビジ
ネスニーズに合ったコミュニティを複数カスタマイズおよび
作成し、コミュニティ間をシームレスに移行できます。Salesforce
Communities には Network コンポーネントを使用します。Chatter
アンサーおよび アイデアを含むゾーンを作成する場合は、
Community (Zone) コンポーネントを使用します。
いいえ
商談の自動更新や類似商談条件検索などの機能に関する組織
の設定を表します。
OrderSettings
はい
注文の設定を表します。
OwnerSharingRule
はい
所有権ベースの共有ルールを表します。OwnerSharingRule を使
用すると、対象のユーザグループのアクセスレベルを指定す
るルールを使用して、あるユーザのセットが所有するレコー
ドを他のユーザのセットと共有することができます。取引先、
キャンペーン、ケース、取引先責任者、カスタムオブジェク
ト、リード、取引先テリトリー、商談の特定の所有者共有ルー
ルのメタデータが含まれます。
(説明を参照)
ワイルドカード (*) は、カスタムオブジェクトを除くすべての
型でサポートされます。
Package
いいえ
retrieve() コールの一部として取得するメタデータコンポー
ネントを指定するため、またはコンポーネントのパッケージ
を定義するために使用されます。
PermissionSet
はい
ユーザのプロファイルを変更せずに、追加権限の許可に使用
する権限のセットを表します。アクセスの許可に権限セット
を使用できますが、アクセスの拒否には使用できません。
いいえ
カスタムオブジェクトのカスタム項目、または取引先などの
標準オブジェクトのカスタム項目または標準項目の選択リス
ト (または連動選択リスト) の定義を表します。
Portal
はい
Portal メタデータ型はパートナーポータルまたはカスタマーポー
タルを表します。
PostTemplate
はい
[Chatter での承認] の承認投稿テンプレートに関連付けられたメ
タデータを表します。承認投稿テンプレートでは、Chatter
フィードに表示される承認申請投稿に含まれる情報をカスタ
マイズできます。
Picklist (連動選択リストを
含む)
111
メタデータ型
メタデータ型
ProductSettings
ワイルドカード (*) 説明
を使用できるか
いいえ
数量スケジュール、収益スケジュール、および有効フラグと
価格の相互作用の組織の設定を表します。
Profile
はい
ユーザプロファイルを表します。プロファイルは、Salesforce内
でさまざまな機能を実行するためのユーザの権限を定義しま
す。
Queue
はい
処理する前にアイテムを置いておく領域を表します。
QuickAction
はい
Chatterパブリッシャーで使用可能となるオブジェクトに対して
指定された作成または更新アクションを表します。たとえば、
取引先の詳細ページで、ユーザがそのページの Chatter フィー
ドからその取引先に関連する取引先責任者を作成するアクショ
ンを作成できます。QuickActionは、カスタム項目が許可された
オブジェクトで作成できます。
いいえ
商品およびサービスの提案された価格を示す見積を有効また
は無効にします。
RecordType
はい
レコードタイプに関連付けられたメタデータを表します。レ
コードタイプを使用すると、異なるビジネスプロセス、選択
リストの値、およびページレイアウトを、さまざまなユーザ
に提供できます。
RemoteSiteSetting
はい
リモートサイトの設定を表します。Sコントロールやカスタム
ボタンで XmlHttpRequest を使用し、Visualforce ページ、Apex 呼び
出し、または JavaScript コードで外部サイトを呼び出せるよう
にするには、[リモートサイトの設定] ページにそのサイトを登
録しておく必要があります。これを行わないと、呼び出しは
失敗します。
QuoteSettings
Report
いいえ
カスタムレポートを表します。
ReportType
はい
カスタムレポートタイプに関連付けられたメタデータを表し
ます。カスタムレポートタイプを使用すると、ユーザがレポー
トを作成またはカスタマイズできるフレームワークを構築で
きます。
Role
はい
組織内のロールを表します。
SamlSsoConfig
はい
SAML シングルサインオン設定を表します。
Scontrol
はい
非推奨。Salesforce ユーザインターフェースの Sコントロールに
対応する、Scontrol コンポーネントを表します。
いいえ
オブジェクトの検索レイアウトに関連付けられたメタデータ
を表します。検索結果、検索条件項目、ルックアップダイア
SearchLayouts
112
メタデータ型
メタデータ型
ワイルドカード (*) 説明
を使用できるか
ログ、およびタブホームページの最近のレコードリストに表
示される項目をカスタマイズできます。
SecuritySettings
はい
組織のセキュリティ設定を表します。セキュリティ設定は、
ネットワークアクセス用の信頼できる IP 範囲、パスワードと
ログインの要件、およびセッション終了とセキュリティ設定
を定義します。
SharingReason
いいえ
カスタムオブジェクトに共有が実装された理由を示すために
使用される Apex の共有の理由を表します。
SharingRecalculation
いいえ
特定のカスタムオブジェクトの Apex による共有管理を再適用
する Apex クラスを表します。
(説明を参照)
共有ルールのセットを表します。SharingRules を使用すると、対
象ユーザグループのアクセスレベルを指定するルールを使用
して、レコードをユーザのセットと共有できます。
SharingRules
ワイルドカードのサポートについては、CriteriaBasedSharingRule
および OwnerSharingRule のエントリを参照してください。
SharingSet
はい
共有セットを表します。共有セットでは、アクセス権の対応
付けを定義して、ポータルユーザまたはコミュニティユーザ
に、取引先または取引先責任者に関連付けられたオブジェク
トへのアクセス権を付与します。
SiteDotCom
はい
リリース用のサイトを表します。MetadataWithContent 型を拡張
し、その fullName 項目と content 項目を継承します。
Skill
はい
スキル名や、スキルを割り当てるエージェントなど、Live Agent
でエージェントにチャットを転送するために使用するスキル
の設定を表します。
StaticResource
はい
静的リソースファイルを表します。多くの場合は、ZIP ファイ
ル内のコードライブラリです。
SynonymDictionary
はい
シノニムグループ (ユーザの検索で同義とされる語または句の
集合) のセットを表します。シノニムグループを定義して、頭
字語、商品名のバリエーション、および組織に固有のその他
の用語の検索結果を最適化できます。
Territory
はい
組織内のテリトリーを表します。
Territory2
はい
Territory Management 2.0 で営業テリトリーに関連付けられている
メタデータを表します。
113
メタデータ型
メタデータ型
ワイルドカード (*) 説明
を使用できるか
Territory2Model
はい
Territory Management 2.0 でテリトリーモデルに関連付けられてい
るメタデータを表します。
Territory2Rule
はい
Territory Management 2.0 で Account などのオブジェクトに関連付
けられているテリトリー割り当てルールに関連付けられてい
るメタデータを表します。
いいえ
Territory Management 2.0 ユーザが、営業テリトリーに関連付けら
れているレコードにアクセスして変更できるようにするため
のデフォルト設定のメタデータを表します。標準レコードア
クセス設定は、取引先と商談に適用されます。組織で取引先
責任者とケースに「非公開」のデフォルトの内部アクセス権を
使用している場合は、それらのレコードのアクセス権も設定
できます。
Territory2Type
はい
Territory Management 2.0 にあるテリトリーのカテゴリのメタデー
タを表します。すべての Territory2 に Territory2Type が必要です。
Translations
はい
このメタデータ型を使用して、さまざまな使用言語の翻訳を
処理できます。
ValidationRule
いいえ
入力規則を表します。入力規則は、ユーザがレコードに入力
したデータが有効で保存可能かどうかを確認するために使用
されます。入力規則には、1 つ以上の項目のデータを評価する
数式が含まれ、true または false の値を返します。入力規
則には、無効なデータによりルールが true の値を返すとき
に、クライアントアプリケーションがユーザに表示できるエ
ラーメッセージも含まれます。
Weblink
いいえ
カスタムオブジェクトに定義された Web リンクを表します。
Workflow
はい
ワークフロールールに関連付けられたメタデータを表します。
ワークフロールールは、指定された条件に該当するときに、
ワークフローアクションを実行します。ワークフローアクショ
ンは、ワークフロールールで指定された条件をレコードが満
たすとただちに実行するか、タイムトリガを設定して特定の
日に実行するように設定することができます。
XOrgHub
いいえ
組織間データ接続のハブ組織に関連付けられているメタデー
タを表します。
XOrgHubSharedObject
いいえ
組織間データ接続の共有オブジェクトに関連付けられている
メタデータを表します。
Territory2Settings
114
メタデータ型
Metadata コンポーネントおよびメタデータ型
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 での選択リストと同じです。項目
の有効な値は、同じデータ型を持つ指定可能な値のセットに厳密に制限されます。これらの値のリストは、各
列挙項目の項目の説明列に示されます。string 型の列挙項目の例については、「sortBy」を参照してくださ
い。以下の XML では WSDL の string 型の列挙の定義のサンプルを示します。
<xsd:simpleType name="DashboardComponentFilter">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="RowLabelAscending"/>
<xsd:enumeration value="RowLabelDescending"/>
115
メタデータ型
サポートされていないメタデータ型
<xsd:enumeration value="RowValueAscending"/>
<xsd:enumeration value="RowValueDescending"/>
</xsd:restriction>
</xsd:simpleType>
サポートされているコール
個々のコンポーネントセクションで別途指定されていない限り、すべてのメタデータ型はメインコールでサ
ポートされています。メタデータ API のメインコールは、次のとおりです。
• CRUD コール (createMetadata()、deleteMetadata() など)
• ファイルベースのコール (deploy()、retrieve() など)
• ユーティリティ コール (listMetadata()、describeMetadata() など)
サポートされていないメタデータ型
Salesforce 組織でカスタマイズできるコンポーネントの一部をメタデータ API では使用できません。
次のコンポーネントは メタデータ API では取得またはリリースできません。また、これらのコンポーネントへ
の変更は組織ごとに手動で行う必要があります。
• 取引先チーム
• 活動ボタンの上書き
• 分析設定
• カスタマイズ可能な標準項目での自動採番
• キャンペーンの影響
• ケース取引先責任者の役割
• ケースフィードのレイアウト
• ケースチーム内の役割
• コンソールレイアウト
• 通貨の換算レート
• データカテゴリの表示設定
• 代理管理者
• ディビジョン
• メールサービス
• 会計年度
• HTML ドキュメントと添付ファイルの設定
• リードの設定
• 差し込み印刷テンプレート
• モバイル管理
• モバイルユーザとデバイス
• オフラインブリーフケース設定
116
メタデータ型
メタデータ API リリースの特殊な動作
• 商談の大規模商談アラート
• 商談アップデートリマインダー
• 組織のメールアドレス
• パートナー管理
• 定義済みのケースチーム
• 商品スケジュール設定
• 公開およびリソースカレンダー
• 見積テンプレート
• Salesforce to Salesforce
• 選択リスト項目と参照項目を除く標準項目
• 検索設定
• セルフサービスポータルのフォントと色
• セルフサービスポータルの設定
• セルフサービスポータルユーザ
• セルフサービス公開ソリューション
• セルフサービス Web-to-ケース
• 組織の共有設定の共有
• Site.com
• ソーシャル取引先/取引先責任者の設定
• ソリューションカテゴリ
• ソリューション設定
• タグ設定
• テリトリー割り当てルール
• ユーザインターフェース設定 (ActivitiesSettings (ページ 507) でサポートされているカレンダー機能を除く)
• 個人取引先ページレイアウトの Web リンク
• Web-to-リード
メタデータ API リリースの特殊な動作
リリースの特定の種類と内容に関する重要な考慮事項
変更を組織にリリースする場合、成功するために必要なすべての変更が含まれるように、リリースの個々のコ
ンポーネントがどのように動作するのかを考慮します。次の情報を参考にして、リリースに含めるものや、対
象組織での変更の表示方法を決定してください。
Apex クラスおよび Apex トリガ
デフォルトでは、Apex ジョブを待機中または処理中にする Apex コードへの変更はリリースできません。こ
れらの変更をリリースするには、次のいずれかを実行します。
• Apexコードへの変更をリリースする前に、Apexジョブをキャンセルします。リリース後にジョブを再ス
ケジュールします。
117
メタデータ型
メタデータ API リリースの特殊な動作
• Salesforce ユーザインターフェースの [リリース設定] ページで Apex ジョブによるリリースを有効化しま
す。
承認プロセス
• メタデータ API と共に Salesforce ナレッジ記事の承認プロセスを使用するには、記事タイプをリリースす
る必要があります。承認プロセスの記事バージョン (_kav) の場合、サポートされるアクションの種別は、
ナレッジアクション、メールアラート、項目自動更新、アウトバウンドメッセージになります。
• 承認プロセスで、カスタム項目を含む投稿テンプレートを参照している場合、変更セットに追加する前
にこれらの投稿テンプレートを送信側組織に再保存する必要があります。[設定] から、[作成] > [ワーク
フローと承認申請] > [テンプレートの投稿] をクリックします。各投稿テンプレートで、[編集]、[保存]
の順にクリックします。
• メタデータには、有効承認プロセスの順序は含まれません。場合によっては、リリース後に対象組織で
承認プロセスを並び替える必要があります。
• 変更セットに以前に含まれており別の組織でリリース済みの承認プロセスの [一意の名前] を変更し、
変更セット経由で承認プロセスを再送信する場合は、他の組織でリリースされる時点で新しい承認プロ
セスが作成されます。以前にリリースされた承認プロセスは、変更されません。
カスタム項目
API バージョン 30.0 以降、新しいカスタム項目をリリースする場合、プロファイル項目権限の editable 項
目と readable 項目のデフォルト値は false です。デフォルト値を上書きするには、新規項目の項目権
限をプロファイルに含めます。
カスタムオブジェクト
API バージョン 29.0 では、メタデータ API を使用してオブジェクトの sharingModel を変更することはでき
ません。対象組織に対するこのような変更は、ユーザインターフェースを使用して手動で行う必要があり
ます。
APIバージョン 30.0 以降、メタデータ APIとユーザインターフェースを使用して、内部ユーザ向けにオブジェ
クトの sharingModel を変更できます。
接続アプリケーション
• メタデータ API で consumerKey を設定することはできません。これは、情報提供を目的とした取得操
作に含まれます。接続アプリケーションを別の組織に移動する場合、組織にリリースする前に
consumerKey を .zip ファイルから削除する必要があります。移行先の組織で新しいキーが生成されま
す。
• 接続アプリケーションのモバイル設定は、変更セットでサポートされていないため、手動で移行する必
要があります。
ページレイアウト
ページレイアウトの割り当てを含むリリースでは、対象組織にある既存のすべてのページレイアウトの割
り当てが、.zip ファイルで指定された割り当てに置き換えられます。組織の既存のページレイアウトの割り
当てが .zip ファイルに含まれていない場合、それらのページレイアウトはなくなります。すべての必要なレ
コードタイプの全ページレイアウトを .zip ファイルに必ず含めるようにしてください。
共有
どのオブジェクトを更新するかに関係なく、メタデータ API では、オブジェクトの sharingModel 項目の
更新と新しい共有ルールの追加を同時に行うことはサポートされていません。たとえば、組織の共有設定
118
メタデータ型
AnalyticSnapshot
が公開である場合、共有ルールを追加し、その後で sharingModel を更新することができます。共有の再
適用は1 度のみとなります。
ワークフロー
メタデータ APIでは、フロートリガのテストモードはサポートされていません。システム管理者がワークフ
ロールールを起動したときにフロートリガで最新のフローバージョンを実行する場合は、リリース後にユー
ザインターフェースでテストモードを有効にします。
AnalyticSnapshot
分析スナップショットを表します。分析スナップショットにより、履歴データに関するレポートを作成できま
す。承認されたユーザは、表形式のレポートやサマリーレポートの結果をカスタムオブジェクトの項目に保存
することができ、それらの項目を対象オブジェクト上の対応する項目に割り当てることができます。その上
で、レポートをいつ実行してそのカスタムオブジェクトの項目にレポートのデータを読み込むかをスケジュー
リングできます。分析スナップショットでは、一般のSalesforceでのレコード操作と同様のレポートデータ操作
を実行できます。
宣言的なメタデータファイルのサフィックスおよびディレクトリの
場所
Force.com の AnalyticSnapshot コンポーネントは、対応するパッケージディレクトリの analyticSnapshots ディ
レクトリに保存されます。ファイル名は、分析スナップショットの一意の名前に一致し、拡張子は
.analyticsnapshot です。
バージョン
Force.com の AnalyticSnapshot コンポーネントは、API バージョン 16.0 以降で使用できます。
項目
項目
データ型
説明
description
string
分析スナップショットの説明。
fullName
string
APIアクセスに使用される分析スナップショット名。
名前には、英数字、およびアンダースコア (_) 文字
のみを使用できます。また、最初は文字とし、最後
にアンダースコアを使用したり、連続した 2 つのア
ンダースコア文字を含めたりすることはできませ
ん。この項目は、Metadata コンポーネントから継承
されています。
groupColumn
string
ソースレポートからのデータ抽出レベルを指定する
列。サマリーレポートのみに適用されます。
119
メタデータ型
AnalyticSnapshot
項目
データ型
説明
mappings
AnalyticSnapshotMapping[]
分析スナップショットの対応付けのリスト。有効な
値については、「AnalyticSnapshotMapping」を参照し
てください。
name
string
必須。分析スナップショットの表示名。
runningUser
string
分析スナップショットを実行するために使用される
ロールと共有設定を所有するユーザのユーザ名。
sourceReport
string
必須。データの抽出元であるレポート。
targetObject
string
必須。データの挿入先であるカスタムオブジェク
ト。
AnalyticSnapshotMapping
AnalyticSnapshotMapping は、分析スナップショットの対応付けを定義します。有効な値は、次のとおりです。
項目
データ型
説明
aggregateType
ReportSummaryType[]
(string 型の列挙)
各レポート項目が集計されるかどうか、および集計方法を
定義するリスト。有効な値については、
「ReportSummaryType」を参照してください。
sourceField
string
sourceField は、次のいずれかです。
• targetObject で targetField に対応付ける sourceReport の項目。
• sourceReport の項目の概要 (サマリーレポートのみ)
• 分析スナップショットの JobName、RunningUser、または
ExecutionTime などの項目 (ユーザインターフェースで設定)
注意: sourceField は、指定する sourceType に対応している必要
があります。
sourceType
ReportJobSourceTypes[]
(string 型の列挙)
分析スナップショットのレポート形式を定義するリスト。
有効な値については、「ReportJobSourceTypes」を参照してく
ださい。
targetField
string
この特定の sourceField の挿入先である targetObject の項目。
ReportJobSourceTypes
分析スナップショットのレポート形式を定義する string 型の列挙。有効な値は、次のとおりです。
120
メタデータ型
ArticleType
列挙値
説明
snapshot
sourceField に JobName、RunningUser、または ExecutionTime などのスナップショッ
ト固有の情報が含まれる場合は、このオプションを使用します。
summary
sourceReport の項目の集計 (合計、平均、最小、最大) を参照する場合は、この
オプションを使用します。
tabular
sourceReportから使用可能な列を参照する場合は、このオプションを使用しま
す。
宣言的なメタデータの定義のサンプル
分析スナップショットの 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>
<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 つのカスタム
121
メタデータ型
ArticleType
項目があり、記事マネージャが FAQ の記事の作成または更新時にそこにデータを入力します。より複雑な記事
タイプでは、複数のセクションに分かれた多数の項目が必要な場合があります。レイアウトおよびテンプレー
トを使用することで、管理者は特定のコンテンツに対して最も効果的な方法で記事タイプを構築できます。記
事タイプへのユーザのアクセスは権限によって制御されます。各記事タイプについて、管理者は「作成」、
「参照」、「編集」、または「削除」権限をユーザに与えることができます。たとえば、記事マネージャが内
部ユーザには FAQ を参照、作成、編集できるようにするけれども、パートナーユーザには FAQ の参照のみを可
能にする場合などです。Salesforce オンラインヘルプの「記事タイプの管理」および『SOAP API 開発者ガイド』
の「記事」を参照してください。
宣言的なメタデータファイルのサフィックスおよびディレクトリの
場所
ArticleType はカスタムオブジェクトとして定義され、objects フォルダに保存されます。ArticleType のサフィッ
クスには __kav を使用します (カスタムオブジェクトの場合の __c の代わりに)。ArticleType 項目名にはその
他のカスタムオブジェクトと同様に __c サフィックスを使用し、属する記事タイプの名前を使ってドット修
飾する必要があります。次のサンプル package.xml ファイルでこれを示します。
<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<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 以降で使用できます。
項目
項目名
データ型
articleTypeChannel articleTypeChannelDisplay
Display
説明
さまざまなチャネルで記事を表示するために使用する記事
タイプテンプレートを表します。Salesforce オンラインヘル
プの「記事タイプテンプレートの割り当て」を参照してく
ださい。
122
メタデータ型
ArticleType
項目名
データ型
説明
deploymentStatus
DeploymentStatus (string 型
の列挙)
カスタムオブジェクトまたはカスタム項目のリリース状況
を表す文字列。有効な値は、次のとおりです。
• InDevelopment
• Deployed
description
string
記事タイプの説明。最大 1000 文字です。
fields
CustomField[]
記事タイプの 1 つ以上の項目を表します。
gender
Gender
オブジェクトを表す名詞の性別を示します。これは、語の
性別に基づいて、異なる処理が必要となる言語に使用され
ます。
label
string
Salesforce ユーザインターフェース全体でオブジェクトを表
す表示ラベル。
pluralLabel
string
label 値の複数形です。
startsWith
StartsWith (string 型の列挙) 名詞が母音、子音、または特殊文字で開始されているかを
示します。これは、語の最初の文字に基づいて、異なる処
理が必要となる言語に使用されます。有効な値は、
「StartsWith」 にリストされています。
articleTypeChannelDisplay
チャネルで記事を表示するために使用される記事タイプテンプレートを決定します。別途記載がない限り、す
べての項目は作成可能、除外可能で、null にすることもできます。
項目名
データ型
articleTypeTemplates articleTypeTemplates
説明
特定のチャネルに適用する記事タイプテンプレートを示し
ます。
articleTypeTemplates
特定のチャネルで使用する記事タイプテンプレートを設定します。指定されていない場合、デフォルトの記事
タイプテンプレートが適用されます。
項目名
データ型
説明
channel
string
記事タイプテンプレートが適用されるチャネルを指定しま
す。
• AllChannels: 使用できるすべてのチャネル
• App: Salesforce ナレッジの [記事] タブ
123
メタデータ型
項目名
ArticleType
データ型
説明
• Pkb: 公開知識ベース
• Csp: カスタマーポータル
• Prm: パートナーポータル
チャネルについての詳細は、Salesforce オンラインヘルプの
「Salesforce ナレッジの用語」を参照してください。
page
string
カスタム記事タイプテンプレートとして使用されるカスタ
ム Visualforce ページの名前を表します。template 項目で Page
を選択する場合にこの項目を使用します。
template
string
特定のチャネルに使用する記事タイプテンプレートを示し
ます。
• 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>
</articleTypeTemplates>
<articleTypeTemplates>
<channel>Csp</channel>
<template>Tab</template>
</articleTypeTemplates>
<articleTypeTemplates>
<channel>Pkb</channel>
<template>Toc</template>
</articleTypeTemplates>
</articleTypeChannelDisplay>
<deploymentStatus>Deployed</deploymentStatus>
124
メタデータ型
ArticleType レイアウト
<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>
<pluralLabel>newarticles</pluralLabel>
</CustomObject>
関連トピック:
ArticleType レイアウト
ArticleType CustomField
ArticleType レイアウト
記事タイプのページレイアウトに関連付けられたメタデータを表します。記事タイプレイアウトは、ユーザが
記事にデータを入力するときに参照および編集できる項目と、ユーザが記事を参照するときに表示されるセク
ションも決定します。記事の形式 (たとえばレイアウトセクションをサブタブ、またはリンクのある 1 つのペー
ジとして表示するかどうか) は、記事タイプテンプレートで定義します。各記事タイプには 1 つのレイアウト
のみ使用できますが、記事タイプの 4 つのチャネルのそれぞれに異なるテンプレートを選択できます。詳細
は、Salesforce オンラインヘルプの「記事タイプの管理」および『SOAP API 開発者ガイド』の「記事」を参照し
てください。
ファイルのサフィックスおよびディレクトリの場所
ArticleType レイアウトは、対応するパッケージディレクトリの layouts ディレクトリに保存されます。プレ
フィックスは、記事タイプの API 名に一致する必要があります。拡張子は .layout です。
バージョン
ArticleType レイアウトは、API バージョン 19.0 以降で使用できます。
項目
項目名
データ型
説明
layoutSections
LayoutSection[]
記事項目を含むレイアウトのメインセクション。ここ
での順序はレイアウトの順序を決定します。
LayoutSection
LayoutSection は、ArticleType レイアウトのセクションを表します。
125
メタデータ型
ArticleType レイアウト
項目名
データ型
説明
customLabel
boolean
このセクションの表示ラベルがカスタムであるか標準 (組
み込み) であるかを示します。カスタム表示ラベルは任意
のテキストですが、翻訳する必要があります。標準表示ラ
ベルには、「システム情報」など、自動的に翻訳される、
定義済みの有効な値セットが含まれます。
label
string
表示ラベル。customLabel フラグに基づいて標準または
カスタムのいずれかとなります。
layoutColumns
LayoutColumn[]
レイアウトの列です。スタイルによって異なります。
Salesforce ナレッジでは、記事タイプレイアウトで 1 つの列
のみがサポートされています。
style
LayoutSectionStyle
(string 型の列挙)
レイアウトのスタイル。Salesforce ナレッジでは、1 つの列
ページを表示する OneColumn 値のみがサポートされてい
ます。
LayoutColumn
LayoutColumn は、レイアウトセクション内の列の項目を表します。
項目名
データ型
説明
layoutItems
LayoutItem[]
列内の個々の項目 (上から下の順序)
LayoutItem
LayoutItem は、レイアウト項目を定義する有効な値を表します。
項目名
データ型
説明
field
string
MyField__c などの項目名の参照。
宣言的なメタデータの定義のサンプル
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>
126
メタデータ型
ArticleType CustomField
<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>
関連トピック:
ArticleType
ArticleType CustomField
ArticleType CustomField
記事タイプカスタム項目に関連付けられたメタデータを表します。記事タイプ カスタム項目の定義を作成、
更新、または削除するには、このメタデータ型を使用します。Metadataメタデータ型を拡張し、その fullName
項目を継承します。
カスタム項目を作成または更新するときには必ず完全名を指定する必要があります。たとえば、カスタムオブ
ジェクトのカスタム項目は次のように表されます。
MyArticleType__kav.MyCustomField__c
宣言的なメタデータファイルのサフィックスおよびディレクトリの場所
カスタム項目は記事タイプの一部として定義されます。ArticleType 項目名にはその他のカスタムオブジェクト
と同様に __c サフィックスを使用し、属する記事タイプの名前を使ってドット修飾する必要があります。詳
細は、「ArticleType」を参照してください。
カスタムオブジェクトまたは標準オブジェクトのカスタム項目の取得
カスタムオブジェクトまたは標準オブジェクトを取得するとき、そのオブジェクトに関連付けられるものすべ
てが返されます。ただし、package.xml で明示的にオブジェクトと項目の名前を指定することによって、オ
ブジェクトのカスタム項目のみを取得することもできます。package.xml 内の次の定義は、それぞれに 1 つ
のカスタム項目の定義を含む、objects/MyCustomObject__c.object、
127
メタデータ型
ArticleType CustomField
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 にすることもできます。
項目名
データ型
説明
defaultValue
string
指定されている場合、項目のデフォルト値を表し
ます。
deleteConstraint
DeleteConstraint (string 型 参照関係の削除オプションを提供します。有効な
の 列挙)
値は、次のとおりです。
SetNull
これはデフォルトです。参照レコードが削除さ
れると、参照項目は消去されます。
Restrict
レコードが参照関係にある場合に、そのレコー
ドが削除されないように防止します。
Cascade
参照レコードも関連付けられた参照項目も削除
します。
参照関係についての詳細は、Salesforceヘルプの「オ
ブジェクトリレーション」を参照してください。
description
string
項目の説明。
formula
string
指定されている場合、項目の数式を表します。
formulaTreatBlankAs
TreatBlanksAs (string 型の 数式内の空白の処理方法を示します。有効な値は、
列挙)
BlankAsBlank および BlankAsZero です。
fullName
string
Metadataから継承されるこの項目は、このメタデー
タ型の WSDL では定義されません。作成時、更新
時、または削除時に指定する必要があります。コー
128
メタデータ型
項目名
ArticleType CustomField
データ型
説明
ルにおけるこの項目の例を確認するには、
「create()」を参照してください。
この値は null にできません。
inlineHelpText
string
項目レベルのヘルプの内容を表します。詳細は、
Salesforce ヘルプの「項目レベルのヘルプの定義」
を参照してください。
label
string
項目の表示ラベル。[記事タイプ] の標準項目の [タ
イトル]、[URL 名]、[概要] などの表示ラベルを更新
することはできません。
length
int
項目の長さ。
picklist
Picklist (連動選択リス
トを含む)
指定されている場合、項目は選択リストで、この
項目は選択リスト値および表示ラベルを列挙しま
す。
referenceTo
string
指定されている場合、この項目に含まれる別のオ
ブジェクトへの参照を示します。
relationshipLabel
string
リレーションの表示ラベル。
relationshipName
string
指定されている場合、一対多のリレーションの値
を示します。たとえば、YourObject へのリレーショ
ンを持っていた MyObject オブジェクトでは、その
リレーション名は YourObjects となります。
required
boolean
作成時に項目への値の入力が必須であるか (true)、
否か (false) を示します。
type
FieldType
必須。項目のデータ型を示します。有効な値は、
次のとおりです。
• Checkbox (バージョン 30.0 以降で使用可能)
• Currency
• ArticleCurrency
• Date
• DateTime
• Email
• File
• Formula
• Html
• Lookup
• Number
• Percent
129
メタデータ型
項目名
ApexClass
データ型
説明
• Phone
• Picklist
• DependentPicklist
• MultiselectPicklist
• Text
• TextArea
• LongTextArea
• URL
visibleLines
int
項目に表示される線の数を示します。
宣言的なメタデータの定義のサンプル
<?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 レイアウト
ApexClass
Apex クラスを表します。Apex クラスは、Apex オブジェクトを作成するためのテンプレート、つまり設計図で
す。クラスは、他のクラス、ユーザ定義メソッド、変数、例外型、および静的初期化コードで構成されます。
詳細は、『Force.comApex コード開発者ガイド』を参照してください。このメタデータ型は、MetadataWithContent
コンポーネントを拡張し、その項目を共有します。
メモ: デフォルトでは、Apex クラスに 1 つ以上の有効なジョブがある場合は、このクラスへの更新をリ
リースすることはできません。この場合に更新をリリースするには、次のいずれかを実行します。
• Apex コードへの変更をリリースする前に、Apex ジョブをキャンセルします。リリース後にジョブを再
スケジュールします。
130
メタデータ型
ApexClass
• Salesforce ユーザインターフェースの [リリース設定] ページで Apex ジョブによるリリースを有効化しま
す。
サポートされているコール
deploy()、retrieve()、describeMetadata()、listMetadata()
メモ: このメタデータ型は、create()、delete()、および update() コールでサポートされていませ
ん。
宣言的なメタデータファイルのサフィックスおよびディレクトリの
場所
クラスファイルのファイルサフィックスは、 .cls です。付随するメタデータファイルには、
ClassName-meta.xml という名前が付けられます。
Apex クラスは、対応するパッケージディレクトリの classes フォルダに保存されます。
バージョン
API クラスは API バージョン 10.0 以降で使用できます。
項目
このメタデータ型には、次の項目が含まれます。
項目名
データ型
説明
apiVersion
double
このクラスの API バージョン。すべてのクラスには、作成時に指
定された API バージョンが割り当てられています。
content
base64
Apex クラスの定義。Base 64 で符号化されたバイナリデータ API
コールを行う前に、クライアントアプリケーションはバイナリ
添付データを base64 に符号化する必要があります。応答を受信
したら、クライアントアプリケーションは、base64 データをバイ
ナリに復号化する必要があります。この変換は、通常 SOAP クラ
イアントによって処理されます。この項目は、MetadataWithContent
コンポーネントから継承されます。
fullName
string
Apex クラス名。名前には、英数字、およびアンダースコア (_) 文
字のみを使用できます。また、最初は文字とし、最後にアンダー
スコアを使用したり、連続した 2 つのアンダースコア文字を含め
たりすることはできません。この項目は、Metadataコンポーネン
トから継承されています。
131
メタデータ型
項目名
ApexClass
データ型
packageVersions PackageVersion[]
status
ApexCodeUnitStatus (string
型の列挙)
説明
この Apex クラスによって参照される、インストール済みの管理
パッケージバージョンのリスト
Apex クラスの現在の状況。有効な文字列値は次のとおりです。
• Active -クラスは有効です。
• Deleted - クラスには削除のマークが付いています。管理パッ
ケージの更新時にクラスを削除できるため、管理パッケージ
に利用すると便利です。
メモ: ApexCodeUnitStatus には Inactive オプションが含ま
れますが、ApexTrigger のみでサポートされており、ApexClass
ではサポートされていません。
PackageVersion
PackageVersion は、管理パッケージのバージョンを識別します。パッケージバージョンは、パッケージでアップ
ロードされる一連のコンポーネントを特定する番号です。バージョン番号の形式は
majorNumber.minorNumber.patchNumber (例: 2.1.3) です。メジャー番号とマイナー番号は、毎回のメジャー
リリース時に指定した値に増えます。patchNumber は、パッチリリースにのみ生成および更新されます。API
バージョン 16.0 以降で使用できます。
項目名
データ型
説明
namespace
string
必須。パッケージコンテキストでは、名前空間プレフィックス
とは AppExchange にある自社パッケージとそのコンテンツを他の
開発者のパッケージと区別するための 1 ～ 15 文字の英数字で構
成される識別子です。名前空間プレフィックスでは、大文字小
文字は区別されません。たとえば、ABC と abc は一意として認識
されません。名前空間プレフィックスは、すべての Salesforce 組
織にわたって必ずグローバルに一意なものを指定します。名前
空間プレフィックスを使用することで、自社の管理パッケージ
のみを管理できるようになります。
名前空間についての詳細は、Salesforceオンラインヘルプの「名前
空間プレフィックスの登録」を参照してください。
majorNumber
int
必須。パッケージバージョンのメジャー番号。パッケージバー
ジョン番号は、majorNumber.minorNumber 形式です。
minorNumber
int
必須。パッケージバージョンのマイナー番号。パッケージバー
ジョン番号は、majorNumber.minorNumber 形式です。
132
メタデータ型
ApexComponent
宣言的なメタデータの定義のサンプル
次のサンプルでは、MyhelloWorld.cls クラスと、対応する MyHelloWorld.cls-meta.xml メタデータファ
イルを作成します。
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>32.0</apiVersion>
</ApexClass>
関連トピック:
ApexTrigger
ApexComponent
Visualforce コンポーネントを表します。詳細は、Salesforce オンラインヘルプの「Visualforce の概要」を参照して
ください。このメタデータ型は、MetadataWithContent コンポーネントを拡張し、その項目を共有します。
宣言的なメタデータファイルのサフィックスおよびディレクトリの
場所
ページファイルのファイルサフィックスは、 .component です。付随するメタデータファイルには、
ComponentName-meta.xml という名前が付けられます。
Visualforce コンポーネントは、対応するパッケージディレクトリの components フォルダに保存されます。
バージョン
Visualforce コンポーネントは、API バージョン 12.0 以降で使用できます。
項目
このメタデータ型には、次の項目が含まれます。
133
メタデータ型
ApexPage
項目名
データ型
説明
apiVersion
double
この Visualforce コンポーネントの API バージョン。どのコンポーネ
ントにも、作成時に API バージョンが指定されます。この項目は
API バージョン 16.0 以降で使用できます。
content
base64Binary
コンポーネントのコンテンツ。Base 64 で符号化されたバイナリ
データ API コールを行う前に、クライアントアプリケーションは
バイナリ添付データを base64 に符号化する必要があります。応
答を受信したら、クライアントアプリケーションは、base64 デー
タをバイナリに復号化する必要があります。この変換は、通常
SOAP クライアントによって処理されます。この項目は、
MetadataWithContent コンポーネントから継承されます。
description
string
コンポーネントの機能の説明。
fullName
string
API アクセスの一意の識別子として使用されるコンポーネントの
開発者名。fullName には、アンダースコアと英数字のみを使用
できます。一意であること、最初は文字であること、空白は使
用しない、最後にアンダースコアを使用しない、2 つ続けてアン
ダースコアを使用しないという制約があります。この項目は、
Metadata コンポーネントから継承されています。
label
string
必須。このコンポーネントの表示ラベル。
packageVersions PackageVersion[]
この Visualforce コンポーネントによって参照される、インストー
ル済みの管理パッケージバージョンのリスト。
メモ: パッケージコンポーネントと Visualforce カスタムコン
ポーネントの概念は大きく異なります。パッケージは、カ
スタムオブジェクト、Apexクラスとトリガ、カスタムペー
ジおよびカスタムコンポーネントなどの、多くの要素で構
成されます。
関連トピック:
ApexPage
ApexPage
1 つの Visualforce ページを表します。詳細は、Salesforce オンラインヘルプの「Visualforce の概要」を参照してくだ
さい。このメタデータ型は、MetadataWithContent コンポーネントを拡張し、その項目を共有します。
134
メタデータ型
ApexPage
宣言的なメタデータファイルのサフィックスおよびディレクトリの
場所
ページファイルのファイルサフィックスは、 .page です。付随するメタデータファイルには、
PageName-meta.xml という名前が付けられます。
Visualforce ページは、対応するパッケージディレクトリの pages フォルダに保存されます。
バージョン
Visualforce ページは、API バージョン 11.0 以降で使用できます。
項目
このメタデータ型には、次の項目が含まれます。
項目名
データ型
説明
apiVersion
double
必須。このページの API バージョン。すべてのクラスに
は、作成時に指定された API バージョンが割り当てられ
ています。この項目は API バージョン 15.0 以降で使用で
きます。この項目を 15.0 より小さい数値に設定すると、
15.0 に変更されます。
content
base64Binary
ページコンテンツ。Base 64 で符号化されたバイナリデー
タ API コールを行う前に、クライアントアプリケーショ
ンはバイナリ添付データを base64 に符号化する必要があ
ります。応答を受信したら、クライアントアプリケー
ションは、base64 データをバイナリに復号化する必要が
あります。この変換は、通常 SOAP クライアントによっ
て処理されます。この項目は、MetadataWithContent コン
ポーネントから継承されます。
description
string
ページが実行する内容の説明。
fullName
string
API アクセスの一意の識別子として使用されるページの
開発者名。fullName には、アンダースコアと英数字の
みを使用できます。一意であること、最初は文字である
こと、空白は使用しない、最後にアンダースコアを使用
しない、2 つ続けてアンダースコアを使用しないという
制約があります。この項目は、Metadata コンポーネント
から継承されています。
availableInTouch
boolean
Visualforce ページに関連付けられている Visualforce タブを
Salesforce1 アプリケーションで使用できるかどうかを示
します (Salesforce Touch でのこの項目の使用は廃止されま
135
メタデータ型
項目名
ApexPage
データ型
説明
した)。この項目は、API バージョン 27.0 以降で使用でき
ます。
Visualforce ページで上書きされる標準オブジェクトタブ
は、そのページにこの項目を設定しても、Salesforce1 で
サポートされません。Visualforceページの代わりに、オブ
ジェクトのデフォルトの Salesforce1 ページが表示されま
す。
confirmationTokenRequired boolean
ページの GET 要求に CSRF 確認トークンが必要かどうか
を示します。この項目は API バージョン 28.0 以降で使用
できます。
この項目の値を false から true に変更した場合は、
ページへのリンクに CSRF トークンを追加しないとページ
にアクセスできなくなります。
label
string
必須。このページの表示ラベル。
packageVersions
PackageVersion[]
この Visualforce ページによって参照される、インストー
ルされた管理パッケージバージョンのリスト。
宣言的なメタデータの定義のサンプル
次のサンプルでは 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
136
メタデータ型
ApexTrigger
ApexTrigger
Apexトリガを表します。トリガは、オブジェクトレコードがデータベースに挿入される前や、レコードが削除
された後など、特定のデータ操作言語 (DML) 行動が発生する前後に実行される Apex コードです。詳細は、
Salesforce オンラインヘルプの「Apex トリガの管理」を参照してください。このメタデータ型は、
MetadataWithContent コンポーネントを拡張し、その項目を共有します。
サポートされているコール
deploy()、retrieve()、describeMetadata()、listMetadata()
メモ: このメタデータ型は、create()、delete()、および update() コールでサポートされていませ
ん。
宣言的なメタデータファイルのサフィックスおよびディレクトリの
場所
トリガファイルのファイルサフィックスは .trigger です。付随するメタデータファイルには、
TriggerName-meta.xml という名前が付けられます。
Apex トリガは、対応するパッケージディレクトリの triggers フォルダに保存されます。
バージョン
トリガは、API バージョン 10.0 以降で使用できます。
項目
このメタデータ型には、次の項目が含まれます。
項目名
データ型
説明
apiVersion
double
必須。このトリガの API バージョン。どのトリガにも、作成時に
API バージョンが指定されます。
content
base64
Apex トリガの定義。この項目は、MetadataWithContent コンポーネ
ントから継承されます。
fullName
string
Apex トリガ名。名前には、英数字、およびアンダースコア (_) 文
字のみを使用できます。また、最初は文字とし、最後にアンダー
スコアを使用したり、連続した 2 つのアンダースコア文字を含め
たりすることはできません。この項目は、Metadataコンポーネン
トから継承されています。
packageVersions PackageVersion[]
この Apex トリガによって参照される、インストールされた管理
パッケージバージョンのリスト。
137
メタデータ型
AppMenu
項目名
データ型
説明
status
ApexCodeUnitStatus (string
型の列挙)
必須。Apex トリガの現在の状況。有効な文字列値は次のとおり
です。
• 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>32.0</apiVersion>
</ApexTrigger>
関連トピック:
ApexClass
AppMenu
Force.com アプリケーションメニューまたは Salesforce1 ナビゲーションメニューを表します。
ファイルのサフィックスおよびディレクトリの場所
各 AppMenu コンポーネントは、対応するパッケージディレクトリのフォルダ内の 1 つのファイルに保存されま
す。ファイル名には、Feature.appMenu という形式が使用されます。
• AppSwitcher.appMenu という名前のファイルに 1 つのアプリケーションスイッチャのアプリケーション
メニューファイルが保存されます。
138
メタデータ型
AppMenu
• Salesforce1.appMenu という名前のファイルに 1 つの Salesforce1 アプリケーションメニューファイルが保
存されます。
appMenus フォルダにはこれら 2 つのファイルがあります。.appMenu ファイルは、AppMenu コンポーネント
ごとにファイルが 1 つしかないため、他の名前付きコンポーネントとは異なります。アプリケーションメニュー
ファイルの作成や削除はできません。
バージョン
AppMenu コンポーネントは、API バージョン 30.0 以降で使用できます。
項目
項目名
データ型
説明
appMenuItems
AppMenuItem[]
アプリケーションメニュー内のメニュー項目のリスト。
AppMenuItem
アプリケーションメニュー内のメニュー項目を表します。
項目名
データ型
説明
name
string
項目の API 名。
type
string
この項目で表されるアプリケーションの種別。
AppSwitcher.appMenu の有効値は次のとおりです。
• ConnectedApp
• CustomApplication
• ServiceProvider
Salesforce1.appMenu の有効値は次のとおりです。
• CustomApplication
• CustomTab
• StandardAppMenuItem。
この項目には次の名前を使用できます。
– MyDay
– Feed
– ToDo
– Dashboards
– Search
– People (Chatter が有効な場合にのみ使用可能)
– Groups (Chatter が有効な場合にのみ使用可能)
139
メタデータ型
AppMenu
宣言的なメタデータの定義のサンプル
次に、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>
</appMenuItem>
<appMenuItem>
<name>CustomApp1</name>
<type>CustomApplication</type>
</appMenuItem>
<appMenuItem>
<name>CustomApp2</name>
<type>CustomApplication</type>
</appMenuItem>
<appMenuItem>
<name>ConnectedApp1</name>
<type>ConnectedApp</type>
</appMenuItem>
</appMenuItems>
</AppMenu>
前の定義を参照する package.xml の例を次に示します。
<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<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>
</appMenuItem>
<appMenuItem>
<name>StandardItem2</name>
<type>StandardAppMenuItem</type>
</appMenuItem>
<appMenuItem>
<name>StandardItem3</name>
<type>StandardAppMenuItem</type>
140
メタデータ型
ApprovalProcess
</appMenuItem>
<appMenuItem>
<name>CustomTab1</name>
<type>CustomTab</type>
</appMenuItem>
</appMenuItems>
</AppMenu>
前の定義を参照する package.xml の例を次に示します。
<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<types>
<members>Salesforce1</members>
<name>AppMenu</name>
</types>
組織の使用可能なすべてのアプリケーションメニューメタデータをリリースまたは取得するために使用され
る、パッケージマニフェストの例を次に示します。
<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<types>
<members>*</members>
<name>AppMenu</name>
</types>
<version>30.0</version>
</Package>
使用方法
Force.com アプリケーションメニューに表示されるメニュー項目のリストを並び替えるには、
AppSwitcher.appMenu を使用します。AppSwitcher.appMenu にアプリケーションメニュー項目を追加し
たり、AppSwitcher.appMenu からアプリケーションメニュー項目を削除したりすることはできません。
アプリケーションメニュー項目を並び替え、追加、または削除することによって Salesforce1 ナビゲーションメ
ニューに表示されるメニュー項目のリストをカスタマイズするには、Salesforce1.appMenu を使用します。
ApprovalProcess
承認プロセスに関連付けられたメタデータを表します。承認プロセスは、Salesforceでレコードを承認する場合
に、組織で使用できる自動化されたプロセスです。承認プロセスでは、承認するレコードの条件と各承認ス
テップの承認者を指定します。各承認ステップは、その承認プロセスの対象レコードすべてに適用すること
も、システム管理者が定義した特定の条件を満たすレコードのみに適用することもできます。承認プロセスで
は、レコードの承認、却下、取り消しまたは最初の承認申請時に実施するアクションも指定します。Metadata
メタデータ型を拡張し、その fullName 項目を継承します。
メモ:
• メタデータ API と共に Salesforce ナレッジ記事の承認プロセスを使用するには、記事タイプをリリース
する必要があります。承認プロセスの記事バージョン (_kav) の場合、サポートされるアクションの種
141
メタデータ型
ApprovalProcess
別は、ナレッジアクション、メールアラート、項目自動更新、アウトバウンドメッセージになりま
す。
• メールドラフトの送信アクションおよび承認プロセスは、メタデータ API ではサポートされません。
• メタデータには、有効承認プロセスの順序は含まれません。場合によっては、リリース後に対象組織
で承認プロセスを並び替える必要があります。
• 組織に承認プロセスを実装する前に、Salesforce ヘルプの「承認プロセスの考慮事項」を参照してくだ
さい。
ファイルのサフィックスおよびディレクトリの場所
ApprovalProcess コンポーネントのサフィックスは .approvalProcess で、approvalProcesses フォルダに保
存されます。
バージョン
ApprovalProcess コンポーネントは、API バージョン 28.0 以降で使用できます。
項目
項目名
データ型
説明
active
boolean
必須。承認プロセスがアクティブかどうか。
承認プロセスを有効にした後に、その承認プロセ
スのステップの追加、削除、または順序の変更
や、プロセスの却下またはスキップの動作の変更
はできません (プロセスを無効にしてもこれらの操
作を行うことはできません)。
allowRecall
boolean
申請者に承認申請の取り消しを許可するかどう
か。
false に設定されている場合、システム管理者の
みが承認申請を取り消すことができます。
allowedSubmitters
ApprovalSubmitter[]
必須。レコードの承認申請が許可されているユー
ザの配列。
approvalPageFields
ApprovalPageField
承認者がレコードを承認または却下する承認ペー
ジに表示する項目を指定します。デフォルトで
は、次の項目が表示されます。
• [名前] 項目
• [所有者] 項目 (子オブジェクトを除く)
142
メタデータ型
項目名
ApprovalProcess
データ型
説明
Salesforce1で通知を有効にしている場合、承認者が
モバイルデバイスでこの項目のリストを参照可能
になります。ユーザがレコードの承認または却下
を決定する必要がある項目のみを選択してくださ
い。
approvalStep
ApprovalStep[]
承認ステップ定義の配列。
description
string
承認プロセスを説明します。
emailTemplate
string
承認申請に使用するメールテンプレートを指定し
ます。指定されていない場合は、デフォルトの
メールテンプレートが使用されます。
承認プロセスによってユーザへ承認申請が割り当
てられると、Salesforce からそのユーザに対して承
認申請メールが送信されます。メールにはSalesforce
の承認ページへのリンクが記載されています。こ
のリンクでは、ユーザが申請を承認または却下
し、コメントを追加できます。
enableMobileDeviceAccess boolean
ユーザは Salesforce にログインせずに、モバイルデ
バイスのブラウザを含む任意のブラウザから承認
ページの外部バージョンにアクセスできるかどう
か。ユーザインターフェースの [セキュリティ設
定] に対応します。
true に設定されている場合、承認ステップに
type adhoc の承認者を含めることはできませ
ん。
false に設定されている場合、承認者は Salesforce
にログインして承認ページにアクセスする必要が
あります。
entryCriteria
ApprovalEntryCriteria
承認プロセスの対象となるレコードを決定しま
す。承認プロセスをすべてのレコードに許可する
場合は、この項目を除外します。
finalApprovalActions
ApprovalAction
レコードに対するすべての承認申請が終了したと
きに実行するワークフローアクションを指定しま
す。
finalApprovalRecordLock
boolean
必要なすべての承認が終了した後でレコードを
ロックしたままにするかどうか。デフォルト:
false。
143
メタデータ型
ApprovalProcess
項目名
データ型
説明
finalRejectionActions
ApprovalAction
レコードが最終却下状態に移行した後で実行する
ワークフローアクションを指定します。
finalRejectionRecordLock boolean
最終的に却下された後でレコードをロックしたま
まにするかどうか。デフォルト: false。
initialSubmissionActions ApprovalAction
レコードの最初の承認申請時に実行するワークフ
ローアクションを指定します。
label
string
必須。承認プロセスの名前。
nextAutomatedApprover
NextAutomatedApprover
承認ステップに承認者を自動割り当てするために
使用できる、標準またはカスタムユーザ階層項目
を指定します。
この項目を除外すると、承認ステップでユーザ階
層項目を使用して承認者の自動割り当てができな
くなります。
postTemplate
Chatter での承認に使用する投稿テンプレート。
string
Chatter投稿承認通知は、フィード追跡が有効になっ
ているオブジェクトに関連付けられている承認プ
ロセスでのみ使用可能です。
recallActions
ApprovalAction
未承認の申請を取り下げたときに実行するワーク
フローアクションを指定します。
recordEditability
RecordEditabilityType (string 未承認のレコードを編集できるユーザを指定しま
型の列挙)
す。レコードは承認申請されると自動的にロック
され、承認プロセス中に他のユーザがそのレコー
ドを編集するのを防ぎます。有効な値は、次のと
おりです。
• AdminOnly — 未承認のレコードを編集できる
ユーザは、次のとおりです。
– 「すべてのデータの編集」権限を持つユー
ザ
– 指定のオブジェクトに対してオブジェクト
レベルで「すべての編集」権限を持つユー
ザ
• AdminOrCurrentApprover — 未承認のレコー
ドを編集できるユーザは、次のとおりです。
– 「すべてのデータの編集」権限を持つユー
ザ
144
メタデータ型
ApprovalProcess
項目名
データ型
説明
– 指定のオブジェクトに対してオブジェクト
レベルで「すべての編集」権限を持つユー
ザ
– 指定のオブジェクトに対して、ユーザ権限
および組織の共有設定を介してレコードへ
の編集アクセス権を持つ、割り当て済みの
承認者
showApprovalHistory
boolean
承認申請の詳細を承認者が表示できレコードを承
認または却下できる承認ページに、[承認履歴] 関
連リストを追加するかどうか。[承認履歴] 関連リ
ストは、レコードの承認プロセスを追跡します。
[承認履歴] 関連リストをレコード詳細ページおよ
び編集ページにも追加する場合は、Salesforce ユー
ザインターフェースを使用して指定のオブジェク
トのページレイアウトをカスタマイズします。
ApprovalSubmitter
レコードの承認を申請できるユーザまたはユーザセットを表します。
項目名
データ型
説明
submitter
string
レコードの承認を申請できる特定のユーザまたはユーザセットを識
別します。次のタイプが指定され submitter 項目が無視される場合
を除き、この項目は必須です。
• owner
• creator
• allInternalUsers
例:
<allowedSubmitters>
<type>allInternalUsers</type>
</allowedSubmitters>
<allowedSubmitters>
<submitter>myGroup</submitter>
<type>group</type>
</allowedSubmitters>
type
ProcessSubmitterType
(string 型の列挙)
必須。レコードの承認を申請できるユーザまたはユーザセットの種
別。有効な値は、次のとおりです。
• group
145
メタデータ型
項目名
ApprovalProcess
データ型
説明
• role
• user
• roleSubordinates
• roleSubordinatesInternal
• owner
• creator
• partnerUser
• customerPortalUser
• portalRole
• portalRoleSubordinates
• allInternalUsers — 組織内のすべての Salesforce ユーザ。
ApprovalPageField
承認申請の詳細を承認者が表示できレコードを承認または却下できる承認ページに表示するために選択された
項目を表します。
項目名
データ型
説明
field
string[]
承認者がレコードを承認または却下する承認ページに表示する
項目の配列。
ApprovalStep
承認プロセスのステップを表します。承認ステップでは、承認申請をさまざまなユーザに割り当て、承認プロ
セスにおける承認のつながりを定義します。各承認ステップでは、その承認ステップに進むために必要なレ
コードの条件、そのレコードの申請を承認できるユーザ、および代理承認者による承認を許可するかどうかを
指定します。承認プロセスの最初の承認ステップでは、レコードがこのステップの条件を満たさない場合に実
施するアクションを指定します。その後のステップでは、却下時のアクションを指定することができます。
メモ:
• 承認プロセス定義の ApprovalStep エントリの順序によって、承認ステップの実行順序が決まりま
す。
• 承認プロセスを有効にした後に、その承認プロセスのステップの追加、削除、または順序の変更や、
プロセスの却下またはスキップの動作の変更はできません (プロセスを無効にしてもこれらの操作を行
うことはできません)。
• ステップは、最大 30 に制限されています。
146
メタデータ型
ApprovalProcess
項目名
データ型
説明
allowDelegate
boolean
承認プロセスのこのステップで代理承認者を許可
するかどうか。代理承認者は、割り当てられた承
認者により承認申請の承認代理として任命された
ユーザです。
approvalActions
ApprovalAction
承認プロセスのこのステップでレコードが承認さ
れたときに実行するワークフローアクションを指
定します。
assignedApprover
ApprovalStepApprover
承認プロセスのこのステップに割り当てられた承
認者を指定します。
description
string
承認ステップを説明します。
entryCriteria
ApprovalEntryCriteria
承認プロセスのこのステップの対象となるレコー
ドを決定します。
ifCriteriaNotMet
StepCriteriaNotMetType (string 開始条件を満たさないレコードに対する処理を指
型の列挙)
定します。有効な値は、次のとおりです。
• ApproveRecord — 申請を承認し、最終承認時
のアクションをすべて実行します。
• RejectRecord — 申請を却下し、最終却下時の
アクションをすべて実行します。このオプショ
ンは、承認プロセスの最初のステップでのみ表
示されます。
• GotoNextStep — 次の承認ステップにスキップ
します。最初の承認ステップでこのオプション
を選択し、レコードが他のステップの開始条件
を満たさない場合、レコードは却下されます。
label
string
必須。承認ステップの名前。
name
string
必須。承認ステップの一意の名前。アンダースコ
アと英数字のみを含むこと、最初は文字であるこ
と、空白は使用しない、最後にアンダースコアを
使用しない、2 つ続けてアンダースコアを使用しな
いという制約があります。一意性は、特定の承認
プロセス内でのみ必要です。
rejectBehavior
ApprovalStepRejectBehavior
承認プロセスの最初のステップを除き必須。承認
プロセスの最初のステップでない場合に、承認者
がこの承認ステップで申請を却下したときの処理
を指定します。
147
メタデータ型
ApprovalProcess
項目名
データ型
説明
承認プロセスの最初のステップで承認者が申請を
却下した場合、却下時の処理は
finalRejectionActions によって決まります。
rejectionActions
承認プロセスのこのステップでレコードが却下さ
れたときに実行するワークフローアクションを指
定します。
ApprovalAction
ApprovalAction
承認プロセスの結果として発生するアクションを表します。
項目名
データ型
説明
action
WorkflowActionReference[]
実行するワークフローアクションの配列。
ApprovalStepApprover
承認ステップに割り当てられた承認者を表します。承認者は、ステップごとに最大 25 人に制限されています。
項目名
データ型
説明
approver
Approver[]
承認プロセスのこのステップに割り当てられた承認者の配
列。
whenMultipleApprovers
RoutingType (string ステップに複数の承認者が割り当てられている場合の、承
型の列挙)
認または却下の処理方法を指定します。有効な値は、次の
とおりです。
• Unanimous — (デフォルト) このステップのすべての承
認者から全員の承認を得る必要があります。いずれか
の承認者が申請を却下すると、このステップの承認申
請は却下されます。
• FirstResponse — 最初の返答に基づいて承認または
却下します。
Approver
承認ステップに割り当てられた承認者を表します。
メモ: 承認者を指定するときには、次の点に注意してください。
• 割り当てられる承認者に、承認申請対象レコードの参照アクセス権を必ず付与してください。たとえ
ば、経費カスタムオブジェクトの参照アクセス権がないユーザは、経費承認申請を参照できません。
148
メタデータ型
ApprovalProcess
• パートナーユーザに承認申請を割り当てることはできません。
• 承認者にキューを割り当てた承認プロセスでは、メール承認は使用できません。
• 承認者は、メールを使用して承認申請を承認または却下できる「API の有効化」システム権限が必要で
す。
• 1 つのステップで承認申請を同じユーザに複数回割り当てることもできますが、Salesforceはそのような
冗長性を認識すると、そのユーザに対して 1 つの承認しか申請しません。
• レコードが承認ステップに進んだ後は、そのステップの承認者は変更されません。これは、承認プロ
セスが前のステップに戻されたときに、承認者を指定するユーザ項目が変更されている場合でも同様
です。たとえば、承認プロセスの最初のステップでユーザのマネージャに承認を申請しているとしま
す。2 番目のステップで承認申請が却下され最初のステップに戻された場合、承認申請は、ユーザの
マネージャが現在変わっている場合でも、前回この申請を受け取ったマネージャに割り当てられま
す。
• 承認者にキューを割り当てた場合:
– すべてのキューメンバーが、そのキューに割り当てられた承認申請を承認または却下できます。
– 承認申請メールは、キューのメールアドレスに送信されます。メンバーにメールを送信するように
キューが設定されている場合、キューメンバーにも承認申請メールが送信されます。ただし、承認
ユーザ設定で承認申請メールを受信しないように設定しているキューメンバーには送信されませ
ん。
– 承認申請がキューに割り当てられると、各キューのメンバーの代理承認者も承認申請のメール通知
を受信します。
– キューへのメール通知は外部利用者を対象としたものではないため、メールテンプレート内の差し
込み項目 {!ApprovalRequest.External_URL} のインスタンスは、相当する内部 URL として送
信されます。
– Salesforce1 での承認申請通知は、キューには送信されません。個人ユーザが Salesforce1 で承認申請通
知を受信できるように、キューを伴う各承認ステップで、割り当てられた承認者としてそれらの個
人ユーザを追加することをお勧めします。割り当てられた承認者としてキューと個人ユーザの両方
を設定するには、承認ステップで [自動的にキューに割り当てる] の代わりに [自動的に承認者に割
り当てる] を選択します。
– 承認申請が却下されて前の承認者に戻され、前の承認者がキューであった場合は、キューではなく
承認したユーザに割り当てられます。
– [承認履歴] 関連リストの [割り当て先] 列にキュー名が表示され、その承認申請を承認または却下
した実際のユーザが [承認者] 列に表示されます。
項目名
データ型
説明
name
string
割り当てられた承認者を特定します。type が次のいずれかで name が
無視される場合を除き、この項目は必須です。
• adhoc
• userHierarchyField
149
メタデータ型
ApprovalProcess
項目名
データ型
説明
type
NextOwnerType (string
型の列挙)
指定された name と組み合わせて、割り当てられた承認者を特定しま
す。有効な値は、次のとおりです。
• adhoc — ステップの承認者を手動で選択する必要があります。最初
のステップの場合は、申請者が承認者を選択します。2 番目以降のス
テップの場合は、前のステップの承認者が承認者を選択します。こ
の値の場合は、name 項目を除外します。
• user — 組織内のユーザ。この値の場合は、name 項目にユーザ名を
入力します。
• userHierarchyField — 標準またはカスタムユーザ階層項目 (標準
[マネージャ] 項目など) で指定されたユーザ。この値の場合は、name
項目を除外します。ユーザ階層項目は、承認プロセスの
nextAutomatedApprover で定義されている必要があります。
• relatedUserField — 申請されたレコードのユーザ参照項目 ([最終
更新者] 項目など) で指定されたユーザ。この値の場合は、name 項目
にユーザ参照項目の名前を入力します。
• queue — 自動的にキューに割り当てます。この値の場合は、name
項目にキューの名前を入力します。
ApprovalEntryCriteria
レコードが承認プロセスまたは承認ステップに進むための条件を表します。検索条件または数式のいずれかを
指定します。両方は指定できません。
項目名
データ型
説明
booleanFilter
string
criteriaItems の検索条件ロジック。formula を入力する
場合は、この項目を除外します。
criteriaItems
FilterItem[]
レコードが承認プロセスまたは承認ステップに進むための検
索条件。
承認プロセスでは、検索条件の valueField エントリをサポー
トしていません。
formula
string
レコードが承認プロセスまたは承認ステップに進むためにレ
コードを true と評価する数式。
ApprovalStepRejectBehavior
承認プロセスの最初のステップでない場合に、承認者がこの承認ステップで申請を却下したときの処理を表し
ます。承認プロセスの最初のステップの場合、却下時の処理は承認プロセスの最終却下時のアクションによっ
て決まります。
150
メタデータ型
ApprovalProcess
項目名
データ型
説明
type
StepRejectBehaviorType
(string 型の列挙)
有効な値は、次のとおりです。
• RejectRequest — これまでに承認されたステップに関係なく、
申請を自動的に最終却下します。Salesforce は、このステップのす
べての却下時のアクションと、最終却下時のすべてのアクション
を実行します。
• BackToPrevious — 申請を自動的に却下し、承認申請を前の承認
者に戻します。Salesforce は、このステップのすべての却下時のア
クションを実行します。承認プロセスの最初のステップでは無効
です。
NextAutomatedApprover
承認プロセスの次の承認者として使用するユーザ階層項目を表します。定義されていると、階層項目で指定さ
れたユーザを、1 つ以上の承認ステップで承認者として自動的に割り当てることができます。
項目名
データ型 説明
useApproverFieldOfRecordOwner boolean
userHierarchyField
string
必須。申請者のユーザレコードではなく、レコード所有者
のユーザレコードで指定された userHierarchyField を
承認者として最初に実行される承認ステップで使用すべき
かどうか。残りのすべてのステップでは、前のステップの
承認者のユーザレコードで指定された
userHierarchyField が使用されます。
必須。承認者として割り当てるユーザを指定する値を持
つ、標準またはカスタムユーザ階層項目。たとえば、標準
[マネージャ] 階層項目を使用して、従業員の有給休暇申
請の承認者を割り当てることができます。
割り当てられる承認者に、承認申請対象レコードの参照ア
クセス権を必ず付与してください。たとえば、経費カスタ
ムオブジェクトの参照アクセス権がないユーザは、経費承
認申請を参照できません。
宣言的なメタデータの定義のサンプル
次に、ApprovalProcess コンポーネントの例を示します。
<?xml version="1.0" encoding="UTF-8"?>
<ApprovalProcess xmlns="http://soap.sforce.com/2006/04/metadata">
<active>false</active>
<allowRecall>false</allowRecall>
<allowedSubmitters>
151
メタデータ型
ApprovalProcess
<type>owner</type>
</allowedSubmitters>
<allowedSubmitters>
<submitter>USSalesRep</submitter>
<type>role</type>
</allowedSubmitters>
<allowedSubmitters>
<submitter>MarketingGroup</submitter>
<type>group</type>
</allowedSubmitters>
<allowedSubmitters>
<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>
</approver>
</assignedApprover>
<entryCriteria>
152
メタデータ型
ApprovalProcess
<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>
</criteriaItems>
<criteriaItems>
<field>Lead.MyLeadCustomField__c</field>
153
メタデータ型
AssignmentRules
<operation>equals</operation>
<value>Salesforce</value>
</criteriaItems>
</entryCriteria>
<finalApprovalActions>
<action>
<name>LeadEmailContacted</name>
<type>Alert</type>
</action>
</finalApprovalActions>
<finalApprovalRecordLock>true</finalApprovalRecordLock>
<finalRejectionActions>
<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
適切なユーザまたはキューに自動的にケースを転送できる割り当てルールを表します。該当するすべてのオブ
ジェクト、特定のオブジェクト、または特定のオブジェクトの特定のルールのルールメタデータにアクセスで
154
メタデータ型
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>
<name>AssignmentRule</name>
</types>
ファイルのサフィックスおよびディレクトリの場所
オブジェクトの割り当てルールのサフィックスは .assignmentRules で、assignmentRules フォルダに保
存されます。たとえば、すべての Case 割り当てルールは、Case.assignmentRules ファイルに保存されま
す。
バージョン
AssignmentRules コンポーネントは、API バージョン 27.0 以降で使用できます。
項目
項目名
データ型
説明
assignmentRule
AssignmentRule[]
指定した割り当てルールの定義を表します。
AssignmentRule
ルールが有効であるかどうか、およびその定義を指定します。 ルールは AssignmentRules コンテナ内に表示され
る順序で処理されます。
155
メタデータ型
AssignmentRules
項目名
データ型
説明
active
boolean
割り当てルールが有効であるか (true)、否か
(false) を示します。
fullname
string
Metadata から継承されるこの項目は、このメタ
データ型の WSDL では定義されません。作成時、
更新時、または削除時に指定する必要がありま
す。コールにおけるこの項目の例を確認するに
は、「create()」を参照してください。
この値は null にできません。
ruleEntry
割り当てルールの種類と説明を表します。
RuleEntry[]
RuleEntry
ルールで使用される項目を表します。
項目名
データ型
説明
assignedTo
string
項目が割り当てられるユーザまたはキューの名
前。
assignedToType
AssignToLookupValueType 有効な値は、次のとおりです。
(string 型の列挙)
• User
• Queue
booleanFilter
string
ルールに指定されている高度な絞り込み条件。
criteriaItems
FilterItem[]
割り当て条件を定義するリストの項目。
formula
string
入力規則数式。
メモ: formula と criteriaItems のい
ずれかを指定します。両方の項目は指定
できません。
notifyCcRecipients
boolean
受信するメール-to-ケースまたは Web-to-リード
メッセージの CC 行に含まれるメールアドレス
を、そのメッセージへの自動レスポンスの CC 行
に含める必要があるか (true)、否か (false) を
指定します。API バージョン 32.0 以降で利用でき
ます。
overrideExistingTeams
boolean
割り当てが完了したらケースチームをリセット
するか (true)、または前のチームを置き換える
156
メタデータ型
項目名
AssignmentRules
データ型
説明
代わりに現在のチームをケースに追加するか
(false) を指定します。
team
string[]
ケースチームの名前。0 回以上発生する場合が
あります。
template
string
指定した受信者に自動送信されるメールで使用
されるテンプレートを指定します。
宣言的なメタデータの定義のサンプル
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>
157
メタデータ型
AuthProvider
AuthProvider
組織の認証プロバイダを表します。認証プロバイダは Facebook© や Janrain© などの外部サービスプロバイダのロ
グイン情報を使用して、Salesforce 組織にユーザがログインできるようにします。Metadata メタデータ型を拡張
し、その fullName 項目を継承します。
ファイルのサフィックスおよびディレクトリの場所
認証プロバイダは authproviders ディレクトリに保存されます。ファイル名は URL サフィックスに一致し、
拡張子は .authprovider です。たとえば、URL サフィックスが FacebookProvider という認証プロバイダ
は、authproviders/FacebookProvider.authprovider に保存されます。
バージョン
認証プロバイダは、API バージョン 27.0 以降で使用できます。
特別なアクセスルール
このオブジェクトにアクセスできるのは、「アプリケーションのカスタマイズ」権限および「認証プロバイダ
の管理」権限のあるユーザのみです。
項目
項目名
データ型
説明
authorizeUrl
string
providerType が OpenIdConnect である場合にのみ必須
です。OAuth 認証エンドポイント URL。OpenID Connect 認証プ
ロバイダでのみ使用されます。API バージョン 29.0 以降で利
用できます。
consumerKey
string
必須。サードパーティのシングルサインオンプロバイダに
登録されているアプリケーションの鍵。
consumerSecret
string
必須。サードパーティのシングルサインオンプロバイダに
登録されているアプリケーションのコンシューマの秘密。
この項目は更新できません。create() を使用する場合、こ
の項目は暗号化する必要があります。テキスト形式から暗
号化形式のコンシューマの秘密を作成する手順は、次のと
おりです。
1. consumerSecret プレーンテキスト値を使用して認証プ
ロバイダを作成します。
2. 認証プロバイダを保存します。
158
メタデータ型
項目名
AuthProvider
データ型
説明
3. 認証プロバイダコンポーネントを含む送信変更セットを
作成します。
新規変更セットの .xml ファイルには
<consumerSecret>++XYZ++</consumerSecret> という
形式の入力があります。++XYZ++ は暗号化された秘密です。
defaultScopes
string
providerType が OpenIdConnect である場合にのみ必須
です。フローの開始時に指定されていない場合に、認証要
求で送信される範囲。OpenID Connect 認証プロバイダでのみ
使用されます。API バージョン 29.0 以降で利用できます。
DeveloperName
string
必須。プログラムから認証プロバイダを参照するときに使
用します。
errorUrl
string
エラーのレポートに使用するプロバイダのカスタムエラー
URL。
executionUserId
string
Apexハンドラクラスを実行するユーザ。このユーザは「ユー
ザの管理」権限を持っている必要があります。登録ハンド
ラクラスを指定した場合は、ユーザが必要です。
friendlyName
string
必須。わかりやすいプロバイダ名。
iconUrl
string
コミュニティのログインページのボタンとして使用するア
イコンへのパス。ユーザは、このボタンをクリックし、
Twitter© や LinkedIn© など、関連付けられた認証プロバイダを
使用して コミュニティにログインします。API バージョン
32.0 以降で使用できます。
idTokenIssuer
string
providerType が OpenIdConnect の場合にのみ使用でき
ます。この値には、認証トークンのソースを https: URI
形式で指定します。OpenID Connect 認証プロバイダでのみ使
用されます。指定されている場合、Salesforce は返された
id_token 値を検証します。OpenID Connect 仕様では、
id_token 値と一緒に access_token 値を返す必要があり
ます。API バージョン 30.0 以降で利用できます。
providerType
AuthProviderType 必須。使用するサードパーティのシングルサインオンプロ
(string 型の列挙) バイダ。有効な値は、次のとおりです。
• Facebook
• Salesforce
• Janrain
• LinkedIn (API バージョン 32.0 以降で使用可能)
• Twitter (API バージョン 32.0 以降で使用可能)
• OpenIdConnect (API バージョン 29.0 以降で使用可能)
159
メタデータ型
項目名
AuthProvider
データ型
説明
メモ: この型には、次の項目に値が必要です。
– authorizeUrl
– defaultScopes
– tokenUrl
– userInfoUrl
• 通常、MicrosoftACS Microsoft アクセスコントロールサー
ビスは、SharePoint® Online などの Microsoft Office 365 サービ
スの認証を提供します (API バージョン 31.0 以降で使用可
能)。
registrationHandler
string
Auth.RegistrationHandler インターフェースを実装す
る既存の Apex クラス。
sendAccessTokenInHeader boolean
providerType が OpenIdConnect の場合にのみ必須です。
true の場合、アクセストークンはクエリ文字列ではなく
ヘッダーで userInfoUrl に送信されます。OpenID Connect
認証プロバイダでのみ使用されます。API バージョン 30.0 以
降で利用できます。
sendClientCredentialsInHeader boolean
providerType が OpenIdConnect の場合にのみ必須です。
true の場合、クライアントログイン情報はクエリ文字列で
はなくヘッダーで tokenUrl に送信されます。ログイン情
報には、標準の OpenID Connect 基本ログイン情報ヘッダー形
式 Basic <token> が使用されます。ここで <token> は、
base64 符号化文字列 "clientkey:clientsecret" です。
OpenID Connect 認証プロバイダでのみ使用されます。API バー
ジョン 30.0 以降で利用できます。
tokenUrl
string
providerType が OpenIdConnect である場合にのみ必須
です。OAuth トークンエンドポイント URL。OpenID Connect 認
証プロバイダでのみ使用されます。API バージョン 29.0 以降
で利用できます。
userInfoUrl
string
providerType が OpenIdConnect である場合にのみ必須
です。OpenID Connect エンドポイント URL。OpenID Connect 認
証プロバイダでのみ使用されます。API バージョン 29.0 以降
で利用できます。
宣言的なメタデータの定義のサンプル
<?xml version="1.0" encoding="UTF-8"?>
<AuthProvider xmlns="http://soap.sforce.com/2006/04/metadata">
<consumerKey>yourappkey</consumerKey>
160
メタデータ型
AutoResponseRules
<consumerSecret>PwdVxXjzu3NCZ3MD4He+wA==</consumerSecret>
<executionUser>[email protected]</executionUser>
<friendlyName>FacebookAuthProvider</friendlyName>
<providerType>Facebook</providerType>
<registrationHandler>RegistrationHandler</registrationHandler>
</AuthProvider>
前の AuthProvider 定義を参照するパッケージマニフェストの例を次に示します。
<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<types>
<members>AuthProvider</members>
<name>FacebookProvider</name>
</types>
<version>28.0</version>
</Package>
AutoResponseRules
提出されたレコードの属性に基づいてリードまたはケース登録に自動メールレスポンスを送信する条件を設定
する自動レスポンスルールを表します。該当するすべてのオブジェクト、特定のオブジェクト、または特定の
オブジェクトの特定のルールのルールメタデータにアクセスできます。すべてのオブジェクトのすべての自動
レスポンスルールにアクセスする package.xml 構文は次のとおりです。
<types>
<members>*</members>
<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>
161
メタデータ型
AutoResponseRules
ファイルのサフィックスおよびディレクトリの場所
オブジェクトの AutoResponseRules のサフィックスは .autoResponseRules で、autoResponseRules フォル
ダに保存されます。たとえば、すべてのケース自動レスポンスルールは、Case.autoResponseRules ファイ
ルに保存されます。
バージョン
AutoResponseRules コンポーネントは、API バージョン 27.0 以降で使用できます。
項目
項目名
データ型
説明
autoresponseRule
AutoResponseRule[] 指定した自動レスポンスルールの定義を表します。
AutoResponseRule
ルールが有効であるかどうかと、ルールで処理される項目の順序を表します。
項目名
データ型
説明
active
boolean
自動レスポンスルールが有効であるか (true)、
否か (false) を示します。
fullname
string
Metadata から継承されるこの項目は、このメタ
データ型の WSDL では定義されません。作成時、
更新時、または削除時に指定する必要がありま
す。コールにおけるこの項目の例を確認するに
は、「create()」を参照してください。
この値は null にできません。
ruleEntry
RuleEntry[]
自動レスポンスルールの種類と説明を表しま
す。
RuleEntry
ルールで使用される項目を表します。
項目名
データ型
説明
booleanFilter
string
ルールに指定されている高度な絞り込み条件。
criteriaItems
FilterItem[]
割り当て条件を定義するリストの項目。
162
メタデータ型
CallCenter
項目名
データ型
説明
formula
string
入力規則数式。
メモ: formula と criteriaItems のい
ずれかを指定します。両方の項目は指定
できません。
replyToEmail
string
reply-to ヘッダーに表示されるメールアドレス。
senderEmail
string
メール通知を送信する個人またはキューのメー
ルアドレス。
senderName
string
メール通知を送信する個人またはキューの名
前。
template
string
指定した受信者に自動送信されるメールで使用
されるテンプレートを指定します。
宣言的なメタデータの定義のサンプル
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>
CallCenter
Salesforce をサードパーティのコンピュータテレフォニーインテグレーション (CTI) システムと統合するために使
用されるコールセンター定義を表します。
ファイルのサフィックスおよびディレクトリの場所
CallCenter コンポーネントのサフィックスは callCenter で、callCenters フォルダに保存されます。
163
メタデータ型
CallCenter
バージョン
CallCenter コンポーネントは、API バージョン 27.0 以降で使用できます。
項目
項目名
データ型
説明
adapterUrl
string
省略可能な項目。CTI 4 アダプタを示す URL。
displayName
string
このコールセンターの表示名。
displayNameLabel
string
コールセンター設定ページの displayName 項目の表示ラ
ベル。
internalNameLabel
string
コールセンター設定ページの internalName 項目の表示
ラベル。
version
string
このコールセンターのバージョン。
sections
CallCenterSection[] このコールセンターに定義されたカスタム設定項目。
CallCenterSection
項目名
データ型
説明
items
CallCenterItem[] (ページ 164)
セクションを説明する表示ラベル、
名前、値が表示されます。
label
string
セクションの表示ラベル。
name
string
セクションの名前。
項目名
データ型
説明
label
string
カスタム設定項目の表示ラベル。
name
string
カスタム設定項目の名前。
value
int または URL
カスタム設定項目の値。
CallCenterItem
164
メタデータ型
CallCenter
宣言的なメタデータの定義のサンプル
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>
<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>
165
メタデータ型
Community (Zone)
<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 項目に指定した値は無視され、保存されません。
ファイルのサフィックスおよびディレクトリの場所
ゾーンのサフィックスは community で、communities フォルダに保存されます。
バージョン
Community (Zone) コンポーネントは、API バージョン 27.0 以降で使用できます。
項目
項目名
データ型
説明
active
boolean
ゾーンが有効であるか (true)、否か (false) を示します。
communityFeedPage
string
ゾーンのフィードがホストされる Visualforce ページ。この
項目は、組織でChatter アンサーが有効になっている場合に
使用できます。
description
string
ゾーンの説明。
emailFooterDocument
string
組織のブランド情報をメール通知のフッターに組み込むテ
キストファイルまたは HTML ファイル。この項目は、組織
で Chatter アンサーが有効になっている場合に使用できま
す。
emailHeaderDocument
string
組織のブランド情報をメール通知のヘッダーに組み込むテ
キストファイルまたは HTML ファイル。この項目は、組織
で Chatter アンサーが有効になっている場合に使用できま
す。
166
メタデータ型
Community (Zone)
項目名
データ型
説明
emailNotificationUrl
string
メール通知に含まれる URL。この項目は、組織で Chatter ア
ンサーが有効になっている場合に使用できます。この項目
は API バージョン 28.0 以降の
portalEmailNotificationUrl に置き換わるものです。
enableChatterAnswers
boolean
ゾーンで Chatter アンサーが有効化されているか (true)、否
か (false) を示します。この項目は、組織で Chatter アン
サーが有効になっている場合に使用できます。
enablePrivateQuestions
boolean
Chatter アンサーの質問をケースにエスカレーションできる
か (true)、否か (false) を示します。この項目は、組織で
Chatter アンサーが有効になっている場合に使用できます。
expertsGroup
string
ゾーンのエキスパートの役割を果たす公開グループの名
前。この項目は、組織でアイデアまたはアンサーが有効に
なっている場合に使用できます。
portal
string
ゾーンが表示されるポータルの名前。
portalEmailNotificationUrl string
メール通知に含まれるポータル URL。この項目は、組織で
Chatter アンサーが有効になっている場合に使用できます。
この項目は API バージョン 28.0 以降の
emailNotificationUrl に置き換わるものです。
reputationLevels
ReputationLevels
定義する各評価レベルの名前とポイントを定義する項目。
評価レベルは、1 ゾーンにつき 25 個まで作成できます。
showInPortal
boolean
ゾーンをすべてのポータルで使用できるか (true)、いずれ
のポータルでも使用できないか (false) を示します。
site
string
ゾーンのサイトの名前。この項目は、組織で Chatter アン
サーが有効になっている場合に使用できます。
ReputationLevels
フィードでユーザの写真の上にマウスを置くと表示されるポイントと評価レベルを表します。
項目名
データ型
説明
chatterAnswersReputationLevels ChatterAnswersReputationLevel Chatter アンサーの評価レベルを説明する名前と
ideaReputationLevels
[]
値のペアが含まれます。APIバージョン 28.0 以降
で利用できます。
IdeaReputationLevel
アイデアの評価レベルを説明する名前と値のペ
アが含まれます。APIバージョン 28.0 以降で利用
できます。
167
メタデータ型
Community (Zone)
ChatterAnswersReputationLevel
Chatter アンサーの評価名およびそのレベルのポイント数を表します。
項目名
データ型
説明
name
string
評価レベルの名前。たとえば「エキスパート」など。
value
int
評価レベルの最小ポイント数。
IdeaReputationLevel
アイデアの評価名およびそのレベルのポイント数を表します。API バージョン 28.0 以降で利用できます。
項目名
データ型
説明
name
string
評価レベルの名前。たとえば「エキスパート」など。
value
int
評価レベルの最小ポイント数。
宣言的なメタデータの定義のサンプル
次に、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>
<emailNotificationUrl>http://yourURL</emailNotificationUrl>
<reputationLevels>
<chatterAnswersReputationLevels>
<name>Newbie</name>
<value>0</value>
</chatterAnswersReputationLevels>
<chatterAnswersReputationLevels>
<name>Smartie</name>
<value>500</value>
</chatterAnswersReputationLevels>
<chatterAnswersReputationLevels>
<name>Pro</name>
<value>2000</value>
</chatterAnswersReputationLevels>
<chatterAnswersReputationLevels>
<name>All Star</name>
168
メタデータ型
ConnectedApp
<value>5000</value>
</chatterAnswersReputationLevels>
<ideaReputationLevels>
<name>Observer</name>
<value>0</value>
</ideaReputationLevels>
<ideaReputationLevels>
<name>Contributor</name>
<value>100</value>
</ideaReputationLevels>
<ideaReputationLevels>
<name>Influencer</name>
<value>400</value>
</ideaReputationLevels>
<ideaReputationLevels>
<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 以降で使用できます。
項目
項目名
データ型
説明
attributes
ConnectedAppAttribute
接続アプリケーションのカスタム属性。
169
メタデータ型
ConnectedApp
項目名
データ型
説明
canvasConfig
ConnectedAppCanvasConfig
キャンバスアプリケーションとして公開されている場合
の接続アプリケーションの設定オプション。
contactEmail
string
salesforce.comがアプリケーション提供者またはそのサポー
トチームへの連絡に使用するメールアドレス。
contactPhone
string
salesforce.com から連絡する必要がある場合に使用する電
話番号。
description
string
アプリケーションの説明 (省略可能)。
iconUrl
string
将来の使用のために予約されています。
infoUrl
string
アプリケーションについての詳細が記載された Web ペー
ジの URL (省略可能)。
ipRanges
ConnectedAppIpRange
接続アプリケーションでのユーザの認証を必要とせずに
アプリケーションにアクセス可能な IP アドレスの範囲を
指定します。
label
string
アプリケーションの名前。
logoUrl
string
アプリケーションのロゴ (省略可能)。このロゴは、認証
時にユーザに表示されるアプリケーションリストおよび
同意ページのアプリケーションのエントリに表示されま
す。URL には HTTPS を使用し、ロゴは 125×200 ピクセル
(高さ×幅) 以下にする必要があります。デフォルトは雲の
ロゴです。
mobileStartUrl
string
モバイルデバイスからアプリケーションにアクセスする
ときに、認証後、ユーザはこの URL に転送されます。URL
を指定しない場合、ユーザは認証完了後アプリケーショ
ンのデフォルトのスタートページに転送されます。作成
中の接続アプリケーションがキャンバスアプリケーショ
ンである場合は、この項目に値を入力する必要はありま
せん。[キャンバスアプリケーションの URL] 項目には、
接続アプリケーションからコールされる URL が含まれま
す。
oauthConfig
ConnectedAppOauthConfig
アプリケーションが Salesforce と通信する方法を指定しま
す。
samlConfig
ConnectedAppSamlConfig
アプリケーションによるシングルサインオンの使用方法
を制御します。
startUrl
string
モバイルデバイスからのアクセスでない場合、認証後、
ユーザはこの URL に転送されます。URL を指定しない場
合、ユーザは認証完了後アプリケーションのデフォルト
のスタートページに転送されます。モバイルデバイスか
170
メタデータ型
項目名
ConnectedApp
データ型
説明
らアプリケーションにアクセスする場合、
mobileStartUrl を参照してください。作成中の接続ア
プリケーションがキャンバスアプリケーションである場
合は、この項目に値を入力する必要はありません。[キャ
ンバスアプリケーションの URL] 項目には、接続アプリ
ケーションからコールされる URL が含まれます。
ConnectedAppAttribute
SAML とConnectedAppを併用する場合にカスタム属性を構成する項目名を表します。これらの値は、特定のサー
ビスプロバイダに合わせて調整する必要があります。
項目名
データ型
説明
formula
string
属性の値。
key
string
属性の識別子。
ConnectedAppCanvasConfig
キャンバスアプリケーションとして公開されている場合の接続アプリケーションの設定オプション。
項目名
データ型
説明
accessMethod
AccessMethod (string 型の列挙) キャンバスアプリケーションで OAuth 認証フローを開始
する方法を示します。有効な値は、次のとおりです。
• Get — OAuth 認証が使用され、サードパーティアプリ
ケーションがユーザ情報にアクセスすることを許可
するように求められます。このアクセスメソッドを
使用する場合、キャンバスアプリケーションで OAuth
認証フローが開始されるようにする必要があります。
• Post — OAuth 認証を使用しますが、システム管理者
がキャンバスアプリケーションをインストールする
場合、キャンバスアプリケーションはユーザのアク
セスを暗黙的に許可します。したがって、サードパー
ティがユーザ情報にアクセスすることを許可するよ
うに求められることはありません。このアクセスメ
ソッドを使用する場合、認証は直接キャンバスアプ
リケーションの URL に post 送信されます。
canvasUrl
string
キャンバスアプリケーションとして公開されたサード
パーティアプリケーションの URL。
171
メタデータ型
ConnectedApp
項目名
データ型
説明
lifecycleClass
string
Canvas.CanvasLifecycleHandler Apex クラスの名前
(カスタムパラメータの制御にこのクラスを実装している
場合)。
この項目は API バージョン 31.0 以降で使用できます。
locations
CanvasLocationOptions (string 型 キャンバスアプリケーションを表示できる場所を示しま
の列挙)
す。有効な値は、次のとおりです。
• Aura — 今後の使用のために予約されています。
• AppLauncher — 今後の使用のために予約されていま
す。
• Chatter — キャンバスアプリケーションを Chatter タ
ブのアプリケーションナビゲーションリストに表示
できます。
• ChatterFeed — キャンバスアプリケーションを
Chatter フィード項目として表示できます。
• MobileNav — キャンバスアプリケーションを
Salesforce1 アプリケーションのモバイルカードに表示
できます。この値は、API バージョン 31.0 以降で使用
できます。
• None — キャンバスアプリケーションをキャンバスア
プリケーションのプレビューアでのみ表示できます。
• OpenCTI — キャンバスアプリケーションを通話制御
ツールに表示できます。
• PageLayout — キャンバスアプリケーションをペー
ジレイアウトに表示できます。Salesforce1 アプリケー
ションで表示されるとき、キャンバスアプリケーショ
ンはレコード詳細ページに表示されます。この値は、
API バージョン 31.0 以降で使用できます。
• Publisher — キャンバスアプリケーションをグロー
バルアクションとして表示できます。
• ServiceDesk — キャンバスアプリケーションを
Salesforce コンソールのフッターまたはサイドバーに表
示できます。
• UserProfile — 今後の使用のために予約されていま
す。
• Visualforce — キャンバスアプリケーションを
Visualforce ページに表示できます。
options
CanvasOptions (string 型の列挙) キャンバスアプリケーションのパブリッシャーで [共有]
ボタンとヘッダーを非表示にするかどうか、およびアプ
172
メタデータ型
項目名
ConnectedApp
データ型
説明
リケーションがキャンバス個人用アプリケーションかど
うかを示します。有効な値は、次のとおりです。
• HideShare — 関連するキャンバスアプリケーション
のパブリッシャーで [共有] ボタンが非表示になりま
す。
API バージョン 30.0 以降で利用できます。
• HideHeader — 関連するキャンバスアプリケーショ
ンのパブリッシャーでヘッダーが非表示になります。
API バージョン 30.0 以降で利用できます。
• PersonalEnabled — エンドユーザは、アプリケー
ションをキャンバス個人用アプリケーションとして
インストールできます。
API バージョン 32.0 以降で利用できます。
samlInitiationMethod SamlInitiationMethod (string 型
の列挙)
SAML シングルサインオン (SSO) を使用している場合、SSO
フローを開始するプロバイダを示します。
• IdpInitiated — ID プロバイダが開始します。
Salesforce は、SSO フローを開始するための初期要求を
行います。
• SpInitiated — サービスプロバイダが開始します。
キャンバスアプリケーションは、呼び出された後に
SSO フローを開始します。
• None — キャンバスアプリケーションは SAML SSO を使
用していません。
この項目は API バージョン 31.0 以降で使用できます。
ConnectedAppIpRange
ユーザの認証を必要とせずにアプリケーションにアクセス可能な IP アドレスのリスト。
項目名
データ型
説明
description
string
この項目は、この範囲に対応するネットワークの部分な
ど、範囲の目的を識別するために使用します。この項目
は API バージョン 31.0 以降で使用できます。
startAddress
string
IP 範囲の最初のアドレス (指定した値を含む)。
endAddress
string
IP 範囲の最後のアドレス (指定した値を含む)。
173
メタデータ型
ConnectedApp
ConnectedAppOauthConfig
ConnectedApp のカスタム属性を構成する項目名を表します。
項目名
データ型
説明
callbackUrl
string
Salesforce が OAuth 時にアプリケーションにコールバック
するエンドポイントです。これは、OAuth redirect_uri
です。
certificate
string
アプリケーションが証明書を使用する場合の PEM エンコー
ド証明書文字列。
consumerKey
string
Salesforce で識別するためのコンシューマにより使用され
る値。OAuth 2.0 では client_id と呼ばれます。
API バージョン 32.0 以降では、この項目は編集可能です。
設定した後の値は編集できません。値は、8 文字以上 (256
文字以下) の英数字 (特殊文字とスペースは不可) にする必
要があります。組織で別の接続アプリケーションにすで
に使用されている鍵を指定した場合、エラーになります。
consumerSecret
string
consumerKey と組み合わされ、コンシューマによって
Salesforce での識別に使用される値。OAuth 2.0 では
client_secret と呼ばれます。通常、この値は、接続
アプリケーションを作成するときに Salesforce によって生
成されます。ただし、項目は編集可能であるため、共有
された秘密の値をカスタマイズできます。設定後、値は
メタデータ API 要求では返されません。
値は、8 文字以上 (256 文字以下) の英数字 (特殊文字とス
ペースは不可) にする必要があります。組織で別の接続ア
プリケーションにすでに使用されている秘密を指定した
場合、エラーになります。
この項目は API バージョン 32.0 以降で使用できます。
scopes
ConnectedAppOauthAccessScope この範囲は、接続アプリケーションを実行するユーザに
(string 型の列挙)
よって付与される権限です。メタデータをリリースする
場合の有効値は次のとおりです。
• Address — ログインユーザの住所へのアクセスを許
可します (Basic をリリースする場合と同じ動作)。
• Api — API を介したログインユーザのアカウントへの
アクセスを許可します。
• Basic — ID URL サービスへのアクセスを許可します
(Address、Email、Phone、Profile をリリースす
る場合と同じ動作)。
174
メタデータ型
項目名
ConnectedApp
データ型
説明
• Chatter — Chatter REST API リソースへのアクセスのみ
を許可します。
• CustomApplications — Visualforce を使用したカスタ
ムアプリケーションなどのカスタムアプリケーション
へのアクセスを提供します。
• CustomPermissions — 接続アプリケーションに関
連付けられている組織のカスタム権限へのアクセスを
許可し、現在のユーザで各権限が有効かどうかを示し
ます。
• Email — ログインユーザのメールアドレスへのアク
セスを許可します (Basic をリリースする場合と同じ
動作)。
• 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 リソースへのアクセスのみ
を許可します。
175
メタデータ型
項目名
ConnectedApp
データ型
説明
• CustomApplications — Visualforce を使用したカスタ
ムアプリケーションなどのカスタムアプリケーション
へのアクセスを提供します。
• Full — ログインユーザがアクセスできるすべての
データへのアクセスを許可します。
• OpenID — ログインユーザの OpenID Connect アプリケー
ションの一意の識別子へのアクセスを許可します。
• RefreshToken — 更新トークンを受信できる場合に、
それを返すように指定します。OfflineAccess を許
可する場合と同じです。
• Web — Web で access_token を使用することを許可
します。これには visualforce も含まれ、Visualforce
ページへのアクセスが許可されます。
ConnectedAppSamlConfig
アプリケーションによるシングルサインオンの使用方法を指定します。
項目名
データ型
説明
acsUrl
string
サービスプロバイダから取得するアサーションコンシュー
マサービス URL。
certificate
string
アプリケーションが証明書を使用する場合の PEM エンコー
ド証明書文字列。
entityUrl
string
サービスプロバイダから取得するエンティティ ID。
encryptionCertificate string
サービスプロバイダへの SAML アサーションの暗号化に使
用する証明書の名前。この証明書は、組織の [証明書と鍵
の管理] リストに保存されます。API バージョン 30.0 以降
で利用できます。
encryptionType
Salesforce が ID プロバイダの場合、SAML 設定ではサービス
プロバイダへの SAML アサーションの暗号化に使用する暗
号化メソッドを指定できます。サービスプロバイダは、
SAML アサーション内の暗号化メソッドを検出して復号化
できるようにします。有効な値は、次のとおりです。
SamlEncryptionType
(string 型の列挙)
• AES_128 – 128 ビットの鍵。
• AES_256 – 256 ビットの鍵。
• Triple_Des — トリプル DES アルゴリズム。
API バージョン 30.0 以降で利用できます。
176
メタデータ型
ConnectedApp
項目名
データ型
説明
issuer
string
SAML レスポンスを送信する URI。サービスプロバイダが
これを使用してレスポンスを送信する ID プロバイダを特
定できます。API バージョン 29.0 以降で利用できます。
samlNameIdFormat SamlNameIdFormatType (string
サービスプロバイダ (SP) が要求する、ユーザのシングル
サインオン識別子の形式を示します。API バージョン 29.0
以降で利用できます。有効な値は、次のとおりです。
型の列挙)
• Unspecified — 形式は指定されません。これはデ
フォルトです。
• EmailAddress — 件名種別がユーザの名前または統
合 ID (SP の内部の ID) である場合に使用します。
• Persistent — ユーザ ID および永続 ID の件名種別と
併用します。
• Transient — 件名種別がカスタム属性である場合に
使用し、ユーザがログインするたびに変更される可能
性があります。
samlSubjectCustomAttr string
samlSubjectType が CustomAttr である場合、ここに
カスタム値を含めます。それ以外の場合は、空のままに
します。API バージョン 29.0 以降で利用できます。
samlSubjectType
SamlSubjectType (string 型の列 ユーザのシングルサインオン識別子。有効な値は、次の
挙)
とおりです。
• Username — Salesforce ユーザ名。
• FederationId — サービスプロバイダでのユーザの
識別子。この値はサービスプロバイダから取得しま
す。
• UserId — Salesforce ユーザ識別子。
• PersistentID — ID プロバイダおよびサービスプロ
バイダに固有の永続的で不透明な識別子。
• CustomAttr — samlSubjectCustomAttr のカスタ
ム項目値から取得する識別子。
宣言的なメタデータの定義のサンプル
組織の ConnectedApp メタデータをリリースまたは取得するために使用される、パッケージマニフェストの例を
次に示します。
<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<types>
<members>PortalTestApp</members>
177
メタデータ型
ConnectedApp
<name>ConnectedApp</name>
</types>
<version>29.0</version>
</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 つのオプションがあります。
app パラメータにサービスプロバイダアプリケーション ID を次の形式で使用できます。この値は、Salesforce
ユーザインターフェースに表示されます。[設定] から、[アプリケーションを管理する] > [接続アプリケーショ
ン] をクリックし、接続アプリケーションの名前をクリックしてその詳細ページを表示します。
https://<Salesforce_base_URL>/idp/login?app=<app_id>
178
メタデータ型
CorsWhitelistOrigin
または、メタデータ APIのみを使用して接続アプリケーションを設定する場合、サービスプロバイダアプリケー
ションの apiName パラメータを次の形式で使用できます。apiName パラメータは、メタデータ型から継承さ
れた fullName です。
https://<Salesforce_base_URL>/idp/login?apiName=<fullName>
CorsWhitelistOrigin
CORS ホワイトリストのオリジンを表します。
ファイルのサフィックスおよびディレクトリの場所
CorsWhitelistOrigin コンポーネントのサフィックスは .corswhitelistorigin で、corswhitelistorigins
フォルダに保存されます。
バージョン
CorsWhitelistOrigin コンポーネントは、API バージョン 32.0 以降で使用できます。
項目
項目名
データ型
説明
developerName
String
エントリの一意の名前。
urlPattern
String
オリジンの URL パターン。
オリジンの URL パターンには、HTTPS プロトコルとドメイ
ン名、必要に応じてポートが含まれている必要がありま
す。ワイルドカード文字 (*) はサポートされますが、第 2
レベルドメイン名の前にある必要があります。たとえ
ば、https://*.example.com では、example.com の
すべてのサブドメインがホワイトリストに追加されま
す。
オリジンの URL パターンを IP アドレスにすることができ
ます。ただし、同じアドレスに解決される IP アドレスと
ドメインは同じオリジンではなく、それらを CORS ホワ
イトリストに異なるエントリとして追加する必要があり
ます。
179
メタデータ型
CustomApplication
宣言的なメタデータの定義のサンプル
組織の CorsWhitelistOrigin メタデータをリリースまたは取得するために使用される、パッケージマニフェストの
例を次に示します。
<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<types>
<members>*</members>
<name>CorsWhitelistOrigin</name>
</types>
<version>32.0</version>
</Package>
CorsWhitelistOrigin コンポーネントの例を次に示します。
<?xml version="1.0" encoding="UTF-8"?>
<CorsWhitelistOrigin xmlns="http://soap.sforce.com/2006/04/metadata">
<developerName>CorsWhitelistEntry1</developerName>
<urlPattern>https://*.example.com</urlPattern>
</CorsWhitelistOrigin>
使用方法
CORS (クロスオリジンリソース共有) は、Web ブラウザで他のオリジンからのリソースを要求できるようにする
W3C 勧告です。たとえば、CORS を使用すると、https://www.example.com にある JavaScript スクリプトで
https://www.salesforce.com からのリソースを要求できます。
CORS をサポートするブラウザが、Salesforce CORS ホワイトリスト内のオリジンに要求を行うと、Salesforce はオリ
ジンを含む Access-Control-Allow-Origin HTTP ヘッダーと、追加の CORS HTTP ヘッダーを返します。オリ
ジンがホワイトリストにない場合、Salesforce は HTTP 状況コード 404 を返します。
CustomApplication
CustomApplication はカスタムアプリケーションまたは標準アプリケーションを表します。API バージョン 29.0 以
前では、CustomApplication はカスタムアプリケーションのみを表します。アプリケーションは、説明とロゴを
使用したタブ参照のリストです。Metadata メタデータ型を拡張し、その fullName 項目を継承します。
ファイルのサフィックスおよびディレクトリの場所
カスタムアプリケーションおよび標準アプリケーションのサフィックスは .app で、applications フォルダ
に保存されます。
メモ: プロジェクトでこのメタデータ型のコンポーネントを取得すると、同じパッケージで取得された
Profile コンポーネントおよび PermissionSet コンポーネントにこのコンポーネントが表示されるようになり
ます。
180
メタデータ型
CustomApplication
バージョン
カスタムアプリケーションは API バージョン 10.0 以降で使用できます。標準アプリケーションは API バージョ
ン 30.0 以降で使用できます。
項目
項目名
データ型
説明
customApplicationComponents CustomApplicationComponents
Salesforce コンソールアプリケーションに割り
当てられたカスタムコンソールコンポーネン
ト (Visualforce ページ) を表します。
defaultLandingTab
string
このアプリケーションが選択されたときに開
く標準タブまたはカスタムタブの fullName。
description
string
アプリケーションの説明テキスト (省略可能)。
detailPageRefreshMethod string
Salesforce コンソールアプリケーションにおけ
る詳細ページの更新方法を決定します。
isServiceCloudConsole が true である場
合は必須です。有効な値は、次のとおりです。
• none
• autoRefresh
• flag
この項目はAPIバージョン 25.0 以降で使用でき
ます。
domainWhitelist
DomainWhitelist
Salesforce コンソールアプリケーション内から
ユーザがアクセスできる外部ドメイン。たと
えば、www.yourdomain.com のように指定し
ます。この項目はAPIバージョン 25.0 以降で使
用できます。
enableKeyboardShortcuts boolean
Salesforce コンソールアプリケーションでキー
ボードショートカットが有効化されており、
ユーザがマウスを使用せずにキーの組み合わ
せを押してアクションを実行できるかどうか
を示します。キーボードショートカットを有
効化すると、デフォルトのいくつかのショー
トカットをカスタマイズできます。カスタム
ショートカットを作成するには、事前に開発
者が addEventListener() メソッドを使用
してショートカットのアクションを Salesforce
コンソール統合ツールキットに定義しておく
必要があります。コンソールの外部から実行
181
メタデータ型
項目名
CustomApplication
データ型
説明
されるアクションのキーボードショートカッ
トを作成することはできません。
isServiceCloudConsole が true である場
合は必須です。
この項目はAPIバージョン 28.0 以降で使用でき
ます。
Salesforce コンソールアプリケーションで、マ
ルチモニターコンポーネントが有効かどうか
を示します。マルチモニターコンポーネント
を使用すると、ユーザがコンソールの各部分
をブラウザから画面上の場所に移動できます。
isServiceCloudConsole が true である場
合は必須です。
enableMultiMonitorComponents boolean
この項目はAPIバージョン 30.0 以降で使用でき
ます。
isServiceCloudConsole
boolean
アプリケーションが Salesforce コンソールアプ
リケーションであるかを示します。詳細は、
Salesforce オンラインヘルプの「Salesforce コン
ソールの概要」を参照してください。
keyboardShortcuts
KeyboardShortcuts
Salesforce コンソールアプリケーションのキー
ボードショートカットを表します。キーボー
ドショートカットにより、ユーザはマウスを
使用せずにキーの組み合わせを押してアクショ
ンを実行できます。
この項目はAPIバージョン 28.0 以降で使用でき
ます。
fullName
string
アプリケーションの内部名。label に基づき
ますが、有効性のために空白と特殊文字はエ
スケープ処理されます。fullName には、ア
ンダースコアと英数字のみを使用できます。
一意であること、最初は文字であること、空
白は使用しない、最後にアンダースコアを使
用しない、2 つ続けてアンダースコアを使用
しないという制約があります。この項目は、
Metadata コンポーネントから継承されていま
す。
label
string
アプリケーションの名前。
182
メタデータ型
CustomApplication
項目名
データ型
説明
listPlacement
ListPlacement
Salesforce コンソールアプリケーションにおけ
るリストの表示方法を表します。
isServiceCloudConsole が true である場
合は必須です。
listRefreshMethod
string
Salesforce コンソールアプリケーションにおけ
るリストの更新方法を決定します。
isServiceCloudConsole が true である場
合は必須です。有効な値は、次のとおりです。
• none
• refreshList
• refreshListRows
この項目はAPIバージョン 25.0 以降で使用でき
ます。
liveAgentConfig
LiveAgentConfig (ページ 191)
Salesforce コンソールで Live Agent を使用するた
めの設定を表します。
logo
string
アプリケーションの画像ドキュメントへの参
照 (省略可能)。
pushNotifications
PushNotifications
Salesforce コンソールアプリケーションの転送
通知を表します。転送通知とは、リストおよ
び詳細ページにあるビジュアルインジケータ
であり、ユーザのセッション中にレコードま
たは項目が変更されると表示されます。たと
えば、2 つのサポートエージェントが同じケー
スで作業している場合に一方のエージェント
が [優先度] を変更すると、もう一方のエー
ジェントに転送通知が表示されるため、その
エージェントは変更を認識でき、同じ作業を
行わなくてすみます。
この項目はAPIバージョン 28.0 以降で使用でき
ます。
saveUserSessions
boolean
コンソールのユーザがブラウザを閉じたり、
Salesforce からログアウトしたりしても、再度
ログインしたときに以前に開いていたタブが
表示されるようにするため、Salesforce コンソー
ルアプリケーションでユーザセッションを自
動的に保存するかどうかを示します。
isServiceCloudConsole が true である場
合は必須です。
183
メタデータ型
項目名
CustomApplication
データ型
説明
この項目はAPIバージョン 28.0 以降で使用でき
ます。
tab
string[]
このアプリケーションに含まれるタブのリス
ト。API バージョン 12.0 では、[ホーム]、[取引
先]、および [レポート] などの組み込みタブの
fullName がタブの名前になります (Home な
ど)。APIバージョン 13.0 以降では、組み込みタ
ブには standard- というプレフィックスが
追加されます。たとえば、[取引先] タブを参
照するには、standard-Account を使用しま
す。
workspaceMappings
WorkspaceMappings
Salesforce コンソールアプリケーションでレコー
ドをどのように開くかを表します。
isServiceCloudConsole が true である場
合は必須です。この項目は API バージョン 25.0
以降で使用できます。
CustomApplicationComponents
Salesforce コンソールアプリケーションに割り当てられたカスタムコンソールコンポーネント (Visualforce ページ)
を表します。API バージョン 25.0 以降で利用できます。
項目名
データ型
説明
alignment
string
Salesforce コンソールアプリケーションのフッターにおける
カスタムコンソールコンポーネントの整列方法を決定しま
す。
customApplicationComponent string
Salesforce コンソールアプリケーションに割り当てられたカ
スタムコンソールコンポーネントの名前。
CustomShortcut
Salesforce コンソールアプリケーションに割り当てられたカスタムキーボードショートカットを表します。カス
タムショートカットを作成するには、事前に開発者が addEventListener() メソッドを使用してショート
カットのアクションをSalesforce コンソール統合ツールキットに定義しておく必要があります。コンソールの外
部から実行されるアクションのキーボードショートカットを作成することはできません。API バージョン 28.0
以降で利用できます。
184
メタデータ型
CustomApplication
項目名
データ型
説明
action
string
必須。ユーザがキーボードショートカットを押したときに
コンソールで実行されるアクション。
active
boolean
必須。キーボードショートカットが有効であるか (true)、
否か (false) を示します。
keyCommand
string
必須。キーボードショートカットをトリガするためにユー
ザが押すキーの組み合わせ。キーボードショートカットで
は大文字と小文字が区別されませんが、見やすくするため
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
185
メタデータ型
項目名
CustomApplication
データ型
説明
• 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
• F6
• F7
• F8
• F9
• F10
• F11
• F12
• NUM LOCK
• SCROLL LOCK
• ;
• =
• ,
• —
• .
• /
• ‘
186
メタデータ型
項目名
CustomApplication
データ型
説明
• [
• ]
• \
• '
description
string
キーボードショートカットの説明テキスト (省略可能)。
eventName
string
必須。Salesforce コンソールインテグレーションツールキッ
トを使用して、開発者がカスタムショートカット関数をコ
ンソールに追加するときに使用できるコード。
DefaultShortcut
Salesforce コンソールアプリケーションにデフォルトで割り当てられたキーボードショートカットを表します。
コンソールのキーボードショートカットを有効にすると、タブの開閉、タブ間の移動、およびレコードの保存
など、いくつかのデフォルトショートカットをカスタマイズに使用できるようになります。APIバージョン 28.0
以降で利用できます。
項目名
データ型
説明
action
string
必須。ユーザがキーボードショートカットを押したときに
コンソールで実行されるアクション。有効な値は、次のと
おりです。
• 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
187
メタデータ型
項目名
CustomApplication
データ型
説明
デフォルトのキーボードショートカットの一覧および説明
は、Salesforce オンラインヘルプの「Salesforce コンソールの
デフォルトのキーボードショートカット」を参照してくだ
さい。
active
boolean
必須。キーボードショートカットが有効であるか (true)、
否か (false) を示します。
keyCommand
string
必須。キーボードショートカットをトリガするためにユー
ザが押すキーの組み合わせ。キーボードショートカットで
は大文字と小文字が区別されませんが、見やすくするため
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
188
メタデータ型
項目名
CustomApplication
データ型
説明
• 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
• F6
• F7
• F8
• F9
• F10
• F11
• F12
• NUM LOCK
• SCROLL LOCK
• ;
• =
• ,
• —
• .
189
メタデータ型
項目名
CustomApplication
データ型
説明
• /
• ‘
• [
• ]
• \
• '
DomainWhitelist
Salesforce コンソールアプリケーション内からユーザがアクセスできる外部ドメインを表します。たとえば、
www.yourdomain.com です。API バージョン 25.0 以降で利用できます。
項目名
データ型
説明
domain
string
このSalesforce コンソールアプリケーション内からユーザが
アクセスできる外部ドメイン。
KeyboardShortcuts
Salesforce コンソールアプリケーションに割り当てられたキーボードショートカットを表します。
isServiceCloudConsole が true である場合は必須です。API バージョン 28.0 以降で利用できます。
項目名
データ型
説明
customShortcut
KeyboardShortcuts[]
Salesforce コンソールアプリケーションに割り当てられたカ
スタムキーボードショートカットを表します。カスタム
ショートカットを作成するには、事前に開発者が
addEventListener() メソッドを使用してショートカッ
トのアクションをSalesforce コンソール統合ツールキットに
定義しておく必要があります。コンソールの外部から実行
されるアクションのキーボードショートカットを作成する
ことはできません。
defaultShortcut
KeyboardShortcuts[]
Salesforce コンソールアプリケーションにデフォルトで割り
当てられたキーボードショートカットを表します。コン
ソールのキーボードショートカットを有効にすると、タブ
の開閉、タブ間の移動、およびレコードの保存など、いく
つかのデフォルトショートカットをカスタマイズに使用で
きるようになります。
デフォルトのキーボードショートカットの一覧および説明
は、Salesforce オンラインヘルプの「Salesforce コンソールの
190
メタデータ型
項目名
CustomApplication
データ型
説明
デフォルトのキーボードショートカット」を参照してくだ
さい。
ListPlacement
Salesforce コンソールアプリケーションにおけるリストの表示方法を表します。isServiceCloudConsole が
true である場合は必須です。API バージョン 25.0 以降で利用できます。
項目名
データ型
説明
height
int
リストの高さ (ピクセルまたはパーセント単位)。location
が top の場合は必須です。
location
string
必須。画面上のリストの位置。有効な値は、次のとおりで
す。
• full
• top
• left
units
string
必須。height または width がピクセル単位かパーセント
単位かを表します。
width
int
リストの幅 (ピクセルまたはパーセント単位)。location
が left の場合は必須です。
LiveAgentConfig
Salesforce コンソールで Live Agent を使用するための組織の設定を表します。
項目名
データ型
説明
enableLiveChat
boolean
組織でLive Agentが有効化されているか (true)、否か (false)
を指定します。
openNewAccountSubtab
boolean
エージェントがチャットを受け入れたときにSalesforce コン
ソールで新しい [取引先] サブタブを自動的に開くか (true)、
否か (false) を指定します。
openNewCaseSubtab
boolean
エージェントがチャットを受け入れたときにSalesforce コン
ソールで新しい [ケース] サブタブを自動的に開くか (true)、
否か (false) を指定します。
191
メタデータ型
CustomApplication
項目名
データ型
説明
openNewContactSubtab
boolean
エージェントがチャットを受け入れたときにSalesforce コン
ソールで新しい [取引先責任者] サブタブを自動的に開くか
(true)、否か (false) を指定します。
openNewLeadSubtab
boolean
エージェントがチャットを受け入れたときにSalesforce コン
ソールで新しい [リード] サブタブを自動的に開くか (true)、
否か (false) を指定します。
openNewVFPageSubtab
boolean
エージェントがチャットを受け入れたときにSalesforce コン
ソールで新しい Visualforce ページをサブタブとして自動的
に開くか (true)、否か (false) を指定します。
pagesToOpen
PagesToOpen (ペー
ジ 192)
エージェントがチャットを受け入れたときにSalesforce コン
ソールのサブタブで Visualforce ページを開くことを指定し
ます。
showKnowledgeArticles
boolean
Salesforce コンソールで Live Agent を使用するときにナレッジ
コンポーネントを表示するか (true)、否か (false) を指定
します。
PagesToOpen
エージェントがチャット要求を受け入れたときに Salesforce コンソールのサブタブで開く Visualforce ページを表
します。API バージョン 28.0 以降で利用できます。
項目名
データ型
説明
pagesToOpen
string
エージェントがチャットを受け入れたときにSalesforce コン
ソールのサブタブで開く Visualforce ページの名前。
PushNotifications
ユーザのセッション中にレコードまたは項目が変更されると表示される、リストおよび詳細ページにあるビ
ジュアルインジケータである転送通知のセットを表します。isServiceCloudConsole が true の場合に使
用できます。API バージョン 28.0 以降で利用できます。
項目名
データ型
説明
pushNotification
PushNotification[]
転送通知のセット。
192
メタデータ型
CustomApplication
PushNotification
ユーザのセッション中にレコードまたは項目が変更された場合に、リストおよび詳細ページにあるビジュアル
インジケータを Salesforce コンソールアプリケーションに表示するかどうかを表します。
isServiceCloudConsole が true の場合に使用できます。API バージョン 28.0 以降で利用できます。
項目名
データ型
説明
fieldNames
string
必須。選択されたオブジェクトに対して転送通知をトリガ
する 1 つまたは複数の項目の名前。
objectName
string
必須。転送通知をトリガするオブジェクトの名前。
WorkspaceMappings
Salesforce コンソールアプリケーションでレコードをどのように開くかを表します。isServiceCloudConsole
が true である場合は必須です。API バージョン 25.0 以降で利用できます。
項目名
データ型
説明
mapping
WorkspaceMapping
Salesforce コンソールアプリケーションで特定のタブのレ
コードをどのように開くかを表します。CustomApplicationに
指定された各タブで必須です。
WorkspaceMapping
Salesforce コンソールアプリケーションで特定のタブのレコードをどのように開くかを表します。CustomApplication
に指定された各タブで必須です。API バージョン 25.0 以降で利用できます。
項目名
データ型
説明
fieldName
string
tab をサブタブとして表示する主タブを指定する項目の名
前。指定されていない場合、tab は主タブとして開きま
す。
tab
string
必須。タブの名前。
アプリケーションの取得
組織のアプリケーションを取得するには、package.xml マニフェストファイルで CustomApplication 型の名前を
使用します。すべてのアプリケーションを取得することも、package.xml の types セクションに取得するアプ
リケーションを指定することもできます。
193
メタデータ型
CustomApplication
組織のすべてのアプリケーション (カスタムアプリケーションおよび標準アプリケーション) を取得するには、
ワイルドカード文字 (*) を次のように指定します。
<types>
<members>*</members>
<name>CustomApplication</name>
</types>
メモ: API バージョン 29.0 以前では、ワイルドカードを使用するとすべてのカスタムアプリケーションの
みが返され、標準アプリケーションは返されません。
カスタムアプリケーションを取得するには、アプリケーション名を指定します。
<types>
<members>MyCustomApp</members>
<name>CustomApplication</name>
</types>
標準アプリケーションを取得するには、アプリケーション名に 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>
194
メタデータ型
CustomApplication
標準アプリケーション (Chatter) の定義を次に示します。
<?xml version="1.0" encoding="UTF-8"?>
<CustomApplication xmlns="http://soap.sforce.com/2006/04/metadata">
<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 であるカスタムアプリケーションの定義を次に示します。
<?xml version="1.0" encoding="UTF-8"?>
<CustomApplication xmlns="http://soap.sforce.com/2006/04/metadata">
<customApplicationComponents>
<alignment>left</alignment>
<customApplicationComponent>MyComponent</customApplicationComponent>
</customApplicationComponents>
<defaultLandingTab>standard-home</defaultLandingTab>
<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>
195
メタデータ型
CustomApplication
<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>
</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>
196
メタデータ型
CustomApplication
</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>
197
メタデータ型
CustomApplicationComponent
</workspaceMappings>
</CustomApplication>
関連トピック:
CustomTab
CustomApplicationComponent
Salesforce コンソールとしてマークされている CustomApplication に割り当てられたカスタムコンソールコンポー
ネント (Visualforce ページ) を表します。カスタムコンソールコンポーネントは、Salesforce コンソールアプリケー
ションの機能を拡張します。Salesforceオンラインヘルプの「カスタムコンソールコンポーネントの概要」を参
照してください。
ファイルのサフィックスおよびディレクトリの場所
カスタムアプリケーションコンポーネントのサフィックスは .customApplicationComponent で、
customApplicationComponents フォルダに保存されます。
バージョン
カスタムアプリケーションは API バージョン 25.0 以降で使用できます。
項目
項目名
データ型
説明
buttonIconUrl
string
ボタンのアイコンをホストするページのアドレス。
buttonStyle
string
ボタンの外観の定義に使用されるインラインスタイル。
buttonText
string
カスタムコンソールコンポーネントの起動に使用されるボ
タンの表示ラベル。
buttonWidth
int
Salesforce コンソールに表示されるボタンの幅 (ピクセル単
位)。
height
int
カスタムコンソールコンポーネントを表示するために使用
されるウィンドウの高さ (ピクセル単位)。
isHeightFixed
boolean
必須。ユーザがカスタムコンソールコンポーネントの高さ
を変更できるか (false)、否か (true) を示します。
isHidden
boolean
必須。カスタムコンソールコンポーネントがユーザに非表
示であるか (true)、否か (false) を示します。
198
メタデータ型
CustomLabels
項目名
データ型
説明
isWidthFixed
boolean
必須。ユーザがコンポーネントの幅を変更できるか
(false)、否か (true) を示します。
visualforcePage
string
必須。カスタムコンソールコンポーネントを表すVisualforce
ページの名前。
width
int
カスタムコンソールコンポーネントを表示するために使用
されるウィンドウの幅 (ピクセル単位)。
宣言的なメタデータの定義のサンプル
カスタムアプリケーションコンポーネントの定義を次に示します。
<?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 は、翻
訳言語のロケールコードです。サポートされるロケールコードのリストは、「言語」 (ページ 607) に示してい
ます。
カスタム表示ラベルの翻訳は、対応するパッケージディレクトリの labels フォルダに保存されます。
199
メタデータ型
CustomLabels
バージョン
CustomLabels コンポーネントは、API バージョン 14.0 以降で使用できます。
項目
項目
データ型
説明
fullName
string
必須。カスタム表示ラベルバンドルの名前。
Metadata から継承されるこの項目は、このメタデー
タ型の WSDL では定義されません。作成時、更新時、
または削除時に指定する必要があります。コールに
おけるこの項目の例を確認するには、「create()」
を参照してください。
labels
CustomLabel[]
カスタム表示ラベルのリスト。
CustomLabel
このメタデータ型は、カスタム表示ラベルを表します。Metadata メタデータ型を拡張し、その fullName 項目
を継承します。
項目
データ型
説明
categories
string
表示ラベルのカテゴリのカンマ区切りのリスト。こ
の項目は、カスタム表示ラベルのリストビューを作
成するときに、検索条件として使用できます。最大
255 文字です。
fullName
string
必須。カスタム表示ラベルの名前。
Metadata から継承されるこの項目は、このメタデー
タ型の WSDL では定義されません。作成時、更新時、
または削除時に指定する必要があります。コールに
おけるこの項目の例を確認するには、「create()」
を参照してください。
language
string
必須。翻訳されたカスタム表示ラベルの言語。
protected
boolean
必須。このコンポーネントが保護されるか (true)、
否か (false) を示します。保護コンポーネントは、
インストールする組織で作成されたコンポーネント
によってリンク設定したり参照したりすることはで
きません。
200
メタデータ型
CustomLabels
項目
データ型
説明
shortDescription
string
必須。このカスタム表示ラベルを識別するための、
認識しやすい用語。この説明は差し込み項目で使用
されます。
value
string
必須。翻訳済みのカスタム表示ラベル。最大 1000
文字です。
使用方法
組織で定義されているすべてのカスタム表示ラベルを取得するには、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>
次のサンプルマニフェストファイルは、CustomLabels 型を使用して、組織のすべてのカスタム表示ラベルを取
得します。
<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<fullName>MyPkg</fullName>
<types>
<members>*</members>
<name>CustomLabels</name>
</types>
<version>32.0</version>
</Package>
201
メタデータ型
CustomObject
次のサンプルマニフェストファイルでは、名前で 2 つのカスタム表示ラベルを取得します。単数形の CustomLabel
が使用されています。
<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<fullName>MyPkg</fullName>
<types>
<members>quoteManual</members>
<members>quoteAuto</members>
<name>CustomLabel</name>
</types>
<version>32.0</version>
</Package>
関連トピック:
Translations
CustomObject
組織に固有のデータを保存するカスタムオブジェクト、またはSalesforceの外部に保存されているデータに対応
付けられる外部オブジェクトを表します。Metadata メタデータ型を拡張し、その fullName 項目を継承しま
す。カスタムオブジェクトを作成または更新するときに関連するすべての項目を指定する必要があります。オ
ブジェクトの単一の項目を更新することはできません。カスタムオブジェクトの詳細については、Salesforceオ
ンラインヘルプの「カスタムオブジェクトの概要」を参照してください。
また、このメタデータ型を使用して、取引先などの標準オブジェクトのカスタマイズを行うこともできます。
「標準オブジェクト」 (ページ 19)の例を参照してください。
すべてのメタデータコンポーネントには fullName 項目があり、すべてのカスタムオブジェクトで完全に指定
されている必要があります。
たとえば、標準オブジェクトおよびカスタムオブジェクトの完全に指定された名前はそれぞれ次のようになり
ます。
Account
MyCustomObject__c
外部オブジェクトの完全に指定された名前は次のようになります。
MyExternalObject__x
カスタムオブジェクトを作成する Java のサンプルコードについては、「ステップ 3: Java サンプルコードの説
明」 (ページ 7)を参照してください。
宣言的なメタデータファイルのサフィックスおよびディレクトリの
場所
カスタムオブジェクト名には、自動的に __c が追加されます。カスタムオブジェクトまたは標準オブジェクト
ファイルのファイルサフィックスは .object です。
202
メタデータ型
CustomObject
外部オブジェクト名には、自動的に __x が追加されます。外部オブジェクトファイルのファイルサフィックス
は、.object です。
カスタムオブジェクト、標準オブジェクト、および外部オブジェクトは、対応するパッケージディレクトリの
objects フォルダに保存されます。
メモ: プロジェクトでこのメタデータ型のコンポーネントを取得すると、同じパッケージで取得された
Profile コンポーネントおよび PermissionSet コンポーネントにこのコンポーネントが表示されるようになり
ます。
バージョン
カスタムオブジェクトは API バージョン 10.0 以降で使用できます。外部オブジェクトは API バージョン 32.0 以降
で使用できます。
項目
別途記載がない限り、すべての項目は作成可能、除外可能で、null にすることもできます。
項目名
データ型
説明
actionOverrides
ActionOverride[]
オブジェクトの override アクションのリスト。
この項目は API バージョン 18.0 以降で使用できま
す。
businessProcesses
BusinessProcess[]
オブジェクトに関連付けられたビジネスプロセス
のリスト。
この項目は API バージョン 17.0 以降で使用できま
す。
compactLayoutAssignment
string
オブジェクトに割り当てられたコンパクトレイア
ウト。
この項目は API バージョン 29.0 以降で使用できま
す。
compactLayouts
CompactLayout[]
オブジェクトに関連付けられたコンパクトレイア
ウトのリスト。
この項目は API バージョン 29.0 以降で使用できま
す。
customHelp
string
オブジェクトのヘルプコンテンツがカスタマイズ
されている場合に、ヘルプコンテンツが含まれる
Sコントロール。この項目は、API バージョン 14.0
以降で使用できます。
203
メタデータ型
CustomObject
項目名
データ型
説明
customHelpPage
string
オブジェクトのヘルプコンテンツがカスタマイズ
されている場合に、ヘルプコンテンツが含まれる
Visualforce ページ。この項目は、API バージョン 16.0
以降で使用できます。
customSettingsType
CustomSettingsType (string
型の列挙)
この項目が存在する場合、このコンポーネントは
カスタムオブジェクトではなくカスタム設定で
す。この項目はカスタム設定の型を返します。有
効な文字列値は次のとおりです。
• List — キャッシュに保存された静的データ
で、アプリケーションの一部としてアクセス
されます。組織全体で使用できます。
• Hierarchy — キャッシュに保存された静的
データで、アプリケーションの一部としてア
クセスされます。ユーザ、プロファイル、ま
たは組織の階層に基づいて使用できます。こ
れはデフォルト値です。
この項目は API バージョン 17.0 以降で使用できま
す。
customSettingsVisibility
CustomSettingsVisibility
(string 型の列挙)
この項目が存在する場合、このコンポーネントは
カスタムオブジェクトではなくカスタム設定で
す。この項目はカスタム設定の表示を返します。
有効な文字列値は次のとおりです。
• Public — カスタム設定がパッケージ化され
ている場合、すべての登録組織がアクセスで
きます。
• Protected — カスタム設定が管理パッケージ
に含まれる場合、開発組織のみがアクセスで
きます。登録組織はアクセスできません。こ
れはデフォルト値です。
この項目は API バージョン 17.0 以降で使用できま
す。
deploymentStatus
DeploymentStatus (string 型 オブジェクトのリリース状況を示します。
の列挙)
deprecated
boolean
将来の使用のために予約されています。
description
string
オブジェクトの説明。最大 1000 文字です。
enableActivities
boolean
活動のオブジェクトが有効になっているか
(true)、否か (false) を示します。
204
メタデータ型
CustomObject
項目名
データ型
説明
enableBulkApi
boolean
有効な場合、オブジェクトは、利用状況の追跡の
ためのエンタープライズアプリケーションオブ
ジェクトとして分類されます。
有効な場合、enableSharing および
enableStreamingApi も有効にする必要があり
ます。
この項目は API バージョン 31.0 以降で使用できま
す。
enableDivisions
boolean
ディビジョンのオブジェクトが有効になっている
か (true)、否か (false) を示します。ディビジョ
ンオブジェクトについての詳細は、『SOAP API 開
発者ガイド』を参照してください。
enableEnhancedLookup
boolean
拡張ルックアップのオブジェクトが有効になって
いるか (true)、否か (false) を示します。API バー
ジョン 28.0 以降では、この項目を Account、
Contact、および User オブジェクトにも使用できま
す。拡張ルックアップにより、ルックアップダイ
アログインターフェースが更新され、検索結果の
絞り込み、並び替え、およびページ操作と検索結
果列のカスタマイズが可能になります。拡張ルッ
クアップについての詳細は、Salesforce オンライン
ヘルプの「拡張ルックアップの有効化」を参照し
てください。
enableFeeds
boolean
フィード追跡のオブジェクトが有効になっている
か (true)、否か (false) を示します。詳細は、
Salesforce オンラインヘルプの「Chatter フィード追
跡のカスタマイズ」を参照してください。
この項目は API バージョン 18.0 以降で使用できま
す。
enableHistory
boolean
履歴追跡のオブジェクトが有効になっているか
(true)、否か (false) を示します。API バージョン
29.0 以降では標準オブジェクトにも使用できます。
enableReports
boolean
レポートのオブジェクトが有効になっているか
(true)、否か (false) を示します。
205
メタデータ型
CustomObject
項目名
データ型
説明
enableSharing
boolean
有効な場合、オブジェクトは、利用状況の追跡の
ためのエンタープライズアプリケーションオブ
ジェクトとして分類されます。
有効な場合、enableBulkApi および
enableStreamingApi も有効にする必要があり
ます。
この項目は API バージョン 31.0 以降で使用できま
す。
enableStreamingApi
boolean
有効な場合、オブジェクトは、利用状況の追跡の
ためのエンタープライズアプリケーションオブ
ジェクトとして分類されます。
有効な場合、enableBulkApi および
enableSharing も有効にする必要があります。
この項目は API バージョン 31.0 以降で使用できま
す。
externalDataSource
必須で、外部オブジェクトでのみ使用可能です。
外部オブジェクトのデータが保存される外部デー
タソースの名前です。データソースは
ExternalDataSource コンポーネントで表されます。
string
この項目は API バージョン 32.0 以降で使用できま
す。
externalName
string
必須で、外部オブジェクトでのみ使用可能です。
外部オブジェクトのデータが含まれる、外部デー
タソース内のテーブルの名前です。
この項目は API バージョン 32.0 以降で使用できま
す。
externalSharingModel
SharingModel(string 型の列 ポータルユーザやコミュニティユーザなど、外部
挙)
ユーザのアクセスレベルを決定する、オブジェク
トの外部組織の共有設定を示します。この項目
は、次のオブジェクトでサポートされます。
• 取引先と、それに関連する契約および納入商
品
• ケース
• 取引先責任者
• 商談
• カスタムオブジェクト
206
メタデータ型
項目名
CustomObject
データ型
説明
• ユーザ
この項目は API バージョン 31.0 以降で使用できま
す。
fields
CustomField[]
オブジェクトの 1 つ以上の項目を表します。
fieldSets
FieldSet
このオブジェクトに存在する項目セットを定義し
ます。
fullName
string
Metadataから継承されるこの項目は、このメタデー
タ型の WSDL では定義されません。作成時、更新
時、または削除時に指定する必要があります。
コールにおけるこの項目の例を確認するには、
「create()」を参照してください。
この値は null にできません。
gender
Gender
オブジェクトを表す名詞の性別を示します。これ
は、語の性別に基づいて、異なる処理が必要とな
る言語に使用されます。
household
boolean
この項目は、Salesforce for Wealth Management でのみ
使用できるリレーショングループという機能をサ
ポートします。詳細は、Salesforce オンラインヘル
プの「Salesforce for Wealth Management の概要」を参
照してください。
historyRetentionPolicy
HistoryRetentionPolicy
将来の使用のために予約されています。
label
string
Salesforce ユーザインターフェース全体でオブジェ
クトを表す表示ラベル。
listViews
ListView[]
オブジェクトに関連付けられた 1 つ以上のリスト
ビューを表します。
namedFilter
NamedFilter[]
ルックアップ検索条件に関連付けられたメタデー
タを表します。ルックアップ検索条件の定義を作
成、更新、または削除するには、このメタデータ
型を使用します。
この項目は API バージョン 17.0 以降で使用できま
す。
この項目はAPIバージョン 30.0 で削除されました。
それより前のバージョンでのみ使用できます。
ルックアップ検索条件に関連付けられたメタデー
タは、CustomField コンポーネントの
207
メタデータ型
項目名
CustomObject
データ型
説明
lookupFilter 項目によって表されるようになり
ました。
nameField
CustomField
カスタムオブジェクトの場合、必須です。外部オ
ブジェクトは代わりに、CustomField コンポーネン
トの isNameField を true に設定することで、
名前項目を指定する場合があります。
このオブジェクトの名前が保存されている項目。
すべてのカスタムオブジェクトには名前が必要で
す。この名前は、通常文字列型または自動採番型
です。
カスタムオブジェクトのレコードに付けられる識
別子。この名前は、ページレイアウト、関連リス
ト、ルックアップダイアログ、検索結果、および
タブホームページの主要リストに表示されます。
デフォルトでは、カスタムオブジェクトのページ
レイアウトに必須項目としてこの項目が追加され
ます。
pluralLabel
string
label 値の複数形です。
recordTypes
RecordType[]
このオブジェクトに定義された 1 つ以上のレコー
ドタイプの配列。
recordTypeTrackFeedHistory boolean
フィード追跡のレコードタイプが有効になってい
るか (true)、否か (false) を示します。この項目
を true に設定するには、関連付けられた
CustomObject の enableFeeds 項目も true に設定
されている必要があります。詳細は、Salesforce オ
ンラインヘルプの「Chatter フィード追跡のカスタ
マイズ」を参照してください。
この項目は API バージョン 19.0 以降で使用できま
す。
recordTypeTrackHistory
boolean
このレコードタイプの履歴追跡が有効になってい
るか (true)、否か (false) を示します。
recordTypeTrackHistory を true に設定するに
は、関連付けられたカスタムオブジェクトの
enableHistory 項目も true に設定されている
必要があります。
この項目は API バージョン 19.0 以降で使用できま
す。
208
メタデータ型
CustomObject
項目名
データ型
説明
searchLayouts
SearchLayouts
オブジェクトの検索レイアウト関連リスト情報。
sharingModel
SharingModel(string 型の列 オブジェクトの組織の共有設定を示します。
挙)
メモ: API バージョン 29.0 以前を使用する場
合、この項目は参照のみであり、メタデー
タ APIを使用して設定できないため、Salesforce
ユーザインターフェースを使用する必要が
あります。API バージョン 30.0 以降を使用す
る場合、この項目は API および Salesforce ユー
ザインターフェースを使用して内部ユーザ
向けに設定できます。
sharingReasons
SharingReason[]
オブジェクトが共有されている理由。
sharingRecalculations
SharingRecalculation[]
オブジェクトに関連付けられたカスタム共有の再
適用のリスト。
startsWith
StartsWith (string 型の列挙) 名詞が母音、子音、または特殊文字で開始されて
いるかを示します。これは、語の最初の文字に基
づいて、異なる処理が必要となる言語に使用され
ます。有効な値は、「StartsWith」 にリストされて
います。
validationRules
ValidationRule[]
オブジェクトの 1 つ以上の入力規則の配列。
webLinks
Weblink[]
このオブジェクトに定義された 1 つ以上の Web リ
ンクの配列。
宣言的なメタデータのその他のコンポーネント
CustomObject の定義には、カスタムオブジェクトで宣言的なメタデータについて定義されているその他のコン
ポーネントが含まれる場合があります。CustomObject に定義されているコンポーネントは、次のとおりです。
• ActionOverride
• BusinessProcess
• CompactLayout
• CustomField
• FieldSet
• HistoryRetentionPolicy
• ListView
• RecordType
• SearchLayouts
• SharingReason
• SharingRecalculation
209
メタデータ型
CustomObject
• ValidationRule
• Weblink
宣言的なメタデータの定義のサンプル
<?xml version="1.0" encoding="UTF-8"?>
<CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">
<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>
Platform Connect の外部オブジェクトのメタデータ定義を次に示します。
<?xml version="1.0" encoding="UTF-8"?>
<CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">
<actionOverrides>
<actionName>CancelEdit</actionName>
<type>Default</type>
</actionOverrides>
<actionOverrides>
<actionName>Delete</actionName>
<type>Default</type>
</actionOverrides>
<actionOverrides>
<actionName>Edit</actionName>
<type>Default</type>
</actionOverrides>
<actionOverrides>
<actionName>Follow</actionName>
<type>Default</type>
</actionOverrides>
<actionOverrides>
<actionName>List</actionName>
<type>Default</type>
</actionOverrides>
<actionOverrides>
210
メタデータ型
CustomObject
<actionName>New</actionName>
<type>Default</type>
</actionOverrides>
<actionOverrides>
<actionName>SaveEdit</actionName>
<type>Default</type>
</actionOverrides>
<actionOverrides>
<actionName>Tab</actionName>
<type>Default</type>
</actionOverrides>
<actionOverrides>
<actionName>View</actionName>
<type>Default</type>
</actionOverrides>
<deploymentStatus>InDevelopment</deploymentStatus>
<description>Products</description>
<enableFeeds>false</enableFeeds>
<externalDataSource>OData</externalDataSource>
<externalIndexAvailable>false</externalIndexAvailable>
<externalName>Products</externalName>
<fields>
<fullName>DiscontinuedDate__c</fullName>
<description>DiscontinuedDate</description>
<externalDeveloperName>DiscontinuedDate</externalDeveloperName>
<externalId>false</externalId>
<isFilteringDisabled>false</isFilteringDisabled>
<isNameField>false</isNameField>
<isSortingDisabled>false</isSortingDisabled>
<label>DiscontinuedDate</label>
<required>false</required>
<type>DateTime</type>
</fields>
<fields>
<fullName>ID__c</fullName>
<description>ID</description>
<externalDeveloperName>ID</externalDeveloperName>
<externalId>false</externalId>
<isFilteringDisabled>false</isFilteringDisabled>
<isNameField>false</isNameField>
<isSortingDisabled>false</isSortingDisabled>
<label>ID</label>
<precision>18</precision>
<required>false</required>
<scale>0</scale>
<type>Number</type>
<unique>false</unique>
</fields>
<fields>
<fullName>Name__c</fullName>
<description>Name</description>
<externalDeveloperName>Name</externalDeveloperName>
<externalId>false</externalId>
<isFilteringDisabled>false</isFilteringDisabled>
211
メタデータ型
CustomObject
<isNameField>false</isNameField>
<isSortingDisabled>false</isSortingDisabled>
<label>Name</label>
<length>128</length>
<required>false</required>
<type>Text</type>
<unique>false</unique>
</fields>
<fields>
<fullName>Price__c</fullName>
<description>Price</description>
<externalDeveloperName>Price</externalDeveloperName>
<externalId>false</externalId>
<isFilteringDisabled>false</isFilteringDisabled>
<isNameField>false</isNameField>
<isSortingDisabled>false</isSortingDisabled>
<label>Price</label>
<precision>16</precision>
<required>false</required>
<scale>2</scale>
<type>Number</type>
<unique>false</unique>
</fields>
<fields>
<fullName>Products__c</fullName>
<externalDeveloperName>Products</externalDeveloperName>
<externalId>false</externalId>
<isFilteringDisabled>false</isFilteringDisabled>
<isNameField>false</isNameField>
<isSortingDisabled>false</isSortingDisabled>
<label>Products</label>
<length>20</length>
<referenceTo>Products__x</referenceTo>
<relationshipLabel>Products</relationshipLabel>
<relationshipName>Products</relationshipName>
<type>ExternalLookup</type>
</fields>
<fields>
<fullName>Rating__c</fullName>
<description>Rating</description>
<externalDeveloperName>Rating</externalDeveloperName>
<externalId>false</externalId>
<isFilteringDisabled>false</isFilteringDisabled>
<isNameField>false</isNameField>
<isSortingDisabled>false</isSortingDisabled>
<label>Rating</label>
<precision>18</precision>
<required>false</required>
<scale>0</scale>
<type>Number</type>
<unique>false</unique>
</fields>
<fields>
<fullName>ReleaseDate__c</fullName>
212
メタデータ型
ActionOverride
<description>ReleaseDate</description>
<externalDeveloperName>ReleaseDate</externalDeveloperName>
<externalId>false</externalId>
<isFilteringDisabled>false</isFilteringDisabled>
<isNameField>false</isNameField>
<isSortingDisabled>false</isSortingDisabled>
<label>ReleaseDate</label>
<required>false</required>
<type>DateTime</type>
</fields>
<label>Products</label>
<pluralLabel>Products</pluralLabel>
<searchLayouts>
<customTabListAdditionalFields>ExternalId</customTabListAdditionalFields>
<lookupDialogsAdditionalFields>ExternalId</lookupDialogsAdditionalFields>
<lookupPhoneDialogsAdditionalFields>ExternalId</lookupPhoneDialogsAdditionalFields>
<searchResultsAdditionalFields>ExternalId</searchResultsAdditionalFields>
<searchResultsAdditionalFields>DisplayUrl</searchResultsAdditionalFields>
<searchResultsAdditionalFields>ID__c</searchResultsAdditionalFields>
</searchLayouts>
</CustomObject>
関連トピック:
CustomField
Metadata
Picklist (連動選択リストを含む)
SearchLayouts
Weblink
CustomObjectTranslation
ListView
CompactLayout
ActionOverride
標準オブジェクトまたはカスタムオブジェクトの override アクションを表します。これを使用して、override ア
クションを作成、更新、編集、または削除します。ActionOverride には、これを含む CustomObject にアクセスす
ることによってのみアクセスできます。
宣言的なメタデータファイルのサフィックスおよびディレクトリの場所
override アクションは標準オブジェクトまたはカスタムオブジェクトの一部として定義されます。
213
メタデータ型
ActionOverride
バージョン
override アクションは、API バージョン 18.0 以降で使用できます。Summer ’13 以降では、override アクションを標
準オブジェクトとカスタムオブジェクトの両方に適用できます。以前は、カスタムオブジェクトのみに適用で
きました。
項目
別途記載がない限り、すべての項目は作成可能、除外可能で、null にすることもできます。
項目名
データ型
説明
actionName
string
必須。使用できる値は、上書きできるアクションと同じで
す。
• accept
• clone
• delete
• edit
• list
• new
• tab
• view
comment
string
override に関連付けるすべてのコメント。
content
string
scontrol または visualforce に type が設定されてい
る場合は、この項目を設定します。override として使用する
SコントロールまたはVisualforceページの名前を参照します。
インストールされたコンポーネントを参照するには、
Component_ namespace__Component_name の形式を使
用します。
skipRecordTypeSelect boolean
type
この override アクションによって作成された新しいレコード
をレコードタイプ選択ページに転送されないようにするに
は、この項目を true に設定します。この項目は、
actionName が "create" 種別 (new など) で、type が
visualforce に設定されている場合にのみ有効です。こ
の項目は、API バージョン 21.0 以降で使用できます。
ActionOverrideType(string 型 必須。override アクションの種別を表します。有効な値は、
の列挙)
「ActionOverrideType」 に記述されています。
ActionOverrideType
ActionOverrideType は、使用する override アクションの種別を定義する string 型の列挙です。有効な値は、次のと
おりです。
214
メタデータ型
BusinessProcess
• 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>
</actionOverrides>
</CustomObject>
上記の定義では、retrieve() をコールすると次のコードが表示されます。
<CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">
<actionOverrides>
<actionName>edit</actionName>
<type>default</type>
</actionOverrides>
</CustomObject>
登録者が上述のメタデータを使用してパッケージをインストールした場合、XML を編集することによってその
動作を上書きできます。たとえば、通常の Salesforce の動作が必要な場合は、次のコードを使用します。
<CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">
<actionOverrides>
<actionName>edit</actionName>
<type>standard</type>
</actionOverrides>
</CustomObject>
関連トピック:
CustomObject
BusinessProcess
BusinessProcessメタデータ型によって、ユーザのプロファイルに基づいて異なる選択リスト値を表示できます。
Metadata メタデータ型を拡張し、その fullName 項目を継承します。
複数のビジネスプロセスを使用すると、セールス、サポート、およびリードのライフサイクルを個別に追跡で
きます。セールス、サポート、リード、またはソリューションのプロセスは、レコードタイプに割り当てられ
ます。レコードタイプは、ビジネスプロセスに関連付けられるユーザプロファイルを決定します。詳細は、
Salesforce オンラインヘルプの「複数のビジネスプロセスの管理」を参照してください。
215
メタデータ型
BusinessProcess
宣言的なメタデータファイルのサフィックスおよびディレクトリの場所
ビジネスプロセスは、カスタムオブジェクトまたは標準オブジェクトの定義の一部として定義されます。詳細
は、「CustomObject」を参照してください。
バージョン
BusinessProcess コンポーネントは、API バージョン 17.0 以降で使用できます。
項目
項目
データ型
説明
description
string
ビジネスプロセスの説明。
fullName
string
APIアクセスの一意の識別子として使用される名前。
fullName には、アンダースコアと英数字のみを使
用できます。一意であること、最初は文字であるこ
と、空白は使用しない、最後にアンダースコアを使
用しない、2 つ続けてアンダースコアを使用しない
という制約があります。この項目は、Metadata コン
ポーネントから継承されています。
isActive
boolean
ビジネスプロセスが有効であるか (true)、否か
(false) を示します。
namespacePrefix
string
パッケージが作成された開発組織の名前空間。
values
PicklistValue[]
このビジネスプロセスに関連付けられた選択リスト
値のリスト。
宣言的なメタデータの定義のサンプル
リードビジネスプロセスの 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>
216
メタデータ型
CompactLayout
</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>
関連トピック:
CustomObject
CompactLayout
コンパクトレイアウトに関連付けられたメタデータを表します。Metadataメタデータ型を拡張し、その fullName
項目を継承します。
コンパクトレイアウトは、レコードの重要な項目を一目で確認できるよう表示するために Salesforce1 で使用さ
れます。コンパクトレイアウトは、スペースが限られていて、レコードをすばやく認識することが重要なタッ
チスクリーンモバイルデバイスでレコードを表示するために設計されています。
コンパクトレイアウトでは、次を除くすべての項目種別がサポートされています。
• テキストエリア
• ロングテキストエリア
• リッチテキストエリア
• 複数選択リスト
コンパクトレイアウトについての詳細は、Salesforceヘルプの「コンパクトレイアウトの概要」を参照してくだ
さい。
ファイルのサフィックスおよびディレクトリの場所
コンパクトレイアウトは、カスタムオブジェクトまたは標準オブジェクトの定義の一部として定義されます。
詳細は、「CustomObject」 を参照してください。
バージョン
CompactLayout コンポーネントは、API バージョン 29.0 以降で使用できます。
217
メタデータ型
CompactLayout
項目
項目名
データ型
説明
fields
string
コンパクトレイアウトに割り当てられた項目。項目の順序
は、コンパクトレイアウトを定義するときに項目に付与さ
れる優先度付けを表します。
label
string
Salesforceユーザインターフェース全体でオブジェクトを表
す表示ラベル。
宣言的なメタデータの定義のサンプル
CompactLayout コンポーネントの例を次に示します。
<CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">
<actionOverrides>
<actionName>Accept</actionName>
<type>Default</type>
</actionOverrides>
<actionOverrides>
<actionName>Clone</actionName>
<type>Default</type>
</actionOverrides>
<actionOverrides>
<actionName>Delete</actionName>
<type>Default</type>
</actionOverrides>
<actionOverrides>
<actionName>Edit</actionName>
<type>Default</type>
</actionOverrides>
<actionOverrides>
<actionName>List</actionName>
<type>Default</type>
</actionOverrides>
<actionOverrides>
<actionName>New</actionName>
<type>Default</type>
</actionOverrides>
<actionOverrides>
<actionName>Tab</actionName>
<type>Default</type>
</actionOverrides>
<actionOverrides>
<actionName>View</actionName>
<type>Default</type>
</actionOverrides>
<compactLayouts>
<fullName>testCompactLayout</fullName>
<compactLayoutItems>textfield__c</compactLayoutItems>
<label>testCompactLayoutLabel</label>
218
メタデータ型
CustomField
</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 など)、自動採番項目を
含む、その他の標準項目はサポートされません。
項目を作成または更新するときには必ず完全名を指定する必要があります。たとえば、カスタムオブジェクト
のカスタム項目は次のように表されます。
MyCustomObject__c.MyCustomField__c
219
メタデータ型
CustomField
標準オブジェクトのカスタム項目の例を次に示します。
Account.MyAcctCustomField__c
標準オブジェクトの標準項目の例を次に示します。
Account.Phone
外部オブジェクトのカスタム項目の例を次に示します。
MyExternalObject__x.MyCustomField__c
メモ: メタデータ API では、外部オブジェクトは CustomObject メタデータ型で表されます。
次のカスタム項目種別は、外部オブジェクトでは使用できません。
• 自動採番
• 通貨
• 数式
• Geolocation
• 主従関係
• 選択リスト
• 選択リスト (複数選択)
• テキスト (暗号化)
• テキストエリア (リッチ)
宣言的なメタデータファイルのサフィックスおよびディレクトリの場所
カスタム項目はユーザ定義項目で、カスタムオブジェクトまたは標準オブジェクトの定義の一部です。詳細
は、「CustomObject」を参照してください。標準項目は、標準オブジェクトで事前に定義されています。
メモ: プロジェクトでこのメタデータ型のコンポーネントを取得すると、同じパッケージで取得された
Profile コンポーネントおよび PermissionSet コンポーネントにこのコンポーネントが表示されるようになり
ます。
カスタムオブジェクトまたは標準オブジェクトの項目の取得
カスタムオブジェクトまたは標準オブジェクトを取得するとき、カスタマイズできない標準項目を除き、その
オブジェクトに関連付けられるものすべてが返されます。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>
220
メタデータ型
CustomField
バージョン
カスタム項目および標準項目は API バージョン 10.0 以降で使用できます。
項目
別途記載がない限り、すべての項目は作成可能、除外可能で、null にすることもできます。
項目名
データ型
説明
caseSensitive
boolean
この項目が大文字と小文字を区別するかどうかを示し
ます (区別する場合は true、しない場合は false)。
外部オブジェクトの間接参照関係項目の場合、この属
性は、このカスタム項目の値を
referenceTargetField の値と照合する方法に影響
を与えます。
defaultValue
string
指定されている場合、項目のデフォルト値を表しま
す。
deleteConstraint
DeleteConstraint (string 型の
列挙)
参照関係の削除オプションを提供します。有効な値
は、次のとおりです。
SetNull
これはデフォルトです。参照レコードが削除され
ると、参照項目は消去されます。
Restrict
レコードが参照関係にある場合に、そのレコード
が削除されないように防止します。
Cascade
参照レコードも関連付けられた参照項目も削除し
ます。
参照関係についての詳細は、Salesforceヘルプの「オブ
ジェクトリレーション」を参照してください。
deprecated
boolean
将来の使用のために予約されています。
description
string
項目の説明。
displayFormat
string
表示形式。
externalDeveloperName string
外部オブジェクトでのみ使用できます。Salesforceのこ
のカスタム項目に対応付けられる外部データソースの
テーブル列の名前です。ユーザインターフェースの
[外部列の名前] に対応します。この項目は、API バー
ジョン 32.0 以降で使用できます。
221
メタデータ型
CustomField
項目名
データ型
説明
externalId
boolean
項目が外部 ID 項目であるか (true)、否か (false) を示
します。
formula
string
指定されている場合、項目の数式を表します。
formulaTreatBlankAs
TreatBlanksAs (string 型の列挙) 数式内の空白の処理方法を示します。有効な値は、
BlankAsBlank および BlankAsZero です。
fullName
string
Metadata から継承されるこの項目は、このメタデータ
型の WSDL では定義されません。作成時、更新時、ま
たは削除時に指定する必要があります。コールにおけ
るこの項目の例を確認するには、「create()」を参
照してください。
この値は null にできません。
indexed
boolean
項目がインデックス付けされるかどうかを示します。
この項目が一意である場合、または externalId が
true に設定されている場合、isIndexed 値は true に設
定されます。バージョン 14.0 では、この項目は廃止さ
れ、後方互換性の目的でのみ提供されています。
inlineHelpText
string
項目レベルのヘルプの内容を表します。詳細は、
Salesforceヘルプの「項目レベルのヘルプの定義」を参
照してください。
isFilteringDisabled
boolean
外部オブジェクトでのみ使用できます。検索条件でカ
スタム項目を使用できるかどうかを示します。この項
目は、API バージョン 32.0 以降で使用できます。
isNameField
boolean
テキスト型の外部オブジェクト項目でのみ使用できま
す。外部オブジェクトごとに、名前項目として 1 つの
項目を指定できます。これを true に設定する場合、
externalDeveloperName 属性で識別される外部テー
ブル列に名前値が含まれていることを確認してくださ
い。この項目は、API バージョン 32.0 以降で使用でき
ます。
isSortingDisabled
boolean
外部オブジェクトでのみ使用できます。カスタム項目
が並び替え可能かどうかを示します。この項目は、
API バージョン 32.0 以降で使用できます。
reparentableMasterDetail boolean
カスタムオブジェクトの主従関係の子レコードの親
を、他の親レコードに変更できるかどうかを示しま
す。デフォルト値は、false です。
この項目は API バージョン 25.0 以降で使用できます。
222
メタデータ型
CustomField
項目名
データ型
説明
label
string
項目の表示ラベル。取引先の Industry 項目など、
標準選択リスト項目の表示ラベルを更新することはで
きません。
length
int
項目の長さ。
lookupFilter
LookupFilter
ルックアップ検索条件に関連付けられたメタデータを
表します。ルックアップ検索条件の定義を作成、更
新、または削除するには、このメタデータ型を使用し
ます。
この項目は API バージョン 30.0 以降で使用できます。
maskChar
EncryptedFieldMaskChar (string 暗号化された項目では、マスクとして使用される文字
型の列挙)
を指定します。有効な値は、EncryptedFieldMaskChar に
列挙されています。
暗号化項目についての詳細は、Salesforceヘルプの「暗
号化カスタム項目について」を参照してください。
maskType
EncryptedFieldMaskType (string 暗号化されたテキスト項目の場合、マスクされる文字
型の列挙)
とマスクされない文字の形式を項目で指定します。有
効な値は、EncryptedFieldMaskTypeに列挙されています。
暗号化項目についての詳細は、Salesforceヘルプの「暗
号化カスタム項目について」を参照してください。
picklist
picklist
populateExistingRows boolean
precision
int
referenceTargetField string
指定されている場合、項目は選択リストで、この項目
は選択リスト値および表示ラベルを列挙します。
既存の行が挿入されるか (true)、否か (false) を示し
ます。
数値の精度。精度は、数字の桁数です。たとえば、数
値 256.99 の精度は 5 です。
外部オブジェクトの間接参照関係項目でのみ使用でき
ます。外部データソースから値が発生するこの間接参
照関係項目と照合される、親オブジェクトのカスタム
項目を指定します。指定された親オブジェクトのカス
タム項目では、externalId と unique の両方が
true に設定されている必要があります。この項目
は、API バージョン 32.0 以降で使用できます。
referenceTo
string
指定されている場合、この項目に含まれる別のオブ
ジェクトへの参照を示します。
relationshipLabel
string
リレーションの表示ラベル。
223
メタデータ型
CustomField
項目名
データ型
説明
relationshipName
string
指定されている場合、一対多のリレーションの値を示
します。たとえば、YourObject へのリレーションを持っ
ていた MyObject オブジェクトでは、そのリレーション
名は YourObjects となります。
relationshipOrder
int
この項目はすべての主従関係で有効ですが、連結オブ
ジェクト場合、値はゼロ以外のみです。連結オブジェ
クトには、2 つの主従関係があり、多対多リレーショ
ンにある関連付けテーブルに類似しています。連結オ
ブジェクトは 1 つの親オブジェクトを主オブジェクト
(0) として、他方を第 2 オブジェクト (1) として定義す
る必要があります。主または第 2 の定義は、連結オブ
ジェクトの削除動作およびデザインとレコード所有者
の継承に影響します。詳細は、Salesforceヘルプを参照
してください。
有効な値は 0 または 1 で、0 は常に、連結オブジェク
トではないオブジェクトの値です。
required
boolean
作成時に項目への値の入力が必須であるか (true)、否
か (false) を示します。
scale
int
項目のスケール。スケールは、数字の小数点の右側の
桁数です。たとえば、数値 256.99 のスケールは 2 で
す。
startingNumber
int
指定されている場合、項目の開始番号を示します。
stripMarkup
boolean
マークアップを削除するには true、維持するには
false を設定します。リッチテキストエリアをロン
グテキストエリアに変換するときに使用されます。
summarizedField
string
集計されている詳細行の項目を表します。この項目
は、summaryOperation 値が count でない限り、null
にできません。
summaryFilterItems
FilterItem[]
この項目が集計項目である場合、項目の検索条件の
セットを表します。この項目は、検索条件が一致する
場合、子で集計されます。
summaryForeignKey
string
親と子のリレーションを定義する、子の主従項目を表
します。
summaryOperation
SummaryOperations (string 型 実行される加算演算を表します。有効な値は、
の列挙)
SummaryOperations に列挙されています。
trackFeedHistory
boolean
フィード追跡の項目が有効になっているか (true)、否
か (false) を示します。この項目を true に設定する
224
メタデータ型
項目名
CustomField
データ型
説明
には、関連付けられた CustomObject の enableFeeds
項目も true に設定されている必要があります。詳細
は、Salesforce ヘルプの「Chatter フィード追跡のカスタ
マイズ」を参照してください。
この項目は API バージョン 18.0 以降で使用できます。
trackHistory
boolean
項目の履歴追跡が有効になっているか (true)、否か
(false) を示します。API バージョン 30.0 以降では、標
準オブジェクト項目 (選択リスト項目と参照項目のみ)
でも使用可能になりました。
trackHistory を true に設定するには、関連付け
られた標準オブジェクトまたはカスタムオブジェクト
の enableHistory 項目も true に設定されている必
要があります。
詳細は、Salesforceヘルプの「項目履歴管理」を参照し
てください。
項目履歴管理は、外部オブジェクトでは使用できませ
ん。
trackTrending
boolean
項目の履歴トレンドデータがキャプチャされているか
(true)、否か (false) を示します。少なくとも 1 つの
項目でこの属性が true であると、オブジェクトが履
歴トレンド用に有効化されます。API バージョン 29.0
以降で使用できます。
詳細は、Salesforceヘルプの「履歴変更のレポート」を
参照してください。
trueValueIndexed
boolean
これは、チェックボックス項目にのみ関連します。設
定されている場合、true 値はインデックスに組み込ま
れます。この項目は API バージョン 14.0 で廃止され、
後方互換性の目的でのみ提供されています。
type
FieldType
項目のデータ型を示します。有効な値は、FieldTypeに
列挙されています。
標準オブジェクトの標準項目の場合、type 項目は省
略可能です。選択リストやルックアップなどの一部の
標準項目種別ではこの項目が含まれますが、その他の
種別では含まれません。カスタム項目では type 項目
が含まれます。
unique
boolean
項目が一意であるか (true)、否か (false) を示しま
す。
225
メタデータ型
CustomField
項目名
データ型
説明
visibleLines
int
項目に表示される線の数を示します。
writeRequiresMasterRead boolean
子レコードを作成、編集、または削除するためにマス
タレコードに必要な最低限の共有アクセスレベルを設
定します。この項目は、主従または連結オブジェクト
カスタム項目のデータ型にのみ適用されます。
• true —「参照」アクセス権を持つユーザは、マス
タレコード権限を使用して子レコードを作成、編
集、または削除できます。この設定により、共有
の制限が緩和されます。
• false —「参照・更新」アクセス権を持つユーザ
は、マスタレコード権限を使用して子レコードを
作成、編集、または削除できます。この設定は
true より制限的であり、デフォルト値となって
います。
連結オブジェクトの場合、2 つの親からの最も厳しい
制限のあるアクセス権が適用されます。たとえば、両
方の主従項目に true が設定されているが、ユーザが
1 つのマスタレコードに対して「参照」アクセス権が
あり、他方のマスタレコードに対して「参照・更新」
アクセス権がある場合、ユーザは子レコードを作成、
編集、または削除することはできません。
項目は、追加のデータ型を使用します。詳細は、「メタデータのデータ型」 (ページ259)を参照してください。
EncryptedFieldMaskChar
このデータ型は、maskChar で使用されます。asterisk または X という 2 つの有効な値を持つ文字列です。
暗号化項目についての詳細は、Salesforceオンラインヘルプの「暗号化カスタム項目について」を参照してくだ
さい。
EncryptedFieldMaskType
このデータ型は、maskType で使用されます。有効な値は、次のとおりです。
all
項目内のすべての文字が非表示になります。このオプションは、Salesforce の [すべての文字をマスク] オプ
ションと同等です。
creditCard
最初の 12 桁が非表示になり、最後の 4 桁が表示されます。このオプションは、Salesforce の [クレジットカー
ド番号] オプションと同等です。
226
メタデータ型
CustomField
ssn
最初の 5 桁が非表示になり、最後の 4 桁が表示されます。このオプションは、Salesforce の [社会保障番号]
オプションと同等です。
lastFour
最後の 4 桁を除くすべての文字が非表示になります。このオプションは、Salesforce の [最後の 4 桁を表示]
オプションと同等です。
sin
最後の 4 桁を除くすべての文字が非表示になります。このオプションは、Salesforce の [社会保険番号] オプ
ションと同等です。
nino
すべての文字が非表示になります。項目が 9 桁の場合は、各ペアの文字の後にスペースが自動的に挿入さ
れます。このオプションは、Salesforce の [国民保険番号] オプションと同等です。
暗号化項目についての詳細は、Salesforceオンラインヘルプの「暗号化カスタム項目について」を参照してくだ
さい。
LookupFilter
ルックアップ検索条件に関連付けられたメタデータを表します。API バージョン 30.0 で削除された NamedFilter
コンポーネントにこれが置き換わります。LookupFilter は、API バージョン 30.0 以降で使用できます。
項目
データ型
説明
active
boolean
必須。ルックアップ検索条件が有効かどうかを示しま
す。
booleanFilter
string
高度な検索条件を指定します。高度な検索条件の詳細
は、Salesforceヘルプの「検索条件ロジックを最大限に活
用」を参照してください。
description
string
この検索条件の機能の説明。
errorMessage
string
ルックアップ検索条件が失敗した場合に表示されるエ
ラーメッセージ。
filterItems
FilterItem[]
必須。検索条件のセット。1 つのルックアップ検索条件
につき FilterItem を 10 個まで入れることができます。
infoMessage
string
ページに表示される情報メッセージ。ある項目がルック
アップ検索条件で除外されている理由など、ユーザに
とってわかりにくい内容を説明するために使用します。
isOptional
boolean
必須。ルックアップ検索条件が省略可能かどうかを示し
ます。
ルックアップ検索条件は、追加のデータ型を使用します。詳細は、「メタデータのデータ型」を参照してくだ
さい。
227
メタデータ型
CustomField
FilterItem
一連の検索条件の 1 つのエントリを表します。
項目
データ型
説明
field
string
検索条件に指定された項目を表します。
operation
FilterOperation
この検索条件項目の絞り込み操作を表します。有効な値
(string 型の列挙) は、FilterOperation に列挙されています。
value
string
操作される検索条件項目の値を表します。たとえば、検
索条件が my_number_field__c > 1 である場合、
value の値は 1 です。
valueField
string
検索条件の最終列に項目または項目値が含まれるかを指
定します。
承認プロセスでは、検索条件の valueField エントリ
をサポートしていません。
FilterOperation
これは、さまざまな絞り込み操作をリストする string 型の列挙です。有効な値は、次のとおりです。
• equals
• notEqual
• lessThan
• greaterThan
• lessOrEqual
• greaterOrEqual
• contains
• notContain
• startsWith
• includes
• excludes
SummaryOperations
summaryOperation のデータ型を表します。有効な値は、次のとおりです。
• Count
• Min
• Max
• Sum
228
メタデータ型
CustomField
宣言的なメタデータの定義のサンプル
次の例は、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>
</fields>
....
</CustomObject>
次の Account 標準オブジェクトの 2 つの項目の定義を示します。1 つはカスタム項目
(MyCustomAccountField__c)、もう 1 つは履歴追跡が有効になっている標準項目 (Phone) です。
<?xml version="1.0" encoding="UTF-8"?>
<CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">
<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>
関連トピック:
CustomObject
Picklist (連動選択リストを含む)
Metadata
NamedFilter
229
メタデータ型
FieldSet
FieldSet
項目セットを表します。項目セットとは、項目をグループ化したものです。たとえば、ユーザの名、ミドル
ネーム、姓、肩書を示す項目を 1 つの項目セットにして持つことができます。項目セットは、Visualforceページ
で動的に参照できます。そのページを管理パッケージに追加すれば、システム管理者は項目セット内の項目の
追加、削除、並び替えを行って、コードを変更せずに Visualforce ページ上に表示する項目を変更できます。
バージョン
FieldSet コンポーネントは、API バージョン 21.0 以降で使用できます。
項目
項目
データ型
説明
availableFields
FieldSetItem[]
項目セットのすべての使用可能な項目を含む配列。
description
string
必須。開発者が記載する項目セットに関する説明。
これは必須です。
displayedFields
FieldSetItem[]
Visualforce ページ上に表示されているすべての項目
を含む配列。項目が表示される順序により、ページ
上の表示順序が決まります。
label
string
必須。項目セットの参照に使用する表示ラベル。
FieldSetItem
FieldSetItem は項目セットの個別の項目を表します。
項目
データ型
説明
field
string
必須。標準オブジェクトまたはカスタムオブジェク
トの項目名。
isFieldManaged
boolean
参照のみ。項目が管理パッケージと未管理パッケー
ジのどちらを使用して項目セットに追加されたかを
示します。
isRequired
boolean
参照のみ。項目が必須であるか (true)、否か (false)
を示します。
宣言的なメタデータの定義のサンプル
FieldSet コンポーネントの XML 定義のサンプルを以下に示します。
<?xml version="1.0" encoding="UTF-8"?>
230
メタデータ型
ListView
<CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">
<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>
ListView
ListView では取引先責任者、取引先、またはカスタムオブジェクトなどのレコードの条件設定済みリストを表
示できます。Metadata メタデータ型を拡張し、その fullName 項目を継承します。Salesforce オンラインヘルプ
の「カスタムリストビューの作成」を参照してください。
メモ: 自分にのみ表示する [表示の制限] オプションが設定されているリストビューにはメタデータ API で
はアクセスできません。これらの各リストビューは特定のユーザに関連付けられます。
宣言的なメタデータファイルのサフィックスおよびディレクトリの場所
リストビューは CustomObject コンポーネント内に保存されます。コンポーネントは、取引先などのカスタムオ
ブジェクトまたは標準オブジェクトを表すことができます。
231
メタデータ型
ListView
バージョン
カスタムオブジェクトの ListView コンポーネントは、API バージョン 14.0 以降で使用できます。取引先などの標
準オブジェクトの ListView コンポーネントは、API バージョン 17.0 以降で使用できます。
項目
項目
データ型
説明
booleanFilter
string
この項目は検索条件の詳細オプションを表します。
検索条件の詳細オプションでは、複数の検索条件行
項目に対する AND Boolean 演算子と OR Boolean 演算子
の組み合わせを使用する検索条件を作成できます。
たとえば、(1 AND 2) OR 3 では最初の 2 つの検
索条件行項目または 3 番目の検索条件行項目に一致
するレコードが検索されます。Salesforceオンライン
ヘルプの「検索条件ロジックを最大限に活用」を参
照してください。
columns
string[]
リストビューの項目のリスト。各カスタム項目に
MyCustomField__c などのオブジェクト名を基準
にした項目名が指定されます。
division
string
組織がディビジョンを使用してデータを分類してお
り、「ディビジョンの使用」権限を持っている場合
は、リストビュー内のレコードがこのディビジョン
に一致する必要があります。この項目は、すべての
レコードを検索する場合にのみ利用できます。
この項目はAPIバージョン 17.0 以降で使用できます。
filterScope
FilterScope (string 型の列挙) 必須。この項目は、所有者でレコードを絞り込む
か、すべてのレコードを表示するかを示します。
filters
ListViewFilter[]
検索条件行項目のリスト。
fullName
string
必須。Metadata から継承されるこの項目は、このメ
タデータ型の WSDL では定義されません。作成時、
更新時、または削除時に指定する必要があります。
コールにおけるこの項目の例を確認するには、
「create()」を参照してください。
label
string
必須。リストビューの名前。
language
Language
組織がトランスレーションワークベンチを使用し、
startsWith または contains 演算子を使用して
いる場合、条件検索に使用する言語。検索用語とし
て入力した値は検索条件の言語と同じ言語である必
232
メタデータ型
項目
ListView
データ型
説明
要があります。Salesforceオンラインヘルプの「検索
条件の入力」を参照してください。
有効な言語の値の一覧は、「Translations」を参照し
てください。
この項目はAPIバージョン 17.0 以降で使用できます。
queue
string
キューの名前。キューへのアクセス権を持つユーザ
がオブジェクトを監視および管理できるように、オ
ブジェクトがキューに割り当てられている場合があ
ります。キューを作成すると、対応するリスト
ビューが自動的に作成されます。Salesforceオンライ
ンヘルプの「キューの作成」を参照してください。
sharedTo
SharedTo
リストビューの共有アクセス権。
この項目はAPIバージョン 17.0 以降で使用できます。
ListViewFilter
ListViewFilter は検索条件行項目を表します。
項目
データ型
説明
filter
string
必須。検索条件に指定された項目を表します。
operation
FilterOperation (string 型の列 必須。equals など、検索条件で使用する演算。有
挙)
効な値は、「FilterOperation」 にリストされていま
す。
value
string
操作される検索条件項目の値を表します。たとえ
ば、検索条件が my_number_field__c > 1 であ
る場合、value の値は 1 です。
FilterScope
これは、レコードの検索条件を表す string 型の列挙です。有効な値のリストを下の表に示します。
列挙値
説明
Everything
すべての商談などのすべてのレコード。
Mine
私の商談など、リストビューを実行しているユーザが所有しているレコー
ド。
Queue
キューに割り当てられているレコード。
233
メタデータ型
ListView
列挙値
説明
Delegated
代理 ToDo などアクションを他のユーザが代理で行うレコード。このオプショ
ンは、API バージョン 17.0 以降で使用できます。
MyTerritory
リストビューを参照するユーザのテリトリーのレコード。このオプション
は、組織でテリトリー管理が有効になっている場合に使用できます。このオ
プションは、API バージョン 17.0 以降で使用できます。
MyTeamTerritory
リストビューを参照するユーザのチームのテリトリーのレコード。このオプ
ションは、組織でテリトリー管理が有効になっている場合に使用できます。
このオプションは、API バージョン 17.0 以降で使用できます。
Team
チームに割り当てられているレコード。このオプションは、API バージョン
17.0 以降で使用できます。
宣言的なメタデータの定義のサンプル
カスタムオブジェクトのリストビューの 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>
234
メタデータ型
NamedFilter
. . .
</CustomObject>
関連トピック:
CustomObject
package.xml マニフェストファイルのサンプル
NamedFilter
メモ: このコンポーネントは API バージョン 30.0 で削除されました。それより前の API バージョンでのみ使
用できます。ルックアップ検索条件に関連付けられたメタデータは、CustomField コンポーネントの
lookupFilter 項目によって表されるようになりました。
ルックアップ検索条件に関連付けられたメタデータを表します。ルックアップ検索条件の定義を作成、更新、
または削除するには、このメタデータ型を使用します。Metadata メタデータ型を拡張し、その fullName 項目
を継承します。このメタデータ型は、標準項目のルックアップ検索条件のカスタマイズを行う場合にも使用で
きます。
メモ: namedFilter は、関連付けられたルックアップ項目の対象オブジェクトの子として表示されます。
宣言的なメタデータファイルのサフィックスおよびディレクトリの場所
ルックアップ検索条件は、カスタムオブジェクト定義または標準オブジェクト定義の一部として定義されま
す。詳細は、「CustomObject」を参照してください。
メモ: プロジェクトでこのメタデータ型のコンポーネントを取得すると、同じパッケージで取得された
Profile コンポーネントおよび PermissionSet コンポーネントにこのコンポーネントが表示されるようになり
ます。
バージョン
ルックアップ検索条件は、API バージョン 17.0 以降で使用できます。
項目
別途記載がない限り、すべての項目は作成可能、除外可能で、null にすることもできます。
項目名
データ型
説明
active
boolean
必須。ルックアップ検索条件が有効かどうかを示
します。
booleanFilter
string
高度な検索条件を指定します。高度な検索条件に
ついての詳細は、Salesforceオンラインヘルプの「検
索条件ロジックを最大限に活用」を参照してくだ
さい。
235
メタデータ型
NamedFilter
項目名
データ型
説明
description
string
この検索条件の機能の説明。
errorMessage
string
ルックアップ検索条件が失敗した場合に表示され
るエラーメッセージ。
field
string
必須。ルックアップ検索条件に関連付けられたカ
スタム項目または標準項目の fullName。各ルッ
クアップ検索条件に 1 つのリレーション項目を関
連付けることができます。その逆も可能です。
メモ: ルックアップ検索条件に関連付けられ
た項目の更新はできません。
filterItems
FilterItems[]
必須。検索条件のセット。
infoMessage
string
ページに表示される情報メッセージ。ある項目が
ルックアップ検索条件で除外されている理由など、
ユーザにとってわかりにくい内容を説明するため
に使用します。
fullName
string
Metadataから継承されるこの項目は、このメタデー
タ型の WSDL では定義されません。作成時、更新
時、または削除時に指定する必要があります。コー
ルにおけるこの項目の例を確認するには、
「create()」を参照してください。
この値は null にできません。
isOptional
boolean
必須。ルックアップ検索条件が省略可能かどうか
を示します。
name
string
必須。ルックアップ検索条件の名前。ユーザイン
ターフェースでこの項目を作成する場合、名前は
自動的に割り当てられます。メタデータ APIを使用
してこの項目を作成する場合、name 項目を含める
必要があります。
sourceObject
string
このルックアップ検索条件を使用するルックアッ
プ項目が含まれるオブジェクト。ルックアップ検
索条件がソースオブジェクトの項目を参照する場
合、この項目を設定します。
ルックアップ検索条件は、追加のデータ型を使用します。詳細は、「メタデータのデータ型」を参照してくだ
さい。
236
メタデータ型
NamedFilter
FilterItems
FilterItems には次のプロパティが含まれます。
項目
データ型
説明
field
string
検索条件に指定された項目を表します。
operation
FilterOperation
この検索条件項目の絞り込み操作を表します。有効な値
(string 型の列挙) は、FilterOperation に列挙されています。
value
string
操作される検索条件項目の値を表します。たとえば、検
索条件が my_number_field__c > 1 である場合、
value の値は 1 です。
FilterOperation
これは、さまざまな絞り込み操作をリストする string 型の列挙です。有効な値は、次のとおりです。
• equals
• notEqual
• lessThan
• greaterThan
• lessOrEqual
• greaterOrEqual
• contains
• notContain
• startsWith
• includes
• excludes
宣言的なメタデータの定義のサンプル
<?xml version="1.0" encoding="UTF-8"?>
<CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">
....
<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>
237
メタデータ型
Picklist (連動選択リストを含む)
<operation>notEqual</operation>
<value>y</value>
</filterItems>
<name>Acc</name>
<sourceObject>Account</sourceObject>
</namedfilters>
....
</CustomObject>
関連トピック:
CustomObject
Picklist (連動選択リストを含む)
Metadata
CustomField
Picklist (連動選択リストを含む)
カスタムオブジェクトのカスタム項目、または取引先などの標準オブジェクトのカスタム項目または標準項目
の選択リスト (または連動選択リスト) の定義を表します。
バージョン
カスタムオブジェクトのカスタム項目の選択リストは、API バージョン 12.0 以降で使用できます。取引先など
の標準オブジェクトのカスタム項目または標準項目の選択リストは、APIバージョン 16.0 以降で使用できます。
API バージョン 27.0 以降では、カスタム項目のリリースに必要な場合は、選択リストの値が削除されます。
宣言的なメタデータファイルのサフィックスおよびディレクトリの場所
選択リストの定義は、カスタムオブジェクトと選択リストの定義が関連付けられた項目に含まれます。
項目
選択リストには次の項目が含まれます。
項目名
データ型
説明
controllingField
string
これが連動選択リストである場合、制御項目のfullName。
連動選択リストは、制御選択リストまたはチェックボック
スと連動して動作し、使用可能なオプションに検索条件を
適用します。制御項目で選択した値は、連動項目に使用で
きる値に影響します。この項目は API バージョン 14.0 以降
で使用できます。
picklistValues
PicklistValue[]
必須。選択リストの値のセットを表します。
238
メタデータ型
Picklist (連動選択リストを含む)
項目名
データ型
説明
sorted
boolean
必須。値を並び替えるか (true)、否か (false) を示しま
す。
PicklistValue
このメタデータ型では選択リストの値を定義し、この値がデフォルト値であるかどうかを指定します。Metadata
メタデータ型を拡張し、その fullName 項目を継承します。選択リストの値を使用する場合は、次の点に注
意してください。
• 標準オブジェクトを取得する場合、カスタマイズされた選択リスト値のみでなく、すべての選択リスト値
が取得されます。
• 標準選択リスト項目への変更をリリースする場合、必要に応じて選択リストの値を追加、更新、削除する
ことができます。
• 選択リストの値を無効として設定することはできませんが、選択リストの値が欠落しているときに update()
コールを呼び出すと、欠落している値が無効になります。
項目名
データ型
説明
allowEmail
boolean
この値によりユーザが見積 PDF をメール送信できるか
(true)、否か (false) を示します。この項目は見積の
Status 項目にのみ関連します。この項目は API バージョ
ン 18.0 以降で使用できます。
closed
boolean
この値が完了の状況に関連付けられるか (true)、否か
(false) を示します。この項目はケースおよび ToDo の標準
項目の Status にのみ関連します。この項目は API バー
ジョン 16.0 以降で使用できます。
color
string
レポートおよびダッシュボードのグラフで色が使用されて
いる場合、選択リスト値に割り当てられている色を示しま
す。色は、16 進形式で表記されます (#FF6600 など)。色が指
定されていない場合、グラフ作成時に動的に割り当てられ
ます。この項目はAPIバージョン 17.0 以降で使用できます。
controllingFieldValues
string[]
この選択リスト値にリンクしている制御項目の値のリス
ト。制御項目は、チェックボックスまたは選択リストにす
ることができます。この項目は API バージョン 14.0 以降で
使用できます。リストの値は項目のデータ型によって異な
ります。
• Checkbox: checked または unchecked。
• Picklist: 制御項目の選択リスト値の fullName。
converted
boolean
この値が取引開始済みの状況に関連付けられるか (true)、
否か (false) を示します。この項目はリードの標準項目の
239
メタデータ型
項目名
Picklist (連動選択リストを含む)
データ型
説明
[リード状況] にのみ関連します。詳細は、Salesforce オン
ラインヘルプの「取引の開始」を参照してください。この
項目は、API バージョン 16.0 以降で使用できます。
cssExposed
boolean
この値がセルフサービスポータルで使用可能か (true)、否
か (false) を示します。この項目はケースの標準項目の
[原因] にのみ関連します。
セルフサービスは、顧客にオンラインサポートチャネルを
提供します。これにより、顧客は、カスタマサービス担当
者に連絡しなくても各自の疑問を解消できます。セルフ
サービスについての詳細は、Salesforceオンラインヘルプの
「セルフサービスの設定」を参照してください。
メモ: Spring '12 リリースから、新しい組織ではセルフ
サービスポータルを利用できなくなります。既存の
組織は、引き続きセルフサービスポータルを使用で
きます。
この項目は API バージョン 16.0 以降で使用できます。
default
boolean
必須。この値が指定されている選択リストのデフォルトの
選択リスト値であるか (true)、否か (false) を示します。
description
string
カスタム選択リスト値の説明。この項目は商談の標準項目
の Stage にのみ関連します。カスタマイズされている選
択リスト値に関する説明を記載すると、これを作成した理
由の履歴を追跡できるので便利です。この項目は API バー
ジョン 16.0 以降で使用できます。
forecastCategory
ForecastCategories この値が売上予測分類に関連付けられるか (true)、否か
(string 型の列挙) (false) を示します。この項目は商談の標準項目の Stage
にのみ関連します。以下に示した有効な文字列値を含む、
売上予測分類についての詳細は、Salesforceオンラインヘル
プの「売上予測分類の使用」を参照してください。
• Omitted
• Pipeline
• BestCase
• Forecast
• Closed
この項目は API バージョン 16.0 以降で使用できます。
fullName
string
API アクセスの一意の識別子として使用される名前。
fullName には、アンダースコアと英数字のみを使用でき
ます。一意であること、最初は文字であること、空白は使
240
メタデータ型
項目名
Picklist (連動選択リストを含む)
データ型
説明
用しない、最後にアンダースコアを使用しない、2 つ続け
てアンダースコアを使用しないという制約があります。こ
の項目は、Metadata コンポーネントから継承されていま
す。
highPriority
boolean
この値が優先度が高い項目であるか (true)、否か (false)
を示します。この項目は ToDo の標準項目の Priority に
のみ関連します。ToDo についての詳細は、Salesforceオンラ
インヘルプの「ToDo の使用についての考慮事項」を参照
してください。この項目は、API バージョン 16.0 以降で使
用できます。
probability
int
この値が確度割合であるか (true)、否か (false) を示しま
す。この項目は商談の標準項目の Stage にのみ関連しま
す。商談についての詳細は、Salesforceオンラインヘルプの
「商談の概要」を参照してください。この項目は、APIバー
ジョン 16.0 以降で使用できます。
reverseRole
string
パートナーの相手側から見たロールの名前に対応する選択
リスト値。ロールが「下請け」の場合、相手側から見た
ロールは「元請け」となります。Salesforce でパートナー
ロールを取引先に割り当てると、相手側から見たパート
ナーとの関係が作成され、両方の取引先で他方をパート
ナーとして表示できます。この項目は、パートナーロール
にのみ関連します。
詳細は、Salesforce オンラインヘルプの「パートナーの項
目」を参照してください。
この項目は、API バージョン 18.0 以降で使用できます。
reviewed
boolean
この値がレビュー済み状況に関連付けられるか (true)、否
か (false) を示します。この項目はソリューションの標準
項目の Status にのみ関連します。商談についての詳細
は、Salesforce オンラインヘルプの「ソリューションの作
成」を参照してください。この項目は、APIバージョン 16.0
以降で使用できます。
won
boolean
この値が完了または成立の状況に関連付けられるか
(true)、否か (false) を示します。この項目は商談の標準
項目の Stage にのみ関連します。この項目はAPIバージョ
ン 16.0 以降で使用できます。
241
メタデータ型
Picklist (連動選択リストを含む)
Java のサンプル
次のサンプルでは選択リストを使用します。レコードタイプおよびプロファイルを含む選択リストを使用する
完全なサンプルについては、「Profile」 (ページ 437)を参照してください。
public void setPicklistValues() {
// Create a picklist
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);
try {
AsyncResult[] ars =
metadataConnection.create(new Metadata[] {expenseStatusField});
} catch (ConnectionException ce) {
ce.printStackTrace();
}
}
宣言的なメタデータの定義のサンプル
次のサンプルでは、カスタムオブジェクトの連動選択リストを含む選択リストの使用例を示します。
isAmerican__c チェックボックスでは manufacturer__c 選択リストに表示されるメーカーのリストを制御
します。また、manufacturer__c チェックボックスでは model__c 選択リストに表示されるモデルのリスト
を制御します。
<?xml version="1.0" encoding="UTF-8"?>
<CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">
<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>
242
メタデータ型
Picklist (連動選択リストを含む)
<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>
</picklistValues>
<picklistValues>
<fullName>Honda</fullName>
<controllingFieldValues>unchecked</controllingFieldValues>
<default>false</default>
</picklistValues>
<picklistValues>
<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>
<default>false</default>
</picklistValues>
<picklistValues>
<fullName>Taurus</fullName>
<controllingFieldValues>Ford</controllingFieldValues>
<default>false</default>
</picklistValues>
<picklistValues>
<fullName>PT Cruiser</fullName>
<controllingFieldValues>Chrysler</controllingFieldValues>
<default>false</default>
</picklistValues>
<picklistValues>
<fullName>Pacifica</fullName>
<controllingFieldValues>Chrysler</controllingFieldValues>
<default>false</default>
</picklistValues>
<picklistValues>
<fullName>Accord</fullName>
<controllingFieldValues>Honda</controllingFieldValues>
243
メタデータ型
Picklist (連動選択リストを含む)
<default>false</default>
</picklistValues>
<picklistValues>
<fullName>Civic</fullName>
<controllingFieldValues>Honda</controllingFieldValues>
<default>false</default>
</picklistValues>
<picklistValues>
<fullName>Prius</fullName>
<controllingFieldValues>Toyota</controllingFieldValues>
<default>false</default>
</picklistValues>
<picklistValues>
<fullName>Camry</fullName>
<controllingFieldValues>Toyota</controllingFieldValues>
<default>false</default>
</picklistValues>
<sorted>false</sorted>
</picklist>
<type>Picklist</type>
</fields>
....
</CustomObject>
次のサンプルでは、商談の標準項目の Stage の使用例を示します。
<?xml version="1.0" encoding="UTF-8"?>
<CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">
<fields>
<fullName>StageName</fullName>
<picklist>
<picklistValues>
<fullName>Prospecting</fullName>
<default>false</default>
<forecastCategory>Pipeline</forecastCategory>
<probability>10</probability>
</picklistValues>
<picklistValues>
<fullName>Qualification</fullName>
<default>false</default>
<forecastCategory>Pipeline</forecastCategory>
<probability>10</probability>
</picklistValues>
<picklistValues>
<fullName>Needs Analysis</fullName>
<default>false</default>
<forecastCategory>Pipeline</forecastCategory>
<probability>20</probability>
</picklistValues>
...
</picklist>
</fields>
<CustomObject>
244
メタデータ型
RecordType
RecordType
レコードタイプに関連付けられたメタデータを表します。レコードタイプを使用すると、異なるビジネスプロ
セス、選択リストの値、およびページレイアウトを、さまざまなユーザに提供できます。詳細は、Salesforceオ
ンラインヘルプの「レコードタイプの概要」を参照してください。このメタデータ型は、カスタムオブジェク
トのレコードタイプの定義を作成、更新または削除するために使用します。Metadata メタデータ型を拡張し、
その fullName 項目を継承します。
メモ: プロジェクトでこのメタデータ型のコンポーネントを取得すると、同じパッケージで取得された
Profile コンポーネントおよび PermissionSet コンポーネントにこのコンポーネントが表示されるようになり
ます。
バージョン
レコードタイプは API バージョン 12.0 以降で使用できます。
項目
項目
データ型
説明
active
boolean
必須。レコードタイプが有効かどうかを示しま
す。
businessProcess
string
このレコードタイプに関連付けられたビジネス
プロセスの fullName。リード、商談、ソリュー
ション、およびケースのレコードタイプではこ
の項目は必須項目です。それ以外の場合は使用
できません。「BusinessProcess」 (ページ 215)を参
照してください。
この項目は API バージョン 17.0 以降で使用できま
す。
compactLayoutAssignment string
レコードタイプに割り当てられているコンパク
トレイアウトを表します。
この項目は API バージョン 29.0 以降で使用できま
す。
description
string
レコードタイプの説明。最大 255 文字です。
fullName
string
レコードタイプの名前。fullName には、アン
ダースコアと英数字のみを使用できます。一意
であること、最初は文字であること、空白は使
用しない、最後にアンダースコアを使用しない、
2 つ続けてアンダースコアを使用しないという制
約があります。この項目が、使用できなくなっ
たバージョン 14.0 より前の文字を含んでいた場
245
メタデータ型
項目
RecordType
データ型
説明
合は、それらの文字はこの項目から削除され、
その項目の以前の値は label 項目に保存されて
いました。
この項目はMetadataコンポーネントから継承する
ため、この項目はこのコンポーネントの WSDL で
定義されません。作成時、更新時、または削除
時に指定する必要があります。コールにおける
この項目の例を確認するには、「create()」を
参照してください。
この値は null にできません。
label
string
必須。レコードタイプの説明ラベル。fullName
項目で使用できる文字のリストは、バージョン
14.0 以降削減されています。この項目には、バー
ジョン 14.0 以前の fullName 項目に含まれてい
る値が含まれます。
picklistValues
RecordTypePicklistValue[]
選択リストの値のセットを表します。
RecordTypePicklistValue
RecordTypePicklistValue は、レコードタイプを定義する選択リストおよび有効な値の組み合わせを表します。
項目名
データ型
説明
picklist
string
必須。選択リストの名前。
values
PicklistValue
選択リストの 1 つ以上の選択リストの値。定義されている
各値は、このコンポーネントを含むレコードタイプで使用
できます。
Java のサンプル
次のサンプルでは 2 つのレコードタイプを使用します。プロファイルおよび選択リストを含む完全なサンプル
については、「Profile」 (ページ 437)を参照してください。
public void recordTypeSample() {
try {
// Employees and managers have different access
// to the state of the expense sheet
RecordType edit = new RecordType();
edit.setFullName("ExpenseReport__c.Edit");
edit.setLabel("ExpenseReport__c.Label");
PicklistValue unsubmitted = new PicklistValue();
unsubmitted.setFullName("Unsubmitted");
246
メタデータ型
SearchLayouts
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});
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});
} catch (ConnectionException ce) {
ce.printStackTrace();
}
}
宣言的なメタデータの定義のサンプル
カスタムオブジェクトのレコードタイプの定義を以下に示します。
<CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">
. . .
<recordTypes>
<fullName>My First Recordtype</fullName>
</recordTypes>
. . .
</CustomObject>
SearchLayouts
オブジェクトの検索レイアウトに関連付けられたメタデータを表します。検索結果、検索条件項目、ルック
アップダイアログ、およびタブホームページの最近のレコードリストに表示される項目をカスタマイズできま
す。詳細は、Salesforceオンラインヘルプの「検索レイアウトのカスタマイズ」および「カスタムオブジェクト
用の検索レイアウトのカスタマイズ」を参照してください。
247
メタデータ型
SearchLayouts
バージョン
カスタムオブジェクト用の検索レイアウトは、API バージョン 14.0 以降で使用できます。標準オブジェクト (行
動と ToDo を除く) の検索レイアウトを変更する機能は、API バージョン 27.0 以降で使用できます。
項目
項目
データ型
説明
customTabListAdditionalFields
string[]
オブジェクトに関連付けられたタブの、最近の
オブジェクト名 リストビューに表示される項目
のリスト。name 項目は必須で、常に最初の列
ヘッダーとして表示されるため、このリストに
含まれません。その他のすべての項目は含まれ
ます。各カスタム項目に MyCustomField__c な
どのオブジェクト名を基準にした項目名が指定
されます。
excludedStandardButtons
string[]
検索レイアウトから除外される標準ボタンのリ
スト。
listViewButtons
string[]
オブジェクトのリストビューで使用できるボタ
ンのリスト。
この項目は、Salesforceユーザインターフェースの
オブジェクト詳細ページに表示される [検索レイ
アウト] 関連リストの [オブジェクト名 リスト
ビュー] に含まれる [表示されるボタン] の値に相
当します。詳細は、Salesforceオンラインヘルプの
「ルックアップダイアログ検索」を参照してく
ださい。
lookupDialogsAdditionalFields
string[]
オブジェクトのルックアップダイアログに表示
される項目のリスト。name 項目は必須で、常に
最初の列ヘッダーとして表示されるため、この
リストに含まれません。その他のすべての項目
は含まれます。各カスタム項目に
MyCustomField__c などのオブジェクト名を基
準にした項目名が指定されます。
Salesforceオブジェクトには、多くの場合、リレー
ションで 2 つのレコードを互いに関連付けるルッ
クアップ項目が 1 つ以上含まれます。たとえば、
取引先責任者レコードには、その取引先責任者
とその取引先責任者が関連付けられた組織との
間のリレーションを表す [取引先] ルックアップ
項目があります。ルックアップ検索ダイアログ
248
メタデータ型
項目
SearchLayouts
データ型
説明
を使用すると、編集中のレコードに関連付けら
れたレコードを検索しやすくなります。ルック
アップ検索条件項目を使用すると、オブジェク
ト内のカスタマイズされた項目のリストによっ
てルックアップ検索を絞り込むことができます。
この項目は、アプリケーションユーザインター
フェースのオブジェクト詳細ページに表示され
る [検索レイアウト] 関連リストの [ルックアップ
ダイアログ] に相当します。詳細は、Salesforce オ
ンラインヘルプの「ルックアップダイアログ検
索」を参照してください。
lookupFilterFields
オブジェクトの拡張ルックアップの絞り込みに
使用できる項目のリスト。拡張ルックアップは、
必要に応じてシステム管理者が有効にできます。
各カスタム項目に MyCustomField__c などのオ
ブジェクト名を基準にした項目名が指定されま
す。
string[]
この項目は、アプリケーションユーザインター
フェースのオブジェクト詳細ページに表示され
る [検索レイアウト] 関連リストの [ルックアップ
検索条件項目] に相当します。詳細は、Salesforce
オンラインヘルプの「ルックアップダイアログ
検索」を参照してください。
lookupPhoneDialogsAdditionalFields string[]
オブジェクトのルックアップダイアログに表示
される電話関連項目のリスト。name 項目は必須
で、常に最初の列ヘッダーとして表示されるた
め、このリストに含まれません。その他のすべ
ての項目は含まれます。各カスタム項目に
MyCustomField__c などのオブジェクト名を基
準にした項目名が指定されます。
このリストにより、項目をソフトフォンダイア
ルパッドと統合できます。詳細は、Salesforceオン
ラインヘルプの「CTI 1.0 および 2.0 ソフトフォン
について」を参照してください。
この項目は、アプリケーションユーザインター
フェースのオブジェクト詳細ページに表示され
る [検索レイアウト] 関連リストの [ルックアップ
電話ダイアログ] に相当します。
249
メタデータ型
SearchLayouts
項目
データ型
説明
searchFilterFields
string[]
オブジェクトの検索の絞り込みに使用できる項
目のリスト。各カスタム項目に
MyCustomField__c などのオブジェクト名を基
準にした項目名が指定されます。
この項目は、アプリケーションユーザインター
フェースのオブジェクト詳細ページに表示され
る [検索レイアウト] 関連リストの [検索条件項
目] に相当します。
searchResultsAdditionalFields
string[]
オブジェクトの検索結果に表示される項目のリ
スト。name 項目は必須で、常に最初の列ヘッ
ダーとして表示されるため、このリストに含ま
れません。その他のすべての項目は含まれます。
各カスタム項目に MyCustomField__c などのオ
ブジェクト名を基準にした項目名が指定されま
す。
この項目は、アプリケーションユーザインター
フェースのオブジェクト詳細ページに表示され
る [検索レイアウト] 関連リストの [検索結果] に
相当します。
searchResultsCustomButtons
string[]
オブジェクトの検索結果で使用できるカスタム
ボタンのリスト。ボタンに関連付けられたアク
ションは、検索結果で返される任意のレコード
に適用できます。
宣言的なメタデータの定義のサンプル
オブジェクトの検索レイアウトの定義のサンプルを以下に示します。
<?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>
250
メタデータ型
SharingReason
. . .
</CustomObject>
関連トピック:
CustomObject
SharingReason
カスタムオブジェクトに共有が実装された理由を示すために使用される Apex の共有の理由を表します。Apex
による共有管理により、開発者はApexを使用して、プログラムでカスタムオブジェクトを共有できます。Apex
による共有管理を使用してカスタムオブジェクトを共有した場合は、「すべてのデータの編集」権限を持つ
ユーザのみが、カスタムオブジェクトのレコードの共有を追加または変更できます。共有アクセス権は、レ
コード所有者が変わっても維持されます。詳細は、Salesforceオンラインヘルプの「共有設定の概要」を参照し
てください。
SharingReasonを使用して、カスタムオブジェクトの共有の理由定義を作成、更新、または削除できます。Metadata
メタデータ型を拡張し、その fullName 項目を継承します。
バージョン
共有の理由は、API バージョン 14.0 以降で使用できます。
項目
項目
データ型
説明
fullName
string
必須。共有の理由の名前。__c サフィックスが、カスタム
共有の理由に追加されます。
Metadata から継承されるこの項目は、このメタデータ型の
WSDL では定義されません。作成時、更新時、または削除
時に指定する必要があります。コールにおけるこの項目の
例を確認するには、「create()」を参照してください。
label
string
必須。共有の理由を説明する表示ラベル。最大 40 文字で
す。
宣言的なメタデータの定義のサンプル
カスタムオブジェクトの共有の理由の定義を次に示します。
<CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">
. . .
<sharingReasons>
<fullName>recruiter__c</fullName>
<label>Recruiter</label>
251
メタデータ型
SharingRecalculation
</sharingReasons>
. . .
</CustomObject>
SharingRecalculation
特定のカスタムオブジェクトの Apex による共有管理を再適用する Apex クラスを表します。詳細は、Salesforce
オンラインヘルプの「Apex による共有管理の再適用」を参照してください。
バージョン
共有の再適用は、API バージョン 14.0 以降で使用できます。
項目
項目
データ型
説明
className
string
必須。カスタムオブジェクトのApex共有を再適用するApex
クラス。このクラスは、Database.Batchable インター
フェースを実装している必要があります。
宣言的なメタデータの定義のサンプル
カスタムオブジェクトでの共有の再適用の定義を次に示します。
<CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">
. . .
<sharingRecalculations>
<className>RecruiterRecalculation</className>
</sharingRecalculations>
. . .
</CustomObject>
ValidationRule
入力規則を表します。入力規則は、ユーザがレコードに入力したデータが有効で保存可能かどうかを確認する
ために使用されます。入力規則には、1 つ以上の項目のデータを評価する数式が含まれ、true または false
の値を返します。入力規則には、無効なデータによりルールが true の値を返すときに、クライアントアプリ
ケーションがユーザに表示できるエラーメッセージも含まれます。Metadata メタデータ型を拡張し、その
fullName 項目を継承します。
API バージョン 20.0 の時点で、入力規則には複合項目を設定できません。複合項目の例には、住所、姓名、連
動選択リスト、連動ルックアップがあります。
252
メタデータ型
ValidationRule
バージョン
入力規則は、API バージョン 12.0 以降で使用できます。
項目
項目名
データ型
説明
active
boolean
必須。この入力規則が有効であるか (true)、否か (false)
を示します。
description
string
入力規則の説明。
errorConditionFormula
string
必須。入力規則数式ページに記載された入力規則数式。
Salesforce オンラインヘルプの「入力規則の定義」を参照し
てください。
errorDisplayField
string
アプリケーション内の項目の完全に指定された名前。この
項目に値を入力すると、errorMessage の値が指定した項
目の横に表示されます。値を指定しない場合、ページ上部
にエラーメッセージが表示されます。
errorMessage
string
必須。入力規則が失敗した場合に表示されるメッセージ。
メッセージは 255 文字以下にする必要があります。
fullName
string
有効性のために空白と特殊文字がエスケープされた、入力
規則の内部名。名前には、英数字、およびアンダースコア
(_) 文字のみを使用できます。また、最初は文字とし、最後
にアンダースコアを使用したり、連続した 2 つのアンダー
スコア文字を含めたりすることはできません。
この項目はMetadata コンポーネントから継承するため、こ
の項目はこのコンポーネントの WSDL で定義されません。
作成時、更新時、または削除時に指定する必要がありま
す。コールにおけるこの項目の例を確認するには、
「create()」を参照してください。
宣言的なメタデータの定義のサンプル
カスタムオブジェクトの入力規則の XML 定義のサンプルを以下に示します。
<?xml version="1.0" encoding="UTF-8"?>
<CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">
<deploymentStatus>Deployed</deploymentStatus>
<fields>
<fullName>Mommy_Cat__c</fullName>
<label>Mommy Cat</label>
<referenceTo>Cat__c</referenceTo>
<relationshipName>Cats</relationshipName>
253
メタデータ型
Weblink
<type>Lookup</type>
</fields>
<label>Cat</label>
<nameField>
<label>Cat Name</label>
<type>Text</type>
</nameField>
<pluralLabel>Cats</pluralLabel>
<sharingModel>ReadWrite</sharingModel>
<validationRules>
<fullName>CatsRule</fullName>
<active>true</active>
<errorConditionFormula>OR(Name = &apos;Milo&apos;,Name =
&apos;Moop&apos;)</errorConditionFormula>
<validationMessage>Name must be that of one of my cats</validationMessage>
</validationRules>
</CustomObject>
Weblink
カスタムオブジェクトに定義された Web リンクを表します。Metadata メタデータ型を拡張し、その fullName
項目を継承します。
バージョン
Web リンクは、API バージョン 12.0 以降で使用できます。
項目
Web リンクの定義には次の項目が含まれます。
項目名
データ型
説明
availability
WebLinkAvailability (string 型の 必須。Web リンクをオンラインでのみ使用できるか
列挙)
(online)、オフラインでも使用できるか (offline) を示し
ます。
description
string
displayType
WebLinkDisplayType (string 型 この Web リンクの表示方法を表します。
の列挙)
有効な値は次のとおりです。
Web リンクの説明。
• ハイパーリンクの link。
• ボタンの button。
• 関連リストに添付されるボタンの massAction。
encodingKey
Encoding (string 型の列挙)
必須。デフォルトの文字コード設定は Unicode (UTF-8) で
す。リンクの対象が異なる形式のデータを必要とする場合
254
メタデータ型
項目名
Weblink
データ型
説明
は、デフォルトの文字コード設定を変更します。この指定
は、内容のソースが 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)」
fullName
string
有効性のために空白と特殊文字がエスケープされた Web リ
ンクの名前。名前には、英数字、およびアンダースコア (_)
文字のみを使用できます。また、最初は文字とし、最後に
アンダースコアを使用したり、連続した 2 つのアンダース
コア文字を含めたりすることはできません。
この項目はMetadata コンポーネントから継承するため、こ
の項目はこのコンポーネントの WSDL で定義されません。
作成時、更新時、または削除時に指定する必要があります。
コールにおけるこの項目の例を確認するには、
「create()」を参照してください。
hasMenubar
boolean
openType が newWindow である場合、ウィンドウにブラ
ウザメニューを表示するか (true)、否か (false) を示しま
す。そうでない場合、この項目は指定しないでください。
hasScrollbars
boolean
openType が newWindow である場合、ウィンドウにスク
ロールバーを表示するか (true)、否か (false) を示します。
そうでない場合、この項目は指定しないでください。
hasToolbar
boolean
openType が newWindow である場合、ウィンドウにブラ
ウザツールバーを表示するか (true)、否か (false) を示し
ます。そうでない場合、この項目は指定しないでください。
height
int
Web リンクによって開かれたウィンドウの高さ (ピクセル単
位)。openType が newWindow である場合は必須です。そ
うでない場合は、指定できません。
255
メタデータ型
Weblink
項目名
データ型
説明
isResizable
boolean
openType が newWindow である場合、ウィンドウのサイ
ズを変更できるか (true)、否か (false) を示します。そう
でない場合、この項目は指定しないでください。
linkType
WebLinkType (string 型の列挙) 必須。この Web リンクのコンテンツが URL、Sコントロー
ル、JavaScript コードブロック、または Visualforce ページに
よって指定されているかどうかを表します。
有効な値は次のとおりです。
• url
• sControl
• javascript
• page
• flow — 今後の使用のために予約されています。
masterLabel
string
Web リンクのマスタラベル。
openType
WebLinkWindowType (string 型 必須。このボタンがクリックされたときのコンテンツの表
の列挙)
示に使用されるウィンドウのスタイルを指定します。
有効な値は次のとおりです。
• newWindow
• sidebar
• noSidebar
• replace
• onClickJavaScript
page
string
linkType の値が page である場合、この項目は Visualforce
ページを表します。そうでない場合、この項目は指定しな
いでください。
position
WebLinkPosition (string 型の列 openType が newWindow である場合、新規ウィンドウの
挙)
表示方法を示します。そうでない場合、この項目は指定し
ないでください。
有効な値は次のとおりです。
• fullScreen
• none
• topLeft
protected
boolean
必須。この下位コンポーネントが保護されるか (true)、否
か (false) を示します。保護される下位コンポーネントは、
インストールする組織で作成されたコンポーネントまたは
下位コンポーネントによってリンク設定したり参照したり
することはできません。
256
メタデータ型
項目名
Weblink
データ型
requireRowSelection boolean
説明
openType が massAction である場合、このボタンのアク
ションを実行するために個々の行を選択する必要があるか
(true)、否か (false) を示します。そうでない場合、この
項目は指定しないでください。
scontrol
string
linkType の値が sControl である場合、この項目は Sコ
ントロールの名前を表します。そうでない場合、この項目
は指定しないでください。
showsLocation
boolean
openType が newWindow である場合、ウィンドウにブラ
ウザのロケーションバーを表示するか否かを示します。そ
うでない場合、この項目は指定しないでください。
showsStatus
boolean
openType が newWindow である場合、ウィンドウにブラ
ウザのステータスバーを表示するか否かを示します。そう
でない場合、この項目は指定しないでください。
url
string
linkType が url である場合、これは URL 値です。
linkType の値が javascript である場合、これは JavaScript
コンテンツです。値がこのいずれでもない場合、この項目
は指定しないでください。
コンテンツは、XML 解析ルールと同じ方法でエスケープす
る必要があります。
width
int
Web リンクによって開かれたウィンドウの幅 (ピクセル単
位)。
openType が newWindow である場合は必須です。そうで
ない場合は、指定できません。
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__c
weblink.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);
257
メタデータ型
Weblink
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」の「宣言的なメタ
データの定義のサンプル」を参照してください。
<?xml version="1.0" encoding="UTF-8"?>
<CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">
....
<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>
<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>
関連トピック:
HomePageComponent
HomePageLayout
CustomPageWebLink
258
メタデータ型
メタデータのデータ型
メタデータのデータ型
これらのデータ型は、『SOAP API 開発者ガイド』で説明されているデータ型を拡張します。
データ型
オブジェクト
項目に含まれる内容
CustomField
カスタムオブ
ジェクト
カスタム項目を表します。
カスタム項目
DeleteConstraint
カスタム項目
参照関係の削除オプションを表す文字列。有効な値は、次のとおりです。
• SetNull
• Restrict
• Cascade
DeploymentStatus カスタムオブ
ジェクト
カスタム項目
カスタムオブジェクトまたはカスタム項目のリリース状況を表す文字列。
有効な値は、次のとおりです。
• InDevelopment
• Deployed
FieldType
カスタム項目
カスタム項目の型を示します。有効な値は、次のとおりです。
• AutoNumber
• Lookup
• MasterDetail
• Checkbox
• Currency
• Date
• DateTime
• Email
• EncryptedText
1
• Number
• Percent
• Phone
• Picklist
• MultiselectPicklist
• Summary
• Text
• TextArea
• LongTextArea
• Summary
• Url
• Hierarchy
259
メタデータ型
データ型
メタデータのデータ型
オブジェクト
項目に含まれる内容
• File
• CustomDataType
• Html
• Geolocation
1
Number カスタム項目は内部的には double 型の項目として表されます。
Number 項目のスケールを 0 に設定すると int と同様に動作する double を使
用できます。
Gender
カスタムオブ
ジェクト
オブジェクトを表す名詞の性別を示します。これは、語の性別に基づいて、
異なる処理が必要となる言語に使用されます。有効な値は、次のとおりで
す。
• Masculine
• Feminine
• Neuter
• AnimateMasculine (スラブ言語 — 現在はチェコ語、ポーランド語、ロ
シア語、スロバキア語、スロベニア語、およびウクライナ語)
メモ: 次の性別は [設定] > [カスタマイズ] > [タブ名と表示ラベル] > [タ
ブと表示ラベルの名称変更]に表示されますが、内部的には「Feminine」
として保存されます。メタデータ API で以下を設定する場合は、
「Feminine」を使用します。
• Euter (スウェーデン語)
• Common (オランダ語)
Picklist (連動選
択リストを含
む)
カスタム項目
選択リストから選択できる表示ラベルおよび値のセットである選択リスト
を表す。
SharingModel
カスタムオブ
ジェクト
カスタムオブジェクトの共有モデルを表します。オブジェクトに応じて、
有効な値は次のようになります。
• Private
• Read
• ReadWrite
• ReadWriteTransfer
• FullAccess
• ControlledByParent
たとえば、ユーザオブジェクトは、値 Private および Read をサポートし
ます。取引先責任者、商談、およびカスタムオブジェクトは、値 Private、
Read、および ReadWrite をサポートします。
260
メタデータ型
CustomObjectTranslation
データ型
オブジェクト
項目に含まれる内容
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 以降で使用できます。
項目
項目
データ型
説明
caseValues
ObjectNameCaseValue[]
冠詞、複数形、所有格、大文字/小文字に関するカ
スタムオブジェクトのさまざまな組み合わせ。
261
メタデータ型
CustomObjectTranslation
項目
データ型
説明
fields
CustomFieldTranslation[]
カスタムオブジェクトに関連付けられたカスタム項
目の翻訳のリスト。
fullName
string
customObjectName-lang という形式のカスタムオ
ブジェクトの名前と翻訳言語。customObjectName
はカスタムオブジェクト名で、lang は翻訳言語で
す。
Metadata から継承されるこの項目は、このメタデー
タ型の WSDL では定義されません。作成時、更新時、
または削除時に指定する必要があります。コールに
おけるこの項目の例を確認するには、「create()」
を参照してください。
gender
Gender
オブジェクトを表す名詞の性別を示します。これ
は、語の性別に基づいて、異なる処理が必要となる
言語に使用されます。
layouts
LayoutTranslation[]
ページレイアウトの翻訳のリスト。
nameFieldLabel
string
名前項目の表示ラベル。最大 765 文字です。
namedFilters
NamedFilterTranslation[]
カスタムオブジェクトに関連付けられたルックアッ
プ検索条件のエラーメッセージの翻訳のリスト。
この項目は API バージョン 30.0 で削除されました。
それより前のバージョンでのみ使用できます。ルッ
クアップ検索条件に関連付けられた翻訳メタデータ
は、CustomFieldTranslation サブタイプの
lookupFilter 項目によって表されるようになり
ました。
quickActions
QuickActionTranslation[]
アクションの翻訳のリスト。
recordTypes
RecordTypeTranslation[]
レコードタイプの翻訳のリスト。
sharingReasons
SharingReasonTranslation[]
共有の理由の翻訳のリスト。
startsWith
StartsWith (string 型の列挙)
名詞が母音、子音、または特殊文字で開始されてい
るかを示します。これは、語の最初の文字に基づい
て、異なる処理が必要となる言語に使用されます。
validationRules
ValidationRuleTranslation[]
入力規則の翻訳のリスト。
webLinks
WebLinkTranslation[]
Web リンクの翻訳のリスト。
workflowTasks
WorkflowTaskTranslation[]
ワークフロー ToDo の翻訳のリスト。
262
メタデータ型
CustomObjectTranslation
CustomFieldTranslation
CustomFieldTranslation には、カスタム項目の翻訳の詳細が含まれます。詳細は、「CustomField」を参照してくだ
さい。
メモ: すべての言語で、CustomFieldTranslation の項目に使用可能なすべての値がサポートされているわけで
はありません。言語固有のサポートされる値については、「CustomObjectTranslation の言語サポート — 完全
サポート対象言語」および「CustomObjectTranslation の言語サポート — エンドユーザ言語」の付録を参照し
てください。
項目
データ型
説明
caseValues
ObjectNameCaseValue[]
冠詞、複数形、所有格、大文字/小文字に関するカ
スタムオブジェクトのさまざまな組み合わせ。API
バージョン 29.0 以降で利用できます。
description
string
カスタム項目の説明の翻訳。
gender
Gender
オブジェクトを表す名詞の性別を示します。これ
は、語の性別に基づいて、異なる処理が必要となる
言語に使用されます。API バージョン 29.0 以降で利
用できます。
help
string
この項目の項目レベルのヘルプでフロート表示テキ
ストとして表示されるテキストの翻訳。
label
string
表示ラベルの翻訳。最大 765 文字です。
lookupFilter
LookupFilterTranslation
ルックアップ検索条件に関連付けられた翻訳メタ
データを表します。
この項目はAPIバージョン 30.0 以降で使用できます。
name
string
必須。MyField__c などの、カスタムオブジェクト
に関連する項目の名前。
picklistValues
PicklistValueTranslation[]
選択リスト値の翻訳のリスト。「PicklistValue」を参
照してください。
relationshipLabel
string
参照関係の表示ラベルの翻訳。参照関係により、項
目を別の項目に関連付けることができます。リレー
ション項目により、ユーザは他の項目によって定義
された値のリストからオプションを選択できます。
最大 765 文字です。
startsWith
StartsWith (string 型の列挙)
名詞が母音、子音、または特殊文字で開始されてい
るかを示します。これは、語の最初の文字に基づい
て、異なる処理が必要となる言語に使用されます。
API バージョン 29.0 以降で利用できます。
263
メタデータ型
CustomObjectTranslation
LayoutTranslation
LayoutTranslation には、ページレイアウトの翻訳の詳細が含まれます。詳細は、「項目」を参照してください。
項目
データ型
説明
layout
string
必須。レイアウト名。
layoutType
string
sections
LayoutSectionTranslation[]
レイアウトセクションの翻訳の配列。
LayoutSectionTranslation
LayoutSectionTranslation には、ページレイアウトセクションの翻訳の詳細が含まれます。詳細は、「LayoutSection」
を参照してください。
項目
データ型
説明
label
string
必須。表示ラベルの翻訳。最大 765 文字です。
section
string
必須。セクション名。
LookupFilterTranslation
LookupFilterTranslation は、カスタムオブジェクトに関連付けられたルックアップ検索条件のエラーメッセージの
翻訳を表示します。NamedFilterTranslation にこれが置き換わります。
LookupFilterTranslation は、API バージョン 30.0 以降で使用できます。
項目
データ型
説明
errorMessage
string
ルックアップ検索条件が失敗した場合に表示される
エラーメッセージ。
informationalMessage
string
ページに表示される情報メッセージ。ある項目が
ルックアップ検索条件で除外されている理由など、
ユーザにとってわかりにくい内容を説明するために
使用します。
NamedFilterTranslation
NamedFilterTranslation は API バージョン 30.0 で削除されました。それより前の API バージョンでのみ使用できま
す。
NamedFilterTranslation は、カスタムオブジェクトに関連付けられるルックアップ検索条件エラーメッセージの翻
訳のリストを示します。詳細は、「NamedFilter」を参照してください。
264
メタデータ型
CustomObjectTranslation
項目
データ型
説明
errorMessage
string
ルックアップ検索条件が失敗した場合に表示される
エラーメッセージ。
informationalMessage
string
ページに表示される情報メッセージ。ある項目が
ルックアップ検索条件で除外されている理由など、
ユーザにとってわかりにくい内容を説明するために
使用します。
name
string
必須。ルックアップ検索条件の名前。ユーザイン
ターフェースでこの項目を作成する場合、名前は自
動的に割り当てられます。メタデータ API を使用し
てこの項目を作成する場合、name 項目を含める必
要があります。
ObjectNameCaseValue
ObjectNameCaseValue は、さまざまな文法的なコンテキストで使用できるように、カスタムオブジェクト名の複
数の格と定義をサポートします。
メモ: すべての言語で、ObjectNameCaseValue の項目に使用可能なすべての値がサポートされているわけで
はありません。言語固有のサポートされる値については、「CustomObjectTranslation の言語サポート — 完全
サポート対象言語」および「CustomObjectTranslation の言語サポート — エンドユーザ言語」の付録を参照し
てください。
項目
データ型
説明
article
Article (string 型の列挙)
英語には、定冠詞 (the) と不定冠詞 (a、an) の 2 種類
の冠詞があります。これらの冠詞の使用は、主に、
グループの任意のメンバーを参照しているか、グ
ループの特定のメンバーを参照しているかによって
異なります。有効な値は、次のとおりです。
• Definite
• Indefinite
• None
caseType
CaseType (string 型の列挙)
カスタムオブジェクト名の格。有効な値は、次のと
おりです。
• Ablative
• Accusative
• Adessive
• Allative
• Causalfinal
• Dative
265
メタデータ型
項目
CustomObjectTranslation
データ型
説明
• Delative
• Distributive
• Elative
• Essive
• Essiveformal
• Genitive
• Illative
• Inessive
• Instrumental
• Lative
• Locative
• Nominative
• Objective
• Partitive
• Prepositional
• Subjective
• Sublative
• Superessive
• Termanative
• Translative
• Vocative
plural
boolean
value 項目が複数であるか (true)、単数であるか
(false) を示します。
possessive
Possessive (string 型の列挙)
言語の所有格は、所有の関係を示すために使用され
る文法上の格です。有効な値は、次のとおりです。
• First
• None
• Second
value
string
必須。この文法的なコンテキストでの値または表示
ラベル。
PicklistValueTranslation
PicklistValueTranslation には、選択リスト値の翻訳の詳細が含まれます。詳細は、「Picklist (連動選択リストを含
む)」を参照してください。
266
メタデータ型
CustomObjectTranslation
項目
データ型
説明
masterLabel
string
必須。アプリケーションの設定ページに定義された
選択リスト値は、マスタラベルになります。マスタ
ラベルは、翻訳された表示ラベルが使用できないす
べての場所に表示されます。
translation
string
必須。値の翻訳。
QuickActionTranslation
QuickActionTranslation には、ユーザインターフェースのアクションの表示ラベルの詳細が含まれています。詳細
は、「QuickAction」を参照してください。
項目
データ型
説明
label
string
必須。表示ラベルの翻訳。最大 765 文字です。
name
string
必須。クイックアクション名。
RecordTypeTranslation
RecordTypeTranslation には、レコードタイプ名の翻訳の詳細が含まれます。詳細は、「RecordType」を参照してく
ださい。
項目
データ型
説明
label
string
必須。表示ラベルの翻訳。最大 765 文字です。
name
string
必須。レコードタイプ名。
SharingReasonTranslation
SharingReasonTranslation には、共有の理由の翻訳の詳細が含まれます。詳細は、「SharingReason」を参照してくだ
さい。
項目
データ型
説明
label
string
必須。共有の理由の翻訳。
name
string
必須。共有の理由名。
ValidationRuleTranslation
ValidationRuleTranslation には、入力規則の翻訳の詳細が含まれます。詳細は、「ValidationRule」を参照してくださ
い。
267
メタデータ型
CustomObjectTranslation
項目
データ型
説明
errorMessage
string
必須。入力規則の失敗に関連付けられたエラーメッ
セージの翻訳。
name
string
必須。入力規則名。
WebLinkTranslation
WebLinkTranslation には、Web リンクの翻訳の詳細が含まれます。詳細は、「Weblink」を参照してください。
項目
データ型
説明
label
string
必須。Web リンク表示ラベルの翻訳。最大 765 文字
です。
name
string
必須。Web リンク名。
WorkflowTaskTranslation
WorkflowTaskTranslation には、ワークフロー ToDo の翻訳の詳細が含まれます。詳細は、「Workflow」を参照して
ください。
項目
データ型
説明
description
string
ワークフロー ToDo の説明の翻訳。
name
string
必須。ワークフロー ToDo 名。
subject
string
ワークフロー ToDo の件名の翻訳。
宣言的なメタデータの定義のサンプル
次のサンプルはドイツ語の 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>
</caseValues>
268
メタデータ型
CustomObjectTranslation
<caseValues>
<caseType>Accusative</caseType>
<plural>false</plural>
<value>Beschreibung</value>
</caseValues>
<caseValues>
<caseType>Accusative</caseType>
<plural>true</plural>
<value>Beschreibungen</value>
</caseValues>
<caseValues>
<caseType>Genitive</caseType>
<plural>false</plural>
<value>Beschreibung</value>
</caseValues>
<caseValues>
<caseType>Genitive</caseType>
<plural>true</plural>
<value>Beschreibungen</value>
</caseValues>
<caseValues>
<caseType>Dative</caseType>
<plural>false</plural>
<value>Beschreibung</value>
</caseValues>
<caseValues>
<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>
</caseValues>
<caseValues>
<caseType>Nominative</caseType>
<plural>true</plural>
<value>Kunden</value>
269
メタデータ型
CustomObjectTranslation
</caseValues>
<caseValues>
<caseType>Accusative</caseType>
<plural>false</plural>
<value>Kunden</value>
</caseValues>
<caseValues>
<caseType>Accusative</caseType>
<plural>true</plural>
<value>Kunden</value>
</caseValues>
<caseValues>
<caseType>Genitive</caseType>
<plural>false</plural>
<value>Kunden</value>
</caseValues>
<caseValues>
<caseType>Genitive</caseType>
<plural>true</plural>
<value>Kunden</value>
</caseValues>
<caseValues>
<caseType>Dative</caseType>
<plural>false</plural>
<value>Kunden</value>
</caseValues>
<caseValues>
<caseType>Dative</caseType>
<plural>true</plural>
<value>Kunden</value>
</caseValues>
<fields>
<caseValues>
<caseType>Nominative</caseType>
<plural>false</plural>
<value>Kundennummer</value>
</caseValues>
<caseValues>
<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>
270
メタデータ型
CustomPageWebLink
<gender>Masculine</gender>
</CustomObjectTranslation>
関連トピック:
CustomObject
Translations
CustomPageWebLink
ホームページコンポーネントに定義された Web リンクを表します。Metadata メタデータ型を拡張し、その
fullName 項目を継承します。その他のすべての Web リンクは、CustomObject に Weblink として保存されます。
宣言的なメタデータファイルのサフィックスおよびディレクトリの
場所
1 つの Web リンクの定義あたり 1 つのファイルがあり、対応するパッケージディレクトリの weblinks フォル
ダに保存されます。ファイルのサフィックスは、.weblink です。
バージョン
CustomPageWebLink は、API バージョン 13.0 以降で使用できます。
項目
CustomPageWebLink の定義には、次の項目があります。
項目名
データ型
説明
availability
WebLinkAvailability (string 型の 必須。Web リンクをオンラインでのみ使用できるか
列挙)
(online)、オフラインでも使用できるか (offline) を示し
ます。
description
string
displayType
WebLinkDisplayType (string 型 この Web リンクの表示方法を表します。
の列挙)
有効な値は次のとおりです。
Web リンクの説明。
• ハイパーリンクの link。
• ボタンの button。
• 関連リストに添付されるボタンの massAction。
encodingKey
Encoding (string 型の列挙)
必須。デフォルトの文字コード設定は Unicode (UTF-8) で
す。リンクの対象が異なる形式のデータを必要とする場合
271
メタデータ型
項目名
CustomPageWebLink
データ型
説明
は、デフォルトの文字コード設定を変更します。この指定
は、内容のソースが 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)」
fullName
string
API アクセスの一意の識別子として使用される名前。
fullName には、アンダースコアと英数字のみを使用でき
ます。一意であること、最初は文字であること、空白は使
用しない、最後にアンダースコアを使用しない、2 つ続け
てアンダースコアを使用しないという制約があります。
hasMenubar
boolean
openType が newWindow である場合、ウィンドウにブラ
ウザメニューを表示するか (true)、否か (false) を示しま
す。そうでない場合、この項目は指定しないでください。
hasScrollbars
boolean
openType が newWindow である場合、ウィンドウにスク
ロールバーを表示するか (true)、否か (false) を示します。
そうでない場合、この項目は指定しないでください。
hasToolbar
boolean
openType が newWindow である場合、ウィンドウにブラ
ウザツールバーを表示するか (true)、否か (false) を示し
ます。そうでない場合、この項目は指定しないでください。
height
int
Web リンクによって開かれたウィンドウの高さ (ピクセル単
位)。openType が newWindow である場合は必須です。そ
うでない場合は、指定できません。
isResizable
boolean
openType が newWindow である場合、ウィンドウのサイ
ズを変更できるか (true)、否か (false) を示します。そう
でない場合、この項目は指定しないでください。
272
メタデータ型
CustomPageWebLink
項目名
データ型
説明
linkType
WebLinkType (string 型の列挙) 必須。この Web リンクのコンテンツが URL、Sコントロー
ル、JavaScript コードブロック、または Visualforce ページに
よって指定されているかどうかを表します。
有効な値は次のとおりです。
• url
• sControl
• javascript
• page
• flow — 今後の使用のために予約されています。
Web リンクのマスタラベル。
masterLabel
string
openType
WebLinkWindowType (string 型 必須。このボタンがクリックされたときのコンテンツの表
の列挙)
示に使用されるウィンドウのスタイルを指定します。
有効な値は次のとおりです。
• newWindow
• sidebar
• noSidebar
• replace
• onClickJavaScript
page
string
linkType の値が page である場合、この項目は Visualforce
ページを表します。そうでない場合、この項目は指定しな
いでください。
position
WebLinkPosition (string 型の列 openType が newWindow である場合、新規ウィンドウの
挙)
表示方法を示します。そうでない場合、この項目は指定し
ないでください。
有効な値は次のとおりです。
• fullScreen
• none
• topLeft
boolean
必須。このコンポーネントが保護されるか (true)、否か
(false) を示します。保護コンポーネントは、インストー
ルする組織で作成されたコンポーネントによってリンク設
定したり参照したりすることはできません。
requireRowSelection boolean
openType が massAction である場合、このボタンのアク
protected
ションを実行するために個々の行を選択する必要があるか
(true)、否か (false) を示します。そうでない場合、この
項目は指定しないでください。
273
メタデータ型
CustomPageWebLink
項目名
データ型
説明
scontrol
string
linkType の値が sControl である場合、この項目は Sコ
ントロールの名前を表します。そうでない場合、この項目
は指定しないでください。
showsLocation
boolean
openType が newWindow である場合、ウィンドウにブラ
ウザのロケーションバーを表示するか否かを示します。そ
うでない場合、この項目は指定しないでください。
showsStatus
boolean
openType が newWindow である場合、ウィンドウにブラ
ウザのステータスバーを表示するか否かを示します。そう
でない場合、この項目は指定しないでください。
url
string
linkType が url である場合、これは URL 値です。
linkType の値が javascript である場合、これは JavaScript
コンテンツです。値がこのいずれでもない場合、この項目
は指定しないでください。
コンテンツは、XML 解析ルールと同じ方法でエスケープす
る必要があります。
width
int
Web リンクによって開かれたウィンドウの幅 (ピクセル単
位)。
openType が newWindow である場合は必須です。そうで
ない場合は、指定できません。
宣言的なメタデータの定義のサンプル
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>
274
メタデータ型
CustomPermission
<showsStatus>false</showsStatus>
<url>http://google.com</url>
</CustomPageWebLink>
関連トピック:
HomePageComponent
HomePageLayout
Weblink
CustomPermission
カスタム機能へのアクセス権限を付与する権限を表します。Metadata メタデータ型を拡張し、その fullName
項目を継承します。
ファイルのサフィックスおよびディレクトリの場所
CustomPermission コンポーネントのサフィックスは .customPermission であり、customPermissions フォ
ルダに保存されます。
バージョン
CustomPermission コンポーネントは、API バージョン 31.0 以降で使用できます。
項目
項目名
データ型
説明
connectedApp
string
この権限に関連付けられた接続ア
プリケーションの名前。最大 80 文
字です。
description
string
カスタム権限の説明。最大 255 文字
です。
label
string
必須。カスタム権限の表示ラベル。
最大 80 文字です。
requiredPermission
CustomPermissionDependencyRequired[] 親カスタム権限に必要なカスタム
権限を示します。この項目は、API
バージョン 32.0 以降で使用できま
す。
275
メタデータ型
CustomPermission
CustomPermissionDependencyRequired
CustomPermissionDependencyRequired は、カスタム権限が親カスタム権限に必要かどうかを決定します。親が有効
な場合、必要なカスタム権限は有効である必要があります。
項目名
データ型
説明
customPermission
string
必須。カスタム権限名。
dependency
boolean
必須。このカスタム権限が親カスタム権限に必要か(true)、
否か (false) を示します。
宣言的なメタデータの定義のサンプル
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 Acme accounts.</description>
<label>Acme Account Full Access</label>
<requiredPermission>
<customPermission>Acme_Account_Read</customPermission>
<dependency>true</dependency>
</requiredPermission>
</CustomPermission>
次の package.xml の例では、以前の定義と、接続アプリケーションに関連付けられている他のカスタム権限
を参照します。
<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<types>
<members>Acme</members>
<name>ConnectedApp</name>
</types>
<types>
<members>Acme_Account_Email_Read</members>
<members>Acme_Account_Phone_Edit</members>
<members>Acme_Account_Full_Access</members>
<members>Acme_Account_Read</members>
<name>CustomPermission</name>
</types>
<types>
<members>Acme_Account_Email_Read</members>
<members>Acme_Account_Phone_Edit</members>
<members>Acme_Account_Full_Access</members>
<members>Acme_Account_Read</members>
<name>PermissionSet</name>
</types>
<version>32.0</version>
</Package>
276
メタデータ型
CustomSite
CustomSite
Force.com サイトを表します。Force.com サイトでは、公開 Web サイトとアプリケーションを作成できます。そ
れらはSalesforce組織と直接統合されるため、ユーザがログインする場合にユーザ名やパスワードは必要ありま
せん。詳細は、Salesforce オンラインヘルプの「Force.com サイトの概要」を参照してください。
メモ: CustomSite は、現在、シンジケーションフィードをサポートしていません。
Metadata メタデータ型を拡張し、その fullName 項目を継承します。
宣言的なメタデータファイルのサフィックスおよびディレクトリの
場所
Force.com CustomSite コンポーネントは、対応するパッケージディレクトリの sites ディレクトリに保存されま
す。ファイル名はサイト名に一致し、拡張子は .site です。
バージョン
Force.com CustomSite コンポーネントは、API バージョン 14.0 以降で使用できます。
項目
項目
データ型
説明
active
boolean
必須。サイトが有効かどうかを決定しま
す。
allowHomePage
boolean
標準ホームページが一般ユーザに表示され
るかどうかを決定します。これは、APIバー
ジョン 15.0 の新項目です。
allowStandardAnswersPages
boolean
標準回答ページが一般ユーザに表示される
かどうかを決定します。これは、API バー
ジョン 19.0 の新項目です。
allowStandardIdeasPages
boolean
標準のアイデアページが一般ユーザに表示
されるかどうかを決定します。これは、API
バージョン 15.0 の新項目です。
allowStandardLookups
boolean
標準ルックアップページが一般ユーザに表
示されるかどうかを決定します。これは、
API バージョン 15.0 の新項目です。
allowStandardSearch
boolean
標準検索ページが一般ユーザに表示される
かどうかを決定します。これは、API バー
ジョン 15.0 の新項目です。
277
メタデータ型
CustomSite
項目
データ型
説明
analyticsTrackingCode
string
サイトに関連付けられている追跡コード。
このコードは、サイトに対するページリク
エストデータを追跡するために、Google
Analytics などのサービスで使用されます。こ
の項目は API バージョン 17.0 以降で使用でき
ます。
authorizationRequiredPage
string
ゲストユーザが許可されていないページに
アクセスしようとすると表示される
Visualforce ページの名前。
bandwidthExceededPage
string
サイトがその割り当て帯域幅を超えると表
示される Visualforce ページの名前。
changePasswordPage
string
ポータルまたは Chatter アンサーのいずれか
のパスワードをポータルユーザが変更しよ
うとすると表示される Visualforce ページの名
前 (有効になっている場合)。
chatterAnswersForgotPasswordConfirmPage string
仮パスワードを記載したメールが送信され
たことをユーザに知らせるために表示され
る Visualforce ページの名前。この項目は、組
織で Chatter アンサーが有効になっている場
合に使用できます。この項目はAPIバージョ
ン 27.0 以降で使用できます。
chatterAnswersForgotPasswordPage string
ユーザがリンクをクリックして忘れたパス
ワードを取得する場合に表示される
Visualforce ページの名前。この項目は、組織
で Chatter アンサーが有効になっている場合
に使用できます。この項目は API バージョ
ン 27.0 以降で使用できます。
chatterAnswersHelpPage
string
ユーザがヘルプリンクをクリックすると表
示される Visualforce ページの名前。この項目
は、組織で Chatter アンサーが有効になって
いる場合に使用できます。この項目は API
バージョン 27.0 以降で使用できます。
chatterAnswersLoginPage
string
ユーザがポータルにログインできるように
するために表示される Visualforce ページの名
前。この項目は、組織で Chatter アンサーが
有効になっている場合に使用できます。こ
の項目は API バージョン 27.0 以降で使用でき
ます。
278
メタデータ型
CustomSite
項目
データ型
説明
chatterAnswersRegistrationPage
string
ユーザを登録してポータルにアクセスでき
るようにするために表示される Visualforce
ページの名前。この項目は API バージョン
27.0 以降で使用できます。
clickjackProtectionLevel
SiteClickjackProtectionLevel 必須。クリックジャック保護レベルを設定
(string 型の列挙)
します。選択肢は次のとおりです。
• AllowAllFraming — すべてのページで
フレーム化を許可 (保護なし)
• SameOriginOnly — 公開元が同じペー
ジのみでフレーム化を許可 (推奨)
• NoFraming — すべてのページでフレー
ム化を許可しない (最大保護)
この項目は API バージョン 30.0 以降で使用で
きます。
customWebAddresses
SiteWebAddress[]
サイトに関連付けられたルートカスタム
URL。CustomSite を保存またはリリースする
と、サイト内のすべてのルートカスタム URL
がこのリストのルートカスタム URL に置き
換えられます。ルート以外のパスプレ
フィックスを使用するカスタム URL はこの
リストには含まれず、CustomSite を保存また
はリリースしても影響を受けません。この
項目は API バージョン 21.0 以降で使用できま
す。
description
string
サイトの説明。
favoriteIcon
string
サイトにアクセスしているときに、ブラウ
ザのアドレス項目に表示されるアイコンに
使用されるファイルの名前。サイト全体の
お気に入りアイコンを設定します。
fileNotFoundPage
string
ゲストユーザが存在しないページにアクセ
スしようとすると表示される Visualforce ペー
ジの名前。
genericErrorPage
string
エラー時に、他に指定されていない場合に
表示される Visualforce ページの名前。
guestProfile
string
参照のみ。ゲストユーザに関連付けられた
プロファイルの名前。
279
メタデータ型
CustomSite
項目
データ型
説明
inMaintenancePage
string
サイトがメンテナンスのためにダウンして
いる場合に表示される Visualforce ページの名
前。
inactiveIndexPage
string
無効なサイトのホームページとして設定さ
れている Visualforce ページの名前。
indexPage
string
必須。有効なサイトのホームページとして
設定されている Visualforce ページの名前。
masterLabel
string
Salesforce ユーザインターフェースでのサイ
トの表示ラベル名。
portal
string
ログインアクセス用にこのサイトに関連付
けられたポータルの名前。
requireHttps
boolean
サイトがセキュアな接続を必要とするか
(true)、否か (false) を決定します。false の場
合、サイトは通常、セキュアな接続にリダ
イレクトされずに、セキュアではない接続
を介して動作します。
requireInsecurePortalAccess
boolean
必須。組織のセキュリティ設定を上書き
し、サイトから関連付けられたポータルに
ログインする場合に HTTP を排他的に使用す
るかどうかを決定します。
robotsTxtPage
string
Web クローラで使用される robots.txt
ファイルに表示される Visualforce ページの名
前。
serverIsDown
string
Salesforceサーバのダウン時にキャッシュサー
バから表示される静的リソースの名前。静
的リソースは、1 MB 以下の公開 zip ファイル
で、zip ファイルのルートレベルに
maintenance.html という名前のページ
が含まれている必要があります。画像や CSS
ファイルなどの、zip ファイル内のその他の
リソースは、ディレクトリ構造上の制限は
ありません。この項目は API バージョン 17.0
以降で使用できます。
siteRedirectMappings
SiteRedirectMapping[]
サイトに設定されているすべての URL リダ
イレクトルールの配列。この項目はAPIバー
ジョン 20.0 以降で使用できます。
siteAdmin
string
サイト管理者のユーザ名。
280
メタデータ型
CustomSite
項目
データ型
説明
siteTemplate
string
サイトテンプレートとして使用される
Visualforce ページの名前。
siteType
siteType
サイトが Visualforce であるか (Force.com サイ
ト)、Site.comサイトであるかを特定します。
組織で Salesforce Communities が有効になって
いる場合は、ChatterNetwork (Force.com サイト)
または ChatterNetworkPicasso (Site.com) サイト
となる場合もあります。
これは、API バージョン 27.0 の新項目です。
subdomain
string
必須。参照のみ。サイトのカスタムサブド
メインプレフィックス。たとえば、サイト
URL が mycompany.force.com/partners
である場合、mycompany.force.com がサ
ブドメインです。
urlPathPrefix
string
サイトを他のサイトと区別する、サイトの
URL 上のパスの最初の部分。たとえば、サ
イト URL が
mycompany.force.com/partners である
場合、partners が urlPathPrefix です。
SiteRedirectMapping
SiteRedirectMapping は、Force.com サイトの URL リダイレクトルールを表します。詳細は、Salesforce オンラインヘ
ルプの「Force.com サイトの URL リダイレクト」を参照してください。
項目
データ型
説明
action
SiteRedirect (string 型の列挙)
リダイレクトの種別。使用可能な
string 値は次のとおりです。
• Permanent
• Temporary
isActive
boolean
リダイレクトの状況 (有効または無
効)。
source
string
リダイレクトする URL。相対 URL で
ある必要がありますが、.html や
.php など、任意の有効な種類の拡
張子にできます。
281
メタデータ型
CustomSite
項目
データ型
説明
target
string
ユーザのアクセス先とする新しい
URL。相対 URL または http:// や
https:// プレフィックスを含む
完全修飾 URL にすることができま
す。
SiteWebAddress
Force.com サイトの Web アドレスを表します。
項目
データ型
説明
certificate
string
この項目はメタデータ APIバージョ
ン32.0では表示されますが、機能し
ないため、空白のままにする必要
があります。
domainName
string
Web サイトのドメイン。
www.acme.com 形式で指定します。
primary
boolean
これはプライマリドメインである
か (true)、否かを示します。false
の場合は、プライマリドメインで
はありません。
宣言的なメタデータの定義のサンプル
サイトの 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>
282
メタデータ型
CustomTab
<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 フォルダに保存されます。
メモ: プロジェクトでこのメタデータ型のコンポーネントを取得すると、同じパッケージで取得された
Profile コンポーネントおよび PermissionSet コンポーネントにこのコンポーネントが表示されるようになり
ます。
バージョン
タブは、API バージョン 10.0 以降で使用できます。
283
メタデータ型
CustomTab
項目
このメタデータ型には、次の項目が含まれます。
項目名
データ型
説明
customObject
boolean
このタブがカスタムオブジェクトを表示するか (true)、否
か (false) を示します。true に設定されている場合、タ
ブの名前はカスタムオブジェクトの名前と一致します。
次の項目のいずれか 1 つのみに値が設定されている必要が
あります。
• customObject
• flexiPage
• page
• scontrol
• url
description
string
タブの説明テキスト (省略可能)。
flexiPage
string
このタブに表示する フレキシブルページの名前。
次の項目のいずれか 1 つのみに値が設定されている必要が
あります。
• customObject
• flexiPage
• page
• scontrol
• url
frameHeight
int
タブフレームの高さ (ピクセル単位)。Sコントロールおよ
びページタブでは必須です。
fullName
string
タブの名前。この項目の値は、タブの種類と API バージョ
ンに応じて異なります。
• カスタムオブジェクトタブの場合、fullName は開発
者が割り当てたカスタムオブジェクトの名前です (たと
えば、MyCustomObject__c など)。カスタムオブジェクト
タブの場合、この名前はカスタムオブジェクト名と同
じである必要があり、customObject は true に設定
されている必要があります。
• Web タブの場合、fullName は開発者が割り当てたタ
ブの名前です (たとえば、MyWebTab など)。
fullName には、アンダースコアと英数字のみを使用でき
ます。一意であること、最初は文字であること、空白は使
用しない、最後にアンダースコアを使用しない、2 つ続け
284
メタデータ型
項目名
CustomTab
データ型
説明
てアンダースコアを使用しないという制約があります。こ
の項目は、Metadata コンポーネントから継承されていま
す。
hasSidebar
boolean
タブにサイドバーパネルが表示されるかを示します。
icon
string
タブがどの標準タブスタイルも使用していない場合におけ
る、タブの画像ドキュメントへの参照 (省略可能)。これ
は、API バージョン 14.0 の新項目です。
label
string
タブの表示ラベルです (Web タブのみ)。
mobileReady
boolean
必須。カスタムタブが Mobile Edition で使用できるか (true)、
否か (false) を示します。
motif
string
必須。カスタムタブの配色とアイコンのタブスタイル。た
とえば、"'Custom70: Handsaw," は、のこぎりアイコンです。
page
string
このタブに表示する Visualforce ページの名前。
次の項目のいずれか 1 つのみに値が設定されている必要が
あります。
• customObject
• flexiPage
• page
• scontrol
• url
scontrol
string
このタブに表示する Sコントロールの名前。
次の項目のいずれか 1 つのみに値が設定されている必要が
あります。
• customObject
• flexiPage
• page
• scontrol
• url
splashPageLink
string
ユーザがタブをクリックしたときに内容を紹介するスプ
ラッシュページとして使用されるカスタムリンク。
HomePageComponent を参照します。
url
string
このタブに埋め込む外部 Web ページの URL。
次の項目のいずれか 1 つのみに値が設定されている必要が
あります。
• customObject
285
メタデータ型
項目名
Dashboard
データ型
説明
• flexiPage
• page
• scontrol
• url
urlEncodingKey
Encoding (string 型 デフォルトの文字コード設定は Unicode (UTF-8) です。情報
の列挙)
を渡す URL が別形式のデータを必要とする場合は、この設
定を変更します。このオプションは、タブの種類で値 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 です。
286
メタデータ型
Dashboard
ダッシュボードの取得
package.xml ではダッシュボードにワイルドカード (*) 記号を使用できません。 明示的な名前を package.xml
に入力するためにダッシュボードのリストを取得するには、listMetadata() をコールし、DashboardFolder
をデータ型として渡します。DashboardFolder は describeMetadata() ではデータ型として返されません。
ダッシュボードは、inFolder の関連付けられている属性が true に設定された describeMetadata() から返
されます。 この属性が true に設定されている場合は、DashboardFolder など、「Folder」という単語を含むコン
ポーネント名を使用してデータ型を作成できます。
次の例では、package.xml 内のフォルダを示します。
<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<types>
<members>MyDBFolder/MyDBName</members>
<name>Dashboard</name>
</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>
</types>
<version>32.0</version>
</Package>
バージョン
Dashboard コンポーネントは、API バージョン 14.0 以降で使用できます。
項目
項目
データ型
説明
backgroundEndColor
string
必須。ダッシュボードでは、グラフにグラデーショ
ンの色の変化を適用できます。この項目は、グラ
デーションの 2 つ目の色を定義し、
backgroundStartColor は、最初の色を定義しま
す。背景で単色を使用する場合、またはグラデー
ションの色の変化を使用しない場合は、この項目と
backgroundStartColor に同じ色を選択してくだ
287
メタデータ型
項目
Dashboard
データ型
説明
さい。色は、16 進形式で表記されます (#FF6600 な
ど)。
必須。backgroundStartColor 項目と
backgroundEndColor 項目で定義される、グラデー
ションの色の変化の方向。有効な値は、次のとおり
です。
backgroundFadeDirection ChartBackgroundDirection
(string 型の列挙)
• diagonal
• leftToRight
• topToBottom
backgroundStartColor
string
必須。ダッシュボードのグラフでのグラデーション
の色の変化の開始色。詳細は、
「backgroundEndColor」を参照してください。
色は、16 進形式で表記されます (#FF6600 など)。
dashboardFilters
DashboardFilters[]
ダッシュボードの検索条件のリスト。
この項目はAPIバージョン 23.0 以降で使用できます。
dashboardType
DashboardType (string 型の列 ダッシュボードの表示設定を設定する方法を決定し
挙)
ます。有効な値は、次のとおりです。
• SpecifiedUser — すべてのユーザは、個々の
セキュリティ設定に関係なく、runningUser 項
目に指定された、1 人の特定の実行ユーザのアク
セスレベルでデータを表示します。
• LoggedInUser — 各ログインユーザは、個々の
アクセスレベルに従ってデータを表示します。
• MyTeamUser — マネージャは、ロール階層にお
けるその部下の視点でダッシュボードを参照す
るように選択できます。この値は、APIバージョ
ン 20.0 以降で使用できます。
この項目はAPIバージョン 19.0 以降で使用できます。
description
string
ダッシュボードの説明。最大 255 文字です。
fullName
string
Metadata から継承されるこの項目は、このメタデー
タ型の WSDL では定義されません。作成時、更新時、
または削除時に指定する必要があります。コールに
おけるこの項目の例を確認するには、「create()」
を参照してください。
この項目は、フォルダとダッシュボードのタイトル
を指定します。たとえば、
folderSales/California です。
288
メタデータ型
Dashboard
項目
データ型
説明
leftSection
DashboardComponentSection 必須。ダッシュボードの左セクションまたは列。
middleSection
DashboardComponentSection ダッシュボードの中央セクションまたは列。
rightSection
DashboardComponentSection 必須。ダッシュボードの右セクションまたは列。
runningUser
string
ダッシュボードに表示されるデータを決定するため
に使用されるロールと共有設定を所有するユーザの
ユーザ名。
ダッシュボードをリリースするときに、この項目の
値が定義されていないか有効なユーザに対応してい
ない場合、項目にはリリースを実行するユーザの
ユーザ名が入力されます。
ダッシュボードは常に特定のユーザのセキュリティ
設定を使用して実行されるため、各ユーザのセキュ
リティ設定に関係なく、ダッシュボードを参照する
すべてのユーザにまったく同一のデータが表示され
ます。
ヒント: 機密データの不適切な開示を避ける
には、適切なユーザにのみ表示されるフォル
ダにダッシュボードを保存します。
textColor
string
必須。ダッシュボードの各グラフのテキストの色。
色は、16 進形式で表記されます (#FF6600 など)。
title
string
必須。ダッシュボードのタイトル。
titleColor
string
必須。各サッシュボードコンポーネントのタイトル
の色。色は、16 進形式で表記されます (#FF6600 な
ど)。
titleSize
int
必須。タイトルテキストの文字のサイズ。たとえ
ば、12 という値は 12pt のテキストを示します。
DashboardComponentSection
DashboardComponentSection は、ダッシュボードの 1 つのセクションまたは列を表します。
項目
データ型
説明
columnSize
DashboardComponentSize
(string 型の列挙)
必須。ダッシュボードの列のサイズ。有効な値につ
いての詳細は、「DashboardComponentSize」を参照し
てください。
289
メタデータ型
Dashboard
項目
データ型
説明
components
DashboardComponent[]
ダッシュボード列の DashboardComponent オブジェク
トのリスト。
DashboardComponentSize
DashboardComponentSize は、異なるサイズカテゴリをリストする string 型の列挙です。有効な値のリストを下の
表に示します。
列挙値
説明
medium
中サイズのコンポーネント。
narrow
最小サイズのコンポーネント。
wide
最大サイズのコンポーネント。
DashboardComponent
データを表示する異なるコンポーネントまたは要素のグループで構成されるダッシュボード。各コンポーネン
トは、経営指標または重要業績評価指標 (KPI) を表示するためのデータソースとして、カスタムレポートまたは
カスタム Sコントロールを使用できます。複数のダッシュボードコンポーネントを作成し、最大 3 列のダッシュ
ボード 1 つにすべてを表示できます。
項目
データ型
説明
chartAxisRange
ChartRangeType (string 型の列挙)
棒グラフまたは折れ線グラフの手動または自
動設定の軸範囲。有効な値は、次のとおりで
す。
• auto
• manual
chartAxisRangeMax
double
表示する最大軸範囲。これは、
chartAxisRange 項目について manual の軸
範囲が選択された棒グラフと折れ線グラフに
のみ適用されます。
chartAxisRangeMin
double
表示する最小軸範囲。これは、
chartAxisRange 項目について manual の軸
範囲が選択された棒グラフと折れ線グラフに
のみ適用されます。
290
メタデータ型
Dashboard
項目
データ型
説明
chartSummary
ChartSummary
グラフデータの集計項目を指定します。
isAutoSelectFromReport が false に設定
されている場合は必須です。
この項目は API バージョン 25.0 以降で使用でき
ます。
componentType
DashboardComponentType (string 型 必須。ダッシュボードコンポーネントの種類。
の列挙)
有効な値は、次のとおりです。
• 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[]
ダッシュボードの検索条件列のリスト。各レ
ポートベースのコンポーネントには、検索条
件が適用される列を定義するダッシュボード
検索条件列が必要です。
291
メタデータ型
項目
Dashboard
データ型
説明
この項目は API バージョン 23.0 以降で使用でき
ます。
dashboardTableColumn
DashboardTableColumn[]
カスタマイズされたダッシュボードテーブル
コンポーネントの列のリストを表します。
displayUnits
ChartUnits (string 型の列挙)
グラフの単位。有効な値は、次のとおりです。
• Auto
• Integer
• Hundreds
• Thousands
• Millions
• Billions
• Trillions
drillDownUrl
string
グラフで、ユーザがダッシュボードコンポー
ネントをクリックしたときに移動先となる URL
を指定します。このオプションを使用して、
別のダッシュボード、レポート、レコード詳
細ページ、または Web インターフェースを使
用するその他のシステムにユーザを送信しま
す。この項目は、drillEnabled 項目と
drillToDetailEnabled 項目より優先されま
す。
drillEnabled
boolean
ユーザがダッシュボードコンポーネントをク
リックしたときに、完全なソースレポートま
たは絞り込まれたソースレポートにユーザを
移動するかどうかを指定します。完全なソー
スレポートにドリルするには false を設定
し、ユーザがクリックした項目によって絞り
込まれたソースレポートにドリルするには
true を設定します。true に設定すると、ユー
ザは、個々のグループ、軸の値、または凡例
のエントリをクリックできます。
これは、drillToDetailEnabled 項目より優
先されます。この項目は API バージョン 17.0 以
降で使用できます。
drillToDetailEnabled
boolean
有効である場合、ユーザがテーブルまたはグ
ラフのレコード名、レコード所有者、または
フィード投稿をクリックすると、レコード詳
細ページに移動します。true に設定すると、
292
メタデータ型
項目
Dashboard
データ型
説明
ユーザは軸、凡例値、グラフ要素、およびテー
ブルエントリをクリックできます。
drillDownUrl 項目と drillEnabled 項目は、
この項目より優先されます。この項目は API
バージョン 20.0 以降で使用できます。
enableHover
boolean
グラフにマウスを重ねたとき、値、表示ラベ
ル、およびパーセントを表示するかどうかを
指定します。詳細のフロート表示はグラフの
種類によって異なります。パーセントは、円
グラフ、ドーナツグラフ、およびじょうごグ
ラフのみに適用されます。この項目はAPIバー
ジョン 17.0 以降で使用できます。
expandOthers
boolean
合計の 3% 以下のグループをすべて 1 つの「そ
の他」系列または区分グループにまとめるか
どうかを指定します。円グラフ、ドーナツグ
ラフ、およびじょうごグラフのみに適用され
ます。グラフにすべての値を個別に表示する
場合は true を設定し、小さなグループを「そ
の他」にまとめるには false に設定します。
この項目は API バージョン 17.0 以降で使用でき
ます。
footer
string
ダッシュボードコンポーネントの下部に表示
されるフッター。最大 255 文字です。
gaugeMax
double
ゲージの最大値。ゲージは、ゴール達成まで
の距離を表示するために使用されます。自動
車の速度計のようなものです。
gaugeMin
double
ゲージの最小値。
groupingColumn
string
データのグループ化の基準となる項目を指定
します。このデータは、縦棒グラフの場合は
X 軸に、横棒グラフの場合は Y 軸に表示されま
す。
この項目は API バージョン 25.0 以降で使用でき
ます。
header
string
ダッシュボードコンポーネントの上部に表示
されるヘッダー。最大 80 文字です。
indicatorBreakpoint1
double
ダッシュボードの indicatorMiddleColor と
indicatorLowColor を区切る値。
293
メタデータ型
Dashboard
項目
データ型
説明
indicatorBreakpoint2
double
ダッシュボードの indicatorHighColor と
indicatorMiddleColor を区切る値。
indicatorHighColor
string
ゲージで高い数値の範囲を表す色。
indicatorLowColor
string
ゲージで低い数値の範囲を表す色。
indicatorMiddleColor
string
ゲージで中位の数値の範囲を表す色。
legendPosition
ChartLegendPosition (string 型の列 グラフに対する凡例の位置。有効な値は、次
挙)
のとおりです。
• Bottom
• OnChart
• Right
maxValuesDisplayed
int
横棒グラフでの横軸、縦棒グラフでの縦軸、
または積み上げ棒グラフでの選択した軸の上
位グループに含める要素の最大数。たとえば、
上位 5 名の営業担当者のみを表示する場合は、
所有者別の合計商談額を表す商談レポートを
作成し、この項目に「5」と入力します。
metricLabel
string
指標を説明した表示ラベル metric が
componentType 項目の値である場合に関連し
ます。
page
string
コンポーネントに関連付けられたVisualforceペー
ジ。
pageHeightInPixels
int
Visualforceページの表示の高さ (ピクセル単位)。
report
string
コンポーネントに関連付けられたレポートの
名前。
scontrol
string
scontrol が componentType 項目の値である
場合に、コンポーネントに関連付けられる Sコ
ントロール。詳細は、Salesforce オンラインヘ
ルプの「カスタム Sコントロールの定義」を参
照してください。
scontrolHeightInPixels int
showPercentage
Sコントロールの表示の高さ (ピクセル単位)。
boolean
円グラフ、ドーナツグラフ、およびじょうご
グラフのゲージ、系列、および区分の領域に
パーセント値を表示するか (true)、否か
(false) を示します。
294
メタデータ型
Dashboard
項目
データ型
説明
showPicturesOnCharts
boolean
ユーザまたはグループの名前項目によってソー
スレポートがグループ化されている横棒グラ
フコンポーネントに、最大20レコードのChatter
写真を表示します。写真を含むレコードが 20
件より多くある場合は、写真ではなくレコー
ド名が表示されます。写真を表示するには、
[グルーピング表示] で [なし] に設定します。
[ドリルダウン先] オプションを [レコード詳細
ページ] に設定すると、写真をクリックした
ときにユーザプロファイルやグループページ
に直接移動できます。写真を表示するには、
Chatter を有効にする必要があります。組織の
設定に応じて、テーブルやグラフで写真が表
示されない場合があります。
showPicturesOnTables
boolean
ユーザまたはグループの名前項目によってソー
スレポートがグループ化されている横棒グラ
フコンポーネントに、最大20レコードのChatter
写真を表示します。写真を含むレコードが 20
件より多くある場合は、写真ではなくレコー
ド名が表示されます。写真を表示するには、
[グルーピング表示] で [なし] に設定します。
[ドリルダウン先] オプションを [レコード詳細
ページ] に設定すると、写真をクリックした
ときにユーザプロファイルやグループページ
に直接移動できます。写真を表示するには、
Chatter を有効にする必要があります。組織の
設定に応じて、テーブルやグラフで写真が表
示されない場合があります。
showTotal
boolean
ゲージとドーナツグラフですべての系列の合
計を表示するか (true)、否か (false) を示しま
す。
showValues
boolean
グラフの個々のレコードまたはグループの値
が表示されるか (true)、否か (false) を示しま
す。
sortBy
DashboardComponentFilter (string 型 ダッシュボードコンポーネントの並び替えオ
の列挙)
プション。
title
string
ダッシュボードコンポーネントのタイトル。
最大 40 文字です。
useReportChart
boolean
ソースレポートに定義されたグラフをこの
dashboard コンポーネントで使用するかどうか
295
メタデータ型
項目
Dashboard
データ型
説明
を指定します。ソースレポートのグラフの設
定によって、ダッシュボードでのグラフの表
示方法が決定します。また、ダッシュボード
に定義したグラフ設定はすべて上書きされま
す。ソースレポートに組み合わせグラフを定
義した場合、このオプションを使用して、こ
のダッシュボードで組み合わせグラフを使用
します。
DashboardFilters
DashboardFilters は、ダッシュボードの検索条件を表します。
項目
データ型
説明
dashboardFilterOptions DashboardFilterOptions[]
name
[検索条件を追加] ダイアログの [検索条件オプショ
ン] セクションで選択できる項目のリスト。
string
必須。検索条件の表示ラベル。
DashboardFilterColumns
DashboardFilterColumns は、ダッシュボードの検索条件列を表します。
項目
データ型
説明
column
string
必須。検索条件のレポート列コード。
DashboardFilterOptions
DashboardFilterOptions は、ダッシュボードの検索条件オプションを表します。
項目
データ型
説明
operator
DashboardFilterOperation
必須。この検索条件項目の絞り込み操作を表しま
す。有効な値は、DashboardFilterOperation に列挙され
ています。この項目は API バージョン 24.0 以降で使
用できます。
(string 型の列挙)
API バージョン 23.0 での有効な値は、FilterOperation に
列挙されています。
296
メタデータ型
Dashboard
項目
データ型
説明
value
string
必須。[検索条件を追加] ダイアログの [検索条件オ
プション] 領域の値。この項目はAPIバージョン 23.0
で使用できます。
values
string[]
必須。[検索条件を追加] ダイアログの [検索条件オ
プション] 領域の 1 つ以上の値。この項目はAPIバー
ジョン 24.0 以降で使用できます。
DashboardFilterOperation
これは、ダッシュボードの絞り込み操作をリストする string 型の列挙です。有効な値は、次のとおりです。
• equals
• notEqual
• lessThan
• greaterThan
• lessOrEqual
• greaterOrEqual
• contains
• notContain
• startsWith
• includes
• excludes
• between
メモ: "between" 演算子には、2 つのオペランドが必要です ("between MinimumValue, MaximumValue" など)。
また、最小値にはその値自体が含まれますが、最大値にはその値自体は含まれません。その他すべて
のダッシュボード絞り込み操作では、1 つのオペランドのみが必要です。
DashboardTableColumn
DashboardTableColumn は、ダッシュボードのカスタマイズされたテーブルコンポーネントの列を表します。
項目
データ型
説明
aggregateType
ReportSummaryType[] (string
型の列挙)
テーブル列の集計種別を指定します。
column
string
必須。テーブルで使用する列の表示ラベル。
showTotal
boolean
ダッシュボードテーブルに集計可能な各列の合計を
表示します。この項目は API バージョン 19.0 以降で
使用できます。
297
メタデータ型
Dashboard
項目
データ型
説明
sortBy
DashboardComponentFilter
(string 型の列挙)
ダッシュボードテーブルコンポーネントの並び替え
オプション。テーブルあたり 1 つの列で並び替えま
す。
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>
</dashboardFilterOptions>
<dashboardFilterOptions>
<operator>between</operator>
<values>ABC</values>
<values>XYZ</values>
</dashboardFilterOptions>
<name>Industry</name>
</dashboardFilters>
298
メタデータ型
Dashboard
<dashboardFilters>
<dashboardFilterOptions>
<operator>equals</operator>
<values>Analyst,Partner</values>
</dashboardFilterOptions>
<dashboardFilterOptions>
<operator>startsWith</operator>
<values>Integrator</values>
</dashboardFilterOptions>
<name>Account Type</name>
</dashboardFilters>
<dashboardType>SpecifiedUser</dashboardType>
<leftSection>
<columnSize>Medium</columnSize>
<components>
<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>
<columnSize>Medium</columnSize>
<components>
<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>
299
メタデータ型
Dashboard
<report>unfiled$public/SampleReportofCases</report>
<showPercentage>false</showPercentage>
<showValues>true</showValues>
<sortBy>RowLabelAscending</sortBy>
<useReportChart>false</useReportChart>
</components>
</middleSection>
<rightSection>
<columnSize>Medium</columnSize>
<components>
<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>
</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>
<columnSize>Medium</columnSize>
300
メタデータ型
Dashboard
<components>
<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>
</components>
<components>
<chartAxisRange>Auto</chartAxisRange>
<componentType>Bar</componentType>
<displayUnits>Auto</displayUnits>
<drillEnabled>true</drillEnabled>
<enableHover>true</enableHover>
<report>testFolder/sourceRep</report>
<sortBy>RowLabelAscending</sortBy>
</components>
<components>
<chartAxisRange>Auto</chartAxisRange>
<componentType>Column</componentType>
<displayUnits>Auto</displayUnits>
<drillEnabled>true</drillEnabled>
<legendPosition>Bottom</legendPosition>
<report>testFolder/sourceRep</report>
<sortBy>RowLabelAscending</sortBy>
<useReportChart>true</useReportChart>
</components>
301
メタデータ型
Dashboard
<components>
<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>
<columnSize>Medium</columnSize>
<components>
<chartAxisRange>Auto</chartAxisRange>
<componentType>ColumnStacked100</componentType>
<displayUnits>Auto</displayUnits>
<drillEnabled>true</drillEnabled>
<enableHover>true</enableHover>
<report>testFolder/sourceRep</report>
<sortBy>RowLabelAscending</sortBy>
</components>
<components>
<chartAxisRange>Auto</chartAxisRange>
<componentType>ColumnStacked</componentType>
<displayUnits>Auto</displayUnits>
<drillEnabled>true</drillEnabled>
<enableHover>true</enableHover>
<report>testFolder/sourceRep</report>
<sortBy>RowLabelAscending</sortBy>
</components>
<components>
<chartAxisRange>Auto</chartAxisRange>
<componentType>ColumnStacked</componentType>
<displayUnits>Auto</displayUnits>
<drillEnabled>true</drillEnabled>
<enableHover>true</enableHover>
<report>testFolder/sourceRep</report>
<sortBy>RowLabelAscending</sortBy>
</components>
<components>
<chartAxisRange>Auto</chartAxisRange>
<componentType>ColumnGrouped</componentType>
<displayUnits>Auto</displayUnits>
<drillEnabled>true</drillEnabled>
<enableHover>true</enableHover>
<report>testFolder/sourceRep</report>
<sortBy>RowLabelAscending</sortBy>
</components>
<components>
<chartAxisRange>Auto</chartAxisRange>
<componentType>Column</componentType>
<displayUnits>Auto</displayUnits>
302
メタデータ型
Dashboard
<drillEnabled>true</drillEnabled>
<enableHover>true</enableHover>
<report>testFolder/sourceRep</report>
<sortBy>RowLabelAscending</sortBy>
</components>
</middleSection>
<rightSection>
<columnSize>Medium</columnSize>
<components>
<chartAxisRange>Auto</chartAxisRange>
<componentType>Bar</componentType>
<displayUnits>Auto</displayUnits>
<drillEnabled>true</drillEnabled>
<enableHover>true</enableHover>
<report>testFolder/sourceRep</report>
<sortBy>RowLabelAscending</sortBy>
</components>
<components>
<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>
</components>
<components>
<chartAxisRange>Auto</chartAxisRange>
<componentType>LineGroupedCumulative</componentType>
<displayUnits>Auto</displayUnits>
<drillEnabled>true</drillEnabled>
<enableHover>true</enableHover>
<report>testFolder/sourceRep</report>
<sortBy>RowLabelAscending</sortBy>
</components>
<components>
<chartAxisRange>Auto</chartAxisRange>
<componentType>LineGrouped</componentType>
<displayUnits>Auto</displayUnits>
<drillEnabled>true</drillEnabled>
<enableHover>true</enableHover>
<report>testFolder/sourceRep</report>
<sortBy>RowLabelAscending</sortBy>
</components>
<components>
<chartAxisRange>Auto</chartAxisRange>
<componentType>LineCumulative</componentType>
<displayUnits>Auto</displayUnits>
<drillEnabled>true</drillEnabled>
<enableHover>true</enableHover>
<report>testFolder/sourceRep</report>
<sortBy>RowLabelAscending</sortBy>
</components>
303
メタデータ型
DataCategoryGroup
<components>
<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>
<titleSize>12</titleSize>
</Dashboard>
関連トピック:
Folder
Report
DataCategoryGroup
データカテゴリグループを表します。Metadata メタデータ型を拡張し、その fullName 項目を継承します。
警告: メタデータ API を使用して、組織から別の組織にカテゴリ変更をリリースすると、XML ファイルで
指定されていないカテゴリとレコードカテゴリが完全に削除されます。Salesforce.com では、Sandbox から
本番組織に変更をリリースするのではなく、[設定] の[カスタマイズ] > [データカテゴリ]をクリックして、
組織内のデータカテゴリとレコードの関連付けを手動で作成することをお勧めします。詳細は、「使用
方法」を参照してください。
データカテゴリグループでは次を行えます。
• データの分類と絞り込み。
• ユーザ間でのデータの共有。
各データカテゴリグループには、階層的にまとめることのできる項目またはデータカテゴリが含まれます。
下の例は、Geography データカテゴリグループとそのデータカテゴリを示します。
Geography
Worldwide
North America
United States of America
Canada
Mexico
Europe
Asia
304
メタデータ型
DataCategoryGroup
メモ: データカテゴリグループ、データカテゴリ、親カテゴリ、およびサブカテゴリについての詳細は、
Salesforce オンラインヘルプの「データカテゴリとは?」を参照してください。
ファイルのサフィックスおよびディレクトリの場所
ファイルのサフィックスは、.datacategorygroup です。各データカテゴリグループに 1 つのファイルがあ
り、対応するパッケージディレクトリの datacategorygroups フォルダに保存されます。
バージョン
データカテゴリグループは API バージョン 18.0 以降で使用できます。
項目
このメタデータ型には、次の項目が含まれます。
項目名
データ型
説明
active
boolean
必須。カテゴリグループの状況。このカテゴリグループが
有効であるか (true)、否か (false) を示します。
dataCategory
DataCategory
必須。データカテゴリグループ内の最上位レベルのカテゴ
リ。
description
string
データカテゴリグループの説明。
fullName
string
必須。データカテゴリグループの一意の名前。データカテ
ゴリグループを作成するとき、fullName 項目とファイル
名 (サフィックスを含まない) が一致している必要がありま
す。fullName には、アンダースコアと英数字のみを使用
できます。一意であること、最初は文字であること、空白
は使用しない、最後にアンダースコアを使用しない、2 つ
続けてアンダースコアを使用しないという制約がありま
す。この項目は、Metadata コンポーネントから継承されて
います。
label
string
必須。Salesforce のオブジェクトを表す表示ラベル。
objectUsage
ObjectUsage
データカテゴリグループと関連付けられたオブジェクト。
DataCategory
データカテゴリグループの項目 (またはデータカテゴリ) を表します。データカテゴリは、他のデータカテゴリ
のリストを再帰的に含めることができます。
305
メタデータ型
DataCategoryGroup
項目名
データ型
説明
dataCategory
DataCategory[]
サブデータカテゴリの再帰的リスト。たとえば、一大陸内
の国のリストです。各データカテゴリグループに最大 100
個のカテゴリを作成し、各データカテゴリグループ階層に
最大 5 つのレベルを設定できます。
label
string
必須。Salesforceユーザインターフェースでのデータカテゴ
リの表示ラベル。
name
string
必須。API アクセスの一意の識別子として使用されるデー
タカテゴリの開発者名。名前には、英数字、およびアン
ダースコア (_) 文字のみを使用できます。また、最初は文
字とし、最後にアンダースコアを使用したり、連続した 2
つのアンダースコア文字を含めたりすることはできませ
ん。
重要: この項目の値は一度定義されると、後で変更
できません。
警告: 組織にすでに存在するカテゴリグループをリ
リースすると、XML ファイルで定義されていないカ
テゴリは、組織から完全に削除されます。詳細は、
「使用方法」を参照してください。
ObjectUsage
データカテゴリグループに関連付けることができるオブジェクトを表します。この関連付けによって、データ
カテゴリを使用したオブジェクトの分類および絞り込みが可能になります。
項目名
データ型
説明
object
string[]
データカテゴリグループに関連付けることができるオブ
ジェクト名のリスト。有効な値は、次のとおりです。
• KnowledgeArticleVersion — 記事を関連付けます。
データカテゴリグループの記事への関連付けについて
の詳細は、Salesforce オンラインヘルプの「Salesforce ナ
レッジのカテゴリグループ割り当ての変更」を参照し
てください。
• Question — 質問を関連付けます。Question オブジェ
クトを最大 1 つのカテゴリグループに関連付けること
ができます。データカテゴリグループの質問への関連
付けについての詳細は、Salesforce オンラインヘルプの
「データカテゴリのアンサーへの割り当て」を参照し
てください。
306
メタデータ型
項目名
DataCategoryGroup
データ型
説明
警告: 組織にすでに存在するカテゴリグループをリ
リースすると、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>
</dataCategory>
<dataCategory>
<name>MEX</name>
<label>Mexico</label>
</dataCategory>
</dataCategory>
<dataCategory> <name>EMEA</name> <label>Europe, Middle East, Africa</label>
<dataCategory>
<name>FR</name>
<label>France</label>
</dataCategory>
<dataCategory>
<name>SP</name>
<label>Spain</label>
</dataCategory>
<dataCategory>
<name>UK</name>
<label>United-Kingdom</label>
</dataCategory>
</dataCategory>
<dataCategory>
<name>APAC</name>
307
メタデータ型
DataCategoryGroup
<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 カテゴリに関連付けられます。
308
メタデータ型
DataCategoryGroup
次の例では、データカテゴリグループのカテゴリを削除または移動し、その XML 表現を Sandbox から、この
データカテゴリグループをすでに定義している本番組織にリリースするとどのようになるかを説明していま
す。階層 1 は、Sandbox 組織の最初のデータカテゴリグループを示します。階層 2 では、EU カテゴリを EMEA
の下に追加し、FR、SP、および UK を EU の下に移動しています。階層 3 では、FR を削除し、そのレコード
をその新しい親 EU に関連付けています。最後に、変更を Sandbox から本番組織にリリースします。
309
メタデータ型
Document
メタデータ 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 内のフォルダを示します。
<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<types>
310
メタデータ型
Document
<members>MyDBFolder/MyDBName</members>
<name>Dashboard</name>
</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>
</types>
<version>32.0</version>
</Package>
各ドキュメントには、DocumentFilename-meta.xml という名前の付随するメタデータファイルがドキュメ
ントフォルダ内に作成されます。たとえば、sampleFolder フォルダにあるドキュメント TestDocument.png の
場合は、パッケージの documents/sampleFolder に TestDocument.png-meta.xml があります。
バージョン
ドキュメントは、API バージョン 10.0 以降で使用できます。
API バージョン 17.0 以降では、ごみ箱に移動したドキュメントを含むフォルダを削除できます。フォルダを削
除すると、ごみ箱内の関連ドキュメントをはすべて完全に削除されます。
API バージョン 18.0 以降では、ドキュメントに拡張子が不要です。
項目
このメタデータ型には、次の項目が含まれます。
項目名
データ型
説明
content
base64
ドキュメントのコンテンツ。Base 64 で符号化されたバイナ
リデータ API コールを行う前に、クライアントアプリケー
ションはバイナリ添付データを base64 に符号化する必要が
あります。応答を受信したら、クライアントアプリケー
ションは、base64 データをバイナリに復号化する必要があ
ります。この変換は、通常 SOAP クライアントによって処
理されます。この項目は、MetadataWithContent コンポーネ
ントから継承されます。
description
string
ドキュメントの説明。このドキュメントを他のドキュメン
トと区別するための説明を入力します。
311
メタデータ型
Document
項目名
データ型
説明
fullName
string
フォルダ名を含む、ドキュメントの名前。バージョン 17.0
以前では、fullName にドキュメント拡張子が含まれてい
ました。バージョン 18.0 以降では、fullName にはファイ
ル拡張子が含まれていません。fullName には、アンダー
スコアと英数字のみを使用できます。一意であること、最
初は文字であること、空白は使用しない、最後にアンダー
スコアを使用しない、2 つ続けてアンダースコアを使用し
ないという制約があります。この項目が、使用できなく
なったバージョン 14.0 より前の文字を含んでいた場合は、
それらの文字はこの項目から削除され、その項目の以前の
値は name 項目に保存されていました。この項目は、
Metadata コンポーネントから継承されています。
internalUseOnly
boolean
必須。ドキュメントが機密文書であるか (true)、否か
(false) を示します。この項目と public はどちらか 1 つ
のみを true に設定でき、両方を true に設定することはで
きません。
keywords
string
ドキュメントを説明するための 1 つ以上の語が含まれま
す。検索時には、この項目の語に一致するかどうかの確認
が実行されます。
name
string
fullName 項目で使用できる文字のリストは、バージョン
14.0 以降削減されています。この項目には、バージョン
14.0 以前の fullName 項目に含まれている値が含まれま
す。この項目は、fullName 項目の値にその項目で受け入
れらない文字が含まれる場合にのみ入力されます。
public
boolean
必須。ドキュメントが HTML メールテンプレートに使用で
きる画像であり、メールで参照する場合にSalesforceユーザ
名とパスワードが必要でないか (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>
312
メタデータ型
EmailTemplate
<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 内のフォルダを示します。
<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<types>
<members>MyDBFolder/MyDBName</members>
<name>Dashboard</name>
</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>
</types>
313
メタデータ型
EmailTemplate
<version>32.0</version>
</Package>
バージョン
メールテンプレートは API バージョン 12.0 以降で使用できます。
項目
このメタデータ型には、次の項目が含まれます。
項目名
データ型
説明
apiVersion
double
これが Visualforce メールテンプレートである場合は、API バージョ
ン。どの Visualforce メールテンプレートにも作成時に指定された
API バージョンがあります。この項目は API バージョン 16.0 以降で
使用できます。
attachedDocuments string[]
組織のドキュメントへの参照のリスト。これらのドキュメント
は、メールテンプレートの添付ファイルとして含まれています。
各ドキュメントは、MyFolder/MyDocument.txt などのパスで
参照されます。
attachments
Attachment[]
メールテンプレートの添付ファイルのリスト。
available
boolean
必須。メール送信時にこのテンプレートがユーザに提供される
か (true)、否か (false) を示します。
content
base64Binary
メールテンプレートのコンテンツ。Base 64 で符号化されたバイ
ナリデータ API コールを行う前に、クライアントアプリケーショ
ンはバイナリ添付データを base64 に符号化する必要があります。
応答を受信したら、クライアントアプリケーションは、base64
データをバイナリに復号化する必要があります。この変換は、
通常 SOAP クライアントによって処理されます。この項目には次
のものが含まれています。
• type が text に設定されている場合は、メール本文のバイナ
リコンテンツ
• type が html に設定されている場合は、HTML メールコンテ
ンツ
• type が custom に設定されている場合は、HTML 本文
• type が visualforce に設定されている場合は、Visualforce
の本文
この項目は、MetadataWithContent コンポーネントから継承されま
す。
314
メタデータ型
EmailTemplate
項目名
データ型
説明
description
string
メールテンプレートの説明。これはテンプレートを作成した理
由を説明するのに役立ちます。
encodingKey
Encoding (string 型の列 必須。デフォルトの文字コード設定は Unicode (UTF-8) です。テ
挙)
ンプレートが別形式のデータを必要とする場合は、この設定を
変更します。
使用できる値は次のとおりです。
• 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)」
fullName
string
API アクセスの一意の識別子として使用されるメールテンプレー
トの開発者名。fullName には、アンダースコアと英数字のみを
使用できます。一意であること、最初は文字であること、空白
は使用しない、最後にアンダースコアを使用しない、2 つ続けて
アンダースコアを使用しないという制約があります。この項目
が、使用できなくなったバージョン 14.0 より前の文字を含んでい
た場合は、それらの文字はこの項目から削除され、その項目の
以前の値は name 項目に保存されていました。この項目は、
Metadata コンポーネントから継承されています。
letterhead
string
このメールテンプレートに関連付けられたレターヘッド名。type
が html に設定されている場合のみ有効です。
name
string
必須。メールテンプレート名。fullName 項目で使用できる文字
のリストは、バージョン 14.0 以降削減されています。この項目に
は、バージョン 14.0 以前の fullName 項目に含まれている値が含
まれます。
packageVersions
PackageVersion[]
このメールテンプレートによって参照されるコンポーネントを
含むすべての管理パッケージのパッケージバージョンのリスト。
この項目は、Visualforce メールテンプレートにのみ関連します。
315
メタデータ型
EmailTemplate
項目名
データ型
説明
style
EmailTemplateStyle
(string 型の列挙)
必須。テンプレートのスタイル。この項目は、type が html に
設定されている場合にのみ表示されます。
使用できるスタイルの値は次のとおりです。
• none
• freeForm
• formalLetter
• promotionRight
• promotionLeft
• newsletter
• products
subject
string
メールの件名。
textOnly
string
type が html または custom に設定されている場合は、メール
本文のテキスト。
type
EmailTemplateType
(string 型の列挙)
必須。メールテンプレートの種類。
有効な値は、次のとおりです。
• text - すべてのユーザがテキストメールテンプレートを作成
または削除できます。
• html - システム管理者および「HTML テンプレートの編集」権
限を持つユーザは、レターヘッドを基にして HTML メールテ
ンプレートを作成できます。
• custom - システム管理者および「HTML テンプレートの編集」
権限を持つユーザは、レターヘッドを使用しないカスタムの
HTML メールテンプレートを作成できます。HTML の知識があ
るか、メールテンプレートに挿入する HTML コードを用意し
ておく必要があります。
• visualforce - システム管理者および「アプリケーションの
カスタマイズ」権限を持つユーザは、Visualforce を使用して
メールテンプレートを作成できます。
Attachment
Attachment は添付ファイルを表します。
項目
データ型
説明
content
base64Binary
必須。添付ファイルのコンテンツ。Base 64 で符号化
されたバイナリデータ API コールを行う前に、クラ
イアントアプリケーションはバイナリ添付データを
316
メタデータ型
項目
EntitlementProcess
データ型
説明
base64 に符号化する必要があります。応答を受信し
たら、クライアントアプリケーションは、base64
データをバイナリに復号化する必要があります。こ
の変換は、通常 SOAP クライアントによって処理さ
れます。
name
必須。添付ファイル名。
string
宣言的なメタデータの定義のサンプル
メールテンプレートの 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 項目とは異なり、バージョニングが有効化されている場合は、同じエン
タイトルメントプロセスの複数のバージョンで共有されます。
317
メタデータ型
EntitlementProcess
バージョン
エンタイトルメントプロセスは、API バージョン 27.0 以降で使用できます。
項目
項目名
データ型
説明
active
boolean
エンタイトルメントプロセスが有効であるか
(true)、有効でないか (false) を示します。
businessHours
string
エンタイトルメントプロセスに適用される営
業時間。
この項目は API バージョン 30.0 以降で使用でき
ます。
description
string
エンタイトルメントプロセスの説明。
entryStartDateField
string
ケースのカスタム日付/時間項目に基づいて
ケースのプロセスが開始されるマイルストン
プロセスの場合、使用される日付と時間を指
定します。有効な値は、次のとおりです。
• SlaStartDate (エンタイトルメントプロセスの
開始日)
• CreatedDate (ケースのオープン日)
• ClosedDate (ケースのクローズ日)
• LastModifiedDate (ケースの最終更新日)
• StopStartDate (ケースの停止日)
exitCriteriaBooleanFilter string
カスタム条件が一致したときにケースのプロ
セスが終了するマイルストンプロセスに条件
ロジックを追加する場合、その条件ロジック
を指定します。
exitCriteriaFilterItems FilterItem[]
カスタム条件が一致したときにケースのプロ
セスが終了するマイルストンプロセスの場合、
その条件を指定します。
exitCriteriaFormula
string
カスタム数式の評価が true になったときにケー
スのプロセスが終了するマイルストンプロセ
スの場合、その数式を指定します。
318
メタデータ型
EntitlementProcess
項目名
データ型
説明
isVersionDefault
boolean
エンタイトルメントプロセスがデフォルトの
バージョンであるか (true)、否か (false) を
示します。
この項目は API バージョン 28.0 以降で使用でき
ます。
milestones
EntitlementProcessMilestoneItem[]
エンタイトルメントプロセスのマイルストン
を表します。
name
string
ユーザインターフェースに表示されるエンタ
イトルメントプロセスの名前。
versionMaster
string
このエンタイトルメントプロセスに属するバー
ジョンの順序を示します。この項目の内容は、
エンタイトルメントプロセスのすべてのバー
ジョンで同じであれば、任意の値が有効です。
この項目は API バージョン 28.0 以降で使用でき
ます。
versionNotes
string
エンタイトルメントプロセスバージョンの説
明。
この項目は API バージョン 28.0 以降で使用でき
ます。
versionNumber
int
エンタイトルメントプロセスのバージョン番
号。1 以上である必要があります。
この項目は API バージョン 28.0 以降で使用でき
ます。
EntitlementProcessMilestoneItem
エンタイトルメントプロセスのマイルストン項目を表します。
項目
項目名
データ型
説明
businessHours
string
マイルストンに適用される営業時間。
この項目は API バージョン 30.0 以降で使用で
きます。
319
メタデータ型
EntitlementProcess
項目名
データ型
説明
criteriaBooleanFilter
string
条件が一致したときにのみ適用されるマイ
ルストンに条件ロジックを追加する場合、
その条件ロジックを指定します。
milestoneCriteriaFilterItems FilterItem[]
条件が一致したときにのみ適用されるマイ
ルストンの場合、その条件を指定します。
milestoneCriteriaFormula string
数式の評価が true になったときにのみ適用
されるマイルストンの場合、その数式を指
定します。
milestoneName
string
マイルストンの名前。
minutesCustomClass
string
トリガ時間の計算に使用する Apex クラスの
名前。この項目は API バージョン 30.0 以降で
使用できます。
minutesToComplete
int
ケースのエンタイトルメントプロセスが開
始してから、マイルストンが発生するまで
の分数。
successActions
WorkflowActionReference[]
マイルストンが完了するとトリガされるア
クション。
timeTriggers
EntitlementProcessMilestoneTimeTrigger[] エンタイトルメントプロセスのマイルスト
ンのタイムトリガ。
useCriteriaStartTime
boolean
マイルストンが開始されるタイミング。マ
イルストン条件が一致したとき (true)、また
はケースのエンタイトルメントプロセスが
開始されたとき (false)。
EntitlementProcessMilestoneTimeTrigger
エンタイトルメントプロセスのマイルストンのタイムトリガを表します。
項目
項目名
データ型
説明
actions
WorkflowActionReference[] タイムトリガに達したときに、その時点でマイルスト
ンが完了してない場合に実行されるアクション。
timeLength
int
タイムトリガが有効になってから、マイルストンの目
標完了日までの時間。これは、負または正の値になる
場合があります。負の値は、目標完了日に達していな
320
メタデータ型
項目名
EntitlementProcess
データ型
説明
いことを示し、警告のタイムトリガに相当します。正
の値は、目標完了日が過ぎたことを示し、違反のタイ
ムトリガに相当します。
workflowTimeTriggerUnit MilestoneTimeUnits (string ワークフローがトリガされるタイミングを判断するた
型の列挙)
めに使用される単位の種類を指定します。有効な値は、
次のとおりです。
• 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>
321
メタデータ型
EntitlementTemplate
<workflowTimeTriggerUnit>Minutes</workflowTimeTriggerUnit>
</timeTriggers>
<timeTriggers>
<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 以降で使用できます。
322
メタデータ型
EscalationRules
項目
項目
データ型
説明
businessHours
string
エンタイトルメントのサポートされている営業時
間。
casesPerEntitlement
int
エンタイトルメントがサポートするケース数を制限
します。
entitlementProcess
string
エンタイトルメントプロセスのエンタイトルメント
への追加
isPerIncident
boolean
このテンプレートから作成されたエンタイトルメン
トでケース数を制限する場合は、true。それ以外
の場合は、false。
term
int
エンタイトルメントが有効な日数。
type
string
Web サポート、電話サポートなど、エンタイトルメ
ントのタイプ。
宣言的なメタデータの定義のサンプル
エンタイトルメントテンプレートの 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
ケースが一定の期間内に解決されない場合に自動的にエスカレーションを行うための、ケースのエスカレー
ションルールを表します。該当するすべてのオブジェクト、特定のオブジェクト、または特定のオブジェクト
323
メタデータ型
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>
ファイルのサフィックスおよびディレクトリの場所
オブジェクトの EscalationRules のサフィックスは .escalationRules で、escalationRules フォルダに保存
されます。たとえば、すべての Case エスカレーションルールは、Case.escalationRules ファイルに保存さ
れます。
バージョン
EscalationRules コンポーネントは、API バージョン 27.0 以降で使用できます。
項目
項目名
データ型
説明
escalationRule
EscalationRule[]
1 つのエスカレーションルールを表し、有効かどうかを示
します。 エスカレーションルールは EscalationRules コンテ
ナ内に表示される順序で処理されます。
324
メタデータ型
EscalationRules
EscalationRule
項目名
データ型
説明
active
boolean
エスカレーションルールが有効であるか(true)、
否か (false) を示します。
fullname
string
Metadata から継承されるこの項目は、このメタ
データ型の WSDL では定義されません。作成時、
更新時、または削除時に指定する必要がありま
す。コールにおけるこの項目の例を確認するに
は、「create()」を参照してください。
この値は null にできません。
ruleEntry
エスカレーションルールのルールエントリの定
義が含まれます。
RuleEntry[]
RuleEntry
ルールで使用される項目を表します。
項目名
データ型
説明
booleanFilter
string
ルールに指定されている高度な絞り込み条件。
businessHours
string
エスカレーションアクションが実行される時
間。businessHoursSource が Static に設定
されている場合のみ指定します。
businessHoursSource
BusinessHoursSourceType 有効な値は、次のとおりです。
(string 型の列挙)
• None
• Case
• Static
criteriaItems
割り当て条件を定義するリストの項目。
FilterItem
disableEscalationWhenModified boolean
レコードが変更されるとエスカレーションが無
効化されるか (true)、否か (false) を示します。
escalationAction
エスカレーション条件が一致すると実行される
アクション。
EscalationAction[]
(ページ 326)
escalationStartTime
EscalationStartTimeType エスカレーションの開始時間を示します。有効
(string 型の列挙)
な値は、次のとおりです。
• CaseCreation
• CaseLastModified
325
メタデータ型
EscalationRules
項目名
データ型
説明
formula
string
入力規則数式。
メモ: formula と criteriaItems のい
ずれかを指定します。両方の項目は指定
できません。
EscalationAction
エスカレーションルールで実行されるアクションを説明します。
項目名
データ型
説明
assignedTo
string
項目が割り当てられるユーザまたはキューの名
前。
assignedToTemplate
string
エスカレーションルールで指定された新しい所
有者に自動送信されるメールで使用するテンプ
レートを指定します。
assignedToType
AssignToLookupValueType 有効な値は、次のとおりです。
(string 型の列挙)
• User
• Queue
minutesToEscalation
int
エスカレーションが発生するまでの分数。
notifyCaseOwner
boolean
ケースがエスカレーションされたときにケース
所有者に通知するか (true)、否か (false) を示
します。
notifyEmail
string
通知するユーザのメールアドレスを指定しま
す。
notifyTo
string
通知するユーザを指定します。
notifyToTemplate
string
通知メールに使用するテンプレートを指定しま
す。
宣言的なメタデータの定義のサンプル
EscalationRules コンポーネントの例を次に示します。
<EscalationRules xmlns="http://soap.sforce.com/2006/04/metadata">
<escalationRule>
<fullName>samplerule</fullName>
<active>false</active>
<ruleEntry>
326
メタデータ型
ExternalDataSource
<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の外部に
あるデータソースとのインテグレーションに関する接続の詳細を管理します。Metadata メタデータ型を拡張
し、その fullName 項目を継承します。
ファイルのサフィックスおよびディレクトリの場所
ExternalDataSource コンポーネントは、対応するパッケージディレクトリの dataSources ディレクトリに保存
されます。ExternalDataSource コンポーネントにはサフィックス .dataSource があり、プレフィックスは外部
データソースの名前です。
バージョン
ExternalDataSource コンポーネントは、API バージョン 28.0 以降で使用できます。
項目
項目名
データ型
説明
apiKey
string
外部データソースに接続するための鍵。
authProvider
string
AuthProvider コンポーネントで表される認証プロバイダ。
certificate
string
SharePoint 2010 と 2007 でのみ使用できます。セキュリティ
証明書が必要な場合は、証明書のルックアップアイコンを
クリックして、Salesforceで作成された有効な証明書をすべ
て検索します。
327
メタデータ型
ExternalDataSource
項目名
データ型
説明
customConfiguration
string
データソースの構成に使用されるカスタム文字列。
たとえば、次の JSON コード化された設定文字列では、type
が OData に設定されている場合に適用されるパターンを
定義します。
{"noIdMapping":"false","searchFunc":"",
"searchEnabled":"true","format":"ATOM",
"timeout":"120"}
パラメータは、ユーザインターフェースの次の項目に対応
します。
• noIdMapping — 大量データ
• searchFunc — Salesforce 検索のカスタムクエリオプショ
ン
• searchEnabled — Salesforce 検索に含まれる
• format — 形式
• timeout — 接続タイムアウト
endpoint
string
データソースに接続する URL。
label
string
リストビューなどのSalesforceユーザインターフェースに表
示される、データソースのわかりやすい名前。
たとえば、Acme Team Marketing Site や Acme SharePoint などで
す。
oauthRefreshToken
string
更新済みの OAuth トークン。指定された期間に、既存のエ
ンドユーザの新しいアクセストークンを取得するために使
用します。
oauthScope
string
アクセストークンの範囲。特定のユーザデータへのアクセ
ス権を指定する権限セットが、スペースで区切られた文字
列のリストとして示されています。
oauthToken
string
権限サーバによって発行されるアクセストークン。
password
string
外部ソースにアクセスするためにSalesforceで使用するパス
ワード。使用するログイン情報に、データソースへのアク
セス、検索の実行、外部データに関する情報の復帰を行う
ための十分な権限があることを確認してください。アクセ
スの設定方法によっては、システム管理者のパスワードの
指定を必要とする場合があります。
principalType
External
Salesforce 外のデータソースの認証に使用する ID タイプ。外
PrincipalType 部データソースの [設定] ページと [編集] ページでは、これ
(string 型の列挙)
328
メタデータ型
項目名
ExternalDataSource
データ型
説明
らの選択は [ID 種別] 項目から行われます。有効な値は、次
のとおりです。
• Anonymous
• PerUser
• NamedUser
protocol
Authentication Salesforce外のデータソースへのアクセスに必要なプロトコ
Protocol (string ル。外部データソースが SharePoint の場合、[基本認証] を
型の列挙)
選択します。有効な値は、次のとおりです。
• NoAuthentication
• Oauth
• Password
repository
string
type
ExternalData 接続先であるデータソースのタイプ。有効な値は、次のと
SourceType
おりです。
(string 型の列挙)
SharePoint Online に使用します。メタデータにアクセスでき
ない場合、この項目を使用してテーブルとデフォルトの
テーブル項目を作成します。
• ID
• OData
• SimpleURL
username
string
外部データソースにアクセスするためにSalesforceで使用す
るユーザ名。使用するログイン情報に、データソースへの
アクセス、検索の実行、情報の復帰を行うための十分な権
限があることを確認してください。アクセスの設定方法に
よっては、システム管理者のユーザ名の指定を必要とする
場合があります。
version
string
使用しているデータソースのバージョン番号。
宣言的なメタデータの定義のサンプル
Platform Connect の外部データソースの定義を次に示します。
<?xml version="1.0" encoding="UTF-8"?>
<ExternalDataSource xmlns="http://soap.sforce.com/2006/04/metadata">
<authProvider>FacebookAuth</authProvider>
<customConfiguration>{"noIdMapping":"false",
"searchFunc":"","searchEnabled":"true","format":"ATOM",
"timeout":"120"}</customConfiguration>
<endpoint>http://myappname.herokuapp.com/DataHub.svc</endpoint>
<label>DataHub</label>
329
メタデータ型
FlexiPage
<principalType>NamedUser</principalType>
<protocol>Oauth</protocol>
<type>OData</type>
</ExternalDataSource>
FlexiPage
フレキシブルページに関連付けられたメタデータを表します。フレキシブルページは、Salesforce1ナビゲーショ
ンメニューのメニュー項目として表示されるモバイルアプリケーションのホームページです。Metadata メタ
データ型を拡張し、その fullName 項目を継承します。フレキシブルページについての詳細は、Salesforceヘル
プを参照してください。
メモ: FlexiPageコンポーネントは、Salesforce1でのみサポートされています。Salesforce1についての詳細は、
Salesforce ヘルプを参照してください。
ファイルのサフィックスおよびディレクトリの場所
FlexiPage コンポーネントのサフィックスは .flexipage であり、flexipages フォルダに保存されます。
バージョン
FlexiPage コンポーネントは、API バージョン 29.0 以降で使用できます。
項目
項目名
データ型
説明
description
string
フレキシブルページの説明テキスト (省略可能)。
flexiPageRegions
FlexiPageRegion[]
必須。ページの領域。必ず 1 つの領域がある必要
があります。
masterLabel
string
必須。[設定] に表示されるこの FlexiPage の表示ラ
ベル。
quickActionList
QuickActionList
ページレイアウトに関連付けられたアクションの
リスト。
type
FlexiPageType (string 型の列 必須。ページの種別。APIバージョン 32.0 では、こ
挙)
の項目には値 AppPage しか設定できません。
• AppPage — サードパーティアプリケーションの
ホームページとして使用されるフレキシブル
ページ。
API バージョン 32.0 以降で利用できます。
330
メタデータ型
FlexiPage
FlexiPageRegion
FlexiPageRegion は、ページ領域のプロパティを表します。FlexiPage ごとに 1 つの範囲があります。範囲には、エ
ンティティセットを範囲とすることができる、レコードリストコンポーネントまたは最近使ったデータコン
ポーネントを含めることができます。
項目名
データ型
説明
componentInstances
ComponentInstance[]
コンポーネントインスタンスのプロパティと名前。
name
string
必須。FlexiPage 範囲の一意の名前。
main である必要があります。
ComponentInstance
フィルタリストなど、ページ内のコンポーネントのインスタンス。
項目名
データ型
説明
componentInstanceProperties ComponentInstanceProperty[]
componentName
コンポーネントインスタンスの単一プロパ
ティの値。コンポーネントインスタンスに
はプロパティがない場合もあります。
string
必須。コンポーネントの単一インスタンス
の名前。
ComponentInstanceProperty
コンポーネントインスタンスの単一プロパティの値。
項目名
データ型
説明
name
string
コンポーネントインスタンス内で一意のプロパティ
名。
value
string
プロパティの参照または値。
宣言的なメタデータの定義のサンプル
次に、ユーザの出張、経費報告、および他の関連データを追跡する出張アプリケーションのサンプル XML
FlexiPage コンポーネント定義を示します。
<?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>
331
メタデータ型
FlexiPage
<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>
</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 ファイルを次に示します。
<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<fullName>Travel, Inc.</fullName>
<types>
<members>TravelIncFlexiPage</members>
<name>CustomTab</name>
</types>
<types>
<members>TravelIncFlexiPage</members>
<name>FlexiPage</name>
</types>
<types>
332
メタデータ型
Flow
<members>TravelIncQuickActions</members>
<name>QuickAction</name>
</types>
<version>29.0</version>
</Package>
Flow
フローに関連付けられたメタデータを表します。フローを使用すると、ユーザが一連の画面を移動してデータ
ベース内のレコードをクエリおよび更新するアプリケーションを作成できます。また、ユーザ入力に基づいて
ロジックを実行して分岐機能を提供し、動的なアプリケーションを構築できます。対応する UI ベースのフロー
作成ツールについての詳細は、Salesforce ヘルプの「Flow Designer の概要」を参照してください。
ファイルベースのメタデータ API を使用してフローを操作する場合、次の点に留意してください。
• 管理パッケージからインストールされたフローへのアクセスには、メタデータ API を使用できません。
• フローファイル名には空白を含めないでください。含めるとリリース時にエラーが発生します。先頭と末
尾の空白は許可されますが、リリース時に削除されます。
• メタデータ APIを使用してフローをリリースするときには、有効なフローまたはかつて有効だったフローは
上書きできません。
• フローの新バージョンを作成するには、ファイルに新しいバージョン番号を指定してリリースします。
宣言的なメタデータファイルのサフィックスおよびディレクトリの
場所
フローは、対応するパッケージディレクトリの Flow ディレクトリに保存されます。ファイル名はフローの一
意の完全名と一致し、拡張子は .flow です。
バージョン
フローメタデータ API は、API バージョン 24.0 以降で使用できます。
Flow
このメタデータ型はフローの有効な定義を表します。Metadata メタデータ型を拡張し、その fullName 項目を
継承します。
項目名
データ型
説明
actionCalls
FlowActionCall[]
アクションへのコールを定義するノードの配列。こ
の項目は API バージョン 31.0 以降で使用できます。
apexPluginCalls
FlowApexPluginCall[]
Apex プラグインへのコールを定義するノードの配
列。
assignments
FlowAssignment[]
割り当てノードの配列。
333
メタデータ型
Flow
項目名
データ型
説明
choices
FlowChoice[]
静的選択オプションの配列。
constants
FlowConstant[]
定数の配列。
decisions
FlowDecision[]
決定ノードの配列。
description
string
フローの説明。
dynamicChoiceSets
FlowDynamicChoiceSet[]
データベースルックアップに基づく選択オプション
のセットを構成する配列。
formulas
FlowFormula[]
数式の配列。
fullName
string
必須。Metadata コンポーネントから継承されます。
メタデータ API 内のファイルの名前。
fullName は、ハイフンで区切られた 2 つの部分で
構成されます。
• アンダースコアと英数字のみで構成されるフロー
の一意の名前。組織全体で一意であること、最
初は文字であること、空白は使用しない、最後
にアンダースコアを使用しない、2 つ続けてアン
ダースコアを使用しないという制約があります。
• フローのバージョン番号。
たとえば、「sampleFlow-3」は、一意の名前が
sampleFlow であるフローのバージョン 3 であること
を示します。
label
string
必須。フローの表示ラベル。
loops
FlowLoop[]
コレクションを反復処理するためのノードの配列。
この項目はAPIバージョン 30.0 以降で使用できます。
processMetadataValues
FlowMetadataValue[]
フローのメタデータ値。
この項目はAPIバージョン 31.0 以降で使用できます。
processType
FlowProcessType (string 型の
列挙)
プロセス種別。有効な値は、次のとおりです。
• AutoLaunchedFlow — 有効なバージョン (有効
なバージョンがない場合は最新バージョン) がト
リガ対応のフロー
• Flow — 制限対象の要素またはリソースが 1 つ以
上含まれるため、有効なバージョン (有効なバー
ジョンがない場合は最新バージョン) がトリガ対
応ではないフロー
• Workflow — 将来の使用のために予約
334
メタデータ型
Flow
項目名
データ型
説明
バージョン間で processType を Flow から
AutoLaunchedFlow (またはその逆) に変更できま
す。
この項目はAPIバージョン 31.0 以降で使用できます。
recordCreates
FlowRecordCreate[]
データベース内のレコードを作成するためのノード
の配列。
recordDeletes
FlowRecordDelete[]
データベース内のレコードを削除するためのノード
の配列。
recordLookups
FlowRecordLookup[]
データベース内のレコードを検索するためのノード
の配列。
recordUpdates
FlowRecordUpdate[]
データベース内のレコードを更新するためのノード
の配列。
screens
FlowScreen[]
画面ノードの配列。
startElementReference
string
フローの開始点となるノードまたは要素を指定しま
す。
steps
FlowStep[]
ステップノードの配列。
subflows
FlowSubflow[]
サブフローの配列です。この項目は API バージョン
25.0 以降で使用できます。
textTemplates
FlowTextTemplate[]
テキストテンプレートの配列。
variables
FlowVariable[]
変数定義の配列。
waits
FlowWait[]
待機ノードの配列。この項目は、APIバージョン 32.0
以降で使用できます。
FlowActionCall
フローからアクションへのコールを定義します。FlowNode を拡張します。
API バージョン 31.0 以降で利用できます。
項目名
データ型
説明
actionName
string
必須。アクションの名前。同じ actionType の
アクション間で一意である必要があります。
actionType
InvocableActionType (string 型の列挙)
必須。アクションの種別。有効な値は、次のと
おりです。
• chatterPost — Chatter に投稿します。
335
メタデータ型
項目名
Flow
データ型
説明
• emailAlert — ワークフローメールアラー
トを参照してメールを送信します。
• emailSimple — フローリソースを使用して
メールを送信します。
• flow — 今後の使用のために予約されていま
す。
• quickAction — QuickActionを呼び出します。
• submit — レコードの承認を申請します。
connector
FlowConnector
このアクションコールの後に実行するノードを
指定します。
faultConnector
FlowConnector
アクションコールの結果がエラーの場合に実行
するノードを指定します。
inputParameters
FlowActionCallInputParameter[]
フローからアクションへの入力パラメータの配
列。
outputParameters
FlowActionCallOutputParameter[]
アクションからフローへの出力パラメータの配
列。
FlowActionCallInputParameter
フローからアクションへの入力パラメータを定義します。FlowBaseElement を拡張し、その項目のすべてを継承
します。API バージョン 31.0 以降で使用できます。
項目名
データ型
説明
name
string
必須。入力パラメータの一意の名前。
value
FlowElementReferenceOrValue
入力パラメータの値を定義します。
FlowActionCallOutputParameter
アクションからフローへの出力パラメータを定義します。FlowBaseElement を拡張し、その項目のすべてを継承
します。API バージョン 31.0 以降で使用できます。
項目名
データ型
説明
assignToReference
string
必須。出力パラメータ値を割り当てる変数を指定しま
す。
name
string
必須。出力パラメータの一意の名前。
336
メタデータ型
Flow
FlowApexPluginCall
フローから Apex プラグインへのコールを定義します。FlowNode を拡張し、その項目のすべてを継承します。
項目名
データ型
説明
apexClass
string
必須。Apex クラスの名前。
connector
FlowConnector
この Apex プラグインコールの後に実行するノー
ドを指定します。
faultConnector
FlowConnector
Apex プラグインコールの結果がエラーの場合に
実行するノードを指定します。
inputParameters
FlowApexPluginCallInputParameter[]
フローから Apex プラグインへの入力パラメータ
の配列。
outputParameters
FlowApexPluginCallOutputParameter[]
Apex プラグインからフローへの出力パラメータ
の配列。
FlowApexPluginCallInputParameter
フローからApexプラグインへの入力パラメータを定義します。FlowBaseElementを拡張し、その項目のすべてを
継承します。
項目名
データ型
説明
name
string
必須。入力パラメータの一意の名前。
value
FlowElementReferenceOrValue
入力パラメータの値を定義します。
FlowApexPluginCallOutputParameter
Apex プラグインからフローへの出力パラメータを定義します。FlowBaseElement を拡張し、その項目のすべてを
継承します。
項目名
データ型
説明
assignToReference
string
必須。出力パラメータ値を割り当てる変数を指定しま
す。
name
string
必須。出力パラメータの一意の名前。
FlowAssignment
フロー内の変数の値を動的に変更できる割り当てノードを定義します。FlowNodeを拡張し、その項目のすべて
を継承します。
337
メタデータ型
Flow
項目名
データ型
説明
assignmentItems
FlowAssignmentItem[]
インデックス 0 から開始して特定の順序で実行され
る、割り当て操作の配列。
connector
FlowConnector
この割り当てノードの後に実行するノードを指定しま
す。
FlowAssignmentItem
変数に適用する操作を定義します。FlowBaseElement を拡張し、その項目のすべてを継承します。
項目名
データ型
説明
assignToReference
string
必須。指定した演算子を適用する変数への参照。
operator
FlowAssignmentOperator (string 型の 必須。assignToReference 項目での変数参照に適用
列挙)
する操作。有効な値は、次のとおりです。
• Assign – assignToReference 項目の変数に指定
値を割り当てます。
• Add – assignToReference 項目の変数に指定値を
追加します。
• Subtract – assignToReference 項目の変数から
指定値を減算します。
value
FlowElementReferenceOrValue
assignToReference 項目の変数参照に演算子で適用
する値を定義します。
FlowChoice
選択肢リソースは、フロー全体で参照または再利用できるスタンドアロンの選択オプションです。FlowElement
を拡張し、その項目のすべてを継承します。
項目名
データ型
説明
choiceText
string
必須。画面に表示する選択肢の表示ラベル。
dataType
FlowDataType (string 型の列挙)
必須。有効な値は、次のとおりです。
• Currency
• Date
• Number
• String
• Boolean
338
メタデータ型
Flow
項目名
データ型
説明
userInput
FlowChoiceUserInput
選択肢が選択されたときに選択肢でユーザ入力を
許可できるようにします。複数選択肢項目ではサ
ポートされません。
value
FlowElementReferenceOrValue
割り当て、Apex プラグインへのコール、レコード
要素など、フロー実行時に使用される実際の値。
null の場合、この選択肢の値は常に null になりま
す。
FlowChoiceUserInput
ユーザが選択肢を選択したときに表示されるユーザ入力項目を、選択肢に含められるようにします。ユーザ入
力は複数選択肢項目ではサポートされません。FlowBaseElement を拡張し、その項目のすべてを継承します。
項目名
データ型
説明
isRequired
boolean
ユーザが選択肢を選択したときに、ユーザに項目への
入力を要求するかどうかを示します。
promptText
string
実行時にユーザに入力を要求するために表示されるテ
キスト。差し込み項目がサポートされます。
validationRule
FlowInputValidationRule
実行時にユーザ入力の検証に使用されるルール。
FlowCondition
ルールの条件を定義します。FlowBaseElement を拡張し、その項目のすべてを継承します。
項目名
データ型
説明
leftValueReference
string
必須。条件式の左側として機能する要素の一意
の名前。
operator
FlowComparisonOperator (string 型の 必須。有効な値は、次のとおりです。
列挙)
• EqualTo
• NotEqualTo
• GreaterThan
• LessThan
• GreaterThanOrEqualTo
• LessThanOrEqualTo
• StartsWith
• EndsWith
• Contains
339
メタデータ型
Flow
項目名
データ型
説明
• IsNull
• WasSet — この値は、API バージョン 30.0 以降
で使用できます。
• WasSelected — 左側に選択肢が必要です。
• WasVisited — 左側にノードが必要です。
条件式の右側の要素の一意の名前または実際の
値 (テキストや数値など)。
FlowElementReferenceOrValue
rightValue
FlowConnector
コネクタは、フローのノードの実行順序を決定します。コネクタは、後続ノードを定義してそれにリンクしま
す。FlowBaseElement を拡張し、その項目のすべてを継承します。
項目名
データ型
説明
targetReference
string
必須。現在のノードの完了後に実行するノード。
FlowConstant
定数リソースは、フロー全体で使用できる固定値を定義します。FlowElementを拡張し、その項目のすべてを継
承します。
項目名
データ型
説明
dataType
FlowDataType (string 型の列挙)
必須。有効な値は、次のとおりです。
• Currency
• Date
• Number
• String
• Boolean
value
FlowElementReferenceOrValue
定数のデフォルト値。この項目には、差し込み項目を設
定できません。また、$GlobalConstant.EmptyString
を除き、別のリソースを参照することもできません。
FlowDecision
一連のルールを評価し、最初に true と評価されたルールに基づいてフロー実行を転送する決定ノード。FlowNode
を拡張し、その項目のすべてを継承します。
340
メタデータ型
Flow
項目名
データ型
説明
defaultConnector
FlowConnector
true と評価されたルールがない場合に実行するノード
を指定します。
defaultConnectorLabel
string
デフォルトコネクタの表示ラベル。
rules
FlowRule[]
決定用のルールの配列。ルールはリストされた順序で
評価され、最初に true となったルールのコネクタが使
用されます。true のルールがない場合、デフォルトの
コネクタが使用されます。Cloud Flow Designerでは、ルー
ルは「結果」と呼ばれます。
FlowDynamicChoiceSet
実行時に sObject からデータを検索して動的に選択肢のセットを生成します。FlowElement を拡張し、その項目
のすべてを継承します。
メモ: フロー内で Geolocation 型の sObject カスタム項目を参照することはできません。たとえば、レコード
検索条件内、入力または出力項目の割り当て内で、または動的選択肢の表示項目、値項目、並び替え項
目として Geolocation 項目を使用することはできません。
項目名
データ型
説明
dataType
FlowDataType (string 型の列挙)
必須。有効な値は、次のとおりです。
• Currency
• Date
• Number
• String
• Boolean
displayField
string
必須。ユーザに選択肢表示ラベルとして表示す
る sObject の項目。
たとえば、取引先では、動的に生成される選択
肢をデータベースから取得したレコードの取引
先名として表示する場合、DisplayField "Name" を使
用します。
filters
FlowRecordFilter[]
データベースから取得したレコードに適用する
検索条件の配列。たとえば、指定日以降に作成
された取引先のみを含めるように取引先を絞り
込む場合などがあります。
341
メタデータ型
Flow
項目名
データ型
説明
limit
int
生成される選択肢のセットに含まれる選択肢の
最大数です。最大数とデフォルトの数は 200 で
す。
sortField と sortOrder も指定されている場
合、レコードは、limit が適用される前に並び
替えられます。
この項目は API バージョン 25.0 以降で使用できま
す。
object
string
必須。データベースから項目情報を取得して、
生成された選択肢のセットに使用する sObject。
たとえば、データベースの取引先レコードの情
報から選択肢を動的に生成するには、"Account"
を使用します。
outputAssignments
FlowOutputFieldAssignment[]
ユーザが選択したレコードの項目をフローの他
の場所で使用できる変数に割り当てる配列。た
とえば、ユーザが動的に生成された選択オプショ
ンのリストから取引先名を選択した場合、
outputAssignments はユーザが選択した取引先から
の ID と AnnualRevenue を指定した変数に割り当て
ることができます。
sortField
string
検索条件を満たすレコードを並び替えるために
使用される項目です。この項目が指定されてい
ない場合、返されるレコードは並び替えられま
せん。
SOAP API に明記されているとおり、Sort API 項目
プロパティを持つ項目でのみ、レコードを並び
替えることができます。
この項目は API バージョン 25.0 以降で使用できま
す。
sortOrder
SortOrder (string 型の列挙)
レコードの並び替え順です。この項目が指定さ
れていない場合、結果は並び替えられません。
有効な値は、次のとおりです。
• Asc — 昇順
• Desc — 降順
この項目は API バージョン 25.0 以降で使用できま
す。
342
メタデータ型
Flow
項目名
データ型
説明
valueField
string
選択肢の保存値。ユーザに選択オプションとし
て表示される値 (DisplayField) とは異なる場合があ
ります。たとえば、DisplayField が取引先の "Name"
で、valueField が取引先の "Id" になる場合がありま
す。
FlowElement
すべてのフロー要素の基本クラス。これは抽象クラスです。FlowBaseElement を拡張し、その項目のすべてを継
承します。
項目名
データ型
説明
description
string
フロー要素の説明。
name
string
必須。フロー要素の一意の名前。
FlowBaseElement
メタデータ値のコンテキスト情報を必要とするすべてのフロー要素の基本クラス。これは抽象クラスです。
FlowBaseElement は、API バージョン 32.0 以降で使用できます。
項目名
データ型
説明
processMetadataValues
FlowMetadataValue[]
要素のコンテキスト情報。
FlowMetadataValue
フローの要素間で渡されるコンテキスト情報を定義します。フローのメタデータ値は、フローを生成または消
費するアプリケーションで使用できます。FlowMetadataValue は、API バージョン 32.0 以降で使用できます。
項目名
データ型
説明
name
string
必須。メタデータ値の名前。この名前は要素全体で一
意である必要はありません。
value
FlowElementReferenceOrValue メタデータ値の参照または値。
FlowElementReferenceOrValue
既存の要素または指定した特定の値への参照を定義します。必ずいずれか 1 つの項目のみを指定してくださ
い。
343
メタデータ型
Flow
項目名
データ型
説明
booleanValue
boolean
boolean 値を指定するにはこの項目を使用します。異なるデータ
型または要素参照を指定する場合はこの項目を使用しないでく
ださい。
dateTimeValue
dateTime
dateTime 値を指定するにはこの項目を使用します。異なるデータ
型または要素参照を指定する場合はこの項目を使用しないでく
ださい。この項目は API バージョン 30.0 以降で使用できます。
dateValue
date
date 値を指定するにはこの項目を使用します。異なるデータ型ま
たは要素参照を指定する場合はこの項目を使用しないでくださ
い。
elementReference
string
既存の要素の名前を指定するにはこの項目を使用します。要素
参照の代わりに値を指定する場合はこの項目を使用しないでく
ださい。
numberValue
double
double 値を指定するにはこの項目を使用します。異なるデータ型
または要素参照を指定する場合はこの項目を使用しないでくだ
さい。
stringValue
string
string 値を指定するにはこの項目を使用します。異なるデータ型
または要素参照を指定する場合はこの項目を使用しないでくだ
さい。
FlowFormula
フローの関数と要素を使用して数値を計算します。FlowElement を拡張し、その項目のすべてを継承します。
項目名
データ型
説明
dataType
FlowDataType (string 型の 数式のデータ型。有効な値は、次のとおりです。
列挙)
• Boolean
• Currency
• Date
• DateTime
• Number
• String
dataType は、数式で定義されていない場合、デフォ
ルトの Number になります。
この項目は API バージョン 31.0 以降で使用できます。
expression
string
必須。Salesforce の数式。返される値は数値である必要
があります。Salesforce ヘルプの「フロー数式の概要」
を参照してください。
344
メタデータ型
Flow
項目名
データ型
説明
scale
int
返される値のスケール。特に、小数点以下の桁数。
FlowInputFieldAssignment
リソースまたは静的値に基づいてレコード項目の値を割り当てます。FlowBaseElement を拡張し、その項目のす
べてを継承します。
メモ: フロー内で Geolocation 型の sObject カスタム項目を参照することはできません。たとえば、レコード
検索条件内、入力または出力項目の割り当て内で、または動的選択肢の表示項目、値項目、並び替え項
目として Geolocation 項目を使用することはできません。
項目名
データ型
説明
field
string
必須。レコードの作成または更新中に値が割り当てら
れる項目の名前。
value
FlowElementReferenceOrValue
項目に割り当てられる値。
FlowInputValidationRule
入力規則は、ユーザが入力したデータが指定された要件を満たすことを検証します。入力規則の評価が false の
場合、指定されたエラーメッセージが表示されます。
項目名
データ型
説明
errorMessage
string
必須。formulaExpression が false と評価されたとき
に表示するエラーメッセージ。
formulaExpression
string
必須。ユーザ入力の検証に使用される boolean 数式。
Salesforce ヘルプの「フロー数式の概要」を参照してく
ださい。
FlowLoop
コレクションを反復処理するためのコンストラクタ。FlowNode を拡張し、その項目のすべてを継承します。
FlowLoop は、API バージョン 30.0 以降で使用できます。
項目名
データ型
説明
nextValueConnector
FlowConnector
コレクション内のエントリごとにフローの移動先となる要素を指
し示します。フローはコレクション内の次の値を処理するために
ここに移動します。
noMoreValuesConnector FlowConnector
コレクションのすべてのエントリのループが終了したときに移動
先となる要素を指し示します。
345
メタデータ型
項目名
Flow
データ型
説明
collectionReference string
必須。ループ対象のコレクション。
assignNextValueToReference string
必須。nextValueConnector の対象に移動する前に、コレクショ
ン内の現在の値が割り当てられる変数。
iterationOrder
iterationOrder
有効な値は、次のとおりです。
(string 型の列挙) •
Asc — 値がリストされている順序で (最初から最後へ)、コレク
ションを反復処理します。
• Desc — 値がリストされている順序と逆に (最後から最初へ)、
コレクションを反復処理します。
FlowNode
ノードは、フローダイアグラムに表示される要素の種別です。FlowElementを拡張し、その項目のすべてを継承
します。
項目名
データ型
説明
label
string
必須。ノードの名前。この一意ではない表示ラベルは、FlowElement
から継承される、ノードの一意の名前とは異なります。
locationX
int
必須。ノードの水平位置 (左からのピクセル数)。
locationY
int
必須。ノードの垂直位置 (上からのピクセル数)。
FlowOutputFieldAssignment
レコード項目の値を、レコードからフローの他の場所で使用できる変数に割り当てます。レコードは、レコー
ドの検索で選択される場合と、ユーザの選択によって選択される場合があります。FlowBaseElement を拡張し、
その項目のすべてを継承します。
メモ: フロー内で Geolocation 型の sObject カスタム項目を参照することはできません。たとえば、レコード
検索条件内、入力または出力項目の割り当て内で、または動的選択肢の表示項目、値項目、並び替え項
目として Geolocation 項目を使用することはできません。
項目名
データ型
説明
assignToReference
string
必須。レコード項目の値を保存する変数への参照。
field
string
必須。レコードの検索の後に値が割り当てられる項目
の名前。
346
メタデータ型
Flow
FlowRecordCreate
フローからの値を使用してデータベース内に新しいレコードを作成します。FlowNode を拡張し、そのプロパ
ティのすべてを継承します。
メモ: フローレコードの作成、ルックアップ、更新、および削除操作は、CRUD ベースのメタデータコー
ルである create()、retrieve()、update()、および delete() とは異なります。フローレコードメ
ソッドは、フロー内からレコード操作に適用されるため、CRUD 設定エンティティへのメタデータコール
の実行とは異なります。
フロー内で Geolocation 型の sObject カスタム項目を参照することはできません。たとえば、レコード検索
条件内、入力または出力項目の割り当て内で、または動的選択肢の表示項目、値項目、並び替え項目と
して Geolocation 項目を使用することはできません。
項目名
データ型
説明
assignRecordIdToReference string
レコードの作成後に ID を保存する変数への参
照。
connector
FlowConnector
レコードの作成後に実行するノードを指定し
ます。
faultConnector
FlowConnector
レコードを作成しようとしてエラーになった
場合に実行するノードを指定します。
inputAssignments
FlowInputFieldAssignment[]
作成中のレコードの指定された項目に値を割
り当てる配列。
object
string
必須。この要素によって作成されるレコード
の sObject
inputReference
string
項目値が新しいレコードの項目への入力に使
用される sObject 変数を指定します。
FlowRecordDelete
データベース内の 1 つ以上のレコードを削除します。FlowNode を拡張し、その項目のすべてを継承します。
メモ: フローレコードの作成、ルックアップ、更新、および削除操作は、CRUD ベースのメタデータコー
ルである create()、retrieve()、update()、および delete() とは異なります。フローレコードメ
ソッドは、フロー内からレコード操作に適用されるため、CRUD 設定エンティティへのメタデータコール
の実行とは異なります。
フロー内で Geolocation 型の sObject カスタム項目を参照することはできません。たとえば、レコード検索
条件内、入力または出力項目の割り当て内で、または動的選択肢の表示項目、値項目、並び替え項目と
して Geolocation 項目を使用することはできません。
項目名
データ型
説明
connector
FlowConnector
レコードの削除後に実行するノードを指定します。
347
メタデータ型
Flow
項目名
データ型
説明
faultConnector
FlowConnector
レコードを削除しようとしてエラーになった場合に実行す
るノードを指定します。
filters
FlowRecordFilter[]
データベースから削除されるレコードの選択に使用される
条件を指定する配列。たとえば、指定日以降に活動のない
取引先を削除する場合などがあります。
object
string
必須。レコードが削除されるオブジェクトの名前。
inputReference
string
レコード ID がデータベース内で削除するレコードの識別に
使用される sObject 変数を指定します。
FlowRecordFilter
データベースのレコードを検索する条件を設定します。FlowBaseElement を拡張し、その項目のすべてを継承し
ます。
メモ: フロー内で Geolocation 型の sObject カスタム項目を参照することはできません。たとえば、レコード
検索条件内、入力または出力項目の割り当て内で、または動的選択肢の表示項目、値項目、並び替え項
目として Geolocation 項目を使用することはできません。
項目名
データ型
説明
field
string
必須。レコードの絞り込みに使用される項目。
operator
FlowRecordFilterOperator (string 型の 必須。有効な値は、次のとおりです。
列挙)
• EqualTo
• NotEqualTo
• GreaterThan
• LessThan
• GreaterThanOrEqualTo
• LessThanOrEqualTo
• StartsWith
• EndsWith
• Contains
• IsNull
value
FlowElementReferenceOrValue
レコードを絞り込むために、項目および演算子と一緒
に使用される参照または値。
FlowRecordLookup
データベース内のレコードを検索し、その項目の値をフローで使用または保存します。FlowNodeを拡張し、そ
の項目のすべてを継承します。
348
メタデータ型
Flow
メモ: フローレコードの作成、ルックアップ、更新、および削除操作は、CRUD ベースのメタデータコー
ルである create()、retrieve()、update()、および delete() とは異なります。フローレコードメ
ソッドは、フロー内からレコード操作に適用されるため、CRUD 設定エンティティへのメタデータコール
の実行とは異なります。
フロー内で Geolocation 型の sObject カスタム項目を参照することはできません。たとえば、レコード検索
条件内、入力または出力項目の割り当て内で、または動的選択肢の表示項目、値項目、並び替え項目と
して Geolocation 項目を使用することはできません。
項目名
データ型
説明
レコードが見つからない場合にすべての値を
null に設定することを指定します。この項目は
API バージョン 30.0 以降で使用できます。
assignNullValuesIfNoRecordFound boolean
connector
FlowConnector
レコードルックアップの完了後に実行するノー
ドを指定します。
faultConnector
FlowConnector
レコードを検索しようとしてエラーになった場
合に実行するノードを指定します。
filters
FlowRecordFilter[]
データベースからのレコードの選択に使用する
条件を指定する配列。
検索条件で複数のレコードが返された場合、指
定された sortField と sortOrder に基づいて
並び替えられます。その後で、並び替えられた
リストの最初のレコードが選択されます。
sortField または sortOrder が指定されてい
ない場合、最初に返されたレコードが選択され
ます。ただし、レコードが返される順序は決まっ
ていません。
limit
int
返すレコードの最大数。受信するデータ量を制
限します。この項目は API バージョン 30.0 以降で
使用できます。
object
string
必須。レコードの選択元となる sObject の名前。
outputAssignments
FlowOutputFieldAssignment[]
選択されたレコードの項目を、フローの他の場
所で使用できる変数に割り当てる配列。
outputReference
string
クエリされた項目の値が保存される sObject 変数
を指定します。
queriedFields
string[]
選択されたレコードから指定された sObject 変数
に保存される項目を指定する配列。
sortField
string
検索条件を満たすレコードを並び替えるために
使用される項目です。この項目が指定されてい
349
メタデータ型
項目名
Flow
データ型
説明
ない場合、返されるレコードは並び替えられま
せん。
SOAP API に明記されているとおり、Sort API 項目
プロパティを持つ項目でのみ、レコードを並び
替えることができます。
この項目は API バージョン 25.0 以降で使用できま
す。
sortOrder
SortOrder (string 型の列挙)
レコードの並び替え順です。この項目が指定さ
れていない場合、結果は並び替えられません。
有効な値は、次のとおりです。
• Asc — 昇順
• Desc — 降順
この項目は API バージョン 25.0 以降で使用できま
す。
FlowRecordUpdate
データベース内のレコードを検索し、フローからの値で更新します。FlowNodeを拡張し、その項目のすべてを
継承します。
メモ: フローレコードの作成、ルックアップ、更新、および削除操作は、CRUD ベースのメタデータコー
ルである create()、retrieve()、update()、および delete() とは異なります。フローレコードメ
ソッドは、フロー内からレコード操作に適用されるため、CRUD 設定エンティティへのメタデータコール
の実行とは異なります。
フロー内で Geolocation 型の sObject カスタム項目を参照することはできません。たとえば、レコード検索
条件内、入力または出力項目の割り当て内で、または動的選択肢の表示項目、値項目、並び替え項目と
して Geolocation 項目を使用することはできません。
項目名
データ型
説明
connector
FlowConnector
レコード更新の完了後に実行するノードを指定し
ます。
faultConnector
FlowConnector
レコードを更新しようとしてエラーになった場合
に実行するノードを指定します。
filters
FlowRecordFilter[]
データベース内で更新するレコードの選択に使用
される条件を指定する配列。
inputAssignments
FlowInputFieldAssignment[]
更新されるレコードの指定項目に値を割り当てる
配列。
350
メタデータ型
Flow
項目名
データ型
説明
object
string
必須。レコードが更新される sObject の名前。
inputReference
string
項目値がレコードの項目の更新に使用される sObject
変数を指定します。
FlowRule
ルールが true と評価できる条件とロジックを定義します。FlowElement を拡張し、その項目のすべてを継承しま
す。
項目名
データ型
説明
conditionLogic
string
"and" または "or" のいずれかの値にできます。"and" に設
定すると、ルールの条件がすべて true と評価された場
合にのみルールが true と評価されます。"or" に設定し
た場合、ルールの条件のいずれかが true と評価された
場合にルールが true と評価されます。
conditions
FlowCondition[]
ルールの条件の配列。
connector
FlowConnector
決定でこのルールが最初に true と評価されたルールで
ある場合に実行するノードを指定します。
label
string
必須。コネクタの表示ラベル。
FlowScreen
画面は、ユーザから情報を収集してユーザに情報を表示する機能を提供します。FlowNodeを拡張し、その項目
のすべてを継承します。
項目名
データ型
説明
allowBack
boolean
実行時に[前へ]ボタンを画面に表示するか (true)、非表
示にするか (false) を示します。true の場合、[前へ] ボタ
ンは、ユーザがフローパスで前の画面にアクセスした
場合にのみ表示されます。クレジットカードトランザ
クションなど、前の画面に再アクセスした場合に繰り
返してはいけないアクションが起動されてしまう場合
は、false に設定します。
この項目は API バージョン 26.0 以降で使用できます。
デフォルトは true です。
allowBack と allowFinish のいずれかを false に設
定できますが、両方を設定することはできません。
351
メタデータ型
Flow
項目名
データ型
説明
allowFinish
boolean
実行時に[完了]ボタンを画面に表示するか (true)、非表
示にするか (false) を示します。true の場合、[完了] ボタ
ンは、画面要素がフローパスの最後である場合にのみ
表示されます。ユーザが前の画面に戻ってフローを続
行または完了させる必要がある場合は、これを false に
設定します。たとえば、ユーザに前の画面に戻って修
正するように指示する画面に [完了] ボタンは表示しま
せん。
この項目は API バージョン 26.0 以降で使用できます。
デフォルトは true です。
allowBack と allowFinish のいずれかを false に設
定できますが、両方を設定することはできません。
connector
FlowConnector
画面ノードの後に実行するノードを指定します。
fields
FlowScreenField[]
画面に表示する項目の配列。
helpText
string
エンドユーザが [このフォームのヘルプ] リンクをク
リックした場合に表示されるテキスト。
APIバージョン 26.0 以降で差し込み項目をサポートしま
す。
FlowScreenField
画面上の設定可能な項目。FlowElement を拡張し、その項目のすべてを継承します。
項目名
データ型
説明
choiceReferences
string[]
FlowChoices または FlowDynamicChoiceSets
への参照の配列。作成される選択オプ
ションは、この配列で指定した順序で
表示されます。インデックス 0 の要素
が最上位の選択オプションになりま
す。次の型の画面項目でサポートされ
ています。
• RadioButtons
• DropdownBox
• MultiSelectCheckboxes
• MultiSelectPicklist
352
メタデータ型
項目名
Flow
データ型
説明
複数選択チェックボックスおよび複数
選択リスト項目は、APIバージョン 26.0
以降で使用できます。
dataType
FlowDataType (string 型の列挙)
必須。この画面項目のデータ型。
InputField、RadioButtons、および
DropdownBox 型の画面項目でのみサ
ポートされます。有効な値は、次のと
おりです。
• Currency
• Date
• Number
• String
• Boolean
boolean の InputField は、実行時にチェッ
クボックス項目として表示されます。
チェックボックス入力項目は、APIバー
ジョン 26.0 以降で使用できます。
複数選択チェックボックスおよび複数
選択リスト項目では、string データ型
のみがサポートされます。複数選択項
目は、API バージョン 26.0 以降で使用
できます。
画面項目のデフォルト値として使用さ
れる FlowChoice 要素の名前。次の型の
画面項目でサポートされています。
defaultSelectedChoiceReference string
• RadioButtons
• DropdownBox
• MultiSelectCheckboxes
• MultiSelectPicklist
DropDownBox データ型についてのみ、
defaultSelectedChoiceReference が空か null
の場合、choiceReferences のインデック
ス 0 での参照がデフォルト値として使
用されます。
複数選択チェックボックスおよび複数
選択リスト項目では、デフォルト値と
して FlowChoice 要素を 1 つのみ指定で
きます。複数選択項目は、APIバージョ
ン 26.0 以降で使用できます。
353
メタデータ型
Flow
項目名
データ型
説明
defaultValue
FlowElementReferenceOrValue
この画面項目がユーザに入力を要求し
たときにデフォルトで使用される値。
InputField、LargeTextArea、および
PasswordField でのみサポートされます。
fieldText
string
画面に表示される項目の表示ラベル。
差し込み項目がサポートされます。
fieldType
FlowScreenFieldType (string 型の列 必須。有効な値は、次のとおりです。
挙)
• DisplayText
• InputField
• LargeTextArea
• PasswordField
• RadioButtons
• DropdownBox
• MultiSelectCheckboxes
• MultiSelectPicklist
実行時、各複数選択項目には、その項
目値がユーザが選択した選択肢の値を
セミコロンで区切った結合値として保
存されます。選択した選択肢の値内の
セミコロンは、複数選択項目値に追加
されるときに削除されます。
複数選択チェックボックスおよび複数
選択リスト項目は、APIバージョン 26.0
以降で使用できます。
helpText
string
必須。エンドユーザが画面項目のヘル
プアイコン ( ) をクリックした場合
に表示されるテキスト。
API バージョン 26.0 以降で差し込み項
目をサポートします。
isRequired
boolean
ユーザが選択肢を選択する必要がある
か、または入力する必要があるかを示
します。DisplayText または boolean の
inputField ではサポートされません。
scale
int
データ型が number または currency の場
合のこの画面項目のスケール。スケー
ルは、小数点以下の桁数を設定しま
す。
354
メタデータ型
Flow
項目名
データ型
説明
validationRule
FlowInputValidationRule
この画面項目が InputField、
LargeTextArea、または PasswordField 型の
場合、ユーザ入力の検証に使用される
ルール。
FlowStep
フローの作成時にプレースホルダとして機能するステップ。FlowNodeを拡張し、その項目のすべてを継承しま
す。
項目名
データ型
説明
connectors
FlowConnector[]
ステップノードの後に実行するノードを指定します。
FlowSubflow
サブフロー要素は、実行時にコールする別のフローを参照します。サブフロー要素を含むフローは、マスタフ
ローとして参照されます。FlowSubflow は、FlowNode を拡張し、その項目のすべてを継承します。API バージョ
ン 25.0 以降で使用できます。
項目名
データ型
説明
connector
FlowConnector
サブフローの後に実行するノードを指定しま
す。
flowName
string
実行時にコールするフローを参照します。値
はフローの一意の名前である必要があり、ハ
イフンやバージョン番号を付記することはで
きません。参照されるフローは、Cloud Flow
Designerで作成されたものである必要がありま
す。
inputAssignments
FlowSubflowInputAssignment[]
参照されるフローの開始時に設定される入力
変数割り当ての配列。
outputAssignments
FlowSubflowOutputAssignment[]
参照されるフローの終了時に設定される出力
変数割り当ての配列。
FlowSubflowInputAssignment
参照されるフローの変数にマスタフローの要素または値を割り当てます。入力割り当ては、参照されるフロー
をサブフローがコールするときに行われます。FlowBaseElementを拡張し、その項目のすべてを継承します。API
バージョン 25.0 以降で使用できます。
355
メタデータ型
Flow
項目名
データ型
説明
name
string
必須。参照されるフロー内の変数の一意の名
前。
value
FlowElementReferenceOrValue
変数に割り当てる値を定義します。
FlowSubflowOutputAssignment
参照されるフローの変数の値をマスタフローの変数に割り当てます。出力割り当ては、参照されるフローの実
行が終了するときに行われます。FlowBaseElement を拡張し、その項目のすべてを継承します。API バージョン
25.0 以降で使用できます。
項目名
データ型
説明
assignToReference
string
必須。マスタフローの変数の一意の名前。
name
string
必須。参照されるフロー内の変数の一意の名前。
FlowTextTemplate
フロー全体で使用できるテキストテンプレートを定義します。FlowElementを拡張し、その項目のすべてを継承
します。
項目名
データ型
説明
text
string
テンプレートの実際のテキスト。差し込み項目がサ
ポートされます。
FlowVariable
フロー内で使用する更新可能な値を作成できるようにする変数。FlowVariable は FlowElement を拡張し、その項目
のすべてを継承します。
項目名
データ型
説明
dataType
FlowDataType (string 型の列挙)
必須。有効な値は、次のとおりで
す。
• Currency
• Date
• Number
• String
• Boolean
• sObject
356
メタデータ型
項目名
Flow
データ型
説明
• DateTime — このデータ型は、
API バージョン 30.0 以降で使用で
きます。
isCollection
変数が値のコレクションかどうか
を示します。この項目は、API バー
ジョン 30.0 以降で使用できます。
API バージョン 32.0 以降では、コレ
クション変数を任意のデータ型に
できます。
boolean
デフォルト値は False です。
isInput
boolean
URL パラメータ、Visualforce コント
ローラ、またはサブフロー入力を
使用して、フローの開始時に変数
を設定できるかを示します。この
項目は API バージョン 25.0 以降で使
用できます。
デフォルト値は次のとおりです。
• False: API バージョン 25.0 以降ま
たは Cloud Flow Designer の Summer
'12 以降で作成された変数の場合
• True: API バージョン 24.0 または
Cloud Flow Designer の Summer '12
より前のバージョンで作成され
た変数の場合
警告: 既存の変数の入力また
は出力アクセスを無効にする
と、URL パラメータ、Visualforce
コントローラ、およびサブフ
ローによってフローをコール
し、変数にアクセスするアプ
リケーションとページの機能
に影響する可能性がありま
す。
isOutput
boolean
Visualforce コントローラやその他の
フローから変数の値にアクセスで
きるかどうかを示します。この項
目は API バージョン 25.0 以降で使用
できます。
357
メタデータ型
項目名
Flow
データ型
説明
デフォルト値は次のとおりです。
• False: API バージョン 25.0 以降ま
たは Cloud Flow Designer の Summer
'12 以降で作成された変数の場合
• True: API バージョン 24.0 または
Cloud Flow Designer の Summer '12
より前のバージョンで作成され
た変数の場合
警告: 既存の変数の入力また
は出力アクセスを無効にする
と、URL パラメータ、Visualforce
コントローラ、およびサブフ
ローによってフローをコール
し、変数にアクセスするアプ
リケーションとページの機能
に影響する可能性がありま
す。
objectType
string
データ型が sObject の場合のこの変
数のオブジェクト種別。
scale
int
データ型が Number または Currency
の場合のこの変数のスケール。
value
FlowElementReferenceOrValue
この変数のデフォルト値。
FlowWait
1 つ以上の定義済みイベントが発生するまで待機します。FlowWaiは、FlowNodeを拡張し、その項目のすべてを
継承します。FlowWait は、API バージョン 32.0 以降で使用できます。
項目名
データ型
説明
defaultConnector
FlowConnector
待機要素の各イベントの条件が false
の場合に実行するノードを指定し
ます。
defaultConnectorLabel
string
デフォルトコネクタの表示ラベル。
faultConnector
FlowConnector
待機しようとしてエラーが発生し
た場合に実行するノードを指定し
ます。いずれかの待機イベントに
失敗すると、フローは障害コネク
タを使用します。
358
メタデータ型
Flow
項目名
データ型
説明
waitEvents
FlowWaitEvent[]
待機要素が待機しているイベント
の配列。
各イベントの状況が false と評価
されると、defaultConnector が
使用されます。
FlowWaitEvent
FlowWait 要素が待機しているイベント。FlowWaitEvent は、FlowElement を拡張し、その項目のすべてを継承しま
す。FlowWaitEvent は、API バージョン 32.0 以降で使用できます。
項目名
データ型
説明
conditionLogic
string
and と or のいずれかの値を使用で
きます。and に設定した場合は、
条件がすべて true と評価された場合
にのみイベントの条件が満たされ
ます。or に設定した場合は、いず
れかの条件が true と評価された場合
にイベントの条件が満たされます。
conditions
FlowCondition
フローがこのイベントを待機する
ために true である必要がある条件の
配列。
connector
FlowConnector
これが最初に発生したイベントで
ある場合に実行するノードを指定
します。
eventType
string
必須。イベントの種別。この種別
によって、このイベントの定義に
使用できる入力パラメータが決ま
ります。有効な値は、次のとおり
です。
• AlarmEvent — このイベント
は、絶対日付/時間値のアラーム
ベースのオフ設定です。
• DateRefAlarmEvent — このイ
ベントは、レコードの日付/時間
項目のアラームベースのオフ設
定です。
359
メタデータ型
Flow
項目名
データ型
説明
inputParameters
FlowWaitEventInputParameter[]
イベントの入力パラメータの配列。
パラメータ値は、フローからの値
を使用して設定されます。
label
string
必須。待機イベントの表示ラベル。
outputParameters
FlowWaitEventOutputParameter[]
将来の使用のために予約されてい
ます。
FlowWaitEventInputParameter
FlowWaitEventの入力パラメータ。パラメータの値は、フローからの値を使用して設定されます。FlowBaseElement
を拡張し、その項目のすべてを継承します。FlowWaitEventInputParameter は、API バージョン 32.0 以降で使用でき
ます。
項目名
データ型
説明
name
string
必須。入力パラメータの一意の名
前。
value
FlowElementReferenceOrValue
入力パラメータの値を定義します。
宣言的なメタデータの定義のサンプル
フローの 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>
<numberValue>20.0</numberValue>
</value>
</choices>
<choices>
<name>Fair</name>
<choiceText>Fair</choiceText>
<dataType>Number</dataType>
360
メタデータ型
Flow
<value>
<numberValue>10.0</numberValue>
</value>
</choices>
<choices>
<name>Good</name>
<choiceText>Good</choiceText>
<dataType>Number</dataType>
<value>
<numberValue>15.0</numberValue>
</value>
</choices>
<description>Simple Flow app to calculate a Tip according to corporate
policies</description>
<formulas>
<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>
361
メタデータ型
Folder
</fields>
</screens>
<screens>
<name>TipAmount</name>
<label>Tip Amount</label>
<locationX>518</locationX>
<locationY>266</locationY>
<fields>
<name>TipSUmmary</name>
<fieldText>&lt;TEXTFORMAT
LEADING=&quot;2&quot;&gt;&lt;P
ALIGN=&quot;LEFT&quot;&gt;&lt;FONT
FACE=&quot;Arial&quot;
STYLE=&quot;font-size:12px&quot;
COLOR=&quot;#000000&quot;
LETTERSPACING=&quot;0&quot;
KERNING=&quot;0&quot;&gt;If you think the quality of
service is &lt;FONT
KERNING=&quot;1&quot;&gt;{!Service_Quality},
&lt;/FONT&gt;for a meal of {!Bill_Amount} you should tip
{!fTipAmount}, so the total recommended amount should be
{!fTotalAmount}&lt;/FONT&gt;&lt;/P&gt;&lt;/TEXTFORMAT&gt;</fieldText>
<fieldType>DisplayText</fieldType>
</fields>
</screens>
<startElementReference>Simple_Tip_Calculator</startElementReference>
</Flow>
Folder
フォルダを表します。Metadata メタデータ型を拡張し、その fullName 項目を継承します。Salesforce には、現
在次の 4 つのフォルダの種類があります。
• ドキュメントフォルダ
• メールテンプレートフォルダ
• レポートフォルダ
• ダッシュボードフォルダ
ファイルのサフィックスおよびディレクトリの場所
フォルダは、パッケージの対応するコンポーネントディレクトリに保存されます。これらのディレクトリには
それぞれ documents、email、reports、dashboards という名前が付いています。 フォルダは、ファイル
のコンテナであるため、テキストファイル表記がありません。各フォルダには、同じディレクトリレベルに
FolderName-meta.xml という名前の付随するメタデータファイルが作成されます。FolderName-meta.xml
メタデータファイルには、accessTypeなど、そのフォルダのメタデータ情報が含まれます。たとえば、
sampleFolder という名前のドキュメントフォルダの場合は、パッケージの documents フォルダ内に
sampleFolder-meta.xml があります。
362
メタデータ型
Folder
バージョン
フォルダは、API バージョン 11.0 以降で使用できます。
項目
このメタデータ型には、次の項目が含まれます。
項目名
データ型
説明
accessType
FolderAccessTypes 必須。このフォルダのアクセス権の種類。有効な値は、次
(string 型の列挙) のとおりです。
• Shared。このフォルダには、指定されたユーザのセッ
トのみがアクセス可能です。
• Public。このフォルダには、ポータルユーザを含むす
べてのユーザがアクセス可能です。
• PublicInternal。このフォルダには、ポータルユー
ザを除くすべてのユーザがアクセス可能です。この設
定は、パートナーポータルまたはカスタマーポータル
が有効な組織のレポートおよびダッシュボードフォル
ダにのみ使用できます。
• Hidden。このフォルダは、すべてのユーザに対して非
表示になります。
fullName
string
API アクセスの一意の識別子として使用される名前。
fullName には、アンダースコアと英数字のみを使用でき
ます。一意であること、最初は文字であること、空白は使
用しない、最後にアンダースコアを使用しない、2 つ続け
てアンダースコアを使用しないという制約があります。こ
の項目は、Metadata コンポーネントから継承されていま
す。
name
string
必須。ドキュメントフォルダの名前。
publicFolderAccess
PublicFolderAccess Public が accessType の値である場合、この項目はすべ
(string 型の列挙) てのユーザがフォルダのコンテンツに対して持つアクセス
権の種類を示します。使用できる値は次のとおりです。
• ReadOnly。すべてのユーザがフォルダのコンテンツを
読み取ることができますが、コンテンツを変更するこ
とはできません。
• ReadWrite。すべてのユーザがフォルダのコンテンツ
を読み取りと変更を行うことができます。
sharedTo
SharedTo
フォルダの共有アクセス権。Salesforceオンラインヘルプの
「共有に関する考慮事項」を参照してください。
363
メタデータ型
FolderShare
宣言的なメタデータの定義のサンプル
ドキュメントが含まれるドキュメントフォルダのパッケージマニフェスト定義を次に示します。
<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<fullName>basic</fullName>
<types>
<members>sampleFolder</members>
<members>sampleFolder/TestDocument.txt</members>
<name>Document</name>
</types>
<version>32.0</version>
</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>
関連トピック:
Dashboard
Document
EmailTemplate
Report
FolderShare
拡張分析フォルダの共有設定を表します。レポートまたはダッシュボードを含むフォルダへの閲覧者、エディ
タまたはマネージャアクセス権を他のユーザに付与することにより、レポートまたはダッシュボードへのアク
セスを制御できます。
ファイルのサフィックスおよびディレクトリの場所
FolderShare オブジェクトは、reports ディレクトリと dashboards ディレクトリに保存されます。ディレク
トリに含まれるレポートフォルダまたはダッシュボードフォルダごとに、FolderName-meta.xml という名
前のメタデータファイルがあります。FolderName-meta.xml メタデータファイルには、accessLevelなど、
そのフォルダのメタデータ情報が含まれます。たとえば、reports ディレクトリに myReportsFolder とい
うレポートフォルダがある場合、myReportsFolder と同じレベルに myReportsFolder-meta.xml ファイ
ルもあります。
バージョン
FolderShare コンポーネントは、API バージョン 28 以降で使用できます。
364
メタデータ型
FolderShare
項目
項目名
データ型
説明
accessLevel
FolderShareAccessLevel (string 型 必須。フォルダで実行できるアクションの組み合わせを
の列挙)
指定します。有効な値は、次のとおりです。
• View。レポートの実行やダッシュボードの更新はで
きますが、それらを編集することはできません。すべ
てのユーザは、共有されているレポートフォルダと
ダッシュボードフォルダに対して、少なくとも閲覧者
アクセス権を持っています (ユーザによっては、より
幅広いアクセスが可能なシステム管理者権限を持って
いる場合もあります)。
• EditAllContents。ユーザは、フォルダ内のレポー
トまたはダッシュボードを表示および変更でき、同等
のアクセス権を持つ他のフォルダとの間を移動させる
こともできます。
• Manage。閲覧者とエディタに許可されたすべての操
作を実行でき、フォルダへの他のユーザからのアクセ
スも制御できます。
sharedTo
string
必須。フォルダに対して指定されたアクセス権を持つユー
ザ、グループ、またはロールを指定します。
sharedToType
FolderSharedToType (string 型の 必須。フォルダを共有するエンティティの種別を指定し
列挙)
ます。有効な値は、次のとおりです。
• Group。指定された公開グループに属するユーザに、
フォルダに指定されたアクセス権が付与されます。
• Manager。API バージョン 29.0 以降で利用できます。
• ManagerAndSubordinatesInternal。API バージョ
ン 29.0 以降で利用できます。
• Role。指定されたロールを持つユーザに、フォルダ
に指定されたアクセス権が付与されます。
• RoleAndSubordinates。指定されたロール持つユー
ザと、その下位ロールを持つユーザに、フォルダに指
定されたアクセス権が付与されます。
• RoleAndSubordinatesInternal。公開ポータルユー
ザである場合を除き、指定されたロール持つユーザ
と、その下位ロールを持つユーザに、フォルダに指定
されたアクセス権が付与されます。
• Organization。すべての内部ユーザに、フォルダに
指定されたアクセス権が付与されます。
365
メタデータ型
項目名
FolderShare
データ型
説明
• 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>
</folderShares>
</DashboardFolder>
366
メタデータ型
Group
次に、レポートフォルダの 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 以降で使用できます。
項目
このメタデータ型はグループを定義する有効な値を表します。
項目名
データ型
説明
doesIncludeBosses
boolean
グループのメンバーと共有されたレコードに、マネージャ
がアクセスできるか (true)、否か (false) を示します。こ
の項目は公開グループにのみ使用できます。
fullName
string
APIアクセスの一意の識別子。fullName には、アンダース
コアと英数字のみを使用できます。一意であること、最初
は文字であること、空白は使用しない、最後にアンダース
コアを使用しない、2 つ続けてアンダースコアを使用しな
いという制約があります。この項目は、Metadata コンポー
ネントから継承されています。ユーザインターフェースの
[グループ名] に対応します。
name
string
必須。グループの名前。ユーザインターフェースの [表示
ラベル] に対応します。
367
メタデータ型
HomePageComponent
宣言的なメタデータの定義のサンプル
グループの定義を次に示します。
<?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
このメタデータ型はホームページコンポーネントを定義する有効な値を表します。
項目名
データ型
説明
body
string
これが HTML ページコンポーネントである場合、これは HTML
の本文です。
fullName
string
名前には、英数字、およびアンダースコア (_) 文字のみを
使用できます。また、最初は文字とし、最後にアンダース
368
メタデータ型
項目名
HomePageComponent
データ型
説明
コアを使用したり、連続した 2 つのアンダースコア文字を
含めたりすることはできません。
この項目はMetadata コンポーネントから継承するため、こ
の項目はこのコンポーネントの WSDL で定義されません。
作成時、更新時、または削除時に指定する必要がありま
す。コールにおけるこの項目の例を確認するには、
「create()」を参照してください。
height
int
Visualforceエリアコンポーネントで必須。コンポーネントの
高さ (ピクセル単位) を示します。
この項目は API バージョン 31.0 以降で使用できます。
links
string[]
pageComponentType が links の場合は、カスタムペー
ジリンクの 0 個以上の名前を指定できます。
• ObjectWebLink
• CustomPageWebLink
page
string
この項目は Visualforce エリアコンポーネントでのみ使用可
能で、コンポーネントに関連付けられているVisualforceペー
ジの API 名を示します。
この項目は API バージョン 31.0 以降で使用できます。
pageComponentType
PageComponentType 必須。有効な値は、次のとおりです。
(string 型の列挙)
• links
• htmlArea
• imageOrNote
• visualforcePage (この値は API バージョン 31.0 以降で
使用できます)。
showLabel
boolean
この項目は Visualforce エリアコンポーネントでのみ使用可
能で、コンポーネントがラベル付きで表示されるか(true)、
否か (false) を指定します。
この項目は API バージョン 31.0 以降で使用できます。
showScrollbars
boolean
この項目は Visualforce エリアコンポーネントでのみ使用可
能で、コンポーネントがスクロールバー付きで表示される
か (true)、否か (false) を指定します。
この項目は API バージョン 31.0 以降で使用できます。
width
PageComponentWidth この項目は HTML および Visualforce エリアコンポーネントで
(string 型の
のみ使用可能で、これが幅の狭いまたは広いホームページ
enumeration)
369
メタデータ型
項目名
HomePageLayout
データ型
説明
コンポーネントであるかどうかを示します。有効な値は、
次のとおりです。
• 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>
<width>wideComponents</width>
</HomePageComponent>
関連トピック:
HomePageLayout
Weblink
HomePageLayout
ホームページのレイアウトに関連付けられたメタデータを表します。ホームページのレイアウトをカスタマイ
ズし、ユーザのプロファイルに基づいてユーザにレイアウトを割り当てることができます。詳細は、Salesforce
オンラインヘルプの「[ホーム] タブのページレイアウトのカスタマイズ」を参照してください。
ファイルのサフィックスおよびディレクトリの場所
ホームページのレイアウトは、対応するパッケージディレクトリの homePageLayouts ディレクトリに保存
されます。拡張子は .homePageLayout です。
バージョン
ホームページコンポーネントは、API バージョン 12.0 以降で使用できます。Metadata メタデータ型を拡張し、そ
の fullName 項目を継承します。
370
メタデータ型
InstalledPackage
項目
このメタデータ型はホームページのレイアウトを定義する有効な値を表します。
項目名
データ型
説明
fullName
string
名前には、英数字、およびアンダースコア (_) 文字のみを
使用できます。また、最初は文字とし、最後にアンダース
コアを使用したり、連続した 2 つのアンダースコア文字を
含めたりすることはできません。
この項目はMetadata コンポーネントから継承するため、こ
の項目はこのコンポーネントの WSDL で定義されません。
作成時、更新時、または削除時に指定する必要がありま
す。コールにおけるこの項目の例を確認するには、
「create()」を参照してください。
narrowComponents
string[]
ホームページの左側の幅の狭い列の要素のリスト。
wideComponents
string[]
ホームページの右側の幅の広い列の要素のリスト。
宣言的なメタデータの定義のサンプル
ホームページのレイアウトの定義を次に示します。関連するサンプルについては、「HomePageComponent」の
「宣言的なメタデータの定義のサンプル」 (ページ370)および「Weblink」の「宣言的なメタデータの定義のサン
プル」 (ページ 258)を参照してください。
<?xml version="1.0" encoding="UTF-8"?>
<HomePageLayout xmlns="http://soap.sforce.com/2006/04/metadata">
<narrowComponents>google</narrowComponents>
</HomePageLayout>
関連トピック:
HomePageComponent
Weblink
InstalledPackage
インストールまたはアンインストールするパッケージを表します。現在インストールされているパッケージの
新バージョンをリリースすると、パッケージがアップグレードされます。
メモ: 他のメタデータ型とともにパッケージをリリースすることはできません。このため、マニフェスト
ファイルで指定されているメタデータ型は InstalledPackage のみである必要があります。
371
メタデータ型
Layout
ファイルのサフィックスおよびディレクトリの場所
パッケージは、installedPackages ディレクトリに、パッケージの名前空間プレフィックスが付いたファイ
ル名で指定されます。ファイルの拡張子は .installedPackage です。
バージョン
InstalledPackage は、API バージョン 28.0 以降で使用できます。
項目
項目名
データ型
説明
versionNumber
string
パッケージのバージョン番号。形式は
majorNumber.minorNumber.patchNumber (2.1.3 など) で
す。
password
string
パッケージのパスワードを指定する項目 (省略可能)。
宣言的なメタデータの定義のサンプル
次の例は、インストールまたはアンインストールするパッケージを指定します。
<?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>
Layout
ページレイアウトに関連付けられたメタデータを表します。詳細は、Salesforceオンラインヘルプの「ページレ
イアウトの管理」を参照してください。Metadata メタデータ型を拡張し、その fullName 項目を継承します。
メモ: アイデアレイアウトを編集する場合、package.xml ファイルでこのアイデアレイアウトを名前で
指定する必要があります。package.xml では、次のコードを使用してアイデアレイアウトを取得しま
す。
<types>
<members>Idea-Idea Layout</members>
<name>Layout</name>
</types>
372
メタデータ型
Layout
ファイルのサフィックスおよびディレクトリの場所
レイアウトは、対応するパッケージディレクトリの layouts ディレクトリに保存されます。拡張子は .layout
です。
メモ: プロジェクトでこのメタデータ型のコンポーネントを取得すると、同じパッケージで取得された
Profile コンポーネントおよび PermissionSet コンポーネントにこのコンポーネントが表示されるようになり
ます。
バージョン
レイアウトは、API バージョン 13.0 以降で使用できます。
項目
このメタデータ型は、ページレイアウトを定義する有効な値を表します。
項目名
データ型
説明
customButtons
string[]
このレイアウトのカスタムボタン。各ボタン
は、同一オブジェクト上の Weblink への参照で
す。たとえば、ButtonLink は「ButtonLink」という
名前の同一の標準オブジェクトまたはカスタム
オブジェクトの Web リンクを参照します。
customConsoleComponents
CustomConsoleComponents ページレイアウト上にあるカスタムコンソール
コンポーネント (Visualforce ページ、参照項目、
または関連リスト。Force.com Canvas アプリケー
ションは使用不可) を表します。カスタムコン
ソールコンポーネントは、Salesforce コンソール
にのみ表示されます。
emailDefault
boolean
showEmailCheckbox が設定されている場合に
のみ該当します。そのチェックボックスのデ
フォルト値を示します。
excludeButtons
string[]
このレイアウトから除外する標準ボタンのリス
ト。たとえば、
<excludeButtons>Delete</excludeButtons>
ではこのレイアウトから [削除] ボタンを除外し
ます。
feedLayout
FeedLayout
フィードベースのページレイアウトのフィード
ビューを定義する値を表します。フィードベー
スのレイアウトは、取引先、ケース、取引先責
任者、リード、商談、およびカスタムオブジェ
クトで使用できます。フィードビューと詳細
ビューが含まれます。
373
メタデータ型
Layout
項目名
データ型
説明
headers
LayoutHeader[] (string 型の レイアウトヘッダーは現在タギングのみに使用
列挙)
されており、タギングが有効になっている場合
にのみ UI に表示されます。詳細は、Salesforce オ
ンラインヘルプの「タグの概要」を参照してく
ださい。有効な string 値は次のとおりです。
• PersonalTagging — タグはユーザには非
公開です。
• PublicTagging — レコードにアクセスでき
る他のすべてのユーザがタグを参照できま
す。
layoutSections
LayoutSection[]
項目、Sコントロール、およびカスタムリンク
を含むレイアウトのメインセクション。ここで
の順序はレイアウトの順序を決定します。
miniLayout
MiniLayout
ミニレイアウトは、[コンソール] タブ、詳細の
フロート表示、行動のフロート表示でのレコー
ドのミニビューで使用されます。
multilineLayoutFields
string[]
OpportunityProduct レイアウトで表示される特殊
な複数行レイアウト項目の項目。その他の点で
は、これらは、miniLayoutFields の
miniLayout と似ています。
quickActionList
QuickActionList
ページレイアウトに関連付けられたアクション
のリスト。この項目は API バージョン 28.0 以降
で使用できます。
relatedContent
RelatedContent
ページレイアウトの関連コンテンツセクショ
ン。この項目は API バージョン 29.0 以降で使用
できます。
relatedLists
RelatedListItem[]
レイアウトの関連リスト。ユーザインター
フェースに表示される順序で表示されます。
relatedObjects
string[]
コンソールのミニビューに表示される関連オブ
ジェクトのリスト。データベース用語では、こ
れらはレイアウトのオブジェクトの外部キー項
目です。詳細は、Salesforce オンラインヘルプの
「エージェントコンソールのミニビューの関連
オブジェクトの選択」を参照してください。
runAssignmentRulesDefault
boolean
showRunAssignmentRulesCheckbox が設定さ
れている場合にのみ該当します。そのチェック
ボックスのデフォルト値を示します。
374
メタデータ型
Layout
項目名
データ型
説明
showEmailCheckbox
boolean
ケース、CaseClose、および ToDo レイアウトでの
み使用可能。設定されている場合、メールを表
示するためのチェックボックスが表示されま
す。
showHighlightsPanel
boolean
設定されている場合、強調表示パネルがSalesforce
コンソールのページに表示されます。この項目
は、API バージョン 22.0 以降で使用できます。
showInteractionLogPanel
boolean
設定されている場合、相互関係ログが Salesforce
コンソールのページに表示されます。この項目
は、API バージョン 22.0 以降で使用できます。
showKnowledgeComponent
boolean
ケースレイアウトでのみ使用可能。設定されて
いる場合、ナレッジサイドバーが Salesforce コン
ソールのケースに表示されます。この項目は、
API バージョン 20.0 以降で使用できます。
showRunAssignmentRulesCheckbox boolean
リードオブジェクトおよび Case オブジェクトで
のみ使用可能。設定されている場合、割り当て
ルールを表示するためのチェックボックスが
ページに表示されます。
showSolutionSection
boolean
CaseCloseレイアウトでのみ使用可能。設定され
ている場合、組み込みのソリューション情報セ
クションがページに表示されます。
showSubmitAndAttachButton
boolean
ケースレイアウトでのみ使用可能。設定されて
いる場合、[登録 & ファイルを添付] ボタンは、
カスタムポータルのポータルユーザのケース編
集ページに表示されます。
CustomConsoleComponents
ページレイアウト上にあるカスタムコンソールコンポーネント (Visualforce ページ、参照項目、または関連リス
ト。Force.com Canvasアプリケーションは使用不可) を表します。カスタムコンソールコンポーネントは、Salesforce
コンソールにのみ表示されます。API バージョン 25.0 以降で利用できます。
項目名
データ型
説明
primaryTabComponents
PrimaryTabComponents Salesforce コンソールの主タブにあるカスタムコンソールコ
ンポーネントを表します。API バージョン 25.0 以降で利用
できます。
375
メタデータ型
Layout
項目名
データ型
説明
subtabComponents
SubtabComponents
Salesforce コンソールのサブタブにあるカスタムコンソール
コンポーネントを表します。API バージョン 25.0 以降で利
用できます。
PrimaryTabComponents
Salesforce コンソールの主タブにあるカスタムコンソールコンポーネントを表します。API バージョン 25.0 以降
で利用できます。
項目名
データ型
説明
component
ConsoleComponent[] ページレイアウトのセクション上にあるカスタムコンソー
ルコンポーネント (Visualforce ページ、参照項目、または関
連リスト。Force.com Canvas アプリケーションは使用不可) を
表します。カスタムコンソールコンポーネントは、Salesforce
コンソールにのみ表示されます。この項目は、APIバージョ
ン 29.0 以前で使用できます。
containers
Container[]
Salesforce コンソールのサイドバー上に複数のカスタムコン
ソールコンポーネントを表示するための場所とスタイルを
表します。4 つの場所 (左、右、上、および下) のそれぞれ
に最大 5 つのコンポーネントを指定できます。この項目は
API バージョン 30.0 以降で使用できます。
ConsoleComponent
ページレイアウトのセクション上にあるカスタムコンソールコンポーネント (Visualforce ページ、参照項目、ま
たは関連リスト。Force.com Canvas アプリケーションは使用不可) を表します。カスタムコンソールコンポーネ
ントは、Salesforce コンソールにのみ表示されます。API バージョン 25.0 以降で利用できます。
項目名
データ型
説明
height
int
location が top または bottom のコンポーネントで必須です。
カスタムコンソールコンポーネントの高さです。ピクセル
単位で、0 より大きく 999 より小さい値に指定する必要が
あります。
location
string
必須。ページレイアウトのカスタムコンソールコンポーネ
ントの位置。有効な値は、right、left、top、および bottom で
す。コンポーネントには、ページレイアウトあたり 1 つの
location を指定できます。
visualforcePage
string
必須。カスタムコンソールコンポーネントの一意の名前。
たとえば、ConsoleComponentPage です。
376
メタデータ型
Layout
項目名
データ型
説明
width
int
location が left または right のコンポーネントで必須です。カ
スタムコンソールコンポーネントの幅です。ピクセル単位
で、0 より大きく 999 より小さい値に指定する必要があり
ます。
Container
Salesforce コンソールのサイドバーに複数のカスタムコンソールコンポーネントを表示するための場所とスタイ
ルを表します。たとえば、コンソールの右のサイドバーには、積み上げ、タブ、またはアコーディオンのスタ
イルで複数のコンポーネントを表示できます。API バージョン 30.0 以降で利用できます。
項目名
データ型
説明
height
int
location が top または bottom のコンポーネントで必須です。
コンポーネントのコンテナの高さ。単位 (ピクセルまたは
パーセント) は、unit 項目によって決まります。
isContainerAutoSizeEnabled boolean
region
string
必須。true に設定されると、サイドバーの積み上げコン
ソールコンポーネントの垂直方向のサイズが自動的に設定
されます。新規作成されたコンソールコンポーネントの場
合、デフォルトで true に設定されます。API バージョン
32.0 以降で使用できます。
必須。コンポーネントのコンテナの場所。使用できる値は
次のとおりです。
• right
• left
• top
• bottom
sidebarComponents
SidebarComponent[]
コンポーネントのコンテナに表示する特定のカスタムコン
ソールコンポーネントを表します。
style
string
必須。複数のコンポーネントを表示するコンテナのスタイ
ル。使用できる値は次のとおりです。
• stack — 複数のフレームを含むコンテンツ領域。
• tabs — 複数のパネルのリストを含む単一コンテンツ領
域。
• accordian — 折りたたみ可能なコンテンツ領域。
377
メタデータ型
Layout
項目名
データ型
説明
unit
string
必須。コンポーネントのコンテナの高さまたは幅の単位
(ピクセルまたはパーセント)。
ピクセル値は、ピクセル数 (500 など) で、0 より大きく 999
より小さい値である必要があります。パーセント値は、
パーセント記号を含み (20% など)、0 より大きく、100 より
小さい値である必要があります。
width
int
location が right または left のコンポーネントで必須です。コ
ンポーネントのコンテナの幅。単位 (ピクセルまたはパー
セント) は、unit 項目によって決まります。
SidebarComponent
Salesforce コンソールのサイドバーのいずれかでマルチコンポーネントをホストするコンテナに表示する特定の
カスタムコンソールコンポーネントを表します。4 つのコンテナの場所 (左、右、上、および下) のそれぞれに
最大 5 つのコンポーネントを指定できます。API バージョン 30.0 以降で利用できます。
項目名
データ型
説明
componentType
string
コンポーネントの種類を指定します。有効な値は、
KnowledgeOne、Lookup、Milestones、RelatedList、
Topics、Files、および CaseExperts です。この項目
は、API バージョン 31.0 以降で使用できます。Files およ
び CaseExperts 値は、API バージョン 32.0 以降で使用でき
ます。
メモ: ケースのエキスパートは、現在パイロットプロ
グラムで使用可能です。
height
int
location が top または bottom のコンポーネントで必須です。
コンテナ内のコンポーネントの高さ。単位 (ピクセルまた
はパーセント) は、unit 項目によって決まります。
label
string
コンソールユーザに表示されるコンポーネントの名前。ス
タイルがタブまたはアコーディオンのコンテナに含まれる
コンポーネントに使用できます。
lookup
string
コンポーネントが参照項目の場合、項目の名前。
page
string
コンポーネントが Visualforce ページの場合、Visualforce ペー
ジの名前。
relatedlists
RelatedList[]
コンポーネントが関連リストの場合、リストの名前。この
項目は API バージョン 31.0 以降で使用できます。
378
メタデータ型
Layout
項目名
データ型
説明
unit
string
コンテナ内のコンポーネントの高さまたは幅の単位 (ピク
セルまたはパーセント)。
ピクセル値は、ピクセル数 (500 など) で、0 より大きく 999
より小さい値である必要があります。パーセント値は、
パーセント記号を含み (20% など)、0 より大きく、100 より
小さい値である必要があります。
width
int
location が right または left のコンポーネントで必須です。コ
ンテナ内のコンポーネントの幅。単位 (ピクセルまたはパー
セント) は、unit 項目によって決まります。
RelatedList
Salesforce コンソールのサイドバーにある関連リストのカスタムコンポーネントを表します。APIバージョン 31.0
以降で使用できます。
項目名
データ型
説明
hideOnDetail
boolean
true に設定されている場合、コンポーネントとして表示
される関連リストが詳細ページで非表示になり、重複する
情報が表示されなくなります。
name
string
コンソールユーザに表示されるコンポーネントの名前。
SubtabComponents
Salesforce コンソールのサブタブにあるカスタムコンソールコンポーネントを表します。API バージョン 25.0 以
降で利用できます。
項目名
データ型
説明
component
ConsoleComponent[] ページレイアウトのセクション上にあるカスタムコンソー
ルコンポーネント (Visualforce ページ、参照項目、または関
連リスト。Force.com Canvas アプリケーションは使用不可) を
表します。カスタムコンソールコンポーネントは、Salesforce
コンソールにのみ表示されます。この項目は、APIバージョ
ン 29.0 以前で使用できます。
containers
Container[]
Salesforce コンソールのサイドバー上に複数のカスタムコン
ソールコンポーネントを表示するための場所とスタイルを
表します。4 つの場所 (左、右、上、および下) のそれぞれ
に最大 5 つのコンポーネントを指定できます。この項目は
API バージョン 30.0 以降で使用できます。
379
メタデータ型
Layout
FeedLayout
フィードベースのページレイアウトのフィードビューを定義する値を表します。フィードベースのレイアウト
は、取引先、ケース、取引先責任者、リード、商談、およびカスタムオブジェクトで使用できます。フィード
ビューと詳細ビューが含まれます。API バージョン 30.0 以降で利用できます。
項目名
データ型
説明
autocollapsePublisher
boolean
ページの読み込み時にパブリッシャーを自動的に折りたた
むか (true)、否か (false) を指定します。
compactFeed
boolean
フィードベースのページレイアウトでコンパクトフィード
を使用するか (true)、否か (false) を指定します。true
に設定した場合、ページのフィード項目はデフォルトで折
りたたまれ、フィードビューには更新されたデザインが使
用されます。
feedFilterPosition
FeedLayoutFilterPosition レイアウト内でフィード条件リストが含まれる場所。有効
(string 型の 列挙)
な値は、次のとおりです。
• centerDropDown — 中央列にドロップダウンリストと
して表示。
• leftFixed — 左列に固定リストとして表示。
• leftFloat — 左列にフロート表示リストとして表示。
feedFilters
FeedLayoutFilter[]
フィード条件リストに表示される個々の条件。
fullWidthFeed
boolean
フィードをページ上の使用可能な領域いっぱいまで横に展
開するか (true)、否か (false) を指定します。
hideSidebar
boolean
サイドバーが非表示か (true)、否か (false) を示します。
leftComponents
FeedLayoutComponent[] フィードビューの左列に表示される個々のコンポーネン
ト。
rightComponents
FeedLayoutComponent[] フィードビューの右列に表示される個々のコンポーネン
ト。
FeedLayoutComponent
フィードベースのページレイアウトのフィードビュー内のコンポーネントを表します。API バージョン 30.0 以
降で利用できます。
380
メタデータ型
Layout
項目名
データ型
説明
componentType
FeedLayoutComponentType 必須。コンポーネントの種類。有効な値は、次のとおりで
(string 型の列挙)
す。
• HelpAndToolLinks — ページのヘルプトピック、ペー
ジレイアウト、およびページの印刷用表示にリンクす
るアイコン。ケースレイアウトでのみ使用できます。
• CustomButtons — カスタムボタン。
• Following — [フォロー] ボタン (レコードを表示して
いるユーザがまだレコードをフォローしていない場合)
と [フォロー中] インジケータ (レコードを表示している
ユーザがレコードをフォローしている場合) 間で切り替
わるアイコン。
• Followers — レコードをフォローしているユーザのリ
スト。
• CustomLinks — カスタムリンク。
• Milestones — マイルストントラッカー。これにより、
ユーザはケースのマイルストンの状況を表示できます。
ケースレイアウトでのみ使用できます。
• Topics — レコードに関連するトピックのリスト。
• Visualforce — カスタム Visualforce コンポーネント。
height
int
コンポーネントの高さ (ピクセル単位)。
standardComponents には適用されません。
page
string
カスタムコンポーネントとして使用されている Visualforce
ページの名前。
FeedLayoutFilter
フィードベースのページレイアウトのフィードビュー内のフィード条件オプションを表します。1 つの条件に
は、standardFilter または feedItemType セットのみが含まれる必要があります。API バージョン 30.0 以降
で利用できます。
項目名
データ型
説明
feedFilterType
FeedLayoutFilterType
(string 型の列挙)
条件の種別。有効な値は、次のとおりです。
• AllUpdates — レコードに対するすべてのフィード項
目を表示します。
• FeedItemType — レコードに対する特定の種別の活動
についてのみフィード項目を表示します。
381
メタデータ型
Layout
項目名
データ型
説明
feedItemType
FeedItemType (string
型の列挙)
表示するフィード項目の種別。有効な値は、次のとおりで
す。
• ActivityEvent — ケースに関連付けられている ToDo
と行動に対する活動に関連するフィード項目。ケース
レイアウトでのみ使用できます。
• AdvancedTextPost – フィードに投稿されたグループ
へのお知らせに関連するフィード項目。この値は、API
バージョン 31.0 以降で使用できます。
• AnnouncementPost – 使用されません。
• ApprovalPost — フィードに送信された承認に関連す
るフィード項目。
• AttachArticleEvent — ケースへの記事の添付に関
連する活動に関するフィード項目。ケースレイアウト
でのみ使用できます。
• BasicTemplateFeedItem — 使用されません。
• CallLogPost — 「活動の記録」アクションからの活
動に関するフィード項目。活動 (ToDo と行動) をサポー
トするオブジェクトのレイアウトでのみ使用できます。
• CanvasPost — キャンバスアプリケーションによる
フィードへの投稿に関するフィード項目。
• CaseCommentPost — 「ケースメモ」アクションから
の活動に関するフィード項目。ケースレイアウトでの
み使用できます。
• ChangeStatusPost — 「状況の変更」アクションから
の活動に関するフィード項目。ケースレイアウトでの
み使用できます。
• ChatTranscriptPost — ケースへの Live Agent チャッ
トトランスクリプトの添付に関連する活動に関する
フィード項目。ケースレイアウトでのみ使用できます。
• CollaborationGroupCreated — 公開グループの作
成に関連するフィード項目。
• CollaborationGroupUnarchived — 使用されませ
ん。
• ContentPost — 投稿へのファイルの添付に関連する
フィード項目。
• CreatedRecordEvent — パブリッシャーからのレコー
ドの作成に関連するフィード項目。
382
メタデータ型
項目名
Layout
データ型
説明
• DashboardComponentSnapshot — フィードへのダッ
シュボードスナップショットの投稿に関連するフィー
ド項目。
• EmailMessageEvent — 「メール」アクションからの
活動に関するフィード項目。ケースレイアウトでのみ
使用できます。
• FacebookPost — 使用されません。
• LinkPost — 投稿への URL の添付に関連するフィード
項目。
• MilestoneEvent — ケースのマイルストンの状況への
変更に関するフィード項目。ケースレイアウトでのみ
使用できます。
• PollPost — フィードへのアンケートの投稿に関連す
るフィード項目。
• ProfileSkillPost — ユーザの Chatter プロファイルに
追加されるスキルに関連するフィード項目。この値は、
API バージョン 31.0 以降で使用できます。
• QuestionPost — フィードへの質問の投稿に関連する
フィード項目。この値は API バージョン 31.0 以降で使用
できます。
• ReplyPost — 「ポータル」アクションからの活動に関
するフィード項目。ケースレイアウトでのみ使用でき
ます。
• RypplePost — Work.com での感謝バッジの作成に関連
するフィード項目。
• SocialPost — 「ソーシャル投稿」アクションからの
Twitter での活動に関するフィード項目。
• TextPost — パブリッシャーからのテキスト投稿の作
成に関するフィード項目。
• TrackedChange — 追跡対象の項目に対する単一の変
更、または変更の集合に関連するフィード項目。
• UserStatus — 使用されません。
MiniLayout
[コンソール] タブ、詳細のフロート表示、および行動のフロート表示でのレコードのミニビューを表します。
383
メタデータ型
Layout
項目名
データ型
説明
fields
string[]
ミニレイアウトの項目。UI に表示する順序で表示されま
す。ここに表示される項目はメインレイアウトに表示され
ます。
relatedLists
RelatedListItem[]
ミニ関連リスト。UI に表示される順序で表示されます。ミ
ニ関連リストでの並び替えは設定できません。ここに表示
される項目はメインレイアウトに表示されます。
LayoutSection
LayoutSection は [カスタムリンク] セクションなど、ページレイアウトのセクションを表します。
項目名
データ型
説明
customLabel
boolean
このセクションの表示ラベルがカスタムであるか標準 (組
み込み) であるかを示します。カスタム表示ラベルは任意
のテキストですが、翻訳する必要があります。標準表示ラ
ベルには、「システム情報」など、自動的に翻訳される、
定義済みの有効な値セットが含まれます。
detailHeading
boolean
このセクションを詳細ページに表示するかどうかを制御し
ます。UI では、この設定はセクションの詳細ダイアログの
チェックボックスに対応します。
editHeading
boolean
このセクションを編集ページに表示するかどうかを制御し
ます。
label
string
表示ラベル。customLabel フラグに基づいて標準または
カスタムのいずれかとなります。
layoutColumns
LayoutColumn[]
レイアウトの列です。スタイルによって異なります。1 列、
2 列、または 3 列が含まれ、左から右に並べられます。
style
LayoutSectionStyle
(string 型の列挙)
レイアウトのスタイルは次のとおりです。
• TwoColumnsTopToBottom - 2 列。タブは上から下に並
べられます。
• TwoColumnsLeftToRight - 2 列。タブは左から右に並
べられます。
• OneColumn - 1 列。
• CustomLinks - カスタムリンクのみを含む。
summaryLayout
SummaryLayout
将来の使用のために予約されています。
384
メタデータ型
Layout
LayoutColumn
LayoutColumn は、レイアウトセクション内の列の項目を表します。
項目名
データ型
説明
layoutItems
LayoutItem[]
列内の個々の項目 (上から下の順序)
reserved
string
この項目はSalesforce用に予約されています。この項目は一
部の SOAP ライブラリに関する問題を解決します。この項
目に入力された値はすべて無視されます。
LayoutItem
LayoutItem は、レイアウト項目を定義する有効な値を表します。項目には、component、customLink、field、scontrol、
page、reportChartComponent のいずれか 1 つのみを含める必要があります。
項目名
データ型
説明
behavior
UiBehavior (string 型の列挙)
項目の動作を決定します。有効な string 値は次
のとおりです。
• Edit — レイアウト項目を編集できます
が、必須ではありません。
• Required — レイアウト項目を編集できま
す。必須です。
• Readonly — レイアウト項目は参照のみで
す。
canvas
キャンバスアプリケーションへの参照。
string
この項目はAPIバージョン 31.0 以降で使用でき
ます。
component
string
コンポーネントへの参照。値は
sfa:socialCard である必要があります。
この項目はAPIバージョン 30.0 以降で使用でき
ます。これは、RelatedContentItem 内での
み使用できます。sfa:socialCard は、取引
先責任者、取引先、およびリードのページレ
イアウトでのみサポートされます。
customLink
string
customLink の参照。これは、CustomLink
layoutSection 内でのみ使用できます。
emptySpace
boolean
このレイアウト項目が空白スペースであるか
どうかを制御します。
385
メタデータ型
Layout
項目名
データ型
説明
field
string
Description または MyField__c などのレ
イアウトオブジェクトを基準にした項目名の
参照。
height
int
ピクセル単位の高さ (Sコントロールおよびペー
ジのみ)。
page
string
Visualforce ページへの参照。
reportChartComponent
ReportChartComponentLayoutItem
標準またはカスタムオブジェクトページに追
加できるレポートグラフを参照します。
scontrol
string
Sコントロールへの参照。
showLabel
boolean
表示ラベルを表示するかどうか (Sコントロー
ルおよびページのみ)。
showScrollbars
boolean
スクロールバーを表示するかどうか (Sコント
ロールおよびページのみ)。
width
string
ピクセルまたはパーセント単位の幅 (Sコント
ロールおよびページのみ)。ピクセル値は 500
など、単なるピクセル数です。パーセント値
には、20% などのようにパーセント記号を含
める必要があります。
ReportChartComponentLayoutItem
標準ページまたはカスタムページのレポートグラフの設定を示します。
項目名
データ型
説明
cacheData
boolean
グラフを表示するときにキャッシュデータを使用するかど
うかを示します。属性が true に設定されている場合、
データは 24 時間キャッシュされます。属性が false に設
定されている場合、ページが更新されるたびにレポートが
実行されます。
この項目は API バージョン 29.0 以降で使用できます。
contextFilterableField string
レポートグラフを絞り込んでページに関連するデータを返
すために使用する項目の一意の開発名。これを設定する
と、ページの親オブジェクトまたはレポートタイプの親オ
ブジェクトの ID 項目によってグラフデータが絞り込まれま
す。グラフが関連データを返すようにするには、レポート
タイプの親オブジェクトとページの親オブジェクトが一致
する必要があります。
386
メタデータ型
Layout
項目名
データ型
説明
error
string
基本となるレポートでエラーが発生した場合にのみ入力さ
れるエラー文字列。
この項目は API バージョン 31.0 以降で使用できます。
hideOnError
boolean
エラーのあるグラフをユーザに表示するかどうかを制御し
ます。エラーがあり、この属性が設定されていない場合、
グラフにはエラー以外のデータは表示されません。エラー
はさまざまな理由で発生します。たとえば、グラフで使用
する項目へのアクセス権がユーザにない場合や、グラフが
レポートから削除された場合などがあります。エラー時に
ページでグラフを非表示にするには、この属性を true に
設定します。
この項目は API バージョン 29.0 以降で使用できます。
includeContext
boolean
true の場合、レポートグラフが絞り込まれて、ページに
関連するデータが返されます。
reportName
string
グラフを含むレポートの一意の開発名。
showTitle
boolean
true の場合、レポートからグラフにタイトルが適用され
ます。
size
ReportChartComponentSize 値が指定されていない場合、グラフサイズは中になりま
す。有効な値は次のとおりです。
(string 型の列挙)
• SMALL
• MEDIUM
• LARGE
QuickActionList
QuickActionList はページレイアウトに関連付けられたアクションのリストを表します。API バージョン 28.0 以降
で利用できます。
項目名
データ型
説明
quickActionListItems
QuickActionListItem[] 0 個以上の QuickActionList オブジェクトの配列。
QuickActionListItem
QuickActionListItem は QuickActionList リストのアクションを表します。API バージョン 28.0 以降で利用できます。
387
メタデータ型
Layout
項目名
データ型
説明
quickActionName
string
アクションの API 名。
RelatedContent
RelatedContent は、ページレイアウトの [モバイルカード] セクションを示します。API バージョン 29.0 以降で使
用できます。
項目名
データ型
説明
relatedContentItems
RelatedContentItem[] ページレイアウトの [モバイルカード] セクションにあるレ
イアウト項目のリスト。
RelatedContentItem
RelatedContentItem は、RelatedContentItem リストの個々の項目を表します。API バージョン 29.0 以降で利用できま
す。
項目名
データ型
説明
layoutItem
LayoutItem
[モバイルカード] セクションの個々の LayoutItem。
RelatedListItem
RelatedListItem はページレイアウトの関連リストを表します。
項目名
データ型
説明
customButtons
string[]
関連リストで使用するカスタムボタンのリスト。詳細は、
Salesforce オンラインヘルプの「カスタムボタンとリンクの
定義」を参照してください。
excludeButtons
string[]
除外される関連リストのボタンのリスト。
fields
string[]
関連リストで表示される項目のリスト。
関連リストの標準項目の取得では、API 名ではなく項目の
別名が使用されます。たとえば、[Fax]、[携帯]、および
[自宅電話] 項目は、Phone2、Phone3、および Phone4 として
それぞれ取得されます。
relatedList
string
必須。関連リストの名前。
sortField
string
並び替えに使用される項目の名前。
388
メタデータ型
Layout
項目名
データ型
説明
sortOrder
SortOrder (string 型の sortField が設定されている場合、sortOrder 項目が並
列挙)
び替え順を決定します。
• Asc - 昇順での並び替え
• Desc - 降順での並び替え
SummaryLayout
ケースフィードが有効化されているときにページレイアウト上部のグリッドでキー項目を集計する、強調表示
パネルの外観を制御します。API バージョン 25.0 以降で利用できます。
項目名
データ型
説明
masterLabel
string
必須。レイアウト表示ラベルの名前。
sizeX
int
必須。強調表示パネルの列数。1 ～ 4 (この値は範囲に含ま
れる) である必要があります。
sizeY
int
必須。各列の行数。1 または 2 である必要があります。
sizeZ
int
将来の使用のために予約されています。指定されている場
合、設定内容はユーザに表示されません。
summaryLayoutItems
SummaryLayoutItem[] ケースフィードが有効化されているときに、個々の項目の
外観および強調表示パネルのグリッド内の列と行の位置を
制御します。少なくとも 1 つは必須項目です。
summaryLayoutStyle
SummaryLayoutStyle
(string 型の列挙)
強調表示パネルのスタイル。有効な string 値は次のとおり
です。
• Default
• QuoteTemplate
• DefaultQuoteTemplate
• CaseInteraction
• QuickActionLayoutLeftRight (API バージョン 28.0 以降で使用
可能)
• QuickActionLayoutTopDown (API バージョン 28.0 以降で使用
可能)
SummaryLayoutItem
ケースフィードが有効化されているときに、個々の項目の外観および強調表示パネルのグリッド内の列と行の
位置を制御します。強調表示パネルのグリッドごとに 2 つの項目を指定できます。API バージョン 25.0 以降で
利用できます。
389
メタデータ型
Layout
項目名
データ型
説明
customLink
string
項目がカスタムリンクの場合は、customLink が参照先で
す。
field
string
ページレイアウトを基準にした項目名の参照。詳細ページ
にも存在する標準項目またはカスタム項目である必要があ
ります。
posX
int
必須。強調表示パネルのグリッドにおける項目の列の位
置。sizeX の範囲内である必要があります。
posY
int
必須。強調表示パネルグリッドにおける項目の行の位置。
sizeY の範囲内である必要があります。
posZ
int
将来の使用のために予約されています。指定されている場
合、設定内容はユーザに表示されません。
宣言的なメタデータの定義のサンプル
ページレイアウトの定義を次に示します。
<?xml version="1.0" encoding="UTF-8"?>
<Layout xmlns="http://soap.sforce.com/2006/04/metadata">
<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>
<visualforcePage>ConsoleComponentPage2</visualforcePage>
<height>200</height>
</component>
</subtabComponents>
</customConsoleComponents>
<customButtons>ButtonLink</customButtons>
390
メタデータ型
Layout
<layoutSections>
<editHeading>true</editHeading>
<label>Information</label>
<layoutColumns>
<layoutItems>
<behavior>Required</behavior>
<field>Name</field>
</layoutItems>
<layoutItems>
<height>180</height>
<scontrol>LayoutSControl</scontrol>
<showLabel>true</showLabel>
<showScrollbars>true</showScrollbars>
<width>50%</width>
</layoutItems>
<layoutItems>
<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>
</layoutItems>
<layoutItems>
<behavior>Edit</behavior>
<field>CurrencyIsoCode</field>
</layoutItems>
</layoutColumns>
<style>TwoColumnsTopToBottom</style>
</layoutSections>
<layoutSections>
<editHeading>true</editHeading>
<label>System Information</label>
<layoutColumns>
<layoutItems>
<behavior>Readonly</behavior>
<field>CreatedById</field>
</layoutItems>
<layoutItems>
<behavior>Readonly</behavior>
<field>Alpha1__c</field>
</layoutItems>
<layoutItems>
<height>200</height>
<page>mcanvasPage</page>
<showLabel>true</showLabel>
<showScrollbars>false</showScrollbars>
391
メタデータ型
Layout
<width>100%</width>
</layoutItems>
</layoutColumns>
<layoutColumns>
<layoutItems>
<behavior>Readonly</behavior>
<field>LastModifiedById</field>
</layoutItems>
<layoutItems>
<behavior>Edit</behavior>
<field>TextArea__c</field>
</layoutItems>
</layoutColumns>
<style>TwoColumnsTopToBottom</style>
</layoutSections>
<layoutSections>
<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>
392
メタデータ型
Layout
</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> を使用したレイアウトの例を次に示します。
<?xml version="1.0" encoding="UTF-8"?>
<Layout xmlns="http://soap.sforce.com/2006/04/metadata">
<layoutSections>
<editHeading>true</editHeading>
<label>System Information</label>
<layoutColumns>
<layoutItems>
<behavior>Readonly</behavior>
<field>CreatedById</field>
</layoutItems>
<layoutItems>
<behavior>Required</behavior>
<field>Name</field>
</layoutItems>
</layoutColumns>
<layoutColumns>
<layoutItems>
<behavior>Readonly</behavior>
<field>LastModifiedById</field>
</layoutItems>
</layoutColumns>
<style>TwoColumnsTopToBottom</style>
</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>
393
メタデータ型
Letterhead
フィードベースのレイアウトの例を次に示します。
<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>
Letterhead
メールテンプレートのレターヘッドの書式設定オプションを表します。レターヘッドは、HTML メールテンプ
レートのデザインを定義します。レターヘッドからは、使用するロゴ、ページの色、およびテキスト設定を
HTML メールテンプレートに継承できます。詳細は、Salesforce オンラインヘルプの「レターヘッドの作成」を
参照してください。Metadata メタデータ型を拡張し、その fullName 項目を継承します。
ファイルのサフィックスおよびディレクトリの場所
レターヘッドのファイルのサフィックスは .letter で、コンポーネントは対応するパッケージディレクトリ
の letterhead ディレクトリに保存されます。
394
メタデータ型
Letterhead
バージョン
レターヘッドは、API バージョン 12.0 以降で使用できます。
項目
ロゴ、横位置および縦位置の配置を除き、これらのすべての項目が必須です。
項目名
データ型
説明
available
boolean
必須。メールテンプレート内など、このレター
ヘッドを使用できるか (true)、否か (false) を
示します。
backgroundColor
string
必須。背景色。#FF6600 などの 16 進数で指定し
ます。
bodyColor
string
必須。本文の色。16 進数で指定します。
bottomLine
LetterheadLine (string 型の列挙)
必須。下部区切り線のスタイル。使用できるス
タイルの値は次のとおりです。
• color。線の色。string 値として 16 進数で指
定します。
• height。線の高さ。int値として指定します。
description
string
このレターヘッドが他のレターヘッドとどのよ
うに異なるかを説明したテキスト。
fullName
string
name に基づくレターヘッドの内部名。ただし、
有効性のために空白文字と特殊文字はエスケー
プ処理されます。
footer
LetterheadHeaderFooter
必須。フッターのスタイル。
header
LetterheadHeaderFooter
必須。ヘッダーのスタイル。
middleLine
LetterheadLine
必須。レターヘッドの中間にある境界線のスタ
イル。使用できるスタイルの値は次のとおりで
す。
• color。線の色。string 値として 16 進数で指
定します。
• height。線の高さ。int値として指定します。
name
string
必須。レターヘッドの名前。
395
メタデータ型
Letterhead
項目名
データ型
説明
topLine
LetterheadLine
必須。ヘッダーの下の上部区切り横線のスタイ
ル。使用できるスタイルの値は次のとおりです。
• color。線の色。string 値として 16 進数で指
定します。
• height。線の高さ。int値として指定します。
LetterheadHeaderFooter
LetterheadHeaderFooter ではヘッダーまたはフッターのプロパティを表します。
項目
データ型
説明
backgroundColor
string
必須。ヘッダーまたはフッターの背景色。16 進形式
で指定します。
height
DashboardComponent[]
必須。ヘッダーまたはフッターの高さ。
horizontalAlignment
LetterheadHorizontalAlignment ヘッダーまたはフッターの横方向の配置。有効な値
(string 型の列挙)
は、次のとおりです。
• None
• Left
• Center
• Right
logo
MyFolder/MyDocument.gif などのドキュメント
string
への参照であるロゴ。
verticalAlignment
LetterheadVerticalAlignment
(string 型の列挙)
ヘッダーまたはフッターの縦方向の配置。有効な値
は、次のとおりです。
• None
• Top
• Middle
• Bottom
LetterheadLine
LetterheadLine は線のプロパティを表します。
項目
データ型
説明
color
string
必須。線の色。16 進形式で指定します。
396
メタデータ型
LiveChatAgentConfig
項目
データ型
説明
height
int
必須。線の高さ。
宣言的なメタデータの定義のサンプル
<?xml version="1.0" encoding="UTF-8"?>
<Letterhead xmlns="http://soap.sforce.com/2006/04/metadata">
<available>true</available>
<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 ファイルで参照されます。
397
メタデータ型
LiveChatAgentConfig
バージョン
LiveChatAgentConfig は、API バージョン 28.0 以降で使用できます。
項目
項目名
データ型
説明
assignments
AgentConfigAssignments Live Agent ユーザへのエージェント設定の割り当
て方法を指定します。エージェント設定は、ユー
ザのセットまたはプロファイルのセットに割り
当てることができます。
autoGreeting
string
エージェントとのチャットの開始時に顧客に表
示される挨拶を指定します。
capacity
int
エージェントが一度に参加できるチャットの最
大数を指定します。
criticalWaitTime
int
チャットタブが点滅して、参加しているチャッ
トに回答するように注意が促されるまでに、エー
ジェントが回答するまでに待機できる秒数を指
定します。
enableAgentSneakPeek
boolean
エージェントがメッセージを顧客に送信する前
にスーパーバイザがその内容を確認できるか
(true)、否か (false) を示します。
enableAutoAwayOnDecline
boolean
エージェントが顧客とのチャットに参加しない
ときに、エージェントを「退席中」として表示
するか (true)、否か (false) を示します。
enableAgentFileTransfer
boolean
エージェントのファイル転送が有効か (true)、
否か (false) を示します。API バージョン 31.0 以
降で使用できます。
enableChatTransfer
boolean
エージェントのチャット転送が有効か (true)、
否か (false) を示します。API バージョン 31.0 以
降で使用できます。
enableLogoutSound
boolean
エージェントが Live Agent からログアウトすると
きに、音を鳴らすか (true)、否か (false) を示し
ます。
enableNotifications
boolean
受信チャット通知をエージェントに表示するか
(true)、否か (false) を示します。
398
メタデータ型
LiveChatAgentConfig
項目名
データ型
説明
enableRequestSound
boolean
顧客がエージェントとのチャットを要求すると
きに、音を鳴らすか (true)、否か (false) を示し
ます。
enableSneakPeek
boolean
顧客のメッセージのプレビューをエージェント
の Live Agent ウィンドウに顧客タイプとして表示
するか (true)、否か (false) を示します。API バー
ジョン 29.0 以降で利用できます。
label
string
エージェントのデフォルトのチャット設定の名
前を指定します。
supervisorDefaultAgentStatusFilter SupervisorAgentStatusFilter スーパーバイザパネルの [エージェント状況] リ
(string 型の列挙)
ストを絞り込むための Live Agent の状況を指定し
ます。有効な値は、次のとおりです。
• オンライン
• Away
• オフライン
API バージョン 29.0 以降で利用できます。
supervisorDefaultButtonFilter string
スーパーバイザパネルの [エージェント状況] リ
ストを絞り込むためのデフォルトのボタンを指
定します。API バージョン 29.0 以降で利用できま
す。
supervisorDefaultSkillFilter string
スーパーバイザパネルの [エージェント状況] リ
ストを絞り込むためのデフォルトのスキルを指
定します。API バージョン 29.0 以降で利用できま
す。
supervisorSkills
SupervisorAgentConfigSkills 割り当て済みの Live Agent 設定で指定されたとお
りに、スーパーバイザに割り当てられるエージェ
ントスキルを指定します。API バージョン 29.0 以
降で利用できます。
transferableButtons
AgentConfigButtons
エージェントがチャットの転送先にできるチャッ
トボタンのリストを指定します。API バージョン
31.0 以降で使用できます。
transferableSkills
AgentConfigSkills
エージェントがチャットの転送先にできるスキ
ルグループのリストを指定します。API バージョ
ン 31.0 以降で使用できます。
399
メタデータ型
LiveChatAgentConfig
AgentConfigAssignments
組織のプロファイルとユーザの Live Agent 設定への割り当てを表します。
項目
項目名
データ型
説明
profiles
AgentConfigProfileAssignments
特定のエージェント設定に関連付けられたプロ
ファイルを指定します。
users
AgentConfigUserAssignments
特定のエージェント設定に関連付けられたユー
ザを指定します。
AgentConfigButtons
Live Agent設定に関連付けられているエージェントが、チャットの転送先にできるチャットボタンを表します。
項目
項目名
データ型
説明
button
string[]
エージェントがチャットの転送先にできる
チャットボタンを指定します。
AgentConfigProfileAssignments
特定の Live Agent 設定に関連付けられたプロファイルを表します。
項目
項目名
データ型
説明
profile
string
特定のエージェント設定に関連付けられたプロ
ファイルのカスタム名を指定します。
AgentConfigSkills
Live Agent設定に関連付けられているエージェントが、チャットの転送先にできるスキルグループを表します。
400
メタデータ型
LiveChatAgentConfig
項目
項目名
データ型
説明
skill
string[]
エージェントがチャットの転送先にできるスキ
ルグループを指定します。
AgentConfigUserAssignments
特定の Live Agent 設定に関連付けられたユーザを表します。
項目
項目名
データ型
説明
user
string
特定のエージェント設定に関連付けられたユー
ザのユーザ名を指定します。
SupervisorAgentConfigSkills
スーパーバイザの Live Agent 設定に関連付けられたエージェントスキルを表します。API バージョン 29.0 以降で
利用できます。
項目
項目名
データ型
説明
skill
string
スーパーバイザパネルの [エージェント状況] リ
ストを絞り込むことができるエージェントスキ
ルを指定します。
宣言的なメタデータの定義のサンプル
これは、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>
401
メタデータ型
LiveChatButton
<enableSneakPeek>true</enableSneakPeek>
<assignments>
<profiles>
<profile>standard</profile>
</profiles>
<users>
<user>[email protected]</user>
</users>
</assignments>
</LiveChatAgentConfig>
LiveChatButton
ボタンの表示ラベルやライブチャットの開始前に表示されるチャット前フォームなど、エージェントとチャッ
トするために顧客がクリックするボタンやチャットウィンドウのLive Agentリリースの設定を表します。Metadata
メタデータ型を拡張し、その fullName 項目を継承します。
ファイルのサフィックスおよびディレクトリの場所
LiveChatButton設定は、liveChatButtons ディレクトリの <developer_name>.liveChatButton ファイルに
保存されます。
バージョン
LiveChatButton は、API バージョン 28.0 以降で使用できます。
項目
項目名
データ型
説明
chatPage
string
ページが Live Agent チャットウィンドウ
と異なる場合に、チャットをホストす
るページを指定します。
enableQueue
boolean
キューが有効化されているか (true)、
否か (false) を示します。
label
string
ボタンに表示するテキストを指定しま
す。
numberOfReroutingAttempts int
すべてのエージェントがチャット要求
を拒否した場合に、対応可能なエージェ
ントにチャット要求を再転送できる回
数を指定します。この項目は、API バー
ジョン 30.0 以降で使用できます。
402
メタデータ型
LiveChatButton
項目名
データ型
説明
offlineImage
string
エージェントがチャットに対応できな
い場合にボタンに表示する画像を指定
します。
onlineImage
string
エージェントがチャットに対応できる
場合にボタンに表示する画像を指定し
ます。
optionsCustomRoutingIsEnabled boolean
受信チャット要求のカスタム転送が有
効か (true)、否か (false) を示します。
この項目は、API バージョン 30.0 以降で
使用できます。
optionsHasInviteAfterAccept boolean
顧客が以前のチャット招待を受諾した
後に、新しいチャット招待をトリガす
るか (true)、否か (false) を示します。
optionsHasInviteAfterReject boolean
顧客が以前のチャット招待を辞退した
後に、新しいチャット招待をトリガす
るか (true)、否か (false) を示します。
optionsHasRerouteDeclinedRequest boolean
すべての対応可能なエージェントから
拒否されたチャット要求を、対応可能
なエージェントに再転送する必要があ
るか (true)、否か (false) を示します。
この項目は、API バージョン 30.0 以降で
使用できます。
boolean
チャット要求を割り当てられたエージェ
ントが、チャット要求を自動的に受け
入れる必要があるか (true)、否か
(false) を示します。[[チャット] ボタン
および自動招待] で、routingType が
MostAvailable または LeastActive
に設定されている場合。この項目は、
API バージョン 30.0 以降で使用できま
す。
optionsIsInviteAutoRemove boolean
特定の時間が経過した後に、チャット
招待が自動的に顧客の画面から消える
ように設定するか (true)、否か (false)
を示します。
optionsIsAutoAccept
overallQueueLength
int
キューに許可されるチャット要求の最
大数を指定します。
403
メタデータ型
LiveChatButton
項目名
データ型
説明
perAgentQueueLength
int
必要なスキルを持つエージェントに対
してキューが許可されるチャット要求
の最大数を指定します。
postChatPage
string
チャットの終了時に顧客が転送される
チャット後フォームの名前を指定しま
す。
postChatUrl
string
チャットの終了時に顧客が転送される
チャット後フォームの URL を指定しま
す。
preChatFormPage
string
チャットの開始前に顧客が転送される
チャット前フォームの名前を指定しま
す。
preChatFormUrl
string
チャットの開始時に顧客が転送される
チャット前フォームの URL を指定しま
す。
pushTimeOut
int
チャット要求が別のエージェントに転
送されるまでに、エージェントが受信
チャット要求への回答に費やすことの
できる秒数を指定します。
routingType
LiveChatButtonRoutingType (string 型の列 顧客がボタンを押したときに受信チャッ
挙)
トをエージェントに転送する方法を指
定します。有効な値は、次のとおりで
す。
• Choice
• LeastActive
• MostAvailable
site
string
カスタムチャットボタンの画像または
カスタムチャットページをホストする
Force.com サイトを指定します。
メモ: Live Agent で Force.com サイト
を使用するには、組織で
「CustomDomain」権限が有効化さ
れている必要があります。
skills
LiveChatButtonSkills
ボタンに関連付けられたスキルを指定
します。チャットするために顧客がボ
タンをクリックすると、そのスキルを
404
メタデータ型
項目名
LiveChatButton
データ型
説明
持つエージェントに自動的に転送され
ます。
windowLanguage
ボタンに関連付けられたチャットウィ
ンドウの言語設定を指定します。
Language
LiveChatButtonSkills
チャットボタンに関連付けられたスキルを表します。
項目
項目名
データ型
説明
skill
string
スキルの名前を指定します。
宣言的なメタデータの定義のサンプル
これは、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>
<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 ページを更新してください。
405
メタデータ型
LiveChatDeployment
LiveChatDeployment
リリースのブランド画像や、チャットのトランスクリプトを自動的に保存するかどうかなど、特定のLive Agent
リリースの設定を表します。Metadata メタデータ型を拡張し、その fullName 項目を継承します。
ファイルのサフィックスおよびディレクトリの場所
LiveChatDeploymentの値は、liveChatDeployments ディレクトリの <developer_name>.liveChatDeployment
ファイルに保存されます。
バージョン
LiveChatDeployment は、API バージョン 28.0 以降で使用できます。
項目
項目名
データ型
説明
brandingImage
string
リリースのブランド画像を指定しま
す。
displayQueuePosition
boolean
(パイロット) 顧客がチャット要求に
エージェントが応答するのを待ってい
る間、標準のチャットウィンドウに
キューの何番目にいるかを表示するか
(true)、否か (false) を決定します。
この項目は、API バージョン 32.0 でパ
イロットとして使用できます。この項
目を有効にするには、salesforce.com に
お問い合わせください。
domainWhiteList
LiveChatDeploymentDomainWhiteList
リリースをホストできるドメインのリ
ストを指定します。
enablePrechatApi
boolean
リリースのチャット前 API が有効に
なっているか (true)、否か (false) を
示します。
enableTranscriptSave
boolean
チャットの終了後にチャットのトラン
スクリプトを自動的に保存するか
(true)、否か (false) を示します。
label
string
リリースの名前を指定します。
406
メタデータ型
LiveChatDeployment
項目名
データ型
説明
mobileBrandingImage
string
顧客がモバイルデバイスからリリース
にアクセスするときに表示される、リ
リースのブランド画像を指定します。
site
string
リリースの画像をホストするサイトを
指定します。
メモ: Live Agent で Force.com サイ
トを使用するには、組織で
「CustomDomain」権限が有効化
されている必要があります。
windowTitle
リリースに関連付けられたウィンドウ
のタイトルを指定します。
string
LiveChatDeploymentDomainWhiteList
Live Agent リリースのドメインホワイトリストを表します。
項目
項目名
データ型
説明
domain
string
リリースをホストできるドメインを指定します。
宣言的なメタデータの定義のサンプル
これは、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 ページを更新してください。
407
メタデータ型
ManagedTopics
ManagedTopics
コミュニティで管理されているナビゲーショントピックと主要トピックを表します。特定のコミュニティは、
Network コンポーネントで表されます。
メモ: 関連するネットワークが、管理トピックをリリースする前に存在する必要があります (これは組織
全体をリリースするときに自動的に発生します)。
ファイルのサフィックスおよびディレクトリの場所
コンポーネントのサフィックスは managedTopics で、managedTopics フォルダに保存されます。このフォルダ内
に、ネットワークごとの個別のファイルが保存されています (NetworkNameA.managedTopics や
NetworkNameB.managedTopics など)。
バージョン
ManagedTopics コンポーネントは、API バージョン 32.0 以降で使用できます。
項目
項目名
データ型
説明
ManagedTopic
ManagedTopic
特定のナビゲーショントピックや主要トピックを表しま
す。
ManagedTopic
項目名
データ型
説明
name
string
トピック名です。
managedTopicType
string
トピックの種別です (「ナビゲーション」または「主要」)。
topicDescription
string
トピックのコンテンツの説明です (省略可能)。この項目は
APIを介してのみアクセスできます。ユーザインターフェー
スには付随する機能がありません。
position
int
このトピックの配置は同じ種別の他のトピックと関係しま
す。ナビゲーショントピックでは、これによってコミュニ
ティでの [トピック] メニューの順序が決まります。主要ト
ピックでは、これによってコミュニティホームページでの
トピックのサムネイル画像の順序が決まります。
0 から 24 までの数字を入力します (ナビゲーショントピッ
クまたは主要トピックの最大数は 25 です)。
408
メタデータ型
ManagedTopics
宣言的なメタデータの定義のサンプル
次の例は、すべてのネットワークの管理トピックを取得またはリリースします。
<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<types>
<members>*</members>
<name>ManagedTopics</name>
</types>
<version>32.0</version>
</Package>
次の例は、ManagedTopics コンポーネントを参照する package.xml ファイルを示します。
<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<types>
<members>NetworkName</members>
<name>ManagedTopics</name>
</types>
<version>32.0</version>
</Package>
次の例は、ManagedTopics コンポーネント自体を示します。
<?xml version="1.0" encoding="UTF-8"?>
<ManagedTopics>
<ManagedTopic>
<name>Running</name>
<managedTopicType>Navigational</managedTopicType>
<topicDescription>Training advice</topicDescription>
<position>0</position>
</ManagedTopic>
<ManagedTopic>
<name>Hiking</name>
<managedTopicType>Navigational</managedTopicType>
<topicDescription>Local trails</topicDescription>
<position>1</position>
</ManagedTopic>
<ManagedTopic>
<name>Shoes</name>
<managedTopicType>Featured</managedTopicType>
<topicDescription>Suggested types for each sport</topicDescription>
<position>0</position>
</ManagedTopic>
<ManagedTopic>
<name>Backpacks</name>
<managedTopicType>Featured</managedTopicType>
<topicDescription>Recommended models</topicDescription>
<position>1</position>
</ManagedTopic>
</ManagedTopics>
409
メタデータ型
Metadata
Metadata
これはすべてのメタデータ型の基本クラスです。このオブジェクトを編集することはできません。コンポーネ
ントは、メタデータ型のインスタンスです。
Metadata は、すべての標準オブジェクトを表す sObject に類似しています。Metadata は、メタデータ API ですべて
のコンポーネントと項目を表します。各コンポーネントを ID で識別するのではなく、各カスタムオブジェク
トまたはカスタム項目には一意の fullName があります。この名前は、Salesforceユーザインターフェースでカ
スタムオブジェクトやカスタム項目を作成するときのために、標準オブジェクト名とは異なるものにする必要
があります。
バージョン
Metadata コンポーネントは、API バージョン 10.0 以降で使用できます。
項目
項目名
データ型
説明
fullName
string
必須。コンポーネントの名前。項目の場合、名前には親オ
ブジェクトを指定する必要があります。たとえば、
Account.FirstName などです。fullName を設定する場
合は、__c サフィックスをカスタムオブジェクト名とカス
タム項目名に付加する必要があります。たとえば、カスタ
ムオブジェクトのカスタム項目では fullName が
MyCustomObject__c.MyCustomField__c のようになり
ます。
関連トピック:
CustomObject
CustomField
MetadataWithContent
MetadataWithContent
これは、ドキュメントまたはメールテンプレートなどのコンテンツが含まれるすべてのメタデータ型の基本型
で、Metadata を拡張します。このオブジェクトを編集することはできません。
バージョン
MetadataWithContent コンポーネントは、API バージョン 14.0 以降で使用できます。
410
メタデータ型
MilestoneType
項目
項目名
データ型
説明
content
base64Binary
Base 64 で符号化されたバイナリデータ API コールを行う前
に、クライアントアプリケーションはバイナリ添付データ
を base64 に符号化する必要があります。応答を受信した
ら、クライアントアプリケーションは、base64 データをバ
イナリに復号化する必要があります。この変換は、通常
SOAP クライアントによって処理されます。
fullName
string
必須。コンポーネントの名前。fullName には、アンダー
スコアと英数字のみを使用できます。一意であること、最
初は文字であること、空白は使用しない、最後にアンダー
スコアを使用しない、2 つ続けてアンダースコアを使用し
ないという制約があります。
この項目はMetadata コンポーネントから継承するため、こ
の項目はこのコンポーネントの WSDL で定義されません。
作成時、更新時、または削除時に指定する必要がありま
す。コールにおけるこの項目の例を確認するには、
「create()」を参照してください。
関連トピック:
Metadata
MilestoneType
マイルストンの名前と説明を表します。これらをエンタイトルメントプロセスで使用して、ケースの重要なス
テップを追跡できます。Metadata メタデータ型を拡張し、その fullName 項目を継承します。
ファイルのサフィックスおよびディレクトリの場所
マイルストンタイプは、対応するパッケージディレクトリの milestoneTypes ディレクトリに保存されま
す。拡張子は .milestoneType です。
バージョン
MilestoneType は、API バージョン 27.0 以降で使用できます。
411
メタデータ型
Network
項目
項目名
データ型
説明
description
string
マイルストンの説明。
RecurrenceType
MilestoneTypeRecurrenceType マイルストンの繰り返しのタイプ。API バージョン 29.0 以
(string 型の列挙) 降で利用できます。有効な値は、次のとおりです。
• none — マイルストンの繰り返しがないことを指定し
ます。マイルストンは、エンタイトルメントプロセス
が終了するまでに 1 回のみ発生します。
• recursIndependently — マイルストンが独立して繰
り返すことを指定します。
• recursChained — マイルストンが順次繰り返すこと
を指定します。
宣言的なメタデータの定義のサンプル
これは、マイルストンタイプのサンプルです。
<?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 ファイルを次に示します。
<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<types>
<members>* or a valid name of a milestone type</members>
<name>MilestoneType</name>
</types>
<version>29.0</version>
</Package>
Network
コミュニティを表します。コミュニティとは、従業員、顧客、パートナーがつながることのできるブランド空
間です。ビジネスニーズに合ったコミュニティを複数カスタマイズおよび作成し、コミュニティ間をシームレ
スに移行できます。Salesforce Communities には Network コンポーネントを使用します。Chatter アンサーおよび ア
イデアを含むゾーンを作成する場合は、Community (Zone) コンポーネントを使用します。Metadata メタデータ型
を拡張し、その fullName 項目を継承します。
412
メタデータ型
Network
宣言的なメタデータファイルのサフィックスおよびディレクトリの
場所
Network コンポーネントは、対応するパッケージディレクトリの networks ディレクトリに保存されます。ファ
イル名はコミュニティ名に一致し、拡張子は .network です。
バージョン
このオブジェクトは、API バージョン 28.0 以降で使用できます。
項目
項目
データ型
説明
allowMembersToFlag
boolean
コミュニティのユーザが投稿またはコメント
を不適切としてフラグ付けできるかどうかを
決定します。フラグが付けられた項目は、レ
ビューのためにコミュニティモデレータに送
信されます。API バージョン 29.0 以降で利用で
きます。
branding
Branding
コミュニティで使用する配色、ヘッダー、フッ
ター。
caseCommentEmailTemplate
string
ケースコメントがケースに追加されたか変更
された場合に、コミュニティメンバーに通知
するときに使用されるメールテンプレート。
changePasswordTemplate
string
パスワードがリセットされたことをユーザに
通知するときに使用されるメールテンプレー
ト。
description
string
コミュニティの説明。
emailSenderAddress
string
コミュニティメールの送信元となるメールア
ドレス。
emailSenderName
string
コミュニティメールの送信元となる名前。
enableGuestChatter
boolean
ゲストユーザがログインせずにコミュニティ
の公開 Chatter グループにアクセスできるかど
うかを指定します。
enableInvitation
boolean
ユーザが他のユーザをコミュニティに招待で
きるかどうかを指定します。
enableKnowledgeable
boolean
コミュニティメンバーが、トピックに関する
知識のあるユーザを表示し、その知識につい
413
メタデータ型
項目
Network
データ型
説明
てユーザを支持できるかどうかを決定します。
API バージョン 30.0 以降で使用できます。
enableNicknameDisplay
boolean
コミュニティのほとんどの場所に、ユーザの
氏名ではなくニックネームを表示するかどう
かを示します。デフォルトで false に設定さ
れます。API バージョン 32.0 以降で使用できま
す。
enablePrivateMessages
boolean
コミュニティメンバーが非公開メッセージを
送受信できるかどうかを決定します。API バー
ジョン 30.0 以降で使用できます。
enableReputation
boolean
コミュニティのメンバーに対する評価が計算
および表示されるかどうかを決定します。API
バージョン 31.0 以降で使用できます。
有効な場合、reputationLevels と
reputationPointsRules が使用されます。
データファイルに reputationLevels と
reputationPointsRules のどちらも定義さ
れていない場合、デフォルト値が使用されま
す。
forgotPasswordTemplate
string
ユーザがパスワードを忘れたときに使用され
るメールテンプレート。
networkMemberGroups
NetworkMemberGroups
コミュニティへのアクセス権を持つプロファ
イルおよび権限セット。これらのプロファイ
ルまたは権限セットを持つユーザは、コミュ
ニティのメンバーです。
メモ: コミュニティにも関連付けられて
いる権限セットが (顧客グループの) Chatter
顧客に割り当てられている場合、その
Chatter 顧客はコミュニティに追加されま
せん。
newSenderAddress
string
EmailSenderAddress の新しい値として入力
され、まだ未確認のメールアドレス。ユーザ
が送信元メールアドレスの変更を要求し、確
認メールに正常に応答すると、
NewSenderAddress の値で
EmailSenderAddress の値が上書きされま
す。これが、コミュニティメールの送信元メー
ルアドレスになります。
414
メタデータ型
Network
項目
データ型
説明
picassoSite
string
コミュニティにリンクしている Site.com サイト
の名前。
reputationLevels
ReputationLevelDefinitions
メンバーが特定のアクションを実行してポイ
ントを獲得したときに、メンバーに割り当て
られる評価レベル。
reputationPointsRules
ReputationPointsRules
メンバーが特定の定義済みアクションを実行
したときに獲得するポイント。
selfRegProfile
string
セルフ登録するユーザに割り当てられるプロ
ファイル。この値は、コミュニティで
selfRegistration が有効になっている場合
にのみ使用されます。API バージョン 29.0 以降
で利用できます。
selfRegistration
boolean
コミュニティでセルフ登録が可能かどうかを
指定します。
sendWelcomeEmail
boolean
新しいユーザがコミュニティに追加されたと
きに、お知らせメールを送信するかどうかを
指定します。
site
string
コミュニティに関連付けられているCustomSite。
status
NetworkStatus[]
コミュニティの状況。選択可能な値は次のと
おりです。
• Live — コミュニティがオンラインで、メン
バーはアクセスできます。
• DownForMaintenance — コミュニティは以前
は公開されていましたが、オフラインに
なっています。「コミュニティの作成およ
び設定」権限を持つメンバーは、プロファ
イルまたはメンバー種別に関係なくオフラ
インのコミュニティの設定に引き続きアク
セスできます。メンバーはオフラインのコ
ミュニティにはアクセスできませんが、
ユーザインターフェースのドロップダウン
には引き続き [CommunityName (オフライ
ン)] と表示されます。
• UnderConstruction — コミュニティがまだ公開
されていません。「コミュニティの作成お
よび設定」権限を持つユーザは、プロファ
イルがコミュニティに関連付けられていれ
415
メタデータ型
項目
Network
データ型
説明
ば、この状況のコミュニティにアクセスで
きます。
コミュニティの公開後は、再びこの状況に
なることはありません。
tabs
NetworkTabSet
コミュニティで使用できるタブ。これらのタ
ブは、コミュニティを作成したユーザが選択
します。
urlPathPrefix
string
サイトを他のサイトと区別する、サイトの URL
上のパスの最初の部分。たとえば、サイト URL
が mycompany.force.com/partners である
場合、partners は urlPathPrefix になり
ます。
welcomeTemplate
string
新しいコミュニティメンバーにお知らせメー
ルを送信するときに使用されるメールテンプ
レート。
Branding
コミュニティに適用されるブランド設定と配色を表します。
項目
データ型
説明
loginFooterText
string
コミュニティログインページのフッ
ターに表示されるテキスト。
loginLogo
string
外部ユーザに対してコミュニティ
ログインページに表示されるロゴ。
pageFooter
string
コミュニティページのフッターに
表示される画像。.html ファイルで
ある必要があります。
pageHeader
string
コミュニティページのヘッダーに
表示される画
像。.html、.gif、.jpg、.png ファイル
を使用できます。
primaryColor
string
有効なタブに使用される色。
primaryComplementColor
string
primaryColor で使用されるフォ
ントの色。
quaternaryColor
string
コミュニティのページの背景色。
416
メタデータ型
Network
項目
データ型
説明
quaternaryComplementColor
string
quaternaryColor で使用される
フォントの色。
secondaryColor
string
リストとテーブルの上境界線に使
用される色。
tertiaryColor
string
編集ページと詳細ページのセクショ
ンヘッダーの背景色。
tertiaryComplementColor
string
tertiaryColor で使用されるフォ
ントの色。
zeronaryColor
string
ヘッダーの背景色。
zeronaryComplementColor
string
zeronaryColor で使用されるフォ
ントの色。
NetworkMemberGroup
コミュニティに割り当てられたプロファイルおよび権限セットを表します。いずれかのプロファイルまたは権
限セットを持つユーザは、(顧客グループの) Chatter 顧客でない限り、コミュニティのメンバーです。
項目
データ型
説明
permissionSet
string
コミュニティに割り当てられた権
限セット。
メモ: コミュニティにも関連
付けられている権限セットが
(顧客グループの) Chatter 顧客
に割り当てられている場合、
その Chatter 顧客はコミュニ
ティに追加されません。
string
コミュニティの一部であるプロファ
イル。
項目
データ型
説明
smallImage
string
評価レベルに関連付けられたカス
タム画像。拡張子が .jpeg、.png、ま
たは .gif のファイルを使用します。
profile
ReputationBranding
評価レベルのブランド設定。
417
メタデータ型
項目
Network
データ型
説明
画像はドキュメントとして保存さ
れます。指定されていない場合は、
デフォルトの評価レベル画像が使
用されます。API バージョン 32.0 以
降で使用できます。
ReputationLevelDefinitions
コミュニティ内で特定の定義されたアクションを実行することでメンバーが達成できる評価レベルを表しま
す。
項目
データ型
説明
level
ReputationLevel[]
評価レベルを表します。
ReputationLevel
評価レベルの名前と下限値を表します。上限値はアプリケーションによって計算されます。
項目
データ型
説明
branding
ReputationBranding[]
評価レベルに関連付けられたブラ
ンド設定を表します。具体的には、
評価レベルのカスタム画像です。
この項目は省略可能です。指定さ
れていない場合は、デフォルトの
評価レベル画像が使用されます。
API バージョン 32.0 以降で使用でき
ます。
label
string
評価レベルの名前。
この項目は省略可能です。指定さ
れていない場合、デフォルトが使
用されます。次の 10 個のデフォル
トレベルがあります。
• レベル 1
• レベル 2
• レベル 3
• レベル 4
• レベル 5
• レベル 6
418
メタデータ型
項目
Network
データ型
説明
• レベル 7
• レベル 8
• レベル 9
• レベル 10
lowerThreshold
必須。この評価レベルの範囲の下
限値。たとえば、この評価レベル
がポイント 1 ～ 50 の場合、1 が
lowerThreshold です。
double
ReputationPointsRules
コミュニティのポイントシステムのポイントルールを表します。
項目
データ型
説明
pointsRule
ReputationPointsRule[]
行動とそれに関連付けられたポイ
ントを表します。
ReputationPointsRule
ポイントルールの行動と関連付けられたポイント値を表します。アクションを実行したユーザは、関連付けら
れたポイントを獲得します。
項目
データ型
説明
eventType
string
必須。ポイントを獲得するために
メンバーが実行する必要がある行
動の種別。次の値を使用できます。
• FeedItemWriteAPost
• FeedItemWriteAComment
• FeedItemReceiveAComment
• FeedItemLikeSomething
• FeedItemReceiveALike
• FeedItemMentionSomeone
• FeedItemSomeoneMentionsYou
• FeedItemShareAPost
• FeedItemSomeoneSharesYourPost
points
int
必須。行動を実行してメンバーが
取得するポイント数。行動ごとの
419
メタデータ型
項目
Network
データ型
説明
デフォルトのポイント数は次のと
おりです。
• FeedItemWriteAPost +1
• FeedItemWriteAComment: +1
• FeedItemReceiveAComment: +5
• FeedItemLikeSomething: +1
• FeedItemReceiveALike: +5
• FeedItemMentionSomeone: +1
• FeedItemSomeoneMentionsYou: +5
• FeedItemShareAPost: +1
• FeedItemSomeoneSharesYourPost: +5
NetworkTabSet
項目
データ型
説明
customTab
string
コミュニティの一部であるカスタ
ムタブ。
defaultTab
string
コミュニティの [ホーム] タブ。メン
バーがログインすると、このペー
ジが最初に表示されます。
standardTab
string
コミュニティの一部である標準タ
ブ。
宣言的なメタデータの定義のサンプル
次に、ネットワークの 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>
420
メタデータ型
Network
<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>
<enableNicknameDisplay>false</enableNicknameDisplay>
<enablePrivateMessages>true</enablePrivateMessages>
<enableReputation>true</enableReputation>
<forgotPasswordTemplate>unfiled$public/CommunityForgotPasswordEmailTemplate</forgotPasswordTemplate>
<networkMemberGroups>
<permissionSet>Admin</permissionSet>
<permissionSet>Standard</permissionSet>
<permissionSet>ReadOnly</permissionSet>
<profile>Admin</profile>
<profile>Standard</profile>
<profile>ReadOnly</profile>
</networkMemberGroups>
<reputationLevels>
<level>
<branding>
<smallImage>communities_shared
_document_folder/replevel_beginner.png</smallImage>
</branding>
<label>Beginner</label>
<lowerThreshold>0</lowerThreshold>
</level>
<level>
<branding>
<smallImage>communities_shared
_document_folder/replevel_apprentice.png</smallImage>
</branding>
<label>Apprentice</label>
<lowerThreshold>51</lowerThreshold>
</level>
<level>
<branding>
<smallImage>communities_shared
_document_folder/replevel_gettingthere.png</smallImage>
</branding>
<label>Getting There</label>
<lowerThreshold>101</lowerThreshold>
</level>
<level>
<branding>
<smallImage>communities_shared
421
メタデータ型
Network
_document_folder/replevel_skilled.png</smallImage>
</branding>
<label>Skilled</label>
<lowerThreshold>151</lowerThreshold>
</level>
<level>
<branding>
<smallImage>communities_shared
_document_folder/replevel_expert.png</smallImage>
</branding>
<label>Expert</label>
<lowerThreshold>201</lowerThreshold>
</level>
<level>
<branding>
<smallImage>communities_shared
_document_folder/replevel_mentor.png</smallImage>
</branding>
<label>Mentor</label>
<lowerThreshold>251</lowerThreshold>
</level>
<level>
<branding>
<smallImage>communities_shared
_document_folder/replevel_guru.png</smallImage>
</branding>
<label>Guru</label>
<lowerThreshold>301</lowerThreshold>
</level>
</reputationLevels>
<reputationPointsRules>
<pointsRule>
<eventType>FeedItemWriteAPost</eventType>
<points>5</points>
</pointsRule>
<pointsRule>
<eventType>FeedItemWriteAComment</eventType>
<points>3</points>
</pointsRule>
<pointsRule>
<eventType>FeedItemReceiveAComment</eventType>
<points>10</points>
</pointsRule>
<pointsRule>
<eventType>FeedItemLikeSomething</eventType>
<points>3</points>
</pointsRule>
<pointsRule>
<eventType>FeedItemReceiveALike</eventType>
<points>5</points>
</pointsRule>
<pointsRule>
<eventType>FeedItemMentionSomeone</eventType>
<points>5</points>
422
メタデータ型
Package
</pointsRule>
<pointsRule>
<eventType>FeedItemSomeoneMentionsYou</eventType>
<points>10</points>
</pointsRule>
<pointsRule>
<eventType>FeedItemShareAPost</eventType>
<points>5</points>
</pointsRule>
<pointsRule>
<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)
Package
retrieve() コールの一部として取得するメタデータコンポーネントを指定するため、またはコンポーネント
のパッケージを定義するために使用されます。
423
メタデータ型
Package
名前
型
説明
apiAccessLevel
APIAccessLevel (string 型の列挙) パッケージコンポーネントは、ダイナミック Apex
およびAPI経由でインストールされている組織にあ
る標準オブジェクトやカスタムオブジェクトにア
クセスできます。パッケージをインストールする
システム管理者は、セキュリティの向上のために、
インストール後のこうしたアクセスの制限を望む
場合もあります。有効な値は、次のとおりです。
• Unrestricted — パッケージのコンポーネントに、
コンポーネントが要求を API に送信するときに
ログインしているユーザと同じ標準オブジェク
トへの API アクセス権があります。
• Restricted — コンポーネントがアクセスできる標
準オブジェクトをシステム管理者が選択できま
す。さらに、制限されたパッケージ内のコン
ポーネントは、ユーザの権限で現在のパッケー
ジ内のカスタムオブジェクトへのアクセスが許
可される場合には、それらのオブジェクトにの
みアクセスできます。
詳細は、Salesforce オンラインヘルプの「パッケー
ジの API および動的 Apex アクセスについて」を参
照してください。
description
string
パッケージの簡単な説明。
fullName
string
APIアクセスの一意の識別子として使用されるパッ
ケージ名。fullName には、アンダースコアと英
数字のみを使用できます。一意であること、最初
は文字であること、空白は使用しない、最後にア
ンダースコアを使用しない、2 つ続けてアンダース
コアを使用しないという制約があります。この項
目は、Metadataコンポーネントから継承されていま
す。
namespacePrefix
string
パッケージが作成された開発組織の名前空間。
objectPermissions
ProfileObjectPermissions[]
パッケージにアクセスできるオブジェクトと使用
可能なアクセス権の種類 (作成、参照、更新、削除)
を示します。
setupWeblink
string
パッケージのインストールの説明に使用する Web
リンク。
types
PackageTypeMembers[]
取得するコンポーネントの種類。
version
string
必須。コンポーネントの種類のバージョン。
424
メタデータ型
PermissionSet
PackageTypeMembers
パッケージで取得されるコンポーネントの名前と種類を指定するために使用します。
名前
型
説明
members
string
<name> 要素で指定されている全種類のメタデー
タコンポーネントを取得する、1 つ以上の名前を指
定したコンポーネント、またはワイルドカード文
字 (*)。標準オブジェクトを取得するには、そのオ
ブジェクトを名前で指定します。たとえば、
<members>Account</members> では標準の
Account オブジェクトを取得します。
name
string
取得するメタデータコンポーネントの種類。たと
えば、<name>CustomObject</name> では
<members> 要素で指定されている 1 つ以上のカス
タムオブジェクトを取得します。
関連トピック:
package.xml マニフェストファイルのサンプル
PermissionSet
ユーザのプロファイルを変更せずに、追加権限の許可に使用する権限のセットを表します。アクセスの許可に
権限セットを使用できますが、アクセスの拒否には使用できません。Metadata メタデータ型を拡張し、その
fullName 項目を継承します。
API バージョン 29.0 以降では、プロファイルと権限セットの次の管理コンポーネントのアクセス設定を取得お
よびリリースできます。
• Apex クラス
• アプリケーション
• カスタム項目権限
• カスタムオブジェクト権限
• カスタムタブの設定
• 外部データソース
• レコードタイプ
• Visualforce ページ
詳細は、「package.xml マニフェストファイルのサンプル」 (ページ 23)の「管理コンポーネントへのアクセ
ス」を参照してください。
425
メタデータ型
PermissionSet
宣言的なメタデータファイルのサフィックスおよびディレクトリの
場所
権限セットは permissionsets ディレクトリに保存されます。ファイル名は権限セットのAPI名に一致し、拡
張子は .permissionset です。たとえば、User_Management_Perms という名前の権限セットは
permissionsets/User_Management_Perms.permissionset に保存されます。
バージョン
権限セットは API バージョン 22.0 以降で使用できます。
項目
項目
データ型
説明
applicationVisibilities PermissionSetApplicationVisibility[]
この権限セットに割り当てられているユーザ
に表示されるアプリケーションを示します。
API バージョン 29.0 以降で使用できます。API
バージョン 29.0 では、この項目はカスタムア
プリケーションのみをサポートします。API
バージョン 30.0 以降、この項目は標準アプリ
ケーションとカスタムアプリケーションの両
方をサポートします。
classAccesses
PermissionSetApexClassAccess[]
この権限セットに割り当てられているユーザ
が実行できるメソッドを持つ最上位の Apex ク
ラスを示します。API バージョン 23.0 以降で利
用できます。
customPermissions
PermissionSetCustomPermissions[]
この権限セットに割り当てられているユーザ
が利用可能なカスタム権限を示します。API
バージョン 31.0 以降で使用できます。
description
string
権限セットの説明。最大 255 文字です。
externalDataSourceAccesses PermissionSetExternal
この権限セットに割り当てられているユーザ
が使用できる、ID 種別 [ユーザ] を持つデータ
ソースを示します。API バージョン 27.0 以降で
利用できます。
DataSourceAccess[]
fieldPermissions
PermissionSetFieldPermissions[]
この権限セットに割り当てられているユーザ
がアクセスできる項目、および使用可能なア
クセス権の種類 (参照可能または編集可能) を
示します。API バージョン 23.0 以降で利用でき
ます。
label
string
権限セットの表示ラベル。最大 80 文字です。
426
メタデータ型
PermissionSet
項目
データ型
説明
objectPermissions
PermissionSetObjectPermissions[]
この権限セットに割り当てられているユーザ
がアクセスできるオブジェクト、および使用
可能なアクセス権の種類 (作成、参照、編集、
削除など) を示します。API バージョン 23.0 以
降で利用できます。
pageAccesses
PermissionSetApexPageAccess[]
この権限セットに割り当てられているユーザ
が実行できる Visualforce ページを示します。API
バージョン 23.0 以降で利用できます。
recordTypeVisibilities
PermissionSetRecordTypeVisibility[] この権限セットに割り当てられているユーザ
に表示されるレコードタイプを示します。API
バージョン 29.0 以降で利用できます。無効な
レコードタイプの場合、この項目は取得また
はリリースされません。
tabSettings
PermissionSetTabSetting[]
この権限セットのタブ表示設定を示します。
API バージョン 26.0 以降で利用できます。
userLicense
string
権限セットの[ユーザライセンス]。ユーザラ
イセンスによって、ユーザがアクセスできる
機能の基準が決まります。各ユーザには必ず
1 つのユーザライセンスが割り当てられます。
userPermissions
PermissionSetUserPermission[]
アプリケーション権限またはシステム権限
(「API の有効化」など) と、この権限セットで
有効化されているかどうかを指定します。API
バージョン 28.0 以前では、有効であるか無効
であるかに関係なく、この項目ですべてのユー
ザ権限が取得されます。API バージョン 29.0 以
降では、有効なユーザ権限のみが取得されま
す。
PermissionSetApplicationVisibility
PermissionSetApplicationVisibility は、この権限セットに割り当てられているユーザにアプリケーションが表示され
るかどうかを決定します。
項目名
データ型
説明
application
string
必須。アプリケーションの名前。
visible
boolean
必須。この権限セットに割り当てられているユーザにこの
アプリケーションが表示されるか (true)、否か (false) を
示します。
427
メタデータ型
PermissionSet
PermissionSetApexClassAccess
PermissionSetApexClassAccess は権限セットに割り当てられているユーザの Apex クラスのアクセス権を表します。
項目
データ型
説明
apexClass
string
必須。Apex クラス名。
enabled
boolean
必須。この権限セットに割り当てられているユーザが
最上位クラスのメソッドを実行できるか (true)、否か
(false) を示します。
PermissionSetCustomPermissions
PermissionSetCustomPermissions は権限セットに割り当てられているユーザのカスタムアクセス権限を表します。
取得できるのは有効なカスタム権限のみです。
項目名
データ型
説明
enabled
boolean
必須。カスタム権限が有効化されているか (true)、否か
(false) を示します。
name
string
必須。カスタム権限名。
PermissionSetExternalDataSourceAccess
PermissionSetExternalDataSourceAccess は、ID 種別 [ユーザ] を持つユーザのデータソースアクセス権を表します。
API バージョン 27.0 以降で利用できます。
項目
データ型
説明
enabled
boolean
必須。データソースが有効化されているか (true)、否
か (false) を示します。
externalDataSource
string
外部データソースの名前。
PermissionSetFieldPermissions
PermissionSetFieldPermissions は権限セットに割り当てられているユーザの項目権限を表します。API バージョン
30.0 以降では、必須項目の権限の取得やリリースはできません。
項目
データ型
説明
editable
boolean
必須。この権限セットに割り当てられているユーザが
項目を編集できるか (true)、否か (false) を示しま
す。
428
メタデータ型
PermissionSet
項目
データ型
説明
field
string
必須。項目のAPI名 (Warehouse__c.Description__c
など)。
readable
boolean
この権限セットに割り当てられているユーザが項目を
参照できるか (true)、否か (false) を示します。
PermissionSetObjectPermissions
PermissionSetObjectPermissions は権限セットのオブジェクト権限を表します。権限ごとにこれらの要素の 1 つを使
用します。
項目
データ型
説明
allowCreate
boolean
必須。この権限セットに割り当てられているユーザが
object 項目で参照されているオブジェクトを作成で
きるか (true)、否か (false) を示します。
allowDelete
boolean
必須。この権限セットに割り当てられているユーザが
object 項目で参照されているオブジェクトを削除で
きるか (true)、否か (false) を示します。
allowEdit
boolean
必須。この権限セットに割り当てられているユーザが
object 項目で参照されているオブジェクトを編集で
きるか (true)、否か (false) を示します。
allowRead
boolean
必須。この権限セットに割り当てられているユーザが
object 項目で参照されているオブジェクトを参照で
きるか (true)、否か (false) を示します。
modifyAllRecords
boolean
必須。オブジェクトの共有設定に関係なく、この権限
セットに割り当てられているユーザが object 項目で
参照されているオブジェクトを参照、編集、または削
除できるか (true)、否か (false) を示します。これに
は非公開レコード (親オブジェクトを持たないレコー
ド)を含みます。これは「すべてのデータの編集」ユー
ザ権限と似ていますが、個別のオブジェクトレベルに
限定されます。
object
string
必須。オブジェクトの API 名 (Warehouse__c など)。
viewAllRecords
boolean
必須。オブジェクトの共有設定に関係なく、この権限
セットに割り当てられているユーザが object 項目で
参照されているオブジェクトを参照できるか (true)、
否か (false) を示します。これには非公開レコード
(親オブジェクトを持たないレコード) を含みます。こ
429
メタデータ型
項目
PermissionSet
データ型
説明
れは「すべてのデータの参照」ユーザ権限と似ていま
すが、個別のオブジェクトレベルに限定されます。
PermissionSetApexPageAccess
PermissionSetApexPageAccess は権限セットに割り当てられているユーザの Visualforce ページのアクセス権を表しま
す。
項目
データ型
説明
apexPage
string
必須。Visualforce ページ名。
enabled
boolean
必須。この権限セットに割り当てられているユーザが
Visualforce ページを実行できるか (true)、否か (false)
を示します。
PermissionSetRecordTypeVisibility
PermissionSetRecordTypeVisibility は、この権限セットのレコードタイプが表示されるかどうかを表します。
項目
データ型
説明
recordType
string
必須。Account.MyRecordType などのレコードタイ
プ名。
visible
boolean
必須。レコードタイプがこの権限セットに割り当てら
れているユーザに表示されるか (true)、否か (false)
を示します。
PermissionSetTabSetting
PermissionSetTabSetting は権限セットのタブ設定を表します。
項目
データ型
説明
tab
string
必須。タブ名。
visibility
PermissionSetTabVisibility (string 必須。タブの表示設定を示します。有効な値は、次の
型の列挙)
とおりです。
• Available — このタブは [すべてのタブ] ページで
利用できます。各ユーザは、どのアプリケーショ
ンでもタブが表示されるように表示をカスタマイ
ズできます。
430
メタデータ型
項目
PermissionSet
データ型
説明
• None — このタブは [すべてのタブ] ページでは利
用できず、どのアプリケーションにも表示されま
せん。
• Visible — タブは [すべてのタブ] ページで利用で
き、関連付けられているアプリケーションの表示
タブに表示されます。各ユーザは、表示をカスタ
マイズしてタブを非表示にしたり、その他のアプ
リケーションで表示したりできます。
PermissionSetUserPermission
PermissionSetUserPermission は権限セットのアプリケーション権限またはシステム権限を表します。権限ごとにこ
れらの要素の 1 つを使用します。
項目
データ型
説明
enabled
boolean
必須。権限が有効化されるか (true)、無効化されるか
(false) を示します。
name
string
必須。権限の名前。
宣言的なメタデータの定義のサンプル
権限セットを追加または変更するときは、すべての権限を含める必要はありません。含める必要があるのは、
追加または変更する権限のみです。
<?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 manage
employees.</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>
431
メタデータ型
PermissionSet
<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>
<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
コンポーネントも取得する必要があります。
<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<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>
</types>
432
メタデータ型
Portal
<version>32.0</version>
</Package>
Portal
Portal メタデータ型はパートナーポータルまたはカスタマーポータルを表します。Metadata を拡張し、その
fullName 項目を継承します。このメタデータ型を使用するには、組織でパートナーポータルまたはカスタ
マーポータルが有効になっている必要があります。詳細は、Salesforceオンラインヘルプの「パートナーポータ
ルの概要」および「カスタマーポータルの有効化」を参照してください。
宣言的なメタデータファイルのサフィックスおよびディレクトリの
場所
Force.com Portal コンポーネントは、対応するパッケージディレクトリの portals ディレクトリに保存されま
す。ファイル名はポータル名に一致し、拡張子は .portal です。
バージョン
Force.com Portal コンポーネントは、API バージョン 15.0 以降で使用できます。
項目
項目
データ型
説明
active
boolean
必須。このポータルが有効であるかどうかを示しま
す。
admin
string
ポータルの管理者として指定するユーザの氏名。
defaultLanguage
string
ポータルの HTML メッセージのデフォルト言語。米
国英語では en_US など、言語の略語を使用します。
description
string
ポータルの説明。
emailSenderAddress
string
必須。設定済みのテンプレートを使用してポータル
からメールを送信するときに使用されるメールアド
レス (パスワードをリセットする場合など) 。
emailSenderName
string
必須。設定済みのテンプレートを使用してポータル
からメールを送信するときに表示する名前(パスワー
ドをリセットする場合など)。
enableSelfCloseCase
boolean
カスタマーポータルで、ポータルユーザが自分の
ケースをクローズすることを許可します。
433
メタデータ型
Portal
項目
データ型
説明
footerDocument
string
このポータルのフッターとして使用されるファイ
ル。
forgotPassTemplate
string
ユーザが[パスワードを忘れた場合]リンクをクリッ
クしたときに使用するメールテンプレート。
fullName
string
必須。ポータルの名前。
Metadata から継承されるこの項目は、このメタデー
タ型の WSDL では定義されません。作成時、更新時、
または削除時に指定する必要があります。コールに
おけるこの項目の例を確認するには、「create()」
を参照してください。
headerDocument
string
このポータルのヘッダーとして使用されるファイ
ル。
isSelfRegistrationActivated boolean
このポータルでセルフ登録が有効かどうかを決定し
ます。
loginHeaderDocument
string
このポータルのログインページのヘッダーとして使
用されるファイル。
logoDocument
string
このポータルのロゴとして使用されるファイル。
logoutUrl
string
ログアウト時のユーザのリダイレクト先の URL。
newCommentTemplate
string
新規ケースコメントの自動通知に使用されるメール
テンプレート。
newPassTemplate
string
パスワードリセットの自動通知に使用されるメール
テンプレート。
newUserTemplate
string
新規ユーザ作成時の自動通知に使用されるメールテ
ンプレート。
ownerNotifyTemplate
string
所有者変更時の自動通知に使用されるメールテンプ
レート。
selfRegNewUserUrl
string
セルフ登録ページの URL。
selfRegUserDefaultProfile string
セルフ登録したユーザのデフォルトのプロファイ
ル。
selfRegUserDefaultRole PortalRoles (string 型の列挙)
セルフ登録したユーザのデフォルトのロール。有効
な値は、次のとおりです。
• Executive
• Manager
• User
434
メタデータ型
項目
PostTemplate
データ型
説明
• PersonAccount
selfRegUserTemplate
セルフ登録の自動通知に使用されるメールテンプ
レート。
string
このポータルでアクションに対する確認メッセージ
を表示するか、否かを決定します。
showActionConfirmation boolean
stylesheetDocument
string
このポータルの CSS スタイルシートとして使用され
る Document オブジェクト。
type
PortalType (string 型の列挙)
必須。このポータルのタイプ。有効な値は、次のと
おりです。
• 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
PostTemplate
[Chatter での承認] の承認投稿テンプレートに関連付けられたメタデータを表します。承認投稿テンプレートで
は、Chatter フィードに表示される承認申請投稿に含まれる情報をカスタマイズできます。Metadata メタデータ
型を拡張し、その fullName 項目を継承します。
435
メタデータ型
PostTemplate
メモ:
• 承認が有効化されており、Chatter フィード追跡がサポートされているオブジェクトに限り、承認投稿
テンプレートを作成できます。オブジェクトのフィード追跡が有効になっていない場合は、投稿テン
プレートを承認プロセスに関連付けることはできません。
• カスタム項目を削除すると、その項目が参照するすべての承認投稿テンプレートから削除されます。
既存の投稿は影響を受けません。カスタム項目を復元すると、[選択可能な項目] リストには復元され
ますが、以前にその項目が含まれていた承認投稿テンプレートには復元されません。
• カスタムオブジェクトを削除 (または復元) すると、関連付けられている承認投稿テンプレートと、
Chatter フィードにすでに存在する、そのオブジェクトの承認申請投稿も削除 (または復元) されます。
• カスタムオブジェクトの名前を変更すると、そのオブジェクトに関連付けられている承認投稿テンプ
レートもそれに応じて更新されます。
• 1 つ以上の承認プロセスに対応するカスタム承認投稿テンプレートを作成できますが、承認プロセス
にカスタム投稿テンプレートを関連付ける前に [Chatter での承認] を有効にする必要があります。
ファイルのサフィックスおよびディレクトリの場所
PostTemplate コンポーネントのサフィックスは .postTemplate で、postTemplates フォルダに保存されま
す。
バージョン
PostTemplate コンポーネントは、API バージョン 29.0 以降で使用できます。
項目
項目名
データ型
説明
default
boolean
必須。指定されたオブジェクトのデフォルト投稿テンプレートと
するかどうかを指定します。
true に設定すると、同じオブジェクトに関連付けられた投稿テ
ンプレートを指定していない承認プロセスでこの投稿テンプレー
トが使用されます。
オブジェクトにデフォルト投稿テンプレートが設定されていない
場合、そのオブジェクトの承認プロセスに独自の投稿テンプレー
トが指定されていない限り、各承認プロセスでシステムのデフォ
ルト投稿テンプレートが使用されます。
description
string
投稿テンプレートの説明 (省略可能)。
436
メタデータ型
Profile
項目名
データ型
説明
fields
string[]
必須。承認申請投稿に含める最大 4 つの項目の配列。
承認オブジェクトを主従関係の従オブジェクトに設定した場合、
[所有者] 項目は、承認ページレイアウトまたは承認投稿テンプ
レートに使用できません。
label
string
必須。投稿テンプレートの名前。この一意ではない表示ラベル
は、投稿テンプレートの一意の名前とは異なります。
宣言的なメタデータの定義のサンプル
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 コンポーネントを参照するパッケージマニフェストの例を次に示します。
<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<types>
<members>Lead.leadtemplate</members>
<name>PostTemplate</name>
</types>
<version>29.0</version>
</Package>
Profile
ユーザプロファイルを表します。プロファイルは、Salesforce内でさまざまな機能を実行するためのユーザの権
限を定義します。Metadata メタデータ型を拡張し、その fullName 項目を継承します。
API バージョン 29.0 以降では、プロファイルと権限セットの次の管理コンポーネントのアクセス設定を取得お
よびリリースできます。
• Apex クラス
• アプリケーション
• カスタム項目権限
• カスタムオブジェクト権限
• カスタムタブの設定
• 外部データソース
437
メタデータ型
Profile
• レコードタイプ
• Visualforce ページ
詳細は、「package.xml マニフェストファイルのサンプル」 (ページ 23)の「管理コンポーネントへのアクセ
ス」を参照してください。
宣言的なメタデータファイルのサフィックスおよびディレクトリの
場所
ファイルのサフィックスは、.profile です。各プロファイルに 1 つのファイルがあり、対応するパッケージ
ディレクトリの profiles フォルダに保存されます。
バージョン
プロファイルは、API バージョン 10.0 以降で使用できます。
項目
メタデータ API で返されるプロファイルのコンテンツは、RetrieveRequest メッセージ内で要求されるコンテンツ
によって異なります。たとえば、プロファイルには、プロファイルと同じ RetrieveRequest で返されたカスタム
オブジェクトに含まれている項目の項目レベルのセキュリティのみが含まれます。プロファイルの定義には次
の項目が含まれます。
項目名
データ型
説明
applicationVisibilities ProfileApplicationVisibility[]
このプロファイルに割り当てられているユー
ザに表示されるアプリケーションを示します。
API バージョン 29.0 以前では、この項目はカス
タムアプリケーションのみをサポートします。
API バージョン 30.0 以降、この項目は標準アプ
リケーションとカスタムアプリケーションの
両方をサポートします。
classAccesses
ProfileApexClassAccess[]
このプロファイルに割り当てられているユー
ザが実行できるメソッドを持つ最上位の Apex
クラスを示します。
custom
boolean
プロファイルがカスタムプロファイルか
(true)、標準プロファイルか (false) を示しま
す。API バージョン 30.0 以降で利用できます。
customPermissions
ProfileCustomPermissions[]
このプロファイルに割り当てられているユー
ザが利用可能なカスタム権限を示します。API
バージョン 31.0 以降で使用できます。
description
string
プロファイルの説明。最大 255 文字です。API
バージョン 30.0 以降で利用できます。
438
メタデータ型
項目名
Profile
データ型
説明
externalDataSourceAccesses ProfileExternalDataSourceAccess[]
このプロファイルに割り当てられたユーザが
使用できる、ID 種別が [ユーザ] のデータソー
スを示します。API バージョン 27.0 以降で利用
できます。
fieldLevelSecurities
ProfileFieldLevelSecurity[]
このプロファイルに割り当てられているユー
ザに表示される項目、および使用可能なアク
セス権の種類 (編集可能または非表示) を示し
ます。この項目は、API バージョン 22.0 以前で
使用できます。
fieldPermissions
ProfileFieldLevelSecurity[]
このプロファイルに割り当てられているユー
ザに表示される項目、および使用可能なアク
セス権の種類 (編集可能または参照可能) を示
します。この項目はAPIバージョン 23.0 以降で
使用できます。
fullName
string
名前には、英数字、およびアンダースコア (_)
文字のみを使用できます。また、最初は文字
とし、最後にアンダースコアを使用したり、
連続した 2 つのアンダースコア文字を含めた
りすることはできません。
この項目はMetadata コンポーネントから継承
するため、この項目はこのコンポーネントの
WSDL で定義されません。作成時、更新時、ま
たは削除時に指定する必要があります。コー
ルにおけるこの項目の例を確認するには、
「create()」を参照してください。
layoutAssignments
ProfileLayoutAssignments[]
このプロファイルで使用するレイアウトを示
します。
loginHours
ProfileLoginHours[]
このプロファイルを持つユーザがログインで
きる時間を示します。指定されていない場合、
ユーザのログイン時間はプロファイルによっ
て制限されません。
この項目はAPIバージョン 25.0 以降で使用でき
ます。
loginIpRanges
ProfileLoginIpRange[]
特定のプロファイルを持つユーザがログイン
できる IP アドレスの範囲のリスト。
この項目はAPIバージョン 17.0 以降で使用でき
ます。
439
メタデータ型
Profile
項目名
データ型
説明
objectPermissions
ProfileObjectPermissions[]
このプロファイルに割り当てられているユー
ザがアクセスできるオブジェクト、および使
用可能なアクセス権の種類 (作成、参照、編
集、削除など) を示します。APIバージョン 28.0
以降、この項目は allowRead が true の場
合にのみ取得されます。
pageAccesses
ProfileApexPageAccess[]
このプロファイルに割り当てられているユー
ザが実行できるVisualforceページを示します。
recordTypeVisibilities
ProfileRecordTypeVisibility[]
このプロファイルに割り当てられているユー
ザのレコードタイプの表示設定を示します。
API バージョン 29.0 以降では、無効なレコード
タイプの場合、この項目は取得またはリリー
スされません。
tabVisibilities
ProfileTabVisibility[]
このプロファイルに割り当てられているユー
ザに表示されるレコードタイプ、および表示
されるアプリケーション内のタブを示します。
userLicense
string
プロファイルの[ユーザライセンス]。ユーザ
ライセンスによって、ユーザがアクセスでき
る機能の基準が決まります。各ユーザには必
ず 1 つのユーザライセンスが割り当てられま
す。
この項目はAPIバージョン 17.0 以降で使用でき
ます。
userPermissions
ProfileUserPermission[]
ユーザ権限 (「API の有効化」など) を指定しま
す。また、このプロファイルでその権限が有
効化されているかどうかも指定します。この
項目は、有効なユーザ権限のみを取得します。
API バージョン 29.0 以降で利用できます。
ProfileApplicationVisibility
ProfileApplicationVisibility はこのプロファイルに割り当てられているユーザにアプリケーションが表示されるかど
うかを決定します。
項目名
データ型
説明
application
string
必須。アプリケーションの名前。
default
boolean
必須。アプリケーションがデフォルトのアプリケーション
であるか (true)、否か (false) を示します。プロファイル
440
メタデータ型
項目名
Profile
データ型
説明
ごとに 1 つのアプリケーションのみを true に設定できま
す。
visible
boolean
必須。このプロファイルに割り当てられているユーザにこ
のアプリケーションが表示されるか (true)、否か (false)
を示します。
ProfileApexClassAccess
ProfileApexClassAccess は、このプロファイルに割り当てられているユーザが実行できるメソッドを持つ最上位の
Apex クラスを決定します。
項目名
データ型
説明
apexClass
string
必須。Apex クラス名。
enabled
boolean
必須。このプロファイルに割り当てられているユーザが最
上位クラスのメソッドを実行できるか (true)、否か (false)
を示します。
ProfileCustomPermissions
ProfileCustomPermissions はプロファイルに割り当てられているユーザのカスタムアクセス権限を表します。取得
できるのは有効なカスタム権限のみです。
項目名
データ型
説明
enabled
boolean
必須。カスタム権限が有効化されているか (true)、否か
(false) を示します。
name
string
必須。カスタム権限名。
ProfileExternalDataSourceAccess
ProfileExternalDataSourceAccess は、ID 種別が [ユーザ] のユーザのデータソースアクセスを表します。API バージョ
ン 27.0 以降で利用できます。
項目名
データ型
説明
enabled
boolean
必須。データソースが有効化されているか (true)、否か
(false) を示します。
externalDataSource
string
外部データソースの名前。
441
メタデータ型
Profile
ProfileFieldLevelSecurity
ProfileFieldLevelSecurity は、プロファイルに割り当てられているユーザの項目レベルセキュリティを表します。
API バージョン 30.0 以降では、必須項目の権限の取得やリリースはできません。
項目名
データ型
説明
editable
boolean
必須。この項目が編集可能か (true)、否か (false) を示し
ます。
API バージョン 30.0 以降、新しいカスタム項目をリリース
するとき、この項目はデフォルトで false になります。
field
string
必須。項目の名前を示します。
hidden
boolean
この項目が非表示であるか (true)、否か (false) を示しま
す。この項目は、APIバージョン 22.0 以前で使用できます。
ポータルプロファイルの場合、これは API バージョン 19.0
以降ではデフォルトで true に設定されています。
readable
boolean
この項目が参照可能か (true)、否か (false) を示します。
この項目は API バージョン 23.0 以降で使用できます。これ
は、hidden 項目の代わりに使用されます。
API バージョン 30.0 以降、新しいカスタム項目をリリース
するとき、この項目はデフォルトで false になります。
ポータルプロファイルの場合、これはデフォルトで false
に設定されています。
ProfileLayoutAssignments
ProfileLayoutAssignments はプロファイルおよび特定のエンティティで使用するレイアウトを決定します。
項目名
データ型
説明
layout
string
必須。この特定のエンティティのレイアウトを示します。
recordType
string
この項目は省略可能です。レコードの recordType がレ
イアウトの割り当てルールに一致する場合、指定されてい
るレイアウトを使用します。
ProfileLoginHours
ProfileLoginHours は、特定のプロファイルを持つユーザがログインできる期間を制限します。
442
メタデータ型
Profile
項目名
データ型
説明
weekdayStart
string
このプロファイルを持つユーザがログインできる曜日の開
始時刻を指定します。特定の曜日の開始時刻が指定されて
いる場合、その曜日の終了時刻も指定する必要がありま
す。特定の曜日の Start を End より大きな値に設定すること
はできません。
• weekday の有効な値は、monday、tuesday、
wednesday、thursday、friday、saturday、または
sunday です。たとえば、mondayStart は、月曜日の
ログイン期間の開始を示します。
• Start に使用できる値は、午前 0 時からの分数です。60 (1
時間) で割り切れる値である必要があります。たとえ
ば、300 は、午前 5 時です。
string
weekdayEnd
このプロファイルを持つユーザがログアウトする必要のあ
る曜日の時刻を指定します。
• weekday の有効な値は、monday、tuesday、
wednesday、thursday、friday、saturday、または
sunday です。たとえば、mondayEnd は、月曜日のロ
グイン期間の終了時刻を指定します。
• End に使用できる値は、午前 0 時からの分数です。60 (1
時間) で割り切れる値である必要があります。たとえ
ば、1020 は、午後 5 時です。
プロファイルから以前に設定されたログイン時間帯の制限を削除するには、開始時刻または終了時刻を含まな
い、空の loginHours タグを明示的に含める必要があります。
ProfileLoginIpRange
ProfileLoginIpRange IP は、特定のプロファイルを持つユーザがログインできる IP アドレスの範囲を定義します。
項目名
データ型
説明
description
string
この項目は、この範囲に対応するネットワークの部分な
ど、範囲の目的を識別するために使用します。この項目は
API バージョン 31.0 以降で使用できます。
endAddress
string
必須。範囲の最後の IP アドレス。
startAddress
string
必須。範囲の最初の IP アドレス。
443
メタデータ型
Profile
ProfileObjectPermissions
ProfileObjectPermissions は、オブジェクトへのユーザのアクセス権を表します。
メモ: API バージョン 18.0 以降では、「すべてのデータの参照」または「すべてのデータの編集」が無効
化されているすべてのプロファイルの新しいカスタムオブジェクトで、これらの権限は無効化されてい
ます。
項目名
データ型
説明
allowCreate
boolean
このプロファイルに割り当てられているユーザが object
項目で参照されているオブジェクトを作成できるか(true)、
否か (false) を示します。
この項目は、バージョン 14.0 より前のバージョンでは
revokeCreate という名前でロジックが逆でした。バー
ジョン間での項目名の変更および true から false への
更新およびその逆の処理も自動的に処理されます。そのた
め、既存の XML コンポーネントファイルを手動で編集する
必要は一切ありません。バージョン間での項目名の変更お
よび true から false への更新およびその逆の処理も自
動的に処理されます。そのため、既存の XML コンポーネン
トファイルを手動で編集する必要は一切ありません。
allowDelete
boolean
このプロファイルに割り当てられているユーザが object
項目で参照されているオブジェクトを削除できるか(true)、
否か (false) を示します。
この項目は、バージョン 14.0 より前のバージョンでは
revokeDelete という名前でロジックが逆でした。バー
ジョン間での項目名の変更および true から false への
更新およびその逆の処理も自動的に処理されます。そのた
め、既存の XML コンポーネントファイルを手動で編集する
必要は一切ありません。
allowEdit
boolean
このプロファイルに割り当てられているユーザが object
項目で参照されているオブジェクトを編集できるか(true)、
否か (false) を示します。
この項目は、バージョン 14.0 より前のバージョンでは
revokeEdit という名前でロジックが逆でした。バージョ
ン間での項目名の変更および true から false への更新
およびその逆の処理も自動的に処理されます。そのため、
既存の XML コンポーネントファイルを手動で編集する必要
は一切ありません。
444
メタデータ型
Profile
項目名
データ型
説明
allowRead
boolean
このプロファイルに割り当てられているユーザが object
項目で参照されているオブジェクトを表示できるか(true)、
否か (false) を示します。
この項目は、バージョン 14.0 より前のバージョンでは
revokeRead という名前でロジックが逆でした。バージョ
ン間での項目名の変更および true から false への更新
およびその逆の処理も自動的に処理されます。そのため、
既存の XML コンポーネントファイルを手動で編集する必要
は一切ありません。
modifyAllRecords
boolean
オブジェクトの共有設定に関係なく、このプロファイルに
割り当てられているユーザが object 項目で参照されてい
るオブジェクトを参照、編集、または削除できるか(true)、
否か (false) を示します。これは、個別のオブジェクトレ
ベルに限定されている「すべてのデータの編集」ユーザ権
限と同じです。これは、APIバージョン 15.0 の新項目です。
メモ: この項目はすべてのオブジェクトで利用できる
わけではありません。これらの権限を現在サポート
しているオブジェクトを確認するには、ユーザイン
ターフェースのプロファイルを参照してください。
「すべてのデータの編集」を持つプロファイルは、
メタデータ API の modifyAllRecords エントリを無
視するため、プロファイルで「すべてのデータの編
集」が有効化されている場合はエラーを返しません。
object
string
必須。MyCustomObject__c など、このプロファイルで権
限が変更されるオブジェクトの名前。
viewAllRecords
boolean
オブジェクトの共有設定に関係なく、このプロファイルに
割り当てられているユーザが object 項目で参照されてい
るオブジェクトを参照できるか (true)、否か (false) を示
します。これには非公開レコード (親オブジェクトを持た
ないレコード) を含みます。これは、個別のオブジェクト
レベルに限定されている「すべてのデータの参照」ユーザ
権限と同じです。これは、API バージョン 15.0 の新項目で
す。
メモ: この項目はすべてのオブジェクトで利用できる
わけではありません。これらの権限を現在サポート
しているオブジェクトを確認するには、ユーザイン
ターフェースのプロファイルを参照してください。
「すべてのデータの参照」を持つプロファイルは、
メタデータ API の viewAllRecords エントリを無視
445
メタデータ型
項目名
Profile
データ型
説明
するため、プロファイルで「すべてのデータの参照」
が有効化されている場合はエラーを返しません。
ProfileApexPageAccess
ProfileApexPageAccess では、このプロファイルに割り当てられているユーザが実行できるVisualforceページを決定
します。
項目名
データ型
説明
apexPage
string
必須。Visualforce ページ名。
enabled
boolean
必須。このプロファイルに割り当てられているユーザが
Visualforce ページを実行できるか (true)、否か (false) を示
します。
ProfileRecordTypeVisibility
ProfileRecordTypeVisibility は、このプロファイルのレコードタイプの表示設定を表します。レコードタイプを使用
すると、異なるビジネスプロセス、選択リストの値、およびページレイアウトを、さまざまなユーザに提供で
きます。
項目名
データ型
説明
default
boolean
必須。レコードタイプがこのプロファイルとオブジェクト
のペアのデフォルトであるか (true)、否か (false) を示し
ます。オブジェクトあたりに許可されるデフォルトは 1 つ
のみです。
personAccountDefault
boolean
レコードタイプがこのプロファイルとオブジェクトのペア
のデフォルトの個人取引先レコードタイプであるか(true)、
否か (false) を示します。オブジェクトあたりに許可され
る個人取引先レコードタイプのデフォルトは 1 つのみで
す。この項目は、取引先または取引先責任者オブジェクト
のレコードタイプにのみ関連します。
個人取引先は、貴社が提供する金融サービス、オンライン
ショップ、または旅行代理店サービスの利用者など、貴社
と取引がある個人の顧客を表します。個人取引先は、企業
間取引モデルではなく、企業対消費者取引モデルのビジネ
ス形態を持つ組織に適用できます。
個人取引先についての詳細は、Salesforce オンラインヘルプ
の「個人取引先とは?」を参照してください。個人取引先
は、Salesforce ではデフォルトで無効になっています。個人
446
メタデータ型
項目名
Profile
データ型
説明
取引先の利用が必要な場合は、salesforce.com にお問い合わ
せください。
recordType
string
必須。Account.MyRecordType などのレコードタイプ名。
visible
boolean
必須。このレコードタイプがこのプロファイルに割り当て
られているユーザに表示されるか (true)、否か (false) を
示します。
ProfileTabVisibility
ProfileTabVisibility はこのプロファイルのタブの表示設定を表します。バージョン 17.0 以降では、ProfileTabVisibility
は標準オブジェクトのタブの表示設定をサポートしています。マニフェストファイルには、プロファイルのタ
ブの表示設定を取得するための標準タブに対応する標準オブジェクトを含める必要があります。
項目名
データ型
説明
tab
string
必須。タブの名前。
visibility
TabVisibility (string 型 必須。タブの表示設定を示します。有効な値は、次のとお
の列挙)
りです。
• DefaultOff — このタブは [すべてのタブ] ページで利
用できます。各ユーザは、どのアプリケーションでも
タブが表示されるように表示をカスタマイズできます。
• DefaultOn — タブは [すべてのタブ] ページで利用で
き、関連付けられているアプリケーションの表示タブ
に表示されます。各ユーザは、表示をカスタマイズし
てタブを非表示にしたり、その他のアプリケーション
で表示したりできます。
• Hidden — このタブは [すべてのタブ] ページでは利用
できず、どのアプリケーションにも表示されません。
ProfileUserPermission
ProfileUserPermissionは、プロファイルのアプリケーション権限またはシステム権限を表します。権限ごとにこれ
らの要素の 1 つを使用します。
項目
データ型
説明
enabled
boolean
必須。権限が有効化されるか (true)、無効化されるか
(false) を示します。
name
string
必須。権限名。
447
メタデータ型
Profile
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);
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 =
448
メタデータ型
Profile
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 sheet
RecordType edit = new RecordType();
edit.setFullName("ExpenseReport__c.Edit");
RecordTypePicklistValue editStatuses =
new RecordTypePicklistValue();
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 =
449
メタデータ型
Profile
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 要素が含まれています。そのため、返されたプロファイル
には組織のすべてのカスタムオブジェクトのオブジェクトおよび項目権限が含まれますが、Account などの標
準オブジェクト、および標準項目の権限は含まれません。
<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<types>
<members>*</members>
<name>CustomObject</name>
450
メタデータ型
Profile
</types>
<types>
<members>*</members>
<name>Profile</name>
</types>
<version>32.0</version>
</Package>
CustomObject のワイルドカード「*」は標準オブジェクトに一致しません。これは、意図しない大きな影響を及
ぼすプロファイルの変更を避けるうえで役立ちます。Developer Edition 組織のいくつかのカスタムオブジェクト
を作成し、その情報を retrieve() (取得) し、次にカスタムオブジェクトを本番組織に deploy() (リリース)
する場合、Account などのすべての標準オブジェクトのプロファイルおよび項目レベルのセキュリティ、およ
び標準項目は、標準オブジェクトまたは項目の個別の types 要素を明示的に作成しない限り上書きされませ
ん。
メタデータ API では、予期しないプロファイルの変更を回避するため、retrieve() コールに標準項目を含め
ることが意図的に若干困難になっています。ただし、Account などの標準オブジェクトのカスタム項目と標準
項目のプロファイル権限を取得およびリリースすることはできます。
次の package.xml ファイルでは、Account 標準項目とカスタム項目のプロファイル権限を返すことができま
す。CustomObject 型のメンバーとして標準の Account オブジェクトを指定することにより、types 要素内でこの
オブジェクトがどのように定義されるかに注目してください。
<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<types>
<members>Account</members>
<name>CustomObject</name>
</types>
<types>
<members>*</members>
<name>Profile</name>
</types>
<version>32.0</version>
</Package>
最後の package.xml ファイルでは、Account オブジェクトの MyCustomField__c カスタム項目のプロファイ
ル権限を返すことができます。
<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<types>
<members>Account.MyCustomField__c</members>
<name>CustomField</name>
</types>
<types>
<members>*</members>
<name>Profile</name>
</types>
<version>32.0</version>
</Package>
451
メタデータ型
Queue
Queue
処理する前にアイテムを置いておく領域を表します。
宣言的なメタデータファイルのサフィックスおよびディレクトリの
場所
キューコンポーネントのファイルサフィックスは .queue で、コンポーネントは対応するパッケージディレク
トリの queues ディレクトリに保存されます。このコンポーネントは、ケース、リード、サービス契約 (エン
タイトルメントが有効である場合)、およびカスタムオブジェクトをサポートします。
バージョン
キューコンポーネントは、API バージョン 24.0 以降で使用できます。
項目
このメタデータ型はキューを定義する有効な値を表します。
項目名
データ型
doesSendEmailToMembers boolean
説明
新しいレコードがキューに追加されたときに、メールが
キューメンバーに送信されるか (true)、否か (false) を示
します。
email
string
キューの所有者のメールアドレス。
fullName
string
APIアクセスの一意の識別子。fullName には、アンダース
コアと英数字のみを使用できます。一意であること、最初
は文字であること、空白は使用しない、最後にアンダース
コアを使用しない、2 つ続けてアンダースコアを使用しな
いという制約があります。この項目は、Metadata コンポー
ネントから継承されています。ユーザインターフェースの
[キュー名] に対応します。
name
string
必須。キューの名前。ユーザインターフェースの [表示ラ
ベル] に対応します。
queueSobject
QueueSobject[]
サポートされているエンティティ種別を示します。
QueueSobject
QueueSobject ではキューがサポートするエンティティ種別を表します。
452
メタデータ型
QuickAction
項目名
データ型
説明
sobjectType
string
有効な値は、次のとおりです。
• Case
• Lead
• ServiceContract
• カスタムオブジェクト (たとえば、ObjA_c)
宣言的なメタデータの定義のサンプル
ケース、リードおよび 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>
QuickAction
Chatterパブリッシャーで使用可能となるオブジェクトに対して指定された作成または更新アクションを表しま
す。たとえば、取引先の詳細ページで、ユーザがそのページのChatterフィードからその取引先に関連する取引
453
メタデータ型
QuickAction
先責任者を作成するアクションを作成できます。QuickAction は、カスタム項目が許可されたオブジェクトで作
成できます。サポートされる親オブジェクトは、次のとおりです。
• Account
• Campaign
• Case
• Contact
• Custom objects
• Group
• Lead
• Opportunity
メモ: アプリケーションでは、QuickAction はアクションまたはパブリッシャーアクションと呼ばれます。
ファイルのサフィックスおよびディレクトリの場所
QuickAction コンポーネントのサフィックスは quickAction で、quickActions フォルダに保存されます。
バージョン
QuickAction コンポーネントは、API バージョン 28.0 以降で使用できます。
項目
項目名
データ型
説明
canvas
string
キャンバスアプリケーションを使用してカスタムアクショ
ンを作成する場合に、アプリケーションを特定します。ク
イックアクション種別が Canvas の場合はキャンバスアプ
リケーションの完全修飾名を <namespace>__<dev_name>
形式で返し、そうでない場合は null を返します。この項目
は API バージョン 29.0 以降で使用できます。
description
string
アクションの説明。
fieldOverrides
FieldOverride
QuickAction 内で上書きできる特定の項目。
height
int
カスタムアクションを作成する場合、この値がアクション
ペインの高さ (ピクセル単位) になります。
icon
string
アクションの識別に使用するアイコン。
API バージョン 32.0 以降は、以前の API バージョンと異なる
アイコンを返します。
isProtected
boolean
このコンポーネントが保護されるか (true)、否か (false)
を示します。保護コンポーネントは、インストールする組
454
メタデータ型
項目名
QuickAction
データ型
説明
織で作成されたコンポーネントによってリンク設定したり
参照したりすることはできません。
label
string
アクションを特定し、ユーザに表示します。これは、API
および管理パッケージに使用するデフォルトの識別子でも
あります。
page
string
Visualforce ページを使用してカスタムアクションを作成す
る場合に、ページを特定します。
quickActionLayout
QuickActionLayout アクション中の項目のレイアウト。
standardLabel
QuickActionLabel アクションに使用する標準表示ラベルを指定します。有効
(string 型の列挙) な値は、次のとおりです。
• LogACall
• LogANote
• New (新しいレコード)
• NewRecordType (表示ラベルが「新しいアイデア」な
どのような場合)
• Update
• UpdateRecordType
• NewChild (新しい子レコード)
• NewChildRecordType
• CreateNew
• CreateNewRecordType (表示ラベルが「新しいアイデ
アを作成」などのような場合)
• SendEmail (この値は API バージョン 31.0 以降で使用で
きます)。
• QuickRecordType
• Quick (クイックレコード)
targetObject
string
アクションを作成および実行する対象となるオブジェク
ト。
たとえば、取引先の詳細ページで、ユーザがそのページの
Chatterフィードからその取引先に関連する取引先責任者を
作成するアクションを作成できます。この場合、取引先責
任者が targetObject になります。
targetParentField
string
アクションの親オブジェクト種別。ターゲットオブジェク
トを親オブジェクトにリンクします。たとえば、ターゲッ
トオブジェクトが取引先責任者であり、親オブジェクトが
取引先である場合、取引先を使用します。
455
メタデータ型
QuickAction
項目名
データ型
説明
targetRecordType
string
作成するレコードタイプを指定します。有効な値は、次の
とおりです。
• 法人取引先
• 個人取引先
• 主取引先
type
QuickActionType
クイックアクションの種別。有効な値は、次のとおりで
(string 型の列挙) す。
• Create
• VisualforcePage
• Post
• SendEmail (この値は API バージョン 31.0 以降で使用で
きます)。
• LogACall
• SocialPost
• Canvas
• Update
width
int
カスタムアクションを作成する場合、この値がアクション
ペインの幅 (ピクセル単位) になります。
FieldOverride
QuickAction での上書きを構成する項目名、各項目の数式およびリテラル値を表します。
項目名
データ型
説明
field
string
上書きを許可する特定の項目の名前。
formula
string
項目を上書きするときに使用する数式を指定します。
literalValue
string
上書きなしの項目の値。
QuickActionLayout
アクション中の項目のレイアウト。アクションレイアウトに追加できる項目数にハードリミットはありませ
ん。ただし、使いやすさを最適化するため、最大 8 項目をお勧めします。20 項目以上を追加すると、ユーザの
効率が大幅に低下します。
456
メタデータ型
QuickAction
項目名
データ型
説明
layoutSectionStyle
LayoutSectionStyle
(string 型の列挙)
使用するレイアウト構造の種別。有効な値は、次のとおり
です。
• TwoColumnsTopToBottom
• TwoColumnsLeftToRight
• OneColumn
• CustomLinks
quickActionLayoutColumns QuickActionLayoutColumn[] QuickActionLayout の列を指定します。
QuickActionLayoutColumn
QuickActionLayout に定義される列です。
項目名
データ型
説明
quickActionLayoutItems QuickActionLayoutItem[] QuickActionLayoutColumn の行アイテムを指定します。
QuickActionLayoutItem
項目で構成され QuickActionLayoutColumn 用に定義される行アイテムです。
項目名
データ型
説明
emptySpace
boolean
このレイアウト項目が空白スペースであるか (true)、否か
(false) を制御します。
field
string
QuickActionLayoutItem の特定の項目を表します。アクション
レイアウトに追加できる項目数にハードリミットはありま
せん。ただし、使いやすさを最適化するため、最大 8 項目
をお勧めします。20 項目以上を追加すると、ユーザの効率
が大幅に低下します。
uiBehavior
UiBehavior (string 型
の列挙)
QuickActionLayoutItem の特定の項目に関するユーザ入力動作
を指定します。有効な値は、次のとおりです。
• Edit
• Required
• Readonly
457
メタデータ型
QuickAction
宣言的なメタデータの定義のサンプル
次に、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>
<emptySpace>false</emptySpace>
<field>HomePhone</field>
<uiBehavior>Required</uiBehavior>
</quickActionLayoutItems>
<quickActionLayoutItems>
<emptySpace>true</emptySpace>
<uiBehavior>Edit</uiBehavior>
</quickActionLayoutItems>
<quickActionLayoutItems>
<emptySpace>false</emptySpace>
<field>Name</field>
<uiBehavior>Required</uiBehavior>
</quickActionLayoutItems>
<quickActionLayoutItems>
<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>
458
メタデータ型
RemoteSiteSetting
RemoteSiteSetting
リモートサイトの設定を表します。Sコントロールやカスタムボタンで XmlHttpRequest を使用し、Visualforce ペー
ジ、Apex 呼び出し、または JavaScript コードで外部サイトを呼び出せるようにするには、[リモートサイトの設
定] ページにそのサイトを登録しておく必要があります。これを行わないと、呼び出しは失敗します。
RemoteSiteSetting は Metadata メタデータ型を拡張し、その fullName 項目を継承します。
宣言的なメタデータファイルのサフィックスおよびディレクトリの
場所
RemoteSiteSetting コンポーネントは、対応するパッケージディレクトリの remoteSiteSettings ディレクトリ
に保存されます。ファイル名はリモートサイトの設定の一意の名前に一致し、拡張子は .remoteSite です。
バージョン
RemoteSiteSetting コンポーネントは、API バージョン 19.0 以降で使用できます。
項目
項目
データ型
説明
description
string
このリモートサイトの設定の使用目的を解説する説
明。
必須。ユーザ接続が HTTP または HTTPS 経由であるか
に関係なく、Salesforce内のコードでリモートサイト
にアクセスできるか (true)、否か (false)、を示し
ます。true である場合、Salesforce 内のコードは
HTTPS セッションから HTTP セッションに、またその
逆方向にもデータを渡せます。
disableProtocolSecurity boolean
警告: セキュリティについて理解した上で
true に設定してください。
fullName
string
名前には、英数字、およびアンダースコア (_) 文字
のみを使用できます。また、最初は文字とし、最後
にアンダースコアを使用したり、連続した 2 つのア
ンダースコア文字を含めたりすることはできませ
ん。
この項目はMetadata コンポーネントから継承するた
め、この項目はこのコンポーネントの WSDL で定義
されません。作成時、更新時、または削除時に指定
する必要があります。コールにおけるこの項目の例
459
メタデータ型
項目
Report
データ型
説明
を確認するには、「create()」を参照してくださ
い。
isActive
boolean
必須。リモートサイトの設定が有効であるか
(true)、否か (false) を示します。
url
string
必須。リモートサイトの URL。
宣言的なメタデータの定義のサンプル
リモートサイトの設定の 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 の関連付けられている属性が true に設定された describeMetadata() から返されます。 この属性
が true に設定されている場合は、ReportFolder など、「Folder」という単語を含むコンポーネント名を使用して
データ型を作成できます。
次の例では、package.xml 内のフォルダを示します。
<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
460
メタデータ型
Report
<types>
<members>MyDBFolder/MyDBName</members>
<name>Dashboard</name>
</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>
</types>
<version>32.0</version>
</Package>
バージョン
Report コンポーネントは、API バージョン 14.0 以降で使用できます。
項目
次の情報は、レポートの作成と実行を十分に理解していることを前提としています。これらの項目についての
詳細は、Salesforce オンラインヘルプの「レポートの作成」を参照してください。
項目
データ型
説明
aggregates
ReportAggregate[]
サマリーレポート、マトリックスレ
ポート、および結合レポートのカスタ
ム集計項目を定義するリスト。
block
Report[]
すべてのブロックのレポートタイプが
異なる可能性がある結合レポートの各
ブロックを表します。
blockInfo
ReportBlockInfo
結合レポートの各ブロックの属性を定
義します。
buckets
ReportBucketField[]
レポートに使用されるバケット項目を
定義します。この項目は API バージョ
ン 24.0 以降で使用できます。
chart
ReportChart
サマリーレポートとマトリックスレ
ポートのグラフを定義します。
461
メタデータ型
Report
項目
データ型
説明
colorRanges
ReportColorRange[]
レポートサマリーデータの条件付き強
調表示を指定するリスト。
columns
ReportColumn[]
レポートに表示される項目を指定する
リスト。項目がレポートに表示される
順序は、メタデータ API ファイルに表
示される順序と同じです。
crossFilters
ReportCrossFilter[]
クロス条件のオブジェクト、関連オブ
ジェクト、条件 (「含む」または「含ま
ない」) を定義します。この項目は API
バージョン 32.0 以降で使用できます。
currency
CurrencyIsoCode (string 型の列挙)
マルチ通貨を使用する場合、一部のレ
ポートでは、適切な列を表示対象とし
て選択すると、換算された金額を表示
できます。たとえば、商談レポートで
は、[金額] (換算値) 列をレポートに含め
ることができます。この項目は、換算
額を表示する通貨を定義するstring型の
列挙です。有効値: USD、GBP、JPY な
ど、ISO 4217 標準で定義された有効な英
字 3 文字の ISO 通貨コードである必要が
あります。
description
string
レポート名と一緒に表示される一般情
報を指定します。最大文字数は 255 文
字です。
division
string
組織がディビジョンを使用してデータ
を分類しており、「ディビジョンの使
用」権限を持っている場合は、レポー
ト内のレコードはこのディビジョンと
一致する必要があります。
この項目は API バージョン 17.0 以降で使
用できます。
filter
ReportFilter
レポートの結果を、特定のデータを持
つレコードに制限します。たとえば、
次のようにレポートの結果を金額が
1,000 ドルを超える商談に制限できま
す。
<filter>
<criteriaItems>
<column>AMOUNT</column>
462
メタデータ型
項目
Report
データ型
説明
<operator>greaterThan</operator>
<value>1000</value>
</criteriaItems>
</filter>
詳細は、Salesforce オンラインヘルプの
「検索条件の入力」を参照してくださ
い。
format
ReportFormat (string 型の列挙)
レポート形式を定義します。たとえ
ば、小計のない単純なデータリストの
場合は Tabular を使用します。
fullName
string
API アクセスの識別子として使用され
る、レポートの一意の開発者名。
fullName には、アンダースコアと英
数字のみを使用できます。一意である
こと、最初は文字であること、空白は
使用しない、最後にアンダースコアを
使用しない、2 つ続けてアンダースコ
アを使用しないという制約がありま
す。この項目は、Metadata コンポーネ
ントから継承されています。
groupingsAcross
ReportGrouping[]
マトリックスレポートでデータのグ
ループ化と小計の基準となる項目を定
義するリスト (行ヘッダー)。日付項目
でグループ化する場合は、日、週、ま
たは月などの特定の期間を使用して
データをさらにグループ化できます。
最大項目数は 2 です。
groupingsDown
ReportGrouping[]
サマリーレポートとマトリックスレ
ポートの場合でグループ化と小計の基
準となる項目を定義するリスト。サマ
リーレポートでは、複数の並び替え項
目を選択してデータを並び替えできま
す。マトリックスレポートでは、列
ヘッダーとなる集計項目を指定しま
す。日付項目でグループ化する場合
は、日、週、または月などの特定の期
間を使用してデータをさらにグループ
化できます。マトリックスレポートの
463
メタデータ型
項目
Report
データ型
説明
最大値は 2 です。サマリーレポートの
最大値は 3 です。
historicalSelector
履歴トレンドレポートデータをキャプ
チャする日付範囲を定義します。デ
フォルトは「任意の履歴日付」です。
ReportHistoricalSelector
APIバージョン 29 以降で利用できます。
name
string
必須。レポート名。たとえば、
Opportunity Pipeline のように設
定します。
params
ReportParam[]
各レポートタイプに固有の設定、特に
レポートを絞り込んで役に立つサブ
セットを取得できるようにするオプ
ションを指定するリスト。たとえば、
活動レポートタイプを使用すると、活
動予定、完了した活動、またはその両
方を表示するかどうかや、ToDo、行
動、またはその両方を表示するかどう
かを指定できます。有効な値はレポー
トタイプに応じて異なります。
reportType
string
必須。レポート内のデータの型を定義
します。たとえば、商談データのレ
ポートを作成するには、Opportunity
を指定します。
roleHierarchyFilter
string
レポートドリルダウンのロール名。商
談レポートや活動レポートなどの一部
のレポートには [階層] リンクが表示さ
れ、そこからロール階層に基づいてさ
まざまなデータセットにドリルダウン
できます。
この項目は API バージョン 17.0 以降で使
用できます。
rowLimit
int
レポートで返すことができる最大行数
を定義します。
scope
string
レポートの実行対象となるデータの範
囲を定義します。たとえば、すべての
商談、自分が所有する商談、所属する
チームが所有する商談に対してレポー
トを実行するかどうかなどです。有効
464
メタデータ型
項目
Report
データ型
説明
な値は、reportType によって異なり
ます。たとえば、Account レポートの場
合、次の値になります。
• MyAccounts
• MyTeamsAccounts
• AllAccounts
showCurrentDate
boolean
マトリックス形式の履歴トレンドレ
ポートの場合、true に設定できます。
APIバージョン 29 以降で利用できます。
showDetails
false を指定すると、ヘッダー、小
boolean
計、合計のみのレポートの折りたたみ
ビューが表示されます。デフォルト:
true
sortColumn
string
レポートのデータの並び替え対象とな
る項目を指定します。並び替え順を指
定するには、sortOrder を使用しま
す。
sortOrder
SortOrder (string 型の列挙)
並び替え順を指定します。並び替え対
象となる項目を指定するには、
sortColumn を使用します。
territoryHierarchyFilter string
レポートドリルダウンのテリトリー
名。組織がテリトリー管理を使用して
いる場合、一部のレポートには [階層]
リンクが表示され、そこからテリト
リー階層に基づいてさまざまなデータ
セットにドリルダウンできます。
この項目は API バージョン 17.0 以降で使
用できます。
timeFrameFilter
ReportTimeFrameFilter
レポートの結果を、指定した期間内の
レコードに制限します。
userFilter
string
レポートドリルダウンのユーザ名。商
談レポートや活動レポートなどの一部
のレポートには [階層] リンクが表示さ
れ、そこからユーザ階層に基づいてさ
まざまなデータセットにドリルダウン
できます。
465
メタデータ型
項目
Report
データ型
説明
この項目は API バージョン 17.0 以降で使
用できます。
ReportAggregate
ReportAggregate は、サマリーレポート、マトリックスレポート、および結合レポートのカスタム集計項目を定
義します。これらの項目についての詳細は、Salesforceオンラインヘルプの「カスタム集計項目の作成」を参照
してください。
項目
データ型
説明
acrossGroupingContext
string
カスタム集計項目を表示する行のグループ化レベル
を定義します。これは、API バージョン 15.0 の新項
目です。
calculatedFormula
string
必須。カスタム集計項目。たとえば、AMOUNT:SUM
+ OPP_QUANTITY:SUM のようになります。
datatype
ReportAggregateDatatype
(string 型の列挙)
必須。カスタム集計項目の結果の書式設定および表
示用のデータ型を指定します。
description
string
カスタム集計項目の説明。最大 255 文字です。
developerName
string
必須。カスタム集計項目の内部開発名。たとえば、
FORMULA1 などです。これは、条件付き強調表示な
ど、他のレポートコンポーネントからカスタム集計
項目を参照するために使用されます。
downGroupingContext
string
カスタム集計項目を表示する列のグループ化レベル
を定義します。この項目は API バージョン 15.0 以降
で使用できます。
isActive
boolean
必須。true を指定すると、数式の結果がレポート
に表示されます。false を指定すると、結果がレ
ポートに表示されません。
isCrossBlock
boolean
カスタム集計項目が、結合レポートで使用できるク
ロスブロック集計項目であるかどうかを決定しま
す。true は、クロスブロックカスタム集計項目で
あることを示します。false は、標準のカスタム
集計項目であることを示します。
この項目はAPIバージョン 25.0 以降で使用できます。
masterLabel
string
必須。カスタム集計項目の表示ラベル (名前)。
466
メタデータ型
Report
項目
データ型
説明
reportType
string
結合レポートでは必須。aggregate を追加できる
ブロックの reportType を指定します。
scale
int
数式の結果は、指定された小数点以下の桁数に計算
されます。有効な値は 0 ～ 18 です。
ReportBlockInfo
ReportBlockInfo は、結合レポートのブロックを定義します。
項目
データ型
説明
aggregateReferences
ReportAggregateReference[]
結合レポートブロックで使用されるカスタム集計項
目を表す aggregates をリストします。
blockId
string
必須。blockId は、各集計項目を含むブロックを
識別するために、クロスブロックカスタム集計項目
と結合レポートのグラフで使用されます。blockId
は、自動的に割り当てられます。有効な値は、B1 か
ら B5 です。
この項目はAPIバージョン 25.0 以降で使用できます。
joinTable
string
必須。結合レポートのブロックの結合に使用される
エンティティを参照します。このエンティティに
よって、複数のブロックにまたがってグローバルに
グループ化可能な項目のリストが提供されます。
ReportAggregateReference
ReportAggregateReference は、結合レポートのカスタム集計項目に使用される開発者名を定義します。
項目
データ型
説明
aggregate
string
必須。結合レポートのブロックで使用されるカスタ
ム集計項目を指定する、ReportAggregate の
developerName。
ReportBucketField
ReportBucketField は、レポートで使用されるバケットを定義します。
467
メタデータ型
Report
項目
データ型
説明
bucketType
ReportBucketFieldType (string
型の列挙)
必須。バケットの種別を指定します。有効な値は次
のとおりです。
• text
• number
• picklist
developerName
string
必須。列リストやその他のレポートコンポーネント
(並び替え、検索条件、リスト、グループ、グラフ
など) にバケット項目を表示するために <field> 値
として使用される一意の名前。BucketField_name
の形式にする必要があります。たとえば、
BucketField_BusinessSize です。
masterLabel
string
必須。バケット項目の表示ラベル。最大 40 文字で
す。表示ラベルの先頭と末尾にある改行、タブ、複
数の空白はすべて削除されます。表示ラベル内にあ
るこれらの文字は 1 文字の空白に変換されます。
nullTreatment
ReportBucketFieldNullTreatment 数値バケット項目のみが対象。空の値を 0 として扱
(string 型の列挙)
うか (z)、否か (n) を指定します。
otherBucketLabel
string
バケット化が解除された値のコンテナの表示ラベ
ル。
sourceColumnName
string
必須。バケットが適用されるソース項目。たとえ
ば、SALES または INDUSTRY です。
values
ReportBucketFieldValue (string バケット項目で使用される 1 つのバケット値を定義
型の列挙)
します。
メモ: この名前は複数形ですが、1 つのバケッ
トを表します。典型的な使用方法では、バケッ
ト項目には複数のバケットが含まれます。
ReportBucketFieldValue
ReportBucketFieldValue は、バケット項目で使用されるバケット値を定義します。
項目
データ型
説明
sourceValues
ReportBucketFieldSourceValue バケット項目内のバケットの値。有効な値は次のと
(string 型の列挙)
おりです。
• sourceValue — 選択リスト項目およびテキス
トバケット項目に使用されます。選択リストの
場合、バケット内の選択リスト項目を説明しま
468
メタデータ型
項目
Report
データ型
説明
す。たとえば、TYPE のバケットの sourceValue
は、Customer の場合があります。テキストの
場合、バケット内の項目の文字列全体です。た
とえば、ADDRESS_STATE1 のバケットの
sourceValue は、NY の場合があります。
• from — 数値バケット項目でのみ使用されます。
数値バケット範囲の下限を示します (この値は範
囲に含まれない)。この値は数値である必要があ
ります。
• to — 数値バケット項目でのみ使用されます。数
値バケット範囲の上限を示します (この値は範囲
に含まれる)。この値は数値である必要がありま
す。
数値バケットでは、最初の値には to のみ、最後の
値には from のみが設定されている必要がありま
す。それ以外のすべての値は、to と from の両方
が設定されている必要があります。
value
string
必須。バケット項目内の特定のバケット値の名前。
ReportGrouping
ReportGrouping は、サマリーレポート、マトリックスレポート、および結合レポートでのデータのグループ化、
小計算出、および並び替えの方法を定義します。
項目
データ型
説明
aggregateType
ReportAggrType (string 型の列 並び替え基準になる集計値の種別。有効な値は、次
挙)
のとおりです。
• Sum
• Average
• Maximum
• Minimum
• RowCount
dateGranularity
UserDateGranularity (string 型 日付項目でグループ化する場合、グループ化の基準
の列挙)
となる期間。
field
string
必須。データの集計の基準となる項目。たとえば、
CAMPAIGN_SOURCE のようになります。
sortByName
string
グルーピングの並び替えに使用する列、集計項目、
またはカスタム集計項目の API 名。
469
メタデータ型
Report
項目
データ型
説明
sortOrder
SortOrder
必須。データを英数字の昇順と降順のどちらで並び
替えるかを示します。
sortType
ReportSortType (string 型の列 グルーピングが列、集計項目、カスタム集計項目の
挙)
どれを基準に並び替えられるかを示します。有効な
値は、次のとおりです。
• Column
• Aggregate
• CustomSummaryFormula
ReportHistoricalSelector
ReportHistoricalSelector は、履歴データの日付の範囲を定義します。
項目
データ型
説明
snapshot
string
履歴条件に適用する相対 (N_DAYS_AGO:2 形式) また
は絶対 (yyyy-MM-dd 形式) 日付値を表します。指定
されていない場合、ユーザに表示されるすべての列
に条件が適用されるとみなされます。
API バージョン 29 以降で利用できます。
SortOrder
レポート項目でのデータの並び替え順序を定義する string 型の列挙です。有効な値は次のとおりです。
項目
説明
Asc
データを英数字の昇順に並び替えます。
Desc
データを英数字の降順に並び替えます。
UserDateGranularity
データのグループ化の基準となる期間を定義する string 型の列挙です。有効な値は次のとおりです。
列挙値
説明
None
日付によるグループ化なし
Day
日別
Week
週別
470
メタデータ型
Report
列挙値
説明
Month
月別
Quarter
四半期別
Year
年別
FiscalQuarter
会計四半期別。組織の四半期年度を設定できます。Salesforce オンラインヘル
プの「会計年度の設定」を参照してください。
FiscalYear
会計年度別
MonthInYear
カレンダー月別
DayInMonth
カレンダー日別
FiscalPeriod
会計期間別 (カスタム会計年度が有効な場合)
FiscalWeek
会計週別 (カスタム会計年度が有効な場合)
ReportSummaryType
レポート項目の集計方法を定義する string 型の列挙です。有効な値は次のとおりです。
列挙値
説明
Sum
合計
Average
平均
Maximum
最大値
Minimum
最小値
None
この項目は集計されません。
ReportColorRange
ReportColorRange は、レポートサマリーデータの条件付き強調表示を定義します。
項目
データ型
説明
aggregate
ReportSummaryType (string 型 必須。columnName で指定された項目の集計方法を
の列挙)
定義します。たとえば、Sum です。
columnName
string
必須。値の範囲を色で表現する項目を指定します。
highBreakpoint
double
必須。ミドルレンジの色をミドルレンジの色と分割
する数値を指定します。
471
メタデータ型
Report
項目
データ型
説明
highColor
string
必須。ハイレンジの数値として分類されたデータを
表す色を指定します (HTML 形式)。この色は、
highBreakpoint を超える値に対応します。
lowBreakpoint
double
必須。ローレンジの色をハイレンジの色と分割する
数値を指定します。
lowColor
string
必須。ローレンジの値 (lowBreakpoint 値未満) と
して分類されたデータを表す色を指定します (HTML
形式)。
midColor
string
必須。ミドルレンジの値として分類されたデータを
表す色を指定します (HTML 形式)。
ReportColumn
ReportColumn は、レポート内での項目 (列) の表示方法を定義します。
項目
データ型
説明
aggregateTypes
ReportSummaryType[] (string
型の列挙)
各レポート項目が集計されるかどうか、および集計
方法を定義するリスト。
field
string
必須。項目名。たとえば、AGE または
OPPORTUNITY_NAME などです。
reverseColors
boolean
履歴トレンドレポートの日付値と金額値が増加して
いる場合、デフォルトの色をそれぞれ緑と赤に置き
換えて表示します。
API バージョン 29.0 以降で利用できます。
showChanges
boolean
履歴トレンドレポートに、現在と履歴の日付値と金
額値の差を表示する列を追加します。
API バージョン 29.0 以降で利用できます。
ReportFilter
ReportFilter は、指定された項目に基づいてデータを絞り込み、レポートの結果を制限します。
項目
データ型
説明
booleanFilter
string
検索条件ロジックの条件を指定します。検索条件ロ
ジックの詳細は、Salesforceオンラインヘルプの「検
472
メタデータ型
項目
Report
データ型
説明
索条件ロジックを最大限に活用」を参照してくださ
い。
criteriaItems
レポートデータの絞り込み条件 (履歴値の比較また
は日付の範囲の適用のいずれか)。
ReportFilterItem
<criteriaItems>
criteriaItems ReportFilterItem
<column>Opportunity.Opportunity__hd$Amount__hst</column>
<columnToColumn>false</columnToColumn>
<operator>equals</operator>
<snapshot>N_DAYS_AGO:90</snapshot>
<value>100</value>
</criteriaItems>
language
Language (string 型の列挙)
レポートで演算子 contains または startsWith
を使用して選択リスト値を絞り込むときに使用され
る言語。有効な言語の値の一覧は、「Translations」
を参照してください。
ReportFilterItem
ReportFilterItem は、指定された項目に基づいてデータを絞り込み、レポートの結果を制限します。
項目
データ型
説明
column
string
必須。データの絞り込み対象となる項目。たとえ
ば、AMOUNT のようになります。
columnToColumn
boolean
項目に履歴スナップショットからのデータが含まれ
ることを示します。
API バージョン 29 以降で利用できます。
operator
FilterOperation (string 型の列 必須。データの絞り込みに使用する演算子
挙)
(greaterThan など) を定義する string 型の列挙。有
効な値については、「FilterOperation」を参照してく
ださい。
snapshot
string
相対 (N_DAYS_AGO:2 形式) または絶対 (yyyy-MM-dd
形式) 日付値を表します。
API バージョン 29 以降で利用できます。
473
メタデータ型
Report
項目
データ型
説明
value
string
データの絞り込みに使用する値。たとえば、1000
などです。メタデータ API 検索条件値は、レポート
ウィザードに入力した検索条件値と一致しない場合
があります。たとえば、メタデータ API では日付は
常に米国の日付形式に変換され、非英語言語で入力
された値は標準の米国英語の同等の形式に変換され
る可能性があります。
ReportFormat
レポート形式を定義する string 型の列挙です。有効な値は次のとおりです。
列挙値
説明
Matrix
データをグリッドに集計します。関連する合計を比較するために使用しま
す。
Summary
データをリスト、並び替え、および小計します。
Tabular
並び替えや小計なしでデータをリストします。
Joined
各レポートのデータをそれぞれのブロックに保存しているさまざまなレポー
トタイプからデータを結合します。
ReportParam
ReportParam は、レポートタイプに固有の設定、特に、レポートを特定の便利なサブセットに絞り込めるように
するオプションを表します。
項目
データ型
説明
name
string
必須。固有の reportType 設定を指定します。
value
string
必須。設定値。
ReportAggregateDatatype
カスタム集計項目結果の書式設定および表示用のデータ型を指定する string 型の列挙です。有効な値は次のと
おりです。
列挙値
currency
number
474
メタデータ型
Report
列挙値
percent
ReportChart
ReportChart は、サマリーレポート、マトリックスレポート、および結合レポートのグラフを表します。
項目
データ型
説明
backgroundColor1
string
背景のグラデーションの開始色を指定します (HTML
形式)。
backgroundColor2
string
背景のグラデーションの終了色を指定します (HTML
形式)。
backgroundFadeDir
ChartBackgroundDirection
(string 型の列挙)
背景のグラデーションの色の方向を指定します。グ
ラデーションデザインの開始色を指定する
backgroundColor1、および終了色を指定する
backgroundColor2 と一緒に使用します。背景の
デザインが必要ない場合は、両方に白を選択しま
す。有効な値は次のとおりです。
• diagonal
• leftToRight
• topToBottom
chartSummaries
ChartSummary[]
グラフに使用する集計を指定します。無効な集計
は、通知なしで無視されます。有効な集計がない場
合、デフォルトで RowCount が軸の値に使用されま
す。この項目は API バージョン 17.0 以降で使用でき
ます。
chartType
ChartType (string 型の列挙)
必須。グラフの種類を指定します。使用可能なグラ
フの種類は、レポートタイプに応じて異なります。
enableHoverLabels
boolean
グラフにマウスを重ねたとき、値、表示ラベル、お
よびパーセントを表示するかどうかを指定します。
詳細のフロート表示はグラフの種類によって異なり
ます。パーセントは、円グラフ、ドーナツグラフ、
およびじょうごグラフのみに適用されます。この項
目は API バージョン 17.0 以降で使用できます。
expandOthers
boolean
合計の 3% 以下のグループをすべて 1 つの「その他」
系列または区分グループにまとめるかどうかを指定
します。円グラフ、ドーナツグラフ、およびじょう
ごグラフのみに適用されます。グラフにすべての値
を個別に表示する場合は true を設定し、小さなグ
475
メタデータ型
項目
Report
データ型
説明
ループを「その他」にまとめるには false に設定
します。この項目は API バージョン 17.0 以降で使用
できます。
データのグループ化の基準となる項目を指定しま
す。このデータは、縦棒グラフの場合は X 軸に、横
棒グラフの場合は Y 軸に表示されます。
groupingColumn
string
legendPosition
ChartLegendPosition (string 型 必須。
の列挙)
グラフに対する凡例の位置。有効な値は、次のとお
りです。
• Bottom
• OnChart
• Right
location
ChartPosition (string 型の列挙) 必須。グラフをレポートの上部に表示するか、また
は下部に表示するかを指定します。
secondaryGroupingColumn string
データのグループ化の基準となる項目を指定します
(グループ化されるグラフの種類の場合に指定可能)。
showAxisLabels
boolean
グラフに各軸の名前を表示するかどうかを指定しま
す (棒グラフと折れ線グラフの場合に指定可能)。
showPercentage
boolean
円グラフ、ドーナツグラフ、およびじょうごグラフ
の系列および区分のパーセント値とゲージのパーセ
ント値を表示するか (true)、否か (false) を示しま
す。
showTotal
boolean
ドーナツグラフとゲージの合計を表示するか
(true)、否か (false) を示します。
showValues
boolean
グラフの個々のレコードまたはグループの値が表示
されるか (true)、否か (false) を示します。
size
ReportChartSize (string 型の列 必須。グラフのサイズを指定します。
挙)
summaryAggregate
ReportSummaryType (string 型 グラフデータの集計方法を定義します。たとえば、
の列挙)
Sum です。API バージョン 17.0 以降ではサポートさ
れません。「chartSummaries」を参照してくださ
い。
summaryAxisManualRangeEnd double
終了値を定義します (手動で軸範囲を指定する場合
に指定可能)。
476
メタデータ型
項目
Report
データ型
説明
summaryAxisManualRangeStart double
開始値を定義します (手動で軸範囲を指定する場合
に指定可能)。
summaryAxisRange
ChartRangeType (string 型の列 必須。軸範囲を手動と自動のどちらで指定するかを
挙)
定義します (横棒グラフ、折れ線グラフ、縦棒グラ
フの場合に指定可能)。
summaryColumn
string
必須。グラフデータの集計の基準となる項目を指定
します。通常、この項目は Y 軸に表示されます。API
バージョン 17.0 以降ではサポートされません。
「chartSummaries」を参照してください。
textColor
string
グラフのテキストと表示ラベルの色 (HTML 形式)。
textSize
int
グラフのテキストと表示ラベルのサイズ。有効な値
は次のとおりです。
• 8
• 9
• 10
• 12
• 14
• 18
• 24
• 36
最大サイズは 18 です。18 より大きい値は 18 ポイン
トで表示されます。
title
string
グラフのタイトル。最大 255 文字です。
titleColor
string
タイトルテキストの色 (HTML 形式)。
titleSize
int
タイトルテキストのサイズ。有効な値は次のとおり
です。
• 8
• 9
• 10
• 12
• 14
• 18
• 24
• 36
最大サイズは 18 です。18 より大きい値は 18 ポイン
トで表示されます。
477
メタデータ型
Report
ChartType
グラフの種類を定義する string 型の列挙です。これらのグラフの種類の詳細は、Salesforce オンラインヘルプの
「グラフの種類」を参照してください。有効な値は次のとおりです。
列挙値
None
HorizontalBar
HorizontalBarGrouped
HorizontalBarStacked
HorizontalBarStackedTo100
VerticalColumn
VerticalColumnGrouped
VerticalColumnStacked
VerticalColumnStackedTo100
Line
LineGrouped
LineCumulative
LineCumulativeGrouped
Pie
Donut
Funnel
Scatter
ScatterGrouped
VerticalColumnLine
VerticalColumnGroupedLine
VerticalColumnStackedLine
Plugin
将来の使用のために予約されています。この値は API バージョン 31.0 以降で使用できます。
ChartPosition
レポート内のグラフの位置を指定する string 型の列挙です。有効な値は次のとおりです。
478
メタデータ型
Report
列挙値
CHART_TOP
CHART_BOTTOM
ChartSummary
ChartSummary は、グラフのデータの集計方法を定義します。有効な値は次のとおりです。
項目
データ型
説明
aggregate
ReportSummaryType
集計値の集計方法 (Sum、Average、Min、Max など)
を指定します。集計に使用される集計値を指定する
には、column 項目を使用します。RowCount または
カスタム集計項目にはこの項目を指定する必要はあ
りません。
axisBinding
ChartAxis
グラフで使用する軸を指定します。軸に使用される
集計値を指定するには、column項目を使用します。
column
string
必須。グラフデータの集計項目を指定します。すべ
ての列が無効な場合、デフォルトで RowCount が軸
の値に使用されます。縦棒と横棒の組み合わせグラ
フの場合、最大 4 つの値を指定できます。
ChartAxis
グラフで使用する軸を指定する string 型の列挙です。有効な値は次のとおりです。
列挙値
説明
x
散布図の X 軸に使用する集計値。
y
グラフの Y 軸。
y2
縦棒グラフに折れ線を追加した組み合わせグラフの 2 本目の Y 軸。
ReportChartSize
グラフのサイズを指定する string 型の列挙です。有効な値は次のとおりです。
列挙値
Tiny
Small
Medium
479
メタデータ型
Report
列挙値
Large
Huge
ChartRangeType
レポート形式を定義する string 型の列挙です。有効な値は次のとおりです。
列挙値
Auto
Manual
ReportTimeFrameFilter
ReportTimeFrameFilter は、レポートの期間を表します。
項目
データ型
説明
dateColumn
string
必須。データの絞り込み対象となる日付項目。たと
えば、CLOSE_DATE のようになります。
endDate
date
interval が INTERVAL_CUSTOM の場合、カスタム
期間の終了日を指定します。
interval
UserDateInterval (string 型の
列挙)
必須。期間を指定します。
startDate
date
interval が INTERVAL_CUSTOM の場合、カスタム
期間の開始日を指定します。
ReportCrossFilter
ReportCrossFilter は、レポート内のクロス条件機能を表します。
項目
データ型
説明
criteriaItems
ReportFilterItem
クロス条件のサブ条件を表します。最大 5 つのサブ
条件を指定できます。この項目には次の属性が必要
です。
• Column
• Operator
• Value
480
メタデータ型
Report
項目
データ型
説明
operation
ObjectFilterOperator (string 型 オブジェクトを含めるか、除外するかを示すアク
の列挙)
ション。有効値: with および without。
primaryTableColumn
string
クロス条件に使用する親オブジェクト。
relatedTable
string
クロス条件に使用する子オブジェクト。
親を結合するために使用する子オブジェクトの項
目。
relatedTableJoinColumn string
宣言的なメタデータの定義のサンプル
クロス条件を使用してケース状況がクローズではないケースの 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 型の列挙です。有効な値は次のとおりです。
列挙値
説明
INTERVAL_CURRENT
今期 (会計四半期)
INTERVAL_CURNEXT1
今期と翌期 (会計四半期)
INTERVAL_CURPREV1
今期と前期 (会計四半期)
INTERVAL_NEXT1
翌期 (会計四半期)
INTERVAL_PREV1
前期 (会計四半期)
INTERVAL_CURNEXT3
今期と翌 3 期 (会計四半期)
INTERVAL_CURFY
今期 (会計年度)
INTERVAL_PREVFY
前期 (会計年度)
481
メタデータ型
Report
列挙値
説明
INTERVAL_PREV2FY
過去 2 期 (会計年度)
INTERVAL_AGO2FY
2 期前 (会計年度)
INTERVAL_NEXTFY
翌期 (会計年度)
INTERVAL_PREVCURFY
今期と前期 (会計年度)
INTERVAL_PREVCUR2FY
今期と過去 2 期 (会計年度)
INTERVAL_CURNEXTFY
今期と翌期 (会計年度)
INTERVAL_CUSTOM
カスタム期間期間の開始日と終了日を指定するには、startDate
および endDate 項目を使用します。
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
前期 (カレンダー四半期)
INTERVAL_CURNEXT3Q
今期と翌 3 期 (カレンダー四半期)
INTERVAL_CURY
今年 (カレンダー年)
INTERVAL_PREVY
前年 (カレンダー年)
INTERVAL_PREV2Y
過去 2 年 (カレンダー年)
INTERVAL_AGO2Y
2 年前 (カレンダー年)
482
メタデータ型
Report
列挙値
説明
INTERVAL_NEXTY
来年 (カレンダー年)
INTERVAL_PREVCURY
今年と前年 (カレンダー年)
INTERVAL_PREVCUR2Y
今年と過去 2 年 (カレンダー年)
INTERVAL_CURNEXTY
今年と来年 (カレンダー年)
INTERVAL_LAST7
過去 7 日間
INTERVAL_LAST30
過去 30 日間
INTERVAL_LAST60
過去 60 日間
INTERVAL_LAST90
過去 90 日間
INTERVAL_LAST120
過去 120 日間
INTERVAL_NEXT7
翌 7 日間
INTERVAL_NEXT30
翌 30 日間
INTERVAL_NEXT60
翌 60 日間
INTERVAL_NEXT90
翌 90 日間
INTERVAL_NEXT120
翌 120 日間
LAST_FISCALWEEK
前会計週 (カスタム会計年度が有効な場合に指定可能)
THIS_FISCALWEEK
今会計週 (カスタム会計年度が有効な場合に指定可能)
NEXT_FISCALWEEK
翌会計週 (カスタム会計年度が有効な場合に指定可能)
LAST_FISCALPERIOD
前会計期間 (カスタム会計年度が有効な場合に指定可能)
THIS_FISCALPERIOD
今会計期間 (カスタム会計年度が有効な場合に指定可能)
NEXT_FISCALPERIOD
翌会計期間 (カスタム会計年度が有効な場合に指定可能)
LASTTHIS_FISCALPERIOD
今会計期間と前会計期間 (カスタム会計年度が有効な場合に指定
可能)
THISNEXT_FISCALPERIOD
今会計期間と翌会計期間 (カスタム会計年度が有効な場合に指定
可能)
CURRENT_ENTITLEMENT_PERIOD
今期 (エンタイトルメント期間)
PREVIOUS_ENTITLEMENT_PERIOD
前期 (エンタイトルメント期間)
PREVIOUS_TWO_ENTITLEMENT_PERIODS
過去 2 期 (エンタイトルメント期間)
TWO_ENTITLEMENT_PERIODS_AGO
2 期前 (エンタイトルメント期間)
CURRENT_AND_PREVIOUS_ENTITLEMENT_PERIOD 今期と前期 (エンタイトルメント期間)
483
メタデータ型
列挙値
Report
説明
CURRENT_AND_PREVIOUS_TWO_ENTITLEMENT_PERIODS 今期と過去 2 期 (エンタイトルメント期間)
宣言的なメタデータの定義のサンプル
サンプル 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&gt;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>
484
メタデータ型
Report
<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>
<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>
</chartSummaries>
<chartSummaries>
<aggregate>Maximum</aggregate>
<axisBinding>y</axisBinding>
<column>CRT_Object__c$Number__c</column>
</chartSummaries>
<chartSummaries>
<axisBinding>y</axisBinding>
<column>RowCount</column>
485
メタデータ型
Report
</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>
<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>
486
メタデータ型
Report
</timeFrameFilter>
</Report>
結合レポートの宣言的なメタデータの定義のサンプル
サンプル XML レポート定義を次に示します。
<?xml version="1.0" encoding="UTF-8"?>
<Report xmlns="http://soap.sforce.com/2006/04/metadata">
<!-- This is a cross-block custom summary formula. Note that the calculated formula reference
for a blocks reference uses the BlockId#Aggregate. -->
<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>
<!-- This is a standard custom summary formula. Note that the calculated formula reference
does not have block reference but just the aggregate name of the report type associated
(Opportunity).-->
<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>
<!-- This is how the block defines that the custom summary formula should be referenced.
In this example, it’s the in standard FORMULA 2 defined above. This block report has blockID
B1.-->
<aggregateReferences>
<aggregate>FORMULA2</aggregate>
</aggregateReference>
<blockId>B1</blockId>
<joinTable>a</joinTable>
</blockInfo>
<columns>
<field>TYPE</field>
</columns>
<format>Summary</format>
<name>Opportunities BLock 3</name>
<params>
<name>role_territory</name>
<value>role</value>
</params>
<params>
487
メタデータ型
Report
<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>
<!-- This is how the block defines that the custom summary formula should be referenced.
In this example, it’s the cross-block custom summary formula FORMULA 1 defined above. This
block report has blockId B2.-->
<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>
488
メタデータ型
Report
<params>
<name>co</name>
<value>1</value>
</params>
<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>
<!-- This is how chart aggregates are designed in multiblock. We're using RowCount from
Block 1.-->
<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>
489
メタデータ型
ReportType
<showDetails>true</showDetails>
</Report>
関連トピック:
Dashboard
ReportType
カスタムレポートタイプに関連付けられたメタデータを表します。Metadata メタデータ型を拡張し、その
fullName 項目を継承します。カスタムレポートタイプを使用すると、ユーザがレポートを作成またはカスタ
マイズできるフレームワークを構築できます。詳細は、Salesforceオンラインヘルプの「カスタムレポートタイ
プの設定」を参照してください。
宣言的なメタデータファイルのサフィックスおよびディレクトリの
場所
カスタムレポートタイプ定義のファイルサフィックスは .reportType です。カスタムレポートタイプごとに
1 つのファイルがあります。レポートタイプは、対応するパッケージディレクトリの reportTypes ディレク
トリに保存されます。
バージョン
カスタムレポートタイプは、API バージョン 14.0 以降で使用できます。
項目
項目名
データ型
説明
autogenerated
boolean
エンティティで履歴トレンドが有効になった場合にレポー
トタイプが自動的に生成されることを示します。
API バージョン 29 以降で利用できます。
baseObject
string
category
ReportTypeCategory (string 型 必須。この項目は、レポートのカテゴリを制御します。有
の列挙)
効な値は、次のとおりです。
必須。カスタムレポートタイプの主オブジェクト。たとえ
ば、Account などです。カスタムオブジェクトを含むすべて
のオブジェクトがサポートされます。初回作成後にこの項
目を編集することはできません。
• accounts
• opportunities
• forecasts
490
メタデータ型
項目名
ReportType
データ型
説明
• cases
• leads
• campaigns
• activities
• busop
• products
• admin
• territory
• territory2 (この値は API バージョン 31.0 以降で使用で
きます)。
• usage_entitlement
• wdc (この値は API バージョン 29.0 以降で使用できます)。
• calibration (この値は API バージョン 29.0 以降で使用
できます)。
• other
• content
deployed
boolean
必須。レポートタイプをユーザが使用できるか (true)、ま
だ開発中か (false) を示します。
description
string
カスタムレポートタイプの説明。
fullName
string
APIアクセスの一意の識別子として使用される、レポートタ
イプの開発者名。fullName には、アンダースコアと英数
字のみを使用できます。一意であること、最初は文字であ
ること、空白は使用しない、最後にアンダースコアを使用
しない、2 つ続けてアンダースコアを使用しないという制
約があります。
join
ObjectRelationship
baseObject に結合されたオブジェクト。たとえば、Contact
が主オブジェクトの Account に結合されている場合がありま
す。
label
string
必須。レポートタイプの表示ラベル。
sections
ReportLayoutSection[]
レポートタイプに使用できる列のグループ。列は厳密には
必須ではありませんが、レポートでは列を使用したほうが
便利です。
ObjectRelationship
ObjectRelationship は、別のオブジェクトへの結合を表します。詳細は、Salesforce オンラインヘルプの「カスタム
レポートタイプへの子オブジェクトの追加」を参照してください。
491
メタデータ型
ReportType
項目名
データ型
説明
join
ObjectRelationship
この項目は、3 つ以上のオブジェクトを結合できるようにする再
帰的参照です。最大 4 つのオブジェクトを、カスタムレポートタ
イプ内で結合できます。3 つ以上のオブジェクトを結合する場
合、結合の順序で内部結合より前に外部結合があると、その内
部結合は許可されません。baseObject は、relationship で
指定されたオブジェクトに最初に結合されます。その結果のデー
タセットがこの項目で指定された任意のオブジェクトと結合さ
れます。
outerJoin
boolean
必須。これが外部結合であるか (true)、否か (false) を示しま
す。外部結合は、結合されたテーブルの結合列に一致する値が
含まれていなくても行を返します。
relationship
string
必須。主オブジェクトに結合されたオブジェクト。たとえば、
Contact などです。
ReportLayoutSection
ReportLayoutSection は、カスタムレポートタイプで使用される列のグループを表します。
項目名
データ型
説明
columns
ReportTypeColumn[]
このカスタムレポートタイプで定義された、ク
エリから返される列のリスト。
masterLabel
string
必須。レポートウィザードでのこの列のグルー
プの表示ラベル。
ReportTypeColumn
ReportTypeColumn は、カスタムレポートタイプ内の列を表します。
項目名
データ型
説明
checkedByDefault boolean
必須。この列がデフォルトで選択されるか (true)、否か (false)
を示します。
displayNameOverride string
カスタマイズされた列名 (省略可能)。
field
string
必須。レポート列に関連付けられた項目名。
table
string
必須。項目に関連付けられたテーブル。たとえば、Account など
があります。
492
メタデータ型
ReportType
宣言的なメタデータの定義のサンプル
カスタムレポートタイプの定義を以下に示します。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>
493
メタデータ型
Role
<columns>
<checkedByDefault>true</checkedByDefault>
<field>ReportsTo.CreatedBy.Contact.Owner.MobilePhone</field>
<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」 (ページ 225)を参照してください。
Role
組織内のロールを表します。
宣言的なメタデータファイルのサフィックスおよびディレクトリの
場所
ロールコンポーネントのファイルサフィックスは .role で、コンポーネントは対応するパッケージディレク
トリの roles ディレクトリに保存されます。
バージョン
ロールコンポーネントは、API バージョン 24.0 以降で使用できます。
項目
このメタデータ型は、下位型 RoleOrTerritory (ページ 495) に拡張されます。
項目名
データ型
説明
fullName
string
APIアクセスの一意の識別子。fullName には、アンダース
コアと英数字のみを使用できます。一意であること、最初
494
メタデータ型
項目名
RoleOrTerritory
データ型
説明
は文字であること、空白は使用しない、最後にアンダース
コアを使用しない、2 つ続けてアンダースコアを使用しな
いという制約があります。この項目は、Metadata コンポー
ネントから継承されています。ユーザインターフェースの
[ロール名] に対応します。
parentRole
string
階層でこのロールの上位にあるロール。
宣言的なメタデータの定義のサンプル
ロールの定義を次に示します。
<?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 メタ
データ型を使用します。
項目
項目名
データ型
説明
caseAccessLevel
string
ユーザが、所有する取引先に関連付けられた他のユーザの
ケースにアクセスできるかどうかを指定します。有効な値
は、次のとおりです。
• Read
• Edit
• None
495
メタデータ型
項目名
RoleOrTerritory
データ型
説明
組織のケースに対する共有モデルが「公開/参照・更新可
能」の場合、この項目は表示されません。
この項目に値が設定されていない場合、この項目値には
[テリトリーの管理] ページ ([設定] から[テリトリーの管理] >
[設定]) で指定されたデフォルトのアクセスレベルが使用さ
れます。
contactAccessLevel
string
ユーザが所有する取引先に関連付けられた他のユーザの取
引先責任者に、ユーザがアクセスできるかどうかを指定し
ます。有効な値は、次のとおりです。
• Read
• Edit
• None
取引先責任者に対する組織の共有モデルが「公開/参照・
更新可能」または「親レコードに連動」の場合、この項目
は表示されません。
この項目に値が設定されていない場合、この項目値には
[テリトリーの管理] ページ ([設定] から[テリトリーの管理] >
[設定]) で指定されたデフォルトのアクセスレベルが使用さ
れます。
description
string
ロールまたはテリトリーの説明です。
fullName
string
APIアクセスの一意の識別子。fullName には、アンダース
コアと英数字のみを使用できます。一意であること、最初
は文字であること、空白は使用しない、最後にアンダース
コアを使用しない、2 つ続けてアンダースコアを使用しな
いという制約があります。この項目は、Metadata コンポー
ネントから継承されています。
mayForecastManagerShare boolean
name
string
opportunityAccessLevel string
売上予測マネージャが手動で自身の売上予測を共有できる
かどうかを示します。
必須。ロールまたはテリトリーの名前です。
ユーザが所有する取引先に関連付けられた他のユーザの商
談に、ユーザがアクセスできるかどうかを指定します。有
効な値は、次のとおりです。
• Read
• Edit
• None
組織の商談に対する共有モデルが「公開/参照・更新可能」
の場合、この項目は表示されません。
496
メタデータ型
項目名
RoleOrTerritory
データ型
説明
この項目に値が設定されていない場合、この項目値には
[テリトリーの管理] ページ ([設定] から[テリトリーの管理] >
[設定]) で指定されたデフォルトのアクセスレベルが使用さ
れます。
宣言的なメタデータの定義のサンプル
ロールの定義を次に示します。
<?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>
テリトリーの定義を次に示します。
<?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>
497
メタデータ型
SamlSsoConfig
</Territory>
関連トピック:
Role
Territory
SamlSsoConfig
SAML シングルサインオン設定を表します。Metadata メタデータ型を拡張し、その fullName 項目を継承しま
す。シングルサインオンは、ネットワークユーザが、各リソースに個別にログインすることなく、認証済みの
すべてのネットワークリソースにアクセスできるプロセスです。シングルサインオンを使用すると、企業ユー
ザのデータベースまたはクライアントアプリケーションに対してユーザ名とパスワードを検証できます。
Salesforce 管理の個別のユーザパスワードは必要ありません。
ファイルのサフィックスおよびディレクトリの場所
SamlSsoConfig コンポーネントのサフィックスは .samlssoconfig で、samlssoconfigs フォルダに保存され
ます。
バージョン
SamlSsoConfig コンポーネントは、API バージョン 28.0 以降で使用できます。
項目
項目名
データ型
説明
attributeName
string
ID プロバイダのアプリケーションの名前。ID プロバイダか
らこの情報を取得します。
attributeNameIdFormat string
SAML 2.0 で identityLocation が Attribute に設定され
ている場合にのみ使用されます。値には、unspecified、
emailAddress、persistent があります。すべての規定
値は、SAML 2.0 のアサーションとプロトコルの仕様書にあ
る「Name Identifier Format Identifiers」の項に記載されていま
す。
decryptionCertificate string
受信 SAML アサーションの復号化に使用する証明書の名前。
この証明書は、組織の [証明書と鍵の管理] リストに保存さ
れます。API バージョン 30.0 以降で利用できます。
string
SAML ログイン時にエラーが発生した場合にユーザが移動す
る先のページの URL。この URL は、公開サイトの Visualforce
errorUrl
498
メタデータ型
項目名
SamlSsoConfig
データ型
説明
ページなど、公開されているページである必要がありま
す。URL は相対または絶対のどちらでも使用できます。
identityLocation
SamlIdentityLocationType アサーション内のどこでユーザを識別するかを指定しま
(string 型の列挙)
す。有効な値は、次のとおりです。
• SubjectNameId — ID はアサーションの <Subject> ス
テートメント内にあります
• Attribute — ID はアサーションの <Attribute> の中
の <AttributeValue> で指定されています。
identityMapping
SamlIdentityType (string 型 ジャストインタイムのユーザプロビジョニング中にサービ
の列挙)
スプロバイダがユーザに対して使用する識別子。有効な値
は、次のとおりです。
• Username — ユーザの salesforce.com ユーザ名。
• FederationId — ユーザオブジェクトの統合 ID。サー
ビスプロバイダがユーザに対して使用する識別子。
• UserId — ユーザの Salesforce 組織のユーザ ID。
issuer
string
ID プロバイダの ID 文字列。
loginUrl
string
SAML 2.0 でのみ有効: Salesforce がログインシーケンスを開始
する SAML 要求を送信する URL です。
logoutUrl
string
SAML 2.0 専用: ユーザが [ログアウト] リンクをクリックした
ときに移動先となる URL。デフォルトは、
http://www.salesforce.com です。
name
string
この一意の名前は API および管理パッケージで使用されま
す。名前は文字で始まり、英数字とアンダースコアのみを
使用する必要があります。名前には、最後にアンダースコ
アを使用しない、2 つ続けてアンダースコアを使用しない
という制約があります。
oauthTokenEndpoint
string
SAML 2.0 でのみ有効: ACS URL は、Web シングルサインオン
OAuth アサーションフローで ID プロバイダとして Salesforce
を有効化して使用します。
redirectBinding
boolean
[私のドメイン] を使用している場合は、ID プロバイダが
SAML メッセージで要求するバインドメカニズムを選択しま
す。値は次のとおりです。
• HTTP ポスト — HTTP POST バインドは、base64url エンコー
ドされた HTML フォームを使用して SAML メッセージを
送信します。
499
メタデータ型
項目名
SamlSsoConfig
データ型
説明
• HTTP リダイレクト — HTTP リダイレクトバインドは、
URL パラメータ内で base64url エンコードおよび URL エン
コードされた SAML メッセージを送信します。
salesforceLoginUrl
string
Web シングルサインオンフローのログインに関連付けられ
ている URL。
samlEntityId
string
Salesforce によって生成された SAML 要求の発行者、または
SAML 着信レスポンスの予測される利用者です。ドメインを
リリースしていない場合、この値は常に
https://saml.salesforce.com になります。ドメイン
をリリースしている場合、Salesforce ではカスタムドメイン
名の使用をお勧めします。
samlVersion
SamlType (string 型の列
挙)
使用中の SAML バージョン。有効な値は、次のとおりです。
• SAML1_1 — SAML 1.1
• SAML2_0 — SAML 2.0
userProvisioning
boolean
true の場合、ジャストインタイムのユーザプロビジョニ
ングが有効になり、ユーザがはじめてログインするときに
その場でユーザが作成されます。この機能を使用するに
は、identityMapping 値に Federation ID を指定しま
す。
validationCert
string
要求の検証に使用される証明書。ID プロバイダからこの情
報を取得します。
宣言的なメタデータの定義のサンプル
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>
500
メタデータ型
Scontrol
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>
Scontrol
重要: Sコントロールは、Visualforce ページに置き換えられました。Sコントロールを以前に使用していない
組織は、Sコントロールを作成できません。既存の Sコントロールに影響はありません。今後も編集でき
ます。
非推奨。Salesforce ユーザインターフェースの Sコントロールに対応する、Scontrol コンポーネントを表します。
詳細は、Salesforceオンラインヘルプの「Sコントロールについて」を参照してください。このメタデータ型は、
MetadataWithContent コンポーネントを拡張し、その項目を共有します。
宣言的なメタデータファイルのサフィックスおよびディレクトリの
場所
Sコントロールファイルのファイルサフィックスは .scf です。付随するメタデータファイルには、
ScontrolName-meta.xml という名前が付けられます。
Scontrol コンポーネントは、対応するパッケージディレクトリの scontrols フォルダに保存されます。
バージョン
Sコントロールは、API バージョン 10.0 以降で使用できます。
項目
このメタデータ型には、次の項目が含まれます。
項目名
データ型
説明
content
base64Binary
Sコントロールのコンテンツ。Base 64 で符号化されたバ
イナリデータ API コールを行う前に、クライアントアプ
リケーションはバイナリ添付データを base64 に符号化す
る必要があります。応答を受信したら、クライアントア
プリケーションは、base64 データをバイナリに復号化す
る必要があります。この変換は、通常 SOAP クライアン
501
メタデータ型
項目名
Scontrol
データ型
説明
トによって処理されます。この項目は、
MetadataWithContent コンポーネントから継承されます。
contentSource SControlContentSource (string 型の列 必須。Sコントロールの使用目的を判断します。
挙)
• HTML: Sコントロールのコンテンツを content に入力
する場合、このオプションを選択します。
• URL: 外部 Web サイトへのリンクまたは URL を content
に入力する場合、このオプションを選択します。
• Snippet: スニペットは、他の Sコントロールに組み
込めるよう設計された Sコントロールです。Sコント
ロールスニペットのコンテンツを content に入力す
る場合、このオプションを選択します。
description
string
Sコントロールを説明するテキストです (省略可能)。これ
は「すべてのデータの参照」権限を持つユーザ (システ
ム管理者) にのみ表示されます。
encodingKey
Encoding (string 型の列挙)
必須。デフォルトの文字コード設定は Unicode (UTF-8) で
す。情報を渡す URL が別形式のデータを必要とする場合
は、この設定を変更します。このオプションは、
contentSource の値として URL を選択すると使用でき
ます。
fileContent
base64
この Sコントロールをカスタムリンクに追加した場合に
表示されるファイルのコンテンツ。ファイルには、Java
アプレット、Active-X コントロール、またはその他の任意
のコンテンツを含めることができます。このオプション
は、contentSource の値が HTML の Sコントロールにの
み適用されます。
fileName
string
Sコントロールにつける一意の名前です。この名前は、
アンダースコアと英数字のみを含み、組織内で一意の名
前にする必要があります。最初は文字であること、空白
は使用しない、最後にアンダースコアを使用しない、2
つ続けてアンダースコアを使用しないという制約があり
ます。この項目は、管理パッケージによってインストー
ルされたコンポーネントでは変更できません。
fileContent 項目にも値がある場合にのみ該当します。
これは、API バージョン 14.0 の新項目です。
fullName
string
API アクセスの一意の識別子として使用される、Sコント
ロールの開発者名。fullName には、アンダースコアと
英数字のみを使用できます。一意であること、最初は文
字であること、空白は使用しない、最後にアンダースコ
アを使用しない、2 つ続けてアンダースコアを使用しな
502
メタデータ型
項目名
設定
データ型
説明
いという制約があります。この項目が、使用できなく
なったバージョン 14.0 より前の文字を含んでいた場合
は、それらの文字はこの項目から削除され、その項目の
以前の値は name 項目に保存されていました。この項目
は、Metadata コンポーネントから継承されています。
name
string
supportsCaching boolean
必須。Sコントロールにつける一意の名前です。文字で
始まり、英数字のみが含まれる必要があります。たとえ
ば、example_s_control などです。
必須。Sコントロールがキャッシュをサポートしている
か (true)、否か (false) を示します。キャッシュにより
ページを最適化し、ページの再読み込み時にページに含
まれる Sコントロールを記憶します。このオプションは、
HTML Sコントロールにのみ適用されます。
宣言的なメタデータの定義のサンプル
次のサンプルでは、Myriad_Publishing.scf という Sコントロールを作成し、Sコントロール内に指定され
た Web サイトへのリンクを作成します。対応する Myriad_Publishing.scf-meta.xml メタデータファイル
は、Sコントロールファイルの次に示します。
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 では、
すべての機能設定が使用できるわけではありません。使用できない機能設定についての詳細は、「サポートさ
れていないメタデータ型」 (ページ 116)を参照してください。
503
メタデータ型
設定
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 のみをリリースまたは取得するために使用される、パッケージマニフェストの例を次に示
します。
<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<types>
<members>Mobile</members>
<name>Settings</name>
</types>
<version>27.0</version>
</Package>
504
メタデータ型
AccountSettings
組織の使用可能なすべての設定メタデータをリリースまたは取得するために使用される、パッケージマニフェ
ストの例を次に示します。
<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<types>
<members>*</members>
<name>Settings</name>
</types>
<version>27.0</version>
</Package>
関連トピック:
AccountSettings
ActivitiesSettings
AddressSettings
CaseSettings
ChatterAnswersSettings
CompanySettings
ContractSettings
EntitlementSettings
ForecastingSettings
IdeasSettings
KnowledgeSettings
MobileSettings
SecuritySettings
AccountSettings
取引先チーム、取引先所有者レポート、[階層の表示]リンクの組織の取引先設定を表します。Metadataメタデー
タ型を拡張し、その fullName 項目を継承します。
パッケージマニフェストでは、「Settings」の名前を使用してすべての組織設定メタデータ型にアクセスしま
す。詳細は「設定」を参照してください。
ファイルのサフィックスおよびディレクトリの場所
AccountSettings の値は、settings フォルダの Account.settings ファイルに保存されます。.settings ファ
イルは、各設定コンポーネントに設定ファイルが 1 つしかないため、他の名前つきのコンポーネントとは異な
ります。
505
メタデータ型
AccountSettings
バージョン
AccountSettings は、API バージョン 29.0 以降で使用できます。
項目
項目名
データ型
enableAccountOwnerReport boolean
enableAccountTeams
boolean
説明
取引先所有者レポートをすべてのユーザが実行できるか
(true)、否か (false) を示します。
取引先チームが有効化されているか (true)、否か (false)
を示します。
メタデータ API を使用して、取引先チームを無効にするこ
とはできません。
showViewHierarchyLink
boolean
すべての法人取引先の詳細ページでデフォルトの [階層の
表示]リンクが表示されているか (true)、非表示か (false)
を示します。
宣言的なメタデータの定義のサンプル
次に、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>
506
メタデータ型
ActivitiesSettings
<name>Settings</name>
</types>
<version>29.0</version>
</Package>
関連トピック:
設定
ActivitiesSettings
組織の活動設定と、カレンダー用のユーザインターフェース設定を表します。ActivitiesSettings コンポーネント
の種類を使用して、次の活動設定を制御します。
• グループ ToDo と定期的な ToDo、定期的な行動と複数日の行動、およびメール追跡を設定する
• 複数の取引先責任者を ToDo および行動に関連付ける (Shared Activities)
• ミーティング要請にカスタムロゴを表示する
また、ActivitiesSettings コンポーネントの種類を使用して、フロート表示リンクやドラッグアンドドロップ編集
などを含め、カレンダーのユーザインターフェース設定も制御できます。
パッケージマニフェストでは、「Settings」の名前を使用してすべての組織設定メタデータ型にアクセスしま
す。詳細は「設定」を参照してください。
ファイルのサフィックスおよびディレクトリの場所
ActivitiesSettingsの値は、settings ディレクトリの Activities.settings ファイルに保存されます。.settings
ファイルは、各設定コンポーネントに設定ファイルが 1 つしかないため、他の名前つきのコンポーネントとは
異なります。
バージョン
ActivitiesSettings は、API バージョン 28.0 以降で使用できます。
項目
次に示すすべてのタイプの設定は、[活動設定] ページまたは [ユーザインターフェース設定] ページで次のよう
に制御されます。
項目名
データ型
説明
enableActivityReminders
boolean
組織に対してポップアップ活動アラームを有効化します。
システム管理者は、この項目を [活動設定] ページで制御し
ます。
507
メタデータ型
ActivitiesSettings
項目名
データ型
説明
enableClickCreateEvents
boolean
日表示および週表示のカレンダービューで特定の時間枠を
ダブルクリックし、フロート表示に行動の詳細を入力する
ことによって、行動を作成できます。行動にマウスを置く
とフロート表示が表示され、行動の詳細の参照や行動の削
除をページを離れず行うことができます。システム管理者
は、ミニページレイアウトを使用して、フロート表示され
る項目を設定します。定期的な行動または複数個人の行動
はサポートしていません。
システム管理者は、この項目を [ユーザインターフェース
設定] ページで制御します。
enableDragAndDropScheduling boolean
リストビューからカレンダービューにレコードをドラッグ
し、フロート表示に行動の詳細を入力することによって、
レコードに関連する行動を作成できます。行動にマウスを
置くとフロート表示が表示され、行動の詳細の参照や行動
の削除をページを離れず行うことができます。システム管
理者は、ミニページレイアウトを使用して、フロート表示
される項目を設定します。
システム管理者は、この項目を [ユーザインターフェース
設定] ページで制御します。
enableEmailTracking
boolean
組織で HTML メールテンプレートを使用している場合に、
送信 HTML メールを追跡できます。
システム管理者は、この項目を [活動設定] ページで制御し
ます。
enableGroupTasks
boolean
ユーザが新規 ToDo の独立したコピーを複数のユーザに割
り当てることができます。
システム管理者は、この項目を [活動設定] ページで制御し
ます。
enableListViewScheduling boolean
enableDragAndDropScheduling および
enableClickCreateEvents の機能をリストビューのカ
レンダーに拡張します。
システム管理者は、この項目を [ユーザインターフェース
設定] ページで制御します。
enableMultidayEvents
boolean
開始から 24 時間以上が経過した後で終了する行動を作成
できます。
システム管理者は、この項目を [活動設定] ページで制御し
ます。
508
メタデータ型
ActivitiesSettings
項目名
データ型
説明
enableRecurringEvents
boolean
指定された間隔で繰り返される行動を作成できます。
システム管理者は、この項目を [活動設定] ページで制御し
ます。
enableRecurringTasks
boolean
指定された間隔で繰り返される ToDo を作成できます。
システム管理者は、この項目を [活動設定] ページで制御し
ます。
enableSidebarCalendarShortcut boolean
ユーザが最後に使用したカレンダービューへのショート
カットリンクをサイドバーに表示します。
システム管理者は、この項目を [活動設定] ページで制御し
ます。
enableSimpleTaskCreateUI boolean
Salesforce1 で [新規 ToDo] をタップしたときに、通常の ToDo
レコード編集ページまたは最初に主要な ToDo 項目が表示
されるページのどちらを開くかを、管理者が指定できるよ
うにします。
システム管理者は、この項目を [活動設定] ページで制御し
ます。
enableUNSTaskDelegatedToNotifications boolean
meetingRequestsLogo
string
[活動設定] ページで、設定を公開して管理者がユーザ設定
を表示または非表示にできるようにします。表示すること
で、個々のユーザは ToDo を割り当てられたときのメール
通知を有効化または無効化できます。
showCustomLogoMeetingRequests が有効な場合に使用
できます。カスタムロゴをアップロードします。システム
管理者は、[ドキュメント] タブで特定のフォルダにアップ
ロードされたロゴのみを選択できます。
システム管理者は、この項目を [活動設定] ページで制御し
ます。
showCustomLogoMeetingRequests boolean
ミーティング要請のメールおよびミーティングの Web ペー
ジにカスタムロゴを表示します。ユーザが行動に招待する
かミーティングを要請すると、招待者に対してロゴが表示
されます。
システム管理者は、この項目を [活動設定] ページで制御し
ます。
509
メタデータ型
項目名
ActivitiesSettings
データ型
showEventDetailsMultiUserCalendar boolean
説明
フロート表示テキストとしてではなく、画面上に行動の詳
細を表示します。
システム管理者は、この項目を [活動設定] ページで制御し
ます。
showHomePageHoverLinksForEvents boolean
[ホーム] タブのカレンダーセクションで、次の処理が行わ
れます。
• 行動の件名にマウスポインタを置くと、フロート表示
リンクによって選択された行動の詳細がフロート表示
されます (フロート表示リンクは他のカレンダービュー
で常に使用できます)。
• 行動の件名をクリックすると、行動の詳細ページが表
示されます。
システム管理者は、ミニページレイアウトを使用して、フ
ロート表示される項目を設定します。
システム管理者は、この項目を [ユーザインターフェース
設定] ページで制御します。
showMyTasksHoverLinks
boolean
[ホーム] タブの [ToDo] セクションおよびカレンダーの日表
示で、次の処理が行われます。
• ToDo の件名にマウスポインタを置くと、選択された
ToDo の詳細がフロート表示されます
• ToDo の件名をクリックすると、ToDo の詳細ページが表
示されます。
システム管理者は、ミニページレイアウトを使用して、フ
ロート表示される項目を設定します。
システム管理者は、この項目を [ユーザインターフェース
設定] ページで制御します。
showRequestedMeetingsOnHomePage boolean
ユーザが要請し、まだ確認していないミーティングの一覧
を示す [要請済みミーティング] サブタブを、[ホーム] タブ
の [カレンダー] セクションに表示します。この機能を無効
にすると、[ホーム] タブのカレンダーから [新規ミーティ
ング要請] ボタンが削除されます。
システム管理者は、この項目を [活動設定] ページで制御し
ます。
510
メタデータ型
AddressSettings
パッケージマニフェストの例
組織の活動設定メタデータをリリースまたは取得するために使用される、パッケージマニフェストの例を次に
示します。
<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<types>
<members>Activities</members>
<name>Settings</name>
</types>
<version>28.0</version>
</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オンラインヘルプの「州選択リストと国選
択リストの概要」を参照してください。
511
メタデータ型
AddressSettings
Metadata メタデータ型を拡張し、その fullName 項目を継承します。
パッケージマニフェストでは、「Settings」の名前を使用してすべての組織設定メタデータ型にアクセスしま
す。詳細は「設定」を参照してください。
宣言的なメタデータファイルのサフィックスおよびディレクトリの場所
AddressSettings の値は、settings ディレクトリの Address.settings という 1 つのファイルに保存されま
す。.settings ファイルは、各設定コンポーネントに設定ファイルが 1 つしかないため、他の名前つきのコ
ンポーネントとは異なります。
バージョン
AddressSettings は、API バージョン 32.0 で使用できます。
CountriesAndStates
この複合メタデータ型は、選択リストに含まれる都道府県および国の有効な定義を表します。
メモ: メタデータ API を使用して [州/国選択リスト] で既存の都道府県および国を編集できます。メタデー
タ API を使用して新規の都道府県または国を作成または削除することはできません。
項目
データ型
説明
countries
Country[]
選択リストから選択可能な国。
Country
このメタデータ型は、選択リストに含まれる国の定義を提供します。
項目
データ型
説明
active
boolean
API で値を使用できるかどうかを指定します。
重要: Salesforce 組織で州/国選択リストを有効
にした後に、active 状況を false に設定す
ることはできません。
integrationValue
string
ISO 標準の都道府県または国コードに対応するテキ
ストベースの都道府県および国の値。インテグレー
ション値がレコード内の対応する ISO コードのテキ
スト列に入力されます。デフォルトのインテグレー
ション値はSalesforceによって指定されます。この値
は、組織で以前使用した値と一致するように編集で
きます。これで外部システムとのインテグレーショ
ンが引き続き機能するようにできます。
512
メタデータ型
項目
AddressSettings
データ型
説明
重要: 組織で州/国選択リストを有効にする前
にインテグレーション値を指定しない場合は、
Salesforce によって指定されたデフォルト値が
レコードで使用されます。インテグレーショ
ン値を後から変更すると、それ以降に作成ま
たは更新されるレコードでは、編集後の値が
使用されます。
isoCode
retrieve() コールを発行すると、ISO 標準コード
string
がこの項目に入力されます。standard の都道府県
と国の isoCode は編集できません。
label
string
Salesforceの選択リストに表示されるラベル。この項
目は API では参照のみですが、[設定] でラベルを編
集できます。
orgDefault
boolean
Salesforce 組織の新規レコードに 1 つの国をデフォル
ト値として設定します。
standard
boolean
標準の都道府県と国は、Salesforceに含まれるもので
す。standard 属性は編集できません。
states
State[]
国の一部である都道府県。
visible
boolean
Salesforceでユーザが国または都道府県を使用できる
ようにします。visible である国または都道府県
は、active である必要もあります。
State
このメタデータ型は、選択リストに含まれる都道府県の定義を提供します。
項目
データ型
説明
active
boolean
API で値を使用できるかどうかを指定します。
重要: Salesforce 組織で州/国選択リストを有効
にした後に、active 状況を false に設定す
ることはできません。
integrationValue
string
ISO 標準の都道府県または国コードに対応するテキ
ストベースの都道府県および国の値。インテグレー
ション値がレコード内の対応する ISO コードのテキ
スト列に入力されます。デフォルトのインテグレー
ション値はSalesforceによって指定されます。この値
は、組織で以前使用した値と一致するように編集で
513
メタデータ型
項目
AddressSettings
データ型
説明
きます。これで外部システムとのインテグレーショ
ンが引き続き機能するようにできます。
重要: 組織で州/国選択リストを有効にする前
にインテグレーション値を指定しない場合は、
Salesforce によって指定されたデフォルト値が
レコードで使用されます。インテグレーショ
ン値を後から変更すると、それ以降に作成ま
たは更新されるレコードでは、編集後の値が
使用されます。
isoCode
string
retrieve() コールを発行すると、ISO 標準コード
がこの項目に入力されます。
label
string
Salesforceの選択リストに表示されるラベル。この項
目は API では参照のみですが、[設定] でラベルを編
集できます。
standard
boolean
標準の都道府県と国は、Salesforceに含まれるもので
す。standard 属性は編集できません。
visible
boolean
Salesforceでユーザが国または都道府県を使用できる
ようにします。visible である国または都道府県
は、active である必要もあります。
宣言的なメタデータの定義のサンプル
組織で使用する米国およびカナダの州/国選択リストを設定する XML のサンプルを次に示します。また、グリー
ンランドの国も API でのみ使用できるようにします。この例は、API バージョン 32.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>
514
メタデータ型
AddressSettings
<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>
<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>
関連トピック:
設定
515
メタデータ型
BusinessHoursSettings
BusinessHoursSettings
エンタイトルメント、エンタイトルメントテンプレート、キャンペーン、ケースの営業時間および休日の設定
管理に使用するメタデータを表します。Metadata メタデータ型を拡張し、その fullName 項目を継承します。
パッケージマニフェストでは、「Settings」の名前を使用してすべての組織設定メタデータ型にアクセスしま
す。詳細は「設定」を参照してください。
ファイルのサフィックスおよびディレクトリの場所
営業時間および休日設定は、settings ディレクトリの businessHours.settings という 1 つのファイルに
保存されます。.settings ファイルは、各設定コンポーネントに設定ファイルが 1 つしかないため、他の名
前つきのコンポーネントとは異なります。
バージョン
BusinessHoursSettings は、API バージョン 29.0 以降で使用できます。
項目
項目名
データ型
説明
businessHours
BusinessHoursEntry[]
エンタイトルメント、エンタイトルメントテン
プレート、キャンペーン、およびケースに適用
する営業時間を表します。
holidays
Holidays[]
businessHours の休日および使用方法を表しま
す。
BusinessHoursEntry
エンタイトルメント、エンタイトルメントテンプレート、キャンペーン、およびケースに適用する営業時間を
表します。
項目名
データ型
説明
timeZoneId
string
営業時間を定義する時間のタイムゾーン。
name
string
営業時間の名前。この名前は一意にする必要があります。
active
string
営業時間が有効かどうかを示します。
default
string
営業時間がデフォルトの営業時間に使用されるか否かを示
します。
mondayStartTime
string
月曜日の営業時間の開始時刻。HH:mm:ss.SSSZ 形式を使
用します。
516
メタデータ型
BusinessHoursSettings
項目名
データ型
説明
mondayEndTime
string
月曜日の営業時間の終了時刻。HH:mm:ss.SSSZ 形式を使
用します。00:00:00.000Z という値は、月曜日の午前 0
時を指定します。
tuesdayStartTime
string
火曜日の営業時間の開始時刻。HH:mm:ss.SSSZ 形式を使
用します。
tuesdayEndTime
string
火曜日の営業時間の終了時刻。HH:mm:ss.SSSZ 形式を使
用します。00:00:00.000Z という値は、火曜日の午前 0
時を指定します。
wednesdayStartTime
string
水曜日の営業時間の開始時刻。HH:mm:ss.SSSZ 形式を使
用します。
wednesdayEndTime
string
水曜日の営業時間の終了時刻。HH:mm:ss.SSSZ 形式を使
用します。00:00:00.000Z という値は、水曜日の午前 0
時を指定します。
thursdayStartTime
string
木曜日の営業時間の開始時刻。HH:mm:ss.SSSZ 形式を使
用します。
thursdayEndTime
string
木曜日の営業時間の終了時刻。HH:mm:ss.SSSZ 形式を使
用します。00:00:00.000Z という値は、木曜日の午前 0
時を指定します。
fridayStartTime
string
金曜日の営業時間の開始時刻。HH:mm:ss.SSSZ 形式を使
用します。
fridayEndTime
string
金曜日の営業時間の終了時刻。HH:mm:ss.SSSZ 形式を使
用します。00:00:00.000Z という値は、金曜日の午前 0
時を指定します。
saturdayStartTime
string
土曜日の営業時間の開始時刻。HH:mm:ss.SSSZ 形式を使
用します。
saturdayEndTime
string
土曜日の営業時間の終了時刻。HH:mm:ss.SSSZ 形式を使
用します。00:00:00.000Z という値は、土曜日の午前 0
時を指定します。
sundayStartTime
string
日曜日の営業時間の開始時刻。HH:mm:ss.SSSZ 形式を使
用します。
sundayEndTime
string
日曜日の営業時間の終了時刻。HH:mm:ss.SSSZ 形式を使
用します。00:00:00.000Z という値は、日曜日の午前 0
時を指定します。
517
メタデータ型
BusinessHoursSettings
休日
businessHours の休日および使用方法を表します。
項目名
データ型
説明
name
string
休日の名前。この名前は一意にする必要はありません。
description
string
休日の説明。
isRecurring
string
休日が定期的であるかどうかを示します。
activityDate
string
休日の日付。不定期な休日に使用します。HH:mm:ss.SSSZ
形式を使用します。
recurrenceStartDate
string
休日の繰り返しを開始する日付。yyyy-mm-dd 形式を使用
します。
recurrenceEndDate
string
休日の繰り返しを終了する日付。yyyy-mm-dd 形式を使用
します。(省略可能)。
startTime
string
休日の日付の開始時刻。HH:mm:ss.SSSZ 形式を使用しま
す。startTime および endTime は両方とも null である
か、両方とも null ではない必要があります。両方が null で
ある場合、全日を示します。
endTime
string
休日の日付の終了時刻。HH:mm:ss.SSSZ 形式を使用しま
す。startTime および endTime は両方とも null である
か、両方とも null ではない必要があります。両方が null で
ある場合、全日を示します。
recurrenceType
string
休日の繰り返し種別。有効な値は、RecursDaily、
RecursEveryWeekday、RecursMonthly、RecursMonthlyNth、
RecursWeekly、RecursYearly、RecursYealyNth です。
recurrenceInterval
string
休日を繰り返す週、月または年の間隔。
recurrenceDayOfWeek
string
休日を繰り返す曜日。有効な値は Monday、Tuesday、
Wednesday、Thursday、Friday、Saturday、Sunday です。
recurrenceDayOfMonth
string
休日を繰り返す日付。有効な値は 1 ～ 31 です。
recurrenceInstance
string
有効な値は First、Second、Third、Fourth、Last です。
recurrenceType RecursMonthlyNth および RecursYearlyNth でのみ
使用されます。たとえば、recurenceInstance 値が First である
場合、休日は 3 か月ごとの第 1 月曜日に繰り返します。
recurrenceMonthOfYear
string
有効な値は、January、February、March、April、May、June、
July、August、September、October、November、December で
す。
businessHours
string
この休日に適用される営業時間設定の名前。
518
メタデータ型
BusinessHoursSettings
宣言的なメタデータの定義のサンプル
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>
519
メタデータ型
CaseSettings
<isRecurring>true</isRecurring>
<name>Thanksgiving</name>
<recurrenceDayOfMonth>21</recurrenceDayOfMonth>
<recurrenceMonthOfYear>November</recurrenceMonthOfYear>
<recurrenceStartDate>2013-11-21</recurrenceStartDate>
<recurrenceType>RecursYearly</recurrenceType>
</holidays>
</BusinessHoursSettings>
BusinessHoursSettings 定義を参照する package.xml マニフェストの例は、次のとおりです。
<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<types>
<members>BusinessHours</members>
<name>Settings</name>
</types>
<version>29.0</version>
</Package>
CaseSettings
デフォルトのケース所有者、有効化されるケース関連機能、各種ケース活動に使用されるメールテンプレート
など、組織のケース設定を表します。
パッケージマニフェストでは、「Settings」の名前を使用してすべての組織設定メタデータ型にアクセスしま
す。詳細は「設定」を参照してください。
ファイルのサフィックスおよびディレクトリの場所
CaseSettings の値は、settings ディレクトリの Case.settings ファイルに保存されます。.settings ファ
イルは、各設定コンポーネントに設定ファイルが 1 つしかないため、他の名前つきのコンポーネントとは異な
ります。
バージョン
CaseSettings は、API バージョン 27.0 以降で使用できます。
項目
項目名
データ型
説明
caseAssignNotificationTemplate string
ケース割り当て通知に使用するメールテンプレー
トを指定します。
folderName/emailTemplateName の形式を使
用する必要があります。
caseCloseNotificationTemplate string
ケースクローズ通知に使用するメールテンプレー
トを指定します。
520
メタデータ型
項目名
CaseSettings
データ型
説明
folderName/emailTemplateName の形式を使
用する必要があります。
caseCommentNotificationTemplate string
ケースコメント通知に使用するメールテンプレー
トを指定します。
folderName/emailTemplateName の形式を使
用する必要があります。
caseCreateNotificationTemplate string
ケース作成通知に使用するメールテンプレート
を指定します。
folderName/emailTemplateName の形式を使
用する必要があります。
caseFeedItemSettings
FeedItemSettings[]
フィードベースのケースページレイアウトに含
まれるフィード項目の設定を指定します。この
項目は、APIバージョン 32.0 以降で使用できます。
ケース編集ページの [ケース状況] 項目に Closed
を表示するか (true)、否か (false) を示します。
closeCaseThroughStatusChange boolean
defaultCaseOwner
string
割り当てルールで所有者を見つけられなかった
場合に、ケースのデフォルトの所有者を指定し
ます。
defaultCaseOwnerType
string
デフォルトのケース所有者がユーザか、キュー
かを指定します。
defaultCaseUser
string
自動ケース更新の [ケース履歴] 関連リストに表
示されるユーザを指定します。
• 割り当てルール
• エスカレーションルール
• オンデマンドメール-to-ケース
• セルフサービスポータルでログインしたケー
ス
emailToCase
EmailToCaseSettings
組織のメール-to-ケース設定。
enableCaseFeed
boolean
ケースフィードが有効化されているか (true)、
否か (false) を示します。
enableDraftEmails
boolean
ドラフトメールが有効化されているか (true)、
否か (false) を示します。メールドラフトを有効
にすると、ケースフィードとメール-to-ケースも
有効にする必要があります。
521
メタデータ型
項目名
CaseSettings
データ型
説明
enableEarlyEscalationRuleTriggers boolean
エスカレーションルールの早期トリガが有効化
されているか (true)、否か (false) を示します。
enableNewEmailDefaultTemplate boolean
デフォルトのメールテンプレートが有効化され
ているか (true)、否か (false) を示します。デ
フォルトのメールテンプレートは、ドラフトメー
ルが有効になっている場合にのみ使用できます。
enableSuggestedArticlesApplication boolean
ケースのページに [推奨記事] リストを表示する
か (true)、否か (false) を示します。
enableSuggestedSolutions=false の場合に
のみ使用できます。
enableSuggestedArticlesCustomerPortal boolean
カスタマーポータルのページに [推奨記事] リス
トを表示するか (true)、否か (false) を示しま
す。enableSuggestedSolutions=false の場
合にのみ使用できます。
enableSuggestedArticlesPartnerPortal boolean
パートナーポータルのページに [推奨記事] リス
トを表示するか (true)、否か (false) を示しま
す。enableSuggestedSolutions=false の場
合にのみ使用できます。
boolean
ケースの詳細ページに [推奨ソリューションの参
照] ボタンまたは [記事の検索] ボタンを表示する
か (true)、否か (false) を示します。
enableSuggestedArticlesApplication、
enableSuggestedArticlesCustomerPortal、
および
enableSuggestedArticlesPartnerPortal=false
の場合にのみ使用できます。
enableSuggestedSolutions
keepRecordTypeOnAssignmentRule boolean
割り当てルールを手動作成したレコードに適用
するときに、既存のレコードタイプを使用する
か (true)、既存のレコードタイプを割り当て先
のデフォルトレコードタイプで上書きするか
(false) を示します。
newEmailDefaultTemplateClass string
ケースフィードで新規メールメッセージに使用
されるデフォルトのメールテンプレートを定義
する Apex クラスを指定します。この項目は
enableNewEmailDefaultTemplate=true の場
合にのみ表示されます。
notifyContactOnCaseComment
boolean
新しいコメントがケースに追加された場合に、
セルフサービスポータルのメンバーではない取
522
メタデータ型
CaseSettings
項目名
データ型
説明
引先責任者に通知できるようにするか (true)、
否か (false) を示します。
notifyDefaultCaseOwner
boolean
新規ケースが割り当てられた場合に、デフォル
トのケース所有者に通知するか (true)、否か
(false) を示します。
notifyOwnerOnCaseComment
boolean
コメントがケースに追加された場合に、ケース
所有者に通知するか (true)、否か (false) を示し
ます。
notifyOwnerOnCaseOwnerChange boolean
ユーザがケースの所有者を別のユーザに変更す
る場合に、ケースの [メールで通知する] チェッ
クボックスを自動的に選択されるようにするか
(true) どうかを示します。
showFewerCloseActions
boolean
ケースの編集ページの [保存して閉じる] ボタン
と [ケース] 関連リストの [完了] リンクを非表示
にするか (true)、表示するか (false) を示しま
す。
useSystemEmailAddress
boolean
ケースコメント、ケース添付ファイル、および
ケース割り当てのメール通知がシステムアドレ
スから送信されるか (true)、またはケース通知
がケースを更新するユーザまたは取引先責任者
から送信されるように表示するのか (false) を示
します。
webToCase
WebToCaseSettings
組織のWeb-to-ケース設定。
EmailToCaseSettings
組織のメール-to-ケース設定を表します。
項目
項目名
データ型
説明
enableEmailToCase
boolean
メール-to-ケースが有効化されているか (true)、
否か (false) を示します。メール-to-ケースを有効
にした後に無効にすることはできません。
enableHtmlEmail
boolean
HTML メールが有効化されているか (true)、否か
(false) を示します。
523
メタデータ型
項目名
CaseSettings
データ型
説明
enableOnDemandEmailToCase boolean
オンデマンドメール-to-ケースが有効化されてい
るか (true)、否か (false) を示します。
boolean
ケースのスレッド ID がメールの本文に挿入される
か (true)、否か (false) を示します。
enableThreadIDInSubject boolean
ケースのスレッド ID がメールの件名に挿入される
か (true)、否か (false) を示します。
notifyOwnerOnNewCaseEmail boolean
ケースに関連する新規メールを受信したときに、
ケースの所有者に通知が送信されるか (true)、否
か (false) を示します。
enableThreadIDInBody
overEmailLimitAction
EmailToCaseOnFailureActionType 組織のメール-to-ケースの 1 日の上限を超えた後
(string 型の列挙)
に受信したメールメッセージの処理方法を指定し
ます。有効な値は、次のとおりです。
• Bounce
• Discard
• Requeue
routingAddresses
EmailToCaseRoutingAddress[]
組織のメール-to-ケースのルーティングアドレス
設定。
unauthorizedSenderAction EmailToCaseOnFailureActionType 無効な送信者から受信したメールメッセージの処
(string 型の列挙)
理方法を指定します。有効な値は、次のとおりで
す。
• Bounce
• Discard
EmailToCaseRoutingAddress
組織のメール-to-ケースのルーティングアドレスを表します。
項目
項目名
データ型
説明
addressType
EmailToCaseRoutingAddressType メール-to-ケースのルーティングアドレスの種類
(string 型の列挙)
を指定します。有効な値は、次のとおりです。
• EmailToCase — メール-to-ケースまたはオン
デマンドメール-to-ケースに使用されるルーティ
ングアドレス。
524
メタデータ型
項目名
CaseSettings
データ型
説明
• Outlook — Outlook からケースを作成するため
に Salesforce for Outlook で使用されるルーティン
グアドレス。オンデマンドメール-to-ケースが
有効になっている必要があります。
authorizedSenders
string
オンデマンドメール-to-ケースにメールを送信で
きるメールアドレスまたはドメインを指定しま
す。カンマ区切りのリストで複数のエントリを指
定できます。
caseOrigin
string
このルーティングアドレスから作成されたケース
のデフォルトのケース発生源を指定します。
caseOwner
string
このルーティングアドレスから作成されたケース
のデフォルトの所有者を指定します。所有者は
Salesforce ユーザ名で指定します。
caseOwnerType
string
デフォルトのケース所有者がユーザか、キューか
を指定します。
casePriority
string
このルーティングアドレスから作成されたケース
のデフォルトのケース優先度を指定します。
createTask
boolean
ケースがメールから作成されるときに、ケース所
有者に ToDo が自動的に割り当てられるか (true)、
否か (false) を示します。
emailAddress
string
ケースとして送信されるメールメッセージを転送
するために使用されるメールアドレスを指定しま
す。
routingName
string
メール-to-ケースのルーティングアドレスの名前
を指定します。
saveEmailHeaders
boolean
メールルーティングおよび封筒情報が保存される
か (true)、否か (false) を示します。
taskStatus
string
メールがケースとして送信されるときにケース所
有者に自動的に割り当てられる ToDo のデフォル
ト状況を指定します。createTask が true に設
定されている場合のみ適用されます。
FeedItemSettings
組織のフィード項目設定を表します。API バージョン 32.0 以降で使用できます。
525
メタデータ型
CaseSettings
項目名
データ型
説明
characterLimit
int
フィード項目ごとの最大表示文字数を指定しま
す。
collapseThread
boolean
メールスレッド内の以前のメッセージがメール
フィード項目から削除されたか (true)、否か
(false) を示します。
displayFormat
FeedItemDisplayFormat (string
型の列挙)
メールフィード項目の表示方法を示します。有効
な値は、次のとおりです。
• Default — メールフィード項目の空白行が表
示されます。
• HideBlankLines — メールフィード項目の空
白行は表示されません。
feedItemType
FeedItemType (string 型の列
挙)
設定を適用するフィード項目の種別。
FeedItemSettings の場合、有効な
feedItemType 値は EmailMessageEvent のみ
です。
WebToCaseSettings
組織のWeb-to-ケース設定を表します。
項目
項目名
データ型
説明
caseOrigin
string
この Web フォームから作成されたケースのデフォルトの
ケース発生源を指定します。enableWebToCase が true
に設定されている場合のみ適用されます。
defaultResponseTemplate
string
セルフサービスポータルから送信されたケースへのメール
レスポンスに使用されるデフォルトのテンプレートを指定
します。enableWebToCase が true に設定されている場
合のみ適用されます。
enableWebToCase
boolean
Web-to-ケースが有効化されているか (true)、否か (false)
を示します。
526
メタデータ型
CaseSettings
宣言的なメタデータの定義のサンプル
これは、ケース設定ファイルのサンプルです。
<?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>
<casePriority>High</casePriority>
<routingName>OutlookRoutingAddress1</routingName>
</routingAddresses>
<unauthorizedSenderAction>Discard</unauthorizedSenderAction>
</emailToCase>
<enableCaseFeed>true</enableCaseFeed>
<enableDraftEmails>true</enableDraftEmails>
<enableEarlyEscalationRuleTriggers>true</enableEarlyEscalationRuleTriggers>
527
メタデータ型
ChatterAnswersSettings
<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>
関連トピック:
設定
ChatterAnswersSettings
Chatter アンサーの設定管理に使用するメタデータを表します。
パッケージマニフェストでは、「Settings」の名前を使用してすべての組織設定メタデータ型にアクセスしま
す。詳細は「設定」を参照してください。
ファイルのサフィックスおよびディレクトリの場所
Chatter アンサー設定は、settings ディレクトリの ChatterAnswers.settings という 1 つのファイルに保
存されます。.settings ファイルは、各設定コンポーネントに設定ファイルが 1 つしかないため、他の名前
つきのコンポーネントとは異なります。
バージョン
ChatterAnswersSettings は、API バージョン 27.0 以降で使用できます。
項目
項目名
データ型
emailFollowersOnBestAnswer boolean
説明
フォローしている質問で最良の回答が選択された場合に
ユーザに通知するか (true)、否か (false) を示します。
528
メタデータ型
ChatterAnswersSettings
項目名
データ型
説明
emailFollowersOnReply
boolean
フォローしている質問に他のユーザが返答した場合にユー
ザに通知するか (true)、否か (false) を示します。
emailOwnerOnPrivateReply boolean
カスタマーサポートが質問に非公開で返答した場合にユー
ザに通知するか (true)、否か (false) を示します。
emailOwnerOnReply
boolean
質問に他のユーザが返答した場合にユーザに通知するか
(true)、否か (false) を示します。
enableAnswerViaEmail
boolean
メール通知に返信することで、ユーザが回答を投稿できる
か (true)、否か (false) を示します。この項目は API バー
ジョン 29.0 以降で使用できます。
enableChatterAnswers
boolean
Chatter アンサーが組織で有効化されているか (true)、否か
(false) を示します。
enableFacebookSSO
boolean
ユーザが Facebook ログインを使用して Chatter アンサーコ
ミュニティにサインインするか (true)、否か (false) を示
します。この機能を有効にするには、組織のセキュリティ
のコントロールで Facebook 認証プロバイダを定義して有効
にし、さらに組織内で認証プロバイダを有効にする必要が
あります。
enableInlinePublisher
boolean
Chatter アンサーコミュニティのいずれかに質問を投稿する
前に、ユーザが記事または質問で検索結果をフィルタでき
るか (true)、否か (false) を示します。また、[タイトル]
および [内容] 項目を質問に追加して、テキスト入力やス
キャンを容易にすることができます。この項目は API バー
ジョン 29.0 以降で使用できます。
enableReputation
boolean
ユーザのプロファイルの写真の上にマウスを置くと評価が
表示されるか (true)、否か (false) を示します。 評価は、
すべてのゾーンで有効になります。評価設定を有効にする
には、組織で [評価] を有効にする必要があります。
enableRichTextEditor
boolean
質問を投稿するときに、テキストを書式設定し、画像を
アップロードするために、リッチテキストエディタが有効
化されているか (true)、否か (false) を示します。リッチ
テキストエディタを有効にするには、[質問フローを最適
化] を有効にする必要があります。
facebookAuthProvider
string
既存の Facebook 認証プロバイダの名前。Chatter アンサーコ
ミュニティでの Facebook シングルサインオンを実装するに
は、Facebook 認証プロバイダを選択する必要があります。
showInPortals
boolean
Chatter アンサーをカスタマーポータルまたはパートナー
ポータルにタブとして追加できるか (true)、否か (false)
を示します。
529
メタデータ型
CompanySettings
宣言的なメタデータの定義のサンプル
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 マニフェストの例は、次のとおりです。
<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<types>
<members>ChatterAnswers</members>
<name>Settings</name>
</types>
<version>29.0</version>
</Package>
関連トピック:
設定
CompanySettings
組織内の複数の機能に影響するグローバル設定を表します。
パッケージマニフェストでは、「Settings」の名前を使用してすべての組織設定メタデータ型にアクセスしま
す。詳細は「設定」を参照してください。
宣言的なメタデータファイルのサフィックスおよびディレクトリの場所
CompanySettings の値は、対応するパッケージディレクトリの settings ディレクトリの Company.settings
という 1 つのファイルに保存されます。.settings ファイルは、各設定コンポーネントに設定ファイルが 1
つしかないため、他の名前つきのコンポーネントとは異なります。
バージョン
組織プロファイルの設定は、API バージョン 27.0 以降で使用できます。
530
メタデータ型
CompanySettings
項目
項目名
データ型
説明
fiscalYear
FiscalYearSetting
年および開始月に基づく組織の会計年度設定。[カ
スタム会計年度] または [売上予測 (従来)] が有効に
なっている場合は使用できません。会計年度設定を
変更すると、目標および調整が消去される可能性が
あります。たとえば、開始月を変更すると、この
データは消去されます。
FiscalYearSetting
組織の会計年度設定を表します。
項目
データ型
説明
fiscalYearNameBasedOn
string
この項目は、会計年度名を判断するために使用され
ます。有効な値は、endingMonth または
startingMonth です。たとえば、会計年度が 2012
年 4 月から始まり、2013 年 3 月に終わる場合は、次
のようになります。
• この値が endingMonth のときは、会計年度名
には 2013 が使用されます。
• この値が startingMonth のときは、会計年度
名には 2012 が使用されます。
startMonth
string
会計年度が基づく月。
宣言的なメタデータの定義のサンプル — 会計年度設定
会計年度設定の 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>
関連トピック:
設定
531
メタデータ型
ContractSettings
ContractSettings
契約の設定を表します。詳細は、Salesforceオンラインヘルプの「契約の設定のカスタマイズ」を参照してくだ
さい。
パッケージマニフェストでは、「Settings」の名前を使用してすべての組織設定メタデータ型にアクセスしま
す。詳細は「設定」を参照してください。
ファイルのサフィックスおよびディレクトリの場所
settings ディレクトリには、Contract.settings という名前のファイルに保存される契約設定ファイルが
1 つあります。.settings ファイルは、各設定コンポーネントに設定ファイルが 1 つしかないため、他の名前
つきのコンポーネントとは異なります。
バージョン
ContractSettings は、API バージョン 27.0 以降で使用できます。
項目
項目名
データ型
説明
autoCalculateEndDate
boolean
契約の終了日が自動的に計算されるか (true)、否か (false)
を示します。
notifyOwnersOnContractExpiration boolean
契約の期限が切れるときに、取引先および取引先責任者
にメール通知が自動的に送信されるか (true)、否か (false)
を示します。
宣言的なメタデータの定義のサンプル
これは、契約設定ファイルのサンプルです。
<?xml version="1.0" encoding="UTF-8"?>
<ContractSettings xmlns="http://soap.sforce.com/2006/04/metadata">
<autoCalculateEndDate>true</autoCalculateEndDate>
<notifyOwnersOnContractExpiration>false</notifyOwnersOnContractExpiration>
</ContractSettings>
関連トピック:
設定
EntitlementSettings
組織のエンタイトルメント設定を表します。
532
メタデータ型
EntitlementSettings
パッケージマニフェストでは、「Settings」の名前を使用してすべての組織設定メタデータ型にアクセスしま
す。詳細は「設定」を参照してください。
ファイルのサフィックスおよびディレクトリの場所
EntitlementSettings の値は、settings ディレクトリの Entitlements.settings ファイルに保存されま
す。.settings ファイルは、各設定コンポーネントに設定ファイルが 1 つしかないため、他の名前つきのコ
ンポーネントとは異なります。
バージョン
EntitlementSettings は、API バージョン 27.0 以降で使用できます。
項目
項目名
データ型
説明
assetLookupLimitedToActiveEntitlementsOnAccount boolean
ケースのエンタイトルメント関連ルックアップ
検索条件が、ケースの取引先の有効なエンタイ
トルメントに関連する納入商品のみを返すか
(true)、否か (false) を示します。
assetLookupLimitedToActiveEntitlementsOnContact boolean
ケースのエンタイトルメント関連ルックアップ
検索条件が、ケースの取引先責任者の有効なエ
ンタイトルメントに関連する納入商品のみを返
すか (true)、否か (false) を示します。
assetLookupLimitedToSameAccount
boolean
ケースのエンタイトルメント関連ルックアップ
検索条件が、ケースの取引先に関連する納入商
品のみを返すか (true)、否か (false) を示しま
す。
assetLookupLimitedToSameContact
boolean
ケースのエンタイトルメント関連ルックアップ
検索条件が、ケースの取引先責任者に関連する
納入商品のみを返すか (true)、否か (false) を
示します。
enableEntitlements
boolean
エンタイトルメントが有効化されているか
(true)、否か (false) を示します。
enableEntitlementVersioning
boolean
エンタイトルメントのバージョン管理が有効化
されているか (true)、否か (false) を示します。
この項目は API バージョン 28.0 以降で使用でき
ます。
533
メタデータ型
項目名
EntitlementSettings
データ型
説明
entitlementLookupLimitedToActiveStatus boolean
ケースのエンタイトルメント関連ルックアップ
検索条件が、有効なエンタイトルメントのみを
返すか (true)、否か (false) を示します。
entitlementLookupLimitedToSameAccount boolean
ケースのエンタイトルメント関連ルックアップ
検索条件が、ケースの取引先に関連するエンタ
イトルメントのみを返すか (true)、否か (false)
を示します。
entitlementLookupLimitedToSameAsset boolean
ケースのエンタイトルメント関連ルックアップ
検索条件が、ケースの納入商品に関連するエン
タイトルメントのみを返すか (true)、否か
(false) を示します。
entitlementLookupLimitedToSameContact boolean
ケースのエンタイトルメント関連ルックアップ
検索条件が、ケースの取引先担当者に関連する
エンタイトルメントのみを返すか (true)、否か
(false) を示します。
宣言的なメタデータの定義のサンプル
これは、エンタイトルメント設定ファイルのサンプルです。
<?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>
534
メタデータ型
ForecastingSettings
<entitlementLookupLimitedToSameContact>
false
</entitlementLookupLimitedToSameContact>
</EntitlementSettings>
関連トピック:
設定
ForecastingSettings
コラボレーション売上予測設定オプションを表します。Metadata メタデータ型を拡張し、その fullName 項目
を継承します。
メモ: この情報は、コラボレーション売上予測にのみ適用されます。
ファイルのサフィックスおよびディレクトリの場所
ForecastingSettings の値は、対応するパッケージディレクトリの settings ディレクトリの
Forecasting.settings という 1 つのファイルに保存されます。.settings ファイルは、各設定コンポー
ネントに設定ファイルが 1 つしかないため、他の名前つきのコンポーネントとは異なります。
バージョン
ForecastingSettings コンポーネントは、API バージョン 28 以降で使用できます。ForecastingSettings 型の構造は、API
バージョン 30.0 で大幅に変更されました。
項目
項目名
データ型
説明
displayCurrency
DisplayCurrency
売上予測の表示に使用する通貨。組織のマスタ通貨または
(string 型の列挙) 各売上予測所有者の個人設定の通貨のいずれかになりま
す。これは、コラボレーション売上予測で使用され、設定
で選択されるデフォルトの通貨です。組織で使用するため
に有効化されているいずれか 1 つの通貨を選択する必要が
あり、選択できるのは 1 つのみです。デフォルトは
Corporate です。有効な値は、次のとおりです。
• Corporate
• Personal
535
メタデータ型
ForecastingSettings
項目名
データ型
説明
enableForecasts
boolean
コラボレーション売上予測が有効化されているかどうかを
示します。コラボレーション売上予測を有効にするには
true に設定し、無効にするには false に設定します。
警告: 売上予測を無効にすると、データが失われる
可能性があります。機能を無効にする前に、オンラ
インヘルプを参照してください。
forecastingTypeSettings
ForecastingType
Settings[]
売上予測種別のリストです。項目値については、
「ForecastingTypeSettings」を参照してください。売上予測種
別の最大数は 4 です。
ForecastingTypeSettings
各売上予測種別の設定。組織では、最大 4 個の売上予測種別を有効にできます。最小の API バージョンがメタ
データパッケージバージョン以下の、以前有効だった売上予測種別を除外すると、その目標と調整データが組
織から削除されます。
警告: XML から売上予測種別項目を除外すると、その売上予測種別が無効になる場合があります。その売
上予測種別が XML パッケージバージョンで指定されたリリースで使用可能だった場合、その売上予測種
別は無効になり、その目標および調整データは削除されます。
項目名
データ型
説明
active
boolean
これは、name 項目で指定されている売上予測種別が有効
かどうかを示します。
メモ: active 項目を false に設定すると、その売上予
測種別のすべての売上予測データ、調整、および目
標が消去されます。active を true に設定すると、
[売上予測] タブの一部の値がすぐに表示されない場
合があります。処理中アイコンが表示され、値が計
算中であることを示します。
adjustmentsSettings
AdjustmentsSettings これは、売上予測の売上予測調整オプションを有効または
無効にします。
forecastRangeSettings
ForecastRangeSettings コラボレーション売上予測のデフォルトの期間と範囲の選
択。
name
string
売上予測種別の名前。売上予測種別ごとに特定の文字列が
必要です。
使用できる値は次のとおりです。
• OpportunityRevenue: 商談 - 収益
• OpportunityQuantity: 商談 - 数量
536
メタデータ型
項目名
ForecastingSettings
データ型
説明
• OpportunitySplitRevenue: 商談収益分割 - 収益
• OpportunityOverlayRevenue: 商談オーバーレイ分割
- 収益
• OpportunityLineItemRevenue: 商品ファミリ - 収益
• OpportunityLineItemQuantity: 商品ファミリ - 数量
• 売上予測種別として有効化されているカスタム商談分
割種別の名前。カスタム分割種別は通貨項目に基づい
ており、収益金額のみを保存できます。
opportunityListFields
SelectedSettings
OpportunityListFields 売上予測種別の売上予測ページの商談ペインに表示するた
SelectedSettings
めに選択された項目。[商談名] は必須項目です。15 項目
まで選択できます。
quotasSettings
QuotasSettings
これは、売上予測の目標オプションを有効または無効にし
ます。
AdjustmentsSettings
コラボレーション売上予測の調整オプション。
項目
データ型
説明
enableAdjustments
boolean
コラボレーション売上予測の調整を有効にするには
true に設定し、無効にするには false に設定し
ます。すべての売上予測種別には、同じ
enableAdjustments 値が含まれている必要があり
ます。
警告: 調整を無効にすると、コラボレーショ
ン売上予測調整データが消去されます。
ForecastRangeSettings
コラボレーション売上予測のデフォルトの期間と範囲の選択。ユーザは、過去または将来の 12 か月または 8
四半期までの売上予測が可能です。売上予測範囲に当月または四半期が含まれている場合、[売上予測] ページ
の積み上げ集計テーブルでデフォルトで選択されている期間は当月または当四半期です。 含まれていない場
合、最初の月または四半期が積み上げ集計テーブルでデフォルトで選択されます。すべての売上予測種別に
は、同じ forecastRangeSettings 項目値が含まれている必要があります。
警告: 期間の設定を [毎月] から [毎四半期] または [毎四半期] から [毎月] に変更するか、標準会計年度を変
更すると、すべての調整および目標が消去されます。これらの変更により、売上予測の再計算がトリガ
されます。組織のデータ量に応じて、この再計算にかなりの時間がかかる場合があります。
537
メタデータ型
ForecastingSettings
項目
データ型
説明
beginning
int
デフォルトで表示する開始月または開始四半期を示
します。
displaying
int
デフォルトで表示する月数または四半期数を示しま
す。最大月数は 12、最大四半期数は 8 です。
periodType
PeriodTypes (string 型の列挙) 使用する期間の種別を示します。有効な値は、次の
とおりです。
• Month
• Quarter
OpportunityListFieldsSelectedSettings
売上予測種別の売上予測ページの商談ペインに表示するために選択された項目。[商談名] は必須項目です。
15 項目まで選択できます。
項目
データ型
説明
field
string
商談ペインに表示する項目名を指定します。
QuotasSettings
QuotasSettings は、コラボレーション売上予測で目標を使用できるかどうかを示します。
項目
データ型
説明
showQuotas
boolean
目標を有効にするには、true に設定します。すべ
ての売上予測種別には、同じ showQuotas 項目値
が含まれている必要があります。
宣言的なメタデータの定義のサンプル
次に、[商談 - 収益] および [商品ファミリ - 数量] 売上予測種別を有効にする 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>
538
メタデータ型
IdeasSettings
<name>OpportunityRevenue</name>
<forecastRangeSettings>
<beginning>0</beginning>
<displaying>6</displaying>
<periodType>Month</periodType>
</forecastRangeSettings>
<opportunityListFieldsSelectedSettings>
<field>OPPORTUNITY.NAME</field>
</opportunityListFieldsSelectedSettings>
<quotasSettings>
<showQuotas>true</showQuotas>
</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 つしかないた
め、他の名前つきのコンポーネントとは異なります。
539
メタデータ型
IdeasSettings
バージョン
IdeasSettings は、API バージョン 27.0 以降で使用できます。
アイデア
アイデアおよびアイデアのテーマの設定を表します。
項目
項目名
データ型
説明
enableIdeaThemes
boolean
アイデアのテーマが有効化されているか (true)、否か
(false) を示します。
enableIdeas
boolean
アイデアが有効化されているか (true)、否か (false) を示
します。
enableIdeasReputation
boolean
評価が有効化されているか (true)、否か (false) を示しま
す。組織で「アイデアの評価」権限が有効化されていない
場合は、IdeasReputation を有効化できません。この項目は
API バージョン 28.0 以降で使用できます。
enableChatterProfile
boolean
アイデアユーザプロファイルに Chatter ユーザプロファイル
が使用されることを示します。enableChatterProfile
が true である場合、ideasProfilePage 値は指定しな
いでください。enableChatterProfile が false であ
る場合、ideasProfilePage 値を指定します。指定しな
い場合、アイデアゾーンプロファイルが使用されます。こ
の項目は API バージョン 29.0 以降で使用できます。
ideasProfilePage
string
enableChatterProfile が false の場合に、カスタム
アイデアユーザプロファイルに使用する Visualforce ページ
の名前。enableChatterProfile が false である場合、
ideasProfilePage 値を指定します。指定しない場合、
アイデアゾーンプロファイルが使用されます。この項目は
API バージョン 29.0 以降で使用できます。
halfLife
double
[人気のあるアイデア] サブタブで、どのくらいの期間が経
過すると古いアイデアの順位が下がるのかを示します。半
減期設定により、[人気のあるアイデア] サブタブで古いア
イデアが順位を下げ、新しい投票を多く集めているアイデ
アに順位を譲るまでの日数が決められます。半減期が短い
と、長い場合よりも早く古いアイデアがページの下の方に
移動します。
540
メタデータ型
KnowledgeSettings
宣言的なメタデータの定義のサンプル
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>
関連トピック:
設定
KnowledgeSettings
Salesforce ナレッジの設定管理に使用するメタデータを表します。Metadataメタデータ型を拡張し、その fullName
項目を継承します。
パッケージマニフェストでは、「Settings」の名前を使用してすべての組織設定メタデータ型にアクセスしま
す。詳細は「設定」を参照してください。
ファイルのサフィックスおよびディレクトリの場所
KnowledgeSettings の値は、settings ディレクトリの Knowledge.settings という 1 つのファイルに保存され
ます。.settings ファイルは、各設定コンポーネントに設定ファイルが 1 つしかないため、他の名前つきの
コンポーネントとは異なります。
バージョン
KnowledgeSettings は、API バージョン 27.0 以降で使用できます。
項目
項目名
データ型
説明
answers
KnowledgeAnswerSettings
Salesforce ナレッジおよびアンサーの設定
管理に使用するメタデータを表します。
cases
KnowledgeCaseSettings
Salesforce ナレッジおよびケースの設定管
理に使用するメタデータを表します。
defaultLanguage
string
必須。Salesforce ナレッジのデフォルトの
言語。米国英語では en_US など、言語の
略語を使用します。
541
メタデータ型
KnowledgeSettings
項目名
データ型
説明
languages
KnowledgeLanguageSettings
Salesforce ナレッジで有効化された言語の
リスト。
enableChatterQuestionKBDeflection boolean
Chatterを介したケースのデフレクション
の追跡が有効か (true)、否か (false) を
示します。
enableCreateEditOnArticlesTab boolean
ユーザが記事タブで記事の作成と編集
ができるか (true)、否か (false) を示し
ます。
enableExternalMediaContent
boolean
外部メディアへの接続が有効化されて
いるか (true)、否か (false) を示しま
す。
enableKnowledge
boolean
Salesforce ナレッジが有効化されているか
(true)、否か (false) を示します。
showArticleSummariesCustomerPortal boolean
記事の概要がカスタマーポータルに表
示されるか (true)、否か (false) を示し
ます。
showArticleSummariesInternalApp boolean
記事の概要が社内の知識ベースに表示
されるか (true)、否か (false) を示しま
す。
showArticleSummariesPartnerPortal boolean
記事の概要がパートナーポータルに表
示されるか (true)、否か (false) を示し
ます。
boolean
検証状況が記事に表示されるか (true)、
否か (false) を示します。
showValidationStatusField
KnowledgeAnswerSettings
Salesforce ナレッジおよびアンサーの設定管理に使用するメタデータを表します。
項目名
データ型
説明
assignTo
string
アンサーから記事が割り当てられるユーザ名を指定しま
す。
defaultArticleType
string
アンサーから作成される記事のデフォルトの記事タイプ。
記事タイプの API 名を使用します。
enableArticleCreation
boolean
ユーザがアンサーから記事を作成できるか (true)、否か
(false) を示します。
542
メタデータ型
KnowledgeSettings
KnowledgeCaseSettings
Salesforce ナレッジおよびケースの設定管理に使用するメタデータを表します。
項目名
データ型
説明
articlePDFCreationProfile
string
ケースから記事の PDF を作成するために
使用するプロファイル。
articlePublicSharingSites
KnowledgeSitesSettings
Salesforce ナレッジおよびサイトの設定管
理に使用するメタデータを表します。
articlePublicSharingSitesChatterAnswers KnowledgeSitesSettings
Chatter アンサーで Salesforce ナレッジおよ
びサイトの設定管理に使用するメタデー
タを表します。
assignTo
string
ケースから記事が割り当てられるユーザ
名を指定します。
customizationClass
string
カスタマイズに使用する Apex クラスを指
定します。
defaultContributionArticleType
string
ケースから作成される記事のデフォルト
の記事タイプ。
editor
KnowledgeCaseEditor (string
型の列挙)
リッチテキストエディタの種類を示しま
す。有効な値は、次のとおりです。
• simple
• standard
boolean
ユーザがケースから記事を作成できるか
(true)、否か (false) を示します。
KnowledgeCaseSettings の他の項目を設定で
きるかどうかを制御します。
enableArticlePublicSharingSites boolean
ケースから公開サイト (URL) 経由で記事を
共有できるか (true)、否か (false) を示
します。
boolean
ケースから記事の PDF を作成するために
プロファイルが使用されるか (true)、否
か (false) を示します。
enableArticleCreation
useProfileForPDFCreation
KnowledgeSitesSettings
Salesforce ナレッジおよびサイトの設定管理に使用するメタデータを表します。
543
メタデータ型
KnowledgeSettings
項目名
データ型
説明
site
string[]
Salesforce ナレッジおよびサイトに使用するサイトを指定し
ます。
KnowledgeLanguageSettings
Salesforce ナレッジで有効化された言語のリスト。KnowledgeLanguageSettings は、API バージョン 28.0 以降で使用で
きます。
項目名
データ型
説明
language
KnowledgeLanguage
Salesforce ナレッジで有効化された言語の設
定管理に使用するメタデータを表します。
KnowledgeLanguage
Salesforce ナレッジで有効化された言語の設定管理に使用するメタデータを表します。KnowledgeLanguage は、API
バージョン 28.0 以降で使用できます。
項目名
データ型
説明
active
boolean
言語が有効化されているか (true)、否か
(false) を示します。
defaultAssignee
string
その言語の記事のデフォルトの任命先。
defaultAssigneeType
KnowledgeLanguageLookupValueType
(string 型の列挙)
デフォルトの任命先の種別を示します。有
効な値は、次のとおりです。
• user
• queue
defaultReviewer
string
その言語の記事のデフォルトの校閲者。
defaultReviewerType
KnowledgeLanguageLookupValueType
(string 型の列挙)
デフォルトの校閲者の種別を示します。有
効な値は、次のとおりです。
• user
• queue
name
string
言語名のコード (英語の場合は en)。サポー
トされる言語およびそのコードの一覧は、
Salesforce オンラインヘルプの「Salesforce がサ
ポートする言語は?」を参照してください。
544
メタデータ型
LiveAgentSettings
宣言的なメタデータの定義のサンプル
これは、ナレッジ設定ファイルのサンプルです。
<?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 knowledge
profile</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>
関連トピック:
設定
LiveAgentSettings
Live Agent が有効化されているかどうかなどの、組織の Live Agent 設定を表します。Metadata メタデータ型を拡張
し、その fullName 項目を継承します。
ファイルのサフィックスおよびディレクトリの場所
LiveAgentSettingsの値は、settings ディレクトリの LiveAgent.settings ファイルに保存されます。.settings
ファイルは、各設定コンポーネントに設定ファイルが 1 つしかないため、他の名前つきのコンポーネントとは
異なります。
545
メタデータ型
MobileSettings
パッケージマニフェストでは、「Settings」の名前を使用してすべての組織設定メタデータ型にアクセスしま
す。詳細は「設定」を参照してください。
バージョン
LiveAgentSettings は、API バージョン 28.0 以降で使用できます。
項目
項目名
データ型
説明
enableLiveAgent
boolean
Live Agent が有効化されているか (true)、否か
(false) を示します。
宣言的なメタデータの定義のサンプル
これは、Live Agent 設定ファイルのサンプルです。
<?xml version="1.0" encoding="UTF-8"?>
<LiveAgentSettings xmlns="http://soap.sforce.com/2006/04/metadata">
<enableLiveAgent>true</enableLiveAgent>
</LiveAgentSettings>
MobileSettings
Chatter 設定や、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 以降で使用できます。
546
メタデータ型
MobileSettings
項目
項目
データ型
説明
chatterMobile
ChatterMobileSettings
Chatter Mobile デバイスの設定。
dashboardMobile
DashboardMobileSettings
モバイルデバイスのダッシュボー
ドの設定。
salesforceMobile
SFDCMobileSettings
モバイルデバイスの一般的なユー
ザの設定。
touchMobile (廃止)
TouchMobileSettings
モバイルデバイスのタッチの設定。
ChatterMobileSettings
組織の Chatter Mobile 設定を表します。
項目
データ型
説明
IPadAuthorized
boolean
iPad デバイスで Chatter Mobile が有効
化されているか (true)、否か
(false) を示します。
IPhoneAuthorized
boolean
iPhone デバイスで Chatter Mobile が有
効化されているか (true)、否か
(false) を示します。
androidAuthorized
boolean
Android デバイスで Chatter Mobile が有
効化されているか (true)、否か
(false) を示します。
blackBerryAuthorized
boolean
Blackberry デバイスで Chatter Mobile が
有効化されているか (true)、否か
(false) を示します。
enableChatterMobile
boolean
組織で Chatter Mobile が有効化されて
いるか (true)、否か (false) を示し
ます。
メモ: これを true に設定す
ると、その他のすべての設定
を設定できます。この設定を
true から false に変更し
て、さらに、その他いずれか
の ChatterMobile 設定を変更し
ようと試みると、リリースは
エラーで失敗します。
547
メタデータ型
MobileSettings
項目
データ型
説明
enablePushNotifications
boolean
組織で Chatter 転送通知が有効化さ
れているか (true)、否か (false) を
示します。
sessionTimeout
MobileSessionTimeout (string 型の列挙) 何も操作を行っていないユーザに、
ログアウトするか操作を続行する
かを尋ねるまでの時間。有効な値
は、次のとおりです。
• Never
• OneMinute
• FiveMinutes
• TenMinutes
• ThirtyMinutes
DashboardMobileSettings
組織のモバイルダッシュボード iPad アプリケーションの設定を表します。
項目
データ型
説明
enableDashboardIPadApp
boolean
モバイルダッシュボード iPad アプリ
ケーションが組織で有効化されて
いるか (true)、否か (false) を示し
ます。
SFDCMobileSettings
組織の一般的なモバイル設定を表します。
項目
データ型
説明
enableUserToDeviceLinking
boolean
ユーザをモバイルデバイスに永続
的にリンクします。ユーザがシス
テム管理者の介入なしでデバイス
を切り替えることができないよう
にする場合のみ、このオプション
を true に設定します。
enableMobileLite
boolean
組織で Mobile Lite が有効化されてい
るか (true)、否か (false) を示しま
す。
548
メタデータ型
MobileSettings
TouchMobileSettings
この項目は廃止されました。Salesforce Touch は、Salesforce1 アプリケーションにアップグレードされました。
項目
データ型
説明
enableTouchBrowserIPad
boolean
組織で Salesforce Touch モバイルブラ
ウザアプリケーションが有効化さ
れているか (true)、否か (false) を
示します。
enableTouchAppIPad
boolean
組織で Salesforce Touch のダウンロー
ド可能なアプリケーションが有効
化されているか (true)、否か
(false) を示します。
宣言的なメタデータの定義のサンプル
これは、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>
関連トピック:
設定
549
メタデータ型
OpportunitySettings
OpportunitySettings
商談の自動更新や類似商談条件検索などの機能に関する組織の設定を表します。Metadata メタデータ型を拡張
し、その fullName 項目を継承します。
ファイルのサフィックスおよびディレクトリの場所
OpportunitySettings の値は、対応するパッケージディレクトリの settings ディレクトリの
Opportunity.settings という 1 つのファイルに保存されます。.settings ファイルは、各設定コンポー
ネントに設定ファイルが 1 つしかないため、他の名前つきのコンポーネントとは異なります。
バージョン
OpportunitySettings は、API バージョン 28.0 以降で使用できます。
項目
項目名
データ型
説明
enableUpdateReminders
boolean
ユーザは商談でスケジュール済みの自動更新を有効化する
ことができます。
autoActivateNewReminders boolean
新しい商談に自動的にスケジュール済みの更新を使用しま
す。
enableFindSimilarOpportunities boolean
既存の商談に関連または類似する商談を表示できます。
findSimilarOppFilter
multipicklist
類似商談のパラメータを定義します。
enableOpportunityTeam
boolean
チームメンバーを商談に関連付けることができます。
promptToAddProducts
boolean
関連する商品を商談に追加することをユーザに要求しま
す。
FindSimilarOppFilter
列全体または項目全体のどちらで照合するかを定義します。
項目
データ型
説明
similarOpportunitiesDisplayColumns string
比較する列。
similarOpportunitiesMatchFields string
比較する項目。
550
メタデータ型
OrderSettings
宣言的なメタデータの定義のサンプル
次に、パッケージファイルの例を示します。
<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<types>
<members>Opportunity</members>
<name>Settings</name>
</types>
<version>28.0</version>
</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
ヘルプの「注文の設定のカスタマイズ」を参照してください。
パッケージマニフェストでは、「Settings」の名前を使用してすべての組織設定メタデータ型にアクセスしま
す。詳細は「設定」を参照してください。
ファイルのサフィックスおよびディレクトリの場所
settings フォルダ内の Order.settings という名前のファイルに 1 つの OrderSettings コンポーネントが入っ
ています。.settings ファイルは、各設定コンポーネントに設定ファイルが 1 つしかないため、他の名前つ
きのコンポーネントとは異なります。
バージョン
OrderSettings コンポーネントは、API バージョン 30.0 以降で使用できます。
551
メタデータ型
ProductSettings
項目
項目名
データ型
説明
enableNegativeQuantity
boolean
組織のユーザが、数量が 0 未満の注文商品を追加できるか
(true)、否か (false) を示します。
この設定を有効にするには、enableOrders を true に設
定する必要があります。
enableOrders
boolean
組織で注文が有効化されているか (true)、否か (false) を
示します。
enableReductionOrders
boolean
組織で削減注文が有効化されているか (true)、否か (false)
を示します。詳細は、Salesforce ヘルプの「削減注文の概
要」を参照してください。
この設定を有効にするには、enableOrders を true に設
定する必要があります。
宣言的なメタデータの定義のサンプル
これは、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>
前の定義を参照する package.xml の例を次に示します。
<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<types>
<members>Order</members>
<name>Settings</name>
</types>
<version>30.0</version>
</Package>
ProductSettings
数量スケジュール、収益スケジュール、および有効フラグと価格の相互作用の組織の設定を表します。Metadata
メタデータ型を拡張し、その fullName 項目を継承します。
552
メタデータ型
QuoteSettings
ファイルのサフィックスおよびディレクトリの場所
ProductSettings の値は、対応するパッケージディレクトリの settings ディレクトリの Product.settings と
いう 1 つのファイルに保存されます。.settings ファイルは、各設定コンポーネントに設定ファイルが 1 つ
しかないため、他の名前つきのコンポーネントとは異なります。
バージョン
ProductSettings は、API バージョン 28.0 以降で使用できます。
項目
項目名
データ型
enableCascadeActivateToRelatedPrices boolean
説明
商品レコード上の有効フラグを変更した場合、関連する価
格の有効フラグも自動的に更新します。
enableQuantitySchedule
boolean
商品の数量スケジュールを有効化します。
enableRevenueSchedule
boolean
商品の収益スケジュールを有効化します。
宣言的なメタデータの定義のサンプル
次に、パッケージファイルの例を示します。
<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<types>
<members>Product</members>
<name>Settings</name>
</types>
<version>28.0</version>
</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 項目を継承します。
553
メタデータ型
SecuritySettings
ファイルのサフィックスおよびディレクトリの場所
QuoteSettings の値は、対応するパッケージディレクトリの settings ディレクトリの Quote.settings とい
う 1 つのファイルに保存されます。.settings ファイルは、各設定コンポーネントに設定ファイルが 1 つし
かないため、他の名前つきのコンポーネントとは異なります。
バージョン
QuoteSettings は、API バージョン 28.0 以降で使用できます。
項目
項目名
データ型
説明
enableQuote
boolean
true に設定されていると、ユーザは見積にアクセスでき
ます。
宣言的なメタデータの定義のサンプル
次に、パッケージファイルの例を示します。
<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<types>
<members>Quote</members>
<name>Settings</name>
</types>
<version>28.0</version>
</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」の名前を使用してすべての組織設定メタデータ型にアクセスしま
す。詳細は「設定」を参照してください。
554
メタデータ型
SecuritySettings
宣言的なメタデータファイルのサフィックスおよびディレクトリの場所
SecuritySettings の値は、settings ディレクトリの Security.settings という 1 つのファイルに保存されま
す。.settings ファイルは、各設定コンポーネントに設定ファイルが 1 つしかないため、他の名前つきのコ
ンポーネントとは異なります。
メモ: SecuritySettings は、API バージョン 25.0 および 26.0 では今後使用できません。
バージョン
セキュリティ設定は、API バージョン 27.0 以降で使用できます。
項目
項目名
データ型
説明
networkAccess
NetworkAccess
信頼済み IP アドレスの範囲は、ユーザがコンピュー
タの有効化を要求せずに常にログインできる IP 範囲
です。
passwordPolicies
PasswordPolicies
パスワードとログインの要件、および忘れたパス
ワードの取得をサポートする情報です。
sessionSettings
SessionSettings
セッションの有効期限とセキュリティの設定。
NetworkAccess
ネットワークアクセスのための組織の信頼済み IP アドレス範囲を表します。
項目
データ型
説明
ipRanges
IpRange[]
信頼済み IP アドレスの範囲は、ユーザがコンピュー
タの有効化を要求せずに常にログインできる IP 範囲
です。
メモ: IP 範囲を追加するには、すべての既存の
IP 範囲と追加する IP 範囲を同時にリリースす
る必要があります。追加する IP 範囲のみリリー
スした場合、既存の IP 範囲がリリースする IP
範囲に置き換えられます。組織のすべての IP
範囲を削除するには、networkAccess 項目を空
白のままにしてください
(<networkAccess></networkAccess>)。
555
メタデータ型
SecuritySettings
IpRange
ネットワークアクセスのための信頼済み IP アドレスの範囲を定義します。
項目
データ型
説明
end
string
信頼済みアドレスの範囲の上限を定義する IP アドレ
ス。
start
string
信頼済みアドレスの範囲の下限を定義する IP アドレ
ス。
PasswordPolicies
組織のパスワードとログインポリシーを表します。
項目
データ型
説明
apiOnlyUserHomePageURL string
complexity
「API 限定ユーザ」権限を持つユーザがログインペー
ジの代わりにリダイレクトされる URL。
Complexity (string 型の列挙) 必須。ユーザのパスワードとして使用できる文字の
種別の要件。有効な値は、次のとおりです。
• NoRestriction — 任意のパスワード値を許可
します。最も安全性の低いオプションです。
• AlphaNumeric — 少なくとも 1 つの英字と 1 つ
の数字を使用する必要があります。これはデフォ
ルト値です。
• SpecialCharacters — 少なくとも 1 つの英字、
1 つの数字、および ! # $ % - _ = + < > の
うちの 1 文字を含む必要があります。
• UpperLowerCaseNumeric — 少なくとも 1 つの
数字、1 つの英大文字、および 1 つの英小文字を
使用する必要があります。この値は、API バー
ジョン 32.0 以降で使用できます。
• UpperLowerCaseNumericSpecialCharacters
— 少なくとも 1 つの数字、1 つの英大文字、1 つ
の英小文字、および ! # $ % - _ = + < > の
うちの 1 文字を含む必要があります。この値は、
API バージョン 32.0 以降で使用できます。
expiration
Expiration (string 型の列挙)
必須。すべてのユーザパスワードが失効し、変更す
る必要が生じるまでの期間。有効な値は、次のとお
りです。
• Never
556
メタデータ型
項目
SecuritySettings
データ型
説明
• ThirtyDays
• SixtyDays
• NinetyDays。これはデフォルト値です。
• SixMonths
• OneYear
パスワードの最小有効期限 (1 日) が必要か (true)、
否か (false) を示します。この項目は API バージョ
ン 32.0 以降で使用できます。
minimumPasswordLifetime boolean
string
ユーザがクリックして忘れたパスワードを取得でき
る URL。
passwordAssistanceMessage string
パスワードをリセットするユーザに対して、「アカ
ウントロックアウト」メールと [ID を確認] 画面の下
部に表示されるテキスト。
historyRestriction
string
必須。新しく再設定されるパスワードが常に一意の
パスワードになるように、保存されるユーザの過去
のパスワードの数。保存されるパスワード数の有効
な値は、0 から 24 です。最大値 24 は、APIバージョ
ン32.0以降に適用されます。以前のバージョンの最
大値は 16 です。デフォルト値は、3 です。
lockoutInterval
LockoutInterval (string 型の列 必須。ロックアウトが解除されるまでの所要時間。
挙)
有効な値は、次のとおりです。
passwordAssistanceURL
• FifteenMinutes。これはデフォルト値です。
• ThirtyMinutes
• SixtyMinutes
• Forever (システム管理者のみがリセット可能)
maxLoginAttempts
MaxLoginAttempts (string 型の 必須。ログイン失敗が許される回数。この回数を超
列挙)
えると、そのユーザはロックアウトされ、ログイン
できなくなります。有効な値は、次のとおりです。
• NoLimit
• ThreeAttempts
• FiveAttempts
• TenAttempts。これはデフォルト値です。
minPasswordLength
MinPasswordLength (string 型 必須。パスワードに必要な最小限の文字数。有効な
の列挙)
値は、次のとおりです。
• FiveCharacters
• EightCharacters。これはデフォルト値です。
557
メタデータ型
項目
SecuritySettings
データ型
説明
• TenCharacters
• TwelveCharacters (この値は API バージョン
32.0 以降で使用できます)。
obscureSecretAnswer
パスワードに関連付けられた秘密の答えを非表示に
するか (true)、否か (false) を示します。
boolean
メモ: 組織で、入力モードがひらがなに設定
された Microsoft Input Method Editor (IME) を使用し
ている場合、通常のテキスト項目に ASCII 文字
を入力すると日本語文字に変換されます。た
だし、IME は伏せ字のテキストを含む項目では
適切に動作しません。この機能を有効にした
後で組織のユーザがパスワードまたはその他
の値を正しく入力できない場合は、機能を無
効にしてください。
questionRestriction
QuestionRestriction (string 型
の列挙)
必須。パスワードヒントの質問に対する回答にパス
ワードそのものを含めることができるかどうかにつ
いての制限。有効な値は、次のとおりです。
• None
• DoesNotContainPassword。これはデフォルト
値です。
SessionSettings
組織のセッションの有効期限とセキュリティ設定を表します。
項目
データ型
説明
disableTimeoutWarning
boolean
セッションタイムアウトの警告ポップアップが無効
化されるか (true)、有効化されるか (false) を示し
ます。
enableCSRFOnGet
boolean
設定以外のページの GET 要求のクロスサイトリクエ
ストフォージェリ (CSRF) 保護が有効化されているか
(true)、否か (false) を示します。
enableCSRFOnPost
boolean
設定以外のページの POST 要求のクロスサイトリク
エストフォージェリ (CSRF) 保護が有効化されている
か (true)、否か (false) を示します。
558
メタデータ型
項目
SecuritySettings
データ型
説明
enableCacheAndAutocomplete boolean
ユーザのブラウザにユーザ名を保存して、ログイン
ページの [ユーザ名] 項目に自動入力できるように
するか (true)、否か (false) を示します。
enableClickjackNonsetupSFDC boolean
設定以外のSalesforceページでクリックジャック保護
が有効化されるか (true)、無効化されるか (false)
を示します。
enableClickjackNonsetupUser boolean
設定以外の顧客ページでクリックジャック保護が有
効化されるか (true)、無効化されるか (false) を示
します。
enableClickjackSetup
boolean
設定ページでクリックジャック保護が有効化される
か (true)、無効化されるか (false) を示します。
enablePostForSessions
boolean
ユーザが Visualforce ページを使用している場合など
に、クロスドメインセッション情報が GET 要求では
なく POST 要求を使用して交換されるかどうかを示
します。このコンテキストでは、POST 要求は GET 要
求よりもセキュアです。API バージョン 31.0 以降で
使用できます。
enableSMSIdentity
boolean
ユーザが SMS 経由で 1 回限りの PIN を取得できるか
(true)、否か (false) を示します。
forceLogoutOnSessionTimeout boolean
無効なユーザのセッションがタイムアウトすると、
現在のセッションが無効になることを示します。ブ
ラウザは自動的に更新されて、ログインページに戻
ります。この状況が発生した場合に組織に再びアク
セスするには、再ログインする必要があります。有
効化 (true)、または無効化 (false) します。API バー
ジョン 31.0 以降で使用できます。
forceRelogin
boolean
別のユーザとしてログインしているシステム管理者
が、セカンダリユーザとしてログアウトしてから元
のセッションに再度ログインする必要があるか
(true)、否か (false) を示します。
lockSessionsToIp
boolean
ユーザセッションが、ユーザがログインした IP アド
レスにロックされるか (true)、否か (false) を示し
ます。
sessionTimeout
SessionTimeout (string 型の列 何も操作を行っていないユーザに、ログアウトする
挙)
か操作を続行するかを尋ねるまでの時間。有効な値
は、次のとおりです。
• FifteenMinutes
• ThirtyMinutes
559
メタデータ型
項目
SecuritySettings
データ型
説明
• 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>
560
メタデータ型
Territory2Settings
</sessionSettings>
</SecuritySettings>
関連トピック:
設定
Territory2Settings
Territory Management 2.0 ユーザが、営業テリトリーに関連付けられているレコードにアクセスして変更できるよ
うにするためのデフォルト設定のメタデータを表します。標準レコードアクセス設定は、取引先と商談に適用
されます。組織で取引先責任者とケースに「非公開」のデフォルトの内部アクセス権を使用している場合は、
それらのレコードのアクセス権も設定できます。Metadata メタデータ型を拡張し、その fullName 項目を継承
します。組織で Territory Management 2.0 が有効化されている場合にのみ使用できます。
ファイルのサフィックスおよびディレクトリの場所
Territory2Settings コンポーネントのサフィックスは settings で、Settings フォルダに保存されます。
バージョン
Territory2Settings コンポーネントは、API バージョン 32.0 以降で使用できます。
特別なアクセスルール
Territory2Model オブジェクトは、SOAP API に State 項目があります。状態は計画中、有効、アーカイブ済みのほ
か、コピー中などプロセスが進行中であることを示すものも多数あります。「テリトリーの管理」権限のない
ユーザは、有効状態のモデルに属するテリトリーにのみアクセスできます。すべてのテリトリー管理エンティ
ティに対する deploy() コールには、メタデータ API で必要な「すべてのデータの編集」権限のほかに「テリ
トリーの管理」権限が必要です。「テリトリーの管理」権限のないユーザが retrieve() を実行すると、有
効状態の Territory2Model に属するエンティティのみが返されます。「テリトリーの管理」権限なしにコールを
実行してもデータの一部しか取得されないためお勧めしません。
項目
項目名
データ型
説明
defaultAccountAccessLevel string
テリトリーの取引先レコードに対してユーザが持つ必要が
あるデフォルトアクセスレベル: テリトリーに割り当てら
れた取引先の参照および編集、またはテリトリーに割り当
てられた取引先の参照、編集、移行、および削除。
string
テリトリーのケースレコードに対してユーザが持つ必要が
あるデフォルトアクセスレベル: テリトリーに割り当てら
defaultCaseAccessLevel
561
メタデータ型
項目名
SharedTo
データ型
説明
れた取引先の参照および編集、またはテリトリーに割り当
てられた取引先の参照、編集、移行、および削除。
defaultContactAccessLevel string
テリトリーの取引先責任者レコードに対してユーザが持つ
必要があるデフォルトアクセスレベル: テリトリーに割り
当てられた取引先の参照および編集、またはテリトリーに
割り当てられた取引先の参照、編集、移行、および削除。
defaultOpportunityAccessLevel string
テリトリーの商談レコードに対してユーザが持つ必要があ
るデフォルトアクセスレベル: テリトリーに割り当てられ
た取引先の参照および編集、またはテリトリーに割り当て
られた取引先の参照、編集、移行、および削除。
宣言的なメタデータの定義のサンプル
次の例は、Territory2Settings コンポーネントの定義を示します。
<?xml version="1.0" encoding="UTF-8"?>
<Territory2Settings xmlns="http://soap.sforce.com/2006/04/metadata">
<defaultAccountAccessLevel>Owner</defaultAccountAccessLevel>
<defaultOpportunityAccessLevel>Read</defaultOpportunityAccessLevel>
<defaultCaseAccessLevel>None</defaultCaseAccessLevel>
<defaultContactAccessLevel>Edit</defaultContactAccessLevel>
</Territory2Settings>
使用方法
Territory Management 2.0 のコンポーネントは、パッケージ化や変更セットをサポートしておらず、CRUD コールで
サポートされていません。
SharedTo
SharedTo では、リストビューまたはフォルダの共有アクセス権を定義します。所有者に基づく共有ルールの
ターゲットおよびソースを指定するために使用できます。Salesforceオンラインヘルプの「共有に関する考慮事
項」および「グループについて」を参照してください。
宣言的なメタデータファイルのサフィックスおよびディレクトリの
場所
SharedTo は ListView、Folder、およびOwnerSharingRule と一緒に使用します。
562
メタデータ型
SharedTo
バージョン
SharedTo は、API バージョン 17.0 以降で使用できます。
項目
項目
データ型
説明
すべてのカスタマーポータルユーザを含むグルー
プ。
allCustomerPortalUsers string
この項目はAPIバージョン 24.0 以降で使用できます。
allInternalUsers
すべての内部ユーザおよびポータル以外のユーザを
含むグループ。
string
この項目はAPIバージョン 24.0 以降で使用できます。
allPartnerUsers
string
すべてのパートナーユーザを含むグループ。
この項目はAPIバージョン 24.0 以降で使用できます。
group
string[]
共有アクセス権を持つグループのリスト。groups
項目の代わりにこの項目を使用します。
この項目はAPIバージョン 22.0 以降で使用できます。
groups
共有アクセス権を持つグループのリスト。
string[]
API バージョン 22.0 以降では代わりに group 項目を
使用します。
managerSubordinates
string[]
直属および非直属の部下に共有アクセス権が付与さ
れるユーザのリスト。この項目は、API バージョン
24.0 以降で使用できます。
managers
string[]
直属および非直属のマネージャに共有アクセス権が
付与されるユーザのリスト。この項目は、API バー
ジョン 24.0 以降で使用できます。
portalRole
string[]
ポータルロールのすべてのユーザを含む共有アクセ
ス権を持つグループのリスト。
この項目はAPIバージョン 24.0 以降で使用できます。
portalRoleandSubordinates string[]
ポータルロールのすべてのユーザまたはそのロール
の下のユーザを含む共有アクセス権を持つグループ
のリスト。
この項目はAPIバージョン 24.0 以降で使用できます。
563
メタデータ型
SharedTo
項目
データ型
説明
role
string[]
共有アクセス権を持つロールのリスト。roles 項
目の代わりにこの項目を使用します。
この項目はAPIバージョン 22.0 以降で使用できます。
roleAndSubordinates
共有アクセス権を持つロールのリスト。ロール階層
でこれらの各ロールの下位にあるすべてのロールに
も共有アクセス権があります。ポータル取引先が有
効になっている場合、ロール階層のこれらの各ロー
ルの下位にあるすべてのロールおよびポータル取引
先にも共有アクセス権があります。
rolesAndSubordinates 項目の代わりにこの項目
を使用します。
string[]
この項目はAPIバージョン 22.0 以降で使用できます。
roleAndSubordinatesInternal string[]
共有アクセス権を持つロールのリスト。ロール階層
でこれらの各ロールの下位にあるすべてのロールに
も共有アクセス権があります。
この項目はAPIバージョン 22.0 以降で使用できます。
roles
string[]
共有アクセス権を持つロールのリスト。
API バージョン 22.0 以降では代わりに role 項目を
使用します。
rolesAndSubordinates
string[]
共有アクセス権を持つロールのリスト。ロール階層
でこれらの各ロールの下位にあるすべてのロールに
も共有アクセス権があります。ポータル取引先が有
効になっている場合、ロール階層のこれらの各ロー
ルの下位にあるすべてのロールおよびポータル取引
先にも共有アクセス権があります。
API バージョン 22.0 以降では代わりに
roleAndSubordinates 項目を使用します。
territories
string[]
共有アクセス権を持つテリトリーのリスト。
API バージョン 22.0 以降では代わりに territory 項
目を使用します。
territoriesAndSubordinates string[]
共有アクセス権を持つテリトリーのリスト。テリト
リー階層でこれらの各テリトリーの下位にあるすべ
てのテリトリーにも共有アクセス権があります。
API バージョン 22.0 以降では代わりに
territoryAndSubordinates 項目を使用します。
564
メタデータ型
SharingRules
項目
データ型
説明
territory
string[]
共有アクセス権を持つテリトリーのリスト。
territories 項目の代わりにこの項目を使用しま
す。
この項目はAPIバージョン 22.0 以降で使用できます。
共有アクセス権を持つテリトリーのリスト。テリト
リー階層でこれらの各テリトリーの下位にあるすべ
てのテリトリーにも共有アクセス権があります。
territoriesAndSubordinates 項目の代わりに
この項目を使用します。
territoryAndSubordinates string[]
この項目はAPIバージョン 22.0 以降で使用できます。
queue
string[]
共有アクセス権を持つキューのリスト。リード、
ケース、CustomObject 共有ルールにのみ適用します。
この項目はAPIバージョン 24.0 以降で使用できます。
SharingRules
共有ルールのセットを表します。SharingRules を使用すると、対象ユーザグループのアクセスレベルを指定する
ルールを使用して、レコードをユーザのセットと共有できます。Metadataメタデータ型を拡張し、その fullName
項目を継承します。詳細は、Salesforce オンラインヘルプの「共有ルールの概要」を参照してください。
メモ: SharingRules コンポーネントを直接作成することはできません。代わりに、CustomObjectSharingRules な
ど、拡張する型を使用します。このオブジェクトには、パッケージ化のサポートは含まれません。
宣言的なメタデータファイルのサフィックスおよびディレクトリの
場所
SharingRules は、対応するエンティティディレクトリに保存され、ファイル名はエンティティ名と一致します。
たとえば、accountSharingRules ディレクトリには取引先共有ルールの Account.sharingRules ファイ
ルが含まれます。カスタムオブジェクトの SharingRules は、customObjectSharingRules ディレクトリに保存
されます。このディレクトリには、ObjA__c.sharingRules など、拡張子が .sharingRules のファイルが
含まれます。ObjA はカスタムオブジェクト種別の開発者名を指します。
バージョン
SharingRules コンポーネントは、API バージョン 24.0 以降で使用できます。
565
メタデータ型
SharingRules
項目
次の情報は、標準オブジェクトとカスタムオブジェクトの共有ルールの実装を理解していることを前提として
います。これらの項目についての詳細は、Salesforceオンラインヘルプの「共有設定の概要」を参照してくださ
い。
項目
データ型
説明
fullName
string
API アクセスの一意の識別子。
fullName には、アンダースコアと英
数字のみを使用できます。一意である
こと、最初は文字であること、空白は
使用しない、最後にアンダースコアを
使用しない、2 つ続けてアンダースコ
アを使用しないという制約がありま
す。この項目は、Metadata コンポーネ
ントから継承されています。
AccountSharingRules
取引先の共有ルールを表します。SharingRules メタデータ型を拡張し、その fullName 項目を継承します。
項目
データ型
説明
criteriaBasedRules
AccountCriteriaBasedSharingRule[]
ユーザの条件に基づくルールを定義するリス
ト。
ownerRules
AccountOwnerSharingRule[]
ユーザのメンバーシップに基づくルールを定
義するリスト。
CampaignSharingRules
キャンペーンの共有ルールを表します。SharingRules メタデータ型を拡張し、その fullName 項目を継承しま
す。
項目
データ型
説明
criteriaBasedRules
CampaignCriteriaBasedSharingRule[]
ユーザの条件に基づくルールを定義するリス
ト。
ownerRules
CampaignOwnerSharingRule[]
ユーザのメンバーシップに基づくルールを定
義するリスト。
CaseSharingRules
ケースの共有ルールを表します。SharingRules メタデータ型を拡張し、その fullName 項目を継承します。
566
メタデータ型
SharingRules
項目
データ型
説明
criteriaBasedRules
CaseCriteriaBasedSharingRule[]
ユーザの条件に基づくルールを定義するリス
ト。
ownerRules
CaseOwnerSharingRule[]
ユーザのメンバーシップに基づくルールを定義
するリスト。
ContactSharingRules
取引先責任者の共有ルールを表します。SharingRules メタデータ型を拡張し、その fullName 項目を継承しま
す。
項目
データ型
説明
criteriaBasedRules
ContactCriteriaBasedSharingRule[]
ユーザの条件に基づくルールを定義するリス
ト。
ownerRules
ContactOwnerSharingRule[]
ユーザのメンバーシップに基づくルールを定義
するリスト。
LeadSharingRules
リードの共有ルールを表します。SharingRules メタデータ型を拡張し、その fullName 項目を継承します。
項目
データ型
説明
criteriaBasedRules
LeadCriteriaBasedSharingRule[]
ユーザの条件に基づくルールを定義するリス
ト。
ownerRules
LeadOwnerSharingRule[]
ユーザのメンバーシップに基づくルールを定義
するリスト。
OpportunitySharingRules
商談の共有ルールを表します。SharingRules メタデータ型を拡張し、その fullName 項目を継承します。
項目
データ型
説明
criteriaBasedRules
OpportunityCriteriaBasedSharingRule[]
ユーザの条件に基づくルールを定義するリス
ト。
ownerRules
OpportunityOwnerSharingRule[]
ユーザのメンバーシップに基づくルールを定義
するリスト。
567
メタデータ型
SharingRules
AccountTerritorySharingRules
取引先テリトリーの共有ルールを表します。SharingRulesメタデータ型を拡張し、その fullName 項目を継承し
ます。
項目
データ型
説明
rules
AccountTerritorySharingRule[]
ユーザのメンバーシップに基づくルールを定義
するリスト。sharedFrom 項目の許容値のリス
トは次のとおりです。
• territory
• territoryAndSubordinates
CustomObjectSharingRules
カスタムオブジェクトの共有ルールを表します。SharingRulesメタデータ型を拡張し、その fullName 項目を継
承します。
項目
データ型
説明
criteriaBasedRules
CustomObjectCriteriaBasedSharingRule[] ユーザの条件に基づくルールを定義するリス
ト。
ownerRules
CustomObjectOwnerSharingRule[]
ユーザのメンバーシップに基づくルールを定義
するリスト。
UserSharingRules
ユーザの共有ルールを表します。ユーザの共有ルールでは、グループのメンバーを別のグループのメンバーと
共有できます。SharingRules メタデータ型を拡張し、その fullName 項目を継承します。
項目
データ型
説明
criteriaBasedRules
UserCriteriaBasedSharingRule[]
ユーザの条件に基づくルールを定義するリス
ト。
membershipRules
UserMembershipSharingRule[]
ユーザのメンバーシップに基づくルールを定義
するリスト。
568
メタデータ型
SharingRules
宣言的なメタデータの定義のサンプル
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>
ユーザの条件に基づく共有ルールとユーザのメンバーシップに基づく共有ルールの定義を次に示します。ファ
イル名は、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>
569
メタデータ型
BaseSharingRule
<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 ファイルのサンプルを次に示します。
<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<types>
<members>UserRule</members>
<name>UserCriteriaBasedSharingRule</name>
</types>
<types>
<members>*</members>
<name>UserMembershipSharingRule</name>
</types>
<version>32.0</version>
</Package>
BaseSharingRule
条件に基づく共有ルールおよび所有者に基づく共有ルールの基本コンテナを表します。Metadata メタデータ型
を拡張し、その fullName 項目を継承します。
メモ: BaseSharingRule コンポーネントを直接作成することはできません。代わりに、CriteriaBasedSharingRule
または OwnerSharingRule メタデータ型でコンポーネントを使用します。
バージョン
BaseSharingRule コンポーネントは、API バージョン 24.0 以降で使用できます。
項目
これらの項目についての詳細は、Salesforce オンラインヘルプの「共有設定の概要」を参照してください。
項目
データ型
説明
sharedTo
SharedTo
必須。レコードを共有するユーザを指
定します。
570
メタデータ型
CriteriaBasedSharingRule
項目
データ型
説明
fullName
string
API アクセスの一意の識別子。
fullName には、アンダースコアと英
数字のみを使用できます。一意である
こと、最初は文字であること、空白は
使用しない、最後にアンダースコアを
使用しない、2 つ続けてアンダースコ
アを使用しないという制約がありま
す。この項目は、Metadata コンポーネ
ントから継承されています。
CriteriaBasedSharingRule
条件に基づく共有ルールを表します。CriteriaBasedSharingRule を使用すると、特定の条件に基づいたレコードの
共有を行えます。BaseSharingRule メタデータ型を拡張し、その sharedTo 項目を継承します。詳細は、Salesforce
オンラインヘルプの「条件に基づく共有ルールの概要」を参照してください。
メモ: CriteriaBasedSharingRule コンポーネントを直接作成することはできません。代わりに子コンポーネン
トを使用してください。
宣言的なメタデータファイルのサフィックスおよびディレクトリの場所
CriteriaBasedSharingRule コンポーネントは、criteriaBasedRules 項目の SharingRules コンポーネント内に
保存されます。
バージョン
CriteriaBasedSharingRule コンポーネントは、API バージョン 24.0 以降で使用できます。
項目
次の情報は、標準オブジェクトとカスタムオブジェクトの共有ルールの実装を理解していることを前提として
います。これらの項目についての詳細は、Salesforceオンラインヘルプの「共有設定の概要」を参照してくださ
い。
項目
データ型
説明
criteriaItems
FilterItem[]
共有ルールの条件を表すリスト。値は
次のとおりです。
• field
• operation
• value
571
メタデータ型
CriteriaBasedSharingRule
AccountCriteriaBasedSharingRule
取引先の条件に基づく共有ルールを表します。CriteriaBasedSharingRule メタデータ型を拡張し、その
criteriaItems 項目を継承します。
AccountCriteriaBasedSharingRule は、AccountSharingRules の criteriaBasedRules 項目によって使用されます。
項目
データ型
説明
accountAccessLevel
ShareAccessLevelNoNone 必須。ユーザまたはグループが取引先に対して持つ
(string 型の列挙)
アクセスレベルを表す値。値は次のとおりです。
• Read
• Edit
• All
booleanFilter
string
caseAccessLevel
ShareAccessLevelNoAll 必須。ユーザまたはグループが取引先に関連付けら
共有ルールの検索条件ロジックを表します。
(string 型の列挙)
れたケースに対して持つアクセスレベルを表す値。
値は次のとおりです。
• None
• Read
• Edit
contactAccessLevel
ShareAccessLevelNoAll 必須。ユーザまたはグループが取引先に関連付けら
(string 型の列挙)
れた取引先責任者に対して持つアクセスレベルを表
す値。値は次のとおりです。
• None
• Read
• Edit
description
共有ルールの説明を表します。最大 1000 文字です。
string
この項目は、API バージョン 29.0 以降で使用できま
す。
name
string
必須。共有ルールの名前。ユーザインターフェース
の [表示ラベル] に対応します。
opportunityAccessLevel ShareAccessLevelNoAll 必須。ターゲットグループに許可される、関連付け
(string 型の列挙)
られた商談に対するアクセスレベルを表す値。値は
次のとおりです。
• None
• Read
• Edit
572
メタデータ型
CriteriaBasedSharingRule
CampaignCriteriaBasedSharingRule
キャンペーンの条件に基づく共有ルールを表します。CriteriaBasedSharingRule メタデータ型を拡張し、その
criteriaItems 項目を継承します。
CampaignCriteriaBasedSharingRule は、CampaignSharingRules の criteriaBasedRules 項目によって使用されます。
項目
データ型
説明
booleanFilter
string
共有ルールの検索条件ロジックを表します。
description
string
共有ルールの説明を表します。最大 1000 文字です。
この項目は、API バージョン 29.0 以降で使用できま
す。
campaignAccessLevel
ShareAccessLevelNoNone 必須。ターゲットグループに許可される、キャン
(string 型の列挙)
ペーンに対するアクセスレベルを表す値。値は次の
とおりです。
• Read
• Edit
• All
name
string
必須。共有ルールの名前。ユーザインターフェース
の [表示ラベル] に対応します。
CaseCriteriaBasedSharingRule
ケースの条件に基づく共有ルールを表します。CriteriaBasedSharingRule メタデータ型を拡張し、その
criteriaItems 項目を継承します。
CaseCriteriaBasedSharingRule は、CaseSharingRules の criteriaBasedRules 項目によって使用されます。
項目
データ型
説明
booleanFilter
string
共有ルールの検索条件ロジックを表します。
description
string
共有ルールの説明を表します。最大 1000 文字です。
この項目は、API バージョン 29.0 以降で使用できま
す。
caseAccessLevel
ShareAccessLevelReadEdit 必須。許可されるケースに対するアクセスレベルを
(string 型の列挙)
表す値。値は次のとおりです。
• Read
• Edit
name
string
必須。共有ルールの名前。ユーザインターフェース
の [表示ラベル] に対応します。
573
メタデータ型
CriteriaBasedSharingRule
ContactCriteriaBasedSharingRule
取引先責任者の条件に基づく共有ルールを表します。CriteriaBasedSharingRule メタデータ型を拡張し、その
criteriaItems 項目を継承します。
ContactCriteriaBasedSharingRule は、ContactSharingRules の criteriaBasedRules 項目によって使用されます。
項目
データ型
説明
booleanFilter
string
共有ルールの検索条件ロジックを表します。
description
string
共有ルールの説明を表します。最大 1000 文字です。
この項目は、API バージョン 29.0 以降で使用できま
す。
contactAccessLevel
ShareAccessLevelReadEdit 必須。ターゲットグループ、ロール、またはユーザ
(string 型の列挙)
に許可される取引先責任者に対するアクセスレベル
を表す値。値は次のとおりです。
• Read
• Edit
name
string
必須。共有ルールの名前。ユーザインターフェース
の [表示ラベル] に対応します。
LeadCriteriaBasedSharingRule
リードの条件に基づく共有ルールを表します。CriteriaBasedSharingRule メタデータ型を拡張し、その
criteriaItems 項目を継承します。
LeadCriteriaBasedSharingRule は、LeadSharingRules の criteriaBasedRules 項目によって使用されます。
項目
データ型
説明
booleanFilter
string
共有ルールの検索条件ロジックを表します。
description
string
共有ルールの説明を表します。最大 1000 文字です。
この項目は、API バージョン 29.0 以降で使用できま
す。
leadAccessLevel
ShareAccessLevelReadEdit 必須。許可されるアクセスのレベルを表す値。状況
(string 型の列挙)
には次のものがあります。
• Read
• Edit
name
string
必須。共有ルールの名前。ユーザインターフェース
の [表示ラベル] に対応します。
574
メタデータ型
CriteriaBasedSharingRule
OpportunityCriteriaBasedSharingRule
商談の条件に基づく共有ルールを表します。CriteriaBasedSharingRuleメタデータ型を拡張し、その criteriaItems
項目を継承します。
OpportunityCriteriaBasedSharingRule は、OpportunitySharingRules の criteriaBasedRules 項目によって使用されま
す。
項目
データ型
説明
booleanFilter
string
共有ルールの検索条件ロジックを表します。
description
string
共有ルールの説明を表します。最大 1000 文字です。
この項目は、API バージョン 29.0 以降で使用できま
す。
opportunityAccessLevel ShareAccessLevelReadEdit 必須。許可されるアクセスのレベルを表す値。状況
(string 型の列挙)
には次のものがあります。
• Read
• Edit
name
string
必須。共有ルールの名前。ユーザインターフェース
の [表示ラベル] に対応します。
CustomObjectCriteriaBasedSharingRule
カスタムオブジェクトの条件に基づく共有ルールを表します。CriteriaBasedSharingRule メタデータ型を拡張し、
その criteriaItems 項目を継承します。
CustomObjectCriteriaBasedSharingRule は、CustomObjectSharingRules の criteriaBasedRules 項目によって使用され
ます。
項目
データ型
説明
accessLevel
string
必須。許可された共有の種別を表す値。値は次のと
おりです。
• Read
• Edit
• All
booleanFilter
string
共有ルールの検索条件ロジックを表します。
description
string
共有ルールの説明を表します。最大 1000 文字です。
この項目は、API バージョン 29.0 以降で使用できま
す。
575
メタデータ型
CriteriaBasedSharingRule
項目
データ型
説明
name
string
必須。共有ルールの名前。ユーザインターフェース
の [表示ラベル] に対応します。
UserCriteriaBasedSharingRule
ユーザの条件に基づく共有ルールを表します。CriteriaBasedSharingRule メタデータ型を拡張し、その
criteriaItems 項目を継承します。
UserCriteriaBasedSharingRule は、UserSharingRules の criteriaBasedRules 項目によって使用されます。
項目
データ型
説明
booleanFilter
string
共有ルールの検索条件ロジックを表します。
description
string
共有ルールの説明を表します。最大 1000 文字です。
この項目は、API バージョン 29.0 以降で使用できま
す。
name
string
必須。共有ルールの名前。ユーザインターフェース
の [表示ラベル] に対応します。
userAccessLevel
ShareAccessLevelReadEdit 必須。許可された共有の種別を表す値。値は次のと
(string 型の列挙)
おりです。
• 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>
576
メタデータ型
OwnerSharingRule
<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>
OwnerSharingRule
所有権ベースの共有ルールを表します。OwnerSharingRule を使用すると、対象のユーザグループのアクセスレベ
ルを指定するルールを使用して、あるユーザのセットが所有するレコードを他のユーザのセットと共有するこ
とができます。BaseSharingRule メタデータ型を拡張し、その SharedTo 項目を継承します。詳細は、Salesforce オン
ラインヘルプの「共有ルールの概要」を参照してください。
メモ: OwnerSharingRule コンポーネントを直接作成することはできません。代わりに子コンポーネントを使
用してください。
宣言的なメタデータファイルのサフィックスおよびディレクトリの場所
OwnerSharingRules コンポーネントは ownerRules 項目の SharingRules コンポーネント内に保存されます。
577
メタデータ型
OwnerSharingRule
バージョン
OwnerSharingRules コンポーネントは、API バージョン 24.0 以降で使用できます。
項目
次の情報は、標準オブジェクトとカスタムオブジェクトの共有ルールの実装を理解していることを前提として
います。これらの項目についての詳細は、Salesforceオンラインヘルプの「共有設定の概要」を参照してくださ
い。
項目
データ型
説明
sharedFrom
SharedTo
必須。レコードの所有者を指定しま
す。
sharedTo
SharedTo
必須。レコードを共有するユーザを指
定します。
fullName
string
API アクセスの一意の識別子。
fullName には、アンダースコアと英
数字のみを使用できます。一意である
こと、最初は文字であること、空白は
使用しない、最後にアンダースコアを
使用しない、2 つ続けてアンダースコ
アを使用しないという制約がありま
す。この項目は、Metadata コンポーネ
ントから継承されています。
AccountOwnerSharingRule
所有者以外のユーザと取引先を共有するためのルールを表します。これは、OwnerSharingRuleメタデータ型を拡
張し、その fullName 項目、sharedFrom 項目、および sharedTo 項目を継承します。
AccountOwnerSharingRule は AccountSharingRules の ownerRules 項目で使用されます。
項目
データ型
説明
accountAccessLevel
ShareAccessLevelNoNone 必須。グループまたはロールが取引先に対して持つ
(string 型の列挙)
アクセス権のレベルを表す値。値は次のとおりで
す。
• Read
• Edit
• All
578
メタデータ型
OwnerSharingRule
項目
データ型
説明
caseAccessLevel
ShareAccessLevelNoAll 必須。グループまたはロールが取引先に関連付けら
(string 型の列挙)
れたケースに対して持つアクセス権のレベルを表す
値。値は次のとおりです。
• None
• Read
• Edit
contactAccessLevel
ShareAccessLevelNoAll 必須。グループまたはロールが取引先に関連付けら
(string 型の列挙)
れた取引先責任者に対して持つアクセス権のレベル
を表す値。値は次のとおりです。
• None
• Read
• Edit
description
string
共有ルールの説明を表します。最大 1000 文字です。
この項目は、API バージョン 29.0 以降で使用できま
す。
name
string
必須。共有ルールの名前。ユーザインターフェース
の [表示ラベル] に対応します。
opportunityAccessLevel ShareAccessLevelNoAll 必須。関連付けられた任意の商談に対してグループ
(string 型の列挙)
またはロールに許可されているアクセス権のレベル
を表す値。値は次のとおりです。
• None
• Read
• Edit
CampaignOwnerSharingRule
所有者以外のユーザとキャンペーンを共有するためのルールを表します。これは、OwnerSharingRuleメタデータ
型を拡張し、その fullName 項目、sharedFrom 項目、および sharedTo 項目を継承します。
CampaignOwnerSharingRule は CampaignSharingRules の ownerRules 項目で使用されます。
項目
データ型
説明
campaignAccessLevel
ShareAccessLevelNoNone キャンペーンに対してグループまたはロールに許可
(string 型の列挙)
されているアクセス権のレベルを表す値。値は次の
とおりです。
• Read
• Edit
579
メタデータ型
項目
OwnerSharingRule
データ型
説明
• All
description
string
共有ルールの説明を表します。最大 1000 文字です。
この項目は、API バージョン 29.0 以降で使用できま
す。
name
共有ルールの名前。ユーザインターフェースの [表
示ラベル] に対応します。
string
CaseOwnerSharingRule
所有者以外のユーザとケースを共有するためのルールを表します。これは、OwnerSharingRuleメタデータ型を拡
張し、その fullName 項目、sharedFrom 項目、および sharedTo 項目を継承します。
CaseOwnerSharingRule は CaseSharingRules の ownerRules 項目によって使用されます。次の項目はすべて必須項目
です。
項目
データ型
説明
caseAccessLevel
ShareAccessLevelReadEdit 必須。ケースに対してグループまたはロールに許可
(string 型の列挙)
されているアクセス権のレベルを表す値。値は次の
とおりです。
• Read
• Edit
description
string
共有ルールの説明を表します。最大 1000 文字です。
この項目は、API バージョン 29.0 以降で使用できま
す。
name
必須。共有ルールの名前。ユーザインターフェース
の [表示ラベル] に対応します。
string
ContactOwnerSharingRule
所有者以外のユーザと取引先責任者を共有するためのルールを表します。これは、OwnerSharingRuleメタデータ
型を拡張し、その fullName 項目、sharedFrom 項目、および sharedTo 項目を継承します。
ContactOwnerSharingRule は ContactSharingRules の ownerRules 項目で使用されます。
580
メタデータ型
OwnerSharingRule
項目
データ型
説明
contactAccessLevel
ShareAccessLevelReadEdit 必須。取引先責任者に対してグループまたはロール
(string 型の列挙)
に許可されているアクセス権のレベルを表す値。値
は次のとおりです。
• Read
• Edit
description
string
共有ルールの説明を表します。最大 1000 文字です。
この項目は、API バージョン 29.0 以降で使用できま
す。
name
必須。共有ルールの名前。ユーザインターフェース
の [表示ラベル] に対応します。
string
LeadOwnerSharingRule
所有者以外のユーザとリードを共有するためのルールを表します。これは、OwnerSharingRuleメタデータ型を拡
張し、その fullName 項目、sharedFrom 項目、および sharedTo 項目を継承します。
LeadOwnerSharingRule は LeadSharingRules の ownerRules 項目で使用されます。
項目
データ型
説明
leadAccessLevel
ShareAccessLevelReadEdit 必須。リードに対してグループまたはロールに許可
(string 型の列挙)
されているアクセス権のレベルを表す値。値は次の
とおりです。
• Read
• Edit
description
string
共有ルールの説明を表します。最大 1000 文字です。
この項目は、API バージョン 29.0 以降で使用できま
す。
name
string
必須。必須。共有ルールの名前。ユーザインター
フェースの [表示ラベル] に対応します。
OpportunityOwnerSharingRule
所有者以外のユーザと商談を共有するためのルールを表します。これは、OwnerSharingRuleメタデータ型を拡張
し、その fullName 項目、sharedFrom 項目、および sharedTo 項目を継承します。
OpportunityOwnerSharingRule は OpportunitySharingRules の ownerRules 項目で使用されます。
581
メタデータ型
OwnerSharingRule
項目
データ型
説明
name
string
必須。共有ルールの名前。ユーザインターフェース
の [表示ラベル] に対応します。
description
string
共有ルールの説明を表します。最大 1000 文字です。
この項目は、API バージョン 29.0 以降で使用できま
す。
opportunityAccessLevel ShareAccessLevelReadEdit 必須。+商談に対してグループまたはロールに許可
(string 型の列挙)
されているアクセス権のレベルを表す値。値は次の
とおりです。
• Read
• Edit
AccountTerritorySharingRule
テリトリー内の取引先を共有するためのルールを表します。これは、OwnerSharingRuleメタデータ型を拡張し、
その fullName 項目、sharedFrom 項目、および sharedTo 項目を継承します。
AccountTerritorySharingRule は AccountTerritorySharingRules の ownerRules 項目で使用されます。
項目
データ型
説明
accountAccessLevel
ShareAccessLevelNoNone 必須。取引先テリトリーに対して Territory または
(string 型の列挙)
TerritoryAndSubordinates グループに許可されているア
クセス権のレベルを表す値。値は次のとおりです。
• Read
• Edit
• All
caseAccessLevel
ShareAccessLevelNoAll 必須。取引先のすべての子ケースに対して Territory
(string 型の列挙)
または TerritoryAndSubordinates グループに許可されて
いるアクセス権のレベルを表す値。値は次のとおり
です。
• None
• Read
• Edit
contactAccessLevel
ShareAccessLevelNoAll 必須。取引先のすべての関連取引先責任者に対して
(string 型の列挙)
Territory または TerritoryAndSubordinates グループに許可
されているアクセス権のレベルを表す値。値は次の
とおりです。
• None
582
メタデータ型
項目
OwnerSharingRule
データ型
説明
• Read
• Edit
description
共有ルールの説明を表します。最大 1000 文字です。
string
この項目は、API バージョン 29.0 以降で使用できま
す。
name
string
必須。共有ルールの名前。ユーザインターフェース
の [表示ラベル] に対応します。
opportunityAccessLevel ShareAccessLevelNoAll 必須。取引先に関連付けられたすべての商談に対し
(string 型の列挙)
て Territory または TerritoryAndSubordinates グループに
許可されているアクセス権のレベルを表す値。値は
次のとおりです。
• None
• Read
• Edit
CustomObjectOwnerSharingRule
カスタムオブジェクトの共有ルールを表します。これは、OwnerSharingRule メタデータ型を拡張し、その
fullName 項目、sharedFrom 項目、および sharedTo 項目を継承します。
CustomObjectOwnerSharingRule は CustomObjectSharingRules の ownerRules 項目で使用されます。
項目
データ型
説明
accessLevel
string
必須。カスタムオブジェクトに対してグループまた
はロールに許可されているアクセス権のレベルを表
す値。値は次のとおりです。
• Read
• Edit
• All
description
string
共有ルールの説明を表します。最大 1000 文字です。
この項目は、API バージョン 29.0 以降で使用できま
す。
name
string
必須。共有ルールの名前。ユーザインターフェース
の [表示ラベル] に対応します。
583
メタデータ型
SharingSet
UserMembershipSharingRule
グループのメンバーを別のグループのユーザと共有するための共有ルールを表します。これは、OwnerSharingRule
メタデータ型を拡張し、その fullName 項目、sharedFrom 項目、および sharedTo 項目を継承します。
UserMembershipSharingRule は、UserSharingRules (ページ 568) の ownerRules 項目によって使用されます。
項目
データ型
説明
description
string
共有ルールの説明を表します。最大 1000 文字です。
この項目は、API バージョン 29.0 以降で使用できま
す。
必須。共有ルールの名前。ユーザインターフェース
の [表示ラベル] に対応します。
name
string
userAccessLevel
ShareAccessLevelReadEdit 必須。ユーザに対してグループまたはロールに許可
(string 型の列挙)
されているアクセス権のレベルを表す値。値は次の
とおりです。
• Read
• Edit
SharingSet
共有セットを表します。共有セットでは、アクセス権の対応付けを定義して、ポータルユーザまたはコミュニ
ティユーザに、取引先または取引先責任者に関連付けられたオブジェクトへのアクセス権を付与します。
Metadata メタデータ型を拡張し、その fullName 項目を継承します。
たとえば、ポータルユーザまたはコミュニティユーザに、その取引先レコードに関連するすべてのケースへの
アクセス権を付与できます。同様に、ポータルユーザまたはコミュニティユーザに、そのユーザの取引先レ
コードで識別される親取引先に関連するすべてのケースへのアクセス権をユーザに付与できます。詳細は、
Salesforce ヘルプの「共有セットの概要」を参照してください。
ファイルのサフィックスおよびディレクトリの場所
SharingSet コンポーネントのサフィックスは .sharingSet であり、sharingSets フォルダに保存されます。
バージョン
SharingSet コンポーネントは、API バージョン 30.0 以降で使用できます。
584
メタデータ型
SharingSet
項目
項目名
データ型
説明
accessMappings
AccessMapping[]
共有セットのアクセス権の対応付けのリスト。
description
string
共有セットの説明。最大 255 文字です。
name
string
必須。API アクセスの一意の識別子。ユーザインターフェー
スの [共有セット名] に対応します。
profiles
string[]
対象オブジェクトへのアクセス権を付与されたユーザのプ
ロファイル。有効な値は、次のとおりです。
• 認証 Web サイト
• カスタマーコミュニティユーザ
• カスタマーコミュニティログインユーザ
• 大規模カスタマーポータルユーザ
• Overage Authenticated Website ユーザ
• Overage High Volume Customer Portal ユーザ
AccessMapping
AccessMappingは、共有セットのアクセス権の対応付けを表します。これにより、ユーザに関連付けられた取引
先または取引先責任者をルックアップして、対象オブジェクトへのアクセス権が付与されます。
対象オブジェクト、または対象オブジェクトとそれに関連付けられたオブジェクトの両方 (取引先とその取引
先責任者およびケースなど) へのアクセス権をポータルユーザに付与できれます。
項目名
データ型
説明
accessLevel
string
ポータルユーザに付与された対象オブジェクトへのアクセスレ
ベル。有効な値は、次のとおりです。
• Read
• Edit
objectField
string
対象オブジェクトへのルックアップ。標準項目、カスタム項
目、または ID がサポートされます。エンタイトルメントに関連
付けられた取引先またはケースの場合は、
Entitlement.Account または Entitlement.Case を使用し
ます。
object
string
ポータルユーザがアクセス権を得る対象オブジェクト。次のい
ずれかを示します。
• Account
• Contact
585
メタデータ型
項目名
SharingSet
データ型
説明
• Case
• ServiceContract
• User
• カスタムオブジェクト (たとえば ObjA__c)
ポータルユーザには、アクセス権のある取引先のすべての注文
エンタイトルメントおよび注文品目へのアクセス権が付与され
ます。
userField
string
取引先または取引先責任者、あるいは、取引先や取引先責任者
から取得された標準項目またはカスタム項目へのユーザのルッ
クアップ。ルックアップでは、ユーザまたはユーザのマネー
ジャを使用できます。有効な値は、次のとおりです。
• 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">
586
メタデータ型
SharingSet
<name>Case</name>
<accessMappings>
<accessLevel>Edit</accessLevel>
<objectField>Entitlement.Account</objectField>
<object>Case</object>
<userField>Account</userField>
</accessMappings>
</SharingSet>
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.xml の例を次に示します。
<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>
587
メタデータ型
SiteDotCom
<types>
<members>Basic</members>
<name>SharingSet</name>
<types>
<version>30.0</version>
</Package>
SiteDotCom
リリース用のサイトを表します。MetadataWithContent 型を拡張し、その fullName 項目と content 項目を継
承します。
宣言的なメタデータファイルのサフィックスおよびディレクトリの
場所
SiteDotCom コンポーネントは、対応するパッケージディレクトリの siteDotComSites ディレクトリに保存さ
れます。メタデータ .xml ファイルのファイル名は、[sitename].site-meta.xml です。サイトファイルの
ファイル名は、[sitename].site です。
メモ: メタデータ API を使用してサイトを Sandbox から本番にリリースするときのファイルサイズには制限
があります。.site ファイルのアセットは、40 MB を超えることはできません。サイトは作成されます
が、アセットは新しいサイトで壊れて表示されます。アセットを修正するには、Sandbox 環境からアセッ
トを個別にエクスポートして、その後に新しいサイトにインポートします。
バージョン
SiteDotCom コンポーネントは、API バージョン 30.0 以降で使用できます。
項目
項目
データ型
説明
label
string
リリースするサイトの名前。
siteType
(string 型の列挙)
必須。サイトが Salesforce Communities サイト
の ChatterNetworkPicasso サイトであ
るか、Site.com サイトの Siteforce サイト
であるかを示します。
588
メタデータ型
Skill
宣言的なメタデータの定義のサンプル
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 ファイルに保存されます。
バージョン
Skill は、API バージョン 28.0 以降で使用できます。
項目
項目名
データ型
説明
assignments
SkillAssignments
Live Agent ユーザへのスキルの割り当て方法を指
定します。スキルは、ユーザセットまたはプロ
ファイルセットに割り当てることができます。
label
string
スキルの名前を指定します。
SkillAssignments
特定のスキルを割り当てるユーザおよびユーザプロファイルを表します。
589
メタデータ型
Skill
項目
項目名
データ型
説明
profiles
SkillProfileAssignments
特定のスキルに関連付けられたプロファイルを
指定します。
users
SkillUserAssignments
特定のスキルに関連付けられたユーザを指定し
ます。
SkillProfileAssignments
特定のスキルに関連付けられたプロファイルを表します。
項目
項目名
データ型
説明
profile
string
特定のスキルに関連付けられたプロファイルの
カスタム名を指定します。
SkillUserAssignments
特定のスキルに関連付けられたユーザを表します。
項目
項目名
データ型
説明
user
string
特定のスキルに関連付けられたユーザのユーザ
名を指定します。
宣言的なメタデータの定義のサンプル
これは、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>
590
メタデータ型
StaticResource
<user>[email protected]</user>
</users>
</assignments>
</Skill>
StaticResource
静的リソースファイルを表します。多くの場合は、ZIP ファイル内のコードライブラリです。このメタデータ
型は、MetadataWithContent コンポーネントを拡張し、その項目を共有します。
静的リソースにより、アーカイブ (.zip や .jar ファイルなど)、画像、スタイルシート、JavaScript、その他のファ
イルなど、Visualforce ページ内で参照できるコンテンツをアップロードできます。
ファイルのサフィックスおよびディレクトリの場所
テンプレートファイルのファイルサフィックスは .resource です。付随するメタデータファイルには、
resource-meta.xml という名前が付けられます。
静的リソースコンポーネントは、対応するパッケージディレクトリの staticresources フォルダに保存さ
れます。
バージョン
静的リソースは、API バージョン 12.0 以降で使用できます。
項目
このメタデータ型には、次の項目が含まれます。
項目名
データ型
cacheControl StaticResourceCacheControl
(string 型の列挙)
説明
必須。サードパーティ配信クライアントがコンテンツをキャッ
シュできるように、静的リソースが公開キャッシュタグでマー
クされているかどうかを示します。これは、API バージョン 14.0
の新項目です。有効な値は、次のとおりです。
• Private
• Public
content
base64Binary
静的リソースコンテンツ。Base 64 で符号化されたバイナリデー
タ API コールを行う前に、クライアントアプリケーションはバイ
ナリ添付データを base64 に符号化する必要があります。応答を
受信したら、クライアントアプリケーションは、base64 データを
バイナリに復号化する必要があります。この変換は、通常 SOAP
クライアントによって処理されます。この項目は、
MetadataWithContent コンポーネントから継承されます。
591
メタデータ型
SynonymDictionary
項目名
データ型
説明
contentType
string
必須。ファイルのコンテンツタイプ。たとえば、text/plain などで
す。
description
string
静的リソースの説明。
fullName
string
静的リソース名。名前には、英数字、およびアンダースコア (_)
文字のみを使用できます。また、最初は文字とし、最後にアン
ダースコアを使用したり、連続した 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>
SynonymDictionary
シノニムグループ (ユーザの検索で同義とされる語または句の集合) のセットを表します。シノニムグループを
定義して、頭字語、商品名のバリエーション、および組織に固有のその他の用語の検索結果を最適化できま
す。シノニムは、Salesforce ナレッジなどの Service Cloud 機能で使用できます。Metadata メタデータ型を拡張し、
その fullName 項目を継承します。
ファイルのサフィックスおよびディレクトリの場所
SynonymDictionary コンポーネントのサフィックスは .synonymDictionary であり、synonymDictionaries
フォルダに保存されます。
バージョン
SynonymDictionary コンポーネントは、API バージョン 29.0 以降で使用できます。
592
メタデータ型
SynonymDictionary
特別なアクセスルール
シノニムが組織で有効になっている必要があります。「シノニムの管理」権限を持つユーザのみがこのオブ
ジェクトにアクセスできます。
項目
項目名
データ型
説明
groups
SynonymGroup
この辞書で定義されているシノニムグループです。
isProtected
boolean
このコンポーネントが保護されるか (true)、否か (false)
を示します。保護コンポーネントは、インストールする組
織で作成されたコンポーネントによってリンク設定したり
参照したりすることはできません。
label
string
必須。シノニム辞書の表示名を指定します。
SynonymGroup
同義の単語または語句のグループを表します。
項目名
データ型
説明
languages
Language
必須。シノニムグループを適用する言語を指定します。シノニ
ムが 1 つの言語に固有である場合は、その言語のみを指定しま
す。シノニムを複数の言語に適用する場合は、1 つのシノニム
グループに複数の言語を指定します。
terms
string
必須。グループの他の用語と同義の単語または語句です。最大
50 文字です。グループごとに terms は最小 2 語です。
シノニムグループには対称性があります。つまり、oranges と
apples がシノニムグループで定義されている場合、oranges を
検索すると、apples との一致が返され、apples を検索する
とその逆が返されます。
宣言的なメタデータの定義のサンプル
次に、SynonymDictionary コンポーネントの例を示します。
<?xml version="1.0" encoding="UTF-8"?>
<SynonymDictionary xmlns="http://soap.sforce.com/2006/04/metadata">
<groups>
<languages>en_US</languages>
<terms>Salesforce</terms>
<terms>salesforce.com</terms>
593
メタデータ型
Territory
<terms>The Customer Company</terms>
<terms>SFDC</terms>
</groups>
<groups>
<languages>fr</languages>
<terms>renault</terms>
<terms>clio</terms>
</groups>
<label>Sample Dictionary</label>
</SynonymDictionary>
SynonymDictionary コンポーネントを参照する package.xml の例を次に示します。
<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<types>
<members>Sample Dictionary</members>
<name>SynonymDictionary</name>
</types>
<version>32.0</version>
</Package>
使用方法
API バージョン 29.0 より前に定義された既存のシノニムグループがある場合、既存のグループは _Default と
いうデフォルトの辞書に関連付けられます。
頻繁な更新を必要とするシノニムのセットがある場合、シノニムグループまたはグループを少数のグループを
持つ専用の辞書に割り当てることをお勧めします。既存の辞書をリリースするたびに、すべてのシノニムグ
ループが上書きされます。辞書内の単一のシノニムグループのみの更新のリリースはサポートしていません。
Territory
組織内のテリトリーを表します。
宣言的なメタデータファイルのサフィックスおよびディレクトリの
場所
テリトリーコンポーネントのファイルサフィックスは .territory で、コンポーネントは対応するパッケー
ジディレクトリの territories ディレクトリに保存されます。
バージョン
テリトリーコンポーネントは、API バージョン 24.0 以降で使用できます。
594
メタデータ型
Territory
項目
このメタデータ型は、下位型 RoleOrTerritory に拡張されます。
項目名
データ型
説明
accountAccessLevel
string
このテリトリーのユーザが、このテリトリーに割り当てら
れている (通常ならアクセスできない) 取引先にアクセスで
きるかどうかを指定します。有効な値は、次のとおりで
す。
• Read
• Edit
• All
組織の取引先に対する共有モデルが「公開/参照・更新可
能」の場合、有効な値は Edit および All のみです。
この項目に値が設定されていない場合、この項目値には
[テリトリーの管理] ページ ([設定] から[テリトリーの管理] >
[設定]) で指定されたデフォルトのアクセスレベルが使用さ
れます。
この項目は API バージョン 31.0 以降で使用できます。
fullName
string
APIアクセスの一意の識別子。fullName には、アンダース
コアと英数字のみを使用できます。一意であること、最初
は文字であること、空白は使用しない、最後にアンダース
コアを使用しない、2 つ続けてアンダースコアを使用しな
いという制約があります。この項目は、Metadata コンポー
ネントから継承されています。ユーザインターフェースの
[テリトリー名] に対応します。
parentTerritory
string
テリトリー階層でこのテリトリーの上位にあるテリトリー。
宣言的なメタデータの定義のサンプル
テリトリーの定義を次に示します。
<?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>
595
メタデータ型
Territory2
<mayForecastManagerShare>false</mayForecastManagerShare>
<name>T22name</name>
<opportunityAccessLevel>Read</opportunityAccessLevel>
</Territory>
Territory2
Territory Management 2.0 で営業テリトリーに関連付けられているメタデータを表します。Metadata メタデータ型
を拡張し、その fullName 項目を継承します。組織で Territory Management 2.0 が有効化されている場合にのみ使
用できます。
ファイルのサフィックスおよびディレクトリの場所
Territory2 コンポーネントのサフィックスは territory2 で、対応する Territory2Model のフォルダの下位にある
territories フォルダに保存されます。
バージョン
Territory2 コンポーネントは、API バージョン 32.0 以降で使用できます。
特別なアクセスルール
Territory2Model オブジェクトは、SOAP API に State 項目があります。状態は計画中、有効、アーカイブ済みのほ
か、コピー中などプロセスが進行中であることを示すものも多数あります。「テリトリーの管理」権限のない
ユーザは、有効状態のモデルに属するテリトリーにのみアクセスできます。すべてのテリトリー管理エンティ
ティに対する deploy() コールには、メタデータ API で必要な「すべてのデータの編集」権限のほかに「テリ
トリーの管理」権限が必要です。「テリトリーの管理」権限のないユーザが retrieve() を実行すると、有
効状態の Territory2Model に属するエンティティのみが返されます。「テリトリーの管理」権限なしにコールを
実行してもデータの一部しか取得されないためお勧めしません。
項目
項目名
データ型
説明
accountAccessLevel
string
このテリトリーのユーザが、このテリトリーに割り当て
られている (通常ならアクセスできない) 取引先にアクセ
スできるかどうかを指定します。有効な値は、次のとお
りです。
• Read
596
メタデータ型
項目名
Territory2
データ型
説明
• Edit
• All
組織の取引先の共有モデルが「公開/参照・更新可能」の
場合、有効な値は Edit および All のみです。この項目
に値が設定されていない場合は、組織の共有設定で認め
られている、Territory2Settings で指定されたデフォルトの
アクセスレベルが使用されます。
caseAccessLevel
string
このテリトリーのユーザが、このテリトリーに割り当て
られている (通常ならアクセスできない) ケースにアクセ
スできるかどうかを指定します。有効な値は、次のとお
りです。
• None
• Read
• Edit
組織のケース/商談に対する共有モデルが「公開/参照・
更新可能」の場合は、値を指定しません。この項目に値
が設定されていない場合は、組織の共有設定で許可され
ている、Territory2Settings で指定されたデフォルトのアク
セスレベルが使用されます。
contactAccessLevel
string
このテリトリーのユーザが、このテリトリーに割り当て
られている (通常ならアクセスできない) 取引先責任者に
アクセスできるかどうかを指定します。有効な値は、次
のとおりです。
• None
• Read
• Edit
取引先責任者に対する組織の共有モデルが「公開/参照・
更新可能」または「親レコードに連動」の場合は値を指
定しません。
customFields
FieldValue
Territory2 オブジェクトで定義され、このテリトリーで使
用されるカスタム項目の値。このメタデータは、
CustomObject (ページ 202) で個別に取得されます。次の点
に注意してください。
• Territory2 オブジェクトおよび Territory2Model オブジェク
トは、ロングテキストエリア項目、リッチテキストエ
リア項目、およびテキストで暗号化されたカスタム項
目の値を処理しません。
• 項目は、その API 名を使用して参照されます。地理位
置情報のような複合項目種別は、いくつかの要素で構
597
メタデータ型
Territory2
項目名
データ型
説明
成される列項目として表示されます。たとえば、
nnn_Latitude__s、nnn_Longitude__s などで構成
され、「nnn」は項目名、サフィックスは地理位置情
報コンポーネントです。
• 必須カスタム項目の値は、deploy() 操作中に適用さ
れます。
description
string
テリトリーの説明です。
name
string
必須。テリトリーのユーザインターフェース表示ラベル。
opportunityAccessLevel
string
このテリトリーのユーザが、このテリトリーに割り当て
られている (通常ならアクセスできない) 商談にアクセス
できるかどうかを指定します。有効な値は、次のとおり
です。
• None
• Read
• Edit
組織のケース/商談に対する共有モデルが「公開/参照・
更新可能」の場合は、値を指定しません。この項目に値
が設定されていない場合は、組織の共有設定で許可され
ている、Territory2Settings で指定されたデフォルトのアク
セスレベルが使用されます。
parentTerritory
string
テリトリーの上位テリトリーの名前。上位テリトリーを
指定する場合は、開発者名を使用します。「完全修飾」
名は使用しないでください。値の型を <value
xsi:nil="true"/> に指定すると、値のないカスタム
項目が取得されます。また、<value xsi:nil="true"/>
構文を使用して、カスタム項目の既存の値を削除するこ
ともできます。
ruleAssociations
Territory2RuleAssociation オブジェクト割り当てルールおよびテリトリーへの関連
付けを表します。ルールの開発者名を使用します。
territory2Type
string
必須。テリトリーが属するテリトリー種別。
FieldValue
Territory2 オブジェクトのカスタム項目の値を表します。API バージョン 32.0 以降で使用できます。
項目名
データ型
説明
name
string
必須。テリトリーのユーザインターフェース表示ラベル。
598
メタデータ型
Territory2
項目名
データ型
説明
value
任意の種別
項目の値。null にすることもできます。項目種別は、XML で
指定し、項目値によって異なります。
Territory2RuleAssociation
オブジェクト割り当てルールのテリトリーへの関連付けを表します。API バージョン 32.0 以降で使用できます。
項目名
データ型
説明
inherited
boolean
必須。ルールが上位のテリトリーから継承されたルールか
(true)、現在のテリトリーのローカルルールか (false) を示し
ます。
ルールの継承は、テリトリーモデル階層内で、ルールが作成さ
れた上位テリトリーからルールの下位テリトリー (ある場合) に
受け継がれます。ローカルルールは、1 つのテリトリー内で作
成され、そのテリトリーにのみ影響します。
ruleName
string
必須。テリトリーに関連付けられたルールの名前。メタデータ
API はルールがテリトリーと同じモデルに属すると想定するた
め、ruleName は完全修飾名である必要はありません。
宣言的なメタデータの定義のサンプル
次の例は、Territory2 コンポーネントの定義を示しています。
<?xml version="1.0" encoding="UTF-8"?>
<Territory2 xmlns="http://soap.sforce.com/2006/04/metadata"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<name>USA</name>
<description>United States sales</description>
<accountAccessLevel>Edit</accountAccessLevel>
<opportunityAccessLevel>Read</opportunityAccessLevel>
<caseAccessLevel>Edit</caseAccessLevel>
<contactAccessLevel>Edit</contactAccessLevel>
<parentTerritory>Worldwide_Sales</parentTerritory>
<territory2Type>Geo</territory2Type>
<ruleAssociations>
<ruleName>AccRule1</name>
<inherited>True</inherited>
</ruleAssociations>
<ruleAssociations>
<ruleName>AccRule2</name>
<inherited>False</inherited>
</ruleAssociations>
<customFields>
599
メタデータ型
Territory2
<name>Activation_DateTime__c</name>
<value xsi:type="xsd:dateTime">2014-07-16T05:05:00.000Z</value>
</customFields>
<customFields>
<name>AutoNumber__c</name>
<value xsi:type="xsd:string">T# 000001</value>
</customFields>
<customFields>
<name>DeactivationDate__c</name>
<value xsi:type="xsd:date">2016-07-12</value>
</customFields>
<customFields>
<name>External_Id__c</name>
<value xsi:type="xsd:string">AB2345</value>
</customFields>
<customFields>
<name>ManagersPhone__c</name>
<value xsi:nil="true"/>
</customFields>
</Territory2>
package.xml のサンプルを次に示します。FY13 および FY14 は、テリトリーモデルの名前を表し、異なる
モデル内でルールに同一の開発名を指定できることを示しています。モデル名の代わりにワイルドカード記号
(*) を使用すると、組織内のすべてのモデルの全ルールが取得されます。
<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<types>
<members>FY13</members>
<members>FY14</members>
<name>Territory2Model</name>
</types>
<types>
<members>FY13.USA</members>
<members>FY13.Worldwide_Sales</members>
<members>FY14.APAC</members>
<members>FY14.USA</members>
<name>Territory2</name>
</types>
<version>32.0</version>
</Package>
使用方法
• deploy() 操作中は、Territory2 で定義されたトリガが起動されません。
• Territory Management 2.0 のコンポーネントは、パッケージ化や変更セットをサポートしておらず、CRUD コー
ルでサポートされていません。
600
メタデータ型
Territory2Model
Territory2Model
Territory Management 2.0 でテリトリーモデルに関連付けられているメタデータを表します。Metadata メタデータ
型を拡張し、その fullName 項目を継承します。組織で Territory Management 2.0 が有効化されている場合にのみ
使用できます。
ファイルのサフィックスおよびディレクトリの場所
Territory2Model コンポーネントのサフィックスは territory2Model で、territory2Models フォルダに保存
されます。
バージョン
Territory2Model コンポーネントは、API バージョン 32.0 以降で使用できます。
特別なアクセスルール
Territory2Model オブジェクトは、SOAP API に State 項目があります。状態は計画中、有効、アーカイブ済みのほ
か、コピー中などプロセスが進行中であることを示すものも多数あります。「テリトリーの管理」権限がない
ユーザは、有効状態のモデルのみにアクセスできます。すべてのテリトリー管理エンティティに対する deploy()
コールには、メタデータ API で必要な「すべてのデータの編集」権限のほかに「テリトリーの管理」権限が必
要です。「テリトリーの管理」権限のないユーザが retrieve() を実行すると、有効状態の Territory2Model に
属するエンティティのみが返されます。「テリトリーの管理」権限なしにコールを実行してもデータの一部し
か取得されないためお勧めしません。
項目
項目名
データ型
説明
customFields
FieldValue
Territory2Model オブジェクト上で定義された、このモデルに
よって使用されるカスタム項目です。そのメタデータは別
個に取得されます。
• Territory2 オブジェクトおよび Territory2Model オブジェク
トは、ロングテキストエリア項目、リッチテキストエ
リア項目、およびテキストで暗号化されたカスタム項
目の値を処理しません。
• 項目は、その API 名を使用して参照されます。地理位置
情報のような複合項目種別は、いくつかの要素で構成
される列項目として表示されます。たとえば、
nnn_Latitude__s、nnn_Longitude__s などで構成
され、「nnn」は項目名、サフィックスは地理位置情報
コンポーネントです。
601
メタデータ型
項目名
Territory2Model
データ型
説明
• 必須カスタム項目の値は、deploy() 操作中に適用さ
れます。
description
string
テリトリーモデルの説明です。
name
string
必須。テリトリーモデルのユーザインターフェース表示ラ
ベルです。
宣言的なメタデータの定義のサンプル
次の例は、Territory2Model コンポーネントの定義を示します。
<?xml version="1.0" encoding="UTF-8"?>
<Territory2Model xmlns="http://soap.sforce.com/2006/04/metadata"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<name>FY13</name>
<description>Geographic allocation</description>
<customFields>
<name>Activation_DateTime__c</name>
<value xsi:type="xsd:dateTime">2014-07-16T05:05:00.000Z</value>
</customFields>
<customFields>
<name>AutoNumber__c</name>
<value xsi:type="xsd:string">M# 000001</value>
</customFields>
<customFields>
<name>DeactivationDate__c</name>
<value xsi:type="xsd:date">2016-07-12</value>
</customFields>
<customFields>
<name>External_Id__c</name>
<value xsi:nil="true"/>
</customFields>
</Territory2Model>
使用方法
• retrieve() コールは、コピー中、コピー失敗、削除中、および削除失敗の 4 つの状態のモデルを返しませ
ん。
• モデルが作成されると、最初の状態は必ず計画中になります。deploy() 操作を実行できるのは、計画中ま
たは有効状態のモデルのみです。同じ要件が、これらのモデルに関連付けられたテリトリーとルールに適
用されます。たとえば、Sandbox 組織に計画中状態のモデルがあり、本番組織にアーカイブ済み状態の同じ
開発者名を持つモデルがあるとします。このモデルの状態がアーカイブ済みであり、この状態はモデルへの
変更を禁止するため、本番組織での deploy() 操作は失敗します。
602
メタデータ型
Territory2Rule
• 同一の開発者名を持つさまざまな組織にテリトリーモデルがあり、deploy() 操作を実行しようとしてい
る場合、メタデータ API は新しいモデルを作成しようとしますが、状態の制限により、この操作は開発者名
の競合が原因で失敗します。たとえば、Sandbox 組織に計画中状態のモデルがあり、本番組織にアーカイブ
済み状態の同じ開発者名を持つモデルがあるとします。このモデルの状態がアーカイブ済みであり、この状
態はモデルへの変更を禁止するため、本番組織での deploy() 操作は失敗します。
• テリトリーを持つモデルを削除する場合、delete() コールによってモデルの状態が削除中に変更され、
モデル内のすべてのテリトリー、ルール、およびユーザの関連付けがカスケード削除されます。モデル内
のテリトリーの数に応じて、削除にしばらく時間がかかることがあります。
• モデルが作成されると、最初の状態は必ず計画中になります。同じ開発者名を持つモデルがすでに存在す
る場合、すでに何らかの状態になっているため、Territory2 には State 項目を含めません。
• Territory Management 2.0 のコンポーネントは、パッケージ化や変更セットをサポートしておらず、CRUD コー
ルでサポートされていません。
Territory2Rule
Territory Management 2.0 で Account などのオブジェクトに関連付けられているテリトリー割り当てルールに関連付
けられているメタデータを表します。Metadata メタデータ型を拡張し、その fullName 項目を継承します。組
織で Territory Management 2.0 が有効化されている場合にのみ使用できます。
ファイルのサフィックスおよびディレクトリの場所
Territory2Rule コンポーネントのサフィックスは territory2Rule で、対応する Territory2Model のフォルダの下位
にある rules フォルダに保存されます。
バージョン
Territory2Rule コンポーネントは、API バージョン 32.0 以降で使用できます。
特別なアクセス
Territory2Model オブジェクトは、SOAP API に State 項目があります。状態は計画中、有効、アーカイブ済みのほ
か、コピー中などプロセスが進行中であることを示すものも多数あります。「テリトリーの管理」権限がない
ユーザは、有効状態のモデルに属するルールのみにアクセスできます。すべてのテリトリー管理エンティティ
に対する deploy() コールには、メタデータ API で必要な「すべてのデータの編集」権限のほかに「テリト
リーの管理」権限が必要です。「テリトリーの管理」権限のないユーザが retrieve() を実行すると、有効
状態の Territory2Model に属するエンティティのみが返されます。「テリトリーの管理」権限なしにコールを実
行してもデータの一部しか取得されないためお勧めしません。SOAP API とユーザインターフェースでは、ルー
ルを作成または編集するユーザに、ルール項目で参照される項目に対する項目レベルセキュリティのアクセス
権が必要です。メタデータ API deploy() 操作では、「すべてのデータの編集」および「テリトリーの管理」
権限が必要とされるため、この制限は緩和されます。「すべてのデータの編集」はメタデータ API 操作の基本
の権限要件です。
603
メタデータ型
Territory2Rule
項目
項目名
データ型
説明
active
boolean
必須。ルールが有効か (true)、無効か (false) を示しま
す。API を使用して、有効なルールは、オブジェクトレコー
ドの作成時および編集時に自動的に実行されます。オブ
ジェクトレコードの IsExcludedFromRealign 項目の値
が true の場合は例外で、レコード割り当てルールによっ
てそのレコードを評価することができません。
booleanFilter
string
高度な検索条件。たとえば、(1 AND 2) OR 3 です。番
号は 1 で始まり、連続している必要があります。
name
string
必須。ルールのユーザインターフェース表示ラベル。
objectType
string
必須。ルールの定義対象であるオブジェクト。API バージョ
ン 32.0 の場合、使用できるオブジェクトは取引先のみで
す。
ruleItems
Territory2RuleItem
(ページ 604)
ルールの選択基準を定義する項目 ([都道府県(請求先)]
equals [カリフォルニア] など)。
Territory2RuleItem
ルールへのルール項目の関連付けを表します。API バージョン 32.0 以降で使用できます。
項目名
データ型
説明
field
string
ルール項目の操作対象である標準またはカスタムオブジェクト
項目。
operation
FilterOperation (string ルール項目に適用する条件。たとえば、「次の文字列と一致す
型の列挙)
る」や「次の文字列で始まる」などです。
value
string
評価する項目値。たとえば、項目が [郵便番号(請求先)] の場
合、値は 94105 などです。
宣言的なメタデータの定義のサンプル
次の例は、Territory2RuleItem コンポーネントの定義を示します。
<?xml version="1.0" encoding="UTF-8"?>
<Territory2Rule xmlns="http://soap.sforce.com/2006/04/metadata">
<label>Northern CA</label>
<description>To capture northern CA based accounts</description>
<objectType>Account</objectType>
604
メタデータ型
Territory2Rule
<active>True</active>
<ruleItems>
<field>BillingZip</field>
<operation>contains</operation>
<value><94105,94404,94536/value>
</ruleItems>
<ruleItems>
<field>Industry</field>
<operation>equals</operation>
<value>IT</value>
</ruleItems>
<ruleItems>
<field>someCustomField__c</field>
<operation>greater_than</operation>
<value>50000</value>
</ruleItems>
<booleanFilter>(1 OR 2) AND 3</booleanFilter>
</Territory2Rule>
package.xml のサンプルを次に示します。FY13 および FY14 は、テリトリーモデルの名前を表し、異なる
モデル内でルールに同一の開発者名を指定できることを示しています。モデル名の代わりにワイルドカード記
号 (*) を使用すると、組織内のすべてのモデルの全ルールが取得されます。
<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<types>
<members>FY13</members>
<members>FY14</members>
<name>Territory2Model</name>
</types>
<types>
<members>FY13.AccRule1</members>
<members>FY14.AccRule1</members>
<name>Territory2Rule</name>
</types>
<version>32.0</version>
</Package>
使用方法
• テリトリールールには、最大 10 個のルール項目を設定できます。
• ルール項目の並び替え順は、XML のルール項目の位置から暗黙的に導出されます。
• ルールはメタデータ API 経由で実行できません。
• Territory Management 2.0 のコンポーネントは、パッケージ化や変更セットをサポートしておらず、CRUD コー
ルでサポートされていません。
605
メタデータ型
Territory2Type
Territory2Type
Territory Management 2.0 にあるテリトリーのカテゴリのメタデータを表します。すべての Territory2 に Territory2Type
が必要です。Metadata メタデータ型を拡張し、その fullName 項目を継承します。組織で Territory Management
2.0 が有効化されている場合にのみ使用できます。
ファイルのサフィックスおよびディレクトリの場所
Territory2Type コンポーネントのサフィックスは territory2Type で、territory2Types フォルダに保存され
ます。
バージョン
Territory2Type コンポーネントは、API バージョン 32.0 以降で使用できます。
特別なアクセスルール
「テリトリーの管理」権限のないユーザは、組織のすべての Territory2Type を取得できます。deploy() 操作に
は、メタデータ API で必要な「すべてのデータの編集」権限のほかに「テリトリーの管理」権限が必要です。
項目
項目名
データ型
説明
description
string
テリトリー種別の説明。
name
string
必須。テリトリー種別のユーザインターフェース表示
ラベル。
宣言的なメタデータの定義のサンプル
次の例は、Territory2Type コンポーネントの定義を示しています。
<?xml version="1.0" encoding="UTF-8"?>
<Territory2Type xmlns="http://soap.sforce.com/2006/04/metadata">
<name>Geo</name>
<description>Geographic allocation</description>
</Territory2Type>
使用方法
Territory Management 2.0 のコンポーネントは、パッケージ化や変更セットをサポートしておらず、CRUD コールで
サポートされていません。
606
メタデータ型
Translations
Translations
このメタデータ型を使用して、さまざまな使用言語の翻訳を処理できます。Metadata メタデータ型を拡張し、
その fullName 項目を継承します。コンポーネントの表示ラベルを翻訳する機能は、トランスレーションワー
クベンチの一部です。詳細は、Salesforceオンラインヘルプの「トランスレーションワークベンチの設定」を参
照してください。
言語
Salesforce.com では、完全サポート対象言語、エンドユーザ言語、プラットフォーム専用言語の 3 つのレベルの
言語サポートが提供されています。すべての言語は、2 文字の言語コード (en など) または 5 文字のロケール
コード (en_AU など) で識別されます。
Salesforce では、次の言語を完全にサポートしています。
• 中国語 (簡体字): zh_CN
• 中国語 (繁体字): zh_TW
• デンマーク語: da
• オランダ語: nl_NL
• 英語: en_US
• フィンランド語: fi
• フランス語: fr
• ドイツ語: de
• イタリア語: it
• 日本語: ja
• 韓国語: ko
• ノルウェー語: no
• ポルトガル語 (ブラジル): pt_BR
• ロシア語: ru
• スペイン語: es
• スペイン語 (メキシコ): es_MX
• スウェーデン語: sv
• タイ語: th
Salesforceは、次のエンドユーザ言語をサポートしていますが、管理ページとオンラインヘルプは翻訳されてい
ません。
• アラビア語: ar
• ブルガリア語: bg
• チェコ語: cs
• 英語 (UK): en_GB
• ギリシャ語: el
607
メタデータ型
Translations
• ヘブライ語: iw
• ハンガリー語: hu
• インドネシア語: in
• ポーランド語: pl
• ポルトガル語 (ポルトガル): pt_PT
• ルーマニア語: ro
• スロバキア語: sk
• トルコ語: tr
• ウクライナ語: uk
• ベトナム語: vi
プラットフォーム専用言語は、Salesforceプラットフォーム上で作成したカスタム機能（アプリケーション）を
ローカライズする場合に使用します。プラットフォームのみの言語を使用すると、Salesforceがデフォルトの翻
訳を提供していない場合に、カスタム表示ラベル、カスタムオブジェクト、および項目の表示ラベルをローカ
ライズできます。
プラットフォームのみの言語は、アプリケーションで言語を選択できる場所のすべてで使用できますが、プ
ラットフォームのみの言語を選択しても、アプリケーションのすべての表示ラベルはデフォルトの英語のまま
になります。Salesforceに対するすべてのカスタマイズは、プラットフォームのみの言語に翻訳できます。多く
のオブジェクト上にある標準項目名を翻訳する場合は名前の変更を使用します。情報テキストと項目以外の表
示ラベルのテキストは翻訳できません。
• アルバニア語: 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
608
メタデータ型
Translations
• ラトビア語: lv
• リトアニア語: lt
• ルクセンブルク語: lb
• マケドニア語: mk
• マレー語 : ms
• マルタ語: mt
• ルーマニア語 (モルドバ): ro_MD
• モンテネグロ語: sh_ME
• ロマンシュ語: rm
• セルビア語 (キリル文字): sr
• セルビア語 (ラテン文字): sh
• スロベニア語: sl
• タガログ語: tl
• タミル語: ta
• ウルドゥー語: ur
• ウェールズ語: cy
宣言的なメタデータファイルのサフィックスおよびディレクトリの
場所
翻訳は localeCode.translation の形式でファイルに保存されます。localeCode は、翻訳言語のロケー
ルコードです。たとえば、ドイツ語翻訳のファイル名は de.translation です。サポートされるロケール
コードのリストは、「言語」 に示しています。
カスタムオブジェクトの翻訳は、対応するパッケージディレクトリの translations フォルダに保存されま
す。
バージョン
Translations コンポーネントは、API バージョン 14.0 以降で使用できます。
項目
項目
データ型
説明
customApplications
CustomApplicationTranslation[]
カスタムアプリケーション翻訳のリスト。
customLabels
CustomLabelTranslation[]
カスタム表示ラベル翻訳のリスト。
customPageWebLinks
CustomPageWebLinkTranslation[]
ホームページコンポーネントで定義された
Web リンクの翻訳のリスト。
609
メタデータ型
Translations
項目
データ型
説明
customTabs
CustomTabTranslation[]
カスタムタブ翻訳のリスト。
fullName
string
必須。言語コード。たとえば、ドイツ語の場
合は de です。
Metadata から継承されるこの項目は、このメ
タデータ型の WSDL では定義されません。作
成時、更新時、または削除時に指定する必要
があります。コールにおけるこの項目の例を
確認するには、「create()」を参照してく
ださい。
quickActions
GlobalQuickActionTranslation[]
グローバル (オブジェクト固有ではない) クイッ
クアクションのリスト。
reportTypes
ReportTypeTranslation[]
レポートタイプ翻訳のリスト。
scontrols
ScontrolTranslation[]
Sコントロール翻訳のリスト。
CustomApplicationTranslation
CustomApplicationTranslation には、カスタムアプリケーション翻訳の詳細が含まれます。詳細は、
「CustomApplication」を参照してください。
項目
データ型
説明
label
string
必須。翻訳されたカスタムアプリケーション名。最
大 765 文字です。
name
string
必須。カスタムアプリケーションの名前。
CustomLabelTranslation
CustomLabelTranslation には、カスタム表示ラベル翻訳の詳細が含まれます。詳細は、「CustomLabels」を参照し
てください。
項目
データ型
説明
label
string
必須。翻訳されたカスタム表示ラベル名。最大 765
文字です。
name
string
必須。カスタム表示ラベル名。
610
メタデータ型
Translations
CustomPageWebLinkTranslation
CustomPageWebLinkTranslation には、ホームページコンポーネントで定義された Web リンクの翻訳の詳細が含ま
れます。詳細は、「CustomPageWebLink」を参照してください。
項目
データ型
説明
label
string
必須。翻訳された Web リンク。
name
string
必須。Web リンクの名前。
CustomTabTranslation
CustomTabTranslation にはカスタムタブの翻訳の詳細が含まれます。詳細は、「CustomTab」を参照してください。
項目
データ型
説明
label
string
必須。翻訳されたカスタムタブ名。
name
string
必須。カスタムタブ名。
GlobalQuickActionTranslation
GlobalQuickActionTranslation には、グローバルなクイックアクションの翻訳の詳細が含まれます。詳細は、
「QuickAction」を参照してください。
項目
データ型
説明
label
string
必須。グローバルに翻訳されたクイックアクション
名。
name
string
必須。クイックアクション名。
ReportTypeTranslation
ReportTypeTranslation にはカスタムレポートタイプの翻訳の詳細が含まれます。詳細は、「ReportType」を参照し
てください。
項目
データ型
説明
description
string
翻訳されたレポートタイプの説明。
label
string
翻訳されたレポートタイプ名。
name
string
必須。レポートタイプの名前。
sections
ReportTypeSectionTranslation[]
レポートタイプセクションの翻訳のリスト。
611
メタデータ型
Translations
ReportTypeSectionTranslation
ReportTypeSectionTranslation には、レポートタイプセクションの翻訳の詳細が含まれます。
項目
データ型
説明
columns
ReportTypeColumnTranslation[]
レポートタイプ列翻訳のリスト。
label
string
翻訳されたレポートタイプセクション名。
name
string
必須。レポートタイプセクションの名前。
ReportTypeColumnTranslation
ReportTypeColumnTranslation には、レポートタイプ列翻訳の詳細が含まれます。
項目
データ型
説明
label
string
必須。翻訳されたレポートタイプ列名。
name
string
必須。レポートタイプ列名。
ScontrolTranslation
重要: Sコントロールは、Visualforceページに置き換えられました。組織で以前に Sコントロールを使用して
いない場合は、作成できません。既存の Sコントロールに影響はありません。今後も編集できます。
ScontrolTranslation には、Sコントロールの翻訳の詳細が含まれます。詳細は、Salesforce オンラインヘルプの「Sコ
ントロールについて」を参照してください。
項目
データ型
説明
label
string
必須。翻訳された Sコントロール名。
name
string
必須。Sコントロールの名前。
宣言的なメタデータの定義のサンプル
翻訳コンポーネントの 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>
612
メタデータ型
Translations
</customLabels>
</Translations>
使用方法
retrieve() コールを使用して組織内の翻訳を取得する場合、.translations フォルダ内に返されるファイ
ルには package.xml で参照されている他のメタデータ型の翻訳のみが含まれます。たとえば、次の
package.xml ファイルには、すべてのカスタムアプリケーション、カスタム表示ラベル、ホームページコン
ポーネントで定義された Web リンク、カスタムタブ、レポートタイプ、および Sコントロールに一致する types
要素が含まれます。各メタデータ型は明示的に package.xml にリストされているため、これらすべてのメタ
データ型の翻訳が返されます。
<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<types>
<members>*</members>
<name>CustomApplication</name>
</types>
<types>
<members>*</members>
<name>CustomLabels</name>
</types>
<types>
<members>*</members>
<name>CustomPageWebLink</name>
</types>
<types>
<members>*</members>
<name>CustomTab</name>
</types>
<types>
<members>*</members>
<name>ReportType</name>
</types>
<types>
<members>*</members>
<name>Scontrol</name>
</types>
<types>
<members>*</members>
<name>Translations</name>
</types>
<version>32.0</version>
</Package>
関連トピック:
CustomLabels
613
メタデータ型
Workflow
Workflow
ワークフロールールに関連付けられたメタデータを表します。ワークフロールールは、指定された条件に該当
するときに、ワークフローアクションを実行します。ワークフローアクションは、ワークフロールールで指定
された条件をレコードが満たすとただちに実行するか、タイムトリガを設定して特定の日に実行するように設
定することができます。詳細は、Salesforceヘルプの「ワークフローと承認申請の概要」を参照してください。
Metadata メタデータ型を拡張し、その fullName 項目を継承します。ワークフロールール定義の作成、更新、
または削除にはこのメタデータ型を使用します。
マニフェストファイルを使用する場合、次のコードを使用してすべてのワークフローコンポーネントを取得し
ます。
<types>
<members>*</members>
<name>Workflow</name>
</types>
宣言的なメタデータファイルのサフィックスおよびディレクトリの
場所
ワークフローファイルには、サフィックス .workflow が付けられます。ワークフローのある標準オブジェク
トまたはカスタムオブジェクトごとに、1 つのファイルがあります。これらのファイルは、対応するパッケー
ジの workflows ディレクトリに保存されます。
バージョン
ワークフロールールは、API バージョン 13.0 以降で使用できます。
Workflow
このメタデータ型は、標準オブジェクトまたはカスタムオブジェクトに関連付けられたワークフロールールお
よびアクションの有効な型を表します。
項目名
データ型
説明
alerts
WorkflowAlert[]
ワークフローに関連付けられたオブジェクトに関す
るすべてのアラートの配列。
fieldUpdates
WorkflowFieldUpdate[]
ワークフローに関連付けられたオブジェクトに関す
るすべての項目自動更新の配列。
fullName
string
API アクセスの一意の識別子として使用される開発
者名。fullName には、アンダースコアと英数字の
みを使用できます。一意であること、最初は文字で
あること、空白は使用しない、最後にアンダースコ
アを使用しない、2 つ続けてアンダースコアを使用
614
メタデータ型
項目名
Workflow
データ型
説明
しないという制約があります。この項目は、Metadata
コンポーネントから継承されています。
knowledgePublishes
WorkflowKnowledgePublish[]
ワークフローに関連付けられているSalesforce ナレッ
ジワークフロー公開の配列。API バージョン 27.0 以
降で利用できます。
outboundMessages
WorkflowOutboundMessage[]
ワークフローに関連付けられたオブジェクトに関す
るすべてのアウトバウンドメッセージの配列。
rules
WorkflowRule[]
ワークフローに関連付けられてたすべてのオブジェ
クトの配列。
tasks
WorkflowTask[]
ワークフローに関連付けられたオブジェクトに関す
るすべての ToDo の配列。
WorkflowActionReference
WorkflowActionReference は、いずれかのワークフローアクションを表します。
項目名
データ型
説明
name
string
必須。ワークフローアクションの名前。
type
WorkflowActionType (string 必須。次の種別のワークフローアクションを使用でき
型の列挙)
ます。
• Alert
• FieldUpdate
• OutboundMessage
• Task
WorkflowAlert
WorkflowAlert は、ワークフロールールに関連付けられたメールアラートを表します。
項目名
データ型
説明
ccEmails
string[]
追加の CC メールアドレス。
description
string
必須。メールアラートの説明。API バージョン 16.0
以降で利用できます。
fullName
string
必須。APIアクセスの一意の識別子として使用され
る開発者名。fullName には、アンダースコアと
英数字のみを使用できます。一意であること、最
615
メタデータ型
項目名
Workflow
データ型
説明
初は文字であること、空白は使用しない、最後に
アンダースコアを使用しない、2 つ続けてアンダー
スコアを使用しないという制約があります。この
項目は、Metadata コンポーネントから継承されて
います。
protected
boolean
必須。このコンポーネントが保護されるか (true)、
否か (false) を示します。保護コンポーネントは、
インストールする組織で作成されたコンポーネン
トによってリンク設定したり参照したりすること
はできません。
recipients
WorkflowEmailRecipient[]
メールの受信者。
senderAddress
string
メールアラートの [送信者] 項目のアドレス。デフォ
ルトの [送信者] 項目 (レコードを更新したユーザの
メールアドレス) の代わりに、組織の標準のグロー
バルメールアドレス ([email protected] な
ど) を使用できます。senderType が
OrgWideEmailAddress に設定されている場合に
のみ、この項目に値を指定できます。Salesforce ヘ
ルプの「組織の共有アドレス」を参照してくださ
い。
senderType
ActionEmailSenderType (string 型 送信者の送信者および返信先アドレスとして使用
の列挙)
されるメール。有効な値は次のとおりです。
• CurrentUser — レコードを更新するユーザの
メールアドレス。これは、デフォルト設定で
す。
• DefaultWorkflowUser — デフォルトワーク
フローユーザのメールアドレス。
• OrgWideEmailAddress —
[email protected] など、組織の検証済
みグローバルメールアドレス。
template
string
必須。EmailTemplate への名前指定参照。このメー
ルテンプレートは zip ファイル内に存在する必要は
ありませんが、メタデータ API には存在する必要
があります。
WorkflowEmailRecipient
WorkflowEmailRecipient は、ワークフロールールに関連付けられたメールアラートの受信者を表します。
616
メタデータ型
Workflow
項目名
データ型
説明
field
string
type で参照される項目の名前。名前を指定した項
目は、type で指定されている型である必要があり
ます。
recipient
string
メールの受信者。選択した型に応じて、必須にな
る場合があります。
type
ActionEmailRecipientTypes
(string 型の列挙)
EmailTemplate コンポーネントへの名前指定参照。有
効な値は、次のとおりです。
• accountOwner - メールはレコードの取引先所
有者に送信されます (商談の取引先所有者など)。
• accountTeam - Account オブジェクトのみに適用
されます。メールはその Account の取引先チーム
全員に送信されます。
• campaignMemberDerivedOwner - 取引先責任
者がキャンペーンに追加された場合、または
キャンペーンに応じて、メールがリードおよび
取引先責任者所有者に送信されます。
• contactLookup - メールは、レコードの項目か
ら検索された値を含む取引先責任者に送信され
ます。この値では、field 項目が Contact を参照
する必要があります。
• creator - メールはレコードの作成者に送信さ
れます。
• customerPortalOwner - メールは特定のセル
フサービスポータルユーザに送信されます。こ
の値では、recipient 項目が User を (ユーザ名で) 参
照する必要があります。セルフサービスポータ
ルユーザのみが対象です。
• email - メールはレコードの項目から検索され
た値を含むメールアドレスに送信されます。こ
の値では、field 項目が email 項目を参照する
必要があります。
• group - メールはグループ内の全ユーザに送信
されます。この値では、recipient 項目が group を
(グループ名で) 参照する必要があります。
• opportunityTeam - Opportunity オブジェクトの
みに適用されます。メールはその Opportunity の
商談チーム全員に送信されます。
• owner - メールはレコードの所有者に送信され
ます。
617
メタデータ型
項目名
Workflow
データ型
説明
• partnerUser - メールは特定のパートナーユー
ザに送信されます。この値では、recipient 項目が
User を (ユーザ名で) 参照する必要があります。
パートナーユーザのみが対象です。
• portalRole - role と似ていますが、ポータル
ロールのみが対象となります。
• portalRoleSubordinates roleSubordinates と似ていますが、ポータ
ルロールのみが対象となります。
• role - メールはロールの全ユーザに送信されま
す。この値では、recipient 項目が (ロール階層内
の) Role を (ロール名で) 参照する必要がありま
す。
• roleSubordinates - メールは下位ロールの全
ユーザに送信されます。この値では、recipient 項
目が Role を参照する必要があります。
• roleSubordinatesInternal roleSubordinates と似ていますが、内部ポー
タルロールのみが対象となります。
• user - メールは特定のユーザに送信されます。
この値では、recipient 項目が User を (ユーザ名で)
参照する必要があります。
• userLookup - メールはレコードの項目から検
索された値を含むユーザに送信されます。この
値では、field 項目がユーザの外部キー項目を
参照する必要があります。
WorkflowFieldUpdate
WorkflowFieldUpdate は、ワークフローの項目自動更新を表します。項目自動更新を使用すると、ワークフロー
ルールがトリガされたときに、自動的に項目値を指定した値に更新できます。詳細は、Salesforceヘルプの「項
目自動更新の定義」を参照してください。
項目名
データ型
説明
description
string
項目自動更新の説明。この情報は、項目自動更新を
最初に設定したときの理由を追跡するのに役立ちま
す。
field
string
必須。更新する項目 (ワークフローのオブジェクト上
の)。
618
メタデータ型
Workflow
項目名
データ型
説明
formula
string
operation 項目値が Formula の場合、これは新し
い項目値の計算に使用される数式に設定されます。
fullName
string
必須。APIアクセスの一意の識別子として使用される
開発者名。fullName には、アンダースコアと英数
字のみを使用できます。一意であること、最初は文
字であること、空白は使用しない、最後にアンダー
スコアを使用しない、2 つ続けてアンダースコアを使
用しないという制約があります。この項目は、
Metadata コンポーネントから継承されています。
literalValue
string
operation 項目値が Literal の場合、これは項目
のリテラル値です。
lookupValue
operation 項目値が lookupValue の場合、これは
string
参照されるルックアップ値です。
lookupValueType
LookupValueType (string 型
の列挙)
lookupValue 項目値が参照するオブジェクトの種
別。有効な値は、次のとおりです。
• Queue
• RecordType
• User
name
string
必須。コンポーネントの名前。API バージョン 16.0 以
降で使用できます。
notifyAssignee
boolean
必須。項目が更新された場合に割り当て先に通知し
ます。
operation
FieldUpdateOperation (string 必須。項目の更新に使用される値を計算する操作。
型の列挙)
有効な値は、次のとおりです。
• Formula - 項目が数式に設定されることを示しま
す。設定されている場合、数式は有効な数式であ
る必要があります。
• Literal - 項目がリテラル値に設定されることを
示します。設定されている場合、literalValue はこの
項目にとって有効なリテラル値である必要があり
ます。
• LookupValue - Literal と似ていますが、contact、
user、account などの、オブジェクト参照用です。
設定されている場合、lookupValue 要素を設定
する必要があります。現在の API では User のみが
サポートされています。
619
メタデータ型
項目名
Workflow
データ型
説明
• NextValue - 項目が次の値に設定されることを示
します。これは、項目自動更新が選択リストを参
照する場合にのみ許可されます。
• Null - 項目が null に設定されることを示します。
• PreviousValue - 項目が前の値に設定されること
を示します。これは、項目自動更新が選択リスト
を参照する場合にのみ許可されます。
protected
boolean
必須。このコンポーネントが保護されるか (true)、
否か (false) を示します。保護コンポーネントは、イ
ンストールする組織で作成されたコンポーネントに
よってリンク設定したり参照したりすることはでき
ません。
reevaluateOnChange
boolean
この項目が true に設定されているときにこの項目が
項目の値を更新すると、関連付けられたオブジェク
トのすべてのワークフロールールが再評価されます。
条件が項目値の変更結果と一致するすべてのワーク
フロールールがトリガされます。
トリガされたワークフロールールのいずれかにより、
ワークフロールールの再評価も有効にする他の項目
自動更新が実行される場合、ドミノ効果が発生し、
新規にトリガされた項目自動更新の結果としてより
多くのワークフロールールを再評価できます。この
ワーフロールールの再評価およびトリガのカスケー
ドは、それを開始した最初の項目自動更新の後、最
大 5 回実行できます。
targetObject
string
これは、子レコードで変更が検出された場合に設定
されます。これが設定されている場合、親 (Case など)
を指し示す子オブジェクト
(EmailMessage.ParentId など) の外部キー参照を
指し示します。設定されると、数式は子オブジェク
ト (EmailMessage など) に基づきます。この項目は、
バージョン 14.0 より前では sourceField という名
前です。項目名の変更は、バージョン間で自動的に
処理され、既存の XML コンポーネントファイルを手
動で編集する必要はありません。
620
メタデータ型
Workflow
WorkflowKnowledgePublish
WorkflowKnowledgePublish は、Salesforce ナレッジ記事の公開アクションおよび情報を表します。API バージョン
27.0 以降で利用できます。
項目名
データ型
説明
action
KnowledgeWorkflowAction (string 型 このルールが起動したときに実行可能な記事の
の列挙)
公開アクション。有効な値は、次のとおりで
す。
• PublishAsNew: 記事を新規記事として公開
します。
• Publish: 記事を公開済み記事のバージョン
として公開します。
description
string
簡単な記事の説明。
label
string
Salesforceユーザインターフェース全体で記事を
表す表示ラベル。
language
string
記事の言語。
protected
boolean
必須。このコンポーネントが保護されるか
(true)、否か (false) を示します。保護コンポー
ネントは、インストールする組織で作成された
コンポーネントによってリンク設定したり参照
したりすることはできません。
WorkflowOutboundMessage
WorkflowOutboundMessage は、ワークフロールールに関連付けられたアウトバウンドメッセージを表します。ア
ウトバウンドメッセージは、外部サービスなどの指定したエンドポイントに指定の情報を送信するワークフ
ローおよび承認アクションです。アウトバウンドメッセージは、エンドポイントに対し、特定の項目内のデー
タを SOAP メッセージとして送信します。詳細は、Salesforce ヘルプの「アウトバウンドメッセージの定義」を
参照してください。
項目名
データ型
説明
apiVersion
double
必須。アウトバウンドメッセージの API バージョン。アウ
トバウンドメッセージが作成されると、自動的に現在の
API バージョンに設定されます。アウトバウンドメッセー
ジの有効な API バージョンは 8.0 および 18.0 以降です。
この API バージョンは、Enterprise または Partner WSDL を使用
した Salesforce への API コールバックで使用されます。[API
バージョン] は、メタデータ APIを使用してのみ変更できま
す。Salesforce ユーザインターフェースを使用して変更する
621
メタデータ型
項目名
Workflow
データ型
説明
ことはできません。この項目は、API バージョン 18.0 以降
で使用できます。
警告: apiVersion を、アウトバウンドメッセージに
設定された fields のいずれもサポートしていない
バージョンに変更した場合、更新された WSDL を消費
するようにアウトバウンドメッセージリスナーを更
新するまでメッセージは失敗します。[設定] からアウ
トバウンドメッセージの状況を監視するには、
Salesforce で [監視] > [アウトバウンドメッセージ] をク
リックします。
description
string
アウトバウンドメッセージを説明します。
endpointUrl
string
必須。アウトバウンドメッセージの送信先となるエンドポ
イント URL。
fields
string[]
送信対象の項目への名前指定参照。
fullName
string
必須。API アクセスの一意の識別子として使用される開発
者名。fullName には、アンダースコアと英数字のみを使
用できます。一意であること、最初は文字であること、空
白は使用しない、最後にアンダースコアを使用しない、2
つ続けてアンダースコアを使用しないという制約がありま
す。この項目は、Metadata コンポーネントから継承されて
います。
includeSessionId
boolean
必須。アウトバウンドメッセージに Salesforce セッション ID
を含める場合は設定します。APIコール発行の予定があり、
ユーザ名とパスワードを含めたくない場合に便利です。
integrationUser
string
必須。このメッセージの送信者となるユーザへの名前指定
参照。
name
string
必須。コンポーネントの名前。API バージョン 16.0 以降で
使用できます。
protected
boolean
必須。このコンポーネントが保護されるか (true)、否か
(false) を示します。保護コンポーネントは、インストー
ルする組織で作成されたコンポーネントによってリンク設
定したり参照したりすることはできません。
useDeadLetterQueue
boolean
この項目は、配信不能メッセージキュー権限が有効な組織
でのみ使用できます。設定されている場合、このアウトバ
ウンドメッセージは、通常の配信が失敗した場合に配信不
能メッセージキューを使用します。
622
メタデータ型
Workflow
WorkflowRule
このメタデータ型はワークフロールールを表します。Metadata メタデータ型を拡張し、その fullName 項目を
継承します。
項目名
データ型
説明
actions
WorkflowActionReference[]
このルールが起動したら実行する必要があるアク
ションの参照の配列。
active
boolean
必須。このルールが有効かどうかを決定します。
booleanFilter
string
高度な検索条件の boolean 数式 ((1 AND 2) OR 3
など) です。
criteriaItems
FilterItem[]
このルールを起動する boolean 条件の配列。この項
目か、formula のいずれかが設定されている必要
があります。
description
string
ワークフロールールの説明。
formula
string
このルールが最初に (この項目か criteriaItems
に) 設定されている必要がある数式条件。
fullName
string
API アクセスの一意の識別子として使用される開発
者名。fullName には、アンダースコアと英数字の
みを使用できます。一意であること、最初は文字で
あること、空白は使用しない、最後にアンダースコ
アを使用しない、2 つ続けてアンダースコアを使用
しないという制約があります。この項目は、Metadata
コンポーネントから継承されています。
triggerType
WorkflowTriggerTypes (string
型の列挙)
トリガが起動する条件。有効な値は、次のとおりで
す。
• onAllChanges - すべての変更でワークフロー
ルールが考慮されます。
• onCreateOnly - 作成でのみワークフロールール
が考慮されます。
• onCreateOrTriggeringUpdate - 作成およびト
リガする更新でのみワークフロールールが考慮
されます。
workflowTimeTriggers
WorkflowTimeTrigger
指定間隔の前/後に実行する一連のワークフローア
クション (項目自動更新、メールアラート、アウト
バウンドメッセージ、ToDo) を表します。
623
メタデータ型
Workflow
WorkflowTask
このメタデータ型は、割り当てられたワークフロー ToDo を参照します。
項目名
データ型
説明
assignedTo
string
ワークフロールールまたはアクションが割り当
てられているユーザ、ロール、またはチームを
指定します。ここで指定した値に対応する項目
は、指定された assignedToType と同じであ
る必要があります。
assignedToType
ActionTaskAssignedToTypes (string この型の有効な string 値は次のとおりです。
型の列挙)
• accountCreator - 設定した場合、ToDo はレ
コードの取引先の作成者に割り当てられま
す。
• accountOwner - 設定した場合、ToDo はレ
コードの取引先の所有者 (Opportunity) に割り
当てられます。
• accountTeam - WorkflowAlert 型と同じです。
• creator - 設定した場合、ToDo はレコード
の作成者に割り当てられます。
• opportunityTeam - WorkflowAlert 型と同じで
す。
• owner - 設定した場合、ToDo はレコードの所
有者に割り当てられます。
• partnerUser - 設定した場合、assignedTo
項目は User を (ユーザ名で) 参照します。パー
トナーユーザが対象です。
• portalRole - 設定した場合、assignedTo
項目は Role を (ロール名で) 参照します。ポー
タルロールが対象です。
• role - 設定した場合、assignedTo 項目は
Role を (ロール名で) 参照します。
• user - 設定した場合、assignedTo 項目は
User を (ユーザ名で) 参照します。
description
string
このワークフロー ToDo の説明。
dueDateOffset
int
必須。トリガ日または (省略可能な)
offsetFromField で指定された日付からのオ
フセット (日数)。負の数値を設定できます。
fullName
string
必須。APIアクセスの一意の識別子として使用さ
れる開発者名。fullName には、アンダースコ
624
メタデータ型
項目名
Workflow
データ型
説明
アと英数字のみを使用できます。一意であるこ
と、最初は文字であること、空白は使用しな
い、最後にアンダースコアを使用しない、2 つ
続けてアンダースコアを使用しないという制約
があります。この項目は、Metadata コンポーネ
ントから継承されています。
notifyAssignee
boolean
必須。ToDo が割り当てられたときにメール通知
を送信する場合に設定します。
offsetFromField
string
dueDate の計算の基準となる date 項目の項目参
照 (省略可能)。
priority
string
必須。作成された ToDo に割り当てる優先度。
protected
boolean
必須。このコンポーネントが保護されるか
(true)、否か (false) を示します。保護コンポー
ネントは、インストールする組織で作成された
コンポーネントによってリンク設定したり参照
したりすることはできません。
status
string
必須。作成した ToDo を割り当てる状況。
subject
string
必須。ワークフロー ToDo の件名。ToDo が割り
当てられたときにメール通知を送信する場合に
使用されます。APIバージョン 16.0 以降で利用で
きます。
WorkflowTimeTrigger
指定間隔の前/後に実行する一連のワークフローアクション (項目自動更新、メールアラート、アウトバウンド
メッセージ、ToDo) を表します。
項目名
データ型
説明
actions
WorkflowActionReference[] このトリガが起動した場合に実行するアクションの参
照の配列。
offsetFromField
string
時間ベースのワークフローがトリガされる基準となる
date 型の項目名 ([作成日]、[最終更新日]、[ルール適
用日])、またはワークフロールールが定義されている、
オブジェクトのカスタム日付項目。
timeLength
string
ワークフローをトリガした後/トリガする前の時間 (数
値)。負の値は、トリガが起動する前の時間の長さを表
します。
625
メタデータ型
項目名
Workflow
データ型
workflowTimeTriggerUnit WorkflowTimeUnits (string
型の列挙)
説明
時間ベースのワークフローがトリガされる前または後
の時間の単位。有効な string 値は次のとおりです。
• 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>
</fieldUpdates>
<fieldUpdates>
<fullName>Field_Update</fullName>
626
メタデータ型
Workflow
<description>TestField update desc</description>
<field>Name</field>
<formula>Name &amp; &quot;Updated&quot;</formula>
<name>Field Update</name>
<notifyAssignee>false</notifyAssignee>
<operation>Formula</operation>
<protected>false</protected>
</fieldUpdates>
<fieldUpdates>
<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>
</criteriaItems>
<criteriaItems>
<field>CustomObjectForWorkflow__c.CreatedById</field>
<operation>notEqual</operation>
<value>abc</value>
</criteriaItems>
<criteriaItems>
<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>
627
メタデータ型
Workflow
</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>
<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>
628
メタデータ型
XOrgHub
<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>
XOrgHub
組織間データ接続のハブ組織に関連付けられているメタデータを表します。
ハブとは、別の組織と共有する 1 つ以上のカスタムオブジェクトのコンテナです。Metadata メタデータ型を拡
張し、その fullName 項目を継承します。
メモ: 組織間データ共有は現在、パイロットプログラムで使用可能です。組織間共有の有効化についての
詳細は、salesforce.com にお問い合わせください。
ファイルのサフィックスおよびディレクトリの場所
XOrgHub コンポーネントのサフィックスは .xorghub で、xorghub フォルダに保存されます。
バージョン
XOrgHub コンポーネントは、API バージョン 32.0 以降で使用できます。
項目
項目名
データ型
説明
label
string
必須。Salesforce ユーザインターフェースでハ
ブ組織を識別する表示ラベル。
lockSharedObjects
boolean
この項目が true に設定されている場合は、ハ
ブ管理者が項目やオブジェクトを削除した
り、開発者名を変更したりすることができま
せん。false の場合は、ハブ管理者が必要に応
じて組織を変更できます。
629
メタデータ型
XOrgHubSharedObject
項目名
データ型
説明
permissionSets
string[]
各スポークプロキシオブジェクトの権限セッ
トを保存します。
sharedObjects
XOrgHubSharedObject[]
ハブがスポークと共有するオブジェクトのリ
ストを保存します。この配列は空にすること
も、組織で許容される最大数の共有オブジェ
クトを格納することもできます。
宣言的なメタデータの定義のサンプル
XOrgHub コンポーネントの例を次に示します。
<XOrgHub xmlns="http://soap.sforce.com/2006/04/metadata">
<fullName>TestHub</fullName>
<label>TestHub</label>
<lockSharedObjects>false</lockSharedObjects>
<permissionSets>HubPermset</permissionSets>
<sharedObjects>
<fields>MyCustomObject__c.Checkbox_field1__c</fields>
<fields>MyCustomObject__c.DateTime_field2__c</fields>
<fields>MyCustomObject__c.Text_field0__c</fields>
<name>MyCustomObject__c</name>
</sharedObjects>
<version>0.0.0</version>
</XOrgHub>
XOrgHubSharedObject
組織間データ接続の共有オブジェクトに関連付けられているメタデータを表します。
XOrgHubSharedObject 種別は、ハブ組織がスポークと共有するために選択したオブジェクトを表します。Metadata
メタデータ型を拡張し、その fullName 項目を継承します。
メモ: 組織間データ共有は現在、パイロットプログラムで使用可能です。組織間共有の有効化についての
詳細は、salesforce.com にお問い合わせください。
ファイルのサフィックスおよびディレクトリの場所
XOrgHubSharedObject コンポーネントのサフィックスは .xorghubsharedobject で、xorghubsharedobject
フォルダに保存されます。
バージョン
XOrgHubSharedObject コンポーネントは、API バージョン 32.0 以降で使用できます。
630
メタデータ型
XOrgHubSharedObject
項目
項目名
データ型
説明
fields
string[]
ハブがスポークと共有するオブジェクトからの項目。この
配列のサイズは、0 からオブジェクトごとに組織で共有可
能な項目の最大数までの範囲になります。
name
string
Salesforceユーザインターフェースのオブジェクトの名前。
宣言的なメタデータの定義のサンプル
XOrgHubSharedObject コンポーネントの例を次に示します。
<XOrgHub xmlns="http://soap.sforce.com/2006/04/metadata">
<fullName>TestHub</fullName>
<label>TestHub</label>
<lockSharedObjects>false</lockSharedObjects>
<permissionSets>HubPermset</permissionSets>
<sharedObjects>
<fields>MyCustomObject__c.Checkbox_field1__c</fields>
<fields>MyCustomObject__c.DateTime_field2__c</fields>
<fields>MyCustomObject__c.Text_field0__c</fields>
<name>MyCustomObject__c</name>
</sharedObjects>
<version>0.0.0</version>
</XOrgHub>
631
付録
付録 A
CustomObjectTranslation の言語サポート — 完全
サポート対象言語
すべての言語で、CustomObjectTranslation の項目で使用可能なすべての値がサポートされているわけではありま
せん。この付録で、特定の言語でサポートされる項目値を確認してください。
メモ: Salesforce では、完全にサポートされる言語、エンドユーザ言語、およびプラットフォームのみの言
語という 3 つのレベルの言語がサポートされています。この付録には、完全にサポートされている言語の
情報が記載されています。詳細については、Salesforce ヘルプの 「Salesforce がサポートする言語は?」を参
照してください。
中国語 (簡体字)
plural
true
false
中国語 (繁体字)
plural
true
false
デンマーク語
plural
true
false
オランダ語
article
Definite
Indefinite
632
CustomObjectTranslation の言語サポート — 完全サポー
ト対象言語
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
gender
Masculine
Feminine
633
CustomObjectTranslation の言語サポート — 完全サポー
ト対象言語
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
Special
634
CustomObjectTranslation の言語サポート — 完全サポー
ト対象言語
日本語
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
635
CustomObjectTranslation の言語サポート — 完全サポー
ト対象言語
スペイン語
article
Definite
Indefinite
gender
Masculine
Feminine
plural
true
false
タイ語
plural
true
false
636
付録 B
CustomObjectTranslation の言語サポート — エン
ドユーザ言語
すべての言語で、CustomObjectTranslation の項目で使用可能なすべての値がサポートされているわけではありま
せん。この付録で、特定の言語でサポートされる項目値を確認してください。
メモ: Salesforce では、完全にサポートされる言語、エンドユーザ言語、およびプラットフォームのみの言
語という 3 つのレベルの言語がサポートされています。この付録には、エンドユーザ言語の情報が記載さ
れています。詳細については、Salesforce ヘルプの 「Salesforce がサポートする言語は?」を参照してくださ
い。
アラビア語
article
Definite
gender
Masculine
Feminine
plural
true
false
possessive
First
Second
ブルガリア語
article
Definite
gender
Masculine
Feminine
Neuter
plural
true
637
CustomObjectTranslation の言語サポート — エンドユー
ザ言語
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
638
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
639
CustomObjectTranslation の言語サポート — エンドユー
ザ言語
Second
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
640
CustomObjectTranslation の言語サポート — エンドユー
ザ言語
ルーマニア語
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
641
CustomObjectTranslation の言語サポート — エンドユー
ザ言語
Second
ウクライナ語
caseType
Accusative
Dative
Genitive
Instrumental
Nominative
Prepositional
gender
Masculine
Feminine
Neuter
plural
true
false
ベトナム語
plural
true
false
642
用語集
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
A
Apex
Apex は、開発者が Force.com プラットフォームサーバでフローとトランザクションの制御ステートメントを
Force.comAPIへのコールと組み合わせて実行できるようにした、強く型付けされたオブジェクト指向のプロ
グラミング言語です。Java に似た構文を使い、データベースのストアドプロシージャのように動作するApex
を使用して、開発者は、ボタンクリック、関連レコードの更新、および Visualforce ページなどのほとんどの
システムイベントにビジネスロジックを追加できます。Apexコードは、Web サービス要求、およびオブジェ
クトのトリガから開始できます。
Apex による共有管理
開発者は、アプリケーションの動作をサポートする共有をプログラムで操作できるようになります。Apex
による共有管理は、カスタムオブジェクトでのみ有効です。
アプリケーション
「App」と表記されることもあります。特定のビジネス要件を扱うタブ、レポート、ダッシュボードおよび
Visualforce ページなどのコンポーネントの集合です。Salesforce では、セールスおよびコールセンターなどの
標準アプリケーションを提供しています。お客様のニーズに合わせてこれらの標準アプリケーションをカ
スタマイズできます。また、アプリケーションをパッケージ化して、カスタム項目、カスタムタブ、カス
タムオブジェクトなどの関連コンポーネントと共にAppExchangeにアップロードできます。そのアプリケー
ションを AppExchange から他の Salesforce ユーザが利用できるようにすることもできます。
AppExchange
AppExchange は salesforce.com の共有インターフェースであり、Force.com プラットフォームのアプリケーショ
ンやサービスを参照および共有できます。
AppExchange のアップグレード
アプリケーションのアップグレードは、新しいバージョンをインストールするプロセスです。
アプリケーションプログラムインターフェース (API)
コンピュータシステム、ライブラリ、またはアプリケーションが、その他のコンピュータプログラムがサー
ビスを要求したりデータを交換したりできる機能を提供するインターフェースです。
非同期コール
操作に長い時間がかかるため、直ちに結果を返さないコールです。メタデータ API と Bulk API のコールは非
同期です。
643
用語集
B
Boolean 演算子
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.com IDE や
Force.com 移行ツールなど、API で構築されたツールを使用してリリースしたり、取得したりできます。
コンポーネント、Visualforce
<apex:detail> などの一連のタグを使用して Visualforce ページに追加できます。Visualforce には、多くの標
準コンポーネントが含まれていますが、独自のカスタムコンポーネントを作成することもできます。
コンポーネントの参照、Visualforce
組織で使用できるVisualforceの標準コンポーネントおよびカスタムコンポーネントの説明。Visualforceページ
の開発フッターまたは『Visualforce 開発者ガイド』からコンポーネントライブラリにアクセスできます。
コントローラ、Visualforce
Visualforce ページに実行する必要のあるデータおよびビジネスロジックを提供する Apex クラス。Visualforce
ページは、デフォルトですべての標準オブジェクトまたはカスタムオブジェクトに付属する標準コントロー
ラを使用、またはカスタムコントローラを使用できます。
制御項目
対応する 1 つ以上の連動項目で使用可能な値を制御する、標準またはカスタムの選択リストやチェックボッ
クスの項目です。
644
用語集
カスタムアプリケーション
「アプリケーション」を参照してください。
カスタムリンク
カスタムリンクとは管理者によって定義された 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 では、round half up アルゴリズムを使用しま
す。中間値は常に切り上げられます。たとえば、1.45 は 1.5 に切り上げられます。–1.45 は –1.5 に切り上げら
れます。
連動項目
対応する制御項目で選択された値に基づいて、使用可能な値が表示される、カスタムの選択リストまたは
複数選択の選択リストの項目です。
Developer Force
Developer Force Web サイト (developer.salesforce.com) では、サンプルコード、ツールキット、オンライン開発者
コミュニティなど、プラットフォーム開発者向けの幅広いリソースを提供しています。開発向けのForce.com
プラットフォーム環境も、ここから入手できます。
645
用語集
ドキュメントライブラリ
ドキュメントの保存場所。これらのドキュメントは、取引先や取引先責任者、商談、またはその他のレコー
ドに添付しません。
E
メールアラート
メールアラートは、メールテンプレートを使用してワークフロールールまたは承認プロセスによって生成
され、Salesforce ユーザなど、指定された受信者に送信されるワークフローおよび承認アクションです。
Enterprise WSDL
Salesforce 組織のみでインテグレーションを構築する顧客や、Tibco、webMethods などのツールを使って強い
型キャストが必要なインテグレーションを構築するパートナー向けの強い型付けの WSDL。Enterprise WSDL の
欠点は、組織のデータモデルに存在するすべての一意のオブジェクトおよび項目にバインドされているた
め、1 つの Salesforce 組織のスキーマだけを扱うという点です。
エンティティ関係図 (ERD)
データをエンティティ (またはForce.comプラットフォームではオブジェクト) に整理し、それらのリレーショ
ンを定義することができるデータモデリングツールです。主要な Salesforce オブジェクトの ERD ダイアグラ
ムについては、『SOAP API 開発者ガイド』を参照してください。
列挙項目
列挙は、WSDL での選択項目と同じです。項目の有効な値は、同じデータ型を持つ指定可能な値のセットに
厳密に制限されます。
F
項目
テキストまたは通貨の値など、情報の特定の部分を保持するオブジェクトの一部です。
項目レベルセキュリティ
項目が、ユーザに非表示、表示、参照のみ、または編集可能であるかどうかを決定する設定です。Enterprise
Edition、Unlimited Edition、Performance Edition、Developer Edition でのみ使用できます。
検索条件
リストビューまたはレポートに含まれる項目を絞り込むための、特定の項目に対する条件。たとえば「都
道府県」「次の文字列と一致する」「東京都」など。
Force.com
アプリケーションを構築する salesforce.com プラットフォームです。Force.com は、強力なユーザインター
フェース、オペレーティングシステムおよびデータベースを結合して、企業全体でアプリケーションをカ
スタマイズおよび展開できます。
Force.com IDE
開発者が Eclipse 開発環境で Force.com アプリケーションを管理、作成、デバッグおよびリリースできる Eclipse
プラグイン。
646
用語集
Force.com 移行ツール
ローカルファイルシステムと Salesforce 組織との間で Force.com コンポーネントを移行する Apache Ant 開発ス
クリプトを作成するためのツールキット。
外部キー
値が別のテーブルの主キーと同じ項目です。外部キーは、別のテーブルの主キーのコピーとしてみなすこ
とができます。2 つのテーブルのリレーションは、あるテーブルの外部キーの値と、別のテーブルの主キー
の値が一致することによって成り立ちます。
数式項目
カスタム項目の一種。差し込み項目、式、またはその他の値に基づいて、値を自動的に計算します。
関数
あらかじめ用意されている数式。入力パラメータを使用してカスタマイズできます。たとえば、DATE 関数
は、年、月、および日付から日付データ型を作成します。
G
グレゴリオ暦
世界中で使用されている、12 か月構造に基づいたカレンダーです。
H
HTTP デバッガ
AJAX Toolkit から送信される SOAP 要求を識別し、調査するために使用できるアプリケーションです。ローカ
ルコンピュータで稼動するプロキシサーバとして動作し、各要求を調査および認証できます。
I
ID
「Salesforce レコード ID」を参照してください。
インライン Sコントロール
メモ: Sコントロールは、Visualforce ページに置き換えられました。2010 年以降、新しい組織同様、Sコ
ントロールを作成したことのない組織は、Sコントロールを作成できなくなります。既存の Sコント
ロールに影響はありません。今後も編集できます。
個別のページでなく、レコード詳細ページまたはダッシュボード内に表示される Sコントロールです。
インスタンス
組織のデータをホストし、アプリケーションを実行する単一の論理サーバとして示されるソフトウェアお
よびハードウェアのクラスタです。Force.comプラットフォームは複数のインスタンスで稼動しますが、1 つ
の組織のデータは常に 1 つのインスタンスに一元管理されています。
インテグレーションユーザ
クライアントアプリケーションまたはインテグレーションのみを対象に定義された Salesforce ユーザです。
また、SOAP API コンテキストではログインユーザとも呼ばれます。
647
用語集
ISO コード
国際標準化機構が定める国コードで、各国を 2 文字で表します。
J
連結オブジェクト
2 つの主従関係を持つカスタムオブジェクトです。カスタム連結オブジェクトを使用して、2 つのオブジェ
クト間の「多対多」リレーションをモデル化できます。たとえば、「バグ」という名前のカスタムオブジェ
クトを作成し、1 つのバグを複数のケースに、また 1 つのケースを複数のバグに関連付けることができま
す。
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にログインするために使用するユーザ名です。クライアントアプリケー
ションは、ログインユーザの権限および共有設定に基づいて動作します。また、インテグレーションユー
ザとも呼ばれます。
648
用語集
参照項目
別のレコードに対するリンク可能な値を含む項目の種別です。オブジェクトに別のオブジェクトとの参照
関係または主従関係がある場合、ページレイアウトに参照項目を表示できます。たとえば、ケースに納入
商品との参照関係がある場合、ケース詳細ページからルックアップダイアログを使用して納入商品を選択
し、ケース詳細ページから納入商品の名前をクリックできます。
M
管理パッケージ
ユニットとしてAppExchangeに投稿され、名前空間と、場合によりライセンス管理組織に関連付けられるア
プリケーションコンポーネントの集合です。アップグレードをサポートするには、管理パッケージである
ことが必要です。組織は、他の多くの組織でダウンロードおよびインストールできる単一の管理パッケー
ジを作成できます。管理パッケージは、未管理パッケージとは異なり、コンポーネントの一部がロックさ
れていて、後でアップグレードできます。未管理パッケージには、ロックされたコンポーネントは含まれ
ておらず、アップグレードはできません。また、管理パッケージでは、開発者の知的財産保護のため、登
録している組織では特定のコンポーネント (Apex など) は隠されます。
マニフェストファイル
プロジェクトマニフェストファイル (package.xml) には、メタデータ API、またはメタデータ API の上に構
築された Force.com IDE または Force.com 移行ツールなどのクライアントを使用するときに取得またはリリー
スする XML コンポーネントがリストされます。
手動による共有
レコード所有者がレコードにアクセス権を持たないユーザに参照権限および編集権限を与えることができ
るレコードレベルのアクセスルールです。
多対多リレーション
リレーションの両端に多くの子があるリレーションです。多対多リレーションは、連結オブジェクトを使
用して実装されます。
メタデータ
組織およびいずれかの部署の構造、外観、機能に関する情報です。Force.com では、メタデータを記述する
のに XML を使用します。
メタデータ WSDL
Force.com メタデータ API コールを使用するユーザの WSDL。
マルチテナンシー
すべてのユーザおよびアプリケーションが単一で共通のインフラストラクチャおよびコードベースを共有
するアプリケーションモデルです。
N
名前空間
パッケージコンテキストでは、ドメイン名と同様、AppExchangeにある自社パッケージとその内容を他の開
発者のパッケージと区別するための 1 ～ 15 文字の英数字で構成される識別子です。Salesforce では、Salesforce
649
用語集
組織のすべての一意のコンポーネント名に自動的に名前空間接頭辞とそれに続く 2 つのアンダースコア (__)
を追加します。
ネイティブアプリケーション
Force.comの設定 (メタデータ) 定義で排他的に開発されたアプリケーションです。ネイティブアプリケーショ
ンには、外部サービスまたは外部インフラストラクチャは必要ありません。
O
オブジェクト
Salesforce 組織に情報を保存するために使用するオブジェクト。オブジェクトは、保存する情報の種類の全
体的な定義です。たとえば、Case オブジェクトを使用して、顧客からの問い合わせに関する情報を保存で
きます。各オブジェクトについて、組織は、そのデータ型の具体的なインスタンスに関する情報を保存す
る複数のレコードを保有します。たとえば、佐藤次郎さんから寄せられたトレーニングに関する問い合わ
せに関する情報を保存するケースレコードと、山田花子さんから寄せられたコンフィグレーションの問題
に関する情報を保存するケースレコードなどです。
オブジェクトレベルのヘルプ
カスタムオブジェクトに提供できるカスタムヘルプのテキスト。カスタムオブジェクトレコードのホーム
(概要)、詳細、編集ページ、リストビューや関連リストに表示されます。
オブジェクトレベルセキュリティ
特定のユーザに対してオブジェクト全体を非表示にできる設定です。ユーザはそうしたデータの存在を知
ることもできません。オブジェクトレベルセキュリティはオブジェクト権限で指定されます。
onClick JavaScript
ボタンまたはリンクをクリックすると実行される JavaScript コードです。
一対多リレーション
1 つのオブジェクトが多数のオブジェクトに関連するリレーションです。たとえば、取引先に 1 つまたは複
数の関連取引先責任者がある場合があります。
組織の共有設定
ユーザが組織で持つデータアクセスのベースラインレベルを指定できる設定です。たとえば、オブジェク
ト権限によって有効化されている特定のオブジェクトの任意のレコードを参照できますが、編集するには
別の権限が必要となるよう、組織の共有設定を設定できます。
アウトバウンドメッセージ
アウトバウンドメッセージは、外部サービスなどの指定したエンドポイントに指定の情報を送信するワー
クフロー、承認、およびマイルストンアクションです。アウトバウンドメッセージは、エンドポイントに
対し、特定の項目内のデータを SOAP メッセージとして送信します。アウトバウンドメッセージは、Salesforce
の設定メニューで設定します。その後で、外部エンドポイントを設定する必要があります。SOAP APIを使用
して、メッセージのリスナーを作成できます。
フロート表示
ユーザインターフェースの要素にマウスポインタを停止すると、フロート表示に追加情報が表示されます。
フロート表示によって、マウスを移動したり、フロート表示外部をクリックしたり、または [閉じる] ボタ
ンをクリックしたりすると、フロート表示が閉じられます。
650
用語集
所有者
レコード (取引先責任者またはケースなど) が割り当てられる個別ユーザ。
P
パッケージ
AppExchangeを介して他の組織で使用可能なForce.comのコンポーネントおよびアプリケーションのグループ
です。AppExchangeにまとめてアップロードできるように、パッケージを使用してアプリケーションおよび
関連するコンポーネントをバンドルします。
Partner WSDL
複数の Salesforce 組織にまたがって動作するインテグレーションや AppExchange アプリケーションを構築する
場合に顧客、パートナー、ISV が使用する、弱い型付けの WSDL。この WSDL では、開発者が適切なオブジェ
クト表現でデータのマーシャリングを行います。通常、ここには XML の編集が含まれます。ただし、開発
者は特定のデータモデルまたは Salesforce 組織に依存しません。強い型付けの Enterprise WSDL とは対照的で
す。
選択リスト
Salesforce オブジェクトの特定の項目で選択できる選択肢。たとえば、取引先の [業種] 項目など。ユーザ
は、項目に直接入力せずに、選択リストから 1 つの値を選択できます。「マスタ選択リスト」も参照して
ください。
選択リスト (複数選択)
Salesforce オブジェクトの特定の項目で選択できる選択肢のリストです。複数選択の選択リストを使用して
1 つまたは複数の値を選択できます。ユーザは値をダブルクリックして選択するか、Ctrl キーを押したまま
値をクリックしてスクロールリストから複数の値を選択し、矢印アイコンを使用して選択されたボックス
に値を移動できます。
主キー
リレーショナルデータベースのコンセプトです。リレーショナルデータベースの各テーブルには、データ
値が一意にレコードを識別する項目があります。この項目を、主キーと呼びます。2 つのテーブルのリレー
ションは、あるテーブルの外部キーの値と、別のテーブルの主キーの値が一致することによって成り立ち
ます。
本番組織
実際の本番データとそれらにアクセスするライブユーザを持っている Salesforce 組織です。
Q
キュー
処理する前にアイテムを置いておく領域です。Salesforce では、さまざまな機能やテクノロジーにキューを
使用します。
クエリ文字列パラメータ
通常 URL の「?」文字の後に指定されている名前 - 値のペアです。次に例を示します。
http://na1.salesforce.com/001/e?name=value
651
用語集
R
レコード
Salesforce オブジェクトの単一インスタンス。たとえば、「John Jones」は取引先責任者レコードの名前とな
ります。
レコード名
すべての Salesforce オブジェクトの標準項目です。レコード名が Force.com アプリケーションに表示される
と、値はレコードの詳細ビューへのリンクとして表示されます。レコード名は自由形式のテキストまたは
自動採番項目です。[レコード名] には、必ずしも一意の値を割り当てる必要はありません。
レコードタイプ
レコードタイプとは、そのレコードの標準およびカスタムの選択リスト項目の一部またはすべてを含める
ことができる特定のレコードに使用可能な項目です。レコードタイプをプロファイルに関連付けて、含ま
れている選択リストの値のみがそのプロファイルのユーザに使用できるようにできます。
レコードレベルセキュリティ
データを制御するメソッドで、特定のユーザがオブジェクトを参照および編集でき、ユーザが編集できる
レコードを制限できます。
ごみ箱
削除した情報を表示し、復元できるページです。ごみ箱には、サイドバー内のリンクからアクセスします。
関連オブジェクト
特定のタイプのレコードがコンソールの詳細ビューに表示されている状況で、システム管理者がエージェ
ントコンソールのミニビューへの表示を指定できるオブジェクトです。たとえば、システム管理者は、ケー
スが詳細ビューに表示されているときにミニビューに表示される項目として、関連する取引先、取引先責
任者、納入商品などを指定できます。
リレーション
ページレイアウト内の関連リストおよびレポート内の詳細レベルを作成するために使われる、2 つのオブ
ジェクトの間の接続です。両方のオブジェクトの特定の項目において一致する値を使用して、関連するデー
タにリンクします。たとえば、あるオブジェクトには会社に関連するデータが保存されていて、別のオブ
ジェクトには人に関連するデータが保存されている場合、リレーションを使用すると、その会社で働いて
いる人を検索できます。
リレーションクエリ
SOQL コンテキストで、オブジェクト間のリレーションを辿り、結果を識別および返すクエリです。親対子
および子対親の構文は、SOQL クエリでは異なります。
レポートタイプ
レポートタイプは、主オブジェクトとその関連オブジェクトとの関係に基づいて、レポートで使用するレ
コードと項目のセットを定義するものです。レポートには、レポートタイプで定義された条件を満たすレ
コードのみが表示されます。Salesforceには、定義済みの標準レポートタイプのセットが用意されています。
管理者がカスタムレポートタイプを作成することもできます。
ロール階層
レコードレベルのセキュリティで使用される設定です。ロール階層によって特定のレベルのロールを割り
当てられたユーザは、組織の共有モデルとは関係なく、階層において自分よりも下位のユーザが所有して
いるデータ、および該当のユーザと共有しているデータに対する参照、編集権限を持つことになります。
652
用語集
積み上げ集計項目
主従関係の子レコードの値の集計値を自動的に提供する項目の種別です。
S
SaaS
「サービスとしてのソフトウェア (SaaS)」を参照してください。
Sコントロール
メモ: Sコントロールは、Visualforce ページに置き換えられました。2010 年以降、新しい組織同様、Sコ
ントロールを作成したことのない組織は、Sコントロールを作成できなくなります。既存の Sコント
ロールに影響はありません。今後も編集できます。
カスタムリンクで使用するカスタム Web コンテンツ。カスタム Sコントロールには、Java アプレット、Active-X
コントロール、Excel ファイル、カスタム HTML Web フォームなど、ブラウザに表示できるあらゆる種類のコ
ンテンツを入れることができます。
Salesforce レコード ID
Salesforce の 1 つのレコードを識別する 15 文字または 18 文字の一意の英数字文字列です。
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 組織と直接
統合されるため、ユーザがログインする場合にユーザ名やパスワードは必要ありません。
653
用語集
スニペット
メモ: Sコントロールは、Visualforce ページに置き換えられました。2010 年以降、新しい組織同様、Sコ
ントロールを作成したことのない組織は、Sコントロールを作成できなくなります。既存の Sコント
ロールに影響はありません。引き続き編集できます。
スニペットは、他の Sコントロールに組み込めるよう設計された Sコントロールです。コードの一部で他の
メソッドによって使用されるヘルパーメソッドと同様、スニペットを使用して、複数の Sコントロールで再
利用できる HTML や JavaScript の 1 つのコピーを保持できます。
SOAP (Simple Object Access Protocol)
XML エンコードデータを渡す一定の方法を定義するプロトコル。
サービスとしてのソフトウェア (SaaS)
ソフトウェアアプリケーションがサービスとしてホストされ、顧客にインターネットを経由して提供され
る配信モデルです。SaaS ベンダは、アプリケーションおよび各顧客データの日常メンテナンス、操作およ
びサポートを行う責任があります。このサービスで、顧客が独自のハードウェア、ソフトウェア、そして
関連 IT リソースを使用してアプリケーションをインストール、構成、保守する必要性を緩和します。SaaS
モデルを使用して、あらゆる市場区分にサービスを配信することができます。
SOQL (Salesforce オブジェクトクエリ言語)
Force.com データベースからデータを選択する条件を指定するために使う、単純で強力なクエリ文字列を構
築できるクエリ言語です。
SOSL (Salesforce オブジェクト検索言語)
Force.com API を使用して、テキストベースの検索を実行できるクエリ言語。
標準オブジェクト
Force.com プラットフォームに含まれる組み込みオブジェクトです。アプリケーション独自の情報を格納す
るカスタムオブジェクトを作成することもできます。
システムログ
開発者コンソールの一部。コードスニペットのデバッグに使用できる独立したウィンドウ。ウィンドウの
下部にテストするコードを入力して、[実行] をクリックします。システムログの本文には、実行する行の
長さや、作成されたデータベースコール数などのシステムリソース情報が表示されます。コードが完了し
なかった場合は、コンソールにデバッグ情報が表示されます。
T
Test メソッド
特定のコードが適切に動作しているかを確認する Apex クラスメソッドです。Test メソッドは引数を採用せ
ず、データをデータベースにコミットしません。また、コマンドラインまたは Force.com IDE のような Apex
IDE で runTests() システムメソッドによって実行できます。
トランスレーションワークベンチ
トランスレーションワークベンチを使用して、翻訳する言語を指定し、翻訳者を言語に割り当て、Salesforce
組織に作成したカスタマイズの翻訳を作成し、管理対象パッケージから表示ラベルと翻訳を上書きするこ
とができます。カスタム選択リスト値からカスタム項目にいたるすべてを翻訳し、海外のユーザがSalesforce
のすべてを彼らの言語で使用できるようになりました。
654
用語集
トリガ
データベースの特定の種別のレコードが挿入、更新、または削除される前後で実行する Apex スクリプトで
す。各トリガは、トリガが実行されるレコードへのアクセス権限を提供する一連のコンテキスト変数で実
行し、すべてのトリガは一括モードで実行します。つまり、一度に 1 つずつレコードを処理するのではな
く、複数のレコードを一度に処理します。
トリガコンテキスト変数
トリガおよびトリガが起動するレコードに関する情報へのアクセス権を提供するデフォルトの変数です。
U
V
入力規則
指定される基準に一致しない場合、レコードを保存しない規則です。
Visualforce
開発者が、プラットフォームに作成されたアプリケーションのカスタムページおよびコンポーネントを容
易に定義できる、単純で、タグベースのマークアップ言語。各タグが、ページのセクション、関連リスト、
または項目など、大まかなコンポーネントときめの細かいコンポーネントのどちらにも対応しています。
コンポーネントは、標準の Salesforce ページと同じロジックを使用して制御することができます。また、開
発者が独自のロジックを Apex で記述されたコントローラと関連付けることもできます。
W
Web コントロール
「URL Sコントロール」を参照してください。
Web サービス
様々なプラットフォームで稼動、さまざまな言語で作成、またはお互い地理的に離れている場合であって
も、2 つのアプリケーションがインターネットを経由してデータを容易に交換できるメカニズムです。
WebService メソッド
サードパーティのアプリケーションのマッシュアップなど、外部システムによって使用できる Apex クラス
メソッドまたは変数です。Web サービスメソッドは、グローバルクラスで定義する必要があります。
Web サービス API
Salesforce組織の情報へのアクセスを提供する Web サービスアプリケーションプログラミングインターフェー
ス。「SOAP API」および「Bulk API」も参照してください。
Web タブ
ユーザがアプリケーション内から外部 Web サイトを使用できるカスタムタブです。
ワークフローアクション
ワークフローアクション (メールアラート、項目自動更新、アウトバウンドメッセージ、ToDo など) は、ワー
クフロールールの条件が満たされると起動します。
655
用語集
ワークフローメールアラート
ワークフロールールが起動したときにメールを送信するワークフローアクションです。ワークフロー ToDo
と異なり、アプリケーションユーザにのみ割り当てることができ、ワークフローアラートは有効なメール
アドレスがある限り、ユーザまたは取引先責任者に送信できます。
ワークフロー項目自動更新
ワークフロールールが起動したときに、レコードの特定の項目の値を変更するワークフローアクションで
す。
ワークフローアウトバウンドメッセージ
別のクラウドコンピューティングアプリケーションなど、外部 Web サービスにデータを送信するワークフ
ローアクションです。アウトバウンドメッセージは、主に複合アプリケーションで使用されます。
ワークフローキュー
1つ以上の時間ベースワークフローアクションがあるワークフロールールに基づいて起動するようスケジュー
ルされている、ワークフローアクションのリストです。
ワークフロールール
ワークフロールールは、指定された条件に該当するときに、ワークフローアクションを実行します。ワー
クフローアクションは、ワークフロールールで指定された条件をレコードが満たすとただちに実行するか、
タイムトリガを設定して特定の日に実行するように設定することができます。
ワークフロー ToDo
ワークフロールールが起動したときに ToDo をアプリケーションユーザに割り当てるワークフローアクショ
ン。
WSDL (Web Services Description Language) ファイル
Web サービスと送受信するメッセージの形式を説明する XML ファイルです。開発環境の SOAP クライアント
は、Salesforce Enterprise WSDL または Partner WSDL を使用して、SOAP API で Salesforce と通信します。
X
XML (拡張可能マークアップ言語)
構造化データの共有と移動を可能にするマークアップ言語です。メタデータ API を使用して取得またはリ
リースされるすべての Force.com コンポーネントは、XML 定義に従って表されます。
Y
該当用語はありません。
Z
Zip ファイル
データ圧縮およびアーカイブの形式です。
メタデータ APIによって取得またはリリースされるファイルの集合です。「ローカルプロジェクト」も参照
してください。
656