Overview
The Outbound Integration list view displays the most recent combination of transaction type and transaction records in the outbound queue that have either not been processed yet to the host system or that have errored in being processed to the host system. From this list view, individual integration records can be reprocessed, put on hold, bypassed, and/or manipulated.
Understanding the Outbound Integration Statuses
To view the Outbound Integration list view, expand the Company module and click 'Outbound Integration'. Each outbound integration record that displays will display with the following fields:
- Created: Displays the day and time the outbound transaction was created. This field is never editable.
- ID: Displays the ID of the transaction attempting to be processed. ie: Customer Address ID or Transaction ID just depending on the Transaction Type. This field displays as a hyperlink that, when clicked, opens the outbound integration record's record view, allowing the user to manipulate the data. This field is editable in the record view.
- Integration Message: Displays the information, usually the error, that was presented back from the attempt to integrate. This field is never editable.
- Last Processed: Displays the last date and time that the integration record was attempted to be processed. This field is never editable.
- Reprocess Until: Displays the date and time that the transaction will stop attempting to reprocess. This field is never editable, however the user can manually process outbound integration records beyond their 'Reprocess Until' expiration.
- Status: Displays the current status that the outbound transaction is in. This is the integration status not the actual transaction status. This field is editable using mass update and from the record view.
- Transaction Type: Displays the user-friendly name of the transaction type that is attempting to be processed. This field is never editable.
The potential statuses that an outbound integration record can be in include the following:
- New: A record with a status of 'New' is a new record that has never been processed.
- In Progress: A record with a status of 'In Progress' means the integration of that record into the host system is currently processing.
- Completed: A record with a status of 'Completed' is a record that was successfully processed to the host system.
- Error: A record with the status 'Error' means that there was an error in the integration procedure for that record and the integration failed.
- Reprocess: A record with the status 'Reprocess' is a record that will continue attempting to integrate to the host system until the time limit is surpassed.
- Hold: A record with the status 'Hold' is a record that's integration is on hold and no attempt to process the record will be made.
- User Bypassed: A record with the status 'UserBypassed' means that no attempt will be made to process the integration record and no edits can be made to the integration record.
Reprocessing an Outbound Integration Record
When an outbound integration record fails to integrate, the record's status is updated to 'Reprocess' so long as the 'Reprocess Until' time limit has not been reached. If the 'Reprocess Until' time limit has been reached, the record's status will be updated to 'Error' and will no longer automatically reprocess.
Because outbound integration records have a time limit for reprocess attempts, the user may want to reprocess an outbound integration record after it stopped reprocessing automatically. In order to do this, the user can manually reprocess the record.
If the user would like to reprocess one outbound record, the user can open the integration record by clicking the ID hyperlink. From this window, click the Status field drop-down arrow and deleted the current 'Error' status and select 'Reprocess'. Click Save and exit the record. Saving the record with the new status WILL NOT reprocess the record at the time the user saves, it will reprocess the next time the integration procedure is ran. If the user would like to immediately reprocess the record, the user would click the Process toolbar icon, which would process all the integration records in the list view with a status of New or Reprocess.
If the user would like to reprocess many outbound records, the user can use the mass update functionality.
Bypassing an Outbound Integration Record
Users have the ability to effectively void outbound integration records that have yet to be successfully integrated using the User Bypassed status update. When a user updates an outbound integration record's status to User Bypassed, the integration record is no longer displayed in the Outbound Integration list view nor will it be included in any future integration procedures.
If the user would like to bypass one outbound record, the user can open the integration record by clicking the ID hyperlink. From this window, click the Status field drop-down arrow and deleted the current 'Error' status and select 'User Bypassed'. Click Save and exit the record. Saving the record with the new status will remove the record from the list view and from all future integration attempts. Because it no longer displays in the list view, it is effectively voided and can no longer be edited or retrieved.
If the user would like to bypass many outbound records, the user can use the mass update functionality.
Putting an Outbound Integration Record on Hold
If a user would like to pause the integration attempts for an outbound integration record, the user can place the record in a status of 'Hold'. Records in a status of 'Hold'