Versions Compared

Old Version 1

changes.mady.by.user Former user

Saved on

compared with

New Version 2

changes.mady.by.user Former user

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Your use of this download is governed by Stonebranch’s Terms of Use, which are available at https://www.stonebranch.com/integration-hub/Terms-and-Privacy/Terms-of-Use/

...

Overview

Amazon Simple Queue Service (SQS) is a fully managed message queuing service that enables you to decouple and scale microservices, distributed systems, and serverless applications.

Overview

Using SQS, you can send, store, and receive messages between software components.

The Universal Task for SQS allows you to create, send and monitor AWS SQS messages and automatically trigger a Task in Universal Controller once a message has been receivedThis Universal Extension provides the capability to send an AWS SQS message towards an existing queue.

Software Requirements

Software Requirements Universal Agents and Controller

  • Universal Agent for Linux or Windows Version 6.9.0.0 or later are required

Software Requirements Universal Controller

  • Universal Controller 6.9.0.0. or later is required

  • A Universal Controller license key with support for SAP connector is required

Software Requirements for the Application to be Scheduled

In order to connect to the SAP System the SAP NetWeaver RFC SDK 7.50 libraries are required from SAP.

Those can be downloaded from the SAP Software Download: SAP NetWeaver RFC SDK 7.50

Universal Task for AWS SQS Key Features

Some details about the Universal Tasks for AWS SQS:

Image Removed

...

The Universal Tasks for SQS allows you to create, send and monitor for new AWS SQS messages.

...

The Universal Task for SQS can trigger a Task in Universal Controller upon each arrival of a new message

...

Credentials for AWS S3 are stored in an encrypted format in the database

This integration requires a Universal Agent and a Python runtime to execute the Universal Task.

Software Requirements for Universal Template and Universal Task

  • Requires Python 3.7.0 or higher. Tested with the Universal Agent bundled Python distribution.

Software Requirements Universal Agent

  • Both Windows and Linux agents are supported:

    • Universal Agent for Windows x64 Version 7.1.0.0 and later.

    • Universal Agent for Linux Version 7.1.0.0 and later.

Software Requirements Universal Controller

  • Universal Controller Version 7.0.0.0 and later.

Key Features

This Universal Extension provides the following main features:

  • Support to send an AWS SQS message towards a standard or a FIFO queue.

  • Support for authorization via IAM Role-Based Access Control (RBAC) is supported

  • Communication to AWS is done via the HTTPS protocol

  • A Proxy Server connection to AWS with basic authentication is supported

  • You can create and send a SQS message out of any modern application by calling the Universal Controller Remote Webservice API

  • The new SQS task can be integrated into any existing or new automation workflow like any other task.

  • The Universal template script is using the Python Boto3 Module. This allows to quickly introduce new AWS Service and to update the current SQS Task when new requirements occur. 

  • You can set different log-levels for the Universal task, providing you more information in case of issues

Import AWS SQS Virtual Machine Downloadable Universal Template

To use this downloadable Universal Template, you first must perform the following steps:

  1. This Universal Task requires the /wiki/spaces/UC71x/pages/5178443 feature. Check that the/wiki/spaces/UC71x/pages/5177877 system property has been set to true.

  2. Copy or Transfer the Universal Template file to a directory that can be accessed by the Universal Controller Tomcat user.

  3. In the Universal Controller UI, select Configuration > Universal Templates to display the current list of /wiki/spaces/UC71x/pages/5178054.

  4. Right-click any column header on the list to display an Action menu.

  5. Select Import from the menu, enter the directory containing the Universal Template file(s) that you want to import, and click OK.

When the files have been imported successfully, the Universal Template will appear on the list.

Configure AWS SQS Universal Tasks

...

  • strategy.

  • Support for Proxy communication via HTTP/HTTPS protocol.

Import Universal Template

To use the Universal Template, you first must perform the following steps:

  1. This Universal Task requires the /wiki/spaces/UC71x/pages/5178443 feature. Check that the/wiki/spaces/UC71x/pages/5177877 system property has been set to true.

  2. Download the provided ZIP file.

  3. In the Universal Controller UI, select Administration >Configuration > Universal Templates to display the current list of Universal Templates.

  4. Click Import Template.

  5. Select the template ZIP file and Import.

When the template has been imported successfully, the Universal Template will appear on the list, Refresh your Navigation Tree to see these tasks in the Automation Center Menu.

Configure Universal Task

For the new Universal Task type, create a new task, and enter the task-specific details that were created in the Universal Template.

Input Fields

The input fields for this Universal Extension are described below.

Field

Input Type

Default Value

Type

Description

Action

Required

Send Message

Choice

The action performed upon the task execution.

Region

Required

-

Text

Region for the Amazon Web Service.

Find more information about the AWS Service endpoints and quotas here.

Credentials

Required

-

Credentials

The AWS account credentials.

They are comprised of:

  • AWS access key ID

  • AWS secret access key

Queue Name

Required

-

Dynamic Choice

Dynamic fetched list of queue names. The user can select the required queue name from a drop-down list.

Queue Name Prefix

Optional

-

Text

A prefix to use for filtering the Queue Names list results. Only those queues whose name begins with the specified string are returned.
Queue Names are case-sensitive.

Role Based Access

Optional

False

Boolean

Flag to configure whether the type of authorization is based on IAM Role-Based Access Control(RBAC) strategy.
Find more information about the IAM RBAC authorization model here.

Role ARN

Optional

-

Text

The Role Amazon Resource Name (ARN) to have access to the SQS queue.
Role ARN format: arn:aws:iam::<AWS Account ID>:instance-profile/<Role name>
Required when Role Based Access has been clicked.

Message Body Source

Required

Raw

Choice

Type of message to be sent.
Available options are:

  • Raw

  • Script

Message Attributes

Optional

-

Script

The message attributes to send alongside the message body. Each message attribute consists of a Name, Type, and Value. It should be in JSON format and can have up to 10 attributes.
Example of Attribute Script with 2 Attributes:
{
 "CustomerFirstname": {
  "DataType": "String",
  "StringValue": "John"
 },
 "CustomerLastname": {
  "DataType": "String",
  "StringValue": "Doe"
 }
}

Message Body

Optional

-

Large Text

The message to send to queue.
A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:
#x9, #xA, #xD, #x20 to #xD7FF, #xE000 to #xFFFD, #x10000 to #x10FFFF
Any characters not included in this list will be rejected.
For more information, see the W3C specification for characters.
Required when Message Body Source is configured for "Raw"

Message Body Script

Optional

-

Script

The message to send to queue. The minimum message size is 1 byte (1 character). The maximum is 262,144 bytes (256 KB).
Required when Message Body Source is configured for "Script".

Is Queue Fifo

Required

False

Boolean

Flag to configure whether the message will be sent to a FIFO Queue.
It should be enabled, if the message will be sent to a FIFO Queue.

Delay Seconds

Optional

-

Integer

The length of time, in seconds, for which to delay a specific message. Messages with a positive value become available for processing after the delay period is finished.
Valid values from 0 to 900.
Used when Is Queue Fifo is disabled.

Message Deduplication ID

Optional

-

Text

Specifies ID for deduplication of sent messages. If a Message Deduplication ID is not provided and the queue doesn't have Content Based Deduplication set on Queue, an error will be raised.
Maximum Length is 128 characters.
Used when Is Queue Fifo is enabled.

Message Group ID

Optional

-

Text

Group ID that specifies that a message belongs to a specific message group.
Maximum Length is 128 characters.
Required when Is Queue Fifo is enabled.

Use Proxy

Required

False

Boolean

Flag to configure whether Proxy should be used in communication.

Proxy Type

Optional

http

Choice

Type of proxy connection to be used.
Available options are:

  • http

  • https

  • https with password

Required when Use Proxy is enabled.

Proxy

Optional

-

Text

Proxy server and port. Valid format: http://proxyip:port or https://proxyip:port.
Required when Use Proxy is enabled.

Proxy CA Bundle File

Optional

-

Text

The path to a custom certificate bundle to use when establishing SSL/TLS connections with proxy.
Used when Proxy Type is configured for "https" or "https with password".

Proxy Credentials

Optional

-

Credentials

Credentials to be used for the proxy communication.
They are comprised of:

  • username

  • password

Required when Proxy Type is configured for "https with password".





Field Descriptions for AWS SQS Universal Task - Actions

...