Digizuite™ Mobile: Installation Instruction

Info

This process must be repeated every time the Digizuite Mobile App is updated

For this installation, no website is needed. Digizuite Mobile App is a self employed product that reflects the Digizuite Media Manager.

During the installation process there are changes applied to the DAM database. For this reason it is strongly recommended to back up the database for the DAM Center before proceeding with running the installation script.

Before you can use the Media Manager Mobile App, an installation script needs to be run towards the DAM Center.

For DAM Center releases later than than 5.3.0 (incl. 5.3.0)

Use this version for 5.3.2 and up:

Copy the zip installation folder from swinstall, into the server and unzip the file.

In the folder, there is a appsettings.json file which needs to have some data set:

{
    "Logging": {
        "LogLevel": {
            "Default": "Debug",
            "System": "Information",
            "Microsoft": "Information"
        }
    },
    "Upgrade": {
        "ConnectionString": "#{ConnectionString}",
        "RunGenerateSearchForAll": true,
        "ApiUrl": "#{ApiUrl}",
        "ApiUsername": "#{ApiUsername}",
        "ApiPassword": "#{ApiPassword}",
        "VersionGuid": "1356CC29-B3A4-E6CC-152A-FEE1504E0C34",
        "Availability": "74A5A102-A310-4BB7-9E84-0B14C36436B2",
        "Timeout": "00:30:00"
    }
}

Here is a description of all the configuration parameters:

Parameter nameDescription
ConnectionString

The database connection string. Must include the SQL server IP/Hostname, database name for the DAM Center, and the credentials of a SQL Server user with the rights to edit the given database.

Most of this information can be found in the Media Manager's corresponding appsettings.json file.

RunGenerateSearchForAll

Determines whether all Solr searches should be repopulated after the installation/update.

Default: true

ApiUrlThe URL to the DAM Center external API. Usually this would be the base URL of the DAM Center, with /dmm3bwsv3 added to the end.
ApiUsername

The high level user.

Default: System

ApiPasswordMD5 hash of the password for the user set in apiUsername. You will find this in the db members table.
VersionGuid

A unique key which refers to mobile. Don't change it, if it works. Otherwise, locate your Mobile GUID in Mobile's configManager.

Default: 1356CC29-B3A4-E6CC-152A-FEE1504E0C34

Availability

GUID of metadata field that controls publishing.

Default: 74A5A102-A310-4BB7-9E84-0B14C36436B2

Timeout

Maximum time (in seconds) to wait before timing out any request. If using runGenerateSearchForAll, the advised value is 1800.

Default: 1800

Once the config file is set up correctly and saved, run db-upgrade.exe. You may choose to run it by double clicking it, by calling it from the CMD prompt, or, if you want to retain the log, run it via PowerShell.

For DAM Center releases earlier than 5.3.0

The folder includes a "MediaManager.DbUpgrade" executable that is an all-in-one. You must specify a variety of configuration parameters in the accompanying MediaManager.DbUpgrade.exe.config file before running the executable script. 

The following is an example of a valid configuration:

<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <connectionStrings>
    <add name="db" connectionString="Server=localhost;Persist Security Info=False;MultipleActiveResultSets=False;Initial Catalog=customer_dam;User ID=admin_customer_dam;Password=admin_customer_dam"/>
  </connectionStrings>
  <appSettings>
    <!-- JobService GenerateSearchForAll -->
    <add key="runGenerateSearchForAll" value="true"/>
    <add key="apiUrl" value="http://customerdc.digizuite.com/dmm3bwsv3"/>
    <add key="apiUsername" value="System"/>
    <add key="apiPassword" value="#{dzApiPassword}"/>

    <!-- Standard/Required -->
    <add key="versionGuid" value="5021806d-157c-466d-b346-ba7bed246968"/>
    <add key="availability" value="74A5A102-A310-4BB7-9E84-0B14C36436B2"/>
    <add key="usingEmbeddedScripts" value="true"/>
    <add key="timeoutInSeconds" value="1800"/>
  </appSettings>
  <startup>
    <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.6.2"/>
  </startup>
</configuration>

Here is a description of all the configuration parameters:

Parameter nameDescription
connectionString

The database connection string. Must include the SQL server IP/Hostname, database name for the DAM Center, and the credentials of a SQL Server user with the rights to edit the given database.

Most of this information can be found in the Media Manager's DbUpgrade.exe.config file.

runGenerateSearchForAll

Determines whether all Solr searches should be repopulated after the install/update.

Default: true

apiUrlThe URL to the DAM Center's external API. Usually this would be the base URL of the DAM Center, with /dmm3bwsv3 added to the end.
apiUsername

The system user.

Default: System

apiPasswordMD5 hash of the password for the user set in apiUsername. You will find this in the db members table.
versionGuid

The Guid can be generated in e.g. https://www.guidgenerator.com/

Otherwise, the field can use the Media Manager version GUID from the DAM Center. 

More information can be found here: Where do I find this GUID?

availability

Guid of metadata field that controls publishing.

Default: 74A5A102-A310-4BB7-9E84-0B14C36436B2

usingEmbeddedScripts

Determines whether the executable uses the default embedded SQL scripts for the install, or if it looks for SQL scripts in the installer folder.

Default: true

timeoutInSeconds

Maximum time to wait before timing out any request. If using runGenerateSearchForAll, the advised value is 1800.

Default: 1800

Once the config file is set up correctly and saved, the next step is to simply run the MediaManager.DbUpgrade.exe file from the cmd prompt.

Note

There is a small possibility of the installer crashing due to a rare deadlock issue. If this happens, simply run the application one more time.

Modifying the configuration file

(1) Download the following file MobileAppConfiguration.json

(2) Edit the information in the file according to the following guidelines:

Parameter nameDescription

ApiUrl

The URL to the DAM Center's external API. It is formed by the base URL of the DAM Center and ending "/dmm3bwsv3/". Remember to include the character "/" at the end!

Example: https://demo3dc.digizuite.com/dmm3bwsv3/

MMUrl

The URL to the Media Manager's website.

Example: https://demo3mm5.digizuite.com/

VersionId

This is the current version ID of Digizuite Mobile's ConfigManager version to be used.

The easiest way to find it is by opening and logging in to your DAM Center, as demonstrated on the screenshot below:

Use "!" in front of the VersionId to set that specific version as the current one, and not any version available beneath.

Remember to include the character "/" at the end! 

SSOLoginMode

This line enables or disables the ability to log in through SSO.

Default: true

(3) Add the file to the root of the DC web folder