LLodi Agent

Last updated 9 days ago

To see all the features for the LLodi Agent Module, visit the API Reference.

Functionalities:

  • Provides a server-side environment to make your request.

  • Manages your authentication credentials for different APIs (LLodi Agent supports OAuth2 authentication).

  • Provides some out-of-the-box functionality for Qlik Sense.

  • Offers some built-in services like SMS, Twitter or Email.

Installation

For the moment it is required to contact with LLodi Support to get and install your LLodi Agent instance.

Basic Configuration

Ports and Certificates

LLodi Agent supports both HTTP (by default, port 8088) and HTTPS (by default, port 8089).

You can modify the ports in your configuration tab.

Be sure that the chosen ports are available and open from where you are going to call them

Note that if you change the port it will change the url of your LLodi Agent

{protocol}://{url}:{port}

To use HTTPS you must upload a certificate (PFX or PEM)in the configuration tab. When your certificate is correctly uploaded, the status will be "Active".

LLodi Key

To add an additional layer of security you can require a LLodi Key to be added to any request to your Agent.

Click on Refresh button to update your LLodi Key

LLodi Key is a unique GUID defined and activated from your Agent. When enabled, it becomes required as the llodi-key header for any request. See line 12 in the example below.

Example from Qlik script using LLodi Connector
LIB CONNECT TO 'LLodi Writer Connector';
SELECT *
FROM MailAgent
WITH GUID 123l4567-8l9o-0d1i-2a3l-456l7890od1i
WITH FIELDS (
to "fakename.smith@llodi.com",
subject "Important Email from LLodi!",
html "<b>WOW</b><p>Great job!</p><h1>Using LLodi mail is very cool</h1>:)"
)
WITH CONNECTION (HTTPHEADER "Content-Type" "application/json",
URL " https://server.llodiserver.com:8089/email",
HTTPHEADER "llodi-key" "6f473260-1234-e433-98yt-2e1nov040159"
);

White-Lists

When enabled Whitelist feature will accept only IPs or domains on the list, blocking all others.

You can add your IP or domain to the list just clicking on the save button

Connections

This setting is for the Proxy feature.

To use a created connection, add the header "llodi-auth" with the name of the connection as a value.

Creating a connection

You can use LLodi Agent to manage your authentication credentials. Connection types supported are: Oauth2, API-key, Basic and JWT.

You will need some data from your app to create the connection

To manage your stored credentials, select them in the side menu. You can test, update or delete your existing connections.

Encrypted Fields as Password or Client Secret must be filled anytime a connection is updated.

Credentials

Some features of the Agent (Qlik, Email, SMS, Twitter) require you to add some credentials.

Adding an Email Account

To add your email credentials just choose your email service in the dropdown, or configure your custom connection.

You can choose the authentication type

Use it.

Getting a SMS service.

We integrate Nexmo and Twilio, but you’ll need to sign up for a Nexmo or Twilio account to get started.

You must use either Nexmo or Twilio, both can't be active at the same time.

Switch between SMS services clicking on "Update"

Use it.

Connecting your Twitter

To be able to send Tweets you must provide your Twitter Keys.

Note that you must apply for a Twitter developer account to get your keys and complete the connection.

Use it.

Linking your Agent to a Qlik Sense Server

To connect your Agent and Qlik Sense Server it is required to upload a certificate and define the hostname of the server where Qlik Sense is installed.

If you need some help to connect using certificates check this Qlik Help page.

Use it.

Using your LLodi Agent

Find out your Agent's URL

{protocol}://{address}:{port}

  • Protocol: If you have added a certificate, HTTPS, otherwise HTTP.

  • Address: localhost or the address to the server where you installed it.

  • Port: . If you are making a remote call, make sure the port is open in your firewall.