1. Help Center
  2. How To's
  3. Engage - Protocol Editor Videos

8. Protocol Editor: Flow value collectors

Flow value collectors are used to gather information entered during the Triage flow in a single location. This information can then be reviewed, added to, or otherwise used in your integrations.

 

Setting up a Flow Value Collector is quite simple and it can easily be tested in Triage to double check it works as expected.

  • A collector is able to collect values that belong to the same graph where the collector is located.
  • It is possible to have multiple collectors within the same graph, as long as they all have unique ID.
  • It is designed to collect and store values as soon as they are selected (entered) by the call taker during the call in Triage. 

That being said, the necessary steps to do so are the following:

1. Create a dedicated view node to host the flowValueCollector

  • It is important to highlight that, although it could potentially be placed anywhere, the primary purpose of this block it to collect desired values to provide an overview of certain parameters to the call taker. 
  • Therefore, this block it is best placed in a view node that has no links to other nodes and pin it, so that is always accessible from the pinned items view in Triage. That being said, you can also host the flowValueCollector in an existing viewnode that is a part of the flow, if you want the call taker to see the contents at a set point in the flow. 

2. Pin it to Triage (if you want the collector to be pinned in the Triage call taker view)

  • In the section dedicated to the 'Node Info' in the sidebar, there is the option to pin the viewnode to Triage by simply ticking the box. 
  • If you have chosen to host this block in a view node that is not connected to the flow, you must pin it to Triage for the call taker to see it, otherwise the block will be hidden. 
  • Pinned items are not available in Graph Preview. To test the functionality you must save the graph and then start a test interview in Triage. 

3. Name the view to quickly identify it in Triage

  • It is also important to give a proper 'publicly visible' name to the view, so that it will be clear what this pinned view is about when opened in Triage.
  • To name the view, first, make sure the correct element is selected. If you are in doubt, from the sidebar you can double-check that the view is selected and colored in light blue.
  • Then go to the 'EDIT CONTENT' section in the sidebar and give it a proper name. 
  • The node has of course to be populated with at least one flowValueCollector block. It is possible to have more than one collector in the same node.
  • The same view can be populated with other block types as well, for example a 'Paragraph' or text block, to add extra information for the call taker so that s/he will clearly understand what kind of values each collector is collecting.

4. Name the flowValueCollector block

  • In case you have 2 or more flowValueCollector blocks, make sure they are all named differently. Otherwise they will all collect the same information. To make sure the right element is selected you can:
    • Double-check that the desired flowValuCollector block is highlighted in light blue
  • Once selected, enter the collector name in the corresponding field. The name given to each collector block is not visible to the call taker but it is nonetheless important as it is used to build the value collection logic. Note down or copy the name you give as you will need it for the next step. 

5. Edit custom attributes accordingly for all the values that you would like the collector to collect

  • At this point, the collector has been set up and it is ready to collect values. We just need to tell it what values to look for, this is done using custom attributes.
  • For example, if you want the collector 'Collector1' to collect values: 
    1. Select the node containing the values you want to collect, and press 'EDIT CONTENT'
    2. Select the block and optionally one of the values (the options) that you would like to monitor and collect.
      1. It is possible to collect values from a multi-select block as well as values from a single-select, simple text or multi-line text block. For select blocks you can choose to collect values from the entire block or only certain selections by click the entire block or induvial options and then adding the attribute. If you add the attribute to the entire block, you don't need to also add the custom attribute to each option.  
    3. Once you have selected a value that you want the collector to collect, click the 'ADD ATTRIBUTE' button.
    4. Edit the custom attributes accordingly.
      1. Each custom attribute is composed of 2 elements, a Key and a Value.   
          1. Key: To point to a flowValueCollector, it must say 'collectorNames'. 
          2. Value: For flowValueCollectors, the value will be the actual collector name you want to use. In this example, that is 'Collector1'.   
    5. Validate and save the graph.
      1. These steps are the very same for any other value that you would like to collect in Collector1. 
      2. You can add as many custom attributes to blocks as you would like. If you'd like to track a value in multiple containers just add a new variable with the same key and adjust the value to the name of the other flowValueCollector block. 

     

6. Test it in Triage or Graph Preview to make sure it has been set up correctly

  • Once the collector and the necessary values logics have been set up correctly, it it time to test the relevant graph in Triage to see if the collectors are working as expected. You can also test in Graph Preview but pinned items will not appear. 
  • Use the 'CREATE A NEW INTERVIEW' to start a new session and test the collector functionality. Make sure you choose the correct graph and version. 

Smart Comments

Smart Comments are a feature that allow you to send additional information, mostly in the form of additional symptom information, directly to the dispatched resource. You will first need to create a flowValueCollector by following the above instructions. Once that is complete you can build the Send Smart Comment Action button by following the below steps: 

1. Create an Action block 

  • You will want to create this somewhere the call taker has access to, so either in a node that is pinned in Triage or a node that is a part of the flow. 
  • Name the action smart-comment-trigger.
    • It must have this exact name to function. 
  • For content name it Send Smart Comment or something similar that will make sense to the call taker.
  • It is highly recommended that you make this action block a component so it can be easily replicated elsewhere without fear of typos. 

2. Add a custom attribute to the flowValueCollector 

  • Locate the flowValueCollector you want to send from.
  • Add a new custom attribute and type the following 
    • For the key: smart-comment
    • For the value: 1

For Smart Comments to function additional back end integration work is required. Please coordinate this with your Corti representative.

Further Reading:

How To Videos - Protocol Editor: Welcome to the Editor

How To Videos - Protocol Editor: Accessing the New Menus

How To Videos - Protocol Editor: The Main Menu

How To Videos - Protocol Editor: Version History and Releases

How To Videos - Protocol Editor: Branches

How To Videos - Protocol Editor: Nodes and Blocks

How To Videos - Protocol Editor: Introduction to logic and basic call flow

How To Videos - Protocol Editor: Link Portal Nodes

How To Videos - Protocol Editor: Text Editing