© 2010-2011, Heymann Consulting
List Search EJaP - Version 8.5.0
 
Documentation
 
Documentation Version: 8.5.0
last modified: 2011-03-13

Contents

 

0 Introduction

1 Installation
 
   1.1 Tryout Version

2 Usage

3 Menus and Preferences

4 Additional Information

5 Version History & Product Support

 

0 Introduction

 

 
 
The List Search Main Dialog
 

The List Search EJaP is an extension to the Canto Cumulus Workgroup or Enterprise Client 7.5 or higher based on the Canto EJaP (Embedded Java Plugins) technology. It allows to search for records in the Cumulus catalogs specified in a text list. This can be e.g. a list of filenames, product codes, article numbers, .etc. Each list entry will be converted into a configurable search query. The search result of all these search queries will be displayed in the frontmost Cumulus Collection window.

A log informs about empty search results of single queries or if the single results contains more than one record at a time. The log information can be saved to a text file. The application supports the English and German language based on the current Cumulus Client setup.

The search query that is generated for the selected list can be saved to a Cumulus Query file that can be loaded by the Cumulus Client lateron if necessary.

Do you need additional functionality in the application? We develop additional functionality based on your needs. Send an email with your feature requests by clicking here.

 

 

1 Installation

 

In the 'Installation' folder of the product you will find the folder 'ListSearch'. Copy this folder into the 'ejp' folder of your Cumulus Client application.

Under Windows it is usually 'C:\Program Files\Canto\Cumulus 7 Workgroup Client\ejp', under Mac OS X it is 'Macintosh HD/Applications/Cumulus 7 Workgroup Client'. The 'ejp' folder of the Cumulus application can be found in the Cumulus package. You can reach this folder by clicking the mouse-button while holding down the CTRL-key on the Cumulus application icon. Click on 'Show Package Contents' in the context-menu. This will open a finder-window with a subfolder 'Contents'. In that folder you will find a Mac OS X folder and there you will find the 'ejp' folder in which to copy the folder 'ListSearch'.

Restart the Cumulus Client application to use the List Search EJaP, it will show a new menu item in your Cumulus application called 'List Search'.

You will get a serial number for the List Search EJaP with the full version of the product. After opening the Cumulus Client select 'List Search>LIcense...' to open the license dialog.

 
 
The List Search EJaP License Dialog
 

Specify the information necessary to unlock the demo version. Click 'OK' to save the serial number information for this Cumulus Client application.

 

1.1 Tryout Version

The tryout version of the 'List Search EJaP' is a full version of the product, so you can evaluate all the functionality available. The limitation: the search function is limited to 5 text list entries. So if your list contains more than 5 entries, the application will stop after performing the 5th search query. There are no other limitations in the tryout version. The demo version is for testing purposes only and you are not allowed to use it in a working environment! To order the product, just send an email to Heymann Consulting.

 
 
The List Search Info Dialog after providing a valid serial number
 

 

 

2 Usage

 
 
 
The List Search EJaP's Main Dialog
 

The List Search EJaP creates a new menu List Search in the Cumulus Client menu bar. Select the menu item List Search>List Search... to show the above dialog:

1. Open the Cumulus Client and open one or multiple catalogs.
2. Select the menu item List Search... to configure the list search function.
3. A file chooser allows to select a text file that contains the list of search items. Select a file or click 'Cancel' if you want to copy and paste a list from the clipboard or another application into the main dialog.
4. Specify the search query by selecting one of the Cumulus record fields from the list of fields. Also select the appropriate search condition.
5. If you have not loaded a text file into the search list field so far, please copy your search list into the textfield to enable the 'Start search' button.
6. After setting the search query you can display the complete search query by clicking 'Show Queries...' for your information.

 
 
The List Search EJaP's Query Dialog
 

 


You can click 'Save...' to save the full query into a Cumulus Query file. This file can be loaded as a Cumulus search query into the Cumulus Client.

7. The list search function can be performed in all open catalogs or in the Current Collection (based on the current records display). Select the appropriate setting.
8 . To perform the List Search, click the button 'Start search' in the main dialog.
9. After performing all the specified search queries a statistics dialog informs about the search result, errors, missing or multiple files.
10. Log information is generated to all errors, missing or multiple files in the search result. A text dialog for each error type is displayed and the user is able to save the information into a text file.

 
 
The List Search EJaP's search statistics
 

11. If more than one record is found by a search query, the result is listed in the following window:

 
 
The list of search queries with more than one record found
 

12. The reference list shows you all the search results. At the top of the dialog you can find the search query. The first column of the table lists the search term, all other columns contain the Asset Names of the files found.

 
 
The reference list can be saved in different file formats
 

You can save the reference list into a file. You can select the file format and also the platform (Macintosh or Windows):

- Microsoft Excel
- CSV file (MS-DOS)
- CSV file (Macintosh)
- Text file (MS-DOS)
- Text file (Macintosh)

Remark: the reference list is only displayed, when the search result contains at least one record.

 

 

3 Menus and Preferences

 

The List Search EJaP creates its own menu 'List Search' in the menu bar.

 
 
The Menu Options
 

The menu comes with the following options:

List Search...

Opens the main dialog and asks to select the text file containing the list.

Preferences...

Opens the Canto Cumulus Preferences dialog. You find the List Search preferences under 'User Settings>General>List Search EJaP'.

License...

You can specify your serial number here to unlock all the functionality.

Info...

Version number information and a button that leads you to the website.

 

The List Search preferences allow to specify the encoding of the text file that contains the list of information that you want to search for.

 
 
The List Search User Settings
 

The List Search EJaP use the standard encoding of the operating system when opening the text file. If your text file uses a different encoding (e.g. UTF-8), please specify the encoding here before selecting the file.

 

 

4 Additonal Information

 

1. The application supports the English and German language based on the current Cumulus Client setup.

2. The search query is saved in the language that is used by the Cumulus Client. So if you want to reload the query in the Cumulus Client, make sure that the Client is set to the appropriate language.

3. The software is able to read list files with different encodings and different line separators.

4. The search result will be displayed in the current Collection. Warning: in Cumulus versions 7.5 and 7.6 the current Collection can be the Collection Basket Pane. So if the Collection Basket Pane is displayed in your current view and the pane is selected (active), the search result will be displayed here and the current contents of the Collection Basket is lost. This does not apply to Cumulus versions 8.x and higher.

 

 

5 Version History & Product Support

 

Version 8.5.0 - February 2011

This update release implements the following changes:

- Implementation of a file reference list
- The list search function can now be performed in all open catalogs or in the Current Collection (based on the current records display).

Version 8.1.0 - November 2010

This update release implements the following changes:

- Multi Catalog Collection Support
- Preferences allow to configure the text file encoding

Version 8.0.0 - August 2009

This update release of the List Search EJaP comes with a new serial number to match the serial number of the current Cumulus version.

This new version is optimized to work with Cumulus 8, but it also works with older versions from 7.5 or higher. User Interface improvements and optimizations for Cumulus 8 have been implemented and minor bugs have been fixed. This version also reads list files with different encodings and line seperators.

Version 1.0.0 - October 2007

This is the first version of the List Search EJaP.

Please send all your questions about the product to the email address support@heymann-consulting.de. We try hard to answer your questions quickly and improve our products by implementing functionality based on your feedback.

 

 

© 2010-2011, Heymann Consulting

Heymann Consulting
Brandstwiete 36
20457 Hamburg
GERMANY