Instructions

Manage and organize Instruction Sets in the Platform by uploading DEX Packs, creating custom instruction groups, assigning permissions, and controlling access to Platform actions and automation workflows. This guide explains how to create, update, move, and delete instructions, helping administrators securely manage Platform functionality and user roles.

You can perform these tasks:

• Adding Instruction definitions into the Platform.

• Creating Instruction sets.

• Moving Instructions to Instruction sets.

• Deleting Instructions sets and Instructions.

• Updating Instructions.

Overview

Platform functionality is based around instructions. Until these are added to the system you will not be able to ask questions or perform actions.

Instructions are available to download and deploy using the TeamViewer DEX Hub in the Platform, or online at Hub (Exchange).

You can upload DEX Packs into the Platform using any of the following options:

• 1E Product Pack Deployment Tool (PPDT) which you can download from the TeamViewer Support Portal.

• Directly into 1E Platform using Settings > Instructions > Instruction Sets, refer to Instructions

• Using the PowerShell Toolkit.

The Instruction sets page enables users with the Full Administrator role, to add, remove and modify the DEX Packs used by the Platform. This page can be viewed by users with the All instructions actioner role.

Instruction sets and permissions

After you load an Instruction into the Platform, complete the following steps before users can work with it:

• Newly loaded Instructions are automatically assigned to the built-in Unassigned Instruction set.

• The Unassigned Instruction set is intended only as a staging area for newly loaded Instructions. Instructions in this set can't be used directly.

• An Instruction can belong to only one Instruction set.

• Before an Instruction can be used, move it from the Unassigned Instruction set to an Instruction set created by a Full Administrator.

• Instruction sets created by a Full Administrator can serve as the basis for custom roles created by a Full Administrator or Group Administrator.

• These custom roles determine the permissions for the Instruction set and all Instructions it contains.

• After configuring the roles, administrators can assign Instruction set roles to users and determine which Instructions they can complete, approve, question, or view.

Adding Instruction definitions

1. Click Upload on the header for the page.

2. In the Open dialog, locate and select the file(s) you want.

3. Click Open.

4. At this point all the Instructions from the selected DEX Packs or Instruction Definition files will be uploaded into the Platform and added to the default Unassigned Instruction set.

Creating Instruction sets

Instruction sets can be created in the following way.

1. Select the Instructions you want to move to the new set by checking the checkbox at the left-hand end of the instruction's row.

2. Click Add New set.

3. In the Add new instruction set popup, enter a suitable name for the Instruction set.

4. You can optionally add a custom icon, in JPG or PNG format, that will be used when displaying the instruction:

   1. Click Choose File.

   2. In the Open dialog, locate and select the JPG or PNG file you want to use.

   3. Click Open to load the file into the Platform.

   4. The file location and a preview of the file will be displayed in the popup.

5. Ensure that the Include n selected instructions checkbox is selected.

6. Click Add.

When familiarizing yourself with the new instructions contained in a DEX Pack it can be convenient to create a matching Instruction set to hold all its instructions. You can then set permissions for all the instructions contained in the DEX Pack in one go. Later on you can then add other Instruction sets and move the Instructions in order to refine the permissions for each instruction.

Creating an empty Instruction set

To add an empty Instruction set where you can subsequently move Instructions.

1. Click Add new set.

2. In the Add new instruction set popup, enter a suitable name for the Instruction set.

3. You can optionally add a custom icon, in JPG or PNG format, that will be used when displaying the instruction:

   1. Click Choose File.

   2. In the Open dialog, locate and select the JPG or PNG file you want to use.

   3. Click Open to load the file into the Platform.

   4. The file location and a preview of the file will be displayed in the popup.

4. Click Add.

Updating Instructions

To update an Instruction, load the newer version into the Platform, and it will be updated in place, keeping any currently set Instruction set intact.

Statistics for the upload operation can be viewed by clicking on the drop zone.

Upgrading and updating Instructions

Instructions are designed as far as possible to be backwards compatible, but as a general rule we recommend that you update your DEX Packs to the latest version so that you can gain the benefit of newer features.

When upgrading you should be able to safely keep your existing Instructions. We recommend that newer versions of Instructions are verified in a test environment to ensure that they still behave as expected before updating in your production environment.

Your license should retain any code signing certificates you may have registered. This means your custom instructions should continue to be licensed as normal following a Platform upgrade. You may want to check the Writing instructions in the PDF version of the SDK documentation to check for any changes to the SCALE language.

Moving Instructions to Instruction sets

The following steps are used to move instructions between Instruction sets:

Move one or more selected Instructions:

1. Select the source Instruction set you want to move the Instruction(s) from, or select All, from the list of Instruction sets, and locate the Instruction(s) you want to move.

2. Check the checkbox at the start of each Instruction item in the Instructions table for each Instruction you want to move.

3. When the selection has been made click Move.

4. In the Move instructions popup subsequently displayed:

   1. Select the desired destination Instruction set from the Destination instruction set drop-down list.

   2. Click Move when the set has been selected.

Deleting Instructions sets and Instructions

Instruction sets are relatively simple to add, populate and delete, making the re-organization of Instruction permissions easy to do.

When deleting you get to choose whether you just want to delete the Instruction set or to also remove the Instructions in the Set from the Platform, if you choose to delete:

• Just the Instruction set, any Instructions it contained will be returned to the Unassigned Set, effectively making them unavailable until they are assigned to another Instruction set.

• Both the Instruction set and all the Instructions it contains, those Instructions will be unavailable to the Platform until they are loaded back into the system and assigned to another Instruction set.

Before deleting you need to be aware:

• Instructions in the Instruction set you want to delete may currently be running. Deleting an Instruction set will invalidate any role-based permissions from that point onwards, though any instructions that are in flight will not change.

• Any Custom Roles that were previously configured for the deleted Instruction set will still remain but will be disconnected from the deleted Instruction set.

Deleting an Instruction set

The following steps can be used to delete an Instruction set.

1. Locate the Instruction set you want to delete in the Instruction sets list.

2. Hover the mouse over the Instruction set name, a tooltip with three vertical dots will appear. Click on this to display a menu.

3. Select Delete.

4. In the Delete instruction set popup subsequently displayed you have the choice as to whether you want to just delete the Instruction set or delete the Instruction definitions it contains too. To delete both you select Delete both instruction set and instructions inside set.

5. Once you've made your choice click Yes, delete instruction set to proceed with the deletion.

6. If you chose to just delete the Instruction set, as shown in our example, the Instructions previously held in the Instruction set go back to the Unassigned Instruction set.

7. If you chose to delete the Instruction set and instructions all the instructions contained in the set are removed from the Platform.

Deleting one or more selected Instructions from the Platform

The following steps can be used to delete one or more selected Instructions.

1. In the Instructions table, select the Instruction set containing the Instruction(s) you want to delete, or select All.

2. Select the checkbox at the left-hand end of the Instruction's row in the Instructions table for each one you want to delete.

3. Click on Delete in the panel on the right.

4. In the Confirm delete dialog subsequently displayed click Delete to continue and remove the selected Instruction(s) from the Platform or Cancel to cancel the operation.