Perceptive TransForm Web Services Autowrite

Transcription

1 Perceptive TransForm Web Services Autowrite Getting Started Guide Version 8.10.x

2 Overview The release of TransForm provides the ability to transmit form data using a web service as the destination through Autowrite. SOAP 1.1 and 1.2 are the currently supported web service types. REST web services will be supported at a later date. Configure Autowrite via Web Services You can configure Web Service Endpoint and Operations through the WS Integration menu, if the EFM instance is appropriately licensed. To configure Autowrite through Web Services, complete the following steps. 1. On the Administration tab, configure a Web Service Endpoint. 2. On the Administration tab, configure a Web Service Autowrite Operation. 3. On the Catalog tab, configure an Autowrite handler or configure a workflow action that performs a Web Service Autowrite action. Perceptive TransForm Web Services Autowrite Getting Started Guide Page 2

3 Configure a Web Service Endpoint In the context of Autowrite, a Web Service Endpoint in E-Forms Manager contains the definition of an endpoint that publishes data consuming web services. A single endpoint can be referenced in the configuration of many Web Service Operations. Attribute Name Attribute Description Example Endpoint Name Endpoint Address SOAP Binding Name SOAP Binding Version Authentication Type Unique, descriptive name for the endpoint. This name is be used to identify the endpoint in other areas of the application. The address to use to communicate with the target service. Enter the name of the SOAP Binding that contains the operations that are used from this endpoint. Currently, only SOAP 1.1 and SOAP 1.2 are supported. Type of security is used by this endpoint, if any. WebServiceEndpointOne Note Names can only contain letters, digits, dashes, and underscore characters. CatalogSoap11 The following security schemes are currently supported: None HTTP Basic WSS Username - Password Text WSS Username - Password Digest Web Service Operation Perceptive TransForm Web Services Autowrite Getting Started Guide Page 3

4 Attribute Name Attribute Description Example Login Operation Logout Operation Username Password If Web Service Operation is set as the Authentication Type, this will be the Web Service Operation configured in E-Forms Manager to perform a login for this endpoint. This is not used for other Authentication Types. If Web Service Operation is set as the Authentication Type, this will be the Web Service Operation configured in E-Forms Manager to perform a log out for this endpoint. This is not used for other Authentication Types. This will be used as credentials for HTTP Basic and WSS Authentication Types. This is not used for None and Web Service Operation Authentication Types. This will be used as credentials for HTTP Basic and WSS Authentication Types. This is not used for None and Web Service Operation Authentication Types. WebServiceLoginOperationName WebServiceLogoutOperationName Perceptive TransForm Web Services Autowrite Getting Started Guide Page 4

5 Configure an Autowrite Web Service Operation An Autowrite Web Service Operation configured in E-Forms Manager contains the definition of a single, web service used to receive the information contained within a form submission. The values consumed by the service are logically represented in E-Forms Manager by Web Service Operation Aliases. These aliases are configured during the creation of a Web Service Operation and are used to map to the data within the E-Forms submission during Autowrite operations. Attribute Name Attribute Description Example Operation Name Endpoint Unique, descriptive name for the operation. This name will be used to identify the operation in other areas of the application. The Web Service Endpoint that contains this operation. WebServiceOperationOne Note Names can only contain letters, digits, dashes, and underscore characters. # of Expected Results The number of records returned from the operation. SOAP Operation Name The name must correspond to the name of the operation specified in the operation element in the WSDL. Use the Select from WSDL link to launch the WSDL Configuration utility. GetFormCategories Perceptive TransForm Web Services Autowrite Getting Started Guide Page 5

6 Attribute Name Attribute Description Example SOAP Action One-Way? Request Template Optionally, the SOAP Action for this operation. Specifies if the operation is unidirectional. Enter the SOAP envelope that will be used for all requests for this operation. Form, dialog, request, constant, and operation parameters can be specified in the template. View the E-Forms Manager online for more information. Y/N <s11:envelope xmlns:s11=' soap/envelope/'> <s11:body> <ns1:addemployee xmlns:ns1=' test.efm.transform.com/'> <!-- optional --> <employeeinfo> <!-- optional --> <firstname>?xxx?</firstname> <!-- optional --> <lastname>?xxx?</lastname> <!-- optional --> <title>?xxx?</title> </employeeinfo> </ns1:addemployee> </s11:body> </s11:envelope> In the final step, you must configure the Web Service Operation Aliases for the data elements being sent from the form to the service. You must enter the XPath to the element in the request template for each alias. You may find an XML editor helpful in deriving this information from the message returned from the operation. XML Copy Editor is one such utility and can be downloaded from the following location. Perceptive TransForm Web Services Autowrite Getting Started Guide Page 6

7 Attribute Name Attribute Description Example Alias Name XPath XPath Result Type Parent Alias Default Form Fields Unique, descriptive name for the operation alias. This name will be used to identify the data element in other areas of the application. The XPath to the source data element. Node or Text If the alias resolves to a value, it is a Text result type. If the alias resolves to an attribute group, it is a Node result type. Only required if the Alias is a Text result type and is a participant in a Node group of Aliases. A comma delimited list of form field to automatically map to this alias. OperationOne_ALIAS_FNAME /*[localname()='addemployee']/employeeinfo/l astname FIELD1, FIELD2, FIELD3 Perceptive TransForm Web Services Autowrite Getting Started Guide Page 7

8 WSDL Configuration utility 1. Launch the WSDL Configuration utility by clicking the Select from WSDL link, under the SOAP Operation Name header. This launches a multi-screen wizard to assist in the construction of a valid Request Template value. 2. Enter the URL to the WSDL or select it for upload from a file on your file system. 3. Once you have identified the WSDL, a list of valid SOAP Operations displays. 4. After selecting the desired SOAP Operation, a summary appears. You can go back and make any necessary changes, or click Finish to save. Perceptive TransForm Web Services Autowrite Getting Started Guide Page 8

9 Configure published form 1. Navigate to the form you wish to configure for Autowrite through Web Services. 2. Create a new Autowrite handler using the New WS Autowrite Handler link. 3. Enter the requested information on the Autowrite Handler Setup screen. 4. Select the Operation where you want the handler to send form data. 5. Map the aliases to the form fields you want to populate with data from the web service call using the web service operation aliases and form field names. Perceptive TransForm Web Services Autowrite Getting Started Guide Page 9

10 6. Once you complete the mappings, click Finish to save the Autowrite handler. Enable Autowrite and the correct handler(s) for this form. Workflow configuration You can also configure a form to perform a Web Services Autowrite during Workflow execution. 1. To configure Autowrite during Workflow, navigate to the Workflow > Autowrite Handlers > Web Services tab and select New WS Autowrite Handler. 2. This link launches the same wizard described above, but makes the handler applicable for use in Workflow. Perceptive TransForm Web Services Autowrite Getting Started Guide Page 10

11 3. After the handler is created, you can create an action that is called through a Submission or Callable rule. Select Perform Web Services Autowrite as the Action Type. 4. On the next screen select the handler you want to use to perform the Web Services Autowrite Action. Perceptive TransForm Web Services Autowrite Getting Started Guide Page 11