OpenAPI 3.0ファイルからのプロセスオブジェクトの作成
1つ以上のOpenAPI 3.0 JSONファイルまたはYAMLファイルをインポートすることで、複数の大きな階層プロセスオブジェクトを簡単に同時に作成できます。
[OpenAPI 3.0ファイルからの新規プロセスオブジェクト作成]ウィザードを使用して、OpenAPI 3.0ファイルからプロセスオブジェクトを作成します。ソースを指定すると、アプリケーション統合ではソースが解析され、リソースがロードされて、XSDスキーマが生成されます。XSDスキーマに基づいて、アプリケーション統合ではプロセスオブジェクトが生成されます。プロセスオブジェクトを保存する場所などのインポート設定を指定し、必要に応じてプロセスオブジェクトに使用されるタグを指定できます。
プロセスオブジェクト作成中にエラーが発生した場合、ウィザードの該当するステップの[関連ログ]タブにエラーが表示されます。ログを確認して対処できます。ログをダウンロードすることもできます。特定のステップでログをダウンロードすると、ログにはそれより前のすべてのステップに関する累積ログ情報も表示されます。
1アプリケーション統合で、[新規]をクリックします。
[新しいアセット]ダイアログボックスが表示されます。
次の図は、[新しいアセット]ダイアログボックスを示しています。
2左ペインの[プロセスオブジェクト]をクリックします。
3右ペインで、[プロセスオブジェクト作成パターン]リストを展開し、[OpenAPI 3.0から作成]をクリックしてから、[作成]をクリックします。
[OpenAPI 3.0ファイルからの新規プロセスオブジェクト作成]ダイアログボックスが表示されます。
次の図は、[OpenAPI 3.0ファイルからの新規プロセスオブジェクト作成]ダイアログボックスを示しています。
4[ソース]フィールドで、次のうちいずれかの値を選択します。
オプション | 説明 |
---|
ファイル | [ファイル]を選択し、型が定義されている単一のOpenAPI 3.0ソースファイルをローカルシステムから指定します。HTTPリソースを指定することもできます。[ファイルを選択]をクリックして、OpenAPI 3.0ソースファイルを選択します。 単一ファイルの最大許容ファイルサイズは5 MBです。 デフォルトは[ファイル]です。 |
Zip(複数ファイル) | [Zip]を選択して、zipファイル形式で型が定義されている複数のOpenAPI 3.0ソースファイルをローカルシステムから指定します。[ファイルを選択]をクリックして、zipファイルを選択します。 zipファイルの最大許容ファイルサイズは3 MBです。 |
URL | [URL]を選択し、型が定義されているOpenAPI 3.0ソースファイルを含むURLを指定します。[URL]フィールドと[認証の使用]フィールドが表示されます。 [URL]フィールドに、ソースURLを入力します。 [認証の使用]オプションを選択して、ソースURLにアクセスするためのユーザー名とパスワードを指定します。 |
5[次へ]をクリックします。
アプリケーション統合では指定されたソースファイルまたはURLが解析され、[リソースのロード]タブにリソース詳細が表示されます。
次の図は、リソース詳細が表示された[リソースのロード]タブを示しています。
6リソース詳細を確認します。
以下の表に、[リソースのロード]タブに表示される列を示します。
カラム名 | 説明 |
---|
ファイル名 | リソースのファイル名。 |
ファイルパス | ソース内の各リソースのURLまたは関連する場所。 |
タイプ | リソースのファイルタイプ。値が[OPENAPI]のように表示されます。 |
ステータス | リソースのステータス。次のいずれかの値を表示します。 - - 有効。ファイルタイプがサポートされ、ファイルコンテンツが有効であることを示します。
- - 無効。ファイルタイプがサポートされていないか、ファイルコンテンツが無効であることを示します。例えば、txtファイルの場合、ファイルタイプがサポートされていないため、ステータスは[無効]と表示されます。
|
コメント | ファイルタイプがサポートされているかどうかを示します。 |
解析エラーがある場合、アプリケーション統合では[関連ログ]タブにエラー詳細が表示されます。エラーを修正してやり直してください。
7[次へ]をクリックします。
アプリケーション統合では、作成されるプロセスオブジェクトに基づいてリソースがXSDスキーマに変換されます。[スキーマの生成]タブにスキーマ詳細が表示されます。
次の図は、スキーマ詳細が表示された[スキーマの生成]タブを示しています。
8スキーマ詳細を確認します。
以下の表に、[スキーマの生成]タブに表示される列を示します。
カラム名 | 説明 |
---|
スキーマ | 生成されたXSDスキーマファイルの名前。 |
ソース | XSDスキーマファイルが生成されたソース。 |
複合型 | XSDスキーマごとに作成される複合型の数。 |
プレフィックス | XSDスキーマに使用されるプレフィックス。 プレフィックスを使用して、スキーマから作成されるプロセスオブジェクトを簡単に特定できます。例えば、Salesforceスキーマから作成されるすべてのプロセスオブジェクトに対しプレフィックスSalesforceを追加するとします。 スキーマに対しプレフィックスを指定するには、スキーマが含まれている行に対し[プレフィックス]列をダブルクリックし、プレフィックスを入力します。スキーマから作成されるすべてのプロセスオブジェクトでは、このフィールドで指定したものと同じプレフィックスが使用されます。 |
タグ | XSDスキーマに使用されるタグ。 タグを使用して、関連するスキーマをまとめてグループ化することができます。例えば、財務リソースを含むすべてのスキーマをタグFinanceにグループ化するとします。 スキーマに対しタグを指定するには、スキーマが含まれている行に対し[タグ]列をダブルクリックし、タグを入力します。スキーマから作成されるすべてのプロセスオブジェクトでは、このフィールドで指定したものと同じプレフィックスが使用されます。 |
スキーマ生成エラーがある場合、アプリケーション統合では[関連ログ]タブにエラー詳細が表示されます。エラーを修正してやり直してください。
9[次へ]をクリックします。
アプリケーション統合では、XSDスキーマに指定したプレフィックスとタグが適用され、プロセスオブジェクトがXSDスキーマに基づいて生成されます。[オブジェクトの生成]タブにプロセスオブジェクト詳細が表示されます。
次の図は、プロセスオブジェクト詳細が表示された[オブジェクトの生成]タブを示しています。
10プロセスオブジェクトの詳細を確認します。
以下の表に、[オブジェクトの生成]タブに表示される列を示します。
カラム名 | 説明 |
---|
名前 | スキーマから生成されたプロセスオブジェクトの名前。 |
説明 | プロセスオブジェクトが生成されたスキーマ。説明を編集できます。 |
いいえフィールド関連 | プロセスオブジェクトに含まれている複合型の数。 |
タグ | プロセスオブジェクトに使用されるタグ。デフォルトで、プロセスオブジェクトタグはXSDスキーマに指定したタグから派生します。 プロセスオブジェクトレベルで別のタグを指定する場合はタグを編集できます。 プロセスオブジェクトのタグを編集するには、プロセスオブジェクトを含む行に対し[タグ]列をダブルクリックし、タグを更新します |
11[次へ]をクリックします。
作成されるプロセスオブジェクトの数を表示する[設定のインポート]タブが表示されます。
次の図は、[設定のインポート]タブを示しています。
12必要に応じて、[選択]をクリックして、プロセスオブジェクトを保存する場所を指定します。
デフォルトは、[OpenAPI 3.0ファイルからの新規プロセスオブジェクト作成]ウィザードを開いたときに選択された場所です。
13必要に応じて、プロセスオブジェクトに対し追加のタグをカンマ区切り値として指定します。
14[インポートの開始]をクリックします。
アプリケーション統合では、プロセスオブジェクトのインポートが開始され、インポートステータスが表示されます。
次の図は、インポートステータスを示しています。
15以下のいずれかのアクションを実行します。
- - ダイアログボックスを破棄し、プロセスオブジェクトのインポート完了時に通知を受けるには、[破棄]をクリックします。
- - インポートエラーを表示し、修正してインポートを再試行するには、ダイアログボックスを開いたままにします。
プロセスオブジェクトのインポート後、アプリケーション統合ではインポートが成功または失敗したかどうかを示すステータスメッセージが表示されます。
インポートが失敗した場合、[関連ログ]タブを確認してエラーを修正し、プロセスオブジェクトのインポートを再試行します。[ダウンロード]アイコンをクリックして、ログ全体をダウンロードすることもできます。
次の図は、8つのプロセスオブジェクトが正常にインポートされたことを示すサンプルログを示しています。
16[完了]をクリックします。
17プロセスオブジェクト生成に指定した場所に移動し、プロセスオブジェクトを確認します。