Skip to main content

IF Integration Guidelines

The following table lists the integration function types in Integration Framework, along with their expected usage and steps.

High-level Integration Framework functionality

TypeActionComplete Description and Steps
INPUTCollect/Reference external data inside AF attributesThis function lets you get data (scalar or tabular) in PIAF Attributes from external systems:Configure the connector for the external system, in order to establish a valid connection.Define the Dataset according to the type of connector.The dataset represents the business rule to retrieve data from the external systemConsume the Dataset defined at the previous step with the Integration Framework Data Reference.The Data Reference has client smart look-up functions in order to get the scalar value.
Asset SynchronizationThis function lets you synchronize asset repositories (logical or physical objects) into PI-AF system. The repository can be structured as flat-lists or in hierarchical structures. This function can be used to retrieve movements from external systems or to update Sigmafine models.Elements:Configure the connector for the external system, in order to establish a valid connection.Configure the connector for the PI-AF/Sigmafine system to be synchronized.Define the Dataset(s) according to the type of connector of the external system.The dataset(s) represent the business rule(s)Define an Integration Rule (workflow) including the flow of the data.The flow should start with the source Dataset(s) and must be terminated with the AF EndPoint – ELEMENTS.Configure the EndPoint for:AF DB element/DB root entry pointHierarchy definitionElement name/template definitionElement Attribute configurationTransfers:Configure the connector for the external system, in order to establish a valid connection.Configure the connector for the PI-AF/Sigmafine system to be synchronized.Define the Dataset(s) according to the type of connector of the external system.The dataset(s) represent the business rule(s)Define an Integration Rule (workflow) including the flow of the data.The flow should start with the source Dataset(s) and must be terminated with the AF EndPoint – TRANSFERS.Configure the EndPoint for:AF database to be populated and transfer templateTransfer Attributes configuration
OUTPUTAsset SynchronizationThis function lets you synchronize asset repositories (logical or physical objects) starting from PI-AF databases/models.Elements/Transfers:Configure the connector for the external system, in order to establish a valid connection.Configure the connector for the PI-AF/Sigmafine system source of the configuration.Define the AF Dataset(s) query/table containing the master data for the integration, in order to have a tabular Dataset containing data to be exported to the external system.Define an Integration Rule (workflow) including the flow of the data.The flow should start with the source AF query defined in the step before and must be terminated with the external system Dataset(s)Configure the final Dataset with the following items:Include the Type of call to the external system.Ensure that the Dataset will be called for each row included in the source Dataset from AF.Check the parameter names, values and formats (for numbers and date/time) .
Data ExposureThis function lets you expose in SOA paradigm PI or PI-AF data to the external system. Data is only exposed, so this feature should be ready to reply to the external system like a “server”. The Data Exposure can be used in conjunction with:Already existing Dataset in Integration FrameworkAlready defined Integration RulesCustom assemblies to be exposed as SOA providerSigmafine Reporting packagesExpected sequence:Define the exposure connector in terms of:Name/NamespaceProtocol handler (TCP/HTTP/HTTPS…)TCP portInterface contract type: WS-I, WCF…etcConfigure the type of the data exposed:DatasetIntegration RuleCustom AssemblySigmafine Reporting PackagePolicy Validation: The engine automatically loads the definition of the data interfaces in terms of input and output structures and it builds the necessary WS/WCF contracts/WSDL/XML structures compliant with the interface contract type selected.Once the contract interface has been built and ready it is loaded and started in the Integration Framework server and is available to external systems.This interface can be turned-on/off by the Integration Framework admin and there’s an option to start it up automatically upon Integration Framework startup.Upon the external system call (so triggered by external service), this connector automatically triggers the object exposed that was configured in step 2 and it outputs the data according to the policy validated in the step 3.
Publish DataThis functions lets you publish PI or PI-AF data (not structures) directly into external systems. This feature will create a copy of data (not only results) into the destination system(s).Expected sequence:Configure the connector for the external system, in order to establish a valid connection.Configure the connector for the PI-AF/Sigmafine system source of the configuration.Define the AF Dataset(s) query/table containing the master data for the integration, in order to have a tabular Dataset containing data to be exported.Define an Integration Rule (workflow) including the flow of the data.The flow should start with the source AF query defined in the step before and terminated with the external system Dataset(s)Configure the final Dataset with the following items:Include the Type of call to the external system.Ensure that the Dataset is called for each row included in the source Dataset from AF.Check the parameter names, values and formats (for numbers and date/time).
INPUT / OUTPUTRetrieving and posting data from/to SAPThis function lets you post PI or PI-AF data (not structures) directly into SAP. This feature is a bidirectional data-flow between SAP and the PI-AF system.In order to integrate the following modules:PMMMInput sequence (from SAP to PI-AF):Create and instance of the SAP Connector and configure the SAP server connection parameters.Instantiate and configure the connector for the PIAF/Sigmafine system receiving the data and use it as the endpoint.Select the SAP MODULE connector (MM, PM, etc) and create the endpoint for integration.Select the BAPI to implement from the list of the available BAPIs for the selected module and create a Dataset over it.Define a new Integration Rule (workflow) including the following objects:SAP source Dataset (3 and 4)PI-AF endpoint (step 2)At the PI-AF endpoint level, configure the database and the asset type; attribute, Element or transfer.For the specific asset type, configure the specific mappings between SAP Dataset results returned by the BAPI and the PI-AF asset type.Output sequence (from PI-AF to SAP):Instantiate the SAP Connector and configure the SAP server connection parameters.Instantiate and configure the connector for the PIAF/Sigmafine system source of the dataDefine the AF Dataset(s) query/table containing the master data for the integration in order to have a tabular Dataset containing data to be exportedSelect the SAP MODULE connector (MM, PM, etc) and create the endpoint for integrationSelect the BAPI to implement from the list of the available BAPIs for the selected moduleDefine a new Integration Rule (workflow) including the following objects:Source Dataset (step 3)SAP endpoint (step 4 and 5)Configure at SAP endpoint level parameters to run the integration.Each item is an input BAPI parameter, while each row is a BAPI call.