Like SOAP and REST Integration Points, new Custom Services are created in the Admin Console, using a New Integration Point wizard. The wizard for adding Custom Services is similar to that of other Integration Points in that it enables you to define request and response parameters and test your service. However, unlike the other wizards, the New Integration Point wizard features a code editor that allows you to write the required coding.

The procedure below is intended to familiarize you with the end-to-end high level workflow involved in adding a Custom Integration Point. Instructions and guidelines about the code structure, permitted node.js modules, and error handling are provided in the next article, Writing Code for a Custom Service. As you need to strictly adhere to these guidelines for your code to run successfully, you should review this article carefully before you begin. It is also recommended to refer to the structures of the sample Custom Integration Points before writing your own Custom Service.

To add a Custom Integration Point:

  1. At the top of the Web Service Integration Points page, click Add, and then select Custom.



    The New Custom Integration Point wizard opens.

  2. At the top of the page, enter a relevant name and description in the appropriate fields. 
  3. Define input parameters:
    For each parameter, in the Variable Type column, select the appropriate parameter type. Then, if desired, in the Variable Name column, change the default name to a more meaningful name. The name assigned in this column is the one displayed to users in the Interaction Designer.
  4. At the upper right corner of the page, click Next.
    The Compose page is displayed.

  5. Write the code for your Custom Service in the code editor of the Compose page. For details and guidelines, click here.
  6. At the upper right corner of the page, click Next
    The Response page is displayed.

  7. Map the response parameter(s) to variables available in the Interaction Designer. For more details about response mapping for a Custom Integration Point, click here.
  8. To test the service, click Test. For details about testing, refer to Checking Syntax and Debugging.
  9. At the upper right corner of the page, click Create.
    A confirmation message is displayed, and the new Integration Point is listed on the Web Service Integration Points page.

Revision:

Comments