Function documentationTransaction Calls Using URLs Locate this document in the navigation structure

 

You can use the following URL to run a transaction: http://<servername>/XMII/Runner?

Features

You can pass parameters to a transaction through the URL. You may have different parameters for each transaction. You can pass the following predefined command line parameters to the Web service:

Parameter

Description

Transaction

Folder and transaction name of the transaction you want to run.

(<folder>/<transactionname>)

If the transaction is in the root folder, you only need to specify the transaction name. This parameter is required.

LogType

Debugging level.

The value can be one of the following:

  • TraceDebug: Displays detailed trace information about each action

  • Debug: Displays debug information of each action start and end with few internal trace messages

  • Info (Default): Provides information about each action start and end

  • Warn: Displays only warnings, error, and fatal messages about the transaction execution

  • Error: Displays only error and fatal messages about the transaction execution

  • Fatal: Shows only fatal messages about the transaction execution

  • Advanced: Displays further action steps and the history of transaction execution.

InputParameter

Name of the transaction property to which you want to post a document. The default value is null.

<transactionParamName>

OutputParameter

Property value returned from the transaction. The default value is null.

If you pass the wildcard value *, all non-XML data type property values are returned. You can return XML data type values individually by explicitly referencing them using this parameter.

<transactionParamName,*>

Expiration

The amount of time to retain transaction information in the database from the end of execution. Only applies when Persistence is set to Always or OnError. The default value is six hours, or 21,600,000 milliseconds.

<expirationTimeInMilliseconds>

Persistence

Controls the persistence of the transaction into the Transaction Manager database. The value can be one of the following:

  • Always (Default)

  • OnError

  • Never

IsAsync

Controls the transaction runtime environment. If the value is false, which is the default, the response is generated after the transaction executes. If the value is true, the transaction runs after the URL response is returned. To validate the response, check the Transaction Manager.

IsBinaryInput

If the value is true, the post data is treated as binary data. The default value is false.

IsBinary

If the value is true, the output is encoded as binary data. The default value is false.

<transactionPropertyName>

Transaction property name-value pair

<transactionPropertyValue>

StoreTransactionOutput

Controls the persistence of the transaction output to the database. Only applies when Persistence is set to Always or OnError. The default value is false.

Content-Type

The response data structure returned from the URL call. For example, text/xml, text/html.

Example

You want to call a transaction named YieldCalc in the Test folder. You want to pass a value of 10.0 to the YieldFactor input parameter and return the YieldAverage transaction property.

To do so, use the following URL:

http://<servername>/XMII/Runner?Transaction=Test/YieldCalc&YieldFactor=10.0&OutputParameter=YieldAverage

The default response is similar to the following:

<Rowsets DateCreated="2009-12-23T16:52:53"EndDate="2009-12-23T16:52:53"

<Rowset>

<Columns>

<Column Name="YieldAverage" SourceColumn="YieldAverage" Description=""SQLDataType="8"MinRange="0"MaxRange="0" />

</Columns>

<Row>

<YieldAverage>62.308633176</YieldAverage>

</Row>

</Rowset>

</Rowsets>