Skip to content
English
Log a Support Call Customer portal
  • There are no suggestions because the search field is empty.

Export and Migrate ATRS Schedule Definitions

ATRS allows you to export schedule definitions and migrate them to another ATRS installation using the ATRS REST API. This is useful when moving schedules between environments, such as from a test or development environment to a production environment, or when transferring schedule configurations between ATRS servers. The Export Schedules wizard guides you through selecting the schedule to export, connecting to the destination ATRS API, and transferring the schedule definition.

Before You Begin

Before exporting and migrating a ATRS schedule definition, make sure:

  • ATRS is installed and accessible on both the source and destination environments.
  • The ATRS API is configured and running on the destination environment.
  • You have the connection information required to access the destination ATRS API.
  • You have access to the schedule you want to migrate.
  • Any resources used by the schedule, such as Tableau accounts, database connections, destinations, or other environment-specific settings, are available and correctly configured on the destination ATRS installation.

Important: Exporting a schedule transfers the schedule definition. Environment-specific resources and configuration referenced by the schedule may need to be configured separately on the destination ATRS installation.

Note: Schedules are exported individually. If you need to migrate multiple schedules, repeat the export process for each schedule.

Export the Schedule Definition

To export a schedule definition from ATRS:

  1. Open ATRS.
  2. From the main menu, select the System tab.
  1. Select Export Schedules.

  2. The Export Schedules window opens. Use this window to configure the schedule export and migration.

The REST API option allows ATRS to send the selected schedule definition to another ATRS installation.

Note: Only the selected schedule is exported. To migrate additional schedules, repeat this process for each schedule.

Select the Schedule to Migrate

The Select Schedules screen displays the schedules available in the source ATRS installation. Use this screen to select the schedule definitions you want to migrate.

  1. Browse the folder structure on the left to locate the schedule you want to migrate.
  2. Select the required schedule.
  3. Select the right arrow to move the schedule to the selection panel on the right.




  4. Review the schedules displayed in the right panel to make sure you have selected the correct schedules.
  5. To remove a schedule from the selection, select it in the right panel and select the left arrow.
  6. Select Next to continue.

Important: When migrating schedules using the REST API, only one schedule can be exported at a time. To migrate additional schedules, complete the export process and then repeat the procedure for each additional schedule.

Configure the Destination System

On the Destination System screen, specify how ATRS will connect to the destination environment. To migrate the selected schedule directly to another ATRS installation, use the REST API option.

  1. Under Select the destination system's connection type, select Use REST API for Export.
  2. In the ATRS API section, enter the connection details for the destination system:
    • Client Address — Enter the address of the destination ATRS API.
    • Client ID — Enter the Client ID used to authenticate with the destination API.
    • Client Secret — Enter the Client Secret associated with the Client ID.
  3. Select Retrieve Token.
  4. ATRS uses the supplied credentials to request an authentication token from the destination system.
  5. Confirm that a value appears in the Token field.
  6. Select Next to continue.

Important: The ATRS API must be configured and accessible on the destination system, and the Client ID and Client Secret must be valid before ATRS can retrieve a token.

Export the Schedule

The Do Export screen confirms that ATRS is ready to export the selected schedule to the destination system.

  1. Review the previous selections and connection information if necessary.
  2. Select Finish to begin the export process.
  3. ATRS exports the selected schedule definition to the destination ATRS installation using the REST API.
  4. Wait for the export process to complete.

Important: Selecting Finish initiates the migration. Make sure the correct schedule and destination system have been selected before proceeding.

Confirm the Schedule Export

When the migration completes successfully, ATRS displays a confirmation message showing the number of schedules exported.

  1. Confirm that the message “1 schedules exported successfully” appears.

  2. Select OK to close the confirmation message.
  3. Close the Schedule Export Wizard when complete.

Because REST API migration supports only one schedule at a time, the successful export should report 1 schedule exported successfully.

The schedule definition has now been exported. Before using it in another environment, review the dependencies and validation steps below.

Scope and Limitations

This workflow supports all ATRS schedule types, but when using the REST API, schedules must be exported individually. The REST API workflow does not provide a bulk-export operation.

To migrate multiple schedules, repeat the export process for each schedule.

Before Migrating to Another ATRS Environment

Before migrating a schedule, review the destination ATRS environment and:

  • Confirm that the required Tableau accounts exist in the destination environment, as applicable.
  • Confirm that the required destination folders and delivery accounts are configured.
  • Identify any environment-specific URLs, credentials, recipients, file paths, and server assignments.
  • Record the ATRS build used by the source and destination environments.
  • Use controlled recipients and destinations for the first execution after migration.

Important: Exporting a schedule transfers the schedule definition. Environment-specific resources or configuration referenced by the schedule may need to be configured or updated separately in the destination ATRS environment.

Validate the Migrated Schedule

After the export completes successfully, verify the migrated schedule in the destination ATRS environment.

  1. Open the migrated schedule in the destination ATRS environment.
  2. Confirm its folder, name, schedule type, enabled state, recurrence, report, filters, parameters, rendering settings, outputs, and destinations, as applicable.
  3. Replace any environment-specific values and credentials that need to be changed for the destination environment.
  4. Run the schedule using controlled data, recipients, and destinations.
  5. Verify that the expected report content is generated and delivered to the correct location.
  6. Record the migration result and any manual corrections made to the schedule.

Tip: For a newly migrated schedule, manually Execute and verify it before relying on its automatic scheduling.

Detailed API documentation

For complete export and migration guidance, see:

Export Schedule Definitions

Import and Migrate Schedule Definitions

Troubleshooting

Unable to Retrieve a Token

Possible cause:
The ATRS API service on the destination server is not running.

Resolution:

  • Confirm that the ATRS API service is running on the destination server.
  • If the service is stopped, start or restart it.
  • Return to the Destination System screen and select Retrieve Token again.
  • If the service will not start, review the Windows account configured to run the ATRS API service.

ATRS API Service Will Not Start

Possible cause:
The Windows account configured to run the ATRS API service may no longer be able to start the service. For example, the account password may have expired or changed.

Resolution:

  1. Make sure only one instance of ATRS is running on the server.
  2. In ATRS, go to Options > REST API.
  3. Uninstall the REST API.
  4. Reopen Options > REST API and reinstall the REST API.
  5. Select the appropriate Windows account to run the service.
  6. Confirm that the ATRS API service starts successfully.
  7. Retry Retrieve Token.

Note: Existing API Clients, Client IDs, and Client Secrets can remain in place when reinstalling the REST API.

Connection Is Refused or Reset

Possible cause:
ATRS cannot establish a connection to the REST API service. This may result in connection refused, connection reset, or closed connection errors.

Resolution:

  • Confirm that the ATRS API service is running.
  • Verify the Client Address entered in the Schedule Export Wizard.
  • Confirm that the configured REST API port is accessible between the source and destination environments.
  • Check firewall and network rules that could block the connection.
  • Test API connectivity independently before attempting the migration again.

Token Cannot Be Retrieved Using the Client Credentials

Possible cause:
The Client ID or Client Secret entered in the Schedule Export Wizard does not match a valid API Client on the destination ATRS environment.

Resolution:

  • Recheck the Client Address, Client ID, and Client Secret.
  • Confirm that the API Client exists on the destination ATRS environment.
  • Re-enter the credentials to eliminate copying or whitespace errors.
  • Confirm that the ATRS API service is running.
  • Select Retrieve Token again.

The Schedule Exports but Does Not Work Correctly in the Destination Environment

Possible cause:
The schedule definition migrated successfully, but one or more resources referenced by the schedule are specific to the source environment.

Resolution:

  • Open the migrated schedule and review its configuration.
  • Verify the report or report server.
  • Verify the required Tableau accounts, as applicable.
  • Check database connections and credentials.
  • Review filters and parameters.
  • Check file paths, URLs, recipients, and server assignments.
  • Verify each configured destination.
  • Manually Execute the migrated schedule using controlled recipients and destinations before relying on automatic scheduling.

REST API Functions Behave Differently After an Upgrade or Migration

Possible cause:
The source and destination environments may be running different ATRS builds, or REST API functionality may have changed between releases.

Resolution:

  • Check the ATRS build installed on both environments.
  • Where possible, use compatible/current ATRS builds on the source and destination environments.
  • Review the relevant ATRS release notes for REST API changes.
  • Test the REST API connection and schedule migration before migrating additional schedules.
  • If necessary, update ATRS and retest the migration.

The Migrated Schedule Cannot Find Required Resources

Possible cause:
Resources referenced by the schedule do not exist in the same location or configuration in the destination ATRS environment.

Resolution:

  • Review the migrated schedule using the Validate the Migrated Schedule section above.
  • Confirm the report and folder locations.
  • Update environment-specific paths and URLs.
  • Confirm that the required accounts and credentials exist on the destination system.
  • Refresh or reselect report resources where necessary.
  • Check the ATRS Error Log for the specific resource or configuration that could not be found.

Need Additional Help?

If the issue continues after completing these troubleshooting steps, check the ATRS Error Log and record any error messages generated during the export or when executing the migrated schedule.

When contacting ChristianSteven Support, include the ATRS build numbers for the source and destination environments, the error message or relevant Error Log entries, whether Retrieve Token succeeds, whether the ATRS API service is running, the schedule type being migrated, whether the export completes successfully, and screenshots of the relevant Schedule Export Wizard screen where appropriate.

Log a Support Call