AIF inbound ports (form)

Article
05/05/2014

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.

Use this form to create a new inbound port. You can also use the form to configure a selected inbound port for services.

After integration ports, services, or adapters have been added to the Application Object Tree (AOT), they must be registered to work in Application Integration Framework (AIF). Unregistered integration ports, services, and adapters are not displayed in this form. To register integration ports, services, and adapters, follow these steps.

Click System administration > Setup > Checklists > Initialization checklist.
Expand the Initialize system node.
Click Set up Application Integration Framework.

This form is organized into a series of FastTabs. As you move through the tabs, several settings depend on, or require, the settings on a previous tab or in another form. For example, you must specify at least one service operation before you can add a pipeline component, because pipeline components depend on service operations.

Task that uses this form

Managing integration ports

Navigating the form

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

Tabs

Tab	Description
Service contract customizations	Specify which service operations are available, and which data policies are used to customize documents.
Processing options	Specify how requests are processed through the inbound port.
Troubleshooting	Specify troubleshooting options.
Security	Restrict access to the inbound port, or specify trusted intermediaries.

Buttons

Button	Description
Activate	Activate the inbound integration port. Warning Activating an integration port causes all integration ports on Application Object Server (AOS) to be reactivated. You should avoid clicking this button when integration ports are processing messages.
Deactivate	Deactivate the inbound port. You must deactivate an integration port before you can change the port's configuration. Warning Deactivating an integration port causes all integration ports on AOS to be reactivated. You should avoid clicking this button when integration ports are processing messages.
Configure	Open the configuration form for the selected adapter. For example, for services that are based on Windows Communication Foundation (WCF), either the Service Configuration Editor or an XML editor opens when you click this button.
Configure AOS	Open the WCF Service Configuration Editor or an XML editor. This button appears after you select an adapter other than the NetTCP adapter and then save the form settings, such as by pressing CTRL+S. This option is available only if Microsoft Dynamics AX 2012 R2 or AX 2012 R3 is installed.
Service operations	Open the Select service operations form, where you can select the service operations that are available on the inbound port.
Data policies	Open the Document data policies form, where you can specify XML Schema Definition language (XSD) restrictions and field-level legal values for documents that are handled through the inbound port.
Inbound transforms	Open the Inbound transforms form, where you can specify transforms that are applied to all inbound requests.
Inbound pipelines	Open the Inbound pipelines form, where you can specify or configure pipeline components for each service operation.
Outbound pipelines	Open the Outbound pipelines form, where you can specify or configure pipeline components for each service operation.
Outbound transforms	Open the Outbound transforms form, where you can specify transforms that are applied to all responses.
Value mapping	Open the Value mapping form, where you can specify the translation of values for field data, based on business rules. For example, internal item numbers can be translated to either vendor-specific item numbers or industry-standard numbers, depending on the trading partner.
Document Filters	Open the Document filters form, where you can specify query constraints for the getKeys and getChangedKeys service operations.
Authorized users	Open the Authorized users form, where you can specify the list of users who have permission to use the inbound port.
Trusted intermediary users	Open the Trusted intermediaries form, where you can specify the list of users or groups that are authorized to serve as intermediaries on the inbound port.

Fields

Field	Description
Adapter	The type of adapter that the inbound port uses to provide the transport mechanism for inbound messages or response messages. If the adapter that you want to use is not listed, click Register all adapters..
URI	The URI that points to the source that the inbound port uses. Some services require that you use a specific adapter and a specific type of URI.
Category	The category of the inbound port. The categories are Basic and Enhanced. The value in this field is determined by the category of the port that is currently selected. Basic ports are added to the AOT by developers. Ports that you create by using this form are always enhanced.
Expose service operations	A selected check box indicates that service operations are available on the inbound port. This check box is always selected. To specify the service operations that apply, click Service operations.
Customize documents	Select this check box to apply data policies to documents that are handled through the inbound port. To specify XSD restrictions and legal values, click Data policies.
Upon error in batched requests:	Select the behavior when an error is encountered in a batched request for processing. Batched requests are separate requests that use the same message set identifier. The following options are available: Continue Halt Rollback
Process requests in parallel	Select this check box to specify that requests are processed in parallel.
Validate document XML	Select this check box to enforce schema validation. Warning Disable schema validation only for trusted messages, such as messages that originate from trusted, internal sources. Disabling schema validation after you define custom data policies can cause unexpected results. For example, required fields cannot be determined when you disable schema validation.
Replace existing documents on create	Select this check box to enable the create service operation to update an existing document if the document can be uniquely identified from the request.
Transform all requests	Select this check box to apply transforms to all requests that are handled by the inbound port. To specify the transforms that are applied, click Inbound transforms.
Preprocess service operation requests	Select this check box to enable the preprocessing of requests by inbound pipelines. To specify or configure pipeline components, click Inbound pipelines.
Post-process service operation responses	Select this check box to enable post-processing of responses from the inbound port. To configure the post-processing pipeline, click Outbound pipelines.
Transform all responses	Select this check box to apply transforms to all responses from the inbound port. To specify the transforms that are applied to documents, click Outbound transforms.
Apply value mapping	Select this check box to enable value mapping. To specify how the inbound port translates various values for field data, click Value mapping.
Logging mode	You can store, or log, copies of documents that are exchanged, and then view these documents by using the History form. Select the logging mode. The following options are available: Original document – Store only the original document. All document versions – Store a separate version of the document every time that the document is modified by a pipeline. Message header only – Store only the message header for each document. Logging disabled – Turn logging off. When you select this option, no documents are entered in the document history. Therefore, you cannot view correlation information.
Include exceptions in fault	Select this check box to specify that X++ error messages from the service are displayed to users of the port.
Respond after error in asynchronous request	Select this check box to specify that the port automatically sends error messages as responses in asynchronous scenarios.
Restrict to partition:	Select the partition to which inbound requests that are handled through the port are limited. Clear the field to remove the restriction. Selecting a partition enables the Restrict to company field. This option is available only if Microsoft Dynamics AX 2012 R2 or AX 2012 R3 is installed.
Restrict to company	Select the name of the company to which exclusive access to the port is granted. Clear the field to remove the restriction. In Microsoft Dynamics AX 2012 R2, the check box has been removed from the form. You can select a company after you select a partition.
Restrict users	Select this check box to limit use of the inbound port to specified users or user groups. To specify the list of users or groups that have permission to use the inbound port, click Authorized users. By default, all users have permission to use the port.
Allow trusted intermediary to impersonate	Select this check box to authorize trusted intermediaries. To specify the list of users or groups that are authorized to serve as intermediaries on the inbound port, click Trusted intermediary users. Typically, trusted intermediaries are middleware components, such as installations of Microsoft BizTalk Server, that help keep inbound requests secure.