Documentation Index

Fetch the complete documentation index at: https://kb.pigment.com/llms.txt

Use this file to discover all available pages before exploring further.

Schedule Imports in Pigment

Prev Next

You can schedule any existing import configuration that doesn't require an external file at the time of import. This includes Metric-to-Metric and List-to-List imports or imports using Pigment Connectors.

Access import scheduling

All Data Flow and import scheduling configurations can be found on the Scheduling page in the Data Actions and Flows section. Scheduling is Application-specific.

  1. Open the Application you want to add a Schedule to.

  2. Use one of the following options to open Scheduling:

    • Select the three-dot menu, then Scheduling.

    • Select the three-dot menu, then All Settings. Select Data Actions and Flows, then the Scheduling tab.

Schedule an import

To schedule a Data Flow or import from the Scheduling tab:

  1. Select New schedule.

  2. Choose Schedule a Data Flow or Schedule an import.

ℹ️ Note

You can adjust the settings of existing scheduled imports by selecting the three dots to the right of the time and selecting Edit schedule. Once you adjust your configuration, select Update Schedule.

Schedule options

To schedule an import or Data Flow, configure the following options:

  1. Block. Select the Block you want to populate during the import.

    ℹ️ Note

    Only Blocks with an import configuration using a Pigment connector will be available.

  2. Configuration. Select the Import configuration you want to trigger.

  3. Start Time. Set the time at which the import should be scheduled. You can select the time zone that you want the import to be scheduled on.

  4. Repeat. Select the frequency of this import.

    ℹ️ Note

    You can configure up to four different schedules on a given import configuration.

  5. (Optional) Import Notifications. Toggle on Get notified on the final status of the import.
    Enable this option to automatically receive a notification (email or in-app notification) based on import status.

    1. Notify about. Select which import status will trigger a notification Failed, Failed and partial, or All imports.

    2. Send notification to. Select the Members you wish to send a notification to.

      ⚠️ Important

      You cannot receive success or failure notifications for the final status of Data Flows.

  6. Select Schedule Import to create the import scheduling configuration.

Now a scheduled import is configured. You no longer need to manually refresh your data. Import notifications are received in-app, by email, or through the Pigment App in Slack.

ℹ️ Note

If you need to create several scheduled imports for one connector, we recommend setting a different Start Time for each import. For example, Import #1 1:00 am; Import #2: 1:05 am, and so on.

Review and update your scheduled import

Now that the first import scheduling configurations are configured, you can use the Scheduling page to monitor your scheduled imports.

Add new scheduling option or run import now

Each section represents an import configuration. All scheduling configurations associated with this import configuration are listed below each import configuration. Depending on the type of import, you can use one of the following options to trigger the import directly from the page:

  • Start an import right now

  • Start a Data Flow right now

Manage scheduling configurations

Next to each scheduled configuration is a toggle. You can use this to activate or deactivate a scheduling configuration without deleting it. If you want to delete it, select the three dots at the end of the configuration and select Delete schedule.

Change ownership of scheduled imports

⚠️ Important

Import schedules rely on active accounts within a Workspace. If the Member who scheduled an import is deactivated from a Pigment Workspace, you must update the ownership of scheduled imports to prevent import failures.

To change ownership of scheduled imports, open Import scheduling. Whichever Member edits the schedule configuration becomes the owner of the schedule configuration. Ensure that any recipient of import notifications is updated on the change of ownership.

Show history

You can view all instances where a configuration has been run. Select Show history to see each instance that was triggered. Select View Summary to access detailed information about a specific import. The history includes imports triggered either manually or through a scheduling configuration.

Handle import failure

If for any reason the import fails, the import configuration will be flagged with a Failed status and an email notification will be sent if the Failure Alerts option was enabled. This cannot be enabled for Data Flows.

Check the history to get more details on the root cause of the failure. Once the problem is resolved, select Run Again to confirm that the problem is resolved and revert the import configuration to a Success status.