Create a New CSA Project: Difference between revisions

From OCAD 12 Wiki - English
Jump to navigation Jump to search
No edit summary
 
(42 intermediate revisions by 4 users not shown)
Line 1: Line 1:
==Connect Database==
[[Category:Client Server Architecture]][[File:Ent40px.PNG|This function is only available in the OCAD Enterprise Edition.|link=https://www.ocad.com/en/products/ocad-for-cartography]]
After the basic database setup you can connect to the database. You have to enter the
==Connect to the Server==
information in the below shown mask.
After the '''[[Installation of the Client Server Architecture|Installation and Setup of the Client Server Architecture (CSA)]]''', a connection to the server can be made. Click the [[File:Icon_ConnectDisconnect.PNG]] '''Load and Manage Client Server Projects''' icon in the '''Client Server''' toolbar to build up a new connection. The '''Load and Manage Client Server Projects''' dialog is shown.


[[File:ServerClient_NewConnection.png|500px]]
The upper left side shows the connection data to the PostgreSQL server. It should be preconfigured by your administrator. The upper right side provides a login form in order to gain access to your projects. This login is personal for each user. Click the '''Connect''' button when you have entered all relevant data. If the login succeeds the table with all availaboe projects on the server is shown in the middle of the dialog. With the button '''Manage...''' in the Project user group box you are able to manage the project users if you have the right to. For further details read the article [[Rights_Management#Server_Rights| Manage project users]]


For the first connection you have to provide the database protocol – currently only
[[File:NewConnectionDialog.PNG]]
Postgres is supported. For a connection although the host, the database name, the port
and the port must be provided. The user name for the database currently must be ocad11
as mentioned in the setup selection and a Password.


For the project user you must provide the data as inserted during the installation for the
In the lower part of the '''Load and Manage Client Server Projects''' dialog there are several buttons and options:
user name and the password. When you are connected the currently database projects
get loaded and your userident. In the current development stage none of the provided settings are
saved! The hard coded default settings shown above. The database password is ocaddb.


The '''auto reload changes''' re-fetches all loaded objects when they changed in the db.
* '''Resync current open project after offline work''': The '''Resync mode''' option allows to synchronize OCAD data back into the CSA-Project. Read the '''[[Create a New CSA Project#Resync|Resync a project after offline work]]''' article for more information.
* '''Autoreload changes (5 seconds)''': With a checked '''Autoreload changes''' option, changes made by other users on the loaded CSA-Project are updated automatically every fifth second. The update happens in the background and does not become visible until the screen is refreshed.
* '''Load selected project''': Click this button to load the selected project. Projects can also be loaded by double click on the project name.
* '''Clear selected project''': Click this button to clear all entries made in the database on the server.
* '''Delete selected project''': Click this button to delete the selected projects completely (The whole database is deleted).
* '''Create new project''': Click this button to create a new CSA-Project.
* '''Project information''': Click this button to show all available information for the selected CSA-Project.


==Create a New Project==
To create a new CSA-Project, you must have the necessary '''[[Rights Management|Rights]]''' to do so. A server administrator can manage all the rights. More information can be found on the '''[[Rights Management]]''' page.


==Create New Project==
# Click the '''Create new project button'''. The '''Create New Project''' dialog appears.
After the basic setup you can create a new map project in the database. To do so click in
#: [[File:CreateNewProjectDialog.PNG]]
the connection window on new project. The following information have to be provided for
# Enter a project name in the '''Project Name''' field. In the '''Project ident''' field an identifier is automatically derived from the project name but can be manually adjusted, too.
the project creation.
# Choose one '''Project type'' with the radio buttons
## '''Empty project''':Creates an empty OCAD 12 Enterprise project that has set up a real world offset and a coordinate system. Colors and Symbols are empty.
## '''Import project from existing file''':  With the mode “Import project from existing file” you can select an OCAD 12 file with an import the data. It is possible to choose what information of the file is loaded into the server project. Furthermore it is possible to choose another offset of the file to place multiple map files into an OCAD 12 Enterprise project.
## '''Use existing project as base project''': This option let you choose an already existing project from the server and creates a new project on that. Symbols, Colors and settings are copied from the existing project to the new project. Objects are not copied but linked to the newly created project. The linked objects are shown in the background and cannot be changed in the inherited project. It is possible to change the styling of the objects by editing the symbol in the inherited project and also the status hidden of the symbol will hide both, the object in the new map project and the base map object


[[File:ServerClient_CreateNewProject.PNG]]
===Create an '''Empty project'''===
# Choose the '''Empty project''' in the creation dialog (dialog shown above)
# Adjust the '''Map settings''' ('''[[Create a New Map#Set Scale and Coordinate System|Set Scale and Coordinate System]]''') as you are used to from local OCAD projects.
# Click on ''Create'' creates the project an it is shown afterwards in the available projects list


A project name and a unique project ident must be supplied.
'''Empty project''' creates an empty OCAD 12 Enterprise project that has set up a real world offset and a coordinate system. Colors and Symbols are empty.
When you enter a project name a project ident will be created of the name by default but
you can change it the way you like. A map scale and a grid distance should be provided all
other parameters are optional. When clicking on the '''Create''' button the new project will be
created and should shown up in the database window.


==Draw with database connection==
===Create a project with '''Import project from existing file'''===
# Choose the '''Import project from existing file''' in the creation dialog.
#:[[File:CreateNewProjectDialogExisting.PNG]]
# Select with the check boxes what would you like to import into the project. Furthermore you can deselect the '''Import scale and offset parameter''' to shift the map if you want to.
#:[[File:CreateNewProjectDialogExisting2.PNG]]
# Click on ''Create'' creates the project an it is shown afterwards in the available projects list. This will take a while, depending on your connection speed and objects to import.


To draw objects directly into the database you have to create a database project first. As
===Create a project with '''Use existing project as base project'''===
next step load a file with a symbol set. Now the database project can be associated with
# Choose the '''Use existing project as base project''' in the creation dialog
the file. Therefore open the database window, select a project from the projects grid and
# Select a project you would like to derive from
click '''OK'''.
# Click on ''Create''


Every new drawn object is now immediately saved into the database project. The objects
get automatically checked out too for future editing.


All objects checked out can be edited all others only can be viewed.


Every object inserted or changed is saved as undo in the database. You can click '''Undo'''
[[File:CreateNewProjectBaseProject.PNG]]
button in the database toolbar to revise the last change or insert and click on '''Redo''' to redo
the last change.




==Add objects to the database==


Add objects to the database is only needed to import objects. For importing one or more
The '''Use existing project as base project''' option lets you choose an already existing project from the server and creates a new project on that. Symbols, Colors and settings are copied from the existing project to the new project. Objects are not copied but linked to the newly created project. The linked objects are shown in the background and cannot be changed in the inherited project. It is possible to change the styling of the objects by editing the symbol in the inherited project and also the status hidden of the symbol will hide both, the object in the new map project and the base map object.
selected objects the following steps needs to be done.
# load the file with the objects
# associate the file with a project from the projects grid
# select one or more objects
# click the '''Add objects to the database''' button
# the objects will be added to the database
All objects associated with the database will only be saved in the database. The same
applies for object changes too.


'''Important''': The creator of the project is the owner of the project. He is the only one possible to load the project after creation.


==Add all objects to the database==
----


To import all objects from a file into the database the following steps needs to be done:
Next page: '''[[First Loading of CSA Project]]'''<br />
# load the file with the objects
Back to the '''[[Client Server Architecture]]''' page.<br />
# associated the file with a project from the projects grid
An overview about all pages dealing with the '''[[Client Server Architecture]]''' can be found in the corresponding category (see below for the link).
# hold down the shift+alt key and click on the '''Add objects''' button
# all objects from the file with the status normal or hidden will be imported in the
database now.
All objects from the file are imported in the database now. For now all changes will only be
saved in the database.
 
 
==Add symbol descriptions to the database==
 
To import the symbol descriptions into the database the following steps needs be done:
# load the file with the objects
# associated the file with a project from the projects grid
# hold down the alt key and click on the '''Add objects''' button
# all symbol descriptions from the file will be imported into the database
 
[[File:Hint.jpg]] '''Important note''': In the current implementation the symbol description depends on the
symbol number. Only '''ONE''' Symbol table is used no duplicate symbol numbers are
prevented and failure will occur if you try to import duplicate symbol numbers!
 
 
==Remove objects from the Database==
 
[[File:DeleteObjectInDatabase.PNG]]
To remove objects from the database not simple delete them with the delete key. By hitting
the delete key the object is only removed from the current view. Loading the project again
the object will show up as before. To remove an object from the database the object must
be checked out. After a successful checkout objects can be remove from the database
with a click.
 
==Get all from current view==
 
[[File:GetObjectsFromCurrentView.PNG]]
To get all objects from the current loaded view click on the button. To get the objects
window hold down the alt – key and click on the button.
 
==Check out element(s)==
 
[[File:CheckOutSelectedObjects.PNG]]
To check out elements for editing from the database select the objects to be check out and
click on the button. If no problem occurs during the check out nothing seems to be done.
On any error a message will appear describing the error.
 
 
==Check in element(s)==
 
[[File:CheckInSelectedObjects.PNG]]
To check in elements you finished editing with select them and click on the '''Check in'''  
button. Now other users are able to check the elements out and edit them. To check in all
your objects checked out click on the '''show objects checked out''' button and there click
the '''Check in all''' button all.
 
==Objects dialog==
 
Hold down the alt key and Click on the '''get objects from current view''' button to get the
objects window.
 
[[File:ServerClient_ViewObjectInDB.PNG]]
 
All objects saved in the database. Here can be
chosen to '''Load all objects''', '''Get all from the current view''' of the work sheet or to '''get a
selected object'''. It is possible that not all objects are shown therefore click the '''Reload'''
button. All objects from the database are re-fetch. To get all objects from the database click
on the '''Get all''' button. Depending on how many objects are save in the database this may
takes a long time. The objects count is show in braces in the '''Get all''' button.
 
==Show checked out dialog==
 
With this dialog you can show all objects checked out by any user of the project. Only the
objects you have currently loaded are shown in the list.
 
[[File:ServerClient_ServerShowsCheckedOut.PNG]]
 
You can leave the window open an you will see all check in and check out by any user
working with the project. By clicking on of the rows in the list OCAD will jump to the
selected object in the current project. If you deselect the reload functionality you can click
the '''Reload''' button to reload the window manually otherwise the reload takes place every 3
seconds. The description column show you the symbol description of the object is drawn
with. The button '''Check in all''' checks in all your objects you have checked out for editing.
 
==Generate Project Preview==
 
With this functionality a raster map preview can be created.
 
[[File:ServerClient_GeneratePreview.PNG|200px]]
 
To generate a raster map preview the project must be drawn with real world coordinates.
As next step you have to set the pixel size per meter for the preview. By clicking '''OK''' the
generation process will start. First all objects from the database will be loaded into the
current worksheet. This step may take a longer time depends how many objects are in the
project. Afterwards the preview is generated and saved into the database. Now every time
you load the project from the database the preview will be loaded first. This may help you
to find the correct view in the file and you have to load only the objects you need to work
with.
 
 
 
Back to [[Server Client]]

Latest revision as of 11:54, 29 May 2015

This function is only available in the OCAD Enterprise Edition.

Connect to the Server

After the Installation and Setup of the Client Server Architecture (CSA), a connection to the server can be made. Click the Icon ConnectDisconnect.PNG Load and Manage Client Server Projects icon in the Client Server toolbar to build up a new connection. The Load and Manage Client Server Projects dialog is shown.

The upper left side shows the connection data to the PostgreSQL server. It should be preconfigured by your administrator. The upper right side provides a login form in order to gain access to your projects. This login is personal for each user. Click the Connect button when you have entered all relevant data. If the login succeeds the table with all availaboe projects on the server is shown in the middle of the dialog. With the button Manage... in the Project user group box you are able to manage the project users if you have the right to. For further details read the article Manage project users

NewConnectionDialog.PNG

In the lower part of the Load and Manage Client Server Projects dialog there are several buttons and options:

  • Resync current open project after offline work: The Resync mode option allows to synchronize OCAD data back into the CSA-Project. Read the Resync a project after offline work article for more information.
  • Autoreload changes (5 seconds): With a checked Autoreload changes option, changes made by other users on the loaded CSA-Project are updated automatically every fifth second. The update happens in the background and does not become visible until the screen is refreshed.
  • Load selected project: Click this button to load the selected project. Projects can also be loaded by double click on the project name.
  • Clear selected project: Click this button to clear all entries made in the database on the server.
  • Delete selected project: Click this button to delete the selected projects completely (The whole database is deleted).
  • Create new project: Click this button to create a new CSA-Project.
  • Project information: Click this button to show all available information for the selected CSA-Project.

Create a New Project

To create a new CSA-Project, you must have the necessary Rights to do so. A server administrator can manage all the rights. More information can be found on the Rights Management page.

  1. Click the Create new project button. The Create New Project dialog appears.
    CreateNewProjectDialog.PNG
  2. Enter a project name in the Project Name field. In the Project ident field an identifier is automatically derived from the project name but can be manually adjusted, too.
  3. Choose one 'Project type with the radio buttons
    1. Empty project:Creates an empty OCAD 12 Enterprise project that has set up a real world offset and a coordinate system. Colors and Symbols are empty.
    2. Import project from existing file: With the mode “Import project from existing file” you can select an OCAD 12 file with an import the data. It is possible to choose what information of the file is loaded into the server project. Furthermore it is possible to choose another offset of the file to place multiple map files into an OCAD 12 Enterprise project.
    3. Use existing project as base project: This option let you choose an already existing project from the server and creates a new project on that. Symbols, Colors and settings are copied from the existing project to the new project. Objects are not copied but linked to the newly created project. The linked objects are shown in the background and cannot be changed in the inherited project. It is possible to change the styling of the objects by editing the symbol in the inherited project and also the status hidden of the symbol will hide both, the object in the new map project and the base map object

Create an Empty project

  1. Choose the Empty project in the creation dialog (dialog shown above)
  2. Adjust the Map settings (Set Scale and Coordinate System) as you are used to from local OCAD projects.
  3. Click on Create creates the project an it is shown afterwards in the available projects list

Empty project creates an empty OCAD 12 Enterprise project that has set up a real world offset and a coordinate system. Colors and Symbols are empty.

Create a project with Import project from existing file

  1. Choose the Import project from existing file in the creation dialog.
    CreateNewProjectDialogExisting.PNG
  2. Select with the check boxes what would you like to import into the project. Furthermore you can deselect the Import scale and offset parameter to shift the map if you want to.
    CreateNewProjectDialogExisting2.PNG
  3. Click on Create creates the project an it is shown afterwards in the available projects list. This will take a while, depending on your connection speed and objects to import.

Create a project with Use existing project as base project

  1. Choose the Use existing project as base project in the creation dialog
  2. Select a project you would like to derive from
  3. Click on Create


CreateNewProjectBaseProject.PNG


The Use existing project as base project option lets you choose an already existing project from the server and creates a new project on that. Symbols, Colors and settings are copied from the existing project to the new project. Objects are not copied but linked to the newly created project. The linked objects are shown in the background and cannot be changed in the inherited project. It is possible to change the styling of the objects by editing the symbol in the inherited project and also the status hidden of the symbol will hide both, the object in the new map project and the base map object.

Important: The creator of the project is the owner of the project. He is the only one possible to load the project after creation.


Next page: First Loading of CSA Project
Back to the Client Server Architecture page.
An overview about all pages dealing with the Client Server Architecture can be found in the corresponding category (see below for the link).