Connection of IGUASU to the BPC

IGUASU is a platform for controlling data flows of any sources, destinations and formats.

It allows the creation and execution of flows. In the flows, different modules (processors) of specific functions are linked using a directed graph. This defines the order of execution, but also conditions that must be met. Branches, loops and dynamic processes can therefore be implemented.

A connection to the BPC enables user input and process data to be processed in IGUASU and linked as an application with other external services. In addition, results determined in IGUASU can be displayed clearly in the BPC to provide a better overview of the existing business processes.

To connect IGUASU to the BPC, some configurations must first be made, which are described in detail in the following section Configuration. Once the connection has been configured, data can be transferred between the BPC and IGUASU in both directions. The exchange of data and the options available for this are listed in the section Transfer data between IGUASU and the BPC.

Further information on configuring the Services and processors in the IGUASU can be found in the IGUASU documentation.

Requirements

You need a BPC application version 4.0 or higher for the link between the IGUASU and the BPC.

Configuration

The configuration for the connection between the IGUASU and the BPC is carried out in the Administration area. Accordingly, rights are required to be able to operate in the administration area.
If necessary, contact your administrator if you encounter difficulties with the configuration.
Instructions for configuring the connection in IGUASU can be found in the IGUASU documentation.

Create API key

The API key from the BPC is used in IGUASU in the HybridRESTClientController service to establish the connection.

  1. Open the Core Services tab and API Keys sub-tab in the administration area.

  2. Click on the Add-Button to add a new API key.

  3. Enter information under "Name" and "Issued for" to make it easier to assign to IGUASU.

    Create API key

  4. Fill in further fields if necessary.

  5. If necessary, assign organizations/roles/rights, see Mapping of organizations, roles and rights.

  6. Save settings via the Save-Button.

Create new flow component

A new component must be created in the embedded flow module. This allows connections to be established to the IGUASU processors.

  1. Open the Flow tab and Components sub-tab in the administration area.

  2. Click on the Add-Button to add a new component.

  3. Select the desired type (here: "IGUASU") and confirm with OK.

  4. Define "Module_Name" and "Module_Description" for identification.

  5. Enter the corresponding address for the IGUASU under "Target_BaseURL".
    If BPC and IGUASU are operated in the same cloud, the URL is “https://iguasu-nifi:PORT”
    The Port is defined in the IGUASU HybridRESTServerController.
    In addition to the authentication, add the "Connection_Username" and "Connection_Password" details, which have also been defined in the BPCListenerController service.

  6. Use the Create-Button to create the component.

  7. Make adjustments to the configuration under "URL", "Username" and "Password" if necessary.

  8. Save the settings via the Save-Button.

If the configuration is successful, IGUASU listener processors that have already been created are displayed in the Processors field.

Flow IGUASU configuration

Transfer data between IGUASU and the BPC

Once IGUASU has been successfully connected to the BPC, data can be communicated between the applications in both directions.
This section describes an example of a transmission direction.

From the BPC to IGUASU

The first direction of data transfer is the transfer of information from the BPC to IGUASU. User input can be forwarded using the Forms module, for example. The forms created can be designed and adapted as desired in order to adapt the input options to individual requirements.

Extensive information on configuration and the elements of the module can be found at Forms.

For communication with IGUASU, the submitURL must also be adapted to the general configuration of the module. The IGUASU component created in which the corresponding listeners were defined is entered under configurations in the form code. The ID of the component created and the ID of the ListenBPCFlowStarter processor in IGUASU are entered in the submit URL.
By default, the path is /bpc/cxf/bpc-flow/flow/KOMPONENTEN_ID/PROZESSOR_ID.

If the configuration is successful, the completed content in the form is transmitted with further data to the corresponding ListenerBPCFlowStarter processor.

From IGUASU to the BPC

In IGUASU, the data can be returned both to the AuditLog-Monitor and to process monitors created in the BPC. The procedure for both processes is described in the following two sections.

Create AuditLogs

Audit logs require no further configuration once the BPCController Service has been set up in IGUASU. The audit level, the action and the originator are defined in the PutBPCAuditLog processor in IGUASU. The created audit log is then displayed in the AuditLog-Monitor and thus provides an improved overview of the actions.

Create ProcessLogs

In addition to the audit logs, more specific process logs can also be generated, which are displayed in preconfigured process monitors and provide a better overview of business processes. Two components are required for this purpose, which must be configured in advance.

On the one hand, a ProcessLogger is required, which can be used in IGUASU to transmit the corresponding data. Comprehensive information on this can be found in the section Log Services.
No further adjustments are necessary in the BPC for use in IGUASU. However, care should be taken to ensure that the configured structure matches the data in IGUASU so that errors are excluded during transmission. Once the process logger has been created, it should be available as a selection option in the PutBPCProcessLog processor in IGUASU.

In addition, the configuration of a process monitor is required on which the generated data is displayed. Detailed information on the customization possibilities and options can be found in the section Process Monitoring. Similar to the Process Logger, no specific configurations are required for IGUASU, so that the module can be used after creation without further customization.

Jump from BPC to IGUASU

Errors or irregularities that become visible in BPC Process Monitoring (e.g. a failed process step) often require a more detailed investigation to identify the cause. By jumping to IGUASU, the user can view the details of the specific processor responsible for this process step. This could show, for example, that the processor has received an incorrect input.

The jump to IGUASU is therefore useful for error analysis and traceability of data origin and processing.

If AuditLogs or ProcessLogs have been created, a column with the index externalReference is generated on the corresponding monitor. This column can be configured in the column configuration (Monitor_ColumnConfig) so that you can jump from the monitor with one click to the processor or Service in the IGUASU that executed the event that wrote this data. If the event is too old and therefore no longer available, you can still access the processor or Service.

It is necessary that the Flow component has been created has been created beforehand, because the ID of this component must be specified in the column configuration.
Monitor_ColumnConfig for the column externalReference:

{
    "filter": {
        "type": "json"
    },
    "hidden": false,
    "dataIndex": "externalReference",
    "hideable": true,
    "width": 200,
    "customRenderer": "flow!_!flowRenderer", (1)
    "minWidth": 64,
    "hideUnknownObjects": true, (2)
    "text": "externalReference",
    "sortable": true,
    "linkIcon": "x-fal fa-fire", (3)
    "flowId": "mein-iguasu" (4)
}
1 Required if the content of the column is to be transformed into a link.
2 Optional. Hides unknown objects that do not have the type iguasu or inubit.
3 Optional. Defines the icon that is displayed next to the text.
4 Required to generate links with the customRenderer. ID of the flow component that references the system that writes data to the monitor.

You can find more information about the monitor column configuration here.

Keywords:
Press Esc to exit full screen
Modal image placeholder
Press Esc to exit full screen