1. User Profile
You can manage your profile by accessing the user profile. Click on your btn:[user name] in the top right corner of the screen and select btn:[User Profile].
1.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 btn:[save] at the bottom of the profile
1.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 btn:[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. |
1.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 btn:[save] at the bottom of the page.
2. 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 btn:[Create your own Gravatar] on their website.
3. The User Dashboard
TODO: Complete this section
4. The Admin Dashboard
TODO: Complete this section
5. The User Dashboard
TODO: Complete this section
6. The User Dashboard
TODO: Complete this section
7. Search
7.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.
7.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.
7.2.1. Search terms
A query consists of a list of search terms separated by whitespace:
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:
where the term key defines the type of search to be performed, and the list of operators defines the values to be matched.
The values matched by the operators are combined with or, so each additional operator extends the list of search results.
Operators may also consist either of a single value (e.g. 123) or be a operator key / value 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:
| Term key | Operator type | Searches by |
|---|---|---|
|
user work items based on models from matching apps |
|
|
assigned user |
|
|
creation date |
|
|
work item type (using dashboard shortcuts) |
|
|
ID |
hierarchy |
|
work item description |
|
|
work item description (alias for |
|
|
assigned user (alias for |
|
|
user work items based on matching models |
|
|
work item name |
|
|
owner |
|
|
ID |
hierarchy (alias for |
|
priority |
|
|
state |
|
|
textual content (the default search term key) |
|
|
work item type |
|
|
last modified date |
|
|
all |
variable value |
7.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:
| Sort attribute | Description |
|---|---|
|
creation date |
|
last modified date |
|
work item name |
|
priority |
|
work item type |
sort:desc:name sort:creation
7.4. User operator
A user operator accepts the following values:
| Value | Matches |
|---|---|
|
the specific user ID (work object ID) |
|
any assigned user |
|
the current user |
|
unassigned work items (a value alias for the |
The following operator keys are also supported:
| Value | Matches |
|---|---|
|
unassigned work items |
owner:empty: owner:all owner:me
7.5. Date operator
The following date operator keys are supported:
| Key | Value | Matches |
|---|---|---|
|
|
values equal to the given value (default) |
|
|
values greater than the given value |
|
|
values greater than or equal to the given value |
|
|
values less than the given value |
|
|
values less than or equal to the given value |
|
|
values in the given range (inclusive) |
|
Note
|
Date values are currently interpreted as UTC values, so a date-based search may contain unexpected results when viewed from a particular user’s local timezone. |
created:2014-02-14 created:lt:2014-02-14 updated:range:2012-01-01..2012-12-31
7.6. Number operator
The following number operator keys are supported:
| Key | Value | Matches |
|---|---|---|
|
|
values equal to the given value (default) |
|
|
values greater than the given value |
|
|
values greater than or equal to the given value |
|
|
values less than the given value |
|
|
values less than or equal to the given value |
|
|
values in the given range (inclusive) |
priority:1,2 priority:gt:5
7.7. State operator
No special state operators are supported, only the following state values:
| Value | Matches |
|---|---|
|
all states (no restriction) |
|
open work items (active, pending, pending inactive) |
|
active work items |
|
inactive work items |
|
pending work items |
|
pending inactive work items (quotes are required) |
|
completed work items |
|
archived work items |
state:open state:archived,completed
7.8. Type operator
No special type operators are supported, only the following type values:
| Value | Matches |
|---|---|
|
cases |
|
documents |
|
tasks |
|
queries |
|
apps |
|
case models |
|
document models |
|
form models |
|
mail models |
|
process models |
|
task models |
|
accounts |
|
groups |
|
users |
type:TSK,DOC
7.9. Dashboard operator
No special dashboard operators are supported, only the following dashboard values:
| Value | Matches |
|---|---|
|
accounts, groups & users |
|
apps & models |
|
cases, task, documents & queries |
Dashboard terms are just a shortcut for a type term with the corresponding type list.
dashboard:user
7.10. String operator
The following string operator keys are supported:
| Key | Value | Matches |
|---|---|---|
|
|
values that contain the given sub-string (default) |
|
|
values that are not set |
name:example description:empty:
7.11. Model operator
No special model operators are supported. The operator 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.
app:vacation model:'Vacation Request Case'
8. Glossary
- app
-
an app 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
- 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 operator
-
part of a search term. A search term can contain multiple operators, separated by commas. The result set for the term contains work items that match any of the operators.
- 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.