CDM Server Installation

Certent CDM Network Topology

Before you install and configure CDM Server, it is important to understand the network topology it requires.

Users use the client interface of Certent CDM to work with reports and access financial data from various sources. The CDM Client communicates with data sources (for example, relational or Microsoft™ Excel files) through the CDM Server. OLAP data can be retrieved through the CDM database, or directly from an OLAP database environment.

CDM uses server processes to coordinate communication from an end user client to the database environment. Other components include administrator and end user client computers, and existing ERP systems.

Important:

There is no write-back from the database server to the data source.
For support information about third-party OLAP and relational database server applications such as Oracle Essbase and Microsoft SQL Server, consult the documentation provided by the software manufacturer. CDM documentation does not document aspects of these components beyond the minimal definitions required to perform specific configuration tasks.

Preinstallation Requirements

In addition to installing the server components, the CDM Server installation also creates a database and configures your web server.

To review an up-to-date list of environments supported by this version of CDM, such as operating systems, patches, browsers, web servers, directory servers, database servers, and application servers, reach out to Certent CDM Support.

The CDM application pool requires that you should have the Write and Delete permissions on your Windows Temp folder. Please check how the %temp% environment variable is set for your machine.

Install Microsoft .NET Framework

You need to install Microsoft™ .NET Framework 4.7.2, or a later version, on all CDM Server computers. You can go to the Microsoft download website and select the Runtime version of the latest .NET Framework to download and install the software.

Install Microsoft Visual C++ 2017 Redistributable

The CDM installer downloads and installs the Microsoft™ Visual C++ 2017 Redistributable Package version 14.10.25017 32-bit and 64-bit during the installation if you have not installed it. However, if you prefer, you download the Microsoft™ Visual C++ 2017 Redistributable Package from the Microsoft download website and install it before you install Certent CDM. You can also use a newer version. You need both the 32-bit and 64-bit versions.

You should install the Microsoft™ Visual C++ 2017 Redistributable Package on the CDM Server and Client computers.

Note: The Microsoft Visual C++ 2017 Redistributable Package is only needed for the CDM installer to run. It is not needed by CDM itself.

Install Microsoft Internet Information Services (IIS)

You must have Microsoft™ Internet Information Services (IIS) installed and running before you install Certent CDM.

Depending on the Windows™ Server version you have installed, there are different instructions to install IIS. Please refer to Microsoft documentation to install Internet Information Services.

Necessary Server Components

In the Select Role Services window, ensure you select the following role services if they are not already selected.

ASP.NET
Basic Authentication
Default Document
HTTP Errors
IIS Management Console
IIS Management Scripts and Tools
ISAPI Extensions
ISAPI Filters
.NET Extensibility
Request Filtering
Static Content

Install ASP.NET Core 8 Runtime Windows Hosting Bundle

You must have Microsoft .NET 8 installed and running before you install the CDM Server. Specifically, the Hosting Bundle must be installed on the CDM Server machine.

Go to the Microsoft .NET download page.
Download and install, at least, Hosting Bundle 8.0.11 (ASP.NET Core Runtime 8 - Windows Hosting Bundle installer).

Configure the Server Computer for Windows Authentication

You must ensure that the computer where you are going to install the CDM Server is configured to allow for Windows™ authentication.

The server computer must have the Windows authentication for Microsoft™ Internet Information Services (IIS) features installed before users can log in to the CDM Client using Windows authentication.

Click Start > Control Panel > Programs > > Turn Windows features on or off.
Navigate to Internet Information Services > World Wide Web Services > Security and ensure that Windows Authentication is enabled.

The server computer must also have the HTTP and Non-HTTP activation features installed.

Click Start > Control Panel > Programs > Programs and Features > Turn Windows features on or off.
Navigate to .NET Framework and ensure that both Windows Communication Foundation HTTP Activation and Windows Communication Foundation Non-HTTP Activation are enabled.
Ensure that http and net.tcp protocols are enabled in IIS for the CDM Server application:
1. Click Start > All Programs > Administrative Tools > Internet Information Services (IIS) Manager.
2. Navigate to the Certent CDM application.
3. Click Advanced Settings.
4. Under Behavior, ensure that http and net.tcp are both listed in the Enabled Protocols field.

Important: Ensure that port 808 (the default port) is opened for incoming connections.

Install CDM Server

After you ensure that you have the correct requirements, you can install the server software for CDM.

Ensure that Microsoft™ .NET Framework 4.7.2 (or later) is installed on your computer.

Ensure that the computer on which you are installing the CDM Server is connected to the Internet, so that the Microsoft™ Visual C++ 2017 Redistributable Package can be downloaded during the installation if not already installed.

If you want users to see Electronic Data Gathering, Analysis, and Retrieval (EDGAR) functionality in the user interface, you should also ensure EDGAR functionality is enabled in CDM.

Important: The CDM Server installer does not check if the selected path contains another CDM instance. It will overwrite the files in the directory without prompting you. The Administrator must verify that there are no other files located at the physical path of the CDM Server web application.

Launch .exe and Accept License Agreement

Extract the contents of the Server_installer.zip folder.
Double-click the CDM Setup.exe file to start the installation wizard.
If you do not have the Microsoft™ Visual C++ 2017 Redistributable Package installed on your computer, click Install to install these components.
Accept the license agreement and click Next.

Configure Setup Type

Select either the Typical or Custom setup type, depending on what features you want to install. If you select Typical installation, the wizard takes you to the Internet Information Services Settings window. If you want to install Filing, XBRL, or Electronic Data Gathering, Analysis, and Retrieval (EDGAR), you must select Custom to install those features.
Note: The Migration Tool is installed with Typical installation.
In the Custom Setup window, you can select whether you want to install the database or not. Expand the Core feature and select Database scripts if you would like to install the database.
Note: The database scripts are required for a normal CDM Server installer. However, they can be skipped only if a CDM web server installation is required to point to an already existing database created by a previous installation.
To install Filing, select this feature, and it will be installed on the local hard drive. Click Next.
The License Keys window opens and prompts you to enter your XBRL and EDGAR license keys. Enter the respective keys and click Next.

Internet Information Services Settings

In the Internet Information Services Settings window, you have the option of changing the name of the application pool, the name of the website, and the installation location of the CDM Server website. You can also set database properties by selecting the Also configure database parameters checkbox.

Database Server Settings

In the Database Server window, enter the following information:

In the Database Provider field, select Microsoft SQL Server as your database provider.
Enter the name of the server where your database server is running, for example, enter server_name. If you use multiple instances on your database server, enter server_name\instance_name.
Select the type of authentication for your database server and enter the credentials if required.
Enter a name for the CDM database.
Note: If a database with the same name exists on the database server, the database deployment tool will fail.
Enter an encryption key. Enter a string of characters. The value you enter as the encryption key is used to secure communication between the application server files and the database. The strength of the encryption key is determined by its length. For example, enter 1234.
Click Test Connection to ensure that the connection to the database is successful.
Select the Use existing empty database or databases checkbox if you want to use an existing empty database or databases. If an empty database cannot be found, the database deployment tool will fail. If you do not select this checkbox, the database deployment tool will create the database if it does not exist.
Select Use existing CDM database(s) if you already have a CDM database of an older CDM version and you would like to use that instead of a new, empty, database. The existing database will be upgraded to the new version.
Important: The database cannot be downgraded to the older version. You should back up any database before upgrade. For more information, see Upgrade Over an Existing Database.
Select the Install the Cache database separately checkbox if you would like the Cache database to be deployed in a separate database. Otherwise, its tables are going to be deployed in the same database as the CDM Core component under a different schema.
If you have selected XBRL to be installed, you will see the Install the XBRL database separately checkbox. Select this if you would like the XBRL database to be deployed in a separate database, otherwise, its tables are going to be deployed in the same database as the CDM Core component under a different schema.

Finish Installation

Click Next.
Click Install.
Click Finish to exit the installation wizard.

The server component is installed and the CDM database is created on your database server. An application pool named CertentCDMApplicationPool and a website application named Certent CDM Server are configured on your web server. By default, the installer creates one database with the name you provided, which will be the main CDM database. If you selected to install the cache separately, a new database will be created. This database appends Cache to the database name you provided. If you have selected XBRL to be installed, this will also, by default, be deployed into the main CDM database. If you want to install XBRL separately, a new database will also be deployed which appends XBRL to the database name you provided.

The server components are installed to the wwwroot directory of your Microsoft Internet Information Services (IIS) web server. For example, the components are installed to C:\inetpub\wwwroot\CertentCDM-Server. You must import your SSL certificate on your web server and enable SSL communication for CDM.

You must also install at least one client to access the server.

Upgrade CDM Server Over an Existing Database

You can deploy a new instance of the CDM Server over an existing CDM database, preserving configurations.

Prerequisite Steps

These are the steps that should be completed prior to an upgrade of the CDM application server.

Ensure all users are logged off of the CDM Server.
Make a backup of the CDM database(s). This is to ensure that a latest backup of the database is available.
Export the CDM encryption key using these steps:
1. Open a command prompt using the Run as administrator option.
2. Navigate to the encryption directory:
  CD C:\inetpub\wwwroot\CertentCDM-Server\Tools\EncryptionTool\
3. Run this command:
  Ibm.CognosDM.EncryptionTool /EMK/cfgfile:"C:\inetpub\wwwroot\CertentCDM-Server\Web.config"/o "C:\ExportedEncryptionKeyDec2019.txt"
Decrypt the ConnectionString.config and Credentials.config files with these steps:
1. Open a command prompt using the Run as administrator option.
2. Navigate to the encryption directory:
  CD C:\inetpub\wwwroot\CertentCDM-Server\Tools\EncryptionTool\
3. Run this command:
  Ibm.CognosDM.EncryptionTool.exe /DCF/cm:Ibm.CognosDM.Configuration.dll/sections:"connectionStrings,Credentials" /cfgfile:"C:\inetpub\wwwroot\CertentCDM-Server\Web.config"
Backup the entire CognosDM-Server or CertentCDM-Server directory in \inetpub\wwwroot\.
Go to Control Panel > Programs and Features and select IBM Cognos Disclosure Management or CertentCDM-Server, then right-click and select Change:
1. Click Next until you reach the list of features. Take a screen shot and save the file.
2. Click Next and take a screen shot of the Internet Information Services Settings. Save the file.
3. Click Next and take a screen shot of the Database Server settings. Save the file.
Tip: These screen shots will be useful during the upgrade, when prompted to select the features that are installed, setup the Internet Information service settings, and while configuring the Database Server.
Launch IIS on the CDM application server, then click Application Pool. Take a screen shot. The screen shot should include the application pool ID column as well.
Take a screen shot of the server if you want.
If the existing CDM version is 10.3 IF 27 or earlier, uninstall Arelle and NodeJS using the Control Panel and remove the folders from the path where these applications were installed.

Upgrade Procedure

Complete all prerequisites steps.
Note: You will be required to enter the password that was used when CDM was first installed in your environment for this upgrade. If you do not know this password, obtain a copy of the Get Encryption Key.zip file from Certent CDM Support if it is not included in the installation package. Copy this file to the CDM application server and extract. Run the GEK file included in the package and follow the instructions. You will be presented with the password in the Windows PowerShell window. Copy this password to a notepad file and save the password for later use. You can delete the file once the installation has completed. There is a readme file included with the package as well.
Go to Control Panel > Programs and Features and uninstall the existing Certent CDM installation.
Remove the CertentCDM-Server folder located in C:\inetpub\wwwroot\, excluding the copied folder. Remove the references to CDM in IIS (in effect, application pools, websites).
Right-click Ibm.CognosDM.InstallSetup or setup.exe from the Server folder of the installation package and select Run as administrator.
Select Install a new instance.
Select Accept on the agreement and click Next. The Setup Type page of the Certent CDM Server InstallSheild Wizard is displayed.
Select Custom and click Next. The Custom Setup page is displayed.
Select the features that were previously installed. Refer to the screen shots that were previously taken and saved during the steps in the Prerequisite section in this topic. Click Next. The Internet Information Services Settings page is displayed.
You can click Change to change the location path to the drive where the CDM application was previously installed. However, it is recommended to leave the application pool and application website as shown (default settings).
Click Next. The Database Server page is displayed.
For the database server details:
1. Select the Database Provider, Database server that you are installing to, and Connect using options (ensure you have DBO rights to the databases).
2. In the Name of database catalog field, use the same database name and settings that have been used in the previous IBM or Certent CDM installation and select the Use existing CDM database(s) checkbox to upgrade the existing IBM or Certent CDM database.
3. To set an encryption key for the catalog, the same encryption key should be used to avoid additional steps. If you do not know the encryption key, use the encryption key that was exported in the Prerequisite steps of this topic.
4. If the Cache or XBRL database(s), or both, have been deployed separately make sure the corresponding Use existing empty database or database and Install the Cache database separately checkboxes are also marked to ensure all databases are upgraded correctly.
You can click Test Connection to test the setup values you have entered.
Click Next to complete the installation.
Configure your IIS. Modify your CDM application pool ID to the ID determined in the prerequisites steps. If Windows Authentication or SSL, or both, were enabled, enable these in IIS too.
Perform an IIS reset and test CDM to ensure a successful connection is established. If the connection is successful, then proceed. If the connection fails, consult the CDM Knowledge Center for troubleshooting documents or contact CDM support by submitting a ticket at insightsoftware.com/support/product-support/.
Apply any manual configuration changes to the remaining config files, as these files have now been replaced with default settings (for example: section preview, reduce cell styles, idle timeout, and so on). If you are not sure which keys or parameters need to be modified, refer to your backup folder in the prerequisite section in this topic.
If you use XBRL, run the XBRL Dependencies utility included with the package.

Install CDM Server Using a Silent Installation

A silent installation is an installation that does not send messages to the console but instead stores messages and errors in log files. A silent installation can use response files for data input. You can use a silent installation to install the Certent CDM Server components.

Ensure that you have Microsoft™ .NET Framework 4.7.2 software installed on your computer.

Ensure that the computer on which you are installing the CDM Server is connected to the internet, so that the Microsoft™ Visual C++ 2017 Redistributable Package can be downloaded during the installation if not already installed.

Important: Ensure that all prerequisites are met. The silent installer will not enforce them.

Silent Installation Procedure

In Command Prompt, navigate to the setup.exe file location on the server.
Type the following command to start the installation:
start /wait "install" setup.exe /s /instance=16 /v"/qn ADDLOCAL=CORE,Database,XBRL,EDGAR,FILING,FILINGWIZ XBRL_LICENSE_KEY="" EDGAR_LICENSE_KEY="" IS_SQLSERVER_SERVER="" IS_SQLSERVER_DATABASE="" IS_SQLSERVER_AUTHENTICATION=1 IS_SQLSERVER_USERNAME=user IS_SQLSERVER_PASSWORD=password ENCRYPTIONKEY= CERTENTCDM_SERVER_IIS="" APP_POOL_NAME="" WEBSITE_NAME="" INSTALLDIR="" /l C:\install.log"

Important:
Ensure that there are no spaces in /v"/qn. If you use spaces in the value of INSTALLDIR, ensure that you use quotation marks around the value, appropriately escaped. For example:

setup.exe /s /v"/qn INSTALLDIR=\"C:\Program Files\CognosCDM Server\""

Parameter Details

Parameter	Description
`/instance`	The number of the CDM Server instance to be deployed. It will be visible in Programs and Features and must be different from existing instances. The value must be equal to n+1 where n is the largest instance number installed on that machine. For example, if you already have a CDM Server with Instance ID = 0 and Instance ID = 1, `/instance` must be 2. If you are trying to modify an installed instance, the instance ID must be the same as the instance you are trying to modify.
`ADDLOCAL`	Instructs the installer that all listed parts will be deployed locally, on the target machine, in the target location. There are five possible values: CORE - Deploys the CORE CDM Server. Database - Creates the database on the SQL server and adds all necessary parameters to it. If you are attempting to modify the installation to add additional components, this does not have to be mentioned. XBRL - Deploys the XBRL component. This includes the necessary database tables. EDGAR - Activates the EDGAR component. FILING - Deploys the Filing component. This includes the necessary database tables. FILINGWIZ - Deploys the SEC Filing Wizard module.
`XBRL_LICENSE_KEY`	Needs to contain the XBRL license key.
`EDGAR_LICENSE_KEY`	Needs to contain the EDGAR license key.
CERTENTCDM_SERVER_IIS	The location on the HDD where the CDM Server files are going to be copied.
`INSTALLDIR`	The location on the HDD where the licenses are going to be deployed. It is recommended to use the same as `CERTENTCDM_SERVER_IIS`.
`APP_POOL_NAME`	The name of the CDM Server application pool in the IIS.
`WEBSITE_NAME`	The name of the website in IIS.
`IS_SQLSERVER_SERVER`	The database server and instance, if required, for example, ServerName, ServerIP, or ServerName\InstanceName.
`IS_SQLSERVER_DATABASE`	The name of your CDM database. If the database does not exist, it will be created. If the database exists, the installer will try to update it.
`IS_SQLSERVER_AUTHENTICATION`	1 to instruct that the login to the SQL server will be performed using a native SQL user. `IS_SQLSERVER_USERNAME` - The native SQL user name to be used during database deployment. `IS_SQLSERVER_PASSWORD` - The password for the native SQL user used during database deployment. 0 to instruct that the login to the SQL server will be performed with the user currently logged into Windows and running the silent installation.
`ENCRYPTIONKEY`	The encryption key for the database. Enter a string of characters. The value you enter as the encryption key is used to secure communication between the application server files and the database. The strength of the encryption key is determined by its length. For example, type: setup.exe /s /v"/qn IS_SQLSERVER_SERVER=myserver IS_SQLSERVER_DATABASE=CognosDM IS_SQLSERVER_AUTHENTICATION=0 ENCRYPTIONKEY=1234"
`DEPLOY_ON_EMPTY_DATABASE`	Enter 1 if the deployment will target an empty database.
`SEPARATE_CACHE`	Enter 1 if the deployment will create the cache on a separate database or enter 0 if the cache will be installed on the same database.
`SEPARATE_XBRL`	Enter 1 if the deployment will create the XBRL on a separate database or enter 0 if the XBRL will be installed on the same database.

By default, the silent installation will perform a typical installation, which will only install CDM. If you would like Certent CDM XBRL, Electronic Data Gathering, Analysis, and Retrieval (EDGAR), the Filing component, or the SEC Filing Wizard module installed, you must add the following parameters:

ADDLOCAL=CORE,DATABASE,XBRL
Use this parameter to install both CDM and XBRL.
ADDLOCAL=CORE,DATABASE,EDGAR
Use this parameter to install both CDM and EDGAR.
ADDLOCAL=CORE,DATABASE,FILING
Use this parameter to install both CDM and FILING.
ADDLOCAL=CORE,DATABASE,FILINGWIZ
Use this parameter to install both CDM and FILINGWIZ.

The server component is installed and the CDM database is created on your database server. An application pool named CertentCDMApplicationPool and a website application named Certent CDM Server are configured on your web server. The installer creates two databases. One database uses the name that you provided, which will be the main CDM database. The other database appends the cache to the database name that you provided. If you selected XBRL to be installed, a third database will also be deployed and will store all XBRL data. The CDM Server components are installed to the wwwroot directory of your Microsoft Internet Information Services (IIS) web server. For example, the components are installed to C:\inetpub\wwwroot\CertentCDM-Server\. You must import your SSL certificate on your web server and enable SSL communication for CDM.

SSL Certificates

Certent CDM requires a secure socket layer (SSL) certificate to allow clients to access the server. You must install an SSL certificate on your web server, and then associate the certificate with your web server SSL port. You must also ensure that SSL is enabled for the CDM website application.

Important: Do not use a self-signed certificate in a production environment. Ensure that you are using an SSL certificate from a recognized certificate authority.

Import an SSL Certificate to IIS 8.0

You can import an SSL certificate for Certent CDM if you use Microsoft™ Internet Information Services (IIS) 8.0.

In the Internet Information Services (IIS) Manager console, under IIS:
1. Double-click Server Certificates.
2. Click Import.
3. Browse to and select the SSL certificate.
4. Enter the password for the certificate and click OK.
Under Sites, select the website where the Certent CDM Server virtual directory is located, for example, Default Web Site.
Click Bindings.
Select the https type and click Edit.
In the SSL certificate window, select the certificate you imported, and click OK.
Close the Site Bindings window.
Select the Certent CDM Server website application.
Double-click SSL Settings.
Ensure that Require SSL is selected, and select Ignore in the Client certificates section.
Click Apply.

Install the Microsoft ClickOnce Client Installer

The Microsoft™ ClickOnce client installer allows client users to install the Certent CDM desktop client from a server URL. Ensure that you have installed the CDM Server on your computer. Install the Microsoft ClickOnce client installer on the computer where you installed the CDM Server. For more information about Microsoft ClickOnce, go to the Microsoft Developer Network (MSDN) website.

ClickOnce Installation Procedure

Important: Due to the change from 32-bit to 64-bit of the CDM client, previously installed clients by ClickOnce will not be automatically upgraded upon start up. You must remove and redeploy the client.

Remove Certent CDM from Programs and Features.
Access the publishing server URL.
Click the Install button. Download and installation begins.
When finished, the CDM client is launched and a desktop shortcut is created.

The Microsoft ClickOnce server is installed to the wwwroot directory of your Microsoft Internet Information Services (IIS) web server. The ClickOnce client is installed to your temporary files location.

Log File Location for the CDM Server Components

The server components for Certent CDM are installed to the wwwroot directory of your Microsoft™ Internet Information Services (IIS) web server. For example, the components are installed to C:\inetpub\wwwroot\CertentCDM-Server.

Log files are in the LogFiles directory, for example, C:\inetpub\wwwroot\CertentCDM-Server\LogFiles.