Refer Strings

Configure the Hidden Components

Configure four Hidden components to store the following parameters: User ID, Role, Expire Measure, and Expire Offset.

1. In the Module Builder, drag and drop four Hidden components onto the canvas.

2. In the Property ID and Label Text fields, enter the following for each component:

   #	Property ID	Label Text
   1	userId	userId
   2	role	role
   3	expireMeasure	expireMeasure
   4	expireOffset	expireOffset

3. Click Save Component after adding each component.

Configure the Calculator Component

Now, add a Calculator component to set the expireOffset parameter. Doing so lets you easily update the length of time the refer string is valid.

1. Drag and drop a Calculator component onto your canvas, placing it below the expireOffset Hidden component.

2. In the Property ID and Canvas Label Text fields, enter calcOffset.

3. In the Outputs table, enter the following:

   Property ID	Formula
   expireOffset	=7

   

   This configuration sets the expireOffset to 7 with an expireMeasure of days, which you configure in the next step. So, refer string expires after 7 days.

4. Click Save Component.

Configure the Initializer Component

Next, add an Initializer component to set the parameter values in the following ways:

• Sets the User ID, Role, and Expire Measure parameters, while triggering the Calculator component to set the Expire Offset parameter. These are the same parameters that you referenced in your Hidden components earlier.

• Triggers the pluginCreateReferString Plug-In component, which calls your refer string API endpoint.

1. Drag and drop an Initializer component onto your canvas, placing it above your Hidden components.

2. In the Property ID and Canvas Label Text fields, enter initParameters.

3. From the Trigger Type drop-down, select New Submission.

4. In the Outputs table, enter the following:

   Property ID	Type	Value
   role	value	Authenticated
   userId	value	0000000abc
   expireMeasure	value	days
   calcOffset	trigger	GO
   pluginCreateReferString	trigger	GO

   

   You configured a userId value of 0000000abc for demonstration purposes only. You can enter any value you want.

5. Click Save Component.

Configure the Text Field Component

Add a Text Field component to store the result of the refer string, which is the result of an API call.

1. Drag and drop a Text Field component onto your canvas, placing it below your calcOffset Calculator component.

2. In the Property ID field, enter referString.

3. In the Label Text field, enter Refer String.

   In normal instances, you might set this component as hidden. But for this example, you’ll leave it visible so you can review the results.

4. Click Save Component.

Configure the Plug-In Component

Add a Plug-In component to call the refer string API endpoint.

1. Drag and drop a Plug-In component onto your canvas, plaing it above your referString Text Field component.

2. In the Property ID and Canvas Label Text fields, enter pluginCreateReferString.

3. In the Inputs table, enter the following:

   Property ID	Mapping	Required
   userId	userId	(checked)
   expireMeasure	expireMeasure	(checked)
   expireOffset	expireOffset	(checked)
   role	additionalParams.role	(unchecked)

   The Mapping column matches the parameters for the refer string API call.

4. In the Outputs table, enter the following:

   Property ID	Mapping	Option
   referString	referString	replace

5. From the Internal Services drop-down, select Generates an Encrypted Referstring for Authentication. The Request Type and Data Source URL auto-populate.

   

6. Click Save Component.

Configure the Decisions Component

Remember, a refer string on its own is not useful. So, you must add the refer string to a URL that your end-user can navigate to in the browser. So, you’ll use a Decisions component configured with a concatenate formula to achieve this task.

1. Drag and drop a Decisions component onto your canvas, placing it below your referString Text Field component.

2. In Property ID and Canvas Label Text fields, enter ruleURL.

3. In the Inputs table, enter the following:

   #	Property ID	Type
   1	referString	exact

4. In the Outputs table, enter the following:

   #	Property ID	Type
   1	referURL	value

   This Property ID corresponds to the Text Field component you’ll add in the next step. This component is where the Decisions component stores the concatenated URL.

5. In the Conditionals table, enter the following:

   referString	referURL_value
   	=CONCATENATE('https://trainingx.unqork.io?refer=', referString, '#/display/5e9f83275349fc020f8db299')

   

   The first cell must remain blank as shown. The formula in the second cell uses the following URL structure: <hostname>?refer=<referstring>/#/display/<moduleID>. Here, the <hostname> is https://trainingx.unqork.io, and the <moduleID> is 5e9f83275349fc020f8db299.

6. Click Save Component.

Configure the Text Field Component

Lastly, add a second Text Field component to store your full URL.

1. Drag and drop a Text Field component onto your canvas, placing it below your ruleURL Decisions component.

2. In the Property ID field, enter referURL.

3. In the Label Text field, enter URL with Refer String.

4. Click Save Component.

5. Save your module.

Below is how your module looks in the Module Builder:

With the above steps complete, your module generates a unique refer string for each new end-user and displays in the referString Text Field component. You also see the full concatenated URL in the URL with Refer String Text Field component:

You can test your work by copying the URL and logging out of the Training environment. Then, paste the full URL into your browser to gain access to the module immediately. For comparison, the URL without the refer string is https://trainingx.unqork.io/#/display/5e9f83275349fc020f8db299. If you visit this URL while logged out, you’ll navigate to the login screen. If you need to test the API call portion of the lab again, log back into the Training environment.