イントロダクション
dataLoadDataSets REST APIを使用して、HCMデータ・ローダー(HDL)およびHCMスプレッドシート・データ・ローダー(HSDL)の統合を自動化します。
目的
このチュートリアルでは、次のことを行います。
- Oracle WebCenter Contentサーバーにファイルをアップロードする方法を理解します。
- HCMデータ・ローダーおよびHCMスプレッドシート・データ・ローダーを開始します。
- データ・セットおよびビジネス・オブジェクト・ステータスをモニターし、メッセージおよびプロセス情報を取得します。
前提条件
このチュートリアルのステップを完了するには、次のものが必要です:
- HDL REST APIの使用へのアクセス。
- RESTを介してHSDLを開始するステップを完了するには、ロールをORA_PER_JOB HSDLテンプレート、またはHSDLを開始するテンプレートに割り当てる必要があります。
- Base 64エンコーディングでファイルをエンコードする機能。
- PostmanがREST APIコールを発行します。
- RESTを使用して失敗した明細ファイルを生成できるようにするには、エラー・ファイルへのOracle WebCenterコンテンツ・アクセスを有効にする必要もあります。
- 「設定および保守」から、「HCMデータ・ローダー」機能領域を見つけて、「HCMデータ・ローダーの構成」をクリックします。
- 「エラー・ファイルへのOracle WebCenter Contentアクセスの有効化」パラメータを検索し、オーバーライドを「いいえ」以外に設定します。
- 保存して閉じる
HCMデータ・ローダー(HDL)のアクセスおよびHDLセキュリティ・オプションの理解の構成チュートリアルのRESTアクセスのステップに従って、タスク2を完了するためにRESTサービスを使用したHCMデータ・ローダー・データ・セットの作成権限へのアクセス権を付与します。
「HCMスプレッドシート・データ・ローダーを実行するためのアクセス権の付与」チュートリアルの「ロールのデータ・セット・アクセス権の割当て」ステップに従います。
このチュートリアルの例では、Postman変数を使用して、環境および変化するその他の値を参照します。
| 可変 | 説明 |
|---|---|
| {{env}} | 環境パス。 |
| {{user}} | ユーザー名 |
| {{RequestId}} | データ・セットを一意に識別するために使用される値。 |
| {{DataSetBusObjId}} | データ・セット内のビジネス・オブジェクト・レコードを一意に識別するために使用される値。 |
| {{ProcessId}} | データ・セットに対して送信されたプロセスを一意に識別するために使用される値。 |
ノート:
RESTコールの本文で変更する必要があるその他の値は青で表示されます。たとえば、<file_name>です。
タスク1: Oracle WebCenter Content Serverへのデータ・ファイルのアップロード
Oracle WebCenter Contentサーバーにファイルをアップロードする方法は複数あります。このタスクには、HCMデータ・ローダーdataLoadDataSetsリソースで使用可能なuploadFileカスタム・アクションとOracle WebCenter RESTリソースの2つの異なるRESTオプションがあります。
次のステップを完了する場合は、次のファイルをダウンロードして使用できます。
- HCMデータ・ローダーの新規等級およびJobs.zip。
- HCMスプレッドシート・データ・ローダーの場合はJobs.csv。
HCMデータ・ローダーuploadFile処理
- Postmanを開き、次のURLに対して新しいPOSTリクエストを作成します。
- 次のJSON本文を指定します:
- リクエストの「認可」を構成します。ユーザーには、「人材管理ファイル・ベースのインポート用のデータのアップロード」ロール階層が必要です。
- Content-Typeヘッダーを値に設定します。
application/vnd.oracle.adf.action+json
- 「送信」をクリックします。
- レスポンスをレビューし、コンテンツIDをノートにとります。HDLおよびHSDLの開始時にファイルを識別する必要があります。
- Base64は、Jobs.csvファイルをエンコードし、次のステップを使用してcsvファイルをアップロードします。
https://{{env}}/hcmRestApi/resources/11.13.18.05/dataLoadDataSets/action/uploadFile
{
"content" : "UEsDBBQAAAAIAJF+Qle0P8ZqHgEAAAQFAAAJAAAAR3JhZGUuZGF0ldPNaoQwEAfw+4LvsG+wmhhKDz2ERGyg2S269LqkGovQKqRxT3n4xu6Hxj3IQECZTH4h/BmZHSmnR+pyo2rtsqbRlW3PurTKWK7srJR19Vi4dLLed5fa+u+1slc/2tHbYTv8urIfTKUL3cRx8vLfsx3bo43Mijy73pg8k2QXj8ulTwna+YUT98rfTnnBT9KX2UHKw95J1akvbbaJo/NtmIaWGgo0BNPwUsOBhmFautTSQEthGllqJNBItIF4gt1zEF3dntt6UN8+zc6a9nOw/SWWqRsUi2BoBUcBDkpJMLyC4wAHhSZYuoKnAQ7KUDCygpMAB0bKp9HirdHVMkQOmy0eowcOzTnYcPEYB9w9qGkf9tyP95vn/+isHG3+AFBLAwQUAAAACAAbSlJXX/ch5FMCAAC9CgAABwAAAEpvYi5kYXTNldFumzAYhe8r9R14g5Fut7uwwElYY0LBq7SryCNOZI1AZUy1SH74GQdDnJCY9mpSpIjkP+ezzzGAIAYhwED+qH5LuNvRXLB3mgnCRUgElRkVQbWl7d/6OyYHfTEnB1Yc9U/ASERTy3lTFIkSY6bmUrpvCsIxPbxVnPCjFjalmq9KLUWkJHvKV/SdFjKrGp7TlO58f/ZdTXrtyOMDgukC6uU9+b7/xZ+pjwzWCK1juQxXmwysYLYJ1nHWXnoZKWitpGXdFIKUwhuGJJDzn6vVBkcIylTKC/kEVJxe4WjJKn5FdUEto/8ZrGfRIj3LtivNJmGFQCAGCzmzhVMZYXTOCBlXJ7HiN7dzYj3ZBm4WSp/xkCEi/A8VrNxfBohA+gxxFC9GQ+xN3Lw2b5vZ9fZJtOXnxutR096APG/wFu+8TGMzEWiqHIBWnfeJT5aPm5ik61CtDcVYMxNebZtcdFs80C5VM4VHUx083Ly2gQtmV+mn0LadGz/M9r1ec62Cb/DhwqrY9v3QOkzdI+uwb+P27F7ncF677epexWuiya8spwpPa7Y1qd+Ffe3EbgDsCPAvzZv2Nfdh1jfj44a9BBsMMwxPcb40pGDi2D4fBK8KD9NaqEpHT1GvnAQxB+eSYE6NBAG++Sw46d2cCG9AiCJ94UXYA9sDK1ktOGnPw+gujMRtvlRvsQQG2nuZetkbzZnaSy3GjbvxSb7DopXxhEUbySRzc6so6/7WuOU66QZIwK8hiYQcVY2FMw4jmmY/BGL8J6TSC6cx+kdIR7gfTqd4fPgHUEsBAhQAFAAAAAgAkX5CV7Q/xmoeAQAABAUAAAkAJAAAAAAAAAAgAAAAAAAAAEdyYWRlLmRhdAoAIAAAAAAAAQAYANn4TRNA9dkBAAAAAAAAAAAAAAAAAAAAAFBLAQIUABQAAAAIABtKUldf9yHkUwIAAL0KAAAHACQAAAAAAAEAIAAAAEUBAABKb2IuZGF0CgAgAAAAAAABABgAjuYejz/12QEAAAAAAAAAAAAAAAAAAAAAUEsFBgAAAAACAAIAtAAAAL0DAAAAAA==",
"fileName" : "Grades and Jobs.zip"
}
ノート:
contentの値は、New GradesおよびJobs.zipファイルのBase64エンコード・バージョンです。コンテンツおよびfileNameパラメータは必須です。uploadFileカスタム・アクションでは、次のパラメータを使用できます。
| パラメータ | 説明 |
|---|---|
| コンテンツ | ロードするBase64エンコード・ファイル。 |
| fileName | ファイルの名前。 |
| Content-ID | Oracle WebCenterコンテンツ・サーバー上のファイルの一意の識別子。指定しない場合、自動的に生成されます。 |
レスポンスの形式は次のとおりです。
{
"result": {
"Status": "SUCCESS",
"ContentId": "UCMFA00078879"
}
}
Oracle WebCenter REST
Oracle WebCenter RESTリソースの利点は、最初にファイルをエンコードする必要がないため、このRESTサービスはより大きなソース・ファイルをロードできることです。ただし、使用するのは少し複雑です。
HCMデータ・ローダーのuploadFile処理は、Oracle WebCenterのHCMデータ・ローダー・インポート・アカウントにのみファイルをアップロードします。このAPIを使用すると、ユーザーがアクセスできるOracle WebCenterアカウントにアップロードできます。
要求の作成
- Postmanを開き、次のURLに対して新しいPOSTリクエストを作成します。
- 本文に次のform-dataを指定します。
- primaryFileキーにマウス・ポインタを重ねて「テキスト/ファイル」選択リストを表示し、値を「ファイル」に設定します。
- リクエストの「認可」を構成します。ユーザーには、「人材管理ファイル・ベースのインポート用のデータのアップロード」ロール階層が必要です。
- 要求を保存します。これでファイルをアップロードできます。
https://{{env}}/documents/files/data
| ヒント | Value |
|---|---|
| metadataValues | {
"dDocAuthor":"{{user}}",
"dDocTitle":"<file_name>",
"dSecurityGroup":"FAFusionImportExport",
"dDocAccount":"hcm$/dataloader$/import$",
"dDocType":"Document"
}
ノート: <file_name>を自分のファイル名に置き換えます。 |
| primaryFile |
ファイルのアップロード
このステップでは、前述の手順で作成したリクエストを使用して、zipおよびcsvファイルをOracle WebCenter Contentサーバーにアップロードします。
- リクエストの本文のフォーム・データで、「ファイルの選択」
ヒント :
「ファイルの選択」ボタンは、primaryFile選択リストが「ファイル」に設定されている場合にのみ使用できます。 - ファイル・ブラウザを使用して、ファイルを検索および選択します。
- metadataValuesキーdDocTitle値を編集して、ファイルの名前を指定します。
ヒント :
HCMデータ・ローダーを開始すると、データ・セット名がここで指定した値にデフォルト設定されます。 - 「送信」をクリックします。
- レスポンスをレビューし、コンテンツIDをノートにとります。HDLおよびHSDLの開始時にファイルを識別する必要があります。
- csvファイルに対して「ファイルのアップロード」ステップを繰り返します。
レスポンスの形式は次のとおりです。
{
"dWebExtension": "zip",
"dRevClassID": "213206",
"createdBy": "VISION_INTEGRATION",
"modifiedBy": "VISION_INTEGRATION",
"XFND_RANDOM": "4641327459804635554",
"dReleaseState": "N",
"dPublishState": "",
"dID": "213551",
"xComments": "",
"errorCode": "0",
"title": "Grades and Jobs.zip",
"size": "1125",
"createdTime": "10/3/23 7:27 AM",
"dDocName": "UCMFA00213206",
"mimeType": "application/zip",
"dRevRank": "0",
"dDocID": "426034",
"name": "New Grades and Jobs.zip",
"dDocAccount": "hcm$/dataloader$/import$",
"ownedBy": "VISION_INTEGRATION",
"xStorageRule": "FusionStorageRule",
"dStatus": "DONE",
"modifiedTime": "10/3/23 7:27 AM",
"XFND_SIGNATURE": "Y-Qs7rQwyYANlmfo-....",
"errorKey": "!csServiceStatusMessage_checkin,UCMFA00213206",
"dExtension": "zip",
"dWorkflowState": "",
"XFND_SCHEME_ID": "1",
"XFND_CERT_FP": "901B32887DDC81F780757624",
"dPublishType": "",
"dUser": "VISION_INTEGRATION",
"dSecurityGroup": "FAFusionImportExport",
"errorMessage": "Successfully checked in content item 'UCMFA00213206'.",
"dRevisionID": "1",
"version": "1"
}
ノート:
Oracle WebCenter Content REST APIは、dDocNameラベルを使用してコンテンツIDを返します。タスク2: バルク・データ・ロードの開始
HCMデータ・ローダーを使用したデータのアップロード
このステップでは、createFileDataSetカスタム・アクションをコールしてHDLを開始し、Oracle WebCenter Contentサーバーのhcm$/dataloader$/import$アカウントに以前にロードされたファイルを処理します。
- Postmanで、このURLに対する新しいPOSTリクエストを作成します。
- 次のJSON本文を指定します:
- リクエストの「認可」を構成します。ユーザーには、「RESTサービスの使用- データ・ロード・データ・セット」ロール階層が必要です。
- Content-Typeヘッダーを値に設定します。
application/vnd.oracle.adf.action+json
- 「送信」をクリックします。
https://{{env}}/hcmRestApi/resources/11.13.18.05/dataLoadDataSets/action/createFileDataSet
ノート:
この要求を発行するには、「RESTサービスを使用したHCMデータ・ローダー・データ・セットの作成」機能セキュリティ権限が必要です。{
"contentId" : "<content_id>"
}
ヒント :
<content_id>値をファイルのコンテンツIDに置き換えます。必須パラメータは、contentIdのみです。createFileDataSetカスタム・アクションでは、次のパラメータを使用できます。
| パラメータ | 説明 | デフォルト値を提供するHCMデータ・ローダー・パラメータの構成 |
|---|---|---|
| Content-ID | Oracle WebCenterコンテンツ・サーバー上のファイルの一意の識別子。 | |
| fileAction | 有効な値は、IMPORT_AND_LOADおよびIMPORT_ONLYです。 | ファイル・アクション |
| dataSetName | データ・セットの名前。デフォルトは、ファイルのドキュメント・タイトルです。 | |
| importConcurrentThreads | インポート・プロセスに割り当てるコンカレント・スレッドの最大数。 | インポートの最大コンカレント・スレッド |
| loadConcurrentThreads | ロード・プロセスに割り当てるコンカレント・スレッドの最大数。 | ロードの最大コンカレント・スレッド |
| importMaxErrorPercentage | インポートが停止するまでのエラー・レコードの最大割合。 | インポート・エラーの最大パーセンテージ |
| loadMaxErrorPercentage | ロードが停止するまでのエラー・レコードの最大割合。 | ロード・エラーの最大パーセンテージ |
| fileEncryption | ソース・ファイルに使用される暗号化。
NONE、PGPUNSIGNEDまたはPGPSIGNEDを指定します。 ヒント : Oracle WebCenterにアップロードする前に、ファイルを暗号化することをお薦めします。HCMデータ・ローダー・インポート・アカウントには、多くの場合、様々なユーザーがアクセスします。これらのアカウントはすべて、暗号化されていないファイルのコンテンツをダウンロードして確認できます。 |
ファイルの暗号化 |
| verificationKey | ソース・ファイルの暗号化に使用される検証キー。fileEncryptionがPGPSIGNEDの場合に指定します。 | |
| deleteSourceFile | データがステージング表にインポートされた後にソース・ファイルを削除するかどうかを示します。 | ソース・ファイルを削除 |
ノート:
表の最後の列では、各REST APIパラメータのデフォルトを定義する「HCMデータ・ローダーの構成」タスクのパラメータ名を指定します。レスポンスの形式は次のとおりです。
{
"result": {
"Status": "SUCCESS",
"RequestId": "107468"
}
}
ノート:
レスポンスのRequestIdは、dataLoadDataSetsリソースを使用してデータ・セット情報を取得するために使用されます。HCMスプレッドシート・データ・ローダーを使用したデータのアップロード
このステップでは、createSpreadsheetDataSetカスタム・アクションをコールしてHSDLを開始し、Oracle WebCenter Contentサーバーのhcm$/dataloader$/import$アカウントに以前にロードされたファイルを処理します。
ファイルのアップロードに使用するHSDLテンプレートのファイルは、ファイル形式にする必要があります。
- Postmanで、このURLに対する新しいPOSTリクエストを作成します。
- 次のJSON本文を指定します:
- リクエストの「認可」を構成します。ユーザーには、「RESTサービスの使用- データ・ロード・データ・セット」ロール階層が必要です。
- Content-Typeヘッダーを値に設定します。
application/vnd.oracle.adf.action+json
- 「送信」をクリックします。 レスポンスの形式は次のとおりです。
https://{{env}}/hcmRestApi/resources/11.13.18.05/dataLoadDataSets/action/createSpreadsheetDataSet
{
"contentId" : "<content_id>",
"templateCode" : "ORA_PER_JOB"
}
ヒント :
<content_id>値をファイルのコンテンツIDに置き換えます。ヒント :
ORA_PER_JOBテンプレートは、ジョブのロードに使用できる事前構成済テンプレートです。テンプレート・コードは、「スプレッドシート・データ・ローダーの実行」タスクを使用して検索できます。必須パラメータは、contentIdおよびtemplateCodeのみです。createSpreadsheetDataSetカスタム・アクションでは、次のパラメータを使用できます。
| パラメータ | 説明 | デフォルト値を提供するHCMデータ・ローダー・パラメータの構成 |
|---|---|---|
| Content-ID | Oracle WebCenterコンテンツ・サーバー上のファイルの一意の識別子。 | |
| templateCode | ファイルをアップロードするスプレッドシート・テンプレート・コード。 | |
| fileAction | 有効な値は、IMPORT_AND_LOADおよびIMPORT_ONLYです。
ヒント : インポートするファイルのみの場合、RESTでモニターまたはロードすることはできません。かわりに、テンプレート用のスプレッドシートを生成し、データ・セットをフェッチしてスプレッドシートからアップロードします。 |
"IMPORT_AND_LOAD" |
| dataSetName | データ・セットの名前。 | デフォルトは、テンプレート・コードおよびタイムスタンプです。 |
| importConcurrentThreads | インポート・プロセスに割り当てるコンカレント・スレッドの最大数。 | インポートの最大コンカレント・スレッド |
| loadConcurrentThreads | ロード・プロセスに割り当てるコンカレント・スレッドの最大数。 | ロードの最大コンカレント・スレッド |
| importMaxErrorPercentage | インポートが停止するまでのエラー・レコードの最大割合。 | インポート・エラーの最大パーセンテージ |
| loadMaxErrorPercentage | ロードが停止するまでのエラー・レコードの最大割合。 | ロード・エラーの最大パーセンテージ |
| fileEncryption | ソース・ファイルに使用される暗号化。
NONE、PGPUNSIGNEDまたはPGPSIGNEDを指定します。 ヒント : Oracle WebCenterにアップロードする前に、ファイルを暗号化することをお薦めします。HCMデータ・ローダー・インポート・アカウントには、多くの場合、様々なユーザーがアクセスします。これらのアカウントはすべて、暗号化されていないファイルのコンテンツをダウンロードして確認できます。 |
ファイルの暗号化 |
| verificationKey | ソース・ファイルの暗号化に使用される検証キー。fileEncryptionがPGPSIGNEDの場合に指定します。 | |
| deleteSourceFile | データがステージング表にインポートされた後にソース・ファイルを削除するかどうかを示します。 | ソース・ファイルを削除 |
| headerIncludedFlag | ファイルに含まれる属性に名前を付けるために、ヘッダーがソース・ファイルに含まれているかどうかを示します。 | "Y" |
| attributeDelimiter | ファイル内の値を区切るために使用される文字。 | "、" (カンマ)。 |
| newLineIndicator | 新しい行を示すために使用される文字。 | 先頭にエスケープ文字が付いた「n」。 |
| escapeIndicator | 属性値内のデリミタ文字をエスケープするために使用される文字。 | "/" (バックスラッシュ)) |
| dateFormat | 日付データ型の属性に使用される日付書式 | デフォルト書式はYYYY/MM/DDです。 |
{
"result": {
"Status": "SUCCESS",
"RequestId": "107483",
"UserInfo": "",
"Review": "https://{env}/hcmUI/oracle/apps/hcm/enterpriseSetup/hdlSpreadsheetLoader/di/GenericHdlSpreadsheet.xlsx?layoutCode=ORA_PER_JOB&dataSetName="Job#2024-08-06 11:40:56"",
"FileAction": "IMPORT_AND_LOAD",
"DataSetName": ""Job#2024-08-06 11:40:56""
}
}
ノート:
レスポンスのRequestIdを使用して、dataLoadDataSetsリソースを使用してデータ・セットのステータスを監視します。ヒント :
「レビュー」リンクを使用して、HSDLテンプレートからスプレッドシートを生成し、データ・セットをレビューします。タスク3: データ・セット・ステータスのモニター
このステップでは、dataLoadDataSetsリソースを使用してデータ・セット・ステータスをモニターします。このリソースは、HDLデータセットとHSDLデータセットの両方を監視するために使用できます。
ヒント :
インポート済のみのHSDLファイルは、HCMデータ・ローダー・ステージング表にデータ・セットを作成せず、RESTを使用してモニターできません。特定のデータ・セットのモニター
- Postmanで、このURLに対する新しいGETリクエストを作成します:
- リクエストの「認可」を構成し、「送信」をクリックします。
- csvファイルに対して繰り返すと、応答によってスプレッドシート関連要素の情報が返されます。
https://{{env}}/hcmRestApi/resources/11.13.18.05/dataLoadDataSets/{{RequestId}}
ノート:
{{RequestId}}を、ファイルの送信時に返されたRequestId値に置き換えます。レスポンスの形式は次のとおりです。
{
"RequestId": 107468,
"DataSetId": 300100621962415,
"ContentId": "UCMFA00103266",
"DataSetName": "Grades and Jobs.zip",
"DataSetStatusCode": "ORA_IN_ERROR",
"DataSetStatusMeaning": "Error",
"TransferStatusCode": "SUCCESS",
"TransferStatusMeaning": "Success",
"ImportStatusCode": "SUCCESS",
"ImportStatusMeaning": "Success",
"LoadStatusCode": "ERROR",
"LoadStatusMeaning": "Error",
"SourceTypeCode": "ZIP_DAT_FILE",
"SourceTypeMeaning": "Compressed DAT file",
"IntegrationTypeCode": null,
"IntegrationTypeMeaning": null,
"ImportPercentageComplete": 100,
"LoadPercentageComplete": 100,
"ImportSuccessPercentage": 100,
"LoadSuccessPercentage": 59,
"FileLineTotalCount": 38,
"FileLineImportErrorCount": 0,
"FileLineImportSuccessCount": 38,
"ObjectTotalCount": 37,
"ObjectLoadErrorCount": 15,
"ObjectRollbackErrorCount": 0,
"ObjectSuccessCount": 22,
"ObjectUnprocessedCount": 0,
"SpreadsheetTemplateCode": null,
"SpreadsheetTemplateName": null,
"SpreadsheetTemplateUserTypeCode": null,
"SpreadsheetTemplateUserTypeMeaning": null,
"SpreadsheetMessage": null,
"FileSize": 1175,
"CreatedBy": "HCM_USER10",
"CreationDate": "2024-08-06T11:38:28+00:00",
"LastUpdatedBy": "HCM_USER10",
"LastUpdateDate": "2024-08-06T11:40:04.127+00:00",
"ProtectedFlag": false,
"Review": null,
"FailedLinesFileContentId": null,
"FailedLinesFileEncryptionType": null,
"FailedLinesFileEncryptionKey": null,
"links": [
...
]
}
エラーのデータ・セットの識別
次のURLを使用して、エラーのすべてのデータ・セットの要約情報を取得します。
https://{{env}}/hcmRestApi/resources/11.13.18.05/dataLoadDataSets?q=DataSetStatusCode=ORA_IN_ERROR&fields=RequestId,DataSetName,DataSetStatusCode,ImportStatusCode,LoadStatusCode,SourceTypeCode,FileLineTotalCount,FileLineImportErrorCount,ObjectTotalCount,ObjectLoadErrorCount,LastUpdateDate&onlyData=true
レスポンスの形式は次のとおりです。
{
"items": [
{
"RequestId": 107483,
"DataSetName": "Job#2024-08-06 11:40:56",
"DataSetStatusCode": "ORA_IN_ERROR",
"ImportStatusCode": "SUCCESS",
"LoadStatusCode": "ERROR",
"SourceTypeCode": "SPREADSHEET",
"FileLineTotalCount": 6,
"FileLineImportErrorCount": 0,
"ObjectTotalCount": 6,
"ObjectLoadErrorCount": 2,
"LastUpdateDate": "2024-08-06T11:42:13.333+00:00"
},
{
"RequestId": 107468,
"DataSetName": "Grades and Jobs.zip",
"DataSetStatusCode": "ORA_IN_ERROR",
"ImportStatusCode": "SUCCESS",
"LoadStatusCode": "ERROR",
"SourceTypeCode": "ZIP_DAT_FILE",
"FileLineTotalCount": 38,
"FileLineImportErrorCount": 0,
"ObjectTotalCount": 37,
"ObjectLoadErrorCount": 15,
"LastUpdateDate": "2024-08-06T11:40:04.127+00:00"
},...
特定のHSDLテンプレートのデータ・セットのモニター
次のURLを使用して、特定のスプレッドシート・テンプレートでロードされたすべてのデータ・セットの要約情報を取得します。
https://{{env}}/hcmRestApi/resources/11.13.18.05/dataLoadDataSets?q=SpreadsheetTemplateCode=ORA_PER_JOB&fields=RequestId,DataSetName,ImportStatusCode,LoadStatusCode,SourceTypeCode,ObjectTotalCount,ObjectLoadErrorCount,Review&onlyData=true
レスポンスの形式は次のとおりです。
{
"items": [
{
"RequestId": 107483,
"DataSetName": "Job#2024-08-06 11:40:56",
"ImportStatusCode": "SUCCESS",
"LoadStatusCode": "ERROR",
"SourceTypeCode": "SPREADSHEET",
"ObjectTotalCount": 6,
"ObjectLoadErrorCount": 2,
"Review": "https://cptapniqy.fusionapps.ocs.oc-test.com:443/hcmUI/oracle/apps/hcm/enterpriseSetup/hdlSpreadsheetLoader/di/GenericHdlSpreadsheet.xlsx?layoutCode=ORA_PER_JOB&dataSetName=Job#2024-08-06 11:40:56"
}
],
"count": 1,
"hasMore": false,
"limit": 25,
"offset": 0,
"links": [
...
タスク4: ビジネス・オブジェクト・ステータスのモニター
HDLデータ・セットに複数のビジネス・オブジェクト・ファイルがある場合、個々のビジネス・オブジェクトのステータスをモニターできます。
データ・セット内のすべてのビジネス・オブジェクトのレビュー
- Postmanで、このURLに対する新しいGETリクエストを作成します:
- リクエストの「認可」を構成し、「送信」をクリックします。
https://{{env}}/hcmRestApi/resources/11.13.18.05/dataLoadDataSets/{{RequestId}}/child/businessObjects?onlyData=true
ノート:
{{RequestId}}を、ファイルの送信時に返されたRequestId値に置き換えます。レスポンスの形式は次のとおりです。
{
"items": [
{
"DataSetBusObjId": 300100621962438,
"BusinessObjectDiscriminator": "Grade",
"BusinessObjectName": "Grade",
"DatFileName": "Grade.dat",
"LoadOrder": 1,
"BusinessObjectId": 300100028324439,
"TransferStatusCode": "SUCCESS",
"TransferStatusMeaning": "Success",
"ImportStatusCode": "SUCCESS",
"ImportStatusMeaning": "Success",
"LoadStatusCode": "SUCCESS",
"LoadStatusMeaning": "Success",
"ImportPercentageComplete": 100,
"LoadPercentageComplete": 100,
"ImportSuccessPercentage": 100,
"LoadSuccessPercentage": 100,
"FileLineTotalCount": 14,
"FileLineImportErrorCount": 0,
"FileLineImportSuccessCount": 14,
"ObjectTotalCount": 14,
"ObjectLoadErrorCount": 0,
"ObjectRollbackErrorCount": 0,
"ObjectSuccessCount": 14,
"ObjectUnprocessedCount": 0,
"DataSetId": 300100621962415,
"RequestId": 107468,
"CreatedBy": "HCM_USER10",
"CreationDate": "2024-08-06T11:38:29+00:00",
"LastUpdateDate": "2024-08-06T11:39:24.490+00:00",
"LastUpdatedBy": "FUSION_APPS_HCM_ESS_LOADER_APPID",
"RollbackEnabledFlag": false,
"FailedLinesFileContentId": null,
"FailedLinesFileEncryptionType": null,
"FailedLinesFileEncryptionKey": null
},
{
"DataSetBusObjId": 300100621962439,
"BusinessObjectDiscriminator": "Job",
"BusinessObjectName": "Job",
"DatFileName": "Job.dat",
"LoadOrder": 2,
"BusinessObjectId": 300100028327309,
"TransferStatusCode": "SUCCESS",
"TransferStatusMeaning": "Success",
"ImportStatusCode": "SUCCESS",
"ImportStatusMeaning": "Success",
"LoadStatusCode": "ERROR",
"LoadStatusMeaning": "Error",
"ImportPercentageComplete": 100,
"LoadPercentageComplete": 100,
"ImportSuccessPercentage": 100,
"LoadSuccessPercentage": 34,
"FileLineTotalCount": 24,
"FileLineImportErrorCount": 0,
"FileLineImportSuccessCount": 24,
"ObjectTotalCount": 23,
"ObjectLoadErrorCount": 15,
"ObjectRollbackErrorCount": 0,
"ObjectSuccessCount": 8,
"ObjectUnprocessedCount": 0,
"DataSetId": 300100621962415,
"RequestId": 107468,
"CreatedBy": "HCM_USER10",
"CreationDate": "2024-08-06T11:38:29.004+00:00",
"LastUpdateDate": "2024-08-06T11:39:58.914+00:00",
"LastUpdatedBy": "FUSION_APPS_HCM_ESS_LOADER_APPID",
"RollbackEnabledFlag": false,
"FailedLinesFileContentId": null,
"FailedLinesFileEncryptionType": null,
"FailedLinesFileEncryptionKey": null
}
],
"count": 2,
"hasMore": false,
"limit": 25,
"offset": 0,
"links": [
...
データ・セット内の特定のビジネス・オブジェクトのモニター
- Postmanで、このURLに対する新しいGETリクエストを作成します:
- リクエストの「認可」を構成し、「送信」をクリックします。
https://{{env}}/hcmRestApi/resources/11.13.18.05/dataLoadDataSets/{{RequestId}}/child/businessObjects/{{DataSetBusObjId}}?onlyData=true&fields=DataSetBusObjId,BusinessObjectName,LoadOrder,TransferStatusCode,ImportStatusCode,LoadStatusCode,ImportSuccessPercentage,LoadSuccessPercentage,FileLineTotalCount,FileLineImportErrorCount,ObjectTotalCount,ObjectSuccessCount,ObjectLoadErrorCount
ノート:
ファイルの送信時に返されたRequestId値に{{RequestId}}を、取得するビジネス・オブジェクト・レコードの{{DataSetBusObjId}}にDataSetBusObjIdを置き換えます。レスポンスの形式は次のとおりです。
{
"DataSetBusObjId": 300100621962439,
"BusinessObjectName": "Job",
"LoadOrder": 2,
"TransferStatusCode": "SUCCESS",
"ImportStatusCode": "SUCCESS",
"LoadStatusCode": "ERROR",
"ImportSuccessPercentage": 100,
"LoadSuccessPercentage": 34,
"FileLineTotalCount": 24,
"FileLineImportErrorCount": 0,
"ObjectTotalCount": 23,
"ObjectSuccessCount": 8,
"ObjectLoadErrorCount": 15
}
エラーのビジネス・オブジェクトの識別
- このURLを使用して、ロード中にエラーが発生したデータ・セット内のすべてのビジネス・オブジェクトのサマリー情報を取得します。
- リクエストの「認可」を構成し、「送信」をクリックします。
https://{{env}}/hcmRestApi/resources/11.13.18.05/dataLoadDataSets/{{RequestId}}/child/businessObjects?q=LoadStatusCode=ERROR&fields=DataSetBusObjId,LoadOrder,BusinessObjectName,TransferStatusCode,ImportStatusCode,LoadStatusCode,FileLineTotalCount,FileLineImportErrorCount,ObjectTotalCount,ObjectLoadErrorCount&onlyData=true
レスポンスの形式は次のとおりです。
{
"items": [
{
"DataSetBusObjId": 300100621962439,
"LoadOrder": 2,
"BusinessObjectName": "Job",
"TransferStatusCode": "SUCCESS",
"ImportStatusCode": "SUCCESS",
"LoadStatusCode": "ERROR",
"FileLineTotalCount": 24,
"FileLineImportErrorCount": 0,
"ObjectTotalCount": 23,
"ObjectLoadErrorCount": 15
}
]...
タスク5: メッセージの取得
データ・セットにエラーがある場合は、そのデータ・セットに対して発生したメッセージと、各メッセージがレポートされるレコードの識別子を取得できます。
データ・セットのすべてのメッセージの取得
- Postmanで、このURLに対する新しいGETリクエストを作成します:
- リクエストの「認可」を構成し、「送信」をクリックします。
https://{{env}}/hcmRestApi/resources/11.13.18.05/dataLoadDataSets/{{RequestId}}/child/messages?totalResults=true&orderBy=DatFileName,FileLine&fields=DatFileName,BusinessObjectDiscriminator,OriginatingProcessCode,FileLine,ConcatenatedUserKey,SourceSystemOwner,SourceSystemId,SourceReference001,MessageTypeCode,MessageText,MessageUserDetails&onlyData=true
ノート:
{{RequestId}}を、ファイルの送信時に返されたRequestId値に置き換えます。レスポンスの形式は次のとおりです。
{
"items": [
{
"DatFileName": "Job.dat",
"BusinessObjectDiscriminator": "Job",
"OriginatingProcessCode": "LOAD",
"FileLine": 4,
"ConcatenatedUserKey": "HDL_SNR_SALES_CONS-COMMON",
"SourceSystemOwner": null,
"SourceSystemId": null,
"SourceReference001": "HDL_SNR_SALES_CONS",
"MessageTypeCode": "ERROR",
"MessageText": "You need to enter a valid value for the JobFamilyId attribute. The current values are HDL_SALES.",
"MessageUserDetails": null
},
{
"DatFileName": "Job.dat",
"BusinessObjectDiscriminator": "Job",
"OriginatingProcessCode": "LOAD",
"FileLine": 10,
"ConcatenatedUserKey": "HDL_MRKT_DIR-COMMON",
"SourceSystemOwner": null,
"SourceSystemId": null,
"SourceReference001": "HDL_MRKT_DIR",
"MessageTypeCode": "ERROR",
"MessageText": "You need to enter a valid value for the JobFamilyId attribute. The current values are HDL_MARKETING.",
"MessageUserDetails": null
},
{
"DatFileName": "Job.dat",
"BusinessObjectDiscriminator": "Job",
"OriginatingProcessCode": "LOAD",
"FileLine": 5,
"ConcatenatedUserKey": "HDL_SALES_MGR-COMMON",
"SourceSystemOwner": null,
"SourceSystemId": null,
"SourceReference001": "HDL_SALES_MGR",
"MessageTypeCode": "ERROR",
"MessageText": "The FT value for the FullPartTime attribute is invalid and doesn't exist in the list of values.",
"MessageUserDetails": null
},
...
タスク6: 失敗した明細ファイルの生成
メッセージ情報の直接抽出に加えて、失敗した行ファイルの生成を開始できます。これらのファイルには、エラーのあるすべてのデータ行が含まれ、オプションでメッセージ・テキストが含まれます。
ヒント :
生成された失敗した行ファイルは、Oracle WebCenterのhcm$/dataloader$/export$アカウントからダウンロードできます。データ・セットの失敗した明細ファイルの生成
- Postmanで、このURLに対する新しいPOSTリクエストを作成します。
- 次のJSON本文を指定します:
- Content-Typeヘッダーを値に設定します。
application/vnd.oracle.adf.action+json
- リクエストの「認可」を構成し、「送信」をクリックします。 レスポンスの形式は次のとおりです。
- 次のGET URLを使用して、dataLoadDataSetsリソースからファイル詳細を取得します:
https://{{env}}/hcmRestApi/resources/11.13.18.05/dataLoadDataSets/{{RequestId}}?onlyData=true&fields=FailedLinesFileContentId,FailedLinesFileEncryptionType,FailedLinesFileEncryptionKeyレスポンスは次のようになります。ノート:
{{RequestId}}を、ファイルの送信時に返されたRequestId値に置き換えます。{ "FailedLinesFileContentId": "107468_ERRFILE", "FailedLinesFileEncryptionType": "PGPUNSIGNED", "FailedLinesFileEncryptionKey": "customer-key" }
https://{{env}}/hcmRestApi/resources/11.13.18.05/dataLoadDataSets/{{RequestId}}/action/generateFailedLinesFile
ノート:
{{RequestId}}を、ファイルの送信時に返されたRequestId値に置き換えます。{
"includeMessagesFlag" : "Y",
"messageLanguage" : "US",
"fileEncryption" : "PGPUNSIGNED",
"encryptionKey" : "<customer-key>"
}
ヒント :
<customer-key>を、ファイルの暗号化に使用するPGP証明書の名前に置き換えます。セキュリティ・コンソールの「証明書」ページで指定した名前を指定します。
このカスタムアクションには、次のパラメータを使用できます。
| パラメータ | 説明 | デフォルト値 | 必須 |
|---|---|---|---|
| includeMessagesFlag | 警告メッセージおよびエラー・メッセージをファイルに含めるかどうかを決定します。YまたはNを指定します。 | "N" | |
| messageLanguage | メッセージを提供する言語を識別する2文字のコード。 | "米国" | |
| fileEncryption | 生成されたファイルを暗号化する暗号化のタイプ。 有効な値はPGPUNSIGNED、PGPSIGNEDおよびNONEです。 |
必要時ファイルを暗号化しない場合は、NONEを指定する必要があります。 | |
| encryptionKey | 生成されたファイルを暗号化するためのPGP証明書。これは、セキュリティ・コンソールのPGP証明書のリストで使用可能である必要があります。HDLは、秘密キーを使用して復号化するための公開キーを使用してファイルを暗号化します。 | fileEncryptionがPGPUNSIGNEDまたはPGPSIGNEDの場合。 |
{
"result": {
"Status": "SUCCESS",
"RequestId": "107640",
"ErrorFileContentID": "107468_ERRFILE",
"UserInfo": "The file will be available on the Oracle WebCenter on completion of this process."
}
}
ビジネス・オブジェクトの失敗した明細ファイルの生成
generateFailedLinesFileカスタム・アクションは、子businessObjectsリソースでも使用できます。データ・セット・レベルのカスタム・アクションと同じパラメータがあります。
- Postmanで、このURLに対する新しいPOSTリクエストを作成します。
- 次のJSON本文を指定します:
- Content-Typeヘッダーを値に設定します。
application/vnd.oracle.adf.action+json
- リクエストの「認可」を構成し、「送信」をクリックします。 レスポンスの形式は次のとおりです。
- 次のGET URLを使用して、dataLoadDataSetsリソースからファイル詳細を取得します:
https://{{env}}/hcmRestApi/resources/11.13.18.05/dataLoadDataSets/{{RequestId}}/child/businessObjects/{{DataSetBusObjId}}?onlyData=true&fields=FailedLinesFileContentId,FailedLinesFileEncryptionType,FailedLinesFileEncryptionKeyレスポンスは次のようになります。タスク4の説明に従って、businessObjectsリソースから最新のファイル詳細を取得することもできます。レスポンスには、次のフィールドが含まれます。
{ "FailedLinesFileContentId": "107468_JOB_ERRFILE", "FailedLinesFileEncryptionType": "PGPUNSIGNED", "FailedLinesFileEncryptionKey": "customer-key" }
https://{{env}}/hcmRestApi/resources/11.13.18.05/dataLoadDataSets/{{RequestId}}/child/businessObjects/{{DataSetBusObjId}}/action/generateFailedLinesFile
ノート:
{{RequestId}}をファイルの送信時に返されたRequestId値に置き換え、{{DataSetBusObjId}}を、ファイルを生成するデータ・セット内のビジネス・オブジェクトのDataSetBusObjIdに置き換えます。{
"includeMessagesFlag" : "Y",
"messageLanguage" : "US",
"fileEncryption" : "PGPUNSIGNED",
"encryptionKey" : "customer-key"
}
{
"result": {
"Status": "SUCCESS",
"RequestId": "107669",
"ErrorFileContentID": "107468_JOB_ERRFILE",
"UserInfo": "The file will be available on the Oracle WebCenter on completion of this process."
}
}
タスク7: 発行済プロセス詳細の取得
データ セットに対して送信されたプロセスおよびサブプロセスに関する情報を取得できます。
プロセス詳細の取得
通常、データ・セット内の各ビジネス・オブジェクトの転送、インポートおよびロード・プロセスのレコードと、ビジネス・オブジェクトおよびデータ・セット後処理が表示されます。ロードの再発行、ロールバックの送信、失敗した明細明細の生成など、データ・セットのさらなる処理を発行した場合は、追加のプロセスがあります。
- Postmanで、このURLに対する新しいGETリクエストを作成します:
- リクエストの「認可」を構成し、「送信」をクリックします。
https://{{env}}/hcmRestApi/resources/11.13.18.05/dataLoadDataSets/{{RequestId}}/child/processes?onlyData=true&fields=ProcessId,ProcessCode,BusinessObjectName,FileActionCode,TotalCount,ErrorCount,ElapsedTime,ThreadsAllocated,ThreadsUsed
これは、レスポンスがWorkerビジネス・オブジェクトを含むデータ・セットを検索する方法です。この例では、ビジネス・オブジェクトに対してロードが2回発行されています。
{
"items": [
{
"ProcessId": 300100618948404,
"ProcessCode": "ORA_TRANSFER_OBJECT",
"BusinessObjectName": "Worker",
"FileActionCode": null,
"TotalCount": 540,
"ErrorCount": 0,
"ElapsedTime": "+000000000 00:00:40.347000",
"ThreadsAllocated": 8,
"ThreadsUsed": 1
},
{
"ProcessId": 300100618948432,
"ProcessCode": "ORA_IMPORT_OBJECT",
"BusinessObjectName": "Worker",
"FileActionCode": null,
"TotalCount": 540,
"ErrorCount": 0,
"ElapsedTime": "+000000000 00:00:13.475000",
"ThreadsAllocated": 8,
"ThreadsUsed": 8
},
{
"ProcessId": 300100618950528,
"ProcessCode": "ORA_LOAD_OBJECT",
"BusinessObjectName": "Worker",
"FileActionCode": "IMPORT_AND_LOAD",
"TotalCount": 54,
"ErrorCount": 54,
"ElapsedTime": "+000000000 00:00:43.242000",
"ThreadsAllocated": 8,
"ThreadsUsed": 3
},
{
"ProcessId": 300100618950575,
"ProcessCode": "ORA_HDL_POST_PROCESS",
"BusinessObjectName": "Worker",
"FileActionCode": null,
"TotalCount": 0,
"ErrorCount": 0,
"ElapsedTime": "+000000000 00:00:43.444000",
"ThreadsAllocated": null,
"ThreadsUsed": null
},
{
"ProcessId": 300100619031844,
"ProcessCode": "ORA_LOAD_OBJECT",
"BusinessObjectName": "Worker",
"FileActionCode": "ORA_LOAD",
"TotalCount": 54,
"ErrorCount": 11,
"ElapsedTime": "+000000000 00:14:56.706000",
"ThreadsAllocated": 8,
"ThreadsUsed": 3
},
{
"ProcessId": 300100619039767,
"ProcessCode": "ORA_HDL_POST_PROCESS",
"BusinessObjectName": "Worker",
"FileActionCode": null,
"TotalCount": 0,
"ErrorCount": 0,
"ElapsedTime": "+000000000 00:00:34.738000",
"ThreadsAllocated": null,
"ThreadsUsed": null
},
{
"ProcessId": 300100619039775,
"ProcessCode": "ORA_ORACLE_SEARCH",
"BusinessObjectName": "Worker",
"FileActionCode": null,
"TotalCount": 0,
"ErrorCount": 0,
"ElapsedTime": "+000000000 00:01:41.009000",
"ThreadsAllocated": null,
"ThreadsUsed": null
}
...
サブプロセス情報の取得
サブプロセスは、プロセス・リソースの子リソースです。指定されたプロセスによって送信されたサブプロセスの詳細を取得します。転送、インポート、ロード・プロセスの場合、これはマルチスレッド・プロセスの詳細になります。ORA_HDL_POST_PROCESSの場合、これは発行された個々のポスト・プロセスの詳細を示します。
- Postmanで、このURLに対する新しいGETリクエストを作成します:
- リクエストの「認可」を構成し、「送信」をクリックします。
https://{{env}}/hcmRestApi/resources/11.13.18.05/dataLoadDataSets/{{RequestId}}/child/processes/{{ProcessId}}/child/subprocesses?onlyData=true&fields=ProcessName,ProcessId,ProcessCode,Elapsedtime,ProcessStatusMeaning
ノート:
{{RequestId}}をファイルの送信時に返されたRequestId値に置き換え、{ProcessId}}をサブプロセスが必要なプロセスのProcessIdに置き換えます。これは、レスポンスがワーカー・ビジネス・オブジェクトに対して発行されたORA_HDL_POST_PROCESSプロセスを検索する方法です。
{
"items": [
{
"ProcessName": "Refresh Manager Hierarchy",
"ProcessId": 300100619039790,
"ProcessCode": "WORKER_REFRESHMANAGERHIERARCHY",
"Elapsedtime": "+000000000 00:00:08.216000",
"ProcessStatusMeaning": "Succeeded"
},
{
"ProcessName": "Update Person Search Keywords",
"ProcessId": 300100619037746,
"ProcessCode": "WORKER_UPDATEPERSONSEARCHKEYWORDS",
"Elapsedtime": "+000000000 00:00:09.093000",
"ProcessStatusMeaning": "Succeeded"
},
{
"ProcessName": "EMEA Localization Postprocessing",
"ProcessId": 300100619037756,
"ProcessCode": "WORKER_EMEALOCALIZATIONPOSTPROCESSING",
"Elapsedtime": "+000000000 00:00:02.959000",
"ProcessStatusMeaning": "Succeeded"
},
{
"ProcessName": "Global Tax Reporting Unit Maintenance",
"ProcessId": 300100619037764,
"ProcessCode": "WORKER_GLOBALTAXREPORTINGUNITMAINTENANCE",
"Elapsedtime": "+000000000 00:00:02.702000",
"ProcessStatusMeaning": "Succeeded"
}
...
タスク8: 既存のデータ・セットの処理の発行
HCMデータ・ローダー・ファイルがインポート済のみの場合、または以前に失敗したレコードのロードを試行する場合は、データ・セットのロードを発行できます。レコードが正常にロードされた場合は、データ・セットのロールバックを発行できます。ロールバックは、ロールバック処理をサポートするビジネス・オブジェクトに対してのみ開始されます。
ヒント :
businessObjectsリソースのRollbackEnabledFlag要素は、ビジネス・オブジェクトがロールバックをサポートしているかどうかを示します。データ・セットの処理の発行
- Postmanで、このURLに対する新しいPOSTリクエストを作成します。
- 次のJSON本文を指定します:
- Content-Typeヘッダーを値に設定します。
application/vnd.oracle.adf.action+json
- リクエストの「認可」を構成し、「送信」をクリックします。 レスポンスの形式は次のとおりです。
https://{{env}}/hcmRestApi/resources/11.13.18.05/dataLoadDataSets/{{RequestId}}/action/submit
ノート:
{{RequestId}}を、ファイルの送信時に返されたRequestId値に置き換えます。{
"fileAction" : "LOAD"
}
このカスタムアクションには、次のパラメータを使用できます。
| パラメータ | 説明 | デフォルト値 |
|---|---|---|
| fileAction | 有効な値はLOADおよびROLLBACKです。
ヒント : HSDLファイルの場合、ファイルをインポートするだけで、RESTでロードできず、かわりにテンプレート用のスプレッドシートを生成し、データ・セットをフェッチしてスプレッドシートからアップロードできます。 |
"LOAD" |
| loadConcurrentThreads | ロード・プロセスに割り当てるコンカレント・スレッドの最大数。 | 「ロードの最大同時スレッド数」パラメータからデフォルト設定されます。 |
{
"result": {
"Status": "SUCCESS",
"RequestId": "107683"
}
}
データ・セット内のビジネス・オブジェクトに対する処理の発行
submitカスタム・アクションは、同じパラメータを持つビジネス・オブジェクト・レベルでも使用できますが、URLで指定されたビジネス・オブジェクトの処理のみを送信します。
このURLを使用して、特定のビジネス・オブジェクトの処理を開始します。
https://{{env}}/hcmRestApi/resources/11.13.18.05/dataLoadDataSets/{{RequestId}}/child/businessObjects/{{DataSetBusObjId}}/action/submit
ノート:
データ・セット内のビジネス・オブジェクトをレビューしたときに返されたDataSetBusObjId値に{{DataSetBusObjId}}を置き換えます。ヒント :
これをテストするには、Base64エンコーディング、JobFamily.zipファイルのアップロードおよび送信を行います。このファイルは、前述のエラーでJob.datファイルによって参照されるジョブ・ファミリを作成します。ジョブ・ファミリが正常にロードされたら、前述のように、データ・セット内のデータ・セットまたはジョブ・ビジネス・オブジェクトに対してLOADを開始します。
タスク9: 進行中のデータ・セットまたはビジネス・オブジェクトの停止
進行中のデータ・セットおよびビジネス・オブジェクトの停止をリクエストできます。
データ・セットの処理の中止
- Postmanで、このURLに対する新しいPOSTリクエストを作成します。
- Content-Typeヘッダーを値に設定します。
application/vnd.oracle.adf.action+json
- リクエストの「認可」を構成し、「送信」をクリックします。
https://{{env}}/hcmRestApi/resources/11.13.18.05/dataLoadDataSets/{{RequestId}}/action/stop
このアクションのパラメータはありません。
データ・セットが現在進行中でない場合、かわりに次のレスポンスが返されます:
{
"result": "You can't stop processing this data set because it isn't being processed. Check the current status of the data set."
}
ビジネス・オブジェクトの処理停止
stopカスタム・アクションは、ビジネス・オブジェクト・レベルでも使用できます。次のURLを使用して、特定のビジネス・オブジェクトに対する処理停止をリクエストします。
https://{{env}}/hcmRestApi/resources/11.13.18.05/dataLoadDataSets/{{RequestId}}/child/businessObjects/{{DataSetBusObjId}}/action/stop
ノート:
データ・セット内のビジネス・オブジェクトをレビューしたときに返されたDataSetBusObjId値に{{DataSetBusObjId}}を置き換えます。タスク10: データ・セットの削除
データ・セットが処理されていない場合は、データ・セットのステージング表データを削除できます。
HDLステージ表データの削除
- Postmanで、このURLに対する新しいPOSTリクエストを作成します。
- Content-Typeヘッダーを値に設定します。
application/vnd.oracle.adf.action+json
- リクエストの「認可」を構成し、「送信」をクリックします。
https://{{env}}/hcmRestApi/resources/11.13.18.05/dataLoadDataSets/{{RequestId}}/action/deleteDataSet
このアクションのパラメータはありません。
HSDLステージ表データの削除
この処理を発行すると、HSDLとHDLの両方のステージング表からデータ・セットが削除されます。
- Postmanで、このURLに対する新しいPOSTリクエストを作成します。
- Content-Typeヘッダーを値に設定します。
application/vnd.oracle.adf.action+json
- リクエストの「認可」を構成し、「送信」をクリックします。
https://{{env}}/hcmRestApi/resources/11.13.18.05/dataLoadDataSets/{{RequestId}}/action/deleteSpreadsheetDataSet
このアクションのパラメータはありません。
関連リンク
- ソリューション・プレイブック: Oracle Fusion Cloud Human Capital Management (HCM)へのデータのロード
- ユーザー・ガイド: HCMデータ・ローダー
- HCMデータ・ローダーOracle by Exampleチュートリアル
「操作」セクションでは、Oracle WebCenter Contentサーバーにファイルをロードするその他の方法について説明します。
その他の学習リソース
docs.oracle.com/learnで他のラボを確認するか、Oracle Learning YouTubeチャネルで無料のラーニング・コンテンツにアクセスしてください。また、education.oracle.com/learning-explorerにアクセスして、Oracle Learning Explorerになります。
製品ドキュメントについては、Oracle Help Centerを参照してください。