You can call a server scriptlet in page-level JavaScript by using the liveBallScriptlet function. Here\u2019s an example of what this line of code would look like in your page-level script:<\/p>\n
var result = liveballScriptlet(1, \"json\", 'data1=' + val1 + '&data2=' + val2);<\/pre>\nThere are three parameters in this function:<\/p>\n
\n
- \u201c1\u201d represents the scriptlet id. To obtain the scriptlet id, navigate into the scriptlet editor in ion and view the URL in your browser window. The sscID parameter value is what you\u2019ll use as the first parameter in the liveBallScriptlet function.<\/li>\n
- The second parameter defines the scriptlet response content type. For example,\u00a0you’d specify “json” as the content type if that is format the scriptlet will return.<\/li>\n
- The third parameter is optional and\u00a0can\u00a0be leveraged to save data to the respondent prior to invoking the scriptlet.<\/li>\n<\/ol>\n
Let’s say you have a server scriptlet that calculates the sum of x and y that you seek to invoke from page-level script. For example:<\/p>\n
return respondent.x + respondent.y;<\/pre>\nIf this scriptlet’s id is 10, below is an example that passes x and y into the scriptlet to return the sum:<\/p>\n
var x = 1;\n\nvar y = 2;\n\nvar sum\u00a0= liveballScriptlet(10, \"text\/plain\", 'x=' + x + '&y=' + y);<\/pre>\n<\/h2>\n
Server scriptlets for global sets of page rules & advanced functionality<\/h2>\n
The power behind scriptlets is that you can write code for advanced, custom logic on your pages, store it centrally then plug it into creatives as needed!<\/p>\n
1. Add Scriptlet(s) to your Ion console<\/strong><\/h4>\n
You’ll create your scriptlet outside of Ion and then add it to the library.<\/p>\n
\n
- Navigate to Libraries > Server Scriptlets<\/li>\n
- Click green \u201cNew scriptlet category\u201d and give it a label<\/li>\n
- Click green \u201cNew scriptlet\u201d button and label the scriptlet<\/li>\n
- Paste or write custom Javascript into the scriptlet field\n
\n
- Note, use server-side Javascript (ECMAScript Version 3) to process data. The script should return a string or null.<\/li>\n<\/ul>\n<\/li>\n
- Save<\/li>\n<\/ol>\n
2. Use rules to run your scriptlet(s) on your Ion pages<\/strong><\/h4>\n
Now that your custom Javascript has been added to your console, you can use rules to trigger the script and base actions off of its response.<\/p>\n
\n
- Navigate to the page you want your script to run on<\/li>\n
- Click on the \u201crules\u201d button in the Page tab of your creative studio if you want the scriptlet to run on page load. If you would like the scriptlet to run on form submission, click the form\u2019s submit button and then open the rules editor from within the Edit tab of your creative studio.<\/li>\n
- Add a rule condition to trigger the scriptlet. If you want the scriptlet to run unconditionally upon page load or form submission, select \u201cNo conditions required\u201d.<\/li>\n
- Add the action labeled \u201cRun server scriptlet\u201d and select the scriptlet from the dropdown to the right.<\/li>\n
- To base action(s) from the scriptlet\u2019s result(s), add a new rule with the condition being \u201cServer scriptlet result\u201d, select the scriptlet, and input the result value.<\/li>\n
- Add an action to trigger based on the scriptlet\u2019s result value.<\/li>\n<\/ol>\n
Let\u2019s say you added a scriptlet to your console that calculates the respondent\u2019s age based on a birth date value they input on an ion form. You would run the scriptlet using form-level rules. You could drive respondents under eighteen, for example, to a page explaining they are not qualified to register.\u00a0Here\u2019s an example of what your rules might look like to accomplish this:<\/p>\n
\nCondition<\/strong>: No conditions required<\/p>\n
Action<\/strong>: Run server scriptlet – Age Calculation<\/p>\n<\/div>\n
\nCondition<\/strong>: Server scriptlet result – Age Calculation – less than \u2013 19<\/p>\n
Action<\/strong>: Go to next page \u2013 \u201cNot qualified to register\u201d<\/p>\n<\/div>\n
Mobile detection Scriptlet<\/strong><\/p>\n
We’ve attached a server scriptlet to this post. This scriptlet identifies if the respondent is on a smartphone and assigns a true\/false value accordingly. Using rules, you can run the scriptlet and redirect respondents with a “true” value to a mobile-optimized page<\/a>. The scriptlet also saves the smartphone type into a data collection field and tags<\/a> the respondent, giving you heightened visibility into the devices your smartphone audience uses.<\/p>\n