Call Web Service - Workflow - English - Foundation 22.1 - OnBase - Premier - external - Standard - Premier - Standard

Workflow

Platform
OnBase
Product
Workflow
Release
Foundation 22.1
License
Premier
Standard

The call web service action allows a user to call a method exposed via a web service. The action provides a wrapper around the .NET framework classes that handle calling methods in web services.

Note:

This action is not supported in the Classic Client interface.

Features of this Action

  • Supports complex data types including arrays of nested complex data types.

  • Retrieves the information about complex types from the WSDL.

  • Supports SOAP headers as inputs, outputs or by reference (input and output).

  • Retrieves the information about SOAP headers from the WSDL.

  • Allows the user to decide whether the task list execution should be broken if there was an issue calling the web service.

  • Supports multiple protocols: HTTP GET, HTTP POST, SOAP 1.1 and SOAP 1.2.

  • Supports mapping to system keywords.

  • Supports the following .NET primitive data types and their nullable data types: System.Boolean, System.Byte, System.Char, System.DateTime, System.Decimal, System.Double, System.Int16, System.Int32, System.Int64, System.SByte, System.Single, System.String, System.UInt16, System.UInt32, System.UInt64

    Note:

    Nullable data types will be converted to their non-nullable data type before being added to the property bag.

  • Has limited support for the System.Xml.XmlAttribute data type.

  • Supports mapping to constant values containing tokens.

  • Supports mapping to constant values containing arrays.

  • Allows the user to test that the application server can successfully call the web service from the Configuration module.

Limitations of this Action

  • Does not support the Data Set data type.

  • Does not allow mapping to the InnerText or InnerXml properties of the System.Xml.XmlAttribute data type. This limits the user to specifying a single value for a SOAP header.

Configuring this Action

To configure this action:

  1. Click Configure. The WSDL dialog box is displayed.
  2. You can either select a configured WSDL location from the drop-down list or, with >> Use the specified WSDL Location selected in the drop-down list, enter the location of the WSDL file used by the Web Service in the field. The location value cannot exceed 255 characters.
    Note:

    OnBase Studio supports case-sensitivity when configuring a WSDL web service path. This functionality is not respected in the Configuration module. Any web service that requires case-sensitivity must be configured within OnBase Studio.

  3. If you do not want to store the WSDL within the action configuration, but want to retrieve the WSDL the first time the action is executed, select the Retrieve WSDL at execution time option.
    Note:

    If the WSDL imports schemas from other files or URLs, the action must be configured to retrieve the WSDL at execution time.

  4. If the service requires authentication, select the Requires Authentication check box.
  5. Click OK.
  6. If the service required authentication, the Authentication dialog box is displayed. Enter the User Name, Password, and Confirm Password credentials and click OK.
  7. Select the Protocol from the drop-down list.
  8. Select a method using the Method drop-down list.
  9. Click Mappings. The Mappings dialog box is displayed.
  10. Select a parameter. The None, Keyword, Property, and Constant Value mapping properties are enabled. Keyword maps to the Keyword Type selected from the drop-down list. Property maps to the property specified in the field. Constant Value maps to the value entered in the field.
  11. Select the appropriate mapping option.

    If the user maps an item to a constant value the two check boxes become available and are:

    • Parse tokens (%K, %D etc…)- This tells the action that before it uses the constant value it should parse any tokens.

    The following symbols can be used:

    Symbol

    Description

    %#

    Displays the Document Handle of the current document.

    %B

    Displays the Institution Name assigned to the current document.

    Note:

    This symbol is only applicable when used with an Institutional Database.

    %C

    Displays the name of the user who created the current document.

    %D or %D2

    Displays the Document Date. This value can be changed.

    %D1

    Displays the date that the document was stored. This value cannot be changed.

    %I1 or %T

    Displays the time that the document was stored. This value cannot be changed.

    %K

    Displays a configured Keyword Value.

    %K#.n

    Displays the Keyword Value of Keyword Type # n times. For example, %K00101.4 would display up to 4 unique Keyword Values for Keyword Type 101 for a single document.

    For some functionality, a Keyword Type drop-down list may be available to configure this. Select a Keyword Type from the drop-down list, enter the number of times you want the Keyword Value to be displayed in the Repeat field, and click Keyword. The value in the Repeat field specifies how many instances of the Keyword Value will be displayed. Entering an * character will pull all existing Keyword Values for display up to 99 instances.

    Note:

    When using the Classic Client interface, double digits in the Repeat field are not supported.

    %L

    Displays the life cycle number of the current document.

    %L2

    Displays the life cycle name of the current document.

    %M

    Extracts metadata values from items. This includes attribute values from WorkView objects or a field values from an Entity item.

    %M must be followed by the metadata value you want to extract. For example, if you want to extract the value of a WorkView attribute called Name, it would be %MName.

    The token strings can contain nested expressions. Example, a nested WorkView attribute: %MVendor.Buyer.Name.

    %N

    Displays the name of the document.

    %P

    Displays the number of notes present on the document.

    %Q

    Displays the queue number of the current document.

    Note:

    This token will not have a value when used outside of a life cycle as part of a System Task.

    %Q2

    Displays the queue name of the current document.

    Note:

    This token will not have a value when used outside of a life cycle as part of a System Task.

    %R

    Displays the real name of the currently logged in user.

    %U

    Displays the user name of the currently logged in user who executed the task.

    %V###

    Displays the value of a configured Workflow property. For example, to display the value for the property “Color”, this symbol would be configured %VColor.

    Note:

    In the Core-based interfaces, if a property contains an array of values, all property values will be used.

    Note:

    If a property name has spaces, using %V to display the property value will not preserve the spaces, and therefore, the property will not be correctly identified.

    The following symbols are not supported in the Classic Client interface:

    • %L [life cycle ID]

    • %L2 [life cycle name]

    • %Q [queue ID]

    • %Q2 [queue name]

    %M [item metadata value] is not supported in the Classic OnBase Client interface or the Core-Based OnBase Client interface.

    • The value is an array (separated by commas)- This is only useful for items that are arrays. It allows the user to specify a list of values (separated by commas) to send.

  12. Click Map.
  13. Repeat steps 8 through 12 for each method and parameter.
  14. Click OK.
    Note:

    If the location of a service is modified, mappings will persist if the method associated with the mappings exists in the service in the new location.