Use scripting within a checklist
Overview
How can I use scripting to automate my checklist tasks in CxPlanner?
Scripting lets you automatically update checklist values or reassign tasks based on user input. Instead of manually editing line items, scripting rules can process the entered data and adjust values or task assignments in real time.
When and why to use this
Scripting is useful when you want to reduce manual data handling and ensure consistency in checklists.
- Use it to automatically format entered values (e.g., add units like “Length: 200 mm”).
- Reassign tasks automatically if a checklist item fails.
- Save time when processing many checklist line items.
- Minimize user errors by standardizing how values are recorded.
How to - step by step
- Open the Checklist module in your project.
- Enable the Scripting column for the checklist.
- Define the rules you want to apply:
For modifying data values:
=> Update = <true | false>
=> Column = <name of the column>
=> Prefix = <any text>
=> Replace = <true | false>
=> Append = <true | false>
For modifying task assignment after PASS/FAIL:
=> reassignto = ttj@cxplanner.com
=> reassigntoonfail = ttj@cxplanner.com
- Save the checklist.
- Test by entering a value in the scripted column.
The screenshot below shows a number entered that gets transformed to “Length: <number>” in the column Length.
Behavior and results
When scripting is active, CxPlanner automatically updates the checklist fields or task assignments based on your rules.
- Input values can be prefixed, replaced, or appended.
- Values are stored in the target column you define.
- Task assignment rules will move ownership of a line item when PASS or FAIL is clicked.
Example
- A user enters “200” in a scripted column.
- The script updates the value to “Length: 200”.
- If the result is FAIL, the task can be reassigned automatically to another user.
Result after automation:
Troubleshooting
Problem | Cause | Solution |
|---|---|---|
Script does not run | Scripting column not enabled | Enable scripting in the checklist settings |
Values not updating as expected | Incorrect rule syntax | Check your rule syntax (Update, Prefix, etc.) |
Tasks not reassigned on FAIL | Wrong email or role entered | Verify correct email and that user is in the project |
Scripted values missing in export/PDF | Column not included in template | Add the scripted column to the output setup |
Quick facts
- Requires: Project role Manager or higher
- Location: Checklists → Scripting column
- Affects: Checklist data values, task assignments, exports
Updated on: 08/20/2025
Thank you!