Developer

XML via HTTP Step Request Argument

An HTTP Request Argument is a child definition to the XML via HTTP step definition, defining the data values passed as arguments to the parent step’s defined URL. Included in the request argument definition is the type of request and the property value or other data value in scope for the step to be passed as the argument. Request arguments also have a data type, which specifies the source for the argument’s data.

A request argument is defined for the parent step only when it is necessary to pass arguments to the step’s defined URL request. The request allows for access to the property values of the definition for which the step was defined, as well as values at the user or application level via the SDML. A fixed string value may also be defined to passed as the argument.

The values accessed via the SDML can be contained in either a small or large markup value. Both allow for the use of HTML markup text. The difference between these two items is the manner in which the markup is stored. For a small markup argument, a single field that can contain one line of markup text is available within the request argument.

Each of these data sources is a different data type within the request argument. A data type is selected first within the definition, followed by the specific value of that type.

The argument itself also has a type. This may be one of CGI Argument, Cookie, HTTP Header, or XML Body. The selection of the argument type specifies how the data for the request argument is passed to the URL defined in the parent step definition.

A given XML via HTTP step can contain multiple arguments. All arguments are listed within the Properties View of the parent step definition. Within this list, the position of each request argument definition specifies the order in which the arguments will be passed to the URL request. This order can be changed by moving the arguments up or down within the list.

Request Argument Attributes

  • Argument Type: This attribute specifies how the data within the argument will be passed to the URL defined in the parent step definition. This may be one of CGI Argument, Cookie, HTTP Header, or XML Body.
  • Name: Contains the unique internal name of the request argument. This value must be unique among all request arguments within the same step definition. The field label in the Editor for this attribute will change based on the selection of the Argument Type attribute.
  • Data Type: This attribute specifies the type of the data for the argument. This selection determines the source for the argument data within the mobile application.
    • Fixed String: This selection specifies the argument will be a plain text value. When this is selected the String attribute will be enabled, allowing for the entry of text value to be passed for the argument.
    • Large Markup: This selection specifies the argument will be HTML markup. The markup text will be stored in a text file. This file is accessible on the Agentry Development Server for the application project and may be edited directly from this location, or from within the Agentry Editor. The relative path and name for this file is listed in the Markup File attribute, which is enabled when the “Large Markup” type is selected in the Data Type attribute.
    • Property Path: This selection specifies that the argument value is contained in a property of the definition for which the parent step has been defined. When this selection is made the Property Path attribute is enabled, where the property can be selected.
    • Small Markup: This selection specifies the argument will be HTML markup. The markup text will be entered in the Markup Text attribute field, which will be enabled for this selection. This argument Data Type allows for a single line of HTML markup to be entered for the argument.
    • User ID: This selection specifies that user’s login ID for the Agentry Client is passed as the argument value. No other attributes are enabled in relation to this selection.
  • String: This attribute is enabled when the Data Type attribute is set to Fixed String. The String attribute contains the plain text value passed as the argument value to the parent step’s URL request.
  • Mask in Log: This attribute can be set to hide the value of the argument in logs generated by the Agentry Server. in place of the value, a series of asterisks is recorded. Typically this is used for passwords and other sensitive values.
  • Markup File: This attribute is enabled when the Data Type attribute is set to Large Markup. The Markup File attribute lists the relative path and file name for the text file containing the HTML markup text. This path is relative to the Agentry Development Server’s installation location. The default value is the location:
    ServerDirectory\Application\Development\Scripts
    

    where ServerDirectory is the installation location for the development server. This path may be changed, relative to this location, though this is rarely necessary for this definition type.

  • Property Path: This attribute is enabled when the Data Type attribute is set to Property Path. The Property Path attribute references the property definition within the definition for which the parent step was defined. The value of this property will the value passed as the argument to the parent step’s URL request.
  • Markup Text: This attribute is enabled when the Data Type attribute is set to Small Markup. The Markup Text attribute can contain a single line of HTML markup text that will be passed as the argument to the parent step’s URL request.