Skip to main content

Veritran Docs

Add or Edit a Register

You can add registers to Studio or modify the settings of existing ones from the Registers page (General > Registers).

Add a Register

To add a register to Studio, go to the Registers page and click New register.

Important

Registers are initially created in the middleware and configured by an admin. Before adding any registers to Studio, you must obtain the list of available registers with their number and type from your admin.

Refer to the table below to learn about the information available.

Name

Name that identifies the register on the list. Use characters from A-a to Z-z and numbers from 0 to 9 (no spaces or special characters).

Short description

Use a short description with relevant key words that help to understand what the register is for. This description appears on the list.

Description

Give details on what the register is used for. This description is visible for internal use.

Register Number

Number ID that identifies the register. Register numbers consist of numbers only and a maximum of 6 digits.

Important

Registers ranging from 1 to 1000 are global, which means that they are available for all the apps within the same Studio environment. Registers higher than 1000 are local, and therefore, they are specific for the main app or module selected.

Type

Select a type of register from the drop-down menu: Register or Array.

Site

This field determines whether the register will be local or global in scope. Local registers belong to a specific app and branch while global registers can be used in any app or branch in the environment.

To make the register local, select the app and branch where the register will be used.

To make the register global, leave this field blank.

When you finish editing, click Save.

Edit a Register

In the Registers page, click Edit next to the register you want to modify.

On the edit view of the register you selected, you can modify any of its attributes and values. Refer to the Add a Register section above to learn more about each editable field. When you finish editing, click Save.