Export Schedule Definitions

Export PBRS schedule definitions to a local file or another PBRS environment through the REST API. Check dependencies and verify transferred schedules.

Use the PBRS Schedule Export Wizard to transfer schedule definitions between PBRS environments or prepare them for a separate import workflow.

A schedule definition describes how PBRS runs and delivers a report or other scheduled task. Exporting it does not replace a backup of the PBRS database or the external resources used by the schedule.

Choose an export destination

The wizard provides two destination options:

OptionPurpose
Local FileSystemExport to a local file for separate handling
Use REST API for ExportTransfer the selected schedule to a destination system through its PBRS API

The REST API workflow supports all PBRS schedule types, with one schedule exported at a time.

Before you begin

Identify the source PBRS installation and the destination environment.

For a REST API transfer, confirm that:

  • The destination PBRS API service is installed and running.
  • The source machine can reach the destination API address.
  • An API client is configured on the destination.
  • You have the destination client’s ID and secret.
  • The destination permits the required schedule changes.

Record the PBRS build used in each environment. Validate compatibility before transferring production schedules between different builds.

Review external dependencies

A schedule can depend on resources outside its exported definition. Check the dependencies that apply to your schedule.

DependencyWhat to verify in the destination environment
Reporting accountsAccounts exist and can access the required reports
Reports and workspacesReport locations, URLs, paths, and permissions are valid
Database connectionsRequired databases, DSNs, drivers, and credentials are available
Email deliveryMail configuration, sender permissions, and recipients are correct
Disk and network pathsPaths exist and are accessible to the execution account
Templates and supporting filesRequired files are available at valid locations
Calendars and recurrenceReferenced calendars and scheduling settings are appropriate
Tasks and event resourcesRequired programs, files, connections, and monitored resources are available

Do not assume that transferring a definition provisions these resources or grants access to them.

Plan the execution state

Before transferring a live schedule, decide when the destination should begin running it.

Account for the source schedule’s enabled state, recurrence, event triggers, and delivery destinations. Coordinate the transfer so that the source and destination do not unintentionally deliver the same reports.

Export through the REST API

Perform these steps in the source PBRS application:

  1. Open the System tab.

  2. Select Export Schedules.

  3. Select one schedule.

  4. Click the right arrow to move it into the export selection.

  5. Click Next.

  6. Select Use REST API for Export.

  7. Enter the destination connection details:

    FieldValue
    Client AddressDestination PBRS API address
    Client IDAPI client ID configured on the destination
    Client SecretSecret for that destination API client
  8. Click Retrieve Token.

  9. After authentication succeeds, click Next.

  10. Review the export stage and click Finish.

  11. Wait for the success confirmation, then click OK.

Repeat the workflow for each additional schedule.

The PBRS export walkthrough illustrates these wizard screens.

Verify the transferred schedule

Open the receiving PBRS installation and locate the resulting schedule.

Verify the saved configuration independently of the wizard’s success message.

AreaChecks
IdentityName, schedule type, folder, and destination identifier
ExecutionEnabled state, recurrence, next run, and applicable event triggers
Report sourceReporting account, workspace, report URL, or report path
Report selectionFilters, parameters, bookmarks, and page selection
OutputFormat, filenames, rendering settings, and applicable merge settings
DeliveryRecipients, sender settings, disk paths, and other destinations
Data driverSource, query or row data, credentials, and mappings
Package membershipIncluded reports, member settings, and ordering
Additional behaviorApplicable tasks, alerts, refresh settings, and supporting resources

Destination identifiers can differ from source identifiers. Record the destination values rather than assuming the original IDs were preserved.

Run a controlled test

Before allowing production delivery:

  1. Resolve any environment-specific account, path, or connection differences.
  2. Use an approved test recipient or output location.
  3. Execute the schedule.
  4. Inspect the execution result.
  5. Open the generated output and verify its content.
  6. Confirm delivery to the intended destination.
  7. Set the required production destinations and enabled state.

For a package or data-driven schedule, verify each report and recipient mapping. A successful execution status alone does not establish that every recipient received the correct content.

Handle exported files

When using a file-based workflow, retain the original PBRS-generated export unchanged. Make a separate working copy if migration requires adjustments.

Treat exported definitions as sensitive configuration. Depending on the schedule, they can contain connection details, credentials, recipients, queries, paths, and other operational information.

Store exports in an access-controlled location. Do not place unredacted exports in public repositories, documentation examples, or broadly shared tickets.

Record:

  • Source PBRS build.
  • Export date.
  • Source schedule name and identifier.
  • Schedule type.
  • Intended destination.
  • Required dependencies.
  • Any changes made to the working copy.

Do not assume that an export produced by one PBRS build is compatible with every other build.

Use the correct payload for programmatic import

The public programmatic import operation is:

POST /api/Schedule/importScheduleJSON

It accepts a compatible PBRS-exported definition.

A response from a schedule or package Get endpoint is not a complete export and must not be substituted for the exported import payload. Authoring requests used to create individual schedules are also different from exported definitions.

The public API does not expose a corresponding schedule-export endpoint. Use the PBRS export workflow to obtain or transfer the definition.

Programmatic import requires its own dependency mapping, response handling, and post-import verification. Importing schedules is separate from migrating the underlying PBRS database.

Recover from an interrupted transfer

If authentication, transfer, or confirmation fails:

  1. Record the error and the selected source schedule.
  2. Check the destination before repeating the export.
  3. Determine whether a schedule or related records were created.
  4. Compare any resulting schedule with the intended configuration.
  5. Resolve partial or duplicate results before retrying.

Do not assume that a failed or interrupted operation made no changes. Repeating a transfer is not a guaranteed update or overwrite operation.

Keep the source schedule available until destination validation and cutover are complete. Remove or disable the source only according to the agreed migration plan.

Troubleshooting

ProblemWhat to check
Token retrieval failsDestination API address, service availability, client ID, and client secret
The source cannot reach the APIDNS, port, firewall, and applicable HTTPS configuration
The export reports success but the schedule cannot be foundConfirm the receiving PBRS instance and inspect its folders and schedules
The transferred schedule cannot access a reportDestination reporting account, report location, and permissions
A data-driven schedule failsDSN, database access, credentials, query, and required driver configuration
Output cannot be writtenDestination path and execution-account permissions
A schedule runs unexpectedly after transferEnabled state, recurrence, event triggers, and next run
Duplicate schedules appearRepeated transfers following an uncertain outcome
The transferred schedule behaves differentlyBuild compatibility, omitted dependencies, and environment-specific settings

Did this page help you?