About the EffectConnect category

Alumio_Bot · September 21, 2022, 11:17am

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

Extra information

System documentation: EffectConnect API Reference

Connector package documentation

1. Setting up HTTP Client EffectConnect

1.1 Steps

In the Alumio Dashboard, go to Clients → HTTP Clients. Create a new HTTP Client.
Select EffectConnect HTTP Client as PlatForm and click next step
Fill in the Base URI.
(For more information, see EffectConnect Reference)
Click the next step, fill in the name of the HTTP Client, and finally, you can save the HTTP Client for use.

image1790×686 36 KB

2. Subscribing to Entities from EffectConnect

2.1 Steps

Go to Connections → Incoming, create a new incoming configuration, and select Effectconnect Subscriber as the subscriber.
Select the entity you want to subscribe from Effectconnect.
Add public key, secret key, and any request parameters needed to subscribe to the entity (optional).
Select the Effectconnect HTTP Client to use
You can optionally add a transformer to transform the request parameters into something you will request from EffectConnect.
You can also optionally enable pagination to allow Alumio to fetch paginated entities.

2.2 General Concept

We follow EffectConnect documentation on building this connector, so you can easily use the connector based on EffectConnect API Reference.

Entity

It’s the entity you want to subscribe from Effectconnect. Please refer to the entities in Management APIs from the EffectConnect API Reference page.

Request Parameters

These are the parameters you can provide to get the needed entity based on Effectconnect API Reference. Please look at the example below on how to fill Request Parameters when subscribing Process Status

That’s why we need to define the ID property inside the process property in the Request Parameters field. Based on the documentation, it only provides XML examples. We can convert XML to JSON using XML to JSON Converter Online to convert XML to JSON String, URL and File.

Alumio will then make a request to EffectConnect with the URL /process

Path is the path parameter of the url. For example, the {id}.
Query is a defined set of parameters attached to the end of a url.
Example: URL.com - MediaOptions
Payload is the data contained within a request.

Input Transformer

Any transformers set here will be executed after the Request Parameters are loaded. So, you can add any transformer to provide and transform the request parameters into anything you need, either as path parameters and/or as query parameters of an entity.

HTTP Client

The HTTP Client configuration you will use to access EffectConnect.

3. Publishing Entity to EffectConnect

3.1 Steps

Go to Connections → Outgoing, create a new outgoing configuration, and select “EffectConnect Publisher” as the publisher.
Select the Method you want the publisher to use with the data.
Select the EffectConnect entity to which the data will be published.
You can optionally add any query data to the request on the key query.
You can optionally add any payload data to the request on the key payload.
Select the HTTP Client to use.

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). However, you can also add or modify payload using the Request Transformer.

Method

Currently, we support POST and PUT methods.