Catglobe Wiki - User contributions [en]

MediaWiki:Public read whitelist

2014-05-07T08:43:19Z

Wikicatglobe:

Special:OpenIDLogin
Special:OpenIDFinish
Questionnaire_-_Javascript_Fun_Tips
Showing_Answer_Option_in_tab
Rotate_answer_options/sub_questions
Randomize_answer_options/sub_questions
Drag_and_drop_answer_option_values
Change_Impsys_mages
Add_an_extra_row_before_a_sub_question_in_a_grid
Hide_sub_question_text_column_in_a_grid_question
Show_a_text_grid_and_a_single_question_in_the_same_page
Change_stylesheet_of_an_answer_option_column_in_a_single_grid_question
Add_an_extra_column_before_an_answer_option_column_in_single_grid_question
Both_horizontal_and_vertical_single_grid
Disable_sub_questions_in_text_grids
Number_grid
Close_to_URL
Double_columns_in_text_grids
Count_down_with_invisible_counter
Fold_in/out_texts_in_question_text
Force_email_address
Force_number_of_characters
Change_text_box_size
Set_focus_on_question_text_in_the_top
Maximum_text_length
Next_button_count_down
Mark_answer_option_with_keyboard
Show_flash_movies_on_questionnaire_viewer
Play_a_commercial_and_automatically_go_next_when_it_is_over_in_questionnaire
Show_a_single_question_as_a_dropdown_list_inside_another_text_grid_question
Hide_Next_button_in_n_seconds
Show_datepicker_in_text/text_grid_questions
Show_column_header_in_text_grid_question
Prioritize_sub_questions_in_a_text_grid_question
Align_min/max_texts_in_scale_grid_questions
Add_text_before_answer_option_of_single_question
Show_a_single_question_as_a_dropdown_list_inside_another_text_grid_question
Show_language_selector_page
Reverse_single_grid_between_sub_questions_and_answer_options
Insert_a_TextGrid_question_into_a_SingleGrid_Question
Questionnaire_layout_styling_guideline
Convert_closed_question_TextBox_into_TextArea
Movie_player_element
Show_single_questions_as_dropdown_lists_in_their_own_pages
Script_for_making_a_text_grid_numerical_summing_to_a_specific_value
Validate_email_specified_as_an_open_text_of_a_single_question
Show_more_than_one_singe_grid_in_the_same_page
Show_more_than_one_singe_question_in_the_same_page
Category:User_Guidelines
Change_non-multi_option_in_Multi_question_to_Radio_button
Disable_users
Import_tools
File:Email_validation.zip
AutoSum_numerical_text_grid
Make_whole_cell_clickable_in_single_and_multi_grids
Require_only_one_check_for_grid_question
Show_more_than_one_questions_in_the_same_page
Show_open_textbox_in_a_grid_question
Special:UserLogout&returnto=Main_Page
Main_Page

MediaWiki:Public read whitelist

2014-05-07T07:36:22Z

Wikicatglobe:

Special:OpenIDLogin
Questionnaire_-_Javascript_Fun_Tips
Showing_Answer_Option_in_tab
Rotate_answer_options/sub_questions
Randomize_answer_options/sub_questions
Drag_and_drop_answer_option_values
Change_Impsys_mages
Add_an_extra_row_before_a_sub_question_in_a_grid
Hide_sub_question_text_column_in_a_grid_question
Show_a_text_grid_and_a_single_question_in_the_same_page
Change_stylesheet_of_an_answer_option_column_in_a_single_grid_question
Add_an_extra_column_before_an_answer_option_column_in_single_grid_question
Both_horizontal_and_vertical_single_grid
Disable_sub_questions_in_text_grids
Number_grid
Close_to_URL
Double_columns_in_text_grids
Count_down_with_invisible_counter
Fold_in/out_texts_in_question_text
Force_email_address
Force_number_of_characters
Change_text_box_size
Set_focus_on_question_text_in_the_top
Maximum_text_length
Next_button_count_down
Mark_answer_option_with_keyboard
Show_flash_movies_on_questionnaire_viewer
Play_a_commercial_and_automatically_go_next_when_it_is_over_in_questionnaire
Show_a_single_question_as_a_dropdown_list_inside_another_text_grid_question
Hide_Next_button_in_n_seconds
Show_datepicker_in_text/text_grid_questions
Show_column_header_in_text_grid_question
Prioritize_sub_questions_in_a_text_grid_question
Align_min/max_texts_in_scale_grid_questions
Add_text_before_answer_option_of_single_question
Show_a_single_question_as_a_dropdown_list_inside_another_text_grid_question
Show_language_selector_page
Reverse_single_grid_between_sub_questions_and_answer_options
Insert_a_TextGrid_question_into_a_SingleGrid_Question
Questionnaire_layout_styling_guideline
Convert_closed_question_TextBox_into_TextArea
Movie_player_element
Show_single_questions_as_dropdown_lists_in_their_own_pages
Script_for_making_a_text_grid_numerical_summing_to_a_specific_value
Validate_email_specified_as_an_open_text_of_a_single_question
Show_more_than_one_singe_grid_in_the_same_page
Show_more_than_one_singe_question_in_the_same_page
Category:User_Guidelines
Change_non-multi_option_in_Multi_question_to_Radio_button
Disable_users
Import_tools
File:Email_validation.zip
AutoSum_numerical_text_grid
Make_whole_cell_clickable_in_single_and_multi_grids
Require_only_one_check_for_grid_question
Show_more_than_one_questions_in_the_same_page
Show_open_textbox_in_a_grid_question
Special:UserLogout&returnto=Main_Page
Main_Page

Category:CGKB

2013-10-23T08:38:02Z

Wikicatglobe:

This is Catglobe Knowledge Base
[[Category:Contents]]

Key: CatTaskWebServerMessageUrl

2013-10-23T04:50:25Z

Wikicatglobe:

[[Category:CatTask keys]]
{{HelpFiles_Deployment}}

==Key: CatTaskWebServerMessageUrl==

===Syntax===

<add key="CatTaskWebServerMessageUrl" value="tcp://[HOST]:[PORT]/[SERVICENAME]"/>

[HOST]: host is the IP address (or DNS name if a local DNS server is available) of the server where the message service is installed.

[PORT]: this is the port number of that the message service uses for communication. Services for different versions will have different port numbers.

[SERVICENAME]: specifies the remoting name of the external service. This setting must be identical to the one in the CatTaskService.exe.config file for the service.

===Purpose===

Remoting url of the messageservice of the cattask service. The key contain host, port and name of the remove service, just like the normal cattask service url

===Example of key===

<add key="CatTaskWebServerMessageUrl" value="tcp://localhost:10001/CatTaskService_54_UnitTest_WebHostChannel.rem"/>

__NOTOC__

Key: CatTaskServiceUrl

2013-10-23T04:50:05Z

Wikicatglobe:

[[Category:CatTask keys]]
{{HelpFiles_Deployment}}

==Key: CatTaskServiceUrl==

===Syntax===

<add key="CatTaskServiceUrl" value="tcp://[HOST]:[PORT]/[SERVICENAME]"/>

[HOST]: host is the IP address (or DNS name if a local DNS server is available) of the server where the CatTask service is installed.

[PORT]: this is the port number of that CatTask uses for communication. Services for different versions will have different port numbers.

[SERVICENAME]: specifies the remoting name of the external service. This setting must be identical to the one in the CatTaskService.exe.config file for the service.

===Purpose===

CatTaskServiceUrl describes the location of the CatTask service on the network. The key consists of three parts that must be specified to be able to make a connection to the service.

[HOST], [PORT], and [SERVICENAME]

This key is required.

===Example of key===

<add key="CatTaskServiceUrl" value="tcp://localhost:8085/CatTaskService.rem" />

...
__NOTOC__

Key: DefaultCountryCodeForImportedUsers

2013-10-23T04:49:48Z

Wikicatglobe:

[[Category:Import/Export_keys]]
{{HelpFiles_Deployment}}

==Key: DefaultCountryCodeForImportedUsers==

===Syntax===

<add key="DefaultCountryCodeForImportedUsers" value="[CODE]"/>

[CODE]: Value found in the "Country_Code" column on the "Country" table of the Catglobe database.

===Purpose===

Default country code for imported users. Valid values are all available codes stored in the Country table. If importing users that do not have a country code defined in the imported material, then they will be given this country code instead.

===Example of key===

<add key="DefaultCountryCodeForImportedUsers" value="dk"/>

...
__NOTOC__

What to test

2013-10-18T10:38:02Z

Wikicatglobe:

<accesscontrol>Main:MyGroup</accesscontrol>
= What to test =

== GUI ==

*Navigator
*LnF
*Text resource
*Language
*Culture
*Timezone

== Navigation access ==

*Navigator
*NAV is set
*NAV is not set

== Resource access ==

*Administor account
*System account
*Administrator role
*Manager role
*Observer role
*No role
*Inherite access

== Function test ==

*Main function specified in FD
*Using basic technique to generate test data:

- Equivalence partitioning: http://en.wikipedia.org/wiki/Equivalence_partitioning

- Boundary-value analysis: http://en.wikipedia.org/wiki/Boundary-value_analysis

== Validation test ==

*Valid value
*Invalid value
*Overload value

== Performance test ==

[[Category: Test case guidelines]]

Test case approval

2013-10-18T10:37:34Z

Wikicatglobe:

<accesscontrol>Main:MyGroup</accesscontrol>
== How to get testcases approved ==

There are some steps that need to be followed to get your test cases approved:

=== Get a list of what to be tested ===

#'''Input:'''Feature Design
#'''Output:''' a list of  testable scenarios in order.

*In this phase, it's important that the FD as well as the related modules are understood clearly so that all the scenarios are listed. Every unclear scenarios should be discussed together with development team, including Tester, QA, BA and PM.
*Spreadsheet should be used to specify the list.
*Scenarios should be grouped and sorted (see ''''''[[What to test]]'''''')
*Scenarios' priority should be specified.

=== Specify which test can be automation-tested ===

#'''Input:''' list of scenarios in order
#'''Output:''' 2 lists of scenarios: a list for manual test and a list for automation test

*In this phase, it is important that tester and dev work well together to specify which case can be implemented automation test and which one should be tested manually.
*Test data should be provided in details for those cases which will be added to automation test. They must at least fulfill these criteria:
**100% equivalence partitionning values.
**100% boundary values.
**xx% statement coverage.
*Together with QA, get it approved.

=== Input more information to the test to fulfill the testcase template. ===

#'''Input:'''a list of testable scenarios which are approved.
#'''Output:''' a list of test cases in correct template and with detail information.

*Base on ''''[[General guidelines]]'''' section, write test cases for those scenarios in correct template and with detail information. 
*Together with QA, get it approved.

=== Create test cases in our System. ===

#'''Input:''' a list of test cases having detail information.
#'''Output:''' test cases are created in vnsurvey with all required information.

*In vnsurvey, create test cases in the same order with the list.
*Specify required information.
*For those test cases that are supposed to test automatically, specify the Unittest-related information.
*Send the test cases number to the Unittest development team.
*Together with QA, get its final approval. 

[[Category:Test case guidelines]]

General guidelines

2013-10-18T10:37:20Z

Wikicatglobe:

<accesscontrol>Main:MyGroup</accesscontrol>
== How to write test case ==

=== Details required before writing test cases ===

*Read Specification and Requirements carefully
*Be clear with the design ad the implementation details
*Analyze and Identify all possible scenarios
*Identify the test enviroments and test types
*Should have detailed information related and affected areas of the requirement
*Should be clear of behavior under failure condition (invalid input, boundary values, ect.)

=== Qualities of a Good Test Case ===

*Easy to determine the result

    Tests are viewed one after the other in quick succession, usually in groups of serveral hundred to a thousand. As such, it is important that the results be easy to interpret.

*Quick to determine the result

    The tests should need no more than a fiew seconds to convey their results to the tester.

*Self explanatory

    The tests should not need an understanding of the specification to be used.

*Short

    Tests should be very short (a paragrapt or so) and certainly not require scrolling on even the most modest of screens, unless the test is specifically for scrolling or paginating behaviour.

*Valid

    Unless specifically testing error-recovery features, the tests should all be valid

*Cross-platform

    Test should be a cross-platform as reasonably possible, working across different devices, screen resolutions, paper sizes, etc. Exceptions should be document their assumption

Note: Properly written test cases help both testers as well as developers while execution and debugging.

=== Improving Testability (Easy to Test) - Language ===

*Use Action case say Do This, Do That
*System Display this, Do That
*Simple Conversational Language
*Exact, consistent names of fields, not generic
*Don't explain windows basics
*10-15 steps or less. In case of integration test cases try to provide references instead of explaining te functionality again and again.
*Always update your test case with the new build
*Follow Naming Convention - Naming Convention helps to differentiate between function, control, dbname, etc. It helps in easy identification of different controls, functions, Labels, hyperlink, etc.

=== Naming Conventions ===

*Module names should be in Capitals and Bold
*Screen names should be in bold and have camel notations i.e., the first word in capital letters and rest all in small letters.
*All the objects like textbox, listbox, checkbox, radio buttons, etc. should be in italics and bold.
*The link names should be mentioned in italics, bold and underline below the word e.g.,'Sign Out' link should be mentioned as ''''''Sign Out''''''
*Database table name should be in caps e.g., Emp_Details table name should be EMP_DETAILS.

=== Test case Attributes ===

''Look at'' [[Bug's settings]]

=== General Guidelines ===

*Write test cases before implementation of requirement.
*Test cases are written for all the requirements. Test case should map to current requirement and should not be an enhancement to the application.
*Follow a standard template for all test cases.
*User very simple English and general words.
*Format followed (Aglignment, Naming convention, etc.) by test cases should be uniform for the entire application.
*All the scenario/Test case should be easily understandable, clear and to the point.
*Highlight important points by making text bold or assigning it a color or writing it in different font.
*You may add sections to a group of test cases to make it more informative.
*You may use double quotes for a paricular display text.
*Maintain the test cases in a flow so that execution order is maintained and time is saved.
*You bullet points for different steps.
*Specify Test case type and priority which would help in determining whether to run the test case in specific scenario or not.
*the prerequisite for the scenario/test case should be mentioned before the test case.
*Use a mix of both 'Positive and Negative' tests.
*Provide test data (if possible)
*Write in details SQL Queries (it will be save time while executing)
*Add reference to bugs or requirement as per your needs.
*Add some notes in case you want to convey adtional information or explain the test case with example in case the scenario is not much clear.
*You can use build number next to your results to keep track of results or determining defect density

Note: Test case should be such that any person going to execute it or read it gets a clear picture of what needs to be done without needing any explanations.

[[Category:Test_case_guidelines]]

Test case template

2013-10-18T10:37:00Z

Wikicatglobe:

<accesscontrol>Main:MyGroup</accesscontrol>
{| style="width: 498px; height: 103px" border="1" cellspacing="1" cellpadding="1" width="498"
|-
| Short description
| colspan="2" | <project_code> - <short_description>
|-
| Project code
| colspan="2" | <project_code>
|-
| style="text-align: center" | Pre-condition
| style="text-align: center" | Action
| style="text-align: center" | Post-condition
|-
| style="text-align: center" | <Current status>
| style="text-align: center" | <What to do>
| style="text-align: center" | <Expected result>
|}

[[Category: Test case guidelines]]

Resource access and NAV access LnF

2013-10-18T10:16:53Z

Wikicatglobe:

<accesscontrol>Main:MyGroup</accesscontrol>
Resource access and NAV access LnF
#If logged in user doesn't have enough navigation access to use a module/control, then this module/control should be hidden.
#If logged in user doesn't have Administrator access to a resource then Access tab in CRD of this resource will be hidden
#If logged in user only has Observer access to a resource then Save buttons in CRD of this resource will be hidden, and all controls which would allow the user to change the resource using the CRD must be disabled.
#If logged in user selects one resource in resource list or open CRD of this resource, then: the buttons in menu bar/tool bar, or controls in CRD which required higher resource access than user has, will:be disabled, or show error msg when using

[[Category:LnF_guidelines]]

Lists LnF

2013-10-18T10:16:39Z

Wikicatglobe:

<accesscontrol>Main:MyGroup</accesscontrol>
'''Lists LnF'''

#Whenever possible / applicable, lists should support multiple row highlight!
#When multiple records are highlighted in a list, only the buttons that support this are enabled!
#If no record is highlighted then disable icon buttons that require a record highlighted [[Image:List-1.png]]
#Disabled icon buttons are shown in grayscale color (disabled image).
#All lists should be Ajax-enabled. Only where speed will suffer markedly will we still approve refresh.
#Scroll bars should be inside lists not outside!
#Column widths of lists should be changeable (by drag and move) whenever possible in the GUI. If list uses fixed with for whole list it should not be changeable width.
#Whenever possible make it possible to update information directly in lists. Where the lists have no save button make the updates directly when releasing a record.
#In lists you should middle-align columns with checkboxes and dates, right-align numbers and left-align all other column types.
#Lists should have a pager, that can be expected, as default, to have 30, 60 or 100 rows per page ( if possible, should be 100 rows).
#Lists should use the style sheet for this. The style sheet sets colors for rows and alternate rows. It also sets a color for highlighted rows.
#If a row is removed or added the alternate color scheme should still be intact throughout the list.

[[Category:LnF_guidelines]]

Graphics LnF

2013-10-18T10:16:11Z

Wikicatglobe:

<accesscontrol>Main:MyGroup</accesscontrol>
'''Graphics LnF'''

#Graphics must always look good no matter where it is placed.
#All menus using dropdown should use 16x16 pixel icons. These icons will not use effect on mouse over.

[[Category:LnF_guidelines]]

Check boxes LnF

2013-10-18T10:15:32Z

Wikicatglobe:

<accesscontrol>Main:MyGroup</accesscontrol>
'''Check boxes LnF'''

#In a column, if all rows only have check boxes, then should be middle align. But if there are check boxes and text boxes (can input text, number...) then should be left align.  [[Image:Check boxes-1.jpg]]

[[Category:LnF_guidelines]]

Text boxes and field label LnF

2013-10-18T10:14:59Z

Wikicatglobe:

<accesscontrol>Main:MyGroup</accesscontrol>
'''Text boxes and field label LnF'''

#If a text is too long for a text box / label then the text continues and the user will be able to see this text by moving the cursor in the text box / label. It should never change size due to content.
#Label must be on the right side of check box.
#Any field that is just for display of info and cannot be edited should be shown in disabled mode (either gray background or gray font text).
#Second letter should be small for labels and dialog headers for all English, Danish and Vietnamese text resources. E.g. it is called "User name" and not "User Name".
#Field labels in other languages may be longer than the original meaning you should consider that the label will still look good if label is longer text string.
#Make sure there is always space in between fields, boxes and window edges. Text that ends very close to where a another entry box starts also does not look good.
#All fields must use general style-sheet that specifies width, color, etc. 

[[Category:LnF_guidelines]]

Dialog LnF

2013-10-18T09:59:52Z

Wikicatglobe:

<accesscontrol>Main:MyGroup</accesscontrol>
'''Dialog LnF'''

#Dialogues should have good describing titles, where possible individualized like "Navigational access for [Ressource type ]:[ ressourcename]".
#Dialogues must never open inside another dialogue. This also includes dialogues that post back to other dialogues!
#Dialogues that are meant to post back to another dialogue should always be opened in modal view.
#Modal dialogues should not have Minimize feature.
#Dialogues should by default never open in maximized state. There should always be space to see that the dialogue is opened on top of another window.
#Dialogues should always have default size that fits their content, and the content must be resized to fit the dialog when dialog is resized. Make sure the windows are always adequately large to show max number of error messages possible!
#The default dialog size (mostly height) is never bigger than one of its container page which could cause uncomfortable to user. You must adjust its size to fit in its container page. [[Image:Dialog-1.png]]
#If a dialogue does not have a reason to have the Restore Down / Maximize button then it should not appear on dialogue. This concerns all dialogues which are exactly fit to its contents and where it will never be necessary to expand to view all the information. (notice that dialogues that have e.g. date control or other controls that can require space we may need to have dialogue expandable).
#You rarely want to open dialogues with a size that is based on the users screen resolution. Rather you want to base it on the content of your dialogue. Exceptions are when the dialogues will not fit in a 1024 by 768 dialogue.
#If logged-in user only has observer access to current resource, then when he open the resource, all the controls in dialog should be disabled (or just not editable) and there's no button Save 
#The buttons on search dialogues should be 'Search' and 'Cancel'. Please notice examples below of correct and incorrect way    [[Image:General-13-1.png]]  [[Image:General-13-2.png]] 
#If a dialog have only main action Save, it should have 2 buttons: "Save" and "Close"; or "Save and close" and "Cancel"
[[Image:Save_Close.png]][[Image:SaveClose_and_Cancel.png]]

[[Category:LnF_guidelines]]

Error messages LnF

2013-10-18T09:59:43Z

Wikicatglobe:

<accesscontrol>Main:MyGroup</accesscontrol>
'''Error messages LnF'''

#Error messages should always explain exactly what the user did wrong. If user cannot immediately understand what the message means; it is a bug!
#If the same error message is used for two different bugs - it is a bug!
#Errors should appear in the top of dialogues / windows in red color in bullet format. All the errors that are registered should be listed.
#The title of dialog must be "Error" if the message lets users know that they can NOT do that action. And "Warning" if still allowing users to continue that action.
#The GUI should not refresh before showing the errors (if possible) 

[[Category:LnF_guidelines]]

Text resource LnF

2013-10-18T09:59:32Z

Wikicatglobe:

<accesscontrol>Main:MyGroup</accesscontrol>
'''Text resource LnF'''

One of the most important elements of usability is the way that we write texts that appear in the application. The following is a guideline that guides the way that we expect you to make these in Catglobe.

#If a text resource in the interface does not have English, Danish and Vietnamese translations; it is a bug!
#If any text in GUI is hard-coded; it is a bug!
#All dialogues should have informative titles!
#If any Danish or English text resource has not been corrected and approved by a Process responsible; it is still seen as a bug!
#Any text that can be partially or fully hidden in the GUI must be shown fully on mouse over: show tool tip or; resize that field (if allow)
#Never use exclamation marks (!).
#QAS/RPQ are disallowed abbreviations. Please call it ”Answer sheet” (in DK ”Svarark”).
#DCS is a disallowed abbreviation. Please call it ”Data cache” (in DK ”Data cache”).
#When presenting a confirmation message it should in English be formatted as: ”Are you sure you want to [requestet action]?”. If the action that the user is doing is not easily described in one sentence the format may be: "You have chosen to [long version requestet action]. Are you sure you want to [requestet action]?". In Danish the short version is: ”Er du sikker på du vil [requestet action]?” . And it should used with buttons "Yes", "No", "Cancel"
<div style='text-align: center;'>[[Image:Confirm msg.png]]</div>

'''Menus: UI Text Guidelines'''

#A menu is a list of commands available to the user in the current context.
#Only capitalize the first letter of the menu name and menu command. Do not capitalize secondary words as is done in Microsoft.
#Include an ellipsis (...) at the end of a menu command that opens another dialog box rather than immediately performing an action. The ellipsis is a visual cue that the user must supply additional information to complete the command.
#Use verbs or noun phrases to label menu commands that represent actions.
#If the menu name is a verb, use a noun or noun phrase for the menu command. For example, if the menu name is Insert, the menu commands can be Text, Table, Picture, and so on.
#If the menu name is a noun, use a verb or verb phrase for the menu command. For example, if the menu name is Table, the menu commands can be Insert Table, Select Row, Insert Column, and so on.
#To describe removing a check mark from a menu command that toggles on and off, use click to remove the check mark. Don't use clear.
#Use click to refer to choosing commands.
#When referring to a menu or menu command, don't capitalize the descriptor (the word menu or command).

[[Category:LnF_guidelines]]

MyPortal Development guide

2013-10-18T07:57:49Z

Wikicatglobe:

<accesscontrol>Main:MyGroup</accesscontrol>
[[Category:Personalization]]

== Introduction ==

The My Portal page is your own personalized view of what goes on in the Catglobe system that is interesting to you.

More information about My Portal is available [[My_portal|here]].

== How to make user defined elements ==

A user defined element as its name is the one you can put anything you want.

[[Image:MyPortal - User-defined.jpg]]  

An element contains 2 features:

*HTML content: input inside Detailed decsription tab's HTML editor. It is required to show the element in MyPortal page (empty content will end up in not displaying anything)
*Javascript: input inside Detailed description tab's script mode. It is used to manipulate the way the element will act, it can connect to registered web services or change the HTML content dynamically. jQuery is also supported, which makes it even more powerful.

== Script - Supported features ==

=== Events ===

*''onload'': called after loading the element
*''onadd'': called once after adding the element to MyPortal page (Insert)
*''onminimize'': called when minimizing the element
*''onmaximize'': called when maximizing the element
*''onremove'': called when the element is removed from MyPortal page
*''onmouseover'': called when mouse is over the element (Currently, this event does not work - CHECK ME)
*''onmouseout'': called when mouse is out of the element (Currently, this event does not work - CHECK ME)

=== Functions ===

*''set_title(titleText)'': change the title of element
*''get_contentDiv()'': get the content of "div" element, used for manipulating the HTML content
*''getManager().updateElementOrdination()'': automatically re-arrange MyPortal page (used when the HTML content is updated dynamically)

=== Sample code ===

<source lang="javascript">
this.onload = function()
{
// use "this" keyword to access the element itself.
alert("onload");
}
this.onadd = function() {
alert("onadd");
}
this.onminimize = function() {
alert("onminimize");
}
this.onmaximize = function() {
alert("onmaximize");
}
this.onremove = function() {
alert("onremove");
}
</source>

== Potential problems ==

It can sometimes be quite problematic when displaying portal elements.Be careful when adding the HTML content, no validation is supported inside the editors.

=== Tips ===

*Flash objects might be placed on top of others. To fix that problem, these parameters should be added into the flash: ''IE: "<param name='wmode' value='transparent' />" FF: 'wmode="transparent" ''' 

== Examples ==

[[Display a questionnaire's answers in real time]]

[[Movie player element]]

Wizard LnF

2013-10-18T07:15:57Z

Wikicatglobe:

<accesscontrol>Main:MyGroup</accesscontrol>
'''Wizard LnF'''

To make wizards look good and be easy to understand across different modules we need to decide on a generic style. This style is specified below with examples.

The name of the dialog should be the general name of the wizard. After the 'Step n of n' text should be the name of the specific step.

The styles should be available for the generic style sheet. These should be set to:

- Top background color: F2F2F2

- 'Step n of n:...' text color: FF8A00

- Middle background: E5E9ED

- Bottom background: D2DEE9

- Line color: 77A2C4

- Please use top, bottom, left, right margin for all content in Top, Middle and Bottom section: 15px

- Try to make the same with layout from designer as much as you can ( if any): distance between elements, width and height of the same controls, font size, color,.. and use CSS for all things.

- If we don't have Top section, please remove them from layout.

- Error message will be above the Middle section and below the Top section, but better is using pop up for Error.

- If you have grid control in the Middle content, please use white background for it, not use the same color with Middle background.

- If you have texts for explaining the control please use color: 999999 and put it below the control (You can see it in the second image below).

- Align Cancel button to the left and right for others.

[[Image:Wizard-1.jpg]]

[[Image:Wizard-2.jpg]]

[[Category:LnF_guidelines]]

Template:Documentation

2013-10-18T07:03:11Z

Wikicatglobe:

<h1>{{FULLPAGENAME}}</h1>
<div style="background-color: #ECFCF4; border: 1px solid #AAAAAA; clear: both; margin: 1em 0 0; padding: 5px;"><div style="padding-bottom: 6px; border-bottom: 1px solid #aaa; font-weight: bold;">
[[File:TemplateDocumentation-Logo.png|50px|alt=|middle]] Template documentation</div>
<div style="padding-top: 15px;">{{{{FULLPAGENAME}}/doc}}</div></div>__NOTOC____NOEDITSECTION__

Bug's settings

2013-10-18T06:55:12Z

Wikicatglobe:

<accesscontrol>Main:MyGroup</accesscontrol>
[[Category:Archive]]
= Settings for Bug template: =

== Properties: ==

=== _Property: Reporter [Resource - ''Required''] ===

[[Image:Reporter.png]]

*'''Objectives:'''

     This parameter stores information about the bug reporters so that we can:        + Contact to them to get more information of the bug report, to ask them for approval after the bug was fixed.        + Add them to the task's Observer list so that they can get informer messages about the status of the bug they have reported.

*'''Value:'''

     Select the person who sent the bug report.

=== _Property: Priority [Single - ''Required''] ===

[[Image:Priority.png]]

*'''Objectives:'''

     This parameter is used to prioritize bugs so that we can know which one is more important to be fixed than others.

*'''Values:'''

'''     Critical:''' choose this option if:                + Important work process cannot be completed or Cattask crasking.

'''     High:''' choose this option if:                + A work process cannot be completed.                   + A bug that makes Cattask fail.                    + Return wrong results.                    + Cause invalid data in the database.                    + Performance issue on important modules.                 + The client want it fixed immediately.

'''     Medium:''' choose this option if:                + A work process doesn't work, but a work-around works.                    + Validation incorrectly limits something that should be allowed.                    + A work process doesn't work in FireFox, but works in other browswers.                    + Text resources wrong/misleading.                    + That LnF guideline are not followed prevents users from finishing a work process properly.                    + Perfomance/speed issue.

'''     Nice to have:''' choose this option if:                 + Validation error that doesn't limit normal work processes.                    + That LnF are not followed doesn't prevent users from finishing a work process properly.                + Text resource doesn't look nice but not misleading.

=== _'''Property:''' RootCause_Project [Single - ''Required''] ===

[[Image:RootCause Project.png]]

*'''Objectives:'''

    This parameter is used to keep information about why the bug occurs. 

    Investigating this parameter's information, we can know how stable we are regarding to the Project Management process. 

*'''Values:'''

'''     From making projects:''' choose this option if the bug is caused from making a new projects.

'''     From fixing other bugs: '''choose this option if the bug is caused from fixing other bugs.

'''     New discoveries (Bugs comming out of nowhere): '''choose this option if the bug is on the system from very early versions.

'''     From changes in FD:''' choose this option if the bug is caused from changes in FD.

'''     From changes in LnF guideline:''' choose this option if the bug is caused from changes in LnF guideline.

'''     From missing features when making new projects: '''choose this option if the bug is caused from missing features when making new projects.

'''     Unknown:''' choose this option if you cannot choose one of the above options.

 

 

=== _Property: TaskStatus [''Single - Required''] ===

[[Image:TaskStatus.png]]

*'''Objectives:'''

     This property is used to keep Task's status infomation. It allows us to create the task before the problem is considered as a bug. In the other words, with this property, we can speed up the interaction with clients by creating the task and reply to them right after receiving bug reports.

*'''Values:'''

'''     Reproducing:''' choose this option if the task is created for the bug report but it is not accepted as a bug yet. Tester/Dev is trying to reproducing the reported problem. '''    '''

'''     Needs more information:''' choose this option if the problem cannot be reproduced with the reported information. It requires more information from reporter. '''    '''

'''     Assigned:''' choose this option if the reported problem can be reproduced and assiged to responsible Dev/Group.

=== _Property: FoundIn_Project [''Resource - Not required''] ===

[[Image:FoundIn Project.png]]

*'''Objectives:'''

     The property simply tell us which project the bug comes from; therefore, presents the project's quality.

*'''Values'''

     Choose the project that the bug comes from.

=== _Property: FoundIn_Stage [''Single - Required''] ===

[[Image:FoundIn Stage.png]]

*'''Objectves:'''

     The property store information about in which stage of the Project Development Life Circle the bug comes from. Since "the cost of fixing faults increases as you move the product towards live use", this property allows us to have an overview of our "cost of fixing bug" and then improving the Testing process.

*'''Values'''

'''     Testing:''' choose this option if the bug is found in testing phase before giving it to QA for approving the testing task. '''    '''

'''     Approving:''' choose this option if the bug is found after the testing task was sent to QA for approval at the first time. '''    '''

'''     Before Deploy:''' choose this option if the bug is found after IAT but before client ever had the chance to find it. '''    '''

'''     Pre-Released:''' choose this option if the bug is found after the project was released to client (PRE PROD). '''    '''

'''     Released:''' choose this option if the bug is found after the project was released to client (used in production site).

*'''Notes'''

'''     The first three options depend on project status while the last two depend on version status'''. For example: If the bug is found only in developing version, its stage will never be "Released" no matter which project it belongs to.

[[Image:SetStage.png]]

=== _Property: FoundBy_User [''Single - Required''] ===

[[Image:FoundBy User.png]]

*'''Objectives:'''

     Similiarly to Approver parameter, this property stores information about the bug reporter. The main idea of having this property is that we can know if the bug is found by the members of development team or other teams. It would be great if all bugs are found by development team in testing stage.

*'''Values    '''

'''     Development Team:''' choose this option if the bug is found by the Team itself, including QA and BA if in the Approval phase.

'''     Other Team:''' choose this option if the bug is found by some other team.

'''     Production:''' choose this option if the bug is found while doing production work (Catinet and Process).

'''     Client/User:''' choose this option if the bug is found by end clients/users/partners.

=== _Property: Version [''Multi – Required'')] ===

[[Image:Version.png]]

*'''Objectives:'''

     The property stores information about how many and which versions the bug occurs so that the Devs and Tester can know in which versions the bugs should be fixed. 

*'''Values:'''

     Select all the versions having the bug.

 '''''New Version setting (applied from Jan 25th, 2010)'''''

*'''Objectives:'''

     In order to support the sub version setup, a new Version property should be created for each version.      The property stores information about how many and which sub-versions the bug occurs so that the Devs and Tester can know in which sub-versions the bugs should be fixed.

*'''Values:'''

     Select all the sub-versions having the bug.

[[Image:58 Version.png]]

 [[Image:60 Version.png]]

=== _Property: Version_unFixed [''Multi – Required''] ===

[[Image:Version unFixed.png]]

*'''Objectives:'''

     This property stores information about which versions the bug hasn't been fixed yet. Using it together with the Version property, we have all information about relationship between bugs and versions.

*'''Values:'''

     Select all the versions having the bug which has not been fixed yet.

 

'''''New Version setting (applied from Jan 25th, 2010)''''' 

*'''Objectives:'''

     In order to support the sub version setup, a new Version property should be created for each version.      This property stores information about which sub-versions the bug hasn't been fixed yet. Using it together with the Version property, we have all information about relationship between bugs and sub-versions.

*'''Values:'''

     Select all the sub-versions having the bug which has not been fixed yet.

[[Image:58 Version unFixed.png]] 

[[Image:60 Version unFixed.png]] 

=== _Property: Known issue [Multi - ''Not Required''] ===

*'''Objectives:'''

    This property is used to categorize issues which will not be fixed in a release due to technical limitation or bad ROI. It should be specified by the TL together with RnD team. Detail reasons should be specified in the resource's journal.

*'''Values:'''

    '''Technical limitation''': choose this option if the issue cannot be fixed by our current technique.

    '''3rd party library's bug''': choose this option if the issue come from 3rd party's problems.

    '''Costly bug''': choose this option if the issue can be fixed but it takes too much time, manpower in comparison to the benefit.

[[Image:Known Issue.png]]

Template:HelpFiles Deployment

2013-10-18T04:56:41Z

Wikicatglobe:

<accesscontrol>Main:MyGroup</accesscontrol>

Template:HelpFiles Deployment

2013-10-18T04:55:41Z

Wikicatglobe: Blanked the page

Create a public page (anonymous access)

2013-10-18T04:54:12Z

Wikicatglobe:

<accesscontrol>Main:MyGroup</accesscontrol>
How public a page in wiki so Every can access without require to log in

1. Go wiki page http://wiki.catglobe.com/index.php/MediaWiki:Whitelist then add a page name to public

Remember Only wiki Administrators group can edit this page

[[category:Wiki guidelines]]

Working with QSL

2013-10-18T04:46:40Z

Wikicatglobe:

<accesscontrol>Main:MyGroup</accesscontrol>
== What is QSL ? ==
QSL stands for Questionnaire Structure Language . We can use this language to specify structure of a questionnaire template including questionnaire's properties , questions and question's properties . Though QSL has not been supported completely questionnaire template ( there are a few features missing ), it is an advance way to work with questionnaire template . Once getting familiar with QSL , user can create a questionnaire template quicker than using the GUI .
== From which version QSL has supported ? ==
QSL started in version 5.4 (VN1197QNR - Import of Questionnaire template) . In 5.5 , we re-defined the grammar of QSL and keep it up to now . An improvement was made in 5.6 so that the engine can catch syntax error and support test resource for error message .
== Before working with QSL ==
QSL is a domain specific language (DSL) . It is always a painful to deal with DSL by our own but everything is easier thank to ANTLR (AnoTher Tool for Language Recognition). This is a language tool that provides a framework for constructing recognizers, compilers, and translators from grammatical descriptions containing actions in a variety of target languages. It is widely used because it's easy to understand, powerful, flexible, generates human-readable output and free . It is recommended that developers read the book "The Definitive Antlr Reference Building Domain-Specific Languages" to have a background before getting into QSL . You also need to install ANTLR Runtime engine and configure environment .

== Processing QSL ==

[[Image:Process_QSL.png]]

All the work we need to do is define the syntax for QSL ( edit file Questionnaire.g) and write a class to parse the abstract structure tree into a Questionnaire object . We use ANTLR Work to edit and debug the syntax of QSL
[[Image:ANTLR_Work.JPG]]

After finished Questionnaire.g , we also use ANTLR Work to generate Java source code for the lexer and parser .

[[Image:GenerateCode.JPG]]

Put QuestionnaireLexer.java and QuestionnaireParser.java into source code folder and compile as normal source file .
The final work we need to handle is parsing the tree structure into Questionnaire object using the API library comes with ANTLR package .

[[Image:ASTTree.JPG]]

== Reference links ==
http://antlr.org/
 http://www.ociweb.com/jnb/jnbJun2008.html

[[Category:Technical_guidelines]]

WebConfig - Requirements guideline

2013-10-18T04:46:31Z

Wikicatglobe:

<accesscontrol>Main:MyGroup</accesscontrol>
There are some requirements you should specify clearly when making a request for the new webconfig keys:

{| cellspacing="1" cellpadding="1" width="1000" align="left" border="2"
|+
== WebConfig Requirements ==

|-
| '''Syntax'''
|
Syntax of that new key

|-
|
'''Description'''

| What is that? What's that used for? (The purpose of the key)
|-
|
'''Type'''

| Type of key's value (Int, UInt, Boolean, String...etc)
|-
|
'''Required'''

| Is that key required or not?
|-
|
'''Default value'''

| The default value for the key, if it is missing. Obviously it makes no sense to have a default, if it is required.
|-
|
'''Recommend value'''

| How should the administrator of the site determine what to set this value to.
|-
|
'''Validation rule'''

|
Describe the validation rule for the key. We will base on these rules to implement the validation method for the

new one. If no any validation rule specified, we will implement the validation base on Type, Required...etc

|-
|
'''Example'''

| Give us an example of the new key plz
|}

[[Category:Technical_guidelines ]]

Using questionnaire editor template behind fire wall

2013-10-18T04:44:37Z

Wikicatglobe:

<accesscontrol>Main:MyGroup</accesscontrol>
== Problem ==
Some client computer using a fire and they can't open questionnaire template editor. Error message can be various, "Can not connect to server" or "Connection time out" ...etc and the editor applet can't load the questionnaire template content.
== Known cases ==
Up to now , client from Coloplast network has faced this problem.
== Solution ==
Make a rule in fire wall so that it let the editor applet (JRE) can income and outcome internet traffic.
Below is a example using Mc Afee Desktop Fire Wall 8.5
[[Image:Imagerq.png]]

[[category:Technical guidelines]]

Styling textbox in Questionnaire

2013-10-18T04:44:27Z

Wikicatglobe:

<accesscontrol>Main:MyGroup</accesscontrol>
Currently we don't have specified class for text box in all question types. Now we only use the parent class contain the text box you want to change and then add "input" or "textarea" after it to make a new class.

Example for Open answer in Single / Multi question:
<source lang = css>
.answer_option_cell input{ height:40px;}
</source>

This way is inconvenient a little bit because if we add this class to questionnaire layout stylesheet, it will take effect on all text boxes using the same class.
So if you want to change style of text box in only that question, you can put new class in the stylesheet section in questionnaire editor or use jQuery.

Here some images for you to see relationship between class and text box so you can add more class to edit it.

===Textgrid===
<source lang = css>
.grid_inner input { height:30px;}
</source>
[[Image:Textgrid.png]]

===Single/Multi open answer===
<source lang = css>
.answer_option_cell input { height:40px;}
</source>
[[Image:Single_openanswer.png]]

===Number or text question===
<source lang = css>
.question_content input { height:30px;}
</source>
[[Image:Number.png]]

===Open questions===
<source lang = css>
.question_outer textarea { height:200px;}
</source>
[[Image:Open.png]]

[[category:Technical guidelines]]

----

ServerMethods' exception handling

2013-10-18T04:44:05Z

Wikicatglobe:

<accesscontrol>Main:MyGroup</accesscontrol>
== Introduction ==

ServerMethods' exception handling for asynchronous server methods has been improved. The improvement will be available from version 5.0 and forward. Should anyone need it for version 4.9, then a merge back to version 4.9 will also be done, but this is only done on request.

In the previous version of ServerMethods there was no easy way of handling exceptions that occurred for asynchronous server methods. If an exception occurred then the message from that exception would be returned to the callback function as a string. So, if your server method already returned a string it would be difficult to see, when the string was an exception and when it was actually the result you wanted.

== The Improvements ==

In order to better handle exceptions for asynchronous server methods we have implemented two new event handlers on the ServerMethods class:

*ServerMethods.onValidationError
*ServerMethods.onCallServerError

And a new property on the ServerMethodException class:

*isException

How to use these new event handlers and properties will be explained in the following sections.

== ServerMethods.onValidationError ==

When a server method is called from the client side, then validation of the arguments passed to the server method is done before actually sending the request to the server side.

If validation of the arguments passed to the server method cannot be validated then ServerMethods.onValidationError is called. A default implementation of this method already exists, and we will show it here as an example of how to implement an event handler for validation errors.

<source lang="javascript">
// On validation error event handler
ServerMethods.onValidationError = function(serverMethod, callerArguments)
{
// Get parameters for the server method
var parameters = serverMethod.getParameters();

// Validate number of parameters
if(parameters.length != callerArguments.length)
{
alert("Server method "+serverMethod.getName()+" received an invalid number of arguments");
return;
}

// Validate types
var messages = "";
for(var i = 0; i < parameters.length; i++)
{
if(!ServerMethods.__validateType(parameters[i].getType(), callerArguments[i]))
{
// Some kind of error showing there is a type mismatch
messages += " - Parameter '"+parameters[i].getName()+
"' expected type '"+parameters[i].getTypeName()+
"' not type '"+ (typeof callerArguments[i])+"'";
}
}

if(0 < messages.length)
{
messages = "Type mismatch(es) in server method "+serverMethod.getName()+":\n"+messages;
alert(messages);
return;
}
}
</source>

The whole page must be loaded before you can change the event handler, so the ServerMethods.onValidationError method could be changed for example when the body fires the onload event. A small example of this is given below:

<source lang="javascript">
<%@ Page language="c#" Inherits="CatGlobe.Web.Common.ServerMethods.ServerMethodsTesting" Codebehind="ServerMethodsTesting.aspx.cs">
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" >
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>ServerMethods example</title>

<script type="text/javascript">
function onPageLoad()
{
// On validation error event handler
ServerMethods.onValidationError = function(serverMethod, callerArguments)
{
alert("Validation error");
}
}
</script>
</head>

<body onload="onPageLoad();">
<form action="ServerMethodsTesting.aspx" runat="server">

</form>
</body>
</html>
</source>

== ServerMethods.onCallServerError ==

When a server method is called synchronous we can use a try-catch block around the call to catch exceptions that might have been thrown on the server, but doing so for an asynchronous server method is not possible because JavaScript is not waiting actively for the server side to respond back to the client side.

Therefore we have changed the way that asynchronous server methods inform the client side about exceptions occurred on the server side. When an exception is thrown on the server it is captured by ServerMethods API and ServerMethods.onCallServerError is called.

The default implementation for ServerMethods.onCallServerError method is shown below:

<source lang="javascript">
// On error event handler
ServerMethods.onCallServerError = function(exception, serverMethod, callerArguments)
{
alert(exception.getMessage());
}
</source>

It is possible to disable the call to this method as shown in the following example; again overriding this method can only be done after the whole page has been loaded:

<source lang="javascript">
<%@ Page language="c#" Inherits="CatGlobe.Web.Common.ServerMethods.ServerMethodsTesting" Codebehind="ServerMethodsTesting.aspx.cs" %>

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" >

<html xmlns="http://www.w3.org/1999/xhtml">

<head>
<title>ServerMethods example</title>

<script type="text/javascript">
function onPageLoad()
{
ServerMethods.onCallServerError = null;
}
</script>
</head>

<body onload="onPageLoad();">
<form action="servermethodstesting.aspx" runat="server">

</form>
</body>
</html>
</source>

When the ServerMethods.onCallServerError is disabled as shown in the example above, then any exception thrown on the server will be send to the client side’s callback function instead. The next section described how it is possible to determine whether the value returned to the callback function is a ServerMethodException or actually the result that was expected.

== ServerMethodException.isException ==

Instead of returning the exception as a string, the exception object ServerMethodException is now passed to the callback function if an exception was caught on the server side. In order to identify that an exception occurred a new property has been added to the ServerMethodException class called isException, so your callback function should look something like this:

<source lang="javascript">
function onMyServerMethodCallback(returnValue)
{
if(returnValue.isException)
{
// Do your error handling here
}

// Do your normal callback handling here
}
</source>

Notice that when exceptions are thrown the callback function is only called if you have disabled the error handler as described in the previous section.

[[Category:Technical guidelines]]

Questionnaire layout styling guideline

2013-10-18T04:43:50Z

Wikicatglobe:

<accesscontrol>Main:MyGroup</accesscontrol>
== Questionnaire layout styling guideline ==

To layout questionnaire, we can edit class or id in Style sheet tag. But remember that one class can be used in more than one question types. For this reason, when you change any class/id, it can affect to other questions which use the same class/id.

Considering aspect of layout structure, we can divide them into 2 groups: NormalQuestionType( Page, Open, Single, Multi, Text, Number, Scale, Multimedia) and GridQuestionType (Single grid, Multi grid, Scale grid, Text grid). Generally, each type of question has 2 main elements: main question texts and it's content (usually is checkbox, radio button, textbox,.. but with GridQuestionType, it can have sub questions inside). Below table shows relationship between class/id and question types.

{| width="0" cellspacing="0" cellpadding="5" border="1"
|-
| align="right" rowspan="2" |  
| bgcolor="#e8e8e8" align="center" colspan="12" | '''Question types'''
| bgcolor="#e2e2e2" align="center" rowspan="2" | '''Insert in tag'''
| bgcolor="#d2d2d2" align="center" rowspan="2" | '''Class/Id function'''
|-
| bgcolor="#f2f2f2" | '''Page'''
| bgcolor="#f2f2f2" | '''Open'''
| bgcolor="#f2f2f2" | '''Single'''
| bgcolor="#f2f2f2" | '''Multi'''
| bgcolor="#f2f2f2" | '''Text'''
| bgcolor="#f2f2f2" | '''Number'''
| bgcolor="#f2f2f2" | '''Scale'''
| bgcolor="#f2f2f2" | '''Multimedia'''
| bgcolor="#f2f2f2" | '''Single grid'''
| bgcolor="#f2f2f2" | '''Multi grid'''
| bgcolor="#f2f2f2" | '''Scale grid'''
| bgcolor="#f2f2f2" | '''Text grid'''
|-
| bgcolor="#ffbf55" colspan="1" | Class
|-
| bgcolor="#f2f2f2" | question_outer
| valign="middle" align="center" |  
| valign="middle" align="center" | x
| valign="middle" align="center" | x
| valign="middle" align="center" | x
| valign="middle" align="center" | x
| valign="middle" align="center" | x
| valign="middle" align="center" | x
| valign="middle" align="center" | x
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" bgcolor="#f2f2f2" align="center" | table
| valign="middle" | the outer table (it wraps question text, and question content), usually uses to make border around the question
|-
| bgcolor="#f2f2f2" | question_content
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" | x
| valign="middle" align="center" | x
| valign="middle" align="center" | x
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" bgcolor="#f2f2f2" align="center" | td
| valign="middle" | the content part
|-
| bgcolor="#f2f2f2" | multimedia_question_content
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" | x
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" bgcolor="#f2f2f2" align="center" | td
| valign="middle" | like question_content but for Multimedia question (usually is movie playback or flash file)
|-
| bgcolor="#f2f2f2" | option_table
| valign="middle" align="center" |  
| valign="middle" align="center" | x
| valign="middle" align="center" | x
| valign="middle" align="center" | x
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" bgcolor="#f2f2f2" align="center" | table
| valign="middle" | use for single/multi question. This class is the same as class "question_content"
|-
| bgcolor="#f2f2f2" | option_link
| valign="middle" align="center" |  
| valign="middle" align="center" | x
| valign="middle" align="center" | x
| valign="middle" align="center" | x
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" bgcolor="#f2f2f2" align="center" | a
| valign="middle" | use for the anchor tag, apply to the texts next to radio button or checkbox of Single/Multi question
|-
| bgcolor="#f2f2f2" | option_row_even
| valign="middle" align="center" |  
| valign="middle" align="center" | x
| valign="middle" align="center" | x
| valign="middle" align="center" | x
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" bgcolor="#f2f2f2" align="center" | tr
| valign="middle" | apply to even row
|-
| bgcolor="#f2f2f2" | option_row_odd
| valign="middle" align="center" |  
| valign="middle" align="center" | x
| valign="middle" align="center" | x
| valign="middle" align="center" | x
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" bgcolor="#f2f2f2" align="center" | tr
| valign="middle" | apply to odd row
|-
| bgcolor="#f2f2f2" | answer_option_cell
| valign="middle" align="center" |  
| valign="middle" align="center" | x
| valign="middle" align="center" | x
| valign="middle" align="center" | x
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" bgcolor="#f2f2f2" align="center" | td
| valign="middle" | he same as "option_row_even"/"option_row_odd" but different when we use more than 2 columns for answer options. We use "option_row_even"/"option_row_odd" in tr tag and "answer_option_cell" in td tag
|-
| bgcolor="#f2f2f2" | grid_outer
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" | x
| valign="middle" align="center" | x
| valign="middle" align="center" | x
| valign="middle" align="center" | x
| valign="middle" bgcolor="#f2f2f2" align="center" | table
| valign="middle" | for the table contains the GridQuestionType. It is the same as "question_outer"
|-
| bgcolor="#f2f2f2" | grid_inner
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" | x
| valign="middle" align="center" | x
| valign="middle" align="center" | x
| valign="middle" align="center" | x
| valign="middle" bgcolor="#f2f2f2" align="center" | table
| valign="middle" | for the table contains the content of GridQuestionType. It is the same as "question_content"
|-
| bgcolor="#f2f2f2" | grid_empty_cell
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" | x
| valign="middle" align="center" | x
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" bgcolor="#f2f2f2" align="center" | td
| valign="middle" | use for the cell that contains nothing in the first row and the first column
|-
| bgcolor="#f2f2f2" | grid_answeroption_text
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" | x
| valign="middle" align="center" | x
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" bgcolor="#f2f2f2" align="center" | td
| valign="middle" | use for the cell contains answer option text
|-
| bgcolor="#f2f2f2" | grid_subquestion_text
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" | x
| valign="middle" align="center" | x
| valign="middle" align="center" | x
| valign="middle" align="center" |  
| valign="middle" bgcolor="#f2f2f2" align="center" | td
| valign="middle" | use for the cell contains sub question text (layout will change rely on order of class "grid_subquestion_text" in comparison with class "grid_subquestion_odd" and "grid_subquestion_even" in css file)
|-
| bgcolor="#f2f2f2" | grid_subquestion_odd
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" | x
| valign="middle" align="center" | x
| valign="middle" align="center" |  
| valign="middle" align="center" | x
| valign="middle" bgcolor="#f2f2f2" align="center" | td
| valign="middle" | use for the cell in the even row
|-
| bgcolor="#f2f2f2" | grid_subquestion_even
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" | x
| valign="middle" align="center" | x
| valign="middle" align="center" |  
| valign="middle" align="center" | x
| valign="middle" bgcolor="#f2f2f2" align="center" | td
| valign="middle" | use for the cell in the odd row
|-
| bgcolor="#ffbf55" colspan="1" | Id
|-
| bgcolor="#f2f2f2" | page_question_text
| valign="middle" align="center" | x
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" bgcolor="#f2f2f2" align="center" | td
| valign="middle" | use for the cell contains question text of Page question
|-
| bgcolor="#f2f2f2" | question_text
| valign="middle" align="center" |  
| valign="middle" align="center" | x
| valign="middle" align="center" | x
| valign="middle" align="center" | x
| valign="middle" align="center" | x
| valign="middle" align="center" | x
| valign="middle" align="center" | x
| valign="middle" align="center" | x
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" bgcolor="#f2f2f2" align="center" | td
| valign="middle" | use main question text
|-
| bgcolor="#f2f2f2" | grid_question_text
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" | x
| valign="middle" align="center" | x
| valign="middle" align="center" | x
| valign="middle" align="center" | x
| valign="middle" bgcolor="#f2f2f2" align="center" | td
| valign="middle" | the same as "question_text", for main question texts of GridQuestionType.
|-
| bgcolor="#f2f2f2" | errorMessages
| valign="middle" align="center" | x
| valign="middle" align="center" | x
| valign="middle" align="center" | x
| valign="middle" align="center" | x
| valign="middle" align="center" | x
| valign="middle" align="center" | x
| valign="middle" align="center" | x
| valign="middle" align="center" | x
| valign="middle" align="center" | x
| valign="middle" align="center" | x
| valign="middle" align="center" | x
| valign="middle" align="center" | x
| valign="middle" bgcolor="#f2f2f2" align="center" | p span
| valign="middle" | error message texts
|-
| bgcolor="#f2f2f2" | countdowndisplay
| valign="middle" align="center" | x
| valign="middle" align="center" | x
| valign="middle" align="center" | x
| valign="middle" align="center" | x
| valign="middle" align="center" | x
| valign="middle" align="center" | x
| valign="middle" align="center" | x
| valign="middle" align="center" | x
| valign="middle" align="center" | x
| valign="middle" align="center" | x
| valign="middle" align="center" | x
| valign="middle" align="center" | x
| valign="middle" bgcolor="#f2f2f2" align="center" | div
| valign="middle" |  
|-
| bgcolor="#f2f2f2" | grid_answeroption_text_
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" | x
| valign="middle" align="center" | x
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" bgcolor="#f2f2f2" align="center" | td
| valign="middle" | (with i is the column number): use for a specific cell contains the answer option text
|-
| bgcolor="#f2f2f2" | grid_subquestion_text_
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" |  
| valign="middle" align="center" | x
| valign="middle" align="center" | x
| valign="middle" align="center" | x
| valign="middle" align="center" | x
| valign="middle" bgcolor="#f2f2f2" align="center" | td
| valign="middle" | ( with i is the row number of the subquestion): use for a specific cell contains the sub question text
|}

[[Image:NormalQues.gif]]

[[Image:GridQues.gif]]

[[Category:Technical guidelines]]

Project VN2664QNR : Export to QSL from Questionnaire Editor

2013-10-18T04:43:08Z

Wikicatglobe:

<accesscontrol>Main:MyGroup</accesscontrol>
== What's purpose of this project ? ==
The main goal of this project is to allow user to export the structure of a questionnaire template into a QSL script .
== Feature design ==
The feature design could be found here :
\\catproc\Share\CatGlobe Teams\Questionnaire\Projects\Version 5.8\VN2644QNR - Export to QSL from Questionnaire Editor
== Implement GUI ==
In this project , we need to write a new collapse-able container and a container that can hold a collection of collapse-able container because the editor only use Swing ( standard Java's API library for providing a graphical user interface ) and this library does not have an explicit collapse-able container .
=== Class diagram ===
[[Image:Container.JPG‎]]
=== How to use an instance of collapse-able container ===
All sub panels of the container initialized once on constructor . The parameter of constructor contains an Array of sub panel's caption and an Array of sub panel .
In order get the collapse-able container itself , use method getComponent()
TO add a collapse-able container to another
== Making an customize save file dialog ==
Currently we have an class for customize save file dialog but this one has not been supported our customize file filter yet so i modified it a little bit so that it supports
=== Making the a file filter ===
The default "All file(*.*)" filter is in inconvenient when using so it will be overwrite . Another useful of it is that we can have text resource fully supported .
==== Make QSL file filter ====
<source lang="java" line="1">
public class QSLFilter extends FileFilter {

/* (non-Javadoc)
* @see javax.swing.filechooser.FileFilter#accept(java.io.File)
*/
@Override
public boolean accept(File arg0) {
// TODO Auto-generated method stub
if(arg0.isDirectory())
return true;
else
return (getExtension(arg0).equals("qsl"));
}

/* (non-Javadoc)
* @see javax.swing.filechooser.FileFilter#getDescription()
*/
@Override
public String getDescription() {

// TODO Auto-generated method stub
return "QSL file(*.qsl)";
}
public static String getExtension(File f) {
String ext = null;
String s = f.getName();
int i = s.lastIndexOf('.');

if (i > 0 && i < s.length() - 1) {
ext = s.substring(i+1).toLowerCase();
}
return ext;
}
</source>

== Export questionnaire template to QSL script ==
To implement export task , we need to go through the structure of the questionnaire template ( questionnaire , question , property , answer option , sub-question) and export to a text file . "Visitor Pattern" has been chosen because this pattern allows us add new operations to existing object structures without modifying those structures . Thus, using the visitor pattern helps conformance with the open/closed principle
=== Visitor pattern ===
[[Image:Visitor.PNG]]

=== QSL keyword using in exporting ===
The QSL keywords are defined in file questionnaire.g and we can't get keywords directly from it . In order to keep the synchronization with import QSL module , we will get the keyword from public variables of QuestionnaireLexer.java and QuestionnaireParser.java . Those 2 file were generated directly and automiccally from Questionnaire.g using ANTLR library .
=== Processing properties ===
In the questionnaire template , properties are only defined for questionnaire and question but QSL script has properties for sub question and answer option . We need to generate these properties from the properties of the related question . To solve this problem , we use 2 map ( Map in java used like a dictionary in .NET) to store properties relate to answer option and sub question .
 Algorithm :
 -Visit question element . If this question type has properties use for answer option ( or sub question ) , process them and put to the map
 -When visit answer option ( or sub question ) , if the map is not empty then get the value from it and generate properties for answer option ( or sub question )

[[category:Technical guidelines]]

=== Data structure use for export task ===
[[Image:DataStructure.PNG]]
==== General ====
The structure of questionnaire template is not completely fit the structure of QSL Script . We do not have an explicit property for answer option so we need to parse the to get the property for answer option from the range contains in question property's value . Another addition is that the properties for sub question is contained in question's properties .
We have made 4 new class in this project :
 - ExportQSLVisitor : This class implements Visitor pattern . We also store internal information that is needed for export task ( export mode , visited question list ...) and information about the exported questionnaire ( properties set ) .
 - ExportQSLVisitor : This class stores all information related to a question ( question properties , answer option , sub question , question text ) . It also include saperatedly the properties we use for answer option and sub question .
 - AnswerOptionQSLExportData : Information of an answer option .
 - SubQuestionQSLExportData : Information of an sub question

==== Visit Questionnaire Element ====
If the export mode include questionnaire properties or using HTML , we initialize _questionnaireProperties

==== Visit Question Element ====
- If this question is not selected to export , ignore it and stop visiting
 - Create new instance of QuestionQSLExportData . Information of question will be created in constructor of QuestionQSLExportData
 - Storing the new QuestionQSLExportData

==== Visit Property Elemnt ====
- If this property belongs to questionnaire , check "Visit Questionnaire Property Element"
 - If this property belongs to question , check "Question Question property Element"
===== Visit Questionnaire Property Element =====
- Create a new QSLProperty for the property
 - If the QSLProperty's output is valid , then store the output to Questionnaire Property

===== Visit Question Question property Element =====
- If this property belongs to a question which is not selected to export , than ignore it and stop visiting ( If the export task does not include question properties , also ignore)
 - If the property related to Answer Option and Range value call function handleAnswerOptionPropertyForRange of _currentQuestionData . Return
 - If the property related to Answer Option and single value call function handleAnswerOptionPropertyForSingle of _currentQuestionData . Return
 - If the property related to sub question of scale grid call function handleSubquestionForScaleGrid of _currentQuestionData . Return
 - Other wise , create a new QSLProperty instance for the property . If the QSLOutput is valid , call function insertQSLPropertyToQuestion of _currentQuestionData

==== Visit sub question Element ====
- If this sub question does not belong to a selected question , return .
 - Other wise , create a SubQuestionQSLExportData for it . Use hasSubQuestionProperties to check if this sub question has property . If yes , get them from the parent question
 - Add the new SubQuestionQSLExportData instance to _currentQuestionData

==== Visit answer option element ====
- If this answer option does not belong to a selected question , return .
 - Other wise , create a AnswerOptionQSLExportData for it . Use hasAnswerOptionProperties to check if this sub question has property . If yes , get them from the parent question
 - Add this new AnswerOptionQSLExportData instance to _currentQuestionData

Process QSL grammar file

2013-10-18T04:43:00Z

Wikicatglobe:

<accesscontrol>Main:MyGroup</accesscontrol>
== Introduction ==
Since the first version of QSL grammar file, there have been many changes and the current grammar is completely different from the original. Unlike other projects, project related to language seems to be not easy to follow. In order to make it clear, i write an article dedicated to technique we use to solve QSL grammar.
== Before we continue ==
It would be easier when you have experience with grammar of a language but i think regular expression is all we need to get into QSL grammar file. ANTLR library and ANTLR Works are also needed.
== Sequence of processing QSL script ==
[[Image:Process_QSL.png]]
 
The lexical analyzer, or lexer, breaks up the input stream into tokens. The parser feeds off this token stream and tries to recognize the sentence structure. Next, we translate the sentences get from parser in to abstract structure tree (AST). Finally, we parse AST into data object.
This article focuses on lexical level as it caused many problem need to solved (From my point of view, parser grammar of QSL is pretty clean and easy to understand)

== Structure of QSL grammar file ==
Normally, there are individual file for lexer grammar and parser grammar but in QSL, we use a mixed grammar file. It means that all lexer rules and parser rules are defined in the same file. This is the original structure and decide to keep it since from my own experience, it is easier to work in ANTLR Works.
== From the bottom of QSL lexer ==
The lexer has many mode and they work like switches so that we can direct the input stream to match the possible tokens. Besides, we have a flag that plays the most important role in the grammar : lineMode.
=== Logic of lineMode flag ===
This flag is true in case we scan each line of the input, searching for keyword or just a text line (question text, answer option text and sub question text). lineMode is false when the input cursor is inside of block (properties or expression).
=== Question text is not wrapped ===
Question text(including answer option text, sub question text) used to be wrapped with '##' when the the very first version of QSL came out. Later, in an update, we decided to remove '##'. This is a big change and effect the tactical of handling lexer.
=== Algorithm of lexer ===
There is no explicit way to distinguish between question text and keyword and it leads to our special algorithm. When lineMode is true and we are at the first position of a line, we try to match all the keyword and symbol to find the correct one. If none keyword is matched, then it is consider as a line of question text.
 
[[image:LineMode.jpg ]]
 
[[image:Dependency.jpg]]
 
Notice that ANY_CHARACTER is tokens represent for a line of text.
==== Negative effect ====
Although this algorithm does work at the moment, but it still has some potential problem as we see:
===== What if question text contain QSL keyword? =====
We all know that question text is an HTML content. It means that it can contain almost every possible character/word. But in case a new text line begin with an QSL keyword? Our beloved algorithm will be broken. Actually in reality, this case is rare but in logic, there is a potential problem need to be considered.
===== The complexity of DFA dicision making =====
Token LINE is a special token in QSL grammar and our algorithm focus on it. The problem is that DFA decision making for this token is complicated
 
[[image:DFADicision.jpg]]
 
Whenever we expand the grammar (add new keyword for example), the complexity is increased and leads to "Code too large" problem.
===== Heavy semantic prediction =====
Back to the meaning of lexical level, it analyzes the input and return tokens for parser. In QSL Lexer, almost all the tokens have semantic prediction (we use condition and flag to direct the input cursor). Most of semantic prediction we use in lexer come from Parser (we decide tokens base on it's role in a complete sentence). From my own experience, that can make someone who is new to QSL grammar confused and the lexer grammar looks like hard to understand.

=== Identified problems when working with QSL grammar in Java environment ===
==== "Code too large" ====
===== Cause =====
Java compiler could not compile code if there is any function larger than 64 kB in size. Some time our rule is complex and the code behind it could up to more than 64kB. No file could be compiled and we can't use the generated file for our purposes.
===== Solution =====
====== Composite grammar ======
In this way, we split the grammar file into some smaller file. It is the solution mentioned in ANTLR official page. Unluckily, we tried but not succeed with it.
====== Write our own lexer for a particular tokens ======
This solution works pretty perfectly when we combine with semantic prediction in grammar file. If we can use our flag to direct the input cursor into a path that only can match a token, it is very effective way to solve the "Code too large" problem. When working project "VN2615QNR - Condition for QSL language", we use ANTLR API method to handle 3 tokens : EXPRESSION, ANY_CHARACTER and COMMENT. It could take much time but it also bring many useful experiences.

== Future improvement for QSL ==
From now on, QSL cover all the aspect of a questionnaire template. For any further improvement, it is reasonable to consider to wrap question text in double quote symbol ("). It will reduce the semantic prediction and the grammar file looks nicer. 
Logical validating properties should be more strictly, especially those properties we split to answer option or sub question properties set. This feature can lead to a new design for error/warning system. 
Format exported question text (including answer option text and sub question text ) in export QSL module. We know that it is HTML content and sometimes reading a bunch without any indent could be a pain. This feature may require an open library to format text. 

[[category:Technical guidelines]]

Placing JComponent inside a JScrollPane

2013-10-18T04:42:42Z

Wikicatglobe:

<accesscontrol>Main:MyGroup</accesscontrol>
Add Your Content Here

[[category:Technical guidelines]]

=Introduction=
You have some component in a scroll pane and when its preferred height is less than the scollpane area then you want it to stretch to fill the scollpane. But when it grows bigger than the scollpane area you would like it show the scrollbars. This is very useful when you want to be able to click in the spare space to clear selection or in the case of drag and drop where you want to be able to drop into the empty area. From JDK 6, in order to do this, simply use function
 
<source lang="java">
this.setFillsViewportHeight(true);
</source>
But back to JDK 5, you must implement it by your self.
=Our problem=
Recently, we have some client using MAC PC. MAC OS only supports JDK 5. That's the reason why the supported function i mentioned above can't be use. It leads to our GUI for question properties dialog broken
 
[[Image:MAC_bug.png]]
=Solution=
Notice that our question properties dialog contains many sub-class of PropertyTable ( also a subclass of JTable. All we have to do is implement Scrollable and write some addition function to the class:
<source lang="java">
public Dimension getPreferredScrollableViewportSize() {
return getPreferredSize();
}

public int getScrollableBlockIncrement(Rectangle visibleRect, int orientation, int direction) {
return (orientation == SwingConstants.HORIZONTAL)? visibleRect.width : visibleRect.height;
}

public boolean getScrollableTracksViewportHeight() {
boolean tracks = false;
if (getParent() instanceof JViewport) {
tracks = getPreferredSize().getHeight() <
((JViewport) getParent()).getExtentSize().getHeight();
}
return tracks;
}

public boolean getScrollableTracksViewportWidth() {
return true;
}

public int getScrollableUnitIncrement(Rectangle visibleRect, int orientation, int direction) {
return getScrollableBlockIncrement(visibleRect, orientation, direction)/5;
}

</source>
 Finally we have working Questionnaire Editor for MAC OS. Happy Swing ;)
 
[[Image:MAC_Fixed.PNG]]
=References=
http://www.jasperpotts.com/blog/2007/06/full-size-jcomponent-in-jscrollpane/
 http://explodingpixels.wordpress.com/2008/10/05/making-a-jtable-fill-the-view-without-extension/

Config workspace for Questionnaire Editor module

2013-10-18T04:40:08Z

Wikicatglobe:

<accesscontrol>Main:MyGroup</accesscontrol>
== Configure workspace for Questionnaire Editor ==

=== Before working with Eclipse ===

Make sure that you have the modules below installed (and also configured environment variable)

*Java JDK
*Apache_ant
*ANTLR
*Eclipse

=== Configure Eclipse ===

*For each version, create a new folder “workspace” which is placed outside the folder “QuestionnaireEditor”.

For example: if folder QuestionnaireEditor is placed at E:\SRC\HEAD\catglobe. Then, the folder 'workspace' will be placed at E:\SRC\HEAD After create it, open Elipse, choose workspace for the current version by choosing the folder 'workspace' of this version

[[Image:01.png‎ ]]

*Choose OK
*Choose File -> Import. In node General, choose 'Existing Projects into Workspace' and click Next
[[Image:02.png‎ ]]
*Choose the folder contains 'QuestionnaireEditor'
[[Image:03.png‎ ]]
*Then, click Next. This project will be loaded in the Eclipse.
Focus on the content of one file java in src folder: choose Projects -> Properties
 [[Image:04.png‎ ]]
*Choose tab Libraries: if all the file .jar don't look like the same in this image, remove all of them except for JRE System library. (For new loading project into Eclipse, those file .jar will get from the C:\Storage\... -> if see them, remove them). Then, click Add Jars... button:
*Choose lib folder and insert those jar files: ekitapplet.jar, plugin.jar, antlr-runtime-3.0.1.jar (if they are in 'lib' folder).
[[Image:05.png‎ ]]
*After do all these things, you can use Eclipse to code Java. This is applied for the first time you load QuestionnaireEditor project. The second time you don't need to do it since it will reserve your previous configuration.

[[Category:Technical_guidelines]]

Coding guideline - Common rules

2013-10-18T04:39:58Z

Wikicatglobe:

<accesscontrol>Main:MyGroup</accesscontrol>
== Introduction ==

This document aims at giving common rules that developers MUST follow to ensure not only consistency in the whole application but also the ease of code reading and maintaining. Due to the fact that we are working mainly on C# language, all examples will be given in this language only.

Please refer to the .NET Framework Design Guidelines (http://msdn.microsoft.com/en-us/library/czefa0ke.aspx) for a complete set of guidelines suggested by Microsoft.

== Terms and Conventions ==

=== Naming Terms ===

There are 3 terms used for naming files, class names, variable names, etc. All are listed in this section.

'''Pascal case'''

The first letter in the identifier and the first letter of each subsequent concatenated word are capitalized. You can use Pascal case for identifiers of three or more characters.

For example: CatGlobeImageButton, LanguageEditor 

'''Camel case'''

The first letter of an identifier is lowercase and the first letter of each subsequent concatenated word is capitalized.

For example: resourceId, resourceTemplateId 

'''Uppercase''' All letters in the identifier are capitalized. Use this convention only for identifiers that consist of two or fewer letters.

For example: ID, UI, IO 

== Style Guidelines ==

=== File Organization ===

'''Location '''

*Class file should be put in directory whose path follows class's namespace. This makes finding a class easier.

For example: code file of class ''CatGlobe.Web.UI.WebControls.CatGlobeImageButton'' should be found in side “''{CODE_BASE}\CatGlobe\Web\UI\WebControls''”

'''Naming '''

*Always use ''Pascal'' for naming code file.
*Source files should be given the name of the first public class in the file plus “.cs”. The purpose of this naming is clear, it increases the consistent of organization and also the maintainability.

For example: code file “''{CODE_BASE}\CatGlobe\Web\UI\WebControls\CatGlobeImageButton.cs''” should have the first public class as ''CatGlobeImageButton''

'''Content'''

*There should be only one namespace declaration in one code file only.
*One source file should contain only one public class/interface/enum, although multiple internal classes are allowed. Delegates and Interfaces are allowed to be put in the same file as class/interface/enum.

''Should'' 

:public sealed class CatTask : PersistentObject, ICatTaskClientObject, IComparable
:{ 
::private sealed class CatTasksAccess : AccessBase
::{
::}
:}



''Should not'' 

:public sealed class CatTask : PersistentObject, ICatTaskClientObject, IComparable
:{
:}

:[Serializable]
:public sealed class StringConstant
:{
:}



*Classes member should be grouped into sections (Fields, Constructors, Properties, Events, Methods, Private interface implementations, Nested types). And there should be a region name in ''#endregion'' instructive although it is not required. Regions can be shown/hide while viewing with VS thus increasing the readability.

For example: 

:public sealed class CatTask : PersistentObject, ICatTaskClientObject, IComparable
:{ 
::#region AccessClass

::private sealed class CatTasksAccess : AccessBase
::{
::}

::#endregion AccessClass

::#region Private Instance Fields

::private int resourceId;
::private int resourceTemplateId;

::#endregion Private Instance Fields
:}



''A propose class file with regions:'' 

:public class SampleClass
:{ 
::#region Nested Enums, Structs, and Classes
::#endregion Nested Enums, Structs, and Classes

::#region Constructors & Finalizers
::#endregion Constructors & Finalizers

::#region Member variables
::#endregion Member variables

::#region roperties
::#endregion Properties

::#region Methods
::#endregion Methods
:}



*There should not be more than ''500 lines of code'' inside one file. Files containing more than 500 lines have less readability than the ones with less than 500 lines. There is one exception that we should not take into account on this rules, that are auto-generated files since most of the time we do not maintain these files directly.
*Each line of code ''should not exceed 120 characters''. Lines with more than 120 characters normally require code viewer using the horizontal scrollbar thus decrease readability.

=== Tabs, Indenting, Spacing and Bracing ===

'''Tabs and Indenting'''

*Tab characters (\0x09) '''MUST NOT''' be used in code. All tabs must be replaced by 3 space characters.
*All indentation '''MUST''' be done with '''''3 space characters'''''.

'''Spacing''' Spaces improve readability by decreasing code density. Here are some guidelines for the use of space characters within code:

*'''Do''' use a single space after a comma between function arguments.

:Right:Console.In.Read(myChar,0,1);
:Wrong: Console.In.Read(myChar,0,1);

*'''Do not''' use a space after the parenthesis and function arguments.

:Right: CreateFoo(myChar, 0, 1);
:Wrong: CreateFoo( myChar, 0, 1 )

*'''Do not'''''use spaces between a function name and parenthesis.''

:Right: CreateFoo(); 
:Wrong: CreateFoo ()

*'''Do not'''''use spaces inside brackets.''

:Right: x = dataArray[index];
:Wrong: x = dataArray[ index ]; 

*'''Do''' use a single space before flow control statements.

:Right: while (x == y)
:Wrong: while(x==y)

*'''Do''' use a single space before and after comparison operators.

:Right: if (x == y)
:Wrong: if (x==y)

'''Bracing'''

*Open braces must always be at the beginning of the line after the statement that begins the block. This increases readability of code.

''Must:'' 

:if ((CatTaskStatus.Status == CatTaskCommon.CatTaskStatus.Failed)
:{ 
::CatTaskCompleted ctc = CatTaskCompleted.GetByLatestCompletedDate(this);
::if (ctc != null) 
:::completedDate = ctc.CompletedDate;
::return completedDate;
:}
:else
:{ 
::...
:}



''Must not:'' 

:if ((CatTaskStatus.Status == CatTaskCommon.CatTaskStatus.Failed) '''{''''''=> Wrong brace's location''' 
::CatTaskCompleted ctc = CatTaskCompleted.GetByLatestCompletedDate(this);
::if (ctc != null) '''{''' 
:::completedDate = ctc.CompletedDate;
::}
::return completedDate;
:}



*For anonymous methods and lambda expressions, the braces must be indent at the same level with its declaration.

''Example:'' 

:private SampleDelegate _mySampleDelegate = delegate() 
::::::::   '''{'''
::::::::   '''};'''

:private SampleDelegate _mySampleDelegate = (name) => 
::::::::   '''{'''
::::::::   '''}''';



*Must not put block that contains more than 2 statements in the same line:

''Must not'': 

:if (ctc != null) {completedDate = ctc.CompletedDate; return completedDate; }



*With single statement blocks, using of braces is optionnal. It is encourage to not use the braces to save number of line of code.

''Should:'' 

:if (ctc != null) 
::completedDate = ctc.CompletedDate;



''Should not:'' 

:if (ctc != null)
:{ 
::completedDate = ctc.CompletedDate; '''=> 3 lines of code do the same as 1 line'''
:}



*There are exceptions that brace should be placed on the same line as the keyword that requires braces.

''One statement code block:''



:public int CompletedMailTemplateId
:{ 
::get { return completedMailTemplateId; } '''=> It is much nicer than having 4 lines of code'''
::set { completedMailTemplateId = value; }
:}



''.NET 3.0 property syntax:'' 

:public int MyProperty { get; set; }


<div style="border: 1pt solid rgb(0, 0, 0); padding: 5px; background: rgb(192, 192, 192) none repeat scroll 0% 0%; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial; color: rgb(0, 0, 255);">
'''Tips:''' All rules in this section can be applied automatically by applying a common ''Visual Studio settings file''. Developers just have to remember to apply these rules by pressing ''Ctrl + K + D'' (under default installation) or ''Ctrl + E + C ''using Resharper before committing.
</div>
=== Commenting ===

Comments should be used to describe intention, algorithmic overview, and/or logical flow. It would be ideal, if from reading the comments alone, someone other than the author could understand a function’s intended behavior and general operation. While there are no minimum comment requirements and certainly some very small routines need no commenting at all, it is hoped that most routines will have comments reflecting the programmer’s intent and approach.

*Use // or /// for commenting but not /* ... */. The last comment style is out of date, it is useful in the old time when coder wanted to comment a large block of code. Using such comment will save a lot of time as writing // on each line. However, with new editor, comment/uncomment block of code is just a matter of selecting the block and calling a short cut key.
*Do not decorate your comment with special charaters.

''Must not:'' 

:// *********************************
:// Comments block
:// **********************************



*Avoid comments that explain the obvious. Code should be self-explanatory. Good code with readable variable and method names should not require comments.

''Should not'' 

:/// <summary>
:/// Resource Id
:/// </summary>
:private int resourceId;



:=> Comment that makes no sense. Could be something like: <''The primary id of the <see cref=”CatGlobe.Domain.Common.Resource” /> that this class is working with.''

*Include Task-List keywords flags to enable comment-filtering. These comment can be tracked by using Visual Studio Task List window or just simply by searching.

''Example:'' 

:// TODO: Fix this
:// HACK: work-around temporarily while waiting for better solution
:// UNDONE: Will be done in version xxxx


<div style="border: 1pt solid rgb(0, 0, 0); padding: 5px; background: rgb(192, 192, 192) none repeat scroll 0% 0%; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial;">
'''Tips:''' In Visual Studio, more keywords can be defined in Tools → Environment → Task List. More detail description can be found here http://msdn.microsoft.com/en-us/library/zce12xx2(VS.80).aspx 
</div>
*Always apply C# comment-blocks (///) to public, protected and internal declaration. The comment will be displayed as tooltip in editor and this helps method's user a lot for writing code correctly.

See picture below: [[Image:Coding Guidelines Common rules 1.0 html m698f2609.png|thumb|center|500px|Class comment displayed inside help text]]

 

*Use comment tags whenever possible, this could give very much help on generating help files. The most used tags are: <summary>, <param>, <paramref>, <return>, <exception>, <see>, <seeAlso>.

''Class comment:'' 

:/// <summary>
:/// This is my sample class for illustating comment on coding guide line document
:/// </summary>
:public class SampleClass
:{
:}



''Method comment:'' 

:/// <summary>
:/// This is my test method. It is created for demonstrating how to write comment for
:/// a method.
:/// </summary>
:/// <param name="arg1">This is sample argument 1. It will be used for ... </param>
:/// <param name="arg2">This is sample argument 2. It will be used for ...</param>
:/// <returns>Return the result string.</returns>
:protected string MyMethod(string arg1, string arg2)
:{
:}


<div style="border: 1pt solid rgb(0, 0, 0); padding: 5px; background: rgb(192, 192, 192) none repeat scroll 0% 0%; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial; color: rgb(0, 0, 255);">
'''Tips:''' In Visual Studio, typing three slashes on the line right before a declaration will automatically create a template for comment on the correspondence element.

An explaination on the comment can be found here: http://msdn.microsoft.com/en-us/magazine/cc302121.aspx

A detail explaination of all comment tags can be found here: http://thoughtpad.net/alan-dean/cs-xml-documentation.
</div>
=== Naming ===

==== Common rules ====

*Always use Camel Case or Pascal Case for naming. With private instance member, prefix variable name with an underscore '_'.

''Pascal case for types (classes/interfaces/delegates/enums/structs) and methods:'' 

:public class SomeClass
:{ 
::public void SomeMethod() { }
:}



''Camel case for member variables and parameters:'' 

:public void MyMethod(int someNumber)
:{ 
::int ''_number'';
:}



''Camel case preceding by an underscore '_' for private/protected fields:'' 

:public class SomeClass
:{ 
::private int ''_number'';
::protected string ''_name'';
:}



''Pascal case for enum's values:'' 

:public enumCodeReviewResult
:{ 
::None,
::Approval,
::PartialDisapproval,
::CompleteDisapproval,
::NeedRework,
:}



*Must use Upper Case for naming constant and separate words with underscore character '_'

''Example:'' 

:public const int DATABASE_CONNECTION_TIMEOUT = 500;



*Should not create namespaces, classes, methods, properties, fields, or parameters that vary only by capitalization.

''Should not:'' 

:public void MyMethod(string arg1, string Arg1)
:{
:}



*Should not use names that begin with numeric characters.
*Should not use single char variable names, except in '''For/While''' loop.
*Always choose meaningful and specific names.
*Should not use abbreviations unless the full name is excessive (over 20 characters). With Visual Studio IDE's IntelliSense, it is very easy finding a variable no matter how long the name is.

''Should not:'' 

:public List<string> UDFList;



:=> this stands for User Defined list, the name hide the purpose of the owner variable from code reader

==== Namespace naming ====

The general rule for naming namespaces is to use the company name followed by the technology name and optionally the feature and design.

''Example:'' 

:namespace CatGlobe.DiffStat.Console;
:namespace CatGlobe.DiffStat.WinApp;



==== Type naming ====

*Use noun or pronoun for naming classes/interfaces.

''Should not:'' 

:public class Run
:{
:}



''Should:'' 

:public class Runner
:{
:}



*MUST prefix an interface with character I.

''Example:'' 

:public int erface ISomeInterface
:{
:}



*MUST suffix custom attribute classes with Attribute.

''Example:'' 

:public class MyCustomAttribute: System.Attribute
:{
:}



*MUST suffix custom exeptions classes with Exeption.

''Example:'' 

:public class MyException: System.Exception
:{
:}



*MUST NOT suffix any enums with Enum.

''Must not:'' 

:public enum ResourceTypeEnum=> it is better if Enum is removed
:{
:}



==== Method and Property naming ====

*Use a verb-object pair for naming methods.

''Example:'' 

:public void TestCatTask();
:public void GetName();



*If returned type is Boolean, try to prefix method name with “Can”, “Is” or “Has”.

''Example:'' 

:public bool CanSave()
:public bool IsEditable()
:public bool HasAccess()



*Never perfix a property name with “Get”, “Set”. It is because when using value of a property it is already understand as calling to a “Get” method.

''Must not:'' 

:public int GetIntValue { get; set; }



''Must:'' 

:public int IntValue { get; set; }



==== Generic types naming ====

*Should use single capital letters for generic types.

''Should:'' 

:public class List<'''T'''>where '''T''' : string 
:{
:}



=== Code organization ===

==== using Statement ====

*All using statements should be put outside any namespaces statements.

''Should:'' 

:using CatGlobe.Web.UI.WebControls;
:using CatGlobe.Web.Common.ClassBase;
:using CatGlobe.Web.Common.ServerMethods;
:using CatGlobe.Domain.SiteVisitor.ServiceHandler;

:namespace CatGlobe.Web.Common.Resources.List;
:{
:}



''Should not:'' 

:namespace CatGlobe.Web.Common.Resources.List
:{ 
::using CatGlobe.Web.UI.WebControls;
::using CatGlobe.Web.Common.ClassBase;
::using CatGlobe.Web.Common.ServerMethods;
::using CatGlobe.Domain.SiteVisitor.ServiceHandler;
:}



*Related using statements should be group together. This helps reader an overview of which library will be used in the remaining code.

''Example:'' 

:using System;
:using System.Xml;
:using System.IO;

:using Infragistics.WebUI.UltraWebGrid; => Reference Infragistics
:using Infragistics.WebUI.UltraWebNavigator;
:using Infragistics.WebUI.UltraWebToolbar;

:using CatGlobe.DataAccess;=> Reference CatGlobe's DataAccess

:using CatGlobe.Framework.GroupBuilder; => Reference CatGlobe's Framework
:using CatGlobe.Framework.Resources;



==== Internal Types ====

*Types that are declared inside a class must be group together. And the group must be put right after class definition.

''Example:'' 

:public class ResourceList
:{ 
::#region Types

::/// <summary>
::/// Collection of <seecref="CatGlobe.Domain.Common.Resource"/>s,
::/// in which we can sort the whole list or 
::/// fetch resources based on some criteria.
::/// </summary>
::private class ResourceCollection
::{
::}

::/// <summary>
::/// Provide methods for Save/Delete a single <seecref="CatGlobe.Domain.Common.Resource"/>
::/// or collection of <see cref="CatGlobe.Domain.Common.Resource"/>s.
::/// </summary>
::private class ResourceHandler
::{
::}

::#endregion Types
:}



==== Member and Local Variables ====

*All class's member variable must be put at top of class (after internal types declaration). This increase readability of code, since at the first look the viewer can tell what are members of class and also theirs types.

*Each variable of different types must be declared on different lines.

''Must:'' 

:private string _sampleString;
:private int _sampleInt;
:private long _sampleLong1, _sampleLong2, _sampleLong3;



''Must not:'' 

:private string _sampleString;
:private int _sampleInt;



*Local variables must be clared as close as possible to its first use and must be in the same code block that use it.

==== Methods ====

*A method must not exceed 100 lines. Methods with more than 100 lines usually decrease readability and thus maintainability.

*Methods that relate to each others by any means should be grouped together.

''Example:'' 

:#region Database Access Methods
:#endregion Database Access Methods

:#region Private Utility Methods
:#endregion Private Utility Methods

:#region Serialization Methods
:#endregion Serialization Methods



*Interface implementations must be grouped together.

''Example:'' 

:public interface ISample
:{ 
::void SampleMethod();
:}

:public class SampleImplementation: ISample
:{ 
::#region ISample Members

::void ISample.SampleMethod()
::{
::}

::#endregion ISample Members
:}



==== Indentation deep ====

*All methods' indentation must not exceed a deep level of 3. Methods, whose indentation exceeds 3 in deep level, decrease readability, maintainability and also increase complexity.

''Must not:'' 

:if (HasAccess)
:{ 
::for (int i = 0; i < COUNT; i++)
::{ 
:::if (list[i].IsTrue)
:::{ 
::::switch (resourceType)
::::{ 
:::::=> Code inside this block are too deep
::::}
:::}
::}
:}


<div style="border: 1pt solid rgb(0, 0, 0); padding: 5px; background: rgb(192, 192, 192) none repeat scroll 0% 0%; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial; color: rgb(0, 0, 255);">
'''Tips:''' There are 2 methods for reducing the deep level of code block:

*Reorganizing if statement

''Original code:'' 

:public void SampleMethod(bool someCondition)
:{ 
::if (someCondition)
::{ 
:::for (int i = 0; i < COUNT; i++)
:::{
:::}
::}
:}



''Changed code:'' 

:public void SampleMethod(bool someCondition)
:{ 
::if (!someCondition) 
:::return ;
::for (int i = 0; i < COUNT; i++)
::{
::}
:}



=> The indentation's deep level has been decreased by 1.

*Creating private method

''Original code:'' 

:public void SampleMethod(bool someCondition)
:{ 
::if (HasAccess)
::{ 
:::for (int i = 0; i < COUNT; i++)
:::{ 
::::if (list[i].IsTrue)
::::{ 
:::::foreach (int value in list[i].Values)
:::::{ 
::::::if (value > 0)
::::::{ 
:::::::for (int j = 0; j < value; j++)
:::::::{ 
::::::::if (anotherCondition)
::::::::{
::::::::}
:::::::}
::::::}
:::::}
::::}
:::}
::}
::}



''Changed code:'' 

:public void SampleMethod(bool someCondition)
:{ 
::if (HasAccess)
::{ 
:::for (int i = 0; i < COUNT; i++)
:::{ 
::::if (list[i].IsTrue)
::::{ 
:::::ProcessValues(list[i].Values);
::::}
:::}
::}
:}

:private void ProcessValues(List<int> values)
:{ 
::foreach (int value in values)
::{ 
:::if (value > 0)
:::{ 
::::for (int j = 0; j < value; j++)
::::{ 
:::::if (anotherCondition)
:::::{
:::::}
::::}
:::}
::}
:}



=> The indentation's deep level is dreased more than 1
</div>
==== Attribute declaration ====

*For elements that have more than one Attribute declaration, then each Attribute must be put on one line.

''Must not:'' 

:[Serializable, STAThread, Obsolete("This class is obsolete. Use class Abc instead.")]
:public class SampleClass



''Must:'' 

:[Serializable]
:[STAThread]
:[Obsolete("This class is obsolete. Use class Abc instead.")]
:public class SampleClass



== Coding guidelines ==

=== Basic language usage ===

==== Access modifier ====

*All access modifier must be explicitly given, except in interface's declaration where public is undertood by default.

''Must not:'' 

:class SampleClass
:{ 
::int sampleInt;
::void SampleMethod()
::{
::}
:}



==== Variables and Types ====

*If possible, initialize variables at declaration time.

''Should:'' 

:private int primaryId = 0;
:private string sampleString = string.Empty;
:private List<int> sampleList = new List<int>();



*Must use fully qualified name of types, declare the type by using statements. In case there are duplication in type's name, define aliases.

''Must not:'' 

:ResourceCollectionPager pager = CatGlobe.Framework.Services.SessionManager.Current.DataModule.Get<ResourceCollectionPager>(Request["sessionid"]);



''Must:'' 

:using CatGlobe.Framework.Services;
:ResourceCollectionPager pager = SessionManager.Current.DataModule.Get<ResourceCollectionPager>(Request["sessionid"]);


<div style="border: 1pt solid rgb(0, 0, 0); padding: 5px; background: rgb(192, 192, 192) none repeat scroll 0% 0%; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial; color: rgb(0, 0, 255);">
'''Tips:''' Always choose “using” over fully qualified name from Resolve menu of Visual Studio. [[Image:Coding Guidelines Common rules 1.0 html m6738e672.png|center|400px|Resolve menu of VS2008]]
</div>
''Example of using alias:'' 

:using Threading = System.Threading;
:using Timers = System.Timers;
:using Web = System.Web.UI;

:namespaceCatGlobe.DataAccess
:{ 
::public class SampleClass
::{ 
:::private Threading.Timer _threadTimer1;
:::private Timers.Timer _threadTimer2;
:::private Web.Timer _threadTimer3;
::}
:}



==== Constants and Literals ====

*Never hardcoded strings that will be presented to end-users. Use Resoures class instead.

''Must not'': 

:<span>Username</span>



''Must'': 

:<span><%=Resources.Username %></span>



*Try to use @ instead escape characters symbol

''Should:''

:string filename = @"D:\test\test.xml";

==== Direct cast vs. as keyword ====

Following code block: 

:CustomClass a = src as CustomClass;



can be considered the same as the code block below: 

:if (src is CustomClass) 
::return (CustomClass)src;
:else 
::return null;



Consequently, it is encouraged to use as keyword over directcasting, because it is neat and safer.

=== Exceptions handling ===

*Catch least generic exception first

''Must not:'' 

:try
:{ 
::using (FileStream fs = newFileStream(@"D:\test.xml")) { }
:}
:catch (Exception) { }
:catch (IOException)
:{ 
::=>Unreachable code
:}



*Do not use exception for controlling flows, instead try to validate input parameter. Most of the time exceptions can be prevented by proper input validation.

''Should not'': 

:string input = "something";
:try
:{ 
::DoWork(input);
:}
:catch (Exception e)
:{ 
::DoAlternateWork(input);
:}



*All exception must be re-thrown, the outest layer (usually GUI win-form or web-form) must responsible for handling the exception properly.

''Must not'': 

:try
:{ 
::DoWork();
:}
:catch (Exception e)
:{ 
::// do nothing
:}



*If not creating a wrapper exception, use “throw” instead of “throwe” to reserve the call-stack. “throw” statement's stack trace points to the code place that actually causes the error, while “throwe”'s stack trace points to the location of the “throwe” statement only.

''Must not'': 

:catch (IOException ioe)
:{ 
::Logger.LogError(ioe);
::throw ioe; => Must be throw;
:}



''Correct'': 

:catch (IOException ioe)
:{ 
::Logger.LogError(ioe);
::throw new CustomeException("error", ioe);
:}

:catch (IOException ioe)
:{ 
::Logger.LogError(ioe);
::throw;
:}



== Document revisions ==

{|
|-
| '''Version No.'''
| '''Date'''
| '''Changed By'''
| '''Description'''
|-
| 0.1
| 10.07.2008
| Nguyen Trung Chinh
| Copy from http://blogs.msdn.com/brada/articles/361363.aspx
|-
| 0.1
| 22.08.2008
| Nguyen Trung Chinh
| Refine from original document, add more applicable rules
|-
| 0.1
| 25.08.2008
| Nguyen Trung Chinh
| Fix for 0.1 after reviews of Dennis and Thuan
|-
| 0.2
| 08.10.2008
| Nguyen Trung Chinh
| Add section 3.5 and 4
|-
| 0.3
| 13.10.2008
| Nguyen Trung Chinh
| Finish section 4
|-
| 1.0
| 14.11.2008
| Nguyen Trung Chinh
| Finalize version 1.0
|}

[[Category:Technical guidelines]]

CG Grid's height

2013-10-18T04:39:16Z

Wikicatglobe:

<accesscontrol>Main:MyGroup</accesscontrol>
Hi,

To simplify this, I have attached new funtion to grid object. Therefore, from now on, you can reset grid height as

grid.resizeHeight( value );

------------------------------------------

These days i have fixed some bugs related to LnF in FF. Most of them came from the CGGrid which overlapped other below content. For example, in Data Import wizard or Access Dialog. When i looked at the code, it had code to set the grid's height as we normally does in catglobe. 

But why did not it work? In reality, sometime it did, sometime not. What did we do was, i mentioned here was a [[JQuery]] structure: 

$("#" + grid.Id + "_mr").height(h); $("#" + grid.Id + "_mc").height(h); 

What it did was to set height for the row and cell containing the main content of grid. HOWEVER, the outer parts of them are tbody and table, they were still 100% height.  That is the point. 

How to fix it? Simple, make sure you also set height for tbody and table as well. 

Code snippest: 

$("#" + grid.Id + "_mtb").height(h); $("#" + grid.Id + "_main").height(h); 

[[Category:Technical_guidelines]]

Business logic of Require property in Questionnaire Template

2013-10-18T04:38:48Z

Wikicatglobe:

<accesscontrol>Main:MyGroup</accesscontrol>
== Description ==
This property existed in both questionnaire template's properties and question's properties .
*Setting for questionnaire :
[[Image:QnaireRequired.JPG‎]]
*Setting for question (non-Grid question)
[[Image:NonGridRequired.JPG]]
*Setting for question (Grid question)
[[Image:GridRequired.JPG]]

*Using in .NET
CatGlobe.Domain.Questionnaires.PropertyType.Required

*Using in Java
Property.REQUIRED

== Business logic ==
=== Required as Questionnaire's property ===
*If this property is checked , it means that all the question in the questionnaire template , which are not specified Required property explicitly , will require the users answer it and they can't go to another question without answering .
Behind the code : the template will has property REQUIRED with the property's value is "true" .
*If this property is unchecked , it means that all the question in the questionnaire template , which are not specified Required property explicitly,will not require users answer it.
Behind the code : '''the template will has property NOT_REQUIRE with the property's value is "true"'''
=== Required as Question's property ===
This property is inherited from the value of property Required in a questionnaire. However, a question can set anew for this property through its Required property, and this value is only applied to this question.
*Inherited from Required property of questionnaire template :
[[Image:Inherited.JPG]]
 In this case the there is not both REQUIRED and NOT_REQUIRED property register in question's property (the existed one will be removed). So the question will inherited from the Required property of the questionnaire template]
*Required property is checked
[[Image:Checked.JPG]]
 In this case , the question will has REQUIRED property with the property's value is "true"
*Required property is unchecked
[[Image:UnChecked.JPG]]
 In this case , '''the question will has NOT_REQUIRED property with the property's value is "true"'''
*If the question is a GRID question ( single grid , multi grid , scale grid , text grid) , users need to define which sub questions will be required . '''The range will be save to the value of correlative property''' (REQUIRED or NOT_REQUIRED).

== Working with Required property in .NET side ==
=== This example shows how to use the Required property of grid question and apply it to related sub question ===
<source lang="csharp" line="1">
// Apply the required property if set
QuestionProperty requiredProperty = q.GetProperty(PropertyType.Required);
if (requiredProperty != null && !string.IsNullOrEmpty(requiredProperty.Value))
{
// Parse the property's value into ranges
Ranges requiredRanges = new Ranges(requiredProperty.Value);

// For each range run through the integers contained in the range
// and set the required property to true
foreach (Range r in requiredRanges)
for (int j = r.From; j <= r.To; j++)
//Tho : this if expression is to make sure that we only take valid
//sub question index . Some old questionnaire template has invalid property value
if ( j>-1 && j < q.subQuestions.Count)
q.subQuestions[j].Required = true;
}

// Apply the not required property if set
QuestionProperty notRequiredProperty = q.GetProperty(PropertyType.NotRequired);
if (notRequiredProperty != null && !string.IsNullOrEmpty(notRequiredProperty.Value))
{
// Parse the property's value into ranges
Ranges notRequiredRanges = new Ranges(notRequiredProperty.Value);

// For each range run through the integers contained in the range
// and set the required property to false
foreach (Range r in notRequiredRanges)
{
if (r.To >= q.SubQuestions.Count)
r.To = q.SubQuestions.Count - 1;
for (int j = r.From; j <= r.To; j++)
//Tho : this if expression is to make sure that we only take valid
//sub question index . Some old questionnaire template has invalid property value
if (j > -1 && j < q.subQuestions.Count)
q.subQuestions[j].Required = false;
}
}
</source>
=== This example show how to apply Required property of questionnaire template to question and register it to client side ===
<source lang="csharp">
foreach (QuestionnaireProperty p in Questionnaire.Properties)
{
switch (p.Type)
//Before inherited from Questionnaire properties , you must make sure that the question does not have both Required and NotRequired property
case PropertyType.Required:
if (Question.IsGrid())
{
int i = 0;
foreach (SubQuestion sq in Question.SubQuestions)
{
if (sq.Visible)
{
script.Append("// Require answer for ");
script.Append(sq.Question.Label);
script.Append("[");
script.Append(sq.GridNumber);
script.Append("]\n");
script.AppendFormat("quest.questions[{0}].required = true;\n", i++);
}
}
}
else
{
script.Append("quest.required = true;\n");
}
break;
case PropertyType.NotRequired:
if (Question.IsGrid())
{
int i = 0;
foreach (SubQuestion sq in Question.SubQuestions)
{
if (sq.Visible)
{
script.Append("// Not require answer for ");
script.Append(sq.Question.Label);
script.Append("[");
script.Append(sq.GridNumber);
script.Append("]\n");
script.AppendFormat("quest.questions[{0}].required = false;\n", i++);
}
}
}
else
{
script.Append("quest.required = false;\n");
}
break;
//...
}
</source>
=== This example shows how to apply Required property of question register it to client side ===
<source lang="csharp">
foreach (QuestionProperty p in Question.Properties)
{
// ....
switch(p.Type)
case PropertyType.NotRequired:
if (Question.IsGrid())
{
ranges = new Ranges(p.Value);

int i = 0;
foreach (SubQuestion sq in Question.SubQuestions)
{
if (sq.Visible && ranges.Contains(sq.GridNumber))
{
script.Append("// Not require answer for ");
script.Append(sq.Question.Label);
script.Append("[");
script.Append(sq.GridNumber);
script.Append("]\n");

script.AppendFormat("quest.questions[{0}].required = false;\n", i);
}

if (sq.Visible)
{
i++;
}
}
}
else
{
script.Append("quest.required = false;\n");
}
break;
case PropertyType.Required:
if (Question.IsGrid())
{
ranges = new Ranges(p.Value);

int i = 0;
foreach (SubQuestion sq in Question.SubQuestions)
{
if (sq.Visible && ranges.Contains(sq.GridNumber))
{
script.Append("// Require answer for ");
script.Append(sq.Question.Label);
script.Append("[");
script.Append(sq.GridNumber);
script.Append("]\n");

script.AppendFormat("quest.questions[{0}].required = true;\n", i);
}

if (sq.Visible)
{
i++;
}
}
}
else
{
script.Append("quest.required = true;\n");
}
break;
//...
}
</source>
[[category:Technical guidelines]]

Roadmap

2013-10-18T03:59:51Z

Wikicatglobe:

<accesscontrol>Main:MyGroup</accesscontrol>
[[Category:Archive]]
= Roadmap diagram =

[[Image:Roadmap Graphics 2010-03-05.png]] 

= Version 5.8.1 (SP1) - Catglobe Heisenberg =

Version has already been released. You can find release notes here: [[Release Notes version 5.8.1 Heisenberg|Release_Notes_version_5.8.1_Heisenberg]]

= Version 5.8.2 (SP2) - Catglobe Heisenberg =

Catglobe version 5.8.2 Heisenberg (SP2) is the second minor iteration on top of the major release of v.5.8 January 2010. 

This minor release focuses on a few topics, most significantly the new questionnaire viewer will be release for production in this version. The new questionnaire viewer sets the new standard for how to display question in Catglobe and will allow for a lot more customization by the graphical user interface including placing multiple questions per page. 

Secondly the version will focus on two other major areas besides a number of minor fixes and improvements, the two other major areas is a project within the CGScript engine allowing for manipulating huge amount of data and improvements in the PDF output from tabulation jobs. The project within CGScript will provide an efficient way for manipulation huge amounts of data from scripting. This solution will allow panel managers to move data and convert it for hundred of thousands of panel members at a time. The solution for PDF output is some long needed modification for making the output format so customizable that it will be a feasible way for many users for creating table output from surveys for the clients. 

== CG Script engine ==

Project including description...

Integration to external systems using webservices. 

'''4 ways to go about this:''' 

#Putting data into Catglobe 
##Catglobe pulls data from an external system using a webservice provided by the external system. 
##External system pushes data into Catglobe using a webservice provided by Catglobe calling a workflow with parameters. (Consider batch with many records at a time) 
#Getting data from Catglobe into an external system
##External system pulls data from Catglobe using a webservice provided by Catglobe
##Catglobe pushes data into an external system using a webservice provided by External System Provider.

Case 2.1 is already supported. Case 1.1 and 2.2 is roughly the same but large batches of data should be considered. Case 1.2 is not yet supported.

=== Projects ===
Yet to be written

== Report ==

Project including description...

=== Projects ===
Yet to be written

== Survey ==

Description description description. Description description description Description description description Description description description Description description description 

=== Projects ===

VNXXXXYYY - Multiple question per page Allowing for placing multiple question on a single page for questionnaire. Including support for condition for helping developers not use conditions which should have effect internally on a page. VNZZZZYYYY - Blah blah

Will help on this... 

== Release ==

Release date primo September 

= Version 6.0 - Catglobe Tiger =

Version 6.0 Catglobe Tiger

== CG Script engine ==

Report spreadsheet API Invoice API Call of work flows from script Triggers added for questionnaire and project events

Scripted solution for import allowing us to import a pre-specied job from CGScript with away of controlling the file to be used. Purpose is to predefine a setup allowing a users to only upload a file and then have Catglobe do the rest using a specified workflow.

=== Projects ===

Yet to come 

== CatTask ==
New CatTask engine implemented. Providing better failover solution for CatTask service system.
CatTask scheduler allowing for much more fine grained schedule, allowing the user to select weekdays and time of day and combine this in a much more flexible manor.

== Survey ==

User experience improvements for questionnare editor

=== Projects ===

Yet to come 

== Usability ==

New import module

=== Projects ===

Yet to come 

== Report ==

New report engine

=== Projects ===

Yet to come 

== Framework ==

CatTask moved to new CatTask

=== Projects ===

Yet to come 

== Release ==

Release date ultimo December 

= Version 6.0.1 (SP1) - Catglobe Tiger =

Blah blah blah

= Version 6.0.2 (SP2) - Catglobe Tiger =

Blah blah blah

= Version 6.1 - Catglobe Panther =

Blah blah blah

Icon LnF

2013-10-18T03:57:06Z

Wikicatglobe:

<accesscontrol>Main:MyGroup</accesscontrol>
== Icon LnF ==

#Icons should have two states; normal and mouse over. The mouse over effect is a 3d shadow effect!
#All tool bar icons need 3 images specified; normal, hover, and disable!
#Buttons in tool bars that cannot be used should be grayed out, for example delete cannot be used until an item is chosen so it is grayed out until something is chosen. Tool tips should be visible on grayed out buttons.
#Tool tips must be added to all buttons that does not have text on the button.
#If the button text consists of more than one word then the first word is with a capital letter the following are with small letters. For example "Changed by".
#There can never be buttons after a Pager Control in a tool bar.
#Some icons should always have the same image no matter where we see the icon; please refer to "[http://wiki.catglobe.com/index.php/Icon_LnF#What_icons_to_use What icons to use]". If the icon is not available, please talk to Process group for getting assigned an icon!
#Icons must always be set in the same general order on all lists. Please refer to [http://wiki.catglobe.com/index.php/Icon_LnF#Order_of_Icons Order_of_Icons] to see the order in which icons must appear when you have an icon tool bar or equivalent!
#When we have 6 or more icons on a tool bar (or the dialogue is very small) we can choose to show some icons without the text label. Those icons that can be shown this way are marked with * in [http://wiki.catglobe.com/index.php/Icon_LnF#Order_of_Icons Order_of_Icons]
#Groups of tool bar buttons are separated by a vertical separator
#Do not show two icons button separators next to each other - if e.g. no buttons with access in between!
#Do not show icon button separator at start or end without buttons on each side.

== What icons to use ==

Icons is grouped based on the their function or number of use in each modules. Click on each group to see more details.

=== [[Project tree icons]] ===

:{| class="CGTable" border="1"
|-
| [[Image:Company.gif]]
| [[Image:facility.gif]]
| [[Image:user.gif]]
| [[Image:Grouptree.gif]]
| [[Image:Sitetree.gif]]
| [[Image:Project.gif]]
| [[Image:Project complete.gif]]
| [[Image:Foldertree.gif]]
| [[Image:Task.gif]]
| [[Image:Task complete.gif]]
| [[Image:Taskset.gif]]
| [[Image:Workflow.gif]]
| [[Image:Communicator template.gif]]
| [[Image:Attachment.gif]]
| [[Image:DCS.gif]]
| [[Image:DCS export.gif]]
| [[Image:Product.gif]]
| [[Image:Shift.gif]]
| [[Image:Translationjob.gif]]
| [[Image:Codingjob.gif]]
|-
| [[Image:Issue.gif]]
| [[Image:project_questionnaire.gif]]
| [[Image:project_questionnaire_complete.gif]]
| [[Image:Questionnaire.gif]]
| [[Image:questionnaire_template.gif]]
| [[Image:questionnaire_layout.gif]]
| [[Image:questionnaire_layout_template.gif]]
| [[Image:questionnaire_paper.gif]]
| [[Image:sample_request.gif]]
| [[Image:Diagram.gif]]
| [[Image:Monitor.gif]]
| [[Image:Report.gif]]
| [[Image:report_template.gif]]
| [[Image:spreadsheet.gif]]
| [[Image:dashboard.gif]]
| [[Image:nextpage.gif]]
|
|
|
|
|}

=== [[Attachment type icons]] ===

:{| class="CGTable" border="1"
|-
| [[Image:Image access.gif]]
| [[Image:Image excel.gif]]
| [[Image:Image word.gif]]
| [[Image:Image ppt.gif]]
| [[Image:Image visio.gif]]
| [[Image:Image pdf.gif]]
| [[Image:Image html.gif]]
| [[Image:Image xml.gif]]
| [[Image:Image text.gif]]
| [[Image:Image bmp.gif]]
| [[Image:Image png.gif]]
| [[Image:Image gif.gif]]
| [[Image:Image jpg.gif]]
| [[Image:Image zip.gif]]
| [[Image:Image wma.gif]]
| [[Image:Notype.gif]]
|}

=== [[Common use icons]] ===

:{| class="CGTable" border="1"
| [[Image:Create.gif]]
| [[Image:CreateAndClose.gif]]
| [[Image:Delete.gif]]
| [[Image:Add.gif]]
| [[Image:Remove.gif]]
| [[Image:DeleteToRecycleBin.gif]]
| [[Image:RestoreBin.gif]]
| [[Image:DestroyBin.gif]]
| [[Image:DestroyBinAll.gif]]
| [[Image:Recycle bin.gif]]
| [[Image:Save.gif]]
| [[Image:SaveAndNew.gif]]
| [[Image:SaveAndClose.gif]]
| [[Image:SaveAndView.gif]]
| [[Image:SaveAs.gif]]
| [[Image:SaveAsTemplate.gif]]
| [[Image:Open.gif]]
| [[Image:OpenTemplate.gif]]
| [[Image:Viewoption.gif]]
| [[Image:SetDefault.gif]]
|-
| [[Image:Favorite.gif]]
| [[Image:View.gif]]
| [[Image:Cut.gif]]
| [[Image:Edit.gif]]
| [[Image:Editall.gif]]
| [[Image:Copy.gif]]
| [[Image:Paste.gif]]
| [[Image:Close.gif]]
| [[Image:Cancel.png]]
| [[Image:OK.gif]]
| [[Image:No.gif]]
| [[Image:Yes.gif]]
| [[Image:Search.gif]]
| [[Image:Find all.gif]]
| [[Image:Replace.gif]]
| [[Image:Replace all.gif]]
| [[Image:Refresh.gif]]
| [[Image:SortDescending.gif]]
| [[Image:SortAscending.gif]]
| [[Image:Run.gif]]
|-
| [[Image:Generate.gif]]
| [[Image:Download.gif]]
| [[Image:Upload.gif]]
| [[Image:Submit.gif]]
| [[Image:Submit close.gif]]
| [[Image:Submit new.gif]]
| [[Image:Undo.gif]]
| [[Image:ResetAll.gif]]
| [[Image:Redo.gif]]
| [[Image:AddImage.gif]]
| [[Image:AddAttachment.gif]]
| [[Image:Hyperlink.gif]]
| [[Image:Image.gif]]
| [[Image:Excel.gif]]
| [[Image:Pdf.gif]]
| [[Image:Powerpoint.gif]]
| [[Image:Lock.gif]]
| [[Image:Execute.gif]]
| [[Image:Constant.gif]]
| [[Image:TimeRegistration.gif]]
|-
| [[Image:Register_external_hour.gif]]
| [[Image:Chart.gif]]
| [[Image:Myportal.gif]]
| [[Image:Import.gif]]
| [[Image:Export.gif]]
| [[Image:Import export.gif]]
| [[Image:Help.gif]]
| [[Image:Tip.gif]]
| [[Image:Information.gif]]
| [[Image:Printer.gif]]
| [[Image:Data gear.gif]]
| [[Image:Schedule.png]]
| [[Image:Calculator.gif]]
| [[Image:ViewSlideshow plain.gif]]
| [[Image:Layoutxml.gif]]
| [[Image:Stable_plain.gif]]
| [[Image:UnStable_plain.gif]]
| [[Image:SetFail_plain.gif‎]]
| [[Image:Properties.gif]]
|
|}

=== [[Access icons]] ===

:{| class="CGTable" border="1"
| [[Image:Access.gif]]
| [[Image:Resource-access.gif]]
| [[Image:Navigation.gif]]
| [[Image:Inherit.gif]]
|}

=== [[Journal icons]] ===

:{| class="CGTable" border="1"
| [[Image:Journal.gif]]
| [[Image:Check checked.gif]]
| [[Image:Check none.gif]]
| [[Image:grant1.png]]
| [[Image:ungrant1.png]]
| [[Image:Select Some.gif]]
| [[Image:Select All.gif]]
|}

=== [[User icons]] ===

:{| class="CGTable" border="1"
| [[Image:User.gif]]
| [[Image:AddUser.png]]
| [[Image:Edit2.gif]]
| [[Image:Protectdate.gif]]
| [[Image:Account.gif]]
| [[Image:group.gif]]
| [[Image:Add group.gif]]
| [[Image:view_user_plain.gif]]
|}

=== [[Navigation icons|Navigation & Expand/Collapse icons]] ===

:{| class="CGTable" border="1"
|-
| [[Image:NavigateFirst.gif]]
| [[Image:NavigateLeft.gif]]
| [[Image:NavigateRight.gif]]
| [[Image:NavigateLast.gif]]
| [[Image:Navigate_left2.gif]]
| [[Image:Navigate_right2.gif]]
|-
| [[Image:Navigatesave_beginning.gif]]
| [[Image:Navigatesave_left.gif]]
| [[Image:Navigatesave_left2.gif]]
| [[Image:Navigatesave_right2.gif]]
| [[Image:Navigatesave_right.gif]]
| [[Image:Navigatesave_end.gif]]
|-
| [[Image:UpArrow.gif]]
| [[Image:DownArrow.gif]]
| [[Image:LeftArrow.gif]]
| [[Image:RightArrow.gif]]
| [[Image:Hide.gif]]
|
|-
| [[Image:left_circle.gif]]
| [[Image:right_circle.gif]]
| [[Image:up_circle.gif]]
| [[Image:down_circle.gif]]
|
|
|-
| [[Image:up.gif]]
| [[Image:down.gif]]
|
|
|
|
|-
| [[Image:left.gif]]
| [[Image:right.gif]]
|
|
|
|
|}

=== [[Editor icons]] ===

:{| class="CGTable" border="1"
|-
| [[Image:Subscript.gif]]
| [[Image:Superscript.gif]]
| [[Image:Bullets.gif]]
| [[Image:Numberlist.gif]]
| [[Image:Table.gif]]
| [[Image:Aligncenter.gif]]
| [[Image:Alignleft.gif]]
| [[Image:Alignright.gif]]
| [[Image:Justify.gif]]
| [[Image:Top.gif]]
| [[Image:Bottom.gif]]
| [[Image:Middle.gif]]
| [[Image:Bold.gif]]
| [[Image:Italic.gif]]
| [[Image:Underline.gif]]
| [[Image:Fontcolor.gif]]
| [[Image:Bringfoward.gif]]
| [[Image:Sendbackward.gif]]
| [[Image:Bringtofront.gif]]
| [[Image:Sendtoback.gif]]
|-
| [[Image:Insertbreakpage.gif]]
| [[Image:Insertchart.gif]]
| [[Image:Insertpagelink.gif]]
| [[Image:Insert-Text-Box-1.gif]]
| [[Image:Newpagebefore.gif]]
| [[Image:Newpageafter.gif]]
| [[Image:Deletecurrentpage.gif]]
| [[Image:AddRow.gif]]
| [[Image:DeleteRow.gif]]
| [[Image:AddColumn.gif]]
| [[Image:DeleteColumn.gif]]
| [[Image:Moverowdown.gif‎]]
| [[Image:Moverowup.gif]]
| [[Image:Movecolumnleft.gif‎]]
| [[Image:Movecolumnright.gif‎]]
|
|
|
|
|
|}

=== [[Questionnaire icons]] ===

:{| class="CGTable" border="1"
|-
| [[Image:Project questionnaire.gif]]
| [[Image:Project questionnaire complete.gif]]
| [[Image:Questionnaire.gif]]
| [[Image:Questionnaire template.gif]]
| [[Image:Questionnaire layout.gif]]
| [[Image:Questionnaire layout template.gif]]
| [[Image:Questionnaire datagrid.gif]]
| [[Image:QuestionGroup.gif]]
| [[Image:Questionnaire paper.gif]]
| [[Image:ViewSampleSize.gif]]
| [[Image:ViewFilter.gif]]
| [[Image:ViewCross.gif]]
| [[Image:Viewproperties.gif]]
| [[Image:Viewconditions.gif]]
| [[Image:Moveto.gif]]
| [[Image:Interview manager.gif]]
| [[Image:Mask.gif]]
| [[Image:Disable.gif]]
| [[Image:Lock information.png]]
| [[Image:Target.gif]]
|-
| [[Image:testlink.gif]]
| [[Image:Reset layout.gif]]
| [[Image:Resetdelete.gif]]
| [[Image:Translate.gif]]
| [[Image:Start.gif]]
| [[Image:Pause.gif]]
| [[Image:Checksyntax.gif]]
| [[Image:Analyze.gif]]
| [[Image:Insertflash.gif]]
| [[Image:ExportPerformance_plain.gif]]
|
|
|
|
|
|
|
|
|
|
|}

=== [[Report icons]] ===

:{| class="CGTable" border="1"
|-
| [[Image:Report.gif]]
| [[Image:Report template.gif]]
| [[Image:ViewReport.gif]]
| [[Image:Dashboard.gif]]
| [[Image:Spreadsheet.gif]]
| [[Image:Monitor.gif]]
| [[Image:Diagram.gif]]
| [[Image:GotoSite.gif]]
| [[Image:Customize.gif]]
| [[Image:Random.gif]]
| [[Image:Selection view.gif]]
| [[Image:Chartstyle.gif]]
| [[Image:Document chart.gif]]
| [[Image:Viewresult.gif]]
| [[Image:Copychart.gif]]
| [[Image:Sum.gif]]
| [[Image:Expression.gif]]
| [[Image:Checks.gif]]
| [[Image:Providerxml.gif]]
| [[Image:weekcross.gif]]
|-
| [[Image:addtoleft.gif]]
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|}

=== [[Communicator icons]] ===

:{| border="1" class="CGTable"
|-
| [[Image:Mail.gif]]
| [[Image:Bulkmail.gif]]
| [[Image:InformMessage.gif]]
| [[Image:SentMail.gif]]
| [[Image:SendAllMails.gif]]
| [[Image:SaveAndSentLater.gif]]
| [[Image:SavetoDraft.gif]]
| [[Image:Reply.gif]]
| [[Image:ReplyAll.gif]]
| [[Image:ReadMail.gif]]
| [[Image:UnreadMail.gif]]
| [[Image:MailAccount.gif]]
| [[Image:Sms.gif]]
| [[Image:Bulksms.gif]]
| [[Image:InvalidAddress_plain.gif]]
| [[Image:SendProperty.gif]]
| [[Image:Move.gif]]
| [[Image:StartQuestionnaire.gif]]
| [[Image:SendingMail.gif]]
| [[Image:Informer_plain.gif]]
|-
| [[Image:Highpriority.GIF]]
| [[Image:Priority.gif]]
| [[Image:Normalpriority.gif]]
| [[Image:Lowpriority.GIF]]
| [[Image:Rules.gif]]
| [[Image:Keys.png]]
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|}

=== [[CGScript icons]] ===

:{| class="CGTable" border="1"
|-
| [[Image:CGScriptPrompt.gif]]
| [[Image:CGScriptRun.gif]]
| [[Image:CGScriptRunAll.gif]]
|}

=== [[Coding job icons]] ===

:{| class="CGTable" border="1"
|-
| [[Image:Script.gif]]
| [[Image:Exclude.gif]]
| [[Image:Include.gif]]
| [[Image:Reuse.gif]]
| [[Image:ClearAll.gif]]
|}

=== [[Data icons]] ===

:{| class="CGTable" border="1"
|-
| [[Image:Datacache.gif]]
| [[Image:DeleteCache.gif]]
| [[Image:GenerateCache.gif]]
| [[Image:Rename.gif]]
| [[Image:Autofix.gif]]
| [[Image:Editaxis.gif]]
| [[Image:Weight.gif]]
| [[Image:Rebuild.png]]
|}

=== [[Expression icons]] ===

:{| class="CGTable" border="1"
|-
| [[Image:Larger.gif]]
| [[Image:LargerEqual.gif]]
| [[Image:Smaller.gif]]
| [[Image:SmallerEqual.gif]]
| [[Image:Equal.gif]]
| [[Image:NotEqual.gif]]
| [[Image:And.gif]]
| [[Image:Or.gif]]
| [[Image:Inside.gif]]
| [[Image:Value.gif]]
|}

=== [[Task icons]] ===

:{| class="CGTable" border="1"
|-
| [[Image:Approve.gif]]
| [[Image:Disapprove.gif]]
| [[Image:Finish.gif]]
| [[Image:Accept.gif]]
| [[Image:Reassign.gif]]
| [[Image:Merge.gif]]
| [[Image:SelectMerge.gif]]
| [[Image:generatetask.gif]]
|}

=== [[Webshop icons]] ===

:{| class="CGTable" border="1"
|-
| [[Image:Transaction.gif]]
| [[Image:Addtransactionex.gif]]
| [[Image:Viewtransaction.gif]]
| [[Image:Updatebudget.gif]]
| [[Image:Pending.gif]]
| [[Image:Deliver.gif]]
| [[Image:Cashier approve.gif]]
| [[Image:Creditcard approve.gif]]
| [[Image:setAttribute_plain.gif]]
|}

=== [[Monitor icons]] ===

:{| class="CGTable" border="1"
|-
| [[Image:Dashboard.gif]]
| [[Image:Document.gif]]
| [[Image:Document_attachment.gif]]
| [[Image:Earth2.gif]]
| [[Image:Folder.gif]]
| [[Image:DiagramCross.gif]]
| [[Image:DiagramStandard.gif‎]]
| [[Image:DiagramTracking.gif]]
| [[Image:DiagramCampaign.gif]]
| [[Image:DiagramComparison.gif]]
| [[Image:PowerPoint.gif]]
| [[Image:Presentation.gif]]
|}

=== [[CATI & Asterisk icons]] ===

:{| class="CGTable" border="1"
|-
| [[Image:Phone.gif]]
| [[Image:Speaker.gif]]
| [[Image:Check.gif]]
| [[Image:custom.gif]]
| [[Image:Play.png]]
| [[Image:Record.gif]]
| [[Image:Stop.gif]]
| [[Image:Overhear.gif]]
|-
| [[Image:DisconnectPhone.gif]]
| [[Image:RingPhone.gif]]
| [[Image:SleepPhone.gif]]
| [[Image:TalkingPhone.gif]]
|
|
|
|}

=== [[System announcement icons]] ===

:{| class="CGTable" border="1"
|-
| [[Image:Error.png]]
| [[Image:Warning.png]]
| [[Image:Check.png]]
|}

== Order of Icons ==

To give CatGlobe a uniform Look & Feel, buttons must be in about the same location on all pages. While there are many different buttons the system, most buttons are in the same list of categories. 

When we have limited space the icons with * may appear with no text labeling.

=== Some samples ===

[[Image:OrderofIcon.gif]]

=== Order of icons ===

#Create *
#Add *
#Save * ''--------(Separator)''
#Save and next
#Save and new
#Save and close ''--------(Separator)''
#Edit *
#Open *
#Open Template
#Copy * ''--------(Separator)''
#Search *
#Refresh * ''--------(Separator)''
#Backward *
#Forward * ''--------(Separator)''
#Print resource information *
#Send resource information * ''--------(Separator)''
#'''Other specified Icons''' ''--------(Separator)''
#Delete *
#Remove *
#Close * ''--------(Separator)''
#Pager control
#No of Records field

[[Category:LnF_guidelines]]

Coding guideline - CatGlobe

2013-10-18T03:56:33Z

Wikicatglobe:

<accesscontrol>Main:MyGroup</accesscontrol>
== Introduction ==

This guideline contains CatGlobe-specific coding rules.

== Exception ==

=== Exception handling ===

*Only catch exception if you can do some thing with it.
*All re-thrown exception must include the original exception in its inner exception.
*DO: always catch specific exception type. You are allowed to catch generic exception and re-throw a specific exception; for example in CGScript all exceptions are caught and a RuntimeException is re-thrown afterward.
*DO NOT: empty and undocumented catches; using unspecific catches, unless they are documented well in the design document and are approved by the PMs.

=== Create a new custom of exception ===

*Naming rule: the new exception must be suffixed with “Exception”.
*All custom exceptions must inherit from another exception class.
*The exception should be serializable in order to use in CatTask service. Refer to [[Serializable exceptions]] for more details. Notice: when the new CatTask service is done, this may be obsolete.
*Namespace rule:

        - If the being created exception is used in multiple places, it must be placed in the CatGlobe.Framework.Exceptions namespace.

        - Otherwise, if it is used for a specific class only, it can be placed in the namespace where it is used.

== Working with threads ==

*Usages of threads must be specified in the Technical design and approved by PMs.
*Use CatGlobe.Framework.Security.AsyncHelper class to start a thread with auto-impersonate, access factory and webconfig manager.

== Web pages – web controls ==

=== Code behind (ASPX and ASCX) ===

*Code behind must be documented with request parameters, usage, purpose.
*Use Register…(JavascriptConstant…) to include javascript files in the code behind.
*Web page must inherit from the PageBase class, control must inherit from the ControlBase class and Web Service must inherit from the WebServiceBase class.
*DO NOT override the OnError event, unless it is approved in the technical design.

=== ASPX file ===

*Replace the auto-generated DOCTYPE by this one: <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" >
*A page must have a title using text resource.
*All the validation warnings which the Visual Studio shows must be fixed.
*Adding references to user controls and using of tagPrefixes: must following this guideline [[Tag prefixes for user controls and web controls]]
*You are allowed to reference to javascript files in the aspx files directly. However, you must use the JavascriptConstant to reference to them.
*If a page or a control contains more than 3 methods or more than 20 lines, move it to a separate js file.

=== ASCX file ===

*DO NOT reference to javascript files in the ascx files.

=== Text resources ===

*When you need to register a text resource to the client side, use the PageBase.CGClientScript.RegisterTextResource method. The method will encode registered text resources for you.
*Setting for text resource files of web pages:

        - Need to be set to the [filename].aspx.resx file only.

        - Custom tool namespace: x (yes, only the letter 'x').

        - Build action: None

        - Custom tool: ResXFileCodeGeneratorEx

*Setting for text resource files of an enumeration file:

        - Custom tool namespace: aenum

        - Build action: Embedded Resource

        - Custom tool: ResXFileCodeGeneratorEx

=== Events handling ===

*When you override an event, always call to base class method.
*Only handle an event when you have something to do with it. On this example, the OnInit method should be removed because we have nothing to do with it:

<source lang="csharp">
protected override void OnInit(EventArgs e)
{
base.OnInit(e);
}
</source>

=== Request ===

*All the arguments which can be passed to the url must be documented.
*Each request parameter must have it own getter property. Handling of the request parameters must always be inside the getter properties.
*All request parameter getters must be put in a region called “REQUEST PARAMETERS”.

=== Session ===

*Use SessionManager to work with Session.
*Objects which are put into the Session must be serializable.
*Examples about good and bad usages of Session, in the share-data-between-pages context:

         - Good if the data is complicated and cannot be render to the clientside or pass via url easily. A good example is the search criterion of the search page.

         - Good if the data is incompleted, so it is not ready to be saved to the database yet, for example the data which is collected through a wizard: we collect some pieces of information in step 1, put them into Session and navigate to the step 2, and so on...

         - Good if the data takes too much resources (IO, CPU, time) to retrieved. For example a fully-initialized Questionnaire, means all of its questions, question properties, sub questions, answer options are initialized.

         - Bad if the data in Session can be changed by multiple pages/forms by multiple ways. For example: the page A shows some information about a report, which is put in the session. The user opens the Report compact dialog in another tab. When the user saves the report in the CRD, it is the database is updated, not the report object in the Session. Now the user backs to the page A and modifies the report. Obviously he will get a concurrency problem.

=== Javascript ===

*Do not use browser-specific script. All the javascript must work in both IE and FireFox.
*Javascript should be written in OOP style using AJAX .NET. One class should be in one file.
*Functions must be documented about their usages and their parameters. Types of parameters must also be specified.
*In order to utilize the intellisense feature of VS2008:

       - Put summary inside function:

[[Image:Javascriptsummary.jpg]]

*To get intellisense work in a javascript file, you have to add a reference to the source JavaScript file. There are two situations need to be considered here:

      - If the source JavaScript file is a embedded resource, use the declaration below:
<blockquote>               /// <reference name="registered name of that embeded JavaScript file" /> </blockquote>
      - If the source JavaScript file is an included file, use the declaration below:

               /// <reference path="path file name of that JavaScript file"/>

[[Image:Javascriptreference.jpg]]

*To get intellisense work in a ASPX file:

      - If your page is implementing AJAX, reference to the source JavaScript file in ScriptManager control: <source lang="csharp" line="1"> <asp:ScriptManager runat="server" id="scriptManager"> <Scripts> <asp:ScriptReference path="virtual path file name of the JavaScript file" /> </Scripts> </asp:ScriptManager> </source>       - Otherwise, reference to the source JavaScript file in a script element declaration:

                <script src="virtual path file name of the JavaScript file" type="text/javascript" >

== Data access layer ==

=== AccessFactory ===

*Special uses of AF must be approved in the TD. They can be:

        - Where you need to create an AF by yourself.

        - Where you need to call Commit or Abort.

        - Where you need to call CloseOverwritenConnectionWithNoGlobalTransaction and OverwriteConnectionToNoGlobalTransaction. 

=== Access class ===

*Every access class of a domain class needs two callback methods and two delegates which are used when creating and saving objects.
*The callback method which is used when creating object is named Create. In this method, data is read from the IDataReader to build an object. Signature of the Create method is:

<source lang="csharp" line="1">
static private T Create(ref CreateOrd co, IDataReader reader)
</source>

where T is a domain class, for example User, Attachment or EmailAddress.

*The callback method which is used when saving object is named Save. In this method, the primary key of the being saved object is read from the IDataReader and update to the object. If the object is a Resource, version is read and update too. Signature of the Save method is:

<source lang="csharp" line="1">

static private void Save(T emailerror, IDataReader reader)
</source>

*Create two delegates for the two methods above. These delegates are passed to the AccessBase.Execute[Action] methods:

<source lang="csharp" line="1">
static readonly CreateDelegateGen<T> create = Create;

static readonly SaveDelegateGen<T> save = Save;
</source>

=== Building query ===

When building a query:

*Only make your own sql builder function if you can’t find an appropriate one in the GenericSqlBuilder class.
*All the methods in the MySqlBuilder layer must begin with “Build” and end with “Sql”.
*Use StringBuilder to build your queries.
*Always use provider constant to get table names and column names.
*MySqlBuilder methods should take the same parameters as calling method from the Access layer, except when multiple methods from the Access layer call the same builder.
*Make your input parameters as strict as possible. For example, if the input is a provider table of a resource view, its type shouldn’t be ProviderTable, but ProviderResourceViewTable.
*Always use GetLiteral functions to convert a value to a string which can be appended to the query. Usage of GetLiteral is not required when data type of the value is number.
*Append every condition of the where clause in a separate line. Operants of an OR operator should be written in one line.
*Example:

'''''Wrong: '''''<source lang="csharp" line="1">
StringBuilder sqlBuilder = new StringBuilder();
sqlBuilder.Append("SELECT ID");
sqlBuilder.Append(" FROM ");
sqlBuilder.Append(" USER_RESOURCE ");
sqlBuilder.Append(" WHERE ");
sqlBuilder.Append(" NAME ");
sqlBuilder.Append(" = ");
sqlBuilder.Append(userName);
sqlBuilder.Append(" AND ");
sqlBuilder.Append(" (Access_Expiration <= ");
sqlBuilder.Append(CGDateTime.Now.ToString());
sqlBuilder.Append(" OR ");
sqlBuilder.Append(" Access_Expiration is NULL) ");
</source>

'''''Correct: '''''
<source lang="csharp" line="1">
StringBuilder sqlBuilder = new StringBuilder();
sqlBuilder.AppendFormat("SELECT {0} ", PC.UserResource.Id);
sqlBuilder.AppendFormat("FROM {0} ", PC.UserResource.TableName);
sqlBuilder.Append("WHERE ");
sqlBuilder.AppendFormat("{0} = {1} ", PC.UserResource.ShortName.Name, GetLiteral(userName));
sqlBuilder.AppendFormat("AND ({0} <= {1} OR {0} is NULL)", PC.UserResource.AccessExpiration.Name, GetLiteral(CGDateTime.Now));
</source> 

== Performance ==

*If using lazy evaluated property on a collection of objects, then the properties should be initialized before usage to prevent the lazy evaluation. Naming for that function is InitAll[PropertyName].
*The InitAll[PropertyName] functions should be implemented using the CatGlobe.Domain.Common.GenericInitAllHelper class.
*When you need to check for access of a user to many resources, do it once directly in the query.
*Similarly for navigation accesses checking: there is a method to check for many navigation accesses in the PageBase class.
*Use string.Format when you want to concatenate more than 2 string objects in one line.
*Use StringBuilder when you want to concatenate string objects in many lines, or inside a loop.
*Use generic types like Dictionary<> and List<> instead of HashTable, ArrayList. ArrayList can be used for return type of Server methods.
*When you have a list of items, you may want to use Dictionary or List to store them. The rule is:when you want to store values to look up quickly, use the Dictionary class. Otherwise, use List.

== Auto-generated files ==

There are a few auto-generated files in Catglobe:
*ConfigurationConstants.
*ProviderConstants.
*Text resource classes.
*Resx files.
*Designer files.
*SessionManager.
*JavaScriptFileConstants
*LINQ to XSD generated files.
*WSDL generated files.
*WCF generated files.
Rules:
*DO NOT: modify it manually.
*DO: modify the source file and then generate the source code file.

 

== Webconfig ==
*A new key must be approved by CORE.
*You need to add a validation method for the new key in the WebconfigValidation class.
*DO NOT: read the key directly from webconfig.
*DO: make a new property in the WebconfigManager class to read it.
 

== Data validation ==
*Specify the maximum length of character input fields.
*Specify the minimum and the maximum value of numeric input fields.
*Validation, if possible, should be done first on the client side. Data then must always be validated again on the server side.
*Try to use control which supports data-restriction. For example, the WebNumeric control allows us to specify the minimum and maximum values, allows numbers only.
*Checking for database constraints, for example if a resource name already exists, should be done before data is actually inserted or updated to the database.
*Validations may need to be done:
*If the input value is in the valid range.
*If length the input value is the valid range.
*If it contains invalid character.
*If it meets some specific constraints, for example an email address field must match the email naming rule.

 

== Resource access – navigation access ==
*Any page which requires navigation access must be check for navigation access in itself.
*Any page which shows information of a resource to the user must check for resource access.
*Given that in page A we have a button called Open which is used to open the page B, which shows information about a User. *Typically, we need to check:
**In the page A:
***Check for navigation access to show/hide or to enable/disable the Open button.
***In some pages you may need to check for resource access to enable/disable the Open button.
**In the page B: You need to check for both navigation access and resource access again. The reason for this check is that the user may copy the url to open a page and change some of its parameters to open another resource directly to bypass the check in the source page.

 

== Server method ==
*DO NOT call server method inside a FOR loop. There is almost always a way to collect all the needed data and call the server method just one time.
*Important rules
*Always put the call to a synchronous server method in a try-catch block on the client side. Recall to the empty try catch rule, you may need to show an error message to the user.
*For asynchronous server methods, refer to [[ServerMethods' exception handling]] for more details.
*Exception handling in a server method should follow the section about exception above.

 

== Localization ==

*Data which is shown to the user must be in the culture of the logged in user. In the case of date time, it is also required that the display value must be in the time zone of the logged in user. All exceptions must be specified in the feature design.
*Use CGDateTime instead of DateTime in the Business logic layer and Domain layer. Usages of the .NET DateTime struct is restricted in GUI only, unless they are approved in TD.
*If a GUI needs a control to work with date time, use the CGDateTimeControl. However, if the field is an editable-date-only, use the Infragistic.WebDateChooser control.
*The Turkish culture has a lot of differences from other cultures. Refer to this link for more information: http://www.moserware.com/2008/02/does-your-code-pass-turkey-test.html
*String representation of data which is saved to the database must be in Invariant culture.
*String representation of data which is passed to the domain layer should also be in Invariant culture.
*Date time which is stored in the database must be in UTC. If you need to store a string of date time value in the database, its format must be in Invariant Culture and its time zone must be UTC. This includes all data in XMLs.

 

== Commit rule ==
For project:
*Commit all the files in one commit is recommended. Commit log must contains the project id.
*When committing bug fixes for a project, both task id and project id are required. In addition, there must be comment about what the bug is and what has been done to fix it.
For bug fix:
*Task id is required.
*Commit fix for one bug a time (sometimes one fix may kill many bugs).
*Depend on the complexity and importance of the bug, provide proper comments.
 

== General ==

=== Code changing ===

*Whenever you modify a domain method, you must use the find all references feature to find all the places which the method is used and investigate if your change also affects them.
*If you change code of another group, please inform them before you commit.
*If you modify a public method which doesn’t have summary, add summary for it.
*If you reformat/re-indent a class, commit it separately without any code change.

=== Utilizing C# 3.0 syntax ===

*Fast declaration of get/set for simple property. Please notice that this syntax cannot be used if you need to initialize a field inline, for example initialize a CGDateTime field to MinValue.
*Use lambda syntax instead of anonymous method.

ContactFolder missingFolder = contactFolders.Find(cf => cf.ContactFolderType == contactFolderType); instead of ContactFolder missingFolder = contactFolders.Find(delegate(ContactFolder cf) { return cf.ContactFolderType == contactFolderType; });

*Use object initializers:

<source lang="csharp">
//Object initializer
User user = new User {Name = "CatGlobe", Password = "cg"};
</source>

<source lang="csharp">
// List initializer
List<string> people = new List<string>()
{
"Granville",
"John",
"Rachel",
"Betty",
"Chandler",
"Ross",
"Monica"
};
</source>

*When you need to make a JavaScript version of a server side object encoded in JSON, use the CatGlobe.Framework.Serialization.CGJavaScriptSerializer class. Also be noticed that the anonymous type feature of C# 3.0 is a good choice to make an object to serialize to the clientside. Example:
<source lang="csharp">
var clientObject = new { Name = "CatGlobe", Value = "Hi there!", Accesible = false };
string json = CGJavaScriptSerializer.Serialize(clientObject);
Page.ClientScript.RegisterStartupScript(typeof(_Default), "Startup", string.Format("var clientObject = {0};", json), true);
</source>

The value of json is “{"Name":"CatGlobe","Value":"Hi there!","Accesible":false}”

=== Code reusing ===

*Look for or ask for the needed APIs first. If it is not available, contact the PM to include it.
*If need to use some piece of code twice or more, then make a function to do it. Even if it is just 2 lines!
*Whenever you think that what you make may be used by other developer, or it can somehow be promoted to a common library, please contact with RnD to find a good place to put it.

=== Placement of code ===

*Business logic does NOT belong in GUI.
*What are business logics? Rule of Thumb: any code which doesn’t directly manipulate a GUI component is BL.
*BL code which is used to make decision should be put in the Framework classes, not Domain classes.
*A domain class:

       - Is an in-code instance of a database table.

       - Read data from and write data to the corresponding table.

       - Validate data before which may be saved to database.

*A framework class:

       - Called module class in technical design.

       - Contains business logic code of a web page, calls domain classes to manipulate database's data.

       - Contains helper APIs which are used widely.

*Helper classes that are used only inside some other class should not be defined it its own file and namespace. Instead it should be an inner class.
*We alreay had a new project called CatGlobe.Common which contains all the common stuffs which are used across the solution.

== Xml ==

*It is required that every xml document must have an XSD. The XSD file is put in the same folder with the class which uses it. Set the Build action property to Embedded Resource.
*Look for an appropriate existing AssemblyIncludedFiles class or create one new iIn the same folder. In this file:

      - Make a string constant for the path to the xsd file.

      - Make a GetStream method like the example below.
<source lang="csharp">
public static class AssemblyIncludedFiles
{
public const string RULES_SCHEMA_PATH = "CatGlobe.Domain.PhoneNumbers.Rules.rules.xsd";
static public System.IO.Stream GetStream(string filePath)
{
return typeof(AssemblyIncludedFiles).Assembly.GetManifestResourceStream(filePath);
}
}
</source>

=== Working with XSD ===

*Naming of the elements becomes naming of classes and properties, so you might want to make your xsd naming same as C# naming.
*For the targetNamespace attribute: our suggestion is that you can use that of the XSD file, which means http://CatGlobe/<module>/<class>. For example, if the targetNameSpace is [http://catglobe/Domain/Report/DashBoard/TimeSet http://CatGlobe/Domain/Report/DashBoard/TimeSet], namespace then will become CatGlobe.Domain.Report.DashBoard.TimeSet
*After the XSD is ready, generate a C# class for it by executing this command:

C:\Program Files\LINQ to XSD Preview\Bin\LinqToXsd.exe <path to your xsd> /fileName:<path to where you want your generated cs file>

*Read the manual on how to use the generated class. It is located in C:\Program Files\LINQ to XSD Preview\Docs

== Utility classes ==

*Classes in the namespace CatGlobe.Framework.Text have many APIs which are used to work with strings:

     - Encode strings to use in javascript, in HTML.

     - Validate email addresses.

     - Convert a generic list to a string.

     - Escapse special characters.

     - Convert HTML to plain text.

     - Generate some kinds of strings.

*CatGlobe.Framework.Security.SecurityManager: provides various APIs to check for resource access, navigation access as well as grant/ungrant resource access, navigation access.
*CatGlobe.Framework.Network.Dns: have various classes to work with DNS. One of the most useful feature is that it can be used to check for the existence of both ARecord and MXRecord.
*CatGlobe.Framework.Images.ImageUtilities: provides APIs to work with images:

     - Create thumbnails.

     - Get the link to an Image resource.

     - Get mime type.

*CatGlobe.Framework.DateTimer.DateTimeHelper and CatGlobe.Framework.DateTimer.CGDateTimeConverter: provide various APIs to work with date times. You also can find standard format strings for date time there.
*CatGlobe.Framework.DataStructure.SortingHelper: a class which is used to sort unsaved data of a grid control on the server side.
*CatGlobe.Framework.Communication.Mail: provides various APIs to send mails out.
*System.Collections.SerializableDictionary: a dictionary type which is xml-serializable.

== How to create a CGScript library or function ==

*CGScript functions are in the CatGlobe.Framework.Runtime namespace. You need to specify which library the function belongs to.
*How to register new functions to the library:
*Register new function to the symbol table: inside Register() method of this library class. Call the symbolTable.AddFunction method with the following syntax:

symbolTable.AddFunction("functionName", new FunctionIdentifier("functionName", new FunctionEventHandler(this.FunctionName), ConstantType.<return_data_type>));

where FunctionName: name of new functions: such as isRequiredConstant, setBooleanConstant,... this.FunctionName: a method for handling this new CGS function ConstantType.<return_data_type>: return type of a new function

*Put all register commands on the region “register constant functions”. Create a method for handling the CGS function logic. It must have the signature of :

private Constant FunctionName(FunctionIdentifier function)

 In this method, we must follow the scenario:

*Validate the number of arguments, throw runtime exception if it's wrong
*Validate argument (type and its existence if needed), throw runtime exception if it's wrong
*Execute its main logic
*Return result as its <return_data_type>

[[Category:Technical_guidelines]]

CGScript - Coding guideline

2013-10-18T03:29:15Z

Wikicatglobe:

<accesscontrol>Main:MyGroup</accesscontrol>
= Objects =

Objects in cgscript can be created by doing following this guideline.

First an object must be created. The normal name for this is xxxCGO where xxx is the name of the object in cgscript.

This object must inherit from <code>CgScriptObject</code> and it must have a <code>CgAttribute</code>.

For example, here is the absolute minimal class:

<code><pre>
[Cg(OBJECT_TYPE_NAME, "write the documentation for the class here")]
internal class MyObjectCGO : CgScriptObject
{
private const string OBJECT_TYPE_NAME = "MyObject";
public override string ObjectTypeName
{
get { return OBJECT_TYPE_NAME; }
}
}
</pre></code>

The class must be internal or public, and non-abstract, and must not play with generics.
The exception is that it may inherit from a generic baseclass (which then inherits from CgScriptObject), or implement a generic interface.

=== Inheritance ===

A CgScriptObject may utilize inheritance as a normal .NET object. CgScript will not be aware of this, it just sees all inherited methods, properties, etc. as belonging to the class.

== Object functions ==

Functions are exposed as cgscript functions by marking them with the CgAttribute and also marking all the parameters with the CgAttribute (see [[#Parameters]]).

The function must be internal or public, and non-abstract, and must not play with generics.

Overloads are supported, so the same name can be defined multiple times with different parameters. The rules for this is similar to C#s overload resolution (but not identical). If in doubt, don't use fancy parameters.

Example:

<code><pre>
[Cg("ContainsKey", "Determines whether the dictionary contains the specified key with type is a string.")]
public bool ContainsKey([Cg("key", "Check with specific key")]string key)
{
return _dict.ContainsKey(key);
}
</pre></code>

A function may be static, but from inside cgscript it will be exposed as a member function.

== Object properties ==

Properties have almost the same requirements as methods.

Example:

<code><pre>
[Cg("Count", "Gets the number of key/value pairs contained in the dictionary.")]
public int Count
{
get { return _dict.Count; }
}
</pre></code>

The getter and setter may have different visibility, e.g. the getter may be public and the setter may be private. In that case, only the getter is accessible from CgScript.

However, note that this alternative marking of the getter/setter may not do what you expect:

<code><pre>
public int Count
{
[Cg("Count", "Gets the number of key/value pairs contained in the dictionary.")]
get { return _dict.Count; }
}
</pre></code>

This will register the getter as a function (ie. from cgscript you would have to call o.Count() instead of o.Count)

== Object indexer ==

Indexers are a special construction in C# (and VB). They look a little bit like both Properties and Methods. So the syntax for registering them in CgScript is a little special.

The indexer must be marked with a CgAttribute, and the getter/setter must be marked with a CgAttribute also, the name must be <code>get_Item/set_Item</code> respectively in order to use it as an indexer inside CgScript. Furthermore the setter must use the very special "param:" prefix on the CgAttribute to document the value.

Example:
<code><pre>
public IConstant this[[Cg("key", "The key used to lookup the value.")] string key]
{
[Cg("get_Item", "Get an item based on a key.")]
get { return _dict[key]; }
[Cg("set_Item", "Set an item based on a key and a value.")]
[param:Cg("value", "The value to set.")]
set { _dict[key] = value; }
}
</pre></code>

== Parameters ==

CgScript objects support a number of types, that are automatically converted when calling the function and returning from the function:

* Void (For return values only) - Constant.Empty is returned
* string - Automatically converted to and from a StringConstant
* double - Automatically converted to and from a NumberConstant
* int - Automatically converted to and from a NumberConstant
* bool - Automatically converted to and from a BooleanConstant
* CGDateTime - Automatically converted to and from a DateTimeConstant
* Any type that implement IConstant - No conversion is done

Example:
<code><pre>
[Cg("Add", "Adds the specified key and value to the dictionary with type of key is a string.")]
public bool Add([Cg("key", "Add with specific key")] string key,
[Cg("value", "Add with specific value")] IConstant constant)
</pre></code>

There are some special parameter types, that must all NOT be marked with a CgAttribute:

* <code>Interpreter</code> - If you require the interpreter to do something, you can get it by adding a Interpreter parameter. You are probably doing something wrong if you need this. If you do need it, then you should be aware that your object may be shared among several interpreters, and you should therefore NOT store the value anywhere.
* <code>IList<IConstant></code> - This is roughly equivalent to a normal C# method that takes a <code>"params object[]"</code>. This enables you to do advanced scenarios where the parameters from cgscript cannot be predicted. For obvious reasons there can be no other parameters marked with CgAttribute.
* other - If a parameter is not marked with a CgAttribute, it is presumed it is a IoC type that must be resolved when calling the function. This works for Constructors, Methods and Properties.

== Overload resolution ==

To find the right overload, a score is calculated.

A function that takes an <code>IList<IConstant></code> as parameter is always a match, but the lowest priority match.

A function that takes the exact type (or a type with a known conversion) will be a better match than a function that takes a very generic superclass. For example, a function x that has two overloads, one takes an IConstant and another that takes an ArrayConstant, when called with an ArrayConstant, the second overload takes precedence.

Due to the automapping some constructs may have the same overload. For example a function x that has two overloads, one takes an NumberConstant and another that takes an int. These are considered equivalent, and it is totally random which is called.

= Namespace =

Objects as such do not have a namespace, but we decided to simulate it by having namespace objects.

In the symbol table a variable called "Catglobe" is registered, this is an instance of GlobalNamespace.

If you want to add some global function, then implement another class in <code>CatGlobe.Framework.Runtime.Library.GlobalFunctions</code>. It must be a normal <code>CgScriptObject</code>. The class must have no member variables since the instance is shared among all interpreters, and only static getters/setters/methods (although if you forgot to mark them static they will still work).

You then register the class in the namespace you want it to appear. For instance here is the registration of Json in the GlobalNamespace:

<code><pre>
private static readonly JsonNamespace JsonNamespace = new JsonNamespace();
[Cg("Json", "The json namespace")]
public static JsonNamespace Json { get { return JsonNamespace; } }
</pre></code>

Now you can call the functions in this namespace:

<code><pre>
return Catglobe.Json.Parse(Catglobe.Json.Encode({1, ""Hejsa""}));
</pre></code>

And because they are objects, you can also do this:

<code><pre>
object n = Catglobe.Json;
return n.Parse(n.Encode({1, ""Hejsa""}));
</pre></code>

= Functions =

Normal non-object functions - Yet to be written

[[Category:Technical_guidelines]]

MediaWiki:Sidebar

2013-10-18T03:18:12Z

Wikicatglobe:

categorytree-portlet

MediaWiki:Sidebar

2013-10-18T03:18:00Z

Wikicatglobe:

categorytree-portlet
[[Category:Quick_start]]

MediaWiki:Sidebar

2013-10-18T03:17:17Z

Wikicatglobe:

categorytree-portlet
Category:Quick start

Update DCS frequency

2013-10-18T03:11:07Z

Wikicatglobe:

<accesscontrol>Main:MyGroup</accesscontrol>
== Introduction ==

This page is created to show how to build DCS frequently.

=== List of DCS ===

This table consists:
1. Dashboard/Monitor to which DCSs belong
2. DCSs need rebuilding
3. Rebuilding time
4. Axis need updating

{| border="1" class="VerticalTable"
|-
! style="background-color: rgb(244, 219, 165); text-align: center;" | Dashboard/Monitor
! style="background-color: rgb(244, 219, 165); text-align: center;" | DCS
! style="background-color: rgb(244, 219, 165); text-align: center;" | Building Time
! style="background-color: rgb(244, 219, 165); text-align: center;" | Updated Axis
|-
| style="text-align: left;" | Danske Bank Dashboad, ID 7
| style="text-align: left;" |
9006cat - CEM Bank Intelligence

9006cat - CEM Consumer 

| style="text-align: left;" | 1AM every Monday 
| style="text-align: left;" | N/A 
|- style="background: rgb(240, 240, 240) none repeat scroll 0% 0%; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial;"
| style="text-align: left;" | Jyske Bank Dashboard, ID 33
| style="text-align: left;" |
9006cat - CEM Bank Intelligence

9006cat - CEM Consumer 

| style="text-align: left;" | 1AM every Monday 
| style="text-align: left;" | N/A 
|-
| style="text-align: left;" | Danske Bank, CEM Score, ID ID 104
| style="text-align: left;" | 9006cat - Danske Bank 
| style="text-align: left;" | 1AM every Monday 
|- style="background: rgb(240, 240, 240) none repeat scroll 0% 0%; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial;"
| style="text-align: left;" | Pensam Bank, ID 98 
| style="text-align: left;" |
9006cat - CEM Bank Intelligence - PenSam Bank

9006cat - CEM Consumer 

| style="text-align: left;" | 1AM every Monday 
| style="text-align: left;" | N/A 
|-
| style="text-align: left;" | CEM Economy Landing Page, ID 123 
| style="text-align: left;" |
9006cat - CEM Economy Intelligence (Konjunktur)

 

 

| style="text-align: left;" | 1AM every Monday 
| style="text-align: left;" |
Quarters since Q1/1999 Quarters since Q1/1999 (Table) Quarters since Q3/2000 Quarters since Q3/2000 (Table) Quarters since Q4/2001 Quarters since Q4/2001 (Table) Quarters since Q4/2003 Quarters since Q4/2003 (Table) Quarters since Q3/2009 Quarters since Q3/2009 (Table) Quarters since Q4/2009 Quarters since Q4/2009 (Table)

Months since 10/2009 

|- style="background: rgb(240, 240, 240) none repeat scroll 0% 0%; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial;"
| style="text-align: left;" | CEM Economy Landing Page, ID 123 
| style="text-align: left;" | 9006cat - CEM Economy Intelligence (Konjunktur) (for exporting) 
| style="text-align: left;" | 1AM every Monday 
| style="text-align: left;" | Quarters Months 
|-
| style="text-align: left;" | CEM Economy Portal, ID 124 
| style="text-align: left;" | N/A 
| style="text-align: left;" | 1AM every Monday 
| style="text-align: left;" | N/A 
|- style="background: rgb(240, 240, 240) none repeat scroll 0% 0%; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial;"
| style="text-align: left;" | CEM Bank Monitor 
| style="text-align: left;" | 8386cat - CEM Bank Intelligence 
| style="text-align: left;" | 1AM every Monday (already being built for CEM Bank weekly task) 
| style="text-align: left;" | Uge 
|}

 

== Workflow ==
Two work flows are created on mycatinet site: http://mycatinet.catglobe.com 
1. "Update DCS Frequency - Part 1 - Build DCS" (Resource ID: 36443047) is automatically run as schedule time. 
2. "Update DCS Frequency - Part 2 - Update Axis" (Resource ID: 36443055) is run manually.

[[Category:Production_guidelines]]

Tracking configuration

2013-10-18T03:10:49Z

Wikicatglobe:

<accesscontrol>Main:MyGroup</accesscontrol>
== Introduction ==

=== Version ===

This documentation is updated in February 2009 for Catglobe version 5.6. Catglobe menus and commands are in English.

== Automated tracking ==

Catglobe offers a suite of best practices CG Scripts, which partners will be provided with upon request. Automated tracking is one of these scripts. The automated tracking CG script serves two main purposes:

*Automatically sending the optimal number of emails in order to reach the weekly target.
*Automatically direct the outgoing emails to specific target groups according to demands and continuously adjusted in accordance with the response.

Additionally, the system can be configured to send reminder emails to panelists who have not completed the survey within a certain time limit, if their quota is not closed.

=== Prerequisites ===

It is assumed that the reader is familiar with the general concepts of the Catglobe system, such as users, groups, rules, access rights, questionnaires, samples and quotas. Additionally, basic understanding of CG Script is required. This level of knowledge should be achieved with a Catglobe Data course I and II and some experience.

=== Requirements and limitations ===

The tracking should continue in one questionnaire for a certain (preferably long) period of time.

The tracking quotas used for targeting certain target groups must be based on weeks, must be labeled according to certain rules, and categorized into a maximum of 3 categories (see description below and appendix 2 - quotas).

The respondents must be existing users in the Catglobe system, and must be part of an existing panel with a questionnaire keeping information necessary for stratification (i.e. gender and age).

Group rules must be according to description in this document.

No guarantee is given regarding the scripts. Please contact Catglobe if any trouble is experienced. Functions included in the scripts are valid for the stated version of Catglobe.

== Preparing the CG Ssript for a project ==

=== The main parts of the script ===

The script consists of two main parts, as shown in the image below; part 1, which must be modified according to project specifications, and part 2, which is a standard script that should not be modified.
(some declarations)

<source lang="csharp">
//=======================================================
//PROJECT SPECIFIC CONSTANTS - BELOW THIS LINE ONLY =====
//=======================================================
(part 1 - project specifications)
//=======================================================
//PROJECT SPECIFIC CONSTANTS - ABOVE THIS LINE ONLY =====
//=======================================================
(part 2 - standard script)

</source>

In part 1 of the script, the following information must be filled in:

<source lang="csharp">
STEP 1. Choose test mode (test = true) or real mode (test = false)
STEP 2. Add receipients for status email
STEP 3. Specify a factor for each day of the week (no mails = 0)
STEP 4. Keep quota time frames up-to-date
STEP 5. Categorize quotas (type 1-3) and specify quota labels
STEP 6. Specify rule id's for rules in group used by Bulk Mail
STEP 7. Specify rule lables (for the same rules)
STEP 8. Specify Bulk Mail id
STEP 9. Specify RPQ id for a dummy user in the questionnaire
SCRIPT EXTENSION FOR REMINDERS ------------------------------------
STEP R1. Choose if reminders should be sent (Additional groups required)
STEP R2. (if reminders) Specify reminder delay days (max 7 days)
STEP R3. (if reminders) Reminder day groups
STEP R4. (if reminders) Reminder Temporary group id
STEP R5. (if reminders) Specify rule id's for rules in group used by BulkMail
STEP R6. (if reminders) Reminder bulkmail-id
</source>

=== Step 1. Test mode or real mode ===

Use test mode (test = true) to test the script without actually rebuilding the group or sending any emails. Set test = false for real mode when the script has been tested.

Example:

<source lang="csharp">
//STEP 1. Choose test mode (test = true) or real mode (test = false)
bool test = true;
</source>

=== Step 2. Email recipients ===

Each time the script is being executed, an email will be sent to recipients specified here. There is no limitation to the number of recipients. For each recipient, email address and name should be added as shown in the example.

Example:

<source lang="csharp">
//STEP 2. Add receipients for status email
// (Each respondent will need: email_recipient[] and
email_recipient_alias[])
arrayAdd(email_recipient, "john.smith@company.example");
arrayAdd(email_recipient_alias,"John Smith");
arrayAdd(email_recipient, "one.more@company.example");
arrayAdd(email_recipient_alias,"One More");
</source>

=== Step 3. A factor for each weekday ===

For each day of the week, the total number of mails sent will be calculated as:

:'''Number of mails = factor x (week quota target - week quota current)'''

For example if the week target is 100 and 40 respondents have completed until now, and today’s factor is 1.5; a total of 1.5 x (100-40) = 90 emails will be sent.

All seven weekday variables must be specified. If no emails are to be sent for a certain day of the week, set the factor = 0 for that day.

Example:

<source lang="csharp">
//STEP 3. Specify a factor for each day of the week (no mails = 0)
number factor_monday = 0.8; // normal in this project = 0.8
number factor_tuesday = 1.0; // normal in this project = 1.0
number factor_wednesday = 1.2; // normal in this project = 1.2
number factor_thursday = 1.5; // normal in this project = 1.5
number factor_friday = 2.0; // normal in this project = 2.0
number factor_saturday = 3.0; // normal in this project = 3.0
number factor_sunday = 4.0; // normal in this project = 4.0
</source>

It is recommended to send out every day. In case a mail out will have to wait, for example for modifications in the questionnaire, just change the questionnaire status to closed/paused/open for test. Emails will only be sent if the questionnaire status is open.

Which factors to choose will depend on the quality of the panel, the survey penetration, and other local variables. As a main rule, the factor should increase gradually from day to day during the week.

=== Step 4. Quota time frames ===

If additional quotas are being used for stratification (see the quota section,) time frames must be specified.

A time frame has a start (time_frame_start) and an end (time_frame_end). The following rules must be complied with:

*The number of time_frame_start and the number of time_frame_end must be equal.
*For any time frame; time_frame_end <= time_frame_start
*Two different time frames must never overlap each other.

Example:
<source lang="csharp">
//STEP 4. Keep quota time frames up-to-date
arrayAdd(time_frame_start,200751);
arrayAdd(time_frame_end ,200802);
arrayAdd(time_frame_start,200803);
arrayAdd(time_frame_end ,200806);
arrayAdd(time_frame_start,200807);
arrayAdd(time_frame_end ,200810);
</source>

=== Step 5. Quota categorization and quota labels ===

One quota for each week must be created, and labeled according to the quota labeling convention
(appendix 2). These quotas controls the total number of emails being sent. (These quotas should not be
inserted in the script.)

When the only respondent requirement of a survey is the total number of interviews pr. week, no additional quotas will be needed. However, if we have more specific requirements, like i.e. 50/50 male/female, etc. additional quotas will be needed. The automated script supports stratification for up to 3 categories of additional quotas, for example gender, age group and geographical region.

If additional quotas (in addition to the week quota) are being used for stratification, these must follow the standard in appendix 2.

Additional quotas will not influence on the total number of emails.

Examples of quota categories are gender, age and geography. Typically one would have 2 gender quotas, a number of age quotas and / or geographic and/or other quotas.

For each quota, one arrayAdd() statement should be added as shown in the example below. The labels must match the last part of the quota labels exact.

<source lang="csharp">
//STEP 5. Categorize quotas (type 1-3) and specify quota labels
//project specific labels for quotas type 1
arrayAdd(quota_type_1_suffix,"Males");
arrayAdd(quota_type_1_suffix,"Females");
//project specific labels for quotas type 2
arrayAdd(quota_type_2_suffix,"Age 15-25");
arrayAdd(quota_type_2_suffix,"Age 26-39");
arrayAdd(quota_type_2_suffix,"Age 40-59");
arrayAdd(quota_type_2_suffix,"Age 60+");
//project specific names for quotas type 3
arrayAdd(quota_type_3_suffix,"Region 1");
arrayAdd(quota_type_3_suffix,"Region 2");
</source>

=== Step 6. Rule ids ===

A group for emails must be created.

If the only quotas are one pr. week, the group should consist of 1 rule only. This rule should include your normal sampling rules, and a usage variable: "Users who did not participate in the following questionnaire" (tracking questionnaire). If additional quotas are used, the number of rules is calculated by the following equation:

:'''Number of rules = type 1 quotas x type 2 quotas x type 3 quotas'''

In the example above, 2 x 4 x 2 = 16 rules is required. The following table show which rules should be created for the quotas in the example above.

{| class="VerticalTable" border="1"
|-
! style="background-color: rgb(244,219,165); text-align: center" | Rule #
! style="background-color: rgb(244,219,165); text-align: center" | Gender
! style="background-color: rgb(244,219,165); text-align: center" | Age
! style="background-color: rgb(244,219,165); text-align: center" | Geography
|-
| Rule 1 
| Males 
| 15-25 
| Region 1 
|-
| Rule 2 
| Males 
| 15-25 
| Region 2 
|-
| Rule 3 
| Males 
| 26-39 
| Region 1 
|-
| Rule 4 
| Males 
| 26-39 
| Region 2 
|-
| Rule 5 
| Males 
| 40-59 
| Region 1 
|-
| Rule 6 
| Males 
| 40-59 
| Region 2 
|-
| Rule 7 
| Males 
| 60+ 
| Region 1 
|-
| Rule 8 
| Males 
| 60+ 
| Region 2 
|-
| Rule 9 
| Females 
| 15-25 
| Region 1 
|-
| Rule 10 
| Females 
| 15-25 
| Region 2 
|-
| Rule 11 
| Females 
| 26-39 
| Region 1 
|-
| Rule 12 
| Females 
| 26-39 
| Region 2 
|-
| Rule 13 
| Females 
| 40-59 
| Region 1 
|-
| Rule 14 
| Females 
| 40-59 
| Region 2 
|-
| Rule 15 
| Females 
| 60+ 
| Region 1 
|-
| Rule 16 
| Females 
| 60+ 
| Region 2 
|}

The rules should be labeled so they are easy to recognize.

The script will need a rule id and a label for each rule.

The only way to make sure the system can figure out the relation between the quotas and the rules is if the rules are declared in a specific order. Therefore it is very important to declare the rules in the following order:

*All rules covering the first quota in quota type 1
**All rules also covering the first quota in quota type 2
***One rule for each quota in quota type 3, (in the same order the quota type 3 quotas is specified.)
**All rules covering the second quota in quota type 2
***One rule for each quota in quota type 3, (in the same order the quota type 3 quotas is specified.)
**Etc...
*All rules covering the second quota in quota type 1
**Etc...
*Etc...

The following example would be the correct declaration of rules for the example used above:

<source lang="csharp">
//STEP 6. Specify rule id's for rules in group used by Bulk Mail
//It is crucial that rules are added in correct order.
Follow instructions from Catglobe
arrayAdd(rule_id,2584170); // Males 15-25 Region 1
arrayAdd(rule_id,2584169); // Males 15-25 Region 2
arrayAdd(rule_id,2584168); // Males 26-39 Region 1
arrayAdd(rule_id,2584167); // Males 26-39 Region 2
arrayAdd(rule_id,2584174); // Males 40-59 Region 1
arrayAdd(rule_id,2584173); // Males 40-59 Region 2
arrayAdd(rule_id,2584172); // Males 60+ Region 1
arrayAdd(rule_id,2584171); // Males 60+ Region 2
arrayAdd(rule_id,2584178); // Females 15-25 Region 1
arrayAdd(rule_id,2584177); // Females 15-25 Region 2
arrayAdd(rule_id,2584176); // Females 26-39 Region 1
arrayAdd(rule_id,2584175); // Females 26-39 Region 2
arrayAdd(rule_id,2584182); // Females 40-59 Region 1
arrayAdd(rule_id,2584181); // Females 40-59 Region 2
arrayAdd(rule_id,2584180); // Females 60+ Region 1
arrayAdd(rule_id,2584179); // Females 60+ Region 2
</source>

=== Step 7. Rule Labels ===

For each rule id, one rule label should be specified. The order must be the same as the orders in the rule declaration above. These labels are being used in the status info email.

In the example above, the following rule labels would be appropriate:

<source lang="csharp">
//STEP 7. Specify rule lables (for the same rules)
arrayAdd(rule_label,"Males 15-25 Region 1");
arrayAdd(rule_label,"Males 15-25 Region 2");
arrayAdd(rule_label,"Males 26-39 Region 1");
arrayAdd(rule_label,"Males 26-39 Region 2");
arrayAdd(rule_label,"Males 40-59 Region 1");
arrayAdd(rule_label,"Males 40-59 Region 2");
arrayAdd(rule_label,"Males 60+ Region 1");
arrayAdd(rule_label,"Males 60+ Region 2");
arrayAdd(rule_label,"Females 15-25 Region 1");
arrayAdd(rule_label,"Females 15-25 Region 2");
arrayAdd(rule_label,"Females 26-39 Region 1");
arrayAdd(rule_label,"Females 26-39 Region 2");
arrayAdd(rule_label,"Females 40-59 Region 1");
arrayAdd(rule_label,"Females 40-59 Region 2");
arrayAdd(rule_label,"Females 60+ Region 1");
arrayAdd(rule_label,"Females 60+ Region 2");
</source>

=== Step 8. Bulk mail id ===

In the communicator tab of the tracking questionnaire, a bulk mail must be prepared with a link to the
tracking questionnaire. Choose the group to send to. It is crucial that the group is put in the field: Groups
to be rebuilt.

[[Image:Tracking configuration - Prepare CGS - Bulkmail.jpg]]

Insert the bulk mail id like this:

<source lang="csharp">
//STEP 8. Specify Bulk Mail id
number bulkmailid = 393621;
</source>

=== Step 9. RPQ Id for dummy user ===

The script must be executed in the context of a RPQ (Questionnaire answer sheet). Thus a dummy user should be sampled to the questionnaire. Get the RPQ Id for this user either by performing an export, or get it by batch executing a small CG script.

:{| class="VerticalTable" border="1"
|-
! style="background-color: rgb(153,153,255);" | [[Image:Catinet logo.gif]]
! style="background-color: rgb(153,153,255);" | CATINÉT NOTICE: A user has been created on mycatinet for this purpose. Add the user with username ‘Automated_mailout’ to the questionnaire and get the RPQ id of this user.
|}

Example:
<source lang="csharp">
//STEP 9. Specify RPQ id for a dummy user in the questionnaire
number neededRPQId = 621758923;
</source>

=== Step 10. Multiple countries in one PQ ===

In this case, ''Multiple countries in one PQ'' means each country is running as an independent survey with its own quotas.

Each country will also have its own workflow.

Example 1 (Not using this feature):
<source lang="csharp">
//STEP 10.
bool useCountryId = false;
string country = "";
</source>

Example 2 (Using the feature multiple countries in one PQ):
<source lang="csharp">
//STEP 10.
bool useCountryId = true;
string country = "DK";
</source>

:{| class="VerticalTable" border="1"
|-
! style="background-color: rgb(153,153,255);" | [[Image:Catinet logo.gif]]
! style="background-color: rgb(153,153,255);" | CATINÉT NOTICE: This feature was added in 2009, and many of the older workflows do not have this capability.
|}

==== Multiple countries impact on quotas ====

When one questionnaire holds quotas for multiple countries. The country information must be included in all quota names.

In these cases, the naming convention will be different, (see appendix about quotas.)

== Scheduling the script ==

For each tracking questionnaire, a workflow must be created. (Tools -> Administration -> Work flow). When the CG script is ready, it should be pasted into the Script tab of the workflow.

Always test the script by setting test = true. (Remember to set test = false after testing.)

When the script is ready and tested, schedule it for daily execution. In the workflow list, highlight the workflow, choose ''schedule'', choose ''Re-occurrence build'', set Interval = 1 day, set an appropriate time for first time and last time.

[[Image:Tracking configuration - Schedule CGS 1.jpg]]

When the script is scheduled, it will be displayed in the "Scheduled CatTask" list. (In the current version, you will only be able to see CatTasks you have created yourself.

[[Image:Tracking configuration - Schedule CGS 2.jpg]]

== Appendix 1 - Week system ==

The script supports the European week system (ISO 8601)

*The week with the year’s first Thursday in it, is week 01.
*The first day of a week is always a Monday.
*A week always consist of 7 days.

To make sure the same week system is used in the questionnaire, it is recommended to insert a dummy question of type number labeled YEARWEEK in the questionnaire, with the following CG script:

<source lang="csharp">
array dateTime = getDateTime();
number year_ = convertToNumber(dateTime[0]);
number month_ = convertToNumber(dateTime[1]);
number week_ = convertToNumber(dateTime[7]);
number wyear;
number YWnumber;

if(week_ > 51 && month_ == 1){
wyear = year_ -1;
}
else if(week_ == 1 && month_ == 12){
wyear = year_ +1;
}
else wyear = year_;

YWnumber = (wyear * 100) + week_;
YEARWEEK = YWnumber;
</source>

A solution for tracking weeks starting on any weekday has been requested, but this is not yet supported.

== Appendix 2 - Quotas ==

=== The PQ is configured for one country ===

All quotas to be part of the automated tracking must be based on weeks. At least one quota must exist for each week, labeled [YYYYWW], for example 200810, 200811, etc. See also Appendix 1: Week system.

Up to 3 categories of additional quotas are allowed. These must be based on weeks (one or multiple weeks), all additional quotas must follow the same time frame scheme, and the quotas must be labeled according to specifications below.

These additional quotas must be labeled [YYYY WW - YYYY WW: [free text]].

Quota examples:

*200801
*2008 01 - 2008 04: Males
*2008 01 - 2008 04: Females
*2008 01 - 2008 04: Age 15-25

One group must be created according to specifications below.

The sum of target for quotas in one category must be equal to or more than the sum of the week quotas for the same interval of weeks.

==== Example: ====

Assume the following week quotas have been defined:

{| class="VerticalTable" border="1"
|-
! style="background-color: rgb(244,219,165); text-align: center" | Quota label
! style="background-color: rgb(244,219,165); text-align: center" | Quota target
|-
| 200801
| 100
|-
| 200802
| 100
|-
| 200803
| 100
|-
| 200804
| 100
|}

Also assume that other quotas are based on 4 weeks. The following targets will be allowed.

{| class="VerticalTable" border="1"
|-
! style="background-color: rgb(244,219,165); text-align: center" | Quota label
! style="background-color: rgb(244,219,165); text-align: center" | Quota target
|-
| 2008 01 - 2008 04: Males
| 200
|-
| 2008 01 - 2008 04: Females
| 200
|}

The following targets will also be allowed. These targets will never be reached, but it is a useful method to allow a little deviation from the perfect target.

{| class="VerticalTable" border="1"
|-
! style="background-color: rgb(244,219,165); text-align: center" | Quota label
! style="background-color: rgb(244,219,165); text-align: center" | Quota target
|-
| 2008 01 - 2008 04: Males
| 220
|-
| 2008 01 - 2008 04: Females
| 230
|}

The following targets will '''not''' be allowed. In this case the sum of the sub targets are less than the main target.

{| class="VerticalTable" border="1"
|-
! style="background-color: rgb(244,219,165); text-align: center" | Quota label
! style="background-color: rgb(244,219,165); text-align: center" | Quota target
|-
| 2008 01 - 2008 04: Males
| 190
|-
| 2008 01 - 2008 04: Females
| 190
|}

Remember, the week quota target is the quota used to calculate the total number of emails to send. Other quotas are used for targeting specific target groups.

100% of the respondents must be included in each quota category.

=== The PQ is configured for multiple countries ===

The same general rules applies as for single countries PQ, but with the following modifications:

If the PQ is configured for multiple countries, the country identifier (assigned to the variable ''country'' in the workflow) should be appended at the end of the quota name.

==== Example: ====

If the above example was part of a multiple country survey, the multiple conotry configuration of the script would look like below for Denmark.

<source lang="csharp">
//STEP 10.
bool useCountryId = true;
string country = "DK";
</source>

In that case, the quota names from the example above, would be like:

{| class="VerticalTable" border="1"
|-
! style="background-color: rgb(244,219,165); text-align: center" | Quota label
! style="background-color: rgb(244,219,165); text-align: center" | Quota target
|-
| 200801 DK
| 100
|-
| 200802 DK
| 100
|-
| 200803 DK
| 100
|-
| 200804 DK
| 100
|}

{| class="VerticalTable" border="1"
|-
! style="background-color: rgb(244,219,165); text-align: center" | Quota label
! style="background-color: rgb(244,219,165); text-align: center" | Quota target
|-
| 2008 01 - 2008 04 DK: Males
| 200
|-
| 2008 01 - 2008 04 DK: Females
| 200
|}

[[category:Production guidelines]]

Tracking projects

2013-10-18T03:10:34Z

Wikicatglobe:

<accesscontrol>Main:MyGroup</accesscontrol>
== Introduction ==
This page will display all the tracking projects and the deadline for the data deliveries.

=== Demo ===
<table cellspacing="1" cellpadding="10" bordercolor="#000000" border="1">

<tr height="18" bgcolor="#CCCCCC" bordercolordark="#000000">
<td height="18" width="86">'''Project Name'''</td>
<td width="255">'''Delivery'''</td>
<td width="529">'''Quota'''</td>
</tr>
<tr height="17">
<td height="17">8653ins</td>
<td>The first week in every month, not strict</td>
<td>Have to have 75 completed every week, but the other quota can have plus/minus some..</td>
</tr>
<tr height="17">
<td height="17"> </td>
<td> </td>
<td> </td>
</tr>
</table>

[[category:Production guidelines]]

Retrieve data from top-1000-company site

2013-10-18T03:09:41Z

Wikicatglobe:

<accesscontrol>Main:MyGroup</accesscontrol>
== Introduction ==

This Solution is used to retrieve data from site http://top1000.dk/ and then import to Catglobe system

 

== Solution ==

We have

*Server Path: \catproc\Share\CatGlobe Teams\Production\Top 1000\
*Use Tool Top1000dk.exe to get raw data from http://top1000.dk/ site from server path
*Customize data, import to Excel file
*Run Macro (get Macro source code from from server path 
*

=== Step 1 - Generate files by Internal Tool ===

*Run Top1000dk.exe Tool, input index of page. Generate all pages. Note: run only one instance of this tool at a time.

[[Image:Top1000Tool 1.png]] 

*Go to your local C:\ to get exported files

 

=== Step 2 - Customize raw data ===

*Merge all files we get from step1 to one file
*Replace character "~" as "$$" and "|" as "$" (the purpose is separating into columns when importing these files to Excel)

 

[[Image:Customize Data.png]]

 

*Save file as txt format

 

=== Step 2 - Import to Excel ===

*Open Excel application -> select Data tab -> Get External data -> From Text
*Browse the txt file we get from step2
*Follow step 1: Choose Delimited option

 

[[Image:Import step 1.png]]

 

*Follow step 2: Unselect "Tab" option, Select "Other" option = @

 

[[Image:Import step 2.png]]

 

=== Step 3 - Customize Excel data ===

Because of limitation of the original site http://top1000.dk/, we encounter some problems with Unicode and long names which are displayed as "..."

*Open file "Unicode name" from server path to get list of incorrect names and replacements.
*Replace all incorrect unicode character in file we get from Step2 by correct ones. Tips: we use IFERROR and VLOOKUP functions

[[Image:Vlookup function.png]]

*Similarly, replace three-dot companies from the file 3-dot companies. We get the list of replacements of three-dot companies from file "3-dot companies"

 

=== Step 3 - Run Macro ===

*Get Macro source code from server path
*Orderly run these functions:

- Run Macro "top1000One" - Run Macro "top1000Two" - Run Macro "top1000Three" - Run Macro "top1000Four" 

=== Step 4 - ===

Test your work, compare to original site http://top1000.dk/da/top1000/1/rank/ASC

[[Category:Production_guidelines]]

Questionnaire Specification

2013-10-18T03:09:07Z

Wikicatglobe:

<accesscontrol>Main:MyGroup</accesscontrol>
=Introduction=
This specification contains some basic rules that we need to follow when creating a questionnaire specification in order to get it done as fast as possible.
= Content =

==Important features==

*Label
*Type
*Text
**In each language
*Answer options
**Value & Text
**Semi open answer option value
**Min/Max value
**Randomize?
**Rotate?
**No multi
*Sub questions
**Rotate?
**Randomize?
*Conditions
**Show if
**Go to question if
**Exclude answer options if
**Exclude answer option from
**Include answer option if
**Include answer option from
**Exclude sub question if
**Include sub question if
*Is scripted? special action need to be taken
*Points
*RPQ Status
*Others (anything not mentioned in the previous parts)

== Format ==

1. English command is a must

2. Different colors should be used to distinguish between what to be shown in the questionnaire and notes/commands to the questionnaire creator

3. Horizontal lines should be used to separate different parts of a question

4. Question text should be written in plain text, in case HTML is required, please state it clearly

5. Sub question should be indexed from 0 (like what is shown in questionnaire editor)

6. Answer options should be indexed from 1 (if no special values are written, indexes will be used as values)

7. Sub questions and answer options could be described in list format or table (whatever can be achieved fast from the original description sent by the end-client)

Order of attributes:

1. Question label and question type

2. Conditions/validation/scripts/status/points

3. Question text4. Sub questions5. Answer options

6. The exact way that the question should look (if it is expected to look different from what generated by the system)

'''Examples:''' [[Image:Samples.jpg]] [[Image:Sample 2.jpg]] [[Image:Sample 3.jpg]] [[Image:Sample 4.jpg]] 

 Here is a sample document: [[Media:Reduceret_sp%C3%B8rgeskema_finale_catin%C3%A9t_to_Vietnam_version_1_March_-_UPDATED.doc|sample]]

[[Category:Production_guidelines]]