Start and stop the asynchronous Application Integration Framework (AIF) services

Microsoft Dynamics AX 4

In order for the Application Integration Framework (AIF) to begin sending and receiving documents with adapters, four services must be running as batch jobs within Microsoft Dynamics AX:

AIFOutboundProcessingService
AIFInboundProcessingService
GatewaySendService
GatewayReceiveService

Until these batch jobs are started, no documents can be processed in adapter-based exchanges. Inbound documents do not enter your Microsoft Dynamics AX system and outbound documents accumulate in the AIF outbound processing queue.

All the services are implemented as Microsoft Dynamics AX batch jobs. See Processing batch jobs.

You can create a single batch job to support both inbound and outbound processing, or you can create multiple batch jobs to run on one or more computers, depending on your processing needs.

To start the services and allow AIF to begin processing documents from the queues, you perform the following steps:

Create a batch group.
See Create a batch group.
Create a batch journal type using the form.
Add the AIF services (the classes in the Application Object Tree) to the batch journal type. See Create a batch journal type.
Create a batch journal using the form.
See Create a batch journal.
Set parameters for the batch job on the Batch journal execution form.
Start batch job execution using the Set up batch processing form.
See Run batch jobs.

Note
You must keep the batch window open while the batch jobs are running. To stop the services, click Stop on the Batch processing form.

Create a batch group, a batch journal type containing the AIF services, and a batch journal

These steps create one batch group for as many of the AIF services as you need to set up. For more information, see Processing batch jobs.

1. Create a batch group

Click Basic > Setup > Batch > .
Press CTRL+N to create a new batch group.
In the Group field, type an identification for the batch group, for example AIF.
In the Description field, type a name for the batch group that is unique in the system, for example AIF Group.

2. Create a new batch journal type

For the AIF services you want to run, complete the following:

Click Basic > Setup > Batch > .
Press CTRL+N to create a new batch journal type.
In the Journal type field, type an identification for the new journal type.
In the Description field, type a descriptive name for the new journal type.
Click the General tab.
Press CTRL+N to add a new job to the journal type.
Add some or all of the AIF document processing components (called AifInboundProcessingService, AifOutboundProcessingService, GatewaySendService, and GatewayReceiveService) by clicking the drop-down icon under Class name and pressing CTRL+N for each new entry.

3. Create a batch journal

Click Basic > Setup > Batch > .
Click CTRL+N to create the batch journal.
Type a unique identifier for the journal in the Journal field.
Select the journal type you created in Step 2.
Type a unique descriptive name for the journal in the Name field.

4. Create the processing rules for the journal

In the Batch journal execution form, complete the following:

Click Basic > Setup > Batch > .
Select a batch journal.
Click Processing.
On the Batch tab, select the Batch processing checkbox.
In the Batch group field, select the batch group that you created above.
To set the recurrence fields, click Recurrence.
One minute is a good value for testing, but a longer time between execution of batch jobs would probably be more efficient in production. The most efficient timing depends on your installation.
Click OK.
Click OK again to exit the Batch journal execution form.
After a short processing time, you should see a message of this form in the Infolog: "The 'Batch journal execution' job is added to the batch queue."
On the Batch-journal name form, click Jobs.
On the Batch journal line form, press CTRL+N to add the AIF services in the Class name field.

Start processing documents in the AIF queues

Note
Keep the batch window open while the batch jobs are running. To stop the services, click Stop on the Batch processing form.

Click Basic > Setup > Batch > Processing.
In the Group field, select the AIF batch group you created above or any batch group available from the lookup field.
Click OK.
View the Infolog message informing you that the status is Waiting before the batch job is executed.
View the Infolog messages each time the batch job is executed.

Stop processing documents in the AIF queues

To stop processing, on the Batch processing form, click Stop. This form appears when you start processing by clicking OK on the Set up batch processing form.