Catglobe Wiki - User contributions [en]

Category:Shopping in the web shop

2012-03-05T08:58:00Z

Nguyentanphong: /* Shopping in the web shop */

[[Category:Web shop module]]

==Shopping in the web shop==

Using Catglobe's web shop is similar to using most other shopping pages, but a few pointers are in order to help clarify some of the features that exist.

To go the the web shop you can either go from the main pages of Catglobe via:

''Tools->Personal->My web shop''

or enter directly via e.g.

''http://[your/ site]/Catalogue/shop/ShoppingPage.aspx''

You will then see the web shop which may look something like below:

[[Image:5757.png|800px|Webshop56-2]]

If you for any reason are missing access to the web shop or the links to "My Questionnaires" or "My Transactions" you most likely do not have the necessary access rights. Please contact your administrator if this problem persists.

As you can see from the above example the main screen of the web shop consists of a number of elements. Each will be explained in turn below!

'''1. The language selector'''
 
It is here possible to choose the language in which you want to see the web shop. The initial language you will see is always the one that in the system is specified to be your main language.

'''2. Search product'''
 
It is here possible to search for products throughout regardless of the categories in which they are placed. [[_Search_products_|Click here]] to learn more about the search feature.

'''3. Product categories'''
 
On the left menu you can see the categories of the shop. Using these categories you can quickly navigate to the exact products that you want to see. The first category that will always be shown to you first is the category on the top of the menu. In the example above it would be "Selected offers". The categories which have small arrows pointing to the right offer sub categories. This is normally used when the main category has a lot of products related to it.

'''4. Pager'''
 
When the category you choose has more than 9 product related to it the array of products will be shown on more than 1 page. If you wish to browse through the available products you must click on the next page in this pager. The page you are currently looking at will be highlighted in a red box.

'''5. Records per page chooser'''
 
Choose between 12, 24, 48 and 100 records to be shown on each page. If the shop jas a lot of products it will save you some time paging to find just the one you need.

'''6. Product'''
 
All products in the list will be shown with an images and a price. If you do not have any points available then the price will be shown in your currency - else it will be shown in points.You can click on any product to see a detailed description of it. In the detailed description there may also sometimes be additional choices to make regarding a product.

'''7. Price'''
 
If the manager of the system has specified a recommended market price this will be shown below the product. This will ensure that you can see how much you save by shopping online. Depending on your personal profile you may also here receive additional discounts or offers on a specific product. The price you will have to pay is although always stated in red with the text "Your price".

'''8. Out of stock product '''
 
Some products may be out of stock, If a product is out of stock you will not be able to purchase it until it comes in stock again. Other times the manager of the shop may also choose to terminate the item which will mean that it disappears from the shop completely.

'''9. Shopping basket'''
 
The shopping basket shows how many products you have placed in your basket during this session. The idea of a basket is that it follows you around and every time you see a product you like you can place it in the basket and keep shopping. Only when you are satisfied with the items you have selected do you need to [[_Payment_for_the_basket_|proceed with the payment]]. The value of whatever you have in your basket will be shown by both points and cash.

'''10. Currency'''
 
If you wish to see the cost of the products and your basket in a different currency than your default currency you can do so by changing the currency in this drop down. If your shop does not support credit card this option will although be hidden.

'''11. Go to payment'''
 
As described above you can choose to go to payment once you are satisfied with what you have in your basket. To know more about the payment process pls click here.

'''12. My Status'''
 
This box will show your user name and how many points that you have. If you are have earned points by filling in questionnaires you can click the "My Questionnaires" link to see the full list of answered questionnaires. There is also a link that shows the full list of earned and used points for your user account. To read more about My Transactions please [[_My_transactions_|click here]].

'''13. Newest and most popular products'''
 
In the top of the category section you will a list of all the newest products available as well as a link to view the [[_Most_popular_products_|most popular products]] in the shop, so you can see what other shoppers have thought was a good buy.

'''14. Go to catglobe'''
 
If you have access to other things than the shopping pages of the site you can use this button to go to the main pages.

==Detailed product description==

Once you click on a product that you are interested in you will go to the detailed description of that product. An example of a detailed description is shown below:

[[Image:5288.png|800px|WebShop5-5-2]]

As you can see the detailed description shows more images of the product and a more detailed explanation of the product in question. You can click the "Buy" button to place the product in your basket. If you want more of 1 item of the product you just click several times. Please notice that a product may have several options to choose from. These options are shown in the drop down. Once you have placed an product of this sort in your basket it will be shown on the bottom part of the blue box. If you want remove this product from your basket again just click "Remove option from basket" and your basket will be emptied.
__NOTOC__

Managing orders

2012-03-05T08:44:36Z

Nguyentanphong: /* How to handle various situations */

[[Category:Web shop module]]

==Managing orders==

One thing is getting your shoppers to buy your products, another thing is to give service those orders. Catglobe understands the importance of quick response and professional service and we have applied a number of tools to manage the incoming orders that you receive.

To manage orders please proceed to the order list

''Tools -> Web shop -> Orders''

The first list you will see is all undelivered orders. These will be sorted by order date, so that those orders which are oldest are on the top of the list (thus requiring most attention).

[[Image:7639.png|800px|Order58-1]]

The list will show some general important information on the orders, namely:
 
'''Order number: '''a unique number given to your order by the system. This number can be changed by you, but is required to be unique.
 
'''Order date:''' the date and time that the shopper added the order.
 
'''Delivered date:''' the date that the order was delivered. If the order was shipped over several times then it is the date of delivery of the final part of the order.
 
'''Payment type: '''shows whether the order was paid by points, credit card or a combination of both.
 
'''Status: '''where in the process the order is and what needs to be done with it now (read further down for more information).
 
'''Ordered item(s): '''what has been ordered by the shopper.

The tool bar and drop down menu has buttons that enable you to take different actions on orders.

'''Open: '''opens a highlighted order.
 
'''Open user:''' opens the user resource dialogue to learn more about the user making the order.
 
'''Search: '''search for orders by date, order number, user, payment type, site (if handling orders for other sites), status, and suppliers, products or product templates that were included in the order.
 
'''View - pending orders:''' This is the only place where it is possible to get access to "Pending orders". To learn more on what these are please read the chapter below called "Order states".
 
'''View - orders for cashier approval:''' This is in reality a quick way to use the search dialog to get all existing orders that needs the web shop supervisors accept of credit card payment having been done on the related credit card portal (external system that must be looked at before carrying out this action). To learn more please read the chapter below called "Order states".
 
'''View - orders for delivery:''' This is in reality a quick way to use the search dialog to get all existing orders that needs to be delivered to the shopper. These orders have all been paid and credit card accepted, so last step is to ship the merchandise and finally set the status to delivered. To learn more on orders with status "Needs delivery" please read the chapter below called "Order states".
 
'''View transaction:''' Opening this dialog you can see all the points and cash transactions that have been carried out in relation with a highlighted order.
 
'''Cancel order:''' Only orders that have not yet been delivered can be cancelled. When you cancel an order the points of the user will be returned to him; cash cannot be returned so this will have to be done manually be the web shop manager. Read chapters further down on this page to learn more on how to do this.
 
'''Cashier approve: '''When the web shop manager has seen that a "credit card" or "points and credit card" order was appropriately paid and received on the external credit card portal, then he can return to this order in catglobe to tell the system that it is not fully approved. Just highlight the order in the list with status "Needs cashier approval" and click the button "Cashier approves".
 
'''Set to delivered:''' Use this button when you have orders that needs delivery and you have actually carried out that need. When clicking this button an email will be sent to the shopper telling him that his order has been shipped and that he should expect receiving it within a few days or else contact the web shop. To learn more on orders with status "Needs delivery" please read the chapter below called "Order states".
 
'''Export to excel: '''Exports the list of orders based on your latest search criteria to an excel file. This excel file has a lot more information than what can be seen in the list on the screen, and is useful for managing your orders off line.

Further there are some button that effect the order status of highlighted orders. These will be explained below while giving an introduction to the logic of managing orders in Catglobe.

==Order states==

Depending on a state of an order different actions will be expected from you. There are of course two states to which no more action is required. These are "delivered" and "cancelled".

If orders were paid by credit card or mixed payments (points and credit card) then we will need to approve the credit card transaction on the external pay site before we can deliver the order. The shop administrator will go to the external pay site and approve all incoming credit card transaction and not down the order numbers. Then he or she will go to this list and highlight these orders (which will have status "Credit card needs to be approved" or "Needs cashier approval") and click the "Cashier approve" button for them. This will change their status to "Needs delivery". In situations where the transaction is noted as failed on the external pay site you may also choose to click "Cancel order" for that specific order, which will pay the user back any points he may have paid for mixed orders, and send him an e-mail informing him of the cancellation.

Orders that need to be fulfilled are set to status "Needs delivery". These orders are points orders, that immediately receive this status upon purchase, or credit card/mixed orders, that have been approved by cashier. Once you deliver these orders you can highlight them and click "Set to delivered". This will change their order to "Delivered" and generate a stock transaction on the database. Read chapter on stock to understand more on stock management.

If you find out that you have an order with status "Needs delivery" that cannot be delivered (maybe you have miscounted stock or similar unfortunate occurrences), then you can also click cancel order while highlighting the order. This will pay user back any points that he may have paid. Unfortunately, external pay sites do not allow us to pay back shoppers cash, that has already been deducted. So if credit card payments are canceled, where the transaction has already been accepted, then we will need to find another way to pay back the money to the shopper. In this case the cancelled order will appear as an "Unsettled canceled orders", which holds all orders where what the client has paid for is different from what he has received.

How to manually correct this data inaccuracy after having paid back the cash, is explained in further down in this help file.

Finally we have a status called "Pending orders" which holds all orders where the system is waiting for a transaction notification from the external pay site. If this notification is never received by Catglobe the pending order will sooner or later be cancelled automatically by the system. It is also possible for the user to cancel the order manually; but this makes little sense since the auto-cancellation normally happens within 1 hour. Please read the configuration information for the web shop on how to set up this feature.

==The order form==

When highlighting an order and clicking "Open" you will be presented with the following dialog.

[[Image:7640.png|800px|Order58-2]]

In this form you can update delivery information and add notes to the order. It is only possible to update information for orders that are not delivered or cancelled.

You can also click the "view transaction" button to handle manual cash or points changes to the order. You should only add such manual cash or points transaction if you are 100% sure what you are doing. Do not pay back user points of orders that are pending, since these money will also automatically be paid back later, and you may mistakenly give the shopper back more money than he should have had.

The transaction form should only be used in connection with paying users back cash which could not happen automatically when canceling orders.

The order transaction form looks like below:

[[Image:6335.png|800px|Web shop 5-7-2]]

Points orders will not approve you to add cash transactions, and credit card orders not approve points transactions.

==How to handle various situations==

Managing a web shop can be quite a challenge. Many situations may arise where you will need to handle a situation, and often there are situations where catglobe does not offer any features to support such situations. The following chapter tries to propose some modes of action for situations you may encounter.

'''Situation:''' You have delivered an order but the client wants to send it back.
 
'''Proposed action:''' Since Catglobe does not allow you to cancel delivered orders, you will have to pay back the shopper the points and/or cash via the user points tab. You will further have to update the stock as appropriate through the stock page. This will of course mean that you have a situation where an order looks like it was successful, but where it in reality was "cancelled". This is unfortunate, but gives a lot of security for the system processes.
 
'''Situation:''' Part of a user's order cannot be delivered; but we can not cancel part of an order.
 
'''Proposed action:''' Cancel the whole order, send an e-mail to the client, and ask the client to carry out the purchase again but without that option which you could not deliver.
 
'''Situation: '''You and the client have agreed that what he should pay for an order is less than what was initially withdrawn from his account (maybe due to quality problems or similar).
 
'''Proposed action:''' Add a note explaining that this has been done to the order. Then add the points or cash transaction directly to his user point or cash tab.
 
'''Situation: '''Shopper says he never received an order we have set to delivered.
 
'''Proposed action: '''Send it again, but withdraw the stock using the stock page.
__NOTOC__

Managing orders

2012-03-05T08:42:22Z

Nguyentanphong: /* Managing orders */

[[Category:Web shop module]]

==Managing orders==

One thing is getting your shoppers to buy your products, another thing is to give service those orders. Catglobe understands the importance of quick response and professional service and we have applied a number of tools to manage the incoming orders that you receive.

To manage orders please proceed to the order list

''Tools -> Web shop -> Orders''

The first list you will see is all undelivered orders. These will be sorted by order date, so that those orders which are oldest are on the top of the list (thus requiring most attention).

[[Image:7639.png|800px|Order58-1]]

The list will show some general important information on the orders, namely:
 
'''Order number: '''a unique number given to your order by the system. This number can be changed by you, but is required to be unique.
 
'''Order date:''' the date and time that the shopper added the order.
 
'''Delivered date:''' the date that the order was delivered. If the order was shipped over several times then it is the date of delivery of the final part of the order.
 
'''Payment type: '''shows whether the order was paid by points, credit card or a combination of both.
 
'''Status: '''where in the process the order is and what needs to be done with it now (read further down for more information).
 
'''Ordered item(s): '''what has been ordered by the shopper.

The tool bar and drop down menu has buttons that enable you to take different actions on orders.

'''Open: '''opens a highlighted order.
 
'''Open user:''' opens the user resource dialogue to learn more about the user making the order.
 
'''Search: '''search for orders by date, order number, user, payment type, site (if handling orders for other sites), status, and suppliers, products or product templates that were included in the order.
 
'''View - pending orders:''' This is the only place where it is possible to get access to "Pending orders". To learn more on what these are please read the chapter below called "Order states".
 
'''View - orders for cashier approval:''' This is in reality a quick way to use the search dialog to get all existing orders that needs the web shop supervisors accept of credit card payment having been done on the related credit card portal (external system that must be looked at before carrying out this action). To learn more please read the chapter below called "Order states".
 
'''View - orders for delivery:''' This is in reality a quick way to use the search dialog to get all existing orders that needs to be delivered to the shopper. These orders have all been paid and credit card accepted, so last step is to ship the merchandise and finally set the status to delivered. To learn more on orders with status "Needs delivery" please read the chapter below called "Order states".
 
'''View transaction:''' Opening this dialog you can see all the points and cash transactions that have been carried out in relation with a highlighted order.
 
'''Cancel order:''' Only orders that have not yet been delivered can be cancelled. When you cancel an order the points of the user will be returned to him; cash cannot be returned so this will have to be done manually be the web shop manager. Read chapters further down on this page to learn more on how to do this.
 
'''Cashier approve: '''When the web shop manager has seen that a "credit card" or "points and credit card" order was appropriately paid and received on the external credit card portal, then he can return to this order in catglobe to tell the system that it is not fully approved. Just highlight the order in the list with status "Needs cashier approval" and click the button "Cashier approves".
 
'''Set to delivered:''' Use this button when you have orders that needs delivery and you have actually carried out that need. When clicking this button an email will be sent to the shopper telling him that his order has been shipped and that he should expect receiving it within a few days or else contact the web shop. To learn more on orders with status "Needs delivery" please read the chapter below called "Order states".
 
'''Export to excel: '''Exports the list of orders based on your latest search criteria to an excel file. This excel file has a lot more information than what can be seen in the list on the screen, and is useful for managing your orders off line.

Further there are some button that effect the order status of highlighted orders. These will be explained below while giving an introduction to the logic of managing orders in Catglobe.

==Order states==

Depending on a state of an order different actions will be expected from you. There are of course two states to which no more action is required. These are "delivered" and "cancelled".

If orders were paid by credit card or mixed payments (points and credit card) then we will need to approve the credit card transaction on the external pay site before we can deliver the order. The shop administrator will go to the external pay site and approve all incoming credit card transaction and not down the order numbers. Then he or she will go to this list and highlight these orders (which will have status "Credit card needs to be approved" or "Needs cashier approval") and click the "Cashier approve" button for them. This will change their status to "Needs delivery". In situations where the transaction is noted as failed on the external pay site you may also choose to click "Cancel order" for that specific order, which will pay the user back any points he may have paid for mixed orders, and send him an e-mail informing him of the cancellation.

Orders that need to be fulfilled are set to status "Needs delivery". These orders are points orders, that immediately receive this status upon purchase, or credit card/mixed orders, that have been approved by cashier. Once you deliver these orders you can highlight them and click "Set to delivered". This will change their order to "Delivered" and generate a stock transaction on the database. Read chapter on stock to understand more on stock management.

If you find out that you have an order with status "Needs delivery" that cannot be delivered (maybe you have miscounted stock or similar unfortunate occurrences), then you can also click cancel order while highlighting the order. This will pay user back any points that he may have paid. Unfortunately, external pay sites do not allow us to pay back shoppers cash, that has already been deducted. So if credit card payments are canceled, where the transaction has already been accepted, then we will need to find another way to pay back the money to the shopper. In this case the cancelled order will appear as an "Unsettled canceled orders", which holds all orders where what the client has paid for is different from what he has received.

How to manually correct this data inaccuracy after having paid back the cash, is explained in further down in this help file.

Finally we have a status called "Pending orders" which holds all orders where the system is waiting for a transaction notification from the external pay site. If this notification is never received by Catglobe the pending order will sooner or later be cancelled automatically by the system. It is also possible for the user to cancel the order manually; but this makes little sense since the auto-cancellation normally happens within 1 hour. Please read the configuration information for the web shop on how to set up this feature.

==The order form==

When highlighting an order and clicking "Open" you will be presented with the following dialog.

[[Image:7640.png|800px|Order58-2]]

In this form you can update delivery information and add notes to the order. It is only possible to update information for orders that are not delivered or cancelled.

You can also click the "view transaction" button to handle manual cash or points changes to the order. You should only add such manual cash or points transaction if you are 100% sure what you are doing. Do not pay back user points of orders that are pending, since these money will also automatically be paid back later, and you may mistakenly give the shopper back more money than he should have had.

The transaction form should only be used in connection with paying users back cash which could not happen automatically when canceling orders.

The order transaction form looks like below:

[[Image:6335.png|800px|Web shop 5-7-2]]

Points orders will not approve you to add cash transactions, and credit card orders not approve points transactions.

==How to handle various situations==

Managing a web shop can be quite a challenge. Many situations may arise where you will need to handle a situation, and often there are situations where catglobe does not offer any features to support such situations. The following chapter tries to propose some modes of action for situations you may encounter.

'''Situation:''' You have delivered an order but the client wants to send it back.'''Proposed action:''' Since Catglobe does not allow you to cancel delivered orders, you will have to pay back the shopper the points and/or cash via the user points tab. You will further have to update the stock as appropriate through the stock page. This will of course mean that you have a situation where an order looks like it was successful, but where it in reality was "cancelled". This is unfortunate, but gives a lot of security for the system processes.

'''Situation:''' Part of a user's order cannot be delivered; but we can not cancel part of an order.'''Proposed action:''' Cancel the whole order, send an e-mail to the client, and ask the client to carry out the purchase again but without that option which you could not deliver.

'''Situation: '''You and the client have agreed that what he should pay for an order is less than what was initially withdrawn from his account (maybe due to quality problems or similar).'''Proposed action:''' Add a note explaining that this has been done to the order. Then add the points or cash transaction directly to his user point or cash tab.

'''Situation: '''Shopper says he never received an order we have set to delivered.'''Proposed action: '''Send it again, but withdraw the stock using the stock page.
__NOTOC__

Setting up detailed description

2012-03-05T08:27:32Z

Nguyentanphong:

== Setting up detailed description ==

The detailed description of a product is the one you see when you click on the product from the main web shop page. This will lead you to a page, where you can see a detailed description of the product including many images and styles for the text. Please see the below example for how a detailed description may look.

[[Image:1709.jpg|600px|Detailed product description]]

In this example the area used in width is larger that the available immediate view area and a scrollbar will appear making it possible for the shopper to see all.

The detailed description is set up inside the product dialog using a standard HTML editor. The following is a short description on how to use the standard elements of the editor, but also some explanation of the more advanced features specific for Catglobe.

When viewing the editor, the default language (as set on the product's general information tab) will always be shown on the 'detailed description (default)' tab. This way it is easy to copy graphics, formatting and text to a new language that can be chosen on the 'detailed description' tab!

[[Image:4355.png|800px|Product5-4-1]]

In each editors top bar you will find the basic editor buttons, like Cut, Copy, Paste, Preview, Print, Insert table, Cell Editing, and Table configuration buttons. These we presume to be self explanatory and no further information will be given.

In the second menu bar you will find buttons enabling font styles, sizes, colors, alignment, and bullet & tab features for text. These we also presume to be self explanatory.

Finally in the third row of icons are the following buttons.

'''Horizontal line:''' Places a horizontal line where your cursor is. A good tool to split the page up into sub sections.'''Insert hyper link:''' Highlight the text you want to act as a hyper link and click this button. You can then specify where the link will lead to once clicked.'''Remove hyper link:''' In order to use this button you need to highlight the sentence or word onto which you have already placed a hyper link.'''Insert Marquee: '''This is a small "funky" feature  that makes it possible for you to create a small scrolling text in your html page. This can help show a lot of information in limited space.'''Save:''' Will save the detailed description to the core information tab, but remember that you need to save the product as well in order to save your changes to the database.

If you want to create even more advanced detailed descriptions you can click the HTML button in order to manipulate the html of the page. This will provide you with almost unlimited flexibility

== "Template" drop down ==

In the Template drop down you will find a list of "product templates" that will help you set of your initial HTML for any new product detailed description. These product templates are some that you yourself can set up - please click here to read more on how to do this. These defaults will help you maintain a common look and feel for all your detailed descriptions; and of course, make the work quicker and simpler.

== Merge fields ==

Since some information that you show in the detailed description may change over time, and you will not want to go in and change these information all the time, we offer some merge fields for you to use. Merge fields are tags that will be replaced with database information whenever a user views the detailed information. An example of a merge field used in a description may be:

''<nowiki>The price of the product you have to pay is only [[Price]], which is a lot cheaper than the recommended market price of [[Recommendedprice]].</nowiki>''

'''Below is the full list of merge fields that exist:''' ''<nowiki>[[DefaultImage]]</nowiki>'' to be used in image viewing. ''<nowiki>[[Price]]</nowiki>'' to show the users price in users currency. ''<nowiki>[[RecommendedPrice]]</nowiki>'' to show the recommended price in users currency. ''<nowiki>[[SumDelivered]]</nowiki>'' = the amount of default currency spent on the product where the orders containing the product have been delivered. ''<nowiki>[[SumDelivered,USD]]</nowiki>'' = the amount of money in USD spent on the product where the orders containing the product have been delivered. (USD is the short name for the currency and can be replaced with any currency on the currency table). ''<nowiki>[[SumPending]] </nowiki>''= the amount of default currency spent on the product where the orders containing the product have NOT been delivered. ''<nowiki>[[SumPending,USD]]</nowiki>'' = the amount of money in USD spent on the product where the orders containing the product have NOT been delivered.  (USD is the short name for the currency and can be replaced with any currency on the currency table)

An example of the usefulness of the lower 4 merge fields is the following.

''<nowiki>So far shoppers on this site have donated [[SumDelivered]] USD for Red Cross paying 20 USD each. Catglobe futher has pending [[SumPending]] USD to donate to Red Cross.</nowiki>'' __NOTOC__ 

[[Category:Adding_products]]

Category:Adding products

2012-03-05T08:23:35Z

Nguyentanphong:

== Adding products ==

The place where you can add new products is via the products module, which can be found in the Tools menu under Web Shop. The first page you will see will give you a resource list page displaying available products. The resource lists of Catglobe all work in similar ways so please refer to the Managing Resources chapter for more information on how to find the exact product you are looking for.

There are a number of links/actions we can choose. We can

*Create new products
*Edit current products
*Edit access to products
*Delete products
*Copy products (please refer to the Copy Resource Wizard for more information)

Once we open the product resource dialogue we will be presented with the general information tab.

[[Image:5292.png|800px|Image1]]

Let us go through some of the information on this tab and what you should insert.

'''Name:''' The name is a unique name that helps the administrator identify the product. This name is not shown to shoppers.

'''Active:''' By un-checking this check box you ensure that the product is not shown to any shoppers.

'''Main image:''' The image you choose is the one that will be shown to shoppers on the main web shop pages to illustrate the product. When choosing to add main image using "Existing image" choice, the the list of images in the drop down shown will be those that exist on the images tab. In order to get more images in the drop down here you thus have to use the image tab features. There is another option than only choosing from the images on the image tab. By clicking "Find image" you can search for a folder or project in the system containing images. The images from the project or folder you then choose are the ones that will be available in the drop down. Depending on whether you choose move or copy, the product will either get the image that earlier belonged to the project/folder before (removing it from its original location) or a completely new copy will be made.

'''Supplier: '''This will present a list of groups from your group resource list. If you cannot find the supplier of the product here you must go to the group list to add the supplier (or alternatively make sure you have access to view the supplier). You can also click the default button ensuring that your most used supplier will be shown here next time you need to add a new product.

'''Non physical product:''' Products that do not need to be delivered to any specific address (e.g. donations) should have this check box checked. The result will be, that if anyone puts only non-physical products in their basket, then they will not be asked to specify a delivery address when they go through the payment wizard of the web shop.

'''Product categories the product belongs to:''' You can here choose a category the product belongs to and then click the add button. You may add a product to ask many categories as you like. You can remove the product from the category again by highlighting it and clicking the remove button next to the add button. Any product category shown in red has been disabled and will thus not be shown in the web shop menu.

'''Name of product:''' Is the name that will be shown as headlines for the product both in the main web shop page above the image, but also as the headline of the detailed description page.Name is added using the language control, which ensures that the product can be presented in multiple languages. Depending on the language of a shopper he or she will be shown the product information in his own language. If his own language is missing names or descriptions he will be shown the default language. That is why it is always necessary to specify a default language when adding information into a language control. Please notice that the choices of languages you make here will require you to make detailed descriptions in the same language. Please refer to the help file on the "Detailed description tab" to learn more.

=== Set cost information ===

'''Weight:''' The weight of a product is relevant in order to calculate the delivery and handling costs. If you do not charge for delivery and handling you can just leave this field blank. Please refer to the help files on delivery and handling costs to learn more. '''Point:''' The point cost is for one unit of this product. Be aware that what you charge in points will also establish what you charge in cash. This will be decided based on what your default currency is and what your conversion rate for points is. '''Recommended price:''' The recommended price is what is normally charged in other shops. If the recommended price is the same as you charge or you do not know this information, then you should just leave the information blank and it will not be mentioned on the web shop page. '''Purchase price:''' Purchase price is the price that the product costs you to buy it. This is used for calculations of earnings for sales of the product.

=== Stock notification settings ===

In order to make it easier to take action when the web shop is almost out of a certain type of product, it is possible to choose that a user be automatically informed when a purchase is made that makes the total stock fall below a certain amount for any of the options of the product. Since it may be very different from product to product what this limit should be, it can be set for each individual product.

=== Product type and attribute information ===

Finally this is where you specify the type of product and the attributes of the product. Please refer to the chapter on [[Managing product attributes|Product attributes]] to learn more on how to add more types.

[[Category:Web_shop_module]]

Search products

2012-03-05T08:19:54Z

Nguyentanphong:

== Search products ==

In order to quickly find products that suit your needs and requirements, the web shop offers a search feature. The search page can be seen below:

[[Image:1719.png|600px|Search for product]]

In the menu under filters you must specify what filters that you wish to search for. The available filters are:

'''Product name:''' you can specify parts of the name of a product in order to get returned all where the entered string is part of the product name.

'''Points:''' You can specify minimum or maximum price in points for the product. This is especially useful if you want to find products that do not cost more than the amont of points you have available. Please notice that there may be an additional postage or handling fee which can also be paid in points.

'''Price: '''If you wish to know the price in your preferred currency you can also state a minimum or maximum price in this field.

'''Product type: '''Depending on how the manager of the web shop has specified the available product types you can here choose among such a list. Depending on the product type you choose a number of detailed options may appear below the product type. In the example above it is possible for you to choose "Genre" once having selected that you want to search for a "Movie" product type. If product attributes have not been specified for any products in the site then the choice will be completely hidden on the search page. __NOTOC__ 

[[Category:Shopping_in_the_web_shop]]

Search products

2012-03-05T08:17:20Z

Nguyentanphong: /* Search products */

Category:Question Definition

2012-02-28T05:04:53Z

Nguyentanphong:

== Question Definition ==

This chapter describes how to define a question using QSL.

'''Supported question types'''

*Single
*Multi
*Open
*Text
*Number
*Page
*Multimedia
*Scale
*Single grid
*Multi grid
*Scale grid
*Text grid

'''General syntax'''

QUESTION ''question_label [question_type] [property_set]''

''question_body''

''question_text''

'''Arguments'''

''question_label'': label of the question. It must follow the standard format of question label.

''question_type'': must be one of QSL's predefined keywords for question types. This is an optional argument, if it is left blank, the question's type will be set as Single.

{| width="563" cellpadding="2" border="1" style="border-collapse: collapse; border: 1px solid #010101" class="tableintopic"
|- valign="top" align="left"
| width="281" valign="bottom" bgcolor="#C0C0C0" style="border: 1px solid #010101" |
'''Question Type'''

| width="281" valign="bottom" bgcolor="#C0C0C0" style="border: 1px solid #010101" |
'''QSL Keyword'''

|- valign="top" align="left"
| width="281" valign="bottom" style="border: 1px solid #010101" |
Single

| width="281" valign="bottom" style="border: 1px solid #010101" |
SINGLE

|- valign="top" align="left"
| width="281" valign="bottom" style="border: 1px solid #010101" |
Multi

| width="281" valign="bottom" style="border: 1px solid #010101" |
MULTI

|- valign="top" align="left"
| width="281" valign="bottom" style="border: 1px solid #010101" |
Page

| width="281" valign="bottom" style="border: 1px solid #010101" |
PAGE

|- valign="top" align="left"
| width="281" valign="bottom" style="border: 1px solid #010101" |
Number

| width="281" valign="bottom" style="border: 1px solid #010101" |
NUMBER

|- valign="top" align="left"
| width="281" valign="bottom" style="border: 1px solid #010101" |
Text

| width="281" valign="bottom" style="border: 1px solid #010101" |
TEXT

|- valign="top" align="left"
| width="281" valign="bottom" style="border: 1px solid #010101" |
Open

| width="281" valign="bottom" style="border: 1px solid #010101" |
OPEN

|- valign="top" align="left"
| width="281" valign="bottom" style="border: 1px solid #010101" |
Multimedia

| width="281" valign="bottom" style="border: 1px solid #010101" |
MULTIMEDIA

|- valign="top" align="left"
| width="281" valign="bottom" style="border: 1px solid #010101" |
Scale

| width="281" valign="bottom" style="border: 1px solid #010101" |
SCALE

|- valign="top" align="left"
| width="281" valign="bottom" style="border: 1px solid #010101" |
Single grid

| width="281" valign="bottom" style="border: 1px solid #010101" |
SINGLEGRID

|- valign="top" align="left"
| width="281" valign="bottom" style="border: 1px solid #010101" |
Multi grid

| width="281" valign="bottom" style="border: 1px solid #010101" |
MULTIGRID

|- valign="top" align="left"
| width="281" valign="bottom" style="border: 1px solid #010101" |
Scale grid

| width="281" valign="bottom" style="border: 1px solid #010101" |
SCALEGRID

|- valign="top" align="left"
| width="281" valign="bottom" style="border: 1px solid #010101" |
Text grid

| width="281" valign="bottom" style="border: 1px solid #010101" |
TEXTGRID

|}

property_set : is a QSL properties set. This is an optional argument which is dependent on each question type.

question_text : is the text of the question.

question_body: is used for defining the internal attributes of the question, which is also dependent on question type. __NOTOC__ 

[[Category:Questionnaire_Template_Definition]]

Question Definition

2012-02-28T04:57:22Z

Nguyentanphong:

====== Question Definition ======

This chapter describes how to define a question using QSL.

'''Supported question types'''

*Single
*Multi
*Open
*Text
*Number
*Page
*Multimedia
*Scale
*Single grid
*Multi grid
*Scale grid
*Text grid

'''General syntax'''

QUESTION ''question_label [question_type] [property_set]''

''question_body''

''question_text''

'''Arguments'''

''question_label'': label of the question. It must follow the standard format of question label.

''question_type'': must be one of QSL's predefined keywords for question types. This is an optional argument, if it is left blank, the question's type will be set as Single.

{| width="563" cellpadding="2" border="1" style="border-collapse: collapse; border: 1px solid #010101" class="tableintopic"
|- valign="top" align="left"
| width="281" valign="bottom" bgcolor="#C0C0C0" style="border: 1px solid #010101" |
'''Question Type'''

| width="281" valign="bottom" bgcolor="#C0C0C0" style="border: 1px solid #010101" |
'''QSL Keyword'''

|- valign="top" align="left"
| width="281" valign="bottom" style="border: 1px solid #010101" |
Single

| width="281" valign="bottom" style="border: 1px solid #010101" |
SINGLE

|- valign="top" align="left"
| width="281" valign="bottom" style="border: 1px solid #010101" |
Multi

| width="281" valign="bottom" style="border: 1px solid #010101" |
MULTI

|- valign="top" align="left"
| width="281" valign="bottom" style="border: 1px solid #010101" |
Page

| width="281" valign="bottom" style="border: 1px solid #010101" |
PAGE

|- valign="top" align="left"
| width="281" valign="bottom" style="border: 1px solid #010101" |
Number

| width="281" valign="bottom" style="border: 1px solid #010101" |
NUMBER

|- valign="top" align="left"
| width="281" valign="bottom" style="border: 1px solid #010101" |
Text

| width="281" valign="bottom" style="border: 1px solid #010101" |
TEXT

|- valign="top" align="left"
| width="281" valign="bottom" style="border: 1px solid #010101" |
Open

| width="281" valign="bottom" style="border: 1px solid #010101" |
OPEN

|- valign="top" align="left"
| width="281" valign="bottom" style="border: 1px solid #010101" |
Multimedia

| width="281" valign="bottom" style="border: 1px solid #010101" |
MULTIMEDIA

|- valign="top" align="left"
| width="281" valign="bottom" style="border: 1px solid #010101" |
Scale

| width="281" valign="bottom" style="border: 1px solid #010101" |
SCALE

|- valign="top" align="left"
| width="281" valign="bottom" style="border: 1px solid #010101" |
Single grid

| width="281" valign="bottom" style="border: 1px solid #010101" |
SINGLEGRID

|- valign="top" align="left"
| width="281" valign="bottom" style="border: 1px solid #010101" |
Multi grid

| width="281" valign="bottom" style="border: 1px solid #010101" |
MULTIGRID

|- valign="top" align="left"
| width="281" valign="bottom" style="border: 1px solid #010101" |
Scale grid

| width="281" valign="bottom" style="border: 1px solid #010101" |
SCALEGRID

|- valign="top" align="left"
| width="281" valign="bottom" style="border: 1px solid #010101" |
Text grid

| width="281" valign="bottom" style="border: 1px solid #010101" |
TEXTGRID



|}

property_set : is a QSL properties set. This is an optional argument which is dependent on each question type.

question_text : is the text of the question.

question_body: is used for defining the internal attributes of the question, which is also dependent on question type. __NOTOC__ 

 

[[Category:HelpBooks]]

Impsys required text

2012-02-23T07:52:13Z

Nguyentanphong:

= Impsys required text =

 

{| width="907" cellspacing="0" cellpadding="2" border="0" class="tableintopic" style="border-collapse:collapse"
|-
| width="180" height="0" |
| width="84" height="0" |
| width="66" height="0" |
| width="576" height="0" |
| width="0" height="0" |
|- valign="top" align="left"
| width="180" |
'''Purpose:'''

| width="727" colspan="4" |
 

|- valign="top" align="left"
| width="180" |
'''Property name:'''

| width="727" colspan="4" |
IMP_SYS_REQUIRED_TEXT

|- valign="top" align="left"
| width="180" |
'''Type:'''

| width="727" colspan="4" |
 

|- valign="top" align="left"
| width="180" |
'''Used for questionnaire:'''

| width="727" colspan="4" |
[[Image:8153.png]] 

|- valign="top" align="left"
| width="180" |
'''Used for questions:'''

| width="84" |
[[Image:8152.png]]

| width="66" |
'''Types:'''

| width="577" |
Multi grid

|- valign="top" align="left"
| width="180" |
'''Used for sub-questions:'''

| width="727" colspan="4" |
[[Image:8153.png]]

|- valign="top" align="left"
| width="180" |
'''Used for answer options:'''

| width="727" colspan="4" |
[[Image:8153.png]]

|- valign="top" align="left"
| width="180" |
'''Example:'''

| width="727" colspan="4" |
 

|}

[[Category:Properties]]

CATI Outcome Sets

2012-02-22T04:09:57Z

Nguyentanphong:

===== CATI Outcome Sets =====

You decide what effect outcomes have on the prioritization of your sample by attaching an existing outcome set to any questionnaire you have made. The action of assign an outcome set to a questionnaire also identifies the questionnaire as a CATI type questionnaire!

[[Image:1451.png]]

Please also notice the Edit button next to the drop down choice for CATI outcome set. This drop down makes it possible to edit any attached outcome set, without simultaneously changing the original outcome set, which may be used by more than this particular questionnaire.

We will below shortly try to explain why it is important to have outcomes for any interview being made. If you would rather learn how to set up these outcome sets please [[Creating a CATI outcome set|click here]].

When an Interviewer has finished calling the number of a respondent, he must specify what the outcome of that interaction was. In Catglobe we talk about 4 main outcome types:

1)      SUCCESS: the questionnaire was successfully completed

2)      FAILURE: the interview could not be carried out

3)      MEETING: we agreed a time and place to call again

4)      RETRY: we will call again in some time

Some variable settings that we can extend on any outcomes are:

1)      block the number for future calls (on failure and success)

2)      prioritize the respondent higher or lower (on recall and meeting)

3)      dedicate call to specific interviewer (on recall and meeting)

4)      maximum expected duration (this feature is explained in detail in CATI Analysis)

Inside these main outcome results there are an almost endless number of specific outcomes we may want to register. Catglobe therefore makes it possible for clients to define as many of their own outcome sets as they please. Outcome Sets can be added, reused, and copied as many times as you like. We can use the specific outcomes of the outcome set for analysis and result purposes.

Below we will try to give an idea of some of the different types of outcomes we could create. These are just ideas – you may add as many as you like for your specific survey.

=== SUCCESS ===

Success – respondent was forthcoming in answering questions detailed

Success – respondent was reluctant in answering questions detailed

Success – person answered but does not want to be contacted again (set block phone number)

=== FAILURE ===

Failure – reached fax number

Failure – phone number does not exist

Failure – reached the wrong person

Failure – person not in target group

Failure – person did not want to participate

Failure – person did not want to participate and never wants to be called again (set block phone number)

Failure – the person was not available and would not be inside time frame of questionnaire

Failure – the person did not speak “the language”

=== MEETING (specific recall date and time must be set) ===

Meeting – person was positive and wants to meet at set time (priority 10)

Meeting – person agreed to meet but seemed reluctant (priority 5)

Meeting – person agreed to meet but seemed to really not want to (priority 1)

=== RECALL (auto-decides recall time) ===

Recall – Line was cut (priority 10 – recall in 1 min – set current interviewer as dedicated interviewer)

Recall – Phone was busy (priority 5 – recall in 10 minutes)

Recall – Better that the respondent talks to another Interviewer with the right qualifications (priority 10 - recall in 1 minute – decide who will be dedicated interviewer)

Recall – Phone was not picked up (priority 3 – call again in at least 4 hours)

Recall – Phone was again not picked up (priority 2 – call again in at least 2 days)

There are of course a lot of outcomes that you can make; but you may as well choose to have fewer, the choice is yours. What Catglobe offers is unlimited flexibility to achieve the specific call process that fits your survey. To know more on how these settings above influence the call process please go to the page on Next Call Logic. __NOTOC__ 

[[Category:HelpBooks]]

Merge duplicate users

2012-02-22T03:47:27Z

Nguyentanphong: /* Merge duplicate users */

[[Category:User module]]

=== Merge duplicate users ===

In order to merge duplicate users that may exist in the system Catglobe offers the merge user feature, which can be accessed via

''Tools -> Administration -> HR -> Duplicate user''

The reason for wanting to merge two users are many, but generally it can have been caused by errors or users who have signed up to be respondent more than once. In both cases we need to keep important information and move it to a new user and delete the rest.

In order to do this we operate with some definitions important for the understanding of merging users.

'''Deleted User:''' the user that will be destroyed after being merged.

'''Main User:''' the user whose values are chosen for the Merged User by default. This is the user account that is kept. After the merge-process is done, we can call it '''Merged User'''.

Since we normally will have no easy way of finding duplicate users, Catglobe offers a feature to do this. The page you will initially see is the duplicate list. This list identifies all the possible duplicates that exist on the database and list them side by side as shown below:

[[Image:4311.png|800px|MergeUser5-4-1]]You may not immediately see all the duplicate users in your system since this page uses a scheduled approach to finding duplicates, since the query is very heavy and cannot be run every time opening this page.

The list you see will feature information on the two users that are found to be possible duplicates. Besides this there is a “certainty” column which shows the percentage of similarity between the two users.

Finally there is the status column showing three possible values:

*Open: no action has been taken on this duplicate.
*Merged: the two users of this duplicate have been merged.
*Ignored: this duplicate has been marked as “Ignored”.

A number of actions are possible from this page:

*Ignore: highlighting and clicking ignore on a pair of users will ensure that they are never again seen as duplicates when we search for potential duplicates. Some duplicates can be caused by similar names and once we find that they are really different people we will never want them to appear in the list again.
*Merge: When highlighting a record and clicking the merge field we will then be introduced to the merge user dialogue, which is explained in more detail below.
*Search: Makes it possible to limit identified duplicates to only include users where both duplicates are members of a certain group.
*Recalculate duplicates: This is a dialogue for managing the duplicate search schedule and rules, which will be explained later in this help file.
*Manual merge (found under tools): A tool for manually choosing the users to merge is available through this button. Explained in detail below.
*Ignored data list: A list that identifies names or data that we want to exclude from being identified as duplicates. Explained in detail below.

===Merge user===

Once we choose to merge a pair of users we will be presented with the following dialog.

[[Image:4312.png|800px|MergeUser5-4-2]]

The screen contains a button to initiate merge of the two users, a reset button to undo any merge settings done in the dialog, and a button to close the dialog without taking any actions.

A normal process to merge two users is to go through all the tabs and choose which information we want to keep. The chosen information will be displayed in the main tab area, where you can make some final adjustments if needed. Once you are satisfied with

How the final main user will look you click merge. The following detailed guide will lead you through merging users.

===Step 1: Choose main user===

* Select one of the two option buttons to choose the Main User. Note that we can’t select a user account that has been deleted as a Main User. If a user has already been deleted, the corresponding radio button will be disabled.
* After the Main User has been chosen, all other controls are enabled.
* When one of the two users is selected as Main User, the Main User will get all values from the selected one, except for Address and Phone numbers.
* If both users have an address specified, the Main User will get the address values from the selected user. If only one of the two users has Address, the Main User will get the address values from that user. The same logic applies to phone numbers.
* By default, the “disabled” setting of the Main User is FALSE and “access expiration” is null.
* Points will always be the sum of all points of both users.

===Step 2: Choose value for each attribute===

Initially the value in the main user will be set to the chosen main user, but it is possibly to change this later either by manually changing the main user or by deciding on the other user’s radio button.

[[Image:4314.png|800px|MergeUser5-4-3]]

* After all the values are decided, click the “Merge” button to start the merging process.
* After the merge process is done, the dialog will close and you will be returned to the duplicate user list.

===Set recalculate duplicates dialog===

This dialog makes it possible to set criteria for how often the find duplicate query is run and the criteria for what users it finds. The dialogue looks like below.

[[Image:5301.png|500px|DuplicateUser5-5-1]]

If you want to limit the search being made for users in a certain group you can select it here. This can e.g. make sure that you only search on panel members, since you do actually allow employees to have more than one user account.

You can further specify when the query will start and how often it will be run (interval in days). There are three options; Start now, start later and recurring. Each of these have different settings to specify.

If you want disabled users to also be compared for duplicates you can check the “Include disabled users?” check box. Finally, you can specify the criteria that will be compared between users to see if they are duplicates. Save and wait to see the result of your settings.

A number of other factors may also influence the business logic of how duplicates are found; these are only for administrators to set up via the web configuration file and you can read more about them by clicking here.

===Manual merge===

When you know of two users that need to be merged and these do not necessarily appear in the duplicate list, you can use the manual merge feature,

[[Image:4316.png|450px|MergeUser5-4-5]] It basically gives you the option to merge two users by searching for their user using the small search dialog or by choosing their ID and clicking the related “Merge” details button. This will open the merge user dialog.

===Ignored data list===

This page displays the list of full names/addresses/phone numbers/e-mails/passwords that are ignored during the search for duplicate users. Please note that these ignored data are different from ignored duplicates. The values that are placed on this list are dependent on a setting in the web configuration, which you can read more about by clicking here. Basically it is a setting specifying the duplicate search to ignore any duplicates that exist in a large number. The reason for such a feature is that we have certain combinations (like empty full name or full names that are all “Respondent Respondent” due to import choices) and we do not wish to include these in our duplicate list. There is no manual choice of what these are; they are purely based on amount in existence. [[Image:4317.png|1094px|MergeUser5-4-6]]

There are 6 buttons on the tool bar:

'''Full name: '''list of the top 30 ignored full names.

'''Password:''' list of the top 30 ignored passwords.

'''Phone number:''' list of the top 30 ignored phone numbers.

'''E-mail: '''list of the top 30 ignored e-mails.

'''Address:''' list of the top 30 ignored addresses.

'''Close: '''Will return you to the duplicate list page.
__NOTOC__

Field: Status

2012-02-20T04:13:28Z

Nguyentanphong:

{{Help_Files_Import_module}}

== Field: Status ==

{| width="1189" cellpadding="2" style="border-collapse: collapse" class="tableintopic"
|-
| width="168" |
| width="1020" |
|- align="left" valign="top"
| width="1189" colspan="2" style="border: 1px solid #010101" |
== Field: Status ==

|- align="left" valign="top"
| width="168" style="border: 1px solid #010101" |
Type

| width="1021" style="border: 1px solid #010101" |
Tinyint

|- align="left" valign="top"
| width="168" style="border: 1px solid #010101" |
General Description

| width="1021" style="border: 1px solid #010101" |
Questionnaire status defines what the status of a questionnaire answer sheet is.

|- align="left" valign="top"
| width="168" style="border: 1px solid #010101" |
Import Group

| width="1021" style="border: 1px solid #010101" |
Import data (advanced)

|- align="left" valign="top"
| width="168" style="border: 1px solid #010101" |
Business Rules

| width="1021" style="border: 1px solid #010101" |
The 5 values that can be chosen are:

1: Normal

2: Quota Full

3: Outside Target

4: Interview Failed

5: Interview Succeeded

|- align="left" valign="top"
| width="168" style="border: 1px solid #010101" |
Validation

| width="1021" style="border: 1px solid #010101" |
*Value that is not an integer cannot be accepted. NULL is also not accepted. Values must be numbers between 1 and 5. Error type: ERROR and the import job will not be allowed to be executed.

|- align="left" valign="top"
| width="168" style="border: 1px solid #010101" |
Notes

| width="1021" style="border: 1px solid #010101" |
N/A __NOTOC__ 

|}

[[Category:Import_module]]

Teams and roles

2012-02-17T07:55:02Z

Nguyentanphong:

= Teams and Roles =

Most resources in the system can have teams related to them. It is up to the users of Catglobe whether or not they believe it is important for them to relate a team to any specific resource type.

On all resources that can have teams attached you will see a team tab in their resource dialogue. From this tab you can add members to the main team or add new team types to the resource. In order to understand the difference between “main team” and “other team types” we will give you some examples:

'''Company Resource'''

   '''Main Team:''' Our companies Key Account Management team for a client company

   '''Client Team:''' The main members of the client team that we take contact with

'''Project Resource'''
   '''Main Team:''' The employees of our company who work on this project

   '''Supplier Team:''' A list of the people from a supplier that works with us on this project

   '''Client Team:''' The main members of the client team that we take contact with

So generally it depends on the resource type what kind of other teams that we want besides the main team. In order to specify team types we would like will go to the Team Type setup page.

''Tools -> Administration -> HR -> Team Type''

[[Image:3249.png|800px|Team type]]

You do not need to add the “main team” to this list since it will always exist by default. For other team types you can add them by giving them a name and whether the team type in question can be identified as a group. Let us presume that you want a team type called “Client team” or “Customer team”. If all your client companies are registered as group resources, then the team tab will allow you to add a team in two steps. First, choose the group that is the client. Secondly, choose the employees from that group who are your contact points for this project.

Let us look at the team tab to see how this works.

First you can choose to add all the teams that are relevant for a specific project. Let us imagine that we have a project where we want a main team and a customer team. We will then first add the customer team by clicking the add button on the left and choosing ‘Customer Team’.

[[Image:3246.png|800px|Team53_1]]

This will bring up the small search control where you can search for the group that you want as customer team.

[[Image:3247.png|800px|Team53_2]]

Once you have selected the team a new section will appear on the page.

[[Image:3248.png|800px|Team53_3]]

You now have two sections. The top one, where you can add members of your own company to the project team, and the bottom one, where you can add employees from the client company to the customer team.

When adding members to the project team (Our team) you can click the [...] buttons to search for the user you want to insert into the team member column. You can also add the first letters of the team members name and if it exists in your list of favorite users it will be proposed for insert. The role field is a combined drop down of existing role options as well as can be used as a free text area where you can specify what that person does in relation to the project. Notice that the available roles will depend on the resource template used by the resource of the team tab. [[Resource templates|Click here]] to read more on setting up applicable roles for resource templates.

The final column (Man-hours) is the budgeted man-hours for the project of each user/role combination. These values can be summed up to specify the entire time budget for the resource the team is added to. [[Time management|Click here]] to learn more on time budgets.

If a user takes on more roles of if a role exists more than once for a team it is beneficial to add new members using the copy button. It will copy both team member and role of a row and you thus only need to change one of these afterwards.

It is also possible to add roles without specifying the user who will take on that role yet. This is beneficial if you know that a certain role is needed for a project but you are still unsure of who will be responsible.

When adding members to the customer team, you will be presented with a drop down in the team member field where you can choose among any employee registered at the external team (members of the group/company you chose for the external team).

In order to set up some predefined roles for team types you must open the following page: ''Tools -> Administration -> HR -> Roles. ''Here you will set the existing list of roles.

[[Image:7737.png|800px|Role58-1]]

The name of the role must be specified in at least the default language! If a role is the one that must be given to users who have their time registered via the fieldwork manager (typically Interviewers), then a checkbox for this exist to the right of the team type drop down. __NOTOC__

[[Category:Managing_resources]]

Data cache specification module

2012-02-16T08:45:50Z

Nguyentanphong: /* When will the data table of a data cache be built? */

[[Category:HelpBooks]]

=Data cache specification module=

A Data Cache Specification is used to collect two types of data.

a) Questionnaire answer sheets (QAS) and the users that filled them in. This data is used to create [[_Answer_sheet_data_caches_|Answer Sheet Data Caches]].

b) Resources and the information linked to these. This data is used to create Resource Data Caches.

Once the data is collected they are placed into data tables. These data tables are then used to make reports or export data.

[[Image:1579.png]]

We are in the following chapters going to explain the logic behind the following 5 processes.

Process 1. Retrieve data from several tables in Microsoft SQL Server database as specified by the data cache.

Process 2. Store retrieved data from Microsoft SQL Server database to long- term data cache (MySQL database). This will save the data which was gotten in one table, making the data a lot easier to work with.

Process 3. Retrieve the data cache specification’s data from Short-term data cache. The short-term data cache will explained below.

Process 4. Retrieve the data cache specification’s data from long-term data cache. The long-term data cache will explained below.

Process 5. Invoke the build process. When and how is explained below.

===What is the data cache?===

The data cache is a specification in what data we want, where we want it from, and in what form we want to represent it when converted to one table. Data in Catglobe is stored in a rather complex relational setup, making it very hard to work with for most users. What the data cache therefore does, is convert it into a table, where each row represents a users questionnaire answer sheet and each column information regarding the user and his answers for the questionnaire answer sheet in question.

We actually have the option to create more complex rules for the records in the data table. This concerns the options to take answers from more than one questionnaires’ QASs and place them in the same data table. This is called having primary AND secondary questionnaires in the same data cache. The logic for how many records a data cache will then have is a bit more complex as explained further down.

=== When will the data table of a data cache be built? ===

When the a user asks the report or export module to get the data from a data cache to use for these two modules, then the data cache manager (the manager of all the data cache in the system) will look to retrieve data.

The first thing the data cache manager will do is to investigate whether the data cache is up to date. This is done by looking at the last updated date and the update frequency. How to set these values we will explain in further help files of setting up your data cache.

If the data cache specification is considered up-to-date then:

• The data cache manager will try to get it from the short-term data cache.

• If the required data table does not exist in the short-term data cache, the data cache manager will try to look for it in the long-term data cache.

• If there is no data cached for the data cache specification in the long-term data cache, the building process will be invoked to rebuild the whole data cache specification.

• When the building process has been finished, the data table will be put in to the long-term and short-term data cache, and then returned to the client.

If the data cache specification is considered out-of-date, or its update frequency plus its last updated date is greater than the current date time or the data cache specification is set to be auto-updated:

• The build process will be invoked to rebuild the data cache specification.

• When the building process has been finished, the data table will be put in to the long-term and short-term data cache, and then returned to the client.

Further, a data cache specification is also not up-to-date if its last updated date is not greater than its modified date.

We have two types of builds that are done by the data cache manager.

'''Forced build:''' When it is necessary to get the most up-to-date data for the data cache specification, the forced build will be invoked.

'''Recover build:''' When the last building process of a data cache specification has been broken by some failures in web servers, internet connections or power failures, the recover build process will be invoked. Instead of force build, the building process will continue from the last broken point of the last building process.

===What does the building process do?===

When a data cache specification is rebuilt, the building process will retrieve data from the tables in the Microsoft SQL Server database as specified by the data cache and store them into the long-term data cache for later use.

If there is only one project questionnaire used inside the data cache specification, the building process will retrieve QASs’ ids and user ids which belong to the primary project questionnaire and satisfy the conditions stated by the data cache specification.

If there is more than one questionnaire used, the building process will create and execute a left outer join query (joining by user id) in which the primary questionnaire is on the left side and other questionnaires are on the right side in order to retrieve QASs’ ids and user ids satisfying the selection rules of the data cache from the Microsoft SQL Server database.

For each column type, the building process will retrieve the corresponding data for columns belonging to that type from the Microsoft SQL Server database and insert them into the temporary cache and then commit the recent cache to the long-term data cache.

===Why do we have both a short term and long term data cache?===

The reason we both a short and long term data cache is to increase speed. The long term data cache makes it possible for us to store the result of a data cache rebuild and thus avoid costly rebuilds if nothing new has happened to the data of a data cache and we just want to use the prior created data table. The short term data cache places the data in the server memory in order to minimize the time it takes to get data out of the long term data cache, since users often use the data tables continuously over shorter periods of time. Data in the short term data cache does therefore not stay there for more than 15 minutes before it is cleared.
__NOTOC__

Category:Data cache specification module

2012-02-16T04:58:29Z

Nguyentanphong: /* When will the data table of a data cache be built? */

[[Category:Help_Files]]

=Data cache specification module=

A Data Cache Specification is used to collect two types of data.

a) Questionnaire answer sheets (QAS) and the users that filled them in. This data is used to create [[_Answer_sheet_data_caches_|Answer Sheet Data Caches]].

b) Resources and the information linked to these. This data is used to create Resource Data Caches.

Once the data is collected they are placed into data tables. These data tables are then used to make reports or export data.

[[Image:1579.png]]

We are in the following chapters going to explain the logic behind the following 5 processes.

Process 1. Retrieve data from several tables in Microsoft SQL Server database as specified by the data cache.

Process 2. Store retrieved data from Microsoft SQL Server database to long- term data cache (MySQL database). This will save the data which was gotten in one table, making the data a lot easier to work with.

Process 3. Retrieve the data cache specification’s data from Short-term data cache. The short-term data cache will explained below.

Process 4. Retrieve the data cache specification’s data from long-term data cache. The long-term data cache will explained below.

Process 5. Invoke the build process. When and how is explained below.

===What is the data cache?===

The data cache is a specification in what data we want, where we want it from, and in what form we want to represent it when converted to one table. Data in Catglobe is stored in a rather complex relational setup, making it very hard to work with for most users. What the data cache therefore does, is convert it into a table, where each row represents a users questionnaire answer sheet and each column information regarding the user and his answers for the questionnaire answer sheet in question.

We actually have the option to create more complex rules for the records in the data table. This concerns the options to take answers from more than one questionnaires’ QASs and place them in the same data table. This is called having primary AND secondary questionnaires in the same data cache. The logic for how many records a data cache will then have is a bit more complex as explained further down.

=== When will the data table of a data cache be built? ===

When the a user asks the report or export module to get the data from a data cache to use for these two modules, then the data cache manager (the manager of all the data cache in the system) will look to retrieve data.

The first thing the data cache manager will do is to investigate whether the data cache is up to date. This is done by looking at the last updated date and the update frequency. How to set these values we will explain in further help files of setting up your data cache.

If the data cache specification is considered up-to-date then:

• The data cache manager will try to get it from the short-term data cache.

• If the required data table does not exist in the short-term data cache, the data cache manager will try to look for it in the long-term data cache.

• If there is no data cached for the data cache specification in the long-term data cache, the building process will be invoked to rebuild the whole data cache specification.

• When the building process has been finished, the data table will be put in to the long-term and short-term data cache, and then returned to the client.

If the data cache specification is considered out-of-date, or its update frequency plus its last updated date is greater than the current date time or the data cache specification is set to be auto-updated:

• The build process will be invoked to rebuild the data cache specification.

• When the building process has been finished, the data table will be put in to the long-term and short-term data cache, and then returned to the client.

Further, a data cache specification is also not up-to-date if its last updated date is not greater than its modified date.

We have two types of builds that are done by the data cache manager.

'''Forced build:''' When it is necessary to get the most up-to-date data for the data cache specification, the forced build will be invoked.

'''Recover build:''' When the last building process of a data cache specification has been broken by some failures in web servers, internet connections or power failures, the recover build process will be invoked. Instead of force build, the building process will continue from the last broken point of the last building process.

===What does the building process do?===

When a data cache specification is rebuilt, the building process will retrieve data from the tables in the Microsoft SQL Server database as specified by the data cache and store them into the long-term data cache for later use.

If there is only one project questionnaire used inside the data cache specification, the building process will retrieve QASs’ ids and user ids which belong to the primary project questionnaire and satisfy the conditions stated by the data cache specification.

If there is more than one questionnaire used, the building process will create and execute a left outer join query (joining by user id) in which the primary questionnaire is on the left side and other questionnaires are on the right side in order to retrieve QASs’ ids and user ids satisfying the selection rules of the data cache from the Microsoft SQL Server database.

For each column type, the building process will retrieve the corresponding data for columns belonging to that type from the Microsoft SQL Server database and insert them into the temporary cache and then commit the recent cache to the long-term data cache.

===Why do we have both a short term and long term data cache?===

The reason we both a short and long term data cache is to increase speed. The long term data cache makes it possible for us to store the result of a data cache rebuild and thus avoid costly rebuilds if nothing new has happened to the data of a data cache and we just want to use the prior created data table. The short term data cache places the data in the server memory in order to minimize the time it takes to get data out of the long term data cache, since users often use the data tables continuously over shorter periods of time. Data in the short term data cache does therefore not stay there for more than 15 minutes before it is cleared.
__NOTOC__

SetPhoneNumber

2012-02-13T08:10:29Z

Nguyentanphong:

{{HelpFiles}}

==== setPhoneNumber ====

Sets the phone number of the current questionnaire answer sheet’s user

'''Syntax'''

setPhoneNumber(''phone_number_type, new_phone_number, country_code'')

'''Arguments'''

''phone_number_type''. Is a numeric (non-decimal) expression. It must be one of the built-in constants:

PhoneNumber_Type_NotIdentified,

PhoneNumber_Type_Home1,

PhoneNumber_Type_Home2,

PhoneNumber_Type_Mobile1,

PhoneNumber_Type_Mobile2,

PhoneNumber_Type_Business1,

PhoneNumber_Type_Business2,

PhoneNumber_Type_HomeFax,

PhoneNumber_Type_BusinessFax

''new_phone_number'': Is a string expression

''country_code'': Is a numeric (non-decimal) expression.

'''Return type'''

empty

'''Examples'''

setPhoneNumber(PhoneNumber_Type_Home1, "212277", 358);

'''Availability'''

Version 4.8

'''Reference:'''

http://help4.catglobe.com/4436.htm __NOTOC__ 

[[Category:User_Functions]]

Category:Literals

2012-02-09T03:44:02Z

Nguyentanphong:

{{HelpFiles}}

=== Literals ===

{| width="1189" cellspacing="0" cellpadding="2" border="1" style="border-collapse:collapse; border:1px solid #010101" class="tableintopic"
|- align="left" valign="top"
| width="204" bgcolor="#C0C0C0" style="border:1px solid #010101;" |
'''Type'''

| width="589" bgcolor="#C0C0C0" style="border:1px solid #010101;" |
'''Description'''

| width="396" bgcolor="#C0C0C0" style="border:1px solid #010101;" |
'''Examples'''

|- align="left" valign="top"
| width="204" style="border:1px solid #010101;" |
string

| width="589" style="border:1px solid #010101;" |
Enclosed with ‘“’ and ‘“’

Not contain ‘“’ or ‘/’ inside.

New line character is not allowed

| width="396" style="border:1px solid #010101;" |
"an"

|- align="left" valign="top"
| width="204" style="border:1px solid #010101;" |
date

| width="589" style="border:1px solid #010101;" |
Must be of the form: #yyyy-mm-dd hh:mm:ss# or #yyyy-mm-dd# used for where expression

Array datetime: {yyyy, mm, dd, hh, mm, ss, [miliseconds], [week] }

Note: Timezone is available from 5.6. Read note below.

| width="396" style="border:1px solid #010101;" | #2006-04-11 10:14:20# 
|- align="left" valign="top"
| width="204" style="border:1px solid #010101;" |
number

| width="589" style="border:1px solid #010101;" |
Could be an integer, a floating point or decimal constant

| width="396" style="border:1px solid #010101;" |
123

1234E 1

123.4

|- align="left" valign="top"
| width="204" style="border:1px solid #010101;" |
range

| width="589" style="border:1px solid #010101;" |
Enclosed with [ and ]

| width="396" style="border:1px solid #010101;" |
[1]

[1,2]

[1-2]

[1-2, 1]

[1, 2, 3]

|- align="left" valign="top"
| width="204" style="border:1px solid #010101;" |
array

| width="589" style="border:1px solid #010101;" |
Enclosed with { and }

| width="396" style="border:1px solid #010101;" |
{1, 2, 3}

|}

 Note: Timezone for datetime (V5.6)

Array datetime: {yyyy, mm, dd, hh, mm, ss, [miliseconds], [week] , [timezone]} 

[[Category:Data_Types_Literals_and_Variables]]

Column: Addressed to

2012-02-07T08:07:42Z

Nguyentanphong:

=== Column: Addressed to ===

{| width="1067" cellpadding="2" border="1" class="tableintopic" style="border-collapse: collapse; border: 1px solid #010101"
|- align="left" valign="top"
| width="228" bgcolor="#FFC20E" style="border: 1px solid #010101" |
Column

| width="839" style="border: 1px solid #010101" |
Addressed to

|- align="left" valign="top"
| width="228" bgcolor="#FFC20E" style="border: 1px solid #010101" |
Source

| width="839" style="border: 1px solid #010101" |
The addressed to value from 1 to 2 of the returned invoice resource

|- align="left" valign="top"
| width="228" bgcolor="#FFC20E" style="border: 1px solid #010101" |
Automatically given column name

| width="839" style="border: 1px solid #010101" |
AddressedTo

|- align="left" valign="top"
| width="228" bgcolor="#FFC20E" style="border: 1px solid #010101" |
Column type

| width="839" style="border: 1px solid #010101" |
Number

|- align="left" valign="top"
| width="228" bgcolor="#FFC20E" style="border: 1px solid #010101" |
Resource types that use it

| width="839" style="border: 1px solid #010101" |
Invoice

|- align="left" valign="top"
| width="228" bgcolor="#FFC20E" style="border: 1px solid #010101" |
How axis set information is built

| width="839" style="border: 1px solid #010101" |
Addressed to for invoices is a fixed enumeration so the value is always the same. The axis set generated will look like below:

Axis text: "AddressedTo"

Math base: "AddressedTo"

Pct base: "AddressedTo!=empty"

Option 1: Name="Customer"; Value="AddressedTo==1"

Option 2: Name="Representative"; Value="AddressedTo==2"

|- align="left" valign="top"
| width="228" bgcolor="#FFC20E" style="border: 1px solid #010101" |
Comment

| width="839" style="border: 1px solid #010101" |
N/A __NOTOC__ 

|}

[[Category:Resource_data_caches]]

Column: Answer sheet duplicate record

2012-02-07T04:38:12Z

Nguyentanphong:

[[Category:Resource data caches]]

=== Column: Answer sheet duplicate record ===

{| width="1067" cellpadding="2" border="1" class="tableintopic" style="border-collapse: collapse; border: 1px solid #010101"
|- align="left" valign="top"
| width="228" bgcolor="#FFC20E" style="border: 1px solid #010101" |
Column

| width="839" style="border: 1px solid #010101" |
Answer sheet duplicate record

|- align="left" valign="top"
| width="228" bgcolor="#FFC20E" style="border: 1px solid #010101" |
Source

| width="839" style="border: 1px solid #010101" |
This column will be set to true for the first instance of the same answer sheet record that is added for a resource cache. Should any duplicates be added, then these will be set to false. The reason that duplicates may exist is when an answer sheet was called multiple times (more CATI contacts for the same answer sheet) then the answer sheet record information will be copied multiple times for each cati contact log record.

|- align="left" valign="top"
| width="228" bgcolor="#FFC20E" style="border: 1px solid #010101" |
Automatically given column name

| width="839" style="border: 1px solid #010101" |
AnswerSheetDuplicateRecord

|- align="left" valign="top"
| width="228" bgcolor="#FFC20E" style="border: 1px solid #010101" |
Column type

| width="839" style="border: 1px solid #010101" |
Boolean

|- align="left" valign="top"
| width="228" bgcolor="#FFC20E" style="border: 1px solid #010101" |
Resource types that use it

| width="839" style="border: 1px solid #010101" |
Questionnaire

|- align="left" valign="top"
| width="228" bgcolor="#FFC20E" style="border: 1px solid #010101" |
How axis set information is built

| width="839" style="border: 1px solid #010101" |
Since this is a boolean column, then the possible values that can exist in this column are only 0 and 1, which corresponds to "False" and "True". It is therefore easy to create the axis since we have a limited well defined number of outcomes.

The axis generated for this column will look like below:

Axis text: "Answer sheet duplicate record"

Math base: "AnswerSheetDuplicateRecord"

Pct base: "AnswerSheetDuplicateRecord!=empty"

Option 1: Name="False"; Value="!AnswerSheetDuplicateRecord"

Option 2: Name="True"; Value="AnswerSheetDuplicateRecord"

|- align="left" valign="top"
| width="228" bgcolor="#FFC20E" style="border: 1px solid #010101" |
Comment

| width="839" style="border: 1px solid #010101" |
As a answer sheet record can occur in more than one data row, this column helps you “SELECT DISTINCT” answer sheet records in a resource cache, so for example the following expression will return the number of times a specific respondent has taken part in the interviews of all questionnaires in QNR resource cache.

=(count() where (respondent == 83861) && (AnswerSheetDuplicated== FALSE) && (id!=empty)) __NOTOC__ 

|}

Column: Account

2012-02-07T04:35:45Z

Nguyentanphong: /* Column: Account */

[[Category:Resource data caches]]

=== Column: Account ===

{| width="1067" cellpadding="2" border="1" class="tableintopic" style="border-collapse: collapse; border: 1px solid #010101"
|- align="left" valign="top"
| width="228" bgcolor="#FFC20E" style="border: 1px solid #010101" |
Column

| width="839" style="border: 1px solid #010101" |
Account

|- align="left" valign="top"
| width="228" bgcolor="#FFC20E" style="border: 1px solid #010101" |
Source

| width="839" style="border: 1px solid #010101" |
The id of the account added for account detail record of a returned invoice resource

|- align="left" valign="top"
| width="228" bgcolor="#FFC20E" style="border: 1px solid #010101" |
Automatically given column name

| width="839" style="border: 1px solid #010101" |
Account

|- align="left" valign="top"
| width="228" bgcolor="#FFC20E" style="border: 1px solid #010101" |
Column type

| width="839" style="border: 1px solid #010101" |
Number

|- align="left" valign="top"
| width="228" bgcolor="#FFC20E" style="border: 1px solid #010101" |
Resource types that use it

| width="839" style="border: 1px solid #010101" |
Invoice

|- align="left" valign="top"
| width="228" bgcolor="#FFC20E" style="border: 1px solid #010101" |
How axis set information is built

| width="839" style="border: 1px solid #010101" |
This column is what we call a "search string dependent axis option". This means that the axis set for it is rebuilt each time that the resource cache is rebuilt. The reason for this is, that the number of possible option outcomes for the column is changing each time the column is updated. For this column it will not make sense if you try to update its options directly in the axis set, since these will be reset on resource cache rebuild anyway.

The axis set is built upon first extracting all the IDs that are in the "Account" column, then creating one option in the axis set for each unique value. The option will be named the same as the account in Catglobe that owns the ID. Let us say that the system finds the value "12" in this column. The system will then look up the name of the account record with this ID and creates an option in the axis that is automatically generated for the column.

Typically the axis for this column will look something like the below:

Axis text: "Account"

Math base: "Account"

Pct base: "Account!=empty"

 

Option 1: Name="Revenue from consultancy work"; Value="Account==123"

Option 2: Name="...."; Value="Account==...", etc.

|- align="left" valign="top"
| width="228" bgcolor="#FFC20E" style="border: 1px solid #010101" |
Comment

| width="839" style="border: 1px solid #010101" |
N/A __NOTOC__ 

|}

CheckAllQuotas

2012-02-01T08:57:03Z

Nguyentanphong:

[[Category:Questionnaire_Functions]]
{{HelpFiles}}

==== checkAllQuotas ====

Returns true if any quotas of the questionnaire have reached their targets and the questionnaire answer sheet is in these quotas (*).

(*)Quotas are defined by opening the questionnaire, choose tab Sample  -> Add Quota

'''Syntax'''

checkAllQuotas()

'''Arguments'''

none

'''Return type'''

bool

'''Example'''

if (checkAllQuotas()) gotoQuestion("Appologize_Appreciate");

'''Availability'''

Version 4.8 __NOTOC__

CATI getLinkToCATIForm

2012-02-01T08:55:55Z

Nguyentanphong:

[[Category:Questionnaire_Functions]]
{{HelpFiles}}

==== CATI_getLinkToCATIForm ====

'''Syntax'''

string CATI_getLinkToCATIForm(number rpqId)

'''Arguments'''

RPQId : resource project questionnaire id

'''Return type'''

String

'''Example'''

string a = CATI_getLinkToCATIForm(89716960);

print(a);

//Output : CommunicatorModule/Cati/CatiFormExpand.aspx?pid=6301

 '''Availability'''

Version 5.8 __NOTOC__

CATI getLinkToCATIForm

2012-02-01T08:53:04Z

Nguyentanphong:

[[Category:Questionnaire_Functions]]
{{HelpFiles}}

==== CATI_getLinkToCATIForm ====

 
 

'''Syntax'''

string CATI_getLinkToCATIForm(number rpqId)

'''Arguments'''

RPQId : resource project questionnaire id

'''Return type'''

String

'''Example'''

string a = CATI_getLinkToCATIForm(89716960);

print(a);

//Output : CommunicatorModule/Cati/CatiFormExpand.aspx?pid=6301

 '''Availability'''

Version 5.8 __NOTOC__

Sms sendMailTemplate

2012-02-01T08:22:16Z

Nguyentanphong:

{{HelpFiles}}

==== Sms_sendMailTemplate ====

This function makes it possible to send SMS messages to users using a mailtemplate for the actual message.

'''Syntax'''

Sms_sendMailTemplate(''userResourceIds, smsoutprovidername, mailtemplateresourceid, [fromresourceid]'')

'''Arguments'''

''userResourceId:'' array of ids of the users who are to receive the SMS

''smsoutprovidername'': the name of the provider which will be used to send the SMS. Look for the ones available in your lists of SMS providers and copy the exact name from there.

''mailtemplateresourceid'': the resource id of the mail template that you want to send to the listed users.

''fromresourceid'': (optional) used to determine the source resource, which is again used to determine which keywords to use in the mail template, and also determines which SENT box the message ends up in. Default is current user.

'''Return type'''

An array of status codes will be returned as result of the function. There will exist one status for each user to which an SMS was sent. The status codes are:

{| width="907" cellpadding="2" border="1" class="tableintopic" style="border-collapse: collapse; border: 1px solid #010101"
|- align="left" valign="top"
| width="48" bgcolor="#FACEAA" style="border: 1px solid #010101" |
Code

| width="288" bgcolor="#FACEAA" style="border: 1px solid #010101" |
Constant name

| width="571" bgcolor="#FACEAA" style="border: 1px solid #010101" |
Description

|- align="left" valign="top"
| width="48" style="border: 1px solid #010101" |
0

| width="288" style="border: 1px solid #010101" |
SMS_STATUS_SUCCESSFUL

| width="571" style="border: 1px solid #010101" |
Sent successfully

|- align="left" valign="top"
| width="48" style="border: 1px solid #010101" |
1

| width="288" style="border: 1px solid #010101" |
SMS_STATUS_NO_VALID_PHONE_NUMBER

| width="571" style="border: 1px solid #010101" |
No valid phone number is found to receive the message or user does not have at least 1 phone number

|- align="left" valign="top"
| width="48" style="border: 1px solid #010101" |
2

| width="288" style="border: 1px solid #010101" |
SMS_STATUS_MESSAGE_TOO_LONG

| width="571" style="border: 1px solid #010101" |
The message length exceeds 160 characters

|- align="left" valign="top"
| width="48" style="border: 1px solid #010101" |
3

| width="288" style="border: 1px solid #010101" |
SMS_STATUS_NOT_USER_RESOURCE

| width="571" style="border: 1px solid #010101" |
The type of given resource is not type of user

|- align="left" valign="top"
| width="48" style="border: 1px solid #010101" |
4

| width="288" style="border: 1px solid #010101" |
SMS_STATUS_USER_DOES_NOT_EXIST

| width="571" style="border: 1px solid #010101" |
The given user does not exist

|- align="left" valign="top"
| width="48" style="border: 1px solid #010101" |
5

| width="288" style="border: 1px solid #010101" |
SMS_STATUS_USER_DELETED

| width="571" style="border: 1px solid #010101" |
This user has been deleted

|- align="left" valign="top"
| width="48" style="border: 1px solid #010101" |
6

| width="288" style="border: 1px solid #010101" |
SMS_STATUS_USER_DISABLED

| width="571" style="border: 1px solid #010101" |
This user has been disabled

|- align="left" valign="top"
| width="48" style="border: 1px solid #010101" |
7

| width="288" style="border: 1px solid #010101" |
SMS_STATUS_MISSING_RESOURCE_ACCESS

| width="571" style="border: 1px solid #010101" |
Current user does not have at least observer access to given user 

|}

'''Examples'''

array users = {1234567,1234568,1234569};

string smsprovidername = "TeleCo";

number mailtemplate = 678;

Sms_sendMailTemplate(users,smsprovidername,mailtemplate);

'''Availability'''

Version 5.8.1 __NOTOC__ 

[[Category:Email_and_SMS_Functions]]

Sms send

2012-02-01T08:19:30Z

Nguyentanphong:

{{HelpFiles}}

==== Sms_send ====

This function makes it possible to send SMS messages to users.

'''Syntax'''

Sms_send(''userResourceIds, smsoutprovidername, message, [fromresourceid]'')

'''Arguments'''

''userResourceId:'' array of ids of the users who are to receive the SMS

''smsoutprovidername'': the name of the provider which will be used to send the SMS. Look for the ones available in your lists of SMS providers and copy the exact name from there.

''message'': the text that you want to send to the users. Should be a string of max 160 characters or it may get truncated.

''fromresourceid'': (optional) used to determine the source resource, which is again used to determine which keywords to use in the mail template, and also determines which SENT box the message ends up in. Default is current user.

'''Return type'''

An array of status codes will be returned as result of the function. There will exist one status for each user to which an SMS was sent. The status codes are:

{| width="907" cellpadding="2" border="1" class="tableintopic" style="border-collapse: collapse; border: 1px solid #010101"
|- align="left" valign="top"
| width="48" bgcolor="#FACEAA" style="border: 1px solid #010101" |
Code

| width="288" bgcolor="#FACEAA" style="border: 1px solid #010101" |
Constant name

| width="571" bgcolor="#FACEAA" style="border: 1px solid #010101" |
Description

|- align="left" valign="top"
| width="48" style="border: 1px solid #010101" |
0

| width="288" style="border: 1px solid #010101" |
SMS_STATUS_SUCCESSFUL

| width="571" style="border: 1px solid #010101" |
Sent successfully

|- align="left" valign="top"
| width="48" style="border: 1px solid #010101" |
1

| width="288" style="border: 1px solid #010101" |
SMS_STATUS_NO_VALID_PHONE_NUMBER

| width="571" style="border: 1px solid #010101" |
No valid phone number is found to receive the message or user does not have at least 1 phone number

|- align="left" valign="top"
| width="48" style="border: 1px solid #010101" |
2

| width="288" style="border: 1px solid #010101" |
SMS_STATUS_MESSAGE_TOO_LONG

| width="571" style="border: 1px solid #010101" |
The message length exceeds 160 characters

|- align="left" valign="top"
| width="48" style="border: 1px solid #010101" |
3

| width="288" style="border: 1px solid #010101" |
SMS_STATUS_NOT_USER_RESOURCE

| width="571" style="border: 1px solid #010101" |
The type of given resource is not type of user

|- align="left" valign="top"
| width="48" style="border: 1px solid #010101" |
4

| width="288" style="border: 1px solid #010101" |
SMS_STATUS_USER_DOES_NOT_EXIST

| width="571" style="border: 1px solid #010101" |
The given user does not exist

|- align="left" valign="top"
| width="48" style="border: 1px solid #010101" |
5

| width="288" style="border: 1px solid #010101" |
SMS_STATUS_USER_DELETED

| width="571" style="border: 1px solid #010101" |
This user has been deleted

|- align="left" valign="top"
| width="48" style="border: 1px solid #010101" |
6

| width="288" style="border: 1px solid #010101" |
SMS_STATUS_USER_DISABLED

| width="571" style="border: 1px solid #010101" |
This user has been disabled

|- align="left" valign="top"
| width="48" style="border: 1px solid #010101" |
7

| width="288" style="border: 1px solid #010101" |
SMS_STATUS_MISSING_RESOURCE_ACCESS

| width="571" style="border: 1px solid #010101" |
Current user does not have at least observer access to given user 

|}

'''Examples'''

array users = {1234567,1234568,1234569};

string smsprovidername = "TeleCo";

string msg = "The project has been completed";

Sms_send(users,smsprovidername,msg);

'''Availability'''

Version 5.8.1 __NOTOC__ 

[[Category:Email_and_SMS_Functions]]

BulkSms new

2012-02-01T08:12:44Z

Nguyentanphong:

{{HelpFiles}}

==== BulkSms_new ====

Create new bulk SMS object

'''Syntax'''

BulkSms_new(''bulkSmsName, parentResourceId, mailTemplateResourceId, smsOutProviderName'')

'''Arguments'''

*''bulkSmsName'': (string) Name of the new bulk SMS
*''parentResourceId'': (number) Parent resource id of the new bulk SMS
*''mailTemplateResourceId'': (number) Mail template resource Id. The mail template that is to be used for the bulk Sms.
*''smsOutProviderName'': (string) Case sensitive name of the outgoing SMS provider that should be used to send the SMS. Please look in your system SMS provider list to find the correct provider to use.

'''Return value'''

Bulk SMS object returned in an array:

{| width="1067" cellpadding="2" border="1" class="tableintopic" style="border-collapse: collapse; border: 1px solid #010101"
|- align="left" valign="top"
| width="356" bgcolor="#C0C0C0" style="border: 1px solid #010101" |
'''Index'''

| width="356" bgcolor="#C0C0C0" style="border: 1px solid #010101" |
'''Data type'''

| width="356" bgcolor="#C0C0C0" style="border: 1px solid #010101" |
'''Value'''

|- align="left" valign="top"
| width="356" style="border: 1px solid #010101" |
BULKSMS_RESOURCE_ID

| width="356" style="border: 1px solid #010101" |
number

| width="356" style="border: 1px solid #010101" |
0

|- align="left" valign="top"
| width="356" style="border: 1px solid #010101" |
BULKSMS_NAME

| width="356" style="border: 1px solid #010101" |
string

| width="356" style="border: 1px solid #010101" |
Entered value

|- align="left" valign="top"
| width="356" style="border: 1px solid #010101" |
BULKSMS_PARENT_RESOURCE_ID

| width="356" style="border: 1px solid #010101" |
number

| width="356" style="border: 1px solid #010101" |
Entered value

|- align="left" valign="top"
| width="356" style="border: 1px solid #010101" |
BULKSMS_MAIL_TEMPLATE_RESOURCE_ID

| width="356" style="border: 1px solid #010101" |
number

| width="356" style="border: 1px solid #010101" |
Entered value

|- align="left" valign="top"
| width="356" style="border: 1px solid #010101" |
BULKSMS_OUT_PROVIDER_NAME

| width="356" style="border: 1px solid #010101" |
string

| width="356" style="border: 1px solid #010101" |
It should be an existing SMS provider by exact name from the SMS provider list.

|- align="left" valign="top"
| width="356" style="border: 1px solid #010101" |
BULKSMS_USER_RESOURCE_IDS

| width="356" style="border: 1px solid #010101" |
array

| width="356" style="border: 1px solid #010101" |
{}

|- align="left" valign="top"
| width="356" style="border: 1px solid #010101" |
BULKSMS_GROUP_RESOURCE_IDS

| width="356" style="border: 1px solid #010101" |
array

| width="356" style="border: 1px solid #010101" |
{}

|- align="left" valign="top"
| width="356" style="border: 1px solid #010101" |
BULKSMS_GROUP_TO_BE_REBUILD_RESOURCE_IDS

| width="356" style="border: 1px solid #010101" |
array

| width="356" style="border: 1px solid #010101" |
{}

|- align="left" valign="top"
| width="356" style="border: 1px solid #010101" |
BULKSMS_NO_IN_OUT_QUEUE

| width="356" style="border: 1px solid #010101" |
Number (read only)

| width="356" style="border: 1px solid #010101" |
Default is 0

|- align="left" valign="top"
| width="356" style="border: 1px solid #010101" |
BULKSMS_NO_OF_SENT

| width="356" style="border: 1px solid #010101" |
Number (read only)

| width="356" style="border: 1px solid #010101" |
Default is 0 

|}

 

'''Example'''

string bulkSmsName = "TestBulkSMS";

number parentResourceId = 34778803;

number mailTemplateResourceId = 501537;

string smsOutProviderName= "TeleCo"

array newBS = BulkSms_new(bulkSmsName, parentResourceId, mailTemplateResourceId, smsOutProviderName);

print(newBS); //{35,0,TestBulkSMS,34778803,501537,TeleCo,{},{},{},0,0}

'''Availability'''

Version 5.8.1 __NOTOC__ 

[[Category:Email_and_SMS_Functions]]

BulkMail new

2012-02-01T08:09:47Z

Nguyentanphong:

{{HelpFiles}}

==== BulkMail_new ====

Create new bulk mail object

'''Syntax'''

BulkMail_new(bulkMailName, parentResourceId, mailTemplateId)

or

BulkMail_new( bulkMailName, parentResourceId, mailTemplateId , bulkMailTemplateResourceId)

'''Arguments'''

*bulkMailName: is string. It is the name of new bulkMail
*parentResourceId: is number. It is parent resource id of the new bulkMail
*mailTemplateId: is number. It is the mail template resource Id gotten from Communicator template
*bulkMailTemplateResourceId: is number. It is bulkMail template resource Id

'''Return value'''

Array which is BulkMail object:

{| width="1067" cellpadding="2" class="tableintopic" style="border-collapse: collapse"
|- align="left" valign="top"
| width="356" bgcolor="#C0C0C0" style="border: 1px solid #010101" |
'''Index'''

| width="356" bgcolor="#C0C0C0" style="border: 1px solid #010101" |
'''Data type'''

| width="356" bgcolor="#C0C0C0" style="border: 1px solid #010101" |
'''Value'''

|- align="left" valign="top"
| width="356" style="border: 1px solid #010101" |
BULKMAIL_RESOURCE_ID

| width="356" style="border: 1px solid #010101" |
number

| width="356" style="border: 1px solid #010101" |
0

|- align="left" valign="top"
| width="356" style="border: 1px solid #010101" |
BULKMAIL_NAME

| width="356" style="border: 1px solid #010101" |
number

| width="356" style="border: 1px solid #010101" |
Entered value

|- align="left" valign="top"
| width="356" style="border: 1px solid #010101" |
BULKMAIL_PARENT_RESOURCE_ID

| width="356" style="border: 1px solid #010101" |
string

| width="356" style="border: 1px solid #010101" |
Entered value

|- align="left" valign="top"
| width="356" style="border: 1px solid #010101" |
BULKMAIL_TEMPLATE_RESOURCE_ID

| width="356" style="border: 1px solid #010101" |
number

| width="356" style="border: 1px solid #010101" |
if it is not specified explicitly in the constructor as a parameter, then get default bulk mail template

|- align="left" valign="top"
| width="356" style="border: 1px solid #010101" |
BULKMAIL_MAIL_TEMPLATE_RESOURCE_ID

| width="356" style="border: 1px solid #010101" |
number

| width="356" style="border: 1px solid #010101" |
Entered value

|- align="left" valign="top"
| width="356" style="border: 1px solid #010101" |
BULKMAIL_EMAIL_ACCOUNT

| width="356" style="border: 1px solid #010101" |
string

| width="356" style="border: 1px solid #010101" |
It will be the default private email inside the parent resource or the first global email in case there is no a default private email. If there is no any private and global email then it's ""

|- align="left" valign="top"
| width="356" style="border: 1px solid #010101" |
BULKMAIL_USER_RESOURCE_IDS

| width="356" style="border: 1px solid #010101" |
array

| width="356" style="border: 1px solid #010101" |
{}

|- align="left" valign="top"
| width="356" style="border: 1px solid #010101" |
BULKMAIL_GROUP_RESOURCE_IDS

| width="356" style="border: 1px solid #010101" |
array

| width="356" style="border: 1px solid #010101" |
{}

|- align="left" valign="top"
| width="356" style="border: 1px solid #010101" |
BULKMAIL_GROUP_TO_BE_REBUILD_RESOURCE_IDS

| width="356" style="border: 1px solid #010101" |
array

| width="356" style="border: 1px solid #010101" |
{}

|- align="left" valign="top"
| width="356" style="border: 1px solid #010101" |
BULKMAIL_PRIORITY

| width="356" style="border: 1px solid #010101" |
number

| width="356" style="border: 1px solid #010101" |
Normal

There must be constants defined for 3 levels of priority:

Bulkmail_Priority_Low

Bulkmail_Priority_Normal

Bulkmail_Priority_High

|- align="left" valign="top"
| width="356" style="border: 1px solid #010101" |
BULKMAIL_NO_IN_OUT_QUEUE

| width="356" style="border: 1px solid #010101" |
Number (read only)

| width="356" style="border: 1px solid #010101" |
Default is 0

|- align="left" valign="top"
| width="356" style="border: 1px solid #010101" |
BULKMAIL_NO_OF_SENT

| width="356" style="border: 1px solid #010101" |
Number (read only)

| width="356" style="border: 1px solid #010101" |
Default is 0 

|}

'''Example'''

string bulkMailName = "TestBulkMail";

number parentResourceId = 34778803;

number mailTemplateResourceId = 501537;

array newBM = BulkMail_new(bulkMailName, parentResourceId, mailTemplateResourceId);

print(newBM); // {27,0,TestBulkMail,34778803,34409968,501537,Administrator@mycatinet.catglobe.com,{},{},{},0,0,0}

 Availability

Version 5.8 __NOTOC__ 

[[Category:Email_and_SMS_Functions]]

Category:Document editor

2012-01-20T04:32:08Z

Nguyentanphong: /* Document editor */

[[Category:Reports]]
{{HelpFiles_Report_Module}}

=== Document editor ===

CatGlobe introduces the Document Editor - a solution to simplify the task of making reports. Once you start working with it, you will soon find it is not only an easy-to-use tool, but also a powerful tool that can interact with Data Cache/Diagrams. Moreover it offers a recently added feature that makes it possible to export any reports to PDF documents, makes the editor more valuable than ever!

[[Image:5842.png|800px|ReportDoc56-1]]

The editor consists of a top menu, two tool bars underneath it, and an editing area.

In the top menu, you will find a number of commands which are shortly described in the table below. [[Data cache specification module|Using data cache in reports and diagrams]]

*[[Standard diagram|Creating static diagrams using the Spreadsheet editor]]
*[[Expression syntax|Using expressions in reports and diagrams]]
*[[Reports - Templates - Filters - Constants|Using constants in reports and diagrams]]
*[[Mass update reports|Mass-updating reports]]
*Setting up style for diagrams

To learn more on some of the standard features please click on the links below. __NOTOC__

Questionnaire minimum value required text

2012-01-10T10:03:14Z

Nguyentanphong: /* Questionnaire minimum value required text */

= Questionnaire minimum value required text =

{| width="907" cellspacing="0" cellpadding="2" border="0" class="tableintopic" style="border-collapse:collapse"
|-
| width="180" height="0" |
| width="84" height="0" |
| width="66" height="0" |
| width="576" height="0" |
| width="0" height="0" |
|- valign="top" align="left"
| width="180" |
'''Purpose:'''

| width="727" colspan="4" |
 

|- valign="top" align="left"
| width="180" |
'''Property name:'''

| width="727" colspan="4" |
MIN_VALUE_REQUIRED_TEXT

|- valign="top" align="left"
| width="180" |
'''Type:'''

| width="727" colspan="4" |
 

|- valign="top" align="left"
| width="180" |
'''Used for questionnaire:'''

| width="727" colspan="4" |
[[Image:8153.png]][[Image:8152.png]] 

|- valign="top" align="left"
| width="180" |
'''Used for questions:'''

| width="84" |
[[Image:8153.png]][[Image:8152.png]] 

| width="66" |
'''Types:'''

| width="577" |
 

|- valign="top" align="left"
| width="180" |
'''Used for sub-questions:'''

| width="727" colspan="4" |
[[Image:8153.png]][[Image:8152.png]]

|- valign="top" align="left"
| width="180" |
'''Used for answer options:'''

| width="727" colspan="4" |
[[Image:8153.png]][[Image:8152.png]] 

|- valign="top" align="left"
| width="180" |
'''Example:'''

| width="727" colspan="4" |
 

|}

[[Category:Properties]]

Category:Shifts module

2012-01-06T07:32:59Z

Nguyentanphong:

== Shifts module ==

In the left side of the navigation overview dialog you will see the list of all main modules. When clicking on any module you will in the right frame see the navigation functions that exist for that module. For all modules there will be a 'main' navigation function on top, which normally is used to grant access to the entire module or at least the most important part of the module.

Below you see how this main navigation function looks when chosen for the Shifts module.

[[Image:7273.png|148px|ShiftModule]]

When checked it means that the user will have access to the shifts list via Tools -> HR -> Shifts.

[[Category:Navigation_access]]

Category:Sample request

2012-01-06T07:31:55Z

Nguyentanphong: /* Sample request */

== Sample request ==

In the left side of the navigation overview dialog you will see the list of all main modules. When clicking on any module you will in the right frame see the navigation functions that exist for that module. For all modules there will be a 'main' navigation function on top, which normally is used to grant access to the entire module or at least the most important part of the module.

Below you see how this main navigation function looks when chosen for the Sample request module.

[[Image:7272.png|188px|SampleRequest]]

When checked it means that the user will have access to the Sample request resource list via Tools -> Surveys -> Sample request module -> Sample requests. 

[[Category:Navigation_access]]

Category:Resource template module

2012-01-06T07:29:57Z

Nguyentanphong: /*  Resource template module */

==  Resource template module ==

In the left side of the navigation overview dialog you will see the list of all main modules. When clicking on any module you will in the right frame see the navigation functions that exist for that module. For all modules there will be a 'main' navigation function on top, which normally is used to grant access to the entire module or at least the most important part of the module.

Below you see how this main navigation function looks when chosen for the Resource template module.

[[Image:7271.png|279px|ResourceTemplateModule]]

When checked it means that the user will have access to the Resource template resource list via Tools -> Administration -> System -> Resource templates.

 

[[Category:Navigation_access]]

The five list tabs

2012-01-04T09:50:07Z

Nguyentanphong: /* The five list tabs */

[[Category:Fieldwork_Manager]]

===The five list tabs===

There are five tabs with lists in the Fieldwork Manager that shows what state a respondent is in for the chosen CATI survey. A respondent will at any given point of time only exist on one of these lists but will be moved between them each time his status is updated in connection with the survey. The five tabs with lists are Main List, Appointment List, Retry List, Ongoing List, and Finished List.

[[Image:5870.png|800px|CATI56-1]]

On these five lists there are a number of buttons and features that we can use to analyze and effect the respondents. Each of these are explained in turn below:

===Button: Call a selected person===

'''Lists where available '''

* Main list
* Appointment list
* Retry list

'''Description'''

These buttons make it possible for the supervisor (user of Live Monitor) to call any respondent of choice on the list without using the Next Call Logic. Please notice that the supervisor must be added as Interviewer in the list of Interviewers in order to do this.

===Button: View detail===

'''Lists where available'''

* Main list
* Ongoing list
* Appointment list
* Retry list
* Finished list

'''Description'''

In case supervisor wants to see more information on a respondent he can click the “View detail” button which will bring up a dialogue, where it is possible to update the respondent’s personal information.

===Button: Dedicate and Un-dedicate===

'''Lists where available'''

* Main list
* Appointment list
* Retry list

'''Description'''It is possible to dedicate interviewers to specific respondents using the dedicate button. If you want the dedication to be removed you can use the un-dedicate button.

===Button: Search===

'''Lists where available '''

* Main list
* Ongoing list
* Appointment list
* Retry list
* Finished list

'''Description'''

If our list of respondents is very long, it may be hard to find the exact respondents that we are looking for. By using the search feature we can filter the returned list of respondents by some popular criteria.

[[Image:3331.png|600px|CATI53_1]]

'''Sample:''' Lists all the samples used in the questionnaire and you should highlight those samples from which you want respondents listed.

'''Priority:''' You can specify a min and max priority that respondents have for them to be returned in connection with your search.

'''Answer sheet status:''' Questionnaire answer sheets can have been given 5 different statuses as an outcome of what happened during the CATI call or what happened in the questionnaire logic. You can choose which of these statuses that should be included in the returned list of respondents.

'''Calls (available for ongoing, meeting, finished):''' If you only want to see the respondents whom you have called a specific number of times in relation with the interview in question you can define minimum and maximum limits using this filter.

'''CATI Contact Status (available for meeting, finished):''' If you want to search respondents based on what outcome a call to them had during the most recent call, you can use this filter. It will make it possible to filter by all the outcomes that are possible for the questionnaire.

'''Dedicated user: '''You can search respondents based on the interviewer who will call him next time.

'''Next contact time from/to (available for meeting):''' Here you can search respondents based on the meeting date and time we have set for them.

===Button: Update priority===

'''Lists where available '''

* Main list
* Appointment list
* Retry list

'''Description'''

Priority is important in connection with the Next Call Logic. By using the “Update priority” button you can influence the priority settings of your respondents and thus who is called first!

If you choose some respondents in the list by highlighting them, you will have to choose on the dialogue if it is the highlighted respondents you want to update or all the respondents in the list that you are updating. If it is the latter you must check the checkbox shown in a red circle below!

[[Image:1629.png|399px|Update priority 1]]

If you don’t choose any respondents in the list, the priority updates will always affect all the respondents in the current list. You can see this by the checkbox in the lower part of the dialogue being checked and deactivated!

[[Image:1630.png|398px|Update priority 2]]

===Button: Update next contact time===

'''Lists where available '''

* Appointment list
* Retry list

'''Description'''

If you want to change the appointment time for respondents in the appointment list you use this feature. There are two methods made available for changing time; namely “set” and “slide”.

The set appointment time makes it possible to specify an exact time where you want the appointments to take place. Below is shown how the dialogue will look in this case.

[[Image:1631.png|500px|Update next 1]]

The slide appointment time differs in that it is will make it possible for you to set the next appointment time based on the difference with the current specified date and time. As seen in the example you can choose to slide both forward (making the new date and time later) or backward (making the new date and time earlier).

[[Image:1632.png|500px|Update next 2]]

The check box on the bottom of the screen will be activated if you in the list had highlighted any respondent. By not checking the checkbox only the respondents you highlighted will be updated. If checking, the specific respondents you chose will be irrelevant because it will just update all respondents in the list that you had selected. In case you did not highlight any respondents when opening this dialogue the check box will always be set to “update all”.

===Button: Reactivate===

'''Lists where available '''

* Finished list

'''Description'''

In the appointment list, the supervisor can reactivate failed respondents. The reasons for doing this may be many, e.g.: that there are too few remaining respondents so another try must be given to failed ones; that there were too many reaching total recalls and given up; or that we statistically do not get a good enough result if we do not try again some of those that initially refused.

If you do not choose any respondents in the list, the system will reactivate all the failed respondents in current view of the meeting list.

[[Image:1494.png]]

If you highlight some respondents in the list, you must choose whether you want to update the selected respondents only (called QAS below) or reactivate all the failed respondents in the view of the finished list.

[[Image:1495.png]]
__NOTOC__

DCS newQuestionnaireQuickSetup

2011-11-28T07:45:02Z

Nguyentanphong: /* Example */

= DCS_newQuestionnaireQuickSetup =

Quick create a DCS base on questionnaires and they must have the same questionnaire template.

=== Syntax ===

DCS_newQuestionnaireQuickSetup(DCSName, Questionnaires)

=== Arguments ===

DCSName: is a string. This is name of new DCS.

Questionnaires: is an array which contain questionnaire resource id.

=== Return type ===

Empty

=== Example ===

string DCSName= "dcs of questionnaire 1 and questionnaire 2";

array Qlist={37246024, 37278197}; //Questionnaire Resource ID

DCS_newQuestionnaireQuickSetup(DCSName, Qlist);

 __NOTOC__

[[Category:Data_cache_specification_module]]

Resource searchByName

2011-11-17T09:50:57Z

Nguyentanphong: /* Resource_searchByName */

= Resource_searchByName =

Search a resource by name.
 

=== Syntax ===

Resource_searchByName(ResourceName, ResourceType, ResourceTemplateResourceID, NameSearchType, SearchMaxCount)
 

=== Arguments ===

ResourceName: is a string. It is a name of resource which user want to look up.

ResourceType: It is a value of Resource type's constant. Or can be used name of [[CGS_Constants_list|Resource Type]] constant.

RsourceTemplateResourceID: is a number. It is the resource id of resource template ID. This value can be set 0 if don't care which template to search for.

NameSearchType: It is a value of Name Search type's constant. Or can be used a name of [[CGS_Constants_list|Name Search Type]] constant.

SearchMaxCount: is a number. 

=== Return type ===

An Array, which contain the information of resource was found. 

=== Examples ===

string RName = "phong";

number RType = Resource_Type_Report;

number RTempRID = 0;

number NSType = 1;

Number SMcount= 1;

array Result = Resource_searchByName(RName, RType, RTempRID, NSType);

print(Result);

//{{10,37257205,Phong report 2,12,37246022,34409964},{10,37257212,Phong report 1,12,37246022,34409964},{10,37272405,phong report 3,12,37246022,34409964},{10,37272427,Phong report 4,12,37246022,34409964},{10,37272501,phong,12,37272491,34409964}} __NOTOC__

[[Category:Resource_Functions]]

Resource searchByName

2011-11-17T09:50:46Z

Nguyentanphong: /* Resource_searchByName */

= Resource_searchByName =

Search a resource by name.

 
=== Syntax ===

Resource_searchByName(ResourceName, ResourceType, ResourceTemplateResourceID, NameSearchType, SearchMaxCount)
 

=== Arguments ===

ResourceName: is a string. It is a name of resource which user want to look up.

ResourceType: It is a value of Resource type's constant. Or can be used name of [[CGS_Constants_list|Resource Type]] constant.

RsourceTemplateResourceID: is a number. It is the resource id of resource template ID. This value can be set 0 if don't care which template to search for.

NameSearchType: It is a value of Name Search type's constant. Or can be used a name of [[CGS_Constants_list|Name Search Type]] constant.

SearchMaxCount: is a number. 

=== Return type ===

An Array, which contain the information of resource was found. 

=== Examples ===

string RName = "phong";

number RType = Resource_Type_Report;

number RTempRID = 0;

number NSType = 1;

Number SMcount= 1;

array Result = Resource_searchByName(RName, RType, RTempRID, NSType);

print(Result);

//{{10,37257205,Phong report 2,12,37246022,34409964},{10,37257212,Phong report 1,12,37246022,34409964},{10,37272405,phong report 3,12,37246022,34409964},{10,37272427,Phong report 4,12,37246022,34409964},{10,37272501,phong,12,37272491,34409964}} __NOTOC__

[[Category:Resource_Functions]]

Resource searchByName

2011-11-17T09:50:32Z

Nguyentanphong: /* Syntax */

= Resource_searchByName =

Search a resource by name.

 

=== Syntax ===

Resource_searchByName(ResourceName, ResourceType, ResourceTemplateResourceID, NameSearchType, SearchMaxCount)
 

=== Arguments ===

ResourceName: is a string. It is a name of resource which user want to look up.

ResourceType: It is a value of Resource type's constant. Or can be used name of [[CGS_Constants_list|Resource Type]] constant.

RsourceTemplateResourceID: is a number. It is the resource id of resource template ID. This value can be set 0 if don't care which template to search for.

NameSearchType: It is a value of Name Search type's constant. Or can be used a name of [[CGS_Constants_list|Name Search Type]] constant.

SearchMaxCount: is a number. 

=== Return type ===

An Array, which contain the information of resource was found. 

=== Examples ===

string RName = "phong";

number RType = Resource_Type_Report;

number RTempRID = 0;

number NSType = 1;

Number SMcount= 1;

array Result = Resource_searchByName(RName, RType, RTempRID, NSType);

print(Result);

//{{10,37257205,Phong report 2,12,37246022,34409964},{10,37257212,Phong report 1,12,37246022,34409964},{10,37272405,phong report 3,12,37246022,34409964},{10,37272427,Phong report 4,12,37246022,34409964},{10,37272501,phong,12,37272491,34409964}} __NOTOC__

[[Category:Resource_Functions]]

Resource searchByName

2011-11-17T09:50:14Z

Nguyentanphong: /* Arguments */

= Resource_searchByName =

Search a resource by name.

 

=== Syntax ===

Resource_searchByName(ResourceName, ResourceType, ResourceTemplateResourceID, NameSearchType, SearchMaxCount)

 

=== Arguments ===

ResourceName: is a string. It is a name of resource which user want to look up.

ResourceType: It is a value of Resource type's constant. Or can be used name of [[CGS_Constants_list|Resource Type]] constant.

RsourceTemplateResourceID: is a number. It is the resource id of resource template ID. This value can be set 0 if don't care which template to search for.

NameSearchType: It is a value of Name Search type's constant. Or can be used a name of [[CGS_Constants_list|Name Search Type]] constant.

SearchMaxCount: is a number. 

=== Return type ===

An Array, which contain the information of resource was found. 

=== Examples ===

string RName = "phong";

number RType = Resource_Type_Report;

number RTempRID = 0;

number NSType = 1;

Number SMcount= 1;

array Result = Resource_searchByName(RName, RType, RTempRID, NSType);

print(Result);

//{{10,37257205,Phong report 2,12,37246022,34409964},{10,37257212,Phong report 1,12,37246022,34409964},{10,37272405,phong report 3,12,37246022,34409964},{10,37272427,Phong report 4,12,37246022,34409964},{10,37272501,phong,12,37272491,34409964}} __NOTOC__

[[Category:Resource_Functions]]

Resource searchByName

2011-11-17T09:48:37Z

Nguyentanphong: /* Arguments */

= Resource_searchByName =

Search a resource by name.

 

=== Syntax ===

Resource_searchByName(ResourceName, ResourceType, ResourceTemplateResourceID, NameSearchType, SearchMaxCount)

 

=== Arguments ===

ResourceID: is a number. It is the resource id of resource.

ResourceName: is a string. It is a name of resource which user want to look up.

ResourceType: It is a value of Resource type's constant. Or can be used name of [[CGS_Constants_list|Resource Type]] constant.

RsourceTemplateResourceID: is a number. It is the resource id of resource template ID. This value can be set 0 if don't care which template to search for.

NameSearchType: It is a value of Name Search type's constant. Or can be used a name of [[CGS_Constants_list|Name Search Type]] constant.

SearchMaxCount: is a number. 

=== Return type ===

An Array, which contain the information of resource was found. 

=== Examples ===

string RName = "phong";

number RType = Resource_Type_Report;

number RTempRID = 0;

number NSType = 1;

Number SMcount= 1;

array Result = Resource_searchByName(RName, RType, RTempRID, NSType);

print(Result);

//{{10,37257205,Phong report 2,12,37246022,34409964},{10,37257212,Phong report 1,12,37246022,34409964},{10,37272405,phong report 3,12,37246022,34409964},{10,37272427,Phong report 4,12,37246022,34409964},{10,37272501,phong,12,37272491,34409964}} __NOTOC__

[[Category:Resource_Functions]]

Resource searchByName

2011-11-17T09:46:01Z

Nguyentanphong:

= Resource_searchByName =

Search a resource by name.

 

=== Syntax ===

Resource_searchByName(ResourceName, ResourceType, ResourceTemplateResourceID, NameSearchType, SearchMaxCount)

 

=== Arguments ===

ResourceID: is a number. It is the resource id of resource.

ResourceName: is a string. It is a name of resource which user want to look up.

ResourceType: It is a value of Resource type's constant. Or can be used name of [[CGS_Constants_list|Resource Type]].

RsourceTemplateResourceID: is a number. It is the resource id of resource template ID. This value can be set 0 if don't care which template to search for.

NameSearchType: It is a value of Name Search type's constant. Or can be used a name of [[CGS_Constants_list|Name Search Type]] constant 

=== Return type ===

An Array, which contain the information of resource was found. 

=== Examples ===

string RName = "phong";

number RType = Resource_Type_Report;

number RTempRID = 0;

number NSType = 1;

Number SMcount= 1;

array Result = Resource_searchByName(RName, RType, RTempRID, NSType);

print(Result);

//{{10,37257205,Phong report 2,12,37246022,34409964},{10,37257212,Phong report 1,12,37246022,34409964},{10,37272405,phong report 3,12,37246022,34409964},{10,37272427,Phong report 4,12,37246022,34409964},{10,37272501,phong,12,37272491,34409964}} __NOTOC__

[[Category:Resource_Functions]]

Resource searchByName

2011-11-17T09:39:40Z

Nguyentanphong: /* Arguments */

= Resource_searchByName =

Search a resource by name.

 

=== Syntax ===

Resource_searchByName(ResourceName, ResourceType, ResourceTemplateResourceID, NameSearchType, SearchMaxCount)

 

=== Arguments ===

ResourceID: is a number. It is the resource id of resource.

ResourceName: is a string. It is a name of resource which user want to look up.

ResourceType: It is a value of Resource type's constant. Or can be used name of [[Resource Type|CGS_Constants_list]].

RsourceTemplateResourceID: is a number. It is the resource id of resource template ID. This value can be set 0 if don't care which template to search for.

NameSearchType: It is a value of Name Search type's constant. Or can be used a name of [[Name Search Type|CGS_Constants_list]] constant 

=== Return type ===[["Name Search Type"]]

An Array, which contain the information of resource was found. 

=== Examples ===

string RName = "phong";

number RType = Resource_Type_Report;

number RTempRID = 0;

number NSType = 1;

Number SMcount= 1;

array Result = Resource_searchByName(RName, RType, RTempRID, NSType);

print(Result);

//{{10,37257205,Phong report 2,12,37246022,34409964},{10,37257212,Phong report 1,12,37246022,34409964},{10,37272405,phong report 3,12,37246022,34409964},{10,37272427,Phong report 4,12,37246022,34409964},{10,37272501,phong,12,37272491,34409964}} __NOTOC__

[[Category:Resource_Functions]]

Resource searchByName

2011-11-17T09:38:31Z

Nguyentanphong:

= Resource_searchByName =

Search a resource by name.

 

=== Syntax ===

Resource_searchByName(ResourceName, ResourceType, ResourceTemplateResourceID, NameSearchType, SearchMaxCount)

 

=== Arguments ===

ResourceID: is a number. It is the resource id of resource.
ResourceName: is a string. It is a name of resource which user want to look up.
ResourceType: It is a value of Resource type's constant. Or can be used name of [[Resource Type|CGS_Constants_list]].
ResourceTemplateResourceID: is a number. It is the resource id of resource template ID. This value can be set 0 if don't care which template to search for.
NameSearchType: It is a value of Name Search type's constant. Or can be used a name of [[Name Search Type|CGS_Constants_list]] constant 

=== Return type ===[["Name Search Type"|"Name Search Type"]]

An Array, which contain the information of resource was found. 

=== Examples ===

string RName = "phong";

number RType = Resource_Type_Report;

number RTempRID = 0;

number NSType = 1;

Number SMcount= 1;

array Result = Resource_searchByName(RName, RType, RTempRID, NSType);

print(Result);

//{{10,37257205,Phong report 2,12,37246022,34409964},{10,37257212,Phong report 1,12,37246022,34409964},{10,37272405,phong report 3,12,37246022,34409964},{10,37272427,Phong report 4,12,37246022,34409964},{10,37272501,phong,12,37272491,34409964}} __NOTOC__

[[Category:Resource_Functions]]

Resource searchByName

2011-11-17T09:34:39Z

Nguyentanphong:

= Resource_searchByName =

Search a resource by name.

 

=== Syntax ===

Resource_searchByName(ResourceName, ResourceType, ResourceTemplateResourceID, NameSearchType, SearchMaxCount)

 

=== Arguments ===

ResourceID: is a number. It is the resource id of resource. ResourceName: is a string. It is a name of resource which user want to look up. ResourceType: It is a value of Resource type's constant. Or can be used a Name of "Resource Type" constant [[Resource Type|CGS_Constants_list]]. ResourceTemplateResourceID: is a number. It is the resource id of resource template ID. This value can be set 0 if don't care which template to search for. NameSearchType: It is a value of Name Search type's constant. Or can be used a name of "Name Search Type" constant [[Name Search Type|CGS_Constants_list]].. 

=== Return type ===

An Array, which contain the information of resource was found. 

=== Examples ===

string RName = "phong";

number RType = Resource_Type_Report;

number RTempRID = 0;

number NSType = 1;

Number SMcount= 1;

array Result = Resource_searchByName(RName, RType, RTempRID, NSType);

print(Result);

//{{10,37257205,Phong report 2,12,37246022,34409964},{10,37257212,Phong report 1,12,37246022,34409964},{10,37272405,phong report 3,12,37246022,34409964},{10,37272427,Phong report 4,12,37246022,34409964},{10,37272501,phong,12,37272491,34409964}} __NOTOC__

[[Category:Resource_Functions]]

Resource searchByName

2011-11-17T09:32:52Z

Nguyentanphong: Created page with "= Resource_searchByName = Search a resource by name. === Syntax === Resource_searchByName(ResourceName, ResourceType, ResourceTemplateResourceID, NameSearchType, Sear..."

= Resource_searchByName =

Search a resource by name.

 

=== Syntax ===

Resource_searchByName(ResourceName, ResourceType, ResourceTemplateResourceID, NameSearchType, SearchMaxCount)

 

=== Arguments ===

ResourceID: is a number. It is the resource id of resource. ResourceName: is a string. It is a name of resource which user want to look up. ResourceType: It is a value of Resource type's constant. Or can be used a Name of "Resource Type" constant [[Resource Type|CGS_Constants_list]]. ResourceTemplateResourceID: is a number. It is the resource id of resource template ID. This value can be set 0 if don't care which template to search for. NameSearchType: It is a value of Name Search type's constant. Or can be used a name of "Name Search Type" constant [[Name Search Type|CGS_Constants_list]].. 

=== Return type ===

An Array, which contain the information of resource was found. 

=== Examples ===

string RName = "phong"; number RType = Resource_Type_Report; number RTempRID = 0; number NSType = 1; Number SMcount= 1;

array Result = Resource_searchByName(RName, RType, RTempRID, NSType); print(Result);

//{{10,37257205,Phong report 2,12,37246022,34409964},{10,37257212,Phong report 1,12,37246022,34409964},{10,37272405,phong report 3,12,37246022,34409964},{10,37272427,Phong report 4,12,37246022,34409964},{10,37272501,phong,12,37272491,34409964}} __NOTOC__

[[Category:Resource_Functions]]

DCS newQuestionnaireQuickSetup

2011-11-16T07:47:08Z

Nguyentanphong:

= DCS_newQuestionnaireQuickSetup =

Quick create a DCS base on questionnaires and they must have the same questionnaire template.

=== Syntax ===

DCS_newQuestionnaireQuickSetup(DCSName, Questionnaires)

=== Arguments ===

DCSName: is a string. This is name of new DCS.

Questionnaires: is an array which contain questionnaire resource id.

=== Return type ===

Empty

=== Example ===

string DCSName= "dcs of questionnaire 1 and questionnaire 2";

array Qlist={37246024, 37278197};

DCS_newQuestionnaireQuickSetup(DCSName, Qlist);

 __NOTOC__

[[Category:Data_cache_specification_module]]

DCS newQuestionnaireQuickSetup

2011-11-16T07:42:50Z

Nguyentanphong:

= DCS_newQuestionnaireQuickSetup =

Create a DCS base on relative questionnaires and they must have the same questionnaire template.

=== Syntax ===

DCS_newQuestionnaireQuickSetup(DCSName, Questionnaires)

=== Arguments ===

DCSName: is a string. This is name of new DCS.

Questionnaires: is an array which contain questionnaire resource id.

=== Return type ===

Empty

=== Example ===

string DCSName= "dcs of questionnaire 1 and questionnaire 2";

array Qlist={37246024, 37278197};

DCS_newQuestionnaireQuickSetup(DCSName, Qlist);

 __NOTOC__

[[Category:Data_cache_specification_module]]

DCS newQuestionnaireQuickSetup

2011-11-16T07:41:47Z

Nguyentanphong:

= DCS_newQuestionnaireQuickSetup =

Create a DCS base on relative questionnaires and they must have the same questionnaire template.

=== Syntax ===

DCS_newQuestionnaireQuickSetup(DCSName, Questionnaires)

=== Arguments ===

DCSName: is a string. This is name of new DCS.

Questionnaires: is an array which contain questionnaire resource id.

=== Return type ===

Empty

=== Example ===

string DCSName= "dcs of questionnaire 1 and questionnaire 2";

array Qlist={37246024, 37278197}; DCS_newQuestionnaireQuickSetup(DCSName, Qlist);

 __NOTOC__

[[Category:Data_cache_specification_module]]

DCS newQuestionnaireQuickSetup

2011-11-16T07:39:52Z

Nguyentanphong: Created page with "Category:Data cache specification module = DCS_newQuestionnaireQuickSetup = Create a DCS base on relative questionnaires and they must have the same questionnaire template..."

[[Category:Data cache specification module]]

= DCS_newQuestionnaireQuickSetup =

Create a DCS base on relative questionnaires and they must have the same questionnaire template.

=== Syntax ===

DCS_newQuestionnaireQuickSetup(DCSName, Questionnaires)

=== Arguments ===

DCSName: is a string. This is name of new DCS.
Questionnaires: is an array which contain questionnaire resource id.

=== Return type ===

Empty

=== Example ===

string DCSName= "dcs of questionnaire 1 and questionnaire 2";
array Qlist={37246024, 37278197};
DCS_newQuestionnaireQuickSetup(DCSName, Qlist);

__NOTOC__

Resource addJournal

2011-11-14T04:32:31Z

Nguyentanphong:

= Resource_addJournal =

Add a journal information to a specific resource.

 

=== Syntax ===

Resource_addJournal(Object)

 

=== Arguments ===

Object: is a [[ResourceJournalEntry class|ResourceJournalEntry objects]].

 

=== Return type ===

Empty.

 

=== Examples ===

<source lang="javascript">
string commentType="UndoComplete"; // Type of journal

string content="test Undo complete"; // Content of journal

number QRID=37246024; // Resource ID of "phong questionnaire 1"

ResourceJournalEntry Rjt = new ResourceJournalEntry(QRID, commentType, content);

Resource_addJournal(Rjt);</source>

__NOTOC__

[[Category:Resource_Functions]]