Forum Discussion
Articulate Storyline: Export to Google Drive
On the Articulate user days in Utrecht (2015), we held a session about exporting Articulate Storyline variables to Google Drive (Spreadsheet). This export is achieved via JavaScript (jQuery).
Use the button Source to download the Storyline project. If you want the same lay-out as the example above, please install the following fonts (see source file):
- flaticons-stroke.ttf
- fontawesome-webfont.ttf
Why do you want to make an export to Google Drive?
- No LMS (or database) available;
- Store more information than just the test results. You can export all Storyline variables to Google Drive.
Why using Javascript?
Besides using Javascript it's also possible to embed a Google form as WEB object. This is a lot easier than using Javascript.
We have chosen for Javascript because we would like the ability to change the appearance of the form. In addition, we want to collect data across multiple slides and then store them in Google Drive.
UPDATE 2017-06-06:
There is also an article available for importing records of a Google Spreadsheet into Storyline:
Articulate Storyline: Import from Google Drive
UPDATE 18-10-2018: PROBLEMS WITH NEW SPREADSHEET, TRY TO USE A TEMPLATE
Google changed somthing within the mechanism of storing variables into a Google Spreadsheet. Creating a new spreadsheet can give you problems for storing variables. Before you try the steps below, please use a template:
Go to the page below and use the button Use this template:
https://drive.google.com/previewtemplate?id=1vrqb9ykwCSxzjcBIpYO7P9AXPyh37J3HviSwhZvYc_U&mode=public
And go further with step 4 below!
Export to Google Drive
The export consists of several steps. Some steps take place on the side of Google. For these steps you will need a Google account. The remaining steps take place in Articulate Storyline.
Below you'll find the steps to create the export to Google Drive:
1. Login with your Google account
Go to the page below and login with your credentials:
https://docs.google.com/spreadsheets/
2. Create a new spreadsheet
Click on the Plus-sign (+) to create a new spreadsheet.
3. Rename the sheet to DATA
Give the spreadsheet a title and change the name of the sheet to DATA.
4. Add extra columns
Add extra columns you would like to use. Probably these columns will have the same name as the variables in Articulate Storyline. As example: the column names name, email and message like in the source project.
You can add the column date in the spreadsheet, if you would like to save the date when the form is sent to Google.
The column names needs to be identical to the variable names in Articulate Storyline. The column names are case sensitive.
5. Copy the ID of your form
Find out your spreadsheet ‘key’ by looking in the address bar, the key is the long series of letters and numbers after /d/ and before /edit: Like:
https://docs.google.com/spreadsheets/d/1AzBuim89ma_ght1-O14cksVzXrQL5Vh4XnRqY9OM_gc/edit#gid=0
The KEY will be = 1AzBuim89ma_ght1-O14cksVzXrQL5Vh4XnRqY9OM_gc
Save this KEY in a Notepad file to keep safe, or other application, you will need this ID in step 8.
6. Open the Script Editor
Open the script editor Tools, Script Editor.
7. Paste custom script
If you are using the template, then you can skip this step. The code is already in the template available. If not, paste the script below, which is needed for importing the Storyline variables into this spreadsheet:
// 1. Enter sheet name where data is to be written below
var SHEET_NAME = "DATA";
// 2. Enter the KEY of your form
var KEY = "KEY"
// 3. Run > setup
// 4. Publish > Deploy as web app
// - enter Project Version name and click 'Save New Version'
// - set security level and enable service (most likely execute as 'me' and access 'anyone, even anonymously)
// 5. Copy the 'Current web app URL' and post this in your form/script action
// 6. Insert column names on your destination sheet matching the parameter names of the data you are passing in (exactly matching case)
var SCRIPT_PROP = PropertiesService.getScriptProperties(); // new property service
// If you don't want to expose either GET or POST methods you can comment out the appropriate function
function doGet(e){
return handleResponse(e);
}
function doPost(e){
return handleResponse(e);
}
function handleResponse(e) {
// shortly after my original solution Google announced the LockService[1]
// this prevents concurrent access overwritting data
// [1] http://googleappsdeveloper.blogspot.co.uk/2011/10/concurrency-and-google-apps-script.html
// we want a public lock, one that locks for all invocations
var lock = LockService.getPublicLock();
lock.waitLock(30000); // wait 30 seconds before conceding defeat.
try {
// next set where we write the data - you could write to multiple/alternate destinations
var doc = SpreadsheetApp.openById(SCRIPT_PROP.getProperty(KEY));
var sheet = doc.getSheetByName(SHEET_NAME);
// we'll assume header is in row 1 but you can override with header_row in GET/POST data
var headRow = e.parameter.header_row || 1;
var headers = sheet.getRange(1, 1, 1, sheet.getLastColumn()).getValues()[0];
var nextRow = sheet.getLastRow()+1; // get next row
var row = [];
// loop through the header columns
for (i in headers){
if (headers[i] == "Timestamp"){ // special case if you include a 'Timestamp' column
row.push(new Date());
} else { // else use header name to get data
row.push(e.parameter[headers[i]]);
}
}
// more efficient to set values as [][] array than individually
sheet.getRange(nextRow, 1, 1, row.length).setValues([row]);
// return json success results
return ContentService
.createTextOutput(JSON.stringify({"result":"success", "row": nextRow}))
.setMimeType(ContentService.MimeType.JSON);
} catch(e){
// if error return this
return ContentService
.createTextOutput(JSON.stringify({"result":"error", "error": e})) .setMimeType(ContentService.MimeType.JSON);
} finally { //release lock
lock.releaseLock();
}
}
function setup() {
var doc = SpreadsheetApp.getActiveSpreadsheet();
SCRIPT_PROP.setProperty(KEY, doc.getId());
}
8. Paste your key
There is one place in the script where it says var KEY = "KEY". Copy and paste your key between the "".
9. Run the script
Run the script via Run, Run function, setup. The first time you run the script it will ask for permission to run. You will need to grant it. If you run the script for a second time you won't get any popup. This is an indication it has run successfully.
10. Deploy a web app
Go to Publish, Deploy as web app. Enter a project name (optional) and set security level. Choose for Me and access Anyone, even anonymously. Click on the button Deploy to create the web app.
11. Copy the Current web app URL
Copy the 'Current web app URL' and paste it in a Notepad file to keep safe.
Example URL:
https://script.google.com/macros/s/AKfycbyoP8c3_wlons5PSHx1W8PWJx4pn7t3ch-_IxTz0dVIKFw1AGLN/exec
12. Add jQuery library
In Articulate, add a trigger to run javascript (Execute Javascript) and use the code below.
This code will add the jQuery library to this project, so you won't have to change the HTML files after publishing the project. The jQuery library is needed for exporting the information to Google Drive.
var head = document.getElementsByTagName('head')[0];
var script = document.createElement('script');
script.src = '//code.jquery.com/jquery-1.11.0.min.js';
script.type = 'text/javascript';
head.appendChild(script)
13. Store information
Add another trigger to run Javascript (Execute Javascript). You can use the code below.
Replace the value Current web app URL for the webapp url you've saved in step 11.
Below the webapp URL, you can place the column names of the spreadsheet and the Storyline variables. Please be aware of the comma if you add multiple variables.
var player = GetPlayer();
//PLACE YOUR WEB APP URL
WEB_APP_URL = "Current web app URL";
// STORE ARTICULATE STORYLINE VARIABLES
// "Columnname_Google_Spreadsheet" : player.GetVar("Name_Storyline_Variable")
// ATTENTION: Use a comma if you use multiple Storyline variables
storyline =
{
"date" : new Date().toJSON().slice(0,10), //STORE DATE
"name" : player.GetVar("name"),
"email" : player.GetVar("email"),
"message" : player.GetVar("message")
}
Don't delete the row below, if you would like to save the date when the form is sent:
"date" : new Date().toJSON().slice(0,10), //STORE DATE
14. Export code to Google Drive
Latest Javascript code. Add another trigger to run Javascript (Execute Javascript). You can use the code below. This trigger will send the information from step 13 to Google Drive.
//DELAY SO JQUERY LIBRARY IS LOADED
setTimeout(function (){
//Export to Google
$.ajax({
url: WEB_APP_URL,
type: "POST",
data : storyline,
success: function(data)
{
console.log(data);
},
error: function(err) {
console.log('Error:', err);
}
});
return false;
}, 1000);
15. Publish to SCORM or WEB format
Publish your articulate project to WEB or SCORM format. You need to host it on a WEB server or somewhere like SCORM cloud (or a LMS).
This export will work in Flash and HTML5 output. You can't use the Articulate Mobile Player, because it won't support Javascript code.
Thank You
Thanks Kate Robertson for making the blog post below:
Exporting Variables into a Google Spreadsheet
I started with your setup and then have tried to simplify the steps by changing the Javascript code and importing the JQuery Library.
- BastiaanTimmerPartner
Hi Elizabeth,
If you follow the steps carefully then the spreadsheet will populating the results. Did you use multiple variables?
storyline =
{
"date" : new Date().toJSON().slice(0,10), //STORE DATE
"name" : player.GetVar("name"),
"email" : player.GetVar("email"),
"message" : player.GetVar("message")
}If you use multiple variables as described above, please take a look at the comma after each variable line. Only the last row can't have a comma.
You can use this setup for SCORM, AICC but also for WEB publication. The example I use in this topic is also a WEB publication on our web server.
Best regards!
- BastiaanTimmerPartner
Hi Martin,
Great to hear it worked.
The problem was caused by the order of the triggers. See screenshot below:
You will have to move the selected trigger one position up. So you will first set the variable and then go to the next page.
Normally we place this trigger on the "Success" and "Fail" layer. And then with the setting "When Time-line starts".
Best regards,
Bastiaan
- MartinLemieuxCommunity Member
Hi Bastiaan,
Thanks again! You really helped get my project back on course - I'll remember about the order of things in the triggers. Sometimes I forget that the order in the list makes a big difference. I'll be sure to remember that from now on.
All the best!
-Martin
- BastiaanTimmerPartner
Thanks Martin, You're welcome!
- BastiaanTimmerPartner
UPDATE 2017-06-06:
There is also an article available for importing records of a Google Spreadsheet into Storyline:
- MichelleJimenezCommunity Member
Thanks so huge for this helpful and superb tutorial... I managed to do it 3 years back using similar approach but yours is more efficient and does not add blank rows in the google sheet when appended, mine did :-(... Now that I need to develop a project like this again, this has been truly a "savior" so I can get started with my new task. God bless Basti ;-)
- BastiaanTimmerPartner
Hi Michelle,
Thanks for this great reply! This is why we share our knowledge to this forum!
- sz-eb98fbb5-bcbCommunity Member
Hello,
It is need one more step.
Step 16: publish your course. Then, add the following line of code before the closing </head> tag in the story.html file in your published output.
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.4.1/jquery.min.js"></script>
Note: If you republish your course, you’ll need to add the code to your published output again.- ReenaMittal-b1fCommunity Member
Thank You, this is work for me :)
- sz-eb98fbb5-bcbCommunity Member
You're welcome 🌸
Get Outlook for Android
- ElizabethDen054Community Member
Thanks, Mark. I appriciate your help, I'm going to take a stab at this again today.
Here's my code, maybe you (or anyone) can see where I messed up.
var head = document.getElementsByTagName('head')[0];
var script = document.createElement('script');
script.src = '//code.jquery.com/jquery-1.11.0.min.js';
script.type = 'text/javascript'; head.appendChild(script)var player = GetPlayer();
//PLACE YOUR WEB APP URL
WEB_APP_URL = "https://script.google.com/macros/s/AKfycbxXSFh5w8DgeUEwKOcTsT9WgguerXFK9STcLyCEX26l85BovKI/exec";
// STORE ARTICULATE STORYLINE VARIABLES
// "Columnname_Google_Spreadsheet" : player.GetVar("Name_Storyline_Variable")
// ATTENTION: Use a comma if you use multiple Storyline variables storyline =
{
"date" : new Date().toJSON().slice(0,10), //STORE DATE "LearnerUNID" : player.GetVar("LearnerUNID"),
"LearnerLastName" : player.GetVar("LearnerLastName"), "LearnerFirstName" : player.GetVar("LearnerFirstName"), "PreviouslyUsed" : player.GetVar("PreviouslyUsed"),
"PreviousLocation" : player.GetVar("PreviousLocation"), "NumberOfMonths" : player.GetVar("NumberOfMonths"), "ResultsPreReq.ScorePercent" : player.GetVar("ResultsPreReq.ScorePercent"),
"GivenAccessToTestOut" : player.GetVar("GivenAccessToTestOut")
}//DELAY SO JQUERY LIBRARY IS LOADED
setTimeout(function (){
//Export to Google
$.ajax({
url: WEB_APP_URL,
type: "POST",
data : storyline,
success: function(data)
{
console.log(data);
},
error: function(err) {
console.log('Error:', err);
}
});
return false;
},
1000);I'm more familiar with HTML than I am with Javasript, so it's very possible my code the issue.
I used your template and replaced only the top KEY (line #2) with my spreadsheet key.
I have two that came back as all "undefined" and one didn't feed information at all to the spreadsheet.
Thanks again for your help.
- WillieThomas-d7Community Member
Hi Elizabeth,
I used the codes above and tested it for more then a week with no desired result.
I moved the code on the program to a place after where the variable where defined and VIOLA it worked. It wouldn't work for me as a button trigger so I placed the codes on the last page of my project as a slide trigger and it worked. As long as you are not using the standard storyline variable to track score you are fine.
I use the codes now in various projects to populate the same google doc.
Hopes this saves you at least a day's work.
- BastiaanTimmerPartner
Hi Elizabeth,
You can use the setup as Willie Thomas described. If the submit won't work to submit your variables, please navigate to another slide and submit the results on this specific slide. I did the same in my example (see the download link above).
When the timeline starts, the results will be submitted to Google. Please be aware that the spreadsheet is a public spreadsheet, otherwise it won't work.
If you get values like "undefined" then it seems to work, but then there is something wrong with the variable names. It could be a Case Sensitive problem.
As Willie Thomas said: you can use variables of questions, but you can't use the default score of a test/quiz. You will have to save the score of a quiz in a user defined variable.
Good luck!
Best regards,
Bastiaan
- ElizabethDen054Community Member
Thank you, WIllie and Bastiaan! I will try it.
- ElizabethDen054Community Member
I got it to work. Thanks for your help!
One thing to add to the list of dos and don'ts: I think only text variables work.
I had it set up so that when a user clicks a box, the variable that feeds to to the spreadsheet is set to equal another variable that equals Yes or No. It wouldn't work, but when I set it to equal Yes when the user clicks Button 1 or No when the user clicks Button 2 it worked.
- BastiaanTimmerPartner
Hi Elizabeth,
I've just created a version with numbered variables and this version is also working fine. Below you'll find the publication of a very simple Storyline 2 module:
http://download.courseware.nl/052016/Number/story.htmlWith the link below you can see the results in Google Drive:
https://docs.google.com/spreadsheets/d/1-qP42B3BAS35LXjACW9N2jsKWLyTKVPRst5EvnUQOUU/edit?usp=sharingI didn't use any other step as described above. In the attachment you'll find the Storyline project.
I think you could use different sheets, because every sheet has his own WEB APP URL.
Best Regards,
Bastiaan
- KengHweeWeeCommunity Member
I tried on Story 360 and found it doesn't update the google sheet. Why?