前のトピック: pdm_task―環境変数の設定

次のトピック: 入力例

pdm_text_cmd―Text APIコマンド ライン インターフェース

Text API の pdm_text_cmd コマンドを使用します。このコマンドを使用すると、リクエスト、変更要求、案件、アセット、連絡先など、さまざまなオブジェクトを作成および更新できます。

重要: pdm_text_nxd または bop_cmd のコマンドのパラメータとして単一引用符や二重引用符は使用できません。

構文

このコマンドのフォーマットは、以下のとおりです。

pdm_text_cmd –t table {-u from_userid –p from_persid} [-o operation] [-f input file] [-T timeout] [-h]

-t table

(必須)処理するテーブルを指定します。 table には、以下のいずれかの値を指定します(大文字小文字は区別されません)。

-u from_userid | -p from_persid

(どちらかのオプションが必須)この操作の連絡先を指定します。

-u from_userid

ユーザ ID 値を使用して連絡先を指定します。

-p from_persid

連絡先レコードのオブジェクト固有 ID を使用して連絡先を指定します。 from_persid は、cnt:xxxx の形式で指定する必要があります。 xxxx はオブジェクトの固定 ID です。

注:このオプションで指定した値は、適切なキーワード %FROM_USERID または %FROM_PERSID を使用して、pdm_text_cmd コマンドの入力の最後に追加されます。

-o operation

実行する操作を指定します。 operation には、以下のいずれかの値を指定します(大文字小文字は区別されません)。

UPDATE も UPDATE_ONLY も、コマンド入力に %SEARCH キーワードが必要です。 pdm_text_cmdの1回の呼出しで実行できる操作は1つだけです。

-f input_file

処理するテキスト ファイルの完全パスを指定します。このファイルには、有効なText APIのコマンドが含まれます。 ユーザがこのパラメータを省略した場合は、STDIN から入力されたコマンドが使用されます。 Text API への入力には、以下の基本フォーマットを使用します。

%keyword=value

入力内で複数のコマンドを実行するには、パーセント記号を 5 つ以上(%%%%%)使用してコマンド リクエストを区切ります。

注:有効なキーワードの詳細と Text API の入力フォーマットの詳細については、text_api.cfg ファイルを参照してください。

-T timeout

サーバからの応答を待機してタイムアウトするまでの秒数を指定します。 初期設定は30秒です。

注:pdm_text_cmd を実行すると、Text API から返されたテキストベースの応答が表示されます。この応答には、正常終了を示すメッセージまたはエラー メッセージと、API を使用して送信された処理用のテキストがそのまま含まれます。 コマンドが正常に完了して警告やエラーが表示されなかった場合は 0、コマンドは正常に完了したが警告が表示された場合は 1 が返されます。 その他の戻り値は、エラーが発生したことを示します。

重要: UNIX では、一部の CA SDM ユーティリティを実行する前に LIBPATH を設定する必要があります。 ユーティリティを実行する前に、pdm_task を使用して LIBPATH を設定します。 たとえば、「pdm_task pdm_clean_attachments ...」と入力します。

注: コマンド プロンプトからパラメータを渡す場合は、Ctrl + Z キー(Windows)、または Ctrl + D キー(POSIX)を使用します。

(新規関連グループ 1)

Text API の使用