Document Schedulers Library

The Document Schedulers Library is a collection of document schedulers owned by a user.
A document scheduler is a set of document specifications with an associated time setting. The document specifications contained by a document scheduler will be automatically run at the time specified in the time setting.

Scheduler actions

Create document scheduler

To create a document scheduler, click on the Create… button from the Document Schedulers panel.

The following dialog will be displayed:

Insert a name and an optional description for the scheduler. If a scheduler with that name already exists, the user will be prompted to insert a different one and try again.
When the Create button is pressed, the document scheduler is saved in the Document Schedulers Library.

Load document scheduler

There are two ways to load a document scheduler:

1. Select the document scheduler that you want to load and double-click on it. The document scheduler will be loaded in the Document Scheduler Workbench panel.
2. Select the document scheduler that you want to load, click on it, and the tool tip dialog will be opened. Select the Load button.

When a document scheduler is loaded, the user can view all the document specifications associated with it.
The properties of each document specification can be seen by selecting the document specification in the Document Scheduler Workbench panel.

Delete document scheduler

Select the document scheduler that you want to delete, click on it, and the tool tip dialog will be opened.

Use the Delete button to delete the scheduler from the Document Schedulers Library.

If you want to delete a document scheduler that was used for generating documents and it appears in the Scheduler Execution history table, you must first remove its entry in the history table, and then try to delete it.

Configure time options for document scheduler

In order to configure time options for a scheduler, you must first load it.
Time options are set from the Document Scheduler Workbench panel.

The following options are available for time scheduler:

1. None: this option removes any schedule set before and no document generation will be run.
2. One time: document generation will be performed only one time, at a date and time chosen by the user.
3. Daily: document generation will be run every day, at the hour chosen by the user.
4. Weekly: document generation will be run every week; the day of the week and time are chosen by the user.
5. Monthly: document generation will be run every month; the day of the month and time are chosen by the user.

The input hour format is HH:MM. In case of a wrong input, an error message will be displayed.

A document scheduler can have associated only one of the above time options.
After time options are configured, select the Save button to save the changes made to the document scheduler.
The Revert button restores the previous configurations of the document scheduler.

View Scheduler properties and settings

Scheduler properties can be viewed in the Properties panel when you select the Scheduler in the Document Scheduler Workbench panel.

The following properties are displayed for a document scheduler:

1. UUID: document scheduler unique identifier
2. description: document scheduler description
3. createdOn: date of creation
4. modifiiedOn: last date of modification
5. owner: document scheduler owner
6. type: time option type (none, one time, daily, weekly, monthly)
7. time options

Add a document specification to scheduler

The document scheduler must first be loaded.
There are two ways to add a document specification to a document scheduler:

1. From the Document Scheduler Workbench panel:

   Select the Document Specifications node, right-click on it, and then select Add Document Specification…

   

   The following dialog will appear:

   

   Select a document specification and press the Add button.

2. From the Document Specifications panel:

   Select the document specification that you want to add, click on it, and the tool tip dialog will be opened. Select the Add to Scheduler button.
   From the Document Specifications panel, you can also double-click the document specification that you want to be added to the scheduler.

   

A user can add to a document scheduler only document specifications belonging to him.

Remove document specification from scheduler

In order to remove a document specification from a scheduler, the scheduler must be loaded into the workbench (see “Load a document Specification section”).
Select the document specification that you want to delete, right-click on it, and then select Remove Document Specification…

After adding or removing a document specification from a document scheduler, you can undo your modifications by clicking the Restore button.
If you want your changes not to be lost, make sure you select the Save button before you load another document scheduler.

A document scheduler that can be run should have at least one document specification.

Document generation

To generate (publish) documents the user should use the Document Scheduler Workbench. This panel is used both to configure and also to publish a document scheduler.

Scheduled document generation

The scheduler checks if there are any document generations programmed every one minute. For this reason, a document generation for a document scheduler may be delayed.
The results of the document generation can be found in the Scheduler Execution table from the History page.

Publish documents

Use Start now button to publish a document scheduler. Once the generation started the execution status will be displayed in the Console Panel.

All the data written by RPE in the log is displayed in the console. The console is used to inform the users about how the extraction goes and about the possible problems which might take place.
The Console Panel contains one button (Clean Console) which allows the user to remove all the text from the console.

When the generation ends, the results and the execution details will be available in the Results Panel.
The Results Panel has 3 states:

1. Empty
   This state is active when the WEB-Publisher is opened and no execution was run in the current session.
2. Running/Waiting
   This state is active when the Web Publisher has an execution running. It displays the status of the execution and the elapsed time.
3. Finished/Canceled/Failed
   This state is active when the execution status has one of the following values: FINISHED, CANCELED or FAILED.

The user can download the results archive by clicking on the results button. Also, the user can download the execution log, by clicking on Log link.

Cancel execution

Use Cancel button to cancel the current execution. When the execution is canceled there are no results available.