arc:info

Version 24.2.8965


arc:info


arc:info キーワードを使用して、スクリプトのメタデータを説明します。この情報は、ユーザー入力の基本的なエラーチェックの実装、およびデフォルト値を設定するためにアプリケーションによって使われます。arc:info キーワードには、次を含めることができます:

  • カラム定義
  • スクリプトが受け入れるインプットパラメータ
  • スクリプトが生成するアウトプット

スクリプトパラメータ

スクリプト自体に次のパラメータを定義できます:

  • desc[ription]:スクリプトの説明。説明が指定されていない場合は、スクリプト名が使われます。
  • title:スクリプトのタイトル。タイトルが指定されていない場合は、スクリプト名が使われます。
  • methods:スクリプトに対して実行できるHTTP メソッド。SELECT、INSERT、UPDATE、およびDELETE は、HTTP GET、POST、PUT/PATCH/MERGE、およびDELETE にそれぞれ対応します。
  • url:スクリプト作成者のURL。
  • keywords:スクリプトを説明するキーワード。

インプット、アウトプット、およびカラムパラメータ

arc:info には、スクリプトのインプットとアウトプットに加えて、カラムを定義する追加のパラメータがスコープ内に含まれています。

Note:これらのパラメータはArcScript キーワードではありません。これらはarc:info の追加情報です。

Input

インプットパラメータは、スクリプトへのインプットを説明するために使われます。

<input
  name="name"
  desc="インプットパラメータの例"
  default="defValue"
  req="true"
  values="value1, value2, value3"
  xs:type="string" 
/>
  • name:インプット名。英数字の文字列で、以下を含めることもできます:
    • # インプットが複数の値を持つことができることを示します
    • myprefix:* 同じ接頭辞を持つインプットのセットを示します
    • * 任意のインプットパラメータを示します
  • desc[ription]:インプットの短い説明。
  • xs:type:インプットのデータ型。使用できる値は、stringintdoubledatetime、およびboolean です。
  • def[ault]:スクリプト呼び出しでインプット値が提供されていない場合に使用するデフォルト値。
  • key:インプットが主キーかどうか。
  • req[uired]:インプットが必須かどうか。必須インプットが提供されず、デフォルト値が定義されていない場合には、エンジンはエラーをスローします。使用できる値はtrue およびfalse です。
  • values:インプットに許容された値のカンマ区切りのリスト。指定されている場合、指定されたインプットが許容された値のいずれかに一致しない場合は、エンジンはエラーをスローします。
  • alias:インプットのエイリアス。
  • otherother: で始まるアトリビュートで追加の情報を提供します。これらのプロパティは、オペレーション固有となる可能性があります。

Output

アウトプットパラメータは、オペレーションのアウトプットを説明します。ただし、これらはアプリケーションには無視されます。これは、オペレーションのアウトプットが、情報ブロックで定義されている内容とは無関係であり得ることを意味します。

<output  name="Id" 
         desc="レコードの一意の識別子。"
         xs:type="string"
         other:xPath="content/properties/Id" 
/>
  • name:アウトプット名。myprefix:* は同一の接頭辞を含むアウトプットのセットを意味し、* は任意のアウトプットパラメータを意味します。
  • xs:type:アウトプットのデータ型。使用できる値は、stringintdoubledatetime、およびboolean です。
  • desc[ription]:アウトプットの短い説明。
  • columnsize:文字列の最大文字数、もしくは数値アウトプットの桁精度。(桁制度とは、桁数です。)
  • otherother: で始まるアトリビュートでアウトプットについて追加の情報を提供します。例えば、other:xPath はローカルまたはリモートリソースのノードにXPath を指定します。XPath はRepeatElement からの相対パスとすることができます。

After Receive イベントへのインプットについて説明します:

<arc:info title="After Receive"  desc="このイベントはファイルを受信した後に発生します。">
  <input name="Filename"         desc="送信されたファイルの名前。" />
  <input name="FilePath"         desc="受信されたファイルのパス。" />
  <input name="MessageId"        desc="トランスミッションのId。" />
  <input name="ErrorMessage"     desc="エラーが発生した場合は、エラーメッセージが表示されます。" />
</arc:info>

** 関連項目

  • arc:script:スクリプトブロックを作成する。
  • arc:call:スクリプトまたはオペレーションを呼び出す。
  • arc:set:アイテムにアトリビュートを設定する。