Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.royaltyport.com/llms.txt

Use this file to discover all available pages before exploring further.

​
What are Variables?

Variables let you store named values that can be referenced as template strings inside automation steps. Instead of hardcoding values in each step, you define them once as a variable and reuse them across your workflows.

​
Variable Types

There are two types of variables:
TypeDescription
CustomA JSON object you define manually. Use this for configuration, rates, or any static values your workflows need.
RoyaltyportA project reference. The variable holds a link to one of your Royaltyport projects, selected from a dropdown. Use this when your workflow needs to know which project to operate on.
When you run workflows from the Start Workflow dialog, both variable types appear in collapsible sections. You can review and update them at run time before execution begins — Royaltyport variables show a project picker, Custom variables show an editor with a UI / Raw toggle. Simple object values display as individual form fields in UI mode; switch to Raw to edit the JSON directly.

​
Accessing Variables

In the Automations section of your organization, click Variables in the left sidebar.

​
Creating a Variable

1

Open Variables

Click Variables in the automations sidebar.
2

Click Variable

Click the Variable button in the top-right corner of the Variables panel.
3

Choose a Type

Select Custom to enter a JSON value, or Royaltyport to link to a project.
4

Enter a Name

Give your variable a descriptive name (e.g. royalty_rates or target_project).
5

Set the Value

  • Custom: Enter a valid JSON object in the content editor.
  • Royaltyport: Select a project from the dropdown. The name defaults to Project ID.
6

Save

Click Save to create the variable.
Custom variable content must be a valid JSON object. The editor will show an error if the JSON is invalid before you can save.

​
Editing a Variable

Click any variable in the list to open it in edit mode. You can update the name and value, then save your changes. The type of an existing variable cannot be changed after creation.

​
Deleting a Variable

Click the trash icon on a variable row, then confirm the deletion in the dialog.
Deleting a variable is permanent. Any automation steps that reference the deleted variable will stop working.

​
Variable Types

Variables come in two types:
TypeDescription
CustomA free-form JSON value you define. You can set both the name and the content.
RoyaltyportA reference to a Royaltyport project. The variable name is set automatically and cannot be changed.

​
Overriding Variables at Run Time

When you click Run from the Automations list view to start a batch run, the Run dialog shows all your variables and lets you change their values before the run starts. These changes are temporary overrides — they apply only to that specific run and do not update the stored variable value. This is useful when you want to test a workflow with a different project or configuration without permanently changing the variable.
To permanently update a variable’s value, edit it from the Variables panel in the sidebar instead.

​
Variable Content

Custom variables store a JSON object. The number of top-level keys is displayed as a badge on the variable row so you can quickly see how much data it contains. Royaltyport variables store a project reference. The selected project name is shown on the variable row. 
{
  "base_rate": 0.12,
  "territory": "US",
  "currency": "USD"
}

​
Using Variables in Steps

Reference variables in any step configuration field using the template syntax: 
{{var.royalty_rates}}
This injects the full JSON object. To access a specific key: 
{{var.royalty_rates.base_rate}}
See Template Variables for the full syntax reference.

Libraries

Reusable prompt and script components for your automations.

Steps

Use variables as template strings in step configurations.

Automations Overview

An introduction to automations and how they work.