Excel Client:Installation: Difference between revisions

From CoPlanner 11
Jump to navigationJump to search
No edit summary
No edit summary
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
__TOC__
__TOC__
The Setup package consists of the following files:
<br>
:*setup.exe
:*CopAddinSetup.msi
:*CoPlanner 9.1 and higher: Install.bat
:*The folder KB908002


Please run setup.exe to start the installation procedure. The folder KB908002 contains the Microsoft .Net Framework Update components that are required for running an Automation Add-In. This update is an official extension of the .Net Framework 2.0 and is created and supported by Microsoft.  
The installation setup for the Excel Client 1.0 will be run by double-clicking the executable file ''CoPlanner Excel Client 1.0.msi''.


{| {{Bausteindesign1}}
{| {{Bausteindesign1}}
|-
|-
| <span style="color: darkblue;">'''Hint'''</span> &nbsp;If the computer on which you are installing the CoPlanner Excel Client already contains the previous version, CoPlanner Com-Client, please verify before starting the Setup procedure that the file excel.exe.config is located in the same folder as excel.exe.  
| <span style="color: darkblue;">'''Hint'''</span> &nbsp; To ensure a clean installation, make sure before starting the installation that no CoPlanner Excel client is already installed on your system. If this is the case, uninstall it before reinstalling.  
|}
|}




Excel.exe is located in the Microsoft Office installation folder. The default installation folder is C:\Program Files\Microsoft Office. Depending on your version of Microsoft Office (XP, 2003, 2007), the name of the subfolder that contains excel.exe will be Office10, Office11, or Office12.
== Installation steps==


If you find the file excel.exe.config in this folder, please delete the file. This file causes Microsoft Excel to be started under the .Net Framework runtime 1.1. However, the CoPlanner Excel Client requires the runtime of .Net Framework 2.0.
Start the installation by starting the client 1.0.msi CoPlanner Excel file. A wizard guides you through the installation.


If you are installing the CoPlanner Excel Client via setup.exe and you see an error message indicating that there is no connection to the Internet, please proceed as follows: Cancel the setup routine. Manually install the setup packages located in the folder KB908002. Then continue installing the Excel Client by means of CopAddinSetup.msi. Please note that you must install the components of the folder KB908002 before you install the Excel Client. You do not need to install the office2003-kb907417sfxcab-ENU.exe package unless you are running Microsoft Office 2003.
{| class="wikitable" width={{{breite|70%}}}
 
|- {{Tabellentitel}}
 
|width="40%" |Installation step
==Installation steps==
|width="60%" |Description
 
CoPlanner 9.0 and older versions: Start the installation procedure by running setup.exe.
 
CoPlanner 9.1: Start the installation procedure by running install.bat. You must have local administrator rights to be able to run this setup procedure.
 
The following dialogue will be displayed to inform you that the .Net Framework Update components are required and will now be installed.
 
{| {{Bausteindesign1}}
|-
|-
| <span style="color: darkblue;">'''Hint'''</span> &nbsp;The user running the setup routine must have local administrator rights. The CoPlanner Excel Client must be installed separately for each NT user. To make the Excel Client available for more than one user on the same computer, the MSI package must be run for each user. (For details, please see the section on Installing Excel Client for more than one user.) 
|[[Image:EC1_Installationsdialog_1.png|thumb|center|Excel Client, Installation step 1]]
|}
|Startscreen of the installation
 
 
To ensure that the CoPlanner Excel Client is available in Microsoft Excel, macro security (Developer tab, Code group, Macro Security button) must be set to Medium or Low.
Click on the “Install” button to install the required components on your computer.
 
 
 
{| style=cellspacing="1" cellpadding="5" border="0" width={{{breite|100%}}}
|-
|-
|[[Image:Excel setup 1.jpg|thumb|left]]  
|[[Image:EC1_Installationsdialog_2.png|thumb|center|Excel Client, Installation step 2]]
|Click on the “Install” button to install the required components on your computer.
|Licence conditions must be accepted in order to proceed the installation
|-
|-
|[[Image:Excel setup 2.jpg|thumb|left]]  
|[[Image:EC1_Installationsdialog_3.png|thumb|center|Excel Client, installation step 3]]
|The following dialogue reports the status of the .Net Framework Component installation procedure. After the components have been successfully installed, CoPlanner Excel Client setup will be started.
|The installation directory of the Excel client can be changed
|-
|-
|[[Image:Excel setup 3.jpg|thumb|left]]  
|[[Image:EC1_Installationsdialog_4.png|thumb|center|Excel Client, installation step 4]]
|Click the “Next >” button to continue installing the CoPlanner Excel Client.
|Installation will be started
{| {{Bausteindesign1}}
|-
|-
|[[Image:Excel setup 4.jpg|thumb|left]]
| <span style="color: darkblue;">'''Hint'''</span> &nbsp;Therefor you need administration rights.
|Installation notes. Click the “Next >” button to continue installing the CoPlanner Excel Client.
|}
|-
|-
|[[Image:Excel setup 5.jpg|thumb|left]]  
|[[Image:EC1_Installationsdialog_5.png|thumb|center|Excel Client, installation step 5]]
|In this dialogue you can specify the folder to which you want to install the CoPlanner Add-In. Select the desired installation folder, then click the “Next >” button to continue installing the CoPlanner Excel Client.
|Overview of the status of the install procedure.
|-
|-
|[[Image:Excel setup 6.jpg|thumb|left]]  
|[[Image:EC1_Installationsdialog_6.png|thumb|center|Excel Client, installation step 6]]
|Your install settings are now complete. The dialogue shows that Setup is now ready to install the Add-In. Click the “Next >” button to continue the installation procedure.
|Dialog for entering the server connection
{| {{Bausteindesign1}}
|-
|-
|[[Image:Excel setup 7.jpg|thumb|left]]  
| <span style="color: darkblue;">'''Hint'''</span> &nbsp;That dialog does not appear if in the installation directory is already the configuration file [[Excel Client:Connection to server|ClientConfig.xml]] configured for the Excel client.
|Overview of the status of the install procedure.
|}
|-
|-
|[[Image:Excel setup 8.jpg|thumb|left]]  
|[[Image:EC1_Installationsdialog_7.png|thumb|center|Excel Client, installation step 7]]
|In the next screen, you will be asked for the server name and the port number.
|Confirmation of a successful installation
This information is saved in the file [[Technics:CoPlanner_Win-Client#ClientConfig.xml|ClientConfig.xml]] in the target install folder and can be changed afterwards using the CoPlanner Excel Client by users who have write privileges.
|}
|}
<br> <br>


==Installing Excel Client for more than one user ==


===CoPlanner 9.0 and older versions===
The file Silent_install.bat is also used for the Excel Client installation. There you don't have to go through the steps, as decribed above, you went through the installation in one step without displaying a user interface. For this the [[Technics:CoPlanner_Win-Client#ClientConfig.xml|ClientConfig.xml]] is used which is in the same directory. This must be configured accordingly. This type of installation is preferably carried out when the Excel client will be rolled out on multiple systems without any interaction by a user.


To install the Excel Client for a user who does not have local administrator rights, the Excel Client must first be installed on the machine by a user who has administrator rights on the computer.
As the necessary registrations are performed during installation by the administrator, the user for whom the Excel Client will be made available must start the installation process by running the file CopAddinSetup.msi.


The installation steps are the same as those described in [[Excel_Client:Installation#Installation_steps|installation steps]]. After completing the installation procedure, the user will be able to access the CoPlanner Excel Client.
{| {{Bausteindesign1}}
|-
| <span style="color: darkblue;">'''Hint'''</span> &nbsp;Frequently asked questions about the installation, see the [[Excel_Client:FAQs|FAQs]].
|}
<br>


===CoPlanner 9.1 and higher===


The CoPlanner Excel Add-In is automatically made available for all users when it is installed by running install.bat.  
====Installation with parameters (from 9.5 HF 3.5)====


{| {{Bausteindesign1}}
Starting with version 9.5 HF 3.5 Add-Ins can be installed via command line using parameters. If no parameter(s) is/are given installation will act as before.  
|-
| <span style="color: darkblue;">'''Hint'''</span> &nbsp;After installation, the CoPlanner Excel Add-In may not be immediately visible, as it will not be activated for the current user until MS Excel is started. If you cannot see the add-in, please close and restart MS Excel to display the new menu item.
|}




==Extended configuration==
The following parameters can be used:


EThe file Cop.AddIn.dll.config, which is included in all versions 2007-11-20 and higher, offers extended configuration options. This file is placed in the target install directory during setup. The structure of the file corresponds to that of an App.exe.config file.
*COP_SERVER
*COP_PORT
*COP_MAXROWS
*COP_MAXCELLS
*COP_TCPFORMATTER
*COP_SSLCOMMONNAME
*COP_LANGUAGES


The following extended configuration options are available:
Example:


msiexec /i CoPlannerExcelClient_v1.0.msi COP_SERVER=ServerXY COP_PORT=8965 COP_LANGUAGES="Deutsch|English"


*&lt;add key="logonProperties.showPlan" value="True"/&gt; <br>Show/hide Select Plan dialogue at login time<br>
*&lt;add key="logonProperties.showLanguages" value="True"/&gt;<br>Show/hide Select Language dialogue at login time<br>
*&lt;add key="logonProperties.showUnternehmen" value="True"/&gt;<br>Show/hide Select Company dialogue at login time <br>
*&lt;add key="layoutProperties.Filtercolor" value="C9D2EA"/&gt;<br>Filter colours <br>
*&lt;add key="layoutProperties.FilterMainColor" value="F0EEE1"/&gt;<br>Main filter colour <br>
*&lt;add key="layoutProperties.SpaceBewtweenFilter" value="4"/&gt;<br>Distance between individual filters <br>
*&lt;add key="compatibility.PreventCustomMouseCursorVisualisation" value="False"/&gt;<br>Activate/deactivate extended mouse cursor on drag & drop <br>
*&lt;add key="SSPITimeOut" value="180"/&gt;<br>Client timeout (in seconds) at SSPI login <br>
*&lt;add key="CommandTimeOut" value="0"/&gt;<br>Command timeout (in seconds) for data requests. 0 means no timeout for data requests.<br>
*&lt;add key="MatrixBuilder.RefreshDataAfterFilterChangeSelectable" value="true"/&gt;<br>&lt;!-- “Filter changes – load data immediately” can be activated by means of a check box in the matrix builder. Note: Used only if activated in host interface as well! --&gt;<br>
*&lt;add key="MatrixBuilder.RefreshDataAfterFilterChangeSelection" value="true"/&gt;<br>&lt;!-- “Filter changes - load data immediately” can be activated by means of a check box in the matrix builder. Note: Used only if activated in host interface as well! This setting determines the default value and is used only if Analyzer.RefreshDataAfterFilterChangeSelectable ==true --&gt;<br>


__NOEDITSECTION__
__NOEDITSECTION__
[[category:Excel_Client|Installation]]
[[Category:Excel_Client|Installation]]
[[de:Excel_Client:Installation]]
[[de:Excel_Client:Installation]]

Latest revision as of 15:15, 15 April 2019


The installation setup for the Excel Client 1.0 will be run by double-clicking the executable file CoPlanner Excel Client 1.0.msi.

Hint   To ensure a clean installation, make sure before starting the installation that no CoPlanner Excel client is already installed on your system. If this is the case, uninstall it before reinstalling.


Installation steps

Start the installation by starting the client 1.0.msi CoPlanner Excel file. A wizard guides you through the installation.

Installation step Description
Excel Client, Installation step 1
Startscreen of the installation
Excel Client, Installation step 2
Licence conditions must be accepted in order to proceed the installation
Excel Client, installation step 3
The installation directory of the Excel client can be changed
Excel Client, installation step 4
Installation will be started
Hint  Therefor you need administration rights.
Excel Client, installation step 5
Overview of the status of the install procedure.
Excel Client, installation step 6
Dialog for entering the server connection
Hint  That dialog does not appear if in the installation directory is already the configuration file ClientConfig.xml configured for the Excel client.
Excel Client, installation step 7
Confirmation of a successful installation


The file Silent_install.bat is also used for the Excel Client installation. There you don't have to go through the steps, as decribed above, you went through the installation in one step without displaying a user interface. For this the ClientConfig.xml is used which is in the same directory. This must be configured accordingly. This type of installation is preferably carried out when the Excel client will be rolled out on multiple systems without any interaction by a user.


Hint  Frequently asked questions about the installation, see the FAQs.



Installation with parameters (from 9.5 HF 3.5)

Starting with version 9.5 HF 3.5 Add-Ins can be installed via command line using parameters. If no parameter(s) is/are given installation will act as before.


The following parameters can be used:

  • COP_SERVER
  • COP_PORT
  • COP_MAXROWS
  • COP_MAXCELLS
  • COP_TCPFORMATTER
  • COP_SSLCOMMONNAME
  • COP_LANGUAGES

Example:

msiexec /i CoPlannerExcelClient_v1.0.msi COP_SERVER=ServerXY COP_PORT=8965 COP_LANGUAGES="Deutsch|English"