= Catglobe modules =

Using CG Script it's possible to build very complex solutions on top of the Catglobe platform. This page and sub pages offers some guidelines on how to use existing Catglobe modules and how to extend with additional generic modules, or create and register customized modules which are used by a specific solution.

Building a new solutioin, where Catglobe modules are used as the foundation, helps you abstract from tedious things like remembering the resource ids of a lot of generic workflows, it also makes it easier to move your solution to other Catglobe sites once it's done.

One workflow resource id must be known in order to initialize the Catglobe modules framework, namely the resource id of the Catglobe module loader.

== Initializing the module loader ==

The Catglobe module loader is the workflow module responsible for loading all other generic Catglobe modules, the script below demonstrates how to initialize the module loader and add a few generic Catglobe modules:

<source lang="javascript">
number moduleLoaderResId = 1234;
Dictionary cgmod = Workflow_call(moduleLoaderResId, {
"Catglobe.DateTime",
"Catglobe.Text"
});
</source>

Let's go through the code above line by line. At line 1 we specify the resource id of the workflow which contains the Catglobe module loader. Line 2 calls the workflow with an array of strings indicating to the module loader which generic Catglobe modules we would like to load initially, in the example above we load Catglobe.DateTime and Catglobe.Text which allows us to manipulate date or time, and text respectively.

=== Delayed module inclusion ===

Not all modules have to be loaded initially. Depending on the flow through your workflow it's possible to delay inclusion of the generic modules until they are actually needed, the next example demonstrates how to load the Catglobe.Text module after the module loader was initialized:

<source lang="javascript">
number moduleLoaderResId = 1234;
Dictionary cgmod = Workflow_call(moduleLoaderResId, {
"Catglobe.DateTime"
});

cgmod["Catglobe.ModuleLoader"]["load"].Call({
"Catglobe.Text"
});
</source>

As in the first example we initially load the Catglobe module loader, this time we initialize with only the Catglobe.DateTime module. At line 5 we call the function "load" defined in the Catglobe.ModuleLoader module which takes an array of strings specifying names of generic Catglobe modules to be loaded. Modules which have already been loaded are not loaded again.

=== Listing loaded modules ===

Sometimes it might be useful to see which modules have been loaded already, this can be done using the listAvailableModules function, the following example shows how to use it:

<source lang="javascript">
number moduleLoaderResId = 1234;
Dictionary cgmod = Workflow_call(moduleLoaderResId, {
"Catglobe.DateTime",
"Catglobe.Text"
});

print(cgmod["Catglobe.ModuleLoader"]["listAvailableModules"].Call());
</source>

The script above will output:

== Further reading ==

How to create a generic Catglobe module

How to create a solution specific module

How to create a Catglobe workflow service

Catglobe modules API reference

Catglobe modules

2011-09-12T09:48:04Z

Catglobe:

Catglobe modules

2011-09-12T09:39:45Z

Catglobe:

Catglobe modules

2011-09-12T09:39:01Z

Catglobe: Initial page which describes how to use catglobe modules

Validate email specified as an open text of a single question

2011-09-05T11:56:05Z

Catglobe: /* Script */

==Challenge==
In order to secure my questionnaire's input 
As a CGS writer 
I want to validate an email specified as an open text of a single question 
 
Example 
 
[[Image:Validate_email_-_semi_open_question.png]]

==Solution==
*Add the script below to the question's Javascript property
*Locate the input text box and use validateEmail function to validate the email
==Script==
<source lang=javascript>
var qLabel = "Question1";//question's label
var openAnswerValue = 1;//the value of answer option which has open text
var ErrorMessage_InvalidEmail = "Invalid email.";//error message in your needed language

var normalQuestionCheck = questioncheck;
function extendedQuestionCheck()
{
var valid = normalQuestionCheck();
var email = $("input[name='QUESTION." + qLabel + ".Open." + openAnswerValue +"']").val();
$(document).ready(function(){
$("input:radio[name='QUESTION." + qLabel+"']").each(function(index) {

if($(this).val() == openAnswerValue && email != ""){
valid = validateEmail(email);
}
});
});
if (!valid)
{
ErrorMessages.getInstance().showErrorMessage(ErrorMessage_InvalidEmail);
return false;
}
else
return true;
}
questioncheck = extendedQuestionCheck;
</source>

Validate email specified as an open text of a single question

2011-09-05T11:55:44Z

Catglobe: /* Script */

==Challenge==
In order to secure my questionnaire's input 
As a CGS writer 
I want to validate an email specified as an open text of a single question 
 
Example 
 
[[Image:Validate_email_-_semi_open_question.png]]

==Solution==
*Add the script below to the question's Javascript property
*Locate the input text box and use validateEmail function to validate the email
==Script==
<source lang=javascript>
var qLabel = "Question1";//question's label
var openAnswerValue = 1;//the value of answer option which has open text
var ErrorMessage_InvalidEmail = "Invalid email.";//error message in your needed language

var normalQuestionCheck = questioncheck;
function extendedQuestionCheck()
{
var valid = normalQuestionCheck();
var email = $("input[name='QUESTION." + qLabel + ".Open." + openAnswerValue +"']").val();
$(document).ready(function(){
$("input:radio[name='QUESTION." + qLabel+"']").each(function(index) {

if($(this).val() == openAnswerValue && email != ""){
alert($(this).val());
valid = validateEmail(email);
}
});
});
if (!valid)
{
ErrorMessages.getInstance().showErrorMessage(ErrorMessage_InvalidEmail);
return false;
}
else
return true;
}
questioncheck = extendedQuestionCheck;
</source>

User:Thomas

2011-08-17T09:33:12Z

Catglobe:

User talk:Thomas

2011-08-17T06:13:46Z

Catglobe: moved User talk:Thomas to Talk:Trip to Denmark 2010: I want my user page back!

#REDIRECT [[Talk:Trip to Denmark 2010]]

Talk:Trip to Denmark 2010

2011-08-17T06:13:46Z

Catglobe: moved User talk:Thomas to Talk:Trip to Denmark 2010: I want my user page back!

User:Thomas

2011-08-17T06:13:45Z

Catglobe: moved User:Thomas to Trip to Denmark 2010: I want my user page back!

#REDIRECT [[Trip to Denmark 2010]]

2011-04-06T09:52:51Z

Catglobe:

How to create a new questionnaire using panel members

2011-04-06T09:49:16Z

Catglobe:

= Create questionnaire =

== Step 1 ==

Go to Ad Hoc Questionnaire resource list

[[Image:Panel questionnaire.gif]]

== Step 2 ==

Copy questionnaire: CGTemplate - CAWI template (resource id = 22631)

Change the destination questionnaire name and parent resource to fit the real project. 

== Step 3 ==

Open the newly created questionnaire resource

Use the correct layout:

*CAWI: CGTemplate (questionnaire layout template): CAWI - Voxmeter DEFAULT Layout
*CATI: CGTemplate (questionnaire layout template): CATI

== Step 4 ==

Modify the questionnaire to suit the real needs

There is a sample questionnaire created namely: CGTemplate - CAWI Template 2010 - EXAMPLE 
The steps below are the simple steps that you need to follow, if you want to understand more clearly about the setup, please read further [[9235cat - Panel Management - Ad Hoc Questionnaire Template - Details|here]].

=== Step 4.1 - Add screening questions ===

If there are screening demographic questions: 

*Select them in constant "Screening questions"

[[Image:Panel management - Constants 2.png]]

*Add quotas containing the conditions with target = 0 (no naming convention is needed)

[[Image:Panel management - Quotas.png]]

=== Step 4.2 - Add main questions ===

*Open the questionnaire template using questionnaire template editor
*Locate question INSERT_QUESTIONS_HERE, replace it with the real set of questions.
*If there are other screening questions (non-demographic), add GOTO if condition to go to D_SetOutsideTarget question, which will screen out the user and show question End_OutsideTarget_PP (for external sample users) or End_OutsideTarget_Catinet (for Catinet users)
*If there is a question for checking quota, make sure it go to D_SetQuotaFull question, which will set answer sheet's status and show question End_QuotaFull_PP or End_QuotaFull_Catinet,
*For questionnaire using external sample providers, if there are links to go back after finishing the questionnaire, remember to update the links (as answer option texts) in question End_Successful_PP, End_QuotaFull_PP and End_OutsideTarget_PP

=== Step 4.3 - Add extra demographic questions ===

*If there are more demographic questions needed to be asked, please select them in constant "Extra demographic questions" 

== Step 5 ==

There are several constants whose values should be set by the questionnaire creator

[[Image:Panel management - Constants.png]]

*Update back to the panel: indicates if the demographic data updated in the current questionnaire should be also copied back to the panel data questionnaire
*Updatable questions: shows the list of demographic questions that need to be updated when their values are missing or the respondent chooses to update their information
*Screeening questions: select desired questions to make screening (this must be used together with quota, which has been described in Step 4
*Extra demographic questions: more demographic questions needed, those will be shown at the end of the questionnaire
*Points - Successful: number of points given to Catinet users when they complete the questionnaire successfully, in the previous setup for Ad hoc questionnaire, its value was 40
*Points - Quota full: number of points given to Catinet users when they meet the quota full status, in the previous setup for Ad hoc questionnaire, its value was 10
*Points - Outside target: number of points given to Catinet users when they are outside target, in the previous setup for Ad hoc questionnaire, its value was 10

= Sampling =

Copy group: CGTemplate (group template): Catinét DK multiple rules - 2010 (Resource Id = 35437463)

There are 2 sample rules: one for Male and the other one for Female

*Copy these to make real rules
*Their current targets are set to 0 on purpose, please change them with the real targets

 

[[Image:Group template 1.png]] 

 

There are 4 variables used in each rule

#The users must belong to Panel members - Available group (not all members are available at the same time)
#Age: add ranges as needed
#Gender: leave unchanged
#Region: select a region if needed or select all/remove the variable if no region filter is needed

 

[[Image:Group template 3.png]]

 

= Invite =

In order to invite people to join the questionnaire, we use a bulk mail based on the sample group(s)

Create a mail template and use it to generate the bulkmail

Remember to use the correct bulkmail resource template: Invitation - Scripted event - Please do not use.

This bulkmail resource template has a script attached to update information of panel members in Panel Data questionnaire before sending the mails out.

[[Image:Invite bulkmail.png]] 

= Remind =

In order to remind people to answer the questionnaire, we use a bulk mail based on the reminder group(s)

Create a mail template and use it to generate the bulkmail

Remember to use the correct bulkmail resource template: Reminder mail - Scripted event - Please do not use.

This bulkmail resource template has a script attached to update information of panel members in Panel Data questionnaire before sending the mails out.

= Re-invite =

In order to re-invite people to join the questionnaire, we use a bulk mail based on the sample group(s)

Create a mail template and use it to generate the bulkmail

Remember to use the correct bulkmail resource template: Re-invite mail - Scripted event - Please do not use.

This bulkmail resource template has a script attached to update information of panel members in Panel Data questionnaire before sending the mails out. 

[[Category:Production_guidelines]]

How to create a new questionnaire using panel members

2011-04-06T09:48:28Z

Catglobe:

= Create questionnaire =

== Step 1 ==

Go to Ad Hoc Questionnaire resource list

[[Image:Panel questionnaire.gif]]

== Step 2 ==

Copy questionnaire: CGTemplate - CAWI template (resource id = 22631)

Change the destination questionnaire name and parent resource to fit the real project. 

== Step 3 ==

Open the newly created questionnaire resource

Use the correct layout:

*CAWI: Layout resources\Catinet Layout\CGTemplate (questionnaire layout template): CAWI - NORSTAT
*CATI: Layout resources\Catinet Layout\CGTemplate (questionnaire layout template): CATI

== Step 4 ==

Modify the questionnaire to suit the real needs

There is a sample questionnaire created namely: CGTemplate - CAWI Template 2010 - EXAMPLE 
The steps below are the simple steps that you need to follow, if you want to understand more clearly about the setup, please read further [[9235cat - Panel Management - Ad Hoc Questionnaire Template - Details|here]].

=== Step 4.1 - Add screening questions ===

If there are screening demographic questions: 

*Select them in constant "Screening questions"

[[Image:Panel management - Constants 2.png]]

*Add quotas containing the conditions with target = 0 (no naming convention is needed)

[[Image:Panel management - Quotas.png]]

=== Step 4.2 - Add main questions ===

*Open the questionnaire template using questionnaire template editor
*Locate question INSERT_QUESTIONS_HERE, replace it with the real set of questions.
*If there are other screening questions (non-demographic), add GOTO if condition to go to D_SetOutsideTarget question, which will screen out the user and show question End_OutsideTarget_PP (for external sample users) or End_OutsideTarget_Catinet (for Catinet users)
*If there is a question for checking quota, make sure it go to D_SetQuotaFull question, which will set answer sheet's status and show question End_QuotaFull_PP or End_QuotaFull_Catinet,
*For questionnaire using external sample providers, if there are links to go back after finishing the questionnaire, remember to update the links (as answer option texts) in question End_Successful_PP, End_QuotaFull_PP and End_OutsideTarget_PP

=== Step 4.3 - Add extra demographic questions ===

*If there are more demographic questions needed to be asked, please select them in constant "Extra demographic questions" 

== Step 5 ==

There are several constants whose values should be set by the questionnaire creator

[[Image:Panel management - Constants.png]]

*Update back to the panel: indicates if the demographic data updated in the current questionnaire should be also copied back to the panel data questionnaire
*Updatable questions: shows the list of demographic questions that need to be updated when their values are missing or the respondent chooses to update their information
*Screeening questions: select desired questions to make screening (this must be used together with quota, which has been described in Step 4
*Extra demographic questions: more demographic questions needed, those will be shown at the end of the questionnaire
*Points - Successful: number of points given to Catinet users when they complete the questionnaire successfully, in the previous setup for Ad hoc questionnaire, its value was 40
*Points - Quota full: number of points given to Catinet users when they meet the quota full status, in the previous setup for Ad hoc questionnaire, its value was 10
*Points - Outside target: number of points given to Catinet users when they are outside target, in the previous setup for Ad hoc questionnaire, its value was 10

= Sampling =

Copy group: CGTemplate (group template): Catinét DK multiple rules - 2010 (Resource Id = 35437463)

There are 2 sample rules: one for Male and the other one for Female

*Copy these to make real rules
*Their current targets are set to 0 on purpose, please change them with the real targets

 

[[Image:Group template 1.png]] 

 

There are 4 variables used in each rule

#The users must belong to Panel members - Available group (not all members are available at the same time)
#Age: add ranges as needed
#Gender: leave unchanged
#Region: select a region if needed or select all/remove the variable if no region filter is needed

 

[[Image:Group template 3.png]]

 

= Invite =

In order to invite people to join the questionnaire, we use a bulk mail based on the sample group(s)

Create a mail template and use it to generate the bulkmail

Remember to use the correct bulkmail resource template: Invitation - Scripted event - Please do not use.

This bulkmail resource template has a script attached to update information of panel members in Panel Data questionnaire before sending the mails out.

[[Image:Invite bulkmail.png]] 

= Remind =

In order to remind people to answer the questionnaire, we use a bulk mail based on the reminder group(s)

Create a mail template and use it to generate the bulkmail

Remember to use the correct bulkmail resource template: Reminder mail - Scripted event - Please do not use.

This bulkmail resource template has a script attached to update information of panel members in Panel Data questionnaire before sending the mails out.

= Re-invite =

In order to re-invite people to join the questionnaire, we use a bulk mail based on the sample group(s)

Create a mail template and use it to generate the bulkmail

Remember to use the correct bulkmail resource template: Re-invite mail - Scripted event - Please do not use.

This bulkmail resource template has a script attached to update information of panel members in Panel Data questionnaire before sending the mails out. 

[[Category:Production_guidelines]]

How to create a new questionnaire using panel members

2011-04-06T09:47:51Z

Catglobe:

= Create questionnaire =

== Step 1 ==

Go to Ad Hoc Questionnaire resource list

[[Image:Panel questionnaire.gif]]

== Step 2 ==

Copy questionnaire: CGTemplate - CAWI Template 2010 (resource id = 35977591)

Change the destination questionnaire name and parent resource to fit the real project. 

== Step 3 ==

Open the newly created questionnaire resource

Use the correct layout:

*CAWI: Layout resources\Catinet Layout\CGTemplate (questionnaire layout template): CAWI - NORSTAT
*CATI: Layout resources\Catinet Layout\CGTemplate (questionnaire layout template): CATI

== Step 4 ==

Modify the questionnaire to suit the real needs

There is a sample questionnaire created namely: CGTemplate - CAWI Template 2010 - EXAMPLE 
The steps below are the simple steps that you need to follow, if you want to understand more clearly about the setup, please read further [[9235cat - Panel Management - Ad Hoc Questionnaire Template - Details|here]].

=== Step 4.1 - Add screening questions ===

If there are screening demographic questions: 

*Select them in constant "Screening questions"

[[Image:Panel management - Constants 2.png]]

*Add quotas containing the conditions with target = 0 (no naming convention is needed)

[[Image:Panel management - Quotas.png]]

=== Step 4.2 - Add main questions ===

*Open the questionnaire template using questionnaire template editor
*Locate question INSERT_QUESTIONS_HERE, replace it with the real set of questions.
*If there are other screening questions (non-demographic), add GOTO if condition to go to D_SetOutsideTarget question, which will screen out the user and show question End_OutsideTarget_PP (for external sample users) or End_OutsideTarget_Catinet (for Catinet users)
*If there is a question for checking quota, make sure it go to D_SetQuotaFull question, which will set answer sheet's status and show question End_QuotaFull_PP or End_QuotaFull_Catinet,
*For questionnaire using external sample providers, if there are links to go back after finishing the questionnaire, remember to update the links (as answer option texts) in question End_Successful_PP, End_QuotaFull_PP and End_OutsideTarget_PP

=== Step 4.3 - Add extra demographic questions ===

*If there are more demographic questions needed to be asked, please select them in constant "Extra demographic questions" 

== Step 5 ==

There are several constants whose values should be set by the questionnaire creator

[[Image:Panel management - Constants.png]]

*Update back to the panel: indicates if the demographic data updated in the current questionnaire should be also copied back to the panel data questionnaire
*Updatable questions: shows the list of demographic questions that need to be updated when their values are missing or the respondent chooses to update their information
*Screeening questions: select desired questions to make screening (this must be used together with quota, which has been described in Step 4
*Extra demographic questions: more demographic questions needed, those will be shown at the end of the questionnaire
*Points - Successful: number of points given to Catinet users when they complete the questionnaire successfully, in the previous setup for Ad hoc questionnaire, its value was 40
*Points - Quota full: number of points given to Catinet users when they meet the quota full status, in the previous setup for Ad hoc questionnaire, its value was 10
*Points - Outside target: number of points given to Catinet users when they are outside target, in the previous setup for Ad hoc questionnaire, its value was 10

= Sampling =

Copy group: CGTemplate (group template): Catinét DK multiple rules - 2010 (Resource Id = 35437463)

There are 2 sample rules: one for Male and the other one for Female

*Copy these to make real rules
*Their current targets are set to 0 on purpose, please change them with the real targets

 

[[Image:Group template 1.png]] 

 

There are 4 variables used in each rule

#The users must belong to Panel members - Available group (not all members are available at the same time)
#Age: add ranges as needed
#Gender: leave unchanged
#Region: select a region if needed or select all/remove the variable if no region filter is needed

 

[[Image:Group template 3.png]]

 

= Invite =

In order to invite people to join the questionnaire, we use a bulk mail based on the sample group(s)

Create a mail template and use it to generate the bulkmail

Remember to use the correct bulkmail resource template: Invitation - Scripted event - Please do not use.

This bulkmail resource template has a script attached to update information of panel members in Panel Data questionnaire before sending the mails out.

[[Image:Invite bulkmail.png]] 

= Remind =

In order to remind people to answer the questionnaire, we use a bulk mail based on the reminder group(s)

Create a mail template and use it to generate the bulkmail

Remember to use the correct bulkmail resource template: Reminder mail - Scripted event - Please do not use.

This bulkmail resource template has a script attached to update information of panel members in Panel Data questionnaire before sending the mails out.

= Re-invite =

In order to re-invite people to join the questionnaire, we use a bulk mail based on the sample group(s)

Create a mail template and use it to generate the bulkmail

Remember to use the correct bulkmail resource template: Re-invite mail - Scripted event - Please do not use.

This bulkmail resource template has a script attached to update information of panel members in Panel Data questionnaire before sending the mails out. 

[[Category:Production_guidelines]]

2011-03-07T09:13:28Z

Catglobe: jrfconvert import

jrfconvert import

File:6827.png

2011-03-07T09:13:27Z

Catglobe: jrfconvert import

jrfconvert import

ReturnFromGoto

2011-03-07T09:13:27Z

Catglobe: jrfconvert import

[[Category:HelpBooks]]

====returnFromGoto====

Goes back to the context before calling goto.

'''Syntax'''

returnFromGoto()

'''Arguments'''

none

'''Return type'''

empty

'''Availability'''

Version 4.8
__NOTOC__