KeyShot Dock

https://keyshot.atlassian.net/wiki/spaces/DD/
Admin
KeyShot Dock is a platform for managing and integrating KeyShot workflows, offering connections to...
Tokens:1,367,662
Snippets:6,246
Trust Score:10
Update:1 year ago
Show doc for...
Tokens:
Raw
### Example appsettings.json Configuration File

Source: https://keyshot.atlassian.net/wiki/spaces/DD/pages/1085603907/MM5.3

An example `appsettings.json` file demonstrating the structure and typical values for the MediaManager.DbUpgrade tool. This file must be correctly configured with environment-specific details before initiating the database upgrade process.

```JSON
{
    "Logging": {
        "LogLevel": {
            "Default": "Debug",
            "System": "Information",
            "Microsoft": "Information"
        }
    },
    "Upgrade": {
        "ConnectionString": "Server=172.18.3.32;Persist Security Info=False;MultipleActiveResultSets=False;Initial Catalog=mmdev_dam;User ID=admin_mmdev_dam;Password=admin_mmdev_dam",
        "RunGenerateSearchForAll": true,
        "ApiUrl": "https://dam.digizuite.com/dmm3bwsv3",
        "ApiUsername": "System",
        "ApiPassword": "a2ddc680310e876a61c5d4bd7e52663f",
        "VersionGuid": "0B59C5CF-E3A9-4043-AEDB-FCEAA4040D4C",
        "Availability": "74A5A102-A310-4BB7-9E84-0B14C36436B2",
        "Timeout": "00:30:00"
    }
}
```

--------------------------------

### Installation Configuration Variables

Source: https://keyshot.atlassian.net/wiki/spaces/DD/pages/1010238111/DC+5.3.0+2

This section outlines all configurable variables for the installation process, detailing their purpose, mandatory status, default values, and examples. These variables control various aspects of the installation, from database setup to web server configuration and service paths.

```APIDOC
InstallationVariables:
  # General Installation Settings
  NewInstallation:
    type: boolean
    mandatory: true
    default: $True
    example: $False
    description: Controls whether it is an update or a new installation (True = new installation, false = update).
  PreStagedDatabases:
    type: boolean
    mandatory: true
    default: $False
    example: $True
    description: Controls whether the installer should create the databases and user, if it is a new installation. Set this to True only if the databases has been pre stages.
  InstallDigiMonitor:
    type: boolean
    mandatory: true
    default: $True
    example: $True
    description: Boolean indicating if Digimonitor should be installed or not.
  # User Credentials
  Users:
    assetstreamUsername:
      type: string
      mandatory: true
      example: assetstream
      description: Username of the storage user.
    assetstreamPassword:
      type: string
      mandatory: true
      example: SuperSecretPassword
      description: Password of the storage user.
    digiadminUsername:
      type: string
      mandatory: true
      example: digiadmin
      description: Username of the administrative user.
    digiadminPassword:
      type: string
      mandatory: true
      example: SuperSecretPassword
      description: Password of the administrative user.
    useActiveDirectory:
      type: boolean
      mandatory: true
      default: $False
      example: $True
      description: Sets up the web site to require windows authentication. Do NOT set this to true on NewInstallations. Only use it on updates that are already setup for active directory.
  # Web Server Configuration
  Web:
    port:
      type: integer
      mandatory: true
      example: 443
      description: Port on which the web interface is installed in the IIS. Usually port 80 or 443.
    protocol:
      type: string
      mandatory: true
      example: https
      description: Protocol used for the web interface installed in the IIS. Typically http or https.
    siteUrl:
      type: string
      mandatory: true
      example: dam.company.com
      description: DNS for the web interface which is installed in the IIS.
  # Database Configuration
  Database:
    dbServerName:
      type: string
      mandatory: true
      example: sqlserver
      description: Used for the SQL server name.
    dbUsername:
      type: string
      mandatory: true
      example: sqluser
      description: User which has access to the database.
    dbPassword:
      type: string
      mandatory: true
      example: SuperSecretPassword
      description: Password of the database user.
    collation:
      type: string
      mandatory: true
      default: SQL_Latin1_General_CP1_CI_AS
      example: SQL_Latin1_General_CP1_CI_AS
      description: The database collation.
    CompatabilityLevel:
      type: integer
      mandatory: true
      default: 120
      example: 130
      description: Compatibility level of the database. Has to be either 120 or 130.
    dbName:
      type: string
      mandatory: true
      example: company_dam
      description: Name of the database to be installed/updated. It has to be called _dam in the end.
    DamdbPassword:
      type: string
      mandatory: false
      example: SuperSecretPassword
      description: Password for database DAM database user. If blank it defaults to: admin_{#dbName}.
    DamJobsdbPassword:
      type: string
      mandatory: false
      example: SuperSecretPassword
      description: Password for database DAM database user. If blank it defaults to: admin_{#dbName}_jobs.
    DamRecoveryModel:
      type: string
      mandatory: true
      default: SIMPLE
      example: FULL
      description: Defines what the recovery model of the DAM database should be.
    JobRecoveryModel:
      type: string
      mandatory: true
      default: SIMPLE
      example: FULL
      description: Defines what the recovery model of the DAM_jobs database should be.
  # Storage and Log Locations
  Locations:
    localStoragePath:
      type: string
      mandatory: true
      default: C:\Storage
      example: C:\Storage
      description: Local storage path. Only used if the storage is located on the web server. Leave as "C:\Storage" if Azure storage is used.
    uncStoragePath:
      type: string
      mandatory: false
      example: \\server\storage
      description: UNC storage path. If on the web server, the installer creates the share itself. If remote, then it has to exist.
    logRoot:
      type: string
      mandatory: true
      default: "C:\LogFiles\" + $siteUrl
      example: D:\logFile\dam.company.com
      description: Path on which the log files are written to.
    servicesFolder:
      type: string
      mandatory: true
      default: C:\Program Files\Digizuite\" + $siteUrl
      example: C:\Program Files\Digizuite\dam.company.com
      description: Path on which all the binaries of the services are placed.
    sitePath:
      type: string
      mandatory: true
      default: "C:\Webs\" + $siteUrl
      example: D:\Webs\dam.company.com
      description: Path on which the files for the web interface are placed.
  # Solr Search Engine Configuration
  Solr:
    installSolr:
      type: boolean
      mandatory: false
      default: $False
      example: $True
      description: True if Solr should be installed. Only able to install on web server.
    solrUrl:
      type: string
      mandatory: "True - if installSolr is True, else false"
      default: http://localhost:8983/solr/
      example: http://localhost:8983/solr/
      description: URL which Solr should use.
    solrLocalPath:
      type: string
      mandatory: "True - if installSolr is True, else false"
      default: C:\Services\SolrService
      example: C:\Services\SolrService
      description: Local path on which the Solr binaries are placed.
    solrUncPath:
      type: string
      mandatory: "True - if installSolr is True, else false"
      default: $solrLocalPath
      example: \\server\Services\SolrService
      description: UNC path on which the Solr binaries are placed.
  # SMTP Server Configuration
  SMTP:
    smtpUsername:
      type: string
      mandatory: false
      example: smtpuser
      description: Username of the SMTP user.
    smtpPassword:
      type: string
      mandatory: false
      example: SuperSecretPassword
      description: Password of the SMTP user.
    smtpFromEmail:
      type: string
      mandatory: false
      example: noreply@company.com
      description: E-mail which should be used to send from.
    smtpPort:
      type: integer
      mandatory: false
      default: 587
      example: 587
      description: Port used for the SMTP server.
    smtpServer:
      type: string
      mandatory: false
      example: smtp.company.com
      description: The SMTP server.
  # Licensing Information
  Licenses:
    licenseName:
      type: string
      mandatory: true
      example: Company
      description: The license holder name.
```

--------------------------------

### Example of a Configured appsettings.json File

Source: https://keyshot.atlassian.net/wiki/spaces/DD/pages/2793871861/CCC2

This JSON snippet provides a concrete example of a fully configured `appsettings.json` file, demonstrating how the `ConnectionString`, `ApiUrl`, `ApiUsername`, `ApiPassword`, and `VersionGuid` parameters would appear after customization for a specific installation.

```JSON
{
    "Logging": {
        "LogLevel": {
            "Default": "Debug",
            "System": "Information",
            "Microsoft": "Information"
        }
    },
    "Upgrade": {
        "ConnectionString": "Server=8.8.8.8;Database=company_dam;User Id=administrator;Password=evK3GFn9LQVpm;",
        "RunGenerateSearchForAll": true,
        "ApiUrl": "https://dam.company-site.net/dmm3bwsv3/",
        "ApiUsername": "System",
        "ApiPassword": "e6662662a3f90aa497566c9b4a32f2f7",
        "VersionGuid": "0827b547-5848-4d21-887e-b476820a812f",
        "Availability": "74A5A102-A310-4BB7-9E84-0B14C36436B2",
        "Timeout": "00:30:00"
    }
}
```

--------------------------------

### System Installation and Configuration Variables

Source: https://keyshot.atlassian.net/wiki/spaces/DD/pages/3463250226/DC+5

This section outlines all variables that can be configured for system installation and updates. Each variable entry includes its mandatory status, default value, example usage, and a detailed description of its function and any relevant notes.

```APIDOC
Installation Variables:
  General:
    NewInstallation:
      type: boolean
      mandatory: true
      default: "$True"
      example: "$False"
      description: "This variable controls whether it is an update or a new installation (True = new installation, false = update)"
    PreStagedDatabases:
      type: boolean
      mandatory: true
      default: "$False"
      example: "$True"
      description: "This variable controls whether the installer should create the databases and user if it is a new installation. Set this to True only if the databases have been pre-stages, see section"
  Users:
    assetstreamUsername:
      type: string
      mandatory: true
      example: "assetstream"
      note: "Removed In 5.6.1"
      description: "This variable is for the username of the storage user. See </wiki/spaces/DD/pages/1322483793>, section 2.1"
    assetstreamPassword:
      type: string
      mandatory: true
      example: "SuperSecretPassword"
      note: "Removed In 5.6.1"
      description: "This variable is for the password of the storage user."
    digiadminUsername:
      type: string
      mandatory: true
      example: "digiadmin"
      description: "This variable is for the username of the administrative user."
    digiadminPassword:
      type: string
      mandatory: true
      example: "SuperSecretPassword"
      note: "Removed In 5.6.1"
      description: "This variable is for the password of the administrative user"
    useActiveDirectory:
      type: boolean
      mandatory: true
      default: "$False"
      example: "$True"
      description: "This variable will setup the web site to require windows authentication. Do NOT set this to true on NewInstallations. Only use it on updates that are already set up for active directory."
  Web:
    port:
      type: integer
      mandatory: true
      example: "443"
      description: "This is the port on which the web interface is installed in the IIS. Usually port 80 or 443"
    protocol:
      type: string
      mandatory: true
      example: "https"
      description: "The protocol used for the web interface installed in the IIS. Typically HTTP or HTTPS"
    siteUrl:
      type: string
      mandatory: true
      example: "dam.company.com"
      description: "The DNS for the web interface which is installed in the IIS"
    CorsAllowOrigins:
      type: array<string>
      mandatory: true
      default: "@("$protocol://$siteurl")"
      example: "@("https://dam.company.com", "https://mm.company.com")"
      description: "A comma-separated list of allowed cors origins"
  Database:
    SqlServerWindowsLogin:
      type: boolean
      mandatory: true
      default: "$False"
      example: "$True"
      note: "Added in 5.6.1"
      description: "True: Use Integrated security in Master Connection String (Windows login) - Current user needs permissions in Db False: Use SQL Login"
    dbServerName:
      type: string
      mandatory: true
      example: "sqlserver"
      description: "This is used for the SQL server name"
    dbUsername:
      type: string
      mandatory: true
      example: "sqluser"
      description: "The user who has access to the database"
    dbPassword:
      type: string
      mandatory: true
      example: "SuperSecretPassword"
      description: "The password of the database user"
    collation:
      type: string
      mandatory: true
      default: "SQL_Latin1_General_CP1_CI_AS"
      example: "SQL_Latin1_General_CP1_CI_AS"
      description: "The database collation"
    dbName:
      type: string
      mandatory: true
      example: "company_dam"
      description: "The name of the database to be installed/updated. It has to be called *_dam*in the end."
    DamdbPassword:
      type: string
      mandatory: false
      example: "SuperSecretPassword"
      description: "Password for database DAM database user. If blank it defaults to: admin_{#dbName}"
    DamRecoveryModel:
      type: string
      mandatory: true
      default: "SIMPLE"
      example: "FULL"
      description: "This variable defines what the recovery model of the DAM database should be"
  Locations:
    localStoragePath:
      type: string
      mandatory: true
      default: "C:\\Storage"
      example: "C:\\Storage"
      description: "The local storage path. This is only used if the storage is located on the webserver. Leave as "C:\\Storage" if Azure storage is used"
    uncStoragePath:
      type: string
      mandatory: false
      example: "\\server\\storage"
      description: "The UNC storage path. If on the webserver, the installer creates the share itself. If remote, then it has to exist."
    SetStorageFilesystemRights:
      type: boolean
      mandatory: false
      default: "$True"
      example: "$true $false"
      note: "Removed in 5.6.1"
      description: "Allow disabling update of Storage FileSystemRights **IF DISABLED RIGHTS MUST BE HANDLED MANUALLY**"
    logRoot:
      type: string
      mandatory: true
      default: ""C:\\LogFiles\\" + $siteUrl"
      example: "D:\\logFile\\dam.company.com"
      description: "This is the path on which the log files are written to"
    servicesFolder:
      type: string
      mandatory: true
      default: "C:\\Services\\Digizuite"
      example: "C:\\Services\\Digizuite"
      description: "This is the path on which all the binaries of the services are placed."
    sitePath:
      type: string
      mandatory: true
      default: ""C:\\Webs\\" + $siteUrl"
      example: "D:\\Webs\\dam.company.com"
      description: "This is the path on which the files for the web interface are placed."
  Monitoring:
    LokiStorageFolder:
      type: string
      mandatory: true
      default: "`$($ServicesFolder)\\loki`"
      note: "Removed in 5.6.1"
      description: "The folder to install loki in. Logs are stored as part of this folder also."
    LokiHostName:
      type: string
      mandatory: true
      default: "`$env:ComputerName`"
      example: "10.0.0.5"
      description: "The hostname/ip-adress of the server that is hosting Loki. Usually it's the web server. If you have multiple web servers, you need to point to the same webserver on all machines."
  RabbitMQ:
    InstallRabbitMQ:
      type: boolean
      mandatory: true
      default: "$True"
      example: "$True $False"
      description: "Should RabbitMQ be installed"
    RabbitMQHost:
      type: string
      mandatory: true
      example: "dam.company.com"
      description: "The hostname of the RabbitMQ Server"
    RabbitMQUsername:
      type: string
      mandatory: true
      example: "[aRabbitMqUsername]"
      description: "Username for connecting to RabbitMQ Server Note: **guest is not allowed anymore**"
    RabbitMQPassword:
      type: string
      mandatory: true
      description: "Password for connecting to RabbitMQ Server"
    RabbitMQVirtualHost:
      type: string
      mandatory: true
      description: "VHost on RabbitMQ, normally set to dam database name, excluding _dam"
```

--------------------------------

### Digizuite DAM Center New Installation Parameters

Source: https://keyshot.atlassian.net/wiki/spaces/DD/pages/3463250226/DC+5

Key parameters for a new installation of Digizuite DAM Center, including settings for database creation and pre-staging. These parameters are crucial for initial setup.

```APIDOC
Variable: NewInstallation
  Value: $True
  Description: This has to be true on new installations, as otherwise databases won't be created

Variable: PrestagedDatabases
  Value: $True/$False
  Description: If databases and users have not been pre-staged (created), then set this to $False, $True otherwise. This is for installing without sysadmin rights

Variable: Azure parameters
  Value: (blank)
  Description: Leave them blank, if UNC storage is used
```

--------------------------------

### Example Media Manager DbUpgrade Configuration XML

Source: https://keyshot.atlassian.net/wiki/spaces/DD/pages/78208714/2+Installation+Upgrade+Process+-+MM+v4.10

An example `MediaManager.DbUpgrade.exe.config` file demonstrating the required structure and common parameters for configuring the Media Manager installation/upgrade process. This file sets database connection strings and various application settings like API URL, credentials, and version GUIDs, which are crucial for the `MediaManager.DbUpgrade.exe` executable.

```XML
<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <connectionStrings>
    <add name="db" connectionString="Server=8.8.8.8;Database=company_dam;User Id=administrator;Password=evK3GFn9LQVpm;"/>
  </connectionStrings>
  <appSettings>
    <!-- JobService GenerateSearchForAll -->
    <add key="runGenerateSearchForAll" value="true"/>
    <add key="apiUrl" value="https://dam.company-site.net/dmm3bwsv3/"/>
    <add key="apiUsername" value="System"/>
    <add key="apiPassword" value="e6662662a3f90aa497566c9b4a32f2f7"/>

    <!-- Standard/Required -->
    <add key="versionGuid" value="CD7179C0-260D-4E8C-9558-3540040749CE"/>
    <add key="availability" value="74A5A102-A310-4BB7-9E84-0B14C36436B2"/>
    <add key="usingEmbeddedScripts" value="true"/>
    <add key="timeoutInSeconds" value="1800"/>
  </appSettings>
</configuration>
```

--------------------------------

### DFS Installer Configuration Parameters Reference

Source: https://keyshot.atlassian.net/wiki/spaces/DD/pages/656212052/DFS+9.1

This section provides a detailed overview of all configurable parameters within the `DFS.Installer.exe.config` file. Each parameter's purpose, default value, and an example are described, guiding users on how to correctly populate the configuration.

```APIDOC
DFS.Installer.exe.config Parameters:
Connectionstring:
  Description: Parameter for the connection string to the DAM database
  Default: [Not applicable]
  Example: Data Source=yourserver;Initial Catalog=yourdb_dam;Persist Security Info=True;User ID=youruser;Password=yourpw;Connect Timeout=3
usingEmbeddedScripts:
  Description: Decides whether the embeded install scripts will be run or not. Usually this should be true
  Default: true
  Example: true
timeoutInSeconds:
  Description: Sets the timeout on execution time on the install scripts
  Default: 1800
  Example: 1800
DefaultPreviews:
  Description: Switch for whether DefaultPreviews should be setup or not (Setting this to true can result in a timeout in abnormally slow DC setups - this is the last thing the script executres, meaning that timeout only means that some default preview will not be in your DFS, which is a minor issue)
  Default: true
  Example: true
RunGenerateSearch:
  Description: Determines if the DFS related searches are repopulated. Set this to true on all updates and new install. Only set it to false, if you only want the sql changes.
  Default: false
  Example: false
ApiUrl:
  Description: The url for the DC's API
  Default: https://yoursite/dmm3bwsv3/
  Example: https://dam.digizuite.com/dmm3sv3/
UserName:
  Description: The username of a DAM user with admin rights
  Default: System
  Example: System
Password:
  Description: The user above's password in MD5 encoding (can be found in the Member table of the DAM database)
  Default: [Not applicable]
  Example: 4d85a9fe623b4d859db56a0c1360c8c8
VersionGuid:
  Description: If this is the first DFS installation you're doing (basically, you're not updating) do not change the default value. The guid for the root version of the DFS's Config Manager entry in the DC Config Manager (typically named Default). This can be found by navigating to System Tools → Config Manager → Digizuite™ DAM for Sitecore → Default and then pressing the menu icon in the top right side.
  Default: 8A66CD0F-2C41-4E18-A0A0-2C97143D3854
  Example: 8A66CD0F-2C41-4E18-A0A0-2C97143D3854
Availability:
  Description: If this is the first DFS installation you're doing (basically, you're not updating) do not change the default value. Guid of metadatafield that controls publishing.
  Default: 74A5A102-A310-4BB7-9E84-0B14C36436B2
  Example: 74A5A102-A310-4BB7-9E84-0B14C36436B2
```

--------------------------------

### Example MediaManager.DbUpgrade appsettings.json Configuration

Source: https://keyshot.atlassian.net/wiki/spaces/DD/pages/808648726/MM5.2

This JSON snippet illustrates the structure and typical content of the `appsettings.json` file required by the MediaManager.DbUpgrade tool. It includes essential settings for logging and the 'Upgrade' section, which contains parameters for database connectivity, API access, and search re-population, all of which must be customized for a specific deployment.

```JSON
{
    "Logging": {
        "LogLevel": {
            "Default": "Debug",
            "System": "Information",
            "Microsoft": "Information"
        }
    },
    "Upgrade": {
        "ConnectionString": "Server=172.18.3.32;Persist Security Info=False;MultipleActiveResultSets=False;Initial Catalog=mmdev_dam;User ID=admin_mmdev_dam;Password=admin_mmdev_dam",
        "RunGenerateSearchForAll": true,
        "ApiUrl": "https://dam.digizuite.com/dmm3bwsv3",
        "ApiUsername": "System",
        "ApiPassword": "a2ddc680310e876a61c5d4bd7e52663f",
        "VersionGuid": "0B59C5CF-E3A9-4043-AEDB-FCEAA4040D4C",
        "Availability": "74A5A102-A310-4BB7-9E84-0B14C36436B2",
        "Timeout": "00:30:00"
    }
}
```

--------------------------------

### System Configuration Variables Reference

Source: https://keyshot.atlassian.net/wiki/spaces/DD/pages/3580625290/DC+5

This section provides a comprehensive reference for all configurable variables used during system installation and updates. Each variable's purpose, mandatory status, default value, example usage, and specific notes are detailed.

```APIDOC
Configuration Variables:
  NewInstallation:
    Mandatory: True
    Default value: $True
    Example /options: $False
    Note: ""
    Description: This variable controls whether it is an update or a new installation (True = new installation, false = update)
  PreStagedDatabases:
    Mandatory: True
    Default value: $False
    Example /options: $True
    Note: ""
    Description: This variable controls whether the installer should create the databases and user if it is a new installation. Set this to True only if the databases have been pre-stages, see section
  Users:
    assetstreamUsername:
      Mandatory: True
      Default value: ""
      Example /options: assetstream
      Note: Removed In 5.6.1
      Description: This variable is for the username of the storage user. See </wiki/spaces/DD/pages/1322483793>, section 2.1
    assetstreamPassword:
      Mandatory: True
      Default value: ""
      Example /options: SuperSecretPassword
      Note: Removed In 5.6.1
      Description: This variable is for the password of the storage user.
    digiadminUsername:
      Mandatory: True
      Default value: ""
      Example /options: digiadmin
      Note: ""
      Description: This variable is for the username of the administrative user.
    digiadminPassword:
      Mandatory: True
      Default value: ""
      Example /options: SuperSecretPassword
      Note: Removed In 5.6.1
      Description: This variable is for the password of the administrative user
    useActiveDirectory:
      Mandatory: True
      Default value: $False
      Example /options: $True
      Note: ""
      Description: This variable will setup the web site to require windows authentication. Do NOT set this to true on NewInstallations. Only use it on updates that are already set up for active directory.
  Web:
    port:
      Mandatory: True
      Default value: ""
      Example /options: 443
      Note: ""
      Description: This is the port on which the web interface is installed in the IIS. Usually port 80 or 443
    protocol:
      Mandatory: True
      Default value: ""
      Example /options: https
      Note: ""
      Description: The protocol used for the web interface installed in the IIS. Typically HTTP or HTTPS
    siteUrl:
      Mandatory: True
      Default value: ""
      Example /options: dam.company.com
      Note: ""
      Description: The DNS for the web interface which is installed in the IIS
    CorsAllowOrigins:
      Mandatory: True
      Default value: @("$protocol://$siteurl")
      Example /options: @("https://dam.company.com", "https://mm.company.com")
      Note: ""
      Description: A comma-separated list of allowed cors origins
  Database:
    SqlServerWindowsLogin:
      Mandatory: True
      Default value: $False
      Example /options: $True
      Note: Added in 5.6.1
      Description: True: Use Integrated security in Master Connection String (Windows login) - Current user needs permissions in Db False: Use SQL Login
    dbServerName:
      Mandatory: True

```

--------------------------------

### Example appsettings.json Configuration for MediaManager.DbUpgrade

Source: https://keyshot.atlassian.net/wiki/spaces/DD/pages/3400794433/MM5

This JSON snippet provides a template for the `appsettings.json` file used by `MediaManager.DbUpgrade`. It includes logging settings and various upgrade-specific parameters such as database connection string, API details, and version GUIDs, which need to be customized for the specific installation.

```JSON
{
 "Logging": {
 "LogLevel": {
 "Default": "Debug",
 "System": "Information",
 "Microsoft": "Information"
 }
 },
 "Upgrade": {
 "ConnectionString": "Server=172.18.3.32;Persist Security Info=False;MultipleActiveResultSets=False;Initial Catalog=mmdev_dam;User ID=admin_mmdev_dam;Password=admin_mmdev_dam",
 "RunGenerateSearchForAll": true,
 "ApiUrl": "https://dam.digizuite.com/dmm3bwsv3",
 "ApiUsername": "System",
 "ApiPassword": "a2ddc680310e876a61c5d4bd7e52663f",
 "VersionGuid": "0B59C5CF-E3A9-4043-AEDB-FCEAA4040D4C",
 "Availability": "74A5A102-A310-4BB7-9E84-0B14C36436B2",
 "Timeout": "00:30:00"
 }
}
```

--------------------------------

### Digizuite DAM for Sitecore Configuration Parameters Reference

Source: https://keyshot.atlassian.net/wiki/spaces/DD/pages/819561233/DFS+9.3

Detailed reference for the essential configuration parameters required for connecting Sitecore to Digizuite DAM Center. This includes their purpose, default values, and examples to guide proper setup in a patched configuration file.

```APIDOC
Variable: BaseAddress
  Description: URL to your DC. It MUST end with a forward slash
  Default: https://[yourdam]/
  Example: https://dam.digizuite.dk/

Variable: Username
  Description: Username for the user to be used when synchronizing between Sitecore and your DAM
  Default: DAM for Sitecore
  Example: DAM for Sitecore

Variable: Password
  Description: Password for the user to be used when synchronizing between Sitecore and your DAM
  Default: sitecore
  Example: sitecore

Variable: ConfigVersionId
  Description: The ConfigVersionId of your DFS ConfigManager in your DC. It MUST have a "!" in front of it.
  Default: ![yourid]
  Example: !/5/
```

--------------------------------

### Example MediaManager.DbUpgrade appsettings.json Configuration

Source: https://keyshot.atlassian.net/wiki/spaces/DD/pages/1473642659/MM5

This JSON snippet illustrates the structure and typical values for the `appsettings.json` configuration file used by the MediaManager.DbUpgrade tool. It includes logging settings and critical upgrade parameters such as database connection details, API endpoints, and version identifiers.

```JSON
{
    "Logging": {
        "LogLevel": {
            "Default": "Debug",
            "System": "Information",
            "Microsoft": "Information"
        }
    },
    "Upgrade": {
        "ConnectionString": "Server=172.18.3.32;Persist Security Info=False;MultipleActiveResultSets=False;Initial Catalog=mmdev_dam;User ID=admin_mmdev_dam;Password=admin_mmdev_dam",
        "RunGenerateSearchForAll": true,
        "ApiUrl": "https://dam.digizuite.com/dmm3bwsv3",
        "ApiUsername": "System",
        "ApiPassword": "a2ddc680310e876a61c5d4bd7e52663f",
        "VersionGuid": "0B59C5CF-E3A9-4043-AEDB-FCEAA4040D4C",
        "Availability": "74A5A102-A310-4BB7-9E84-0B14C36436B2",
        "Timeout": "00:30:00"
    }
}
```

--------------------------------

### Digizuite DAM Sitecore Configuration Variables Reference

Source: https://keyshot.atlassian.net/wiki/spaces/DD/pages/623771788/DFS+9.1

Detailed documentation for the configuration variables used to establish the connection between Sitecore and Digizuite DAM. This includes their purpose, expected format, and example values to guide proper setup.

```APIDOC
Configuration Variables:
  BaseAddress:
    Description: URL to your DC. It MUST end with a forward slash.
    Type: string
    Example: https://dam.digizuite.dk/
  Username:
    Description: Username for the user to be used when synchronizing between Sitecore and your DAM.
    Type: string
    Example: DAM for Sitecore
  Password:
    Description: Password for the user to be used when synchronizing between Sitecore and your DAM.
    Type: string
    Example: sitecore
  ConfigVersionId:
    Description: The ConfigVersionId of your DFS ConfigManager in your DC. It MUST have a "!" in front of it.
    Type: string
    Example: !/5/
```

--------------------------------

### DFS.Installer.exe.config Parameter Reference

Source: https://keyshot.atlassian.net/wiki/spaces/DD/pages/712212646/DFS+9.2

This section provides a detailed reference for all configurable parameters within the `DFS.Installer.exe.config` file. Each parameter's purpose, default value, and an example are described, guiding users on how to customize the DFS installer's behavior and connectivity settings.

```APIDOC
Parameter: Connectionstring
  Description: Parameter for the connection string to the DAM database
  Default: [Not applicable]
  Example: Data Source=yourserver;Initial Catalog=yourdb_dam;Persist Security Info=True;User ID=youruser;Password=yourpw;Connect Timeout=3

Parameter: usingEmbeddedScripts
  Description: Decides whether the embeded install scripts will be run or not. Usually this should be true
  Default: true
  Example: true

Parameter: timeoutInSeconds
  Description: Sets the timeout on execution time on the install scripts
  Default: 1800
  Example: 1800

Parameter: DefaultPreviews
  Description: Switch for whether DefaultPreviews should be setup or not (Setting this to true can result in a timeout in abnormally slow DC setups - this is the last thing the script executres, meaning that timeout only means that some default preview will not be in your DFS, which is a minor issue)
  Default: true
  Example: true

Parameter: RunGenerateSearch
  Description: Determines if the DFS related searches are repopulated. Set this to true on all updates and new install. Only set it to false, if you only want the sql changes.
  Default: false
  Example: false

Parameter: ApiUrl
  Description: The url for the DC's API
  Default: https://yoursite/dmm3bwsv3/
  Example: https://dam.digizuite.com/dmm3bwsv3/

Parameter: UserName
  Description: The username of a DAM user with admin rights
  Default: System
  Example: System

Parameter: Password
  Description: The user above's password in MD5 encoding (can be found in the Member table of the DAM database)
  Default: [Not applicable]
  Example: 4d85a9fe623b4d859db56a0c1360c8c8

Parameter: VersionGuid
  Description: If this is the first DFS installation you're doing (basically, you're not updating) do not change the default value. The guid for the root version of the DFS's Config Manager entry in the DC Config Manager (typically named Default). This can be found by navigating to System Tools → Config Manager → Digizuite™ DAM for Sitecore → Default and then pressing the menu icon in the top right side.
  Default: 8A66CD0F-2C41-4E18-A0A0-2C97143D3854
  Example: 8A66CD0F-2C41-4E18-A0A0-2C97143D3854

Parameter: Availability
  Description: If this is the first DFS installation you're doing (basically, you're not updating) do not change the default value. Guid of metadatafield that controls publishing.
  Default: 74A5A102-A310-4BB7-9E84-0B14C36436B2
  Example: 74A5A102-A310-4BB7-9E84-0B14C36436B2
```

--------------------------------

### Digizuite DAM Center Installation Parameters

Source: https://keyshot.atlassian.net/wiki/spaces/DD/pages/3443982700/DC+5

Parameters required for a new installation of Digizuite DAM Center, including settings for database creation and pre-staging. These parameters control the initial setup and database configuration.

```APIDOC
Variable: NewInstallation
  Value: $True
  Description: This has to be true on new installations, as otherwise databases won't be created
Variable: PrestagedDatabases
  Value: $True/$False
  Description: If databases and users have not been pre-staged (created), then set this to $False, $True otherwise. This is for installing without sysadmin rights
Variable: Azure parameters
  Value: 
  Description: Leave them blank, if UNC storage is used
```

--------------------------------

### DFS.Installer.exe.config Parameter Reference

Source: https://keyshot.atlassian.net/wiki/spaces/DD/pages/656211969/DFS+9.0

This section provides a detailed reference for all configurable parameters within the `DFS.Installer.exe.config` file. Each entry describes the parameter's purpose, default value, and an example, guiding users on how to correctly configure their Digizuite™ DAM for Sitecore (DFS) installation.

```APIDOC
DFS.Installer.exe.config Parameters:
  Connectionstring:
    Description: Parameter for the connection string to the DAM database
    Default: [Not applicable]
    Example: Data Source=yourserver;Initial Catalog=yourdb_dam;Persist Security Info=True;User ID=youruser;Password=yourpw;Connect Timeout=3
  usingEmbeddedScripts:
    Description: Decides whether the embeded install scripts will be run or not. Usually this should be true
    Default: true
    Example: true
  timeoutInSeconds:
    Description: Sets the timeout on execution time on the install scripts
    Default: 1800
    Example: 1800
  DefaultPreviews:
    Description: Switch for whether DefaultPreviews should be setup or not (Setting this to true can result in a timeout in abnormally slow DC setups - this is the last thing the script executres, meaning that timeout only means that some default preview will not be in your DFS, which is a minor issue)
    Default: true
    Example: true
  RunGenerateSearch:
    Description: Determines if the DFS related searches are repopulated. Set this to true on all updates and new install. Only set it to false, if you only want the sql changes.
    Default: false
    Example: false
  ApiUrl:
    Description: The url for the DC's API
    Default: https://yoursite/dmm3bwsv3/
    Example: https://dam.digizuite.com/dmm3bwsv3/
  UserName:
    Description: The username of a DAM user with admin rights
    Default: System
    Example: System
  Password:
    Description: The user above's password in MD5 encoding (can be found in the Member table of the DAM database)
    Default: [Not applicable]
    Example: 4d85a9fe623b4d859db56a0c1360c8c8
  VersionGuid:
    Description: If this is the first DFS installation you're doing (basically, you're not updating) do not change the default value. The guid for the root version of the DFS's Config Manager entry in the DC Config Manager (typically named Default). This can be found by navigating to System Tools → Config Manager → Digizuite™ DAM for Sitecore → Default and then pressing the menu icon in the top right side.
    Default: 8A66CD0F-2C41-4E18-A0A0-2C97143D3854
    Example: 8A66CD0F-2C41-4E18-A0A0-2C97143D3854
  Availability:
    Description: If this is the first DFS installation you're doing (basically, you're not updating) do not change the default value. Guid of metadatafield that controls publishing.
    Default: 74A5A102-A310-4BB7-9E84-0B14C36436B2
    Example: 74A5A102-A310-4BB7-9E84-0B14C36436B2
```

--------------------------------

### Start Solr Example Instance (Initial Check)

Source: https://keyshot.atlassian.net/wiki/spaces/DD/pages/71532910/1+Installation+of+Solr+Search+-+DAM+v4.6

This command starts the default Solr example instance from the `SOLR_MAIN_DIR/example` directory. It's used to quickly verify that Solr can be launched successfully before proceeding with custom configurations.

```Command Prompt
Java –jar start.jar
```

--------------------------------

### DFS.Installer.exe.config XML Configuration Example

Source: https://keyshot.atlassian.net/wiki/spaces/DD/pages/3090253694/DFS+10.1

This XML snippet shows the structure of the `DFS.Installer.exe.config` file, including the startup runtime, database connection string, and various application settings. Users need to update the `value` attributes with their system-specific information.

```xml
<?xml version="1.0" encoding="utf-8"?>
<configuration>
 <startup>
 <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.6.2"/>
 </startup>
 <connectionStrings>
 <add name="db" connectionString="Server=yourserver;Database=yourdb_dam;User Id=youruser;Password=yourpw;"/>
 </connectionStrings>
 <appSettings>
 <!-- Standard/Required -->
 <add key="usingEmbeddedScripts" value="true"/>
 <add key="timeoutInSeconds" value="1800"/>
 <!-- Switch deciding whether to run Default Preview upload or not-->
 <add key="DefaultPreviews" value="true"/>
 <!-- Switch for generating searches -->
 <add key="RunGenerateSearch" value="false"/>
 <!-- Default preview parameters, ignore if DefaultPreviews = 0 -->
 <add key="ApiUrl" value="http://localhost/dev/dmm3bwsv3/"/>
 <add key="UserName" value="System"/>
 <add key="Password" value="af4dff332e1b93a7c7ce8eb02a4cd396"/>
 <!-- Usually these should not be changed. -->
 <add key="VersionGuid" value="8A66CD0F-2C41-4E18-A0A0-2C97143D3854"/>
 <add key="Availability" value="74A5A102-A310-4BB7-9E84-0B14C36436B2"/>
 </appSettings>
</configuration>
```

--------------------------------

### Start Solr Example Instance

Source: https://keyshot.atlassian.net/wiki/spaces/DD/pages/80424649/1+Installation+of+Solr+Search+-+DAM+v4.8

Command to start the Solr example instance from the `example` directory to verify basic functionality. This is a temporary test to ensure Solr is operational.

```Shell
Java –jar start.jar
```

--------------------------------

### Initial License and Azure Configuration Parameters

Source: https://keyshot.atlassian.net/wiki/spaces/DD/pages/667386057/DC5.0.0+2

Lists initial configuration parameters related to licenses for office and DAM connectors, and Azure storage account details for backend and frontend components.

```APIDOC
| licenseOffice | False |  | - | The license for the office connector |
| licenseDamForSitecore | False |  | - | The license for the Dam For Sitecore connector |
| *Azure* |  |  |  |  |
| azureStorageAccountBe | False |  | BackendStorageCompany | The storage account name of backend storage |
| azureAccessKeyBe | False |  | - | The access key for the backend storage |
| azureStorageAccountFe | False |  | FrontendStorageCompany | The storage acocunt name of frontend storage |
| azureAccessKeyFe | False |  | - | The access key for the frontend storage |
```

--------------------------------

### Verify Solr Start with Custom Home Directory

Source: https://keyshot.atlassian.net/wiki/spaces/DD/pages/667451835/DC5.0.0+4.5

This command starts the Solr server, explicitly setting the 'solr.solr.home' property to a custom directory. This is crucial for verifying the setup when Solr is configured to run from a specific service directory rather than the default example location.

```Shell
Java -Dsolr.solr.home=.. -jar start.jar
```
Tokens:
Raw