Rumatadocs
Browse documentation

Activity creation and deployment controls

Find reusable actions, create a Python activity, configure its inputs, and inspect builds and deployments.

Step-by-step guidance.

Before you start

  • Open the named screen in Rumata. Available controls may depend on your account, permissions, and resource state.

Activity list

Open System Explorer → Activities. An activity is a reusable action that a workflow can call. Create an activity by editing its code in the wizard, or ask the Rumata agent to create it for you.

ControlWhat it does
Search activitiesFilter the loaded activities by name or description.
All sources / Built-in by Rumata / Created by you / Third-partyFilter by origin. Source badges identify where an activity comes from; they do not establish its deployment or runtime health.
Runtime status filterFilter by Active, Inactive, Deploying, Sleeping, Waking, Stopping, Unhealthy, Unknown or Checking status. Published/deployed state and current runtime health are different.
Activity row / Activity detailsOpen the activity’s Overview tab.
View source / View CodeOpen the Source tab for the activity’s recorded builds.
Manage accessControl which groups can use, build, deploy, or manage the activity.
New ActivityOpen a local creation draft. This does not create the resource until you submit Create Activity.
Reference capture from the separate Sabai Talk Thai application (September 8, 2026). These reusable operations support the application’s backend. Open Details to inspect an operation before using it.

Creation wizard and basic information

The four tabs are Basic Info, Activity Code, Configuration, and Machine Spec. Review all four before creating the activity.

ControlWhat it does
BackLeave the wizard and return to the activity list. This exits the wizard instead of moving back one step. An unsubmitted draft is not a saved activity.
Next Step / numbered step tabsMove through the form or return to a specific section.
Activity NameEnter a unique activity name using lowercase letters, numbers, dots, slashes, underscores, or hyphens, up to 30 characters.
DescriptionExplain the action in up to 120 characters. Both name and description are required.
Data ProviderMark the activity as providing data to other activities.
Programming LanguageShow Python, the language supported by this wizard. The field is disabled.
Create ActivityValidate the form, create the activity, and queue its build. It appears on Machine Spec and becomes Creating… while submitting.

Activity Code: files and editing

The wizard starts with main.py. File operations here edit the creation draft; they do not publish a running activity.

ControlWhat it does
Explorer toggle / dividerShow or hide the file browser and resize it beside the editor.
Files / Content searchSearch by filename or search text within the available files. Select a result to open the file.
File / folder rowOpen a file or expand/collapse a directory.
File tab / tab close iconSwitch between open files or close a tab. Closing a tab does not delete its file.
Code text editorEdit the selected file in the draft. A modified indicator marks changed contents.
Plus / New File / New File HereOpen file creation. Choose Directory, Name, and Type, then Create. A missing extension is added from Type, and duplicate paths are rejected.
Folder-plus / New Directory / New Directory HereOpen directory creation. Choose its parent and name, then Create. Cancel or Close leaves the draft unchanged.
Rename in the file context menuOpen the filename field. In this activity-file browser, Enter or leaving the field closes it without applying the rename; Escape cancels. Use the full Code editor to rename an existing workspace file.
Delete file / Delete directory in the context menuRemove that item from the creation draft. Check its contents before using this action.

Entry point and arguments

The entry point tells Rumata which function to call. Arguments are named settings supplied to that function.

ControlWhat it does
Entry FileChoose the file containing the function to run.
Entry FunctionEnter the function’s name, initially main.
Package ManagerSelect pip, the supported dependency manager in this wizard.
Edit entry function argumentsOpen the detected function signature and its configurable parameters.
Highlighted argument / argument buttonOpen the settings for that parameter.
Type: String / Number / Boolean / Object / ArrayDescribe whether the setting is text, a number, yes/no, a structured record, or a list.
Argument DescriptionExplain what a workflow author should provide.
Default ValueSet the value to use when a value is not explicitly supplied.
OptionalMark whether the caller may omit this setting.
Options (comma separated)For a string setting, list the choices presented to the caller.
Done / Close in argument settingsReturn from the argument editor. Changes already update the local creation draft; Done is not deployment.
Reference capture from the separate Sabai Talk Thai application (September 8, 2026). The details describe what the operation expects. Field definitions are different from actual secret values or customer data.

Machine Spec

This specification controls resources requested by the activity when it runs. It is separate from your factory development machine’s size.

ControlWhat it does
Memory sliderChoose 128–1,024 MB in the current form. The displayed initial value is 512 MB.
CPU sliderChoose 0.1–1 CPU core in increments of 0.1. The initial value is 0.4 cores.
Activity SummaryReview the name, description, entry point, package manager, and configuration fields before Create Activity.

Activity details: builds and source

Open an existing activity to inspect the versions Rumata built and the source used by those builds.

ControlWhat it does
Overview / Builds / Deployments / SourceSwitch between metadata, build records, running versions, and source files.
Source on a buildOpen files for that specific build. Disabled when its repository, activity path, or commit/ref information is missing.
Choose a build in SourceSelect the recorded revision to inspect.
Repository linkOpen the source repository in a new tab.
Source file explorer / search / tabsBrowse files for the chosen build. This view is read-only; editing and file-creation controls are hidden.
Close activity detailsReturn to the activity list.

Deploy and stop an activity

A build packages code. A deployment makes that build available for workflow calls. The deployment state is shown separately from build success.

ControlWhat it does
Deploy on a buildOpen deployment settings. Unavailable while the build is in progress or failed, while another request is submitting, or until an active deployment has stopped.
Disabled Deploy explanationHover over or focus the area around the disabled action to learn why the build cannot be deployed.
Idle before sleepingChoose an allowed auto-sleep duration. The default and plan maximum are marked. The first request after sleep waits for the activity to wake.
Deploy activityStart an on-demand deployment with that idle duration. Cancel closes the form without deploying.
Stop on a deploymentOpen a confirmation in the Deployments tab.
Stop deployment in confirmationStop accepting new workflow requests. You can deploy a successful build again after it stops.
Cancel stopKeep the current deployment.