Create a Web service call

For each web service that has been created, you can create one or more calls. For example, the Call ML Web service has two calls, one to change the password and one to carry out the Call ML search.

To create a Web service call:

1. Open Utilities application and select Custom Data and Mappings.
2. Click on the XML Gateway tab or you can click on the XML Gateway item on the tree on the left of the screen. The XML Gateway screen displays, Web services at the top and Web service calls in the bottom half.
3. Select the Web service the call is for in the upper half of the screen and then click on the Create button in the lower half of the screen.
   
   The Web Service Call Details screen displays.
• Main Details tab
• Name. Enter a suitable name for the Web service.
• Call Type. Drop-down with selection of Web, File or Lookup:
• Web - if connecting to an external web service.
• File - if importing data from a file with a set name.
• Lookup - if importing data from a file with an unknown name.
• Call/File Name.* Enter the relevant call or file name, depending on the Call type selected.
• Save sent XML into Document Management.* Not currently used.
• Save received XML file into Document Management. Not currently used.
• Run automatically when file is available.* Allows the import process to run when the named file becomes available. Displays when the File call type is selected. When selected a field displays to hold the email address to send a notification when an import has been run.
• E-mail address to notify on completion.* A notification is sent to the email address when an import has been run.
• Send XML tab
• Text tab. Enter the XML coding in plain text.
• XML tab. Enter the XML coding.
• Mappings tab. Map the XML node or attribute to the Variable/Value column for the information to be passed to the Web service. Fields can also have hard coded information added by enclosing it in quotation marks, e.g. fee earner or branch details.
• Preview tab. Displays a preview of the mapping that will be sent.
• Receive XML tab
• Process. Allows you to add procedures and sub procedures, set variables and select a matter workflow. See Process for more details.
• Text tab. Enter the XML coding in plain text.
• XML tab. Enter the XML coding.
• Mappings tab. Map the XML node or attribute to the Variable/Value column for the information to be passed to the Web service by dragging the field or you can type in the field name. Fields can also have hard coded information added by enclosing it in quotation marks, e.g. fee earner "ALN" or branch details "001" or "Grantham".

Note ALB does not allow for NULL fields, so if there are any variables that do not have data in the import file, enter "" against them.

* Dependent on Call Type selection

4. Click OK to save the details and return to the Custom Data and Mappings screen or click Save to save the information and remain in the Web Service Details dialog box.

To Edit a Web Service Call

1. Open Utilities application and select Custom Data and Mappings.
2. Click on the XML Gateway tab or you can click on the XML Gateway item on the tree on the left of the screen.
3. Select the Web Service Call from the bottom half of the screen and click Edit.
4. Amend the Web Service Call Details dialog as required and click OK to save the details and return to the Custom Data and Mappings screen or click Save to save the information and remain in the Web Service Details dialog box.

To Copy a Web Service Call

1. Open Utilities application and select Custom Data and Mappings.
2. Click on the XML Gateway tab or you can click on the XML Gateway item on the tree on the left of the screen.
3. Select the Web Service Call from the bottom half of the screen and click Copy.
4. The Web Service Call Details window opens with the copied details of the web service with (1) appended to the name. Amend the name as required and click OK or Save if you wish to make further amendments.

To Delete a Web Service Call

1. Open Utilities application and select Custom Data and Mappings.
2. Click on the XML Gateway tab or you can click on the XML Gateway item on the tree on the left of the screen.
3. Select the Web Service Call from the bottom half of the screen and click Delete.
4. A message displays "OK to delete Web Service Call?

Note Any history for it will also be deleted!". Click Yes to confirm the delete instruction or No to cancel out.