Box policy

A Box policy contains the connection details that are used by a Box Request node when you connect it to a Box application.

You can use a Box Request node in a message flow to connect IBM® App Connect Enterprise to Box applications and issue requests to create, retrieve, update, and delete objects such as files, folders, bookmarks, and comments. The Box policy controls, at run time, access to the Box application.

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

You can also create, update, or delete a Box 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 a Box policy, all message flows that are using the policy are stopped and restarted.

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

Table 1. Properties of the Box policy
Property Property name in .policyxml file Description of properties
Box Application Type applicationType This property is reserved for future use and must be set to the value online.
Box Application Version applicationVersion This property is reserved for future use and must be set to the value v1.
Box Authentication method authenticationMethod This property specifies the type of authentication that is used for the connection between IBM App Connect Enterprise and Box. This value is reserved for future use and must be set to Standard OAuth 2.0.
Credential Name credentialName This property specifies the name of the credential that is used for the connection to Box.

The specified credential can be defined during connector discovery and stored in the vault. Alternatively, you can specify an existing credential that was configured by using the mqsicredentials command or the server.conf.yaml file, or loaded through an external credential provider.