edoras one User Guide

1.1. Dashboards

When you log into edoras one, you will normally see the edoras one user dashboard:

The edoras one dashboards each provide a summary of information that is relevant to a particular user role, in this case the user’s active work items. Only work items that are visible to the current user are displayed. You can change between dashboards using the dashboard selector in the application toolbar:

Note	that depending on the user’s permissions, some dashboards may be available.

1.2. List view

The dashboard widgets typically show a summary of a particular type of work item:

Clicking on the widget header will open the corresponding list view to show the full list of work items (the widget itself only shows the first few):

1.3. Work item page

Clicking on a particular item in the dashboard list will take you directly to the work item page where the work item details can be viewed and/or edited:

The work item page will typically provide a number of different work item views, which can be selected using the icons in the top right-hand corner:

and a number of work item actions in the action toolbar on the right hand side which can be used to perform operations on the work item:

1.4. Work item views

1.4.1. Browse view

The browse view shows the work item details and is available for all work items. Select the Browse icon to open the work item view:

This will show the work item work form and if the item is active then the details may also be modifiable:

1.4.2. Search view

The search view shows the current child work items and is available for container work items such as Apps and Cases. Select the Search icon to open the child work item view:

This will show the list of child work items:

$searchView$

1.4.3. Comments view

The comments view shows the work item comments and is available for all work items.

Select the Comments icon to open the comments view:

This will show the work item comments, including both automatically generated change notifications and user comments:

1.4.4. Preview view

The preview view shows a preview of the work item contents and is available for all work items with suitable content.

Select the Preview icon to open the comments view:

This will show the content preview, which depends on the work item content type. As an example, a form model preview will show a preview image of the form layout:

1.4.5. Edit entity view

The edit entity view allows all work items to be viewed and/or modified (not just those that are accessible through the normal work item forms). This is a technical view of the work item that is available for all work items but only for users with suitable access permissions.

Select the Edit Entity icon to open the entity editor view:

This will show the work item values as a form:

1.4.6. Edit entity JSON view

The edit entity JSON view allows all the raw work item definition to be viewed and/or modified. This is a technical view of the work item that is available for all work items but only for users with suitable access permissions.

Select the Edit Entity JSON icon to open the entity JSON editor view:

This will show the work item as a raw text field:

1.5. Bookmarking pages

Every page in edoras one has a unique persistent URL that can be bookmarked in the browser or referenced from a link. Simply add a bookmark or copy the page URL from the browser address toolbar.

When following a link to edoras one you may have to log in if the browser does not have active edoras one credentials. When the link points to a work item view, the view will only be shown if the user that is logged in has suitable access permissions for the work item in question.

1.6. Keyboard shortcuts

edoras one provides a number of keyboard navigation shortcuts:

Table 1. Keyboard shortcuts
Key	Description
`c`	create a new work item. The work item types that can be created are defined by the current dashboard. Select the work item type using the arrow keys and press `Enter` to create it.
`d`	change dashboard. Select the dashboard using the arrow keys and press `Enter` to open it.

2. Dashboards

2.1. User dashboard

The user dashboard provides a summary of the work items that are related to the workflows currently in progress in edoras one:

The work items shown in the user dashboard are:

Case: a container for related work items and processes.
Task: describes a task to be performed by a user.
Document: a document or other file.
Query: a stored search configuration.

2.2. Modeler dashboard

The modeler dashboard provides a summary of the workflow apps and models:

The work items shown in the modeler dashboard are:

App Model: a container for related models that combine to define a workflow. The workflow defined by the models can only be used when the app is deployed.
Case Model: defines a particular type of case.
Process Model: defines an executable workflow that combines several tasks, either manual or automated.
Task Model: defines a particular type of task.
Document Model: defines a particular type of document.
Form Model: defines a form used by other models to interact with a specific work item.

Please refer to the edoras one Modeler Guide for more details of the modeler dashboard and the modeler work items.

2.3. Admin dashboard

The admin dashboard provides a summary of the system administration work items:

The work items shown in the admin dashboard are:

Account: a container for related users and groups.
Group: defines related sets of users, and can also be used to grant permissions.
User: a particular user within the system.
App: the instance of an app model where the the dynamic properties can be updated.

Please refer to the edoras one Admin Guide for more details of the admin dashboard and the admin work items.

2.4. Management dashboard

The management dashboard provides a statistical work item overview:

3. User Profile

You can manage your profile by accessing the user profile. Click on your user name in the top right corner of the screen and select User Profile.

3.1. Change your email address

edoras one sends email notifications depending on your settings. to change your email address simply type the new address in the field Email address and save your changes by clicking save at the bottom of the profile

3.2. Change your language

edoras one currently supports english, spanish, german, french and italian as plattform languages. To change the language just select the desired language from the language dropdown and save your changes by clicking save at the bottom of the page.

Note	Changing the language needs a page refresh after the save to become effective. Not every App has to be maintained in all languages. If your language is not maintained in a particular App, it defaults to the primary language defined by the issuer of the App.

3.3. Change your password

To change your password simply enter the new password in the password field (There are currently no restrictions about password strength). Then re-enter the password in the repeat password field and save your changes by clicking save at the bottom of the page.

4. Avatar

edoras one uses the Gravatar online Avatar Service to load your avatar from the internet. If you don’t use gravatar yet and want to have a custom avatar in edoras one, sign up to Gravatar with the email address specified in your user profile by clicking on Create your own Gravatar on their website.

5. Search

5.1. Basic searching

To search for work items in edoras one, use the search functionality provided by the edoras one toolbar.

Clicking on the triangle to the right of the search field opens a pull-down dialog where a number of common search settings can be selected. As these options are changed, the results of the search are shown in the list view:

Typing a plain text value into the search text field will also restrict the search results to work items that contain the given text, either in the name, in the description, or in a string attribute value.

5.2. More complex searching

In addition to plain text search, the search text field supports a query language that allows more complex queries to be created.

5.2.1. Search terms

A query consists of a list of search terms separated by whitespace:

<term1> <term2> <term3> …

In the simplest case, a term can be a single word which performs a text search for work items that contain the given word. This is the basis for the search mechanism described in <basic-search>.

When searching, the search results from each term are combined with and, so each additional term restricts the search results more tightly.

To include whitespace in a search term, surround the search text with quotes (i.e. +multiple word search).

More complex terms follow the pattern:

<termKey>:<expression>,<expression>,…

where the term key defines the type of search to be performed, and the list of expressions defines the values to be matched.

The values matched by the expressions are combined with or, so each additional expression extends the list of search results.

Expressions may also consist either of a single value (e.g. 123) or be an operator / operand pair, also separated by a : (e.g. gt:123).

As an example, the search term priority:1,3,gt:5 will return all work items that have a priority of 1, 3 or any value greater than 5.

The following search term keys are currently supported by edoras one:

Table 2. Supported term keys
Term key	Expression type	Searches by
`app`	Model expression	user work items based on models from matching apps
`assignee`	User expression	assigned user
`created`	Date expression	creation date
`dashboard`	Dashboard expression	work item type (using dashboard shortcuts)
`descendantsOf`	ID	hierarchy
`description`	String expression	work item description
`desc`	String expression	work item description (alias for `description`)
`due`	Date expression	due date
`for`	User expression	assigned user (alias for `assignee`)
`model`	Model expression	user work items based on matching models
`name`	String expression	work item name
`owner`	User expression	owner
`parent`	ID	hierarchy (alias for `descendantsOf`)
`priority`	Number expression	priority
`state`	State expression	state
`text`	String expression	textual content (the default search term key)
`type`	Type expression	work item type
`updated`	Date expression	last modified date
`<variable name>`	all	variable value

5.3. Sort terms

In addition to the search terms described above, a sort term may also be specified which allows the order of the search results to be specified. A sort term begins with sort:, is followed by an optional asc: (ascending, the default) or desc: (descending), and then the attribute to sort by. The following sort attributes are supported:

Table 3. Sort term values
Sort attribute	Description
`assignee`	assignee (grouping only, no alphabetical sort)
`creation`	creation date
`due`	due date
`modification`	last modified date
`name`	work item name
`owner`	owner (grouping only, no alphabetical sort)
`priority`	priority
`type`	work item type

Examples

sort:desc:name
sort:creation

5.4. User expression

A user expression accepts the following operand values:

Table 4. User operand values
Operand value	Matches
`<ID>`	the specific user ID (work object ID)
`all`	any assigned user
`me`	the current user
`unassigned`	unassigned work items (a value alias for the `empty` operator)
`<text>`	any user with the given text as part of the display name

The following operators are also supported:

Table 5. User operators
Value	Matches
`empty:`	unassigned work items

Examples

owner:empty:
owner:all
owner:me
owner:joe

5.5. Date expression

The following date operators are supported:

Table 6. Date operators
Operator	Operand value	Matches
`eq:`	`date`	values equal to the given value (default)
`gt:`	`date`	values greater than the given value
`gte:`	`date`	values greater than or equal to the given value
`lt:`	`date`	values less than the given value
`lte:`	`date`	values less than or equal to the given value
`range:`	`date..date`	values in the given range (inclusive)

The following date specification formats are supported:

Table 7. Date specification formats
Format	Description
`yyyy-MM-dd`	a specific date
`[yY][mM][wW][dD]`	a date relative to today in years, months weeks, or days
`today`	today’s date

Examples

created:today
created:lt:2014-02-14
updated:range:-2W..2W

Note	Date values are currently interpreted in the UTC timezone, so a date-based search may occasionally contain unexpected results when viewed from a particular user’s local timezone.

5.6. Number expression

The following number operators are supported:

Table 8. Number operators
Operator	Operand value	Matches
`eq:`	`<number>`	values equal to the given value (default)
`gt:`	`<number>`	values greater than the given value
`gte:`	`<number>`	values greater than or equal to the given value
`lt:`	`<number>`	values less than the given value
`lte:`	`<number>`	values less than or equal to the given value
`range:`	`<number>..<number>`	values in the given range (inclusive)

Examples

priority:1,2
priority:gt:5

5.7. State expression

No special state operators are supported, only the following state operand values:

Table 9. State operand values
Operand value	Matches
`all`	all states (no restriction)
`open`	open work items (active, pending, pending inactive)
`active`	active work items
`inactive`	inactive work items
`pending`	pending work items
`pending inactive`	pending inactive work items (quotes are required)
`completed`	completed work items
`archived`	archived work items

Examples

state:open
state:archived,completed

5.8. Type expression

No special type operators are supported, only the following operand values:

Table 10. Type operand values
Operand value	Matches
`CAS`	cases
`DOC`	documents
`TSK`	tasks
`QUERY`	queries
`APP`	apps
`CASE_MODEL`	case models
`DOCUMENT_MODEL`	document models
`FORM_MODEL`	form models
`MAIL_MODEL`	mail models
`PROCESS_MODEL`	process models
`TASK_MODEL`	task models
`APP_MODEL`	app models
`ACC`	accounts
`GRP`	groups
`USR`	users

Examples

type:TSK,DOC

5.9. Dashboard expression

No special dashboard operators are supported, only the following operand values:

Table 11. Dashboard operand values
Operand value	Matches
`admin`	accounts, groups, users & apps
`modeler`	models
`user`	cases, task, documents & queries

Dashboard terms are just a shortcut for a type term with the corresponding type list.

Examples

dashboard:user

5.10. String expression

The following string operators are supported:

Table 12. String operators
Operator	Operand value	Matches
`<none>`	`<string>`	values that contain the given sub-string (default)
`empty:`	`<string>`	values that are not set

Examples

name:example
description:empty:

5.11. Model expression

No special model operators are supported. The operand value is used to perform a name search on apps or models (depending on the term). For the app term, all models from the matching apps will be selected, for the model term only the matching models will be selected.

The search results will consist of all work items that were created from one of the matched models.

Examples

app:vacation
model:'Vacation Request Case'

Note	In order to retrieve the corresponding work items, permissions in the corresponding models are needed.

6. Glossary

app model: an app model is a container for a collection of models that define a specific workflow.
dashboard: a page in the edoras one application where work objects can be found, displayed and manipulated. Each dashboard manages related work object types that play a given role within the system.
model: a description of a workflow component which can be deployed together with other models to create a executable workflow in edoras one
operand: the value part of a search term expression.
operator: the optional first part of a search term expression which says how the operand value should be interpreted.
process: a process is a workflow definition, described using a BPMN 2.0 model and executed within edoras one. It typically defines the automated and manual tasks that must be performed to complete the workflow.
search term expression: part of a search term. A search term can contain multiple expressions, separated by commas. The result set for the term contains work items that match any of the operators. A search term expression contains an optional operator, and an operand value.
search term: part of a search query. The result set for the query contains work items that match all of the separate terms.
task: a task is a single action within a workflow, and may be either automated (a service task) or manual (a user task).
work object / work item: an item that can be created or manipulated in edoras one. Different types of work item are supported. The work object types are typically grouped according to their role within the system and accessed through dashboards.

edoras one User Guide

1. Basic application layout and navigation

1.1. Dashboards

1.2. List view

1.3. Work item page

1.4. Work item views

1.4.1. Browse view

1.4.2. Search view

1.4.3. Comments view

1.4.4. Preview view

1.4.5. Edit entity view

1.4.6. Edit entity JSON view

1.5. Bookmarking pages

1.6. Keyboard shortcuts

2. Dashboards

2.1. User dashboard

2.2. Modeler dashboard

2.3. Admin dashboard

2.4. Management dashboard

3. User Profile

3.1. Change your email address

3.2. Change your language

3.3. Change your password

4. Avatar

5. Search

5.1. Basic searching

5.2. More complex searching

5.2.1. Search terms

5.3. Sort terms

5.4. User expression

5.5. Date expression

5.6. Number expression

5.7. State expression

5.8. Type expression

5.9. Dashboard expression

5.10. String expression

5.11. Model expression

6. Glossary