Opencell icon

Opencell

Consume Opencell API

Overview

The Opencell Job: Execute Job operation node allows you to trigger the execution of a specific job in the Opencell system by providing its job code and, optionally, custom field values. This is useful for automating scheduled or on-demand tasks managed by Opencell, such as data processing, reporting, or maintenance jobs.

Common scenarios:

  • Automating batch processes (e.g., billing runs, data imports).
  • Triggering custom business logic encapsulated in Opencell jobs.
  • Integrating Opencell job execution into broader workflows (e.g., after data updates or external events).

Example:
You might use this node to execute a "Monthly Billing" job after updating customer records, passing in custom parameters as needed.


Properties

Name Type Meaning
Authentication options Selects the authentication method for connecting to Opencell ("Basic Authentication" or "OAuth2").
Job Code string The unique code identifying the job instance to execute. Required.
Body Content Type hidden Always set to "multipart-form-data". Used internally for request formatting.
Custom Fields fixedCollection Allows adding one or more custom fields to pass as parameters to the job. Each custom field can be of various types (string, date, boolean, number, list, etc.), depending on the job's definition.

Custom Field sub-properties:

  • Field Name or ID: Select or specify the custom field to set.
  • String/Text Area/Date/Boolean/Number/List Value(s): Depending on the field type, provide the appropriate value.

Output

  • json: The response from the Opencell API after executing the job. The structure depends on the job executed but typically includes status information, any output or result data produced by the job, and possibly error messages if the job failed.

    Example output:

    {
      "status": "SUCCESS",
      "jobInstanceCode": "monthly_billing",
      "executionId": "12345",
      "startTime": "2024-06-01T00:00:00Z",
      "endTime": "2024-06-01T00:05:00Z",
      "result": { ... }
    }
    
  • If the job produces binary data, it will be included as a binary property (not typical for job executions).


Dependencies

  • External Service: Requires access to an Opencell API endpoint.
  • Authentication: Needs either Basic Auth credentials (opencellApi) or OAuth2 credentials (opencellOAuth2Api), configured in n8n.
  • Environment: The Opencell instance must have the relevant job defined and accessible via API.

Troubleshooting

Common issues:

  • Invalid Job Code: If the provided job code does not exist, the API will return an error. Double-check the job code in Opencell.
  • Missing Required Custom Fields: Some jobs may require certain custom fields; ensure all required fields are provided.
  • Authentication Errors: Incorrect credentials or insufficient permissions will cause authentication failures.
  • API Connectivity Issues: Network problems or incorrect API base URL configuration can prevent successful execution.

Error messages:

  • "This resource doesn't support custom fields": The selected job does not accept custom fields, or the job code is invalid.
  • "There are no custom fields defined for this resource": No custom fields are available for the specified job.
  • "Custom fields have not been fetched yet.": Attempted to set a custom field before loading available fields.
  • API errors with status codes (e.g., 401 Unauthorized, 404 Not Found): Check credentials and job code.

Links and References

Discussion