MindConnect Integration - MindSphere Documentation

MindSphere

MindConnect Integration

Getting Started

10/2020

Document history 1Prerequisites 2Preparations for MindConnect Integration 3User Interface of MindConnect Integration 4

Projects 5Monitor 6Recipes 7Stages 8Settings 9MindConnect Integration On-Premise 10

Legal informationWarning notice system

This manual contains notices you have to observe in order to ensure your personal safety, as well as to prevent damage to property. The notices referring to your personal safety are highlighted in the manual by a safety alert symbol, notices referring only to property damage have no safety alert symbol. These notices shown below are graded according to the degree of danger.

DANGERindicates that death or severe personal injury will result if proper precautions are not taken.

WARNINGindicates that death or severe personal injury may result if proper precautions are not taken.

CAUTIONindicates that minor personal injury can result if proper precautions are not taken.

NOTICEindicates that property damage can result if proper precautions are not taken.If more than one degree of danger is present, the warning notice representing the highest degree of danger will be used. A notice warning of injury to persons with a safety alert symbol may also include a warning relating to property damage.

Qualified PersonnelThe product/system described in this documentation may be operated only by personnel qualified for the specific task in accordance with the relevant documentation, in particular its warning notices and safety instructions. Qualified personnel are those who, based on their training and experience, are capable of identifying risks and avoiding potential hazards when working with these products/systems.

Proper use of Siemens productsNote the following:

WARNINGSiemens products may only be used for the applications described in the catalog and in the relevant technical documentation. If products and components from other manufacturers are used, these must be recommended or approved by Siemens. Proper transport, storage, installation, assembly, commissioning, operation and maintenance are required to ensure that the products operate safely and without any problems. The permissible ambient conditions must be complied with. The information in the relevant documentation must be observed.

TrademarksAll names identified by ® are registered trademarks of Siemens AG. The remaining trademarks in this publication may be trademarks whose use by third parties for their own purposes could violate the rights of the owner.

Disclaimer of LiabilityWe have reviewed the contents of this publication to ensure consistency with the hardware and software described. Since variance cannot be precluded entirely, we cannot guarantee full consistency. However, the information in this publication is reviewed regularly and any necessary corrections are included in subsequent editions.

Siemens AGDigital IndustriesPostfach 48 4890026 NÜRNBERGGERMANY

Ⓟ 10/2021 Subject to changeCopyright © Siemens AG 2020.All rights reserved

Table of contents

1 Document history .................................................................................................................................. 72 Prerequisites .......................................................................................................................................... 93 Preparations for MindConnect Integration.......................................................................................... 11

3.1 Overview of MindConnect Integration................................................................................ 113.2 Accessing MindConnect Integration ................................................................................... 113.3 Activate MC Integration on Launchpad ............................................................................... 11

4 User Interface of MindConnect Integration......................................................................................... 135 Projects ................................................................................................................................................ 15

5.1 Overview........................................................................................................................... 155.2 Integrations ....................................................................................................................... 155.3 Document Types ................................................................................................................ 165.4 Reference Data .................................................................................................................. 175.5 APIs ................................................................................................................................... 185.5.1 REST APIs ........................................................................................................................... 185.5.2 SOAP APIs .......................................................................................................................... 185.6 Applications....................................................................................................................... 195.6.1 Example: Integrate an AWS Cloud via MindConnect Integration .......................................... 195.6.2 Applications in MindConnect Integration............................................................................ 205.6.3 Application properties........................................................................................................ 215.6.3.1 Introduction to application properties ................................................................................ 215.6.3.2 Application accounts.......................................................................................................... 225.6.3.3 Application operations ....................................................................................................... 235.6.3.4 Application integrations ..................................................................................................... 265.7 Keys & Certificates in MindConnect Integration................................................................... 26

6 Monitor ................................................................................................................................................ 276.1 Dashboard ......................................................................................................................... 276.2 Execution Results............................................................................................................... 286.3 Alert Rules ......................................................................................................................... 286.4 Reports.............................................................................................................................. 306.5 Clear Storage Locks ............................................................................................................ 31

7 Recipes................................................................................................................................................. 338 Stages .................................................................................................................................................. 35

8.1 Overview........................................................................................................................... 358.2 Change stage to view......................................................................................................... 35

MindConnect IntegrationGetting Started, 10/2020 3

8.3 Deploy Assets .................................................................................................................... 368.4 Manage stages .................................................................................................................. 37

9 Settings................................................................................................................................................ 399.1 Users ................................................................................................................................. 399.2 Access Profiles.................................................................................................................... 399.3 Access Control Lists............................................................................................................ 419.4 Project Permissions ............................................................................................................ 419.5 Company Information ........................................................................................................ 429.6 Audit Logs ......................................................................................................................... 42

10 MindConnect Integration On-Premise................................................................................................. 4510.1 Connect to MindConnect Integration through a proxy......................................................... 4510.2 User Management in MindConnect Integration On-Premise ................................................ 4610.3 Firewall-Settings ................................................................................................................ 4710.4 Configure Integration Server for MindConnect Integration .................................................. 49

Table of contents

MindConnect Integration4 Getting Started, 10/2020

MindConnect Integration is an application for MindSphere, the industrial IoT operating system from Siemens.MindConnect Integration is the solution to connect multiple data systems into MindSphere. MindConnect Integration provides flexible tools to bring enterprise systems and data historians into context with MindSphere. It uses browser-based tools to graphically configure data value mapping.


Document history 1Product version Date Changes Link6.1.0 2020-10-10 Added information about On-Premise applica‐

tions downloadUser Management in MindCon‐nect Integration On-Premise (Page 46)

6.1.0 2020-09-09 Added new chapter "Stages" Stages (Page 35) Updated external links Firewall-Settings (Page 47)

Connect to MindConnect Inte‐gration through a proxy (Page 45)

6.1.0 2020-07-11 New topics added for Reports and Clear Stor‐age Locks.

Reports (Page 30)Clear Storage Locks (Page 31)

Integrations topic updated Integrations (Page 15)Topics for REST APIs and SOAP APIs are con‐solidated into a single section.

APIs (Page 18)

Updated screenshots throughout the docu‐ment w.r.t. the 6.1 upgrade.

5.6.0 2020-05-16 Added information about functional area se‐lection.

Application operations (Page 23)

5.6.0 2020-02-19 Re-structured chapters and sections with addi‐tional content and updated screenshots throughout the document.

2018-09-18 Reviewed documentation, no changes on the software features.


Document history


Prerequisites 2To start with MindConnect Integration, you need to comply with the following prerequisites:• You need at least one of the following licenses:

– MindAccess IoT Value Plan (https://www.plm.automation.siemens.com/store/de-de/mindsphere/mindaccess/iot.html)

– MindAccess IoT Developer Plan (https://www.plm.automation.siemens.com/store/dede/mindsphere/mindaccess/devops-plan.html)

– MindConnect Integration for cloud or MindConnect Integration for on premise • A web browser:

– Google Chrome– Mozilla Firefox– Apple Safari


https://www.plm.automation.siemens.com/store/de-de/mindsphere/mindaccess/iot.html

https://www.plm.automation.siemens.com/store/de-de/mindsphere/mindaccess/iot.html

https://www.plm.automation.siemens.com/store/dede/mindsphere/mindaccess/devops-plan.html

https://www.plm.automation.siemens.com/store/dede/mindsphere/mindaccess/devops-plan.html

Prerequisites


Preparations for MindConnect Integration 33.1 Overview of MindConnect Integration

MindConnect Integration is an application for MindSphere, the industrial IoT operating system from Siemens.MindConnect Integration is the solution to connect multiple data systems into MindSphere. MindConnect Integration provides flexible tools to bring enterprise systems and data historians into context with MindSphere. It uses browser-based tools to graphically configure data value mapping.MindConnect Integration offers various functionalities, as there are for example: • An intuitive graphical user interface• Cloud recipes to allow you a fast and easy connection to MindSphere • A large variety of cloud-based connectors, such as Amazon, Google, Microsoft and many

more • Open interfaces to connect any service which is based on REST or SOAP • It enables holistic analysis across company-wide data

NoteRead the term “User(s)” in this document as “Technical User(s)” unless otherwise specified.

3.2 Accessing MindConnect IntegrationMindConnect Integration provides single sign-on functionality, that allows the user to login with a single 3rd-party authorization server. Users are controlled from MindSphere Settings.

3.3 Activate MC Integration on LaunchpadIn order to activate MindConnect Integration and to make it available on MindSphere Launchpad, you need to assign the required role to a user. Refer to the Settings (https://documentation.mindsphere.io/resources/html/settings/en-US/index.html) document to know more about assigning a role.


https://documentation.mindsphere.io/resources/html/settings/en-US/index.html

https://documentation.mindsphere.io/resources/html/settings/en-US/index.html

Preparations for MindConnect Integration3.3 Activate MC Integration on Launchpad


User Interface of MindConnect Integration 4The following graphic shows the MindConnect Integration user interface:

① MindConnect Integration home button ② MindSphere OS Bar③ Project search bar④ Navigation⑤ Projects pane⑥ Stage in view⑦ Create new project⑧ Navigation bar with links


The following chapters will walk you through all functionalities of the MindConnect Integration application.

Section ContentProjects (Page 15) This section allows you to create and view MindConnect Integration projects.Monitor (Page 27) This section gives you the view of the overall processes in a dashboard along with results

executes and audit logs. It also provides an option to set alert rules to receive related notifica‐tions of events.

Recipes (Page 33) This section allows you to create integrations using the pre-built "Orchestrated" or "Point-to-Point Integration" templates.

User Interface of MindConnect Integration


Projects 55.1 Overview

A project is an independent entity and corresponds to a folder for organizing your assets. A project holds all the assets created as a part of that project by the logged-in user, along with the configurations associated with the assets. Any asset, for example, Integrations, REST APIs, SOAP APIs, Document Types, and Reference Data, is a part of a project.To create a new project, click on the “+ New Project” button and enter a suitable name for the project and click “Create”.

5.2 IntegrationsAn integration is an orchestration of a source and a target operation with appropriate data mappings and transformations. The integrations page lists Point to Point and Orchestrated integrations created for cloud-based SaaS applications with other cloud-based applications and also SaaS applications with On-Premise applications.

NoteOnly users who have the required permissions under "Settings" > "Access Profiles" > "Administrative Permissions" > "Functional Controls" > "Integrations" can create, update, delete, execute, or deploy integrations.


NoteIf assets used by an integration are deleted, you will not be able to pull the integration into subsequent stages or to export the integration.

For more information on create, update, delete, execute, or deploy integrations, refer to MindConnect Integration User Guide (https://documentation.mindsphere.io/resources/html/mindconnect-integration/en-US/index.html).

5.3 Document TypesA Document Type contains a set of fields used to define the structure and type of data in a document. You can use a Document Type to specify the input or output parameters for an integration.

NoteOnly users who have the required access privileges can create, update, and delete a "Document Type".

Document Types can provide the following benefits:• Using a Document Type as the input or output signature for an integration can reduce the

effort required to build an Integration.• Using a Document Type to build document or document list fields can reduce the effort and

time needed to declare input or output parameters or build other document fields.• Document Types improve accuracy because there is less possibility to introduce a typing error

while typing field names.• Document Types make future changes easier to implement because you can make a change

in one place (the Document Type) rather than everywhere the Document type is used.You can use Document Types to define the input or output parameters for an Integration. Input and output parameters are the names and types of fields that the integration requires as input and generates as output. These parameters are also collectively referred to as a signature.

Projects5.3 Document Types


https://documentation.mindsphere.io/resources/html/mindconnect-integration/en-US/index.html


For more information on Document Types, refer to MindConnect Integration User Guide (https://documentation.mindsphere.io/resources/html/mindconnect-integration/en-US/index.html).

5.4 Reference DataReference data is data that defines the set of permissible values to be used by other data fields. It is a collection of key-value pairs, which can be used to determine the value of a data field based on the value of another data field. For example, the value of a status field in an application can be “Cancelled” and that needs to be interpreted as “CN” in another application. If you have the required access privileges can create, update, or delete a Reference Data.

For more information on Reference Data, refer to MindConnect User Guide (https://documentation.mindsphere.io/resources/html/mindconnect-integration/en-US/index.html).

Projects5.4 Reference Data






5.5 APIs

5.5.1 REST APIsMindConnect Integration allows you to write integration logic to integrate different types of applications. This logic can be exposed to the external world using REST APIs.

These REST APIs can be created by using an existing set of integrations (from scratch) or by using a file containing the Open API specification (formerly known as the Swagger specification) as a template.A REST API consists of many resource operations and each resource operation has a path, one or more HTTP Methods, and an associated integration.A REST resource operation can be tried out from the Swagger screen of a REST API. When the resource operation is invoked using the HTTP Method, the associated integration gets executed.

NoteUsers having the required permissions can create, update, delete, and execute REST APIs.

The Integrations, Services and Document Types are now based on the new Swagger file if REST APIs were created by using a file containing the Open API specification as a template and have now uploaded the same.

5.5.2 SOAP APIsWeb services are building blocks for creating open, distributed systems. A web service is a collection of functions that are packaged as a single unit and published to a network for use by other software programs. For example, you could create a web service that checks a customer’s credit or tracks delivery of a package. If you want to provide higher-level functionality, such as a complete order management system, you could create a web service that maps to many different Integrations, each performing a separate order management function.

Projects5.5 APIs


A SOAP API defines a web service and it encapsulates all the information of a web service. The SOAP API contains the message formats, data types, transport protocols, and transport serialization formats that should be used between the consumer (requester) and the provider of the web service. The SOAP API represents an agreement governing the mechanics of interacting with that service.

MindConnect Integration allows you to write integration logic to integrate different types of applications. This logic can be exposed to the external world using SOAP APIs. A SOAP API is a service provided to external users.

NoteUsers having the required permissions can create, update, delete, and execute SOAP APIs.

An operation is the WSDL element that exposes some functions of a web service and defines how data is passed back and forth. A SOAP API exposes one or more Integrations as operations, so each operation in a SOAP API corresponds to an Integration. The input for the Integration corresponds to the request body for the operation. The output of the Integration is the response body for the operation.Using a SOAP client, you can invoke the SOAP operation externally by using either Basic Authentication or 2-way SSL. When the SOAP operation is invoked, the associated Integration gets executed.

5.6 Applications

5.6.1 Example: Integrate an AWS Cloud via MindConnect IntegrationMindConnect Integration can transfer data from any cloud storage service into MindSphere. The MindSphere developer documentation provides a detailed description how to read multiple variable definitions for an aspect from a CSV file, which is stored in an AWS S3 bucket. To learn more about how you can connect your AWS account to MindConnect Integration, please refer to MindSphere developer documentation. (https://mindsphere.siemens.io/howto/howto-aws-integration-mci.html)

Projects5.6 Applications


https://mindsphere.siemens.io/howto/howto-aws-integration-mci.html

https://mindsphere.siemens.io/howto/howto-aws-integration-mci.html

5.6.2 Applications in MindConnect IntegrationMindConnect Integration enables you to create Integrations between Software as a Service (SaaS) and MindSphere. A set of predefined and configurable applications are provided, for example, Applicability Statement, Alfabet, Amazon DynamoDB, Amazon Kinesis, Amazon Simple Storage Service (S3), and so on. Applications allow you to connect to the particular SaaS providers.

You can also create SOAP and REST applications from this page.

Create SOAP application:To create a SOAP application, proceed as follows:1. Navigate to the left window and select "</> SOAP Applications".2. Click "Add New Application". 3. Fill the details of the three sections:

– Select type– Edit details– Confirm

4. Click "Finish" to complete the creation.

Create REST application:



To create a REST Application, proceed as follows:1. Navigate to the left window and select "{...} REST Applications".2. Click "Add New Application".3. Fill the details of the three sections:

– Define application– Define resources– Confirm application

4. Click "Finish" to complete the creation.

Work with an applicationFrom the "Applications" page, you can create accounts and operations for an application and integrations between different SaaS applications. To create or edit an application, you can click "Accounts", "Operations", or "Integrations". For REST applications, the "Documents Types" link allows you to create new document types. Document types created for a REST application appear only in the "Document Types" panel for the selected REST application. If you have the required access permissions, you can also click the "Upgrade" button to upgrade application assets ("Accounts", "Operations", and the associated "Integrations") from a lower to a higher version.To use an application, you are required to agree to the summary of terms. Click "I agree" to use the application.

5.6.3 Application properties

5.6.3.1 Introduction to application propertiesEach of the application has the following application properties:• Accounts• Operations• Integrations



5.6.3.2 Application accountsThe following screen lists available "Accounts" created for an application:



You can create, edit, or delete an account for a particular application from this screen. You need to get access for the actions on the data of the desired source.

NoteOnly users who have the required permissions can create, update, or delete the "Accounts" information.

Create or edit an AccountTo create or edit an account, proceed as follows:1. From the MindConnect Integration navigation bar, click "Applications".2. Select an "Application" from the list, and then click "Accounts".

To use an application, you are required to agree to the summary of terms. Therefore click "I agree" to use the application.

3. From the "Accounts" screen, click "Add New Account" to add an account or click "Edit" to update an existing account.

5.6.3.3 Application operationsMindConnect Integration provides pre-configured applications. These applications contain SaaS provider-specific information that enables you to connect to a particular SaaS provider. Further, each application uses an account to connect to the provider's backend and perform "Operations".

NoteOnly users who have the required permissions under "Settings" > "Access Profiles" > "Administrative Permissions" > "Functional Controls" > "Operations" can create, update, or delete Operations.

Each application comes with a predefined set of "Operations". You can also create your own custom "Operations" and also edit/ delete them. The screen lists all the available "Operations" for a selected application including predefined operations.



Create and edit custom OperationsTo create or edit a custom operation, proceed as follows:1. From the MindConnect Integration navigation bar, click "Applications".2. Select an application from the list, and then click "Operations".

To use an application, you are required to agree to the summary of terms. Therefore click "I agree" to use the application.

3. You can do the following tasks from the operations screen:– Click "Add new Operation" to create a new operation. – Select an operation and click "Edit" to update an existing operation.– Click "Delete" to delete an existing operation.– Click "Show Signature" to view the input and output signature of the operation.– Click "Test" to test the operation.

Select functional areaThe option to select the functional area for the "Siemens MindSphere" application is available under “Projects” > “Applications” > “Operations” > “Add New Operation”. The “Select functional area” field is visible only once the application account is selected from the “Select account” field.



Show signatureClick the "Show Signature" option to view the input and output signature of the operation. The input and output fields cannot be edited. This option is available for all predefined and custom Operations. Click the input and output fields to view the field properties. From the input or output pane, click the icon to copy a field. Depending on the context, you can either paste the field or the field path.

TestClick the "Test" option and in the test dialog box, specify the "Account name" and the "Input data". If an operation does not have an input signature, the input fields are not displayed. The "Test" option is available for all predefined and custom operations.

RunClick "Run" to test the operation and view the test results in the test results window. Click the icon beside "Result" if you want to go back to the test dialog box and enter another set of values. The last 5 test results are also displayed and are applicable only for the same test operation run, that is, if you close the test results window, you will not be able to view the test results later. Further, a test result appears in red color if the test run is unsuccessful and appears in green color for a successful test run.



5.6.3.4 Application integrationsThe application property provides integrations for cloud-based SaaS applications with other cloud-based applications and also SaaS applications with On-Premise applications. The integration feature is also available in applications development. For detailed know-how, see Integrations (Page 15).

5.7 Keys & Certificates in MindConnect Integration"Keystores" and "Truststores" are files that function as repositories for storage of keys and certificates necessary for SSL authentication, encryption/decryption, and digital signing/verification services. "Keystores" and "Truststores" provide added layers of security and ease of administration, compared to maintaining the keys and certificates in separate files.MindConnect Integration stores its private keys and SSL certificates in "Keystore" files and the trusted roots for the certificates in "Truststore" files. "Keystores" and "Truststores" are secure files with industry-standard file formats.

If you want to run services that submit HTTPS requests to other resources on the Internet, your server will be acting as a client and will receive certificates from these resources. In order for these transactions to work, your server must have copies of their public keys and signing CA certificates.To identify a particular "Keystore" or "Truststore" file, or private key within a "Keystore", aliases are used. The use of aliases simplifies "Keystore" and "Truststore" management, because you do not need to enter path information when specifying a "Keystore", "Truststore", or the private key.For more information on "Keys and Certificates" refer to MindConnect Integration User Guide (https://documentation.mindsphere.io/resources/html/mindconnect-integration/en-US/index.html).

Projects5.7 Keys & Certificates in MindConnect Integration




Monitor 66.1 Dashboard

The Dashboard provides a centralized and intuitive way to view and monitor integration executions and performance details. To view the dashboard, click "Monitor" > "Dashboard".

Active stagesYou can identify and diagnose problems for those integrations that are available in the active stage. To select another active stage, click "Stage in view" > "Change Stage To View". You can view the dashboard if the "Access Profile" assigned to you is also specified for that stage in the Manage Stages ("Stage in view" > "Manage") page. Further, you must be able to access the stages to view the dashboard.For more information on dashboard refer to MindConnect Integration User Guide (https://documentation.mindsphere.io/resources/html/mindconnect-integration/en-US/index.html).




6.2 Execution ResultsThe Execution Results page allows you to view the audit trail of all the integration executions that happened in the selected active stage, during a specified time period. You can also do the following tasks:• Restart or resume an integration execution• Specify the number of days to retain the entries• Download the entries.

NoteTo view execution results, ensure that the Access Profile of the user is assigned to the active stage.

For more information on the Execution Results refer to MindConnect Integration User Guide (https://documentation.mindsphere.io/resources/html/mindconnect-integration/en-US/index.html).

6.3 Alert RulesMindConnect Integration allows you to create alert rules and send email messages to selected users for one or more integrations based on integration execution results ("Failed", "Completed with Errors", or "Completed Successfully") for the stage in view. To change the stage in view or the current active stage, click "Stage in view" > "Change Stage To View". All executions that have occurred within a 15-minute period and have alert rules configured are sent as email messages to specified users.

Monitor6.3 Alert Rules




NoteEmail messages are sent only if there are executions that match the alert rules.Ensure that the Access Profile of the user is assigned to the active stage. To select another active stage, click "Stage in view" > "Change Stage To View".

Create new rule alertTo create a new alert rule, proceed as follows:1. From the MindConnect Integration navigation bar, click "Monitor" > "Alert Rules". 2. From the Alert Rules page, click "Add New Alert Rule" to create a new alert rule.3. On the Add New Alert Rule page, fill the fields. 4. Click "Save and Activate" to save and enable the new alert rule.The new alert rule appears in the Alert Rules page. You can disable an alert rule by selecting the alert rule and clicking "Mark As" > "Inactive". You can also enable the alert rule by selecting the alert rule and clicking "Mark As" > "Active".

NoteAlerts will be sent every 5 minutes. If you do not want to receive email alerts for integration executions, go to the Alert Rules page, open the Alert Rule for editing, and remove your username from the user's list.

Monitor6.3 Alert Rules


6.4 ReportsThe Reports page provides you information about the number of times an Integration is run for the specified time frame. The report shows the count for the currently active stage and the reports data is collected daily, at the end of the day.

View reports1. From the MindConnect Integration navigation bar, click "Monitor" > "Reports".

The Reports page appears.2. Select the time frame for which you want to view the report.3. To download the report, select the preferred format from the "Download Reports" drop-

down.NoteThe downloaded report also shows the stage for which you have run the report.

For more information on Reports, refer to the MindConnect Integration User Guide (https://documentation.mindsphere.io/resources/html/mindconnect-integration/en-US/index.html).

Monitor6.4 Reports




6.5 Clear Storage LocksIf the environment collapses while an integration is running, the lock taken on the integration will not be automatically removed immediately. Therefore, any scheduled executions for the same integration will be skipped.

The actions to be taken in order to clear the locks are explained as scenarios in the MindConnect Integration User Guide (https://documentation.mindsphere.io/resources/html/mindconnect-integration/en-US/index.html).

Monitor6.5 Clear Storage Locks




Monitor6.5 Clear Storage Locks


Recipes 7Recipes are pre-built "Orchestrated" or "Point-to-Point Integration" templates that can be used to create an integration. Recipes are based on the most common integration needs and can significantly reduce the effort required to build an Integration. A recipe includes associated assets, for example applications, operations, reference data, and so on, that are used to create an integration. A detailed description of the recipe along with its assets is available for preview, which helps you to select the right recipe.

NoteAll integrations created from recipes are initially copied to the development stage.


View recipesTo view recipes, proceed as follows:1. From the MindConnect Integration navigation bar, click "Recipes". The recipes screen

appears. By default, recipes for all applications and for all integration types (Orchestrated and Point-to-Point) are displayed. The recipes screen also displays the number of times each recipe has been used to create integrations and the applications referenced in the recipe. If there are more than two applications referenced in the recipe, the recipes screen also displays the incremental number.

2. From the recipes screen, for a recipe, click "Preview" to see a view-only mode of the integration details of the recipe.

3. From the recipes screen, for a recipe, click "Details" to view a detailed description of the recipe and the references in the "Recipe Details" screen.

Use recipesTo use recipes, proceed as follows:1. From the recipes or recipe details screen, click "Use" if you want to apply the recipe to create

a new integration. The Connect to Applications screen appears. Depending on the number of integrations referenced in your recipe, a message is displayed at the top of the screen. You will be asked to configure all integrations in your recipe one after another.

2. In the Connect to Applications screen, select the "Account" for each application or create a new account, and then click "Next".The Overview and Save Integration screen appears.

3. In the Overview and Save Integration screen, provide a name and description for your integration. By default, the recipe name and recipe description is displayed.

4. Click "Finish". If you have existing references ("Reference Data", "Document Types", and custom "Operations") with the same name in the development stage, the Copy References screen appears. Click "Cancel" to go back to the Overview and Save Integration screen. By default, all references are selected in the Copy References screen.

5. Deselect the references that you do not want to replace and then click "Continue" to replace or overwrite all the selected references from the recipe in the development stage.The Integration details screen appears for the newly created integration.

Recipes


Stages 88.1 Overview

Stages provide safe environments for development and testing that are separated from the production environment. They allow integrations to migrate from the development environment to the production environment through the intermediate environments. A predefined set of stages is allowed, each representing an activity in the integration service life cycle.For more information on Manage stages, Deploy assets, Change Stages, refer to MindConnect Integration User Guide (https://documentation.mindsphere.io/resources/html/mindconnect-integration/en-US/index.html).

8.2 Change stage to viewThe “Change stage to view” page allows you to change the current stage. Only active and accessible stages appear in the drop-down list for selection in the “Stage to view” field. You can access a stage only if your Access Profile is assigned to that stage.




8.3 Deploy AssetsThe "Deploy" page displays all the assets under the relevant projects that are available in the current stage and the previously selected stage.

Once you change the current stage to any other stage other than the Development stage, the Deploy page gets populated with the relevant assets selected in the Select Asset Type drop-down list.

Stages8.3 Deploy Assets


8.4 Manage stagesIn the “Manage” page, every stage can be assigned a number of Access Profiles. Users who are assigned with the required Access Profiles can perform activities on that stage.

Stages8.4 Manage stages


Stages8.4 Manage stages


Settings 99.1 Users

You can view the details of any user in the "Users" tab of "Settings".You can edit and reset password of any user by selecting a row.

Click the hyperlinked user name to view user details. This showcases three sections:• Basic• Locale• Address and contact

9.2 Access ProfilesYou can view the details of any user in the "Access Profiles" tab of "Settings".You can edit any user details by selecting a row.


Click the hyperlinked user name to view user details. This showcases five sections:1. Access profile information: The section describes the technical user information.2. Login IP address restrictions: IP ranges are described.3. Administrative permissions: Different access and controls are provided in this section. 4. Associated users: Associated users with the selected user profile are displayed.5. Associated ACLs: Associated access controls with the selected user profile are displayed.

Settings9.2 Access Profiles


9.3 Access Control ListsAccess Control Lists (ACLs) control the execution permission of an Integration. ACLs provide you with another level of control over who can execute specific Integrations. An ACL can be assigned to an Integration and a user can be associated with the ACL through the Access Profile. Therefore, you can control the users who can execute an Integration.

9.4 Project PermissionsA project is an independent entity and corresponds to a folder for organizing your assets. A project holds all the assets created as a part of that project by the logged-in user, along with the configurations associated with the assets. Project permissions are used to associate permissions with projects.

Settings9.4 Project Permissions


9.5 Company InformationThe "Company Information" displays tenant company's basic and advanced information.

9.6 Audit LogsAudit Log allows you to access logs related to the following actions:• Adding information• Deleting information• Updating information• Exporting data• Scheduling an action• Skipping an action• Logging into a page• Logging out from a page• Changing passwords

Settings9.6 Audit Logs


• Recording access attempts• Accessing violations• Deployments• Restarting integration executions• Resuming integration executionsTo view the Audit Log, from the MindConnect Integration navigation bar, click "Settings" > "Audit Log".

NoteThe "Audit Log" page can be viewed only by administrators and users who have the "Manage Audit Log" permission under "Settings" > "Access Profiles" > "Administrative Permissions" > "Data Management Controls".



Audit log activitiesBy default, the Audit Log page displays the current day’s log entries, with the most recent entries listed on top. You can sort the log to view the latest log entries. You can search the Audit Log for "User", "Type", or "Operation". The table columns displayed in the UI are defined below:• Activity Date: It refers to the date and time when the event occurred.• User: It refers to the name of the logged in user when the event occurred. • Type: It refers to the type of log entry. For example, "User", "Login/Logout", "Reference Data",

"Stage", "Account", "Application", "Integration", "License Agreement", "Password Policy", "Access Profile", "Company", and so on.

• Operation: It refers to the action performed. For example, "Export", "Execute", "Terminate", "Add", "Delete", "Update", "Login", "Logout", and so on.

• Description: It refers to a summary of the action performed.

Other audit log actionsClick "Modify Retention Period" and specify the number of days to retain the Audit Log entries. The logs which are aged (exceeds the specified retention period) are deleted. Default value of the Retention Period is 1.Click "Download Audit Log" if you want to download and export log entries for a specified period. You can download Audit logs only up to 30 days.



MindConnect Integration On-Premise 1010.1 Connect to MindConnect Integration through a proxy

If you want to connect the On-Premise Integration Server to MindConnect Integration via an Internet proxy, you may need to perform additional configurations which fall into the following categories:• Creating a proxy server alias• Adding proxy-related Java system properties to the Java Virtual Machine (JVM) in which the

On-premise Integration Server runs• Configuring the Internet proxy for use with the On-premise Integration Server and

webMethods Integration Cloud

NoteSteps given above depends on the issue. Not all steps are mandatory.

Create a proxy server aliasIf your company requires the usage of a proxy server for establishing outbound connections to applications located in the cloud, then you need to configure a proxy server alias for your On-premise Integration Server. A proxy server alias identifies the proxy server and the port on the proxy server through which you want to rout requests and any credentials needed to access the proxy server. To configure a proxy server alias, use the Settings > Proxy Servers page in Integration Server Administrator. For detailed information on proxy servers and how to configure a proxy server, see the webMethods Integration Server Administrator’s Guide (https://documentation.softwareag.com/webmethods/microservices_container/msc10-5/10-5_MSC_PIE_webhelp/index.html).

Update JVM Configuration settings for proxiesDepending on your networking and security requirements, you may need to set Java system properties related to proxy servers. Because the connection between the On-Premise Integration Server and webMethods Integration Cloud is via HTTPS, you need to set some or all of the following:• https.proxyHost• https:proxyPort• http:nonProxyHosts• https.proxyUser• https.proxyPassword


https://documentation.softwareag.com/webmethods/microservices_container/msc10-5/10-5_MSC_PIE_webhelp/index.html



You need to set the property values for the Java Virtual Machine (JVM) in which Integration Server runs. Therefore, you need to update he custom_wrapper.conf to make sure that the proxy parameter values are supplied when the JVM launches.Specifically, you need to add a wrapper.java.additional.n property that specifies the property name and value that you want to pass to Integration Server, where "n" is a unique sequence number. The property name must be preceded by -D.For example, the wrapper.java.additional properties in the custom_wrapper.conf file might look similar to the following:• wrapper.java.additional.204=-Dhttps.proxyHost=YOUR_PROXY_HOST• wrapper.java.additional.205=-Dhttps.proxyPort=YOUR_PROXY_PORT• wrapper.java.additional.206=-Dhttps.proxyUser=YOUR_PROXY_USER• wrapper.java.additional.207=-Dhttps.proxyPassword=YOUR_PROXY_PASSWORD• wrapper.java.additional.208=-Dhttp.nonProxyHosts=localhost|127.0.0.1

Configure the Internet ProxyWhen using a proxy server for outbound requests from On-Premise Integration Server to Mind Connect Integration, you may need to configure the whitelist entries on the proxy server. If the proxy server employs a whitelist of allowed URLs, you need to add the URL for Mind Connect Integration.

10.2 User Management in MindConnect Integration On-Premise

Make “MindConnect Integration” available on LaunchpadTo make MindConnect Integration available on MindSphere Launchpad proceed as follows:1. Log in to MindSphere Launchpad and go to Settings. 2. In Settings assign either the role “mdsp:core:mci.user” or “mdsp:core:mci.admin” to users

you want to give permission to access MindConnect Integration. Users should then see the MindConnect Integration tile on Launchpad and be able to access MindConnect Integration.

Administrator in MindConnect IntegrationA user can be Administrator in MindConnect Integration by assigning to the “mdsp:core:mci.admin” role. Note that the user needs to logout/login MindSphere Launchpad for the changes to take effect.

Technical User in MindConnect IntegrationAfter the provisioning, the system will automatically create a Technical User. You can use this Technical User for On-Premise applications and also for calling REST APIs in MindConnect Integration.

MindConnect Integration On-Premise10.2 User Management in MindConnect Integration On-Premise


Downloading On-Premise ApplicationsTo download the On-Premise applications for MindConnect Integration, the Software AG installer requires to access the Software Download Center - Empower portal (https://empower.softwareag.com/).For more information about the Software AG Installer, see the Universal messaging (https://documentation.softwareag.com/onlinehelp/Rohan/num10-5/10-5_UM_webhelp/index.html#page/um-webhelp%2Fco-install_sag_installer.html%23) documentation.

Set up On-Premise ApplicationsIn case of provisioning with On-Premise offering, you will need to configure your On-Premise applications. To configure the On-Premise application proceed as follows:• Set up the On-Premise application according to the email “Confirmation - Your MindConnect

Integration for On-premise purchase”.• In your On-Premise Integration Server settings you need to provide Technical User credentials

and URL as shown below:

(*) If you have more than one tenant admin user, the first created tenant admin will receive the emails.

10.3 Firewall-Settings

Europe 1The AWS Prod Firewall configurations given in this section are only intended for the "Production" environment. For the "Development" environment within MindConnect Integration, different "Stages" are being used to run operations/integrations. For more details about stages, refer to Chapter Stages (Page 35).AWS PRODUniversal Messaging18.195.118.254:44318.195.200.248:44318.195.120.116:443Port 80 will be always routed to port 443.1.1.2

MindConnect Integration On-Premise10.3 Firewall-Settings


https://empower.softwareag.com/

https://empower.softwareag.com/

https://documentation.softwareag.com/onlinehelp/Rohan/num10-5/10-5_UM_webhelp/index.html#page/um-webhelp%2Fco-install_sag_installer.html%23



Load Balancer RecommendationPlease use NLB configurationNLB IP adresses to configure:54.93.54.234:44318.185.122.75:4431.2

NoteELB IP addresses can be changed regularly. Therefore an NLB with a static IP address must be implemented.

Siemens internal proxy setting for reference:telnet zabbix.nes.siemens.de 8888 CONNECT integration.mcintegration.eu-central.mindsphere.io HTTP/1.1To configure the proxy server, use the following steps from the webMethods Integration Server Administrator’s Guide (https://documentation.softwareag.com/webmethods/microservices_container/msc10-5/10-5_MSC_PIE_webhelp/index.html#page/integration-server-integrated-webhelp%2Fto-connecting_to_wmic_through_proxy.html).

Europe 2The firewall configurations are given below:Universal Messagingum-01-azureprod: 52.174.140.176:443um-02-azureprod: 52.174.140.180:443um-03-azureprod: 52.174.143.104:443

Load BalancerLoadBalancer IP address: 51.137.106.246:443LoadBalancer DNS name: 56b10481-75a4-44e4-a125-e93084f5cfa2.cloudapp.net:443 Siemens internal proxy setting for reference:telnet zabbix.nes.siemens.de 8888 CONNECT integration.mcintegration.eu-central.mindsphere.io HTTP/1.1

To configure the proxy server, you can also follow the following steps from the webMethods Integration Server Administrator’s Guide (https://documentation.softwareag.com/webmethods/microservices_container/msc10-5/10-5_MSC_PIE_webhelp/index.html#page/integration-server-integrated-webhelp%2Fto-connecting_to_wmic_through_proxy.html).

MindConnect Integration On-Premise10.3 Firewall-Settings


https://documentation.softwareag.com/webmethods/microservices_container/msc10-5/10-5_MSC_PIE_webhelp/index.html#page/integration-server-integrated-webhelp%2Fto-connecting_to_wmic_through_proxy.html






10.4 Configure Integration Server for MindConnect Integration

webMethods Cloud: SettingsThe Settings screen allows you to specify the location and login details of Mind Connect Integration tenant for which you will connect as well as define accounts and applications.

webMethods Cloud: AccountsWhen you create an account on the On-Premise Integration Server, you specify the connection parameters that the On-Premise Integration Server uses to access Mind Connect Integration. Each account looks for requests from a specific stage on Mind Connect Integration. You can define as many accounts for each stage as necessary and upload them to make them available to Mind Connect Integration.

webMethods Cloud: ApplicationsYou can create applications on the On-Premise Integration Server to share services with Mind Connect Integration.

Check uploaded application in MindConnect IntegrationAfter successful uploading of application from On-Premise, check on the integration cloud whether the application is enabled or not. Click "Test Connection" and the account will turn to "Enabled" state.

MindConnect Integration On-Premise10.4 Configure Integration Server for MindConnect Integration


MindConnect Integration On-Premise10.4 Configure Integration Server for MindConnect Integration


MindConnect Integration - MindSphere Documentation

Documents

Transcript of MindConnect Integration - MindSphere Documentation