Retain Module Configuration Setup
Retain cannot do much if it is not connected to something. The module tells Retain how to connect to the email system.
In the module, you tell Retain where the email server is and give it credentials to make the connection. The worker takes the connection information and uses it to enter the email system and dredge the messages for the archive.
Each module has a test connection button to make sure that the information has been entered correctly.
Once you have successfully tested a connection and saved your changes, you will want to go back to the Module Configuration screen and click "Refresh Address Book". In the Configured Modules pane watch for the Status to change to Configured and the Last Address Book Cache to be the current time.
Contents |
Configuration
The online documentation [1] goes through how to setup each module in detail. Retain Module Configuration goes into more detail on each module.
See Also:
Troubleshooting
It is common to have connection issues when setting up a new Retain system and module.
GroupWise
- Check that the Trusted Key Name matches exactly as it is case-sensitive. It is best to copy&paste the Trusted Application Key(TAK).
- Check that the POA Host Name, SOAP port and SSL option matches what the POA is configured for in the GroupWise Administration Console/Console One.
There is the Worker Diagnostic tool found under [retainserver]/RetainWorker/diag/gw
Exchange
On-Premise
- Make sure that the Impersonation User has ApplicationImpersonation role in Exchange Admin Center and that it does NOT have admin rights.
- How To Create The Retain User In Exchange 2013 [2]
- Basic Authentication needs to be enabled on all CAS and mailbox servers.
- Check that the Search Base is set as high as possible for the organization. For example, it is better to use DC=domain,DC=tld then OU=users,DC=domain,DC=tld
If the test is successful there is a utility for enhanced testing you can reach by clicking on the testExchange.jsp link at the end of the Success test or access the Exchange Test from the About page under the Logo
There is the Worker Diagnostic tool found under [retainserver]/RetainWorker/diag/ex
Office365
- In O365 the Impersonation user may have admin rights.
- It is a best practice to setup an SRV record in the DNS to make it easier to find the autodiscover endpoint.
- Creating a DNS SRV record for Exchange / O365 to solve autodiscover errors [5]
One of the recurring issues with O365 installations is that the sync365.ps1 script fails to update the exchangeuser.csv and exchangegroup.csv files. This could be caused by:
- Scheduled Tasks not being setup or not running the script. Make sure that the "Run with highest privileges" is enabled.
- The password has expired or changed for the admin user.
- The user the script is logging in as does not have write rights to the ~\Beginfinite\Retain\RetainServer\WEB-INF\cfg folder.
One element of troubleshooting the script is to run it manually. Run Powershell as administrator, this is found on the taskbar and start by default so it isn't hard to find. Change directory to where the script is, the best place for the script is in ~\Beginfinite\Retain\RetainServer\WEB-INF\cfg, but it can be run anywhere. You can find it in File Explorer and copy the address bar location and paste it by right clicking in the Powershell window (^V doesn't work). For example:
cd "E:\Program Files\Beginfinite\Retain\RetainServer\WEB-INF\cfg"
Now you can run the script manually and it won't close the window so you have time to read the errors. Run the script:
.\sync365.ps1
There should be a thermometer to show it connecting and then another for downloading the data. Finally, the files should be updated.
Yellow text contains warnings, red text contains errors and you'll need to read them carefully to find the issue.
Mobile, BBM, & REST
Retain Router Configuration The Router connects to mobile, BBM and REST.
Next Step
You will need to setup some workers before you can run a job. Proceed to Retain Worker Configuration Setup
Return to Retain Training
