Purpose and implementation of a callback integration in Oracle Integration Cloud (OIC) to handle FBDI (File-Based Data Import) processes.
Purpose of Callback Integration
When submitting FBDI files to Fusion Applications, it is necessary to know the final status of the job (e.g., succeeded or errored) to manage follow-up tasks.
While manual polling using an ERP connection is possible, it is inefficient and requires wait nodes without a clear duration, making it a lengthy and less ideal process.
A callback integration automatically triggers upon the completion of the FBDI process by utilizing business events within Fusion, ensuring that the OIC process runs as soon as the job is finished without manual intervention.
Functionality and Logic
Status Management:
The primary goal is to fetch the job status.
File Handling:
If the job succeeds, the log file is placed into a specific success folder on an FTP server.
If the job errors out, the log file is placed into an error folder, enabling support teams to review, rectify the issues, and re-run the file.
Additional Actions:Beyond moving files, this integration can be configured to send notifications to teams or insert instance IDs and status information into custom audit tables.
Implementation Steps
1.Creation:The integration is built using the application style.
2.Configuration:An ERP connection is used with the "Receive callback message upon completion of FBDI bulk import job" option.
3.Logical Flow:A switch operation is implemented to route files based on the job status (e.g., "succeeded" or "error").
Choose Logger here
Now, use the switch condition for succeed or error statuses
After add, choose route
Invoke FTP connection for moving the errors to error folder
Choose otherwise and add logger
4.Testing:
The main integration picks up a file from an input folder and submits it to the Fusion application.
Once the supplier creation in Fusion is complete, the callback integration triggers automatically.
Successful creation of suppliers is verified in the Fusion management page, and the callback integration confirms the status in the instance logs.
FAQ
Questions regarding Oracle Integration Cloud (OIC) and File-Based Data Import (FBDI) callback integrations:
----------------------
General FBDI & Integration Concepts
-----------------------
Q:What is the main purpose of building a callback integration in OIC?
A:The main purpose is to automatically retrieve the status of an FBDI job (succeeded or errored) once it completes in the Fusion application.
Q:How do you enable the callback functionality when building an FBDI integration?
A:It is enabled by selecting a specific "Enable Callback" checkbox during the creation of the main FBDI integration.
Q: What is the primary benefit of using a callback over manually checking job status in the main integration?
A: A callback avoids using "wait nodes" and manual status checks in the main integration, which can be time-consuming and inefficient since the duration of large import jobs is unknown.
Q: How does the callback integration know when to trigger after the FBDI process is submitted?
It triggers automatically based on internal business events raised within the Fusion application once the FBDI process completes.
Q:Describe the relationship between "business events" in Fusion and the OIC callback integration.
The callback integration acts like a business event integration; when the FBDI job finishes, Fusion raises a business event that serves as the trigger for the OIC callback flow.
Q:Which connection type is used as the source for a callback integration to receive messages from Fusion?
The ERP connection is used as the source to receive the callback message from the Fusion application.
---------------------
Technical Configuration
--------------------------
When configuring the ERP connection for a callback, which specific option must be selected?
A:You must select the option to "Receive callback message upon completion of FBDI bulk import job submitted via another integration".
Q:Why is it necessary to specify the "Import Job" during the callback configuration?
A:It must be specified so the integration knows which particular job's status (e.g., "Import Suppliers") it needs to fetch.
Q:What output fields are typically received from the Fusion application in a callback message?
A:Typical outputs include the job status, a document ID, and a file reference.
Q: What does the "file reference" in the callback integration's output represent?
A:It represents the log or output file of that particular job, containing details of what happened during the process.
Q: What role does a "switch condition" play in the logic of a callback integration?
It allows the integration to route the flow differently based on whether the status is "succeeded," "error," or another state.
Q: How should status names like "succeeded" or "error" be formatted within the integration logic?
They must be formatted exactly as they appear in the Fusion application (e.g., "succeeded" or "error") for the switch logic to work correctly.
---------------------------------
Error Handling & Workflow
-----------------------------------
Q:What actions can be automated if an FBDI process returns an "error" status?
A:The integration can automatically place the log file into an "error" folder on an FTP server and send a notification to the team.
Q:How does a callback integration assist supporting teams in rectifying failed data imports?
A:By placing log files in an error folder, support teams can check the reasons for failure, rectify the input data, and re-run the integration.
Q:Explain how to handle statuses that are neither "succeeded" nor "error" within the integration.
A:An "otherwise" branch can be used in the switch condition to capture and log other statuses, such as "waiting" or "processing".
Q:Besides placing files in FTP folders, what other automated actions can be triggered by a callback?
A:It can trigger email notifications to the team or insert job details (like instance IDs and status) into a custom audit table.
Q:Why might you use an "audit table" or custom ATP table within a callback flow?
A:To maintain a record of instance IDs and statuses for auditing and tracking purposes.
------------------------------------
Testing & Monitoring
------------------------------------
What information is typically captured in the "business identifier" for a callback integration?
A: A common business identifier used is the Document ID.
Q:If an FBDI job contains a large volume of records, how does this affect the timing of the callback trigger?
A:The callback will only trigger after the entire job is finished; if there is a huge amount of data, it will take more time before the callback integration is initiated.
Q:How do you verify in the Fusion application that the data was successfully imported?
A:You can search for the specific records (e.g., navigate to "Manage Suppliers") to confirm they exist and check that their creation source is "FILE".
----------------------
No comments:
Post a Comment