Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

3.1 Prerequisites

In order to install the Media Manager you need to take the following into account. Download the following Installation files for the latest Media Manager folder on SWinstall:

  1. DigiZuite Media Manager 4.x.x – include source.zip - This file contains the website and the setup for skinning and minification. Please see the separate guide on how to skin and minify.
  2. DigiZuite Media Manager DAM Center updates.zip - This includes a "MediaManager.DbUpgrade" executable that is an all-in-one installer for the DAM Center update. You must specify a SQL database connection string and the desired Digizuite™ Media Manager version Guid. 

Note: Before running this tool, make sure to back up your database.

To obtain the version Guid, log in to the Digizuite DAM Center and navigate to System Tools → ConfigManager → Digizuite™ Media Manager and select the active configuration. Then click Menu → Version Information and copy the VersionGuid value.

The connection string format and credentials must be delivered by your database administrator. You can either supply the values using the included .config file, or invoke the executable with parameters like this:

Where the first parameter is the connection string and the second is the version Guid.

After running the scripts (if any) you may configure the Digizuite™ Media Manager under the Config parameters in the ConfigManager.

3.2 Guest user access

The Digizuite™ Media Manager requires a backend user for accessing the API to collect configuration (required) and for ordinary guest user access (optional). Specify this user in the web.config file in the root website folder. Locate AppSettings guestUsername and guestPassword (md5) and enter credentials for a valid DAM user.

The guest user must belong to a group that defines the roles MediaPortal_User and MediaPortal_Collection. In standard Digizuite™ DAM Center there is already a user (Guest_be) and group (Contributor) for this.

Note: The guest user must be different from the social media user (product configuration).

Note: By default, the guest user has write access to assets in the Digizuite™ Media Manager. You can change this behavior by following these three steps:

  1. Navigate to System tools → Users and groups → Users. Select Guest_be and open the Editor. Access the Standard tab and remove the Contributor group.
  2. Navigate to System tools → Config Manager → Digizuite™ Media Manager. Right click on Digizuite™ Media Manager and select Edit folder rights. Give read access to Guest_be to all menus and submenus.
  3. Navigate to Channels → Digizuite™ Media Manager. Right click on Digizuite™ Media Manager and select Edit folder rights. Give read access to Guest_be to all menus and submenus.

3.3 Template user

The Digizuite™ Media Manager requires a backend template user that defines roles when creating new users from self-signup. This user must be set in the ConfigManager of the Digizuite™ Media Manager in parameter User Template for Self Signup users.

  • Create a new backend user - we recommend template_user
  • Put the new user in the "Contributor" group or alternatively another group with MediaPortal_Collection and MediaPortal_User roles.

Note: If using No verification sign up mode, make sure to check the Approved checkbox on the template user. Likewise, the checkbox should be left unchecked for the other verification configurations.

3.4 Template user for collection sharing

The Digizuite™ Media Manager requires a template user that defines roles when auto generating users for collection sharing. This user must be set in the ConfigManager of the Digizuite™ Media Manager in parameter Template for auto created collection users.

  • Create a new user - we recommend Social_media_user. However, notice that this is not for sharing towards social sites.

3.5 User for social sharing

If configured (Sharing enabled), the application offers social sharing of assets and collections. The system needs a specific backend user to define rights and roles for that material. The system generates a time limited access key (Access key timeout for social sharing) from that user and distributes that key in sharing links.

 By default, the system defines a user called Social_media_user which has very limited access. To edit this user, in Digizuite™ DAM Center, navigate to System tools → Local users and groups → Users and locate the Social_media_user.

Note: The social media user must have read access to the Digizuite™ Media Manager product (right-click ConfigManager → Digizuite™ Media Manager).

Note: The social media user must be different from the configured Guest user (web.config).

If configured (Embed code enabled), the application offers creation of embed code. The system needs a specific backend user to define rights and roles for that material. 

By default, the system defines a backend user called Guest_be which has very limited access.

3.7 Search

The search xml definitions under Digizuite™ Media Manager config must enable Solr usage.

If you should choose to change the metadata setup of the filtering functionality, you must ensure that all searches deliver the same filtering definitions.

In the ConfigManager, navigate to the Search tab and locate the Digizuite_System_Framework_Search definition.

  1. Enable Solr
  2. Save
  3. Start repopulating the search cache by clicking the gear icon of the search definition.

3.8 Filters

Filters inside Digizuite™ Media Manager are completely configurable based on the client's needs.

To add a new filter you have to:

  • Add the field in the search XML
  • Go to System tools → ConfigManager → Digizuite™ Media Manager and select the version to which you want to add a new filter. Select Searches tab and copy the search XML Digizuite_System_Framework_Search and edit it inside a text editor.

In the above screenshot, the search XML look like this:

<searchField id="sNotDownloadable" itemGuid="2772EDAC-1917-4106-AD6F-CB8891408DD5" operator="AND" valueHandler="Equals" visible="true" renderType="bool" />
<searchField id="sKeywords" itemGuid="6AFE78B7-3F24-49F3-BF95-24890EA62696" operator="AND" valueHandler="AllInList" visible="true" renderType="multicombo" />
<searchField id="sDateBetween" fieldName="asset.start_date" operator="AND" valueHandler="Between" visible="true" renderType="datebetween" />
<searchField id="sMenu" itemGuid="BF0AD1A6-984A-494E-A227-9D70C6A864F9" field="item_tree_valueid" operator="AND" valueHandler="InList" visible="true" renderType="tree" />
<searchField id="sAssetType" fieldName="asset.asset_type" operator="AND" valueHandler="InList" visible="true" renderType="assettype" />
  • The searchField will be treated as a filter if visible is set to true and has specified renderTypes. The following renderTypes are possible:
  • String – renders a standard input field
  • Combo –renders as a classic dropdown box
  • Tree –renders as a classic tree control
  • Multicombo – renders as a classic dropdown box with multiple selections possible
  • Bool – renders as a classic checkbox
  • Assettype – renders as a classic dropdown box with multiple selections possible
  • Datebetween – renders with 2 date pickers.

When finishing altering the search XML, copy the new version back inside ConfigManager. The same filters have to be copied to the following searches:

  • Digizuite_System_Framework_My_Favorites
  • Digizuite_System_Framework_My_Videos

Note: In order for the changes to be propagated, you will have to press Save and repopulate the search by pressing on the gear icon next to the title of the search.

  • Add a new label for the searchField
  • Navigate to System tools → ConfigManager → Digizuite™ Media Manager and make sure you select the active version. Navigate to the Labels tab and create a new label. The constant name should be the same as the ID of the searchField

3.9 Roles

The application defines roles that controls functionality in the Digizuite™ Media Manager. A role attaches to a backend user or user group. The following roles apply:

Role

Description

MediaPortal_User

Gives access to the application. Without this role, user will only be allow to access certain public previews (e.g. social media sharing).

MediaPortal_Collection

Gives access to collections view (right panel).

MediaPortal_Uploader

Allows user to upload new assets.

MediaPortal_Admin_StartScreen

Gives access to administer the splash screen.

MediaPortal_Asset_Replacer

Allows the user to replace or restore assets

MediaPortal_Asset_Unpublisher

Allows the user to remove(unpublish) assets

MediaPortal_Member_Viewer

Allows the user to see other members of the portal (e.g. during sharing process as autocompletion suggestions)


3.10 Download qualities

You can assign different download qualities to suit the company's solution. Navigate to System tools → Local users and groups → Groups and select Contributor. In the left panel it can be noticed that the information about the group has been loaded. Select Download qualities tab.

Make sure the desired qualities are present and they will automatically be available in the Digizuite™ Media Manager website.

3.11 SMTP setup

The Digizuite™ Media Manager uses SMTP functionality for various tasks like sharing links, notifications etc.

Navigate to System tools → Digizuite™ Configuration and locate the following constants:

  • SMTPDELIVERYMETHOD – configure the delivery method of the e-mail
  • SMTPPASSWORD – update with SMTP server password
  • SMTPPICKUPDIRECTORY – configure the pick-up directory of the e-mail
  • SMTPSERVER – update with SMTP server name
  • SMTPSERVERPORT – update with the SMTP server port
  • SMTPUSERNAME – update with the SMTP server username

Note: For detailed information on how to configure the e-mail feature, consult the DAM Center documentation.

3.12 Config parameters

Navigate to System Tools → Config → Digizuite™ Media Manager and select the correct version. Select the Config parameters tab where the following parameters apply:

  • Logo SD - Low-resolution logo used for mobile devices.
  • Logo HD - High-resolution logo used for tablet and desktop.
  • Splash screen image - Specifies the splash screen as an image.
  • Splash screen video - Specifies the splash screen as a video. On mobile or tablets only a video thumbnail is displayed.
  • Login (required field)
    • Login required: To access the site the user must login first.
    • Guest login - login possible: Access both with and without login.
    • Guest login – login not possible: Access only without login.
  • Default language (required field) - Controls the language that the site initially uses at startup (not set = English).
  • Portal languages (required field) - Controls the list of languages that the user can select in the site.
  • Portal title - Sets the text on the front page of the Media Manager.
  • Use profile image - Specifies if the profile image is visible.
  • Copyright text - Set the text at the bottom of the splash screen.
  • Copyright link - Set the URL link for the copyright text.
  • Portal menu (required field) - Specifies the metadata tree used for the site menu.
  • Player drawing - Reserved for future usage.
  • Player trim- Reserved for future usage.
  • Player frame stepper- Reserved for future usage.
  • Sharing enabled - Specifies if share options are available.
  • AddThis ID - Reserved for future usage.
  • Social media config - Supported share destinations: email|facebook|linkedin|twitter|googleSeparate with "|" (AddThis semantics).
  • Embed code enabled - Defines if embed code is available
  • Google Analytics tracking ID - Enables tracking asset previews towards Google Analytics. If not set, tracking is disabled.
  • Sorting types (required field) - Specifies which sorting capabilities the site offers.
  • Default sorting (required field) - Sets the default sorting.
  • First year- Reserved for future usage.
  • Paging mode (required field) - Set if the asset list views uses infinite scrolling or fixed page sizes.
  • Dropbox API key - Enables Dropbox integration in upload. Not set = disabled.
  • Microsoft OneDrive client ID - Enables OneDrive integration in upload. Not set = disabled.
  • Google Drive API key - Google Drive client IDEnables Google Drive integration in upload. Not set = disabled.
  • Main search folder (required field) - References the root channel folder for search engines. Typically, this would not include profile images and the likes.
  • Keywords (required field) - Set the metadata field to use for keywords.
  • Portal folder (required field) - References the root channel folder. Typically, this would be the top folder of the channel (all channel data).
  • Google Analytics service account email.
  • Google Analytics View Id - Enables statistics previews per asset in the site. Not set = disabled.
  • Google reCaptcha public key - Enables captcha functionality in signup. Not set = disabled. 
    • Note: To enable, you also need to open the <WebsiteFolder>\Web.Config file in a text editor, uncomment the captcha section and specify both the privateKey and publicKey attributes. You also need to access your (free) Google Recaptcha administration page and add the Media Manager site DNS.
  • Google reCaptcha private key - Reserved for future usage.
  • Verification when creating new member (required field) - Sets the verification when a new member signs up.
  • Administrative verification emails - Sets the email receivers (semicolon separated) for the admin verification option in the configuration Verification when creating new member.
  • Forgot password - Sets if user should have the option of requesting a password reset email.
  • Asset metadata expanded - Reserved for future usage.
  • Member roles root ID - Reserved for future usage.
  • Metafields required when uploading - Reserved for future usage.
  • Extra upload required fields - Reserved for future usage.
  • Download destination - Specifies ZIP files destination when sharing assets or collections.
  • Color spaces (required field) - Specifies the list of color spaces that the users can choose when downloading images.
  • Image formats (required field if using images) - Specifies the list of image formats that the users can choose when downloading images.
  • Frontend destination - Reserved for future usage.
  • Video embed sizes (required field if using video) - Chooses the available sizes for video embed links.
  • Video embed qualities (required field if using video) - Chooses the available quality for video embed links.
  • Folder ID for autocreated users - Here you can direct new auto created users to a specific user folder.See "Template for auto created collection users".
  • Template for autocreated users (required field) - Specifies the user template that ensures that when sharing collections for non-social purposes (e.g. email), new users gets the correct access (roles, security)
    • Note: See section Template user for collection sharing.
  • Access key timeout for internal and email sharing (seconds, required field) - Specifies the timeout associated with access keys generated for social sharing.
  • Language dependent metadata fields - Defines what fields should be language dependent; typically these are title and description.
  • Apply read access to shared assets for internal users - Specifies that read access is applied when sharing assets for internal users.
  • Apply read access to shared assets for external users - Specifies that read access is applied when sharing assets for external users.
  • User for social sharing (required field if sharing enabled) - Specifies the user, which defines access keys for links in social sharing. 
    • Note: See section User for social sharing.
  • External users - Used to differentiate users so that certain users do not obtain read access to shared assets.
  • Sharing with new users - Reserved for future usage.
  • Access key timeout for social sharing (seconds, required field if sharing enabled) - Specifies the timeout associated with access keys generated for social sharing.
  • Apply read access to assets when sharing to social sites - Specifies that read access are be applied when sharing assets for social sites.
  • Apply write access to shared collections (not social sites) - Specifies that write access are be applied when sharing collections internally or by email.
  • Fail upload if no response received after (seconds) - Use higher values for slow or faulty connections.
  • User for embed code links - Set the user that defines access to embedded links.
  • Maximum result set before skipping Solr facet - Used to optimize search response time in very large installations.
  • Enable source path copy to clipboard - Usage in other applications will require source path access.
  • User groups assigned to new users (required field) - Specifies what user groups new user will be designated.
  • Enable sign up - Specifies that users can sign up for site access.
  • User Template for Self Signup users (required field) - Specifies the user template that ensures that new users gets the correct access (roles, security).
    • Note: See section Template user.
  • Show uploader name - Specifies to show the name of the uploader. Disabling this will hide the uploader name from all the instances of the asset manager and from the asset preview metadata.
  • Automatically show asset info in preview - Specifies to show asset information automatically in asset preview. Enabling this will cause the asset preview to automatically open the metadata info section.
  • Show overlay over asset after upload - Specifies how many seconds should the overlay be present over the thumbnail of an asset, after the upload was completed. This only applies to upload task manager view.
  • SolrSortType (required field) - Specifies the order in which to sort the facet results from filter. 
    • Possible options: 
      • count – by the number of occurrences 
      • index – alphabetically.
  • Wintra Tracking Base URL - If specified, it will enable Wintra Analytics.
    • Note: the URL needs to be entered in a protocol relative format(without 'http:' or 'https:' in it).
  • Intro Screen - Specified the type of intro screen the application will render. 
    • Possible options:
      • None – no intro screen will be rendered
      • Splashscreen - enables splash screen functionality. If you specify both video and image, video splash screen takes precedence over image on desktop. On mobile and tablets the image selection takes precedence over video thumbnail.
      • Disclaimer – enables disclaimer as intro screen. The style (layout and colors) are inherited from the splash screen. You want to edit the language labels "LBL_MP_DISCLAIMER_BADGE_LINK" and "LBL_MP_DISCLAIMER_BADGE_TEXT" for all your active languages.

3.13 Meta tags (SEO)

You can control the http meta tags (name, content pair) that the default page renders. Notice that this is only for global entry level tagging. More granular content specific SEO control will be available in a later release.

You may specify any number of meta tags that will be automatically rendered in the page. However, take a notice on SEO best practices as having vast amount of tags might turn out to be counterintuitive.

The system is pre-configured with some common meta tags that you probably want to edit to match the usage of the Digizuite™ Media Manager.

3.14 Mail templates

The application defines mail templates for sending out emails like confirmation and download links. You may change these to fit your organization.

Navigate to System Tools → ConfigManager → Digizuite™ Media Manager and select the correct version. Select the Config parameters tab and Mail templates section.

3.15 Facet Search Configuration

The application allows the configuration of the results obtain from a faceted search.

3.15.1 Facet Result Sorting Order

To configure the order of the facet results, navigate to System Tools → ConfigManager → Digizuite™ Media Manager and select the correct version. Select the Config parameters tab and change the following configuration:

  • SolrSortType 
    • Possible options: 
      • count – by the number of occurrences 
      • index – alphabetically.

3.15.2 Facet Result Limit

To configure the limit of the facet results, open the folder <WebsiteFolder> and find the file web.config. Open it in a text editor, find the appSettings group and add or change the following configuration key:

<add key="solrSearchLimit" value="{value}" />

Replace {value} with an integer representing the number of results you want to limit the facet search to. Use -1 in order to disable the limit.

Note: If the key does not exist or it doesn't have a value, the default value of 100 will be used.

Note: In version 4.7.0 and earlier, the key configuration was misspelled as sorlSearchLimit. As of 4.8.0, the typo is fixed. In order to insure backwards compatibility, the code will check the value of sorlSearchLimit, in case solrSearchLimit is not defined. It is strongly recommended that in installations of 4.8.0 or later to use the correctly spelled key name.

Table of Contents

  • No labels