Optional Upgrade Guides (Sequoia v5.16)

Upgrade Guides for plugins

Note: This is not an installation guide.

Sequoia v5.16 includes enhancements to various plug-ins which you can choose to upgrade. As a user who is already using any of the following plug-ins, you should be aware that they will not have been automatically upgraded by the Sequoia installer and will continue to work as they did before. If you would like to take advantage of the enhancements in the new plugins, you will need to upgrade these by following the applicable guide(s) below.

The process of upgrading Sequoia plug-ins is moderately technical but with care should be easily accomplished without technical assistance. To follow this guide, you should have appropriate access to the machine hosting the Sequoia Server software and you need to upgrade to Sequoia v5.16 and ensure that your installation is working as expected.

The file system path to the Sequoia Server installation folder is referred to as [SequoiaServerPath] in these guide, and is typically located in c:\Program Files (x86)\Sequoia Server, but this path may have been customised by your system administrator during the installation process. You will need to know where these services are located before continuing.

You must stop the 'Sequoia Service Monitor' and the 'Sequoia Event Processing services' (in that order).
- You can do this by browsing the Services using the Windows Services application.

File Document store

Sequoia v5.16 Enhancement: Ability to output the CDS Import Declaration Report

Within the [SequoiaServerPath]\EventProcessingService folder, locate the 'FileDocumentStore' sub-folder and back up this folder somewhere outside of the [SequoiaServerPath] parent directory (maybe in your documents folder, or another temporary location). You will need a copy of the original files later on.
- To 'back-up' the folder, you will need to copy it and paste it in another location as directed. This will create copy of the folder and it's contained files, and will be used during the upgrade process, and also to repair your plug-in if the upgrade fails.
- The backup is to ensure that you can continue working by rolling back in the eventuality that the upgrade fails.
- If you do not perform a backup of this folder, it is likely that it will not be possible to roll your installation back, and the plug-in will need to be re-configured again which may take some time and require assistance from the ASM helpdesk.
Delete the '[SequoiaServerPath]\EventProcessingService\FileDocumentStore' folder (again, you should have backed it up first).
Download the new plugin zip file from here.
Extract the content of this zip file to the location of the original folder '[SequoiaServerPath]\EventProcessingService'.
- This will have the effect of re-creating the folder '[SequoiaServerPath]\EventProcessingService\FileDocumentStore' which contains the new plug-in files.
Copy the 'ASM.Sequoia.EP.Processor.Config.xml' config file from your backup location and overwrite the config file in the '[SequoiaServerPath]\EventProcessingService\FileDocumentStore' directory to retain your original settings.

File System Report Broker

Sequoia v5.16 Enhancement: Ability to output the CDS Import Declaration Report

Within the [SequoiaServerPath]\EventProcessingService folder, locate the 'ReportBroker' sub-folder and back up this folder somewhere outside of the [SequoiaServerPath] parent directory (maybe in your documents folder, or another temporary location). You will need a copy of the original files later on.
- To 'back-up' the folder, you will need to copy it and paste it in another location as directed. This will create copy of the folder and it's contained files, and will be used during the upgrade process, and also to repair your plug-in if the upgrade fails.
- The backup is to ensure that you can continue working by rolling back in the eventuality that the upgrade fails.
- If you do not perform a backup of this folder, it is likely that it will not be possible to roll your installation back, and the plug-in will need to be re-configured again which may take some time and require assistance from the ASM helpdesk.
Delete the '[SequoiaServerPath]\EventProcessingService\ReportBroker' folder (again, you should have backed it up first).
Download the new plugin zip file from here.
Extract the content of this zip file to the location of the original folder '[SequoiaServerPath]\EventProcessingService'.
- This will have the effect of re-creating the folder '[SequoiaServerPath]\EventProcessingService\ReportBroker' which contains the new plug-in files.
Copy the 'ASM.Sequoia.EP.Processor.Config.xml' config file from your backup location and overwrite the config file in the '[SequoiaServerPath]\EventProcessingService\ReportBroker' directory to retain your original settings.
Finally, to enable the new functionality, the 'ASM.Sequoia.EP.Processor.Config.xml' config file will need to be modified as follows:
- Using a text editor such as Notepad, open the 'ASM.Sequoia.EP.Processor.Config.xml' config file.
- The document is written in XML. Within the XML document, find the report element. It will start with <reportNames> and will end with </reportNames>.
  - XML is a very simple markup language which is designed to be interpreted by both humans and machines, but if you don't understand XML, just try to follow along. If you are unable to follow along, then please contact the ASM helpdesk for assistance.
- Find the ending </reportNames> tag and make a copy the last nested <reportName> element, from and including the start tag all the way to and including the closing tag </reportName>.
- Modify the report tag you have copied and do the following:
  - Change the value for the reportName element to CdsImportDeclarationReport.
- Your XML document should have a section in it that now looks a bit like this...
```
    <reportName>SFDDTI-E2</reportName>
    <reportName>SFDDTI-H2</reportName>
    <reportName>CdsImportDeclarationReport</reportName>
  </reportNames>
  <printHandledReports>false</printHandledReports>
```
Save the XML file
- If elevated privileges required, save the file to your desktop and copy it manually to overwrite the file you were trying to save. Doing it this way, you will still be prompted to provide credentials in order to perform the restricted operation.

Email Report Broker

Sequoia v5.16 Enhancement: Ability to output the CDS Import Declaration Report

Within the [SequoiaServerPath]\EventProcessingService folder, locate the 'EmailReportBroker' sub-folder and back up this folder somewhere outside of the [SequoiaServerPath] parent directory (maybe in your documents folder, or another temporary location). You will need a copy of the original files later on.
- To 'back-up' the folder, you will need to copy it and paste it in another location as directed. This will create copy of the folder and it's contained files, and will be used during the upgrade process, and also to repair your plug-in if the upgrade fails.
- The backup is to ensure that you can continue working by rolling back in the eventuality that the upgrade fails.
- If you do not perform a backup of this folder, it is likely that it will not be possible to roll your installation back, and the plug-in will need to be re-configured again which may take some time and require assistance from the ASM helpdesk.
Delete the '[SequoiaServerPath]\EventProcessingService\EmailReportBroker' folder (again, you should have backed it up first).
Download the new plugin zip file from here.
Extract the content of this zip file to the location of the original folder '[SequoiaServerPath]\EventProcessingService'.
- This will have the effect of re-creating the folder '[SequoiaServerPath]\EventProcessingService\EmailReportBroker' which contains the new plug-in files.
Copy the 'ASM.Sequoia.EP.Processor.Config.xml' config file from your backup location and overwrite the config file in the '[SequoiaServerPath]\EventProcessingService\EmailReportBroker' directory to retain your original settings.
Finally, to enable the new functionality, the 'ASM.Sequoia.EP.Processor.Config.xml' config file will need to be modified as follows:
- Using a text editor such as Notepad, open the 'ASM.Sequoia.EP.Processor.Config.xml' config file.
- The document is written in XML. Within the XML document, find the report element. It will start with <reports> and will end with </reports>.
  - XML is a very simple markup language which is designed to be interpreted by both humans and machines, but if you don't understand XML, just try to follow along. If you are unable to follow along, then please contact the ASM helpdesk for assistance.
- Find the ending </reports> tag and make a copy the last nested <report> element, from and including the start tag all the way to and including the closing tag </report>.
- Modify the report tag you have copied and do the following:
  - Change the value for the reportName element to CDS Import Declaration Report.
  - Change the value for the reportType element to CDSI.
  - Change the value for the enabled element to true.
- Your XML document should have a section in it that now looks a bit like this...
```
  <report>
    <reportName>Export SAD/Security Document C88</reportName>
    <reportType>ESS</reportType>    
    <enabled>false</enabled>
  </report>
  <report>
    <reportName>CDS Import Declaration Report</reportName>
    <reportType>CDSI</reportType>    
    <enabled>true</enabled>
  </report>
</reports>
<recipients>
```
Save the XML file
- If elevated privilages required, save the file to your desktop and copy it manually to overwrite the file you were trying to save. Doing it this way, you will still be prompted to provide credentials in order to perform the restricted operation.

After upgrade

Start the 'Sequoia Event Processing services' and then the 'Sequoia Service Monitor' (in that order).
- You can do this by browsing the Services using the Windows Services application.
Test that everything still works. If everything works to your satisfaction, remove the files in the backup folder.

My plugin is no longer working - how do I rollback?

You must stop the 'Sequoia Service Monitor' and the 'Sequoia Event Processing services' (in that order).
- You can do this by browsing the Services using the Windows Services application.
Backup the folder you have been modifying (the sub-folder of [SequoiaServerPath]\EventProcessingService that you have been working on), remove this folder entirely and copy back the files from the back-up you took at the start of this guide.
- If you did not take a back-up, then you will need to have the plug-in re-installed. You will need to contact the ASM helpdesk to assist you.
Start the 'Sequoia Event Processing services' and then the 'Sequoia Service Monitor' (in that order).
In this instance, contact the ASM helpdesk to assist you with upgrading your plugin.