Chapter 3. Organizer

3.1. Using the Organizer

The ERES Cloud Organizer is a powerful graphical user interface that allows users to design charts and reports and organize them with other files in virtual folders. The Organizer contents are automatically published to the Menu page and users can automatically generate URLs to run reports and charts. In addition, schedule and archive jobs are created and maintained through the Organizer. The Organizer also includes the user permissions and security level setting options.

3.1.1. Starting the Organizer

To start the Organizer, click the link labeled Organizer in the Start page. This will open a pop-up window. Confirm ERES_Organizer.jnlp file open by Java Web Start Launcher. Then the Organizer will open.

Opening Organizer

If you use Chrome as a browser, you have to save ERES_Organizer.jnlp at first, and then to open it from your download directory. You will see the next dialog. Click Run and Organizer will open.

Click to view larger image

Opening Organizer in Chrome

3.1.2. The Organizer Interface

Since the Organizer is at heart a file management system, it is no coincidence that the application window resembles a file browser. The left-hand side of the window contains a list of projects and their associated sub-folders, while the right-hand side lists the contents of a folder in the upper pane and the project/folder descriptions in the lower pane.

Click to view larger image

Organizer Interface

3.1.2.1. The Organizer Menus

Most of the Organizer functions can be controlled using the drop-down menus located at the top of the Application window.

3.1.2.1.1. File Menu

This menu performs most of the file operations. Options in this menu include:

New

If you select this option, another menu pops up.

Folder

Creates a new folder in current project/folder.

Chart

Launches ChartDesigner. (see Section 5.2.1 - Introduction to Chart Designer).

Report

Launches ReportDesigner (see Section 5.1.1 - Introduction to Report Designer).

Dashboard

Launches DashboardBuilder (see Chapter 7 - Designing Dashboards).

Manage Data Sources:

This option opens Data Source Manager that allows you to manage data files and database queries.

Open File:

This will open the currently selected file. If the file is a chart then the Chart Designer will open, allowing you to edit the chart. If the file is a report file then the Report Designer will open allowing you to edit the report.

Create PAK:

Pack a GXML (Online Map), SXML (SVG Map) or DSB (Dashboard) file and its components (Templates, Tooltips etc.) into a single file (see Section 3.1.4.5 - Dashboard and Map Packages).

Unpack File:

Unpack a GPAK (Online Map), SPAK (SVG Map) or DPAK (Dashboard) pack file into Organizer (see Section 3.1.4.5 - Dashboard and Map Packages).

Delete:

This will delete the currently selected project, folder, or file.

Refresh:

This will refresh your Organizer window, allowing it to reflect the latest changes/modifications performed by other users.

Exit:

This will close the Organizer.

3.1.2.1.2. Edit Menu

This menu allows you to edit, and cut/paste files and folders. Options in this menu include:

Insert File(s):

This allows you to insert a report or chart into the selected project/folder.

Edit:

This allows you to edit the currently selected project, folder, or file. For projects and folders, you can change the project/folder name as well as its description. For files, you can change the display name, the location path or URL, and the description.

Cut:

This removes the selected project, folder, or file, and places it on the clipboard.

Copy:

This makes a copy of the selected project, folder, or file, and places it on the clipboard.

Paste:

This pastes the current clipboard project, folder, or file into the currently selected project or folder.

3.1.2.1.3. Publish Menu

This menu allows you to setup and view published reports and charts. Options in this menu include:

Preview Menu Page:

This will load the ERES Menu page in a new browser window.

Generate Image URL:

This option generates an Image URL for the currently selected chart.

Generate Report URL:

This option generates a Report URL for the currently selected report.

Generate Dashboard URL:

This option generates a Dashboard URL for the currently selected dashboard.

3.1.2.1.4. View Menu

This menu allows you to search for files or edit charts and reports. Options in this menu include:

Search:

This allows you to search through projects, folders, and files.

Chart Designer:

This will open the Chart Designer, allowing you to design or modify charts.

Report Designer:

This will open the Report Designer, allowing you to design or modify reports.

3.1.2.1.5. Schedule/Archive Menu

The menu allows you to set and view options related to chart/report scheduling and archiving. Options in this menu include:

Set Schedule:

This allows you to set a schedule for the currently selected chart, report, project, or folder.

Set Archive:

This allows you to set an archive for the currently selected chart, report, project, or folder.

Set Alert Monitoring:

This allows you to set an alert monitoring for the currently selected chart, report, dashboard, svg map, project, or folder.

View Schedule Tasks:

This will open the log allowing you to view all the of the currently scheduled and archived jobs.

View Alert Monitoring Tasks:

This will open the log allowing you to view all the current alert monitoring jobs.

3.1.2.1.6. Option Menu
Set Designer:

This allows you to specify whether to open every chart or report in the same Chart Designer or Report Designer window (thus closing the current chart or report), or to open a new Chart Designer or Report Designer window for each chart or report opened.

3.1.2.1.7. Help Menu

This menu allows you to view a version of the program and to open a documentation. Options in this menu include:

About:

This brings you an information about the version of the program.

Contents:

This opens the ERES Cloud User's Guide.

3.1.2.2. The Organizer Toolbar

The toolbar at the top of the Organizer window offers easy access to some of the most commonly used features. The buttons perform the following functions:

Insert a new folder into the current project

Insert a new file into the current project or folder

Cut the currently selected project, folder, or file, and place on the clipboard

Copy the currently selected project, folder, or file, and place on the clipboard

Paste the current clipboard project, folder, or file into the currently selected project or folder

Delete the currently selected project, folder, or file

Manage Data Registries, files, queries, etc.

Search for projects, folders, or files

Edit the currently selected project, folder, or file

Preview the menu page

Generate a URL for the currently selected file

Pack a map or a dashboard and it's components into a single file (see Section 3.1.4.5 - Dashboard and Map Packages)

Unpack a GPAK (Online Map), SPAK (SVG Map) or DPAK (Dashboard) pack file into Organizer (see Section 3.1.4.5 - Dashboard and Map Packages).

Go to Chart Designer

Go to Report Designer

Set schedule for the currently selected chart, report, folder, or project

Refresh the Organizer window

3.1.3. Projects and Folders

Projects and their associated folders are the central part of the Organizer interface. They provide the primary means of organizing charts and reports. Projects are the top level of organization. You can see read-only projects with examples and your project created automatically with the name of your email address. You can insert many layers of sub-folders into your project, creating just about any organizational structure.

It is important to note that all folders in the Organizer are virtual folders, meaning that they do not necessarily have a physical location on the server machine or mirror an actual directory structure. Projects and folders in the Organizer are pointers to real directories and files that may be stored in a variety of locations.

3.1.3.1. Creating and Modifying Folders

To insert a sub-folder into your project or folder, first select the project or folder in which you would like to place the new sub-folder. Then you can either click the New Folder button on the toolbar, select New Folder from the File menu, right-click in the left-hand pane and select New Folder from the pop-up menu, or press Ctrl+F. A node labeled new folder will appear under the currently selected project or folder.

Edit Project/Folder Dialog

To edit the folder name and description, first select it, and then you can either click the Edit button on the toolbar, select Edit from the Edit menu, press F2 key, or right-click, and select Edit from the pop-up menu. A dialog will then appear prompting you to change the folder name and description. Once you have entered your desired changes, click Ok, and the new folder name and description will be displayed in the lower right-hand pane.

3.1.4. Files

3.1.4.1. Adding and Modifying Files

To add a file, first select the folder or your project in which you would like to place the file. Then you can either click the Insert File button on the toolbar, select Insert File from the Edit menu, or right click in the upper right-hand pane, and select Insert File from the pop-up menu. A dialog box will appear, prompting you to enter a display name for the file (by default the file name is used), the location of the file (a direct path) and a description of the file. (If you select a path that is not the server root or a mapped virtual directory, you will be prompted to map one.) Click Ok and the file will be inserted into the current directory or folder.

To insert more than one file at a time, click the Browse button on the insert file dialog, and use CTRL+Click to select multiple files in the browse dialog. Then when you click OK all of the files will be added to the Organizer.

Insert File Dialog

The list of files in the currently selected folder will be displayed in the upper right-hand pane of the Organizer. Each entry shows the file's display name, the file type, the file description, path, and URL.

To edit the file's display name, location, or description, first select the file that you would like to edit. Once you have selected a file, you can either click the Edit button on the toolbar, select Edit from the Edit menu, press F2 key, or right click, and select Edit from the pop-up menu. A dialog box will appear allowing you to make changes to the display name, location, and description. Click Ok and the changes will be reflected in the file list.

To open a file, double click on it, or first select it, and then you can select Open File from the File menu, or right click and select Open File from the pop-up menu. If the file is a chart (PAC, CHT, TPL, or QCH) format, it will be opened in the Chart Designer. If the file is a report (PAK, RPT, QPT, or XML) format, it will be opened in the Report Designer. If the file is a dashboard, the Dashboard Builder interface will open in a new window. If the file is a map, Online Maps interface will open in a new window. All other file types, such as SVG, will be opened in a web browser window.

3.1.4.2. Arranging Files

To arrange files within folder or project, open the folder (click on it in the left-hand side tree-list) and then click on a column header in the right-hand side. Files in the folder/project will be arranged by the content of the selected column. To switch between ascending and descending order, click on the column header again.

A folder arranged by the file names in descending order.

3.1.4.3. File Identification Icons

Each file type can be easily identified by its icon. You can see these icons next to file names in Organizer and all dialogs in ERES designers where you need to select some file.

Report file created in Report Designer that contents supplementary files associated with it (.pak). For more information see Section 5.1.5 - Saving Reports.

Report template created in Report Designer (.rpt) in older versions of ERES (6.6 and older).

Chart file created in Chart Designer (.cht). For more information see Section 5.2.2.3.1 - Saving Chart Definitions.

Chart template created in Chart Designer (.tpl). For more information see Section 5.2.2.3.1 - Saving Chart Definitions.

Chart file created in Chart Designer that contents supplementary files associated with it (.pac). For more information see Section 5.2.2.3.1 - Saving Chart Definitions.

Report file created in QuickDesigner Reports (.qdr). For more information see Section 5.3 - QuickDesigner Reports.

Chart file created in QuickDesigner Charts (.qch). For more information see Section 5.4 - QuickDesigner Charts.

Map file created in Online Maps (.gxml). For more information see Section 6.2 - Online Maps.

Packed map file created in Online Maps and packed in Organizer (.gpak). For more information see Section 3.1.4.5 - Dashboard and Map Packages.

Coordinates file for Online Maps (.cxml). For more information see Section 6.2.1 - Data Sources.

SVG map file created in SVG Maps (.sxml). For more information see Section 6.3 - SVG Maps.

Packed SVG map file created in SVG Maps and packed in Organizer (.spak). For more information see Section 3.1.4.5 - Dashboard and Map Packages.

SVG map image (.svg). For more information see Section 6.3.1 - Introduction to SVG Maps.

Dashboard file created in Dashboard Builder (.dsb). For more information see Section 7.1 - Introduction to Dashboards.

Packed dashboard file created in Dashboard Builder and packed in Organizer (.dpak). For more information see Section 3.1.4.5 - Dashboard and Map Packages.

3.1.4.4. Report Locking

The ERES Organizer has an automatic report locking system designed to block multiple users from editing the same report in Report Designer at the same time. The system utilizes your IP address, your username, and a special token to determine whether you are allowed to open a specific file. Here is an example illustrating how the advanced file locking system operates.

Suppose you are logged in as userA and you are editing a report Sales.pak. One of your colleagues logs in as userB and attempts to edit the same Sales.pak. She would see the following error message, alerting her that the file is currently locked.

File is Locked

Suppose after opening the file, your browser crashed or you moved to a different computer. Now you log back in as userA and open the same file again. You will see the following message allowing you to override your own lock.

Override Your Lock

If you moved to another computer and the report is still opened on the previous computer, you will not be able to save on the previous computer. You must close the report and re-open it in order to have write privilege again.

[Note]Note

The admin has the ability to overwrite any lock.

3.1.4.5. Dashboard and Map Packages

A single map or a single dashboard usually consists of several files (for example, a dashboard needs several chart/report/map templates, a svg map needs a svg image, drill-down template, etc) which could make moving maps or dashboards to another machine very difficult, because you would have to move all the linked files as well. Fortunately, you do not have to move each file manually. A dashboard or a map and can be packed into a single file along with all the linked files (dashboard templates, drill-down templates, etc) without even knowing which exact files are needed for the dashboard or map to work. The packed files can be moved or archived quickly and easily.

To pack a dashboard or a map (both SVG and Online maps can be packed), select the dashboard (.dsb) or map (.sxml or .gxml) file in Organizer and then click on the Create PAK icon on the main Organizer toolbar. A dialog will pop up prompting you to select the pack file name. Enter a file name or use the default one and click OK. Another dialog should show up confirming that the package was created successfully and showing you the full file path. The packed file will be also automatically inserted into the current Organizer folder/project.

Packed files can be viewed in the Menu page without being unpacked, but they can not be modified in the SVG and Online Maps designers or in the Dashboard Builder. In order to modify a packed dashboard or map, you need to unpack the gpak, spak, or dpak file first.

To un-pack a dpak, spak, or gpak file that has not been inserted into Organizer, click on the Unpack File icon on the main Organizer toolbar. A dialog will pop up, allowing you to choose the file on your hard drive and to enter a name which will be used for the main unpacked file (.dsb, .sxml or .gxml file).

If you want to unpack a file that has been inserted into Organizer, select the file in Organizer and then click on the Unpack File. The same dialog will pop up but the file path and the file name fields will be filled automatically.

To view the list of all files that are stored in the package, click on the Details button. A new window will open.

Click to view larger image

Unpack File List Dialog

In this window, you can edit both physical and Organizer file path of all files that can be un-packed from the package (which also allows you to resolve potencial file name conflicts). After you are done editing the file paths, click the Close and then click OK to unpack the package.

The ERES will now try to unpack all files from the packed file to their original locations. If there are any filename conflicts (i.e. there already is a file with the same name in the same path on your hard drive or in Organizer), the following dialog will show up:

If you click Yes, all existing files will be overwritten by the files from the package without no further questions. If you click No, the Unpack File List dialog will open again allowing you to edit the filename conflicts. Then click Unpack to unpack the files into their locations and to insert them into Organizer.

3.1.5. Searching in Organizer

Often, if you have many files in many folders in the Organizer, it can be hard to find a specific file. To locate files or folders, you can use the search function. To search, you can either click the Search button on the toolbar, select Search from the View menu, press Ctrl+F, or right click in the upper right-hand panel and select Search from the pop-up menu. The search dialog will then appear.

Click to view larger image

Search Dialog

The search dialog prompts you to enter a search string in the project or folder in which you would like to search. By default, the currently selected project or folder is listed. If you leave the Look In field blank, it will search all projects.

Other options allow you to include sub-folders in your search, and to match the search string to filenames, descriptions, and URLs. You can also match case in your search by selecting the Case Sensitive option.