AIF document filters (form) [AX 2012]

Updated: May 6, 2011

Applies To: Microsoft Dynamics AX 2012 R3, Microsoft Dynamics AX 2012 R2, Microsoft Dynamics AX 2012 Feature Pack, Microsoft Dynamics AX 2012

Click System administration > Setup > Services and Application Integration Framework > Inbound ports. Create or modify an enhanced integration port. Then, on the Processing options FastTab, click Document Filters.

Use this form to add, modify, or delete document filters for inbound messages.

When you configure an inbound port, you can apply document filters to messages that are sent in response to certain requests. Service users can retrieve a specific instance of a document by using an entity key. To retrieve a list of valid entity keys, service users can use the findKeys, getKeys, and getChangedKeys service operations.

  • findKeys – This service operation returns entity keys based on a query that is provided by the service user. Document filters have no effect on this service operation.

  • getKeys – This service operation returns only entity keys that match document filters that you specify for the integration port.

  • getChangedKeys – This service operation returns only entity keys that match document filters that you specify for the integration port, and that were changed after a date and time that is specified by the caller.

If no document filters are created for a port, getKeys and getChangedKeys return an empty set. Each document filter that you create is defined for a particular service. Each document filter adds a subset of entity keys to the response message.

The following tables provide descriptions for the controls in this form.




Add a new document filter.


Delete the selected document filter.


Open the configuration form for document filters. This form is an instance of the Inquiry form. The contents of this form vary, depending on the document that you selected. The form is customized for the service that you selected. For more information about how to use the Inquiry form, see Inquiry (form).




Enter a description to indicate what the document filter does. For example, you can type, "Amounts more than 10000."

Document name

The name of the document that document filters are applied to.

Document filter type

The type of document filter.

Announcements: To see known issues and recent fixes, use Issue search in Microsoft Dynamics Lifecycle Services (LCS).