Employee Wellbeing app installation instructions

Installing the Employee Wellbeing apps

• Make sure you have the latest stable version of Service Studio installed. At the least, version 11.7.2.

• Open Service Studio and navigate to the OutSystems tab:
  

• Search in Service Studio Forge for “WB.” You should get several results, but you are interested in three components called WB Backoffice, WB Core, and WB Resources. WB Core and WB Resources are actually back-end dependencies for the rest of the applications. 

• Select WB Backoffice and then click on the “Install…” button on the following page. 

• Once the dependencies for the app have been analyzed you’ll see them in a list. These apps, along with any underlying dependencies will also be included in the install.
  
  Note: You may get a warning that says, “Application cannot be safely installed in your environment.” This is likely due to a reported compatibility issue with OutSystems UI. If OutSystems UI or any other components are listed as Not Compatible, you can open these up individually in the Forge and make sure they are updated to the latest version. If you have already done that, and OutSystems UI still displays as Not Compatible, you can ignore this (this won’t affect functionality) and click Force Install.

• Once all the apps have been installed, navigate back to the Forge Tab, search for “My Wellbeing” and install it in the same way as WB Backoffice.

Configuring the Employee Wellbeing apps

Email SMTP server

• Open Service Center and navigate to Administration > Email.

• Add your Server details and credentials and click Save. The quickest way to apply your changes is to create a solution of all components.

• Navigate to Factory > Solutions and click New Solution. 

• Call it All Components and click Save.

• Click on the Components tab in the middle of the screen, enter an asterisk in the input box, and click Associate All Modules/Extensions.
  

• Click Apply Settings.

• If you need to troubleshoot outbound emails, go to Monitoring > Emails.
  
  

The following features are not mandatory but if you would like to use them, here are some instructions on how to configure them.

Progressive Web App

To use the mobile app as a PWA, you must enable the feature. 

• Click this link to learn more about the feature and now to enable it:
  https://success.outsystems.com/Documentation/11/Delivering_Mobile_Apps/Early_Access_-_Distribute_as_a_progressive_web_app_(PWA)

A note on using PWA on iPhones then you’ll need to enable Web SQL in Safari. 

• To enable Web SQL, go to Settings > Safari > Advanced > Experimental Features and switch off “Disable Web SQL”
  On that note, you can only use this in Safari on an iPhone. There is an imminent release to get around this issue, so stay tuned for an update.

Firebase

To use the chat facility between the back office and the client app, you will need a Firebase API key. Here’s how to get a Firebase API Key:

• Configure the Firebase credentials.

• Create a new Firebase Project. Go to the Firebase console: https://console.firebase.google.com/ (You will need to log in with your Google credentials) and create a new project.

• Click on the Cog icon and choose Project Settings from the context menu that is presented. Copy the Project Id value to the clipboard. 

• Go to Service Studio and open the WB Core app. Open the Employee Wellbeing Core module and click on the Cog icon in the top menu:
  
  This will open the Service Center web app on the Employee Wellbeing Core module page. If this is the first time you have opened the page, you may have to log in first.

• Click on the Site Properties tab in the center of the page. You will see two site properties listed: FirebaseProjectID and Firebase Secret.

• Open the FirebaseProjectID and paste your copied project ID into the text box and click Apply. 

• Next, go back to the Firebase Console and click on the Service Accounts tab and then click on the Database Secrets link as shown below.
  Copy the Database Secret to the clipboard and go back to Service Center. 

• Open the FirebaseSecret site property and paste the value in there (Remove any leading/trailing spaces) and click Apply.

• Finally, create a Realtime Database for your project using this menu.
  
  Follow the on-screen instructions to choose the settings that apply to you.

Google Maps

• API Key: To use the map in the Backoffice dashboard, you need a Google Maps Maps Javascript API key. Here’s a link:
  https://developers.google.com/maps/documentation/javascript/get-api-key

• To add this API key to the Google Maps Mobile, open the Google Maps Library app that was installed as a dependency:.
  
  Inside the app, open the module GoogleMapsMobile and click on the cog icon in the top toolbar:
  
  This will open the Service Center web app on the GoogleMapsMobile module page. If it’s the first time you’ve opened the page, you may have to log in first.
  Click on the Site Properties tab in the center of the page and click on the GoogleMapsServerKey link.
  Enter your API Key in the text box and click Apply.

• Next, you’ll need to make sure that Content Security Policy is disabled. Open up Lifetime and click on the Environments tab.

• Under each environment, click on the “More Security Settings” link and toggle the setting off as shown below: