Skip to main content
Version: 5.4.0

Executors

note

You need the admin rights to use this feature.

Executors allow administrators to define the backend services that can execute scheduled jobs. Create an executor before creating a Job that uses a job handler from that service.

Manage executors​

To manage executors, perform the following:

  1. In the KAIZEN studio console, on the left panel, click Job Scheduler > Executors.

    The Job Scheduler/ Executors page displays.

    Executors
  2. From here, you can create executors, search for existing executors, view executor details, edit executors, import executors, and export executors. Each row in the table provides the following actions under the Actions column:

    • View: Opens the executor details in read-only mode.
    • Edit: Opens the executor details for editing.
    • More: Expands a dropdown with additional actions, including Export and Deactivate.

    The executor table shows the following columns:

    ColumnDescription
    User DomainThe user domain where the executor is configured.
    NameThe executor name.
    TitleThe display title of the executor.
    Service NameThe backend service that runs jobs for this executor.
    Executor GroupThe executor group that receives jobs for this executor.
    StatusThe executor status, such as Active.
    ActionsActions available for the executor.
note

Executor Group routes scheduled jobs to a specific group of executor services. Keep the value as DEFAULT unless your environment uses separate executors.

Search executors​

To search for executors, perform the following:

  1. In Job Scheduler/ Executors, enter or select the search criteria.

    FieldDescription
    User DomainDisplays the user domain for the current session.
    NameSearch for executors by executor name.
    StatusFilter executors by status.
    TitleSearch for executors by display title.
    Service NameSearch for executors by backend service name.
  2. Click Search to find the result.

Create an executor​

To create an executor, perform the following:

  1. In Job Scheduler/ Executors, click Create.

  2. In the Create Executor window, provide the details:

    Create Executor window

    The following table describes each field from the window above:

    FieldRequiredDescription
    User DomainYesDisplays the user domain where the executor is created.
    NameYesEnter the executor name. Use a name that helps administrators identify the service that runs the jobs.
    StatusYesSelect Active or Inactive. Only active executors should be used for scheduled jobs.
    TitleYesEnter the display title shown in Runtime.
    Service NameYesEnter the backend service name that this executor represents.
  3. Click Save.

Edit an executor​

To edit an executor, perform the following:

  1. In Job Scheduler/ Executors, click Edit on the same row as the executor.

  2. In the Edit Executor window, update the executor details.

  3. Click Save.

Set the executor status to Inactive when the service should no longer receive scheduled job executions.

Export executors​

To export an executor, perform the following:

  1. In Job Scheduler/ Executors, select the executor you want to export.

  2. Open the Export function using one of the following methods:

    • Click Export at the top of the page.
    • Click More on the same row as the executor, then click Export.
  3. The Confirm window pops up, asking for confirmation. Click OK.

    An XML file containing the selected executor information will be downloaded in your browser.

Export all executors​

To export all executors, perform the following:

  1. In Job Scheduler/ Executors, click Export All.

  2. The Confirm window pops up, asking for confirmation. Click OK.

    An XML file containing the information of all executors will be downloaded in your browser.

Import executors​

To import executors from an existing XML file, perform the following:

  1. In Job Scheduler/ Executors, click Import. The File Explorer window opens.

  2. Browse to the XML file that contains the executor information. Click Open.

    A message will pop up, showing the import is successful.

Deactivate an executor​

To deactivate a executor, perform the following:

  1. Click More on the same row as the executor, then click Deactivate.

  2. In the confirmation dialog, click OK.

    A success message will confirm that the executor has been deactivated. The executor status will change from Active to Inactive.

note

After the deactivation, you have the option to reactivate it by clicking More > Activate.

Last updated on 19 Oct 2026