Teneo Developers

Document basics

Intro

In Teneo Studio there are some functionalities which are similar throughout the process of building a bot, for example, how to create new documents such as Language Objects, Entities or Flows, or how to delete these.
The processes are described in details in their respective sections, but this page provides an overview of some of these functionalities shared by the different document types as well as links to more information when relevant.

Unless otherwise noted, in this page "documents" refer to Flows, Language Objects, Entities and Folders.

Create documents

After selecting the path in the Solution Explorer, creating new documents can be done in the top ribbon of Teneo Studio (Home tab) in the New area; here the user will find the buttons to:

  • Create Flow
  • Create Language Object
  • Create Entity
  • Create Folder
    • When the folder is created, the name field is editable in the Solution Explorer: write the folder name and press Enter
    • The folder can be renamed by selecting the folder and clicking Rename in the top ribbon or F2 on the keyboard

After navigating to the wanted path location (folder) in the solution, creating new documents is done clicking the Create button (available in the lower, right side of the browser window).

Create buttons

Note that the available options to create documents depends on the currently displayed path location:

When viewing the list of all available documents per type (accessed through the Solution dashboard) it is only possible to create the type of document currently visualized

Globals, Classes Integrations and File Resources can be created from the tile on the Solution dashboard or from the document type list, please follow the links for more specific details.

Open and edit documents

Open and edit

To open and edit a document (Flow, Language Object and Entity), follow the below steps:

  • Select the document in the Solution Explorer
  • In the top ribbon of Teneo Studio:
    • Click Open to open a document in read-only mode
    • Click Edit to open a document in edit mode

Read-only mode allows to view documents without activating any editing options which is especially useful if another user is currently editing the document
Edit mode allows to view and edit documents activating all editing options and locks the document for editing for other users (until it is closed and the lock released)

The following options are also available for opening and editing documents:

  • After selecting the document in the Solution Explorer
    • Double-clicking (with the mouse) opens the document in read-only mode
    • Pressing the Alt key and double-clicking opens the document in edit mode

More information related to editing of Flows, Language Objects and Entities is available in their respective sections of the documentation.

To open documents for editing, in Teneo Studio Web, the user simply needs to click the name of the document which should be edited.

For information on how to edit documents, please follow the relevant link below:

To open and see more documents at the same time, simply open the documents in different tabs or windows

Sometimes a document may already be opened in edit mode and locked by another user, in this case the current user will be presented with the option to open the document in read-only view.
Please note that depending on the user permissions some users can only open solutions and documents in read-only.

Update document name and description

In Teneo Studio Desktop, the name and the description of a document are available in the backstage of the document's window:

  • Open the document in edit mode
  • Go to the backstage
  • In the Properties tab, edit the name and/or description
  • Remember to Save to preserve the c

In Teneo Studio Web, document names can be updated directly in the top ribbon:

  • Open the document to rename
  • In the top ribbon, click the name
  • Now, modify the name as needed
  • Remember to click Save to preserve the changes.

Furthermore, the name and/or description can be updated by following these steps:

  • Open the document
  • In the top ribbon, click Info
  • In the modal view, modify the name/description
  • Remember to click Save to preserve the changes.

Delete documents

This section applies to the following document types:

Flows, Language Objects, Entities
Global Variables (Web only), Global Scripted Contexts, Integrations, Classes

To delete a document, follow the below steps:

  • In the Solution Explorer view, select the document
  • In the top ribbon, click Delete (Edit area)
    Alternatively, right-click the document and select Delete in the context menu or drag/drop the document onto the Recycle Bin The following dialogue box is displayed:

Delete document

  • Now, click Delete to remove the selected document
    Note that a usage check is performed and if the document is in use in the solution, the message in the below screenshot is displayed.
    Checking the Do not check usage option allows to delete without performing a usage check of the document(s) to delete.

Items in Use window

  • Now, either check the box of the document(s) which should be deleted, or click Select All to delete all displayed documents
  • After selecting the document(s), click Continue; Teneo Studio will proceed with the deletion of the document(s). If no document(s) are selected, clicking Continue will not delete any documents and Teneo Studio displays a message informing of the aborted deletion.

The Usage Check allows to check if document(s) are in use in the solution to avoid inconsistencies. When many documents are deleted at the same time, this process takes longer, and Teneo Studio provides the option to click Run in background allowing users to perform other tasks during the process. Deleting document(s) without usage check allows to delete any document(s) even if they are in use in the solution; this option is faster when many documents should be deleted at the same time.

To restore a deleted document, check out the Recycle Bin page.

To delete a document, follow the below steps:

  • Navigate to the folder location of the document
  • Hover over the document and click the Recycle Bin icon which appears on the right-side of the window; the following message is displayed

Delete document

  • Now, click Delete to remove the selected document
    Note that a usage check is performed and if the document is in use in the solution, the message in the below screenshot is displayed.
    Checking the Do not check usage option allows to delete without performing a usage check of the document(s) to delete.
  • Select Delete anyway to confirm the deletion or, alternatively, click Cancel to abort the deletion.

Document in use warning

The Recycle Bin is currently not available in Teneo Studio Web; recovery of deleted documents is supported only in Teneo Studio Desktop.

Enable or disable documents

The options and functionalities described in this section currently only apply toTeneo Studio Desktop

One or more documents can be enabled/disabled in the Solution Explorer by following the below steps:

  • Select the document(s) in the Solution Explorer
  • Click Enable or Disable in the top ribbon
    • If a folder is selected, the user will be prompted to confirm if enabling/disabling applies to This folder only or This folder and all sub-folders
  • A confirmation message is displayed, click Yes to continue.

Cut, copy and paste documents

The options and functionalities described in this section currently only apply toTeneo Studio Desktop

Teneo Studio Desktop allows to cut, copy and paste documents within the same solution by following the below steps:

  • In the Solution Explorer, select the document(s)
  • Click Cut or Copy in the top ribbon
  • Select the new location (folder) in the Solution Explorer and click Paste in the top ribbon.

To perform a Cut action on documents, it is also possible to drag/drop the documents onto the new location.

When Flows, Entities and Language Objects are copied, the new documents will receive a new unique Id as they are treated as new documents in the solution.

Language Objects and Entities gets "_1 " (underscore plus sequential numeric value starting at 1) attached to their names as the names of these documents are required to be unique within the solution; this only applies to Flows if the copy/paste actions are performed within the same folder location.

It is also possible to copy/paste documents from a different solution in the same environment, this can be done by following the below steps:

  • Perform a search using the Search All Solutions options
  • Select the document(s) from the search results and click Copy
  • Select the new location (folder) in the Solution Explorer and click Paste in the top ribbon

Keyboard shortcuts:
Ctrl+X: cut document(s)
Ctrl+C: copy document(s)
Ctrl+V: paste document(s)

Set or unset stable version of documents

The options and functionalities described in this section currently only apply toTeneo Studio Desktop

One or more documents can be set/unset as stable in the Solution Explorer by following the below steps:

  • Select the document(s) in the Solution Explorer
  • Click Set or Unset in the top ribbon
    • If a folder is selected, the user will be prompted to confirm if setting/unsetting the stable version applies to This folder only or This folder and all sub-folders
  • A confirmation message is displayed, optionally enter a comment, and lastly click Continue.

Learn more about document version control

Include or exclude documents when branching

The options and functionalities described in this section currently only apply toTeneo Studio Desktop

One or more documents can be included or excluded when branching a solution in a Localization setup, this is done by following the below steps:

  • Select the document(s) in the Solution Explorer
  • Click Include or Exclude in the top ribbon
  • The user is prompted to confirm the inclusion/exclusion, click Yes to continue.

Read more about the Localization setup