Run configured report jobs from your application
Request an existing Gizmo run and distinguish submission, execution and delivery outcomes.
Use an on-demand Gizmo run when a business event in your application needs to trigger a report job already configured in IFBI. For example, an approved month-end process can request a prepared reporting job after its upstream checks finish.
Prepare and test the job first
A Gizmo can combine configured Crystal Reports or SSRS reports, parameters, triggers and delivery destinations. Establish that configuration and test a representative run in IFBI before adding the API request to your application.
This workflow is for a configured job. Native dashboard viewing and definition management follow their own integration path.
Check availability and request execution
- Use Check API availability for a Gizmo with the existing Gizmo ID.
- Inspect the HTTP result, the nested
Response.IsErrorvalue and the Gizmo’sEnabledandGizmoIsDeletedvalues. - Submit
GizmoIdto Add Gizmo To Manually Run. - Retain the GUID returned in
Datawith your own business-event identifier and submission time.
The calling identity needs the applicable Gizmo Execution permission. The Request an on-demand run of a configured report job recipe in Recipes provides the complete example.
Model the outcome in stages
An accepted manual-run request means work has been submitted for asynchronous execution. It does not establish that a report finished or reached its delivery destination.
Track submission separately from execution and delivery evidence. API availability confirms a responsive API and the reported Gizmo state; it does not prove that all backend services, source connections and destinations are healthy.
Prevent duplicate business actions
Record a business-event key in your application before submitting work. If the request times out, reconcile the outcome before retrying. The documented operation does not provide a general idempotency-key contract, so automatically repeating the POST can queue duplicate work.
Use the queue and error evidence described in troubleshooting. Treat a job leaving the queue, or the absence of a new error, as an intermediate observation rather than proof of delivery.
For time-based or event-driven configuration within IFBI, continue with schedules and workflows.
Updated 3 days ago