BECS Connector Documentation B000xxxxx

BECS SYNCHRO Connector Documentation Page 1 of 16

Synopsis: This document describes

implementation of BECS SYNCHRO connector.

BECS SYNCHRO Connector

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

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

2.1 BECS SYNCHRO Connector prerequisites .................................................................................. 2

2.2 BECS SYNCHRO connector Installation Procedure ..................................................................... 2

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

2.1 BECS SYNCHRO connector objects ............................................................................................ 3

2.1.1 SYNCHRO system object ................................................................................................... 3

2.1.2 BECS SYNCHRO connector data objects ............................................................................ 4

2.2 BECS SYNCHRO connector usage .............................................................................................. 6

2.2.1 BECS SYNCHRO connector data objects ............................................................................ 6

2.2.1.1 Step by step procedure – Create task ............................................................................ 6

2.2.1.2 Step by step procedure– Change progress .................................................................... 9

2.2.1.3 Step by step procedure– Manage task ........................................................................ 11

2.2.1.4 Step by step procedure– Get tasks .............................................................................. 13

2.2.1.5 Step by step procedure– Create User Field ................................................................. 15

2.2.1.6 Step by step procedure– Assign User Field .................................................................. 15

3 References ..................................................................................................................................... 16

4 Glossary ......................................................................................................................................... 16

Number: B000xxxxx

Updated: 6th September 2018

By: Alex Cimbalak, Bentley SK

State: Draft Scope: BECS connector 5.5x

BECS Connector Documentation B000xxxxx

BECS SYNCHRO Connector Documentation Page 2 of 16

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 SYNCHRO Connector prerequisites BECS SYNCHRO connector requires:

BECS Server version 5.5 or higher

BECS Visual Architect version 5.5 or higher

SYNCHRO system

2.2 BECS SYNCHRO 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

BECS Connector Documentation B000xxxxx

BECS SYNCHRO Connector Documentation Page 3 of 16

2. After installation (if standard package does not include SYNCHRO Connector), is necessary copy dll file “Ace.Integrator.SYNCHRO.dll”, “Ace.Integrator.SYNCHRO.pdb” and “SynchroNET.dll” to BECS installation path.

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

4. Product will be after Activation ready to use.

2.1 BECS SYNCHRO connector objects BECS SYNCHRO 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 SYNCHRO system object

BECS Connector Documentation B000xxxxx

BECS SYNCHRO Connector Documentation Page 4 of 16

BECS SYNCHRO connector has black color.

Properties for connection:

- Address - User (Standard SYNCHRO user/LogOn) - Password - Port

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

- Create Task (create new task in SYNCHRO)

BECS Connector Documentation B000xxxxx

BECS SYNCHRO Connector Documentation Page 5 of 16

- Change progress (Change field PercentComplete for selected task)

- Manage task (User can delete selected task, or change status (STARTED/FINISHED))

BECS Connector Documentation B000xxxxx

BECS SYNCHRO Connector Documentation Page 6 of 16

- Get Tasks (get all tasks)

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

2.2.1 BECS SYNCHRO connector data objects

2.2.1.1 Step by step procedure – Create task

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 SYNCHRO Connector Documentation Page 7 of 16

4. Select SYNCHRO connector 5. Set connection properties (Address, User, Password, Port) 6. Drag and Drop object 7. Select object Create Task

BECS Connector Documentation B000xxxxx

BECS SYNCHRO Connector Documentation Page 8 of 16

8. Send properties to object Create Task

9. Right click on connector and click Read Structure 10. Set Up Headers:

a. Right click integration Object Create Task b. Click Edit Structure c. Click Add d. In first Name field fill “Header”, choose string datatype and fill name

e. After filling fields, push Enter Button and click Save - Set up a transformation within source integration object and SYNCHRO object, within source

Header string to SYNCHRO Header field Example

o Transformation:

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

BECS Connector Documentation B000xxxxx

BECS SYNCHRO Connector Documentation Page 9 of 16

b. Execute Synchro object Create Task

2.2.1.2 Step by step procedure– Change progress

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 SYNCHRO connector 5. Set connection properties (Address, User, Password, Port) 6. Drag and Drop object 7. Select object Change progress

BECS Connector Documentation B000xxxxx

BECS SYNCHRO Connector Documentation Page 10 of 16

8. Fill Pproperties:

a. TaskID b. TaskProgress

9. Set Execution with step a. Push input parameter to object (read 1 row memory table or else.).

BECS Connector Documentation B000xxxxx

BECS SYNCHRO Connector Documentation Page 11 of 16

b. Execute Synchro object Change progress

2.2.1.3 Step by step procedure– Manage task

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 SYNCHRO connector 5. Set connection properties (Hostname, User, Password, VirtualHost) 6. Drag and Drop object 7. Select object Manage task

BECS Connector Documentation B000xxxxx

BECS SYNCHRO Connector Documentation Page 12 of 16

8. Fill Pproperties:

a. Start i. TaskID

b. Finish i. TaskID

c. Delete i. TaskID

9. Set Execution with step a. Push input parameter to object (read 1 row memory table or else.).

b. Execute Synchro object Start/Finish/Delete

BECS Connector Documentation B000xxxxx

BECS SYNCHRO Connector Documentation Page 13 of 16

2.2.1.4 Step by step procedure– Get tasks

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 SYNCHRO connector 5. Set connection properties (Address, User, Password, Port) 6. Drag and Drop object 7. Select object Get Tasks

BECS Connector Documentation B000xxxxx

BECS SYNCHRO Connector Documentation Page 14 of 16

8. Object Get Tasks:

9. Set Execution with step

BECS Connector Documentation B000xxxxx

BECS SYNCHRO Connector Documentation Page 15 of 16

2.2.1.5 Step by step procedure– Create User Field

2.2.1.6 Step by step procedure– Assign User Field

BECS Connector Documentation B000xxxxx

BECS SYNCHRO Connector Documentation Page 16 of 16

3 References Number Revision Title Status

4 Glossary Term Description

End of document