Microsoft Dynamics 365 for Finance and Operations
is an enterprise resource planning system. It is aimed at medium to large organizations, who can use
it to monitor business performance, predict outcomes and make data-driven decisions to drive
business growth. IBM® App Connect Enterprise provides a Microsoft Dynamics 365 for
Finance and Operations Request node, which
you can use to interact with Microsoft Dynamics 365 for Finance and Operations. You can issue requests to create,
retrieve, update, or delete objects such as applicants, customers, employees, operations, projects,
prospects, sales agreements, user groups, and vendors.
About this task
IBM App Connect Enterprise communicates synchronously with Microsoft Dynamics 365 for Finance and Operations through the Microsoft Dynamics 365 for
Finance and Operations Request node, which is
available on Windows, AIX, and Linux® systems.
You can use the
Microsoft Dynamics 365 for
Finance and Operations Request node to
connect to
Microsoft Dynamics 365 for Finance and Operations
and perform actions on objects, including the following examples:
- Applicants
- Create, retrieve, update, or delete applicants
- Customers
- Create, retrieve, update, or delete customers
- Employees
- Create, retrieve, update, or delete employees
- Operations
- Create, retrieve, update, or delete operations
- Projects
- Create, retrieve, update, or delete projects
- Prospects
- Create, retrieve, update, or delete prospects
- Sales agreements
- Create, retrieve, or delete sales agreements
- User groups
- Create, retrieve, update, or delete user groups
- Vendors
- Create, retrieve, update, or delete vendors
For more information about using the Microsoft Dynamics 365 for
Finance and Operations Request node, see
Microsoft Dynamics 365 for Finance and Operations Request node.
Procedure
- In the IBM App Connect
Enterprise Toolkit, create a flow that contains a Microsoft Dynamics 365 for
Finance and Operations Request
node.
- Select the Microsoft Dynamics 365 for
Finance and Operations Request node in the
flow to show the node properties in the editor.
- On the Basic tab, click Launch Connector
Discovery.
A panel is displayed in which you specify the name of the
policy project and vault details to be used during connector discovery.
- Specify the details of the policy project and vault to be
used during connector discovery:
- In the Policy Project field, specify the policy project that is
used to store the policies that are created during connector discovery.
Alternatively,
you can create a new policy project by clicking New and then specifying the
name of the new policy project. Then click Finish.
- Specify the vault to be used during connector discovery. By default, credentials that
are used during connector discovery are stored in an external directory vault, which is
an App Connect Enterprise vault that can be used by any integration server.
Alternatively, you can store the credentials in an integration server vault, which is created in the
integration server's work directory and can be used only by that specific integration server.
To specify the vault to be used for storing the credentials, complete the steps in the
Using
the Connector Discovery wizard section of one of the following topics:
- In the Vault key field, enter the vault key that is used to
access the credentials stored in the vault. The vault key must be at least 8 characters in
length.
- Optional: By default, the specified vault location and vault key are saved
as preferences in the Toolkit so that the values are preset when you launch Connector Discovery. If
you do not want the preferences to be saved, deselect Save in vault
preferences.
- Click Launch Discovery to start the Connector
Discovery wizard for the Microsoft Dynamics 365 for Finance and Operations
connector.
The Connector Discovery window is
displayed. If existing Microsoft Dynamics 365 for Finance and Operations connections
(accounts) are available, a list of those connections is displayed. If there are no existing
connections, the status of the Microsoft Dynamics 365 for Finance and Operations connector is
shown as Not connected
.
- If one or more Microsoft Dynamics 365 for Finance and Operations connections
(accounts) are available, complete the following steps:
- Select the connection (account) that you want to use by clicking it.
- Click the required object type and then select the action that you want to perform on the
object. For example, to retrieve applicants from Microsoft Dynamics 365 for Finance and Operations, click
Applicants and then Retrieve applicants.
- If there are no existing connections (accounts), complete the following steps:
- Click the required object type and then select the action that you want to perform on that
object. For example, to retrieve applicants from Microsoft Dynamics 365 for Finance and Operations, click
Applicants and then Retrieve applicants.
- Click Connect to display a menu from which you must select one of the
following authorization methods:
- Provide client credentials (OAUTH 2.0 CREDENTIALS)
- Provide a username, password, and client credentials (OAUTH 2.0 PASSWORD)
- If you selected Provide client credentials (OAUTH 2.0 CREDENTIALS) as the
authorization method, enter the following details:
- Endpoint URL: The Microsoft Dynamics 365 for Finance and Operations URL in the
format
https://<Dynamics 365 Finance and Operations base URL>
.
- Tenant ID: The ID of your Microsoft Azure Active Directory (Azure AD)
tenant.
- Client ID: The Application ID assigned to Microsoft Dynamics 365 for Finance and Operations when you
registered it with Azure AD.
- Client secret: The application secret that is created in the Azure Portal
for Microsoft Dynamics 365 for Finance and Operations.
- If you selected Provide a username,password, and client credentials ( OAUTH 2.0
PASSWORD) as the authorization method, enter the following details:
- Endpoint URL: The Microsoft Dynamics 365 for Finance and Operations URL in the
format
https://<Dynamics 365 Finance and Operations base URL>
.
- User name: The username for your Microsoft Dynamics 365 for Finance and Operations account.
- Password: The password for your Microsoft Dynamics 365 for Finance and Operations account.
- Tenant ID: The ID of your Microsoft Azure Active Directory (Azure AD)
tenant.
- Client ID: The Application ID assigned to Microsoft Dynamics 365 for Finance and Operations when you
registered it with Azure AD.
- Client secret: The application secret that is created in the Azure Portal
for Microsoft Dynamics 365 for Finance and Operations.
For more information about identifying these connection details, see How to use IBM® App Connect with Microsoft Dynamics 365 for Finance
and Operations in the IBM App Connect Enterprise as a Service documentation.
Click
Connect.
- Set any required connector properties in the wizard.
You can add conditions for the retrieval of the data, by clicking Add
condition and then selecting the property that you want to filter on. For example, you
can retrieve applicants from a specified city. You can also set properties that specify the maximum
number of records to retrieve and the action to be taken if that limit is exceeded.
- When you have finished specifying the properties in the Connector Discovery wizard, click
Save.
The credentials that are used for connecting to
Microsoft Dynamics 365 for Finance and Operations are stored in
the vault, and the other connection details are saved in the
Microsoft Dynamics 365 for Finance and Operations policy. The values of the properties that
you set in the wizard are returned to the
Microsoft Dynamics 365 for
Finance and Operations Request node in the
IBM App Connect
Enterprise Toolkit.
- After you finish discovery and save the property values, exit the Connector Discovery
wizard by clicking the X in the upper-right corner of the window or by pressing Alt+F4.
- Return to editing the Microsoft Dynamics 365 for
Finance and Operations Request node in the
IBM App Connect
Enterprise Toolkit.
The connector properties that were set in the Connector Discovery wizard (in step
6) are now visible on the
Microsoft Dynamics 365 for
Finance and Operations Request node in the
property editor. The
Basic tab shows the values of the
Action and
Object properties that you set in the
wizard. For example, if you selected
in the wizard, the following properties are visible on the
Basic tab of the node:
- Action -
RETRIEVEALL
- Object -
Applicant
The values of the Action and Object properties
are displayed in read-only format. If you want to change these values, you can do so by clicking
Launch Connector Discovery again and setting new values in the Connector
Discovery wizard.
The Schema base name property specifies the base name
of the schema files that describe the format of the request and response messages that are sent and
received from the Microsoft Dynamics 365 for Finance and Operations connector. The
schema base name is set automatically the first time that you run discovery for the node, and it is
based on the current flow name and node name. If you set this property manually before you run
discovery for the first time, the value that you set is used. If you rename the schemas after
discovery, you must edit this property so that it matches the schema base name that is used by the
renamed schemas in the project. If you change this property after discovery, you must either rename
the schema names to match or run discovery again.
Depending on the action that was selected
during discovery, the Connector Discovery wizard generates either a request schema and a response
schema, or a response schema only. A request schema is generated only if the selected action and
object require a request message. The generated request schema is used for validation of the request
message. If the action was RETRIEVE
or DELETE
, only the response
schema is returned by the connector.
The generated schema files are added to the project and
can be used by a Mapping node for transforming input or
output data. The full file name of the schema is derived from the schema base name (such as
gen/MyMessageFlow.Microsoft_Dynamics_365_for_Finance_and_Operations_Request
),
suffixed with either response.schema.json or
request.schema.json. You can open the schema by clicking Open
request schema or Open response schema.
- Check that the property settings on the Microsoft Dynamics 365 for
Finance and Operations Request node are
correct and then save the message flow.
- On the Connection tab of the Microsoft Dynamics 365 for
Finance and Operations Request node, the
Policy property shows the name of the policy that contains the details of the
security identity to be used for the connection. The policy has a type of
Microsoft Dynamics
365 for Finance and Operations
.
- Optional: Set the Timeout property
on the Connection tab to specify the time (in seconds) that the node waits
for Microsoft Dynamics 365 for Finance and Operations to
process the operation.
- The Filter tab of the Microsoft Dynamics 365 for
Finance and Operations Request node contains
properties that control the way the message flow selects data. The initial values of these
properties are taken from the property values that were set for the Microsoft Dynamics 365 for Finance and Operations connector in the
Connector Discovery wizard, including the filter options properties and any conditions that were
specified (as described in step 6). If you later return to the Connector Discovery wizard and change the values of any properties
(by adding new conditions, for example) those updates are reflected in the properties set on the
node.
The Filter Options properties control which objects are to be operated
upon when the Microsoft Dynamics 365 for
Finance and Operations Request node executes.
The Filter Limit properties control the maximum number of items to be
retrieved and the action to be taken if the limit is exceeded.
You can modify the values by clicking Edit next to the value that you want
to modify in the Filter Options section, and by changing the property values
that have been set in the Filter Limit section.
The property values can be either text values or ESQL or XPATH expressions that are resolved from
the contents of the message that is passed to the Microsoft Dynamics 365 for
Finance and Operations Request node as it
executes.
- On the Request tab, set the Data
location property to specify the location in the incoming message tree that contains the
object data to be created in Microsoft Dynamics 365 for Finance and Operations. This data forms
the request that is sent from the Microsoft Dynamics 365 for
Finance and Operations Request node to Microsoft Dynamics 365 for Finance and Operations.
- On the Result tab, set the Output
data location property to specify the location in the output message tree that contains the
data of the record that is created in Microsoft Dynamics 365 for Finance and Operations.
- By default, request messages are validated against the request schema that was generated
during connector discovery. You can turn off request validation or change the validation settings by
using the Validation properties of the Microsoft Dynamics 365 for
Finance and Operations Request node.
- Save the message flow.