Who is this article for?

Users of Internal Audit synced to Retain.

No special access or permissions are required.

Ideagen no longer provides guidance on use or configuration of the Retain applications.

In v5.4 of Internal Audit, there some changes to the Retain synchronisation.

This article contains a high level summary of the changes.

1. Standard new behaviours

1.1. Adding booking to Retain

Previously, if Budget Time for an Audit Assignment was set at 0, a booking of one day length would be added to Retain.

In the new release:

• If Budget Time is empty, a booking is not created.
• If the Budget Time is populated, a booking of matching duration is created.
• If the Budget Time is set back to 0, then existing ghost bookings for that job/resource will be deleted.
• If Budget Time is changed from one duration to another, and there is only one Retain booking, then the booking time (but not length) will be updated.
• If an Audit Assignment is deleted, then all Retain ghost bookings for that person/job will be deleted.

2. Optional new behaviours

Numerous optional behaviours have been added, and are turned off by default. Each is a System Setting, and is in Setting Group: Retain.

They all relate to sync’ing planning data back from Retain:

• Retain.UpdatePentana specifies that mapped fields in Retain update Internal Audit, i.e. the opposite of what currently happens. A corresponding set of mappings now exists in the System Settings in addition to the Pentana > Retain set.
  Note that to use this feature, it is necessary to redesign the standard Retain security roles.
• Retain.ActiveAssignments causes: 
  • A booking made in Retain to create an active Audit Assignment.
  • If all of a person’s bookings for a given audit are removed, the Audit Assignment is set to 0.
• Retain.UpdateStartDate causes the Audit Start Date to be refreshed when a Retain booking is made or moved: the booking start date is copied into the Pentana record. If there are multiple bookings, the earliest start date is used.
• Retain.UpdateBudgetTime causes the Audit Assignment duration to be copied from Retain when a booking is updated.

3. Implementing new behaviours

If the system is installed at v5.4, then RetainForVisionTriggers_v5.4.sql  is used during the implementation of Retain v5.2.

If the system upgraded to v5.4 from an earlier version, then RetainForVisionTriggers_v5.4_Upgrade.sql is used against Retain v5.2

The scripts mentioned here are not validated against any version of Retain other than v5.2.