Skip to content

Commit c02bbe0

Browse files
committed
refresh article and images
1 parent 8688aff commit c02bbe0

File tree

5 files changed

+54
-58
lines changed

5 files changed

+54
-58
lines changed
Lines changed: 54 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
---
22
title: Connect to IMS programs on IBM mainframes
3-
description: Integrate IMS programs with Standard workflows in Azure Logic Apps using the IBM IMS connector.
3+
description: Integrate IMS programs with Standard workflows in Azure Logic Apps by using the IBM IMS connector.
44
services: logic-apps
55
ms.suite: integration
66
author: haroldcampos
77
ms.author: hcampos
88
ms.reviewer: estfan, azla
99
ms.topic: how-to
10-
ms.date: 02/20/2025
10+
ms.date: 04/02/2025
1111
---
1212

1313
# Integrate IMS programs on IBM mainframes with Standard workflows in Azure Logic Apps
@@ -19,69 +19,63 @@ To access and run IBM mainframe apps on Information Management System (IMS) syst
1919
This how-to guide describes the following aspects about the IMS connector:
2020

2121
* Why use the IMS connector in Azure Logic Apps
22-
2322
* Prerequisites and setup for using the IMS connector
24-
2523
* Steps for adding IMS connector actions to your Standard logic app workflow
2624

27-
## Why use this connector?
25+
## Prerequisites
2826

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 on premises for many years. The **IMS Program Call** connector uses the IMS Connect model to interact with IMS transaction programs through TCP/IP.
27+
* 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).
3028

31-
The following diagram shows how the IMS connector interacts with an IBM mainframe system:
29+
* Access to the mainframe that hosts the IMS system.
3230

33-
:::image type="content" source="media/integrate-ims-apps-ibm-mainframe/ims-connector-overview.png" alt-text="Conceptual diagram shows how the IMS Program Call connector works with IBM mainframe system." lightbox="media/integrate-ims-apps-ibm-mainframe/ims-connector-overview.png":::
31+
* The Host Integration Designer XML (HIDX) file that provides the necessary metadata for the **IMS Program Call** connector to execute your mainframe program.
3432

35-
To extend these hybrid cloud scenarios, the IMS 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 mainframe transaction program. For this task, the HIS Designer converts that information into metadata that the IMS connector uses when running an action in your workflow.
33+
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).
3634

37-
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 IMS connector action. The connector reads the metadata file from your logic app resource, and dynamically presents the parameters to use with the IMS 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.
35+
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.
3836

39-
## Connector technical reference
37+
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.
4038

41-
The following section describes the operations for the IMS connector, which currently includes only the following action:
39+
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.
4240

43-
### Call an IMS program
41+
* The Standard logic app workflow to use for integrating with the IMS system.
4442

45-
| Parameter | Required | Type | Description |
46-
|-----------|----------|-------|-------------|
47-
| **HIDX Name** | Yes | String | Select the IMS HIDX file that you want to use. |
48-
| **Method Name** | Yes | String | Select the method in the HIDX file that you want to use. |
49-
| **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. |
43+
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.
5044

51-
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.
45+
### Limitations
5246

53-
## Limitations
47+
Currently, the IMS connector requires that you upload your HIDX file directly to your Standard logic app resource, not an integration account.
5448

55-
Currently, this connector requires that you upload your HIDX file directly to your Standard logic app resource, not an integration account.
49+
## Explore the IMS connector
5650

57-
## Prerequisites
51+
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 (TI) 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.
5852

59-
* 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-
61-
* Access to the mainframe that hosts the IMS system
53+
The following diagram shows how the IMS connector interacts with an IBM mainframe system:
6254

63-
* The Host Integration Designer XML (HIDX) file that provides the necessary metadata for the **IMS Program Call** connector to execute your mainframe program.
55+
:::image type="content" source="media/integrate-ims-apps-ibm-mainframe/ims-connector-overview.png" alt-text="Conceptual diagram shows how the IMS Program Call connector works with IBM mainframe system." lightbox="media/integrate-ims-apps-ibm-mainframe/ims-connector-overview.png":::
6456

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).
57+
To extend these hybrid cloud scenarios, the IMS 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 mainframe transaction program. For this task, the HIS Designer converts that information into metadata that the IMS connector uses when running an action in your workflow.
6658

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.
59+
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 IMS connector action. The connector reads the metadata file from your logic app resource, and dynamically presents the parameters to use with the IMS 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.
6860

69-
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.
61+
## Connector technical reference
7062

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.
63+
This section describes the available operations for the IMS connector. Currently, only one action is supported:
7264

73-
* The Standard logic app workflow to use for integrating with the IMS system
65+
### Call an IMS program
7466

75-
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.
67+
| Parameter | Required | Type | Description |
68+
|-----------|----------|-------|-------------|
69+
| **HIDX Name** | Yes | String | Select the IMS HIDX file that you want to use. |
70+
| **Method Name** | Yes | String | Select the method in the HIDX file that you want to use. |
71+
| **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. |
7672

77-
<a name="define-generate-app-metadata"></a>
73+
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.
7874

7975
## Define and generate metadata
8076

8177
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).
8278

83-
<a name="upload-hidx-file"></a>
84-
8579
## Upload the HIDX file
8680

8781
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:
9084

9185
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).
9286

93-
1. Now, [add an IMS action to your workflow](#add-ims-action).
94-
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.
87+
1. Continue to the next section to [add an IMS action to your workflow](#add-an-ims-action).
9688

97-
<a name="add-ims-action"></a>
89+
Later in this article, when you add a **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.
9890

9991
## Add an IMS action
10092

93+
Follow these steps to add an IMS action:
94+
10195
1. In the [Azure portal](https://portal.azure.com), open your Standard logic app resource and workflow in the designer.
10296

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 haven't already added 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).
10498

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**:
106100

107101
:::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.":::
108102

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).
110104

111105
1. After the connection details pane appears, provide the following information:
112106

113107
| Parameter | Required | Value | Description |
114108
|-----------|----------|-------|-------------|
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 timeout period in seconds while waiting for responses from the server. |
120+
| **User Name** | No | <*user-Name*> | The optional username for connection authentication. |
127121
| **Use TLS** | No | True or false | Secure the connection with Transport Security Layer (TLS). |
128122
| **Validate Server certificate** | No | True or false | Validate the server's certificate. |
129123

@@ -155,17 +149,19 @@ Later in this guide, when you add a **IMS Program Call** connector action to you
155149

156150
## Test your workflow
157151

158-
1. To run your workflow, on the workflow menu, select **Overview**. On the **Overview** toolbar, select **Run** > **Run**.
152+
Follow these steps to test your workflow:
153+
154+
1. To run your workflow, on the designer toolbar, select **Run** > **Run**.
159155

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 (**!**).
161157

162158
1. To review the inputs and outputs for each step, expand that step.
163159

164160
1. To review the outputs, select **See raw outputs**.
165161

166-
## Next steps
162+
## Related content
167163

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)
169165
* [View metrics for workflow health and performance in Azure Logic Apps](../logic-apps/view-workflow-metrics.md?tabs=standard)
170166
* [Monitor and collect diagnostic data for workflows in Azure Logic Apps](../logic-apps/monitor-workflows-collect-diagnostic-data.md?tabs=standard)
171167
* [Enable and view enhanced telemetry in Application Insights for Standard workflows in Azure Logic Apps](../logic-apps/enable-enhanced-telemetry-standard-workflows.md)
2.59 KB
Loading
-1.14 KB
Loading
128 KB
Loading
58.5 KB
Loading

0 commit comments

Comments
 (0)