The essential
A Phraseanet application is organized in bases and collections. Each bases corresponds to a customizable documentary structure, a collections can be considered as base subsets.
Databases start screen lists available databoxes on the application.
Two forms allow:
Click on a database name to start it customization.
A database start screen display its status.
The screen shows the indexation state of the base and allows the following actions:
As a multi-bases system, each base of a Phraseanet instance is finely customizable. Click on the + icon in order to reveal its sub-menu.
This section displays the documentary structure of the selected base as a XML file.
It’s unlikely to have to customize a base using this interface, the interfaces Fields , Subviews or Status setup are more convenient to change settings.
The section Fields allows to define and edit the documentary structure of a Phraseanet base using forms in a graphical interface.
Each of these fields of the documentary structure is defined by customizable properties:
Note
The field types are linked to the Phrasea engine.
To declare a facet for a field:
Note
In general, and except for changing labels, operations on the document structure involves recreating and rebuilding ElasticSearch indexes.
| Ref: | See paragraph on building ElasticSearch index in Administration manual<Operations-on-indexes> |
|---|
The populate operation can take several hours depending on the volume of archived records.
The Subviews section allows to add and edit the media subviews files for picture, videos, audio, office other multimedia documents type integrated in Phraseanet.
The nature of the sub-definitions depends on the nature of the original documents integrated in Phraseanet. The table below lists some typical examples of subviews generated by Phraseanet.
| Nature of the original Media | Nature of the sub-definition | ||
|---|---|---|---|
| Jpeg, psd, gif, png... pictures | Jpeg, Png or Tiff sub-definition | ||
| Mpeg, Avi, Mov... video | Mpeg4 sub-definition, Jpeg or Gif | ||
| Wav, Mp3... audio | Mp3 sub-definition or Jpeg | ||
| Pdf, Word... office document | Flash animation (Swf) of Jpeg | ||
Warning
The thumbnail and preview subviews are mandatory. They are used in the Phraseanet interfaces to display thumbnails and preview images of media. Don’t delete them. Use label to change their names if needed.
Statuses allows to set states on documents and restrictive access to records for users regardless of collection notions. It is possible to integrate up to 28 statuses.
Terms and conditions of use are shown to the users when they sign-up.
By default, the collections are displayed in Phraseanet by creation date. It is possible to modify this order.
The collections are subsets of a base they share the settings with. The implementation answers to the segmentation needs of documentary assets and/or the assignment of specific users rights.
To create a collection, click on the name/label of the base in which the collection shall be created then click on Create collection.
Specify the name of the collection to create in the name field then validate the form.
Note
When creating a collection, it is possible to apply (duplicate) users rights from an existing collection.
Click on the title of the collection to display its information.
This screen shows the essential information on the collection. It allows to rename it, deactivate it (see section Activate or de-activate a collection), purge it or delete it.
Click on Details to display an inventory of the collection contents.
The table lists the objects composing the collection (records, documents, subviews, the number of objects, the size in megabytes, the size in gigabytes.
To hide the details of a collection, click on Back.
An order manager is a user that can validate download requests on original documents made by users.
Note
The order managers receive download requests notifications in the Phraseanet interface and by email.
To add an order manager, type the user’s name, firstname or login in the form then validate using the suggested choice by the auto-completion system.
To delete an order manager, uncheck the box before his username then apply using the Validate button.
To brand documents published on other sites using Phraseanet, select one of the three suggested options in the group of radio-buttons.
Or
Or
A form regroups other actions on the selected collection.
The labels allows to give names to the collections in each interface language. To define or modify the labels of a collection, fill the form then click on the Set labels button.
By default, the collections are activated when created. This means that they are published and that the users that can access them and can browse their contents.
To de-activate a collection and stop its publication, click on the Disable collection button.
To activate a collection:
- Click on the database name then
- Click Activate a collection
- Select the collection to activate
- Refresh display
Enter a new name for the collection then click on Rename.
Warning
Rename a collection requiere to drop / create and populate Elasticsearch search index. Favour a label change instead could be wiser.
Emptying a collection deletes permanently all its records (documents, notes, subviews, stories).
This action is permanent and applies to the sub-definitions and the notes.
Click on Empty the collection to delete all the records of the collection.
Click on Delete to completely delete the collection from the base.
Note
A collection must be empty to be deleted.
A collection is customizable by a set of distinctive graphical elements.
To add a logo representing the collection :
Use the proposed form to add a customized watermark in order to apply it to all sub-definitions of the collection’s documents.
Note
A watermark is applied to the subviews viewed by the users that have the “No watermark” right unchecked.
A stamp adds a banner containing a logo and some metadatas to the export of original image type documents.
The configuration of the stamp must be completed by editing the XML tags in the collections preferences.
The suggested values are drop down menus that appear in the Edit window to enable a rapid capturing. They are editable by collections and by fields.
The edition of suggested values is possible in a graphical for or using the XML input view mode.
In the graphical mode, it is possible to sort the values by clicking on a value then “Up” or “Down” or to sort them by alphabetical order by clicking on Alpha sort.
To delete a value, select it then click on Delete.
The XML input view mode is useful for advanced settings such as:
Some examples in the FAQ section manual refer to this XML input view mode.