This section explains how to navigate down through the Rates hierarchical structure and how to add new rates categories, groups, types and definitions. It also explains how to update existing rate type parameters and delete rate definitions.
To view the current Rate Category, Group, Type and Definition lists in MiiNT:
Click on the Rates Management menu, to expose the Rates Management options:
Select the Configuration menu, to display the list of rate categories:
The above example contains 2 rate categories; Mining and New Category.
Select the arrow to the left of the rate categories to display the list of rate groups within the rate categories.
In the above example the MIning rate category has been expanded to display the Contractor rate group and the New Category rate category has been expanded to display the New Group rate group.
Select Contractor to display the rates group page.
In the above example the details of the Contractor rate group under the Mining rate category has been displayed.
Select the arrow to the left of the rates group to display the list of rate types.
In the above example the Contractor rate group has been expanded to display the Fixed Cost and Variable Cost rate types and the New Group rate group has been expanded to display the New Fixed Type, New Manual Type and New Variable Type rate types.
Select Fixed Cost to display the rates type page.
In the above example the details of the Fixed Cost rate type under the Contractor rate group and the Mining rate category has been displayed.
Select the arrow to the left of the rate types to display a list of rate definitions.
In the above example the Fixed Cost rate type has been expanded to display the DT001 - Cat 777D Dump Truck rate definition. There is one for each piece of equipment.
Select DT001 - Cat 777D Dump Truck to display the rates definition page.
In the above example the details of the DT001 - Cat 777D Dump Truck rate definition under the Fixed Cost rate type, the Contractor rate group and the Mining rate category has been displayed.
Note: Select the Refresh Tree List button at any time to collapse and refresh the Rates hierarchy tree.
To add a new Rates Category and grant access to the required user groups:
Right click in the white spaces below the existing Rate Categories and select the Add New Category option.
A new category item page will appear.
The table below list the fields for the Rates Category page
Fields | Description |
---|---|
Active |
Active rate categories will be used when processing rates against actuals. |
Name |
The name of the category, this will be the name used to identify the category and must be unique. |
Description |
Use this field to describe the rate category. |
Calendar |
Select the calendar to use for this rate category. For example there could be a Production Calendar and a Financial Calendar. The Periods grid will be populated with the periods for the selected calendar. Note: The calendar can not be changed once the rates process has been run for the category. Refer to the Master Configuration > Calendar topic for information on how to manage calendars. |
Security |
To grant access to user groups, move them from the User Groups column to the Access Granted column. Note: Only users belonging to user groups that have been granted access will be able to assign rates. Refer to the Rates Categories section under the Security topic for information on how to grant user group access. |
Note: Field labels highlighted as bold must have a value entered or selected as they are mandatory.
Select the Save button to save the Rate Category.
Refer to the Rates Validation topic for information regarding the validation of Rate Categories.
To add a new Rates Group:
Right click on the rates category that you want to add the new rates group to and select the Add Group to Category option.
A new group item page will appear.
The table below list the fields for the Rates Group page:
Fields | Description |
---|---|
Active |
Active rate groups will be used when processing fates against actuals. |
Code |
The rate group code, this will be the name used to identify the group and must be unique within the rate category. |
Description |
Use this field to describe the rate group. |
Order |
Enter or select a number to order the group by. |
Note: Field labels highlighted as bold must have a value entered or selected as they are mandatory.
Select the Save button to save the Rate Group.
Refer to the Rates Validation topic for information regarding the validation of Rate Groups.
Variable, fixed and manual rate types can be created.
Note: Before creating Variable or Fixed rate types a query will need to be defined.
A query must be created to retrieve the actual values that are applied to the rate definitions. Rate Type Queries need to contain the following named filters and outputs:
Named Filters / Output | Description |
---|---|
Filters |
|
Date |
The Date named filter is mandatory for variable rate types. Note: The query should also name any filters that are required by the different rate definitions. These name filters will define parameters that can be assigned values at the rates definition level. |
Outputs |
|
ID |
This output will be used to identify the actual source record.If the actual data is from the Engine Hours table the ID output should be the Id output from the Engine Hours table. Note: The Id field must be an integer that uniquely identifies the transaction record that contains the value the rate will be applied to. This current restriction applies for performance reasons. |
Value |
This output is the value that the date effective rate will be applied to, to create a calculated value. Note: The value field must be a number from the transaction record uniquely identified by the Id output. |
Date |
The Date named output is mandatory for variable rate types. It is used to group rates by a day. |
Shift |
The Shift named output is optional for variable rate types. It is used to group rates by a shift within a day. |
In the below image of a variable rates type query the Date and Equipment are named filters. The output Id field uniquely identifies the engine hours record. The output Value field is an expression calculating the engine hours value from the start and end hours. The date and shift fields identify the date and shift of the engine hours.
To add a new Rates Type:
Right click on the rates group that you want to add the new rates type to and select the Add Type to Group option.
A new type item page will appear.
The table below list the fields for the Rates Type page:
Fields | Description |
---|---|
Active |
Active rate types will be used when processing rates against actuals. |
Code |
The rate type code, this will be the name used to identify the rate type and must be unique within the rate group. |
Description |
Use this field to describe the rate type. |
Order |
Enter or select a number to order the rate type by. |
Rate Type |
Use this field to define the type of rate. |
Note: The fields below are only available for variable and fixed rates. |
|
Table |
The database table name that the actual data is drawn. Note: Use the Add New button to add a table and its product code. |
Query |
Paste the query used to retrieve the data and set the parameters, into the Query text field. Please refer to the Define a Rate Type Query section above for requirements. |
Parameters |
Select the Refresh Parameters button to populate the Parameters grid. These parameters will be available to enter values against when defining the rates. Note: Rate Definitions will be populated with any rate type default parameter values. In the below rate type the Total Hours Default From has been set to > and Default To has been set to 0. |
Note: Field labels highlighted as bold must have a value entered or selected as they are mandatory.
Select the Save button to save the record.
Refer to the Rates Validation topic for information regarding the validation of Rate Types.
To add a new Rates Definition:
Right click on the rates group that you want to add the new rates type to and select the Add Definition to Type option.
A new definition item page will appear.
The table below list the fields for the Rates Definition page:
Fields | Description |
---|---|
Active |
Active rate definitions will be used when processing rates against actuals. |
Code |
The rate definition code, this will be the name used to identify the rate definition and must be unique within the rate type. |
Description |
Use this field to describe the rate definition. |
Order |
Enter or select a number to order the rate type by. |
Parameters |
Enter From and To values for each query parameter. The values should reflect the outputs that are expected from the query relevant to the rate being configured. The From and To values can utilise the rich filter markup that is available when using Query Builder. An Example of this would be using the value <in> in the From value and configuring a comma separated list of Output values in the To value. To determine all of the possible markup values it is suggested that you use the Query Builder user interface and copy the markup from there. Note: Values do not need to be entered for the Date range. Any values entered will be ignored as this parameter is driven by the Rate Category Period being processed. Note: The rate definitions parameters will be populated with any default values entered into the rate type. In the above rate definition the Total Hours From Value was set to > and To Value set to 0. Note: Not available for manual rate types. |
Rates |
Monetary rates applicable to this rate definition. Note: At least one rate must be defined for Variable and Fixed rates. |
Note: Field labels highlighted as bold must have a value entered or selected as they are mandatory.
Click on the button to add a new rate.
The table below list the fields for the Rates on the Rates Definition page:
Fields | Description |
---|---|
Description | Use this field to describe the rate. |
Lower Threshold | Enter an optional Lower Threshold value. Any value greater or equal to the lower threshold will use this Rate. Note: There is no lower threshold value if this value is blank. |
Upper Threshold | Enter an optional Upper Threshold value. Any value less than the upper threshold will use this Rate. Note: There is no upper threshold value if this value is blank. |
Note: The threshold fields above are not available for manual rate types. | |
Start Effective Date | This rate is utilised only when calculating against actual values that fall within this Effective Date range. This value identifies the start inclusive date for this range. |
End Effective Date | This rate is utilised only when calculating against actual values that fall within this Effective Date range. This value identifies the end inclusive date for this range. Note: This date will be automatically adjusted for an existing rate record when a new rate record is added. |
Rate Period | The period the fixed and manual rates apply to. Note: This field is not available for variable rate types. |
Rate | This is the rate that will be applied to the query actual values that fall within the effective date range and optional threshold values. |
Unit of Measure | The unit by which this rate is measured. |
Note: Field labels highlighted as bold must have a value entered or selected as they are mandatory.
Select the Save button to save the record.
Note: When you add an additional rate value record the End Effective Date of the existing record will be automatically set to yesterdays date when you save the rates definition record.
In the above example a new rates value record of $74.00 was added on the 20/12/2014. The End Effective Date for the rates value record of $76.00 was automatically changed from 31/12/2099 to 19/12/2014 when the new record was saved.
Refer to the Rates Validation topic for information regarding the validation of Rate Types.
When the parameters of a rate type are changed the rate type parameters will need to be refreshed. This will occur if there is a change to the named filters in the Rate Type Query. To update existing rate type parameters:
Locate the rate type that you wish to change and copy the query to the clipboard.
Open Query Builder. Right click in the filter area and select the Import Query > From Clipboard option.
Make the necessary changes to the filters, ensuring that you name the ones required as parameters for rates.
Copy the updated query from the clipboard into the Query field on the Rate Type definition page.
Select the Refresh Parameters button to apply the updated parameters.
Select the Save button to save the record.
Note: You may need to add a space to the Description field to enable the Save button.
Select any of the rate definitions under the updated rate type and check that the parameters.
Note: Any rate definitions under the updated rate type will automatically have their parameters updated when the rate type is saved.
Refer to the Rates Validation topic for information regarding the validation of Rate Types.
Rates categories, groups, types and definitions can be deleted.
Note: You will not be able to delete rate categories, groups, types and definitions that rate values exist for. The Delete Item option will be disabled.
To delete Rates Categories, Groups, Types and Definition:
Right click on the rates category, group, type or definition that you want to delete and select the Delete Item option.
A Delete prompt will be displayed for delete confirmation.
Select the OK button to delete the rate category, group, type or definition or the Cancel button to not delete.
Select the Refresh Tree List button to confirm that the rate definition rate has been deleted.
To delete a Rates Definition rate:
Right click on the rates definition rate that you want to delete and select the Delete Item option.
A Delete prompt will be displayed for delete confirmation.
Select the OK button to delete the rate definition rate or the Cancel button to not delete.
Select the Refresh Tree List button to confirm that the rate definition rate has been deleted.