Informat Platform System Methods#

Current Session Path Rules (Highest Priority)#

The current session message prefix provides:

• informatclawThreadId
• the absolute path to call_informat.js
• the absolute Informat skill directory

You must use these absolute paths:

• API calls: node "<absolute call_informat.js path from the runtime instruction>" <method> --threadId <informatclawThreadId> ...
• Reference docs: cat "<absolute Informat skill directory from the runtime instruction>/references/..."

Do not use Read on /root/.informatclaw/config/skills/informat; do not use $INFORMAT_CONFIG_DIR, {baseDir}, /data/workspace/informat, or guessed paths; do not write or rely on scripts/.env.

Total 215 methods. The parameter definition file for each method is under {baseDir}/references/.

📚 Reference Documentation Directory: {baseDir}/references/doc/ contains complete platform development documentation:

• references/doc/markdown/ directory: Official platform core feature documentation (AI Assistant, API, Automation, Dashboard, Expression, Scheduled Tasks, Scripts, Data Tables, Tasks, Websites, etc.)
• references/doc/markdown/script/ directory: Script API reference documentation, categorized by module (bpmn.md, table.md, http.md, etc.). Consult these first when developing scripts

Invocation Rules#

Based on method name prefix, the system automatically selects the corresponding agent interface:

PrefixInterface TypeRequired Parameters_wb_Workbench AgentNo extra parameters_company_Team AgentNo extra parametersCommon methodsCommon AgentNo extra parametersOtherApplication Agent--appId

Invocation Protocol (combined gate: doc + schema in one shot)#

⚠️ The script has a built-in gate: before the first operation of a kind, read its domain design doc + parameter schema, otherwise the script refuses to run and returns a hint. The two proofs ( _doc_ack = doc read, _ack = schema read) are merged into one — bring whichever the hint asks for, and one retry clears it:

bash

# Step 1: Read the parameter schema (understand required/enum/type/nested structure)
cat {baseDir}/references/system_create_table_module.json
# Step 2: Read the domain design doc (the matching .md under references/doc/markdown/; take its header DOCKEY: <token>)
cat {baseDir}/references/doc/markdown/informat.table.md

# Step 3: Write the parameter file; per the hint add _doc_ack (=DOCKEY token) and/or _ack (=this method's REQUIRED param names, comma-separated)
#         Both are "already read" proofs, stripped before sending to the backend. _ack only needs the REQUIRED names (not all).
echo '{"id":"t1","name":"Table","fields":[],"_doc_ack":"tbl-2e7a9","_ack":"id,name,fields"}' > params.json

# Step 4: Execute (the script still validates required/enum/type locally — the real safety net against fabricated args)
node {baseDir}/scripts/call_informat.js _create_table_module --appId <appId> --threadId <threadId> --file params.json

# Common/team/workbench methods (no --appId); read-only (query/list/read) and zero-arg methods skip the gate, need no _ack
node {baseDir}/scripts/call_informat.js _get_current_time --threadId <threadId>

The gate fires once per domain: _doc_ack/ _ack proofs are tracked per domain (table/automatic/workflow/dashboard…) — after the first build method in a domain clears the gate, the rest of that domain's methods are no longer gated (e.g. after the 1st table, the next 11 tables pass straight through), backed by the step-4 local validation.

Handling gate feedback:

• [First operation of this kind: please read the documentation and parameter definitions before calling] (exit 3) → first build in this domain. Per the hint, take the DOCKEY from the .md as _doc_ack, and the REQUIRED param names from the schema as _ack, then re-call with the business args (bring whatever the hint lists; one retry clears it). Never guess tokens/param names without reading.
• [Parameter validation failed: xxx] (exit 4) → missing required / illegal enum / wrong type. Fix per the schema and retry. This is the main defense against fabricated args after relaxing the gate — fix it carefully.
• [Before saving this script: read the SDK reference for each informat.* module it uses] (exit 5) → only _save_informat_script: the script/<module>.md for an informat.<module>.* used in the script (e.g. informat.table.*) has not been read this session. Read each script/<module>.md listed to verify exact signatures (argument count/order/position; common errors: tableId placed inside query, update written with three args), then re-call with _sdk_read=<comma-separated module names>. Each module is gated only once per session.
• [Before this operation: read the expression reference, as the payload contains a platform expression ${...}] (exit 6) → any write method whose arguments contain a platform expression ${...} (automation step values, formula fields, flow conditions, etc.) while informat.expression.md has not been read this session. Informat expressions are a platform DSL (UEL), not JavaScript; their syntax and available functions are defined by that document. Read informat.expression.md, then re-call with _expr_ack=<the DOCKEY token in the document header>. Gated only once per session (the ${} in _save_informat_script and _codestudio_* are native JS template literals and do not trigger this gate).
• [Blueprint not yet complete: finishing is not permitted] (exit 7) → only during full-app orchestration: you called _app_check_setting but some component category is below its built count. Continue creating the missing components listed (linked to the blueprint, not added as filler) then finish. Built counts are tallied automatically by name (covering table/automatic/script/api/workflow/dashboard/ listener/schedule — once listeners or scheduled tasks are confirmed by the user during §2 alignment they must be declared in plan.targets and actually built, not silently dropped as "optional extensions" at build time); a verbal "done" cannot bypass it. To genuinely drop an item, re-register targets via _plan_set and explain.
• [Build artifact rejected: it violates the <domain> design rules] (exit 10) → build-artifact validation (anti context-decay): at the moment of building, deterministic per-domain rules are checked, independent of whether the document is still remembered. Covers dashboard (enableCardStyle must be true / Number card xPosition·yPosition both center / subTitle ≠ name / orderByList sort entries must be {field,type:asc|desc} objects, not a "count#desc" string / a card's width must fit the current row's remaining columns: the 24-column grid flows by order+width, so a width that overflows the row wraps and leaves a gap — fill each row to 24 and build cards in visual order / a ProChart must have a data source: proChartSetting.dataset non-empty with each entry binding a real tableId or expression, and series non-empty, else the chart is blank), automatic (each step's required references validated against the schema: OutputBpmnProcess needs bpmnModuleId+bpmnProcessDefineId+bpmnProcessStartFormTableId+bpmnProcessStartFormFieldList, OutputRecordCreate needs recordCreateTableId, CallScript needs scriptId+func, SetReturnValue needs valueVar, If needs expression+If.true/If.false branches; interaction-output steps need display content: OutputToast needs toastValueVar, OutputConfirm needs confirmTitleVar or confirmDialogTitleVar, OutputNotification needs messageVar or message, else a blank box pops on the client; funcSettingList must be non-empty), bpmn (a UserTask needs assignee+formSetting.tableId+at least one button / a return edge must not form a cycle from all-unconditional flows — carry a conditionExpression or use a TaskMoveToActivity button), listeners (eventList elements must be event-ID strings not objects / no top-level tableId / invokeType must have its executor), table (business fields must not be named id·seq / relation fields need a real target tableId), schedule (invokeType must have its executor / cron type needs a cron). The message includes a compact checklist; fix the payload per the checklist and re-call — no re-reading required. Fires only on an actual violation and never on legitimate variation.
• Relation-modeling finish gate (part of exit 7): in full-app orchestration, if the planned table count is ≥2 but no Relation (M:N) or LookupList (1:N) field exists anywhere in the app, the finish self-check judges the model too flat (all relations are N:1) and blocks, asking you to add master→detail LookupLists / many-to-many Relations by semantics instead of making every link a single RelationRecord.
• Transient network errors auto-retry: a 5xx (including intermittent HTTP 550) / timeout / connection-reset is retried with backoff up to 4 times; 4xx and JSON-RPC application errors are not retried. On an intermittent network error just re-issue the same call — do not change parameters that were already correct.
• Domain soft reminder (emitted once per domain per session, on the first build of that domain): after the first object of a domain is built successfully, a ≤8-line checklist for that domain is appended to the response (rules that cannot be machine-checked — theme consistency / chart-type choice / workflows must be multi-node with branches, etc.), throttled by a marker so later calls have zero overhead. Self-check against it; do not ignore it.
• Register the blueprint contract with the _plan_set command ( call_informat.js _plan_set --appId <id> --threadId <threadId> '{"targets":{...}}'), do not write the file yourself — the process often changes into a read-only directory, so a self-written file cannot be located and the gates fail.

Getting Application ID#

bash

# 1. Query all application list
node {baseDir}/scripts/call_informat.js _company_app_list --threadId <threadId>

# 2. Find the target application ID from the returned results, use for subsequent calls
node {baseDir}/scripts/call_informat.js _query_app_define_designer --appId <appId> --threadId <threadId>

Configuration#

The server injects INFORMAT_HOST, INFORMAT_AGENT_TOKEN, and INFORMAT_AGENT_THREAD_ID at runtime. Calls only need to explicitly pass --threadId as described above. Never write or rely on scripts/.env.

INFORMAT_AGENT_TOKEN can be obtained at: /workbench/account/aiAgentApiKey

File Upload Required -- Important Rule#

When you generate any file (Excel, PPT, PDF, Word, CSV, images, etc.) that users need to download:

1. You MUST call _wb_upload_file to upload the file to platform storage
2. You MUST provide the returned downloadUrl to the user as the download link
3. NEVER return local server file paths to the user (users cannot access the server filesystem)

bash

# Example: Upload Excel after generation (base64 encoding, recommended for Docker compatibility)
# 1. Base64 encode the file and write params
node -e "const fs=require('fs');const b64=fs.readFileSync('/path/to/report.xlsx').toString('base64');fs.writeFileSync('params.json',JSON.stringify({fileName:'report.xlsx',fileContent:b64}))"
# 2. Call upload
node {baseDir}/scripts/call_informat.js _wb_upload_file --threadId <threadId> --file params.json
# Returns { "downloadUrl": "https://...", "fileName": "report.xlsx" }
# 3. Provide downloadUrl to the user

Complete Application Orchestration -- Intent Recognition + Requirement Alignment + Blueprint#

On receiving a request, do intent analysis first and split into two kinds — do NOT treat every request as a complete application:

• Single operation (one explicit action: add a table / query data / edit a field / create one automation) → go directly to the matching section under "Query Before Operation" below. Do NOT trigger this flow.
• Website / frontend application (the user asks for a website / official site / portal / frontend page / Vue application / H5, where the page experience is the main goal) → prefer _codestudio_* (AICodeStudio, a complete Vue 3 project). Follow the AICodeStudio guidance under "Website Resource - Website (Designer)": query or create the module, read informat.codestudio.md, write the Vue project, compile it, and preview it. Consider _website_* only for purely static display pages. Do not apply the default "data tables + dashboards + workflow" bundle to these requests unless the user explicitly also wants a backend business application.
• Complete application / system (the user says "build an XX system / management platform / app", regardless of whether some modules are already listed) → enter the complete-application flow. User-listed modules are only initial requirements; still align the blueprint first and do not build directly:

Iron rules:

1. Align first, act second: clarify business domain/core objects/roles/key process/reporting needs → a complete app defaults to only three required component types: data tables, dashboards, and 1 core workflow; automations/scripts/APIs/listeners/scheduled tasks are optional extensions and are included only when the user explicitly confirms they are needed → read the module design docs the blueprint will touch BEFORE producing it (required: tables→informat.table.md, dashboard→informat.dashboard.uipreset.md, workflow→informat.bpmn.md; optional components read their matching docs only if confirmed). Table structures / card types / flow nodes / field choices in the blueprint MUST be based on these docs' real presets, never invent from training memory (typical anti-pattern: dashboard described as "number card + progress bar" / "pie + number" — the only real card types are Number/ProChart/Record/Pivot/Table) → produce a structured blueprint (each card noting type + size + row + theme) → wait for explicit user confirmation; build nothing before confirmation.
2. Linkage iron rule + binding plan: dashboards/workflows and any confirmed optional automations/scripts/APIs/listeners/scheduled tasks must each state "which table or process it serves, why it exists, how it links"; cut whatever you cannot articulate. The blueprint must contain a "binding plan table": list line by line which workflow or optional automation binds to which table's which button (toolbar/form/ lookup-list·relation-list inline button _subtable_create_tool_bar_btn) or which listener/scheduled task — an action component that is created but not bound to an entry is unreachable by the user and equivalent to invalid configuration. Listeners/scheduled tasks are optional extensions; ask once during alignment when relevant, and build them only when meaningful and user-confirmed.
3. Solidify in 3 fixed-order steps: after the user confirms the blueprint, in order — ① first register the blueprint contract via _plan_set (by default only the required three: call_informat.js _plan_set --appId <id> --threadId <threadId> '{"targets":{"table":N,"dashboard":N,"workflow":1}}'; if the user confirmed optional components, append automatic/script/api/listener/schedule counts; dashboard counts cards; do not write the file yourself — the script saves it to a session-stable location); ② read all module design docs the targets touch (table→informat.table.md, dashboard→informat.dashboard.uipreset.md, workflow→informat.bpmn.md; optional components: automatic→informat.automatic.md, script→informat.script.md, api→informat.api.md, listener→informat.listeners.md, schedule→informat.schedule.md) so modeling is grounded in documents; ③ execute components one by one in the order below and pass _app_check_setting.
4. Execution order: app→master-data tables (people/departments/customers — real entities, not dictionaries)→complex tables (reference real fieldIds)→workflow (multi-node + branches; a complete app must build 1 core workflow, and its start button is created here)→dashboards→confirmed optional extensions→ _app_check_setting self-check→prompt the user to publish.
5. Finish gate: _app_check_setting checks built counts against plan.json (auto-counted by the script); below target it exits 7 and blocks, so the gaps must be filled before finishing — do not finish after only the major parts are done.
6. Maintain a progress file: on start cat informat_progress/<appId>.md to resume; after each step rewrite it (keep only Done-summary/Next/Key-IDs, bounded, no unbounded appending). It lets you resume quickly across conversations.
7. Finishing requires a passing publish-health check: if _app_check_setting returns any issue item (e.g. "module Ref not found …"), the script exits 9 and blocks. Those issues mean tables/modules are not actually attached to the app and publishing will fail — fix each one (recreate the missing module, rename conflicts), re-run the self-check until it returns an empty list, and only then report completion. Do not finish while unresolved issues remain, and do not falsely claim "build complete".

Build Calls Must Be Sequential — No Parallelism (Critical)#

Create/save/edit/delete calls that write app structure (create table _create_table_module, create fields, create dashboard cards _save_dashboard_*, create workflow nodes/flows _bpmn_*, _automatic_save_define, _api_create_define, _save_informat_script, etc.) must be executed one at a time, strictly sequentially. Never issue several at once with & / background / parallel batches.

Reason: each such call, on the backend, is "load the whole app module tree → add itself → save the whole tree back". Running several in parallel makes them overwrite each other, so tables/modules are created but not attached to the app module tree (invisible in the left panel, publish reports refNotFound). Actual incident: a for f in …; do node … & done; wait that created 8 tables in parallel ended up with only 2 surviving.

Iron rule: issue one write call, wait for its response, then issue the next. When many tables/cards are needed, loop sequentially — no &. (The script has a serialization lock as a backstop, but do not parallelize intentionally — it only queues and adds latency.)

Query Before Operation -- The Most Important Rule#

Before performing any create or modify operation, you must first query the system's existing structure and obtain real IDs. Never fabricate any ID or field name.

Querying the list alone is not enough - you must further query the complete field structure of each related table. Because creating relational fields requires the target table's field IDs, knowing only the table ID is insufficient.

Before Creating an Application#

text

1. _company_app_list          -> Get all existing applications including unique app identifiers

Before Creating a Data Table#

text

1. _query_table_list_designer          -> Get all existing tables and their IDs
2. For each table that might be referenced, call
   _query_table_define_designer        -> Get the complete field list (field IDs, field types, option values, etc.)
   This step cannot be skipped because relational fields require the target table's field IDs
3. cat {baseDir}/references/system_create_table_module.json  -> Read parameter documentation
4. Use the queried real table IDs and field IDs to construct parameters and create the new table

Why you must query each table's field structure:

• RelationRecord fields require tableId (target table ID) and nameFieldId (field ID in target table used for display)
• RelationRecordField fields require fieldId (foreign key field ID in current table), targetTableId, targetFieldId
• LookupList fields require sub-table ID and the foreign key field ID in the sub-table
• LookupRollup fields require sub-table ID and the aggregation field ID in the sub-table
• These IDs can only be obtained through _query_table_define_designer queries

Default table-modeling rules (see top of informat.table.md; the build doc gate will require reading it):

• Fixed-choice fields (status/type/priority) use ListSelect single/multi, do not create "dictionary table + text field".
• Relations pick one of three by semantics: RelationRecord (N:1) / Relation (M:N) / LookupList (1:N) — do not use RelationRecord exclusively throughout.
• RelationRecord/Relation/LookupList must set display fields (not only the primary display column).
• Business tables need sufficient fields (code+name+basic info+status+key dates+people+relations+amount/qty+remarks+attachments), not only three to five.

Before Creating Dashboard Cards#

text

1. _query_table_list_designer          -> Get all table IDs
2. For the target data source table, call
   _query_table_define_designer        -> Get all field IDs and field types for the table
   Without querying field structure, you cannot correctly configure aggregation fields, group fields, and filter conditions
3. _read_informat_dashboard_document   -> Get dashboard documentation
4. _read_informat_dashboard_ui_preset  -> Get UI presets (when the user does not explicitly specify styles, you must fill cardStyle per the presets;
   all cards in the same dashboard must use the same theme palette; before creating multiple cards, pick one of the 6 layout templates first)
5. Read the parameter documentation for the card type:
   cat {baseDir}/references/system_save_dashboard_prochart_card.json  (chart)
   or system_save_dashboard_number_card.json  (number)
   or system_save_dashboard_record_card.json  (record)
   or system_save_dashboard_pivot_card.json   (pivot)
   or system_save_dashboard_table_card.json   (table)
6. Use the queried real field IDs to construct card parameters
7. Dashboard cards must be tested after publishing to confirm the user-side view is not blank, misaligned, or stuck on a no-data placeholder

Before Creating Automation#

text

1. _query_app_define_designer          -> Get module list and existing automation groups
2. _query_table_list_designer          -> Get all table IDs
3. For each table involved in the automation, call
   _query_table_define_designer        -> Get field IDs (field mapping and filter conditions in automation steps require real field IDs)
4. _automatic_doc                      -> Get automation documentation
5. cat {baseDir}/references/system_automatic_save_define.json  -> Read parameter documentation
6. Use the queried real IDs to construct automation steps

Before Creating Workflow#

text

1. cat references/doc/markdown/informat.bpmn.md -> workflow design doc (required; calling _bpmn_* is gated by the doc-read gate)
2. _query_app_define_designer -> Get module list
3. _query_table_list_designer + _query_table_define_designer -> Get tables and fields
4. _read_informat_expression_doc -> Get expression documentation (assignee/flow conditions are expressions)
5. Read the corresponding parameter documentation
6. Create in order: module -> process definition -> start configuration -> _bpmn_query_process_define to get StartEvent id -> multiple approval nodes (full form fields + approve/reject buttons + x/y) -> sequence flows (branch via multiple conditional flows from one source + one default) -> bind start button on the main table
   The workflow must be multi-node, branched, fully wired, and table-bound — not a single node

Before Creating Scripts#

text

1. _query_informat_script_list -> Get existing scripts and directories
2. _read_informat_script_sdk -> Get script SDK documentation
3. [Mandatory] Before calling any informat.<module>.*, you must Read {baseDir}/references/doc/markdown/script/<module>.md (e.g. table.md, bpmn.md, http.md) to verify exact signatures (argument count/order/position) — do not write from memory; on save, call_informat.js validates this and blocks with exit 5 if unread. Common errors: informat.table.queryList is (tableId, query), not tableId placed inside query; update is (tableId, data) with two args and the id inside data
4. First use _create_informat_script_directory to create directories by function (api/service/utils/mapper, etc.), and split scripts by responsibility into the right directory — never place all functions in a single js file
5. Read cat {baseDir}/references/system_save_informat_script.json
6. Create or edit script (when editing, must pass the existing script ID, do not create duplicates)

Before Editing Fields#

text

1. _query_table_list_designer -> Find the target table
2. _query_table_define_designer -> Get the complete field list of the table
3. _read_informat_expression_doc -> If expression configuration is needed
4. Read cat {baseDir}/references/system_edit_table_field.json
5. Use real tableId and fieldId to operate

Before Operating Data Records#

text

1. _query_all_table_list -> Get published table IDs
2. _query_table_define -> Get published field structure
3. Read the corresponding parameter documentation
4. Use real field IDs to construct record data

Workbench Agent Method List#

SideMethod NameDescriptionParameter Document[User]_wb_set_curr_appidSet current session context application IDreferences/system_wb_set_curr_appid.json MUST READ[User]_wb_process_define_listGet workflow list available to current usernone[User]_wb_get_process_defineGet specified workflow process definition configurationreferences/system_wb_get_process_define.json MUST READ[User]_wb_get_table_infoGet specified data table structure informationreferences/system_wb_get_table_info.json MUST READ[User]_wb_get_login_infoGet my login info including user info and system configurationnone[User]_wb_create_instanceCreate and start workflow process instancereferences/system_wb_create_instance.json MUST READ[User]_wb_query_instance_listQuery all process instances initiated by current user (cross-app)references/system_wb_query_instance_list.json MUST READ[User]_wb_query_instance_infoQuery workbench process instance detailsreferences/system_wb_query_instance_info.json MUST READ[User]_wb_query_task_listQuery workbench workflow task list (cross-app)references/system_wb_query_task_list.json MUST READ[User]_wb_query_task_infoQuery workbench workflow task detailsreferences/system_wb_query_task_info.json MUST READ[User]_wb_complete_taskComplete (approve) workbench workflow taskreferences/system_wb_complete_task.json MUST READ[User]_wb_ask_aiAsk AI assistantreferences/system_wb_ask_ai.json MUST READ[User]_wb_upload_fileUpload file to platform storage and return download URLreferences/system_wb_upload_file.json MUST READ

Team Agent Method List#

SideMethod NameDescriptionParameter Document[Team]_company_app_listQuery application listnone[Team]_company_app_createCreate applicationreferences/system_company_app_create.json MUST READ[Team]_company_app_updateUpdate team application info (name, group, etc.)references/system_company_app_update.json MUST READ[Team]_company_app_group_listGet application group listnone[Team]_company_app_group_createCreate application groupreferences/system_company_app_group_create.json MUST READ[Team]_company_app_group_updateUpdate application groupreferences/system_company_app_group_update.json MUST READ[Team]_company_app_group_deleteDelete application group (dangerous operation)references/system_company_app_group_delete.json MUST READ[Team]_company_department_listGet team department listnone[Team]_company_department_createCreate a new department in the companyreferences/system_company_department_create.json MUST READ[Team]_company_department_updateUpdate an existing department in the companyreferences/system_company_department_update.json MUST READ[Team]_company_department_deleteDelete an existing department in the company (dangerous operation)references/system_company_department_delete.json MUST READ[Team]_company_role_listQuery role listnone[Team]_company_role_createCreate a new role in the companyreferences/system_company_role_create.json MUST READ[Team]_company_role_updateUpdate an existing role in the companyreferences/system_company_role_update.json MUST READ[Team]_company_role_deleteDelete an existing role in the company (dangerous operation)references/system_company_role_delete.json MUST READ[Team]_company_role_permission_listQuery available role permissionsnone[Team]_company_member_listQuery team member listreferences/system_company_member_list.json MUST READ[Team]_company_member_list_countGet the total count of company membersnone[Team]_company_member_createAdd existing account as team memberreferences/system_company_member_create.json MUST READ[Team]_company_member_create_newCreate new account and add as team memberreferences/system_company_member_create_new.json MUST READ[Team]_company_member_updateUpdate team memberreferences/system_company_member_update.json MUST READ[Team]_company_member_deleteDelete team member (dangerous operation)references/system_company_member_delete.json MUST READ[Team]_company_member_infoQuery team member detailsreferences/system_company_member_info.json MUST READ[Team]_company_get_ai_model_listGet team AI model listnone[Team]_company_knowledgebase_searchSearch team knowledge base by keywordreferences/system_company_knowledgebase_search.json MUST READ[Team]_company_knowledgebase_listList team knowledge-base folders available to the current accountreferences/system_company_knowledgebase_list.json MUST READ[Team]_company_expert_listQuery team expert listreferences/system_company_expert_list.json MUST READ[Team]_company_expert_getGet complete team expert configurationreferences/system_company_expert_get.json MUST READ[Team]_company_expert_saveCreate or update a team expertreferences/system_company_expert_save.json MUST READ[Team]_company_expert_team_getGet complete team expert team configurationreferences/system_company_expert_team_get.json MUST READ[Team]_company_expert_team_saveCreate or update a team expert teamreferences/system_company_expert_team_save.json MUST READ

Application Agent Method List#

[Designer] = Draft environment. [User] = Published environment.

API (Designer)#

SideMethod NameDescriptionParameter Document[Designer]_api_create_defineCreate API definition (optional parentId to group it)references/system_api_create_define.json MUST READ[Designer]_api_create_directoryCreate API group directory (deduped by name, returns dir id for parentId)references/system_api_create_directory.json MUST READ[Designer]_api_delete_defineDelete API definition (dangerous operation)references/system_api_delete_define.json MUST READ[Designer]_api_docQuery Informat API documentationnone[Designer]_api_query_define_designerQuery single API detailed definitionreferences/system_api_query_define_designer.json MUST READ[Designer]_api_query_define_listQuery API definition list under applicationnone[Designer]_api_update_defineUpdate API definition, updateFieldList declares fields to modifyreferences/system_api_update_define.json MUST READ

App (Designer)#

SideMethod NameDescriptionParameter Document[Designer]_app_check_settingValidate draft configuration legality before publishingnone[Designer]_app_create_roleCreate application rolereferences/system_app_create_role.json MUST READ[Designer]_app_query_role_by_idQuery application role details by role key (permissionList returns module key format)references/system_app_query_role_by_id.json MUST READ[Designer]_app_update_roleUpdate application role name and remark, updateFieldList declares fields to modifyreferences/system_app_update_role.json MUST READ[Designer]_app_permission_listQuery custom app permissions (table moduleId returns table key)none[Designer]_app_permission_createCreate custom app permission (pass table key as moduleId for table modules)references/system_app_permission_create.json MUST READ[Designer]_app_permission_updateUpdate custom app permission, updateFieldList declares fields to modifyreferences/system_app_permission_update.json MUST READ[Designer]_app_permission_deleteDelete custom app permission and remove it from rolesreferences/system_app_permission_delete.json MUST READ[Designer]_app_delete_draft_defineDelete draft version Define (irreversible)references/system_app_delete_draft_define.json MUST READ[Designer]_app_get_define_listGet application definition object listreferences/system_app_get_define_list.json MUST READ[Designer]_app_get_define_objectGet single definition object detailsreferences/system_app_get_define_object.json MUST READ[Designer]_app_get_define_typeGet supported definition object typesnone[Designer]_app_define_object_log_countQuery design change log countreferences/system_app_define_object_log_count.json MUST READ[Designer]_app_get_draft_define_countDraft change count statisticsnone[Designer]_app_get_draft_define_listDraft object listnone[Designer]_app_publishPublish application to productionreferences/system_app_publish.json MUST READ[Designer]_app_set_themestyleSet application theme style (query _app_themestyle_doc first)references/system_app_set_themestyle.json MUST READ[Designer]_app_update_basic_infoUpdate application basic information (theme color, menu colors, navigation bar style, etc.)references/system_app_update_basic_info.json MUST READ[Designer]_app_themestyle_docQuery application theme style documentationnone[Designer]_query_app_define_designerQuery designer application configuration (module list, roles, APIs, automation groups, etc.)none[Designer]_create_module_groupCreate module groupreferences/system_create_module_group.json MUST READ[Designer]_update_module_and_group_orderUpdate module sortingreferences/system_update_module_and_group_order.json MUST READ

Data Table - Table (Designer)#

SideMethod NameDescriptionParameter Document[Designer]_create_table_moduleCreate data table (must query existing tables and field structures first)references/system_create_table_module.json MUST READ[Designer]_create_table_field_groupCreate data table field groupreferences/system_create_table_field_group.json MUST READ[Designer]_update_table_field_groupUpdate data table field groupreferences/system_update_table_field_group.json MUST READ[Designer]_table_save_filter_conditionSet data table view filter conditionreferences/system_table_save_filter_condition.json MUST READ[Designer]_table_save_datasource_dbviewSave database view table SQL configurationreferences/system_table_save_datasource_dbview.json MUST READ[Designer]_table_create_tool_bar_buttonCreate data table toolbar button (supports calling script or automation)references/system_table_create_tool_bar_button.json MUST READ[Designer]_table_list_tool_bar_buttonQuery data table toolbar button listreferences/system_table_list_tool_bar_button.json MUST READ[Designer]_table_update_tool_bar_buttonUpdate data table toolbar buttonreferences/system_table_update_tool_bar_button.json MUST READ[Designer]_table_delete_tool_bar_buttonDelete data table toolbar buttonreferences/system_table_delete_tool_bar_button.json MUST READ[Designer]_table_create_form_tool_bar_btnCreate data table form toolbar button (supports calling script or automation)references/system_table_create_form_tool_bar_btn.json MUST READ[Designer]_table_list_form_tool_bar_btnQuery data table form toolbar button listreferences/system_table_list_form_tool_bar_btn.json MUST READ[Designer]_table_update_form_tool_bar_btnUpdate data table form toolbar buttonreferences/system_table_update_form_tool_bar_btn.json MUST READ[Designer]_table_del_form_tool_bar_btnDelete data table form toolbar buttonreferences/system_table_del_form_tool_bar_btn.json MUST READ[Designer]_subtable_create_tool_bar_btnCreate subtable toolbar button (Relation/LookupList fields only, supports add row, delete, call script or automation)references/system_subtable_create_tool_bar_btn.json MUST READ[Designer]_subtable_list_tool_bar_btnQuery subtable toolbar button listreferences/system_subtable_list_tool_bar_btn.json MUST READ[Designer]_subtable_update_tool_bar_btnUpdate subtable toolbar buttonreferences/system_subtable_update_tool_bar_btn.json MUST READ[Designer]_subtable_delete_tool_bar_btnDelete subtable toolbar buttonreferences/system_subtable_delete_tool_bar_btn.json MUST READ[Designer]_query_table_list_designerQuery all tables in designer (including unpublished, does not return field structure)none[Designer]_query_table_define_designerQuery designer data table field structurereferences/system_query_table_define_designer.json MUST READ[Designer]_query_table_field_designerQuery single field detailed configurationreferences/system_query_table_field_designer.json MUST READ[Designer]_edit_table_fieldEdit field (must query table structure to get real IDs first)references/system_edit_table_field.json MUST READ[Designer]_edit_table_moduleModify data table module informationreferences/system_edit_table_module.json MUST READ

Workflow - Bpmn (Designer)#

SideMethod NameDescriptionParameter Document[Designer]_bpmn_create_moduleCreate workflow modulereferences/system_bpmn_create_module.json MUST READ[Designer]_bpmn_create_process_defineCreate process definitionreferences/system_bpmn_create_process_define.json MUST READ[Designer]_bpmn_update_start_settingUpdate process start configurationreferences/system_bpmn_update_start_setting.json MUST READ[Designer]_bpmn_create_or_update_nodeCreate/update process nodereferences/system_bpmn_create_or_update_node.json MUST READ[Designer]_bpmn_create_or_update_flowCreate/update sequence flowreferences/system_bpmn_create_or_update_flow.json MUST READ[Designer]_bpmn_delete_nodeDelete process nodereferences/system_bpmn_delete_node.json MUST READ[Designer]_bpmn_delete_flowDelete sequence flowreferences/system_bpmn_delete_flow.json MUST READ[Designer]_bpmn_query_process_defineQuery process definition detailsreferences/system_bpmn_query_process_define.json MUST READ[Designer]_bpmn_query_process_define_listQuery process definition list under modulereferences/system_bpmn_query_process_define_list.json MUST READ

Automation - Automatic (Designer)#

SideMethod NameDescriptionParameter Document[Designer]_automatic_create_groupCreate automation group (query _query_app_define_designer first to avoid duplication)references/system_automatic_create_group.json MUST READ[Designer]_automatic_delete_groupDelete automation groupreferences/system_automatic_delete_group.json MUST READ[Designer]_automatic_update_groupEdit automation groupreferences/system_automatic_update_group.json MUST READ[Designer]_automatic_save_defineSave automation configuration (must query table structure to get field IDs before creation)references/system_automatic_save_define.json MUST READ[Designer]_automatic_query_defineQuery automation configurationreferences/system_automatic_query_define.json MUST READ[Designer]_automatic_run_onceExecute automation immediately (high risk, confirm first)references/system_automatic_run_once.json MUST READ[Designer]_automatic_docRead automation documentationnone

Dashboard (Designer)#

SideMethod NameDescriptionParameter Document[Designer]_create_dashboard_moduleCreate dashboard modulereferences/system_create_dashboard_module.json MUST READ[Designer]_query_dashboard_list_designerQuery all dashboardsnone[Designer]_query_dashboard_card_listQuery dashboard card listreferences/system_query_dashboard_card_list.json MUST READ[Designer]_query_dashboard_card_detailQuery card detailsreferences/system_query_dashboard_card_detail.json MUST READ[Designer]_delete_dashboard_cardDelete dashboard cardreferences/system_delete_dashboard_card.json MUST READ[Designer]_save_dashboard_number_cardCreate/edit number card (query table structure to get field IDs first)references/system_save_dashboard_number_card.json MUST READ[Designer]_save_dashboard_prochart_cardCreate/edit chart card (query table structure to get field IDs first)references/system_save_dashboard_prochart_card.json MUST READ[Designer]_save_dashboard_record_cardCreate/edit record card (Record type, displays data source table records with filter/sort/column config/pagination, columnList required)references/system_save_dashboard_record_card.json MUST READ[Designer]_save_dashboard_pivot_cardCreate/edit pivot card (Pivot type, cross-grouping by row/column dimensions with value field aggregation, colFieldId required)references/system_save_dashboard_pivot_card.json MUST READ[Designer]_save_dashboard_table_cardCreate/edit table card (Table type, data source is automation or expression, does not read data tables directly)references/system_save_dashboard_table_card.json MUST READ[Designer]_read_informat_dashboard_documentInformat dashboard chart documentationnone[Designer]_read_informat_dashboard_ui_presetRead dashboard UI preset documentation (7 theme palettes, 6 layout templates, card style presets, beautified defaults per chart type; must call before every card create/edit)none

Script (Designer)#

SideMethod NameDescriptionParameter Document[Designer]_create_informat_script_directoryCreate script directoryreferences/system_create_informat_script_directory.json MUST READ[Designer]_save_informat_scriptSave script (must pass existing ID when editing)references/system_save_informat_script.json MUST READ[Designer]_query_informat_script_listQuery script listnone[Designer]_query_informat_script_contentQuery script contentreferences/system_query_informat_script_content.json MUST READ[Designer]_execute_informat_script_designerExecute script in designerreferences/system_execute_informat_script_designer.json MUST READ[Designer]_script_save_git_configSave script Git repository configurationreferences/system_script_save_git_config.json MUST READ[Designer]_script_pull_from_gitPull scripts from Git repository to applicationnone[Designer]_script_push_to_gitPush application scripts to Git repositoryreferences/system_script_push_to_git.json MUST READ

Scheduled Task - Schedule (Designer)#

SideMethod NameDescriptionParameter Document[Designer]_schedule_create_defineCreate scheduled taskreferences/system_schedule_create_define.json MUST READ[Designer]_schedule_update_defineUpdate scheduled taskreferences/system_schedule_update_define.json MUST READ[Designer]_schedule_delete_defineDelete scheduled taskreferences/system_schedule_delete_define.json MUST READ[Designer]_schedule_query_define_designerQuery scheduled task detailsreferences/system_schedule_query_define_designer.json MUST READ[Designer]_schedule_query_define_listQuery scheduled task listnone[Designer]_schedule_run_onceTrigger once immediatelyreferences/system_schedule_run_once.json MUST READ[Designer]_schedule_docQuery scheduled task documentationnone

Internationalization - I18n (Designer)#

SideMethod NameDescriptionParameter Document[Designer]_i18n_query_define_designerQuery internationalization configurationnone[Designer]_i18n_save_define_designerSave translation definitionreferences/system_i18n_save_define_designer.json MUST READ[Designer]_i18n_save_locale_designerSave language listreferences/system_i18n_save_locale_designer.json MUST READ[Designer]_i18n_set_app_nameSet application internationalized namereferences/system_i18n_set_app_name.json MUST READ[Designer]_i18n_set_module_nameSet module internationalized namereferences/system_i18n_set_module_name.json MUST READ[Designer]_i18n_set_table_field_nameSet field internationalized namereferences/system_i18n_set_table_field_name.json MUST READ[Designer]_i18n_set_field_option_nameSet option value internationalized namereferences/system_i18n_set_field_option_name.json MUST READ

Website Resource - Website (Designer)#

SideMethod NameDescriptionParameter Document[Designer]_website_create_moduleCreate website module (query first to avoid duplication)references/system_website_create_module.json MUST READ[Designer]_website_create_directoryCreate resource directoryreferences/system_website_create_directory.json MUST READ[Designer]_website_save_resourceCreate/edit resource (query ID first when editing)references/system_website_save_resource.json MUST READ[Designer]_website_delete_resourceDelete resourcereferences/system_website_delete_resource.json MUST READ[Designer]_website_query_define_designerQuery website module detailsreferences/system_website_query_define_designer.json MUST READ[Designer]_website_query_list_designerQuery all website modulesnone[Designer]_website_query_resourceQuery resource detailsreferences/system_website_query_resource.json MUST READ[Designer]_website_previewPreview websitereferences/system_website_preview.json MUST READ[Designer]_website_read_informat_docRead website designer documentationnone[Designer]_codestudio_list_modulesList existing AICodeStudio modules of the current app (query before creating; reuse when possible)none[Designer]_codestudio_create_moduleCreate AICodeStudio module (full Vue3 project, returns moduleId)references/system_codestudio_create_module.json MUST READ[Designer]_codestudio_list_filesList all source files of the modulereferences/system_codestudio_list_files.json MUST READ[Designer]_codestudio_read_fileRead a single source filereferences/system_codestudio_read_file.json MUST READ[Designer]_codestudio_write_fileCreate/overwrite a single source filereferences/system_codestudio_write_file.json MUST READ[Designer]_codestudio_create_scriptCreate/update a script for the module (auto ai_{moduleId}_ prefix + comment + group)references/system_codestudio_create_script.json MUST READ[Designer]_codestudio_create_apiCreate/update an API for the module (auto ai/{moduleId}/ prefix + group)references/system_codestudio_create_api.json MUST READ[Designer]_codestudio_compileCompile and return structured build errors (always call after writing; self-fix from errors)references/system_codestudio_compile.json MUST READ[Designer]_codestudio_previewGet the preview URLreferences/system_codestudio_preview.json MUST READ

Frontend/website choice guidance: For interactive, component-based frontends with routing/state/charts → prefer _codestudio_* (AICodeStudio, full Vue3 project); use _website_* only for purely static display pages. Pick one per requirement; do not mix. ★ Query before creating: Before calling _codestudio_create_module, you MUST first call _codestudio_list_modules to check whether the current app already has a suitable AICodeStudio module — reuse its moduleId if so. Do not create duplicate modules in the same app. ★★ Before building a codestudio app, you MUST read references/doc/markdown/informat.codestudio.md in full (the end-to-end guide: create module → query tables → create scripts → create APIs → write Vue → compile → preview, covering script signature / error envelope / callApi unwrap / file-write boundary / npm whitelist and every known pitfall). Calling _codestudio_* without reading it almost always fails. ★ codestudio data-binding rule: When a codestudio module needs to read/write platform table data, scripts/APIs MUST be created via _codestudio_create_script / _codestudio_create_api (backend auto-applies the ai_{moduleId}_ / ai/{moduleId}/ prefix + grouping, and same-name scripts / same-path APIs update the original resource). Do NOT use raw _save_informat_script / _api_create_define, and do NOT create xxx2/list2 to bypass duplicates — otherwise resources won't be attributed to the module or will pollute the app with duplicates. In Vue, callApi(path) uses the full path returned by _codestudio_create_api.

AI Assistant (Designer)#

SideMethod NameDescriptionParameter Document[Designer]_aiassistant_createCreate AI assistant modulereferences/system_aiassistant_create.json MUST READ[Designer]_aiassistant_updateUpdate AI assistant modulereferences/system_aiassistant_update.json MUST READ[Designer]_aiassistant_deleteDelete AI assistant modulereferences/system_aiassistant_delete.json MUST READ[Designer]_aiassistant_docQuery AI assistant documentationnone

App Listener (Designer)#

SideMethod NameDescriptionParameter Document[Designer]_app_listener_createCreate a new listener definitionreferences/system_app_listener_create.json MUST READ[Designer]_app_listener_updateUpdate listener definition, updateFieldList declares fields to modifyreferences/system_app_listener_update.json MUST READ[Designer]_app_listener_deleteDelete listener definition (if it's a directory, all listeners under it will also be deleted)references/system_app_listener_delete.json MUST READ[Designer]_app_listener_listQuery listener definition list under current application (tree structure, includes directories and sub-listeners)none

Survey (Designer)#

SideMethod NameDescriptionParameter Document[Designer]_survey_create_moduleCreate survey modulereferences/system_survey_create_module.json MUST READ[Designer]_survey_create_itemCreate survey questionreferences/system_survey_create_item.json MUST READ[Designer]_survey_update_itemUpdate survey questionreferences/system_survey_update_item.json MUST READ[Designer]_survey_delete_itemDelete survey questionreferences/system_survey_delete_item.json MUST READ[Designer]_survey_query_define_designerQuery survey configurationreferences/system_survey_query_define_designer.json MUST READ

App (User)#

SideMethod NameDescriptionParameter Document[User]_query_app_defineQuery published application configuration (module list, roles, APIs, etc.)none[User]_query_app_userQuery current user's roles and permissions in this application (admin has all permissions without permissionList; non-admin returns moduleKey_PermissionName format)none[User]_query_app_user_listQuery account information (ID, email, supervisor, department)references/system_query_app_user_list.json MUST READ[Team]_wb_create_user_scheduleCreate a team scheduled task (UserSchedule/t_user_schedule), not an application designer scheduled taskreferences/system_wb_create_user_schedule.json MUST READ[User]_app_member_createAdd existing team members to the current applicationreferences/system_app_member_create.json MUST READ[User]_app_member_updateUpdate application member role informationreferences/system_app_member_update.json MUST READ[User]_app_member_deleteRemove a member from the current application (dangerous operation)references/system_app_member_delete.json MUST READ

Data Table - Table (User)#

SideMethod NameDescriptionParameter Document[User]_query_all_table_listQuery all published data tables (does not return field structure)none[User]_query_table_defineQuery published table field structure (for record operations)references/system_query_table_define.json MUST READ[User]_query_table_record_listQuery data table records by conditionreferences/system_query_table_record_list.json MUST READ[User]_query_table_record_list_countCount records matching conditionsreferences/system_query_table_record_list_count.json MUST READ[User]_table_record_batch_insertBatch insert records (query table structure to get field IDs first)references/system_table_record_batch_insert.json MUST READ[User]_table_record_batch_updateBatch update recordsreferences/system_table_record_batch_update.json MUST READ[User]_table_record_batch_deleteBatch delete records (dangerous operation)references/system_table_record_batch_delete.json MUST READ

Workflow - Bpmn (User)#

SideMethod NameDescriptionParameter Document[User]_bpmn_create_instanceCreate and start workflow process instance (query process definition first)references/system_bpmn_create_instance.json MUST READ[User]_bpmn_query_instance_listQuery process instances initiated by current userreferences/system_bpmn_query_instance_list.json MUST READ[User]_bpmn_query_instance_infoQuery process instance detailsreferences/system_bpmn_query_instance_info.json MUST READ[User]_bpmn_query_task_listQuery workflow tasks assigned to current userreferences/system_bpmn_query_task_list.json MUST READ[User]_bpmn_query_task_infoQuery workflow task detailsreferences/system_bpmn_query_task_info.json MUST READ[User]_bpmn_complete_taskComplete (approve) workflow taskreferences/system_bpmn_complete_task.json MUST READ[User]_bpmn_process_define_listGet process definition listnone[User]_bpmn_get_process_defineGet process definition detailsreferences/system_bpmn_get_process_define.json MUST READ

Search Engine - Textindex (User)#

SideMethod NameDescriptionParameter Document[User]_query_all_textindex_listQuery search engine module listnone[User]_textindex_searchSearch engine keyword searchreferences/system_textindex_search.json MUST READ

Knowledge Base - Knowledgebase (User)#

SideMethod NameDescriptionParameter Document[User]_knowledgebase_searchKnowledge base keyword searchreferences/system_knowledgebase_search.json MUST READ

Notification (User)#

SideMethod NameDescriptionParameter Document[User]_send_notificationSend in-app notificationreferences/system_send_notification.json MUST READ

Common Agent Method List#

The following methods do not require --appId, call them directly.

SideMethod NameDescriptionParameter Document[Common]_app_get_web_urlGet application Web root URLnone[Common]_app_docQuery application documentationnone[Common]_javascript_evalExecute JavaScript codereferences/system_javascript_eval.json MUST READ[Common]_render_htmlRender HTML contentreferences/system_render_html.json MUST READ[Common]_web_contentGet web URL contentreferences/system_web_content.json MUST READ[Common]_get_current_timeGet current timenone[Common]_get_current_userGet current usernone[Common]_read_informat_expression_docInformat expression documentationnone[Common]_read_informat_script_sdkInformat script SDK documentationnone[Common]_list_informat_markdownList all available Markdown documentsnone[Common]_read_informat_markdownRead specified Markdown document content (supports subdirectories like script/)references/system_read_informat_markdown.json MUST READ[Common]_read_office_fileRead Office document contentreferences/system_read_office_file.json MUST READ[Common]_send_system_emailSend emailreferences/system_send_system_email.json MUST READ

Note: _send_notification (send notification) and _read_informat_dashboard_document (dashboard documentation) are Application Agent methods and must be called with --appId.

Local Reference Documentation#

Consult directly without API calls, under {baseDir}/references/doc/ directory:

Core Feature Documentation ( doc/markdown/ directory):

Document FilenameDescriptioninformat.aiassistant.mdAI Assistant Development Documentationinformat.api.mdOpen API Documentationinformat.app.mdApplication Documentationinformat.bpmn.mdWorkflow design doc (six-step creation order + approval-node depth config + branching gateways + countersign/or-sign + x/y layout + table start button; must-read before building a workflow; calling _bpmn_* is gated by the doc-read gate)informat.app.role.mdApplication Role Permission Documentationinformat.app.themestyle.mdApplication Theme Style Documentationinformat.automatic.mdAutomation Process Documentationinformat.company.mdTeam Documentation (members, roles, organization structure)informat.dashboard.mdDashboard Development Documentationinformat.dashboard.uipreset.mdDashboard UI Preset Documentation (theme palettes, layout templates, card style presets)informat.expression.mdExpression Syntax Documentationinformat.listeners.mdApp Listener Documentationinformat.schedule.mdScheduled Task Documentationinformat.script.mdScript Development Overviewinformat.table.mdData Table Design Documentationinformat.website.mdWebsite Designer Documentationinformat.codestudio.mdAI Code Studio end-to-end guide (build a full Vue app via _codestudio_*: module→script→API→Vue→compile→preview)

Script API Documentation ( doc/markdown/script/ directory): Categorized by module (bpmn.md, table.md, http.md, etc.), with method descriptions, parameter definitions, and sample code.

FAQ#

Q: Application module identifier already exists? The module ID is already in use, you need to use a different one.

Q: How to get the module list of an application? Use _query_app_define_designer.

Q: Application access URL? {host}/app/{appId}