Search

arc:info

Version 24.2.8965

arc:info

Use the arc:info keyword to describe the metadata for scripts. This information is used by the application to implement basic error checking on user input and to set default values. The arc:info keyword can contain the following:

  • Column definitions
  • Input parameters the script expects
  • Output the script produces

Script Parameters

You can define the following parameters for the script itself:

  • desc[ription]: The description for the script. If description is not provided, the script name is used.
  • title: The title of the script. If title is not provided, the script name is used.
  • methods: The HTTP methods that can be executed against the script. SELECT, INSERT, UPDATE, and DELETE correspond to HTTP GET, POST, PUT/PATCH/MERGE, and DELETE, respectively.
  • url: The URL of the script author.
  • keywords: The keywords that describe the script.

Input, Output, and Column Parameters

arc:info has additional parameters contained within its scope that define columns as well as script inputs and outputs.

Note: These parameters are not ArcScript keywords. They are additional information for arc:info.

Input

Input parameters are used to describe inputs to the script.

<input
  name="name"
  desc="Example of an input parameter"
  default="defValue"
  req="true"
  values="value1, value2, value3"
  xs:type="string" 
/>
  • name: The name of the input. An alphanumeric string that can also contain the following:
    • # denotes that the input can have multiple values
    • myprefix:* denotes a set of inputs with the same prefix
    • * denotes arbitrary input parameters
  • desc[ription]: A short description of the input.
  • xs:type: The data type of the input. Allowed values: string, int, double, datetime, and boolean.
  • def[ault]: The default value to use when no input value is supplied in the script call.
  • key: Whether the input is a primary key.
  • req[uired]: Whether the input is required. The engine throws an error if the required input is not supplied and there is no default value defined. Allowed values: true and false.
  • values: A comma-separated list of the allowed values for the input. If specified, the engine throws an error if the specified input does not match one of the allowed values.
  • alias: The alias of the input.
  • other: Attributes prefixed with other: that provide extra information. These properties can be operation-specific.

Output

Output parameters describe the output of the operation. However, they are ignored by the application. This means that the output of the operation can be independent of what is defined in the info block.

<output  name="Id" 
         desc="The unique identifier of the record."
         xs:type="string"
         other:xPath="content/properties/Id" 
/>
  • name: The name of the output. myprefix:* denotes a set of outputs with the same prefix, and * denotes arbitrary output parameters.
  • xs:type: The data type of the output. Allowed values: string, int, double, datetime, and boolean.
  • desc[ription]: A short description of the output.
  • columnsize: The maximum character length of a string or the precision of a numeric output. (Precision is the number of digits.)
  • other: Attributes prefixed with other: that provide extra information about the output. For example, other:xPath specifies the XPath to a node in a local or remote resource. The XPath can be relative to a RepeatElement.

Example

Describes the inputs to the After Receive event:

<arc:info title="After Receive"  desc="This event is fired after receiving a file.">
  <input name="Filename"         desc="The name of the file that was sent." />
  <input name="FilePath"         desc="The path of the file that was received." />
  <input name="MessageId"        desc="The Id of the transmission." />
  <input name="ErrorMessage"     desc="If an error occurred, this will contain the error message." />
</arc:info>

** See Also