This document describes how to repackage localization and configuration files in a the ClickOnce deployment of IFS Data Migration Excel Add-in.
ClickOnce package of the add-in is located at "fndmig\client\officeaddins\fndmigexceladdin". There are three cases where the application files can be changed. All those files are located in the Add-In "AppData" Folder of a ClickOnce version folder. The latest version folder should be considered as it's the folder always referred by the ClickOnce deployment manifest. (eg: fndmig\client\officeaddins\fndmigexceladdin\Application Files\Ifs.Application.Fndmig.ExcelAddin_14000_08120_00002_0)
Add-in is packaged with English user manual file named "User_Manual_en.pdf". If translated documentation is needed to be added, edit "fndmig\nobuild\fndmigexceladdin\User_Manual_en.docx" and save the translated file in pdf format, replacing "en" with relavant IFS two letter language code.
First, scan the language definitions file “FndmigExcelAddin.xml” located at fndmig\nobuild\fndmigexceladdin folder.
Then search repository for the translatable attributes.
Then export the translation files as a special component file.
Exported file FndmigExcelAddin<lang_code>.xml should be placed inside "AppData\Translations".
The application server for the add-in to connect to, can be specified in the server.xml file. If not stated, the end user would have to provide the details when connecting from Excel.
After doing these additions and modifications, ClickOnce application and deployment manifests needs to be updated and re-signed with a certificate key. Two batch scripts which should be used to repackage files into the ClickOnce package are provided inside "fndmig\nobuild\fndmigexceladdin" namely "rebuild_appmanifest.bat" and "update_package.bat"
To run the scripts you need to navigate to the above described “Application Files” directory from Visual Studio 2010 command prompt and run the batch scripts from there giving the latest version folder as a parameter.
First run the rebuild script to recreate the ClickOnce application manifest.
After running the script, some manual changes have to be made to the application manifest file inside the version folder. It is named as “Ifs.Application.Fndmig.ExcelAddin.dll.manifest”
For all newly added files, the attribute “writeableType” has to be included with the value “applicationData”.
It is recommended to increment the version number inside the manifest files after changing a package. Follow the guide to correctly define a version for the repackaged Click-Once package. Replace the version number in the two manifest files (.vsto and .manifest) with the new version number everywhere it occurs. This will be useful if the add-in is already installed in client machines. With the incremented version number Click-Once can automatically upgrade the client installations.
After that, run the update script to update and re-sign the application and deployment manifests.
An appropriate certificate key should be used for the signing process.
