Import Transaction, Query, and Third-party Web Services

You can import Web services as well as Transaction and Query scripts into your solution to enable features such as address and email verification.

Importing a service or script into your solution consists of three key actions:

  1. Import a Web service or script .
  2. Create field mappings to map fields in the script to fields in your form.
  3. Edit or re-mapping fields in the service or script.
Note:

If you plan to run Query scripts via Evolve, you must have the Winshuttle Function Module.

Note:

For third-party webservices we support webservices on SOAP 1.1 version only.

Supported Web service bindings and message types

Supported message types

Supported WSDL bindings

  • Input Messages
  • Output Messages
  • Input Headers
  • Output Headers

Unsupported message types

  • Fault Messages
  • base64binary
  • boolean
  • byte
  • date
  • dateTime
  • decimal
  • double
  • int
  • long
  • short
  • string
  • time
  • unsignedbyte

For Winshuttle Update plugin, the user returned by the runnernode parameter is used:

  • To get the credentials to log in to SAP, unless the webservice is configured with the System Account.

  • To validate the appropriate license, even if the webservice is configured with the System Account.

Import a Transaction or Query script

To import a Transaction Script or Query Script for use in your solution:

  1. Click the Solution tab.
  2. In the Solution pane, right-click Transaction Script or Query Script and then click Import.
  3. On the Import screen, click Choose File to browse to a script XML file and select the XML file.
  4. Click Next, and then see Creating a field mapping (below).

Import a Web service

To import a Web service for use in your solution:

  1. Click the Solution tab.
  2. In the Solution pane, right-click Web Services, and then click Import.
  3. On the Import pane, you will see the list of all the web service connections which are added at the global level or at the current app level. If necessary, type your credentials (Domain, Username, Password).
    Note:

    For more information on Web Service Connections, see the External Web Services page. Select the Web service you want to import into this solution.

  4. Click Next, and then see Creating a Field Mapping (below).

When working with RepeatingElements of any kind (Repeating Groups and/or Repeating Tables , for example) within a Web Service or elsewhere, ensure the following:

  • Any field within a Repeating Content folder within theForm Data tree is also in the form within a repeating container.
  • All non-repeating fields in the Form Data tree are non-repeating in the form.

Failure to follow the above guidelines may result in unintended behavior when working with repeating elements as you run a Web service.

Create a field mapping

To create field mapping for an imported Web service:

  1. In the Solution Pane, click Web Services to expand it.
  2. Right-click the Web service, and then click Create Field Mapping.
  3. Under Description, type a description for the Web service.
  4. Under Group Name, select a group from the menu or type a name for the Group. The name must begin with an alphabetic character or underscore, and it can contain only alphanumeric characters and underscores. The name can be the name of an existing group, or a new group that you want to create.

    Note:

    Selecting an existing Group along with the Use Existing Input/Output Fields will force the import to look to that specific group for existing fields.

  5. Check or uncheck Generating Repeating Section (as required).
  6. Select an upload option:

    • Single Upload - When you want to upload the records sequentially. It will be slower in comparison to the Bulk Upload option though. The logs get updated sequentially for each record as the upload gets completed.

    • Bulk Upload - When you want to upload the records in bulk. We recommend that you use this option when the number of records are less than 100. The logs get updated simultaneously with multiple entries (one for each record) as soon as the bulk upload is completed. If you want to access this bulk upload feature, please reach out to your Sales account representative for more details.

    Note:

    Notes:

    • This option is enabled only when you select the Generate Repeating Section check box.

    • It is not advised to use batch uploads for more than 100 records as it may lead to time-out issues.

    • This number may vary based on your form and it is advisable to test out with an Excel data source to determine the threshold value.

    • To change the web service import type to enable the bulk upload option for an existing script, either the mapping needs to be re-created or the script needs to be added again. You could also delete the mapping and create a new one.

  7. Under Web Service Name, type a name for the service.
  8. Under Operation, click the arrow and then select an operation from the menu. This is applicable to third-party web services only.
  9. Click Next to open the Editing Field Mappings box and then continue to Editing a Field Mapping (below), beginning with step 4.

Edit a field mapping

If you are using the same input value in more than one script, but do not wish to have the same field in your form more than once, you can change the way your fields are mapped.

  1. Click the Solution tab.
  2. In the Solution tree, expand Transaction Scripts, Query Scripts, or Web Services to view mapped scripts.
  3. Right-click a script mapping in the Solution tree and click Edit Field Mapping.
  4. Under Web Service Field, a list of fields will be displayed.
  5. In the Form Field column, click the drop-down menu to select the field that you want Web Service Field to map to. Do this for each field you want to map.
  6. Click OK.
Note:

Do not delete input fields from the form. Instead, enter the skip field indicator (the default is the / character), then hide the field so that it is not used. To skip a date field while posting , use value as 01/01/1700 in Date-picker. For more information, see the Skip Indicator sections in Run Settings for Transaction and Filter Mapper Settings. Deleting input fields will cause the script to upload a blank field and overwrite any existing value.

Further information:
  • If Use Existing Fields is checked, Solution Designer maps to form fields in the schema that have the same name. In the Form Field list, fields marked with an asterisk (*) indicate fields that do not yet exist in the schema and will be created – regardless of whether Use Existing fields is checked or not.
  • If Use Existing Fields is not checked and a field does not have an asterisk by it, Solution Designer will generate a new, unique field name using a suffix ‘_n’ (where n=a number).

The Use SAP Credentials checkbox is enabled if you are mapping to a Query or Transaction script. This option includes the SAP Credentials fields in the mapping and enables you to defer authentication to SAP for the person using the form.