Compendium now uses Derby for storing its data. Initially Compendium will have no database projects set up.
This section covers the following database project related issues.
The following options can be found on the Project Management Window accessed from the File Menu
To create a new database project, you go to the File Menu and select 'New'. This will then open the following dialog:
Enter the details, as requested, in each of the fields. Those fields which are required are marked with a '*'.
The 'Project Name' is the name as seen by you, in other words, what do you want to call this project.
If you want this new project to be your default project, then check the box. This means Compendium will automatically launch this project when you open the application. If you check the default project box, it will automatically check the default user box below it. This is because Compendium needs to login to the default database for you to automatically. Note that you can check the default user box independently for any project. This will mean that in the project login window your login details will be automatically filled in for you. (This does not apply to remote MySQL projects for security reasons).
The 'Author Name' is important to complete as it is the name you wish to be known as when you export maps and share them with other people. It is this name that is stored against all nodes and links that you create. The 'Description' field is optional.
The 'Login Name' and 'Password' fields will be used as the login information, which you will need to know to access this project later. This user is set as an 'Administrator' by default.
N.B. The password entered must be more than 1 character long. If you do not enter a password you will be shown an error message. If this happens, just press the 'OK' button on the error message window. You can then enter a password.
Once you have completed all the fields, press the 'Create' button and a new project will be created and some default data loaded in. You will then be presented with the project login dialog, (see below).
Once a project has been create you can access it at any time from the File Menu by selecting the 'Open' option. This will open a login window similar to the one below:
If you select a project for which you have specified a default user, that users login details will automatically be completed for you, otherwise you will need need to enter the Login Name, and Password yourself and then press the 'OK' button. The selected project will be opened provided the login details are valid. The login is case-sensitive. Note: your current default project will be displayed in green writing. (For information specifying default projects and default login details see User Administration and Creating a New Project).
If you have updated Compendium recently the first time you select a project and try and login you may see the following message:
At this point you can stop the login process by pressing the 'No' button, or allow the project data structure to be updated by pressing the 'Yes' button. Once the structure has been updated, the login process will be completed and the project opened.
If you already had Compendium 1.3x installed, you will have MySQL database projects that you may wish to import into Compendium 1.4. These database projects will need converting from MySQL to Derby (the new Compendium default database).
You can only do this when you are connected to the Derby database. (See Database Maintenance).
From the File Menu select 'Convert From MySQL To Derby..'. If you only have one MySQL profile setup it will automatically show you the projects list in the dialog, as in figure 5a:
Figure 5a: The Convert MySQL Project window with one profile setup.
If you have more than one MySQL profile setup the dialog will present you with a drop-down menu from which to select a profile and then it will load the list, (see figure 5b below for an example).
Figure 5b: The Convert MySQL Project window with more than one profile setup.
Select the MySQL project you wish to convert and press the 'Convert' button. A small dialog will appear asking you to enter the name you wish to call the converted project. The current name will be filled in for you, but you can change it. Press OK to continue.
Figure 6: Enter the name for the converted project.
A progress bar will inform you of how the conversion is going.
Figure 7: Conversion progress.
If you wish to convert the Compendium default projects (in Derby), to a MySQL database project, you must first connect to the MySQL database into which you wish to convert the projects, (See Database Maintenance).
From the File Menu select 'Convert Project..', then 'From Derby To MySQL'. This will open a dialog listing the Derby database projects available, similar to figure 8:
Figure 8: The Convert Derby Project.
Select the Derby project you wish to convert and press the 'Convert' button. A small dialog will appear asking you to enter the name you wish to call the converted project (see figure 6 above). The current name will be filled in for you, but you can change it. Press OK to continue. A progress bar will inform you of how the conversion is going.
To access the Project Administration window, you must first close your open project, if you have one open. Then go to the File Menu and select 'Project Management''. This will then open a dialog similar to the following:
Figure 9: The Project Management window.
For all options except 'Restore As New' and 'Copy', you will be asked to login with an administrator account to the selected project as in figure 10:
Figure 10: Administration Login
Note: you can back up from inside an open project with the backup option on the File Menu if you are an administrator. The following sections cover the options available on this window.
To edit the name of a project, first open the Project Management dialog (see Overview) and then select the project from the list then press the 'Edit Name' button. You will be asked to login (see figure 9) and then you will be presented with a dialog like the one in figure 11 where you can change the project name:
Figure 11: Edit a project name.
Once you have made the change press 'OK' to save it or 'Cancel' if you change your mind.
To copy a project, first open the Project Management dialog (see Overview) and then select the project from the list then press the 'Copy' button. You will be asked to login (see figure 10) and then you will be presented with a dialog like the one in figure 11, asking you what you wish to called the copied project:
Figure 12: Enter name for copied project.
Once you have entered the name 'OK' to proceed with the copy or 'Cancel' if you change your mind. You will be presented with a progress bar informing you of how the copy is proceeding.
Once the copy is complete, you will see it appear in the list in the 'Project Management' window.
To backup a project, you have two options. One options is to open the Project Management dialog (see Overview) and then select the project from the list then press the 'Backup' button. You will be asked to login (see figure 10). If you already have a project open, you can select 'Backup' from the File Menu. Note: this option will only be available if you are an administrator.
Which ever way you chose to initiate a backup you will then be shown the following dialog:
Figure 13: Backup dialog.
On this dialog you can select to Backup to either an sql file, which will backup just the project contents, or a zip file with references.
The
zip file will contain the sql file with the project data, as well as copies of
the externally references local files.
If you choose to Backup to Zip then two further options will become available. These two options control how the Referenced files are stored inside the Zip file. By default the first option is selected. This options, 'Zip all Reference files into Linked File' means that inside the zip file the reference files will be put into a Linked Files folder structure (Linked Files/<projectname>/<usename_useid>/referencefile). This is useful if you will be unzipping the backup on another machine. All the file paths in the backuped up sql data will be adjusted to match this folder structure. You can however check the option labelled
'Leave Reference file paths untouched', which will place the reference file in the zip
with the same paths as they have on your computer. This is useful if you are backing up for your restoring on your own machine where you want the paths to remain the same.
Which ever options you select from this dialog you will then see a window similar to the following where you will be asked to enter the name of the backup file. This will wither request an .sql file or a .zip depending on the option you have previously chosen.
Figure 14: Save file dialog.
Once you have entered the name of the backup, and pressed the 'Save' button. The backup will begin. You will see a progress bar letting you know how the backup is going.
Restoring a Project from a backup
A project can be restored from an backup '.sql' file. When you select to restore over an existing project, all the data in that project will be deleted and replaced with the data from the backup file. So use this option with caution!
To restore a project from a backup, first open the Project Management dialog (see Overview) and then select the project from the list that you wish to restore over, and press the 'Restore To' button. You will be asked to login (see figure 9) and then you will be presented with a dialog like the one in figure 15, asking you if you wish to backup the existing project first as all data will be lost:
Figure 15: Backup before restoring.
If you select 'Yes' you will see a dialog similar to Figure 14, asking for the name of the backup file.
Next you will be shown a dialog similar to figure 16, from which you need to select the project backup you wish to restore from.
Figure 16: Select a backup file to restore from.
Once you have select a file, press the 'Restore' button. You will now be shown the following warning:
Figure 17: Final warning.
If you are happy to proceed press the 'OK' button. Press 'Cancel' if you have changed your mind. If you press 'OK', you will be show a progress bar showing you how the restoring is going. Once the progress bar finishes and closes the data will be restored.
Restoring a Project as a New Project
To restore a project backup as a new project, first open the Project Management dialog (see Overview) and then select the project from the list that you wish to restore over, and press the 'Restore As New' button. You will be presented with a file window (as in figure 15), asking you to select the project to restore from. Once you have selected the SQL file and pressed the 'Restore' button you will be see another dialog like the one in figure 18, asking you for the name of the new project:
Figure 18: New project name.
When you press 'OK', the new project will be created with all the data from the backup. You will see a progress bar telling how the restoration is going.
To delete a project, first open the Project Management dialog (see Overview) and then select the project from the list then press the 'Delete' button. You will be asked to login (see figure 8) and then you will be presented with a dialog like the one in figure 19, asking you what you wish to backup the project first::
Figure 19: Deletion backup request.
If you choose 'Yes' you will be shown a file window similar to the one in figure 14, where you need to enter the name of the backup. The backup will then proceed, and after it has completed the project will be deleted. If you select 'No' you will then see the following warning:
Figure 20: Final warning.
If you select 'OK', the project will be deleted. If you press 'Cancel' it won't.