language



Customize your scripts and increase your impact

Scripts bring structure to your online sessions and increase your impact. You will achieve higher conversion rates and instant results. We encourage you to make use of scripts. It’s easy - just use one of our public scripts.

The more advanced option is to create your own scripts using XML code. XML may seem a bit difficult. However, if you are willing to spend a little time and follow the next steps, you can do it as well.

Have fun with your first customized script.

Introduction

A script consists of a number of building blocks, which we call „nodes", put in a logical order. We have nodes for:

  1. Presenting documents, in the most common formats such as pdf, word, powerpoint;
  2. Filling in a form to complete e.g. a questionnaire or gather data from your customer;
  3. Making choices, used for options determining the next step;
  4. Sharing your screen;
  5. Showing templates or embedded content like videos;
  6. Sending emails. This is useful to confirm a follow up meeting or to send documents;
  7. Download a template as PDF document;
  8. Signing documents;
  9. Uploading files;

The functionality to create your own scripts is available for Idiligo Business and Plus users.
For creating and modifying scripts you need administrator rights.

Start creating your own script in XML

To create your own script go to "Manage Scripts" and click "New". Each script has a unique number and a description. The number of the script is given automatically, and can be modified manually. Fill in a logical description for the script, like: "sales pitch new customers".


Copy the following code in your script:

<flow> 	 
<nodes>
 ... 
</nodes> 
</flow>

That's it, you've have created the basic structure. Now you can start filling the script with the nodes. The dots can be replaced by the nodes.

 

Advanced invisible

 

Nodes are visible to the participant of the session. In case you want to make the node invisible add the parameter visible="false" to your node:

 <node id="Checkingdata" type="Form" visble="false">  

 

Advanced goto

 

At the end of the Node you can indicates where to go to next by adding:

 <goto>Node3</goto>

Present a document

Copy the following code to your script:

<node id="Mypresentation" type="File"> 
<name>The presentation</name>
<attachments>
   <attachment fileCode="01preso" attach="true"/>
</attachments>
</node>

Step -1- Make sure the node id is unique.
Step -2- You can give the node a descriptive name.
Step -3- Add a document to the Document Library with an identical <fileCode>.

 

Advanced:

Multiple documents can be added to the node. Just copy the attachment line, change the second fileCode and add an additional document to the Document Library.

During the session you can toggle between the documents. 

Fill in a form

The node "Form" is there to get information from your customer. In this node you can ask questions and gather data.


Copy the following code to your script:

<node id="Checkingdata" type="Form"> 
<name>customer info</name>
<title>Details about the customer</title>
<text>Complete the following</text>
<fields>
   <field name="company name" text="Company" />
   <field name="gender" text="mister / miss">
   <options>
      <option value=" "><text> </text></option>
      <option value="mister"><text>mister</text></option>
      <option value="miss"><text>miss</text></option>
   </options>
   </field>
   <field name="family name" text="Last name" />
   <field name="birth names" text="First name" />
</fields>
</node>

Step -1- Make sure the node id is unique
Step -2- You can give the node a descriptive name
Step -3- Change the title, it will be visible on top of the screen
Step -4- Change the text, it's the subtitle and visible
Step -5- Change the fields: The field name is the name of the database field. The text is the name appearing on the screen.

 

Advanced: system field names

Idiligo has system field names, which can be used in forms. Those system field names can be used by adding the parameter linkedField="...". 

Example: <field name="relation name" text="Name of the relation" linkedField="contact:Full Name" />

For a complete overview of all available system field names see below.

 
Advanced: Re-using the fields:
The information collected by fields can be re-used in templates or documents.
You can use these fields for example in a template: Dear [flow:gender] [flow:family name].
Next to the fields collected in a session, the system fields can be used (see below an overview of all system field names).
 
Advanced: Drop-down field:
The field “gender” in the example above is an example of a “drop-down” field with a few possible options.
The options start with <options> and end with </options>.

Note that this field does not end with a / but with a </field>.
 
Advanced part 2

  1. You can adjust the width and the height of a field by specifying rows=”X” cols=”Y”
    <field name="companyname" text="Company name" linkedField="relation:Company Name" rows="2" 
    cols="60"/>
  2. You can make fields mandatory. A mandatory field must be filled in before you can go to the next step.
    <field name="companyname" text="Company name" linkedField="relation:Company Name" 
    mandatory="true"/>
  3. A separate text line can be made by adding the field type rowWithtext, example:
    <field name="header" text="Your details" type="rowWithText"> </field>
  4. The text of a field can be enhanced with:
    Bold: place the text between **
    Italic: place the text between *
    Line break: add 7 ^^^^^^^
    Tab: use >
    Picture: use ![text](link of the picture)

Example:

<node id="Checkingdata" type="Form"> 
<name>Customer info</name>
<title>Details about the customer</title>
<text>complete the following</text>
<fields>
   <field name="company name" text="Company^^^^^^^if applicable" />
   <field name="gender" text="mister / miss">
   <options>
      <option value=" "><text> </text></option>
      <option value="mister"><text>mister</text></option>
      <option value="miss"><text>miss</text></option>
   </options>
   </field>
   <field name="family name" text="**Last name**" />
   <field name="birth names" text="*First name*" />
   <field name="hobby" text="![lounger](https://idiligo.com/fileadmin/media/Pictures/100f030b_2.jpg) hobby" />
</fields>
</node>

Making choices

The node "choice" let you jump to different nodes of your choice.
 

Copy the following code to your script:

<node id="Mychoice" type="Choice"> 
<name>choice01</name>
<title>I can show you the following</title>
<text>Make a choice:</text>
<options>
   <option value="Presentation"><text>Give a presentation.</text><goto>Node1</goto></option >
   <option value="Screen"><text>Share my screen.</text><goto>Node2</goto></option >
   <option value="Form"><text>Fill in a form.</text><goto>Node3</goto></option >
   <option value="Offer"><text>The customer signs.</text><goto>Node4</goto></option >
</options>
</node>

Step -1- Make sure the node id is unique
Step -2- You can give the node a descriptive name
Step -3- Change the title, it will be visible on the top of the screen
Step -4- Change the text, it's the subtitle and visible
Step -5- Fill options with the text you want, and let it goto the right node

 

Advanced
In case you want to capture the choice the database field is the same as the "name" of the node and the values are the "option values".

Share your screen

Adding the node "screenshare" enables you to share your screen with the participant.
 

Copy the following code to your script:

<node id="Node7" type="ShareScreen"> 
<name>Share my screen</name>
   <command>abc</command>

</node>

Show templates, html and video's

With templates dynamic documents can be presented to the participant, or templates can be used to show html contact, like for example YouTube videos.
 

Copy the following code to your script:

<node id="Node6" type="Template"> 
<name>Fill in the name of the template</name>
   <templateCode>video</templateCode>
</node>

Step -1- Make sure the node id is unique

Step -2- You can give the node a desciptive name

Step -3- Go to "manage templates" and add a template with an identical <templateCode>

 

The added template can contain html-content like a YouTube movie. In this case copy the following code in the template (make sure that in the template you select the code-button first): 


<iframe width="550" height="310" src="https://www.youtube.com/embed/QTcTBJfsXxE?rel=0&amp;autoplay=1;showinfo=0" frameborder="0" allowfullscreen=""></iframe>

 This code can be copied from YouTube (embedded code). Take care that autoplay=1, or add this part.

Send emails

Example:

<node id="Node3" type="Email"> 
<name>Example how to send an email including attachments and
template</name>
<templateCode>email1</templateCode>
<attachments>
<attachment fileCode="pres001" attach="true" />
<attachment templateCode="att001" attach="true" />
</attachments>
</node>

Explanation:
The email template can be created under “Settings /Templates”. Make sure the templatecode is identical. 

  1. In case a file is attached the filecode should be identical to the code in the “Document Library”.
  2. In case a template is attached to the email make sure the templatecode is identical to the template created under menu “Templates”.
    The attached template can e.g. be a personalized offer and containing information gathered in the script (e.g. <flow:Remark> or <relation:Company Name>).
    The template will be attached as a PDF document.

Download a template as PDF

Example:

<node id="Node06" type="Download"> 
<name>Example how to download a template</name>
<title>The title of the node</title>
<text>Subtitle</text>
<attachments>
<attachment templateCode="doc002" />
</attachments>
</node>

Sign documents

With Sign you can ask the participant to sign documents during a session. After the participant has signed the document, you can retrieve it by clicking on "Edit session" in your session history.

Copy the following code in your script:

<node id="sign01" type="Sign"> 
<name>Example how to sign file(s)</name>
<signs>
<sign fileCode="testdoc"> <position left="105" top="180"/> </sign>
</signs>
</node>
 

In this example a document from the Idiligo library is signed, with the signature on a fixed position on the first page. The position (in mm) of the signature is starting from the top left corner (0,0) to the right bottom of the document (A4 document: 210,297). The document should be a PDF document.

Instead of a document from the Idiligo library you can also make use of documents uploaded during the session (see node "Upload"). Replace in this case the following

fileCode="testdoc"

with

uploadId="test01" (test01 is the External ID in the node Upload)

 

And of course you can generate your own document using templates in Idiligo. In this case you can build your own document in html including all kinds of variables gathered in a script (see Node type "Template").  Replace the following

fileCode="testcode"

with

templateCode="testtemplate"

 

Note: see our pricing for the additional fees for a digital signature.

Upload files

Example:

<node id="uploadClient" type="Upload"> 
<name>Example how to upload file(s)</name>
<uploads>
<upload name="curriculum vitae" description="CV van de client" externalId="cv01"
fileTypes="pdf,jpg" mandatory="true" />
</uploads>
</node>

Upload is a node to add documents to the flow.

Uploading documents is useful when you need to collect and store documents in a session.
Documents are uploaded by the client and can be retrieved after the session by the agent (click on edit session).

Node structure

A script contains nodes. All nodes have the following structure:

<node id="NodeName" type="XYZ"> 
<name>...</name>
<title>...</title>
<text>...</text>
...
...
...
<goto>...</goto>
</node>
  1. Each node has a unique “node id”. We suggest to avoid blancs in the node id.
  2. A node has a type. The following types are available: File, Form, Choice, Email, ShowBrowse, ShowbrowseReverse, Template, Upload and Sign.
  3. Each node has a name.
  4. A node can have a title and additional text fields.
  5. A node has content, depending on the type. See further for all possibilities.
  6. Nodes can be made invisible for the client (use visible="false")
  7. Each node can end with a goto field. Here the name of the next node is mentioned.
  8. Optionally a node can have actions.

Actions:

We support the following actions:

  1. An alert (pop up notification)
    <actions> 	 
    <action type="Alert" trigger="Next" fireOnce="true" text="Are you sure?" />
    </actions>
  2. An email
    <actions> 	 
    <action type="Mail" trigger="Load" fireOnce="true" text="The user completes the form!"
    email="john@yourcompany.com" />
    </actions>
  3. Last step of a Client
    <actions> 	 
    <action type="ClientReady" trigger="Load" fireOnce="true" />
    </actions>

FireOnce=true
 A user can visit this node multiple time, but the action is executed once.

Trigger=Load, 
The action is performed when loading the node.

Trigger=Next, 
The action is performed when stepping to the next node.

Field Names

The system contains database fields which can be used in scripts and in templates

 

Customer (your organisation)    Relation (the participant)     Contact (the participant)
[customer:Gender][relation:Gender][contact:Gender] 
[customer:Customer Number][relation:Code][contact:Relation]
[customer:Company Name][relation:Company Name][contact:Commencement]
[customer:VAT Number][relation:VAT Number][contact:Birth Names]
[customer:Company Number][relation:Company Number]      [contact:Initials]
[customer:Family Name][relation:Address][contact:Family Name]
[customer:Prefix][relation:Zip Code][contact:Prefix]
[customer:Initials][relation:City][contact:Title]
[customer:Email][relation:Country][contact:Email]
[customer:Zip Code][relation:Postal Address][contact:Telephone Direct]
[customer:City] [relation:Postal Zip Code][contact:Telephone Mobile]
[customer:Adres][relation:Postal City][contact:Telephone Office]
[customer:ApiKey][relation:Postal Country][contact:Department]
[customer:Culture][relation:Website][contact:Job Title]
[customer:AccountType][relation:Email][contact:Role]
[customer:Full Name][relation:Telephone Number][contact:Remarks]
[customer:Full Family Name][relation:Fax Number][contact:Full Name]
[customer:Commencement][relation:Number of calls][contact:Full Family Name]
[relation:Commencement][contact:Full Commencement]
[relation:Birth Names]
[relation:Initials]
User (the agent)[relation:Family Name]Call (the session)
[user:Role][relation:Prefix][call:ServerId]
[user:Code][relation:Title][call:PublicId]
[user:Name][relation:Department][call:PublicIdRelease]
[user:Initials][relation:Job Title][call:Route]
[user:Email][relation:Role][call:FlowXml]
[user:Customer][relation:Telephone Direct][call:ShowbrowsingHtml]
[user:QuickRoute][relation:Telephone Mobile][call:Gebruiker]
[user:Full Name][relation:Branche][call:Relation]
[user:Online][relation:Full Private Name][call:Contact]
[relation:Full Name][call:ContactEmail]
[relation:Full Family Name][call:Start]
[relation:Full Commencement][call:End]
[relation:Status][call:Status]
[relation:Date Status][call:Remarks]
[relation:Date Reminder][call:Open]
[relation:Days to Reminder][call:EventCount]
[relation:Remarks][call:Bestanden]

Examples

We have many examples of scripts and templates. Contact us to receive them.