Skip to content

User guide

This user guide explains how to follow-up and troubleshoot interfaces developed in the interface framework.

Interface monitor

This form shows all inbound and outbound messages ordered by descending sequence number. The newest messages are shown on top.

interface-framework-overview

Columns

  • Record-ID: A unique id of a message
  • Company: The legal entity is message is from or for
  • Environment: Type of environment: development, qa, test, uat, production, ... This has no impact and is for troubleshooting only
  • Sequence: A numerical sequence number. This is not necessarily unique as it can be provided by applications sending to d365. Usually, this is unique and filled in by d365.
  • Conversation: Multiple messages can be part of the same conversation. Messages of the same conversation will not be processed in parallel. This is mainly used for messages that touch the same d365 objects and avoids update conflicts.
  • Message type: The message type
  • Direction: Inbound or outbound from the perspective of d365
  • Reference: a text value to easily search for messages, this is determined in a different way for every message type. For an inbound product message, the reference could be the product number.
  • Process type: Synchronous messages means the messages get processed on creation. Asynchronous means the messages are created and processed by a batch job afterwards.
  • Status
    • Not processed
    • Executing
    • Pending
    • Canceled
    • Succeeded
  • Status date time: Time of the last status change
  • AX created date time: Time the message was created in d365
  • Sender system: Optional and for troubleshooting only
  • Target system: Optional and for troubleshooting only
  • Sender created date time: Optional, the time the message was created at the sender
  • Sender sent date time: Optional, the time the sender sent the mssage
  • User ID: The user id of the person that triggered the message
  • Operator name: The user name
  • Extra reference 1 - 5: More text fields that can be used for troubleshooting
  • Process logic
    • Standard: A regular message that can be processed in this form and by the standard batch jobs
    • Custom: These messages have separate forms and batch jobs to process them, typically they require additional user interaction

Buttons

  • Process: This will process the message, usually the messages will be processed by a batch job, not in this form.

  • Cancel: This will change the status of the message to 'Canceled', the message will not be processed by the batch job.

  • Set not processed: Change the status of a message from any other status back to 'Not processed'. This allows a message the be processed again.

  • Show detail: Opens a new form with all data from that message. This is a different form for every message type. Opening this form can also be done by clicking on the Record-ID value in the grid.

  • Show response: This is only relevant for inbound synchronous messages, it will show what d365 sent back as a response to the caller. Note that synchronous messages are discouraged.

Batch jobs

Processing

There are 2 types of processing batch jobs. A serial and a parallel one. The serial batch job will process all messages one after the other. The parallel batch job will process several messages at the same time. See the configuration guide for more information about the parallel processing job.

The parallel batch job is recommended as it has a higher throughput.

Cleanup

This batch jobs cleans up all succeeded messages older dan 30 days by default. The query can be adjusted as you like. It is recommended to leave the standard settings.