About the Sherpaan category

Alumio_Bot · September 21, 2022, 11:03am

Add topics about this connector package here.
Always check the ‘How to use the Alumio connector packages’ topic.

Extra information

System documentation: Sherpa API - Sherpaan.nl

Connector package documentation

1. Setting up HTTP Client Sherpaan

1.1 Steps

In the Alumio Dashboard, go to Clients > SOAP Client. Create a new SOAP Client and select the Sherpaan Soap Client as the prototype of the SOAP Client.
Fill in the WSDL URI, SOAP Version, Storage for Cache (Optional), HTTP Client (use Default if none)
Save the HTTP Client.

2. Subscribing to Entities from Sherpaan

2.1 Steps

Go to Connections → Incoming and create a new incoming configuration and select Sherpaan Subscriber as the subscriber.
Select the Method you want to subscribe from Sherpaan.
(Optional) Add any request parameters needed to subscribe to the entity.
You can optionally add a transformer to transform the request parameters into something you need.
Select the Sherpaan HTTP Client to use for the SOAP Client.

2.2 General Concept

We followed the Sherpaan documentation when building this connector, so you can easily use the connector based on the Sherpaan API Reference.

Method

This is the operation you can subscribe to from Sherpaan.
Please refer to the reference in SherpaService Web Service.

Request Parameters

These are the parameters you can provide to get the required method based on the Sherpaan API Reference, the Request Parameters provided in the JSON Schema, and it will be encoded into XML based on the SOAP Version. Please look at the example below on how to fill the Request Parameters field when subscribing to the “GetResponse” Method.

Input Transformer

Any transformers set here will be executed after the Request Parameters are loaded.
So, you can basically add any transformer to provide and transform the request parameters into anything you need.

SOAP Client

This is the SOAP Client configuration you will use to access Sherpaan.

3. Publishing entity to Sherpaan

3.1 Steps

Go to Connections → Outgoing, create a new outgoing configuration and select Sherpaan Publisher as the publisher.
Select the Sherpaan Method you want the data to be published to.
Select the Sherpaan HTTP Client to use for the SOAP Client.

3.2 General Concept

Like the subscriber, the publisher has similar methods on how to use it.
The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration).

Method

This is the operation you can subscribe to from Sherpaan. Please refer to the reference in SherpaService Web Service.

For Methods that require an object as the request payload, please look at the example below. For example, we want to Create a Thread. Please select “Orderinfo”” as the Method of the publisher.

Alumio will send all the data into Sherpaan, here is an example of the Method we just used.