Professional Documents
Culture Documents
Installation and Upgrade Guide
Installation and Upgrade Guide
1 Release-Specific Information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
2 Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
2.1 Hardware and Software Requirements in SAP Disclosure Management. . . . . . . . . . . . . . . . . . . . . . . 8
2.2 SAP Notes for the Installation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
9 Troubleshooting. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
9.1 Known Issues. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
9.2 Usage of the Install Tool. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
9.3 Database Connection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
9.4 SAP Support. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
This chapter contains information about release-specific deviations from the standard installation. In case of
update and installation issues, see Known Issues [page 113]. For general information about DM stacks, see
Choosing the Right DM Stack [page 10].
DM Stack 1100
With DM Stack 1100, the default link to the online help has changed. The setting Root folder for the webhelp in
Administration System configuration Misc is overwritten with the new URL as part of an update of DM
SERVER – APPL SERVER 10.1 to DM Stack 1100.You must reajust the URL after completing all other update
steps.
Hence, it is highly recommended that you skip DM Stack 900 and update via DM Stack 900R instead.
• DM Stack 802
• DM Stack 803
You cannot update from DM Stack 800. If you are on DM Stack 800, update to DM Stack 802 first, then to DM
Stack 900R.
When you import transport packages from earlier releases, DM Stack 900(R) expects dates to be expressed
in this format. Hence, transport packages created earlier have to be adjusted manually to match the ODBC
timestamp format if they contain date fields.
DM Stack 800
DM Stack 600
This guide provides information about the installation of the SAP Disclosure Management components, that is,
the server component, the client component, and BW connector.
The SAP Disclosure Management client is a COM add-in in Microsoft Excel, Microsoft Word, and Microsoft
PowerPoint. After the installation of the SAP Disclosure Management componets, the Microsoft Office
applications display a ribbon that allows easy access to SAP Disclosure Management features.
The SAP Disclosure Management BW connector is used to extract data from an SAP BW system.
Note
The BW connector uses standard SAP BW and SAP NetWeaver functionality. The application uses the SAP
ABAP environment and the ABAP-based Web Service Infrastructure of SAP NetWeaver.
• Consultants
• Technical consultants
• IT administrators
SAP Disclosure Management has two product versions, which include a large number of component versions:
Note
For a list of the software and hardware requirements for SAP Disclosure Management 10.1 and SAP
Disclosure Management XBRL reporting add-ons 1.0, see the SAP Disclosure Management 10.1 Product
Availability Matrix (PAM). The Product Availability - Essentials PowerPoint presentation also contains
information for getting started and can be found under General Information Details and Dates
Essential Information in the section Introducing SAP Disclosure Management.
When you prepare the list of the software component versions you want to use, it is important to understand
the hardware and software requirements to run this combination of software component versions.
You can find more information in the Product Availability Matrices of SAP Disclosure Management and
SAP Disclosure Management, XBRL reporting add-ons, supplemented by the Product Availability - Essentials
presentation, in the sections Software Requirements and Hardware Requirements.
Both product versions, SAP DISCLOSURE MGMT. 10.1 and DISCLOSURE MGM XBRL ADD-IN 1.0,
are maintained via various types of deliveries that are described in the Product Availability - Essentials
presentation, section Product Versions and Releases. One of the main delivery types is the support package,
which is a planned subrelease of a software component version. Support packages for the different software
component versions of a product version that, according to SAP’s testing results, work together on one
system are called support package stacks. All available support package stacks are documented in SAP Note
2138656 . Choose a support package stack that meets your requirements. Unless indicated otherwise, we
recommend that you use the latest available support package stack.
Plese read the following SAP Notes carefully before you start the installation. These SAP Notes contain the
most recent information on the installation, as well as corrections to the installation documentation.
Please make sure that you have an up-to-date version of all SAP Notes, which you can find at https://
support.sap.com/notes .
2672792 DM Stack 1300 Release Note Information about new and changed
features
1566421 Installing DISCMLG on SAP NetWeaver Description for installing add-on for
7.0 (BI 7.1) SAP NetWeaver
Troubleshooting
Miscellaneous Notes
2084486 EBA and EIOPA supervisory reporting Information on product versions and
overview licensing, taxonomy support, support
of individual national requirements,
and information on supervisory
reporting according to EBA and EIOPA
SAP Disclosure Management consist of two product versions containing a large number of components:
• SAP Disclosure Management 10.1 (technical name: SAP DISCLOSURE MGMT. 10.1)
• SAP Disclosure Management, XBRL reporting add-ons 1.0 (technical name: DISCLOSURE MGM XBRL
ADD-IN 1.0)
Depending on the scenario(s) you want to cover with SAP Disclosure Management, you need to make a
decision about the required components. The product availability matrix can help you make such decision.
Please read the presentation under Essential Information.
DM Stacks are working combinations of versions for all DM Components. The DM stacks note 2138656 lists
all DM stacks and provides basic information about this.
The same note refers to release notes for each DM stack. They provide information about enhancements,
corrections, legal change support, and bug fixes.
Please check if the latest DM stack meets your requirements. Unless otherwise indicated, it is strongly
recommended that you use the latest available DM stack.
Note
If you opt for a different DM stack than the one covered by this guide, search for the guide that covers your
target DM stack on the SAP Help Portal at https://help.sap.com.
To install your target DM stack, it is important to understand which components allow you to start with which
version. Depending on the component, one or more of the following installation paths are supported:
The following table shows which components supports which installations from scratch:
Mandatory You must install all DM stacks You must install all DM stacks
DM Application Server*
ending with 00 between your ending with 00 between your
lower than stack 1000
current version and the tar current version and the tar
get version. ** get version. **
Mandatory You must only install the tar You must only install the tar
DM Application Server*
get version. get version.
as of stack 1000
• DM Client Mandatory (must match the You must install previous ver You must install previous ver
Application Server version) sions. sions.
• DM Task Engine
• DM XBRL Engine
• DM XBRL Mapper
tion
Apply all patches and all
correction notes valid for
the latest patch
tion
Apply all patches and all
correction notes valid for
the latest patch
DM CONNECTOR NW BI Mandatory
7.31 - 7.50
Recommenda
tion
Apply all patches and all
correction notes valid for
the latest patch
If you want to update DM SERVER – APPL SERVER 10.1 on a Microsoft Windows Server machine without
Microsoft SQL Server Management Studio, install the following software components:
To simplify update efforts and avoid manual steps, DM stack 900 has been replaced with DM stack 900R,
which covers built-in solutions for a list of issues that could occur with DM stack 900. Hence, it is highly
recommended to skip DM stack 900 and update to DM stack 900R instead.
Only in case you have already or accidentally updated to DM stack 900 instead of DM stack 900R: implement
the following SAP Notes as part of the update of DM SERVER – APPL SERVER 10.1 right after the step
Enable Database Access:
• 2473211
• 2473157
• 2472900
• 2553129
• 2536768
• 2552409
Caution
You can't update from DM stack 800. If you are on DM stack 800, update to DM stack 802 first, then to DM
stack 900R.
1. If you want to update from stack 403 to stack 1202, you must install the following stacks in this order:
• Stack 500
• Stack 600
• Stack 700
• Stack 800
• Stack 802
• Stack 900R
• Stack 1000
• Stack 1202
2. Uninstall previous versions of DM Client, DM Task Engine, DM XBRL Engine, DM XBRL Mapper and
install the latest available version between stack 1200 and stack 1202.
As of DM Stack 902, you can use DM Stacks table (from SAP Note 2138656 ) to find all new downloads of
a DM Stack in SAP Software Downloads (https://launchpad.support.sap.com/#/softwarecenter ). Click the
link at the top of the column listing the target DM Stack.
Note
SAP Software Downloads provides files in two general areas, Installations and Upgrades and Support Packages
and Patches:
Recommendation
SAP DISCLOSURE MGMT. 10.1 Installations and Upgrades Support Packages and Patches
DISCLOSURE MGM XBRL ADD-IN Installations and Upgrades Support Packages and Patches
1.0
Note
For the following components, select WINDOWS ON X64 64BIT from the dropdown list once you have
reached the list of downloads:
1. Arelle
Download Arelle version 2016-11-22 or the latest version from http://arelle.org/download/ .
Caution
Caution
Do not download the installation files from the Fujitsue Web site, as these are part of a demo version
without license key.
If you want to install DM SERVER – APPL SERVER 10.1 on a Microsoft Windows Server machine without
Microsoft SQL Server Management Studio, you must download the following software components from the
Microsoft website and install them on the server:
Note
Even with Microsoft SQL Server Management Studio installed, the above components may have not been
installed.
1. Copy the setup executable to the desktop of the destination server and run it with administrative Microsoft
Windows permissions.
2. The setup wizard checks the following software requirements:
If the result is negative, see Hardware and Software Requirements in SAP Disclosure Management [page 8]
and solve any remaining issues.
You enable the DM setup wizard to connect to the target database with a working authentication.
1. In Microsoft SQL Server Management Studio, log on to the target database with a user with administrative
permissions. The user credentials and the hostname of the database server are required for the next step.
In the Server Properties, ensure that in server authentication "SQL Server and Windows Authentication
mode" is selected.
2. In the DM setup wizard, select the Microsoft SQL Server as the database server to be used by DM.
3. Enter the authentication information to be used during the setup process. Make sure to enter the user with
administrative database permissions.
4. Select the database catalog (the database name) to be updated for DM and continue.
Configure the authentication for a technical database user DM uses to access the database during usage of the
product.
The authentication type is a basic authentication, that is user and password. The default credentials are:
• User: CDMUser
• Password: Initial1
Configure the Microsoft Internet Information Services (IIS) settings for SAP Disclosure Management:
You can change the installation folder of DM SERVER – APPL SERVER 10.1. In most cases, it is sufficient
to change the TCP port to your needs. As the default configuration of the used protocol for Disclosure
Management is HTTPS, the default TCP port is set to 443. Additionally, an SSL certificate is required to
install DM SERVER – APPL SERVER 10.1 with HTTPS configuration. You can select this certificate from the
You can also switch the protocol configuration to HTTP using the Protocol dropdown list. Once it is set to HTTP,
the TCP port is automatically set to 80 , and no SSL certificate is required to continue with the installation:
The application is installed to the named directory of your Microsoft Windows Server system.
A website and an application pool with the entered name is created and the website is added to the application
pool.
• Basic Authentication
• Active Directory Authentication, including basic authentication as a fallback
In both cases, a user for basic authentication with the following credentials will be created:
• User: Admin
• Password: Initial1
If you choose Active Directory Authentication, a technical user with the credentials you enter is created. This
user is not available in the application itself. It is used for the sole purpose of authentication requests to
Microsoft Windows AD. The user name and domain must match a user in your existing Microsoft Windows
Active Directory.
If you install DM Stack 800 or higher, the following steps are required. API calls authenticated via Microsoft
Windows Active Directory use a certificate that needs to be prepared by granting read permissions to it for
ISS_IUSRS.
7. Close the Add or remove Snap-ins dialog box by clicking OK. From the Snap-in tree view, choose
Certificates ) Local Computer) Personal Certificates .
8. Right-click the ApiDisclosureManagementV2 certificate and choose All Tasks Manage Private Keys… .
Note
Use the application pool user with read authorizations for the certificate.
The following error message occurs if you don't set this up correctly:
Note
The Application Pool user needs read access to the private keys of the certificates. For more information,
see SAP Note 2365878 .
Check that the SAP Disclosure Management website is available by using Internet Explorer to open http://
localhost:<Port Number>/ from the server machine itself and http://<Server Host Name or IP
Address>:<Port Number>/.
• user: Admin
• password: Initial1
Note
You are requested to change the default password once you have logged in.
To configure the Web server, follow the steps for the IIS version you run.
If you run DM SERVER – APPLICATION SERVER 10.1 on Microsoft Server 2008 or 2008 R2, configure IIS
7.0/7.5 as follows:
If you run DM SERVER – APPLICATION SERVER 10.1 on Microsoft Server 2012 or 2012 R2, configure IIS 8.0
as follows:
If you run DM SERVER – APPLICATION SERVER 10.1 on Microsoft Server 2012, 2012 R2 or 2016 configure
IIS 10.0 as follows:
Note
7. On the Features wizard page, do not change anything and click Cancel if all features are installed on the
selected server, otherwise click Next > to continue.
8. On the Confirmation wizard page, verify that the roles are ready to be installed.
9. Click Install to activate the role services.
10. Click Close to hide the wizard, when the installation has been completed.
2. Configure Default Delegation State for Features at Lower Levels:
1. Start the Server Manager.
2. Select the top node of the local server instance in the Connections tree view.
3. In the Features View, double-click the Feature Delegation icon.
4. In the next view, make sure that Authentication – Anonymous and Authentication – Windows are set to
Read/Write.
5. When you've finished the configuration, close the Server Manager.
3. Switch IIS to 64 bit:
1. Start the Server Manager.
2. Make sure that the following Advanced Settings of the application pool(s) are set to:
1. False for Enable 32-Bit Applications.
2. Integrated for Managed Pipeline Mode.
3. Close the dialog box.
4. Clean-Up Handler Mapping of IIS Website:
1. Start the Server Manager.
2. Select the website SAP Disclosure Management.
3. Click Handler Mappings.
4. Select the row with the Name “*”.
5. Right-click and click Remove.
Once you have met the software and hardware requirements, found out which components are required to run
your scenario(s) and downloaded the right version of each component from one single DM Stack, you are ready
to install SAP Disclosure Management.
It is recommended that you start with the installation of the most complex component, DM SERVER – APPL
SERVER 10.1.
You can install the DM SERVER - APPL SERVER 10.1 in silent mode. Please note that you must meet
all prerequisites for the SAP Disclosure Management Application Server and make sure that the parameters
have correct values. It is strongly recommended that you make a backup of your existing configuration files
web.config, cundus.enterpriseReporting.Services.dll.config, and log.config, because they
might be overwritten by the setup. You must execute the command line or batch file that is used for executing
the setup in silent mode as an administrator. The default command for a silent installation is <setup.exe>
-s <silent installation parameters>.
You can use the following command line parameters with the setup:
Parameter Definition
Parameters
Parameter Definition
• 0—Windows Authentication.
This parameter tells the setup to
use the SQL connection provided
in the silent installation parameters
• 1—Database Authentication
This parameter can only be used
for a new installation. For up
grades, this parameter should only
be used if the existing database
has been moved manually to an
other server.
Note
The user must have the necessary
authorizations to create or modify
tables.
• 0 — Windows Authentication
This parameter tells the setup pro
gram to use the SQL connection
provided in the silent installation
parameters.
• 1—Database Authentication
This parameter can only be used
for a new installation. For up
grades, this parameter should only
be used if the existing database
has been moved manually to an
other server.
Note
The user has only read/write per
mission on DM tables.
• 0 = Basic Authentication
• 1 = Active Directory Authentication
Note
An active DOMAINUSER is required.
• 0 = Default Update
• 1 = Custom Update
Note
This parameter is optional. If this
parameter is left out in the com
mand string, the default update op
tion ("0") is applied by default.
The example below shows an installation from scratch using the basic authentication method:
Sample Code
<setup.exe> -s -SQLSERVER_HOST="WIN-ANFL4JRDDR2\SQLEXPRESS2008R2"
-SQLSERVER_DATABASE="DisclosureManagementDB"
-SETUP_SQLSERVER_AUTHENTICATION="1"
-SETUP_SQLSERVER_USERNAME="sa" -SETUP_SQLSERVER_PASSWORD="MyPassword1"
-DM_SQLSERVER_USERNAME="CDMUser" -DM_SQLSERVER_PASSWORD="EnterNewPassword"
-WEBSITENAME="SAP Disclosure Management" -IPADDRESS="*" -WEBSITEPORT="8080"
-AUTHMETHOD="0" -BINDING_PROTOCOL="http"
-INSTALLDIR="C:\inetpub\wwwroot\SAP\SAP Disclosure Management"
The example below shows an installation from scratch using the Active Directory authentication method:
Sample Code
<setup.exe> -s -SQLSERVER_HOST="WIN-ANFL4JRDDR2\SQLEXPRESS2008R2"
-SQLSERVER_DATABASE="DisclosureManagementDB"
-SETUP_SQLSERVER_AUTHENTICATION="1"
-SETUP_SQLSERVER_USERNAME="sa" -SETUP_SQLSERVER_PASSWORD="MyPassword1"
-DM_SQLSERVER_USERNAME="CDMUser" -DM_SQLSERVER_PASSWORD="EnterNewPassword"
-WEBSITENAME="SAP Disclosure Management" -IPADDRESS="*" -WEBSITEPORT="8080"
-AUTHUSER="MyDomain\MyDomainUserName" -AUTHPASSWORD="MyDomainUserPassword1"
-BINDING_PROTOCOL="http"
-AUTHMETHOD="1" -INSTALLDIR="C:\inetpub\wwwroot\SAP\SAP Disclosure Management"
The example below shows an update installation using the authentication method using the authentication
method of the existing instance #1::
<setup.exe> -s -SQLSERVER_HOST="WIN-ANFL4JRDDR2\SQLEXPRESS2008R2"
-SQLSERVER_DATABASE="DisclosureManagementDB"
-SETUP_SQLSERVER_AUTHENTICATION="1"
-SETUP_SQLSERVER_USERNAME="sa" -SETUP_SQLSERVER_PASSWORD="MyPassword1"
-DB_BACKUP_DONE="Yes" -INSTANCE_NUMBER="1"
Parameter Definition
SETUP_SQLSERVER_AUTHENTICATION If you set this parameter to 1, you must enter valid database
credentials for the SETUP_SQLSERVER_USERNAME and
SETUP_SQLSERVER_PASSWORD parameters.
Copy the setup file to the desktop of the destination server and run it with administrative Microsoft Windows
permissions.
If the result is negative, see Hardware and Software Requirements [page 8] and solve any remaining issues.
1. Run the setup wizard. In the following step, the currently installed instances of DM SERVER - TASK
ENGINE 10.0 on the current system are displayed:
Note
1. Run the setup wizard. In the same step described under Installing a New Instance from Scratch, you
can update an already existing installation of DM SERVER - TASK ENGINE 10.0, more specifically, what
instance should be updated:
Note
You can update every single existing instance on the current server machine. You can also update DM
Stacks earlier than DM Stack 17xx. Please note that in this case, the DM Stack to be updated must at
least DM Stack 1000 or higher.
Caution
If you already have a Task Engine instance installed with HTTP, you cannot switch to HTTPS by
updating the instance. If you want to switch this instance to HTTPS, you must first uninstall it, then
reinstall it with HTTPS.
1. The setup wizard doesn't automatically detect existing instances of DM SERVER – TASK ENGINE 10.1
on your server machine that were created manually, as such instances aren't available as instances in
2. The drop-down list displays all existing DM SERVER - TASK ENGINE 10.1 Windows services available
on the system where you run the setup wizard. If you select Show all, all available Windows services are
displayed. If you deselect Show all, all Windows services with the SAPDM prefix are listed. Once you've
selected a valid service item that is associated with a DM SERVER – TASK ENGINE 10.1 installation
on the same system, you can select this service item to be registered as an instance of DM SERVER –
TASK ENGINE 10.1 in Windows Registry. If you have selected a valid service item that is associated with DM
SERVER – TASK ENGINE 10.1, the relevant version number and the installation directory of the relevant file
system that is connected to the selected service item are displayed.
You can't uninstall instances of DM SERVER – TASK ENGINE 10.1 using the Microsoft Windows Control
Panel. Instead, you must use the setup executable file in the Command Prompt or from a batch file providing
the relevant uninstall command. As a prerequisite, you must have the instance number and the service name of
the affected instance at hand.
Example
The value for the SERVICE_NAME parameter is the technical name of the Windows Service item. Make sure
that you run the above-mentioned commands as an administrator in the Command Prompt or use a batch
file.
If you want to install a new instance of DM SERVER – TASK ENGINE 10.1 from scratch silently, the
procedure remains identical. You must, however, add the following new parameters to the silent installation
command:
If you leave out the above parameters, the default values for the installation from scratch are used:
You can run a silent installation from scratch using following command, assuming that database authentication
is done using the Windows authentication method:
<setup.exe> -s -SQLSERVER_HOST="WIN-G4H4P1I7AI5\SQLSRV2016EXPR"
-SQLSERVER_DATABASE="DMDB2" -SETUP_SQLSERVER_AUTHENTICATION="0"
-DM_SQLSERVER_USERNAME="CDMUser" -DM_SQLSERVER_PASSWORD="Initial1"
-INSTALLDIR="C:\Program Files\SAP\SAPDMTaskEngine2"
-PATH_TO_JRE="C:\jdk-13.0.1\bin\java.exe" -JRE_SETTINGS="-XX:-UseGCOverheadLimit
-XX:+DisableExplicitGC -XX:+UseParallelGC -Xms2G -Xmx20G -jar"
-DISABLE_CRYPTO_KEY_TRANSFER="Yes" -INSTANCE_NAME="SAP DM Task Engine Instance 2"
-INSTANCE_PORT="2606" -BINDING_PROTOCOL="http"
If you want to update an already existing instance of DM SERVER – TASK ENGINE 10.1, you must make
sure that the affected instance is already registered in Windows Registry. Once this is done, you must have the
instance number, service name, and service port of the instance at hand, whereafter you can run the silent
update.
You can run a silent installation from scratch using following command, assuming that database authentication
is done using the Windows authentication method:
<setup.exe> -s -SQLSERVER_HOST="WIN-G4H4P1I7AI5\SQLSRV2016EXPR"
-SQLSERVER_DATABASE="DMDB2" -SETUP_SQLSERVER_AUTHENTICATION="0"
-DM_SQLSERVER_USERNAME="CDMUser" -DM_SQLSERVER_PASSWORD="Initial1"
-INSTALLDIR="C:\Program Files\SAP\SAPDMTaskEngine2"
-PATH_TO_JRE="C:\jdk-13.0.1\bin\java.exe" -JRE_SETTINGS="-XX:-UseGCOverheadLimit
-XX:+DisableExplicitGC -XX:+UseParallelGC -Xms2G -Xmx20G -jar"
You can also configure the path of Java Runtime Environment and the memory settings.
For any server running DM SERVER - TASK ENGINE 10.1 and/or DM SERVER - XBRL SERVICE 10.1,
the following prerequisites must be met:
• Operating system and DM SERVER - TASK ENGINE 10.1 and DM SERVER - XBRL SERVICE 10.1
running in 64-bit mode
• Quad-core 64-bit CPU at 2 GHz or more
• 32 GB RAM and 20 GB free disk space (excluding database)
The setup wizard is enabled to connect to the target database with a working authenticatio.
Proceed as follows:
Configure the authentication for a technical database user DM uses to access the database during usage of the
product. The authentication type is the basic authentication, that is, user and password.
Caution
Do not use the option Windows authentication of current user, as it is deprecated. For more information, see
SAP Note 2744381 .
• User: CDMUser
• Password: <Password entered during Application Server Installation>
Note
It is required that you enter the same user that is used for DM SERVER – APPL SERVER 10.1.
The credentials are encrypted and saved to the file SAP.DM.TaskEngine.WinService.exe.config in the
installation folder of DM SERVER – TASK ENGINE 10.1.
By default, you can transfer the cryptographic key from the DM SERVER – APPL SERVER 10.1 configuration
to the DM SERVER – TASK ENGINE 10.1 configuration. You can disable this functionality by selecting
If you do not disable the feature, you must provide a valid root URL to the already installed DM SERVER –
APPL SERVER 10.1 and additionally the credentials of an administrative application user.
Once you've selected Register Task Engine in Landscape Configuration of DM Application Server, the current
instance of DM SERVER – TASK ENGINE 10.1 is added in the according landscape configuration of DM
SERVER – APPL SERVER 10.1 administration during the installation. This feature is optional and is disabled
by default.
Prerequisites
Procedure
Do not change the default installation location (C:\Program Files\Arelle). The file
C:\ProgramFiles\Arelle\arelleCmdLine.exe is required to be found on exactly this location
by SAP Disclosure Management. For more information, see also .
2. You can check the installation by starting the application C:\Program Files\Arelle\arelleGUI.exe.
1. To check the installation of DM SERVER – TASK ENGINE 10.1, start Internet Explorer on the destination
server machine and open http://localhost:2605/TaskEngineService/.
2. Check the webpage. It should look like this:
Once you've installed or updated a DM SERVER - TASK ENGINE 10.1 instance, a wizard step for checking
the status of the currently installed or updated instance is displayed:
This wizard step summarizes the status of the installed or updated instance of DM SERVER - TASK ENGINE
10.1. It checks if the TaskEngineService endpoint is up and running. In case or errors, the status is updated
accordingly, along with a recommendation to check the installation log for more information about the issues
that occurred.
As an alternative to the standard installation process, you can install the Task Engine in silent mode. In other
words, the setup is executed in the background. This type of setup is suitable for remote installations and
allows you to change default parameters like destination path, database server, or database catalog. It also
allows you to change the database user that is used to establish the database connection, when Disclosure
Management is in production mode.
The syntax for the setup command is as follows: setup.exe -s <parameters>. To display the general setup
parameter help, run the setup program with following command: setup.exe -help.
• 0 = Windows authentication
• 1 = Database authentication
• 0 — Windows Authentication
This parameter tells the setup program to use the SQL
connection provided in the silent installation parame
ters.
• 1 — Database Authentication
This parameter can only be used for a new installation.
For upgrades, this parameter should only be used if the
existing database has been moved manually to another
server.
DM_SQLSERVER_PASSWORD="<DM Database User Password of the technical DM user to be used in the data
Password>" base connection string in the TaskEngine configuration file.
PATH_TO_JRE="<Physical path to 'java.exe' Path to java.exe file of 64-bit Java Runtime Environment.
file>"
JRE_SETTINGS="<Memory Settings for JRE>" Memory settings for Java Runtime Environment.
INSTANCE_NAME="<Display Name of the DM Task Name of the DM Task Engine instance or service.
Engine Instance/Service>"
INSTANCE_PORT="<TCP Port for the DM Task TCP port for the DM Task Engine instance.
Engine Instance>"
-BINDING_CERTIFICATE This parameter is used for setting the hash value of the SSL
certificate that is used by the DM Application Server for a
secure HTTPS connection.
-BINDING_PROTOCOL Switch for setting the used protocol, which can be either
HTTP or HTTPS.
To uninstall DM SERVER- TASK ENGINE 10.1 in UI mode, run the following command: setup.exe
-uninstall.
To enable the installed DM SERVER – APPL SERVER 10.1 instance to communicate with one of the installed DM
SERVER – TASK ENGINE 10.1 instances as the main Task Engine, you must enter the URL of the Task Engine in
the system administration of DM SERVER – APPL SERVER 10.1.
The following is an example of minimum setup using three instances – one per component – using the default
ports and HTTP:
Once the landscape is configured, the logs of all components are available via the DM website.
1. To check the configuration for correctness, go to Administration Log Files Log Files Application
Sever on the DM website. Select the configured URLs one after another and check the respective log
entries. At this point in time, it is sufficient if the message “No data available” is displayed.
3. Repeat the check for the log files of all XBRL services. As a result, you should see at least one log file entry
per XBRL service.
To configure the installed DM SERVER – APPL SERVER 10.1 instance for using the DM Document Web
Service, enter the root folder of the service in the system administration of DM SERVER – APPL SERVER
10.1.
The SAP Disclosure Management BW connector desktop application is used to extract data from an SAP BW
system. It should primarily be installed on the end user workstation.
For a list of the software and hardware requirements for SAP Disclosure Management 10.1 and SAP
Disclosure Management XBRL reporting add-ons 1.0, see the SAP Disclosure Management 10.1
Product Availability Matrix (PAM). The Product Availability Essentials presentation also contains information for
getting started, and can be found under General Information Details and Dates Essentials .
On the clinet, make sure that the .NET framework security level is set to high (default) to allow the registration
of the DLL files. To do so, select the Trust access to the VBA project object model checkbox in the Developer
Macro Settings area.
Copy the setup file to the desktop of the destination computer and run it with administrative Microsoft
Windows permissions.
The setup wizard checks the following software requirements. If the result is negative, see Hardware and
Software Requirements in SAP Disclosure Management [page 8] to solve any remaining issues.
Proceed as follows:
1. Start a Microsoft Office application directly or open a document on the SAP Disclosure Management server
for editing.
The Disclosure Management ribbon or menu item appears. If no ribbon or menu item appears, activate the
COM-add-in in the application.
Registry Path
Managable by Name in UI in HKEY_CUR More Informa
UI Configuration RENT_USER Registry Key Values Purpose tion
Configuratio
Common .
Configuratio
Common .
Configuratio
Common .
Configuratio
Common .
Yes Enable SSL cer Software\cun EnableSSLCer True/False For more infor
tificate checks dus tificateChec mation, see the
for SOAP AG\cundusBIP ksForSOAP detailed de
ublisher scription of the
registry key in
the SAP Disclo
sure Manage
ment client
component. To
view the de
scription,
choose
Configuratio
Common .
Yes Microsoft Word Software\cun WordTableFor Path to local For local use of For more infor
template dus matPath folder Microsoft Word mation, see the
AG\cundusBIP templates detailed de
ublisher scription of the
registry key in
the SAP Disclo
sure Manage
ment client
component. To
view the de
scription,
choose
Configuratio
Common .
Registry keys
No Software\SAP WordProcessI Set automati
increase per
\Disclosure d cally if key is
formance when
Management created
you start Micro
soft Word and
No Software\SAP OfficePath Path to sub Microsoft Excel
\Disclosure folder in Micro applications.
Management soft Office in
stallation folder
containing the
Microsoft Word
and Microsoft
Excel executa
ble files
No
Software\SAP ShowNotifica • 0 = Disa Disables notifi- Some operating
\Disclosure tions bled cations or systems don't
Management • 1 = Show forces bubble support toast
Bubbles notification. If notifications
not available, with Citrix.
the notification
type depends
on the operat
ing system:
• Windows
versions
lower than
Windows
8: bubbles
• Windows 8
and higher:
toasts
If your XBRL scenario uses an open taxonomy, you may need to edit the taxonomy files. For this purpose, the
Fujitsu Interstage XWand tool is used.
Note
Proceed as follows:
Start the application from the Windows Start menu Interstage XWand Toolkit Taxonomy Editor & Instance
Creator :
Note
All prerequisites for DM CLIENT 10.1 are met and the parameters are defined with the correct values.
For the default DM CLIENT 10.1 installation process, use the following syntax:
Example
setup.exe -s -INSTALLDIR="C:\MyDMClient"
In this example, the client files are installed to the C:\MyDMClient\ program directory.
Additionally, you can use the following command line parameter to display a general parameter help:
setup.exe -help
Note
The DM XBRL MAPPER 10.1 component is only required for XBRL scenarios that require data tagging.
Prerequisites
Installation
Proceed as follows:
1. Start a Microsoft Office application directly or open a document on DM SERVER - APPL SERVER 10.1
for editing.
2. On the SAP Disclosure Management ribbon or menu, an additional option (SAP DM XBRL Mapper) is
displayed.
Note
All prerequisites for DM XBRL MAPPER 10.1 are met and the parameters are defined with the correct
values.
The command prompt or batch file that is used for executing the setup in silent mode must be started as the
administrator.
Example
In this example, DM XBRL MAPPER 10.1 is installed to the C:\<name of directory>\ program directory.
Additionally, you can use the following command line parameter to display a general parameter help:
setup.exe -help
The SAP Disclosure Management BW connector desktop application is used to extract data from an SAP BW
system. It should primarily be installed on the end user workstation.
For a list of the software and hardware requirements for SAP Disclosure Management 10.1 and SAP
Disclosure Management XBRL reporting add-ons 1.0, see the SAP Disclosure Management 10.1
Product Availability Matrix (PAM). The Product Availability Essentials presentation also contains information for
getting started, and can be found under General Information Details and Dates Essentials .
3.12.1.2 Configuration
On the SAP BW server, run transaction SICF to deactivate the following objects:
• /sap/bc/soap/rfc
• /sap/bc/soap/wsdl11
Note
You must create and configure all Web services manually in transaction SOAMANAGER. Do not activate
the ICF nodes /sap/bc/soap/rfc or /sap/bc/soap/wsdl11. Activating these nodes might result in security
issues and could prevent the BW connector for SAP NetWeaver from working properly. For more
information, see SAP Note 1394100 .
To prevent disconnection from SAP Business Warehouse, see SAP Note 1811818 . Before you start the
configuration steps, apply all available ABAP support packages for the SAP Disclosure Management BW
connector. More specifically, apply all available ABAP support packages as soon as you have applied the
installation package or upgraded the exchange package.
To enable Web services, see Establishing and Connecting Single Web Services Manually [page 67].
Caution
For security reasons SAP Disclosure Management no longer supports SOAP Processor 6.20. Deactivate ICF
node /sap/bc/soap/rfc and /sap/bc/soap/wsdl11. It is mandatory to deactivate these ICF nodes and to
establish the single Web services manually. For more information, see SAP Note 1998413 .
Prerequisites
Context
You must establish Web services and connect them to the Web service definition manually.
Note
You have to establish the Web services separately on each BW system that you want to communicate with
an SAP Disclosure Management client. For more information, see SAP Note 1318499 .
Procedure
1. Call transaction SOAMANAGER and establish single Web services. Make sure that the bindings have exactly
the same spelling as the Web service definitions, including the “/” (slash) characters.
Results
CUNDUS_YCU_API_CHAN_BBOOK_RFC /CUNDUS/YCU_API_CHAN_BBOOK_RFC
CUNDUS_YCU_API_DEL_BBOOK_RFC /CUNDUS/YCU_API_DEL_BBOOK_RFC
CUNDUS_YCU_API_DEL_CHILD_RFC /CUNDUS/YCU_API_DEL_CHILD_RFC
CUNDUS_YCU_API_GET_BBOOK_RFC /CUNDUS/YCU_API_GET_BBOOK_RFC
CUNDUS_YCU_API_HAS_ROLE /CUNDUS/YCU_API_HAS_ROLE
CUNDUS_YCU_API_INFO_CHILD_RFC /CUNDUS/YCU_API_INFO_CHILD_RFC
CUNDUS_YCU_API_NEW_BBOOK_RFC /CUNDUS/YCU_API_NEW_BBOOK_RFC
CUNDUS_YCU_API_NEW_CHILD_RFC /CUNDUS/YCU_API_NEW_CHILD_RFC
CUNDUS_YCU_API_NOTE_BBOOK_RFC /CUNDUS/YCU_API_NOTE_BBOOK_RFC
CUNDUS_YCU_API_PUB_BBOOK_RFC /CUNDUS/YCU_API_PUB_BBOOK_RFC
CUNDUS_YCU_API_SEEK_BBOOK_RFC /CUNDUS/YCU_API_SEEK_BBOOK_RFC
CUNDUS_YCU_CHECK_AUTH /CUNDUS/YCU_CHECK_AUTH
CUNDUS_YCU_CHECK_STYLES /CUNDUS/YCU_CHECK_STYLES
CUNDUS_YCU_CHECK_LOGON /CUNDUS/YCU_CHECK_LOGON
CUNDUS_YCU_CHECK_VAR /CUNDUS/YCU_CHECK_VAR
CUNDUS_YCU_CHECK_VERSION /CUNDUS/YCU_CHECK_VERSION
CUNDUS_YCU_GET_BBOOKS /CUNDUS/YCU_GET_BBOOKS
CUNDUS_YCU_GET_BBOOKS_VARS /CUNDUS/YCU_GET_BBOOKS_VARS
CUNDUS_YCU_GET_BBOOKS_XML /CUNDUS/YCU_GET_BBOOKS_XML
CUNDUS_YCU_GET_F4_HIERARCHY /CUNDUS/YCU_GET_F4_HIERARCHY
CUNDUS_YCU_GET_LICENSE_RFC /CUNDUS/YCU_GET_LICENSE_RFC
CUNDUS_YCU_GET_VARIABLE_F4 /CUNDUS/YCU_GET_VARIABLE_F4
CUNDUS_YCU_GET_VAR_DEP /CUNDUS/YCU_GET_VAR_DEP
CUNDUS_YCU_GET_VAR_DEP_SINGLE /CUNDUS/YCU_GET_VAR_DEP_SINGLE
CUNDUS_YCU_SET_LICENSE_RFC /CUNDUS/YCU_SET_LICENSE_RFC
3.12.1.4 Authorizations
Administration rights are required on both the SAP BW server and the client machine that is used for validation.
SAP Disclosure Management users also need authorization for SAP BW queries.
Note
These authorizations are customer-specific. An example role for SAP BW query users is
SAP_BW_WP_QUERY_USER.
Note
There are cases where queries are not available in SAP Disclosure Management. If this is the case, allow
external access as shown below:
The software is delivered as an ABAP add-on installation file. For a description on how to
install add-ons, see https://help.sap.com/viewer/3b5766180ec240949501f4b1897a74a0/LATEST/en-US/
493e90fb29002221e10000000a42189d.html and SAP Note 1566421 .
Before you install BW Connector, you must download and install the relevant Attribute Change Package
to make BW Connector compatible with SAP S/4HANA On Premise 1809. To do so, go to https://
launchpad.support.sap.com/#/softwarecenter and search for DISCLMG.
Installation
The installed function modules and Webservice definitions must be bound into single Web Services.
Note
Configuration
You must create and configure all Web services manually in transaction SOAMANAGER. In other words, do not
activate the ICF node /sap/bc/soap/rfc or /sap/bc/soap/wsdl11, as this may result in security issues
and could prevent the BW connector for SAP NetWeaver from working properly. For more information, see SAP
Note 1394100 .
On the SAP BW server, you can deactivate the above objects in transaction SICF.
You must establish Web services and connect them to the Web service definition manually.
Note
To prevent disconnection from SAP BW, follow the instructions in SAP Note 1811818 . Before you
start configuration, apply all available ABAP support packages for the SAP Disclosure Management BW
connector. To ensure an error-free operation, apply all available ABAP support packages as soon as you
have applied the installation package or upgraded the exchange package.
Note
For security reasons, SAP Disclosure Management no longer supports SOAP Processor 6.20. Deactivate
the ICF node /sap/bc/soap/rfc and /sap/bc/soap/wsdl11. It is mandatory to deactivate these ICF
nodes and to establish the single Web services manually. For more information, see SAP Note 1998413 .
You must establish the Web services separately on each BW system that you want to connect to an SAP
Disclosure Management client. For more information, see SAP Note 1318499 .
Proceed as follows:
Note
Make sure that the bindings have exactly the same spelling as the Web service definitions, for example,
the service uses an underscore (_), while the binding has a slash (/).
3. Establish the binding between the Web service and the corresponding Web service definition in package /
CUNDUS/BIPUBLISHER.
The following objects need to be bound (Please note that four delivered objects are obsolete.):
CUNDUS_YCU_API_CHAN_BBOOK_RFC /CUNDUS/YCU_API_CHAN_BBOOK_RFC
CUNDUS_YCU_API_DEL_BBOOK_RFC /CUNDUS/YCU_API_DEL_BBOOK_RFC
CUNDUS_YCU_API_DEL_CHILD_RFC /CUNDUS/YCU_API_DEL_CHILD_RFC
CUNDUS_YCU_API_GET_BBOOK_RFC /CUNDUS/YCU_API_GET_BBOOK_RFC
CUNDUS_YCU_API_HAS_ROLE /CUNDUS/YCU_API_HAS_ROLE
CUNDUS_YCU_API_INFO_CHILD_RFC /CUNDUS/YCU_API_INFO_CHILD_RFC
CUNDUS_YCU_API_NEW_BBOOK_RFC /CUNDUS/YCU_API_NEW_BBOOK_RFC
CUNDUS_YCU_API_NEW_CHILD_RFC /CUNDUS/YCU_API_NEW_CHILD_RFC
CUNDUS_YCU_API_NOTE_BBOOK_RFC /CUNDUS/YCU_API_NOTE_BBOOK_RFC
CUNDUS_YCU_API_PUB_BBOOK_RFC /CUNDUS/YCU_API_PUB_BBOOK_RFC
CUNDUS_YCU_API_SEEK_BBOOK_RFC /CUNDUS/YCU_API_SEEK_BBOOK_RFC
CUNDUS_YCU_CHECK_AUTH /CUNDUS/YCU_CHECK_AUTH
CUNDUS_YCU_CHECK_LOGON /CUNDUS/YCU_CHECK_LOGON
CUNDUS_YCU_CHECK_STYLES /CUNDUS/YCU_CHECK_STYLES
CUNDUS_YCU_CHECK_VAR /CUNDUS/YCU_CHECK_VAR
CUNDUS_YCU_CHECK_VERSION /CUNDUS/YCU_CHECK_VERSION
CUNDUS_YCU_GET_BBOOKS /CUNDUS/YCU_GET_BBOOKS
CUNDUS_YCU_GET_BBOOKS_VARS /CUNDUS/YCU_GET_BBOOKS_VARS
CUNDUS_YCU_GET_BBOOKS_XML /CUNDUS/YCU_GET_BBOOKS_XML
CUNDUS_YCU_GET_F4_HIERARCHY /CUNDUS/YCU_GET_F4_HIERARCHY
CUNDUS_YCU_GET_LICENSE_RFC /CUNDUS/YCU_GET_LICENSE_RFC
CUNDUS_YCU_GET_VARIABLE_F4 /CUNDUS/YCU_GET_VARIABLE_F4
CUNDUS_YCU_GET_VAR_DEP /CUNDUS/YCU_GET_VAR_DEP
CUNDUS_YCU_GET_VAR_DEP_SINGLE /CUNDUS/YCU_GET_VAR_DEP_SINGLE
CUNDUS_YCU_SET_LICENSE_RFC /CUNDUS/YCU_SET_LICENSE_RFC
Note
On protocol security
Note
The ‘001’ is the client number, so this may vary on your system.
1. BW Queries
You need administration rights on both the SAP BW server and the client machine that is used for
validation.
SAP Disclosure Management users also need authorizations for SAP BW queries.
Note
These authorizations are customer-specific. An sample role for SAP BW query users is
SAP_BW_WP_QUERY_USER.
Note
There are cases where queries are not available in SAP Disclosure Management. If this is the case,
allow external access as shown below:
2. RFC Authorization
To use SAP Disclosure Management, you need authorizations for Remote Function Call (RFC) destinations.
To enable RFC, choose one of the following options:
• Assign the corresponding access rights directly to the user.
SAP Disclosure Management users must have RFC (S_RFC) authorizations for the three function
groups, which are available under /CUNDUS/* and Web Service Authorizations (S_SERVICE).
• If a more detailed authorization situation is required, assign the user to the function group:
Note
Make sure that every user has the appropriate rights to execute the function modules.
To use SAP Disclosure Management, you need authorizations for Remote Function Call (RFC) destinations.
Note
Make sure that every user has the appropriate authorizations to execute the function modules.
Users who need to access and publish briefing books without restrictions, even if they do not own the briefing
book, must be be assigned to the authorization object DCUBIPAUH in the SAP Disclosure Management BW
connector.
This section provides information on administration tasks you execute after the SAP Disclosure Management
BW connector has been activated:
Context
To find the default host name and port number of the SAP Disclosure Management BW connector, proceed as
follows:
Procedure
1. On SAP BW server, enter transaction SMICM to start the Internet Communication Manager.
2. Click Go to Services .
You can use initial passwords or passwords reset by your system administrator to establish a connection with
an SAP ERP or an SAP BW DataSource.
Prerequisites
• Check that you are using a supported version of SAP Business Warehouse (SAP BW). For more
information, see .
• Additional correction notes must be applied for some versions of SAP BW. For more information, see SAP
Note 2541557 .
• Configure SSL on your SAP NetWeaver ABAP Application Server. For more information, see and SAP Note
510007 .
Context
Set up cross-origin resource sharing (CORS) between your SAP S/4HANA or SAP BW/4HANA system and SAP
SAP Disclosure Management to establish a connection.
Note
Setting up a connection requires working with your system administrator and different IT and application
stakeholders in your organization. Most configuration steps are done on your SAP NetWeaver ABAP
Application Server (AS) before the connection from your client is established.
Affected users:
• Users with Create, Read, Update, Delete, and Maintain permissions for Connections
• Users with Execute permission for Other Data Sources.
• Admin, Application Creator, BI Content Creator, BI Admin, and Planner Reporter standard application roles.
Procedure
SAP Information Access (InA) is a REST HTTP-based protocol used by SAP Disclosure Management to
access your data sources in real time. You must confirm that your InA package is enabled and services are
running on the ABAP Application Server (ABAP AX) for your data source.
a. Check that your InA package is enabled. To do so, open the following URL in your browser: https://
<Your_ABAP_Server>/sap/bw/ina/GetServerInfo?sap-client=<Your_Client_ID>.
displayed:
g. Under Virtual Hosts/Services, go to default_host sap bw ina .
h. Make sure that the following services are active: BatchProcessing, GetCatalog, GetResponse,
GetServerInfo, Logoff, and ValueHelp.
i. Check again if the INA protocol is installed. To do so, open the following
URL in your browser: https://<Your_ABAP_Server>/sap/bw/ina/GetServerInfo?sap-
client=<Your_Client_ID>. Make sure you're redirected to your IdP login page (if configured) and
that no 404 page is displayed after login.
2. Logon Cookie Check
a. The expected result in the browser is a JSON response, starting with ‘{"ServerInfo":..’.
b. Use the Browser Development Tool to check whether the authentication cookies are available.
Additional correction notes must be applied if the logon cookie check failed, please see SAP Note
2594129 .
3. SAP S/4 HANA Server Settings
a. The connection for the client and for the server is established through the client installation. This
means that the client is also required for the server content refresh but only for the initial connection.
Otherwise, the server takes over further processing. The Microsoft Office Applications (Microsoft
Context
If the setup has been successfully completed but the website cannot be loaded, you can modify the
web.config file to gerenate a detailed error message that you can send to the IT support team.
Procedure
1. Navigate to the directory in which you have installed SAP Disclosure Management.
2. Open the web.config file.
3. Change the value in the customerrors-tag from On to Off.
4. Save your changes.
Context
Procedure
Context
As of DM Stack 15xx, data source configuration is written to the database. The local configurations are still
located in an xml file (config20.xml).
If you want to make data sources available to all users, we recommend that you create only the connection to
the DM server locally and create all other DM Servers including the DM Server data source on the server.
Create a config20.xml file that only includes the connection to the SAP Disclosure Management
server, and copy the file to the application folder of each user ((%appdata%\cundus AG\cundus
AG\cundusBIPublisher).
Note
You need the permission Administration - Configure content refresh to add, edit, or delete data sources on
the server.
1. In Disclosure Management client, choose the data source to your server and click Connect.
2. Click Connect to switch to server mode.
3. Add all data sources.
If you are running SAP Disclosure Management 10.0, it is strongly recommended that you upgrade to SAP
Disclosure Management 10.1, as SAP Disclosure Management 10.0 is not supported anymore. For more
information, see SAP Note 2085953 .
To familiarize yourself with the upgrade process, please read SAP Note 2043397 .
Changing to a DM Stack not including a change of the major (DM 10.1) or minor (DM 10.1) version number of
the product is referred to as an “update”.
Uninstalling DM SERVER - APPL SERVER 10.1 removes the software from the system. All files and
configuration files are removed, as well as the IIS application pool, the IIS website, and the API certificate.
Note
1. Open the Command Line as administrator and enter following command at the command line prompt:
<setup.exe> -uninstall -INSTANCE_NUMBER="<instance number>
Note
To uninstall DM SERVER - APPL SERVER 10.1 silently, enter the following command:
2. Press <Enter> to run the command. A progress bar is displayed during the uninstallation process. When
the process is complete, a success message is displayed. If errors occur during the uninstallation process,
error messages are displayed upon completion of the process.
6.1 Prerequisites
• You know which software components are required for the scenario you run
• You know the basic software and hardware requirements
• You know the basics of DM Stacks
• You're familiar with SAP software downloads and know where to find yours
The DM Stacks Note 2138656 lists the Release Notes for all DM Stacks. These Release Notes inform you
about enhancements, improvements, legal change support, and bug fixes provided with each DM Stack. Find
the DM Stack that fits to your requirements. If there is no other indication, it is recommended that you use the
latest available DM Stack.
DM Stacks are working combinations of versions for all DM Components. The DM stacks note 2138656 lists
all DM stacks and provides basic information about this.
The same note refers to release notes for each DM stack. They provide information about enhancements,
corrections, legal change support, and bug fixes.
Please check if the latest DM stack meets your requirements. Unless otherwise indicated, it is strongly
recommended that you use the latest available DM stack.
To understand, which Software Components are required to update to the target DM Stack, have a closer look
at DM Stacks Note. The attached table indicates which components have received an update with a certain DM
Stack by showing the cells with a blue background.
The set of all blue entries between the DM Stack you are starting with (excluding) and the target DM Stack
(including) tells which components need to be updated to reach the target DM Stack: If there is at least one
blue cell for a Component, the Component needs to be updated.
Since the update paths differ between components, it is important to understand which component can be
updated from which version to which version.
Depending on the component, one of the following paths for updating to the latest available DM Stack is
supported:
• Single-step update
From DM Stack 1000, you can directly update DM SERVER – APPL SERVER 10.1 to any higher DM Stack.
• Update via the following sequence (for DM Stacks lower than 1000)
If the start version is not a DM Stack ending “…00”, for example "DM Stack 804", proceed as follows:
• Update via all following DM Stacks until the next DM Stack ending “…00” is reached.
• From the reached DM Stack “...00” update via all following DM Stack “...00” until the latest DM Stack
“...00” is reached.
• From the reached DM Stack “...00” update via all following DM Stacks to the latest DM Stack.
For components that must be updated via an update sequence, the exact sequence of required updates to
reach from a given DM Stack to another is described in DM Stacks Note 2138656 .
The following update path is mandatory for the DM SERVER – APPL SERVER 10.1 component only. If your
current version is part of DM Stack 400 or earlier, you must update every Stack ‘00’ one by one until you
you’ve reached Stack 500.
Example
Single-step update
A single-step update means that you must uninstall the current component first. Only then you can install
the new component from scratch. This is relevant for all components provided by a setup executable file,
except for the DM SERVER – APPL SERVER 10.1 component (see example for update path b).
If you have installed an earlier version of DM CLIENT 10.1 and you want to perform an update to the latest
available DM Stack, you must download the latest available download object from SAP Software Downloads,
then uninstall the earlier version of DM CLIENT 10.1, and install the new component version.
Example
From DM Stack 1000, you can directly update DM SERVER – APPL SERVER 10.1 to any higher DM Stack
without following the above-mentioned update path. The following example is only required for updates
from earlier DM Stacks.
Example
You have installed DM SERVER - APPL SERVER 10.1 from DM Stack 511 and you want to update to DM
Stack 902. To do so, download and install in the specified order:
1. All objects following the currently installed DM Stack (see DM Stacks table of DM Stacks Note
2138656 , that is, all blue cells between the version you are starting from and the next DM Stack
“...00”.
2. All objects from DM Stacks “...00” between the start and the target DM Stack.
3. All objects following the DM Stack “...00” until the target DM Stack is reached.
Suppose you want to update from DM Stack 703 to DM Stack 802 and you would like to understand the exact
update sequence for DM SERVER – APPL SERVER 10.1.
Proceed as follows:
The following table shows which components support which of the update paths described above:
* Update in one single step is executed via manual deinstallation of the old version followed by an installation of
a new version
** From DM Stack 1000. If you plan an update from an earlier DM Stack, update via a sequence like described
above.
As of DM Stack 902, you can use the DM Stacks table in SAP Note 2138656 ) to find all new downloads of
a DM Stack in the SAP Software Downloads (https://launchpad.support.sap.com/#/softwarecenter ). Click
the link at the top of the column listing the target DM Stack.
Note
• Table cells with a blue background have been recently released as part of the named DM Stack.
• A yellow background indicates that this version of the component has already been published as part
of an earlier DM Stack. For the downloads, search in SAP Software Downloads for the DM Stack that
first included this version.
SAP Software Downloads provides files in the Installations and Upgrades and Support Packages and Patches
areas:
1. Installations and Upgrades contains a comprehensive download package per product version that is
required only to perform an initial installation of the ABAP-based Components DM CONNECTOR FOR NW
BI.
2. Support Packages and Patches includes all other download objects:
SAP DISCLOSURE MGMT. 10.1 Installations and Upgrades Support Packages and Patches
DISCLOSURE MGM XBRL ADD-IN 1.0 Installations and Upgrades Support Packages and Patches
Make sure that the technical user and connection details DM uses to connect to its database are working.
1. Check that the SAP Disclosure Management website is available through http://<Server Host Name
or IP Address>:<Port Number>/ from any computer in the network.
2. Check that you can log on using your previously existing credentials.
3. After logon, your screen should look like this:
If you are updating a system that has been in use before, it is mandatory to back up the following:
If you want to update DM SERVER – APPL SERVER 10.1 on a Microsoft Windows Server machine without
Microsoft SQL Server Management Studio, download the following software components from the Microsoft
website and install them on the server:
If you run DM SERVER – APPL SERVER 10.1 on Microsoft Server 2008 or 2008 R2, stop Microsoft
Internet Information Services by following the steps described on https://technet.microsoft.com/en-us/
library/b9339773-7eff-4313-a14b-00f2b9f94ead .
If you run DM SERVER – APPL SERVER 10.1 on Microsoft Server 2012 or 2012 R2, stop Microsoft
Internet Information Services by following the steps described on https://technet.microsoft.com/en-US/
library/jj635851(v=ws.11).aspx .
Copy the executable file to the desktop of the destination server and run it with administrative Microsoft
Windows permissions.
Manage Instances
You can install several instances of DM SERVER – APPL SERVER 10.1 on a single server machine and have
several instances of different DM Stacks on the same server.
The Current Mode label tells you that you're currently in installation mode and that you're about to install an
instance from scratch.
Note
You can update lower stacks as of SAP Disclosure Management Stack 1000.
Manually created instances of DM SERVER – APPL SERVER 10.1 on your server machine aren't
automatically detected by the setup wizard, as there are no entries for these instances in Windows Registry. To
make them available for the setup wizard, click Register existing instance:
You can remove existing instances of DM SERVER – APPL SERVER 10.1 and the corresponding entries from
Windows Registry by selecting the instances in the list and clicking Unregister selected instance.
You must confirm the removal of the selected instance. Once you have chosen Yes, the selected instance is
removed from Windows Registry and from the instance list displayed in the setup wizard.
Note
With the setup wizard, you can't update or uninstall unregistered instances of DM SERVER – APPL
SERVER 10.1.
As of DM Stack 1600, you can't uninstall an instance of DM SERVER – APPL SERVER 10.1 in the Control
Panel of Microsoft Windows any longer. Instead, you must uninstall a specific instance using the setup
executable from the Command Line or from a batch file providing the appropriate uninstall command. To
perform the uninstallation, you must have administrator permissions and know the instance number of the
affected instance, for example:
You can update an existing instance of DM SERVER – APPL SERVER 10.1 Before doing so, make sure that
the affected instance is already registered in Windows Registry. Once this is done, you must know the instance
number before you can run the silent update using the command string from earlier DM Stacks and by adding
the parameter -INSTANCE_NUMBER=”<instance number>” to the command string.
Prerequisites Checks
The setup wizard checks some software requirements. If the result is negative, see Hardware and Software
Requirements [page 8] and solve any remaining issues.
As of DM Stack 802, you must confirm that you have manually created a backup of the existing DM database.
If you are updating a fresh installation initially performed from scratch, no database backup is required.
Nevertheless, you must confirm that you can continue with the update. In this case only, you can skip the
backup activity by selecting Yes, I created a manual backup and continue with the update by clicking Next.
Note
It is strongly recommended that you do not uninstall DM SERVER – APPL SERVER 10.1 to resolve
issues. For more information, see Troubleshooting [page 113], otherwise contact SAP Support.
You enable the DM setup wizard to connect to the target database with a working authentication..
1. In Microsoft SQL Server Management Studio, log on to the target database with a user with administrative
permissions. The user credentials and the hostname of the database server are required for the next step.
2. In the DM setup wizard, select the Microsoft SQL Server as the database server to be used by DM.
3. Enter the authentication information to be used during the setup process. Make sure to enter the user with
administrative database permissions.
4. Select the database catalog (the database name) to be updated for DM and continue.
You can update configuration files for DM SERVER - APPL SERVER 10.1 during the update of an already
installed instance choosing one of the following options:
• Default update
• Custom update
When you update an already installed instance of DM SERVER - APPL SERVER 10.1, you can choose to also
update your web.config file. By default, the web.config file is automatically copied to a back-up file and
the current configuration file is overwritten by the default delivery state. You can also choose to take over the
current web.config file and extend with changes relevant for a specific stack.
In this setup wizard step, you can select the option you want to apply to your configuration file back up
and continue updating your DM SERVER - APPL SERVER 10.1 instance as already known from earlier DM
Stacks.
You can also use the update option when you update DM SERVER - APPL SERVER 10.1 in silent mode. For
this purpose, a new command line parameter CONFIG_UPDATE is available, which you can use as follows:
• Default Update
<setup.exe> -s -... -CONFIG_UPDATE="0"
• Custom Update
<setup.exe> -s -... -CONFIG_UPDATE="1"
Note
If you leave out this parameter during a silent update, the Default Update option is applied by default.
1. Click Next to perform the actual update. For installations/updates prior to DM Stack 900(R), some steps
are executed in a command prompt.
Check if you are able to logon using your previously existing credentials.
As of DM Stack 1000, you can directly update DM SERVER – APPL SERVER 10.1 to any higher DM Stack.
The following information is only required for updates from earlier DM Stacks:
• Repeat the steps described in Update of DM SERVER – APPL SERVER 10.1 [page 89] until you reach the
target DM Stack.
• Follow the update path described in Understanding Update Paths [page 85] in combination with DM Stacks
Note 2138656 .
Example
To update from DM Stack 703 to DM Stack 802, go through the updates from DM Stack 703 to DM
Stack 800 and from DM Stack 800 to DM Stack 802 by executing the steps described above for the two
updates.
When you update an existing installation of DM SERVER – TASK ENGINE 10.1, you can decide in the same
setup step which instance should be fully updated:
The checkbox Update selected instance is checked, meaning that the setup switches to update mode. This is
specified by the Current Mode label. The instance affected by the update is the selected one listed in the list of
found instances. In example, instance 2 will be updated.
When you continue the installation process by clicking Next, the update will be performed as already known
from earlier DM Stacks.
By doing so, you can update every single instance existing on the current server machine. Also, you can update
DM Stacks earlier than DM Stack 1700. The only prerequisite for performing an update is that the DM Stack to
be updated is at least DM Stack 1000 or higher.
If you are updating a system that has been in use before, you must make a backup of the following
configuration files, as you will have to restore them later:
• <Installation Location>\SAP.DM.TaskEngine.Console.exe.config
• <Installation Location>\SAP.DM.TaskEngine.WinService.exe.config
• <Installation Location>\Log.config
You can update DM SERVER – XBRL SERVICE 10.1 in one step from the current DM Stack to the target DM
Stack. To do so, you have to back up some configuration files, uninstall the current version, install the target
version and then restore the configuration files.
If you are updating a system that has been in use before, you must make a backup of the following
configuration files, as you will have to restore them later:
• <Installation Location>\corepService.ValidationService.dll.config
• <Installation Location>\csfService_ValidationServiceHost.exe.config
• <Installation Location>\Log.config
To uninstall DM SERVER – XBRL SERVICE 10.1, go to Microsoft Windows Control Panel Programs and
Features Uninstall a Program .
• corepService.ValidationService.dll.config
• csfService_ValidationServiceHost.exe.config
• Log.config
You can update DM CLIENT 10.1 in one step from the current DM Stack to the target DM Stack. To do so,
you have to back up some configuration files, uninstall the current version, install the target version and then
restore the configuration files.
To uninstall DM CLIENT 10.1, go to Microsoft Windows Control Panel Programs and Features Uninstall
a Program .
To update DM CLIENT 10.1, install the target version of DM CLIENT 10.1 as described in Installation of DM
CLIENT 10.1 [page 53].
You can update DM XBRL MAPPER 10.1 in one step from the current DM stack to the target DM stack.
To do so, uninstall the current version, and install the target version.
To uninstall DM XBRL MAPPER 10.1, go to Microsoft Windows Control Panel Programs and Features
Uninstall a Program .
To update DM XBRL MAPPER 10.1, install the target version of DM XBRL MAPPER 10.1 as described in
Installation of DM XBRL MAPPER 10.1 [page 64].
You can update the Fujitsu Interstage XWand tool by running the installation of a new version. This
automatically updates/replaces the existing version.
During the installation of or update to DM Stack 900(R) or later, the user Admin is authorized to assign
business roles to users. A business role is required to access Fiori apps on the SAP DM Fiori Launchpad.
Proceed as follows:
1. Log on to the SAP DM Fiori Launchpad (http://[DM Server host name]:[DM Server port]/
Areas/FLP/Content/login.aspx.) with the Admin user.
2. Assign the required business roles using the Business Role Assignment app.
During the installation of or update to DM Stack 900(R) or later, the user Admin is authorized to assign
business roles to users. A business role is required to access Fiori apps on the SAP DM Fiori Launchpad.
Proceed as follows:
1. Log on to the SAP DM Fiori Launchpad (http://[DM Server host name]:[DM Server port]/
Areas/FLP/Content/login.aspx.) with the Admin user.
2. Assign the required business roles using the Business Role Assignment app.
Configure the authentication for a technical database user DM uses to access the database during usage of the
product. The authentication type is the basic authentication, that is, user and password.
Caution
Do not use the option Windows authentication of current user, as it is deprecated. For more information, see
SAP Note 2744381 .
• User: CDMUser
• Password: <Password entered during Application Server Installation>
It is required that you enter the same user that is used for DM SERVER – APPL SERVER 10.1.
The credentials are encrypted and saved to the file SAP.DM.TaskEngine.WinService.exe.config in the
installation folder of DM SERVER – TASK ENGINE 10.1.
You can perform functional and tests after you have installed or updated SAP Disclosure Management
components.
Prerequisites:
Note
You can use an existing period that has few chapters or few data or in a copy an existing period
delete related Excel and Word chapters/data. This is particularly important for any XBRL scenario
where processing times can be important and data consistency impacts validation.
1
DM SERVER – APPL DM website write ac In SAP Disclosure A success message is
SERVER 10.1 cess to the database Management, proceed displayed.
as follows:
Optionally,you can
1. Choose check the content of
Settings the roll forwarded pe
riod in Reports. To do
Periods .
so, select the period
2. Select a test pe
and a report. On the
riod and choose
Cockpit tab, you can
Roll forward.
view the chapters with
3. Enter a period
the associated files.
name, select
dates, and click
Roll Forward.
2
DM SERVER – APPL DM security view In SAP Disclosure You can see a list of
SERVER 10.1 Management, choose permissions and a list
4
DM SERVER – APPL DM web refresh In SAP Disclosure A success message is
SERVER 10.1 Management, proceed displayed.
as follows:
1. On the Report
tab, select a test
period and a re
port containing
Microsoft Word
chapters with da
talinks.
2. Select a test chap
ter.
3. On the Content
Refresh tab, click
Start Refresh.
6
• DM EXCEL TO DM web preview plug- In SAP Disclosure A PDF file opens. You
PDF PLUGIN in for Microsoft Excel Management, proceed can only see data if
10.1 as follows: the chapter was con
8
• DM SERVER – FC-DM push In SAP Financial Close, A success message is
APPL SERVER proceed as follows: displayed.
10.1 1. Choose
• DM SERVER -
General
TASK ENGINE
Options
10.1
External Links .
2.
Note
Valid as of SAP
Disclosure Man
agement SP06.
10
DM SERVER – APPL Batch tool From the SAP Dis The upload of the
SERVER 10.1 closure Management chapter file is success
server installation ful.
folder and with the test
chapter file, adapt and
execute the following
command line:
DMBatchTool.exe
/u:user /
p:password /
h:http://[DM-
Server]:
[Port]/ /
upload /s:"C:\
\Import\\DM\
\20-F\Chapter
1.xlsx" /t:"/
2012 Q4/20-F/
Chapter 1
Example
C:\inet
pub\wwwroot\SA
P\SAP Disclosure
Manage
ment\BatchTool,
run DMBatch
Tool.exe /
u:editor1 /
p:super /h:http://
localhost:1080/ /
upload /s:"Signa
tures_V1.docx" /t:"
/US GAAP 2014/
Form 10-Q/Signa
tures"
11
• DM SERVER – XBRL In SAP Disclosure A success message is
APPL SERVER Management, proceed displayed.
10.1 as follows:
• DM SERVER - 1. On the Report tab,
TASK ENGINE select a test pe
10.1 riod and an XBRL
report.
• DM SERVER -
2. On the General
XBRL SERVICE
tab, select the
10.1 root and click
• EU XBRL CONS. Create.
VAL. PLUGIN 3. .Keep all check
10.1 boxes selected
and click OK.
• EU XBRL EXCEL
4. After several mi
PREV PLUGIN
nutes, when a new
10.1
message is dis
• EU XBRL played, click New
VALIDATION messages 1.
PLUGIN 10.1
• EU XBRL WEB
PREV PLUGIN
10.1
If you run into issues during an installation or update, see Known Issues [page 113]. In some cases, you must
run the Install Tool, which is described in Usage of the Install Tool [page 115].
If the issue you experience is not mentioned explicitly, run the Install Tool.
If none of the above helps you solve the issues, please contact SAP Support, as described in SAP Support
[page 117].
Caution
It is strongly recommended that you do not uninstall DM SERVER – APPL SERVER 10.1 to solve issues.
The following issues may occur during an update to a specific DM Stack under certain circumstances. For more
information, see the related SAP Notes.
Several of the listed notes refer to the Install Tool. Knowledge about the Install Tool is only required if issues
occur. For more information, see Usage of the Install Tool [page 115].
Logon fails with a message All DM Stacks from DM Stack 800 2506938
Logon fails with a Microsoft Internet In All DM Stacks from DM Stack 800 2506938
formation Services page telling “Machi
neSecret is missing in web.config”
Logon fails with a message “You're not All DM Stacks from DM Stack 800 2474986
connected to a network”
Users are not able to login to the 800 Raise a customer message.
DM website via basic authentication al
though the affected users are active
and the credentials used for login are
correct.
Logon to DM website blocked using 700 If you can run your post-installation test
SSO for DM Stack 700 with a non-SSO user
AND you plan to update to a higher DM
Stack in the next step:
ignore this.
Database connection or technical user All DM Stacks See chapter Database Connection
not working [page 117]
Basic Information
The Install Tool is a part of the setup provided with DM SERVER – APPL SERVER 10.1 and is usually run
automatically as a part of the execution of the setup wizard. Technically speaking, the DM Install Tool is an
executable file ("install.exe") that you can find in the \bin folder of the installation directory of DM SERVER
- APPL SERVER 10.1.
If issues occur, you may have to run the Install Tool separately. SAP Notes for solving issues like the ones
described in Known Issues [page 113] often include SQL scripts and/or DLLs that modify the DM database
and/or the files in the DM installation folder. These SQL scripts and/or DLLs replace invalid SQL scripts / DLLs
from the standard version they refer to. The related SAP Notes include detailed information about which files to
replace.
Before DM Stack 1000: run the Install Tool for the installable named in the error log.
As of DM Stack 1000: run the Install Tool for the installable named in the Failed Installable Parts dialog.
Before you run the Install tool, you must create a “dbconnect.temp” file to provide a database connection
string that can be used by the Install Tool. This file must be saved within the \bin folder of the installation
location.
Data Source=WIN-ANFL4JRDDR2\SQLEXPRESS2008R2;Initial
Catalog=DisclosureManagementDB;User Id=sa;Password=MyPassword#1;Integrated
Security=False;MultipleActiveResultSets=True
Execution
As of DM Stack 1000: if parts of the installable you named for execution have been executed before without
errors, these parts will not be executed again. The Install Tool will still run the installable to execute the parts
that have not been run without errors before.
Verification
If errors are displayed in the console output of the Install Tool, see Known Issues [page 113] and search for
further SAP Notes to correct the remaining issue(s). Repeat the execution of the Install Tool applying all files/
descriptions provided by the different SAP Notes.
Note
If you can't access the console output of the Install Tool, for example, because you closed the command
prompt after execution, you can access the same information in the log files in <installation
folder>\Logs\Install Log\.
Next Steps
If all messages shown in the Install Tool’s console output have the Success or Info level, continue with the
verification of the installation described in Checking the Installation [page 23] or Checking the Update [page
98].
If the DM website issues errors when you try to access it via http://<Server Host Name or IP
Address>:<Port Number>/ from any computer in the network, the technical user and/or connection details
DM uses to connect to its database are not working.
To resolve the cases 1, 2 or 3, see Security Guide, chapter “Changing Connection Strings After Encryption”.
To resolve case 4, change the access rights of the technical user to the SQL server and/or database. The
database user needs at least read and write permissions to the database tables but no administrative
permissions.
If you encounter errors not described in Known Issues [page 113], if you can't find any SAP Note mentioning
the issue, or if an additional manual execution of the installation tool as described in Usage of the Install Tool
[page 115] did not help either, please open a customer message under component EPM-DSM-INS and enter the
following information:
Hyperlinks
Some links are classified by an icon and/or a mouseover text. These links provide additional information.
About the icons:
• Links with the icon : You are entering a Web site that is not hosted by SAP. By using such links, you agree (unless expressly stated otherwise in your
agreements with SAP) to this:
• The content of the linked-to site is not SAP documentation. You may not infer any product claims against SAP based on this information.
• SAP does not agree or disagree with the content on the linked-to site, nor does SAP warrant the availability and correctness. SAP shall not be liable for any
damages caused by the use of such content unless damages have been caused by SAP's gross negligence or willful misconduct.
• Links with the icon : You are leaving the documentation for that particular SAP product or service and are entering an SAP-hosted Web site. By using
such links, you agree that (unless expressly stated otherwise in your agreements with SAP) you may not infer any product claims against SAP based on this
information.
Example Code
Any software coding and/or code snippets are examples. They are not for productive use. The example code is only intended to better explain and visualize the syntax
and phrasing rules. SAP does not warrant the correctness and completeness of the example code. SAP shall not be liable for errors or damages caused by the use of
example code unless damages have been caused by SAP's gross negligence or willful misconduct.
Bias-Free Language
SAP supports a culture of diversity and inclusion. Whenever possible, we use unbiased language in our documentation to refer to people of all cultures, ethnicities,
genders, and abilities.
SAP and other SAP products and services mentioned herein as well as
their respective logos are trademarks or registered trademarks of SAP
SE (or an SAP affiliate company) in Germany and other countries. All
other product and service names mentioned are the trademarks of their
respective companies.