Orienteer Architect User Guide - OrienteerBAP/Orienteer GitHub Wiki

Orienteer Architect - is Orietneer's module which allow yout to create database schema with graphical editor.

Installation

1. Go to tab Artifacts.
2. Download module with artifactId orienteer-architect.
3. Reload Orienteer. After Orienteer reloads you will see new class ODataModel. This class which allows creating schema with graphical editor.

---

Create new data model

1. Click Browse class in class ODataModel
2. Set name and description of your data model. You will see something as this:

---

Managing classes

1. For create new class you can:

• Drag the icon to edit area.
• Click right mouse button. You will see this menu:
• Double click in empty edit area.

After one of this action you will see modal window for creating new class:

Enter class name if your name is invalid you will see error message. After class succesfully created you will empty class:

This class exists only in editor, not in database. For create this class in database you must click on button Apply Changes

2. For add classes which exists in database you can:

• Drag icon to edit area

• Click on right mouse button and choose "Add exists classes" in popup menu.

After one of this actions you will see modal window with exists classes:

Choose some classes and click on button Add class(es). After this actions you can see that classes which already exists in database have different color that classes which do not exists in database:

---

Managing properties

1. For create new property you can:

• Drag icon to edit area.
• Double click on class
• Hiver cursor and click rigth mouse button. After this action you will see:

Click on Add property action.

After one of this actions you will see:

You must enter name and type of new property. After succesfull property creating you will see class with property:

2. For property managing in class you can:

• Click on left icon in property and you will see edit property window.
• Click on right icon in property and you will remove property from class.

3. For change properties order in class you must drag and drop property. And change it's order.

---

Class inheritance

For inherit one class from other class you must do this actions: Hover mouse cursor on icon (this icon will be visible after you hover mouse on class) and drag this icon to another class which will be parent of this class. In result you will see something like this:

---

Saving editor state

For save editor state you must click on button

---

Write editor changes to database

For write editor changes to database you must click on button

---

Use fullscreen mode

For use fullscreen mode you must click F11 or click Maximize in widget menu: