System objects

Emit a log line. {} placeholders in fmt are replaced by the remaining arguments in order.

Return the active locale of the running step, e.g. "en".

Return the identifier of the current process instance.

Insert or update an entity in the backing store.

Look up an entity of a given type by id; returns the entity or null.

Load by id string, or by an entity's own id / identifier. Commonly used with a null check to "load or create".

Remove an entity, given either the entity or its id string.

Create a named relationship edge from one entity to another, e.g. "IN_PARENT_CATEGORY".

Run a query built with PSEntityQuery and return its result. PSEntityQuery

Read an input value. Index chains for nested data: param$["A"]["B"]. Missing keys read as null.

Expose a value to later steps in the workflow.

Read back a value previously written this run.

Get a component's value, or set it when a second argument is supplied. (value is an alias of val.)

Get or set a component's localized text. With one argument it reads; with a locale it reads that locale; with a value it writes.

Store a value in the workflow-level cache, shared across steps of the same instance.

Read a cached value back, or null if not set.

Return the current workflow instance id.

Start another process in the same workspace, optionally naming the start node.

Start a process that lives in a different workspace.

Starts a persisted Iteration over the given map of items. Each activation of the loop exposes the current item through param$["iteration"], param$["iterationItem"] and param$["iterationItemId"]; the iteration status is 0 for no action, 1 done, 2 failed and 3 in progress.

Set localized view text on the current process-component instance. The value is returned in instance load/query data under <code>texts</code>.

Store a named map as view metadata on the current process-component instance. The second argument must be a map and is returned under <code>metadata</code>.

Permit one or more outgoing connectors to fire next.

Block one or more outgoing connectors.

Forwards the step to a different assignee — an account, role, group or access declaration, given as a scope string such as "SEC:WORKSPACE_REVIEWERS".

Send inputData (a map) and a question to a model identified by modelIdentifier, within a named session. Returns a map; common results read with e.g. result["answer"].

Send an HTML email, optionally overriding the sender address.

Send an in-app HTML notification. The optional scope may identify an Account, WorkspaceAccount, Role, Group or Access Declaration.

Send email through the named Mail settings configuration to recipients resolved from the optional security scope.

Sends a message to the account whose platform ID is held in the account custom field named by the configuration's recipientFieldKey. The configuration is a Settings entry of class com.paradicshift.platform.settings.SocialMedia, and Telegram is the platform implemented today. The message must be 1 to 4096 characters.

Mints an NFT from a Settings entry of class com.paradicshift.platform.settings.Blockchain. Crossmint is the provider implemented today, on Solana or Polygon. The metadata argument must be a map, and the recipient may be a bare wallet address or a provider-qualified recipient such as email:[email protected].

Opens an SSH session from a Settings entry of class com.paradicshift.platform.settings.RemoteShell and returns a ShellSession handle. Host, port, username, password or RSA key, host-key fingerprint and timeout all come from that entry.

Runs one command on an open session and returns its standard output. A non-zero exit status raises a script error, and the command must be 1 to 32768 bytes.

Closes the session. Always close a session you opened, ideally from a finally block so a failure part-way through still releases it.

Generate a random UUID string.

Generate a random string of the given length.

Return a random float in the range [min, max].

Parses a JSON string into a map.

Alias of jsonToMap, kept for scripts written against the earlier name.

Serialises a map to a JSON string.

A random integer between min and max, inclusive.

Pauses the script for the given number of milliseconds.

The current UTC timestamp as a string.

The current time in milliseconds since the Unix epoch.

Perform an HTTP GET and return the response body as a string.

Sends an HTTP POST with the given body and headers and returns the response. There is no api$ object and no context$.set method — web$ is the only outbound HTTP host.

Authenticate a WorkspaceAccount by its UN username and password. Returns the sanitized WorkspaceAccount entity on success; password hashes and other secret values are not returned.

Create a WorkspaceAccount entity. Set UN with val, disabled with val, and the initial plaintext password as secret PWH; the platform hashes the password before persistence. Returns the created entity.

var account = PSEntity("com.paradicshift.platform.security.WorkspaceAccount");
account.val("UN", "business-user");
account.val("disabled", false);
account.secret("PWH", "initial password");
var created = security$.createWorkspaceAccount(account);

Update the normal fields, maps, text and access data of an existing WorkspaceAccount. This method deliberately preserves the existing password and cannot change it.

Delete a WorkspaceAccount by UUID and revoke its active sessions.

Change a WorkspaceAccount password after verifying the old password. The new password is hashed and every existing session for the account is revoked.

Preceding script. Runs before the component is presented or executed — use it to prepare data, look up entities and seed the form.

Load script. Runs whenever the component is (re)loaded, so it may execute more than once for one instance.

Post script. Runs after the component completes and before routing. This is the only phase in which router$ may be called; publishing rejects router$ anywhere else.

Each phase is compiled and executed on its own, and every entity operation inside one phase shares a single database transaction — a failure runs the script's rollback block. Local variables do not survive from one phase to the next; use workflow$.cache and workflow$.load to carry state between them. External calls made through web$, email$ or ai$ are not undone by a rollback.

Atomically creates a Record and its RecordItems from the published MODEL_FINANCIAL_RECORD identified by recordModelUid. Values in the params map fill the model's placeholders — both its account selections and the placeholders in its description pattern. The posting is validated so total debit equals total credit, and the new record's id is returned.

Parses a WKT string into a GeoData object. Supported geometry families are Point, LineString, Polygon and MultiPolygon.

Serialises a GeoData object to its JSON representation.

Returns a random Point inside the geometry — useful for seeding test data across an area.