You have been redirected from an outdated version of the article. Below is the content available on this topic. To view the old article click here.

job_info()

Usage

job_info(jobId)

Description

Returns information about the job with the given job Id. If the job does not exist (anymore) the function returns false.

For script jobs this information is:

  • jobId: The job ID
  • jobtype: The job type
  • username: The username of the user who started the job
  • status: The current status of the job
  • jobName: The name of the script job
  • exception: If an exception was caught during the execution, an exception object containing:
    • message: The message of the exception
    • cause: The cause of the exception
    • stacktrace: The stacktrace of the exception

For file import jobs:

  • jobId: The job ID
  • jobtype: The job type
  • username: The username of the user who started the job
  • status: The current status of the job
  • fileUuid: The UUID of the imported file
  • filepath: The path of the imported file
  • filesize: The size of the imported file
  • processedChunks: The number of chunks already processed
  • processedObjects: The number of objects already processed
  • exception: If an exception was caught during the execution, an exception object containing:

    • message: The message of the exception
    • cause: The cause of the exception
    • stacktrace: The stacktrace of the exception

Example

${job_info(1)}

Search results for "job_info()"

job_info()

Returns information about the job with the given job Id. If the job does not exist (anymore) the function returns false.

For script jobs the returned information is:

Key Value
jobId The job ID
jobtype The job type
username The username of the user who started the job
status The current status of the job
jobName The name of the script job
exception

If an exception was caught during the execution, an exception object containing:

message : The message of the exception

cause : The cause of the exception

stacktrace : The stacktrace of the exception

For file import the returned information is:

Key Value
jobId The job ID
jobtype The job type
username The username of the user who started the job
status The current status of the job
fileUuid The UUID of the imported file
filepath The path of the imported file
filesize The size of the imported file
processedChunks The number of chunks already processed
processedObjects The number of objects already processed
exception

If an exception was caught during the execution, an exception object containing:

message : The message of the exception

cause : The cause of the exception

stacktrace : The stacktrace of the exception

job_info(jobId)