Home > コンポーネント シリーズ > ServiceMax > ServiceMax - 設定 > ServiceMax - メソッド

ServiceMax - メソッド

以下のメソッドはダイレクトアクセスメソッドを使用してServiceMaxコネクタを構成するのに使用されています。

オブジェクト添付ファイルは、同じ複製データベースの配下の専用テーブルに保存されます。添付ファイルは、Base64フォーマットで保存されます。添付ファイルテーブルはib_sfdc_attachmentsと呼ばれ、キーとして各々の添付ファイルレコードに対してオブジェクト名とフィールド名、ユニークなオブジェクトIDが含まれています。

以下の表は使用できるメソッドとパラメータの一覧です。太字 のパラメータは必須です。

メソッド

パラメータ

説明

Bulk Abort Job

現在のバルク処理のジョブを中止します。ジョブが中止されると、レコードは処理されません。しかし、データに対していくつか変更されることがあり、ロールバックされません。

ジョブID

アボートしたいジョブのIDを入力します。

タイムスタンプ

アボート処理のタイムスタンプを保持する変数を選択してください。

エラーコード

をクリックして変数リストを開きます。エラーコードが返される変数またはユーザパラメータを選択します。

Bulk Check Job State

ジョブのすべてのバッチが終了したかどうかをチェックします。

ジョブID

チェックしたいジョブのIDを入力します。

ジョブ完了を待つ

ジョブの状態をチェックする前に、ジョブの完了を待つかどうかを指定します。ドロップダウンリストからの以下のどれかを選択します。

  • No (デフォルト)

  • Yes …… このオプションを選択すると、10秒間隔でリトライされます。

バッチステータスXML

XML構造でバッチの状態を保持する変数を選択します。

ジョブ状態

ジョブの状態を保持する変数を選択します。

エラーコード

をクリックして変数リストを開きます。エラーコードが返される変数またはユーザパラメータを選択します。

Bulk Retrieve Job Results

ジョブ内のすべてのバッチの結果を取得します。

ジョブID

結果を取得したいジョブのIDを入力します。

不完全な結果を許可

部分的に結果を取り出素ことができるように指定します。ドロップダウンリストからの以下のどれかを選択します。

  • No (デフォルト)  …… このオプションを選択すると、メソッドの最初のアクションはジョブの状態をチェックすることです。ジョブが進行中の場合は、エラーが作成されます。

  • Yes …… このオプションを選択すると、ジョブが終了しない場合、メソッドはジョブの状態をチェックしないで、部分的な結果を返すかもしれません。

結果XML

XML構造でバッチの状態を保持する変数を選択します。

結果XMLは、以下の場所にあります:

<Magic xpi  のインストールフォルダ>\Runtime\ifclib\ServiceMax\xsd\BulkResults.xsd

エラーコード

をクリックして変数リストを開きます。エラーコードが返される変数またはユーザパラメータを選択します。

Bulk Retrieve Query Results

1つ以上のCSVファイルの形式でServiceMaxから結果を取り出します。

ジョブID

結果を取得したいジョブのIDを入力します。

ジョブ完了を待つ

ジョブの状態をチェックする前に、ジョブの完了を待つかどうかを指定します。ドロップダウンリストからの以下のどれかを選択します。

  • No (デフォルト)

  • Yes …… このオプションを選択すると、10秒間隔でリトライされます。

結果ディレクトリ

結果ファイルが作成されるフォルダへのフルパスを入力してください。

結果ファイル接頭辞

結果ファイルに必要な接頭辞を入力してください。

結果数

オペレーションによって作成されるCSVファイルの数を受け取ります。最大1GBのファイルが返り、そこで、これらのは最大15ファイルになります。

エラーコード

をクリックして変数リストを開きます。エラーコードが返される変数またはユーザパラメータを選択します。

Convert Lead

1度にひとつのLeadをOppourtunity(オプション)と同じように AccountとContactに変換します。

リードID

変換するLeadのID

変換後ステータス

変換されたleadに対する有効なLeadステータス値を入力します。

アカウントID(入力)

leadがマージされる先のAccountのIDを入力します。既存のアカウントを更新する場合のみ必要となります。

コンタクトID(入力)

leadがマージされる先のContactのIDを入力します。既存のcontactを更新する場合のみ必要となります。

リードソースを上書き

ターゲットのContactオブジェクトのLeadSourceフィールドを上書きするかどうか指定します。有効な値はYesまたはNo(デフォルト)です。

条件の作成

lead 変換時に条件を作成するかどうか指定します。有効な値はYesまたはNo(デフォルト)です。

オーナID

新たに生成されるAccount、Contact、とOppourtunityを所有する人のIDを入力します。

通知メールを送信

OwnerIDで指定されているオーナにEmailを送るかどうか指定します。有効な値はYesまたはNo(デフォルト)です。

アカウントID(出力)

新しく作られたAccount IDを保持する変数を選択します。

コンタクトID(出力)

新しく作られたContact IDを保持する変数を選択します。

条件ID

lead がマージされるOpportunityのIDを入力します。

エラーコード

をクリックして変数リストを開きます。エラーコードが返される変数またはユーザパラメータを選択します。

Get Objects List

ServiceMax 組織データで利用可能なオブジェクトのリストを取り出すメソッド。

オブジェクトリストXML

XML構造でオブジェクトリストを保持する変数を選択します。

エラーコード

をクリックして変数リストを開きます。エラーコードが返される変数またはユーザパラメータを選択します。

Get Timestamp

ServiceMaxのタイムスタンプを取り出します。

タイムスタンプ

ServiceMaxタイムスタンプ(XMLフォーマット)を保存する変数を定義します。

をクリックして変数リストを開きます。必要な変数を選択します。

エラーコード

をクリックして変数リストを開きます。エラーコードが返される変数またはユーザパラメータを選択します。

Merge

同じオブジェクトタイプのレコードを一つのレコードにマージし、他のレコードを削除し、関連するレコードを親にします。

オブジェクトタイプ

マージされるオブジェクトタイプを選択します。LeadContactAccountがあります。

マスタレコードID

どのレコードが他のレコードがマージするマスターレコードか指定するためにレコードIDを入力します。

レコードID

マスタレコードにマージされるレコードのIDをカンマ区切りで入力します。最低1レコード、最大で2レコードです。

エラーコード

をクリックして変数リストを開きます。エラーコードが返される変数またはユーザパラメータを選択します。

Metadata CRUD

メタデータの作成、更新または削除を行います。

オペレーション

実行したいCRUD処理。ドロップダウンリストからの以下のどれかを選択します。

  • 作成 (デフォルト)

  • 更新

  • 削除

  • アップサート

メタデータ

メタデータのXML表記。メタデータXMLの詳細については、ここをクリックしてください。

結果XML

XML構造で結果を保持する変数を選択してください。

エラーコード

をクリックして変数リストを開きます。エラーコードが返される変数またはユーザパラメータを選択します。

Metadata Check State

メタデータの非同期メソッドの処理状態をチェックします。

ID

非同期メソッド(Deploy、Retrieveまたは CRUD)のうちの1つから非同期の結果XMLで返されるID

完了を待つ

状態を読み出す前に処理の完成を待つべきかどうか指定します。ドロップダウンリストから以下のどれかを選択します。

  • No (デフォルト)

  • Yes …… メタデータ処理が完了するまで、ステップは終了しません。

結果XML

XML構造で結果を保持する変数を選択してください。

エラーコード

をクリックして変数リストを開きます。エラーコードが返される変数またはユーザパラメータを選択します。

Metadata Deploy

ServiceMaxメタデータzipファイルを配備します。

メタデータZipファイル

フルパスと配備されたメタデータzipファイルのファイル名。

警告を無視

配備が成功したときに警告表示を許可するかどうかを指定します。ドロップダウンリストから以下のどれかを選択します。

  • No (デフォルト)

  • Yes

エラーのロールバック

失敗した場合に、完全にロールバックするかどうかを指定します。ドロップダウンリストから以下のどれかを選択します。

  • Yes (デフォルト)

  • No

Noを選択すると、エラーを含まないアクションが実行され、エラーは残りのアクションに対して返されます。製品組織として配備する場合は、Yesを選択する必要があります。

結果XML

XML構造で結果を保持する変数を選択してください。

エラーコード

をクリックして変数リストを開きます。エラーコードが返される変数またはユーザパラメータを選択します。

Metadata Retrieve

ServiceMaxメタデータzipファイルを読み出します。

メタデータAPIバージョン

リクエストを読み込むために必要なAPIバージョンをフルパスで指定します。APIバージョンは、メタデータタイプごとにどのフィールドが読み込まれるかを指定します。

メタデータ出力先Zipファイル

読み込まれたメタデータzipファイルのフルパスとファイル名。

パッケージ名

読み込むパッケージ名のリストをカンマ区切りで指定します。パッケージが展開されたコンポーネントを取り出したい場合、このフィールドを空のままにして、[マニフェストXMLファイル]フィールド(下記)に値を入力してください。

マニフェストXMLファイル

マニフェストパッケージXMLファイルのフルパス。これは、パッケージが展開されたコンポーネントを読み出すために使用されます。

結果XML

XML構造で結果を保持する変数を選択してください。

エラーコード

をクリックして変数リストを開きます。エラーコードが返される変数またはユーザパラメータを選択します。

Query by SOQL

フリーのServiceMaxオブジェクトオブジェクトクエリー言語(SOQL)ステートメントを送信して、戻り値として結果のXMLを受け取ります。

クエリタイプ

実行したいクエリタイプを定義します。ドロップダウンリストから以下のどれかを選択します。

  • クエリ (デフォルト)

  • 全クエリ

SOQL文

送信したいSOQL文を入力します

結果格納先

結果XMLの保存先を指定します。ドロップダウンリストから以下のどれかを選択します。

  • 変数 (デフォルト)

  • ファイル

  • 分割ファイル

結果XML

をクリックして変数リストを開き、XML構造で処理結果を保存する変数を選択します。

[結果の保存先](上記)で変数を選択した場合のみ有効です。

ファイル名

照会結果を保存したいファイルのフルパスを入力します。

[結果の保存先](上記)でファイルを選択した場合のみ有効です。

ディレクトリ

分割したXML結果を保持しているディレクトリのフルパス。

をクリックして式エディタを開き、ディレクトリ名を入力します。

[結果の保存先](上記)が分割ファイルの場合だけ有効です。

接頭辞

接頭辞は、分割XMLファイルで使用します。

をクリックして式エディタを開き、接頭辞を入力します。

[結果の保存先](上記)が分割ファイルの場合だけ有効です。

ファイル毎のレコード

各分割ファイル内のレコード数。

をクリックして式エディタを開き、接頭辞を入力します。

[結果の保存先](上記)が分割ファイルの場合だけ有効です。

分割数

返される結果XMLから作成される分割数が格納される数値変数

をクリックして変数リストを開き、変数を選択します。

[結果の保存先](上記)が分割ファイルの場合だけ有効です。

エラーコード

をクリックして変数リストを開きます。エラーコードが返される変数またはユーザパラメータを選択します。

Replicate All Data

オブジェクトの完全検索を行い、選択されたローカルデータベースにServiceMaxデータを複製します。

オブジェクト名

ServiceMax オブジェクト名を選択します。

出力先DBリソース

データベースリソースを入力します。

MSSQL 2005サーバで動作させる場合は、このメソッドは8000文字以上のa ServiceMax文字列を扱うことができます。

トランザクションタイプ

データベースのトランザクションタイプを選択します。有効な値は レコードテーブル です。

全レコードを最初に削除

挿入前に既存のレコードを削除するかどうかを指定します。有効な値はYes(デフォルト)またはNoです。

エラーコード

をクリックして変数リストを開きます。エラーコードが返される変数またはユーザパラメータを選択します。

Replicate Last Deletes

Start Date引数に基づきオブジェクトの削除されたレコードを検索し、変更をローカルデータベースに複製します。

オブジェクト名

ServiceMax オブジェクト名を選択します。

出力先DBリソース

データベースリソースを入力します。

MSSQL 2005サーバで動作させる場合は、このメソッドは8000文字以上のa ServiceMax文字列を扱うことができます。

トランザクションタイプ

データベースのトランザクションタイプを選択します。有効な値は レコードテーブル です。

開始日

ServiceMaxの変更を複製し始める日付を入力します。

有効な日付フォーマットは:

YYYY-MM-DDT00:00:00T

YYYY-MM-DDT00:00:00.000T

最終カバー日付

最後にカバーされた日付を保持する変数を入力します。

取得レコード数

取得されたレコード数を保存する変数を定義します。

をクリックして変数リストを開き、必要な変数を選択します。

削除レコード数

削除されたレコード数を保存する変数を定義します。

をクリックして変数リストを開き、必要な変数を選択します。

エラーコード

をクリックして変数リストを開きます。エラーコードが返される変数またはユーザパラメータを選択します。

Replicate Last Updates

[開始日付]に基づきオブジェクトの更新されたレコードを検索し、変更をローカルデータベースに複製します。

オブジェクト名

ServiceMax オブジェクト名を選択します。

出力先DBリソース

データベースリソースを入力します。

MSSQL 2005サーバで動作させる場合は、このメソッドは8000文字以上のa ServiceMax文字列を扱うことができます。

トランザクションタイプ

データベースのトランザクションタイプを選択します。有効な値は レコードテーブル です。

開始日

ServiceMaxの変更を複製し始める日付を入力します。

有効な日付フォーマットは:

YYYY-MM-DDT00:00:00T

YYYY-MM-DDT00:00:00.000T

最終カーバ日付

最後にカバーされた日付を保持する変数を入力します。

取得レコード数

取得されたレコード数を保存する変数を定義します。

をクリックして変数リストを開き、必要な変数を選択します。

更新レコード数

更新されたレコード数を保存する変数を定義します。

をクリックして変数リストを開き、必要な変数を選択します。

挿入レコード数

挿入されたレコード数を保存する変数を定義します。

をクリックして変数リストを開き、必要な変数を選択します。

エラーコード

をクリックして変数リストを開きます。エラーコードが返される変数またはユーザパラメータを選択します。

Update Object Structure

一番更新されたServiceMaxオブジェクトを検索し、同じ Create Table SQL文を生成します。

オブジェクト名

ServiceMax オブジェクト名を選択します。

出力先DBリソース

データベースリソースを入力します。

最初にテーブルをドロップする

オブジェクト構造を作成する前にテーブル構造を削除するかどうかを指定します。

スクリプトファイル名

データベーススクリプトのあるディレクトリへのパスを入力します。

スクリプト実行

生成されたスクリプトを実行するかどうか指定します。

エラーコード

をクリックして変数リストを開きます。エラーコードが返される変数またはユーザパラメータを選択します。

関連トピック:

ダイレクトアクセスメソッドの使い方