Managing Requests

A request is the individual work unit that will be executed by the Cantara Scheduler. Currently you can add either Cantara Report Services or Cantara Extension Services to the scheduler as a request.

Defining a Report Request

1. Select the Reports node in the navigation panel.
2. Select the report for which you want to add a schedule.
3. Click the Add to Scheduler button.
   

   

4. Specify a name for the request and press Save
   

   

5. Define the request:
   
   • Request Name: The name you want to assign to the request. You can enter the exact name of the Cantara Report or create one that is more meaningful to you. The value for this field can be a maximum of 40 characters (no spaces). Valid characters include numbers, letters, and a dash (-). 
   • Batch Queue: The batch queue can be left as the default from the report or alternatively it can be overridden for the request.
   • Print Immediate: Selecting this option will cause the UBE to be submitted with the print immediate option selected.
   • Create CSV: Selecting this wil cause the CSV output to be generated by the UBE.
   • Email Output: The output from the UBE, both PDF and CSV, can be sent to one or more email destinations. To enter multiple email addresses simply separate each address with a semi-colon. This field supports Cantara Variables.
   • Report Output: The output from the UBE, both PDF and CSV, can be save to a specific folder path. The method of transfer and credentials are defined in the Environment Definition.
   • You can add Tags to your request to assist with management of scheduler components. You can select from the existing tags or add a new tag by entering it in the New Tag field and clicking the + button.
6. Each  processing option, report interconnect and data selection can be modified to suit your specific requirements. These values will override the values set in the Cantara Report unless blind execution has been selected on the report definition. All values within these sections support the use of Cantara Variables.
   

   

7. Click the Save Request button to save the request.
8. If the base Cantara Report definition has changed you can click on the Refresh Requestbutton to get an updated definition for the request.

Defining an Extension Request

1. Select the Extenions node in the navigation panel.
2. Select the report for which you want to add a schedule.
3. Click the Add Schedule button.
   

   

   
   

   

4. Define the request:
   
   • Request Name: The name you want to assign to the request. You can enter the exact name of the Cantara Report or create one that is more meaningful to you. The value for this field can be a maximum of 40 characters (no spaces). Valid characters include numbers, letters, and a dash (-). 
   • You can add Tags to your request to assist with management of scheduler components. You can select from the existing tags or add a new tag by entering it in the New Tag field and clicking the + button.
5. Enter the JSON extension request payload required for the Extension to execute correctly.
   

   

6. Click the Save Request button to save the request.
7. If the base Cantara Report definition has changed you can click on the Refresh Requestbutton to get an updated definition for the request.

Modifying Requests

To edit a request

1. Select the Scheduler nodes in the navigation panel.
2. Select the request you want to edit.

3. Make the required changes and click the Save Request button.

To delete a request

Note

You cannot remove a request that is part of a group or that is currently running. To remove a request that is part of a group, you must first remove it from the group.

1. Select the Scheduler nodes in the navigation panel.
2. Activate the selection mode by clicking on the Hand icon in the top right
3. Select the required request / requests for deletion.
   

   

4. Press the Trash can icon to delete
   

   

5. Confirm the deletion.