Skip to main content

Mediazel Installation Guide

Raise a support ticket

DISCLAIMER​

Any advice FYB provide in relation to setting up any FYB App, FYB Add-in, FYB Connector and or advice in relation to opening access to your on-premises or in-the-cloud systems will be general advice only. This means that the advice is of a general nature and will not consider your network setup, network infrastructure or any security requirements that you may have or in fact need. It is highly advised that you seek advice from internal or external providers to ensure that they are comfortable with what is required prior to going ahead with any deployment, setup, or configuration for external access.

LICENSE DETAILS​

Please contact FYB for a valid license if you are yet to obtain one for your App.

INSTALLATION COMPONENTS​

The following installation components are required to ensure the full functionality of the FYB Mediazel:

  • FYB Mediazel Web Application allows the display and upload of media items. This is a server-side installation
  • FYB Mediazel Adobe Connector (optional) allows connection between the below Adobe products and Mediazel (This is a client-side deployment)
    • InDesign (Id)
    • Illustrator (Ai)
    • Photoshop (Ps)

INSTALLING THE MEDIAZEL WEB APPLICATION​

LICENSE​

  1. Create a folder to house the license file (.lic) on the IIS Server
  2. Place the license file in this folder. You will be asked to enter this location during the installation

TRUSTED USER ACCOUNT​

Add the account that will run the application pool as a Trusted User Account in Enterprise Studio.

Please refer to your Enterprise Studio help file on adding trusted accounts.

If using a system account (application pool identity, network service etc) you will be required to enter the details as DOMAIN\ServerName$.

If using a dedicated Windows service account, you will be required to enter the details as DOMAIN\username

INSTALLATION​

Warning

Before running the MSI ensure that all prerequisites are complete. Including deploying the .NET 8 SDK and Hosting Bundle.

To deploy the Net Core SDK and Hosting Bundle to the server, follow these steps:

  1. Install the latest .NET 8 SDK (x64) found here

    2024-10-23_13-58-47.png

  2. Install the latest ASP.NET Core 8 Runtime Hosting Bundle found here

    2024-10-23_13-59-45.png

  3. Once both executables have been installed, complete a full server restart to allow for .NET 8 to bind to IIS. If a server restart is not possible an IIS reset can be completed with the following CMDs from an elevated command prompt.

    • net stop was /y
    • net start w3svc
    • iisreset
    Note

    To check that the SDK has been attached to the hosting bundle, open Command Prompt and type dotnet --info

    2024-06-21_15-06-23.png

    Note

    If you're using the installer to create a new Media record type then it will need to be run using a Content Manager administrator account.

Installation can be completed by running the MSI or using the command line arguments to prefill most data.

To install Mediazel, follow these steps:

  1. Unzip the ffmpeg.zip, ffplay.zip and ffprobe.zip files and place the extracted files in the same folder as the Mediazel msi

    2023-09-01_16-22-13.png

  2. Run the command prompt as an administrator and launch the fybmediazel.msi and click on the Next button

    image.png

  3. On the Web Application Settings screen select the HTTPS protected dedicated site to host the application and click on the Next button

    Note

    The virtual directory name must remain as Mediazel and it cannot be renamed.

    IIS Directory

    The application must be installed under the dedicated site as an application. It cannot be installed at the site level

    image.png

    image.png

  4. On the Application Pool Settings screen, enter the domain, username, and password for the Application Pool identity

  5. Click on the Next button

    App Pool Settings.jpg

    Note

    The account running the app pool will need access to Content Manager. At a minimum, it can be set to a Knowledge Worker account.

  6. On the configuration settings screen provide the required setting and click on the Next button

    2024-05-08_14-25-03.png

    IMPORTANT

    The workgroup server value should always be set to local.

    NAMEDESCRIPTION
    Dataset IDThe two alphanumeric character dataset identifier, for example: FD
    Workgroup ServerThis must be set to local for CM impersonation to function correctly
    Workgroup Server URLThis URL of the COntent Manager Workgroup Server
    Licence PathThe path to your license file including the .lic file. e.g., C:FYB Add-Ins\Licenses\mediazel.lic
    Temp PathA location for Mediazel to write and store temp data. Please include the trailing slash, for example: D:\Mediazel\Temp\
    Web Client URLThe URL of your Content Manager web client
  7. If your environment is configured to only allow OpenId authentication (e.g. Azure AD or ADFS) for your Content Manager, you'll receive the following message:

    image.png

  8. Click OK to navigate to the Open Id settings screen and enter the required values.

    2024-07-19_12-03-23.png

    Note

    If OpenID is not in use and you receive this page, these values should be left blank and can be skipped

    NAMEDESCRIPTION
    Client IdThe Client/App Id of the Open Id application used to secure Content Manager. For ADFS authentication, this will be the username of the Confidential Client app.
    Client SecretThe Client/App Secret of the Open Id application used to secure Content Manager. For ADFS authentication, this will be the password of the Confidential Client app.
    Trusted UserThe Network Login value of the Content Manager Confidential Client app location. For ADFS authentication, this will be the username of the Confidential Client app.
    Note

    Please refer to the below guides on how to configure the Confidential Client App and Trusted User:

  9. On the Record Type Settings Screen, if you already have an existing Record Type that you wish to use for Mediazel provide the URI into the URI field. Alternatively, select the Create New Record Type checkbox to create a new Record Type

    image.png

  10. On the Custom Setup screen select the install location and click on the Next button

image.png 10. From the Confirm Installation window click on the Install button

image.png 12. The installation process will commence

image.png 12. Once the installation is complete click on the Finish button

image.png

COMMAND-LINE ARGUMENTS​

Note

Use "" around values that contain special characters (non-alphanumeric characters)

ARGUMENTPURPOSE
WEBSITEThe Website that Mediazel will be installed under
VIRTUAL_DIR_VALNeeds to be set to MEDIAZEL
WEB_APP_POOL_IDENTITY_DOMAINSets the App Pool domain for the application pool
WEB_APP_POOL_IDENTITY_NAMESets the App Pool username for the account running the application pool
WEB_APP_POOL_IDENTITY_PWDSets the App Pool password for the account running the application pool
DBIDSets the Database ID that connects to the Content Manager dataset to run the application
WORKGROUP_SERVERSets the Workgroup Server Name that connects to the Content Manager dataset to run the application
WORKGROUP_SERVER_URLThis URL of the COntent Manager Workgroup Server
LICENSE_PATHSets the license that connects to the application
TEMP_PATHSets the temp path that connects to the application
WEB_CLIENTThe URL of your Content Manager web client
MEDIA_URIThe URI of the existing record type used for Mediazel
CREATE_RECORD_TYPE'1' to create a new record type for Mediazel
AUTHOR_MANDATORY'1' to make the Author field on the new record type mandatory
CONTAINER_MANDATORY'1' to make the Container field on the new record type mandatory
REPORT_URIThe record type URI for creating reports in Mediazel
CLIENT_IDThe Client/App Id of the Open Id application used to secure Content Manager. For ADFS authentication, this will be the username of the Confidential Client app.
CLIENT_SECRETThe Client/App Id of the Open Id application used to secure Content Manager. For ADFS authentication, this will be the password of the Confidential Client app.
TRUSTED_USERThe Network Login value of the Content Manager Confidential Client app location. For ADFS authentication, this will be the username of the Confidential Client app

FIELDS CREATED BY THE INSTALLER​

The following additional fields are created in Content Manager automatically by the installer if they do not already exist.

Note

The stock properties of Title and Container are mandatory for Mediazel functionality and must be present on the Media record type.

NameFormatIs SearchableMaximum Length
35mm focal lengthNumbertrue255
AlbumStringtrue255
AltitudeStringtrue255
ArtistStringtrue255
Audio Sample Rate (kHz)Numbertrue255
Bit DepthNumbertrue255
Bit Rate (kbps)Numbertrue255
CameraStringtrue255
Camera ModelStringtrue255
ChannelsNumbertrue255
Colour RepresentationStringtrue255
Compressed BitsNumbertrue255
CompressionStringtrue255
Contributing ArtistsStringtrue255
Data Rate (Kbps)Numbertrue255
Date Taken4true255
Exposure BiasStringtrue255
Exposure TimeStringtrue255
Exclude from MapsBooleantrueN/A
F-StopStringtrue255
FlashStringtrue255
Flash EnergyStringtrue255
Focal LengthStringtrue255
Frame HeightNumbertrue255
Frame Rate (fps)Numbertrue255
Frame WidthNumbertrue255
GenreStringtrue255
HeightNumbertrue255
Horizontal DPINumbertrue255
Image IDStringtrue255
ISO SpeedNumbertrue255
Item TypeStringtrue255
LengthStringtrue255
Max ApertureDecimaltrue12
Media FormatStringtrue50
Metering ModeStringtrue50
Resolution UnitNumbertrue255
Subject DistanceNumbertrue255
TagsTexttrue65536
Total Bitrate (kbps)Numbertrue65536
Vertical DPINumbertrue255
WidthNumbertrue255
YearNumbertrue255

CONFIGURATION​

After the installation process is complete, you will be able to locate the application installed within the site selected during installation.

  1. From the Features View double click on Authentication and ensure that only Windows Authentication is enabled

    image.png 2023-06-06_15-15-51.png

  2. Right-click the application in IIS and select explore

    app.jpg

  3. Right click the App_Data folder and select properties

    prop.jpg

  4. Navigate to the security tab and ensure users have read, write and modify permissions

    permiss.jpg

  5. Repeat step 4 for the Images folder within the Content folder

  6. Click on Application Pools

    image.png

  7. Within the application pool listing screen, right-click on Mediazel application pool and select the Advanced Settings option from the drop-down menu

    2025-09-15_11-30-26.png

  8. Within the Advanced Settings window, set Start Mode to AlwaysRunning, Idle Time-out Action to Suspend and Idle Time-out Action (minutes) to 0

    2021-07-23_14-21-09.jpg

  9. Click on the OK button

ADDITIONAL CONFIGURATION (OPTIONAL)​

If all the above steps have been completed, then the Mediazel will be installed and fully functional. However, there are a few additional items that can be configured to enhance/improve its features.

GIS STARTING POINT FOR MAPS​

You can set a default starting point for GPS Searches or when editing the GPS location of an existing item. This is done via User Options > GIS Settings

image.png Please ensure it uses the POINT(LATITUDE LONGITUDE) format otherwise the default location will appear blank and the map unusable.

Note

If the GPS coordinate is not set up, the default map of Australia will be used as the default coordinates.

image.png

ENABLING GOOGLE/MICROSOFT SERVICES​

IMPORTANT

Use at your own risk. Before using the Google or Microsoft Cloud Vision / Speech to Text / Maps services please note that the files will need to be shared with Google/Microsoft Cloud for analysis. We (FYB Pty Ltd) will not be liable and nor do we hold any responsibility for any privacy breaches or data damages because of using this feature.

Note

There is a 10 MB file upload limit when using Google Vision. This is a setting of Google and not a setting of Mediazel. If a file is greater than 10mb is uploaded with Goggle Vision then the upload can potentially fail.

Further information on these features can be found in the following articles:

GOOGLE VISION / SPEECH TO TEXT​

The Google Vision API allows images to be automatically tagged by detecting the content of the image.

A valid Google Vision API JSON key file is required for this feature to function. To obtain the JSON key file please follow the instructions at the following URL: https://cloud.google.com/vision/docs/setup

The Google Speech-to-Text API allows audio to be converted into a text format and captured against the record in CM, this will aid with audio searching. This is optional and not required for the Mediazel to function.

A valid Google Speech to Text API JSON key file is required for this feature to function. For a guide on how to obtain the JSON key file, click here.

Both keys can be set up at the same time if required and one JSON key file uploaded to Mediazel

Once the API key has been obtained transfer this to a secure location. Navigate to the Admin section of the Mediazel, under the Services Tab and upload your API Key

2023-06-06_15-23-01.png

GOOGLE MAPS API KEY​

The Google Maps API Key allows full functionality of Mediazel’s GPS searching abilities.

A valid Google MAP API key file with Places enabled is required for this feature to function. Instructions on obtaining the key can be found here: https://developers.google.com/maps/documentation/embed/get-api-key#get-the-api-key

Once the API key has been obtained transfer this to a secure location. Navigate to the Admin section of the Mediazel and input your API Key

2023-06-06_15-23-50.png

MICROSOFT SPEECH TO TEXT​

The Microsoft Speech-to-Text API allows audio to be converted into a text format and captured against the record in CM, this will aid with audio searching.

A valid Microsoft Speech to Text subscription key is required for this feature to function.

Once the subscription key has been obtained transfer this to a secure location. Navigate to the Admin section of the Mediazel and upload your subscription Key

2023-06-06_15-24-46.png

INSTALLING THE MEDIAZEL ADOBE CONNECTOR​

INSTALLATION​

Once you've installed the Mediazel web application, you will be able to install the Mediazel Adobe connector. To install the Mediazel Adobe connector on a client machine, please follow the steps below:

Note

Note this is an optional feature and not required for the Mediazel to function

Note

Ensure all Adobe products are closed before deploying the connector

  1. Run the command prompt as an administrator and launch the mediazel-adobe-xxx-64bit.msi and click the Next button

    2022-05-09_16-36-05.png

    Note

    There is no 32-bit version of the Adobe connector (only a 64-bit version). This is because Adobe products are always 64-bit.

  2. Enter the URL of the Mediazel web application ( example: https://server-name/mediazel) and click on the Next button

    2022-05-09_16-37-52.png

  3. On the Destination Folder screen click on the Next button

    Note

    Do not change the program files path

    2022-05-09_16-40-40.png

  4. Click on the Install button

    2022-05-09_16-42-52.png

  5. Once the installation is complete, click on the Finish button

    2022-05-09_16-52-21.png

INSTALLING CM LAUNCHER​

The FYB CM Launcher needs to be installed on each user’s machine. The CM Launcher is required to perform native functions on the user’s machine such as viewing a record link directly in CM.

Please refer to the CMLauncher Installation Guide to install CMLauncher.

UNINSTALLATION​

UNINSTALLING THE MEDIAZEL WEB APPLICATION​

To uninstall Mediazel please follow the steps below:

  1. Navigate to Control Panel

image.png 2. Click on uninstall a program option

image.png 3. Locate FYB Mediazel in the list of Programs and feature

image.png 4. Right-click on FYB Mediazel and click on the Uninstall button

image.png 5. If a warning Prompt appears, click on the Continue button

image.png 6. Click on the Yes button

image.png 7. The application will begin to uninstall

image.png 8. Once the uninstallation process is completed, Open IIS (Internet Information Services.) 9. Locate Mediazel in IIS, right click and click on the Remove button

image.png 10. When the prompt appears, click on the Yes button

image.png