Tersus: Modeling Reference Manual

Modeling Reference ManualDate: Jun 28, 2020Tags:Help

Basic Modeling

Icon

Tool Name

Where?

Shortcut

What Does It Do?

Usage Comments

Select

Palette

Change edit mode to the default (select one element)

Then click an element to select it

Marquee

Palette

Change edit mode to allow multiple selection of elements

Then mark a region to select all elements in it

Flow

Palette

Create a new flow from some source to some target

Then click the source and then click the target

Remove

Palette

Create a new 'Remove' flow (to delete the content of some target)

Then click the source and then click the target

Note

Palette

Add a documentation comment

Then click the place in which you want to position the note

Trigger

Palette

Add a trigger (to a process or display model)

Then click inside the model to which you want to add the trigger (near its frame)

Exit

Palette

Add an exit (to a process or display model)

Then click inside the model to which you want to add the exit (near its frame)

Error Exit

Palette

Add an error exit (to a server-side process model)

Then click inside the model to which you want to add the exit (near its frame)

Action

Model Editor

Add a new Action to one of the models in the model editor

Alternative to dragging a new Basic/Action from the palette

Service

Model Editor

Add a new Service to one of the models in the model editor

Alternative to dragging a new Basic/Service from the palette

Exists

Model Editor

Add a new Exists to one of the models in the model editor

Alternative to dragging a new Collections/Exists from the palette

Branch

Model Editor

Add a new Branch to one of the models in the model editor

Alternative to dragging a new Flow Control/Branch from the palette

Conditional Flow

Model Editor

Add a new Conditional Flow to one of the models in the model editor

Alternative to dragging a new Flow Control/Conditional Flow from the palette

Palette

Open a dialog to search for a template by name, and use it

Alternative to searching for the template visually in all categories of the palette

Navigation and Model Browsing

Icon

Tool Name

Where?

Shortcut

What Does It Do?

Usage Comments

Model Editor

Right Click

Open the context menu relevant for the selected model

Open

Model Editor context menu

Click [+] in model's top-right corner

Open the selected model to see its elements (with no zooming)

Zoom Into

Double Click

Zoom into the selected model and open it

Zoom In

Studio toolbar

Ctrl+=

Zoom in (with the currently selected model in the center)

Zoom Out

Studio toolbar

Ctrl+-

Zoom out (with the currently selected model in the center)

Open in a New Tab

Model Editor context menu

Open the selected model in a new model editor

Show in Repository Explorer

Model Editor context menu

Open the Repository Explorer view, focusing on the selected model

Show Usages

Model Editor context menu

Repository Explorer view context menu

Search view context menu

Search view toolbar

Open the Usages view, and list all usages of the selected model in the project

Double click a line in the list of usages to open the relevant using model

Tersus Search

Studio toolbar

Search -> Search... -> Tersus Search

Search for a model by name

Validate

Validation View

Check model validity (flow connectivity, type consistency, conformance to prototypes, etc.)

Double click a line in the list of validation errors to open the violating model

Open Containing Context

Validation View

Opens the container model of the violating model identified by the selected validation error

Use this option if double-clicking the error fails to open the violating model

Show Path

Validation View

Show the full path of the violating model indetified by the selected validation error

Model Modification

Icon

Tool Name

Where?

Shortcut

What Does It Do?

Usage Comments

Copy

Model Editor context menu

Repository Explorer view context menu

Search view context menu

Copy the selected models or package to the clipboard of the Tersus Studio

The next step should be Paste

Paste (Reuse)

Model Editor context menu

Create new element(s) inside the selected target model, reusing the copied models

Only applicable after Copy in the same project

Paste (Clone)

Model Editor context menu

Create a new element inside the selected target model, using a newly created copy of the copied model (shallow copy - elements of the original model are not cloned)

Only applicable after Copy of a single model in the same project

Paste (Import)

Model Editor context menu

Create a new element inside the selected target model, using a newly created copy of the copied model (deep copy - child models of the original model are also created if missing in the target project)

Only applicable after Copy of a single model in another project

Paste Package

Repository Explorer view context menu

Create a copy of a package (and it's subpackages) in the selected package

Only applicable after Copy of a package in the same project

Rename

Model Editor context menu

Repository Explorer view context menu

Rename the selected element and/or model

Encapsulate

Model Editor context menu

Encapsulate the selected models into a single new model

Verify the result is satisfactory and then rename the newly created model

Move Element

Model Editor context menu

Move the selected data/display model(s) into a "brother element" (the model of a data/display element at the same level)

Select one of the suggested brother elements to move the selected elements into it

Mandatory

Model Editor context menu

Toggle the selected trigger from non-mandatory to mandatory or vice versa

Repetitive

Model Editor context menu

Toggle the selected element from non-repetitive to repetitive or vice versa

Type

Model Editor context menu

Change the reference type of the selected data element (between 'Main', 'Parent' and 'Intermediate')

Use 'Parent' for a reference to an element in a containing model (the default is 'Intermediate'; 'Main' is now deprecated)

Add Ancestor Reference

Model Editor context menu

Add a data element that is a reference to a display element in a contain model

Select one of the suggested ancestors

Add Element

Model Editor context menu

Add an element defined in the prototype of the selected model

Select one of the suggested elements

Add Property

Model Editor context menu

Properties view toolbar

Add a new property to the selected model

See list of supported shared properties

Delete Property

Properties view toolbar

Delete the selected property from the model

Some basic properties are reserved and cannot be deleted

Property Name

Properties View

Incrementally filter properties in the view

Show All

Properties View

Controls whether empty properties (with no shared or local value) are displayed

Reset View

Properties view toolbar

Revert properties view to default settings

Set Slot Data Types

Studio toolbar

Set the data types of typeless slots (triggers and exits) according to the types of data flows connecting them

If a slot with no data type is connected to a data element or another slot through a flow, its type is set to match the type of the element at the other end of the flow

Remove Element

Model Editor context menu

Delete

Delete the selected element (process element, display element, data element, slot or flow)

If deleting the last usage of a model, the user is asked whether to delete that model from the repository as well

Delete

Repository Explorer context menu

Delete

Delete the selected model or package

If the model (or all models in package) is unused, it will be deleted, otherwise a list of usages is displayed

Undo

Studio toolbar

Ctrl+Z

Undo the last model modification in the current project (project of the selected model editor)

Works "cross save" (saving the changes does not prevent 'Undo' as long as you don't close the project or quit the Tersus Studio)

Redo

Studio toolbar

Ctrl+Y

Redo the last model modification that has been just undone in the current project (project of the selected model editor)

Works "cross save" (saving the changes does not prevent 'Redo' as long as you don't close the project or quit the Tersus Studio)

Save

Studio toolbar

Ctrl+S

Set the data types of typeless slots and save all modified models in the current project (project of the selected model editor)

Revert Project 'projectname'

Reposoitory Explorer's View menu

Discard all changes to the application. Revert models to the last save

Refresh all unmodified projects

Reposoitory Explorer View menu & toolbar

Refreshes all unmodified projects, by reloading the models from the files system

Following refresh, the undo stack is cleare, and previous changes cannot be undone

Move unused models in project 'projectname'

Reposoitory Explorer View menu

Scans the project and moves all models which are unused in the project into a separate package called 'Unused'

After moving review the moved models and decide whether they are no longer needed and can be deleted

Move unused models in package

Reposoitory Explorer View menu

Scans the selected package (and all sub-packages) and moves all models which are unused in the project into a separate package called 'Unused'

After moving review the moved models and decide whether they are no longer needed and can be deleted

Remove unused models in project 'projectname'

Reposoitory Explorer View menu

Scans the project and deletes all models which are unused in the project

This is similar to performing "Move unused models in project 'projectname'" immediately followed by Delete

List unused models in project 'projectname'

Reposoitory Explorer View menu

Scans the project for unused models and creates a text file listing them.

The text file is called 'unused models.txt' and is saved automatically in the project's root folder

Show services in project 'projectname'

Reposoitory Explorer View menu

Scans the project for services and creates a text file listing them.

The text file is called 'services.txt' and is saved automatically in the project's root folder

Collapse All

Reposoitory Explorer toolbar

Collapses all project trees in the repository

Wizards

Icon

Tool Name

Where?

What Does It Do?

Usage Comments

New Tersus Project

File-> New-> Tersus Project

Create a new Tersus application (project)

Export Tersus Project

File-> Export…-> Archive File

Export a Tersus application (project) as an archive file

Import Tersus Project

File-> Import…-> Existing Projects into Workspace

Import a Tersus application (project) from an archive file

Table Wizard

(automatically started when 'Table Wizard' is dragged from the palette)

Create a pane for displaying and updating records from a database table or view

To update the model, select the pane created by the wizard, right click, and select "Apply Table Wizard"

Import HTML Template

Repository Explorer view context menu

Read an HTML file and create corresponding Tersus models, comprised of an Embedded HTML display model referencing the HTML template and containing other display models which display and control the HTML elements contained in the imported template

Applicable for HTML files located somewhere under the project's "models" folder

Synchronize HTML Template

Repository Explorer view context menu

Synchronize a model created by "Import HTML Template"

Applicable for the Embedded HTML display model container created previously by "Import HTML Template"

Create Corresponding Data Structure

Repository Explorer view context menu

Create a data structure corresponding to a hierarchy of display models + an 'Extract…' process (retrieve data from the display into the data structure) + a 'Populate…' process (copy data from the data structure to the display)

Applicable for a display model with child display elements (e.g. the result of applying the 'Import HTML Template' wizard, once the html element contains at least one "identified sub-element")

Import XML Example

File-> Import…-> Import XML Data Structure by Example

Create a data structure according to an XML document

After the import, you can use the created model to parse, through the 'Parse XML' template, any XML document with the same structure [note: if there is an XML Schema definition for the document, it is better to use the 'Import WSDL' wizard rather than 'Import XML Example']

Import WSDL

File-> Import…-> Import WSDL

Import XML Schema definitions is general (.xsd files) or WSDL definitions, and create a set of corresponding data structures

After the import, you can use the created model to parse, through the 'Parse XML' template, any XML document conforming to the imported definitions

Application Deployment and Execution

Icon

Tool Name

Where?

Shortcut

What Does It Do?

Usage Comments

Launch the application

Studio toolbar

Start the application, to which the current model editor belongs, and launch it in the browser

Applications are started in the internal application server embedded in the Tersus Studio.
If the application is currently running, it will be stopped. refreshed, and restarted.

Stop the application

Studio toolbar

Stop the application, to which the model in the current editor belongs

Show the application log file

Studio toolbar

Open the server log file for the application, to which the model in the current editor belongs

Start the selected application

Application Server view toolbar

Start the selected application

Application is started in the internal application server embedded in the Tersus Studio

Launch in Browser

Application Server view

Double Click

Launch the selected application in your browser

Applicable when a green circle indicates that the application has been started successfully

View Log File

Application Server view

Double Click

Open the server log file for the selected application in a text editor window

Applicable when a red exclamation mark indicates that the application cannot be started due to some errors

Stop all applications

Application Server view toolbar

Stop all running applications

Refresh the list of applications

Application Server view toolbar

Refresh the list of applications (open Tersus projects) and their statuses

Quick Hosting

Studio toolbar

Deploy your application on one of the Tersus servers

Icon

Option

Where?

What Does It Do?

Usage Comments

Preferred Port

Window-> Preferences…-> Tersus-> Application Server

Set the HTTP port for the internal application server embedded in the Tersus Studio

E.g. if you set the port to 8080, then accessing an application X in your browser is made at "http://localhost:8080/X"

Browser

Window-> Preferences…-> General-> Web Browser

Set the default browser for 'Launch in Browser'

The browser checked in the External Web browsers list will be launched.

Hosting upload URL

Window-> Preferences…-> Tersus

Set the URL for 'Quick Hosting'

Set by default to the tersus quick hosting server @ "http://hosting.tersus.com/Upload"

Application Testing and Debugging

Icon

Tool Name

Where?

Shortcut

What Does It Do?

Usage Comments

Start Trace

Browser

(see comment)

Start recording the execution steps of the application (creating a new trace file)

If the icon is not displayed, type "javascript:startTrace()" in the browser's address bar

Stop Trace

Browser

(see comment)

Stop recording the execution steps of the application (closing the trace file)

If the icon is not displayed, type "javascript:stopTrace()" in the browser's address bar

Open

Runtime Trace view

Open a trace file and display its content

Double click a line to open the relevant model (relevant element is marked in red)

Refresh

Runtime Trace view

Refresh the display of the current trace file (helpful if trace has been updated since it was opened)

Double click a line to open the relevant model (relevant element is marked in red)

View Error Log

Help-> About Tersus Studio-> Configuration Details

View error messages created while using the Tersus Studio (in this session as well as in past sessions)

Analyze Dependencies

Model Editor context menu

List order of execution dependencies between the elements of the selected process or display model

Used if there is a problem with the order and execution and there is a need to understand how elements depend on each other

Test Runner

Palette - Testing category

A framework for running automatic ("regression") tests.

Add this module to your application as a separate view and model you test suites and cases

Tersus Studio Management

Icon

Tool Name

Where?

Shortcut

What Does It Do?

Usage Comments

Welcome

Help-> Welcome

View a getting started introduction to Tersus (a "Welcome to Tersus Studio" page)

Help

Help-> Help Contents

View the documentation of Eclipse and Tersus

The "Tersus Documentation" section includes the Tersus step-by-step tutorial and the Tersus Reference Manual

Feature Details

Help-> About Tersus Studio

List the Eclipse features included in your installation of the Tersus Studio

Plug-in Details

Help-> About Tersus Studio

List the Eclipse plug-ins included in your installation of the Tersus Studio

Configuration Details

Help-> About Tersus Studio

View the configuration details of your installation of the Tersus Studio

Press 'View Error Log' to view error messages created while using the Tersus Studio

Find and Install…

Help-> Software Updates

Search for updates of the currently installed features in your installation of the Tersus Studio (or for new features to install)

Manage Configuration

Help-> Software Updates

View and update the configuration of your installation of the Tersus Studio

Use when you want to manually switch to another version of a feature included in your installation

Icon

Option

Where?

What Does It Do?

Usage Comments

Colors

Window-> Preferences…-> Tersus-> Colors

View or modify the color shades used in the Tersus Studio

Fonts

Window-> Preferences…-> Tersus-> Fonts

View or modify the fonts used in the Tersus Studio

Maximum Slot Size

Window-> Preferences…-> Tersus-> Sizes

View or modify the maximal size (in pixels) of a slot icon

Even when you zoom in to enlarge the model's diagram, the size of slot icons won't increase further

Minimum Slot Size

Window-> Preferences…-> Tersus-> Sizes

View or modify the minimal size (in pixels) of a slot icon

Even when you zoom out to shrink the model's diagram, the size of slot icons won't decrease further

Maximum Arrow Head Size

Window-> Preferences…-> Tersus-> Sizes

View or modify the maximal size (in pixels) of the head of flow arrows

Even when you zoom in to enlarge the model's diagram, the size of the arrows of flows won't increase further

Validate on Save

Window-> Preferences…-> Tersus-> Validation

Indicate whether to perform model validation on each save

Recommended

Show Notification Dialog

Window-> Preferences…-> Tersus-> Validation

Indicate whether to show a notification dialog when model validation problems are detected

Recommended

Faster Validation

Window-> Preferences…-> Tersus-> Validation

Indicate whether to validate only one occurrence of each model (might miss some problems)

Not recommended (although saves time for large projects)

Include Unused Models

Window-> Preferences…-> Tersus-> Validation

Indicate whether to include unused models when performing model validation

A model is considered unused if it is not used within the project's root model