This article discusses how to automate data imports in Pigment using scheduling. It provides step-by-step guidance on how to set up and schedule imports to run at specific intervals once the configuration is complete.
Table of Contents
Before you configure a scheduled import, you need to decide if you need to configure a Metric to Metric Import or a Pigment Connector from the Integration page, and save an import configuration using this connector.
Before you begin
Only users with the Can Import Data permission in the Application can access the Import Scheduling page and configure imports.
To access Import Scheduling, you must also have the Import Data Application-level permission.
You can schedule any existing import configuration that doesn't require an external file at the time of import. That is, Metric to Metric imports, or imports using Pigment Connectors.
Accessing import schedule
All import scheduling configuration can be found in the Import Scheduling page. Each Import Scheduling is Application specific.
- Open the Application you want to schedule imports in.
- You can do one of the following to open Import Scheduling:
- Click the menu (...) and then Import Scheduling.
- Click the menu (...), then All Settings. Import Scheduling is displayed in the sidebar.
Scheduling an import
If it’s the first schedule of the Application click on Set up scheduled imports. After an import is scheduled you can click Schedule Imports to create more.
You can adjust the settings of existing scheduled imports by clicking the three dots to the right of the name and selecting Edit schedule. Once you adjust your configuration, select Update Schedule.
Schedule options
To schedule an import, configure the following options:
- Block: Select the Block you want to populate during the import.
Only Blocks with an import configuration using the a Pigment connector will be available.
- Configuration: Select the Import configuration you want to trigger.
- 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.
- Repeat: Select the frequency of this import.
You can configure up to 4 different schedules on a given import configuration.
- Import Notifications (optional): 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.
a. Notify about. Select which import status will trigger a notification Failed, Failed and partial, or All imports.
b. Send notification to. Select the Members you wish to send a notification to. - Click on 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.
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 Import Scheduling page to monitor your scheduled imports.
Add new scheduling option or run import now
| Each section represent an import configuration. Below each of those import configuration, we list all scheduling configuration associated to this import configuration. You can use the “Start an import right now” option to trigger the import directly from that page. | 
|
Manage scheduling configurations
Next to each scheduled configuration is a toggle switch, you can use this turn a scheduling configuration on or off 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
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 which 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 email notification will be sent if the “Failure Alerts” option was enabled. Check the history to get more details on the root cause of this failure. Once the problem is solved, click on Run Again to confirm that the problem is solved and flag back the import configuration to a Success status.
