Upgrade to Engage Major Release 1 -2023

Mar 30, 2024

To begin the upgrade to the Engage Major Release 1 - 2023, you must enter a ticket with the Service Team to receive the link to the new Solution.

Please choose the category of Engage: Upgrade Request for the ticket.

Import the New Solution

Log into the environment you would like to upgrade, specifically logging in as System Administrator.

1. Click Settings.

2. Click Advanced Settings.

3. On the new window/tab, click Settings > Solutions.

4. Verify you have an earlier version of Salentica Engage installed, then click Import.

5. Click Choose File.

6. Select the Engage Solution you downloaded/received from the Salentica Team.

7. Click Next.

8. Click Next again.

9. Make sure the following options are selected:

a. Solution Action: Upgrade (recommended)

b. Previous customizations on components included in this solution: Maintain customizations (recommended)

c. Post Import Actions: Checked Enable any SDK message processing steps included in the solution

10. Click Import.

The solution will start importing. This step will take about 30-45 minutes to complete, so enjoy your coffee or tea!

Confirm the Uninstallation of the Old Solution

After the new solution has been imported, the old solution of Engage needs to be uninstalled before you can install the Flow Solutions. In order to check the status of the old solution, under Settings, you can go to Solutions History. It can take up to 15 minutes for the old solution to be uninstalled, and you can refresh the view periodically to verify the uninstall before following the next steps to install the Flow Solutions.

Post Installation Steps

Major Release 1 has a few simple steps, post-install, necessary for either an update or an upgrade. Please work with the Support team if you have a non-standard build or extensive customizations.

Delete Pre-Existing Flows Solutions

Note: Pre-existing flow solutions should always be deleted prior to the installation of new flow solutions.

⚠️ Customizations will be deleted if any are present. Information regarding the flows to delete may vary by environment.

1. Click Settings.

2. Click Advanced Settings.

3. On the new window/tab, click Settings > Solutions.

4. Select the Solutions and click Delete. Delete the following Flow Solutions:

SalenticaEngage_WorkflowManager
Salentica_Compliance_Flows

Install New Flow Solutions

Install new Flow Solutions files provided by the Support Team to replace those deleted and add new Power Automate Flows.

1. Click Settings.

2. Click Advanced Settings.

3. On the new window/tab, click Settings > Solutions.

4. Click Import.

5. Select the file for the new Workflow Manager Solution and click Next.

6. Click Next.

7. Leave Maintain customizations and Enable any SDK message processing steps included in the solution enabled.

8. Click Import.

9. Repeat steps 1-8 for each of the following Flow Solutions:

Compliance Flows
Email Toast Notification Flow
Govt ID Expiration Date Reminder Flow
Weekly Clear Notification Table Flow
Salentica Engage Expansion 1.0.0.3 (Plugin)
Investment Accounts Flow
Close Open Tasks Deactivated Workflows Flow. Note: Import this flow last to prevent errors.

Verify the On/Off State and Connection References of the Flows

Verify the On/Off status after import to confirm. All the latest flow solutions are pre-configured with the necessary connection references, ensuring seamless integration and saving you the time and effort of setting them up manually.

Please note that the following features are shipped with their default state set to “turned off” allowing you the flexibility to “turn them on” at your convenience.

Verify On/Off Status

1. Log in to make.powerapps.com.

2. Select the Environment you want to verify.

3. Select Flows.

4. Click on the Flow name you wish to verify and view the Status. If turned on it will show a Status of On.

Turn On Flow and Update Connection Reference

1. If turned off, click the pencil icon next to the name of the Flow to Edit.

2. Click Continue under the Connection Reference.

3. Click Save.

4. Click the back arrow and your Flow is turned on.

Update the App ID in the Email Related Flows

Note: The following two Power Automate Flows send emails with hyperlinks that need to be edited to function properly in your environment. These flows are optional. If you choose to use these flows, please ensure they are activated and the reference connections are set. Be aware that these flows require a Microsoft Outlook user license to send emails.

There are two Power Automate Flows that are designed with email template variables that contain a quick access link to the record. In the quick access link (hyperlink) the app ID must be updated according to your firm's org once the flow solution has been imported into your environment. Note: The links in these notification emails will not function without editing the flows. The notifications will still send but links do not work without the updates below.

Government ID Expiration Data Reminder Flow Update

1. Go to make.powerautomate.com and sign in with your administrator credentials.

2. Verify the environment you want to make changes to.

3. Click Solutions.

4. Look for 'SalenticaEngage_GovtID_ExpirationDateReminderFlow_1_0_0_1_managed' and click on it.

5. Click on the name of Flow to be taken to the details screens.

6. Click Edit. Click Edit with Designer.

7. Scroll down to the step labeled 'Travers All Active Contacts Records', and click to expand it.

8. Look for a Condition Step named 'Check Driving License and Passport Expiration Date For Email Body' and expand it.

9. Yes and No branches will be displayed. On the Yes branch, click the 'Set Email Body For Both Driving License and Passport Expiration Date Variable' step.

10. Here, you will find a code snippet written in HTML. In the code, find the following line: <a href="@{outputs('Parse_HyperLink_of_Application')}/main.aspx?appid=14ba5001-7975-e911-a82b-000d3a365fc2&pagetype=entityrecord&etn=contact&id=@{items('Travers_All_Active_Contacts_Records')?['contactid']}">Click Here to View Contact Record</a>

11. Replace the appid in the line above with the new appid from your current Engage environment.

a. Get the App ID. Open your Engage environment in your browser in a new tab.

b. Navigate to any Contact record. In the address bar of your browser, find the 'appid' in the URL It will be in format

https://.../main.aspx?appid=xxxxx-xxxx-xxxx-xxxx-xxxxx&....

c. Copy this 'appid'.

d. Paste the copied 'appid' into the line located below to replace the current data.

12. Click Save.

13. Move to the No branch under 'Check Driving License and Passport Expiration Date For Email Body', expand the Condition Step named "Check Driving License Expiration Date is not null and less then 30 days".

14. In the nested 'Yes' branch, locate the 'Set Email Body For Driving License Expiration Date Variable' step and click on it.

15. Again, you will find a code snippet written in HTML. In the code, find the line that includes your appid and the phrase 'Click Here to View Contact Record'. The line looks like this: <a href="@{outputs('Parse_HyperLink_of_Application')}/main.aspx?appid=14ba5001-7975-e911-a82b-000d3a365fc2&pagetype=entityrecord&etn=contact&id=@{items('Travers_All_Active_Contacts_Records')?['contactid']}">Click Here to View Contact Record</a>

16. Replace the appid in the line above with the new appid from your current Engage environment, just like in step 11.

17. Click Save.

18. Go to the nested No branch under 'Check Driving License Expiration Date is not null and less then 30 days' condition.

19. Expand the 'Check Passport Expiration Date is not null and less then 183 days' condition and navigate to the 'Yes' branch.

20. Locate the 'Set Email Body For Passport Expiration Date Variable' step and click on it.

21. Here, you will find another HTML code snippet. In the code, find the line with your appid and the phrase 'Click Here to View Contact Record': <a href="@{outputs('Parse_HyperLink_of_Application')}/main.aspx?appid=14ba5001-7975-e911-a82b-000d3a365fc2&pagetype=entityrecord&etn=contact&id=@{items('Travers_All_Active_Contacts_Records')?['contactid']}">Click Here to View Contact Record</a>

Replace the appid in the line above with the new appid from your current Engage environment, following the same steps as in step 11 above.

22. Click Save.

23. Click Save at the top of the screen to save all changes to the Flow.

Note: You may see a warning that these changes are going into an unmanaged layer, but this is expected and not an issue.

Engage Email Toast Notification Flow

1. Go to make.powerautomate.com and sign in with your administrator credentials.

2. Verify the environment you want to make changes to.

3. Click Solutions.

4. Find and click the solution 'SalenticaEngage_Email_Toast_Notification_Flows_1_0_0_1_managed'.

5. Click on the flow named 'SalenticaEngage_Email_Toast_Notifications_Task_Flow'.

6. Click Edit. Click Edit with Designer.

7. Find and click on the condition step named "Due Date Condition" to expand it. This condition step branches into two paths: 'Yes' and 'No'. Under each branch, you will edit a respective nested step.

8. Under the Yes branch, find the "Set Due Date Does Not Contain Data Variable" step. Click to expand the details.

9. In the HTML code box, you'll be updating the line with <a href="@{outputs('Parse_HyperLink_of_Application')}/main.aspx?appid=14ba5001-7975-e911-a82b-000d3a365fc2&pagetype=entityrecord&etn=task&id=@{outputs('Get_Task_Record')?['body/activityid']}">Click Here to View Task Record</a>. You need to replace the 'appid' value with the one that corresponds to your current Engage environment.

10. Replace the appid in the line above with the new appid from your current Engage environment.

a. Get the App ID. Open your Engage environment in your browser in a new tab.

b. Navigate to any Task record. In the address bar of your browser, find the 'appid' in the URL It will be in format

https://.../main.aspx?appid=xxxxx-xxxx-xxxx-xxxx-xxxxx&....

c. Copy this 'appid'.

11. Return to the Power Automate Flow and replace the 'appid' in the HTML code box with the one you've just copied.

12. Click Save.

13. Under the No Branch, find the "Set Due Date Contains Data Variable" step. Click to expand the details.

14. Similar to the previous step, in the HTML code box, you'll be updating the line with <a href="@{outputs('Parse_HyperLink_of_Application')}/main.aspx?appid=14ba5001-7975-e911-a82b-000d3a365fc2&pagetype=entityrecord&etn=task&id=@{outputs('Get_Task_Record')?['body/activityid']}">Click Here to View Task Record</a>. You need to replace the 'appid' value with the one that corresponds to your current Engage environment.

15. Open your Dynamics 365 environment in your browser. Navigate to any task record. In the address bar of your browser, find the 'appid' in the URL. It will be in the format <https://.../main.aspx?appid=xxxxx-xxxx-xxxx-xxxx-xxxxx&....> Copy this 'appid'.

16. Update the HTML code. Return to the Power Automate Flow and replace the 'appid' in the HTML code box with the one you've just copied.

17. Click Save.

Enable In-App Notifications in Power Apps

This step is necessary for the Email Toast Notification Power Automate Flow to send in-app notifications.

1. Log in to make.powerapps.com with your System Administrator credentials.

2. Select the correct Environment to update.

3. Select Solutions.

4. Select the Commands menu next to Salentica Engage.

5. Select Edit.

6. Select the Settings gear icon.

7. Switch to the Features Tab.

8. Enable In-app Notifications.

9. Select Save.

10. Select Publish.

You have successfully turned on In-app Notifications.

Import Agent Types CSV into Record Type Manager

Import the new Agent Type records via the CSV file provided by our Support Team.

1. Log in to Engage.

2. Click Engage at the bottom left of the screen.

3. Click Engage Settings.

4. Under Additional Control Tables, click Record Type Manager.

5. Click the dropdown next to Import from Excel and select Import from CSV.

6. Select the file you downloaded from Support.

7. Click Next.

8. Click Review Mapping.

9. Click Finish Import.

Congratulations! You have upgraded to Major Release 1- 2023 and can now utilize the new and advanced features!