Skip to content
English
Log a Support Call Customer portal
  • There are no suggestions because the search field is empty.

Run a Configured Report Job Through the IntelliFront BI API

Request an on-demand run of a configured IntelliFront BI report job and check processing and delivery before retrying.

Use an API-triggered report job when an event in your application should start reporting already configured in IntelliFront BI. For example, an approved month-end process can request a prepared report job after its source data is ready.

Prepare the job in IntelliFront BI

A Gizmo groups configured Crystal Reports or SSRS reports for scheduling and distribution. Set up the reports, parameters, credentials and destinations, then confirm a controlled run in IntelliFront before adding the application request.

See How do I setup Gizmos in IntelliFront BI? for the application walkthrough. Native dashboard and KPI integrations follow the native analytics workflow.

Before you submit a run

  • Confirm the installation address and the intended Gizmo ID.
  • Authenticate with an identity permitted to execute the job.
  • Check that the job is enabled and available.
  • Review its recipients and destinations: a run can send email or write files.
  • Record the business event and submission time in your application.

Request the on-demand run

Follow Run configured report jobs from your application for the availability check, execution request and returned identifier. The Request an on-demand run of a configured report job recipe provides a complete example.

Retain the returned manual-run request ID with your application’s event record. Keep it distinct from the Gizmo ID and queue-entry IDs.

Check processing and delivery

Acceptance confirms submission for asynchronous processing. It does not prove that a report finished or reached its destination.

Review Gizmo History, relevant queue and error evidence, and the actual output. A queue entry disappearing or an empty error result is not evidence of successful delivery.

Reconcile before retrying

If a request times out, investigate the original submission before repeating it. Another request can queue duplicate work and produce duplicate deliveries. Use Troubleshoot IntelliFront BI API Integrations and Build a reliable API integration for recovery guidance.