Creating a collection

Once Zegami has been installed a collection of images can be made by using the web based Manager.
Zegami manager can be accessed by opening a web browser and navigating to http://localhost. If attempting to access the Zegami Manager from a different machine this address will different.

For Command Line Interface (CLI) users who do not have the Zegami Manager, see the CLI guide for creating collections.

Collections are what we call the data/items/assets/things which are displayed within Zegami. In most cases collections have two main components: a source of data and a source of images.

Creating a collection #

From the menu select the ‘Create New’ item. This will open the collection creation wizard – a series of steps which will guide you through creating a collection.

Collection Details #

Give the collection a name and a description.

The name is used to identify the collection and forms the collection URL.

The description is used witin Zegami Manager to help identify the collection and its contents.

Additional Collection Information can also be added. This will be displayed to users when the collection loads. The rich text editor supports formatting and images.

Click Next to set the collection data source.

Data Source #

All collections start with data. By its very nature data can come from many different places and be stored in a variety of different formats. To make it as simple as possible to create a collection we’ve developed a range of data source types which will fit many common scenarios. We are constantly working on new data source types so keep an eye on our plugins page or subscribe to our mailing list.

If there is a data source that is missing that you really need and you have access to a developer then Zegami features a plugin API. This means that it’s possible to support any kind of data source imaginable.

If all else fails then Zegami supports the simplest of all data formats – a CSV file which stands for Comma Separated Values. CSV files are readily exported from most databases and applications like Excel.

Zegami comes with an example *tab delimited* data source file located at C:\Program Files\Zegami\examples\collection\datasource.tsv on Windows and /opt/zegami/examples/collection/datasource.tsv on Linux. Select CSV as the data source type and enter the path to the file.

Leave the default values for the other fields.

Data Source Columns
Now that the data source has been specifed the columns that are imported into Zegami can be edited. This is an opportunity to rename a column, change its order or hide it from view. #

Click the  icon to hide the path column and click Next to continue.

Image Source #

Once we have the data the next most important piece are the images. Images could be as simple as a color to indicate a status or an actual photo of an item.

Images needs to be located in a directory that is accessible by Zegami Server and need to be uniquely named so that it can be matched up with the data.

Zegami comes with an example collection of images located at C:\Program Files\Zegami\examples\collection\images\ on Windows and /opt/zegami/examples/collection/images/ on Linux.

Select File System as the image source and set the path to for Windows:

C:\Program Files\Zegami\examples\collection\images\

or for Linux


You’ll notice that the path can include tokens which correspond to a column in the collection data source. The tokens are designated by using double opening and closing curly braces  wrapped around the column name.
For example C:\Zegami\data-source\images\.jpg will match all jpg images in the C:\Zegami\data-source directory where the file name matches the id column from the data source and has an extension of .jpg.

These tokens allow us to create dynamic, data-driven paths to locate the images.

Click Next to set the Refresh Trigger.

Refresh Trigger
Collections can be set to automatically be processed if a certain trigger event occurs. #

Triggers incude a scheduler which can process a collection at a set interval.

For now we will leave it as the default value of No trigger and click Next to continue.

Zegami collections have three possible levels of access security that can be set. #

Any user who has signed in

The collection is visible to any user who has signed in to Zegami. If they have not signed in they will be prompted for their username and password.

Any user regardless of whether they have signed in (Anonymous access)

This option allows anyone to access a collection, even if they haven’t signed in. This is used for hosting collections publically on the Internet and is only avaliable if an Anonymous Access licence has been purchased.

Only specific users

This option allows you to specify exactly who has access to view and manage (edit and process) the collection.

For now we will leave it as the default value of Any user who has signed in and click Create to create the collection using the values we have entered.

Collection Processing #

Once a collection has been created it will immediately being processing. Collection processing is needed to geenrate a collection that is optimised for viewing of a range of deveices.

Depending on the size of the collection and the server hardware this may take a few minues or a few hours to complete.

The progress of the processing can be monitered in Zegami Manager.

Once the collection has finished processing it can be access by selecting the collection panel.

Powered by BetterDocs