Blueshire Services
Scheduler FE
Technical Documentation of
Parameter File - SchedFileData.csv
Table of Contents
The Row 01 Entries - Colour Definitions
The Row 02 Entries - Screen Definitions
The Row 03 Entries - The Tab Definitions
The Row 04 Entries - The Screen Objects
The Row 05 Entries - Columns Updateable
The Row 06 Entries - Column Pull Down Lists
The Row 07 Entries - Permissions
The Row 08 Entries - The Non-Default Parameter Values
Appendix B - The Valid Security Data Set
Appendix C - The Non-Default Parameter Values
The Scheduler FE system is more then a front end for the Scheduling module of the Oracle database. It is a front end that can be tailored to the individual requirements. There are two aspects of the Scheduler FE that can be tailored. These are :-
The system uses a flat file, SchedFileData.csv, that contains the parameter data. Each row in the file contains a key that occupies the first two characters. These two characters define the row and categorise it into the following row type entries :-
For each of the row types a section has been written that describes the function of that row type and the entries that make up the row entry.
The Row 01 Entries - Colour Definitions
The row 01 entries in the flat file are those that define the colours that are used in the different screen displays. Each colour is uniquely defined by a number, the Colour No. The actual colour is made up of the next four values, the red, green, blue and alpha. The final value is a description of the colour and is there for documentation purposes.
| Row 01 - Colour Entries | ||
| Row Id | Number | 01 |
| Colour No | Number | Unique number |
| Red | Number | 0 - 255 |
| Green | Number | 0 - 255 |
| Blue | Number | 0 - 255 |
| Alpha | Number | 0 - 255 |
| Colour Desc. | Character | n/a |
Row types 02 and 04 reference the Colour No. from this row type, type 01.
The Row 02 Entries - Screen Definitions
The row 02 entries in the flat file are the entries that define a distinct screen. Each row entry defines a separate screen and the first value is an id that uniquely defines that screen. The complete list of screens is given in Appendix A together with its screen id and the database view where its data is accessed from if applicable.
| Row 02 - Screen Id Entries | ||
| Row Id | Number | 02 |
| Screen Id | Number | Unique number |
| Screen Desc. | Character | n/a |
| Foreground Colour | Number | Valid Colour identifier |
| Background Colour | Number | Valid Colour identifier |
| Tab Colour | Number | Valid Colour identifier |
The foreground, background and tab colour numbers are numbers that uniquely identify a colour from the 01 row type rows.
The Row 03 Entries - The Tab Definitions
For each of the Tab entries, the screen_id identifies the screen to which it applies and the tab_id identifies the tab within that screen. The screen_id/tab_id must uniquely identify the row. The tab_description is the text that appears on the tab at the top of the data section of the screen.
| Row 03 - Tab Entries | ||
| Row Id | Number | 03 |
| Screen Id | Number | Number Id and Tab Id to be unique. |
| Tab Id | Number | Number Id and Tab Id to be unique. |
| Tab Description | Character | n/a |
For each row in this table there is a tab in the specified screen. If there are three rows identified by one screen id then there will be three tabs for that screen. The tab entries only apply to the screen ids 2 to 16, the screens that display the data from the database views. Any entries for the data input screens will be ignored.
The Row 04 Entries - The Screen Objects
The 04 entries relate to the objects found on the screen. Each row corresponds to a screen object, either a label, a test item or a text area.
The table scheduling_pages is the most complex of the setup tables. There is an entry in this table for each item on the screen. The screen_id column identifies the screen no. The column row_type identify whether the item is a label, value 1, or a text item, value 2 or a text area, value 3. The tab id column identifies the tab page that the item is located on. The screen id/tab id must match the screen id/tab id in the row 03 type entry. The object id column must contain a number that is unique for this object on this screen. The following column is not used.
The columns x_point, y_point identify where on the screen the object is position. The columns x_pixels, y_pixels, define the height and width of the individual item. The column description will contain the value displayed on the screen if the entry is a label, otherwise it is used solely for documenting the item. The columns font, font_size and font_style define the font characteristics. The column font_style can contain the values, 1(standard), 2(italic) or 3(bold).
The columns fgrnd_colour and bgrnd_colour define the colour ot the item, both background and foreground colour. The value entered must be a numeric number that corresponds with a colour in the table scheduler_colors. The column format_type should be set to 0 (zero) if the item is a text item and 1 if it is numeric. It will cause the item to be right justified as you would expect a number to be. The column button is set to "Y" when a zoom button is to be displayed to the right of the text. This allows a dialogue showing a far greater amount of text to be displayed. The final two columns display relate to the display of pull down lists. If the Pull Down List column is set to Y then a pull down list is displayed when the column is updated. The number of the pull down list is given in the final column. If this number is below 50 then the pull down list is created from the Row 06 entries. If it is 50 or over then one of the following standard pull down lists is used.
| Row 04 - Screen Objects | ||
| Row Id | Number | 04 |
| Screen Id | Number | n/a |
| Row Type | Number | 1, 2, or 3 |
| Tab Id | Number | n/a |
| Object Id | Number | n/a |
| Undefined | n/a | n/a |
| X Point in pixels | Number | n/a |
| Y Point in pixels | Number | n/a |
| Length in pixels | Number | n/a |
| Height in pixels | Number | n/a |
| Description | Character | n/a |
| Font Name | Character | Valid font name. |
| Font Size | Number | Valid font size. |
| Font Style | Number | 1, 2, or 3 |
| Foreground Colour | Number | Valid Colour No. |
| Background Colour | Number | Valid Colour No. |
| Format Type | Number | 0 or 1 |
| Button | Character | Y/N - Display a button after the object. |
| Display | Character | Y/N - Display the item. |
| Pull Down List | Character | Y/N - Display a pull down list. |
| Display | Number | Valid Pull Down List number. |
The columns fgrnd_colour and bgrnd_colour define the colour ot the item, both background and foreground colour. The value entered must be a numeric number that corresponds with a colour in the table scheduler_colors. The column format_type should be set to 0 if the item is a text item and 0 (zero) if it is numeric. It will cause the item to be right justified as you would expect a number to be. The column button is set to "Y" when a zoom button is to be displayed to the right of the text. This allows a dialogue showing a far greater amount of text to be displayed. The final two columns display relate to the display of pull down lists. If the Pull Down List column is set to Y then a pull down list is displayed when the column is updated. The number of the pull down list is given in the final column. If this number is below 50 then the pull down list is created from the Row 06 entries. If it is 50 or over then one of the following standard pull down lists is used.
| Standard Pull Down Lists | ||
| 50 | Resource Plan | |
| 51 | Resource Consumer group | |
| 52 | Job Class | |
The Row 05 Entries - Columns Updateable
The Row 05 entries define the text items that can be updated. The screen Id and item id define the item and the table name and column name link that item to an entry within a scheduler view. Only the items entered in the 05 entries can be updated. To restrict the user further then the specific entries can be removed from the parameter file.
| Row 05 - The columns that are Updateable | ||
| Row Id | Number | 05 |
| Screen Id | Number | n/a |
| Item Id | Number | n/a |
| Table Name | Character | n/a |
| Column Name | Character | n/a |
| Column Name as Displayed | Character | n/a |
| Type of Update | Character | B, S, T or L |
The Row 06 Entries - Column Pull Down Lists
The row 06 entries define the pull down lists and the values within the pull down lists that the user can select from when a value is being updated or inserted. The pull down list number is the number of the pull down list identified in the row type 04 when associating a pull down list with a displayable text item. The list id is the number of the list item and the pull down list id and list id uniquely identify the entry. The description is the description is the value displayed in the pull down list. It is possible to restrict values entered into a column by editing the pull down list.
| Row 06 - The columns that are Updateable | ||
| Row Id | Number | 06 |
| Pull Down List Id | Number | n/a |
| List Id Number | Number | n/a |
| List Item Description | Alpha Numeric | n/a |
The Row 07 Entries - Permissions
The 07 row entries are a security feature that prevent the user accessing functionality. Entries with this row type restrict a user from performing a specific function. In the default parameter file there are no 07 row entries and this is because there is no restrictions within Scheduler FE for the default user. Should you wish to prevent a user from carrying out specific functions then entering 07 type rows can achieve this. The combination of screen no. and option no together with a description of the restriction is given in Appendix B. The third entry in the row, the description is solely for descriptive purposes and serves no function.
| Row 07 - Permissions | ||
| Row Id | Number | 07 |
| Screen_No | Number | n/a |
| Option_No | Number | n/a |
| Description | Character | n/a |
The Row 08 Entries - The Non-Default Parameter Values
The 08 row entries are for when there exist the need to change the default values of certain parameters.
When you wish to change the default value of a parameter then a row for the entry can be entered. Appendix C gives the details of the parameters that can be set. It also gives the default value if the entry is not set. An example of a row entry would be as follows:-
08,02,c:\Work\SchedErrors.log,Entry to reset the Error file
This entry would reset the directory of the error file but retain the existing default name of the file.
| Row 08 - Non-Default Parameter Values | ||
| Row Id | Number | 08 |
| Parameter Id | Number | n/a |
| Parameter Value | Character | n/a |
| Description | Character | n/a |
The table below identifies the Screen name together with the screen no. and gives the database view that the data is obtained from.
| Data Block Screens | ||
| Screen Block | Screen No | Database View |
| Jobs | 2 | Dba_Scheduler_Jobs |
| Programs | 3 | Dba_Scheduler_Programs |
| Schedules | 4 | Dba_Scheduler_Schedules |
| Job Classes | 5 | Dba_Scheduler_Job_Classes |
| Windows | 6 | Dba_Scheduler_Windows |
| Window Groups | 7 | Dba_Scheduler_Window_Group_Members |
| Job Arguments | 8 | Dba_Scheduled_Job_Args |
| Program Arguments | 9 | Dba_Scheduler_Program_Args |
| Jobs Running | 10 | Dba_Scheduler_Running_Jobs |
| Chains | 11 | Dba_Scheduler_Chains |
| Chain Steps | 12 | Dba_Scheduler_Chain_Steps |
| Chain Rules | 13 | Dba_Scheduler_Chain_Rules |
| Jobs Completed | 14 | Dba_Scheduler_Job_Run_Details |
| Global Attributes | 15 | Dba_Scheduler_Global_Attributes |
| Chains Running | 16 | Dba_Scheduler_Running_Chains |
| Create Job | 100 | n/a |
| Create Job with Program & Schedule | 101 | n/a |
| Create Job with Named Program | 102 | n/a |
| Create Job with Named Schedule | 103 | n/a |
| Create Job with Event | 104 | n/a |
| Create Job with Event and Name | 105 | n/a |
| Create Program | 106 | n/a |
| Create Schedule | 107 | n/a |
| Create Event Schedule | 108 | n/a |
| Create Job Class | 109 | n/a |
| Create Window with Named Schedule | 110 | n/a |
| Create Window with Inline Schedule | 111 | n/a |
| Create Window Group | 112 | n/a |
| Create Job Argument | 113 | n/a |
| Create Program Argument | 114 | n/a |
| Create Chain | 115 | n/a |
| Create Chain Rule | 116 | n/a |
| Create Chain Step | 117 | n/a |
| Create Event Chain Step | 118 | n/a |
| Create Event Chain Step with a Schedule | 119 | n/a |
Appendix B - The Valid Security Data Set
| Table - Scheduler_Security | |||||
|---|---|---|---|---|---|
| Screen No | Option No | Description | Screen No | Option No | Description |
| 2 | 1 | Job - Display | 3 | 1 | Program - Display |
| 2 | 2 | Job - Create | 3 | 2 | Program - Create |
| 2 | 3 | Job - Drop | 3 | 3 | Program - Drop |
| 2 | 4 | Job - Update | 3 | 4 | Program - Update |
| 2 | 5 | Job - Enable | 3 | 5 | Program - Enable |
| 2 | 6 | Job - Disable | 3 | 6 | Program - Disable |
| 2 | 7 | Job - Run | . | . | . |
| 2 | 8 | Job - Stop | . | . | . |
| 4 | 1 | Schedule - Display | 5 | 1 | Job Class - Display |
| 4 | 2 | Schedule - Create | 5 | 2 | Job Class - Create |
| 4 | 3 | Schedule - Drop | 5 | 3 | Job Class - Drop |
| 4 | 4 | Schedule - Update | 5 | 4 | Job Class - Update |
| 6 | 1 | Window - Display | 7 | 1 | Window Group - Display |
| 6 | 2 | Window - Create | 7 | 2 | Window Group - Create |
| 6 | 3 | Window - Drop | 7 | 3 | Window Group - Drop |
| 6 | 4 | Window - Update | 7 | 4 | Window Group - Update |
| 6 | 5 | Window - Enable | 7 | 5 | Window Group - Enable |
| 6 | 6 | Window - Disable | 7 | 6 | Window Group - Disable |
| 6 | 7 | Window - Open | . | . | . |
| 6 | 8 | Window - Close | . | . | . |
| 6 | 9 | Window - Assign to Group | 11 | 1 | Chain - Display |
| 6 | 10 | Window - Remove from group | 11 | 2 | Chain - Create |
| 9 | 1 | Program Argument - Display | 11 | 3 | Chain - Drop |
| 9 | 2 | Program Argument - Create | 11 | 4 | Chain - Update |
| 9 | 3 | Program Argument - Drop | 11 | 5 | Chain - Enable |
| 9 | 4 | Program Argument - Update | 11 | 6 | Chain - Disable |
| 12 | 1 | Chain Step - Display | 13 | 1 | Chain Rule - Display |
| 12 | 2 | Chain Step - Create | 13 | 2 | Chain Rule - Create |
| 12 | 3 | Chain Step - Drop | 13 | 3 | Chain Rule - Drop |
| 12 | 4 | Chain Step - Update | 13 | 4 | Chain Rule - Update |
| 8 | 1 | Job Argument - Display | 10 | 1 | Jobs Running - Display |
| 8 | 3 | Job Argument - Drop | 14 | 1 | Job Run Logs - Display |
| 8 | 4 | Job Argument - Update | 15 | 1 | Global Attributes - Display |
| 16 | 1 | Chains Running - Display | 15 | 2 | Global Attributes - Update |
| 20 | 10 | Purge Logs | . | . | . |
| 30 | 10 | Do Not Output Audit Log | . | . | . |
Appendix C - The Non-Default Parameter Values
| Non-Default Parameter Values | ||
| Parameter Id | Parameter Description | Default Value |
| 1 | Directory/File name of Init file. | SchedFileInit.csv |
| 2 | Directory/File name of Error file. | SchedErrors.log |
| 3 | Directory/File name of Audit file. | SchedAudit.log |