Working with Rate Scripts

Working with Rate Scripts

Viewing a Rate Script

The Energy CAP Enterprise default rate script is written in Visual Basic programming language drawing on data selected or entered during rate creation or modification.

  1. Select Accounting | Rates. The Rate Manager appears.

  2. Click rate_lst.gif to navigate to the vendor/commodity under which the rate exists.

  3. Select the appropriate rate VERSION.

  4. From the Rate menu, select View Script. Or right-click and select View Script from the popup menu. The Rate Script Editor window appears.

  5. You can:

    • Save a script by clicking the save.gif icon and following the prompts from the Save As ... window.

    • Print a script by clicking the print.gif icon. The script will be printed to the default printer.

    • Open a script by clicking the Open File open.gif icon and following the prompts from the Open ... window.

    • Search the script text by clicking the Search srch_icon.gif icon and inputting the search parameters in the Find window.

    • Edit a script

    • Run a script

    • Restore the script defaults

  6. Exit the Rate Script Editor window by clicking Cancel.


Working with Rate Scripts

Editing a Rate Script

At times it might be necessary to modify the default Energy CAP Enterprise rate script for events that are not standard. For example, the Rate Wizard can only accept cost per day or flat fee customer charges. You would need to edit the rate script to calculate customer charges by usage.

If you edit the default Energy CAP Enterprise rate script, the modified script applies to the current version and all future versions of this rate.

Editing scripts should only be attempted by advanced users with Visual Basic programming skills.

  1. Select Accounting | Rates. The Rate Manager appears.

  2. Click to navigate to the vendor and commodity under which the rate exists.

  3. Select the appropriate version.

  4. From the Rate menu, select View Script. The Rate Script Editor dialog box appears.

  5. Place the cursor in the area of the script text that you wish to edit.

  6. Make the necessary modifications.

  7. Click OK. The modified rate script is saved.

  8. Exit the Rate Script Editor by clicking Cancel.


Working with Rate Scripts

Running a Rate Script

Running the rate script allows you to verify calculations based on actual values entered, and/or selections made during creation/modification of a rate.

  1. Select Accounting | Rates. The Rate Manager appears.

  2. Click rate_lst.gif to navigate to the vendor and commodity under which the rate exists.

  3. Select the appropriate version.

  4. From the Rate menu, select View Script. The Rate Script Editor window appears.

  5. Click scrpt_run.gif. The Rate Check window appears to verify the script.

  6. You can:

    • Print the rate inputs and outputs by clicking print.gif. The information is printed to your default printer.

    • Enter rate values by clicking in the appropriate input field then entering the value.

    • Copy the values for the rate inputs to edit (using a word processing or spreadsheet application) by clicking copy.gif. You can then copy the edited values (using the other application's copy function) and paste back into the inputs fields by clicking paste.gif. The input values reside in a comma-delimited file-- a file containing the data values in a table as a series of ASCII text lines organized so that each column value is separated by a comma from the next column's value and each row starts a new line. A text file of this sort can be opened in word processing applications such as Microsoft®t Word and Microsoft® Notepad, or converted easily to table format in an application such as Microsoft® Excel.

  7. Click processor.gif to execute with the input values entered. The input values are processed then the calculated values are displayed in the Outputs section.

  8. After verifying your script entries, exit by clicking Close. The Rate Check window closes.

  9. Exit the Rate Script Editor by clicking Cancel.


Working with Rate Scripts

Restoring a Rate Script

Energy CAP Enterprise provides a default rate script, ratescr.txt, located in the Energy CAP Enterprise program directory. The Restore function lets you return a non-custom rate script back to the Energy CAP Enterprise default rate script.

Energy CAP Enterprise defines a custom rate as either:

  • A rate whose script has been modified using the Rate Script Editor.

  • A rate whose properties have been modified using the Simple function.

  1. Select Accounting | Rates. The Rate Manager appears.

  2. Click rate_lst.gif to navigate to the commodity under which the rate exists.

  3. Select the appropriate rate.

  4. From the Rate menu, select View Script. The Rate Script Editor dialog box appears.

  5. Click rate_rstr.gif. The Rate Script Editor returns the script back to the default rate script.

  6. Exit the Rate Script Editor by clicking Cancel.


Working with Rate Scripts

Updating Rates with the Default Rate Script

Energy CAP Enterprise provides a default rate script, ratescr.txt, located in the Energy CAP Enterprise program directory. The Update function is intended to revise all non-custom rate scripts at one time. This is useful if a newer version of the default rate script becomes available or if it is desirable to apply a modified version of the default script to non-custom rates.

Use the Update Script option with all rates only when instructed to do it as part of an upgrade.

NOTE: Energy CAP Enterprise defines a custom rate as either:

  • A rate whose script has been modified using the Rate Script Editor.

  • A rate whose properties have been modified using the Simple function.

 

To update the rate script to the default script:

  1. Select Accounting | Rates. The Rate Manager appears.

  2. From the Rate menu, select Update. The Confirm dialog box appears.

    • Select Yes to update all non-custom rates.

    • Select No to cancel the operation.