Skip to Content

Maintenance workflow in Jitterbit App Builder

Introduction

Since version 4.43, App Builder has guided workflows for installing release packages, and for locking applications and data sources. The workflows step you through the following tasks:

  • Select or upload packages.
  • Select affected objects.
  • Send predefined notifications.
  • Install packages or lock/unlock affected objects.

Locking an application or data source

Locking prevents users from accessing selected resources. User groups can be granted access, which can then be used for testing, while end users are redirected to a maintenance page.

App Builder comes with a default maintenance page, but you can define pages per instance or per application by selecting IDE > Maintenance (Beta), then selecting the Settings tab.

Workflow configuration

Note

The Install Packages and Maintenance workflows provided with App Builder cannot be edited, but they can be deactivated, or they can be copied using the More > Copy command.

To configure a workflow, follow these steps:

  1. Select IDE > Maintenance (Beta).

  2. In the Start Workflow panel, click the Configure button.

  3. Existing workflows are listed in the Workflows panel. Select one to see the workflow's steps in the Steps panel.

  4. Each workflow has one or more steps with a name and one of the following actions:

    • Select/Upload LPs: The user is shown a grid from which to add existing packages or upload new ones.

    • Select Objects: These are used for sending notifications, or for locking and unlocking.

    • Notifications: Predefined system notifications to be sent during the workflow. The available fields are the same as for system notifications, with the following addition:

      • Dismiss After Step: The notification is automatically dismissed and removed after the given step.

    • Install Packages: Lists the packages previously selected or uploaded. (You can still select or upload new packages on this step.)

    • Lock/Unlock: Lock or unlock applications and data sources from the Select Objects step. (You can still add more objects on this step.)

      Tip

      You can allow selected user groups to access locked items. To do this, follow these steps:

      1. Select IDE > User Management.
      2. Select the Groups tab.
      3. In the Groups panel, click the Open record icon for a group.
      4. In the Group dialog, select More > Edge Case.
      5. Turn on the Application and Data Source Lock switch.

Run a workflow

To run an existing workflow, follow these steps:

  1. Select IDE > Maintenance (Beta).

  2. In the Start Workflow panel, click the Start New button for the desired workflow.

  3. Follow the workflow's steps. (Locks are automatically removed when a workflows ends.)

Tip

You can resume an ongoing workflow if the user needs to reopen their browser or another administrator needs to finish the workflow.

To monitor workflow progress, select IDE > Maintenance (Beta), then inspect the items in the On-Going Workflows panel.

To see locked resources, select IDE > Maintenance (Beta), then in the On-Going Workflows panel, select More > Locks.

On-demand notifications

Since App Builder version 4.44, you can send an immediate (on-demand) notification at any step in a workflow. To do this, follow these steps:

  1. Select More > Notifications.

  2. In the Notification dialog, enter the details of the notification.

  3. (Optional) Open the Dismiss After Step menu, then select after which step the notification is to be dismissed.

  4. Click the Send button.

Dismiss notifications

Since App Builder version 4.44, you can dismiss any notification sent by workflows, whether scheduled or on-demand. To do this, follow these steps:

  1. Select IDE > Maintenance (Beta).

  2. Select the Notifications tab.

  3. Click the Dismiss button for a notification.