Ideagen Internal Audit (Aura): Configuring an XCOPY or MSI client to mimic ClickOnce's local database and config file auto-update
One of the benefits of using ClickOnce is that when launching Ideagen Internal Audit (Aura) it will check the location from where it was installed for any updates, including to its own config file (vision.exe.config.xml) and local database file (Vision.bak.zip).
Some organisations prefer to use an MSI or XCOPY deployment, and as a result lose this feature.
By making a change to the client configuration file, it is possible to re-introduce this behaviour where MSI or Xcopy are used. The ability to download the latest local database and config as the application launches is extremely useful, as it enables the system to deliver these key files independently of the application itself, enabling an IT team to package the application files well in advance of a change such as an upgrade or customisation.
Implementation steps
The first step is to set up a network location where these files will be downloaded from. The easiest option for this is the standard ClickOnce location of the application instance, because the files can be easily managed via the App Manager there and users will already have access to the path. In this example, it is assumed that:
- The Pentana instance is at http://appserver.domainname.com/PentanaPRD
- The underlying path for this is c:\inetpub\wwwroot\PentanaPRD
Firstly, ensure that a working ClickOnce deployment is in place. This ensures that you have a valid files at:
c:\inetpub\wwwroot\PentanaPRD\Client\XtraDeploy\vision.exe.config.xml
c:\inetpub\wwwroot\PentanaPRD\Client\XtraDeploy\ClickOnceData\Vision.bak.zip
Once the ClickOnce deployment is in place you can amend the configuration file to add the new setting. Open the vision.exe.config.xml for editing:
- Either open the file c:\inetpub\wwwroot\PentanaPRD\Client\XtraDeploy\vision.exe.config.xml in a text editor, or
- Open App Manager, select the correct instance, click [Config] > [Client]
Once the file is open:
- Find the section <Pentana.Tng.UI.Smart>
- Add the following line to the section, using your server name and path):
<add key="XtraDeploy" value="http://appserver.domainname.com/PentanaPRD/Client/" />
So in our example, the section becomes:
<Pentana.Tng.UI.Smart>
<add key="ApplicationTitle" value="Pentana PRD" />
<add key="HelpUrl" value="http://appserver.domainname.com/PentanaPRD/help" />
<add key="XtraDeploy" value="http://appserver.domainname.com/PentanaPRD/Client/" />
</Pentana.Tng.UI.Smart>
- Save the file
You can use this file in an MSI or XCOPY deployment (renaming to vision.exe.config) as normal.
Note that in the MSI or XCOPY client, the folder LocalData should be empty, or there is a risk that an out of date file will be used.
In use
When this updated configuration is included in an MSI or XCOPY package, the following happens:
- The user clicks on the Pentana launch icon
- The Pentana application starts up
- The application downloads the local database file from http://appserver.domainname.com/PentanaPRD/Client/XtraDeploy/ClickOnceData/Vision.bak.zip
- The application downloads the client config file from http://appserver.domainname.com/PentanaPRD/Client/XtraDeploy/vision.exe.config.xml
(this is why it is essential that the config file at the distribution point is valid and has the updated Pentana.Tng.UI.Smart XtraDeploy setting)
Updating vision.exe.config.xml or the local database in the future
If making changes to the client configuration file or the local database (for example after upgrading or running a customisation) it will be necessary to 'rehash' the XtraDeploy location after the change. The easiest way to do this is to continue to maintain the Client download location via App Manager as if ClickOnce is to be used. Rebuilding the local database or saving a change in the Client tab will automatically rehash the deployment.