Administration
Who may use Oktul Code Studio, the site settings, the console's administration sections, spaces, and exporting and importing the whole configuration.
Administrators configure Code Studio in two places.
| Where | What |
|---|---|
| The console’s side menu | Scripts, then listeners, schedules, API triggers, scripted fields and dynamic forms, then the audit log, then connections and variables. Ctrl+K (or Cmd+K) outside the editor searches them all |
| The administration page, Site settings at the foot of the menu | Four tabs: Settings, Import and export, Rovo and AI, and Help & support |
Every listener, schedule, API trigger and dynamic form has an on and off switch in its row. Turning one off changes nothing else about it. An imported one stays off until an administrator reviews it.
Who may do what
“Administrator” means an administrator of the app’s required product: Jira’s in the Jira listing, Confluence’s in the Confluence listing. Code Studio asks the product on every call and never takes the role from the browser.
| Action | Who |
|---|---|
| Read scripts and runs, edit drafts, run in the sandbox | Administrators and members of the developer groups |
| Publish, run in production, change triggers, connections, variables, repositories and settings, allow a script for automation rules, import and export | Administrators |
| Run a published script in production from the console, as themselves, in a space they may edit | Developers, when Allow developers to run code in production is on |
| Run a script from a Jira automation rule | Whoever may edit the rule, for the scripts and modes an administrator allowed for rules |
Settings
| Setting | Default | What it does |
|---|---|---|
| Developer groups | None | Members write scripts and run them in the sandbox. Groups are stored by ID, so renaming a group grants nothing |
| Allow developers to run code in production | Off | Developers can run a published script in production from the console, as themselves, in a space they may edit. Only administrators publish |
| Keep runs for | 10 days | 1 to 90 days, for each run with its log and web requests |
| Pause after failed runs | 1 | Failed production runs in a row before a listener or schedule pauses. Switching it on again, or a successful run in the console, resumes it. 0 never pauses |
| Check TypeScript strictly | On | A .ts script with a type error cannot be published. JavaScript is not checked, and published scripts keep running when this changes |
| Hosts scripts may call directly | None | Scripts can fetch only approved hosts, with no credentials added. Keep credentials in a connection, never in a script. Each host is approved in Atlassian’s own dialog. The five hosts the app declares are listed as Always allowed |
Help & support links to this documentation and to the Oktul Help Center.
Spaces
A space is a top-level folder with its own viewers and editors, by Jira group or by person.
- Administrators see every space.
- A developer sees a space whose viewers or editors are empty or name them or their group. They edit one whose editors do.
- The server decides on every console call and Rovo action. A space the caller cannot see answers as missing.
- Scripts from before spaces are under Outside every space, open to every role. Nothing new goes there. A script outside can be moved into a space, but not back.
A space can be synced with a repository. See scripts.
Import and export
Export as zip writes every script, trigger, connection, variable and setting. Each script is its own file at its path. Secrets are exported only when you set a passphrase, which encrypts them in an AES-256-GCM envelope with a key derived by scrypt. Without a passphrase they are left out.
Import adds what the file holds with the IDs it had, so automation rules naming a script keep working. Nothing already there is replaced. The whole file is refused if an ID, a connection key, a variable key or a script name is taken.
- Every listener, schedule, API trigger and connection arrives off and awaiting review.
- Production refuses an imported script until an administrator publishes it.
- Hosts are approved again, because an approval belongs to the site that gave it.
- AssemblyScript modules are compiled again in the console.
- A file is limited to 4 million characters, and a zip to 10,000 files and 64 MB unpacked.
An import creates scripted fields in Jira only when the person importing administers Jira. The result lists what was left out.
The audit log
Audit log lists runs, with filters, and what administrators changed. Runs and their logs are kept for the days set under Keep runs for. Secret values never appear in it.
Related
A problem or a question? Write to support@oktul.com or open a request in the Help Center (opens in a new tab).