1. Outline
1.1. What is ERMaster?
2. System requirements
2.1. Eclipse version
2.2. Correspondence DB
3. Introduction
3.1. Install
3.2. Start
3.3. View that can be used
3.3.1. Editor view
3.3.2. Outline view
3.3.3. Problem view
3.3.4. Task view
3.3.5. Property view
4. Data
4.1. Save
4.2. Data format
5. Management of table
5.1. Add/Edit/Delete table
5.1.1. Add table
5.1.2. Edit table
5.1.3. Delete table
5.2. Management of column
5.2.1. Add column
5.2.2. Edit column
5.2.3. Delete column
5.2.4. Constraint
5.2.5. Default value
5.2.6. Description
5.2.7. Sort columns
5.3. Complex unique key
5.3.1. Add complex unique key
5.3.2. Edit complex unique key
5.3.3. Delete complex unique key
5.3.4. Editing and deleting to the complex unique key referenced by the foreign key
5.4. Index
5.4.1. Add index
5.4.2. Edit index
5.4.3. Delete index
6. Management of relation
6.1. Rule when relation is made
6.2. Add 1:N Relation
6.3. Add 1:N Relation (Add relation with existing column)
6.4. Add N:N Relation
6.5. Add self relation
6.6. Edit relation (Setting of constraint name, reference operation, referenced column, and multiplicity)
6.7. Delete Relation
7. Management of view
7.1. Add/Edit/Delete view
7.1.1. Add view
7.1.2. Edit view
7.1.3. Delete view
7.2. Management of column of view
8. Management of note
9. Management of category
9.1. Add category
9.2. Edit category
9.3. Delete category
9.4. Add the table to the category
9.5. Remove the table from the category
10. Management of word
10.1. Add word
10.2. Edit word
10.3. Delete word
10.4. Add word to the table
11. Management of group
11.1. Add group
11.2. Edit group
11.3. Delete group
11.4. Add group to the table
11.5. Remove group from the table
11.6. Global group
11.6.1. Management of global group
11.6.2. Add a group to global groups
11.7. Expansion and fold of group
12. Management of trigger
12.1. Add trigger
12.2. Edit trigger
12.3. Delete trigger
13. Management of sequence
13.1. Add sequence
13.2. Edit sequence
13.3. Delete Sequence
14. Management of tablesapece
15. [Edit all attributes]
16. Copy/Paste
17. Move column
18. Layout
18.1. Move table
18.2. Line up tables
18.3. Edit table size
18.4. Change table color
18.5. Align relation
18.6. Change font
19. Display
19.1. Change scale
19.2. Display Tooltip
19.3. Display grid line
19.4. Change notation
19.5. Change display
19.5.1. Change view mode
19.5.2. Change notation level
19.6. Change design
19.7. Display by the capital letter
19.8. Stamp
20. Import and Export
20.1. Import
20.1.1. Daeabase
20.1.2. File (.erm)
20.2. Export
20.2.1. Export Image
20.2.2. DB definition document(EXCEL from)
20.2.3. DB definition document(HTML from)
20.2.4. DDL (TXT)
20.2.5. Dictionary (CSV)
20.2.6. Translation dictionary
20.2.7. DB
21. Create custom DB definition book template
21.1. Download of standard template
21.2. Edit template
21.2.1. Cover
21.2.2. sheet_index_template sheet
21.2.3. Diagram
21.2.4. Template sheet
21.2.4.1. table_template sheet
21.2.4.2. index_template sheet
21.2.4.3. sequence_template sheet
21.2.4.4. view_template sheet
21.2.4.5. trigger_template sheet
21.2.4.6. category_template sheet
21.2.4.7. column_template sheet
21.2.4.8. all_tables_template sheet
21.2.4.9. all_indices_template sheet
21.2.4.10. all_sequences_template sheet
21.2.4.11. all_view_template sheet
21.2.4.12. all_trigger_template sheet
21.2.5. words sheet
21.2.6. loops sheet
21.3. Register template
22. Search
23. Change Tracking
23.1. Add Change Tracking
23.2. Edit change tracking
23.3. Delete change tracking
23.4. Comparison Display
23.5. Restore from change tracking
24. Translation
24.1. Form of dictionary file
24.2. Registration of dictionary file for translation
24.3. Management of translation
24.4. Execution of translation
25. JDBC driver
25.1. Management of JDBC driver
26. Print
26.1. Setting of page
27. Option
27.1. Change of database
27.2. Option tab
27.2.1. Switch IME mode automatically On focus
27.2.2. Validate the character of physical name
27.2.3. Use Bezier curve to line
28. Creat test data
28.1. Add test data
28.2. Method of inputting data
28.2.1. Setting method of direct input data
28.2.1.1. Input of current timestamp
28.2.1.2. Use of clipboard for direct input data
28.2.2. Setting method of repeating input data
28.2.2.1. Edit the repetition condition
28.2.2.1.1. NULL
28.2.2.1.2. Format
28.2.2.1.3. Foreign Key
28.2.2.1.4. Enumeration
28.2.2.2. Use of clipboard for repeating input data
28.3. Edit test data
28.4. Delete test data
28.5. Export test data
29. Ant Task
29.1. Necessary setting
29.2. Ant task list that ERMaster provides
29.3. ermaster.ddl Task
29.4. ermaster.image Task
29.5. ermaster.htmlReport Task
29.6. ermaster.excelReport Task
1. Outline

To the top of this page
1.1. What is ERMaster?

ERMaster is GUI editor for ER diagram.
It runs as Eclipse plug-in.
It can be done graphically to making ER diagram, printing ER diagram, exporting the DDL from ER diagram, etc. .
Moreover, importing from DB, management of the group, and the historical management, etc. are supported.

To the top of this page
2. System requirements

To the top of this page
2.1. Eclipse version

ERMaster is being developed with Eclipse3.5 now.
We are occasionally confirming operation by 3.2 / 3.3 / 3.4 .

To the top of this page
2.2. Correspondence DB

It corresponds to the following data bases now.

-MySQL
-Oracle (developing)
-DB2 (developing)
-PostgreSQL
-HSQLDB (developing)
-SQLITE (developing)
-SQLServer (developing)

It is comparatively possible to use DB which are not developing with stability,
though it doesn't completely correspond to those DB.

To the top of this page
3. Introduction

To the top of this page
3.1. Install

Please add following URL in
[Help] -> [Softward Updates] -> [Find and Install...] -> [Search for new features to install]
[New Remote Site...] from the menu of Eclipse.

http://ermaster.sourceforge.net/update-site/


install/install_01.png

Push [Finish] button while selected for added URL.

install/install_02.png

Put the check to [ERMaster], and push [Next] button in the Update dialog.

install/install_03.png

Execute the installation according to the displayed message.

install/install_04.png


install/install_05.png


install/install_06.png

After restarting Eclipse
If [right-clicks in the project] -> [New] -> [other...] -> [ERMaster] is added, it is a success.


install/install_07.png


install/install_08.png

To the top of this page
3.2. Start

The ERMaster editor starts by default when the file with extension "*.erm" is opened by double-clicking.
When you want to make the file newly,
select [right-clicks in the project] -> [New] -> [other...] -> [ERMaster].


start/start_01.png


start/start_02.png

Input the file name, and select the database system to be used after the wizard opens.
(Even after making the file, it is possible to change the database system. )


start/start_03.png


start/start_04.png

The file is made when the [Finish] button is pushed, and the editor starts.

start/start_05.png

To the top of this page
3.3. View that can be used

The Eclipse view that can be used with ERMaster is the following.

- Editor view
- Outline view
- Problem view
- Task view
- Property view


eclipse/eclipse_view_01.png

Moreover, when the editor has been selected, the icons that can be used are displayed in the toolbar.

eclipse/eclipse_view_02.png

To the top of this page
3.3.1. Editor view

Main veiew of ERMaster.


er/view_editor.png

ER diagram is drawn in this view. The palette is displayed on the left side.
The tab of each [category] is displayed below.

To the top of this page
3.3.2. Outline view

The list of the object is displayed in the upper side in the outline view,
and in the lower side, the whole image of ER diagram is displayed as thumbnail.


er/view_outline.png

To the top of this page
3.3.3. Problem view

The problem that present ER diagram has is displayed in the problem view.
The content of the problem view is not updated only by changing data, and updated by [saving] the file.


er/view_problem.png

To the top of this page
3.3.4. Task view

The content that the manufacturer is describing as a task is displayed in the task view.
The task can be registered by describing the description that starts by "// TODO"
in [Description] field of [Table], [Column], etc.
The content of the task view is updated by saving the file just like the content of the problem view.


er/view_task.png

To the top of this page
3.3.5. Property view

The property of the object that has been selected now is displayed in the property view.
The displayed content might not stand so much in the post because there is an alone not cervine yet now.
This view might be so useless, because information displayed in this view is still little now.

When the campus is clicked, a present database is displayed.
You are able not only to confirm the value but also to change the value in the property view.


er/view_property.png

To the top of this page
4. Data

To the top of this page
4.1. Save

It is possible to save the file by [Ctrl] + [S] or [File] -> [Save] in the menubar.

save/save_01.png

To the top of this page
4.2. Data format

"*.erm" file is XML form.
It is possible to edit it directly by opening with the text editor.

er/er_data_01.png


er/er_data_02.png

To the top of this page
5. Management of table

To the top of this page
5.1. Add/Edit/Delete table

To the top of this page
5.1.1. Add table

Click the [New Table] tool in the palette of the ER editor.
And when becoming a selective state, click an arbitrary place of the canvas.

Click the [New Table] tool.

table/table_new_01.png

Click the canvas.

table/table_new_02.png

To the top of this page
5.1.2. Edit table

[Table Information] dialog opens when the table is double-clicked.
The table name and the columns can be edited by this dialog.

table/table_mod_01.png

To the top of this page
5.1.3. Delete table

Right-clicks the table, and select [Delete] in the popup menu.
It is possible to delete it by even pushing the [Delete] icon in the toolbar
or [Delete] key with the table has been selected.

Select [Delete] in the popup menu.

table/table_del_01.png

[Delete] icon in the toolbar

table/table_del_02.png

To the top of this page
5.2. Management of column

To the top of this page
5.2.1. Add column

[Column Information] dialog opens when the [Add] button is pushed
in [Table Information] dialog.

When 'Physical Name', 'Logical Name', 'Type and length', 'Constraint',
'Description', and 'Default value' are set in this dialog, and [OK] is pushed,
it is reflected in [Table Information] dialog.
When [OK] is pushed in [Table Information] dialog, the column is added to the table.

Push [Add] button in [Table Information] dialog.

column/column_new_01.png

[Column Information] dialog.

column/column_new_02.png

Reflected in [Table Information] dialog.

column/column_new_03.png

Columns are added to the table.

column/column_new_04.png

To the top of this page
5.2.2. Edit column

To edit the column, select the column and push [Edit] button.
When 'Physical Name', 'Logical Name', 'Type and length', 'Constraint', 'Description', and 'Default value'
are changed in opened [Column Information] dialog, and [OK] is pushed,
it is reflected in [Table Information] dialog.
When [OK] is pushed in [Table Information] dialog, the column of the table is changed.

Select the column and push [Edit] button in [Table Information] dialog.

column/column_mod_01.png

Edit in [Column Information] dialog.

column/column_mod_02.png

Reflected in [Table Information] dialog.

column/column_mod_03.png

The columns of the table are changed.

column/column_mod_04.png

The idea of [word] has been introduced into the column.
Please see Management of word for details.
To add the culumn with another word, set the word pull-down at the blank.

To the top of this page
5.2.3. Delete column

To delete the column, select the column and push [Delete] button.
When [OK] button is pushed after it is reflected in [Table Information] dialog,
the column is deleted from the table.

Select the column and push [Delete] button in [Table Information] dialog.

column/column_del_01.png

Reflected in [Table Information] dialog.

column/column_del_02.png

The columns of the table are changed.

column/column_del_03.png

To the top of this page
5.2.4. Constraint

To add constraints such as primary key, unique key, and the NOT NULL to the column,
check the check box of Primary Key, NOT NULL, and UNIQUE respectively in [Column Information] dialog.

[Column Information] dialog is opened by selecting the column to be changed
and pushing [Edit] button in [Table Information] dialog that is opened when the table is double-clicked.

Select the column and push [Edit] button in [Table Information] dialog.

column/column_constraint_01.png

Edit in [Column Information] dialog.

column/column_constraint_02.png

To set the constraints other than a primary key, NOT NULL, and a unique key,
describe it in [Detail] tab of [Column Information] dialog.

For instance, to set the CHECK constraint to the column, it makes it as shown in the following figure.

column/column_constraint_03.png

The setting of the constraint name of a primary key and complex unique key are done
in the [Constraint] tab of not [Column Information] dialog but [Table Information] dialog.

To the top of this page
5.2.5. Default value

Double-clicking the table, and select the column to which you want to set [Default value],
and push [Edit] button.

When [Default value] is changed, and [OK] is pushed, it is reflected in [Table Information] dialog.

column/column_default_01.png

When [OK] is pushed, it is reflected in the table.

column/column_default_02.png

To the top of this page
5.2.6. Description

Double-clicking table, and select the column to which you want to set [Description],
and push [Edit] button.

When [Description] is changed, and [OK] is pushed, it is reflected in [Table Information] dialog.

column/column_description_01.png

When [OK] is pushed, it is reflected in the table.

column/column_description_02.png

To the top of this page
5.2.7. Sort columns

The order of the column can be changed with selecting the column that is wanted to change,
and pushing [Up] or [Down] button in [Table Information] dialog.


column/column_move_01.png


column/column_move_02.png

To the top of this page
5.3. Complex unique key

To the top of this page
5.3.1. Add complex unique key

Complex unique key is added to the table in [Complex Uniqu Key] tab of [Table Information] dialog.
Check the check box of target columns, and push [Add] button in [Complex Unique Kye] tab.


complex_unique_key/complex_unique_key_01.png

The comlex unique key is added, and the added comlex unique key is displayed to the pull-down.


complex_unique_key/complex_unique_key_02.png

To the top of this page
5.3.2. Edit complex unique key

To change the pair of the columns that composes the complex unique key,
select the complex unique key to be edited by the pull-down
and change the status of checkbox, and push [Update] button.


complex_unique_key/complex_unique_key_03.png

The pair of the columns that composes the complex unique key is updated,
and the display of the pull-down is updated.


complex_unique_key/complex_unique_key_04.png

To the top of this page
5.3.3. Delete complex unique key

To delete the complex unique key,
select the complex unique key to be deleted by the pull-down and push [Delete] button.


complex_unique_key/complex_unique_key_05.png

The Complex unique key is deleted, and it disappears from the pull-down.


complex_unique_key/complex_unique_key_06.png

To the top of this page
5.3.4. Editing and deleting to the complex unique key referenced by the foreign key

Neither the update nor the deletion to the complex unique key referenced by the foreign key can be done.
When you select the complex unique key referenced by the foreign key by the pull-down,
[Update] and [Delete] button become nonactive.


complex_unique_key/complex_unique_key_07.png

To the top of this page
5.4. Index

To the top of this page
5.4.1. Add index

The index is added to the table in [Index] tab of [Table Information] dialog.
When [Add] button is pushed in [Index] tab, the [Index Information] dialog is displayed.

[Double-clicking the table]. Select [Index] tab. Push [Add] button.

column/column_index_new_01.png

[Index Information] dialog.

column/column_index_new_02.png

Input [Index Name], move all columns which compose the index to [Index column].
The order of index column can be changed by pushing [Up] or [Down] button.

column/column_index_new_03.png

When [OK] is pushed, it is reflected in [Index] tab of [Table Information] dialog.

column/column_index_new_04.png

When [OK] is pushed, It is added to [Index] of [Outline] view.

column/column_index_new_05.png

To the top of this page
5.4.2. Edit index

Double-click the table, and select [Index] tab.
Select the upper radio button of the index that is want to change,
and push [Edit] button.

column/column_index_mod_01.png

When it is edited in [Index Information] dialog, and [OK] is pushed,
it is reflected in [Table Information] dialog.

column/column_index_mod_02.png


column/column_index_mod_03.png

When [OK] is pushed, It is reflected to [Index] of [Outline] view.

column/column_index_mod_04.png

To the top of this page
5.4.3. Delete index

Double-click the table, and select [Index] tab.
Select the upper radio button of the index that is want to delete,
and push [Delete] button.

column/column_index_del_01.png

The index is deleted from [Index] tab.

column/column_index_del_02.png

When [OK] is pushed, It is reflected to [Index] of [Outline] view.

column/column_index_del_03.png

To the top of this page
6. Management of relation

The relation can be made by pushing the button on the palette.
The line of the relation becomes a straight line that connects the middle point of each table by default.

To the top of this page
6.1. Rule when relation is made

When the column that can be referenced doesn't exist, the relation cannot be made.
The column that can be referenced indicates the following either.

- Primary Key (or Complex Primary Key).
- Complex unique key
- Unique Key

It is not possible to select the referenced column excluding by [Relation with existing column].

It sequentially looks for the corresponding one from the above-mentioned candidate,
and what is found first is automatically decided as a referenced column.

Execute [Edit relation (Setting of constraint name, reference operation, referenced column, and multiplicity)]
when you want to change the referenced column.

To the top of this page
6.2. Add 1:N Relation

Click [1:N Relation] tool on the palette.


relation/reration_1_n_01.png

The mouse pointer is changed to the one for the relation,
so after clicking the table for one, click the table for N.


relation/reration_1_n_02.png


relation/reration_1_n_03.png

The foreign key column for the relation is added to the table for N, properly edit it.
Moreover, a related column is displayed with the color by selecting the relation.


relation/reration_1_n_04.png

To the top of this page
6.3. Add 1:N Relation (Add relation with existing column)

[1:N Relation] tool automatically adds the foreign key to the table for N.

When the column for foreign key already exists as a usual column in the table for N,
and if you want to make only the relation, use not [1:N Relation] tool
but [Relation with existing column] tool.

Click [Relation with existing column] tool on the palette.


relation/reration_1_na_01.png

The mouse pointer is changed to the one for the relation,


relation/reration_1_na_02.png

The dialog to set the correspondence of the referenced column and the foreign key column is displayed.


relation/reration_1_na_03.png

When the correspondence of the referenced column and the foreign key column is set and [OK] is pushed,
the relation is made.


relation/reration_1_na_04.png


relation/reration_1_na_05.png

To the top of this page
6.4. Add N:N Relation

Click [N:N Relation] tool on the palette.


relation/reration_n_n_01.png

The mouse pointer is changed to the one for the relation,
so after the table for one is clicked,


relation/reration_n_n_02.png

the table for the other is clicked.

relation/reration_n_n_03.png

The relation table is made, so properly edit it.

relation/reration_n_n_04.png

To the top of this page
6.5. Add self relation

Click [Self Relation] tool on the palette.


relation/reration_self_01.png

The mouse pointer is changed to the one for the relation,
so click the table for which you want to make the self-relation.


relation/reration_self_02.png

The foreign key column for the relation is added to the table, properly edit it.


relation/reration_self_03.png

To the top of this page
6.6. Edit relation (Setting of constraint name, reference operation, referenced column, and multiplicity)

Double-click the line for relation.

relation/reration_mod_01.png

[Relation Information] dialog is displayed, so edit necessary parts.
At [Referenced Column] field only the column that can be referenced is displayed.
The column that can be referenced indicates the following either.

- Primary Key (or Complex Primary Key).
- Complex unique key
- Unique Key


relation/reration_mod_02.png

When [OK] button is pushed, it is reflected in the relation.


relation/reration_mod_03.png

To the top of this page
6.7. Delete Relation

Click the line for relation, and right-click it that became selective state.
Select [Delete] in the pop-up menu.

relation/reration_del_01.png

The confirmation dialog whether to delete the column set to the foreign key
at the same time is displayed.

relation/reration_del_02.png

The foreign key is deleted at the same time as relation when [Yes] is chosen by the confirmation dialog.


relation/reration_del_03.png

When [No] is chosen by the confirmation dialog, only the relation is deleted,
and the foreign key remains as a usual column.


relation/reration_del_04.png

To the top of this page
7. Management of view

To the top of this page
7.1. Add/Edit/Delete view

The addition, the edit, and the deletion for the view look like
the addition, the edit, and the deletion for the table.

To the top of this page
7.1.1. Add view

Click the [Create View] tool in the palette of the ER editor.
And when becoming a selective state, click an arbitrary place of the canvas.

Click the [Create View] tool.

view/view_add_01.png

Click the canvas.

view/view_add_02.png

To the top of this page
7.1.2. Edit view

[View Information] dialog opens when the view is double-clicked.
The view name and the columns and the sql can be edited by this dialog.

view/view_mod_01.png

To the top of this page
7.1.3. Delete view

Right-clicks the view, and select [Delete] in the popup menu.
It is possible to delete it by even pushing the [Delete] icon in the toolbar
or [Delete] key with the view has been selected.

Select [Delete] in the popup menu.

view/view_del_01.png

To the top of this page
7.2. Management of column of view

Because the management of the column of the view is similar to the management of the column of the table,
refer to Management of column.
However, the constraint such as primary key, NOTNULL, unique key
and the default value cannot be set to the column of the view.

Moreover, because information on the column set here is used only to display it in ER diagram
and in the DB definition document on the Excel/HTML form,
it is not reflected in DDL at all.

To the top of this page
8. Management of note

[Note] can be added to ER diagram.
Click [Create Note] tool of the palette.

note/note_01.png

The mouse pointer is changed, so click an arbitrary place of the canvas.

note/note_02.png

If [Note] is double-clicked, the direct edit becomes possible.

note/note_03.png

To connect the note to the table, click [Connect Note] tool of the palette,
and click the note and the table.

note/note_04.png

To the top of this page
9. Management of category

[Category] is a tool to express the classification of some tables.
The table that belongs to two or more categories can be expressed.

To the top of this page
9.1. Add category

If [icon/category_add_01.png] icon of the palette is selected,
and the mouse is changed, click the canvas,
and without releaseing the mouse button select the tables that you want to have them belong to the category,
and release the mouse button.

category/category_add_02.png

The category is added at the clicked point.
When the category is added, the tab for the category is added under the canvas.

category/category_add_03.png

Only the tables that belong to the category are displayed in the tab of each category.

When the tab of a category is selected with three categories exist as shown in the figure below,

category/category_add_04.png

only the tables that belong to the category are displayed.

category/category_add_05.png

The category can be added by inputting the category name in [Category] dialog
displayed by [right-clicks on the canvas] -> [Category] -> [Management of category],
and pressing [Add] button.


category/category_add_06.png

Input the category name, and push [Add] button.

category/category_add_07.png

To the top of this page
9.2. Edit category

The category name can be changed.
[right-clicks on the canvas] -> [Category] -> [Management of category]

category/category_mod_01.png

Make the category to be edited a selective state.

category/category_mod_02.png

Edit the category name, and push [Update] button.

category/category_mod_03.png

The category name displayed on the canvas and the tab name are changed.

category/category_mod_04.png

To the top of this page
9.3. Delete category

Right-click in the category, and select [Delete] by the pop-up menu.
It is possible to delete it by even pushing [Delete] icon of the toolbar
or by pushing [Delete] key with the category has been selected.


category/category_del_01.png


category/category_del_02.png

The category can be deleted by selecting the category to be deleted and
and pressing [Delete] button in [Category] dialog displayed by
[right-clicks on the canvas] -> [Category] -> [Management of category].

category/category_del_03.png

To the top of this page
9.4. Add the table to the category

The table can be added to the category by dragging the table in the area of the category.

category/category_table_add_01.png


category/category_table_add_02.png

The table can be added to the category by even completely enclosing the table
by dragging the frame of the category and expanding the category area

category/category_table_add_03.png


category/category_table_add_04.png

Moreover, the table can be added to the category by selecting the category and
checking the right side tables, and even pressing [OK] button in [Category] dialog
displayed by [right-clicks on the canvas] -> [Category] -> [Management of category],

category/category_table_add_05.png

To the top of this page
9.5. Remove the table from the category

The table can be removed from the category by dragging the table,
and removing from the area of the category completely.


category/category_table_del_01.png


category/category_table_del_02.png

The table can be removed from the category by even selecting the category,
and removing the check on the right side tables, and even pressing [OK] button in [Category] dialog
displayed by [right-clicks on the canvas] -> [Management of category],

category/category_table_del_03.png

To the top of this page
10. Management of word

In ERMaster, the one that "Logical Name", "Physical Name", "Type", "Length", "Decimal", and "Description"
were grouped is expressed by [Word].

The column of each table is made from [Word], and "Constraint" and "Default value" are added.

Sets of [Word] are assumed [Dictionary], and displayed in [Outline] view.

dictionary/dictionary_01.png

To the top of this page
10.1. Add word

[Word] cannot be added only by it.
When the column was added if [Word] having same "Logical Name", "Physical Name", "Type", "Length", "Decimal", and "Description"
had not been registered yet, [Word] is newly registered automatically.

The table is newly added,

word/word_add_01.png

and two columns are added, and [OK] button is pressed.

word/word_add_02.png

Two columns are added to the table, and [Word] is registered in [Outline] view.
The tables that use [Word] is displayed under [Word].

word/word_add_03.png

To the top of this page
10.2. Edit word

When [Word] is edited, the content of the edit is reflected in all columns that use the [Word].
There are two methods of editing [Word].

The first method is a method of editing the column that uses [Word].
When the column is edited, [Word] used is edited at the same time.
Therefore, when you use the same [Word] by two or more columns as shown in the following figure


word/0.png

When you change information by editing the column of one of tables


word/1.png

The column information on the other table is updated at the same time.


word/2.png

If you want to update column information on the only one of tables,
it is necessary to update it to use a separate word.

If the column is edited with selecting empty at [Word] field as shown in the following figure,
a new word with same information is made.


word/4.png

By doing so, two columns that was originally using the same one [Word] can be divided
into the column using former [Word] and the column using the [Word] newly added.


word/5.png

The second method is a method to editing the word by [Word Information] dialog
that is opened by double-clicking [Word] icon [icon/word_mod_01.png] under [Dictionary] of outline view.

Outline view

word/word_mod_05.png

[Word Information] dialog opens, and [Word] can be edited.

word/word_mod_06.png

To the top of this page
10.3. Delete word

There is no operation that deletes [Word].
[Word] which is not used with any column is automatically deleted.

To the top of this page
10.4. Add word to the table

The column with information of the [Word] can be added to the table by
drag and dropping the [Word] icon[icon/word_mod_01.png] of [Outline] view
to the table of the canvas.


word/word_table_add_01.png


word/word_table_add_02.png

To the top of this page
11. Management of group

The columns can be registered, edited, deleted with the group as a unit,
by making the group that collects some columns.

For instance, if columns such as "UPDATED_DATE", "REGISTRATION_DATE", "UPDATED_USER", and "REGISTRANT_USER"
that all tables similarly have are registered as a group,
it becomes very easy to add four columns for each table.

However, note that it is impossible to making the foreign key that refers to the column of the group,
or selecting the column of the group as the member of a complex unique key.

To the top of this page
11.1. Add group

Right-click in [Group] of [Outline] view,
and select [Management of group] from the displayed pop-up menu.


group/group_add_01.png

[Manage of group] dialog opens, so push [Add group] button.


group/group_add_02.png

It becomes possible to input group information.
Input the group name, and push [Add] button.


group/group_add_03.png

Input column information in the displayed [Group Column Information] dialog
and push [OK] button.


group/group_add_04.png

Column information is added to the group.
Add necessary columns to the group by the same procedure.

When the addition of the columns are finished, push [Update] button.


group/group_add_05.png

When [OK] button of [Management of group] dialog is pushed, the added groups are reflected.


group/group_add_06.png

Moreover, the group management dialog can be opened even by pushing [Management of Group]
button in [Table Information] dialog opend by double-clicking the table


group/group_add_07.png

To the top of this page
11.2. Edit group

Double-click the group to be edited in [Group] of [Outline] view.

group/group_mod_01.png

[Group Information] dialog opens, so select the column to be edited and push [Edit] button.

group/group_mod_02.png

When [Group Column Information] dialog is displayed,
edit the content, and push [OK] button.

group/group_mod_03.png

When the edit of all columns is finished, push [OK] button.

group/group_mod_04.png

It is reflected in the table.

group/group_mod_05.png

To the top of this page
11.3. Delete group

Select the group to be deleted from [Outline] view,
and right-click it and select [Delete] menu.


group/group_del_01.png

The group is deleted, and the group is removed from all tables that use the group.

group/group_del_02.png

To the top of this page
11.4. Add group to the table

Drag the group name displayed in [Outline] view and drop to the table.

group/group_table_add_01.png


group/group_table_add_02.png

Moreover, the group can be added even by the following method.

Selected the group by [Group] pull-down field in [Table Information] dialog
opend by double-clicking the table,

group/group_table_add_03.png

and click [Add the group item to the table] button.

group/group_table_add_04.png

The group is added to the table when information is fixed by pushing [OK] button.

group/group_table_add_05.png


group/group_table_add_06.png

To the top of this page
11.5. Remove group from the table

It is possible to removing [Group] from the table in a similar way to removing a usual column.

Selected the group that wants to be delteted and push [Delete] button in [Table Information] dialog
which is opend by double-clicking the table.

group/group_table_del_01.png

When the group is deleted, fix the information by pushing [OK] button.

group/group_table_del_02.png


group/group_table_del_03.png

To the top of this page
11.6. Global group

It is possible to register the group that wants to be shared by two or more projects as a [Global group].
When the .erm file is newly created, the file contains the group registered as a [Global group] from the beginning.

To the top of this page
11.6.1. Management of global group

To manage a global group, select [Window] -> [Preferences...] from the menu of Eclipse,
and select [ERMaster] in [Preference] dialog, and push [Management of global group] button.

global_group/6.png

The group is added/edited/deleted in the same way as in usual group management.

global_group/7.png

To the top of this page
11.6.2. Add a group to global groups

It is possible to add a group to global groups by selecting the group and pushing
[Add to global group] button in [Group Management] dialog of a usual group.

global_group/8.png


global_group/9.png

To the top of this page
11.7. Expansion and fold of group

The group added to the table is expanded and all columns are displayed in default.

global_group/10.png

By selecting [Expand group] in the pop-up menu displayed by right-clicking on canvas,

global_group/11.png

the group will be folded, and only the group name comes to be displayed.

global_group/12.png

To the top of this page
12. Management of trigger

The addition, the edit, and the deletion of the trigger are done in [Outline] view.

To the top of this page
12.1. Add trigger

Right-click [icon/dictionary.gif] trigger icon in [Outline] view,
and select [Add Trigger] by the pop-up menu.

trigger/trigger_add_01.png

[Trigger Information] dialog opens, so input the name and SQL of the trigger and push [OK] button.

trigger/trigger_add_02.png

The created trigger is added to [Outline] view.

trigger/trigger_add_03.png

To the top of this page
12.2. Edit trigger

Double-click the trigger to be edited from the triggers of [Outline] view.

trigger/trigger_mod_01.png

[Trigger Information] dialog opens, so input necessary information and push [OK] button.

trigger/trigger_mod_02.png

The trigger is edited, and it is reflected in [Outline] view.

trigger/trigger_mod_03.png

To the top of this page
12.3. Delete trigger

Right-click the trigger to be deleted from the triggers of [Outline] view,
and select [Delete] of the pop-up menu.

trigger/trigger_del_01.png

The trigger is deleted, and it is reflected in [Outline] view.

trigger/trigger_del_02.png

To the top of this page
13. Management of sequence

The addition, the edit, and the deletion of the trigger are done in [Outline] view.
The created sequence cannot be related to the table.

To the top of this page
13.1. Add sequence

Right-click [icon/dictionary.gif] sequence icon in [Outline] view,
and select [Add Sequence] of the pop-up menu.


sequence/sequence_add_02.png

[Sequence Information] dialog opens, so input necessary information and push [OK] button.

sequence/sequence_add_03.png

The created sequence is added to [Outline] view.

sequence/sequence_add_04.png

To the top of this page
13.2. Edit sequence

Double-click the sequence to be edited from the sequences of [Outline] view.

sequence/sequence_mod_01.png

[Sequence Information] dialog opens, so input necessary information and push [OK] button.

sequence/sequence_mod_02.png

To the top of this page
13.3. Delete Sequence

Right-click the sequence to be deleted from the sequences of [Outline] view,
and select [Delete] of the pop-up menu.

sequence/sequence_del_01.png

The sequence is deleted, and it is reflected in [Outline] view.

sequence/sequence_del_02.png

To the top of this page
14. Management of tablesapece

[Management of tablesapece] is being developed now.

To the top of this page
15. [Edit all attributes]

[Edit all attributes] is being developed now.

To the top of this page
16. Copy/Paste

Copy the selected tables by [Ctrl]+[c],
and paste the copied tables by [Ctrl]+[v].

Copy by [Ctrl]+[c]

copy/copy_01.png

Paste by [Ctrl]+[v]

copy/copy_02.png

Copy/Paste of the table is able to be done from not only current file,
but also other files.

Copy by [Ctrl]+[c]

copy/copy_03.png

Open another file, and paste by [Ctrl]+[v]

copy/copy_04.png

To the top of this page
17. Move column

It is possible by drag and drop to move the column to another table.

Select the column that you want to move.

move/move_01.png

Drag and drop to the destination table.

move/move_02.png

When you cannot select the column,
please confirm [icon/column_lock.png] of the toolbar is not locking.


move/move_03.png

To the top of this page
18. Layout

To the top of this page
18.1. Move table

The table can be moved by dragging the table directly.
The whole image is displayed under the outline view, and refer to it.
Moreover, refer to [Change scale] to expand figure or to reduce.

In default, to enable [Move column], it is necessary to select the parts other
than the column of the table to select the table.
If it is difficult to select the table, by putting [icon/column_lock.png] of the toolbar
into the state of the lock, even if the column part is clicked, the table comes to be selected.


move/move_03.png

When you want to move a table besides the canvas displayed now,
Screen scrolls by dragging the table to the edge of the canvas and stopping at the point
without releasing the mouse button.

Draggin the table

table/table_move_01.png

Screen scrolls by stopping at the point without releasing the mouse button.

table/table_move_02.png

Drop at the point that you want to move to.

table/table_move_03.png

To the top of this page
18.2. Line up tables

The tables can be lined up by pushing the following icons in the menubar
with two or more tables selected.
The table treated as a base is a table selected at the end.

For instance, selecte two or more tables that want to put the upper part together and
click [icon/align_top.png] icon,

table/table_align_01.png

so the tables are lined up.

table/table_align_02.png

The following icons are prepared to line up tables.

- icon/align_left.png:The left end of the tables that have been selected are put together on the same position.
- icon/align_right.png:The right end of the tables that have been selected are put together on the same position.
- icon/align_center.png:The vertical center line of the tables that have been selected are put together on the same position.
- icon/align_top.png:The top of the tables that have been selected are put together on the same position.
- icon/align_bottom.png:The bottom of the tables that have been selected are put together on the same position.
- icon/align_middle.png:The horizontal middle line of the tables that have been selected are put together on the same position.

- icon/align_width.png:The size of the tables are changed to be the same in width.
- icon/align_height.png:The size of the tables are changed to be the same in height.

- icon/align_even_vertical.png:The interval of the tables that have been selected are vertically evened up.
- icon/align_even_horizontal.png:The interval of the tables that have been selected are horizontally evened up.

To the top of this page
18.3. Edit table size

To change the size of the table, drag the white point (handle) that is displayed when the table is selected.


table/table_size_01.png


table/table_size_02.png

After selecting the table,
and selecting [Self adjustment of size] by the pop-up menu which is displayed by right-clicking,
the size of the table can be adjusted by present volume of data.


table/table_size_03.png


table/table_size_04.png

To the top of this page
18.4. Change table color

When the table is selected, and [icon/table_color_01.png] icon of the menubar is pushed,
the color of the table is changed.

Select the table.

table/table_color_02.png

When you click the icon of the menubar

table/table_color_05.png

The color is changed.

table/table_color_06.png

To change the color of [icon/table_color_01.png] icon of the menubar,
push [icon/table_color_03.png] icon on the side of [icon/table_color_01.png] icon,
and select the color by the displayed dialog.

table/table_color_04.png

To the top of this page
18.5. Align relation

Though the line of the relation becomes a straight line by default,
The connection point to the table can be changed, and the line can be bent.

When a related line is selected, the handle is displayed in connected part of the table.

relation/reration_align_01.png

It is possible to move to an arbitrary place of the table by dragging this handle.

relation/reration_align_02.png

Moreover, when a related line is selected, the handle is displayed at the center of the line.

relation/reration_align_03.png

The line can be bent by dragging this handle.

relation/reration_align_04.png

Moreover, the line is selected, and it right-clicks.
The line can be squarely done by selecting [Right Angle Line] in the pop-up menu.

relation/reration_align_05.png


relation/reration_align_06.png

When you return it to the one when a related line is created,
select the line and right-click it, and select [Back to the default] by the displayed pop-up menu.

relation/reration_align_07.png


relation/reration_align_08.png

To the top of this page
18.6. Change font

The font of the table is changed when the table is selected,
and the value is changed by the font pull-down in the menubar.

layout/font_change_01.png


layout/font_change_02.png

Similarly, the fontsize of the table is changed, when the value is changed
by the fontsize pull-down in the menubar,

layout/font_change_03.png


layout/font_change_04.png

To the top of this page
19. Display

To the top of this page
19.1. Change scale

The display scale of the canvas is changed to scroll the mouse wheel while pushing the [Ctrl] key.

Reduction:25%

canvas/canvas_scale_01.png

Expansion:200%

canvas/canvas_scale_02.png

Moreover, it is possible to change by [icon/zoomin.png] [icon/zoomout.png] [icon/zoom_adjust.png] icon
or the scale pull-down canvas/canvas_scale_03.png in the menubar.

To the top of this page
19.2. Display Tooltip

It becomes impossible to distinguish the table name when the scale becomes small.
The table name can be displayed with the tooltip for mouse over and the range selection.

Turn on [Tooltip] in the menubar.

tooltip/tooltip_01.png

The table name is displayed in case of the mouse over.

tooltip/tooltip_02.png

Even if the range is selected, the table name is displayed.

tooltip/tooltip_03.png

To the top of this page
19.3. Display grid line

The grid line is displayed on the canvas by default.
If it is difficult to see figure because the grid line is obstructive,
the grid line can be non-displayed by turning off [Grid] in the toolbar.


grid/grid_01.png


grid/grid_02.png

To the top of this page
19.4. Change notation

The notation of IE and IDEF1X can be selected.

IE notation

notation/notation_01.png

IDEF1X notation

notation/notation_02.png

It is possible to switch by selecting either from [Notation] of the pop-up menu
which is displayed by right-clicking on the canvas.

notation/notation_03.png

To the top of this page
19.5. Change display

The display level of the table on the canvas and the table of the [Outline] view can be changed.

To the top of this page
19.5.1. Change view mode

It is possible in both canvas and [Outline] view, displaying the only logical names,
displaying the only physical names, and displaying both of logical and physical names.

For the canvas
It is possible to do by selecting either from [View Mode] in the pop-up menu
which is displayed by right-clicking on the canvas.

viewmode/viewmode_01.png

For [Outline] view
It is possible to do by selecting either from [Outlines's View Mode] in the pop-up menu
which is displayed by right-clicking on [Outline] view.

viewmode/viewmode_02.png

To the top of this page
19.5.2. Change notation level

The following display levels can be selected with the table in the canvas.

- Only the table name
- Only the table name and the key columns
- Only the table name and the column names
- Display all

It is possible to change by selecting either from [Notation Level] in the pop-up menu
which is displayed by right-clicking on the canvas.

viewmode/viewmode_03.png

To the top of this page
19.6. Change design

Three designs that can be selected are prepared.
Each image is as follows.

Funny

design/design_01.png

Frame

design/design_02.png

Simple

design/design_03.png

It is possible to change by selecting either from [Design] in the pop-up menu
which is displayed by right-clicking on the canvas.

design/design_04.png

To the top of this page
19.7. Display by the capital letter

When physical name of the tables or the columns are set by the small letter as shown in the following figure

display/capital_01.png

It is possible to display it by the capital letter in the display by selecting [Display by the capital letter]
in the pop-up menu which is displayed by right-clicking on the canvas.

Select [Display by the capital letter]

display/capital_02.png

Physical names are displayed by the capital letter.

display/capital_03.png

To the top of this page
19.8. Stamp

It is possible to display it as a stamp by setting the property of the project name
and the manufacturer, etc. to ER diagram.
Select [Display the stamp] in the pop-up menu which is displayed by right-clicking on the canvas
to display the stamp.


display/stamp_01.png

By selecting [Display the stamp], the stamp is displayed in ER diagram.

display/stamp_02.png

You can set the properties displayed in the stamp in [Model Property] dialog
displayed by double-clicking the stamp.


display/stamp_03.png

In the [Model Property] dialog, it is possible not only to set the value of the properties prepared by default
but also to add or remove the property.

display/stamp_04.png

Information of the properties that is set is reflected in the stamp of figure.

display/stamp_05.png

To the top of this page
20. Import and Export

To the top of this page
20.1. Import

To the top of this page
20.1.1. Daeabase

The ER diagram can be made by loading the table definition from the database that exists now.

Create empty ER diagram.

import/import_database_01.png

Select [Import] -> [Database] in the pop-up menu which is displayed by right-clicking on the canvas.

import/import_database_02.png

[Import from Database] dialog opens, so input necessary information to connect database and push [OK] button.

import/import_database_03.png

If it succeeds to connect, then the list of tables and indexes, etc that exist in the database will be displayed,
so check the ones that you want to import and push [OK] button.

import/import_database_04.png

ER diagram is made by loading the checked ones.

import/import_database_05.png

To the top of this page
20.1.2. File (.erm)

The ER diagram can be made by loading the table definition from another .erm file.

erm file that another file will be imported to.

import/import_file_01.png

erm file that will be imported.

import/import_file_02.png

Select [Import] -> [File] in the pop-up menu which is displayed by right-clicking on the canvas.

import/import_file_03.png

[Open] dialog opens, so select the erm file to be loaded and push [Open] button.

import/import_file_04.png

The list of tables and indexes, etc that exist in the selected file will be displayed,
so check the ones that you want to import and push [OK] button.

import/import_file_05.png

The tables and indexes, etc loaded from another erm file are added.

import/import_file_06.png

To the top of this page
20.2. Export

The image, the DB definition document(EXCEL from), the DB definition document(HTML from), the DDL, the dictionary,
and the translation dictionary can be output from made ER diagram.

To the top of this page
20.2.1. Export Image

Made ER diagram can be output to image.

Select [Export] -> [Image] in the pop-up menu which is displayed by right-clicking on the canvas.

export/export_picture_01.png

The [Save as] dialog opens, so input the file name and push [Save] button.

export/export_picture_02.png

The message is displayed when succeeding in the output.

export/export_picture_03.png

The image can be output by three kinds of forms of "*.png", "*.jpeg", and "*.bmp".

export/export_picture_04.png

To the top of this page
20.2.2. DB definition document(EXCEL from)

The DB definition document can be output from made ER diagram by the Excel form.
Jakarta POI is used for the Excel library.

Select [Export] -> [Excel] in the pop-up menu which is displayed by right-clicking on the canvas.

export/export_excel_01.png

[Output of the DB definition book] dialog opens, so
push [OK] button with specifying the the template which is used and output file.

export/export_excel_02.png

The following file is output.

export/export_excel_03.png

The layout of the output Excel can be edited by making an custom template file.
Refer to Create custom DB definition book template for the method of making the template file.

To the top of this page
20.2.3. DB definition document(HTML from)

The DB definition document can be output from made ER diagram by the HTML form.

Select [Export] -> [HTML] in the pop-up menu which is displayed by right-clicking on the canvas.

export/export_html_01.png

[Reference for folder] dialog opens, so
push [OK] button, then the folder named [dbdocs] is made under the selected folder.


export/export_html_02.png

The files as shown in the following figure are made under [dbdocs].

export/export_html_03.png

The generated DB definition document is a design of the Javadoc style.
The template of this design cannot be customized unlike the DB definition book (EXCEL form).

export/export_html_04.png

To the top of this page
20.2.4. DDL (TXT)

DDL for the database construction can be output from made ER diagram.

Select [Export] -> [DDL] in the pop-up menu which is displayed by right-clicking on the canvas.

export/export_ddl_01.png

[Output of the DDL] dialog opens, so input necessary information and push [OK] button.

export/export_ddl_02.png

Output DDL

export/export_ddl_04.png

When there is incompleteness in the table definition the message dialog is displayed,
but DDL can be output by continuing as it is.

export/export_ddl_05.png

To the top of this page
20.2.5. Dictionary (CSV)

The [word] used in made ER diagram can be output by CSV form.

Select [Export] -> [Dictionary] in the pop-up menu which is displayed by right-clicking on the canvas.

export/export_dictionary_01.png

The [Save as] dialog opens, so input the file name and push [Save] button.

export/export_dictionary_02.png

The message is displayed when succeeding in the output.

export/export_dictionary_03.png

The output form becomes "Physical Name", "Logical Name", "Type", and "Description".

export/export_dictionary_04.png

To the top of this page
20.2.6. Translation dictionary

ERMaster has the function of [Translation].
It translates a physical name to a logical name when importing the data from DB.

The translation is done along the translation dictionary.
To use the correspondence of a physical name and the logical name made for a certain database design
even for other database designs, the translation dictionary file can be output from ER diagram.

To output the translation dictionary file from ER diagram,
selecte [Export] -> [Translation Dictionary] in the pop-up menu which is displayed by right-clicking on the canvas.

export/export_translation_01.png

The [Export translation dictionary] dialog opens, so input the name of translation dictionary and push [OK] button.

export/export_translation_02.png

The generated dictionary is stored in '$workspace$/.metadata/.plugins/org.insightech.er/translation/',
and can be used from other ER diagrams as a translation dictionary file.


export/export_translation_03.png


export/export_translation_04.png

Refer to [Translation] for the usage of the translation dictionary.

To the top of this page
20.2.7. DB

It is possible to execute DDL for the table construction directly from made ER diagram to database.

* Because this function delete all content of the database once,
use it only when there is no problem even if the content of the database is deleted.

To export to DB, click [Export to DB] icon of the toolbar.

export/export_db_01.png

When ER diagram is imperfect, the error dialog is displayed,
so execute it again after solving the error.


export/export_db_06.png

The dialog to specify DB to export to is displayed when there is no problem in ER diagram.

export/export_db_02.png

When [OK] button is pushed, all SQL that will be executed is displayed.

export/export_db_03.png

If you want to execute only a part of displayed SQL,
make the part to be executed a selective state and push [Execute] button.
Moreover, edited SQL can be executed by editing the displayed SQL and pushing [Execute] button.

export/export_db_part.png

When [Execute] button is pushed, the dialog that confirms whether to execute it is displayed,
so push [OK] button.

export/export_db_04.png

The following dialog is displayed when succeeding in updating the database.

export/export_db_05.png

The following dialog that show the reason of the error is displayed when failing in the update of the database.

export/export_db_error.png

To the top of this page
21. Create custom DB definition book template

It explains the method of making the custom template of the DB definition book here.

To the top of this page
21.1. Download of standard template

Download the standard template prepared with ERMaster.

Select [Window] -> [Preferences] in the menu of the Eclipse.


excel_template/download_01.png

Select [ERMaster] -> [Template of Definition Book] in the left tree.


excel_template/download_02.png

push [Download template] button.


excel_template/download_03.png

[Save as] dialog opens, so save the file in a suitable place.

excel_template/template.png

To the top of this page
21.2. Edit template

A standard template is composed of some seats.

To the top of this page
21.2.1. Cover

The first sheet is a [Cover] sheet.


excel_template/cover.png

You may delete the [Cover] seat if unnecessary.
Moreover, the favorite number of seats of favorite name can be added,
if there are firmly attached seat.
These firmly attached seats are left for the generated DB definition document as a firmly attached seat.

To the top of this page
21.2.2. sheet_index_template sheet

The second sheet is a [sheet_index_template] sheet.


excel_template/list_of_sheets.png

This sheet becomes to the list of the sheets of generated Excel,
and it has the links to the each sheet.


excel_template/generated_list_of_sheets.png

The key words that can be used are defined in
[Keyword in sheet_index_template] of [words] sheet.
[Printing character] of [Sheet Name] becomes the genereted sheet name.


excel_template/keyword_sheet_index.png

To the top of this page
21.2.3. Diagram

The third sheet is [Diagram] sheet to stick ER diagram.


excel_template/excel_er.png

The sheet name of [Diagram] sheet is arbitrary. You may change to another name.
The image of ER diagram is put on the part described [$ER(width, height)].
In this case, the image is expanded and contracted to fit into width and the height specified in ()
with maintaining the fineness ratio of the size of the former image.

It can be described only [$ER] specifying neither width nor height.
In this case, the size of the image is used as it is as for the size.

To the top of this page
21.2.4. Template sheet

Contents of each template sheet can be freely edited.
Moreover, an unnecessary template sheet can be deleted.

The template sheet is described by using the key word.
The key word that can be used is defined in the [words] sheet.

Neither each template sheet, the [words] sheet nor the [loops] sheet
exist in the generated DB definition document.

To the top of this page
21.2.4.1. table_template sheet

A sheet is made by each table,
and the physical name or the logical name of the table becomes a sheet name.

The key words that can be used are defined in
[Keyword in table_template/category_template/all_tables_template] of [words] sheet.


excel_template/keyword_table.png

There is a restriction that it is necessary to describe information on one column by one line.

The part described [$PIDX] or [$LIDX]

excel_template/table_index_before.png

is replaced by the matrix table of the index.

excel_template/table_index_after.png

Though it is not described in a standard template,
The number is sequentially applied from 1 to the part
where $ORD was described as information on the column.
Use it when the number is necessary.

To the top of this page
21.2.4.2. index_template sheet

A sheet is made by each index,
and the physical name of the index becomes a sheet name.

The key words that can be used are defined in
[Keyword in index_template/all_indices_template] of [words] sheet.


excel_template/keyword_index.png

There is a restriction that it is necessary to describe information on one column by one line.

The number is sequentially applied from 1 to the part
where $ORD was described as information on the column.


excel_template/index_ord.png

To the top of this page
21.2.4.3. sequence_template sheet

A sheet is made by each sequence,
and the physical name of the sequence becomes a sheet name.

The key words that can be used are defined in
[Keyword in sequence_template/all_sequences_template] of [words] sheet.


excel_template/keyword_sequence.png

To the top of this page
21.2.4.4. view_template sheet

A sheet is made by each view,
and the physical name of the view becomes a sheet name.

The key words that can be used are defined in
[Keyword in view_template/all_view_template] of [words] sheet.


excel_template/keyword_view.png

To the top of this page
21.2.4.5. trigger_template sheet

A sheet is made by each trigger,
and the physical name of the trigger becomes a sheet name.

The key words that can be used are defined in
[Keyword in trigger_template/all_trigger_template] of [words] sheet.


excel_template/keyword_trigger.png

To the top of this page
21.2.4.6. category_template sheet

A sheet is made by each category,
and the name of the category becomes a sheet name.

The key words that can be used are defined in
[Keyword in table_template/category_template/all_tables_template] of [words] sheet.


excel_template/keyword_table.png

In the sheet of each category, all tables contained in the category are
described by the content of the template

To describe the header part of the category,
it is possible to specify what number of line it is repeated from
by [First Line] of [category_template] of [loops] sheet.
Similarly, how many space lines is put between one table and the other table
is specified by [Space Line].


excel_template/loops.png

Moreover, the sheet where tables not contained in any category were collected is made.
The name of this sheet can be specified by [Sheet Name] of [category_template] of [loops] sheet.

To the top of this page
21.2.4.7. column_template sheet

It is a template to describe all columns of all tables.

The key words that can be used are defined in
[Keyword in column_template] of [words] sheet.


excel_template/keyword_column.png

The printing character of $SHTN in the key word of the words sheet that can be used with column_template can specify the name of this sheet.

The name of this sheet can be specified by [Printing character] of [$SHTN] in
[Keyword in column_template] of [words] sheet.

To the top of this page
21.2.4.8. all_tables_template sheet

It is a template to describe all tables in one sheet.

The key words that can be used are defined in
[Keyword in table_template/category_template/all_tables_template] of [words] sheet.


excel_template/keyword_table.png

All tables are described in this sheet by the content of the template.
To describe the header part,
it is possible to specify what number of line it is repeated from
by [First Line] of [all_tables_template] of [loops] sheet.
Similarly, how many space lines is put between one table and the other table
is specified by [Space Line].


excel_template/loops.png

The name of this sheet can be specified by [Sheet Name] of [all_tables_template] of [loops] sheet.

To the top of this page
21.2.4.9. all_indices_template sheet

It is a template to describe all indices in one sheet.

The key words that can be used are defined in
[Keyword in index_template/all_indices_template] of [words] sheet.


excel_template/keyword_index.png

All indices are described in this sheet by the content of the template.
To describe the header part,
it is possible to specify what number of line it is repeated from
by [First Line] of [all_indices_template] of [loops] sheet.
Similarly, how many space lines is put between one index and the other index
is specified by [Space Line].


excel_template/loops.png

The name of this sheet can be specified by [Sheet Name] of [all_indices_template] of [loops] sheet.

To the top of this page
21.2.4.10. all_sequences_template sheet

It is a template to describe all sequences in one sheet.

The key words that can be used are defined in
[Keyword in sequence_template/all_sequences_template] of [words] sheet.


excel_template/keyword_sequence.png

All sequences are described in this sheet by the content of the template.
To describe the header part,
it is possible to specify what number of line it is repeated from
by [First Line] of [all_sequences_template] of [loops] sheet.
Similarly, how many space lines is put between one sequence and the other sequence
is specified by [Space Line].


excel_template/loops.png

The name of this sheet can be specified by [Sheet Name] of [all_sequences_template] of [loops] sheet.

To the top of this page
21.2.4.11. all_view_template sheet

It is a template to describe all views in one sheet.

The key words that can be used are defined in
[Keyword in view_template/all_view_template] of [words] sheet.


excel_template/keyword_view.png

All views are described in this sheet by the content of the template.
To describe the header part,
it is possible to specify what number of line it is repeated from
by [First Line] of [all_view_template] of [loops] sheet.
Similarly, how many space lines is put between one view and the other view
is specified by [Space Line].


excel_template/loops.png

The name of this sheet can be specified by [Sheet Name] of [all_view_template] of [loops] sheet.

To the top of this page
21.2.4.12. all_trigger_template sheet

It is a template to describe all triggers in one sheet.

The key words that can be used are defined in
[Keyword in trigger_template/all_trigger_template] of [words] sheet.


excel_template/keyword_trigger.png

All triggers are described in this sheet by the content of the template.
To describe the header part,
it is possible to specify what number of line it is repeated from
by [First Line] of [all_trigger_template] of [loops] sheet.
Similarly, how many space lines is put between one trigger and the other trigger
is specified by [Space Line].


excel_template/loops.png

The name of this sheet can be specified by [Sheet Name] of [all_trigger_template] of [loops] sheet.

To the top of this page
21.2.5. words sheet

It is possible by [words] sheet not only to defining the key word
that can be used in each template sheet,
but also to changing the character which will be written in the generated DB definition document
by editing the value of [Printing character] corresponding to each key word.

For instance, if you change [Printing character] of [PK] to [#] in [words] sheet,
when the column is a primary key, [#] is written at the position of [$PK]
described in the template sheet.


excel_template/words.png

To the top of this page
21.2.6. loops sheet

In this sheet,
what number of line it is repeated from is specified by [First Line] to describe the header part
of a sheet with repetition such as [all_tables_template sheet] [all_indices_template sheet] [all_sequences_template sheet]
[all_view_template sheet] [all_trigger_template sheet] and [category_template sheet].
Similarly, how many space lines is put between one trigger and the other trigger
is specified by [Space Line].

Moreover, the name of each sheet (in case of [category_template sheet] the name of sheet that
collect tables not contained in any category) is specified by [Sheet Name].


excel_template/loops.png

To the top of this page
21.3. Register template

To register the made template, push [New...] button in a screen of [Template of DB definition Book].


excel_template/add_template_01.png

The file selection dialog opens, so select the made template.


excel_template/add_template_02.png

The selected template is added to the list of custom templates.


excel_template/add_template_03.png

The registration of the template ends by this.
The registered template comes to be displayed in the template selection pull-down
of [Output of the DB definition book].


excel_template/add_template_04.png

To the top of this page
22. Search

It is possible to search to all the data used in ER diagram.
It is possible to search by not only a logical name or a physical name but also a type or a length, etc.

To search, push [Ctrl]+[F] key or select [Find] in the pop-up menu
which is displayed by right-clicking on the canvas.

search/search_01.png

[Search] dialog opens, so input the string used for the search,
and push [Find All] or [Find Next] button.

search/search_02.png

The search result is displayed on [Result] tab of [Search] dialog.

search/search_03.png

To change the range of the search,
after uncheck [All] check box, check the item in [Range of the search] tab


search/search_04.png

Moreover, the string for the search can be substituted.

Input [Replace Word] and select the item to be substituted from the search result list,
and push [Replace] button.

search/search_05.png

Though the substituted item disappears from the search result, the tables have been changed.

search/search_06.png

To the top of this page
23. Change Tracking

The state of ER diagram can be saved as a history.
It is possible to compare the present ER diagram and the history, and
to restore it from the saved history.

To the top of this page
23.1. Add Change Tracking

[Change Tracking] dialog is displayed by
selecting [right-clicks on the canvas] -> [Change Tracking].

history/history_01.png

Input the content of the change in [Change Tracking] dialog,
and push [Add] button.

history/history_02.png

The history is added.

history/history_03.png

To the top of this page
23.2. Edit change tracking

The content of [Change Tracking] can be changed.
Select the history that you want to change in [Change Tracking] dialog,
and input the content of the change, and push [Update] button.

history/history_04.png

The content of the change is changed.

history/history_05.png

To the top of this page
23.3. Delete change tracking

The history can be deleted.
Select the history to be deleted in [Change Tracking] dialog,
and push [Delete] button.

history/history_06.png

The corresponding history will be deleted.

history/history_07.png

To the top of this page
23.4. Comparison Display

To compare saved history and present ER diagram,
select the history in [Change Tracking] dialog,
and push [Comparison display] button.


history/history_08.png

For the table and the note,
tables added compared with history are painted in blue,
tables changed compared with history are painted in green,
tables deleted compared with history are painted in red,
tables without change compared with history are painted in white.

For the column,
columns added compared with history are painted in blue,
columns changed compared with history are painted in red (before changing) and in blue (after changing),
columns deleted compared with history are painted in red.

history/history_09.png

The column deleted compared with the history are displayed in red,
and the column added are displayed in blue.


history/history_05.png

To clear this display, push [Comparison reset] button in [Change Tracking] dialog.

history/history_10.png

To the top of this page
23.5. Restore from change tracking

To restore from the saved history,
select the history, and push [Display the data of this data] button in [Change Tracking] dialog.

history/history_11.png

The dialog to confirm whether to save present data as a history is displayed.

history/history_12.png

It is changed to the selected history data, even if a present history is saved or isn't.

history/history_13.png

To the top of this page
24. Translation

When importing from DB is done, the word translated from a physical name can be used for a logical name.

The dictionary file which is used to translate is necessary to use the function of translation.
However, only the Japanese one is prepared in default as for this dictionary file.
Therefore, only when the locale is japanese, the function of translation is turning on in default.

First of all, it is necessary to prepare the dictionary file to use the
function of translation excluding Japanese.

To the top of this page
24.1. Form of dictionary file

The dictionary file is described by the following Comma Separated Value.
UTF-8 is used for encoding.

updated_date,AAA
date,BBB
first_name,CCC
last_name,DDD
name,EEE
item,FFF

It is not strict Comma Separated Value. The value to the first comma is assumed to be a physical name,
and the value after it assumes to be a logical name.

The words described in the dictionary are sequentially applied
to replace _*physical name*_ (regular expression) by the logical name.

Therefore, when it is described as stated above, it is translated like

first_name -> CCC
item_name -> FFFEEE
item_ID -> FFFID

Moreover, because it is applied to both the capital letter and the small letter,
ITEM_NAME is translated into "FFFEEE" by similar item_name.

To the top of this page
24.2. Registration of dictionary file for translation

The made dictionary file is registered by [menu] -> [Window] -> [Preferences...] -> [ERMaster] -> [Dictionary for translation].

translation/1.png

When two or more dictionary files exist, it is applied sequentially according to the file list.
Therefore, change the order of file properly in consideration of the priority level.

translation/2.png

To the top of this page
24.3. Management of translation

The dictionary file is not used only by being registerd.
Which dictionary files are used by the translation is set in [Translation] dialog.

[Translation] dialog is displayed by right-clicking on the canvas and selecting [Management of translation].

translation/3.png

To use the function of translation, check the check box of [Use the function of translation].
(The function of translation is turning off by default excluding a japanese environment)
Next, check the check box of the dictionary file which you want to use to translate.


translation/4.png

To the top of this page
24.4. Execution of translation

If the function of translation is turning on, when importing from DB is executed,
the function of translation is automatically used.

translation/3.png

To the top of this page
25. JDBC driver

When a necessary JDBC driver is not registered at the DB import,
the dialog to set the JDBC driver opens.
When a correct setting is done once, this dialog is never displayed again.


jdbc/4.png

To the top of this page
25.1. Management of JDBC driver

Select [ERMaster] -> [JDBC Driver] in [Preferences] dialog displayed
by selecting [Window] -> [Preferences...] in the menu of Eclipse to change the JDBC driver which is used.


jdbc/5.png

To the top of this page
26. Print

It is possible to print by using a standard function of Eclipse.
select [File] -> [Print...] in the menu of Eclipse.

To the top of this page
26.1. Setting of page

The print is done with the pages devided by fat lines in the grid lines.
Therefore, if there is a table on page division line as shown in the following figure,
the table extends over two or more paper when printing.


print/print_01.png

For this case, it is possible to adjust it by setting the expansion reduction
and setting the blank by setting of page.

By setting of page, it is possible to change the direction of print and the size of the paper besides this.

Setting of page is done by [Setting of page] dialog displayed by selectiong
[right-clicking on the canvas] -> [Setting of page].


print/print_02.png


print/print_03.png

When the expansion reduction rate etc. are changed by setting of page,
the position of page division lines are changed according to it.


print/print_04.png

To the top of this page
27. Option

The setting of this ER diagram can be done in [Option] dialog
which is displayed by selecting [right-clicking on the canvas] -> [Setting of page].

option/option_01.png


option/option_02.png

To the top of this page
27.1. Change of database

The database specified when the file is made can be changed in [Database] tab of [Option] dialog.

option/change_database_01.png

When the database is changed, the information peculiar to the database that was not able to be converted
will be lost , so the confirmation dialog will be displayed.

option/change_database_02.png

To the top of this page
27.2. Option tab

To the top of this page
27.2.1. Switch IME mode automatically On focus

If the check box of this option is checked,
IME changes into turning on when focus in the fields of the logical name or the explanation, etc.

Please remove the check if this function is unnecessary,
because it is checking it by default.


option/option_03.png

To the top of this page
27.2.2. Validate the character of physical name

The character that can be used for a physical name
is limited to [a-ZA-Z0-9_] by default,
and when the character excluding this is input,
it becomes an input error.

If you want to use the character excluding this for a physical name,
please remove the check on the check box of this option.


option/option_04.png

To the top of this page
27.2.3. Use Bezier curve to line

Bezier curve can be used for a related line in ERMaster.
Please check the check box of this option, when you want to use Bezier curve.
This is specification for all lines.
It is not possible to specify it for each line.


option/option_05.png


option/bezier.png

To the top of this page
28. Creat test data

The test data can be generated by the SQL or the XML(dbUnit) form by using this function.

To the top of this page
28.1. Add test data

Select [Create test data] of the pop-up menu displayed by right-clicking on canvas.


testdata/1.png

Click [Add] button in the displayed [Management of testdata] dialog.


testdata/2.png

When you input the name of the test data,
Select the tables for which data is made by this test data
from all the table lists and click [Add],
and it is moved to the selected table list.


testdata/3.png

Next, chose one table from the selected table list and input the data.
When you finish to input the data, click [OK] button.


testdata/4.png

To the top of this page
28.2. Method of inputting data

There are two methods of inputting data.
The first is a method of setting the value of data one by one.
This method is used when the accurate data is necessary.

The second is a method of setting information on the repetition.
This method is used when you want regular, a large amount of data.

To the top of this page
28.2.1. Setting method of direct input data

Click [Direct Input] tab under the screen of the [Edit Testdata] dialog.
All rows except the final row become the data rows.

The value can be set to the cell by double-clicking the cell.


testdata/5.png

When you want to add the line, input data at the final line
or select [Insert] (or [Insert and Paste]) from the pop-up menu which is displayed by right-clicks.


testdata/6.png

To the top of this page
28.2.1.1. Input of current timestamp

Current timestamp can be set as a value of the cell by pushing [Ctrl] + [;].


testdata/7.png

To the top of this page
28.2.1.2. Use of clipboard for direct input data

In the input of the test data, the clipboard of OS can be used.
Because it can copy/cut/paste by assuming the data of the selected area
to be data of the tsv (tab separeted values),
It is possible to put it on ERMaster by copying it from Excel.
(Or, it is opposite of that. )

It is possible to copy/cut/paste by selecting from the pop-up menu
which is displayed by right-clicks,
or by pushing [Ctrl] + [c] / [Ctrl] + [x] / [Ctrl] + [v].

To the top of this page
28.2.2. Setting method of repeating input data

Click [Repeat Input] tab under the screen of the [Edit Testdata] dialog.


testdata/repeat_1.png

When the number of records to be made is input to the [Record Num] field,
the preview of the records which are made by the default repetition condition
are displayed.
(Previews are displayed up to 50. )


testdata/repeat_2.png

Because the displayed value is a preview value, it is not possible to change.

To the top of this page
28.2.2.1. Edit the repetition condition

The repetition condition is editable in the [Repetition condition setting] dialog
displayed by clicking the column header.


testdata/repeat_3.png


testdata/repeat_4.png

The type of the repetition condition that can be specified are 4 types. Such as
 NULL
 Format
 Foreign Key
 Enumeration

To the top of this page
28.2.2.1.1. NULL

When this type is specified, null is set as for all values.


testdata/repeat_5.png


testdata/repeat_5_2.png

To the top of this page
28.2.2.1.2. Format

When this type is specified, the value is set according to the specified format.


testdata/repeat_6.png

Format
It is a format that becomes the origin of the value.
The part of the % of this format is replaced by the decided value
from other specification.

Repeat Num
After the same value is repeated of the frequency specified by this value,
the next value is used.

Start/End/By
The increasing value from the beginning value to the end value
is set to the part of the % of the format.


testdata/repeat_6_2.png

When the column type is a date type and if the format is specified like "yyyy-MM-%",
the next value of 2010-01-31 is 2010-02-01.


testdata/repeat_6_3.png


testdata/repeat_6_4.png

To the top of this page
28.2.2.1.3. Foreign Key

This type of the repetition is a default value for the column of the foreign key.

As for the column to which this type is set,
the values of the test data are set based on the values of the test data
of the column referred to as a foreign key.


testdata/repeat_7.png

Repeat Num
After the same value is repeated of the frequency specified by this value,
the next value is used.


testdata/repeat_7_2.png

To the top of this page
28.2.2.1.4. Enumeration

Because only data with a different only figure can be made by the format type,
data "apple, orange, peach" cannot be made.
The enumeration type is used to make such data.


testdata/repeat_8.png

Enumeration values
The data to be set is enumerated by the changing line delimitation.

Repeat Num
After the same value is repeated of the frequency specified by this value,
the next value is used.


testdata/repeat_8_2.png

To the top of this page
28.2.2.2. Use of clipboard for repeating input data

Though the clipboard of OS can be used in the method of repeating input data,
The function that can be used is only copy unlike in the method of repeating input data.


testdata/repeat_9.png

To the top of this page
28.3. Edit test data

Select [Create test data] of the pop-up menu displayed by right-clicking on canvas.


testdata/1.png

Click [Edit] button in the displayed [Management of testdata] dialog.


testdata/9.png

When information of the test data is set as well as the addition of the test data,
click [OK] button.

To the top of this page
28.4. Delete test data

Select [Create test data] of the pop-up menu displayed by right-clicking on canvas.


testdata/1.png

Select the test data to be deleted, and click [Delete] button
in the displayed [Management of testdata] dialog.


testdata/10.png

To the top of this page
28.5. Export test data

Select [Create test data] of the pop-up menu displayed by right-clicking on canvas.


testdata/1.png

Select the test data to be exported, and click [Export test data] button
in the displayed [Management of testdata] dialog.


testdata/11.png

[Export test data] dialog is displayed, then
input [Format], [Output file], [Encoding], and click [Export] button.


testdata/12.png

To the top of this page
29. Ant Task

ERMaster provides some Ant tasks.
But, note that all these Ant tasks run only on Eclipse.

To the top of this page
29.1. Necessary setting

If Ant is run on Eclipse in which the plug-in of ERMaster is installed,
Neither the setting nor any definition by Taskdef are necessary.

It is possible to run the task only by describing the task in build.xml.


ant/1.png

When the following exception is thrown and it is not possible to run the task
though it is run on Eclipse,


ant/2.png

It is because the JRE environment when Ant is run is not Eclipse.
Please set the JRE environment as follows.

1.Select [Run As] -> [External Tools Configurations...] from the menu which is
displayed by right-clicking build.xml.


ant/3.png

2.[Runtime JRE:] in [JRE] tab of [External Tools Configurations] dialog may be set to
[Separate JRE], so set it to [Run in the same JRE as the workspace].


ant/4.png

To the top of this page
29.2. Ant task list that ERMaster provides

ERMaster provides the following four Ant tasks now.

To the top of this page
29.3. ermaster.ddl Task

The task for export a DDL.

Usage example

<ermaster.ddl diagramFile="newfile.erm" outputFile="ddl.sql" encoding="UTF-8" />

Attributes

diagramFile

Set the path of .erm file of ERMaster.

This attribute must be set.

outputFile

Set the path of the output file.
Specification by the absolute path or the relative path is possible.
It becomes a relative path from baseDir of the Ant project
when it is specified by the relative path.

This attribute must be set.

encoding

Set the encoding of output DDL file.

This attribute is option.
The default encoding of runtime environment is used when omitted.

To the top of this page
29.4. ermaster.image Task

The task for export a image.

Usage example

<ermaster.image diagramFile="newfile.erm" outputFile="ddl.png" />

Attributes

diagramFile

Set the path of .erm file of ERMaster.

This attribute must be set.

outputFile

Set the pass of the output file.
Specification by the absolute path or the relative path is possible.
It becomes a relative path from baseDir of the Ant project
when it is specified by the relative path.

The output format is decided according to the extension of the file.
There are four extensions that can be used such as png/jpg/jpeg/bmp.

This attribute must be set.

To the top of this page
29.5. ermaster.htmlReport Task

The task for export the database definition document of HTML format.

Usage example

<ermaster.htmlReport diagramFile="newfile.erm" outputDir="html_report" />

Attributes

diagramFile

Set the path of .erm file of ERMaster.

This attribute must be set.

outputDir

Set the pass of the output directory.
Specification by the absolute path or the relative path is possible.
It becomes a relative path from baseDir of the Ant project
when it is specified by the relative path.

The directory 'dbdocs' is made under the specified directory,
and the files are made under that.

Note that when the directory 'dbdocs' exists under the specified directory,
this directory is deleted once.

This attribute is option.
The baseDir of the Ant project is used when omitted.

To the top of this page
29.6. ermaster.excelReport Task

The task for export the database definition document of Excel format.

Usage example

<ermaster.excelReport diagramFile="newfile.erm" outputFile="sample.xls"
template="default_en" outputImageFile="sample.png" useLogicalNameAsSheetName="true" />

Attributes

diagramFile

Set the path of .erm file of ERMaster.

This attribute must be set.

outputFile

Set the pass of the output excel file.
Specification by the absolute path or the relative path is possible.
It becomes a relative path from baseDir of the Ant project
when it is specified by the relative path.

This attribute must be set.

template

Set the template of the Excel to be used.
The values that can be used are
"Default_en" (template of English default) or
"Default_ja" (template of Japanese default) or
file names registered as the custom template.

This attribute must be set.

outputImageFile

To put the image of ER diagram on the Excel definition book,
set the pass of the output image file to this attribute.
Specification by the absolute path or the relative path is possible.
It becomes a relative path from baseDir of the Ant project
when it is specified by the relative path.

The output format is decided according to the extension of the file.
There are three extensions that can be used such as png/jpg/jpeg.
The bmp form cannot be used.

This attribute is option.
The image is not put when omitted.

useLogicalNameAsSheetName

It is specified with true/false whether to use the logical name for the seat name
of the Excel definition book.

When "True" is specified, the logical name is used,
and when "False" is specified, the physical name is used.

This attribute is option.
It becomes "True" when omitted.

To the top of this page