Parameters
The Parameters screen lists the parameters that are used throughout the system. Parameters values are used in the system for processing data, and are accessible on the screens where they are used. For example, the parameters defining the attributes of job class codes are found on the Parameters tab in the Job Class configuration screen.
The screen also indicates the application where parameter is used, the field affected, the functionality of the parameter, the type of value required (alpha, numeric, date, integer, etc.) and value values.
A number of parameters are standard with the system, and additional parameters can be created in this screen.
Parameter values are also accessible on the Parameters tab on the screens where they are used. For example, the values defining the attributes of an activity code are found on the Parameters tab in the Activity Code configuration screen. Parameters are grouped together on application Category cards.
Record Management
Depending on the user's authorization level, the following actions may be available. Note: The options listed below are not available for some screens.
Adding a New Record
Authorized users can Add a New Record by completing the following steps:
- Click on the Add button in the left pane to open a configuration screen.
- Enter data in all applicable fields. The fields with an asterisk are required and must be completed before the record can be saved.
- If specific values are required for a field, the valid options are available in one of the following:
- The Field Look Up Values are displayed in the right pane. In most cases, the values available have been previously entered on the related configuration screen.
- The List Selector icon to the right of a field opens a listing of valid values for a field. In most cases, the values available have been previously entered on the related configuration screen.
- The Drop Down Menu arrow to the right of a field opens a menu of valid options for a field. In most cases, the values available are standard core values.
- A Date Selector Calendar is available in the Field Look Up Values in the right pane for date fields. If there is no right pane, the Date Selector icon is displayed to the right of the field.
- Use the online help features for information on configuration of the screen.
- For information on specific fields, highlight the field with the cursor to view the short Help text in the right pane.
- To open the documentation to find more information for the related page, click on the Help icon in the tool bar or click on More... in the right pane after the short help.
- If there are Indicator and/or Parameter tabs, these must be configured as well. Default values are displayed for the indicator settings, but may be changed for this record. For more information see the Configuration section>System card>Indicator screen and/or Parameter screen.
- After entering information, Save the record. The system does a validation to make sure the information entered is valid for the field (e.g. numbers must be entered in numeric fields, fields with look up values must match the options displayed, etc.)
- The Audits tab is now displayed with information on the entered record.
Note: For more information, see Adding a New Record in the Help section>Record Management.
Deleting a Record
Authorized users can Delete existing records. Open records can be deleted by clicking on the Delete or Delete Selected button in the left pane.
To delete one or more records that are not open, complete the following steps:
- From the related screen, conduct a search to locate the records that are to be deleted.
- To select one or more record, click the box to the left of the record to alternately add or remove the check mark. To select/de-select all records in a specific search result set, click on the box above the search results to add or remove all check marks.
- Click on the Delete Selected button.
- If the record code has been assigned to one or more other records (as a field value), an error message is displayed and the record cannot be deleted.
Note: For more information, see Deleting a Record under the Help section>Record Management.
Editing a Record
Authorized users can make Edits to add or update information in existing records.
- Using the Search page selection criteria, search for all the records to be updated.
- To select one or more record, click the box to the left of each record to alternately add or remove the check mark. To select/de-select all records in a specific search result set, click on the box above the search results to add or remove all check marks.and select them by checking the box to the left of the record.
- To open the record you wish to view first, click its folder. All other selected records can be viewed by scrolling, using the right and left arrows in the Navigator section of the left pane.
- Highlight the field(s) to be updated with the cursor and enter the information.
- If the field is grayed out, that field is not editable.
- If specific values are required for a field, the valid options are available in one of the following:
The Field Look Up Values are displayed in the right pane.
The List Selector icon to the right of a field opens a listing of valid values for a field from the related configuration screen.
The Drop Down Menu arrow to the right of a field opens a menu of valid options for a field.
A Calendar is available in the Field Look Up Values in the right pane for date fields. If there is no right pane, the Date Selector icon is displayed.
- For information on specific fields, view the short Help text in the right pane.
- The Indicator and/or Parameter tabs can also be updated. Click on the tab to open and edit the values. For more information see the Configuration section>System card>Indicator screen and/or Parameter screen.
- After entering information, Save the record. The system does a validation to make sure the information entered is valid for the field (e.g. numbers must be entered in numeric fields, fields with look up values must match the options displayed, etc.)
- The Audits tab displays information on the edits made to the record.
Note: For more information, see Editing a Record in the Help section>Record Management.
Opening and Viewing a Record
To Open and View existing records, complete the following steps:
- Using the Search page selection criteria, search for all the records to be viewed.
- To select one or more record, click the box to the left of each record to alternately add or remove the check mark. To select/de-select all records in a specific search result set, click on the box above the search results to add or remove all check marks.
- To open the record you wish to view first, click its folder. All other selected records are also available.
- To view all other selected records, scroll to the previous record or to the next record using the navigation arrows.
- For records displayed in a list format, click the card arrow on a record to open and view it.
Note: For more information, see Opening and Viewing a Record in the Help section>Record Management screen.
Replacing Record Values
Authorized users can use the Replace feature to update multiple selected records at the same time with the same field information or the same indicator and/or parameter values. Note: Not all screens have the Replace feature available.
- Using the Search page selection criteria, search for all the records to be updated. Multiple searches can be conducted to build a results list.
- To select one or more record, click on the box to the left of each record to alternately add or remove the check mark. To select/de-select all records in a specific search result set, click on the box above the search results to add or remove all check marks.
- Click on the Replace button in the left pane.
A screen is displayed with all replaceable fields showing as read only.
- Check the box to the left of a field to be updated. The field is then enabled.
- Enter the new information in the field.
- Update any additional fields in all tabs.
- Values in the Indicator and Parameter tabs can also be updated by entering values in each field.
- To reset all the values back to the previously saved ones, click on the Reset button. Note: Once the records have been saved, the values cannot be reset to the previous values. They would have to be re-entered as updated values, following steps 1-10.
- Click on the Save button to save the changes.
- All selected records are now updated, with the new information replacing the old information in the selected fields.
Note: For more information, see Replacing Record Values under the Help section>Record Management.
Searching for a Record
The Search page is the default page when a screen is opened. This screen is used to filter criteria when searching for a specific record.
- After entering values in the selected fields, click on the Search button. The results are listed below the search screen.
- Additional searches with different filter options can be run to add to the selected record results set.
- To select one or more record, click the box to the left of the record to alternately add or remove the check mark. To select/de-select all records in a specific search result set, click on the box above the search results to add or remove all check marks.
- To open the record you wish to view first, click its folder. All other selected records can be viewed by scrolling, using the right and left arrows in the Navigator section of the left pane.
Note: For more information on searching for an existing record, see Searching for a Record in the Help section. For more information on the Action buttons available in the left pane after the search is completed, see Search Action Buttons. For more information on setting the check boxes default to be checked or unchecked, see the Preferences section>My Preferences card>List screen.
Assignment Source Category
The category of the assignment source, used to group similar assignments. The value entered here determines the look up options displayed in the assignment source field.
Assignment Source Classification
The Assignment Source Classification determines the type of system classification (Standard, Customer, User-Defined, or Replicated).
More About Classification Options
The Classification options are as follows:
|
A record that is core to the system and included for all clients.
|
|
A record that was custom designed for a specific client.
|
|
A record that was created by a user in the system. When a new record is entered in the screen by clicking on the Add button, it is automatically given a status of User-Defined.
|
|
A record that was copied from an existing record, and then updated to change certain settings. When a new record is created by clicking on the Replicate button, it is automatically given a status of Replicated.
|
Application
The software application where this indicator setting is used.
Note: This option is only available if Application is chosen in the Source Identifier field.
Assignment Source Code
The short name or abbreviation for the assignment source.
After entering the Assignment Source Classification and Assignment Source Code, valid values can be selected from the Field Look Up Values.
Note: When an assignment source classification is selected, only corresponding options for the related assignment source code are displayed. When this field is left blank, all assignment source codes are displayed.
Category
The application or process to which this parameter applies (e.g. Staffing and Scheduling, System Download, etc.).
Classification
Determines the type of system classification (e.g. Standard, Customer, User-Defined, or Replicated).
More About Classification Options
The Classification options are as follows:
|
A record that is core to the system and included for all clients.
|
|
A record that was custom designed for a specific client.
|
|
A record that was created by a user in the system. When a new record is entered in the screen by clicking on the Add button, it is automatically given a status of User-Defined.
|
|
A record that was copied from an existing record, and then updated to change certain settings. When a new record is created by clicking on the Replicate button, it is automatically given a status of Replicated.
|
Default Value
The defaulted parameter value entered when a new record is created. All children records inherit this setting unless overridden at a lower structure level.
When creating a new record, if the "Required" field is set to Yes, a default value must be entered before the record can be saved. If the value is set to No, a default value is optional in this field.
Note: Default values can be updated on the Parameters tab of the applicable screen by authorized users.
Description
The label describing this parameter. For replicated parameters, the Description Template field is displayed instead of the Description field.
Description Template
The label describing this parameter. In a replicated parameter, this field displays the description of the original parameter used as a template. The description of the original parameter can be updated to make the description unique to the replicated record.
Note: For Parameters that are not replicated, the Description field displays instead.
Group Name
Assigns a group name to this parameter, which displays in the corresponding parameter screen under a separate heading.
Click the card arrow in the related Parameters screen to open and view all parameters assigned to the same group name.
Number
The numeric value identifying this parameter.
Organization Level Code
The organization level where this parameter value is assigned. This option is only available for parameter records requiring organization unit level specifications (e.g. download files).
Range Table Code
The range table used with this assignment, to which this parameter applies. This option is only available for assignments that use range tables.
Required
Indicates whether a value must be entered into this parameter field or whether the system can accept an empty (null) field (Yes/No).
Source Identifier
The table within the application where the parameters tab can be found.
Staffer Category
The staffer category used with this assignment, to which this parameter applies. This option is only available for assignments that use staffing.
Type
The type of value required for this parameter (e.g. alpha, date, day of week, hour, integer, pay code, rate, time, percent, or premium category).
More About Parameter Types
The following are the valid options for parameter types:
Alpha
|
The field will accept any letters, numbers, or characters on the keyboard.
|
Date
|
The field will accept any properly formatted date. More About Date Value Fields.
When a date field is highlighted, the Date Selector is displayed in the right pane to search for the date. Use the arrows in the heading bar to scroll to the Previous or Next month's calendar. Double-click on a date to enter it into the field. Alternatively, dates can be typed into the field.
|
DOW
|
The field will accept a day of the week. When this type is selected, the days of the week are available in the drop down menu under Default Value.
|
Hour
|
The field will accept any positive or negative whole and/or decimal value. The system will add a decimal point and trailing zeros up to two places. For example, if 3.5 is entered, the system converts this to 3.50.
|
Integer
|
The field will accept any positive or negative whole numbers (no decimals).
|
Pay Code
|
A valid pay code should be entered. There is no validation done when the record is saved.
|
Rate
|
The field will accept any positive or negative whole and/or decimal value. The system will add a decimal point and trailing zeros up to five places. For example, if 18.2 is entered, the system converts this to 18.20000.
|
Time
|
The field will accept any properly formatted time value. More About Time Value Fields.
When a field requires a Time Value, the value must be formatted in 24-hour time. This means after noon, the hour value entered should have 12 added to the hour value shown on the clock. For example, if the time is 3:00 pm, the correct value in 24-hour format is 15:00 (12+3 = 15).
- The system automatically formats entered values to hh:mm (two-digit hour value, two-digit minute value separated by a colon).
- Enter 1500 and the system automatically adds the colon between the hour and minute values to convert this to 15:00.
- Enter 900 and the system adds the leading zeros and colon to convert this to 09:00.
- The system adds leading zeros to any value less than 4 digits. For example, if 9 is entered, the system converts this to 00:09 (nine minutes after midnight).
- If the last two digits of the entered value is larger than 59, this cannot be converted to a valid time and an error message is generated.
- If the first two digits of a four-digit value is larger than 23, this cannot be converted to a valid time and an error message is generated.
- Enter midnight as 00:00; enter noon as 12:00.
- If a "p" or "pm" is entered after the hour value, the system automatically converts the time to the corresponding afternoon value in 24-hour time. For example:
- Enter 300p or 300pm and the system converts this to 15:00 and adds the colon.
|
Percent
|
The field will accept any positive or negative whole and/or decimal value. The system will add a decimal point and two trailing zeros. For example, if 3.5 is entered, the system converts this to 3.50.
|
Premium Category
|
When this option is selected, the user can select a Default Classification and Default Premium Category Number from the right pane.
|
Valid Character Set
Indicates the acceptable keyboard characters that can be entered into this field. (for example 1-9, A, C, &, *)
Valid Values
Indicates the acceptable value range that can be entered into this field (for example, 1-999, A-Z, etc.).
Visible
Indicates whether this parameter is visible to users when they access the parameters tab in the applicable configuration screen (Yes/No).