BECS Connector Documentation B000xxxxx

BECS RabbitMQ Connector Documentation Page 1 of 14

Synopsis: This document describes

implementation of BECS RabbitMQ connector.

BECS RabbitMQ Connector

Documentation 1 BECS (Bentley Enterprise Connection Services) ................................................................................ 2

2 BECS Licensing processes in detail .................................................................................................... 2

2.1 BECS RabbitMQ Connector prerequisites ................................................................................. 2

2.2 BECS RabbitMQ connector Installation Procedure .................................................................... 2

2.2.1 Step by step procedure..................................................................................................... 2

2.1 BECS RabbitMQ connector objects ........................................................................................... 3

2.1.1 RabbitMQ system object .................................................................................................. 3

2.1.2 BECS RabbitMQ connector data objects ............................................................................ 4

2.2 BECS RabbitMQ connector usage ............................................................................................. 5

2.2.1 BECS RabbitMQ connector data objects ............................................................................ 6

3 References ..................................................................................................................................... 14

4 Glossary ......................................................................................................................................... 14

Number: B000xxxxx

Updated: 6th September 2018

By: Alex Cimbalak, Bentley SK

State: Draft Scope: BECS connector 5.5x

BECS Connector Documentation B000xxxxx

BECS RabbitMQ Connector Documentation Page 2 of 14

1 BECS (Bentley Enterprise Connection Services) BECS enables trusted and certified integration between Bentley software and mission critical enterprise

applications such as enterprise resource planning (ERP) systems based on visual modeling of integration

projects. BECS automates the flow of data between Bentley applications, such as ALIM, and enterprise

applications to provide two-way communications for data creation, updates, and modifications, keeping

the data in both systems accurate and up to date. Bentley Enterprise Connection Services is certified for

integration with SAP® NetWeaver™ as well as SAP® HANA™ and provides the ability to exchange both

business object metadata and table data with SAP.

BECS is essentially a service bus with typical service bus related functionality. This functionality includes

an ability to create and use native "connectors" to external applications, including but not limited to

SAP®, Maximo®, Oracle® and many others.

Connectors are used in conjunction with data flow controls such as merge, split etc., to form a data

exchange solution template. BECS solution templates may be as simple as an incoming and outgoing

connector with pass through data flow, or very complex comprising many connectors with very

sophisticated data flow controls, internal BECS mappings and validations.

2 BECS Licensing processes in detail In this chapter, we will describe all relevant processes related to new licensing model in detail. For

better understanding we will use also schemas for each process with definition of relevant flows marked

by numbers (in chronological order).

2.1 BECS RabbitMQ Connector prerequisites BECS RabbitMQ connector requires:

BECS Server version 5.5 or higher

BECS Visual Architect version 5.5 or higher

2.2 BECS RabbitMQ connector Installation Procedure This connector is from the BECS connector family. It means that it have implemented BECS Licensing

separately (“FeatureID licensing” – see BECS SELECT Licensing implementation document) and Product

ID of this connector is 219x.

2.2.1 Step by step procedure Whole process will drive following steps:

1. Installation of standard BECS package 2. After installation (if standard package does not include RabbitMQ Connector), is necessary copy

dll file “Ace.Integrator.RabbitMQ.dll”, “RabbitMQ.Client.dll” and “RabbitMQ.Client.xml” to BECS installation path.

BECS Connector Documentation B000xxxxx

BECS RabbitMQ Connector Documentation Page 3 of 14

3. After installation (if standard package does not include RabbitMQ Connector), is necessary copy dll file “Ace.Integrator.RabbitMQ.dll”, “RabbitMQ.Client.dll” and “RabbitMQ.Client.xml” to BECS Visual Architect installation path (Architect\Extensions\Application).

4. Product will be after Activation ready to use.

2.1 BECS RabbitMQ connector objects BECS RabbitMQ connector is from “BECS connector family”. In a vision to allow same kind of work

independent of concrete connector we keep similar object structure for any “BECS family connector”.

Connector consist of:

2.1.1 RabbitMQ system object

BECS RabbitMQ connector has orange color.

BECS Connector Documentation B000xxxxx

BECS RabbitMQ Connector Documentation Page 4 of 14

Properties for connection:

- Hostname (ip address of RabbitMQ server ) - User (Standard RabbitMQ user/LogOn) - Password - VirtualHost of RabbitMQ queue

2.1.2 BECS RabbitMQ connector data objects BECS RabbitMQ connector has implemented following set of functions:

- Send Message (sends message to RabbitMQ)

- Declare Exchange

BECS Connector Documentation B000xxxxx

BECS RabbitMQ Connector Documentation Page 5 of 14

- Declare Queue

- Bind Queue

2.2 BECS RabbitMQ connector usage In following section, we will describe how to use data object Send Message on short example:

BECS Connector Documentation B000xxxxx

BECS RabbitMQ Connector Documentation Page 6 of 14

2.2.1 BECS RabbitMQ connector data objects

2.2.1.1 Step by step procedure– send a message

After successful BECS installation and activation will be possible to use development tool – BECS Visual

Architect (similar as today) for deployment of new solution template. Whole process will drive following

steps:

1. Via standard BECS development client tool called BECS Visual Architect will be open new template (Menu File – New)

2. Drag and drop system 3. After drop BECS VA shows following dialog:

4. Select RabbitMQ connector 5. Set connection properties (Hostname, User, Password, VirtualHost) 6. Drag and Drop object 7. Select object Send Message

BECS Connector Documentation B000xxxxx

BECS RabbitMQ Connector Documentation Page 7 of 14

8. Send properties to object SendMessage a. RoutingKey – name of Queue

9. Set Up Headers: a. Right click integration Object Send Message b. Click Edit Structure c. Click Add

d. After filling fields, push Enter Button and click Save

10. Set up a transformation within source integration object and RabbitMQ object, and within source Header string to RabbitMQ Header field

BECS Connector Documentation B000xxxxx

BECS RabbitMQ Connector Documentation Page 8 of 14

11. Set Execution with steps: a. Push input parameter to object (read 1 row memory table or else.). Message must be

valid XML string

12. Received message with Header:

2.2.1.2 Step by step procedure– Declare an Exchange

After successful BECS installation and activation will be possible to use development tool – BECS Visual

Architect (similar as today) for deployment of new solution template. Whole process will drive following

steps:

1. Via standard BECS development client tool called BECS Visual Architect will be open new template (Menu File – New)

2. Drag and drop system 3. After drop BECS VA shows following dialog:

BECS Connector Documentation B000xxxxx

BECS RabbitMQ Connector Documentation Page 9 of 14

4. Select RabbitMQ connector 5. Set connection properties (Hostname, User, Password, VirtualHost) 6. Drag and Drop object

7. Select object Declare Exchange

8. Fill Pproperties:

a. Exchange Name b. Type

BECS Connector Documentation B000xxxxx

BECS RabbitMQ Connector Documentation Page 10 of 14

9. Set Execution with step

2.2.1.3 Step by step procedure– Declare a Queue

After successful BECS installation and activation will be possible to use development tool – BECS Visual

Architect (similar as today) for deployment of new solution template. Whole process will drive following

steps:

1. Via standard BECS development client tool called BECS Visual Architect will be open new template (Menu File – New)

2. Drag and drop system 3. After drop BECS VA shows following dialog:

BECS Connector Documentation B000xxxxx

BECS RabbitMQ Connector Documentation Page 11 of 14

4. Select RabbitMQ connector 5. Set connection properties (Hostname, User, Password, VirtualHost) 6. Drag and Drop object 7. Select object Declare Queue

8. Fill Pproperties:

a. AutoDelete b. Durable c. Exclusive d. QueueName

BECS Connector Documentation B000xxxxx

BECS RabbitMQ Connector Documentation Page 12 of 14

9. Set Execution with step

2.2.1.4 Step by step procedure– Bind Queue

After successful BECS installation and activation will be possible to use development tool – BECS Visual

Architect (similar as today) for deployment of new solution template. Whole process will drive following

steps:

1. Via standard BECS development client tool called BECS Visual Architect will be open new template (Menu File – New)

2. Drag and drop system 3. After drop BECS VA shows following dialog:

BECS Connector Documentation B000xxxxx

BECS RabbitMQ Connector Documentation Page 13 of 14

4. Select RabbitMQ connector 5. Set connection properties (Hostname, User, Password, VirtualHost) 6. Drag and Drop object 7. Select object Declare Queue

8. Fill Pproperties: a. ExchangeName b. QueueName c. RoutingKey

9. Set Execution with step

BECS Connector Documentation B000xxxxx

BECS RabbitMQ Connector Documentation Page 14 of 14

3 References Number Revision Title Status

4 Glossary Term Description

End of document