1. Create a new sandbox and activate the sandbox
2. Click on Edit Global Page Template from Settings and Actions

3. On the screen, select the center header element (see label 1 below)

• • This is the location on the page where the snippet element will be embedded

4. On the bottom of the page, a component editor will appear, you can use your mouse to expand it up about halfway through the page

5. Click on the + icon to add a new component (see label 2 below)

6. Select Components

7. Click + Add next to HTML Markup and then Close

8. Click your new HTML Markup component

• • In the Markup Editor on the bottom, you should see a line that says outputText: New HTML Markup
  • Select outputText: New HTML Markup

9. Click the Edit icon (Gear icon)

10. Click the arrow next to the Value field and select Expression Builder

11. Remove the default value and paste the WalkMe snippet instead

12. Click OK to close the Expression builder

13. Click OK to close the Component Properties

14. Click Close on the top right to exit the editing interface

Pre-requisites

• You must have Visual Builder Studio set up which includes the following:
  • Creating a Visual Builder Studio instance 
  • Assigning users to the correct roles
  • Visual Builder Studio configured correctly for building/deploying applications to your chosen environment

Create a project

Note: These instructions assume that you do not have an existing Project set up that you wish to make the modifications in.

1. In the VB Studio Console go to the Organization tab
2. Click Create above the list of Projects
3. Give your project a name ie “WalkMe Snippet”
4. Select Empty Project
5. Choose defaults for all others or as direct by your Oracle admin
6. Click Finish

Create an Environment

1. In VB Studio Console, open your project and navigate to Environments tab
2. Click Create Environment
3. Give your environment a name and (optional description)
4. Click Create
   • Note: This is a container for an actual Oracle environment. For example: DEV1, TEST, UAT
5. Open the environment and click Add Instance
6. Select the following:
   • Instance Type: Oracle Cloud Applications
   • Authentication Method: Application Credentials
7. Under Add an Oracle Cloud Application using application credentials enter the following:
   • Base URL: The URL users use to access the environment
   • Instance name: A descriptive name for this environment
   • Username: User credentials for an admin with sufficient permissions to develop applications
   • Password: password
8. Click Add
9. Now your instance should be available

Create an Application Extension

1. In the VB Studio Console, open your project and go the Workspaces tab
2. Click New
3. Click New Application Extension
4. Enter the following information in the New Application Extension popup
   1. Extension Name: WalkMe Snippet
   2. Workspace Name: Leave as default
   3. Development Environment: Select the Environment you created earlier, or as directed by your Oracle admin
   4. Base Oracle Cloud Application: Human Capital Management (for the main Oracle HCM Redwood pages)
   5. Sandbox: As directed by your Oracle Admin
   6. Git Repository: Create new repository
   7. Repository Name: walkme (or as directed)
   8. Working Branch Name: development (or as directed)
5. Click Create

Note: Human Capital Management might not be the only application in use where you need WalkMe. If extending this application doesn't cover all areas, see the section at the end of this document: Finding the correct application to extend

Now the Workspace will be automatically opened.

Add the WalkMe Snippet and Deploy

1. If you are not already in the Workspace, open the VB Studio Console and go to: Organization > Projects > Your project > Workspaces > Your workspace
2. Under App UIs, locate the Unified Application
3. Under Unified Application, expect Root Pages and select redwood
4. Click JavaScript tab

5. Paste the WalkMe Snippet (without the <script></script> tags) inside the define function call

6. Click Publish

7. Select Merge now or Merge After review (as directed by your Oracle admin)

8. Add a comment for the Commit Message

9. Click Publish Changes

Note: You may get a warning about the sandbox needing a refresh - we advise customers to do as instructed and refresh before publishing.

10. You should get a confirmation. Click Close

You can check the status of the deployment from VB Studio console > Builds > Job Queue

Note: If you see Waiting for Executor in the Progress column, make sure an Executor has been provisioned under VB Studio console > Organization > Build Executor.

You can create one here if directed by your admin, which may take up to 30 minutes to start up. The deploy job will continue automatically once the Executor is created/started.

Remove (back out) an Extension

1. If you are not already in the Project, open your VB Studio Console and navigate to your project: Organization > Projects > Your project
2. In the navigation menu, click Builds > Builds
3. Enter a unique name under the Name field in the New job dialog box
4. Enter the job's description in the Description field
5. Select System Default OL7 for Visual Builder in Template
6. Click Create
7. On the Job Configuration page, click Configure > Configure
8. Click the Steps tab
9. Select Application from Add Step
10. Select Delete
11. Select the Oracle Cloud Applications instance where the application is deployed in Instance
12. In Username and Password, enter the credentials of an IDCS user who is not only an Oracle Cloud Applications user, but one who can connect and undeploy from the Oracle Cloud Application's production instance
13. In Base Application, Name, and Version, enter the extension's base application, name, and version
14. You can find the details on the Deployments tab of the environment where the extension is deployed
15. Click Save
16. Click Build Now to run a build

Finding the Correct Application to Extend

Choosing the correct application to extend is key to the successful injection. If you extend the wrong application, nothing will happen (well, SOMEONE will get WalkMe, just not where you expect!)

If the pages the customer wants WalkMe on are not part of the Human Capital Management, you'll need to create an additional extension (or multiple) and perform the same process there.

To get started, navigate to the page where you want WalkMe to inject, and inspect the document:

Search the DOM for a script resource called app.json. On the script attribute data-requiremodule it will contain a URL, in the format …/applications/<application name>/app.json

The <application name> is the name of the application you will want to extend: