Skip to Content
Author's profile photo Badrish Shriniwas

How to Centrally Deploy EPM Add-in Connections

Business Case

All the EPM Add-in functions use the connection name as parameter. During the deployment of BPC solution on a wide user base, these connection names should be identical to avoid any errors. Since the connections can’t be deployed or maintained centrally, this leads to lot of manual efforts during the deployment phase of the BPC project.

Solution

The solution is to have the ability to deploy and maintain the connections centrally.

EPM 10 Connection Configuration

EPM 10 Add-in stores the connection details in the Connections.xml file in the folder located in the user profile (C:\Users\%user%\AppData\Local \ EPMOfficeClient). The proposed solution below leverages this file to deploy the connections centrally.

 

File Format

Below is the format of the Connection.XML

Connection File.png

Deployment

The connection details are stored in the tags “<Name>” and “<connection>” in the connection.xml file. These tags can be created manually following the above format or else the entire files can be copied from one machine and moved to user machines. The general strategy would be to copy the file from a central shared network folder location to the user’s machines.

Option 1

The script for copying the file from the network location to the user’s profile (C:\Users\<user>\AppData\Local\EPMOfficeClient) can be executed as the log on script using the group policy.  The script (batch file) will look like the below. The script copies only if the files are not available; this ensures that users can still create their connection after the first time. 

  1. CopyConnection.BAT

if /i not exist
“%USERPROFILE%\AppData\Local\EPMOfficeClient\Connections.xml” copy \\<servername>\CONNECTION\Connections.xml
“%USERPROFILE%\AppData\Local\EPMOfficeClient\Connections.xml”

Copy Connection.jpg

This solution option is very efficient but needs the help of the Network Administrators and their support.

Option 2

The script for copying these file from the network location to the user profile (C:\Users\<user>\AppData\Local\EPMOfficeClient) can be uploaded to the
BPC Web interface in the document folder. Users can execute the batch file to synchronize the connections from the web interface; and the same can be
documented in the user guide.  Below is the script (batch file) for copying connection file to user profile. Note that the files are replaced in this case. You can use the script from option 1 if  you want to avoid replacing the file. 

ReplaceConnectionFile.BAT

 

copy \\NXGPC0015\CONNECTION\Connections.xml “%USERPROFILE%\AppData\Local\EPMOfficeClient\Connections.xml”

Replace Connection.png

BPC Documents folder

Web Page.png

Note: You should allow the .BAT file to be uploaded via the Environment level parameter. Please refer the BPC help for the same.

This solution option is not optimal as there is some manual actions to be performed by the users. But this can be deployed with least help from the Network Administrators.

Assigned Tags

      4 Comments
      Comments are closed.
      Author's profile photo Marc Kuipers
      Marc Kuipers

      Very useful article - thanks!

      Author's profile photo Raj Kandula
      Raj Kandula

      Nice One

      Author's profile photo Former Member
      Former Member

      Hi,

      we are trying to împlement this, but we are facing some issues.

      Adding documents (i.c. the bat file) to the portal almost always gives a "#2032 error".
      Deleting documents throws a cannot delete ReplaceConnectionFile.bat file error
      Executing the bat file from the portal throws cannot find document/directory error. Executing the bat file outside the portal gives the correct result.

      What is the cause of these problems?

      Kind regards,

      christophe

      Author's profile photo Badrish Shriniwas
      Badrish Shriniwas
      Blog Post Author

      The document never designed to be executed from portal. This approach is limited to executing the bat file directly from the client operating system.