Skip to main content

Usage

This page explains the basic usage flow of the AI-native Development Support Feature and its main features.

Basic Usage Flow​

Typical usage proceeds along the following flow.

  1. Develop locally — Develop your script assets as usual in VSCode and similar tools.
  2. Prepare a staging — Create a new staging from the staging list screen (or it is created automatically on the first deploy).
  3. Deploy assets — On the "Deployment" tab of the staging detail screen, upload and transfer your assets (an archive file). The latest deploy becomes the active environment for that staging.
  4. Switch to the staging — Run "Switch to this staging" on the list/detail screen. From then on, your session runs on this staging's assets.
  5. Verify behavior remotely — Open the actual screens and processes to check whether your assets are running.
  6. Return to main — When verification is done, return to the main environment with "Cancel switch."
Tip

When you want to reflect a fix, just redo the deploy in step 3. The old assets are replaced automatically.

Main Features​

The main features provided by the AI-native Development Support Feature are as follows. For definitions of each term, refer to the Glossary.

FeatureWhat You Can DoWhere to Operate
Staging managementCreate stagings, view list/details, edit descriptions, deleteList screen / detail screen
Participant (owner) managementAdd/remove participants for a staging"Owners" tab on detail screen
Deploy (asset transfer)Upload and transfer local assets (multiple files allowed) to a staging"Deployment" tab on detail screen
Staging switchSwitch your session to a staging / return to mainList screen / detail screen
Deploy operation historyView deploy/undeploy historyDeployment detail screen
UndeployDisable and discard active assetsDetail screen / deployment detail screen
Tenant environment setup executionRun setup definitions (DDL, initial data, various settings) included in assets"Tenant Environment Setup" tab on detail screen
Job executionRun jobs defined in the assets (Java jobs / script jobs)"Jobs" tab on detail screen
Sample data setup executionView and run the sample data setup definitions included in the assets"Sample Data Setup" area on detail screen
Routing checkCheck screen URLs provided by the current assets and launch them in a separate tab"Routing" tab on detail screen
Log checkView logs separated per staging"Logs" tab on detail screen
Development API key issuanceA link to the screen for issuing API keys for development"Related Information" on list screen

Staging Management​

  • Create: From "Create new staging" on the list screen, enter a staging ID and a description (optional) to create it.
  • View: Check registered stagings in the list, and open an individual staging from "Details."
  • Edit description: You can edit and save the description in the basic information on the detail screen.
  • Delete: Delete from "Delete" on the list/detail screen. Related assets are deleted as well (see Limitations).
Note

The list shows only the stagings you are participating in (as an owner).

Participant (Owner) Management​

  • On the "Owners" tab of the detail screen, you can add an owner by searching for users by keyword and selecting one from the candidates.
  • User names are displayed in the owner list.
  • You can remove unneeded owners from the list.
  • All owners are equal and can operate the same staging.
  • You cannot remove yourself directly from this screen (to prevent accidentally locking yourself out; if removal is needed, ask another owner).

Deploy (Asset Transfer)​

  • On the "Deployment" tab of the detail screen, upload an archive file by drag and drop or "Select file," and run "Deploy."
  • When you select and upload multiple files, they are combined into a single deployment. You can check the list of file names it contains on the deployment detail screen.
  • You can attach a deploy description (optional, e.g., v1.2.0 release candidate).
  • Once deployed, it becomes the latest and active assets for that staging.
  • If there is an existing deployment, it is automatically replaced (the old assets are undeployed).

Deploying with the Accel CLI​

You can also deploy from the command line using the Accel CLI. Only on the first time, you need to register the shared development server URL and an API key.

Issuing an API Key

Issue a development API key on the API key issuance screen. Be sure to issue it with a user who has owner privileges for the staging. The required scope when issuing the API key is development.

If the development support role has been granted to you, you can issue an API key yourself without asking the tenant administrator (in environments of 2026 Spring or earlier, velbench-1.2.0 or later).

Logging In with the Accel CLI

Log in with the Accel CLI using the shared development server URL and the issued API key. This operation is only needed the first time.

bunx @intra-mart/accel login

Deploying with the Accel CLI

This is a deploy using the Accel CLI command. In interactive mode, you enter the staging ID and the deploy description. You can also specify options and run it non-interactively.

bunx @intra-mart/accel deploy

# Check the options
bunx @intra-mart/accel deploy --help

The options are as follows.

  • --endpoint: Base URL for the iAP environment (e.g., https://example.org/imart). Can also be specified with the ACCEL_ENDPOINT environment variable.
  • --api-key: OAuth Bearer token. Using the ACCEL_API_KEY environment variable is recommended (argv may leak into the process list or CI logs).
  • --staging-id: The target staging ID (required in non-interactive mode).
  • --file: The path to the zip file to deploy (not limited to ./target/).
  • --additional-file: Paths of additional archive files to deploy (.imm / .zip, can be specified multiple times; extracted before the build artifact, in the specified order).
  • --description: The deploy description.
  • --tenant-setup: After deploying, run the tenant environment setup all at once without confirmation.
  • --sample-setup: After deploying, run the sample data setup all at once without confirmation.
  • --non-interactive: Non-interactive mode (no prompts; exits non-zero on failure).

After deploying with the Accel CLI in interactive mode, you are offered to run the tenant environment setup and the sample data setup, and a URL is issued for logging in directly to the shared development server and switching the staging. This is useful in development using coding agents, for example when you leave the build execution and the deploy itself to the agent, and then leave E2E testing and behavior verification to the agent.

Deploying Multiple Archives at Once

You can specify additional archive files (.imm / .zip) — such as shared imm files managed separately from the build artifact — multiple times with --additional-file, and transfer them all in a single deploy.

bunx @intra-mart/accel deploy \
--additional-file ./libs/common-master.imm \
--additional-file ./libs/common-theme.imm
  • Multiple files are extracted in the order they are sent; for entries with the same path, the one extracted later takes precedence (last wins).
  • The default order is "the order specified with --additional-file, then the build artifact (last)." In interactive mode, you can review and change the order before deploying (in non-interactive mode, this order is fixed).
  • Each specified path is validated for existence, extension (.imm / .zip), and duplicates; any violation results in an error exit.

Staging Switch​

  • Switch your session with "Switch to this staging" on the list/detail screen.
  • You can check the staging you are currently switched to in "Current staging" at the top of the list screen, or by the marker on each row.
  • "Cancel switch" / "Leave this staging" returns you to the main runtime (when not switched, "The main runtime is shown" is displayed).

Deploy Operation History​

  • In "Operation history" on the deployment detail screen, you can view the deploy/undeploy history for that deployment, along with the result, operator, and operation date/time.

Undeploy​

  • Disables an active deployment (STAGED state) and discards the runtime under the staging.
  • Undeploy can only be run when in the STAGED state.

Tenant Environment Setup Execution​

  • On the "Tenant Environment Setup" tab of the detail screen, you can run the setup definitions included in the assets of the current deployment (pre-processing / DDL / DML / various settings such as roles, accounts, calendars, menus, and authorizations).
  • You can run by section, or run "all at once." Selected sections are run in dependency order (pre-processing → DDL → DML → tenant master → extensions).
  • When a deployment contains multiple files, you can apply the assets of multiple modules together.
Caution

The results of setup execution are applied directly to the real tenant's database and are not isolated per staging. For details, refer to Limitations.

Job Execution​

  • The "Jobs" tab on the detail screen lists the jobs defined in the assets. You can select one from the list, run it, and check the result.
  • Two job types are supported: Java jobs and script (JSSP) jobs.
  • Jobs that do not appear in the list can also be run by manually entering the type and path to add a row.
  • You can specify the parameters passed to the job at run time.

Sample Data Setup Execution​

  • In the "Sample Data Setup" area of the detail screen, you can list the sample data setup configurations included in the assets and check the definitions for each configuration file.
  • You can run selected sections, or run all configurations at once.
  • After execution, the counts of "succeeded / failed / total" and the result for each definition are shown in a list.
Caution

The results of the sample data setup are also applied to the real tenant's database and cannot be undone. A warning is also shown in the confirmation dialog before execution.

Routing Check​

  • On the "Routing" tab of the detail screen, you can view a list of the URL patterns of the screens provided by the current deployment.
  • You can launch the target screen in a separate tab with "Open," but you must first switch to that staging (links before switching flow to the normal route on the main side and do not reach the target screen).

Log Check​

  • On the "Logs" tab of the detail screen, you can view logs separated per staging. Use this for troubleshooting and behavior verification.
  • You can "Refresh" and "Clear logs."