Scheduled Actions

Prev Next

Scheduled Import

Action type "Scheduled Import" allows to configure actions that will perform import based on the configured schedule. This action type can be used as a replacement of the scheduler as it allows the following import types:

  • HTTP Import

  • FTP Import

  • File system import

HTTP import allows to import from both: sources that requires authentication and those that do not.

For HTTP source that requires authentication, configured Oauth2/Custom Headers connected services are used.

For FTP Import, FTP connected service is used.

Import from File System does not require authentication.

All 3 import types (HTTP, FTP, File System) are relying on the import configuration.

Configuration


Configuration of the scheduled actions requires the following steps:

  • Configuration of field import

  • Configuration of the connected service for the import requiring authentication (HTTP, FTP)

  • Action  configuration

Field Import Configuration

As mentioned previously scheduled import actions rely on field import configuration to be present. All the configuration settings and supportable import formats(xml and csv) are valid for scheduled import.

The only settings not relevant to scheduled import actions are: "Run import scheduled" and "Seconds between import"

Import configuration user guide is available here.

Connected Service Configuration

As mentioned before, "Custom Headers" and "Oauth2" are the 2 connected services that can be used for authenticating with HTTP import source.

Follow the link to get the guide on "Oauth2" connected service configuration steps.

Configuration guide for the FTP connected service is available here.

Action Configuration

To configure scheduled import action, perform the following steps:

  1. Go to Module > Actions and click "Create Actions".

  2. Specify action name in the "Name" field.

  3. Select "Scheduled" in the "Event" select box.

  4. Select "Scheduled Import" in the "Action" select box.

  5. Configued import interval in the "Type of Schedule" section.

  6. Select one of the 3 import types

Depending on selected import type, different configuration options will be displayed

Import Type

Action settings

HTTP URL

  • Import Setting (*required) - list of configured field imports in Module > Import

  • Connected Service - list of configured "Oauth2"/"Custom headers" connected services configured in Site Configuration > Connections > Connected Services

  • HTTP Method (*required) - GET/POST

  • Remote path - path to the HTTP source

SFTP/FTP Folder

  • Import Setting (*required) - list of configured field imports in Module > Import

  • Connected Service - list of FTP connected services in Site Configuration > Connections > Connected Services

  • Remote Folder - folder contianing import files on remote FTP server

  • Remote Files Regexp - regular expression to filter files for import

More configuration details available here.

Server Filesystem

  • Import Setting (*required) - list of configured field imports in Module > Import

After all Scheduled Import configuration options has been specified, save the action. Action will be executed respecting configured schedule.

Logging and Monitoring

The executeScheduledPersistentActions queue allows monitoring scheduled import progress.

Import log for each configured import used in scheduled import action settings will display the result of import performed/failed and status on the created/updated items. Import file can be downloaded.

Known Limitations:

  • Hourly type of schedule: '0' value cannot be inserted into minutes field if was change before;

  • Translations are not available for the Type of Schedule options, hints and validation errors;

  • Missing indent before and after ‘hour’ text for Hourly type of schedule;

  • Hourly type of schedule: any change applied for minutes in ‘At hh mm’ menu reflects in ‘Every’ menu