Microsoft Viva Engage policy

A Microsoft Viva Engage policy contains the connection details that are used by a Microsoft Viva Engage Input or Microsoft Viva Engage Request node when you connect it to Microsoft Viva Engage.

You can use a Microsoft Viva Engage Request node in a message flow to connect IBM® App Connect Enterprise to Microsoft Viva Engage and issue requests to perform actions on objects such as files, groups, messages, topics, and users. You can use a Microsoft Viva Engage Input node to monitor and accept input from Microsoft Viva Engage. The Microsoft Viva Engage policy controls, at run time, access to the Microsoft Viva Engage application.

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

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

For more information about using Microsoft Viva Engage policies, see Using Microsoft Viva Engage with IBM App Connect Enterprise.

Table 1. Properties of the Microsoft Viva Engage policy
Property	Property name in .policyxml file	Description of properties
Microsoft Viva Engage Application Type	applicationType	This property is reserved for future use and must be set to the value `online`.
Microsoft Viva Engage Application Version	applicationVersion	This property is reserved for future use and must be set to the value `v1`.
Microsoft Viva Engage Authentication method	authenticationMethod	This property specifies the type of authentication that is used for the connection between IBM App Connect Enterprise and Microsoft Viva Engage. This property is reserved for future use and must be set to `BASIC_OAUTH`.
Base URI	endpointUrl	The URI for the Microsoft Viva Engage REST APIs. For example, https://www.yammer.com/api.
Credential Name	credentialName	This property specifies the name of the credential that is used for the connection to Microsoft Viva Engage. 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.