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
description: Integrate IMS programs with Standard workflows in Azure Logic Apps using the IBM IMS connector.
2
+
title: Access IMS Programs from Standard Workflows
3
+
description: Connect to IMS programs on IBM mainframes from Standard workflows in Azure Logic Apps by using the IBM IMS 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 IMS connector so I can integrate IMS programs with Standard workflows in Azure Logic Apps.
11
13
---
12
14
13
15
# Integrate IMS programs on IBM mainframes with Standard workflows in Azure Logic Apps
@@ -16,17 +18,15 @@ ms.date: 02/20/2025
16
18
17
19
To access and run IBM mainframe apps on Information Management System (IMS) systems from Standard workflows in Azure Logic Apps, you can use the **IMS Program Call** built-in, service provider-based connector. IMS provides a Transaction Program (TP) Monitor with an integrated Transaction Manager (TM) and hierarchical database. The connector communicates with IBM IMS transaction programs by using IMS Connect, which is an IMS TM network component. This component provides high performance communications for IMS systems between one or more TCP/IP clients and one or more IMS systems. The IMS 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 IMS connector:
20
-
21
-
* Why use the IMS connector in Azure Logic Apps
21
+
This article describes the following aspects about the IMS connector:
22
22
23
+
* Scenarios for using the IMS connector in Azure Logic Apps
23
24
* Prerequisites and setup for using the IMS connector
24
-
25
25
* Steps for adding IMS connector actions to your Standard logic app workflow
26
26
27
-
## Why use this connector?
27
+
## Review the connector usage scenarios
28
28
29
-
IMS systems were one of the first mission-critical systems that run on mainframes. Microsoft [Host Integration Server (HIS)](/host-integration-server/what-is-his) provides connectivity to IMS systems by following two models: IMS Connect and APPC LU6.2. Customers have used the HIS Transaction Integrator (TI) to integrate their IMS systems with Windows onpremises for many years. The **IMS Program Call** connector uses the IMS Connect model to interact with IMS transaction programs through TCP/IP.
29
+
IMS systems were one of the first mission-critical systems to run on mainframes. Microsoft [Host Integration Server (HIS)](/host-integration-server/what-is-his) provides connectivity to IMS systems by following two models: IMS Connect and APPC LU6.2. Customers have used the HIS Transaction Integrator to integrate their IMS systems with Windows on-premises for many years. The **IMS Program Call** connector uses the IMS Connect model to interact with IMS transaction programs through TCP/IP.
30
30
31
31
The following diagram shows how the IMS connector interacts with an IBM mainframe system:
32
32
@@ -38,9 +38,7 @@ After you generate the metadata file as a Host Integration Designer XML (HIDX) f
38
38
39
39
## Connector technical reference
40
40
41
-
The following section describes the operations for the IMS connector, which currently includes only the following action:
42
-
43
-
### Call an IMS program
41
+
Currently, one operation is available for the IMS connector: **Call an IMS program**. The following table summarizes the usage for this action:
44
42
45
43
| Parameter | Required | Type | Description |
46
44
|-----------|----------|-------|-------------|
@@ -50,38 +48,34 @@ The following section describes the operations for the IMS connector, which curr
50
48
51
49
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.
52
50
53
-
## Limitations
54
-
55
-
Currently, this connector requires that you upload your HIDX file directly to your Standard logic app resource, not an integration account.
56
-
57
51
## Prerequisites
58
52
59
53
* 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).
60
54
61
-
* Access to the mainframe that hosts the IMS system
55
+
* Access to the mainframe that hosts the IMS system.
62
56
63
57
* The Host Integration Designer XML (HIDX) file that provides the necessary metadata for the **IMS Program Call** connector to execute your mainframe program.
64
58
65
-
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).
59
+
To create this HIDX file, [download and install the Host Integration Server (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).
66
60
67
-
To invoke a mainframe program, your workflow needs to understand the mainframe program's type, parameters, and return values. The IMS connector manages the process and data conversions, which are required for providing input data from the workflow to the mainframe program and for sending any output data generated from the mainframe 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.
61
+
To invoke a mainframe program, your workflow needs to understand the mainframe program's type, parameters, and return values. The IMS connector manages the process and data conversions. These conversions provide input data from the workflow to the mainframe program and send any output data generated from the mainframe 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.
68
62
69
63
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 can use in your workflow. The tool also allows you to import COBOL or RPG program definitions (copybooks) that provide this information.
70
64
71
-
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.
65
+
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.
72
66
73
-
* The Standard logic app workflow to use for integrating with the IMS system
67
+
* The Standard logic app workflow to use for integrating with the IMS system.
74
68
75
69
The IMS 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 IMS connector actions. To get started, create a blank workflow in your Standard logic app resource.
76
70
77
-
<aname="define-generate-app-metadata"></a>
71
+
## Limitations
72
+
73
+
Currently, the IMS connector requires that you upload your HIDX file directly to your Standard logic app resource, not an integration account.
78
74
79
75
## Define and generate metadata
80
76
81
77
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).
82
78
83
-
<aname="upload-hidx-file"></a>
84
-
85
79
## Upload the HIDX file
86
80
87
81
For your workflow to use the HIDX file, follow these steps:
@@ -90,40 +84,40 @@ For your workflow to use the HIDX file, follow these steps:
90
84
91
85
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).
92
86
93
-
1.Now, [add an IMS action to your workflow](#add-ims-action).
87
+
1.Continue to the next section to [add an IMS action to your workflow](#add-an-ims-action).
94
88
95
-
Later in this guide, when you add a **IMS Program Call** connector action to your workflow for the first time, you're prompted to create a connection between your workflow and the mainframe system. After you create the connection, you can select your previously added HIDX file, the method to run, and the parameters to use.
96
-
97
-
<aname="add-ims-action"></a>
89
+
Later in this article, when you add an **IMS Program Call** connector action to your workflow for the first time, a prompt asks you to create a connection between your workflow and the mainframe system. After you create the connection, you can select your previously added HIDX file, the method to run, and the parameters to use.
98
90
99
91
## Add an IMS action
100
92
93
+
Follow these steps to add an IMS action and configure the necessary parameters:
94
+
101
95
1. In the [Azure portal](https://portal.azure.com), open your Standard logic app resource and workflow in the designer.
102
96
103
-
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).
97
+
1. If you don't have a trigger to start your workflow, follow [these steps to add the trigger that you want](../logic-apps/create-workflow-with-trigger-or-action.md?tabs=standard#add-trigger).
104
98
105
-
This example continues with the **Request** trigger named **When a HTTP request is received**.
99
+
This example continues with the **Request** trigger named **When a HTTP request is received**:
106
100
107
101
:::image type="content" source="media/integrate-ims-apps-ibm-mainframe/request-trigger.png" alt-text="Screenshot shows Azure portal, Standard workflow designer, and Request trigger.":::
108
102
109
-
1. To add an IMS connector action, [follow these general steps to add the **IMS Program Call** built-in connector action named **Call an IMS Program**](../logic-apps/create-workflow-with-trigger-or-action.md?tabs=standard#add-trigger).
103
+
1. To add an IMS connector action, follow [these steps to add the **IMS Program Call** built-in connector action named **Call an IMS Program**](../logic-apps/create-workflow-with-trigger-or-action.md?tabs=standard#add-trigger).
110
104
111
105
1. After the connection details pane appears, provide the following information:
112
106
113
107
| Parameter | Required | Value | Description |
114
108
|-----------|----------|-------|-------------|
115
-
|**Connection Name**| Yes | <*connection-name*> | The name for your connection |
116
-
|**The IMS System ID**| Yes | <*IMS-system-ID*> | The name of the IMS system where the IMS Connect model directs incoming requests |
117
-
|**ITOC Exit Name**| No | <*ITOC-exit-name*> | The name for the exit routine that IMS uses to handle incoming requests |
118
-
|**MFS Mod Name**| No | <*MFS-Mod-Name*> | The name associated with the outbound IMS message output descriptor |
119
-
|**Use the HWSO1 Security Exit**| No | True or false |The server uses the HWSO1 security exit. |
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 | <*time-out*> | The timeout period in seconds while waiting for responses from the server |
126
-
|**User Name**| No | <*user-Name*> | The optional username for connection authentication |
109
+
|**Connection Name**| Yes | <*connection-name*> | The name for your connection.|
110
+
|**The IMS System ID**| Yes | <*IMS-system-ID*> | The name of the IMS system where the IMS Connect model directs incoming requests.|
111
+
|**ITOC Exit Name**| No | <*ITOC-exit-name*> | The name for the exit routine that IMS uses to handle incoming requests.|
112
+
|**MFS Mod Name**| No | <*MFS-Mod-Name*> | The name associated with the outbound IMS message output descriptor.|
113
+
|**Use the HWSO1 Security Exit**| No | True or false |Direct the server to use the HWSO1 security exit. |
114
+
|**Server certificate common name**| No | <*server-cert-common-name*> | The name of the Transport Security layer (TLS) certificate to use.|
115
+
|**Code Page**| No | <*code-page*> | The code page number to use for converting text.|
116
+
|**Password**| No | <*password*> | The optional user password for connection authentication.|
117
+
|**Port Number**| Yes | <*port-number*> | The port number to use for connection authentication.|
118
+
|**Server Name**| Yes | <*server-name*> | The server name.|
119
+
|**Timeout**| No | <*time-out*> | The time-out period in seconds while waiting for responses from the server.|
120
+
|**User Name**| No | <*user-Name*> | The optional username for connection authentication.|
127
121
|**Use TLS**| No | True or false | Secure the connection with Transport Security Layer (TLS). |
128
122
|**Validate Server certificate**| No | True or false | Validate the server's certificate. |
129
123
@@ -151,21 +145,23 @@ Later in this guide, when you add a **IMS Program Call** connector action to you
151
145
152
146
:::image type="content" source="./media/integrate-ims-apps-ibm-mainframe/action-advanced-parameters.png" alt-text="Screenshot shows IMS action with all parameters." lightbox="./media/integrate-ims-apps-ibm-mainframe/action-advanced-parameters.png":::
153
147
154
-
1. When you're done, save your workflow. On designer toolbar, select **Save**.
148
+
1. When you're done, save your workflow. On the designer toolbar, select **Save**.
155
149
156
150
## Test your workflow
157
151
158
-
1. To run your workflow, on the workflow menu, select **Overview**. On the **Overview** toolbar, select **Run** > **Run**.
152
+
Follow these steps to check your workflow and confirm the outputs:
153
+
154
+
1. To run your workflow, on the designer toolbar, select **Run** > **Run**.
159
155
160
-
After your workflow finishes running, your workflow's run history appears. Successful steps show check marks, while unsuccessful steps show an exclamation point (**!**).
156
+
After your workflow finishes running, the workflow's run history appears. Successful steps show check marks, while unsuccessful steps show an exclamation point (**!**).
161
157
162
158
1. To review the inputs and outputs for each step, expand that step.
163
159
164
160
1. To review the outputs, select **See raw outputs**.
165
161
166
-
## Next steps
162
+
## Related content
167
163
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)
164
+
*[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
165
*[View metrics for workflow health and performance in Azure Logic Apps](../logic-apps/view-workflow-metrics.md?tabs=standard)
170
166
*[Monitor and collect diagnostic data for workflows in Azure Logic Apps](../logic-apps/monitor-workflows-collect-diagnostic-data.md?tabs=standard)
171
167
*[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