Photo Archive - Community Edition

Owned by Team Kolibri (Unlicensed)
Last updated: Nov 09, 2022 by Technische Redaktion
8 min read

Setting up a Photo Archive in yuuvis® RAD

This scenario is one of the smallest you can design: a single photo album to manage all your photos.

You will learn how to:

  • create groups and users
  • assign roles
  • use the search function
  • create objects
  • change object types
  • use the structure tree

Requirements

You need two things to get started:

  1. A working version of the yuuvis® RAD Community Edition. Download it here and follow the installation guide that comes with it.
  2. The project file containing the object type definitions used in this scenario. Download it by clicking the paperclip below.

This guide assumes that you have a clean yuuvis® RAD system and that nothing was configured in yuuvis® RAD designer yet.

Installation

Deploying the Scenario to your yuuvis® RAD System

  • Unzip the project file (see Requirements) to the Documents folder.
  • Start yuuvis® RAD designer.
  • Click Open.
  • Navigate to the folder where the scenario was unzipped. Select the .eoproj file and confirm the selection with Open.
  • Navigate to yuuvis > Settings > Environment > Connections.
  • Click Add and set the following parameters:
    • Name — Enter a name for the new connection.
    • Server — Enter the IP of the machine where the server is running.
    • Port — Enter the port, usually 8080.
  • Click Apply and leave the settings by clicking OK.
  • Deploy the scenario to your yuuvis® RAD system by right-clicking the project name in the navigation tree on the left and selecting Deploy. 
  • Open the Windows Task Manager (where the yuuvis® RAD system is running) and go to Details.
  • Look for the structure-service.exe task and end it. After a few seconds, it will be restarted by yuuvis® RAD service-manager. (This step will not be necessary for versions 4.7 or later.)

Assigning Roles

  • In a browser, open yuuvis® RAD management-studio at <servername>/management and log in with your administrator account.
  • Go to Main menu > Organization.
  • Create a new user:
    • Select default-suborganization in the list.
    • Click the Actions menu on the right and select Add > New User.
    • Enter a user name and a real name and save.
  • Create a group for administrators of the photo album and one for users:
    • Select default-suborganization in the list.
    • Click the Actions menu on the right and select Add > New Group.
    • Enter Photo Archive Administrators as the group name and save.
    • Add another group called Photo Archive Users.
  • Assign roles and users:
    • Select the group Photo Archive Administrators and click Role assignment.
    • In the Assigned area, click Roles on the right and start typing the name of the role you want to assign, in this case Photo Archive Administration. Once the name appears in the autocomplete list, click it to assign the role to the group.
    • Click Affiliation.
    • In the Contains area, click Roles on the right and start typing the name of the user you want to assign to this group, in this case root. Once the name appears, click it to assign the user to the group.
    • Repeat these steps in the Photo Archive Users group to assign the role Photo Archive Usage to the group and add your newly created users to the group.

Note: The roles are defined in the project that you imported to yuuvis® RAD designer. Photo Archive Administrators allows to create a photo album but no photos, while Photo Archive Users allows to create, edit and delete photos but not the photo album itself.

Note: Users will inherit the roles of the groups they are assigned to. These roles are not explicitly shown in the role assignment of the user.

Note: If you would like to allow every user in the system to use the photo archive, assign the role Photo Archive Usage to the main group default-suborganization.

To simplify the system for new users, you can limit the functionality:

  • In the Main menu, select System and check the boxes as shown in the following screenshot:

Creating the Photo Album

  • Log in to the client at <servername>/client with a user with the role Photo Archive Administration, e.g., root.
  • Click the + symbol in the upper  toolbar. This opens the Create object dialog.
  • Select Photo album.
  • The Create form does not need any input, so click File and Open. This opens the empty photo album where the users with role Photo Archive Usage can file their photos or search for photos of others.

Background Information About the Photo Album

The action described above creates the unique context folder of the yuuvis® RAD system. Then, the name Photo album is assigned to this context folder and it is filed to the location General (= Root), as can be seen in the schema definition in yuuvis® RAD designer:

The object type Photo album contains only one field of type catalog which is named Photo album as well. This field is set to read-only in the default form and the standard value is set by the only catalog photoalbum entry Photo album. So, when creating the object Photo album, there is no need for further configuration and all that remains to do for the photo archive administrator is to click File and Open.


Use Cases

Opening the Photo Album

  • Log in to the client at <servername>/client with a user with the role Photo Archive Usage.
  • Click the magnifying glass symbol in the upper toolbar. This opens the Search dialog.
  • Check Photo album and click Search.
  • Open the photo album from the results list by double-clicking. You are now inside the context folder of the yuuvis® RAD system, which offers a different set of actions, e.g., creating photos.

Filing a New Photo Into the Album

  • From within the photo album, click the Plus icon in the upper toolbar. This opens the Create object dialog.
  • Select Photo.
  • Upload a file and enter title, occasion and keywords for the new photo. Separate multiple keywords with Enter.
  • Click File and Open to see the new photo.

Searching for Photos

You can search for photos in different ways. The easiest is to enter attributes into the search field on the main page. If you want to go into more detail, you can use the expert search by clicking on the magnifying glass in the upper toolbar.

In the photo album folder, you can also use the structure tree on the left to filter by occasions or keywords. This tree always reflects the current state of your photo album, i.e., the occasions and keywords used as well as the number of photos assigned to them.

Extending the Scenario

You may have noticed that the photo document contains more attributes than you entered. yuuvis® RAD automatically extracted them from the file you uploaded and added them to the document. This gives you more information to filter your photos by. You can edit both these attributes and the ones that you added manually in yuuvis® RAD designer.

There are two types of object definitions in yuuvis® RAD:

  • Abstract object types define a basic set of properties.
  • Object types are the blueprints for actual objects in the yuuvis® RAD system. They can be derived from abstract object types, inheriting all their properties, and add more specific ones as well. You can see the hierarchy in yuuvis® RAD designer via Photo > Properties > Parent Types.

Adding Fields

  • Start yuuvis® RAD designer.
  • Click Open.
  • Navigate to the folder where the scenario was unzipped. Select the .eoproj file and confirm the selection with Open.
  • Select Schema > Object types > Photo Archive - Community Edition > Photo.
  • In the details view in the center, click Fields.
  • At the top of the table, enter a technical name (without blanks), a display name (that will appear in the user interface) and a data type for the new field. Click the Plus icon to add it to the object type.
  • Select the new field in the list and edit the properties on the right.

Adding Extracted Attributes (Aliases)

  • Find an attribute that you want to add:
    • To see which system attributes are available, start the yuuvis® RAD Services Admin at <servername>: 7273
    • Find extraction in the list and click Details.
    • Click the Service URL on the upper right to start the Swagger UI.
    • From the drop-down menu at the top, select extraction-api.
    • Click extraction-resource to expand the operations list.
    • Click POST /extraction/api/xmp.
    • Under Parameters and file, open a file.
    • Click Try it out! to start the extraction process. Once it is finished, the result is displayed below in JSON format. All keys shown here can be used as aliases in yuuvis® RAD designer. Choose one that you want to add.
  • Add a new alias:
    • In yuuvis® RAD designer, open Abstract object type > Photo by double-clicking it.
    • In the details view in the center, click Fields.
    • Add a new field by entering a technical name, display name and type and clicking the Plus icon.
    • Select the new field and, in the properties on the right, expand Type > Aliases.
    • Click the Plus icon next to Aliases.
    • In the field Namespace, enter extract.
    • In the field Name, enter the key of the attribute from the extraction service.
  • Add the new field to the user interface:
    • In yuuvis® RAD designer, open Object type > Photo by double-clicking it.
    • In the detail view in the center, click Form.
    • Find the new field in the list and add it to the form via drag and drop.
    • Deploy the scenario to your yuuvis® RAD system by right-clicking the project name and selecting Deploy.
    • Select a photo to verify if your new field is displayed correctly.

Adding New Elements to the Structure Tree

The structure tree shown in the photo album folder contains two main elements called Occasion and Keywords. The children of these top level nodes are the actual values that photo users assigned to their photos, i.e., the occasion descriptions and keywords stored in the index data of the photo documents.

To configure an additional top level element, proceed as follows:

  • Go to the documentation and copy one of the examples for the standard configuration of the structure tree, e.g.:

    {
    "title" : "Modification range",
    "title_locales" : {
      "de":"Bearbeitungszeitraum",
      "es":"Rango de modificación",
      "fr":"Plage de modification",
      "it":"Gamma di modifica",
      "pt":"Faixa de modificação",
      "ru":"Диапазон модификации",
      "zh":"修改範圍"
    },
    "key" : "ModifiedRange",
    "method" : "daterange",
    "field" : "modified"
  }

  • In yuuvis® RAD designer, open Object type > Photo album.

  • In the details view in the middle, click Structure tree.

  • At the end of the structure tree definition, insert a comma (,) after the last }.

  • Paste the copied code snippet between , and ].

  • Test the new structure tree with the structure testing tool as described in the documentation.

  • Save the project and deploy it to your yuuvis® RAD system by right-clicking the project name in the navigation tree on the left and selecting Deploy.

  • Open the Windows Task Manager (where the yuuvis® RAD system is running) and go to Details.

  • Look for the structure-service.exe task and end it. After a few seconds, it will be restarted by yuuvis® RAD service-manager. (This step will not be necessary for versions 4.7 or later)

  • In the client, open the Photo album or refresh by pressing F5.

Note: Before adding new photos, remember to log in to the client with a user with the role Photo Archive Usage.