Who is this article for?

Implementation and Support who want to Disable Retain Sync.

Product knowledge is required.

Customers who have a combined Ideagen Internal Audit (formerly known as Ideagen Internal Audit (Aura)) and Retain/RetainTime system might cease using Retain, meaning that we have to disable the synchronisation.  This article lists the necessary actions.

1. Preparation
2. Application Server
3. Client deployment

1. Preparation

If you use RetainTime, wish to stop and then start using Internal Audit's timesheets, there will be an impact how summary data is calculated.
You should read the following article to make sure you plan accordingly: Ideagen Internal Audit (Aura): What happens to Pentana’s ‘actual time’ data when synchronisation with RetainTime is disabled?

For the decommissioning work:

• All users should be out of the applications.
• Ideagen Internal Audit (Aura) and Retain databases should be backed up and the backups verified.

This process should be run first in UAT and checked for impact, then run in Production.

2. Application Server

In Services

1. Disable and stop the Retain Server services.
2. Stop the Pentana Robot service.

In IIS Manager

1. Stop the Pentana application pools.

In App Manager

1. Connect to the correct instance.
2. Navigate to the Robot tab and connect.
3. In the job list, deselect UpdateRetain and GetFromRetain jobs.
4. Click Save.
5. Run the Disable Retain customisation. 
   If there are any errors running the customisation, stop the process here, revert to the database backup and troubleshoot.
6. Restart the App Pools.
7. Restart the Robot service.
8. Rebuild the local database.
9. If not using ClickOnce, you will need to redistribute the local database via your chosen method.
10. If using the http tunnelling component, you can globally disable the ISAPI component for both UAT and PRD instances, in IIS Manager:
    1. Disable the tunnelling component by going to ISAPI and CGI Restrictions for the server.
    2. Set the ISAPIpass DLL to Not Allowed.

3. Client deployment

With the back end services turned off, Retain will not be usable.

It is not necessary to remove the client application for users in order for it to not be usable, but you may require that this is done straight away. Regardless, it is better to ensure the client is not deployed with the next update to the Ideagen client, so Retain should be removed from the deployment package.

Where App Manager is used to build the client package:

1. In App Manager, go to the Setup tab and note the Customer Files path
2. In File Explorer, find the CustomerFiles folder.
3. Go into the /Client folder for the instance
   1. If Retain is the only content, then delete the /Client folder.
   2. If there is other content in /Client, then delete just the Retain subfolder.
4. The next step is determined by whether you use ClickOnce or your own mechanism for deploying the client.  
   If you use ClickOnce:
   1. Back in App Manager go to the Config tab
   2. In the Client section, click Upgrade.  This will build a new package, which clients will pull down at next start
      
      If you use your own mechanism for deploying the client, then distribute the updated package as normal.

Important Note: It is not necessary to edit vision.exe.config to remove the ribbon buttons.  If the application .exe is not present, Ideagen Internal Audit (Aura) will just ignore the configuration and omit the menu bar button.