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
Copy file name to clipboardExpand all lines: articles/connectors/integrate-host-files-ibm-mainframe.md
+38-38Lines changed: 38 additions & 38 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
---
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.
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.
20
20
21
21
This how-to guide describes the following aspects about the **IBM Host File** connector:
22
22
23
23
* Scenarios for using the **IBM Host File** connector in Azure Logic Apps
24
24
* Prerequisites and setup for using the **IBM Host File** connector
25
25
* Steps for adding the **IBM Host File** connector actions to your Standard logic app workflow
26
26
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
-
47
27
## Explore the IBM Host File connector and usage scenarios
48
28
49
29
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
64
44
65
45
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.
66
46
67
-
## Review the technical reference
47
+
## Connector technical reference
68
48
69
49
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**.
70
50
71
51
### Parse Host File Contents action
72
52
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:
74
54
75
55
| Parameter | Required | Type | Description |
76
56
|-----------|----------|-------|-------------|
@@ -80,14 +60,34 @@ The following table summarizes the usage for the **Parse Host File Contents** ac
80
60
81
61
### Generate Host File Contents action
82
62
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:
84
64
85
65
| Parameter | Required | Type | Description |
86
66
|-----------|----------|-------|-------------|
87
67
|**HIDX Name**| Yes | String | Select the mainframe host file HIDX file that you want to use. |
88
68
|**Schema Name**| Yes | String | Select the host file schema in the HIDX file that you want to use. |
89
69
|**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. |
90
70
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
+
91
91
## Define and generate metadata
92
92
93
93
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
96
96
97
97
For your workflow to use the HIDX file, follow these steps:
98
98
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.
100
100
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).
102
102
103
103
1. Continue to the next section to [add an **IBM Host File** action to your workflow](#add-a-parse-host-file-contents-action).
104
104
@@ -154,11 +154,11 @@ Follow these steps to add a Parse Host File Contents action:
154
154
155
155
:::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":::
156
156
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):
160
160
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":::
162
162
163
163
After your configuration, the **Parse Host File Contents** action looks like the following example:
164
164
@@ -168,7 +168,7 @@ Follow these steps to add a Parse Host File Contents action:
168
168
169
169
### Test your workflow
170
170
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:
172
172
173
173
1. To run your workflow, on the designer toolbar, select **Run** > **Run**.
174
174
@@ -228,11 +228,11 @@ Follow these steps to add a Generate Host File Contents action:
228
228
229
229
:::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.":::
230
230
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):
234
234
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":::
236
236
237
237
After your configuration, the **Generate Host File Contents** action looks like the following example:
238
238
@@ -242,7 +242,7 @@ Follow these steps to add a Generate Host File Contents action:
242
242
243
243
### Test your workflow
244
244
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:
246
246
247
247
1. To run your workflow, on the designer toolbar, select **Run** > **Run**.
0 commit comments