Opencell icon

Opencell

Consume Opencell API

Overview

The Job → Get Job Report operation in this n8n node retrieves job execution reports from the Opencell API. This is useful for monitoring, auditing, or analyzing the results of scheduled or manual jobs within the Opencell system. Common scenarios include fetching logs or summaries of batch processes, data imports/exports, or other automated tasks managed by Opencell.

Practical examples:

  • Automatically pulling daily job execution reports for compliance tracking.
  • Integrating job status and results into dashboards or alerting systems.
  • Filtering job reports by specific job instance codes or IDs for targeted analysis.

Properties

Name Type Meaning
Authentication options Selects the authentication method to use (Basic Authentication or OAuth2) for connecting to Opencell.
Filters fixedCollection Allows adding one or more filters to narrow down the job reports. Each filter consists of a Key (ID or Job Instance Code) and a Value.
Body Content Type hidden Internal property; always set to "multipart-form-data".
Paging collection Controls pagination and sorting of the report results. Includes:
• Full Text Filter string A full-text search filter. If provided, it takes priority over individual filters.
• Limit number Maximum number of results to return (default: 50).
• Offset number Zero-based index of the first item to return (default: 0).
• Sort Order options Sort order of the results: Ascending or Descending (default: Descending).

Output

  • The output is a JSON object containing the job report(s) as returned by the Opencell API.
  • The structure of the json field will directly reflect the response from /opencell/api/rest/job/jobReport/list, which typically includes details such as job instance code, execution status, timestamps, and possibly log messages or result summaries.

Example output structure:

{
  "jobReports": [
    {
      "id": "123",
      "jobInstanceCode": "DAILY_IMPORT",
      "status": "SUCCESS",
      "startTime": "2024-06-01T00:00:00Z",
      "endTime": "2024-06-01T00:05:00Z",
      "result": "Imported 100 records.",
      ...
    },
    ...
  ]
}

Note: Actual fields depend on the Opencell API response.


Dependencies

  • External Service: Requires access to an Opencell instance with the REST API enabled.
  • Authentication: Needs valid credentials for either Basic Authentication or OAuth2, configured in n8n credentials.
  • n8n Configuration: No special environment variables required beyond standard credential setup.

Troubleshooting

Common issues:

  • Invalid Credentials: If authentication fails, you may see errors like Username/password error. Error code : 401. Ensure your credentials are correct and have sufficient permissions.
  • No Results Returned: If filters are too restrictive or incorrect, the API may return an empty list. Double-check filter keys and values.
  • API Connectivity Issues: Errors such as Host error. Error code : ENOTFOUND indicate network or endpoint configuration problems.
  • Full Text Filter Priority: If both full text filter and individual filters are set, only the full text filter is applied. Remove it if you want to use key/value filters.

Error messages and resolutions:

  • "Invalid credentials (unknown error)": Check your authentication settings in n8n.
  • "This resource doesn't support custom fields": Custom fields are not relevant for this operation.
  • "Unable to get custom fields. Server response: ...": Not applicable here, but indicates server-side issues when fetching metadata.

Links and References

Discussion