You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
title: Connect to COBOL and RPG programs on IBM midrange systems
3
-
description: Integrate COBOL and RPG programs on IBM midrange systems with Standard workflows in Azure Logic Apps using the IBM i connector.
2
+
title: Access COBOL & RPG Programs from Standard Workflows
3
+
description: Connect to COBOL and RPG programs on IBM midrange systems from Standard workflows in Azure Logic Apps by using the IBM i connector.
4
4
services: logic-apps
5
5
ms.suite: integration
6
6
author: haroldcampos
7
7
ms.author: hcampos
8
8
ms.reviewer: estfan, azla
9
9
ms.topic: how-to
10
-
ms.date: 02/20/2025
10
+
ms.date: 04/08/2025
11
+
12
+
#customer intent: As a developer, I want to use the IBM i connector so I can integrate COBOL and RPG programs on IBM midrange systems with Standard workflows in Azure Logic Apps.
11
13
---
12
14
13
15
# Integrate COBOL and RPG programs on IBM midrange systems with Standard workflows in Azure Logic Apps
@@ -16,114 +18,108 @@ ms.date: 02/20/2025
16
18
17
19
To access and run COBOL and RPG programs on IBM midrange systems from Standard workflows in Azure Logic Apps, you can use the **IBM i Program Call** built-in, service provider-based connector. The IBM i operating system provides a Distributed Program Calls (DPC) server. The connector communicates with the IBM i DPC server to execute COBOL and RPG programs by using TCP/IP. The IBM i connector is available in all Azure Logic Apps regions except for Azure Government and Microsoft Azure operated by 21Vianet.
18
20
19
-
This how-to guide describes the following aspects about the IBM i connector:
20
-
21
-
* Why use the IBM i connector in Azure Logic Apps
21
+
This article describes the following aspects about the IBM i connector:
22
22
23
+
* Scenarios for using the IBM i connector in Azure Logic Apps
23
24
* Prerequisites and setup for using the IBM i connector
24
-
25
25
* Steps for adding IBM i connector actions to your Standard logic app workflow
26
26
27
-
## Why use this connector?
27
+
## Review the connector usage scenarios
28
28
29
-
More than 50 years ago, IBM released the first midrange systems. IBM advertised them as “Small in size, small in price and Big in performance. It is a system for now and for the future”. Over the years, the midrange systems evolved and became pervasive in medium-sized businesses or in large enterprises to extend mainframe environments. Midrange systems running IBM i, typically Power Systems, support TCP/IP and SNA.
29
+
More than 50 years ago, IBM released the first midrange systems. IBM advertised them as "Small in size, small in price and Big in performance. It is a system for now and for the future." Over the years, the midrange systems evolved and became pervasive in medium-sized businesses or in large enterprises to extend mainframe environments. Midrange systems that run IBM i, typically Power Systems, support TCP/IP and SNA.
30
30
31
-
The IBM i system includes the DPC server feature that allows most IBM i applications to interact with clients such as Azure Logic Apps using the client-initiated only request-reply pattern with minimum modifications. DPC is a documented protocol that supports program-to-program integration on an IBM i system, which client applications can easily access using the TCP/IP networking protocol.
31
+
The IBM i system includes the DPC server feature that allows most IBM i applications to interact with clients like Azure Logic Apps by using the client-initiated only request-reply pattern with minimum modifications. DPC is a documented protocol that supports program-to-program integration on an IBM i system, which client applications can easily access by using the TCP/IP networking protocol.
32
32
33
-
Microsoft [Host Integration Server (HIS)](/host-integration-server/what-is-his) provides connectivity to IBM i systems using TCP/IP and APPC LU6.2. For many years, customers have used the HIS Transaction Integrator (TI) to integrate IBM i systems and Windows on premises. The **IBM i Program Call** connector uses the TCP/IP [programming model](/host-integration-server/core/choosing-the-appropriate-programming-model1) to interact with IBM i COBOL and RPG programs.
33
+
Microsoft [Host Integration Server (HIS)](/host-integration-server/what-is-his) provides connectivity to IBM i systems by using TCP/IP and APPC LU6.2. For many years, customers have used the HIS Transaction Integrator to integrate on-premises IBM i systems and Windows. The **IBM i Program Call** connector uses the TCP/IP [programming model](/host-integration-server/core/choosing-the-appropriate-programming-model1) to interact with IBM i COBOL and RPG programs.
34
34
35
35
The following diagram shows how the IBM i connector interacts with an IBM i system:
36
36
37
37
:::image type="content" source="media/integrate-ibmi-apps-dpc/ibmi-connector-overview.png" alt-text="Conceptual diagram shows how the IBM i Program Call connector works with an IBM midrange system." lightbox="media/integrate-ibmi-apps-dpc/ibmi-connector-overview.png":::
38
38
39
39
To extend these hybrid cloud scenarios, the IBM i connector in a Standard workflow works with the [HIS Designer for Logic Apps](/host-integration-server/core/application-integration-ladesigner-2), which you can use to create a *program definition* or *program map* of the COBOL or RPG program. For this task, the HIS Designer uses a [programming model](/host-integration-server/core/choosing-the-appropriate-programming-model1) that determines the characteristics of the data exchange between the midrange and the workflow. The HIS Designer converts that information into metadata that the IBM i connector uses when running an action in your workflow.
40
40
41
-
After you generate the metadata file as Host Integration Designer XML (HIDX) file from the HIS Designer, you can add that file as a map artifact to your Standard logic app resource. That way, your workflow can access your app's metadata when you add an IBM i connector action. The connector reads the metadata file from your logic app resource, and dynamically presents parameters to use with the IBM i connector in your workflow. You can then provide parameters to the host application, and the connector returns the results to your workflow. As a result, you can integrate your legacy apps with Azure, Microsoft, other apps, services, and systems that Azure Logic Apps supports.
41
+
After you generate the metadata file as a Host Integration Designer XML (HIDX) file from the HIS Designer, you can add that file as a map artifact to your Standard logic app resource. That way, your workflow can access your app's metadata when you add an IBM i connector action. The connector reads the metadata file from your logic app resource, and dynamically presents parameters to use with the IBM i connector in your workflow. You can then provide parameters to the host application, and the connector returns the results to your workflow. As a result, you can integrate your legacy apps with Azure, Microsoft, other apps, services, and systems that Azure Logic Apps supports.
42
42
43
43
## Connector technical reference
44
44
45
-
The following section describes the operations for the IBM i connector, which currently includes only the following action:
46
-
47
-
### Call an IBM i program
45
+
Currently, one operation is available for the IBM i connector: **Call an IBM i program**. The following table summarizes the usage for this action:
48
46
49
47
| Parameter | Required | Type | Description |
50
-
|-----------|----------|-------|-------------|
48
+
|-----------|----------|------|-------------|
51
49
|**HIDX Name**| Yes | String | Select the IBM i HIDX file that you want to use. |
52
50
|**Method Name**| Yes | String | Select the method in the HIDX file that you want to use. |
53
51
|**Advanced parameters**| No | Varies | This list appears after you select a method so that you can add other parameters to use with the selected method. The available parameters vary based on your HIDX file and the method that you select. |
54
52
55
53
This operation also includes advanced parameters, which appear after you select a method, for you to select and use with the selected method. These parameters vary based on your HIDX file and the method that you select.
56
54
57
-
## Limitations
58
-
59
-
Currently, this connector requires that you upload your HIDX file directly to your Standard logic app resource, not an integration account.
60
-
61
55
## Prerequisites
62
56
63
57
* An Azure account and subscription. If you don't have an Azure subscription, [sign up for a free Azure account](https://azure.microsoft.com/free/?WT.mc_id=A261C142F).
64
58
65
-
* Access to the midrange that hosts the IBM i system
59
+
* Access to the midrange server that hosts the IBM i system.
66
60
67
61
* The Host Integration Designer XML (HIDX) file that provides the necessary metadata for the **IBM i Program Call** connector to execute your midrange program.
68
62
69
63
To create this HIDX file, [download and install the HIS Designer for Azure Logic Apps](https://aka.ms/his-designer-logicapps-download). The only prerequisite is [Microsoft .NET Framework 4.8](https://aka.ms/net-framework-download).
70
64
71
-
To invoke a midrange program, your workflow needs to understand the midrange program's type, parameters, and return values. The IBM i connector manages this process and data conversions, which are required for providing input data from the workflow to the midrange program and for sending any output data generated from the midrange program to the workflow. The connector also provides tabular data definition and code page translation. For this process, Azure Logic Apps requires that you provide this information as metadata.
65
+
To invoke a midrange program, your workflow needs to understand the midrange program's type, parameters, and return values. The IBM i connector manages this process and data conversions. These required conversions provide input data from the workflow to the midrange program and send any output data generated from the midrange program to the workflow. The connector also provides tabular data definition and code page translation. For this process, Azure Logic Apps requires that you provide this information as metadata.
72
66
73
67
To create this metadata, use the [HIS Designer for Logic Apps](/host-integration-server/core/application-integration-ladesigner-2). With this tool, you can manually create the methods, parameters, and return values that you use in your workflow. You can also import COBOL or RPG program definitions (copybooks) that provide this information.
74
68
75
-
The tool generates a Host Integration Designer XML (HIDX) file that provides the necessary metadata for the connector. If you're using HIS, you can use the TI Designer to create the HIDX file.
69
+
The tool generates a Host Integration Designer XML (HIDX) file that provides the necessary metadata for the connector. If you're using HIS, you can use the HIS Transaction Integrator (TI) Designer to create the HIDX file.
76
70
77
-
* The Standard logic app workflow where you want to integrate with the IBM i system
71
+
* The Standard logic app workflow where you want to integrate with the IBM i system.
78
72
79
73
The IBM i connector doesn't have triggers, so use any trigger to start your workflow, such as the **Recurrence** trigger or **Request** trigger. You can then add the IBM i connector action. To get started, create a blank workflow in your Standard logic app resource.
80
74
81
-
<aname="define-generate-app-metadata"></a>
75
+
## Limitations
76
+
77
+
Currently, the IBM i connector requires that you upload your HIDX file directly to your Standard logic app resource, not an integration account.
82
78
83
79
## Define and generate metadata
84
80
85
81
After you download and install the HIS Designer for Azure Logic Apps, follow [these steps to generate the HIDX file from the metadata artifact](/host-integration-server/core/application-integration-lahostapps).
86
82
87
-
<aname="upload-hidx-file"></a>
88
-
89
83
## Upload the HIDX file
90
84
91
85
For your workflow to use the HIDX file, follow these steps:
92
86
93
87
1. Go to the folder where you saved your HIDX file, and copy the file.
94
88
95
-
1. In the [Azure portal](https://portal.azure.com), [upload the HIDX file as a map to your Standard logic app resource](../logic-apps/logic-apps-enterprise-integration-maps.md?tabs=standard#add-map-to-standard-logic-app-resource).
89
+
1. In the [Azure portal](https://portal.azure.com), open your Standard logic app resource.
96
90
97
-
1.Now, [add a IBM i action to your workflow](#add-ibmi-action).
91
+
1.On the logic app menu, under **Artifacts**, [upload the HIDX file as a map to the logic app resource](../logic-apps/logic-apps-enterprise-integration-maps.md?tabs=standard#add-map-to-standard-logic-app-resource).
98
92
99
-
Later in this guide, when you add a **IBM i Program Call** connector action to your workflow for the first time, you're prompted to create a connection between your workflow and the midrange system. After you create the connection, you can select your previously added HIDX file, the method to run, and the parameters to use.
93
+
1. Continue to the next section to [add an IBM i action to your workflow](#add-an-ibm-i-action).
100
94
101
-
<aname="add-ibmi-action"></a>
95
+
Later in this guide, when you add an **IBM i Program Call** connector action to your workflow for the first time, a prompt asks you to create a connection between your workflow and the midrange system. After you create the connection, you can select your previously added HIDX file, the method to run, and the parameters to use.
102
96
103
97
## Add an IBM i action
104
98
99
+
Follow these steps to add an IBM i action and configure the necessary parameters:
100
+
105
101
1. In the [Azure portal](https://portal.azure.com), open your Standard logic app resource and workflow in the designer.
106
102
107
-
1. If you haven't already added a trigger to start your workflow, [follow these general steps to add the trigger that you want](../logic-apps/create-workflow-with-trigger-or-action.md?tabs=standard#add-trigger).
103
+
1. If you don't have a trigger to start your workflow, follow [these general steps to add the trigger that you want](../logic-apps/create-workflow-with-trigger-or-action.md?tabs=standard#add-trigger).
108
104
109
-
This example continues with the **Request** trigger named **When a HTTP request is received**.
105
+
This example continues with the **Request** trigger named **When a HTTP request is received**:
110
106
111
107
:::image type="content" source="media/integrate-ibmi-apps-dpc/request-trigger.png" alt-text="Screenshot shows Azure portal, Standard workflow designer, and Request trigger." lightbox="media/integrate-ibmi-apps-dpc/request-trigger.png":::
112
108
113
-
1. To add an IBM i connector action, [follow these general steps to add the **IBM i Program Call** built-in connector action named **Call an IBM i Program**](../logic-apps/create-workflow-with-trigger-or-action.md?tabs=standard#add-trigger).
109
+
1. To add an IBM i connector action, follow [these general steps to add the **IBM i Program Call** built-in connector action named **Call an IBM i Program**](../logic-apps/create-workflow-with-trigger-or-action.md?tabs=standard#add-trigger).
114
110
115
111
1. After the connection details pane appears, provide the following information, such as the host server name and IBM i system configuration information:
116
112
117
113
| Parameter | Required | Value | Description |
118
114
|-----------|----------|-------|-------------|
119
-
|**Connection Name**| Yes | <*connection-name*> | The name for your connection |
120
-
|**Server certificate common name**| No | <*server-cert-common-name*> | The name of the Transport Security layer (TLS) certificate to use |
121
-
|**Code Page**| No | <*code-page*> | The code page number to use for converting text |
122
-
|**Password**| No | <*password*> | The optional user password for connection authentication |
123
-
|**Port Number**| Yes | <*port-number*> | The port number to use for connection authentication |
124
-
|**Server Name**| Yes | <*server-name*> | The server name |
125
-
|**Timeout**| No | <*timeout*> | The timeout period in seconds while waiting for responses from the server |
126
-
|**User Name**| No | <*user-name*> | The optional username for connection authentication |
115
+
|**Connection Name**| Yes | <*connection-name*> | The name for your connection.|
116
+
|**Server certificate common name**| No | <*server-cert-common-name*> | The name of the Transport Security layer (TLS) certificate to use.|
117
+
|**Code Page**| No | <*code-page*> | The code page number to use for converting text.|
118
+
|**Password**| No | <*password*> | The optional user password for connection authentication.|
119
+
|**Port Number**| Yes | <*port-number*> | The port number to use for connection authentication.|
120
+
|**Server Name**| Yes | <*server-name*> | The server name.|
121
+
|**Timeout**| No | <*timeout*> | The time-out period in seconds while waiting for responses from the server.|
122
+
|**User Name**| No | <*user-name*> | The optional username for connection authentication.|
127
123
|**Use TLS**| No | True or false | Secure the connection with Transport Security Layer (TLS). |
128
124
|**Validate Server certificate**| No | True or false | Validate the server's certificate. |
129
125
@@ -145,27 +141,29 @@ Later in this guide, when you add a **IBM i Program Call** connector action to y
145
141
146
142
**Select HIDX file and method**
147
143
148
-
:::image type="content" source="./media/integrate-ibmi-apps-dpc/action-parameters.png" alt-text="Screenshot shows IBM i action with selected HIDX file and method.":::
144
+
:::image type="content" source="./media/integrate-ibmi-apps-dpc/action-parameters.png" alt-text="Screenshot shows IBM i action with selected HIDX file and method." lightbox="./media/integrate-ibmi-apps-dpc/action-parameters.png":::
149
145
150
146
**Select advanced parameters**
151
147
152
148
:::image type="content" source="./media/integrate-ibmi-apps-dpc/action-advanced-parameters.png" alt-text="Screenshot shows IBM i action with all parameters." lightbox="./media/integrate-ibmi-apps-dpc/action-advanced-parameters.png":::
153
149
154
-
1. When you're done, save your workflow. On designer toolbar, select **Save**.
150
+
1. When you're done, save your workflow. On the designer toolbar, select **Save**.
155
151
156
152
## Test your workflow
157
153
158
-
1. To run your workflow, on the workflow menu, select **Overview**. On the **Overview** toolbar, select **Run** > **Run**.
154
+
Follow these steps to check your workflow and confirm the outputs:
155
+
156
+
1. To run your workflow, on the designer toolbar, select **Run** > **Run**.
159
157
160
-
After your workflow finishes running, your workflow's run history appears. Successful steps show check marks, while unsuccessful steps show an exclamation point (**!**).
158
+
After your workflow finishes running, the workflow's run history appears. Successful steps show check marks, while unsuccessful steps show an exclamation point (**!**).
161
159
162
160
1. To review the inputs and outputs for each step, expand that step.
163
161
164
162
1. To review the outputs, select **See raw outputs**.
165
163
166
-
## Next steps
164
+
## Related content
167
165
168
-
*[Monitor workflow run status, review trigger and workflow run history, and set up alerts in Azure Logic Apps](../logic-apps/monitor-logic-apps.md?tabs=standard)
166
+
*[Check workflow status, view run history, and set up alerts in Azure Logic Apps](../logic-apps/view-workflow-status-run-history.md?tabs=standard)
169
167
*[View metrics for workflow health and performance in Azure Logic Apps](../logic-apps/view-workflow-metrics.md?tabs=standard)
170
168
*[Monitor and collect diagnostic data for workflows in Azure Logic Apps](../logic-apps/monitor-workflows-collect-diagnostic-data.md?tabs=standard)
171
169
*[Enable and view enhanced telemetry in Application Insights for Standard workflows in Azure Logic Apps](../logic-apps/enable-enhanced-telemetry-standard-workflows.md)
0 commit comments