Skip to main content
Mitratech Success Center

DataStoreDSX Installation Procedure

This guide describes the requirements and the installation procedure for a Server Installation, supporting DataStoreDSX, IIS and MS SQL Server.

DataStoreDSX Server - Installation Prerequisites

The following describes the requirements and the installation procedure for a Server Installation, supporting DataStoreDSX, IIS and MS SQL Server. It assumes that the reader has sufficient knowledge of Microsoft Windows Server 2008/2012, Microsoft IIS7-8.5, MS SQL Server 2008/2012 and the DataStoreDSX product suite.

* The server must have Microsoft Windows Server operating system (i.e.2008 or 2012) installed.

* DataStoreDSX is wholly reliant on MS SQL Server being installed on the server or available remotely (SQL client must be installed on the application server).

* The help module is reliant on Microsoft IIS being installed on the server.

* A dedicated Windows user must be created to install and run the DataStoreDSX application. This user must be a member of the Active Directory and it must have local administrative rights on the DataStoreDSX application server.

DataStoreDSX Server Installation Procedure

Please note that all items coloured green are variables, whose value is dependent upon the required configuration of your server.

* Install Windows Server 2008 / 2012 Operating System on the server.

* Install MSSQL Server 2008 or 2012 on the server or make available remotely.

* Create a User profile to be used by the DataStoreDSX service in the Active Directory

E.g. User = DataStoreDSX PWD = **Record password, and set no expiry **

* Ensure the following services have started and set as Automatic

  • World Wide Web Publishing Service (App Server)
  • Distributed Transaction co-ordinator (DB Server if remotely located)
  • SQL Server (MSSQLSERVER)(DB Server)
  • SQL Server Agent (MSSQLSERVER) (DB Server)
  • SQL Server Integration Services (SSIS(App or DB Server)
  • SQL Full-text Filter Daemon Launcher (SQL Server)

Install DataStoreDSX Certificates

Log on to the server with the DataStoreDSX admin user for the remainder of the installation process. Install the certificates into the machine's certificate store

Open Management Console (Start->Run..., type "mmc").

image

On the “Menu bar” click “File” and select “Add/Remove Snap in”. This will display the Add or Remove Snap–ins window.

image

On the Add or Remove Snap–ins window, select the “Certificates snap-in” and click “Add”. This will load the Certificate Snap–ins window.

image

On the Certificates snap –in configuration window, select "Computer Account" add click “Next”. This will take you to the Select Computer configuration window 

image

On the Select Computer configuration window, select "Local computer" and click “Finish”. On the Add or Remove Snap in window, “click OK”.

In the Management Console, you should now see the “Certificates snap in” within the Console Root

image

Expand the tree of certificate stores on the left of the window. Select and right click the mouse button on the "Personal" store and select "All Tasks" and then "Import..." from the context menu. 

image

The Certificate Import Wizard will be launched; “Local Machine” should be selected but greyed out, click “Next”. 

image

The wizard will now let you browse to a location to import a certificate. The certificates are usually located in the Prerequisites folder within the main DataStoreDSX release folder. Browse to “HitecDevWCF.pfx” as the filename of the certificate to install and click “Next”. 

image

You will then have the option to enter security details for the certificate which you are importing .There is no requirement for a password, therefore leave it blank. Tick the box for “Mark the key as exportable” and click “Next”. 

image

On this screen you can select the system area where the certificates are kept.

Check and confirm that the certificate will be placed in the "Personal" store and click Next. 

image

Finally, you will have one more screen to confirm your options. Click “Finish” to close the Certificate Import Wizard

image

A Message Box should pop up advising the import was successful.

image

Follow the steps listed above in order to Import the “HitecCA.cer” into the "Trusted Root Certification Authorities" store in the same way and then close the Management Console window. 

Install DataStoreDSX Server modules.

On the Application Server you will need to create a few folders so that you can copy the release files over.

Browse to C:\Program Files\ create a folder called “Hitec Laboratories Ltd” and within that folder create another folder called “DataStoreDSX” and copy all the files and folders that are in the release folder pack. 

image

Copy the contents of C:\Program Files\Hitec Laboratories Ltd\DataStoreDSX\DataLogics\APDFL10.1.0_64bit\DLE to C:\Program files\Hitec Laboratories Ltd\DataStoreDSX\DSX_Server\Service\ 

Copy the DataStore license file (datastore.lic) to C:\Program files\Hitec Laboratories Ltd\DataStoreDSX\DSX_Server\Service\

Install the DataStore Service.

The DatastoreDSX application requires a service to be created and to run continuously to ensure the application operates appropriately. The service is created by using the “InstallUtil.exe” application which is provided by Microsoft and it should be available in the server environment.

Open a Command Prompt (Start->Run..., type “cmd”) and change directory to:

C:\Windows\Microsoft.NET\Framework64\v4.0.30319\ 

(For DSX v.2.3.65 or lower the path will be C:\Windows\Microsoft.NET\Framework64\v2.0.50727\)

image

Run the command ‘InstallUtil.exe’ “C:\Program files\Hitec Laboratories Ltd\DataStoreDSX\DSX_Server\Service\HitecLabs.DataStore.DataStoreService.exe” to install the DataStore service. NOTE: For DSX 2.5.0.69 or below please run ‘InstallUtil.exe’ “C:\Program files\Hitec Laboratories Ltd\DataStoreDSX\DSX_Server\HitecLabs.DataStore.DataStoreService.exe” instead.

image

The execution should run to its completion and the service will be created. 

Configuring the DataStoreDSX Service

Go to Services (Start->Run..., type “services.msc”) and locate the DataStore service. 

image

Right click on the DataStore Service and select Properties. The DataStore Service Properties configuration window will be displayed. On the General tab, change the “Startup Type” to “Automatic (Delayed Start)”, press “Apply”. 

image

Then switch to the “Log on” tab and select “This account” and enter the relevant User acount for the service and its password and click “Apply”. 

image

A Message Box will pop up confirming the Log On as Service rights. Click “OK” to close the “Message Box”. On the DataStore Service Properties configuration window click “OK”. 

image

Install Database Components & Update .Config Files

The DatastoreDSX application requires a database to be created. This database can reside on the same server as the application server i.e. Local (as long it is fully running SQL server) or alternatively it can reside on a remote/dedicated SQL server. If using a remote SQL server, the “BulkDataItemImport” folder should be specified as a Uniform Naming Convention (UNC) path and the SQL Server Agent service should have the relevant permissions to the “BulkDataItemImport” folder in the application server.

Install the DataStore database using the HitecLabs.Datastore.DatabaseIntegration (executable). The application can be found in C:\Program Files\Hitec Laboratories\DataStoreDSX\DataStoreDatabaseIntegration\.

image

On the “Database Connection” box (on the left hand side of the screen), select the database server from the drop down list and click the “Create Database” button. 

The application will create and upgrade the DataStoreDSX database components and an installation window will open up and display progress.

image

Once completed a Message Box will pop advising the installation is complete. Click “OK” to close the message box. Click “Close” on both remaining DataStore Database Integration windows. 

image

Log on to SQL Server Management Studio (Start->Run..., type “ssms”) and grant the Datastore Service account dbo permissions to the DataStore database

We now need to create an initial sysadmin user. In order to do so we will run the Create sysadmin SQL script.sql located in (C:\Program Files\Hitec Laboratories Ltd\DataStoreDSX\SQLScripts\Admin User Script) against the DataStore database. 

On “Object Explorer” tree view expand “Databases”, Right click on the “DataStore” database and select “New Query”. A “SQL query” box will open on the right hand side. Copy the contents of the Create sysadmin SQL script and press “Execute”. 

image

Once the Query has been executed sucessfully, the query window will have a green tick on the bottom left corner. 

image

Exit SQL Server Management Studio. 

Update the following file C:\Program files\Hitec Laboratories Ltd\DataStoreDSX\DSX_Server\Service\defaultEndpoints.config. 

Perform a global search for “localhost” and replace with the application server name. 

Update the DataStore service configuration file (HitecLabs.DataStore.DataStoreService.exe.config). Edit the connection strings section to reflect the DataSource name: 

<connectionStrings>
    <add name="HitecLabs.DataStore.Server.DatabaseSettings.ConnectionString"
        connectionString="Integrated Security=SSPI;Persist Security Info=False;Initial
Catalog=DataStore;Data Source=Enter Name Here"
    providerName="System.Data.SqlClient" />
    <add name="HitecLabs.MembershipManager.DatabaseServices.Settings.ConnectionString"
        connectionString="Data Source=Enter Name Here;Initial Catalog=DataStore;Integrated
Security=True"
    providerName="System.Data.SqlClient" />
</connectionStrings>

Edit the Database settings section to reflect the two paths below. The BulkImportWorkingDirectory should be located on the application server, and have its path specified in Uniform Name Convention (UNC) if the SQL Server is remote. The “BulkDataImportSSISPackage” should also be located on the application server and again have its path in UNC format if the SQL Server is remote. 

Please make sure you path to the correct packages i.e. “SQL2008R2_SSIS” for 2008 and “SQL2012_SSIS” for 2012.

<HitecLabs.DataStore.Server.DatabaseSettings>
    <setting name="BulkImportWorkingDirectory" serializeAs="String">
        <value>.\BulkImportWorkingDirectory\</value>
    </setting>
    <setting name="BulkDataImportSSISPackageDirectory" serializeAs="String">
        <value>..\..\DatabaseServices\BulkDataItemImport\SQLNNNN_SSIS\Import\Import.dtsx</value>
    </setting>

NOTE: For DataStoreDSX v2.3.65 or greater the “BulkDataImportSSISPackage” setting within the HitecLabs.DataStore.DataStoreService.exe.config file no longer requires for you to specify the package i.e. “SQLNNNN_SSIS\Import\Import.dtsx”. See example below:

<setting name="BulkDataImportSSISPackageDirectory" serializeAs="String">
    <value>..\..\DatabaseServices\BulkDataItemImport\</value>
</setting>

If using a remote SQL Server the “RemoteBulkImport = True” parameter will need adding to the DataStore service configuration file. 

<setting name="RemoteBulkImport" serializeAs="String">
    <value>True</value>
</setting>

Edit the “PDFResourcePaths” to reflect the location of the Service folder. This can be done using a “.\” as below: 

<setting name="PdfResourcePaths" serializeAs="Xml">
    <value>
        <ArrayOfString xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
                <string>.\Resources\CMap</string>
                <string>.\Resources\Font</string>
                <string>.\Resources\Unicode</string>
        </ArrayOfString>
    </value>
</setting>

Although not supported, if running DatastoreDSX on a 32 bit server, the following block should be removed: 

<assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
    <dependentAssembly>
        <assemblyIdentity name="DataLogics.PDFL"
                          publicKeyToken="ec84850197728341"
                          
culture="neutral" />
<bindingRedirect oldVersion="2.2.4940.35047"
                 newVersion="2.2.4940.35079"/>
    </dependentAssembly>
</assemblyBinding>

DataStoreDSX SQL Jobs (Remote SQL Server)

If you are running the DataStore database on a remote SQL Server, the following steps will need to be applied to update the SQL Server Agent jobs appropriately.

When the DataStore database is installed, the “DataStore: Remote Injection” SQL Server Agent job is created:

image

In order for this SQL Server job to run appropriately, it should be updated to reflect the location of the RemoteParent.dtsx SSIS package. To achieve this you will need to edit the job via properties and update step 1 to point to the location of the RemoteParent.dtsx package.

Important: Different package versions exists for SQL 2008 and SQL 2012, ensure you use the correct package for the version of SQL Server that you are configuring.

Go to SQL Server Management Studio and expand the “SQL Server Agent” object from the “Object Explorer” view. Expand the “Jobs” folder and right click on “DataStore: Remote Injection”, select “Properties”. 

image

A Jobs Properties – DataStore: Remote Injection window will be displayed, click on “Steps” from the “Select a page” view and click “Edit”. 

image

A Jobs Properties - step: Call SSIS RemoteParent SSIS Package window will be displayed, select the “Package” tab and update the package path by browsing to the relevant location. 

image

In addition the SQL Server agent job also needs to know the location of the child package “Import.dtsx” To do this click on “Set values” tab and under properties add the following row (property path field): 

\Package.Variables[User::PackageImportFileDataPath].Value

image

Then in the ‘value’ field enter the full path including the file name of the Import.dtsx package. Important: Different package versions exist for SQL 2008 and SQL 2012, ensure you use the correct package for the version of SQL Server that you are configuring. 

image

Injection SSIS Package

Value

\Package.Variables[User::PackageImportFileDataPath]. Value

C:\_Hitec\DataStoreDSX\SQL2012_SSIS\Import.dtsx

The SSIS package “RemoteParent.dtsx” needs to be configured with the database connection string. The Import.dtsx package is passed the database connection string from the remote parent package.

To configure the database connection string for the remote parent package, edit the SQL Server agent job “<DatabaseName> RemoteInjection” and edit step 1. Select the “Set values” tab. Then assign add the following rows (property path field). 

Property Path

Value

Description

\Package.Variables[User::DB_DataSource].Value

.

SQL Server Instance

\Package.Variables[User::DB_Catalog].Value

DataStore

Database name

image

MSDTC Settings

The Microsoft Distributed Transaction Coordinator settings need to be configured on both the application and database servers to allow the following:

√ Network DTC Access

√ Remote Clients

√ Remote Administration,

√ Inbound and outbound communication

√ Mutual Authentication Required.

√ Enable XA Transactions.

Go to Component Services (Start->Run..., type “comexp.msc”). On the “Console Root”, expand “Component Services” -> “Computers”-> “My Computer”. Select “Distributed Transaction Coordinator”, you should now see “Local DTC” in the middle column. 

image

Right click on “Local DTC” and select “Properties”. The Local DTC Properties window will open up. Click the “Security” tab. 

image

On Security tab tick the boxes for “Network DTC access”, “Allow Remote Clients”, “Allow Remote Administration”, ”Allow Inbound”, “ Allow Outbound”, “Mutual Authentication Required” and lastly “Enable XA Transactions” and click “Apply”. 

The MSDTC Service window will be displayed advising restart of service and its impact on applications using MSDTC. 

image

Click “Yes” to restart the MSDTC service. 

A Message Box will open up advising the service has restarted. Click “OK” to close the box. 

image

Click “OK” on the Local DTC Properties window and close the Component Services window. 

Configuring DataStoreDSX Help (IIS Website)

In order to use the Help within the DataStore application you will need to create a website in the application server using IIS (Internet Information Services).

Go to IIS Manager (Start->Run..., type “inetmgr.exe”), in the “Connections” box expand the tree view for your server, and expand “Sites”. Right click on “Default Web Site” and on the context menu select “Add virtual Directory…”

image

An Add Virtual Directory configuration window will open up. Enter “DSXHelp” for the “Alias” field, for the “Physical path” browse to C:\Program files\Hitec Laboratories Ltd\DataStoreDSX\Helpfiles this is the default location for help files. 

image

Click “OK” once you have entered the relevant details. You can test your configuration by selecting one of the applications and click “Browse”. 

DataStoreDSX Client Installation Procedure

ClickOnce Deployment

image

An Add Application Pool configuration box will be displayed. Enter “DSXDeploy” in the “Name” field, select the respective “.Net CLR version” (this will depend on your DSX version) , leave “Managed pipeline Mode” as “Integrated” and click “OK” 

image

It is important to check the settings for the Application Pool and ensure these are correct to avoid issues with deployment. 

On the “Connections” box, go to “Application Pools” and select the “DSXDeploy” pool and right click to select “Advanced Settings…”. Change the setting for “Enable 32-Bit Applications from “False” to “True” and click “OK”. 

image

Now you will need to either add the DSXDeploy pool to the “Default Web Site” where you configured the DSX Help or alternatively you can create a new website for the DataStoreDSX client applications ClickOnce deployment. In this scenario we will create a new site for the ClickOnce deployment of the DataStoreDSX client applications

In order to create a site select and right click on the “Sites” (located in the “Connections” box) and click on “Add Website”. 

An Add Website dialog box will pop up. Enter “DSXDeploy” for the “Site Name”, click “Select” to change the Application pool to “DSXDeploy” and click ok. For the field “Physical path”, browse to your Client applications folder. In some case you may need to change the port number to avoid binding issues. 

image

Click “OK” to start the website. 

As the website is created, you need to add the DSX applications you wish to deploy as virtual directories.

Select the “DSXDeploy” site, click “View Virtual Directories” (located on the right hand side), Click “Add Virtual Directory”. An Add Virtual Directory dialog box will popup. Enter a client application name (such as “Management Studio”) for the “Alias” field, for the field “Physical path”, browse to your relevant client application folder. 

image

Click “OK” and the Add Virtual Directory configuration window will close. Please note you will need to do this for each application you wish to deploy. Therefore repeat the process for each remaining application. 

As the virtual directories have been added to the site, you will need to edit the .exe.config.deploy files for each application. 

Go to C:\Program Files\Hitec Laboratories Ltd\DataStoreDSX\DSX_Client\ClickOnce\ManagementStudio\2.X.X.X\ and “Edit” the “HitecLabs.DataStore.ManagementStudio.exe.config.deploy” file with “Notepad”. Edit the “DSHelpClientURL” string to reflect the correct server name and uncomment the section as indicated

<!-- Remove this comment to setup the online help<HitecLabs.DataStore.Client.Applications.VisualDataStoreHelperLibrary.Properties.Settings>
    <setting name="DSMSHelpURL" serializeAs="String">
       <
value>http://Server/DSXHelp/ManagementStud...mentStudio.htm</value>
    <
/setting>
</HitecLabs.DataStore.Client.Applications.VisualDataStoreHelperLibrary.Properties.Settings>
Remove this comment to setup the online help-->

Edit the “PDFResourcePaths” to reflect the location of the application folder. This can be done using a “.\” as below:

<setting name="PdfResourcePaths" serializeAs="Xml">
    <value>
        <ArrayOfString xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
            <string>.\Resources\CMap</string>
            <string>.\Resources\Font</string>
            <string>.\Resources\Unicode</string>
    </ArrayOfString>

Update the “CurrentSelectedServerHost” with the relevant application server name. 

<HitecLabs.DataStore.Client.ServerHostSettings>
    <setting name="CurrentSelectedServerHost" serializeAs="String">
            <value>Enter server Name</value>
    </setting>

Edit the transport and authentication section to reflect the customer’s requirement. See the options listed below, you must select the appropriate for the customer configuration.

  • Named Pipes can only be used on the server itself
  • HTTP with Custom Authentication (username & password)
  • HTTP with Windows Authentication
  • HTTP for CAS Authentication
  • TCP with Custom Authentication (username & password)
  • TCP with Windows Authentication

For the configuration listed below we will use Windows Authentication (over TCP) 

<! -- Named pipes configuration -->
<!--<client configSource="NamedPipes-windows.config"/>-->

<!-- Username provided authentication over http -->
<!--<client configSource="http-custom.config"/>-->

<!-- Windows Authentication over http-->
<!--<client configSource="http-Windows.config"/>-->

<!-- Cas Authentication over http-->
<!--<client configSource="http-cas.config"/>-->

<!-- Username provided authentication over tcp -->
<!--<client configSource="Tcp-custom.config" />-->

<!-- Windows Authentication -->
<client configSource="Tcp-Windows.config"/>

Once all the applicable configuration files have been edited accordingly, the client applications should be signed using Mage. The Mage utility is not provided in the release files therefore ensure you have a copy of the “Toolkit” folder from \\HITEC-NAS2\DataStoreDSX\Iteration Release Files\Toolkit. Important: Different versions of Mage exist therefore you must ensure you are using the correct Mage utility for the version of DataStoreDSX that you are installing.

It is worth noting that it is possible to configure the Mage utility so that it will always default to using a specific certificate. You will find that configuring the default certificate will save you time as you will no longer have to select a certificate for each signing stage.

In order to configure the default certificate, launch the Mage utility, click “File” and “Preferences…”. A Preferences dialog box will be displayed. Tick the box for “Use default signing certificate” and browse to the Certificate File (.PFX) and click “OK”.

image

Please Note: Each customer will need a certificate to be generated, the Mitratech Engineers will be able to generate the certificate using their SDK.

Whilst the Mage utility is running, click “File” and “Open” and browse to your client application .manifest file (.exe.manifest) and click “Open”. The Mage utility will populate the configuration for the selected .manifests file. (Each .manifest and .deploy files will be located under their respective client application folder). 

image

Ensure the version which you are deploying is correct and click “Save” and click “Close”. 

On the Mage utility, click “File” and “Open” and browse to your client application .manifest file (.application) and click “Open”. The Mage utility will populate the configuration for the selected manifest file. 

image

Ensure the version which you are deploying is correct and click “Description”. 

image

Check Publisher is set to Hitec (Laboratories) Ltd. 

Click “Deployment Options” and set “Application Type” to “Install Locally”. Tick the “Include Start Location (ProviderURL) in the manifest” box. This will allow you to enter a “Start Location” path, enter the web path for your client application deploy file (.application). 

image

Click on “Application Reference” and click on “Select Manifest...”.Browse to your client application manifest file (.exe.manifest). Click “Open” and click “Save” and click “Close”. 

image

Once you have completed the deployment configuration for all client applications you should test your configuration by launching a browser and attemp installing a client application. 

MSI Deployment

Although ClickOnce is the recommended deployment method, you can always create and deploy MSI packages. In order to create MSI packages using “MSIBuilder” you will need to install the WIX toolset which can be found at https://wix.codeplex.com/releases/view/136891.

Before building MSI packages, you need to ensure that the .exe.config files for each client application have been configured accordingly. The path which each application WIX builder project looks into is C:\Program Files\Hitec Laboratories Ltd\DataStoreDSX\DSX_Client\Applications and to its relevant application folder. 

Therefore the .exe.config file should be configured here. See below the sections which usually would require updating: 

<!-- Remove this comment to setup the online help
<HitecLabs.DataStore.Client.Applications.VisualDataStoreHelperLibrary.Properties.Settings>
    <setting name="DSMSHelpURL" serializeAs="String">
        <value>http://Server/DSXHelp/ManagementStud...mentStudio.htm</value>
    </setting>
</HitecLabs.DataStore.Client.Applications.VisualDataStoreHelperLibrary.Properties.Settings>
Remove this comment to setup the online help-->

Edit the “PDFResourcePaths” to reflect the location of the application folder. This can be done using a “.\” as below: 

<setting name="PdfResourcePaths" serializeAs="Xml">
    <value>
        <ArrayOfString xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
            <string>.\Resources\CMap</string>
            <string>.\Resources\Font</string>
            <string>.\Resources\Unicode</string>
        </ArrayOfString>

Update the “CurrentSelectedServerHost” with the relevant application server name. 

<HitecLabs.DataStore.Client.ServerHostSettings>
    <setting name="CurrentSelectedServerHost" serializeAs="String">
        <value>Enter server Name</value>
    </setting>

Edit the transport and authentication section to reflect the customer’s requirement. See the options listed below, you must select the appropriate for the customer configuration.

  • Named Pipes can only be used on the server itself
  • HTTP with Custom Authentication (username & password)
  • HTTP with Windows Authentication
  • HTTP for CAS Authentication
  • TCP with Custom Authentication (username & password)
  • TCP with Windows Authentication

For the configuration listed below we will use Windows Authentication (over TCP) 

<! -- Named pipes configuration -->
<!--<client configSource="NamedPipes-windows.config"/>-->

<!-- Username provided authentication over http -->
<!--<client configSource="http-custom.config"/>-->

<!-- Windows Authentication over http-->
<!--<client configSource="http-Windows.config"/>-->

<!-- Cas Authentication over http-->
<!--<client configSource="http-cas.config"/>-->

<!-- Username provided authentication over tcp -->
<!--<client configSource="Tcp-custom.config" />-->

<!-- Windows Authentication -->
<client configSource="Tcp-Windows.config"/>

Once you completed configuring the .exe.config files for each application, start creating your MSI package. The batch file for creating the client applications can be found in C:\Program Files\Hitec Laboratories Ltd\DataStoreDSX.

Right click on “BuildMSI.bat” and select “Run as administrator”. A command prompt box will open up and the batch file will run and create the MSI packages. 

image

Once the execution is complete, close the Command Prompt window and browse to C:\Program Files\Hitec Laboratories Ltd\DataStoreDSX\DSX_Client\MSI Installer\ to collect or deploy the MSI packages for each client application. You will see that the MSI packages for the Office Add Ins have also been created in the same location. 

image

Office Add Ins deployment (.vsto)

As well as MSI deployment method, the Office Add Ins can be deployed by launching the respective .vsto file. This deployment may look similar to Clickonce; however .vsto applications are not usually launched from a website but instead from a network location. Prior to launching a .vsto file for a DSX Office Add Ins, you need to configure the .dll.config file for each add in and Mage both the .manifest and the .vsto files.

Browse to C:\Program Files\Hitec Laboratories Ltd\DataStoreDSX\DSX_Client\OfficeAddIns\2010 and select the Office Add in you wish to configure. For this example we will select the Excel add in. 

image

Under the Excel folder select and “Edit” the “HitecLabs.DataStore.Office.AddIn.Excel.dll.config” file with “Notepad”. See below the sections which usually would require updating: 

<HitecLabs.DataStore.Client.Applications.VisualDataStoreHelperLibrary.Properties.Settings>
    <setting name="DSISHelpURL" serializeAs="String">
        <value>http://hitec-bldsvr3/DataStoreHelp/I...xingStudio.htm</value>
    </setting>
</HitecLabs.DataStore.Client.Applications.VisualDataStoreHelperLibrary.Properties.Settings>

Update the “CurrentSelectedServerHost” with the relevant application server name. 

<HitecLabs.DataStore.Client.ServerHostSettings>
    <setting name="CurrentSelectedServerHost" serializeAs="String">
        <value>Enter server Name</value>
    </setting>
</HitecLabs.DataStore.Client.ServerHostSettings>

Edit the transport and authentication section to reflect the customer’s requirement. See the options listed below, you must select the appropriate for the customer configuration.

  • Named Pipes can only be used on the server itself
  • HTTP with Custom Authentication (username & password)
  • HTTP with Windows Authentication
  • HTTP for CAS Authentication
  • TCP with Custom Authentication (username & password)
  • TCP with Windows Authentication

For the configuration listed below we will use Windows Authentication (over TCP) 

<! -- Named pipes configuration -->
<!--<client configSource="NamedPipes-windows.config"/>-->

<!-- Username provided authentication over http -->
<!--<client configSource="http-custom.config"/>-->

<!-- Windows Authentication over http-->
<!--<client configSource="http-Windows.config"/>-->

<!-- Cas Authentication over http-->
<!--<client configSource="http-cas.config"/>-->

<!-- Username provided authentication over tcp -->
<!--<client configSource="Tcp-custom.config" />-->

<!-- Windows Authentication -->
<client configSource="Tcp-Windows.config"/>

Once all the applicable configuration files have been edited accordingly, the office add ins should be signed using Mage. The Mage utility is not provided in the release files therefore ensure you have a copy of the “Toolkit” folder from \\HITEC-NAS2\DataStoreDSX\Iteration Release Files\Toolkit. Important: Different versions of Mage exist therefore you must ensure you are using the correct Mage utility for the version of DataStoreDSX that you are installing.

It is worth noting that it is possible to configure the Mage utility so that it will always default to using a specific certificate. You will find that configuring the default certificate will save you time as you will no longer have to select a certificate for each signing stage.

In order to configure the default certificate, launch the Mage utility, click “File” and “Preferences…”. A Preferences dialog box will be displayed. Tick the box for “Use default signing certificate” and browse to the Certificate File (.PFX) and click “OK”.

image

Please Note: Each customer will need a certificate to be generated, the Hitec Engineers will be able to generate the certificate using their SDK.

Whilst the Mage utility is running, click “File” and “Open” and browse to your Office Add In .manifests file (.dll.manifest) and click “Open”. The Mage utility will populate the configuration for the selected .manifest file. (Each .manifest and .vsto files will be located under their respective Office Add In folder). 

image

Ensure the version which you are deploying is correct and click “Save” and click “Close”. 

On the Mage utility, click “File” and “Open” and browse to your client application .vsto file and click “Open”. The Mage utility will populate the configuration for the selected .vsto file. 

image

Ensure the version which you are deploying is correct and click “Deployment Options” and set “Application Type” to “Online Only”. 

image

Click on “Application Reference” and click on “Select Manifest...”.Browse to your client application manifest file (.dll.manifest). Click “Open” and click “Save” and click “Close”. 

image

Once you have completed the deployment configuration for all Office Add In you should test your configuration by launching the respective .vsto and attempt installing the Office Add In. 

DataStoreDSX Modules additional configuration

Document Routing

As DataStoreDSX Product Suite evolves in every product release, some newer modules or features may require additional configuration to operate accordingly. With the release of DataStoreDSX 2.4.68, a new module for document routing was included in the release. This module allows you to route your documents within the Searching Client application. The process of routing design can be accomplished using the “Searching Template Editor” within the Searching Client.

In order to use the Document Routing module your DataStoreDSX licence may need to be updated and you will need to update your “HitecLabs.DataStore.DataStoreService.exe.config” file.

See below the setting in the DataStore service file to enable the document routing. 

<HitecLabs.DataStore.Configuration.TransitionServiceSettings enabled="True" pollInterval="00:05:00"/>

As part of the enhancement to the document routing module, an email notification plugin has been developed. Once configured, the notification will allow the transitioning user to notify other users when transitioning documents to other states.

Create a “Plugins” folder within the “C:\Program files\Hitec Laboratories Ltd\DataStoreDSX\DSX_Server\” in order to place the document routing email notification plugin library file (HitecLabs.DataStore.DocumentRoutingEmailPlugin.dll) and ensure the management studio service plugin path is pointing to the correct folder. 

image

Furthermore, the settings for the email notification plugin are not listed within the DataStore Service .config file; therefore you will need to add these settings in the correct sections. Please take care when entering these settings as if they are incorrectly placed your Datastore service may not start.

Add the following setting within the <configuration> <configSections> just before the end of </sectionGroup>.

<section name="HitecLabs.DataStore.DocumentRoutingEmailPlugin.Settings" type="System.Configuration.ClientSettingsSection, System, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" requirePermission="false" />

The following setting will allow us to configure the sender’s email address, the reply address, the email subject and the body of the email. Please note there are limitations on the body of the email message as there are only certain parameters that we pass. {0} State Name – {1} Transitioning User – {2} Search Template Name.

Within <applicationSettings> add the following setting: 

<HitecLabs.DataStore.DocumentRoutingEmailPlugin.Settings>
    <setting name="FromAddress" serializeAs="String">
        <value>datastore@example.com</value>
    </setting>
    <setting name="ReplyToAddress" serializeAs="String">
        <value />
    </setting>
    <setting name="MessageSubjectTemplate" serializeAs="String">
        <value>New document in {0} state</value>
    </setting>
    <setting name="MessageBodyTemplate" serializeAs="String">
        <value>A document has been moved into the {0} state by {1}.
This document may now require your attention.
You can find the document using the "
{2}" search template.
</value>
     </setting>
</HitecLabs.DataStore.DocumentRoutingEmailPlugin.Settings>

In order to configure the mail server details you will also need to add the following setting. On this setting you will need to add the customer mail server on host= and the port number on port=.

Within <applicationSettings> and just before the end of the file above the </configuration> add the following setting: 

<system.net>
    <mailSettings>
        <smtp deliveryMethod="Network">
            <network
                
host="localhost"
                port="25"
            />
        </smtp>
    </mailSettings>
</system.net>

Unicon Data Pre-Processor

The universal converter (Unicon) is a data transformation application which has been designed to convert COLD data files to the standard expected by DataStore.

Generally, data is downloaded into a directory available to Unicon. The Universal Converter then processes the uploaded data using custom scripts (.scr) to produce data files which can then be archived in DataStore.

image

Unicon has been used a number of times for various DS32 customer implementations and it still used for DSX implementations.

The Unicon application is not provided in the release files therefore ensure you have a copy of the “Unicon32 Release 2.05.06” folder from \\HITEC-NAS2\.

The folder contains 2 files, Unicon.dll and Unicon.exe. No Unicon script files are included.

In order for DataStoreDSX to recognise the presence and to utilize the Unicon application, you must ensure that the “Unicon.dll” file is copied over to C:\Program files\Hitec Laboratories Ltd\DataStoreDSX\DSX_Server\Service\ directory.

A folder called “Unicon” should be created within C:\Program files\Hitec Laboratories Ltd\DataStoreDSX\ and both “Unicon.dll” and “Unicon.exe” files should be copied to the newly created “Unicon” folder. Once the Unicon script files (.scr) have been created, these should also be placed within the C:\Program files\Hitec Laboratories Ltd\DataStoreDSX\Unicon\ directory. Important: Please be aware when configuring the logs path in the Unicon script file, only one folder is supported i.e. Log C:\Logs\convert.txt or Debug C:\Logs\debug.txt.

image

Furthermore please ensure that the Watched Folder Configuration for the relevant Data Definition in DataStoreDSX has UniconPreConversion configured and its respective script file path.

image

DataStoreDSX Optional configuration

Configuring the DataStoreDSX Service (Local Non-Admin Account)

In order to configure the DataStore Service to run as a non admin account you will need to be logged in to the server with the DataStoreDSX admin user for the remainder of the configuration process. Install the certificates into the machine's certificate store

Open Management Console (Start->Run..., type "mmc"),

image

On the “Menu bar” click “File” and select “Add/Remove Snap in”. 

image

An Add or Remove Snap in window will be displayed, add the “Certificates snap-in”. 

image

A Certificates snap –in configuration window will be displayed. Select "Service Account" ad click “Next”. 

This will take you to the Select Computer configuration window. Select "Local computer" and click “Next” 

image

This will take you to the Certificates snap-in configuration window. Select "DataStore Service" and click “Finish”. 

image

On the Add or Remove Snap in window, “click OK”. 

On the Management Console, you should now see the DataStore Service certificates add in within the Console Root window. 

image

Expand the tree of certificate stores on the left of the window. Select and right click the mouse button on the "DataStoreService\Personal" store and select "All Tasks" and then "Import..." from the context menu. 

The Certificate Import Wizard will be launched; Local Machine should be selected but greyed out, click “Next”. The Wizard will now let you browse to a location to import a certificate. 

image

The certificates are usually located in the Prerequisites folder within the main DataStoreDSX release folder. Browse to “HitecDevWCF.pfx” as the filename of the certificate to install and click “Next”.

You will then have the option to enter security details for the certificate which you are importing. 

image

There is no requirement for a password, therefore leave it blank. Tick the box for “Mark the key as exportable” and click “Next”. 

Check and confirm that the certificate will be placed in the "DataStoreService\Personal" store and click “Next” to progress. 

image

Finally, you will have one more screen to confirm your options. Click “Finish” to close the Certificate Import Wizard

image

A Message Box should pop up advising the import was successful. 

image

Follow the steps listed above in order to Import the “HitecCA.cer” into the "DataStoreService\Trusted Root Certification Authorities" store. 

Whilst you have the Management Console application open click on the “Menu bar” click “File” and select “Add/Remove Snap in”. 

An Add or Remove Snap in window will be displayed, add the Certificates snap-in. 

image

A Certificates snap –in configuration window will be displayed. Select "Computer Account" ad click “Next”. 

image

This will take you to the Select Computer configuration window. Select "Local computer" and click “Finish”. 

image

On the Add or Remove Snap in window, “click OK”. 

On the Management Console, you should now see the Local Computer certificates add in within the Console Root window. 

image

Expand the tree of “Local Computer” certificate store on the left of the window and then expand the “Personal” store folder to then click and select the “Certificates” folder. In the next column select and right click the mouse button on the relevant certificate and select "All Tasks" and then "Manage Private Keys." from the context menu. 

image

The Permissions for certificate… window will be launched. Click on “Add” to add the relevant non-admin user account. Once the user account has been added, grant the account with “Full Control and Read” permissions and click “OK”. 

image

Close the Management Console window. 

You will now need to grant the Non Admin account with “Modify” permissions on C:\Windows\Temp\. Once you have granted the permissions it should create ‘DataStore.NETServerAdhocCache’ folder for the non admin user account. Browse to “C:\Windows” and right click on “Temp” folder and select “Properties”. Select the “Security” tab and click on “Edit”. 

image

A Permissions for Temp will be displayed, click on “Add” to add the non-admin account and grant the account with the relevant permissions. 

image

Click “Apply” and click “Yes” on the “Windows Security” window. Click “OK” in the Permissions for Temp window and click “OK” in the Temp Properties window. 

Lastly you will the need to add the non admin user account to the discretionary access control list (DACL).

Open a Command Prompt (Start->Run..., type “cmd”) Run the following command to add the entry to DACL

“netsh http add urlacl url= http://+:8000/ user=SERVER_NAME\Local_user_non-admin_account

image

The “URL Reservation successfully added” message will be displayed. You should now be able to configure the DataStore Service with the non admin account. 

Configuring SearchDisplay Website (IIS Website)

In order to use the Search Display Website you will need to create a website and a respective application pool in the DataStoreDSX application server using IIS (Internet Information Services).

Go to IIS Manager (Start->Run..., type “inetmgr.exe”), in the “Connections” box expand the tree view for your server. Right click on “Application Pools” and on the context menu select “Add Application Pool…”

image

An “Add Application Pool” configuration box will be displayed. Enter “SearchDisplay” in the “Name” field, select the respective “.Net CLR version” (this will depend on your DSX version) , leave “Managed pipeline Mode” as “Integrated” and click “OK” 

image

It is important to check the settings for the Application Pool and ensure these are correct to avoid issues with deployment. 

On the “Connections” box, go to “Application Pools” and select the “SearchDisplay” pool and right click to select “Advanced Settings…”. The “Advanced Settings” window will be displayed, change the setting for “Enable 32-Bit Applications from “False” to “True”. 

image

Whilst you are on the “Advanced Settings” window click on “ApplicationPoolIdentity” value in “Identity” to change its value. An “Application Pool Identity” window will be displayed. Change the setting from “Built-in Account” to “Custome Account” as you will need to use your DataStoreDSX Windows service account. Click “Set…” to enter the relevant username and password on the “Set Credentials” window. 

image

Once you have entered your username and password click “OK” on the “Set Credentials” window and click “OK” on the “Application Pool Identity” window.

Now you will need to create a new website for the SearchDisplay Website and add the “SearchDisplay” Application pool to it. 

In order to create a site select and right click on the “Sites” (located in the “Connections” box) and click on “Add Website”. 

An Add Website dialog box will pop up. Enter “SearchDisplayWebsite” for the “Site Name”, click “Select” to change the Application pool to “SearchDisplay” and click ok. For the field “Physical path”, browse to your Search Display Website folder. In some case you may need to change the port number to avoid binding issues. Click “Ok” once you have entered all the relevant details 

image

Once the website configuration is complete you should see ‘SearchDisplayWebsite’ in the “Connections” list in the left panel as shown in the below screenshot

image

You will now need to configure the Search Display Website “Web.config” file therefore browse to your Search display website folder and edit the “Web.config” file. See below the sections which usually would require updating: 

<appSettings>
    <clear />
    <add key="SearchClientUrl"
value="http://servername/applicationpool/Se...rchingClient.a pplication" />
    <add
key="ReturnFile" value="false" />
</appSettings>

Edit the “PDFResourcePaths” to reflect the location of the application folder. This can be done using a “.\” as below: 

<setting name="PdfResourcePaths" serializeAs="Xml">
    <value>
        <ArrayOfString xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
            <string>.\Resources\CMap</string>
            <string>.\Resources\Font</string>
            <string>.\Resources\Unicode</string>
        </ArrayOfString>
    </value>
</setting>

Update the “CurrentSelectedServerHost” with the relevant application server name. 

<HitecLabs.DataStore.Client.ServerHostSettings>
    <setting name="CurrentSelectedServerHost" serializeAs="String">
        <value>Enter server Name</value>
    </setting>

Once you have made the changes mentioned above save your “Web.config” file and test your configuration. 

See below some of the parameters which you would use for the SearchDisplay Website:

  • Launching URL for Searching Client using UDI (UDI Search)

http://servername/default.aspx?UDI=UDIG0bB7ed1G0oKdAt4F0rm4tG0bB7ed1G0oK

  • Getting the document URL using UDI ( Document will open in native application)

http://servername/default.aspx?UDI=UDIG0bB7ed1G0oKdAt4F0rm4tG0bB7ed1G0ok&GetFile=true

Configuring Reporting Plugins

There are three reporting plugins which can be configured using Management Studio.

  1. DataItem Reporting Plugin
    HitecLabs.DataStore.ReportingDataItemPlugin.dll

  2. 2. Document Inventory Reporting Plugin
    HitecLabs.DataStore.ReportingInventoryPlugin.dll
  3. 3. Document Routing Reporting Plugin
    HitecLabs.DataStore.ReportingRoutingPlugin.dll

To install any of these plugins, you will need the plugin dll along with two other supporting dlls which are;

  • HitecLabs.DataStore.ReportingCommon.dll
  • HitecLabs.TableChangeTracker.dll

Create a folder on the system and copy the required plugin dlls with the other two supporting dlls into this folder.

Configure the path for the plugins against the ‘Service Plug-in Path’, under the ‘Plug-in Options’ in the Management Studio. Use the <Browse> button to select the path of the folder in which the reporting plugins are copied.

Configure the datastore user against the ‘Service Plug-in DataStore User’ which will be used as the user for all the reporting plugin related activites.

After setting the plugin path and the user, ‘Save’ the configured changes.

image

Restart the DataStore DSX service to load these plugins after configuring the plugins in the Management Studio.

The Inventory Report is reconciled daily at a certain time. The start time for the daily reconcilation is controlled by an application setting in the Inventory Reporting Plugin config. The default value of this setting is five minutes past midnight. It can be set to any time as per the requirement of the business.

This setting should be added to the DataStore DSX service config along with the section name.

<applicationSettings>
            <HitecLabs.DataStore.ReportingInventoryPlugin.Settings>
                    <section name="DailyReconciliationStartTime" serializeAs="String">
                            <value>00:05:00</value>
                    </setting>
            </HitecLabs.DataStore.ReportingInventoryPlugin.Settings>
</applicationSettings>

<section name="HitecLabs.DataStore.ReportingInventoryPlugin.ReportingSection" type="HitecLabs.DataStore.ReportingInventoryPlugin.Configuration.ReportingSection, HitecLabs.DataStore.ReportingInventoryPlugin"/>

The information on how to enable/disable the data definitions and search templates for reporting is available in the DataStore DSX Guide under the Section 19.8.4.

  • Was this article helpful?