Scripting Tool Program

Partners interested in checking their scripts prior to adding them to live accounts can use our Scripting Tool program as a test environment. It also works as a training environment if you are new to scripting.
 
The Scripting Tool is a Windows Form Application that you can run on any Windows computer and does the following:
  • Provide a test environment for some time card and accrual scripts.
  • Imports existing scripts from live accounts for easier testing and troubleshooting.
  • Includes some "test" scenarios that you can use to improve your scripting skills.
 
The program is attached at the bottom of this article in a zip file, but before you use it, please read this article to understand it's capabilities and limitations. If you don't want to read the whole article, at least read this section titled Before You Use the Scripting Tool.

Requirements

First of all, the tool requires Windows; we do not have a Mac version of the scripting tool and there is no plan for a Mac version.
 
Second, in order to import scripts from a live account, you will need the account's Site ID and a Client Level Login and Password for that account.
 
Also, the Scripting Tool only works with TimeWorksPlus, it is not compatible with sites using TimeWorks.

A Text Editor is Suggested

And while not required, it is suggested that you use a simple text editor to compose and save your scripts. Window's Notepad app is an example of a simple text editor, but we recommend Notepad++ for some of its additional features.
 
Do not use Word or other rich text editors for the primary reason that our scripting engine will not recognize the curved quotation marks that are often defaulted on these programs.

Downloading and Installing

A zipped attachment at the bottom of this article includes the Scripting Tool (called Scripting Program.exe) as well as some basic instructions and three folders containing scripting tutorials and scenarios.
  1. Click the attachment link at the bottom of this article to download.
  2. Most browsers will auto-download the file and display it somewhere on your browser, but you may be asked you where you want to save the file. Once the download is complete, locate the zip file. You can use the "Show in Folder" option in most browsers by clicking a context menu on the file.
  3. Right-click zipped folder and select "Extract All". You'll then be prompted to select the destination for the files.

Running the Scripting Tool

After extracting the files, the Scripting Tool is ready to use.
 
To run the program, navigate to the folder where you extracted the files and open the file located in this path:
 
Scripting Program\Scripting Program\Scripting Program.exe
 

The Scripting Program executable is run from the folder to which you extracted the files
 
At the top of the tool, you will see tabs that correspond to the various scripting boxes in TimeWorksPlus. You can put your scripts in those boxes and check them against mock data on the Time Card or Accrual Report tab.

Importing Rules

You can also use the Scripting Tool Program to import scripts for an active site. To do this:
  1. Select the Sandbox Setup tab.
  2. Enter the account's Side ID along with a Client level login and password for that site. While you may not have a personal login at this level for your client's site, you can always create one expressly for this purpose.
  3. Click Import Rules
 

You can import scripts from a live account with the site ID and a client login
 
The tool should copy the scripts from the account into the various scripting tabs. Those tabs correspond to each scripting box in the system. However, at this time, the tool will not import the Accrual Buckets or the Accrue Up Bottom script box. You will need to manually copy those scripts/buckets over.
 
By clicking the tabs at the top of the tool, you can adjust and edit any of the scripts for testing.

Checking a Time Card Script

For any script that affects punches on the time card, you can click the Time Card tab and add punches for testing.
 

You can add punches to a mock time card to test your script
 
There is also a tab labeled Employee for scripts that use Employee Setup data.
 
IMPORTANT: The scripting tool does not have the ability to check scripts that affect or use Punch Categories and Clock Prompts.

Checking Accruals

For any script that deals with per pay period accruals, you can use the accrual scripting tabs to test your scripts. Remember, you must add the categories to the Accrual Buckets tab in order for this to work.
 

In order to test accruals, you need to list the accrual buckets
 
There is also a tab labeled Employee for scripts that use Employee Setup data.
 
IMPORTANT: The scripting tool does not have the ability to check accruals earned annually or based on hours worked, nor is it able to account for years of service in the script.

Before Using the Scripting Tool

The Scripting Tool Checks Syntax, but Not Necessarily Logic

It's important to remember that successfully testing a script in the Scripting Tool does not guarantee the effectiveness of you script. While the scripting tool does check syntax, checking the logic is only as good as the scope of your test cases. The wider the scope, the more likely that your script will work on your client's account.

For example, the Scripting Tool might show you that your pay rate script works for a regular punch from 9 to 5, but how does it work on:
  • an hours entry (as opposed to a punch in and out)
  • holidays
  • punch sets that span midnight
  • punch sets with splits or shift diffs
and any other unique cases that you, or your client, may not have considered.
 
And maybe most importantly, how does your script work with other scripts that are present on the account.
 
All these factors are important to consider when checking a script and not all of them can be checked by the scripting tool. Keep that in mind with any script you implement.

Using the Scripting Tool for Training

The Scripting Tool also comes with three folders containing PowerPoint tutorials and test scenarios that you can use to test yourself. These folders are labeled Beginner, Intermediate and Advanced and you can review the PowerPoints and test your skills by loading various scenarios.
  1. Click the "Load Scenario" and choose one of the .xml scenario files from any of the tutorial folders. This will populate the Employee and Time Card with necessary data for the tests.
  2. Using the directions provided on the left, write your script in the appropriate tab.
  3. If your script is correct, you will get a "Complete" pop-up when viewing the time card.

Attachments

Scripting_Program.zip Scripting_Program.zip

Did you find this article helpful?