Configuring OT Backup

The Configuration page is where administrators and integrators define the building blocks used by daily users: equipment types, sequence availability, accounts, variables, agents and grouped application settings, including backup storage.

flowchart LR
  C[Configuration] --> ET[Equipment Types]
  C --> TS[Template Steps]
  C --> A[Accounts]
  C --> V[Substitution Variables]
  C --> AG[Agents]
  C --> U[Users]
  C --> S[Settings]
  S --> BS[Backup Storage]

Before you start

The Configuration page and its navigation link are available with either ViewConfiguration or any user-administration privilege:

Each tab has additional policies for its actions. If an action is hidden or fails because of access, ask an administrator to grant the matching claim.

Equipment Types

Equipment Types are reusable templates for equipment. They can include a name, icon, description, manual-backup setting, backup sequence and restore sequence. When a type is selected on equipment, its manual-backup setting and sequences can be copied into the equipment configuration.

For a full explanation of how sequences work, see Configuring Backup and Restore Sequences.

Required access

Creating an equipment type

Use the Create new section.

Select Upload-only Backup for equipment types whose backups are collected outside OT Backup. Equipment that uses the type inherits this setting, but it can be changed on the individual equipment. When editing an existing type, selecting Upload-only Backup removes its backup and restore sequences.

Editing existing equipment types

The All equipment types section lists every type. Use Search to find one, then choose:

If you leave an edited type with unsaved changes, OT Backup asks:

You have unsaved changes in '…' that will be lost if you continue. Are you sure you want to continue?

When deleting, OT Backup asks:

Are you sure you want to delete '…'?

The confirmation also shows whether any equipment currently uses the type.

Sequence editor

The sequence editor is opened from Add/Edit Backup Sequence and Add/Edit Restore Sequence. Because sequences are used throughout OT Backup, they have their own guide: Configuring Backup and Restore Sequences.

Template Steps

The Template Steps tab controls which steps are available when users build backup and restore sequences. Hidden steps are not offered in the sequence editor, but existing sequences that already contain them continue to work.

Custom steps are built with the Adapter SDK.

Required access

Using the tab

The tab has two lists:

Select one or more steps and move them between lists with the arrow buttons. Choose Save Configuration to save the state. OT Backup shows Template configuration saved successfully! when the change is saved.

Accounts

The Accounts tab stores reusable credentials. Equipment, backup storage, adapters and SMTP settings can refer to an account instead of storing credentials directly in each place.

These are not sign-in accounts. Local users and invitations are managed separately under Configuration → Users.

Required access

Using the tab

Use Search to filter accounts and Add account to create a new one.

The table shows:

The User dialog contains:

When editing an existing account with Set Password enabled, OT Backup asks:

Saving will reset the password. Is this your intention?

When deleting, OT Backup asks:

Are you sure you want to delete …?

Substitution Variables

Substitution variables are reusable text values that can be inserted into sequences, paths and other configuration where variables are supported.

Required access

Using the tab

Use Search to filter variables and Add variable to create one.

The table shows:

The Variable dialog contains:

When deleting, OT Backup asks:

Are you sure you want to delete …?

Agents

The Agents tab shows registered TEE agents and their status. Agents execute backup and restore jobs for equipment.

Required access

Using the tab

Use Search to filter agents and Refresh status to update the displayed state.

The table shows:

The Agent Installation Script panel contains a PowerShell script and Copy Script to Clipboard. Run it from an administrator PowerShell prompt on the target machine.

When deleting an agent, OT Backup asks:

Are you sure you want to delete …?

The confirmation also shows whether any equipment currently uses the agent.

Users

The Users tab, after Agents, manages OT Backup sign-in accounts, separately from the reusable credentials in Accounts. The tab is available with AddUser, EditUser or DeleteUser, without an additional role or sign-in-provider restriction.

Use Add User with AddUser to invite a local user. Select Edit beside a user to open its edit dialog; the adjacent three-dot menu contains additional actions. EditUser allows changes to local account details, reactivation and local-account recovery links. DeleteUser allows deactivation, revoking an invitation and permanent deletion of pending invitations or inactive established accounts. Deactivation retains the account. External users appear after their first eligible sign-in; their identity details and roles remain provider-managed. See User profile and administration for invitation, role and access-management details.

Settings

The Settings tab contains application-level settings grouped by feature, including the default backup storage used by backup and restore sequences. Expand a group to view and edit its settings. Changed values are marked as unsaved until you select Save changes.

Required access

Changing settings

Each settings group is collapsed when the page opens. Select a group to expand it, then select a value to edit it. The editor matches the setting: for example, text and number fields, checkboxes, option lists and schedule dialogs are shown where appropriate.

Changes are not saved immediately. After you change a value:

• Original value: … appears below the changed value so you can compare them.
• Unsaved changes appears at the top of the page.
• Save changes becomes available and saves all changed settings together.

Validation errors are shown with the affected value and must be corrected before the settings can be saved. In a text or number field, you can press Ctrl + Enter instead of selecting Save changes. After a successful save, the unsaved indicators clear and the displayed values become the new saved values.

If you switch to another Configuration tab or leave the page while changes are unsaved, OT Backup asks:

You have unsaved setting changes. Discard them and leave this page?

Cancel to remain on the Settings page with your changes, or confirm to discard them and restore the last saved values.

Setting groups

Every visible group is listed below. Groups with a larger workflow are explained in their dedicated guides instead of being repeated here.

Backup Storage

Expand the Backup Storage group in Settings and configure:

Select Save changes before Test Connection so the test uses the new values. While testing, the button shows Testing.... A successful connection test is required before running backup or restore jobs.

See Also

• Managing Equipment
• Configuring Backup and Restore Sequences
• Creating a Backup
• Restoring a Backup
• Cleanup
• SMTP Alert
• Adapter SDK