Skip to content

Commit 776c016

Browse files
committed
edits per review feedback
1 parent 127554e commit 776c016

7 files changed

+38
-38
lines changed

articles/connectors/integrate-host-files-ibm-mainframe.md

Lines changed: 38 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: Parse and Generate IBM Host Files
3-
description: Learn how to parse and generate offline IBM host files from IBM mainframes for Standard workflows in Azure Logic Apps with the IBM Host File connector.
2+
title: Process IBM Host Files in Standard Workflows
3+
description: Parse and generate offline IBM host files from IBM mainframes through Standard workflows in Azure Logic Apps by using the IBM Host File connector.
44
services: logic-apps
55
ms.suite: integration
66
author: haroldcampos
@@ -16,34 +16,14 @@ ms.date: 04/08/2025
1616

1717
[!INCLUDE [logic-apps-sku-standard](../../includes/logic-apps-sku-standard.md)]
1818

19-
To parse and generate new IBM host files and i Series physical files from Standard workflows in Azure Logic Apps, you can use the **IBM Host File** built-in, service provider-based connector. Since the introduction of mainframe systems, ubiquitous host files have been used to store abundant data for mission critical systems. Although this connector doesn't require access to an IBM mainframe or midrange system, you must make the host file available to a Standard workflow. You can make the file available via FTP, blob storage, Host Integration Server, or a partner software appliance. The **IBM Host File** connector is available in all Azure Logic Apps regions except for Azure Government and Microsoft Azure operated by 21Vianet.
19+
To parse and generate new IBM host files and i Series physical files from Standard workflows in Azure Logic Apps, you can use the **IBM Host File** built-in, service provider-based connector. Since the introduction of mainframe systems, developers used ubiquitous host files to store abundant data for mission critical systems. Although this connector doesn't require access to an IBM mainframe or midrange system, you must make the host file available to a Standard workflow. You can make the file available through FTP, Azure Blob storage, Host Integration Server, or a partner software appliance. The **IBM Host File** connector is available in all Azure Logic Apps regions except for Azure Government and Microsoft Azure operated by 21Vianet.
2020

2121
This how-to guide describes the following aspects about the **IBM Host File** connector:
2222

2323
* Scenarios for using the **IBM Host File** connector in Azure Logic Apps
2424
* Prerequisites and setup for using the **IBM Host File** connector
2525
* Steps for adding the **IBM Host File** connector actions to your Standard logic app workflow
2626

27-
## Prerequisites
28-
29-
* 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).
30-
31-
* The Host Integration Designer XML (HIDX) file that provides the necessary metadata for the **IBM Host File** connector to recognize the host file data structure.
32-
33-
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).
34-
35-
To effectively parse and generate host files, your workflow needs to understand the host file metadata. However, as a key difference between a host file and a database table, the host file doesn't have the metadata that describes the data structure. 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 host file structure that your workflow uses. You can also import COBOL definitions (copybooks) that provide these data structures.
36-
37-
The tool generates a Host Integration Designer XML (HIDX) file that provides the necessary metadata for the connector to recognize the host file data structure. If you use the HIS, you can use the HIS Transaction Integrator (TI) Designer to create the HIDX file.
38-
39-
* The Standard logic app workflow where you want to parse or generate the host file.
40-
41-
The **IBM Host File** connector doesn't have triggers, so use any trigger to start your workflow, such as the **Recurrence** trigger or **Azure Blob Storage** trigger. You can then add the **IBM Host File** connector actions. To get started, create a blank workflow in your Standard logic app resource.
42-
43-
### Limitations
44-
45-
Currently, this connector requires that you upload your HIDX file directly to your Standard logic app resource, not an integration account.
46-
4727
## Explore the IBM Host File connector and usage scenarios
4828

4929
On IBM mainframes, *access methods*, which are special components in the operating system, handle file processing. In the 1970s, Virtual Storage Access Method (VSAM) was built and became the most widely used access method on IBM mainframes. VSAM provides specific types of files, including entry-sequenced datasets, key-sequenced datasets, and relative record datasets.
@@ -64,13 +44,13 @@ To extend hybrid cloud scenarios, the **IBM Host File** connector works with the
6444

6545
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. With this approach, your workflow can access your app's metadata when you add an **IBM Host File** connector action. The connector reads the metadata file from your logic app resource, and dynamically presents the binary file's structure to use with the **IBM Host File** connector actions in your workflow.
6646

67-
## Review the technical reference
47+
## Connector technical reference
6848

6949
This section describes the available operations for the **IBM Host File** connector. Currently, two actions are supported: **Parse Host File Contents** and **Generate Host File Contents**.
7050

7151
### Parse Host File Contents action
7252

73-
The following table summarizes the usage for the **Parse Host File Contents** action:
53+
The following table summarizes the parameters for the **Parse Host File Contents** action:
7454

7555
| Parameter | Required | Type | Description |
7656
|-----------|----------|-------|-------------|
@@ -80,14 +60,34 @@ The following table summarizes the usage for the **Parse Host File Contents** ac
8060

8161
### Generate Host File Contents action
8262

83-
The following table summarizes the usage for the **Generate Host File Contents** action:
63+
The following table summarizes the parameters for the **Generate Host File Contents** action:
8464

8565
| Parameter | Required | Type | Description |
8666
|-----------|----------|-------|-------------|
8767
| **HIDX Name** | Yes | String | Select the mainframe host file HIDX file that you want to use. |
8868
| **Schema Name** | Yes | String | Select the host file schema in the HIDX file that you want to use. |
8969
| **Rows** | Yes | JSON | Select the Array or individual rows. To enter an entire data object in JSON format, you can select the **Switch to input entire array** option. |
9070

71+
## Prerequisites
72+
73+
* 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).
74+
75+
* The Host Integration Designer XML (HIDX) file that provides the necessary metadata for the **IBM Host File** connector to recognize the host file data structure.
76+
77+
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).
78+
79+
To effectively parse and generate host files, your workflow needs to understand the host file metadata. However, as a key difference between a host file and a database table, the host file doesn't have the metadata that describes the data structure. 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 host file structure that your workflow uses. You can also import COBOL definitions (copybooks) that provide these data structures.
80+
81+
The tool generates a Host Integration Designer XML (HIDX) file that provides the necessary metadata for the connector to recognize the host file data structure. If you use the HIS, you can use the HIS Transaction Integrator (TI) Designer to create the HIDX file.
82+
83+
* The Standard logic app workflow where you want to parse or generate the host file.
84+
85+
The **IBM Host File** connector doesn't have triggers, so use any trigger to start your workflow, such as the **Recurrence** trigger or **Azure Blob Storage** trigger. You can then add the **IBM Host File** connector actions. To get started, create a blank workflow in your Standard logic app resource.
86+
87+
## Limitations
88+
89+
Currently, this connector requires that you upload your HIDX file directly to your Standard logic app resource, not an integration account.
90+
9191
## Define and generate metadata
9292

9393
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-lahostfiles).
@@ -96,9 +96,9 @@ After you download and install the HIS Designer for Azure Logic Apps, follow [th
9696

9797
For your workflow to use the HIDX file, follow these steps:
9898

99-
1. Browse to the folder where you saved your HIDX file, and copy the file.
99+
1. Go to the folder where you saved your HIDX file, and copy the file.
100100

101-
1. Go to the [Azure portal](https://portal.azure.com) and [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).
101+
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).
102102

103103
1. Continue to the next section to [add an **IBM Host File** action to your workflow](#add-a-parse-host-file-contents-action).
104104

@@ -154,11 +154,11 @@ Follow these steps to add a Parse Host File Contents action:
154154

155155
:::image type="content" source="./media/integrate-host-files-ibm-mainframe/parse-host-file-contents-binary.png" alt-text="Screenshot shows the Parse Host File Contents action, dynamic content list, and selecting binary data to read from JSON file in Blob Storage account." lightbox="./media/integrate-host-files-ibm-mainframe/parse-host-file-contents-binary.png":::
156156

157-
1. Add a final action to create a file on a Secure File Transfer Protocol (SFTP) server by following [these general steps](../logic-apps/create-workflow-with-trigger-or-action.md?tabs=standard#add-action):
158-
159-
<!-- Reviewer: Current article doesn't indicate how to add the "Create file" step. The text indicates that the action creates a file on an "SFTP" server, but it looks like an FTP server in the image. I chose the "SFTP server (NOT In-app)" option for this refresh. Let me know if an alternate action is required. -->
157+
1. Now, add another action to handle the result.
158+
159+
This example adds an action to create a file on a File Transfer Protocol (FTP) server by following [these general steps](../logic-apps/create-workflow-with-trigger-or-action.md?tabs=standard#add-action):
160160

161-
:::image type="content" source="./media/integrate-host-files-ibm-mainframe/parse-create-file-on-sftp-server.png" alt-text="Screenshot shows the Parse Host File Contents action, dynamic content list, and selecting to create a file on an SFTP server." lightbox="./media/integrate-host-files-ibm-mainframe/parse-create-file-on-sftp-server.png":::
161+
:::image type="content" source="./media/integrate-host-files-ibm-mainframe/parse-create-file-on-ftp-server.png" alt-text="Screenshot shows the Parse Host File Contents action, dynamic content list, and selecting to create a file on an FTP server." lightbox="./media/integrate-host-files-ibm-mainframe/parse-create-file-on-ftp-server.png":::
162162

163163
After your configuration, the **Parse Host File Contents** action looks like the following example:
164164

@@ -168,7 +168,7 @@ Follow these steps to add a Parse Host File Contents action:
168168

169169
### Test your workflow
170170

171-
Follow these steps and confirm the **Parse Host File Contents** workflow runs as expected:
171+
Follow these steps to confirm that the workflow runs as expected:
172172

173173
1. To run your workflow, on the designer toolbar, select **Run** > **Run**.
174174

@@ -228,11 +228,11 @@ Follow these steps to add a Generate Host File Contents action:
228228

229229
:::image type="content" source="./media/integrate-host-files-ibm-mainframe/generate-host-file-contents-rows.png" alt-text="Screenshot shows the Generate Host File Contents action, dynamic content list, and selecting rows to read and convert from JSON file in Blob Storage account.":::
230230

231-
1. Add a final action to create a file on a Secure File Transfer Protocol (SFTP) server by following [these general steps](../logic-apps/create-workflow-with-trigger-or-action.md?tabs=standard#add-action):
232-
233-
<!-- Reviewer: Current article doesn't indicate how to add the "Create file" step. The text indicates that the action creates a file on an "SFTP" server, but it looks like an FTP server in the image. I chose the "SFTP server (NOT In-app)" option for this refresh. Let me know if an alternate action is required. -->
231+
1. Now, add another action to handle the result.
232+
233+
This example adds an action to create a file on a File Transfer Protocol (FTP) server by following [these general steps](../logic-apps/create-workflow-with-trigger-or-action.md?tabs=standard#add-action):
234234

235-
:::image type="content" source="./media/integrate-host-files-ibm-mainframe/generate-create-file-on-sftp-server.png" alt-text="Screenshot shows the Generate Host File Contents action, dynamic content list, and selecting to create a file on an SFTP server." lightbox="./media/integrate-host-files-ibm-mainframe/generate-create-file-on-sftp-server.png":::
235+
:::image type="content" source="./media/integrate-host-files-ibm-mainframe/generate-create-file-on-ftp-server.png" alt-text="Screenshot shows the Generate Host File Contents action, dynamic content list, and selecting to create a file on an FTP server." lightbox="./media/integrate-host-files-ibm-mainframe/generate-create-file-on-ftp-server.png":::
236236

237237
After your configuration, the **Generate Host File Contents** action looks like the following example:
238238

@@ -242,7 +242,7 @@ Follow these steps to add a Generate Host File Contents action:
242242

243243
### Test your workflow
244244

245-
Follow these steps and confirm the **Generate Host File Contents** workflow runs as expected:
245+
Follow these steps to confirm that the workflow runs as expected:
246246

247247
1. To run your workflow, on the designer toolbar, select **Run** > **Run**.
248248

120 KB
Loading
422 Bytes
Loading
121 KB
Loading
403 Bytes
Loading

0 commit comments

Comments
 (0)