Send Web Service Request

Web Service Request

• URL: Enter the URL of the web server that you want to send to. Alternatively, you can add a variable to specify the URL.

• Method: Select the web request HTTP method that you want to use. Options include POST, GET, PUT, DELETE, or HEAD.

• Content-type: Select the content type to use for the web request. Available when you select a POST or PUT method.

• HTTP Headers: Enter the HTTP header properties and values that you want to be sent with the web request. You can select from a dictionary of HTTP header properties and values, or you can add a variable to specify the header property or value. You can also add a special character to the value that you enter.

Source

• Content-Data: Specifies the content data that you want to be sent with a POST or PUT web request HTTP method. Available when you select POST or PUT for the Method property.

• Query String: Specifies the query string that you want to be sent with a GET, DELETE, or HEAD web request HTTP method. Available when you select GET, DELETE, or HEAD for the Method property.

  • Embedded Template:

    • Value: Use the input box to enter the template that you want the action to use. Alternatively, you can add a variable to specify the template or add a special character to the value that you enter.

    • Import: Opens the Open File dialog so that you can browse to and select a file that contains the script that you want. The contents of the file are imported into the Value input box.

    • Export: Opens the Save File dialog so that you can save the contents of the Value input box as an external file. You can save the value as a new file or replace the contents of an existing file.

    • Edit embedded value : Opens the Value for dialog, where you can edit the value of the embedded source.

  • Variable:

    • Variable: Enter the variable that you want to use for the source. Alternatively, click to select a recently used variable or to click More Variables to open the Insert Variable dialog.

  • External File:

    • Location: Specifies the file system where the source folder exists. File systems or locations can include local file systems or network shares, Librarian, or a supported cloud storage location. For more information about supported cloud storage locations, refer to the Administration Console Cloud Storage Page.

    • File Name: Specifies the file path. You can enter the folder location and file name or click Browse to locate and select the file that you want. Alternatively, you can add a variable to specify the file or add a special character to the value that you enter.

    • File Encoding: Specifies the encoding that is used by the source file.

  • HTTP Request Variable:

    • Variable Name: Specifies the variable name for the HTTP request variable that you want to use as the source.

    • Value: Specifies the value for the HTTP request variable.

Authentication

• Method: Specifies the authentication method that the action uses to connect to the client.

  • Anonymous: Specifies that any user can access the client without providing a user name and password.

  • Use current Windows credentials: Specifies that the current Windows user account is used to connect to the client.

  • Use specified credentials: Specifies that the user name, domain, and password that you provide are used to connect to the client.

Response

• Successful Status Codes: Specifies the status codes that you deem successful.

• Save Response to Variable: Specifies the variable to which you want to save the web service response. Enter the variable that you want in the input box. Alternatively, you can add a variable.

Advanced Options

• Wrap source content in SOAP Body tag: Specifies that the source content is wrapped in a SOAP Body tag before being sent. Available when you select POST or PUT for the Method property.

• Send Timeout: Specifies the amount of time in seconds to wait for a response from the client before the action fails.

• Retry Count: Specifies the number of times to re-send the request if the action fails.

Action

• Name: Specifies the name of the action. You can replace the default name by entering a new name in the field.

• Description: Specifies a description for the action.

• Run Action: Specifies how often you want the action to run.

  • Always: Specifies that the action runs each time the event occurs.

  • Never: Specifies that the action does not run when the event occurs.

  • Conditionally, based on variable: Specifies that the action runs only when a selected variable meets a specified condition. Use this option in situations in which there is only one condition that determines whether the action runs. After you select this option, you can create the conditional statement in the input box.

    Input box controls

    • Variable: Specifies the variable that you want to use for the conditional statement. Enter the variable in the input box. Click to see a list of recently used variables or click More Variables to open the Insert Variable dialog.

    • [Relational Operator]: Specifies the relational operator to use for the conditional statement. Click the existing operator to display a list of additional operators, and then click the one that you want to use. For more information, refer to Relational Operators. The operators that are available in the list depend on whether you selected Text or Decimal for the Type option.

    • Value: Specifies the values to use for the conditional statement. To add a value, click , click <enter a value>, enter the value that you want, and then press Enter. To delete a value, use the secondary mouse button to click it, and then click Delete. Some operators, such as Is blank and Is not blank, do not require a value to be specified. In these situations, the Value field is not available.

    • Type: Specifies whether the conditional statement is evaluating a text or decimal value.

  • Conditionally, based on expression: Specifies the conditions under which the action runs. Use this option for situations that require more than one conditional statement. When you select this option, you can create the conditional expression in the input box by creating the conditional statements that you want. You create and edit your conditional expression on the Tree View tab. Click the Text View tab to see a read-only text view of the conditional expression.

    Input box controls (Tree View tab)

    • [Conditional Joiner]: Specifies the conditional joiner for the conditional statements within the group. The default conditional joiner is And.

      Click the existing conditional joiner to display a menu that you can use to configure your conditional expression in one of the following ways:

      • And, Or, NotAnd, NotOr: Click the conditional joiner in the list that you want to use for the conditional statements. For more information about the supported conditional joiners, refer to Conditional Joiners.

      • Add Condition: Click to add another conditional statement to the current group.

      • Add Group: Click to add a subgroup of conditional statements to the current group.

      • Remove Group: Click to delete the subgroup. Available when you open the menu from a subgroup.

      • Clear All: Click to delete all conditional statements (including subgroups). Available when you open the menu from the top-most group.

    • : Adds a conditional statement to the group that is associated with that joiner. Visible to the right of each conditional joiner in your expression.

    • :  Deletes the conditional statement. Visible to the right of an existing conditional statement when you point to the statement.

    • Variable: Specifies the variable that you want to use for the conditional statement. Enter the variable in the input box. Click to see a list of recently used variables or click More Variables to open the Insert Variable dialog.

    • [Relational Operator]: Specifies the relational operator to use for the conditional statement. Click the existing operator to display a list of additional operators, and then click the one that you want to use. For more information, refer to Relational Operators. The operators that are available in the list depend on whether you selected Text or Decimal for the Type option.

    • Value: Specifies the values to use for the conditional statement. To add a value, click , click <enter a value>, enter the value that you want, and then press Enter. To delete a value, use the secondary mouse button to click it, and then click Delete. Some operators, such as Is blank and Is not blank, do not require a value to be specified. In these situations, the Value field is not available.

    • Type: Specifies whether the conditional statement is evaluating a text or decimal value.

Error Handling and Diagnostics

• Ignore errors and continue running actions: Specifies that if the action fails, the remaining actions continue to run. When this option is not selected and the action fails, the resulting behavior depends on several factors, as follows:

  The action is within a Group action

  • If you specified Sequentially for the Execute Actions property on the Group action's Execution tab, no further actions within that Group action are run. No actions outside of this Group action are affected.

  • If you specified In Parallel for the Execute Actions property on the Group action's Execution tab, the errors are ignored, and the other actions within that Group action are run. No actions outside of this Group action are affected.

  The action is not within a Group action

  • If you specified Sequentially for the Execute Actions property on the event's Execution tab, no further actions within the event are run.

  • If you specified In Parallel for the Execute Actions property on the event's Execution tab, the errors are ignored, and the other actions within the event are run.

• Retry if failed: Specifies that if the action fails, BarTender tries to run it again.

  • Maximum retries: Specifies the maximum number of times that BarTender tries to run the action again. Available when the Retry if failed option is selected.

  • Retry interval: Specifies the length of time that BarTender waits after the action fails before it tries to run the action again. Available when the Retry if failed option is selected.