Scripting on Timill Platform Documentation

Backend Scripts

Mon, 01 Jan 0001 00:00:00 +0000

Create server-side automation scripts triggered by events, schedules, or manual execution. Supports two languages: JavaScript (Goja) and Gonja (Jinja2-style templates).

Getting Started#

Creating a Script#

Navigate to Group Settings → Backend Scripts
Click New Script
Choose a language: JavaScript or Gonja
Write your script code
Set the trigger type and schedule
Save and test

Script Structure#

JavaScript Example#

// Get the current item
var item = item;

// Update the status
item.SetStatus("approved");
item.Save();

// Add a comment
item.AddComment("Automatically approved by backend script");

// Send a notification
log("Item " + item.Title() + " has been approved");

Gonja (Jinja2) Example#

{# Update item status #}
{% set item = item %}
{{ item.SetStatus("completed") }}
{{ item.Save() }}

{# Log the change #}
{{ log("Item " ~ item.Title() ~ " completed") }}

Trigger Types#

Type	Description	Configuration
Manual	Execute on demand from UI	None
Schedule	Run on cron schedule	Cron expression (e.g., `0 9 * * *`)
Event	Fire on specific events	Event type + optional conditions
Save Hook	Run after every item save	Optional field conditions

Available Events#

Event	Trigger
`CREATE`	Item is created
`UPDATE`	Item is updated
`DELETE`	Item is deleted
`STATUS_CHANGE`	Item status changes
`FIELD_UPDATE`	Specific field is updated
`ASSIGN`	Item is assigned/unassigned
`COMMENT_CREATE`	Comment is added

Language Features#

JavaScript (Goja ES5.1)#

Best for: Complex logic, external API calls, data transformations

Scripted Widgets

Mon, 01 Jan 0001 00:00:00 +0000

Create custom HTML widgets using Go’s html/template syntax with built-in query helpers and automatic RBAC enforcement. Widgets are rendered server-side and integrated into pages and dashboards.

Getting Started#

Navigate to any page or dashboard
Click Add Widget → Scripted Widget
Enter a name and description
Write your Go template code
Save and preview

Every scripted widget consists of:

Scripted Charts

Mon, 01 Jan 0001 00:00:00 +0000

Create dynamic data visualizations using JavaScript with Apache ECharts. Charts run in both the browser and backend (Goja VM) with full RBAC enforcement.

Getting Started#

Creating a Chart#

Navigate to any page or dashboard
Click Add Widget → Scripted Chart
Enter a name and description
Write your JavaScript code
Save and preview

Chart Structure#

Every chart script follows this pattern:

Scripting API Reference

Mon, 01 Jan 0001 00:00:00 +0000

Complete JavaScript (Goja ES5.1) scripting API for backend scripts, widget scripts, and chart scripts.

Global Variables#

Variable	Type	Description
`userId`	`string`	Current user ID
`groupId`	`string`	Group ID (if group-scoped)
`instanceId`	`string`	Instance ID
`scriptId`	`string`	Current script ID
`scriptType`	`string`	`"backend"`, `"widget"`, or `"chart"`
`itemId`	`string`	Item ID (if item-scoped)
`isGroupScoped`	`boolean`	True if script runs in a group context
`isInstanceScoped`	`boolean`	True if script runs at instance level
`isItemScoped`	`boolean`	True if script runs on a specific item

`user` Object#

Available in all script types. Backend scripts get read-write access.

Scripting on Timill Platform Documentation

Backend Scripts

Getting Started#

Creating a Script#

Script Structure#

JavaScript Example#

Gonja (Jinja2) Example#

Trigger Types#

Available Events#

Language Features#

JavaScript (Goja ES5.1)#

Scripted Widgets

Getting Started#

Creating a Widget#

Widget Structure#

Scripted Charts

Getting Started#

Creating a Chart#

Chart Structure#

Scripting API Reference

Global Variables#

`user` Object#

Scripting on Timill Platform Documentation

Backend Scripts

Getting Started#

Creating a Script#

Script Structure#

JavaScript Example#

Gonja (Jinja2) Example#

Trigger Types#

Available Events#

Language Features#

JavaScript (Goja ES5.1)#

Scripted Widgets

Getting Started#

Creating a Widget#

Widget Structure#

Scripted Charts

Getting Started#

Creating a Chart#

Chart Structure#

Scripting API Reference

Global Variables#

user Object#

`user` Object#