Workiva Support Center

Note: Scripting is currently only available through Customize Workiva.  Learn more.

First script (first-script.py)

This simple script calculates the time value of money. Because it requires no additional libraries, it provides a good way to test out the basics of the Scripting program.

Required files:

• first-script.py

Instructions:

1. From Home, create a new script file.
2. Open the first-script.py file on your machine, and copy the script code onto the blank canvas (i.e., the code-editor space for the pre-created file "__main__.py").
3. Click Save at the top left.
4. Click Run Script.
5. Click +Add Variable and enter the following parameters:
   • INVESTMENT=10000
   • INTEREST_RATE=10
   • COMPOUNDING_PERIOD=annual
   • YEARS=1
6. Click Run Script and verify the result is 11000.

Note: This script is also covered in the Intro to Workiva Scripting article.

 

Fibonacci (fibonacci_main.py and fibonacci.py)

Like the starter script covered above, this simple script requires no additional libraries. However, it does use script sources -- an important building block of the Scripting program. 

Required files:

• fibonacci_main.py
• fibonacci.py

Instructions:

1. From Home, create a new script file.
2. Open the fibonacci_main.py file on your machine, and copy the script code onto the blank canvas (i.e., the code-editor space for the pre-created file "__main__.py").
3. Click Save at the top left.
4. Go to the Sources panel on the left side, right-click in the blank space just below the current sources, and select Upload Source Files.
5. Browse your computer for the fibonacci.py file, then click Upload.
6. Click Save at the top left.
7. Click Run Script and verify the result is 34.

Zero suppression script (Zero-Suppression-Script.py)

This zero-suppression script demonstrates how to hide spreadsheet rows whose displayed numeric values are all zero.

Required files:

• Zero-Suppression-Script.py
• requirements.txt

Instructions:

1. From Home, create a new script.
2. Open the Zero-Suppression-Script.py on your machine and paste its contents into the script’s pre-created __main__.py source file.
3. If you will run the script from an automation, replace the empty CLIENT_ID and CLIENT_SECRET placeholders with credentials from an API grant that has the file:read and file:write scopes and access to the spreadsheet.
4. Click Save.
5. In the Sources panel, right-click below the existing sources and select Upload Source Files.
6. Upload requirements.txt.
7. Click Save and wait for dependency generation to complete.

You can now create an automation in the spreadsheet containing the rows you want to evaluate. Configure the automation with a Manual Execution trigger and an Execute Script action. You will need the Script ID found in the URL of your script.

When run, any empty rows should be hidden in your document.