Configure an endpoint

When you configure an endpoint, you enter information in the Endpoints form about the following:

  • Identifying information for the endpoint, including a unique identifier, a friendly name, the active status, error handling information, the intercompany status, local endpoint, Microsoft Dynamics AX company identification for an intercompany exchange, outbound channel information, and encoding format for the transfer.

  • Constraints on the endpoint that restrict document exchange by defining valid Microsoft Dynamics AX customers, vendors, or warehouses.

  • Microsoft Dynamics AX users and trusted intermediaries that are allowed to submit documents for the exchange.

  • Endpoint action policies that relate actions to the endpoint.

  • Pipeline components for an action related to the endpoint.

  • Endpoint action data policies that define which fields in a document are allowed or required for the exchange.

Available tabs

In the Endpoints form, user interface tabs are available depending on what type of endpoint you select in the Overview tab.

Endpoint type

Tabs enabled

Default endpoint

  • Overview

  • General

Specific endpoint

  • Overview

  • General

  • Constraints

  • Users

Specific intercompany endpoint

  • Overview

  • General

  • Constraints

Default endpoint

Microsoft Dynamics AX ships with a default endpoint that can be used to enable data exchanges as soon as services are generated. The default endpoint has minimal configuration options, and you cannot add any constraints or users to the default endpoint. By default, all actions are enabled for the default endpoint but you must still enable the service actions on the AIF Services form.

You can change the following options on the default endpoint:

  • In the Endpoints form, you can update the Active field and the Propagate errors field. For more information about these fields, see Create an endpoint.

  • In the Endpoint Action Policies form, you can enable and configure actions.

  • In the Endpoint action data policies form, you can define which fields are allowed or required in the data exchange.

  • In the Pipeline components form, you can define data transformations for inbound or outbound exchanges.

  • In the Parameter Schemas form, you can view the schema of the action parameters and the return value and optionally save them to an .xsd file.

  • In the Value Mapping form, you can configure value mapping.

Configure endpoint identification

  1. Click Basic > Setup > Application Integration Framework.> Endpoints.

  2. Press CTRL+N to create a new endpoint, or select an existing endpoint from the list to be modified.

  3. Enter the information for the endpoint on the General tab, including the unique endpoint identification information, the friendly name for the endpoint, the local endpoint ID, and the default encoding format.

  4. Select Propagate errors to return detailed error messages to the endpoint.

    Note

    By default, Microsoft Dynamics AX logs detailed errors and sends a generic error back to the endpoint. Enabling this field will send the detailed error to the endpoint. Only select this field if it is acceptable to send detailed error information to an endpoint.


  5. For intercompany transfers, select Intercompany organization if the endpoint is a company within your Microsoft Dynamics AX installation, and select a company in the Company field.

  6. Do not select Intercompany organization unless the endpoint is to be used in an intercompany transfer. For more information about these transfers, see "Manage intercompany sales orders" or "Manage intercompany purchase orders" in the Application and Business Processes Help.

  7. Selecting an outbound channel is not required for all exchanges. However, if your Microsoft Dynamics AX installation is sending messages to this endpoint (for example, if you are configuring an outbound-only exchange), you must select a channel in the Outbound channel ID field.

  8. In the Local endpoint ID field, select the local endpoint that participates in exchanges with this endpoint.

    Note

    There may be more than one local endpoint configured for your Microsoft Dynamics AX installation. If that is the case, then make sure to select the correct local endpoint to participate in the exchange with the endpoint that you are configuring.


  9. View the pre-populated setting for encoding format in the Default encoding format field. This setting defaults to the value set on the Integration Framework global settings form.

Configure constraints on an endpoint and activate the endpoint

  1. Click Basic > Setup > Application Integration Framework > Endpoints.

  2. Press CTRL+N to create a new endpoint, or select an existing endpoint from the list to be modified.

    Note

    You cannot add constraints to the default endpoint so the Constraints tab will not be enabled if the default endpoint is selected.


  3. On the Constraints tab, select No constraints to clear the form and allow data to be exchanged regardless of any association. The No constraints check box becomes unavailable. However, if you add constraints later, the check box clears itself.

  4. Press CTRL+N to create a new constraint.

  5. Choose the Constraint type (Vendor, Customer, or Warehouse).

  6. Select a Constraint ID from the list. The Name field is completed when you select the Constraint ID.

  7. On the Overview tab, select Active to activate the endpoint.

    Messages flow through the framework from the local endpoint to and from any active endpoints.

Configure users and trusted intermediaries for an endpoint

You must enter information for at least one endpoint user or trusted intermediary who is authorized to initiate transactions for the endpoint on the Users tab.

Note

When configuring users on an endpoint, remember that these Microsoft Dynamics AX users may represent outside interests and must have permissions set appropriately. For more information about configuring Microsoft Dynamics AX users, see "Setting up and maintaining security" in the Microsoft Dynamics AX Installation Guide and the following topics in the System and Application Setup Help: "Manage security permissions for user groups and domain combinations," "Manage user groups," and "Manage users."

You must also set the appropriate security keys and record-level security for any users that are granted access to Microsoft Dynamics AX through Application Integration Framework (AIF), to help prevent unauthorized data access. For more information, see "Manage record level security" in the Application and Business Processes Help.

Certain actions cause data to be written directly to the Microsoft Dynamics AX database without manual end-user verification (for example, creating exchange rates). When configuring endpoints and creating new actions, be especially careful to restrict access to trusted and reliable partners or applications.


Configure an endpoint user

  1. Click Basic > Setup > Application Integration Framework > Endpoints.

  2. Press CTRL+N to create a new endpoint, or select an existing endpoint from the list to be modified.

    Note

    You cannot add users or user groups to the default endpoint so the Users tab will not be enabled if the default endpoint is selected.


  3. Click the Users tab.

  4. Under Endpoint users, in the User type field, select either User or User group.

  5. In the Application user or group field, select a valid Microsoft Dynamics AX user or user group name. The Name field is filled in automatically.

    For more information about Microsoft Dynamics AX users and user groups, see "Setting up and maintaining security" in the System and Application Setup Help.

Configure a trusted intermediary

Trusted intermediaries are middleware applications that reside between external endpoints and AIF. That is, they are Microsoft Dynamics AX users (or user groups) that are authorized to submit inbound requests on behalf of the endpoint. A trusted intermediary prevents an unauthorized user from accessing AIF and is typically used in a business-to-business data exchange scenario. For more information about trusted intermediaries, see Security considerations for AIF.

For more information about Microsoft Dynamics AX users and user groups, see "Setting up and maintaining security" in the System and Application Setup Help.

  1. Under Trusted intermediaries, select Use trusted intermediary to enable a trusted intermediary for exchanges with this endpoint.

    Note

    If the Use trusted intermediary box is checked, there must be at least one entry in the Trusted intermediaries grid.


  2. Under Trusted intermediaries, in the User type field, also select either User or User group.

  3. In the Application user or group field, select a valid Microsoft Dynamics AX user or user group name. The Name field is filled in automatically.

Configure action policies, data policies, and pipeline components for an endpoint

  1. After you have completed the preceding steps, click Action policies to configure actions on the endpoint.

    For more information about action policies, see Configure endpoint action policies.

  2. Press CTRL+S to save the action policy.

  3. From the Endpoint Action Policies form, select an action, press CTRL+S, and click Data Policies to enter information about which fields are required and which are optional in the document to be exchanged.

  4. Click Configure to perform document-specific configuration, including value mapping, for the document exchange.

    Value mapping is translation of field data values based on business rules, for example, translating internal item numbers to vendor-specific item numbers or industry standard numbers depending on the trading partner. For more information, see Configure endpoint action data policies.

  5. Click Inbound Pipeline or Outbound Pipeline to configure the pipeline components for any custom transformations performed on the document. For more information, see Creating and configuring a pipeline.

  6. Click Parameter schema to see a list of parameters and the return value for the selected action. On the Parameter Schemas form, click View schema to view the XML schema for the selected parameter or return value. On the Schema form, you can click Save as to save the schema as an .xsd file.

Give the endpoint user access to Business Connector when using Web services

When you configure an endpoint for Web services, you must configure an endpoint user and/or trusted intermediary, as outlined above. Next, you must give that Microsoft Dynamics AX user or user group access to the Business Connector.

  1. Click Administration > Setup > User groups and select the user group for the endpoint, or the user group that contains the user for the endpoint.

  2. Click Permissions.

  3. On the Permissions tab, select Business Connector and then select Full control.

  4. Click Cascade.

Disable an endpoint

To disable an endpoint, follow these steps.

  1. Click Basic > Setup > Application Integration Framework > Endpoints.

  2. Select an endpoint in the grid and clear the Active field.

    Important

    For adapter-based exchanges, outbound messages are processed completely even when the endpoint is disabled during processing and a response may still be sent. To ensure that no data is sent from AIF when disabling an endpoint, first disable the batch processing jobs. Be sure that there are no outbound messages in the queue, disable the endpoint, and then restart the batch processing jobs.


See Also

Create and configure local endpoints

Creating and configuring actions

Configure endpoint action policies

Configure endpoint action data policies

Creating and configuring a pipeline

Configure global settings for document exchange