IBM zOS Connect Policy

An IBM® zOS Connect policy contains the connection details that are used by an IBM zOS Connect Request node when you connect to an IBM zOS Connect application.

You can use an IBM zOS Connect Request node in a message flow to connect IBM App Connect Enterprise to IBM zOS Connect applications and issue requests to create, retrieve, delete or update objects such as indexes and vectors. The IBM zOS Connect policy controls, at run time, access to the IBM zOS Connect application.

The IBM zOS Connect policy is created when you configure a connection between an IBM zOS Connect Request node and IBM zOS Connect by using the Connector Discovery wizard. During the process of discovery, account credentials are stored in the vault and connection details are stored in an IBM zOS Connect policy. The policy is created with a type of IBM zOS Connect, and the name of the policy is returned to the IBM zOS Connect Request node and specified in the Connection tab of the node, in the format {policyProjectName}:policyName.

You can also create, update, or delete an IBM zOS Connect policy by using the Manage Discovery Connector Policies and Credentials wizard, which you can access by right-clicking the policy project in the IBM App Connect Enterprise Toolkit and then clicking New > Discovery Connector policies and credentials.

You must deploy this policy before message flows that use the policy are started. If you redeploy an IBM zOS Connect policy, all message flows that are using the policy will be stopped and restarted.

For more information about using IBM zOS Connect, see Using IBM zOS Connect with IBM App Connect Enterprise.

Table 1. Properties of the IBM zOS Connect policy
Property Property name in .policyxml file Description of properties
IBM zOS Connect Application Type applicationType This property is reserved for future use and must be set to the value online.
IBM zOS Connect Application Version applicationVersion This property is reserved for future use and must be set to the value v1.
IBM zOS Connect Authentication method authenticationMethod This property specifies the type of authentication that is used for the connection between IBM App Connect Enterprise and IBM zOS Connect. This value is reserved for future use and must be set to BASIC.
Server URL apiUrl Specify the URL for the API server that makes runtime calls.
Override server URL endpointUrl Required if you want to connect to an endpoint in a private network by using the private network client, or if you want to override the server URL. Specify an override value for the host and port for the connector in the format <http or https>://<host_name>:<port>. If you are not using the private network client or do not require an override, leave this field blank.
Credential Name credentialName The name of your IBM zOS Connect account. For example, ibmzosconnectpolicy_IBMzOSConnect1