Once an integration is configured and is ready to perform the magic that you have defined, a job is created. The job holds the results of this particular run of your integration. The results are, among other details, the number of rows that were processed, when it started and finished and the logs.
There are multiple ways to start such a job.
- Manual
Jobs can be started manually from the jobs overview. This is ideal for single use or those once-in-a-while integrations.
For a manual job there is an option to only process the first 10 records from a source to run a test with the newly configured or updated Integration.
Click the triangle on the Run Now button to view the options.
- Scheduled
Schedules can be configured to run hourly, daily, weekly or monthly and with any interval and options that match the selected schedule. - Triggered
Triggered jobs are meant for jobs that need to start automatically via another process, like a SuperOffice Script, Microsoft Power Automate or Zapier. Jobs are triggered by firing a URL with a secret access key. The URL can be found in the Process page in every integration when Triggered is selected under Run Jobs.
Since triggered jobs mostly will be fired by other automated processes, the response is a JSON message that shows the success status (true/false) and an optional message. With this message the third party process can determine to continue or halt the rest of the process.
There are two variants for triggered jobs.- Triggered job
A triggered job will be queued and it will start processing usually within one minute after it has been queued. This is like starting a job for a manual or scheduled integration.
Calling a triggered job is limited to one job per 5 minutes for each integration. More calls to the same trigger URL will fail; this fair use policy is maintained to keep the load on DataBridge and SuperOffice acceptable. - Instant job
An instant job will be processed immediately after the URL has been fired. It is suited for ‘near real time’ export or import routines. There is a downside however: the instant job process is limited as it is meant for small portions of data only. In the next chapter the instant job limitations are listed.
The instant job URL accepts parameters. Without additional parameters the job will be processed according to the profile settings as configured; meaning that the import is done with the original and potentially large import file, and the export is based on the full originally selected SuperOffice selection. This means that without extra control via parameters there won’t be many benefits against triggered jobs. The list of supported parameters is further down this page.
- Triggered job
Instant jobs limitations
These limits apply to instant jobs, since instant jobs are meant to be used for relatively small portions of data:
- Limit of lines per instant request: 10
- When 10 lines are processed the instant job will be aborted, this will be visible in the logs and the job will return as successful.
- Limit of import file size in instant requests: 2MB (2.000.000 Bytes)
- When trying to load an import file above 2MB in an instant job the job will fail with an error.
- Limit of lines per profile when in trial license: 100
- Without a license instant jobs can be tried with a limit of 100 lines in total per profile, when the limit is reached in trial the jobs will fail with an error.
- Instant jobs will ignore the notification settings.
Instant job parameters
General engine parameters
| Parameter | Description |
|---|---|
| ShowLog (true or false) | Show the log output in the browser when done. |
| ExportFile (filename) | Override the file to export by name. |
| FilePath (filepath) | Override the file to import by file path and file name and extension (full path) when using FTP, OneDrive or SharePoint. |
SuperOffice specific parameters
| Parameter | Description |
|---|---|
| ContactId | Primary key of the company (named ‘contact’ in the database) to process, SuperOffice ‘cuid’ variable. |
| PersonId | Primary key of the person to process, SuperOffice ‘atid’ variable. |
| AppointmentId | Primary key of the appointment to process, SuperOffice ‘baid’ variable. |
| Selectionid | Primary key of the Selection to process. |
| DocumentId | Primary key of the document to process, SuperOffice ‘doid’ variable. |
| ProjectId | Primary key of the project to process, SuperOffice ‘prid’ variable. |
| SaleId | Primary key of the sale to process, SuperOffice ‘said’ variable. |
| QuoteLineId | Primary key of the quote line to process. |
| QuoteId | Primary key of the quote to process, to get quote lines belonging to a quote. Please be aware of the limits when using this! See section Instant jobs limitations |
| VismaCustomerId | Primary key of the Visma customer |
| VismaVendorId | Primary key of the Visma vendor |
| VismaContactId | Primary key of the Visma contact |
| TicketId | Primary key of the ticket to process |
Best practice
By default you receive a JSON result whether the request was successful, this is good for production and saves bandwidth. But when setting up an integration and doing some tests it is very useful to append ‘&ShowLog=true&Verbose=true’ to your request URL; this will output the full DataBridge log and all steps taken to your browser when done so you can exactly see what happened.
Example 1
If you have configured your profile to import data in SuperOffice from an FTP location and want to run the import targeting a different import file your integration has prepared:
https://trigger-databridge.infobridgeuniverse.com/Instant/Run/253?key=05c3f4fe-08c0-4b58-ba91-d7cd34be9489&FilePath=/DataBridgeImport/Contact1337.csvThe ‘FilePath’ parameter makes sure another file is imported than configured in the profile. This file must be compatible and have the same columns as configured or it will fail!
Example 2
If you have configured your profile to export companies from SuperOffice to Dropbox and want to export a single specific company to a specific file in Dropbox:
https://trigger-databridge.infobridgeuniverse.com/Instant/Run/253?key=05c3f4fe-08c0-4b58-ba91-d7cd34be9489&ExportFile=Contact1337.csv&ContactId=1337This makes sure only one record from SuperOffice (the company with ID 1337) is exported to the requested file (Contact1337.csv in your Dropbox folder). Please make sure your SuperOffice selection chosen in the profile wizard matches the type of record you want to export!