The content in this article is appropriate for: Supervisors and Administrators
This article will outline the end to end process of creating a TPO (Third Party Offer).
It is common practice for a Singlecomm AE to set up and test the first instance of a TPO guided interaction and workflow on any SC Workflow platform. This ensures that all of the proper fields have been added. These can then be cloned and customized by following the steps in this article. If you do not have a base TPO guided interaction, contact your AE.
When adding a TPO to any offer, it must first be configured (covered below). Once configured, it can be added to any primary offer.
Covered in this article:
- Customizing the TPO
- Configuring the WorkFlow
- Adding the Session Fields
- Mapping the Guided Interaction
- Mapping the Embed
Customize the TPO Guided Interaction
For more details on building a guided interaction, see the articles located here.
Log in to the SC Workflow platform
- Search the SC Workflow platform for "TPO"
- Clone one of the existing Third Party Offer guided interactions.
- Click the Edit button in the top right to make changes to the Name field.
- The guided interaction should be named TPO [name], with the second part of the name including the vendor and an abbreviation of the specific offer.
- For example: a TPO from a vendor named "Singlecomm" with an offer called "Extra Protection" would be named TPO SinglecommEP
- The guided interaction should be named TPO [name], with the second part of the name including the vendor and an abbreviation of the specific offer.
- Access the Graph by clicking the button in the top right
- Click to view the Constant Fields
- The following Text Input fields must be present on the Constant Slide:
- DispoMode
- value=OFF
*DispoMode is set to OFF because the TPO is not dispositioned. The disposition for the call is set on the primary script.
- value=OFF
- TestMode
- value= Production
- TPOScript
-
- value= the name of the Third Party Offer- For example SinglecommEP
*The TPO consumer integration uses this field to trigger looking for TPOOffer tpo script name. So if this field has SinglecommEP as a value, then the field on the wrap up slide labeled “TPOOffer SinglecommEP” (is yes) will indicate a valid order.
- value= the name of the Third Party Offer- For example SinglecommEP
-
- DispoMode
- The following Text Input fields must be present on the Constant Slide:
- Click the wrench to view the Greeting/Welcome* slide:
*Does not necessarily need to be labelled as such, but in this case simply refers to the first slide that the Agent sees.
- The following fields must be present on the Welcome/Greeting slide:
- TPO Name: [Name field]
- Mirrored from Additional Info slide (First Name Text Input field and Last Name Text Input field) with condition Offer=yes
⚠️ You'll notice that on the Additional Info slide the name is split across 2 Text Input fields rather than using 1 Name field. This is intentional and should be done this way.
- Mirrored from Additional Info slide (First Name Text Input field and Last Name Text Input field) with condition Offer=yes
- TPO Address: [Address field]
- Mirrored from Text Input fields on Additional Info slide (Address Line 1, Address Line 2, City, State, Zip) with condition Offer=yes
- TPO Phone: [Text Input field]
- Mirrored from the Phone Text Input field on Additional Info slide with condition Offer=yes
- TPO Email: [Text Input field]
- Mirrored from the Email Text Input field on Additional Info slide with condition Offer=yes
This is optional, as not all TPO scripts require email.
- Mirrored from the Email Text Input field on Additional Info slide with condition Offer=yes
- Offer: [Radios field]
- This can be re-labeled to suit your needs, but must contain an explanation of the third party offer and Yes/No radio buttons (used for setting the conditions on TPO Name, TPO Address, TPO Phone, and TPO Email)
- Terms and Conditions: [Radios field]
- This field must contain all T&C and Yes/No radio buttons, and must be recorded.
- TPO Name: [Name field]
- The following fields must be present on the Welcome/Greeting slide:
- Click the wrench to view the Additional Info slide:
- The following text fields must be present on the Additional Info slide:
- Agent Name
- ANI
- Agent Id*
- Agent Call Id*
- DNIS*
- Root Call Id*
- savvypitch_txnid*
*These fields can instead be mapped on the embed node of the workflow, however it is easier and more efficient to have them mapped here. - First Name -note that this is captured in a separate Text Input field and not a combined "Name" field
- Last Name -note that this is captured in a separate Text Input field and not a combined "Name" field
- Address Line 1 -note that this is captured in a separate Text Input field and not a combined "Address" field
- Address Line 2 -note that this is captured in a separate Text Input field and not a combined "Address" field
- City -note that this is captured in a separate Text Input field and not a combined "Address" field
- State -note that this is captured in a separate Text Input field and not a combined "Address" field
- ZIP -note that this is captured in a separate Text Input field and not a combined "Address" field
- Email (optional, not all TPOs require email capture)
- NextScript -When the TPO Picker integration initiates, it checks to see if a TPO is available to be offered. If a TPO is available, the integration populates this field with the URL for the TPO.
- TxnId**
- Message**
- Success**
- Password**
**These fields are used when the order is passed through an api. If sent in batch files, these fields are NOT used and do not need to be included.
- The following text fields must be present on the Additional Info slide:
-
Credit Card Capture: [Credit/Debit Card field] must be on a separate slide so that it is not recorded.
CC info CAN NOT be transferred from the Primary script to this TPO script. - TPOOffer tponame: [Radios field] this field must be located on the Wrap Up slide, and should be labeled with "TPOOffer" and the name of your TPO.
- For example TPOOffer SinglecommEP
- Yes/No radio options will record whether or not your have a valid offer
The TPO consumer is checking this field for valid orders to be sent to the vendor.
- Click Save on the Graph to save all updates to the slides in the guided interaction, then Close to return to the home page
Configure the WorkFlow
Access the WorkFlows module in the left-hand navigation bar
From an Existing WorkFlow:
(If you are creating a WorkFlow from scratch, skip to the next section)
Like the guided interaction, your platform likely has a TPO workflow that was initially configured by your AE. Search for and clone that workflow.
- Click the Edit button in the top right to make changes to the Name field.
- The workflow name should match the guided interaction name
- Access the Graph by clicking the button in the top right
- Click and drag a new Guided Interaction node onto the graph
- On the New Guided Interaction pop-up, click the dropdown and select your TPO, then click Save to return to the graph
- Delete the connection to the existing script and create a new connection from the embed to your TPO
- Remove the old guided interaction from the graph by clicking the X in the top right corner of the node.
- Click and drag new connections from the guided interaction to the TPO Consumer
- Click Save and exit the graph
From a New WorkFlow:
For more details on building a Workflow, see the articles located here.
- Click the New Workflow button
- Add the TPO Name and click Create
- Access the Graph by clicking the button in the top right
- Click and drag a new Embed node onto the graph, then click the wrench to access settings
- Choose a Partner from the dropdown list and click Update to save
- Click and drag a new Guided Interaction node onto the graph
- On the New Guided Interaction pop-up, click the dropdown and select your TPO, then click Save to return to the graph
- Click to drag an Integration onto the graph
- Select the Integration Library
- Choose your TPO Consumer from the dropdown list
This is NOT a standard consumer. This consumer puts the TPO data into a third party database. - Click to drag another Integration onto the graph
- Select Integration Library again, and this time choose your TPO Picker from the dropdown list.
This allows for chaining more than one TPO to the product script. - Click and drag to add the following connections between the nodes:
- Click Save and exit the graph
Add the Session Fields
- Click the Sessions tab and click Edit
- Click Session Fields
- Scroll to the bottom and click Auto add Guided Interaction fields
- Select your TPO Guided Interaction from the dropdown to map the fields
- You may see that certain fields already exist on the workflow, and new fields that were mapped will be shown underneath
- Scroll to the bottom and click Update to save
Map the Guided Interaction
- Return to the WorkFlow graph and click the wrench on the Guided Interaction node
- Click Auto map
- Scroll down and manually map any remaining fields by matching them in the dropdown to the right
- Click Save to return to the graph
Map the Embed
- Click the wrench on the Embed node
- If using an existing workflow, click the Parameters tab and ensure that everything is mapped
- If you have a new workflow, the parameters must be mapped individually by clicking Add parameter
- Type in your Identifier and then choose the corresponding Session Field from the dropdown
🛑 The embed node is mapped differently. Parameters to match are:-
-
address_city = City
-
address_line1 = Address Line 1
-
address_line2 = Address Line 2
-
address_postal_code = Zip
-
address_state = State
-
agent_call_id = Agent Call Id
-
agent_id = Agent Id
-
agent_name = Agent Name
-
ani = ANI
-
dnis = DNIS
-
first_name = First Name
-
last_name = Last Name
-
phone = Phone
-
root_call_id = Root Call Id
-
-
- Click Update to save
✅ Important Notes Regarding TPOs:
- When building a new TPO, the name of the TPO Offer and the URL from the WorkFlow MUST be provided to the ProServ Team so that it can be added to the TPO Picker and TPO Consumer integrations.
- When a new TPO is built, it is tested which includes sending test files to the TPO client. Once tested, the TPO can be attached to any primary guided interaction. The only testing needed is to verify that the TPO script pops with the name and address populated from the primary script.
Comments
0 comments
Please sign in to leave a comment.