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.2.8. Quickly add columns
5.2.8.1. Use of clipboard in Quick Add dialog
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. Constraint/Option for the table
5.5. Index
5.5.1. Add index
5.5.2. Edit index
5.5.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. Disable the category
9.5. Add the table to the category
9.6. Remove the table from the category
9.7. Display referenced tables on the category tab.
10. Insert Image
10.1. Add image
10.2. Change properties of image
10.3. Fix the aspect ratio
11. Management of word
11.1. Add word
11.2. Edit word
11.3. Delete word
11.4. Add word to the table
12. Management of group
12.1. Add group
12.2. Edit group
12.3. Delete group
12.4. Add group to the table
12.5. Remove group from the table
12.6. Global group
12.6.1. Management of global group
12.6.2. Add a group to global groups
12.7. Expansion and fold of group
13. Management of trigger
13.1. Add trigger
13.2. Edit trigger
13.3. Delete trigger
14. Management of sequence
14.1. Add sequence
14.2. Edit sequence
14.3. Delete Sequence
15. Management of tablesapece
16. Edit all attributes
17. Copy/Paste
17.1. Copy/Paste from another file
17.1.1. Merge of groups having same name
18. Move column
19. Layout
19.1. Move table
19.2. Line up tables
19.3. Edit table size
19.4. Change table color
19.5. Align relation
19.6. Change font
20. Display
20.1. Change scale
20.2. Display Tooltip
20.3. Display grid line
20.4. Change notation
20.5. Change display
20.5.1. Change view mode
20.5.2. Change notation level
20.6. Change design
20.7. Display by the capital letter
20.8. Stamp
21. Import and Export
21.1. Import
21.1.1. Import from Database
21.1.1.1. Use not default driver
21.1.2. Import From File (.erm)
21.1.2.1. Merge of groups
21.1.2.2. Difference between Importing From File and Copy & Paste.
21.2. Export
21.2.1. Common things in export dialog
21.2.1.1. Relative Path & Absolute Path of output file
21.2.1.2. Relative Path & Absolute Path of output directory
21.2.2. Image
21.2.2.1. Image for a category
21.2.3. Excel Document
21.2.3.1. Select Excel Template
21.2.4. HTML Document
21.2.5. DDL (TXT)
21.2.6. Dictionary (CSV)
21.2.7. Translation dictionary
21.2.8. DB
21.2.9. Java
21.2.10. Test Data
22. Create custom template for Excel Document
22.1. Download the standard template
22.2. Edit template
22.2.1. Cover
22.2.2. history_template sheet
22.2.3. sheet_index_template sheet
22.2.4. Diagram
22.2.5. Template sheet
22.2.5.1. table_template sheet
22.2.5.2. index_template sheet
22.2.5.3. sequence_template sheet
22.2.5.4. view_template sheet
22.2.5.5. trigger_template sheet
22.2.5.6. column_template sheet
22.2.5.7. category_template sheet
22.2.5.8. all_tables_template sheet
22.2.5.9. all_indices_template sheet
22.2.5.10. all_sequences_template sheet
22.2.5.11. all_view_template sheet
22.2.5.12. all_trigger_template sheet
22.2.6. words sheet
22.2.7. loops sheet
22.3. Register template
23. Search and Replace
23.1. Search
23.2. Replace
24. Change Tracking
24.1. Add Change Tracking
24.2. Edit change tracking
24.3. Delete change tracking
24.4. Comparison Display
24.5. Restore from change tracking
25. Translation
25.1. Form of dictionary file
25.2. Registration of dictionary file for translation
25.3. Management of translation
25.4. Execution of translation
26. JDBC driver
26.1. Management of JDBC driver
26.2. Download URL for JDBC driver
27. Print
27.1. Setting of page
28. Option
28.1. Change of database
28.2. Tablespace Environment
28.3. Advanced Setting
28.4. Option tab
28.4.1. Switch IME mode automatically On focus
28.4.2. Validate the character of physical name
28.4.3. Use Bezier curve to line
28.4.4. Suspend Validator
29. Create test data
29.1. Add test data
29.2. Method of inputting data
29.2.1. Setting method of direct input data
29.2.1.1. Input of current timestamp
29.2.1.2. Use of clipboard for direct input data
29.2.2. Setting method of repeating input data
29.2.2.1. Edit the repetition condition
29.2.2.1.1. NULL
29.2.2.1.2. Format
29.2.2.1.3. Foreign Key
29.2.2.1.4. Enumeration
29.2.2.2. Use of clipboard for repeating input data
29.3. Edit test data
29.4. Delete test data
29.5. Export test data
29.5.1. Use / to the name to categorize the test data.
30. Ant Task
30.1. Sample of build.xml
30.2. Necessary setting
30.3. Excecute from batch file.
30.4. Ant task list that ERMaster provides
30.5. ermaster.ddl Task
30.6. ermaster.image Task
30.7. ermaster.reportHtml Task
30.8. ermaster.reportExcel Task
30.9. ermaster.testData Task
31. Extention Point
31.1. Extention point for popup menu
31.1.1. Tutorial:How to extend popup menu
31.1.2. How to create more practicable menu
1. Outline

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

2.1. Eclipse version

ERMaster is being developed with Eclipse 4.3(Kepler) now.

To the top of this page
2.2. Correspondence DB

It corresponds to the following data bases now.
Although it doesn't completely correspond to these DB.

To the top of this page
3. Introduction

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, ERMaster is added in [File] menu of Eclipse as
[New] -> [other...] -> [ERMaster].

install/install_07.png


install/install_08.png

To the top of this page
3.2. Start

The editor of ERMaster is launched 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


After the wizard opens, input the file name and select the database system to be used.
(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 is launched.

start/start_05.png

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

The Eclipse views that can be used with ERMaster are following.


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

Editor view is the main view 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 problems that current ER diagram has are 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.
This view might be so useless, because informations displayed in this view are 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

4.1. Save

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

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

5.1. Add/Edit/Delete table

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

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', etc. 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', etc.
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 columns of the table are 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


In ERMaster, the idea of [word] has been introduced into the column.
Please see Management of word for details.
To eidt the culumn with another word, set the blank to the [word] pull-down
in editting in [Column Information] dialog.

To the top of this page
5.2.3. Delete column

To delete the column, select the column and push [Delete] button in [Table Information] dialog.
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 checkbox of Primary Key, NOT NULL, and UNIQUE 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


Check the checkbox 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, describe as shown in the following figure.

column/column_constraint_03.png


To set the constraint name of a primary key,
it is possible in the [Constraint/Option] tab of [Table Information] dialog
but not in [Column Information] dialog.

And to set the constraint name of a complex unique key,
it is possible in the [Complex unique key] tab of [Table Information] dialog.

Because they are not constraints for a column but for the table.

To the top of this page
5.2.5. Default value

Default value can be set in [Column Information] dialog.

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

column/column_constraint_01.png


Then input [Default value] and push [OK] button.

column/column_default_02.png


In addition to input the value directly,
if the type of column is character, it is possible to select the special value <EMPTY_STRING>.

And if type type of column is datetime, it is possible to select the special value <CURRENT_TIME>.

column/column_default_03.png

To the top of this page
5.2.6. Description

Description can be set in [Column Information] dialog.

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

column/column_constraint_01.png


Then input [Description] and push [OK] button.

column/column_description_02.png

To the top of this page
5.2.7. Sort columns

The order of columns 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.2.8. Quickly add columns

To add columns quickly, [Quick Add] button and dialog is useful.

Push [Quick Add] button.

column/quick_add_04.png


And input columns information by [Quick Add] dialog.

column/quick_add_01.png


When [OK] is pushed, columns are added to the table.

column/quick_add_02.png

To the top of this page
5.2.8.1. Use of clipboard in Quick Add dialog

In [Quick Add] dialog, 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.

And like Excel sheet, 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].

column/quick_add_03.png

To the top of this page
5.3. Complex unique key

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 checkbox 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. Constraint/Option for the table

Constraints and options for the table can be set in [Constraint/Option] tab of [Table Information] dialog.
For instance, if you describe as shown in the following figure.

table/constraint_01.png


DDL will be Generated as below.

table/constraint_02.png

To the top of this page
5.5. Index

5.5.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 will open.

[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 columns 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] in [Table Information] dialog is pushed, added [Index] is displayed under [Index] item of [Outline] view.

column/column_index_new_05.png

To the top of this page
5.5.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.5.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 [Table Information] dialog.

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 clicking relation tools on the palette.
By default the line of the relation is a straight line that connects the middle points of each table.

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.


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.
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 will open.

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.
If need, 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.
If need, 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 opens, 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.


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.
Then select [Delete] in the pop-up menu.

relation/reration_del_01.png


The confirmation dialog whether to delete the column set as 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

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 name and the columns and the sql of the view 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,
see Management of column of the table.
However, the constraint such as primary key, NOTNULL, unique key
and the default value cannot be set to the column of the view.

Moreover, the columns informations set for the view are used only to display them in ER diagram
and in the DB definition document on the Excel/HTML form.
They are 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

Select [icon/category_add_01.png] icon of the palette.
Then after 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.

For instance, 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


In addition, the category also can be added by inputting the category name in [Category] dialog
opened 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 in [Category] dialog.

[right-clicks on the canvas] -> [Category] -> [Management of category]

category/category_mod_01.png


Select the category to be edited.

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


In addition, if double-click the tab, [Change Category Name] dialog open.

category/category_mod_05.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 also be deleted by selecting the category to be deleted
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. Disable the category

If you want to disable the category temporarily,
check off the checkbox of the category on the left side in [Category] dialog.

category/category_disable_01.png

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

Tables can be added to the category by dragging tables 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, tables also can be added to the category by selecting the category and
checking the checkbox of tables on right side, 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.6. 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


If the dragged table is remained in the category area even a little,
the table is not removed and the area of the category expand.

category/category_table_del_03.png


category/category_table_del_04.png


Tables also can be removed from the category by even selecting the category,
and checking off the checkbox of tables on right side, and even pressing [OK] button in [Category] dialog
displayed by [right-clicks on the canvas] -> [Management of category],

category/category_table_del_05.png

To the top of this page
9.7. Display referenced tables on the category tab.

By default, only the tables that belong to the category are displayed in the tab of each category.
If you want to display tables which are referenced by the table in the category,
[right-click on the canvas] and select [Category] -> [Display referenced table] in the popup menu.

For instance, when the tab of green category is selected with categories shown in the figure below,

category/category_display_referenced_01.png


only the tables that belong to the category are displayed.

category/category_display_referenced_02.png


But by [right-click on the canvas] and selecting [Category] -> [Display referenced table] in the popup menu.

category/category_display_referenced_03.png


Also referenced tables are displayed.

category/category_display_referenced_04.png

To the top of this page
10. Insert Image

10.1. Add image

[Image] can be added to ER diagram.
Click [Insert Image] tool of the palette.

image/image_add_01.png


The mouse pointer is changed, so click an arbitrary place of the canvas.
Then File Open Dialog opens. So select the image file to be added.

image/image_add_02.png


Then selected image will be inserted to the diagram.

image/image_add_03.png

To the top of this page
10.2. Change properties of image

To change properties of the inserted image, double-clicke the image.
Then [Image Information] dialog opens.

image/image_edit_01.png


In [Image Information] dialog, Hue, Saturation, Brightness and Alpha
of the image can be set.

Change these values and push [OK] button,

image/image_edit_02.png


then the image on the canvas change.

image/image_edit_03.png

To the top of this page
10.3. Fix the aspect ratio

By default the aspect ratio of the image is fixed.

image/image_ratio_01.png


If you want to change the aspect ratio, check off the checkbox in [Image Information] dialog.

image/image_ratio_02.png


Then you can freely change the aspect ratio.

image/image_ratio_03.png

To the top of this page
11. 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] is called [Dictionary], and displayed in [Outline] view.

dictionary/dictionary_01.png

To the top of this page
11.1. Add word

[Word] cannot be added only by itself.
When the column was added without selecting [Word] in [Column Information] dialog,
[Word] will be added automatically.

The table is newly added,

word/word_add_01.png


and add two columns without selecting [Word].

word/word_add_07.png


word/word_add_08.png


word/word_add_02.png


Then in [Outline] view, it can be seen that two [Word]s are added.
And the tables that use the [Word] are displayed under the [Word].

word/word_add_03.png


If a column was added with selecting [word] in [Column Information] dialog,

word/word_add_09.png


word/word_add_10.png


then new [Word] is not added, and the tables that use the same [Word] increase.

word/word_add_11.png


If a column was added without selecting [word] in [Column Information] dialog,
even if the column has the same "Logical Name", "Physical Name", "Type" with the other column,
the new word is added as a different word.

word/word_add_12.png


word/word_add_13.png


word/word_add_14.png

To the top of this page
11.2. Edit word

When a [Word] is edited, the edited contents are reflected in all columns that use the same [Word].

There are two methods for editing [Word].

The first method is a method to editing the column that uses [Word].
When the column is edited, the used [Word] 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 edit the one of columns,

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 columns using diferrent [Word].

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
11.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
11.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
12. Management of group

By making a group that collects some columns,
more than one columns can be registered, edited, deleted together as a group.

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.

To the top of this page
12.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
12.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
12.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
12.4. Add group to the table

Drag the group 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
12.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
12.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
12.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
12.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
12.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
13. Management of trigger

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

To the top of this page
13.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
13.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
13.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
14. 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
14.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
14.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
14.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
15. Management of tablesapece

[Management of tablesapece] is being developed now.

To the top of this page
16. Edit all attributes

By [Edit all attributes] dialog, it is possible to edit all columns in one dialog.

Select [Edit all attributes] in the pop-up menu which is displayed by right-clicking on the canvas

edit/edit_all_01.png


edit/edit_all_02.png

To the top of this page
17. 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

To the top of this page
17.1. Copy/Paste from another file

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.1.1. Merge of groups having same name

If the table that is copied from another file has a group
with the same name as the group that is included in destination diagram,
the group will not be copied and the group in the pasted table
will be replaced with destination diagram's one.

To the top of this page
18. 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
19. Layout

19.1. Move table

The table can be moved by dragging the table directly.
The whole image is displayed under the [outline] view.
Moreover, refer to [Change scale] to zoom in or zoom out.

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, put [icon/column_lock.png] of the menubar into the state of the lock.
By doing so, 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
19.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

To the top of this page
19.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
19.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
19.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 can be a straight line that is bent at a right angle
by selecting [Right Angle Line] in the pop-up menu.

relation/reration_align_05.png


relation/reration_align_06.png


When you want to return the line to one when it 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
19.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
20. Display

20.1. Change scale

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

Zoom out:25%

canvas/canvas_scale_01.png


Zoom in: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
20.2. Display Tooltip

It becomes impossible to distinguish the table name when the scale becomes small.
At such time, 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
20.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


In addition, by turning on [Snap objects to grid] in the toolbar,

grid/grid_03.png


when move a table, it move along the grid.

grid/grid_04.png

To the top of this page
20.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 [Display] -> [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
20.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
20.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 [Display] -> [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
20.5.2. Change notation level

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


It is possible to change by selecting either from [Display] -> [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
20.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 [Display] -> [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
20.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] -> [Display by the capital letter]
in the pop-up menu which is displayed by right-clicking on the canvas.

Select [Display] -> [Display by the capital letter]

display/capital_02.png


Physical names are displayed by the capital letter.

display/capital_03.png


If you check [Display by the capital letter], not only the display but also exported [DDL (TXT)]
will be printed by the capital letter.

display/capital_04.png


So, if you want to export ddl by lower case letter, check off [Display by the capital letter].

To the top of this page
20.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] -> [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
21. Import and Export

21.1. Import

21.1.1. Import from Database

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


Then if this is the first time when you do [Import from Database] for selected database,
[JDBC Driver's path] dialog open in which you have to input the path of [JDBC Driver]
which you use to connect to the database.

From the second time, [JDBC Driver's path] dialog path does not open.
See also [JDBC driver].

import/import_database_09.png


If it succeeds to connect, then
if selected database support schema, [Select schemas to be imported] dialog opens.
if selected database does not support schema, this step is skipped.

import/import_database_08.png


Then after schemas are selected or if selected database does not support schema,
[Select objects to be imported] dialog opens.
so check the tables and views, etc. 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
21.1.1.1. Use not default driver

In [Import from Database] dialog, JDBC driver to be used is automaticaly decided by selected [Database].

For instance, the default JDBC URL of ERMaster for Oracle is one for [thin driver].

import/import_database_06.png


If you want to use [OCI driver], check off the [Use the default driver] checkbox,
and manually input JDBC URL for OCI driver.

import/import_database_07.png

To the top of this page
21.1.2. Import From 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 views, 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
21.1.2.1. Merge of groups

If the table that is imported from another file has a group
with the same name as the group that is included in destination diagram,
the group will not be copied and the group in the imported table
will be replaced with destination diagram's one.

To the top of this page
21.1.2.2. Difference between Importing From File and Copy & Paste.

It is possible to get almost same result as importing from file by [Copy/Paste from another file].
Maybe it is more easy by copy & paste.

The point at which the way of importing from file is better is that that is able to
import sequences and triggers and etc, as well as tables.

To the top of this page
21.2. Export

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

To the top of this page
21.2.1. Common things in export dialog

21.2.1.1. Relative Path & Absolute Path of output file

The path of output file can be specified as both of relative path and absolute path.
The relative path is relative to the root directory of the project in which [.erm] file exists.

To the top of this page
21.2.1.2. Relative Path & Absolute Path of output directory

Some export function need the selection of output directory.
The path of output directory can be specified as both of relative path and absolute path.
The relative path is relative to the root directory of the project in which [.erm] file exists.

In addition, it is possible to input empty as the output directory,
In you do so, the exported files will be output to the root directory of the project
in which [.erm] file exists.

To the top of this page
21.2.2. Image

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


[Export to Image] dialog opens, so input the file path and push [OK] button.

export/export_picture_02.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
21.2.2.1. Image for a category

if [Export] -> [Image] is selected while displaying [All] tab,
and checkbox for [Output images of each category to 'categories' directory.]
in [Export to Image] dialog is checked,

export/export_picture_06.png


'categories' directory will be made in same directory as [Output File],
and images of each category are also output in the directory.

export/export_picture_05.png


Or if [Export] -> [Image] is selected while displaying a category tab,
only the image of the category will be output.

export/export_picture_03.png

To the top of this page
21.2.3. Excel Document

The Excel document can be output from ER diagram.
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


[Export as Excel Document] dialog opens, so
push [OK] button with specifying the output file and the template which is used.

export/export_excel_02.png


Then the excel file like following figure 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 template for Excel Document for the method of making the template file.

To the top of this page
21.2.3.1. Select Excel Template

Excel Document will be output on the basis of the specified template.
There is two way to specify the template.
The first one is the way to specify the template from registered templates.

To register the new template, refere [Register template].

export/export_excel_04.png


And the second is the way to specify the template file from directory.

export/export_excel_05.png

To the top of this page
21.2.4. HTML Document

HTML document can be output from ER diagram.

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

export/export_html_01.png


[Export as HTML Document] dialog opens, so
push [OK] button with specifying the output directory.

export/export_html_02.png


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

export/export_html_03.png


The generated HTML Document is a design of the Javadoc style.
The template of this design cannot be customized unlike Excel document.

export/export_html_04.png


If you check the checkbox of [Put ER Diagram on HTML.] or
[Put ERDiagram of each category on HTML.] in [Export as HTML Document],
images will be embedded in HTML Document.

export/export_html_05.png

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

DDL for the database construction can be output from 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


If you open the [Export to DDL] dialog in a category tab,

export/export_ddl_06.png

the output ddl will be restricted to the objects belonging to the current category.

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

The [word] used in current 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
21.2.7. 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 by using the translation dictionaries.
The translation dictionary file can be output from current ER diagram to use it
for other database designs.

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 [Generation of 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
21.2.8. DB

It is possible to execute DDL to directly creating tables to database from ER diagram.

* Because this function delete all contents of the database once,
use it only when there is no problem even if the contents of the database are 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 problems.

export/export_db_06.png


The dialog to specify DB to export to is displayed when there is no problem in ER diagram.
Although [Database] field is selectable in [Import from Database] dialog,
[Database] field is fixed at current database in [Export to DB] dialog.

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.2.9. Java

Java Sources coresponding to tables can be generated from ER diagram.
Select [Export] -> [Java] in the pop-up menu which is displayed by right-clicking on the canvas.

export/export_java_01.png


[Export to Java Source] dialog opens, so input necessary information and push [OK] button.

export/export_java_02.png


The files as shown in the following figure are made under specified [Output Directory].

export/export_java_03.png


Sample of generated Java Source

export/export_java_04.png


If you check the checkbox of [Output the mapping files for Hibernate],
Not only Java Sources but also [.hbm.xml] files will be generated.

export/export_java_05.png


Unfortunately, you can not customize the template of Java Source used to generate.

To the top of this page
21.2.10. Test Data

See [Export test data] at [Create test data].

To the top of this page
22. Create custom template for Excel Document

Here, it explains the method of making the custom template for Excel Document.

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

At first, download the standard template prepared with ERMaster.

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

excel_template/download_01.png


Select [ERMaster] -> [Template for Excel Document] in the left tree of [Preference] dialog.

excel_template/download_02.png


push [Download template] button.

excel_template/download_03.png


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

excel_template/template.png

To the top of this page
22.2. Edit template

Secondly, customize the downloaded standard template.
A standard template is composed of some seats.

To the top of this page
22.2.1. Cover

The 1st 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 seats.
These firmly attached seats are left for the generated Excel document as a firmly attached seat.

To the top of this page
22.2.2. history_template sheet

The 2nd sheet is a [history_template] sheet.

excel_template/history.png


This sheet becomes to the list of change tracking.

excel_template/history_02.png


It is generated by the [Change Tracking] data of current ER diagram.

excel_template/history_03.png


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

excel_template/keyword_history.png

To the top of this page
22.2.3. sheet_index_template sheet

The 3rd 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
22.2.4. Diagram

The 4th 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
22.2.5. 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
remain in the generated Excel document.

To the top of this page
22.2.5.1. table_template sheet

The sheets will be generated 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
22.2.5.2. index_template sheet

The sheets will be generated 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
22.2.5.3. sequence_template sheet

The sheets will be generated 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
22.2.5.4. view_template sheet

The sheets will be generated by each view,
and the physical name or logical 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
22.2.5.5. trigger_template sheet

The sheets will be generated 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
22.2.5.6. 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 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
22.2.5.7. category_template sheet

The sheets will be generated 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.

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

excel_template/loops.png


For instance, by the default template setting,
the value of [First Line] of [category_template] is [1],
so each category sheet has no header part,
and the area between the 1st row to last row of template will be repeated
for each tables with 5 space line between each other.

[category_template]

excel_template/all_categories.png


On the other hand, when looking at the setting of [all_indices_template] of the default template,
the value of [First Line] is [3],
so the area between the 1st row and 2nd row will be treeted as header part,
and the area between 3rd row to last row of template will be repeated
for each indices.

[all_indices_template]

excel_template/all_indices.png


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

To the top of this page
22.2.5.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 will be described as the content in this sheet.
To describe the header part,
it is possible to specify row number which it is repeated from
as [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 as [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
22.2.5.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 will be described as the content in this sheet.
To describe the header part,
it is possible to specify row number which it is repeated from
as [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 as [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
22.2.5.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 will be described as the content in this sheet.
To describe the header part,
it is possible to specify row number which it is repeated from
as [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 as [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
22.2.5.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 will be described as the content in this sheet.
To describe the header part,
it is possible to specify row number which it is repeated from
as [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 as [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
22.2.5.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 will be described as the content in this sheet.
To describe the header part,
it is possible to specify row number which it is repeated from
as [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 as [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
22.2.6. 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 Excel 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,
in generated Excel document, if the column is a primary key, [#] is written at the position
where [$PK] is described in the template sheet.

excel_template/words.png

To the top of this page
22.2.7. loops sheet

In this sheet,
row number which it is repeated from is specified as [First Line] to describe the header part
of a sheet with repetition such as


Similarly, how many space lines is put between one content and the other content
is specified as [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 as [Sheet Name].

excel_template/loops.png

To the top of this page
22.3. Register template

To register the made template, push [New...] button in [Template for Excel Document] page
in [Preference] dialog.

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 [Export as Excel Document] dialog.

excel_template/add_template_04.png

To the top of this page
23. Search and Replace

23.1. Search

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

To do a 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] button.

search/search_02.png


Search results are displayed on [Result] tab of [Search] dialog.

search/search_03.png


To change the scope of the search,
after check off [All] check box, check the items in [Scope] of the search tab.

search/search_04.png

To the top of this page
23.2. Replace

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
24. Change Tracking

The data of ER diagram can be stored as a history.
It is possible to compare the current ER diagram with the history,
and to restore the data from the stored history.

To the top of this page
24.1. Add Change Tracking

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

history/history_01.png


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

history/history_02.png


Then the history will be added.

history/history_03.png

To the top of this page
24.2. Edit change tracking

[Contents of change] of the history can be edited.
Select the history that you want to change in [Change Tracking] dialog,
and edit [Contents of change], and push [Update] button.

history/history_04.png


Then [Contents of change] will be changed.

history/history_05.png

To the top of this page
24.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


Then the history will be deleted.

history/history_07.png

To the top of this page
24.4. Comparison Display

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

history/history_08.png


For the tables and the notes,


For the columns,

history/history_09.png


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

history/history_10.png

To the top of this page
24.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
25. Translation

When you do [Import from Database], you can use [Translation] function.
[Translation] function enables the automatic conversion to logical name from physical name of objects.

[Translation] function use [Translation dictionary] to translate.

By default, [Translation] function is turning on only only when the locale of eclipse is japanese,
because there is only Japanese [Translation dictionary] that is provided by default.

So, first of all, it is necessary to prepare [Translation dictionary] file to use [Translation]
function excluding Japanese.

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

[Translation dictionary] file is described by the following Comma Separated Value format.
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 [Translation Dictionary] is described as 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" in the same way as [item_name].

To the top of this page
25.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 [Translation Dictionary] files exist, they are applied sequentially according to the file list.
Therefore, properly change the order of files in consideration of the priority level.

translation/2.png

To the top of this page
25.3. Management of translation

[Translation Dictionary] file is not used only by being registerd.
To use [Translation Dictionary] file, it must be set in [Translation] dialog.

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

translation/3.png


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

translation/4.png

To the top of this page
25.4. Execution of translation

If the checkbox of [Use translation] is checked, [Translation] function is automatically used,
when [Import from Database] is executed,

To the top of this page
26. JDBC driver

When you do [Import from Database], if a necessary JDBC driver is not registered yet,
the dialog to set the JDBC driver opens.

jdbc/4.png

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

If a correct setting is done once, this dialog is never displayed again.
If you want to change the path of JDBC driver which has been set once,
Select [ERMaster] -> [JDBC Driver] in [Preferences] dialog displayed
by selecting [Window] -> [Preferences...] in the menu of Eclipse.

jdbc/5.png

To the top of this page
26.2. Download URL for JDBC driver

ER Master does not contain JDBC driver.
So you must download from appropriate URL.

As a reference, I will write the download URL at the time of writing here.

DatabaseJDBC Driver JarDownload URL
DB2db2jcc4.jar, db2jcc_license_cu.jarhttp://www-01.ibm.com/support/docview.wss?uid=swg21363866
H2h2-<version>.jarhttp://www.h2database.com/html/download.html
HSQLDBhsqldb.jarhttp://sourceforge.net/projects/hsqldb/files/hsqldb/
MSAccesssun.jdbc.odbc.JdbcOdbcDriver-
MySQLmysql-connector-java-<version>.jarhttp://dev.mysql.com/downloads/connector/j/
Oracleojdbc7.jarhttp://www.oracle.com/technetwork/database/features/jdbc/index-091264.html
PostgreSQLpostgresql-<version>.jdbc4.jarhttp://jdbc.postgresql.org/download.html
SQLServersqljdbc4.jarhttp://www.microsoft.com/ja-jp/download/details.aspx?id=11774
SQLitesqlite-jdbc-<version>.jarhttps://bitbucket.org/xerial/sqlite-jdbc/downloads


Of course, you can also use a JDBC driver other than the above.

To the top of this page
27. 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
27.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 in [Page Setting] dialog.

In [Page Setting] dialog, it is possible to change the direction of print and the size of the paper besides this.

[Page Setting] dialog opens by selectiong [right-clicking on the canvas] -> [Page Setting].

print/print_02.png


print/print_03.png


When the expansion reduction rate etc. are changed in [Page Setting] dialog,
the position of page division lines are changed according to it.

print/print_04.png

To the top of this page
28. Option

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

option/option_01.png


option/option_02.png

To the top of this page
28.1. Change of database

The database selected 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 informations specific to the old database that can not be converted
to the informations for new database will be lost.

option/change_database_02.png

To the top of this page
28.2. Tablespace Environment

Things about [Tablespace] are in development.

To the top of this page
28.3. Advanced Setting

In [Advanced Setting] tab, the informations specific to the current database can be set.
Available settings are different for each database.

option/advanced_01.png

To the top of this page
28.4. Option tab

28.4.1. Switch IME mode automatically On focus

If the checkbox of this option is checked,
When the fields of the logical name or the explanation or others get focus,
IME automatically changes into turning on.

By default, this checkbox is off.
Please check the checkbox if this function is necessary.

option/option_03.png

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

By default, the character that can be used for a physical name
is limited to [a-ZA-Z0-9_],
and if other characters are input, it becomes an input error.

If you want to use the other character for a physical name,
please check off the checkbox of this option.

option/option_04.png

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

Bezier curve can be used for a related line in ERMaster.
If you want to use Bezier curve, please check the checkbox of this option.
It is not possible to specify it for each line. This setting is applied to all lines.

option/option_05.png


option/bezier.png

To the top of this page
28.4.4. Suspend Validator

By default, ER Master automatically validate the diagram file on saved.
If the file has some problem, warnings are displayed in [Problems] view,

option/problem_01.png


and in [Package Explorer] view, warning mark is displayed on the file icon.

option/problem_02.png


If you do not want to display these warnings, check the checkbox of [Suspend validator].

option/suspend_validator_01.png

To the top of this page
29. Create test data

You can then create a test data along the ER diagram that you created,
and you can outputs it in several formats.

To the top of this page
29.1. Add test data

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

testdata/1.png


Then click [Add] button in [Management of testdata] dialog.

testdata/2.png


Input the name of the test data, and select tables from [All tables] list and click [Add],
then they are moved to [Table in which data is made] list.

testdata/3.png


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

testdata/4.png

To the top of this page
29.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
29.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
29.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
29.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
29.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


Preview value is editable, the color of edited cell become green.

testdata/repeat_10.png


To return to the original value after it is edited,
input the same value as original value.

To the top of this page
29.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

To the top of this page
29.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
29.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
29.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
29.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
29.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
29.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
29.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
29.5. Export test data

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

testdata/1.png


Click [Export test data] button in the displayed [Management of testdata] dialog.

testdata/11.png


[Export test data] dialog is displayed, then
select [Test Data] and input [Format], [Output Directory] and click [Export] button.

testdata/12.png

To the top of this page
29.5.1. Use / to the name to categorize the test data.

Test data are output under the specified [Output Directory],
and their name become to the output file path.

So, if name of the test data contains [/], the sub directory will be made,
and test data file will be created under the sub directory.

To the top of this page
30. Ant Task

ERMaster provides some Ant tasks.
Note that all these Ant tasks run only on Eclipse.
If you want to run these Ant tasks by batch file,
it is possible by using [equinox.launcher].

To the top of this page
30.1. Sample of build.xml

<?xml version="1.0" encoding="UTF-8"?>
<project default="ddl">

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

	<target name="image">
		<ermaster.image diagramfile="newfile.erm" outputfile="newfile.png" withCategory="true" />
	</target>

	<target name="report_html">
		<ermaster.reportHtml diagramFile="newfile.erm" outputDir="." />
	</target>

	<target name="report_excel">
		<ermaster.reportExcel diagramfile="newfile.erm" outputfile="newfile.xls"
			template="default_en" outputimage="true" uselogicalnameassheetname="true" />
	</target>

	<target name="testdata">
		<ermaster.testdata diagramFile="newfile.erm" outputDir="." format="0">
			<testdata name="init/xxx" />
			<testdata name="result/yyy" />
		</ermaster.testdata>
	</target>

</project>

To the top of this page
30.2. 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.

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
30.3. Excecute from batch file.

Ant tasks for ERMaster need Eclipse to execute.
But it is possible to run the task by batch file by using [equinox.launcher].

For instance, see below sample of batch file.

example) sampleAntRun.bat
@echo off

set EQUINOX_LAUNCHER_JAR=c:/eclipse/4.3-2/plugins/org.eclipse.equinox.launcher_1.3.0.v20130327-1440.jar
set BUILD_FILE=./build.xml

if "%EQUINOX_LAUNCHER_JAR%" == "" goto HELP

pushd %~dp0
echo Launching equinox ...
java -jar %EQUINOX_LAUNCHER_JAR% -application org.eclipse.ant.core.antRunner -buildfile %BUILD_FILE% %1
goto end

:HELP
echo EQUINOX_LAUNCHER_JAR environment variable is not defined
goto end

:end
popd
pause

Execute sampleAntRun.bat
1. Set the appropriate path to [EQUINOX_LAUNCHER_JAR] and [BUILD_FILE] of above file.
2. Execute sampleAntRun.bat [taskname]

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

ERMaster provides the following four Ant tasks now.

To the top of this page
30.5. 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 as the absolute path or the relative path is possible.
When it is specified as the relative path,
It becomes a relative path from baseDir of the Ant project.

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
30.6. ermaster.image Task

The task for export a image.

Usage example
<ermaster.image diagramFile="newfile.erm" outputFile="ddl.png" withCategory="true" />

Attributes

diagramFile
Set the path of .erm file of ERMaster.

This attribute must be set.

outputFile
Set the pass of the output file.
Specification as the absolute path or the relative path is possible.
When it is specified as the relative path,
It becomes a relative path from baseDir of the Ant project.

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.

withCategory
It is specified with true/false whether to output images of each category.

If true is specified, then the directory named 'images' will be made,
and images of each category are output under this directory.

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

To the top of this page
30.7. ermaster.reportHtml Task

The task for export Html document.

Usage example
<ermaster.reportHtml 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 as the absolute path or the relative path is possible.
When it is specified as the relative path,
It becomes a relative path from baseDir of the Ant project.

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

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
30.8. ermaster.reportExcel Task

The task for export the Excel document.

Usage example
<ermaster.reportExcel diagramFile="newfile.erm" outputFile="sample.xls" 
	template="default_en" outputImage="true" 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 as the absolute path or the relative path is possible.
When it is specified as the relative path,
It becomes a relative path from baseDir of the Ant project.

This attribute must be set.

template
Set the template of the Excel to be used.

The available values are

Either template or templateFile attribute must be set.

templateFile
The path of the template file for the output excel file.
If you want to use template file which is not registered as the custom template,
set "templateFile" attribute instead of "template" attribute.

Either template or templateFile attribute must be set.

outputImage
It is specified with true/false whether to put the image of ER diagram on the Excel document.

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

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

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 "false" when omitted.

To the top of this page
30.9. ermaster.testData Task

The task for export test data which are defined on ERMaster.

Usage example
<ermaster.testdata diagramFile="newfile.erm" outputDir="." format="0">
	<testdata name="init/xxx" />
	<testdata name="result/yyy" />
</ermaster.testdata>

Attributes
diagramFile
Set the path of .erm file of ERMaster.

This attribute must be set.

outputDir
Set the pass of the output directory.
Specification as the absolute path or the relative path is possible.
When it is specified as the relative path,
It becomes a relative path from baseDir of the Ant project.

The exported test data will be output under this directory.

This attribute must be set.

format
Set the format of the test data to be exported.

The available values are

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.

Sub Element
<testdata>
The element which specifies the testdata being output.

<ermaster.testdata> can have some <testdata> sub elements.
And <ermaster.testdata> must have at least one <testdata> sub element.

Attributes of <testdata> sub element
name
Set the name of the testdata.

This attribute must be set.

To the top of this page
31. Extention Point

ERMaster provides the extention point.
Here, I will introduce how to extend the ERMaster.

To the top of this page
31.1. Extention point for popup menu

It is able to add a your own menu to the popup menu.

To the top of this page
31.1.1. Tutorial:How to extend popup menu

Here, I will introduce how to extend popup menu,
by add simple [Greeting] menu to popup menu.
If select [Greeting] from popup menu, the message dialog will be open with the message "Hello World!".

extention/extention_19.png


extention/extention_20.png


Firstly, create the Eclipse plugin project.

From menu of Eclipse, select [File] -> [New] -> [Project]

extention/extention_1.png


In [New Project] dialog, select [Plug-in Project] and push [Next] button.

extention/extention_2.png


Input [Project name] field and push [Next] button.

extention/extention_3.png


Input [Name] field, and if necessary edit [Activator] field,
and then push [Next] button.

extention/extention_4.png


Then plugin project will be created, and [plugin.xml] file will be opend.

extention/extention_5.png


Then open [Dependencies] tab, and push [Add] button of [Required Plug-ins].

extention/extention_6.png


Then select [org.insightech.er] (ERMaster) plugin, and push [OK] button.

extention/extention_7.png


Also add [org.eclipse.gef] plugin as well.

extention/extention_8.png


Then open [Extensions] tab, and push [Add] button of [All Extensions].

extention/extention_9.png


In [New Extension] dialog, input [insightech] to [Extension Point filter] field,
and select [org.insightech.er.popupMenus], and push [Finish] button.

extention/extention_10.png


As a result, [org.insightech.er.popupMenus] extension will be added.

extention/extention_11.png


Then input "Export" to [path] field, and input arbitrary class name to [class] field.
At this point, the specified class does not need to be created.
Because by next step you will create the class to click [class] link.

The value "Export" which is input to [path] field will be used to decide the location of your extention menu in [Popup] menu of ERMaster.
Available value are only "Export" or "Import".
See also [org.insightech.er.editor.view.ERDiagramPopupMenuManager.java] of ERMaster source.

extention/extention_12.png


When [class] link is clicked, [New Java Class] dialog open.
Edit [package] field and [Name] field, and push [Finish] button.

extention/extention_13.png


Then the specified class will be created.

extention/extention_14.png


Here, aside this class for now, and create [Action] class which implements your extention menu.
It is recomended to extend [org.insightech.er.editor.view.action.AbstractBaseAction.class] which
provides some useful method.

In the sample in the figure below, it spedifies "Greeting" as the label of menu,
and if the menu will be clicked, the message dialog will be open with the message "Hello World!".

extention/extention_15.png


After you create the [Action] class, edit the [createIAction] method of the [Action Factory] class
to create the instance of the [Action] class.

extention/extention_16.png


Creating a sample extention menu is complete.
So now, run for test.

To test the eclipse plugin, right click the project, and select [Run As] -> [Eclipse Application] from popup menu.

extention/extention_18.png


Then another Eclipse is launched.
So create [.erm] file, and check [Greeting] menu from being added to the popup menu.

extention/extention_19.png


If select [Greeting] from popup menu, the message dialog will be open with the message "Hello World!".

extention/extention_20.png


To create jar file of plug-in that was created, right click the project, and select [Export] from popup menu.

extention/extention_17.png


In [Export] dialog, select [Plug-in Development] -> [Deployable plug-ins and fragments], and push [Next] button.

extention/extention_21.png


Finally, input arbitrary path to [Directory] field, and push [Finish] button.
Then plug-in file will be created.

extention/extention_22.png

To the top of this page
31.1.2. How to create more practicable menu

Now I introduced the way of creating simple menu.
To create more practicable menu, please refer to [source code of ERMaster].

To the top of this page