Home

Colectica User Manual

1. Figure 14 The Manage Languages dialog window Change the Active Metadata Language You can change which metadata language Colectica displays in its forms e Choose the language from the dropdown list in Languages section of the ribbon s Study tab 20 Colectica Import p lands r Create New Checkout Create Items Source Figure 15 Language controls on the ribbon All text fields will automatically switch to display text in the selected language Text fields that do not contain text for the currently specified language will appear blank View all Translations of a Text Field Colectica can show you a preview of the different translations of a text field e Hover the mouse cursor over the language button to show a tooltip previewing translations of the text field Were there any additional people staying here April 1 2010 that you did not include sq A ka pasur ndonj person tjet r shtes q q ndronte k tu n dat n 1 prill 2010 g nuk e keni es Hab a personas adicionales quedandose aqu el 1 de abril de 2010 que usted no incluy en la SW Je kulikuwa na mtu yeyote wa zaidi aliyekuwa akiishi hapa mnamo tarehe 1 Aprili 2010 ambaye fr Y avait il d autres personnes qui r sidaient cet endroit au 1er avril 2010 que vous n avez pas incluses de Wohnten noch weitere Personen hier am 1 April 2010 die Siein Frage 1 nichtber cksichtigt haben zh CHS IETTER SICEEBHSBJALISA E S
2. Figure 46 The Categories ribbon tab 3 Edit the values and hierarchy as desired 49 Chapter 9 Design Questionnaires Inside this chapter e Create and Manage Survey Questions e Create and Manage Reusable Sequences e Create and Manage Survey Instruments e Design a Survey Instrument e Analyze a Survey Instrument e Generate a Paper Questionnaire e Generate Survey Instrument Source Code Create and Manage Survey Questions Colectica lets you create questions that can appear in one or more surveys Add and Remove Questions For instructions on how to add collections of questions to your project see Create New Items in a Metadata Package on page 35 Once you have navigated to a question set you can add remove and edit questions To add a question e To add a question simply begin typing the name or question text in the Questions List To remove a question e To remove a concept right click the question and choose Remove Item from the question s context menu e Alternatively you can select the item and press the Delete key on your keyboard Mavigator t Advanced Qi Series SYSEL xogjoaL n Question Text gt f Studies d Q1 How many people were living or staying in this house apartment or mobile home aol a SJ Resource Packages i i Were there any additional people staying here April 1 2010 that you did not include S United States Census 2010 3 Is this house apartment or mobile home
3. Save Items To save the items you are editing simply choose the Save button on the Colectica ribbon or on the quick access toolbar Local languages Figure 21 The Save button on the ribbon and on the Quick Access Toolbar Specify your Agency All items managed by Colectica have an authoritative agency identified by an agency identifier This agency is responsible for keeping the official representation of a project study or any other managed item You may register for an agency identifier with the DDI Alliance at http registry ddialliance org If you prefer to delegate your own authoritative agency or if you do not know your agency identifier you can make one up or use your existing domain name View Revision Information When working with a repository Colectica automatically tracks all revisions that you and others synchronize with the repository In Colectica Designer you can view the full revision history of any item 24 ji Project Project z History ll Midlife in the United States Midlife in the United States Agency midus wisc edu Revision 86 E Remote History Y Last Updated 2013 02 06 05 04 Sb jeremy 2 6 2013 11 04 56 AM Create a Series to describe the overall MIDUS study Citation External Materials 85 jeremy 1 9 2013 3 51 41 PM Fix M12P2 variable groups M Title Midlife in the United States en US 84 jeremy 1 9 2013 3 48 06 PM Subtitle en Us 83 jeremy 12 2 2012 6 41 44 AM Fix encading i
4. Editor Figure 25 A project s citation editor 28 Title DDI The full authoritative title Sub Title DDI Secondary or explanatory title Alternate Title DDI An alternative title by which a study is commonly referred or an abbreviation for the title Creator DDI Person corporate body or agency responsible for the substantive and intellectual content of the described object Publisher DDI Person or organization responsible for making the resource available in its present form Contributor DDI The name of a contributing author or creator who worked in support of the primary creator given above Publication Date DDI The date of publication Identifier DDI ISBN ISSN or similar designator Copyright DDI The copyright statement Add items to a Project Once you have a project open you can add items to the project To add a study to the project e Inthe Navigator right click the Studies node and choose Add Study Add New Study m Example d ik Series By Resource oy Add Existing Study United Stat Import Studies from Delimited File a5 Local Items d s midus colectica org eg localhost Figure 26 The Add New Study context menu in the Navigator Alternatively you can use the Project s contextual ribbon to add a new study 29 e Click the Add Study button on the ribbon Colectica Designer Example Colectica Import Help Commands es gt f 3 QF v B E Add Add
5. count that person Otherwise he or she may be missed in the census E 5 gt O2 lt Name Q2 Were there any additional people staying here April 1 2818 that you did not include in Question 1 ml b b b bbp ds ei un LO ca 1 gt Children such as newborn babies or foster children 2 Relatives such as adult children cousins or in laws 3 Monrelatives such as roommates or live in baby sitters 4 People staying here temporarily 5 No additional people b Put E Oo S g ea 03 Name Q3 aon i Ch Ch Ln n un amp n n Un un n n in e un E 2 Is this house apartment or mobile home 3 A 1 gt Owned by you or someone in this household with a mortgage or loan Include home equity loans 65 2 Qwned by you or someone in this household free and clear without a mortgage or loan 66 lt 3 gt Rented 67 4 gt Occupied without payment of rent 68 59 ea Figure 54 Generated source code 76 Chapter 10 Work with Data In this chapter e Create Reusable Variable Descriptions e Document Data Files e Compute Descriptive Statistics e Generate Statistical Command Files Colectica can document the data products produced by a study Data documentation consists of reusable variable descriptions dataset format descriptions and descriptive statistics Create Reusable Variable Descriptions The first step in documenting this data file is to describ
6. 59 Change Display Styles Design Basic Information E Toggle Display Style uo How many people were living or staying in this house apartment or mobile cD Were there any additional people staying here April 1 2010 that you did mot s Is this house apartment or mobile home CO What is your telephone number We may call if we don t understand an ans A o PersonCounter Q1 I Conditianal n n Li PersonCounter 2 1 Li Branch D How is this person related to Person 17 s Does Person PersonCounter sometimes live or stay somewhere else cD What is Person Person Counter s name D What is Person Person Counter s sex ad To change the visual style of the survey navigator click the Toggle Display Style button above the survey navigator Click the button again to change the styles back 60 Add and Edit Questions Add a Question method 1 faj Instrument Advanced 2010 Instrument Agency example org Revision 3 Last LJ T DRE uou ee E nm Li Data Collection b S Data Collections Design Basic Information fe Questions hc i r 2010 Questions lj Sequence CF L an ere liwi VI ews e Ric mene peepee ung i2 How many people were living or stayin i D Were there any additional people stayin i E Is this house apartment or mobile home i D What is your telephone number We m C Were there any additional peor o Is this house apartmen
7. Add Resource Update Publish Tag Gather Generate Generate Import Harmonization Generate Series Study Packager Item Referenced Items ODI 3 DOI 2 Sheet Documentation Add Repository Export Inport Documentation Figure 27 The Project s contextual ribbon Once your study is created its editor is displayed See the next section for details on this editor My Study Agency test colectica com Hevisian 3 Last Updated 2012 06 12 10 01 Description Funding Coverage Citation Data Collection Data Embargo Modules External Materials Resources extended General Information Title My Study Abstract en US Purpose 2 en US Universe d Editor Links DDI History Figure 28 The study editor You can also use the Add Series and Add Metadata Package buttons to add those types of items Series and Studies A Series represents a collection of Studies DDI 3 and Colectica allow you to describe both series and studies in rich detail This section describes the types of information you can use to describe your series and studies Most information applies to both series and studies with a few exceptions 1 ASeries can contain one or more Studies 2 ASeries can contain detailed information about the repeated nature of the series 3 AStudy can contain one or more Data Files Edit Series or Study Description To edit general information about a study choose the Description tab The Descript
8. Chapter 17 DDI 3 Helper Features In this chapter e View DDI 3 e XML View e Validate DDI 3 View DDI 3 All items in Colectica can be represented as DDI 3 To view the DDI 3 representation of an item click the DDI tab at the bottom of an item s editor United States Census 2010 Agercyexample org Aevisian3 Last Updated 2011 04 05 04 00 Eddi Fragment xmlns ddi ddi instance 3 1 xmlns r ddi reusable 3 1 gt A lt 51 5tudyUnit id l94dlzsSc 93bz 4378 bhbe6z6 zl 5edbdfb5s5l version 3 0 0 versionbate riCitation gt zr Title xml lang en US United States Census 40104 r iTitle gt zdc DCElementz dez title xml lang en UsS United States Census Z l docz title doz description xml lang sn UsS Inited States Census z l c dcez description z dc DbCElements r Litation zs bstract id alebbaae 5fea 4d 0l9 bdl 6 21lfc7471f44 E Content xml lang en UsS The U 5 Census counts every resident in the Unite z s bstract zr UniverzseBeference zr ID bzz 7d4l 9z2z3z 4d97 Sled 3fflfbllfSl38 z r ID zr IdentifyingAdgency example org z r Identifying qency zr Version l r Verzion z r UniverseBefearence zr SeriesStatement zr oeriesName uml Lang en US gt Unknowne r seriesName gt r SeriesStatement zr Fundingqlnformation zr eencwy rnganizationBeferencae zr ID 99f6fa3s9 hbcc3 4 752 93b7 93e456 7081406 z r ID zr lIdentifyingAdgency opendata colectica aorgz r IdentifyingAdgencey Targi nr 4
9. Checkout Name My Project Agency ID example org Figure 84 The Create New Checkout dialog 6 Colectica will create your checkout and it will open automatically Note Colectica does not automatically synchronize your checkout with the repository after it is initially created 106 Check out an Existing Item Checking out an item downloads the item and all its dependencies to your local system You can then edit the item and keep it synchronized with the remote repository Project Project Last Updated 2012 07 25 06 16 Ld Checkouts Advanced s Local Items s localhost 3 Instruments t Organizations Citation External Materials Universes M Variables Title United States Census 2010 Universes W Series D Studies S Resource Packages Alternate Title US Census Jj Projects United States Census 2010 58 Creator Census Bureau Organizations Subtitle Census Publisher Census Bureau Contributor Publication Date Figure 85 Browsing a remote repository To check out an item 1 Find an item using the Navigator 2 Select the item 3 Pressthe Checkout button in the ribbon The full contents of the item will be downloaded from the repository and the item will be added to your checkouts list Colectica will automatically activate and display the item Publish a Checkout When you want to send your local
10. Developer Workshop s instructors were instrumental in the creation of the DDI 3 Data Collection module and have over five years of DDI 3 software development experience Participants will draw on this knowledge and learn what works as well as what doesn t work when developing DDI 3 software The length of the workshop is three days but may be extended if participants desire more hands on development time The workshop covers the following topics The DDI 3 standard Functional overview for developers DDI 3 origins Relations to other standards DDI 3 serialization options Identification and versioning Tracking data not covered by DDI 3 Migrating existing data for use with a DDI 3 based application Interoperability with other standards Available tools Hands on development 126 Chapter 23 Services Colectica Maintenance Plans A Colectica Maintenance Plan helps you to protect your software investment Customers receive priority product support for a designated number of support contacts as well as all product upgrades that are released during the period of the maintenance contract Standard Maintenance Premier Maintenance Yes Yes inci 3 9 3 Upgrades Number of support incidents Number of customer contacts 1 Guaranteed response time 1 business day 2 business hours Invitation to participate in product planning No Yes Colectica Deployment If you prefer not to deploy the Colectica Repository or client application
11. Source Code This feature is only available in Colectica Designer Colectica is able to generate source code for several computer assisted interviewing systems Currently Colectica supports the following systems e Blaise e CASES e CSPro Please contact us if you would like Colectica to support additional systems To generate source code for your instrument 1 Usingthe Navigator navigate to your survey instrument 2 From the ribbon click the Generate Source Code button es Colectica Import Help Commands d BA lt ddi gt X Qu ie Add Duplicate Generate Remove Analyze Generate i Generate Generate Sequence Item DDI3 Instrument Paper Form Source Code Documentation Dataset Add Export Remove Instrument Documentation Dataset Figure 52 The Generate Source Code button In the Generate Source Code dialog choose the system for which you would like to generate source code and the disk location to which the source code should be written 75 CZ Generate Source Code Source Code Options CAI Language Blaise E Output Location Please choose the file where output will be written d ColecticaOutput EarlyPregnancy bla Figure 53 The Generate Source Code dialog box 4 Press the Generate button Colectica will generate your source code and open the location where the results are stored census q 23 48 If someone who has no permanent place to stay is staying 4l here on April 1 2818
12. and Repository Selection e Site wide Custom Field Configuration e Site wide Documentation Template Configuration Site wide Repository and Workflow Server Configuration The repositories and workflow servers to which Colectica Designer has access can be configured through the Colectica Designer user interface as described in Configure a Remote Repository page 105 You can also manually deploy repository and workflow server configuration files for a single user or for all users of a machine Configuring for all users To deploy a repository list for all users on a machine you can provide a repository list file in one of two locations By deploying these files for all your users you can provide site wide repository configuration eliminating the need for individual users to configure a repository The user will be prompted for a username and password when they attempt to connect to a repository Option 1 Server Type File Location Repository Sprogramdata s Algenta Colectica repositories conf Workflow Server Sprogramdata s Algenta Colectica workflowServers conf Option 2 Alternatively you can specify the location of repository list file in Colectica s configuration file The configuration file is located at Sprogramfiles Colectica Colectica Designer ColecticaDesigner exe config Include the full path of the repository list file in the setting specified below You can use a file on the local disk or on a network share Server T
13. classification schemes for your open ended data In cases where an appropriate standard exists we will use it For open ended data without a relevant standard we can create a classification that accurately encompasses your data In order to aid in the coding of your data we will provide your classification to you in DDI format Examples of classification schemes we have already transformed include the International Classification of Disease ICD 9 and ICD 10 and the North American Industry Classification System NAICS Open ended Coding Algenta can code your open ended data to a standardized classification We use text classification algorithms to speed coding along with manual double coding and review to ensure accuracy Data Documentation Algenta can prepare documentation for your analysis data sets in the form of fully searchable and easy to browse code books Your documentation will include variable descriptions links to original data source information cross references and summary statistics 128
14. copy of a project to the server use the Publish command 1 Select the checkout you wish to update 2 Enter a message and click the Next button This message will be recorded as part of the change log 107 Synchronize AEJ Commit Options Log Message I made some changes Cancel Previous Next 3 Colectica will send your items to the server la Smnchronize e amp J 93 Synchronization Complete Your items are now synchronized with the server 0 items updated from the server 0 items added locally since last synchronization 0 conflicted items 5 items committed to the server Click Finish to close the synchronization wizard Finish Update a Checkout When you want to pull changes from the server to your local copy you can update your checkout 1 Select the checkout you wish to update 2 Click the Update button on the Checkout ribbon The Synchronization Wizard will appear and will check for changes to your items 108 n CZ Synchronize e t x Update Colectica is updating your items from the server wa E to Updating Finding working set 3 If any changes are found on the remote repository that you have not yet downloaded the wizard will show you the changes 4 If any conflicts are present resolve the conflicts see Resolve Conflicts below View Changes While viewing incoming changes you can view what has changed comp
15. custom field definitions Configuration location for all users To deploy a custom field configuration for all users on a machine deploy an XML configuration file documented below in Sprogramdata s Algenta Colectica CustomFields Colectica will look for any XML files in the directory and will inspect them for custom field definitions Configuration file format The custom field configuration file is a simple XML format The quickest way to create the configuration file is to use Colectica Express or Colectica Designer to create custom fields and then copy the contents of the default custom field configuration file The location of this file is 115 Yappdata Algenta Colectica CustomFields xml A sample file may look like this lt xml version 1 0 encoding utf 8 lt CustomFieldDefinitionList gt lt CustomFieldDefinition DefinedTypeld f0b69d49 9596 40b6 a3fa e99d6ad6065b ItemType 30ea0200 7121 4F01 8d21 a931a182b86d ValueType String gt lt Title lang en US gt CustomFieldTitle lt Title gt lt Description lang en US gt Description of the custom field lt Description gt lt CustomFieldDefinition gt lt CustomFieldDefinition DefinedTypeId f964a067 5716 4cd4 a498 fd74c1c781f8 ItemTypez 683889c6 f74b 4d5e 92ed 908c0a42bb2d ValueType MultilingualString gt lt Title lang en US gt SecondCustomField lt Title gt lt Description lang en US gt Another custom field lt Description gt lt CustomFi
16. fp jg Cars TH Fa i W Series d e Datasets lli Studies d 3 Resource Packages T 4 BI Cars IJ j Datasets Figure 12 The Navigator displaying only a single study gj Resource Packages k 8 Resource Packages P jj Commute 4 m Example b a Local Items zp midus colectica org P uw localhost Figure 11 The Navigator with all items displayed Work with Text e Manage Multiple Languages e Specify Text for Multiple Audiences e Spell Checking 19 Manage Multiple Languages Most text fields in Colectica Designer allow you to enter text in multiple languages The active language is identified by the language button found on the right side of a text box SS LL Figure 13 A multi lingual text field Choose Available Metadata Languages 1 From the main menu choose Manage Languages 2 Inthe dialog window that appears move languages to and from the Project Languages list move languages either by selecting the language and clicking the appropriate arrow button or by clicking and dragging a language from one list to the other Manage Metadata Lanquages Available Cultures Project Cultures Afrikaans South Africa FI Afrikaans Albanian Chinese Traditional Albanian Albania English United States Alsatian France French Amharic Ethiopia Spanish Arabic Arabic Algeria Arabic Bahrain Arabic Egypt Arabic Iraq Arabic Jordan Arabic Kuwait Arabic Lebanon Arabic Libya p
17. list of concepts 38 Edit a Concept To edit a concept 1 Usethe Navigator to navigate to the concept set you would like to edit 2 Usethe concept list to edit a concept s name label or description Alternatively select a concept and use the Concept view to edit a concept s details The Concept view allows you to edit several elements D Concept Mother Agency example org Hevision O Last Updated 2010 07 23 09 52 Concept synonyms Mapping Relationship external Materials Extended Name Mother en US Label Description Figure 39 The Concepts view Name A name for the concept Label A display label for the concept Description The definition of the concept Synonyms Synonyms are different words that are also used to represent the concept To add a synonym type a word into an empty row of the synonym list To remove a synonym select the row by clicking the rows header and press the delete key on your keyboard Mappings The External Mappings section allows you to map a concept to one or more resources identified by a URL 39 T rip A d est Mother Agency example org Revision O Lost Updated 2010 07 23 09 52 Concept Synonyms Mappings Relationships External Materials Extended http umbel org umbel Po ntrvmemvdorgoe6nswnwno SSCS http en wikipedia org wiki Colectica currently supports the following mappings e OpenCyc e
18. new universe will be created rfl gt universe i Advanced B Search Female Liaoning immigrants Agency example org Revision 1 il B Last Updated 2012 07 09 12 50 T m Testi ih Series General External Materials Extended studies Mame en US B Label Female Liaoning immigrants en Ls jjConceptual k 7 Concepts Description T fa Universes T ist China Study Concepts Te Tedre Liaoning immigrants Female Liaoning immigrants k iy Organizations Organizations Colectica allows you to describe the organizations involved with a study For instructions on how to add collections of organizations to your project see Create New Items ina Metadata Package on page 35 Once you have navigated to an organization set you can add remove and edit organization descriptions 42 e To add an organization simply begin typing the name or description of your new organization in the Organizations List To remove an organization e To remove an organization right click the organization and choose Remove Item from the organization s context menu e Alternatively you can select the item and press the Delete key on your keyboard Edit an Organization To edit a organization 3 Use the Navigator to navigate to the organization set you would like to edit 4 Usethe organization list to edit an organization s name or description Alternatively select an organization and use the Organ
19. ribbon with the Import DDI 2 button 2 The Import wizard will open Click the Choose input files button to select one or more file you wish to import If you select multiple files they will be merged into a single Colectica study Click the Next button F CZ Import Wizard eJ amp Import Wizard To get started choose the file s you would like to import Choose input files Clear file s D work mexico study ddi2 xml Figure 64 DDI 2 import file selection page 92 3 Colectica will read the DDI 2 files and attempt to discover their language If you wish to override the language do so using the ISO language column Click the Next button Import Wizard DDI2 Options Please choose the language of your DDI files DAworkymexico study ddi2 xml Figure 65 DDI 2 language selection page Colectica will read your files and show you a summary of the imported contents Click the Next button C Import Wizard Import Wizard Colectica will import the following items Variable Code Set 49 3 Category Set Resource Package 3 1 Figure 66 DDI 2 import summary page 93 5 Click the Finish button 6 Colectica will import your data Depending on the size of the DDI 2 files this may take a few minutes Import from Spreadsheets or Delimited Files Colectica can import the following types of existing metadata that you may have in spreadsheets or in delimit
20. way on your public web site Text fields that support definitions for multiple audiences have an Audience button as shown below 22 Abstract The U S Census counts every resident in the United States and is required by the Constitution to take place every 10 years Ja v en US Figure 18 The Audience button in a text field Click the Audience button to open the Multi Audience editor To add an audience click the Add text for a new audience button A new text box is added where you can edit the name of the audience and the text for that audience The U S Census counts every resident in the United States and is required by the Constitution to take place every 10 years External Audience A different abstract can be described for a different audience Add text for a new audience Figure 19 The Multi Audience text editor for a single text field Spell Checking For English language text Colectica Designer automatically provides spell checking 23 Abstract The U S Census counts evry resident in the United States and is required by teh Constitution to take place every 10 years 2 Figure 20 Automatic spell checking in a text field Correct a Misspelled Word You can correct a misspelling either by manually changing the text or by using a suggestion from the spell checker e To correct a misspelled word with a suggestion right click the word Choose the appropriate suggestion from the context menu
21. you for completing t Q Add a Until Loop X Remove To add a question or another type of item within a branch right click the branch and select the type of item you would like to add Alternatively you can drag and drop a question or section into the branch 68 Add Additional Branches Basic Information H Main Section CH How many people were living or su Were there any additional peopl CD Is this house apartment or mob D What is your telephone number o PersonCounter Q1 ii Conditional E 2 How is this person related to T PersonCount S m B Remov Li Branch Tegl k 2 Does Person PersonCounter CO What is Person PersonCoun Sel k 2 What is Person Person oun mo CH What is Person Person Coun zm CH Is Person PersonCounter of D What is Person PersonCoun 2 Thank you for completing the 20 To add an extra conditional branch right click the main Conditional item and choose Add Branch 69 Add and Edit Loops It is often useful to repeat a certain set of questions multiple times in a survey Colectica supports three different types of loops e While Loop repeat a section as long as specified condition remains true e Until Loop repeat a section until a specified condition becomes true e For Loop similar to a While loop but also allows you to specify initialization code Add a Lo
22. you paste the above path into Windows Explorer it will expand to something like C ProgramData Algenta Colectica Templates Colectica automatically installs a template named Sample for you You can copy the Sample directory to make your own template The name of the directory is the name that will be displayed in the Generate Documentation dialog when selecting a template Template Files Within each template directory is one or more text files that define the template Description Master txt The overall layout of the documentation in HTML format Includes the opening and closing lt html gt and lt body gt tags Helpers txt Includes a number of reusable helper methods that can be used in any of the files below CategoryScheme txt Each of these files provides a template for the item CodeScheme txt type indicated by the file s name Concept txt ConceptScheme txt ControlConstructScheme txt DataCollection txt DataRelationship txt Ddilnstance txt Group txt 86 Instrument txt MultipleResponseVariableGroup txt Organization txt OrganizationScheme txt Physicallnstance txt Question txt QuestionScheme txt ResourcePackage txt StudyUnit txt Universe txt UniverseScheme txt Variable txt VariableGroup txt VariableScheme txt VariableStatistic txt Questionnaire txt The template used for a Survey Instrument s Generate Paper Form command These files override the default template that Colectica uses when no custo
23. 5 Is Inclusive Figure 40 The Universe view Name A name for the universe Label A display label for the universe Description A human readable description of the universe Hierarchical Universe Definitions Universes can be arranged hierarchically For example the Liaoning immigrants universes might have a sub universe for Female Liaoning immigrants To add a sub universes e Inthe Navigator right click the universe under which you would like to create the sub universe In the context menu choose Add Universe Add New Universe 41 Universe EL Advanced x Liaoning immigrants Agency example org Revisioni Last Updated 2012 07 09 12 45 E li Tes General External Materials Extended k 4 Series ae a TEES Resource Packages bi 3 Label Liaoning immigrants en Us dB Mainly immigrants from North China who settled in rural Liaoning Conceptual T L P during the early eighteenth century and their descendants Ja b Concepts Description E a Universes X Is Inclusi China Study Concepts s Inclusive G Liaoning immigrants k i Organizations b Ll Classifications U Duplkate HE Add Existing Universe b L Data Collection Qa Update Import Universes from Delimited File ji Data Ge Publish b Ll Modules D gt Check Out Item Tag Item sd Generate DDI3 X Remove Generate Documentation Figure 41 Adding a sub universe e Your
24. ALGENTA TECHNOLOGIES Colectica User Manual For Colectica 4 1 GE colectica Updated Wednesday February 27 2013 Copyright 2013 Algenta Technologies All rights reserved Contents Part MOJU CUON TOR Re 4 Chapter 1 Managing Projects with Colectica cssccssssssecsosssscosssscsecsssectenssscneusssensoussestenssscnenes 5 Chapter 2 Th Colecica PIStEOLImi uoi ves ide ne Eesti bote Wee co EH pub AS e HG ead ere Wena 8 Part2 Colectica Desktop Application S ad iex oe Eidos n reu Deb Po E Ud ure ueri Mer So aero Pub Ea o Nav iaene 10 Chapter 3 astall abl Tames mre eee te se ae ne ate bte Sete UD MI EE ne EE LS DU Rer siot E 11 Chapter 4 Gerne Aed stu A epe PIDE I DM III ODE D NELLO EDLDU 16 Chapter 5 Credte Projects qst dodeen had tin vi Dade REX PE Cod geni use p edes mana uv bcunto do spl adii a n Do Cd 27 Chapter 6 Projects Series Studies and Metadata Packages ccccccssesccssssccssssceeeceseeeceeeneseeeeeees 28 Chapter 7 Conceptual Inftortalt OT a esce Eee xu UU E EEG rU vpn UD NE I V Pr OVIUM 38 Chapter 8 Manage Classica ons odes dE e ee oc ea stie ecu UE M EE NEUE 45 Chapter 9 DOCSIS iy OQUestollialkes stetur ce betae rot etat t eae ac b aset cute bb e OPE e pads 50 Chapter 10 Work wth Di asns ro ce eerta aae ext ee b err Ee Vo er uade Ru ne ba eva da o p ees 77 Chapter di Annotations and Custom Fields sese uere feit veut ud espe dub tulte to eue deg E pr
25. Click questions or other elements to see the details for that item 57 Zoom in on a Section Basic Information H Sequence i D How many people were living or stayin i D Were there any additional people stayin D Is this house apartment or mobile home E What is your telephone number We o PersonCounter Q1 g h Conditional CH How is this person related to Person DB Does Person Person Counter somet D What is Person Person Counter s n PD What is Person PersonCounter s sex 25 What is Person PersonCounter s a LD Is Person PersonCounter of Hispan What is Person Person Counter s ra If your survey contains many sections it may be useful to look at just part of it To limit the survey navigation to a particular section select the section and click the re root button on the right The survey navigator will show that item as the top item 58 Go Back to the Top Level Basic Information a me Eg Restore root items P Conditional Loi C5 How is this person related to Person 1 se Does Person PersonCounter sometime u What is Person PersonCounter s name cD What is Person Person Counter s sex uo What is Person Person Counter s age a CD Is Person PersonCounter of Hispanic L u What is Person PersonCounter s race To go back to viewing the entire instrument click the Restore Root Items button above the survey navigator
26. CustomFields and OtherMaterials to the documentation Adds a list of OtherMaterials to the documentation Adds Coverage information to the documentation Coverage can be found in StudyUnits Series DataCollection and elsewhere Method Description AddHeaderWithImage item Adds a header for the item and includes the item type s image in the header AddHeader header Adds a header to the documentation IncreaseHeaderLevel Increases the header level of any subsequent headers This should generally be called after AddHeader so any subsequent headers are written as children of the last header This helps create a document hierarchy DecreaseHeaderLevel Decreases the current header level A call to this should match every ncreaseHeaderLevel call IncreaselndentLevel Increases the indent level of any subsequent text DecreaselndentLevel Decreases the indent level of any subsequent text Custom Styles with CSS To adjust the style of your documentation you can include custom Cascading Style Sheets CSS files CSS is the standard way to provide styles on the Web The first step Colectica takes when generating your documentation is to create an HTML document by processing your template The HTML documentation can use all features of CSS After HTML documentation is generated it is converted to PDF and RTF if desired These formats use a subset of the information in your CSS files The CSS properties used fo
27. GUBR ATE 2010 4H 1 REE EZE Figure 16 A tooltip showing translation previews 21 You can view the full text of all available translations e Click the language button to the right of a text field to view the translation window English United States Were there any additional people staying here April 1 2010 that you did not include in Question 17 Albanian Aka pasur ndonj person tjet r shtes q q ndronte k tu n dat n 1 prill 2010 q nuk e keni p rfshir n Pyetjen 177 spanish Habia personas adicionales quedandose aqui el 1 de abril de 2010 que usted no incluy en la Pregunta 17 Kiswahili Je kulikuwa na mtu yeyote wa zaidi aliyekuwa akiishi hapa mnamo tarehe 1 Aprili 2010 ambaye hukumjumuisha katika Swali la 17 French Y avait il d autres personnes qui r sidaient cet endroit au 1er avril 2010 que vous n avez pas incluses ala question 1 7 German Wohnten noch weitere Personen hier am 1 April 2010 die Siein Frage 1 nichtber cksichtigt haben Chinese Simplified Legacy ical AGG fRESEUREMBAGqE20103FAH 1 BEE Chinese Traditional Chinese Simplified Pd Figure 17 The translation window for a single text field Specify Text for Multiple Audiences Many text fields allow you to specify different text for different audiences For example you may wish to describe your study one way to internal staff members and a different
28. KB XML Document Libraries E XML Document L Documents 2 Music is Pictures B Videos mexico study ddi2 xml m wj Homegroup jE Computer amp Local Disk C ca Local Disk D cx Local Disk Q Filename census2010 ddi3 xml Save as type XML Files xml X Hide Folders Figure 81 The Save As dialog 3 Colectica will create your file 103 Chapter 15 Search In this chapter e Search for Items Search for Items Colectica allows you to search for items located in a repository To search for items enter some text in the Navigator s search area Checkouts j Tk US Census d a5 Local Items Figure 82 The search area in the Navigator Colectica will search your repositories and display the results in the results list States r Ll Checkouts 4 Local Items T _ Codes US State Codes T J Categories US States Select an item from the results list and Colectica will display the contents of the item 104 Chapter 16 Synchronize with a Remote Repository Synchronizing with a remote repository is only available in Colectica Designer In this chapter e Overview e Configure a Remote Repository e Create a New Checkout e Check out an Existing Item e Publish a Checkout e Update a Checkout e Taga Checkout Overview Colectica Designer includes a built in repository that allows you to work with your projects on your local com
29. Mote This serialization is a concise bounded description same metadata elements may only be included by reference Editor Links DDI History Validate DDI 3 Colectica can perform both first level and second level validation against your DDI files This feature allows you to make sure your DDI is able to be used with other tools First Level Validation e Validate DDI files against the DDI 3 1 schema 111 Second Level Validation Identification e Identification o Detect identifiable items without an assigned identifier o Detect lack of an agency identifier at the top level instance o Detect duplicated identifiers within a single maintainable o Detect invalid DDI URNs o Detect maintainable items without a specified agency identifier e Referencing o Detect references that point to non existent objects o Detect references without an identifier specified o Detect ambiguous references o Detect references that do not specify agency identifiers o Detect references that do not specify version numbers e Versioning o Detect versionable items without assigned versions Validate a DDI File To validate a DDI file 1 From the File menu choose the Validate a DDI 3 file command 2 Inthe File Open dialog that appears select a file 3 Colectica will perform the validation and display the results 112 Chapter 18 Administration In this chapter e Site wide Repository and Workflow Server Configuration e Agency Identifiers
30. S States Ageng Revision 1 Last Updated 2012 08 07 03 26 5 Search Label Description Arizona Arkansas Colorado Connecticut Delaware California Agency example org Revisioni Last Updated 2012 08 07 03 26 California en Ls Description Represents Missing Values Editor Figure 43 The Category view Display Label 46 DDI A display label for the category Description DDI Description or definition of the category Name DDI A name for the category Missing DDI Indicates if the category represents missing data Code Lists For instructions on how to add code lists to your project see Create New Items in a Metadata Package on page 35 Once you have navigated to a code list you can add remove and edit codes Add and Remove Codes To add a code you must choose an existing category list that contains the category to which the code s value will correspond 1 From the Commands ribbon tab click the Add a Category Set or Add Individual Categories button c IE 7 S55 se X Colectica Designer Colectica Import Help Commands wy ee Y v e aw vo v y y A Update Publish Check Out Tag Generate Remove Add a Add Individual Duplicate Generate Item Item DDI 3 Category Set Categories Item Documentation Repository Export Remove Codes Add Documentation Figure 44 The Add Categories button 2 Usethe Item Finder dialog to locate the category scheme or category to add to your code list 3 Select th
31. Study Package Item DDI3 DDI 2 Sheet Documentation Add Export Remove Import Documentation Figure 57 The Generate Documentation button on the Ribbon After clicking the Generate Documentation button the Generate Documentation dialog will appear This dialog lets you set some options for your documentation General Options You can specify the title and subtitle as well as custom header and footer text to be included in your documentation In the Output Location field select the directory where the output should be written E Generate Documentation GER General Formats Output Options Title Car Analysid Subtitle Header Text Footer Text August 27 2012 Output Location Please choose the location where the documentation should be written dXColecticaDutput mm Figure 58 The Generate Documentation dialog Formats 117 E Generate Documentation 7x1 Genera Formats PDF HTML RTF Template Override the default template C ProgramData Algenta Colectica Templates Sample L Generate Cancel Figure 59 The Formats tab of the Generate Documentation dialog You can generate documentation in the following formats e PDF Portable Document Format This can be opened by a number of free applications e HTML Hypertext Markup Language This is the format commonly used on the Web e RTF Rich Text Format This can be opened by Microsoft Word or other word p
32. Umbel e DBPedia e WordNet 2 0 e Wikipedia Relationships The relationships section allows you to relate a concept to other concepts The following relationship types are supported e Subclass of e Superclass of e Type of Universes A universe describes the population being studied For instructions on how to add collections of universes to your project see Create New Items in a Metadata Package on page 35 Once you have navigated to a universe set you can add remove and edit universe descriptions e To add a universe simply begin typing the name or label of your new universe in the Universes List To remove a universe e To remove a universe right click the universe and choose Remove Item from the universe s context menu 40 e Alternatively you can select the item and press the Delete key on your keyboard Edit a Universe To edit a universe 1 Use the Navigator to navigate to the universe set you would like to edit 2 Usethe universe list to edit a universe s name label or description Alternatively select a universe and use the Universe view to edit a universe s details The Universe view allows you to edit several elements Liaoning immigrants Agency example or General External Materials Extended Label Liaoning immigrants en US Mainly immigrants from North China who settled in rural Liaoning M during the early eighteenth century and their descendants Ja Description en Ls
33. ame What is Person PersonCounter s sex D What is Person PersonCounter s age and what is Person PersonCounter s date D Is Person PersonCounter of Hispanic Latino or Spanish origin What is Person PersonCounter s race D Does Person PersonCounter sometimes live or stay somewhere else D How is this person related to Person 1 You will be prompted to find a question to add to your survey After selecting a question it will be added to your survey 62 View Question Details Design Basic Information Pa Agencyexample org Hevision 4 Last Updated 2012 10 16 09 09 LI Sequence Tog ts Q2 P How many people were living oF Were there any additional people staying here April 1 2010 that you D Were there any additional p gt did not include in Question 1 CD Is this house apartment or mob z 1 Children such as newborn babies or foster children LD What is your telephone number 2 Relatives such as adult children cousins or in laws o PersonCounter Q1 3 Nonrelatives such as roommates or live in baby sitters 4 People staying here temporarily 5 No additional people B Conditional T PersonCaounter 2 1 T Branch LD How is this person related to 25 Does Person PersonCounter What is Person PersonCoun CD What is Person PersonCoun CO What is Person PersonCoun 25 Is Person PersonCounter of 25 What is Per
34. and Female A code associates a value with a category The value is often numeric but could be any string A code list allows a collection of codes to be specified in either a flat or hierarchical manner Multiple code schemes may be associated with the same category scheme For example one code scheme might assign values to the gender category scheme as follows Value Category Another code scheme might assign different values to the same categories Value Category When creating a classification scheme for use in a survey the general process is 1 Create a category list 2 Create a code list based off the category list Category Lists For instructions on how to add category lists to your project see Create New Items in a Metadata Package on page 35 Once you have navigated to a category list you can add remove and edit categories To add a category 45 e To add a category simply begin typing the name or label of your new category in the Category List To remove a category e To remove a category right click the category and choose Remove Item from the category s context menu e Alternatively you can select the item and press the Delete key on your keyboard Edit a Category To edit a category 1 Usethe navigator to navigate to the category list you would like to edit 2 Usethe category list to edit a category s label and description The category list view allows you to edit several elements U
35. ared to your own copy 1 Right click an item 2 Choose the Show Differences command from the context menu Colectica will show the Difference Viewer window outlining what changes have been made Resolve Conflicts If you have made changes to items that somebody else has already made changes to and committed to the remote repository those items will be in conflict If conflicts are present the synchronization wizard will display the items that are in a conflicted state To view the difference between your version and the remote repository s version follow the instructions in the View Changes section above To resolve a conflict 1 Right click a conflicted item 2 Choose either the Use Mine or Replace with latest from server menu item depending on whether you want to use your copy or the remote copy Tag a Checkout A specific version of a checkout can be tagged with a user defined state Tags can be used to implement organizational workflows or business process models Examples of states might include Development Test or Production To tag a checkout 109 1 Select the checkout in the Checkouts View 2 Press the Tag Item button on the ribbon 3 Inthe Tag dialog enter the tag and press OK The tag will be assigned to the item CC Colectica EX Please choose a tag for this version Production OK Cancel Figure 86 The Tag dialog allows you to tag a checkout with a specific tag or state 110
36. as invited experts on the DDI Technical Implementation Committee where they help solve issues and add functionality to the DDI standard 120 Chapter 20 ISO IEC 11179 Colectica Repository is designed based on principles from the ISO IEC 11179 standard ISO IEC 11179 formally known as the ISO IEC 11179 Metadata Registry MDR standard is an international standard for representing metadata for an organization in a Metadata Registry Today organizations often want to exchange data quickly and precisely between computer systems using enterprise application integration technologies Completed transactions are also often transferred to separate data warehouse and business rules systems with structures designed to support data for analysis The industry de facto standard model for data integration platforms is the Common Warehouse Model CWM Data integration is often also solved as a data rather than a metadata problem with the use of so called master data ISO IEC 11179 claims that it is a standard for metadata driven exchange of data in an heterogeneous environment based on exact definitions of data ISO IEC 11179 2010 March 31 In Wikipedia The Free Encyclopedia Retrieved 04 26 May 7 2010 from http en wikipedia org w index php Ptitle ISO IEC_ 11179 amp 01ldid 353216241 121 Part 4 Additional Resources Chapter 21 Colectica Training Repository Centric Data Management The Repository Centric Data Management course is d
37. ation and frequencies To generate descriptive statistics 1 Navigate to a data file 2 Click the Calculate Summary Statistics button on the ribbon Colectica Import Help Commands so X E a dB G Le 3 Add Generate Remove Generate Open Dataset Calculate Summary Generate Variable DDI 3 Documentation File Statistics Source Code Add Export Remove Documentation Dataset source Code 80 Generate Statistical Command Files Colectica Designer can automatically generate statistical command files consisting of variable definitions and labels Supported statistical languages include e R e SAS e SPSS e Stata To generate statistical command files 1 Navigate to a data file 2 Click the Generate Source Code button on the ribbon Colectica Import Help Commands X E dB adi Add Generate Remove Generate Open Dataset Calculate Summary Generate Variable DDI3 Documentation File Statistics Source Code Add Export Remove Documentation Dataset Source Code 3 Choose the language for which you would like to generate source code and the location where you would like your source code stored c Generate Source Code Source Code Options CAI Language SAS Output Location Please choose the file where output will be written Generate Cancel 4 Press Generate Your source code will be created 81 Chapter 11 Annotations and Custom Fields In this chapter e Overview of A
38. ation Set Add Existing Concept Set 92010 Que tU Add Question Set Figure 35 Adding an item to a metadata package using the navigator e Inthe dialog window that follows enter a name for your new collection of concepts Create Scheme mS Enter a name for the new scheme Figure 36 The Create Item dialog box 36 Add Existing Items to a Metadata Package To add an existing item to a metadata package 1 Usethe same ribbon buttons or context menu items as above but select the Add Existing item r 7 Choose a Concept Set es 4 Census Concepts m B Checkout us TEEN NEST MD SEC E NON POSEN a 1 j United States Census 2010 4 gt 3 United States Census 20107 gt Local Items 5p colecticatest Cancel e Figure 37 The Item Finder dialog being used to search for concept collections 2 Usethe Item Finder dialog to locate the collection of concepts you wish to add to your study 3 Select the item and click the Select button Alternatively you can also simply drag an item from one part of the navigator onto a metadata package and the item will be added to the metadata package Remove Items from a Metadata Package To remove an item from a metadata package right click the item and choose the Remove item 37 Chapter 7 Conceptual Information In this chapter e Concepts e Universes e Organizations Concepts Concepts describe the basic
39. b fj Conceptual a j Classifications Data Callection gt H Data Collections What is your telephone number We may call if we don t understand an answer ie Questi Q2 Agency opendata colectica org Revision 32 Last Updated 2011 04 05 04 02 Y Questions 2010 Questions r Question Instructions External Aids Conceptual External Materials Extended zB Sequences gt E Instruments Question Name Li Data Li Module Question Text Were there any additional people staying here April 1 2010 that you did not include in Question 1 Editor Figure 47 The question list Edit a Question To edit a Question 1 Use the Navigator to navigate to the question set you would like to edit 2 Usethe Question list to edit a Question s name and question text Alternatively select a Question and use the Question view to edit the details of the Question The Question view allows you to edit several elements 51 Q2 Agency opendata colectica org Revision 32 Last Updated 2011 04 05 04 02 Question Instructions External Aids Conceptual External Materials Extended Question Name Q2 Question Text Were there any additional people staying here April 1 2010 that you did not include in Question 17 Response Options Add Response Type Coded Classification Response Label Response Description Selection Style Select one v Searc
40. ble time date currency etc Analysis Unit The entity to which the data refer for example individuals families or households groups institutions organizations administrative units etc 79 Measurement Unit Records the measurement unit for example km miles etc Response Unit Provides information regarding who provided the information contained within the variable e g respondent proxy interviewer Concept A reference to the concept measured by this variable Universes Reference to any universe definition that describe the population about which the variable has data Source Questions Reference any questions used to collect data for this variable Source Variables Reference to any variables used to construct this variable Document Data Files The easiest way to get documentation for your existing data files is to import your data file For instructions on how to import data files see Import SPSS and Stata Files page 100 If you want to document a data file that you don t have access to you can create a description of the file by manually adding a Data File item to a Metadata Package For instructions on how to accomplish this see Create New Items in a Metadata Package on page 35 Compute Descriptive Statistics Colectica can generate descriptive statistics and store this summary information directly in the open standards based metadata Supported statistics include mean minimum maximum standard devi
41. click the Send button CC Submit Feedback Contact Information Please provide contact information if you would like a response If you do not require a response you may leave these fields blank Name John Doe Email johndoe example com Subject Some feedback Message Hello Optional Information Include log file View Include system configuration information View Figure 23 The Send Feedback window Don t be shy about sharing your feedback We appreciate hearing from you Include System Information with your Feedback Colectica allows you to include certain system information and log files in your feedback message These may be useful in helping the Colectica developers diagnose any problems you may experience e To include log files and system information check the Include log file or Include system configuration information checkboxes as desired e To view the information that is to be sent click the View link next to the corresponding item 26 Chapter 5 Create Projects In this chapter e Overview e Create a New Project in Colectica Express e Create a New Project in Colectica Designer e Create a New Study Overview A Colectica project contains one or more series one or more studies and one or more metadata packages Create a New Project in Colectica Express To create a new project in Colectica Express choose the New File button on the Colectica ribbon Your project will be created
42. design you can choose from several ways to actually collect data with your survey you can generate paper questionnaires web forms or source code for difference Computer Assisted Interviewing CAI systems Add and Remove Survey Instruments For instructions on how to add survey instruments see Create New Items in a Metadata Package on page 35 Open a Survey Instrument Navigate to a Survey Instrument Advanced r United States Census 2010 uir Series J Studies E Resource Packages J United States Census 2010 Li Conceptual jj Classifications 4j Data Collection Data Collections fe Questions lt Sequences Instruments s 2010 Instrument Li Data n Modules 55 First use the Navigator to find your survey instrument 56 Explore a Survey Select an Item 2010 Instrument Agency example org Hevision 3 Last Updated 2011 04 05 04 04 Design Basic Information Hu rj t Question Activity Agency example org Last Updated 2011 04 05 04 04 ui Sequence Last Updated 2011 04 05 04 04 gt How many people were li s Q1 CO Were there any additional pe HOW many people were living or staying in this house w apartment or mobile home on April 1 2010 CD Is this house apartment or SP What is your telephone mum ii ber of people b C PersonCounter Q1 Links DDI History The survey instrument view will show you a tree representing the flow of your survey
43. e 2010 Census T CO What is Person PersonCoun 25 What is Person PersonCoun CD Is Person PersonCounter of CO What is Person PersonCoun E Estimated Time Select a statement to edit its details 64 Add a new Section Sections are useful for organizing parts of a larger survey into smaller more easily manageable groups Sections are also useful for reusing common parts in multiple surveys Add a new Section 2010 Instrument Agency example org Revision 3 Last Updated 2011 04 05 04 04 Design Basic Information E Fi uum d Sequence Agency example org Aevi Last Updated 2011 04 05 04 04 W Sequence CD How mamy G Adda Question Sequence Order CD Were then O anii Dena Adda 3tement 25 Is this si NS 2 What is y Q Personcoi InOrderOf Appearance Add Custom Cade Adda Conditional Add a For Loop Add a While Loop GGG235 Add a Until Laop Right click the location where you would like to add a section and click Add a new Sequence Edit a Section Details Hu oom Main Section gency example org Aevisior t Up d 2011 04 05 04 04 im amp imn r5 a d ME A LHI How many people were living or l CD Were there any additional peopl iia spaces er o Is this house apartment or mob CO What is your telephone number Description T o PersonCounter Q1 i i Conditional T PersonCounter 1 T Branch InOrderOfAppea
44. e commands you need to complete a task Commands are organized under tabs To reduce clutter some tabs are shown only when needed c di Colectica Designer Colectica Import Help Commands Metadata Language English United States Source Language Neutral m Manage La Save Create New Checkout Local Languages Source Create Items Figure 7 The ribbon as it appears in Colectica Designer Minimize the Ribbon 1 Click up arrow on the right side of the ribbon Example ommands Source Language Neutral X Create New Checkout Source Create Items 2 To use the ribbon while it is minimized click the tab you wish to use This will temporarily expand the ribbon tab and allow you to access its commands e 7 Colectica Designer xample Colectica Import Commands Figure 8 The ribbon while minimized Restore the Ribbon 1 Click the down arrow on the right side of the minimized ribbon xampie Help Commands Ribbon Tabs The Colectica tab holds commands that allow you to save items create new items and specify the currently displayed metadata and source code languages e dd Colectica Designer xample Colectica Import Help Commands Metadata Language English United States Source Language Neutral J Manage laa M Create New Checkout Local Languages Source Create Items The Import tab contains commands to import data from various sources e l Colectica Designer Co
45. e item and click the Add button To remove a code e Toremove a code right click the code and choose Remove Item from the context menu 47 Edit a Code Scheme s Values and Hierarchy State US Codes Agency example org Revision 9 eee ale Ma Fe NE View ODI AL Alabama AK Alaska Arizona AR Arkansas ra A California o Colorado Connecticut Lr rn Delaware ra District of Columbia TI r Florida D Georgia H i Hawaii Figure 45 A code scheme To edit a code value Use the text box next to a category label to assign the appropriate code To edit a code schemes hierarchy y Right click the code that you wish to move 2 From the context menu choose Move up Move down Move left or Move right as appropriate Generate a Code List from a Category List The fastest way to create code schemes is to enter a category list and then to automatically create a code list based on the category list 1 Locate your category list using the Navigator 2 Inthe Commands ribbon tab click the Create Corresponding Code Scheme button Colecticas will automatically create a code scheme and assign default values for each category 48 Commands cs 3 X i Duplicate Update Publish Check Out Tag Generate Remove Create Corresponding Generate File S Category Item Kem litem DDI3 Code Scheme Documentation Add Repository Export Remove ategories Documentation
46. e its columns In Colectica each column is described by a Variable item Variable descriptions include labels and descriptions the variable s data type its concept its universe and any source questions upon which the data is based If the same type of information is contained in multiple datasets the same Variable item can be used for columns in each dataset Reusing variable definitions like this makes it simple to find comparable data Add and Remove Variables For instructions on how to add collections of variables to your project see Create New Items in a Metadata Package on page 35 Once you have navigated to a variable set you can add remove and edit variables To add a variable e To add a variable simply begin typing the name or label of your new variable in the Variables List To remove a variable e To remove a variable right click the variable and choose Remove Item from the variable s context menu e Alternatively you can select the item and press the Delete key on your keyboard 77 t SSI Variables Agency example org E Last Updated 2010 07 17 10 27 Variables Groups Label Description Identifier State of residence of recipient This field indicates the state of residence oi Year of birth af recipient The field YOE is battomcoded at 1912 that Sex of recipient Primary diagnosis of recipient The primary diagnosis far recipients aged 6 Date of eligibility This field identifies the first year in which tl P
47. e of 0 to 4 294 967 295 or a signed range of 2 147 483 648 to 2 147 483 647 e Short An integer of up to 16 bits in size corresponding to an unsigned range of 0 to 65 535 or a signed range of 32 768 to 432 767 e Decimal Areal number allows fractions expressed as decimals e Float Real numbers that may be stored in scientific notation example 20 0005 99 9 5000 12 6 02e23 e Double Float of up to 32 bits e Count Ordinal number of objects in a finite set discrete A simple incrementing Integer type e Incremental A value that is continuous and infinite can be interval or ratio Additivity the type of additivity e Stock e Flow e NonAdditive Minimum the minimum number allowed in order for the data to be considered valid Maximum the maximum number allowed in order for the data to be considered valid Scale the unit of scale for example 1000 if the actual data should be multiplied by 1000 to calculate the true value of the data Date Time Domains Type the type of date or time that should be provided e Date and Time e Date e Time e Year e Month e Day e Month and Day e Year and Month e Duration e Timespan Code Domains 53 Selection Style indicates how many codes may be selected e Select one e Select all that apply e Select upto enter a number indicating the maximum number of choices that may be selected Code Scheme the code scheme containing the response options Multiple Respo
48. ectica users the information they need to use Colectica effectively The course provides training for both the Colectica Designer and for Colectica Portal The two day course covers the following topics e Introduction to Colectica e Configuring repository access e Using a repository for collaboration and version control e Documenting concepts and general study design e Designing data collection instruments e Analyzing instruments e Generating source code for Computer Assisted Interviewing CAI systems e Importing visualizing and analyzing existing CAl source code e Documenting data products e Publishing documentation to repositories accessible within an organization or worldwide e Indepth walkthrough using Colectica to manage a study chosen by your organization Colectica Administrator Training Course The Colectica Administrator Training Course is designed to give system administrators the information they need to deploy configure and manage the Colectica Repository and the Colectica Designer The half day add on to the Colectica End User Training Course covers the following topics e Deploying the Colectica Repository e Configuring the Colectica Repository e Deploying the Colectica Repository s dependencies e Maintaining the repository s database e Deploying Colectica Designer e Configuring Colectica Designer for repository access e Security considerations e Deploying the Colectica Repository using a resolution se
49. ed text files e Concepts e Universes e Organizations e Categories e Questions e Variables The following steps show how to import variables from a delimited file the steps for other types are similar 1 Navigate to the variable set to which you would like to add the imported variables 2 From the Add Variables dropdown menu on the ribbon choose Import from Delimited File The Import Wizard will appear e ES d Add Variable Duplicate Update Group Item Add New Variable Add Existing Variable 3 Choose the type of delimiter and indicate whether the first row of your file has headers Choose the file you would like to import Click the Next button 94 4 Import Wizard Import Wizard Choose the import source E First row has headers Select the file with the data to import Colectica will provide a list of the columns found in your file In the first column of the list indicate which metadata field to which each of your file s columns should be mapped Click the Next button c Import Wizard Import Wizard Describe how columns will be mapped Label Description RepresentationType Mame Variablel Label Varie 1 bel Row 2 Variable2 Column Row 1 Variable 2 label Description This variable is a numeric type This variable is a text type Type Numeric Text 95 5 Colectica will summarize the items to be imported Click the Finish button to add the items to your p
50. egi Colectica Import Help Metadata Language English United States Il Manage Mew Open Save File File Languages Figure 24 The New File button on the Colectica ribbon Create a New Checkout in Colectica Designer In Colectica Designer a checkout is an item or set of items that can be published to a repository See Synchronize with a Remote Repository Overview page 105 for details on managing checkouts with Colectica Designer To create a new project as a checkout 1 From the Colectica ribbon tab choose Create New Checkout 2 Inthe Create New Checkout dialog choose Project as the type of item you would like to create and enter a name for the project 3 Colectica will create your checkout and it will open automatically Note Colectica does not automatically synchronize your checkout with the repository after it is initially created 27 Chapter 6 Projects Series Studies and Metadata Packages In this chapter e Projects e Series and Studies e Metadata Packages Projects A Project is a high level item that can contain one or more Series Studies or Metadata Packages Edit a Project s Citation Besides containing the items described above a project also has its own citation Citation External Materials Subtitle en U5 Alternate Title en Ls Creator en U5 Publisher en US Contributor en U5 Publication Date Select a date Identifier en Ls Copyright
51. eldDefinition gt lt CustomFieldDefinitionList gt Valid values for ValueType are String MultilingualString and Uri Site wide Documentation Template Configuration Colectica allows users to select a custom template when generating documentation The template specifies the look and layout of the generated documentation The files should be a plain HTML file and may include references to stylesheets and resources Site wide Documentation Template Deployment To deploy HTML templates for all users on a machine you can place template folders in one of two locations Option 1 programdata NAlgentaNColecticaNTemplates Option 2 Alternatively you can specify the location of directory containing your templates in Colectica s configuration file The configuration file is located at wo O programfiles NColecticaNColectica Designer ColecticaDesigner exe config Include the full path of the directory containing your template files in the Html TemplateDirectory setting You can use a path on the local disk or on a network share HTML Template Format See Colectica can generate documentation for any item Your documentation can be made in PDF HTML or Rich Text format To generate documentation for an item click the Generate Documentation button on the ribbon 116 Colectica Import Help Commands a di E Ee ddi lt ddi gt x d Add Add Resource Duplicate Generate Generate Remove Import Harmonization Generate nie
52. es the displayed nodes in case any changes have been made that are not reflected in the navigator The text next to the buttons indicates the current navigation mode Click the button to open a dropdown menu that lets you choose a different navigation mode Navigation Modes By default Colectica shows the Advanced mode which displays all information contained in your projects To limit the types of information that are shown click the mode button to choose a different option 18 Advanced Study Different modes will filter which types of information are displayed as you browse and search the navigator For Conceptual example the Classifications mode will only show category Data Collection and code lists Data er e D atasets J Resource Packages b E Resource Packages Figure 10 A dropdown menu showing the available navigation modes Search To search for items in the navigator enter text in the search box and press Enter The contents of the navigator will be filtered by the search text The search results will only contain items of a type displayed by the current navigation mode Drill Down To show only items under a specific item select the item and click the Drill Down button on the right side of the item To return to the default view click the Restore Root Items button on the Navigator s toolbar E EMT Jj aru Advanced PF Search 1 Jj Checkouts Cars pa
53. esigned to give participants an introduction to metadata repositories and how they can be used to manage an organization s data The focus is on how using a repository based approach to data management can enable data to be shared and reused by researchers in order to maximize the research value of data Throughout the course instructors will discuss and demonstrate how the Colectica platform implements the concepts being described This course offers an opportunity for those evaluating the Colectica platform to determine how it may integrate with their existing systems and workflows The two day course covers the following topics Obstacles to rigorous data based research e Barriers to discovering the right data and knowing how to use the data e Barriers to reproducing data based research e Barriers to data comparability Removing these obstacles with a well structured repository Documenting the full data life cycle e Study concept and design e Data collection o Sample design o Instrument design e Data processing e Data archiving e Data repurposing documenting the process of analysis Metadata publication Metadata versioning e How repositories can enable automatic revision control e Solving identification problems Requirements for Enhanced Publications e Research data e Related materials e Post publication annotations 123 Colectica End User Training Course The Colectica End User Training Course is designed to give new Col
54. files Please choose how each language will be imported Default English United States QuestionText English United States D escription English United States Instructions English United States Figure 69 Blaise language selection page 97 4 Colectica will read your files and show you a summary of the imported contents Click the Next button r CZ Import Wizard amp JL t9 jr eS j Import Wizard Colectica will import the following items Question Code Set 1 Resource Package 76 16 Category Set Question Set 16 14 Cancel Finish Figure 70 Survey instrument import summary 5 Click the Finish button 6 Colectica will import your data Depending on the size of your instrument this may take a few minutes Import CASES Survey Instruments This feature is only available in Colectica Designer Colectica can import CASES survey instruments CASES is a product of the Computer assisted Survey Methods program at the University of California Berkeley You can import a CASES instrument using the Import Wizard 1 Click the Import CASES button from the Import ribbon tab Colectica Import ddi ddi ddi ZI Import DDI Import Import Import I 3 Fragment DDI3 DDI2 Blaise CASES SPSS Stata DDI Survey Instrum Data Figure 71 The Import ribbon with the Import CASES button 2 The Import wizard will open Click the Choose input files button to
55. h for an item Additional People Codes x E Blank values represent missing values Remove this response type Editor Links DDI History Figure 48 The Question view Name A name for the question Question Text The text of the question presented in the survey instrument Response Options The Response Options section determines the type domain of data collected by a question A question may have one or more response domains To add a Response Domain 1 Click the Add Response Domain button and select Text Numeric Date Time or Code as appropriate 2 Fillin the details of the response domain Every type of response domain allows you to enter a Label and Description Text Domains Minimum Length the smallest number of characters allowed for the data to be valid Maximum Length the largest number of characters allowed for the data to be valid Regular Expression A regular expression that must be matched for the data to be valid This allows you to specify requirements such as email addresses or telephone numbers Numeric Domains 52 DDI Type the data type of the number in which the data should be stored e Biginteger An integer of unlimited size e Integer An integer number can hold a whole number but no fraction Integers may be either signed allowing negative values or unsigned nonnegative values only e Long An integer of up to 32 bits in size corresponding to an unsigned rang
56. hich the repository is responsible These agency identifiers are automatically available for selection in Colectica Designer When synchronizing an item with a particular agency identifier Colectica Designer will determine which repository is authoritative for the agency and will synchronize with that repository Site Wide Default Language By default Colectica will use the operating system s language as the default metadata language You can specify a different default language for your users by creating a plain text file in the following location Sprogramdata NAlgentaNColecticaNdefaultLanguage txt The file should have a single line with the language abbreviation Example languages are en en US or fr A language specified this way is only used if the user has not specified a language If a user manually selects a different language that language will be used the next time Colectica starts Site wide Custom Field Configuration Custom fields can be configured through XML configuration files This is useful if you wish to deploy a shared set of custom fields throughout your organization Multiple configuration files can be deployed in this manner Configuration location for individual users To deploy a custom field configuration for a single user deploy an XML configuration file documented below in Sappdata t Algenta Colectica CustomFields Colectica will look for any XML files in the directory and will inspect them for
57. ideas being explored by a study By defining the concepts behind your study you can more easily create well organized documentation Sharing concepts among multiple studies enables quick painless data harmonization Add and Remove Concepts For instructions on how to add collections of concepts to your project see Create New Items in a Metadata Package on page 35 Once you have navigated to a concept set you can add remove and edit concepts To add a concept e To add a concept simply begin typing the name or label of your new concept in the Concepts List To remove a concept e To remove a concept right click the concept and choose Remove Item from the concept s context menu e Alternatively you can select the item and press the Delete key on your keyboard ICPSR 27063 Concepts Agency example org Revision 0 Last Updated 2010 07 23 04 52 View DDI Add existing concepts Name Description China China Is seen variously as an ancient civilization extending over a large area in East A Liaoning Liaoning is located in the southern part of China s Northeast Liaoning often called 1 Identifier An identifier is a unique expression in a written format either by a code by numbers Mother A mother is a woman who has conceived given birth to and raised a child A father is defined as a male parent of any type of offspring Grandparent Grandparents are the father or mother of a person s own father and or mother Figure 38 A
58. ing the Save As dialog select the file where you would like to save the DDI 3 1 F CZ Save As gt Ud gt Computer Local Disk D work v Organize New folder oS E Recent Places Name Date modified Type Size 164 KB 3182 KB 4 21 2010 4 22 PM XML Document 3 5 2010 1 43 PM census2010 ddi3 xml L J Libraries a mexico study ddi2 xml Documents m Music i Pictures BE Videos XML Document n dj Homegroup jM Computer EL Local Disk C Local Disk D cx Local Disk Q a SAN AN III 7 Filename census2010 ddi3 xml Save as type XML Files xml Hide Folders Figure 78 The Save As dialog 3 Colectica will create your file 102 census xml 1841 l Category5cheme id 661218e5 aeb1 4998 9a15 9186808bf2694 version 4 8 8 versionDate 2018 83 17T87 52 34 agency coleci 1842 amp r VersionRationale xml langsz en US Publishing study lt r VersionRationale gt 1843 l CategorySchemeName xml lang en US gt House Ownership lt 1 CategorySchemeName gt 1844 l Category id z 61428675 ddb2 Afbc ad47 4cb877aae4807 version 18 6 8 versionDate 28018 83 26T803 04 58 missing false gt 1845 amp r UserID type 11179 IRDI colectica com 61428675 ddb2 4fbc ad47 4cb877aae497 18 r UserID 1846 amp r rVersionRationale xml lang z en US Publishing studyz r VersionRationale 1847 amp r Label xml lang en US Owned by you
59. ion view allows you to edit several elements 30 United States Census Agency example org Revision 4 Last Updated 2012 07 03 07 11 Coverage Citation Data Collection Modules External Materials Resources Extended Description Studies Series Funding General Information Title United States Census en US Abstract The United States Census is a decennial census mandated by the United States Constitution The population is enumerated every 10 years and the results are used to allocate Congressional seats congressional apportionment electoral votes and government Ja program funding The United States Census Bureau officially the Bureau of the Census as defined in Title 13 U 5 C 8 11 is the government agency that is responsible far the United States Census Some states ar local jurisdictions also conduct local censuses Purpose Mot specified Universe Search for an item Figure 29 The Series Study Description view Abstract DDI Use the Abstract field to describe the nature and scope of the study Purpose DDI Use the Purpose field to describe the primary study questions or hypotheses as well as information on any legal basis for the study such as laws requiring the collection of census data for apportionment purposes Universe DDI Use the Universe field to describe the group of persons or other elements that are the object of research and to which any analytic results refer Age natio
60. items it contains you can specify a metadata package s abstract purpose citation and external materials United States Census 2010 Agency example org Revision 9 Last Updated 2012 07 03 07 11 Description citation External Materials Abstract Purpose Not specified Figure 33 The Metadata Package editor Create New Items in a Metadata Package Items can be added to the metadata package using the ribbon the navigator or using drag and drop e To add an item from the ribbon click one of the Add buttons and choose the appropriate menu item 35 United States Census 2010 Commands tu i Add Organization Add Universe Add Category Add Code Add Question Set Sete Set Sete Set Add Existing Concept Set Figure 34 Adding a concept set from the ribbon e Alternatively you can add an item from the Navigator To add an item from the navigator right click the Metadata Package and choose one of the items from the context menu a Resource Package Advanced Search E United States Census 2010 Agency example jj United States Census 2010 id ui Series ry Studies 3 Resource Packages United States Census 2010 d L Conceptual d L Classifications Ll Data Collection Add Universe Set S Data Collect Add Category Set fe Questions Add Code Set H Description Citation External Materials Abstract ts Add Organiz
61. ization view to edit an organization s details The Organization view allows you to edit several elements E Organization US Census Bureau Agency opendata colectica org Last Lipaat 010 07 23 10 52 p ui Organization Relationships External Materials Extended Mame US Census Bureau en Us Nickname US Census Bureau en Us Description US Census Bureau en Lis Keyword en Ls Image URL http 2010 census gov partners img loga png m Initecd States 2010 IT S IN OUR HANDS Figure 42 The Organization view Name 43 DDI The official name of the organization Nickname DDI An abbreviation or a brief name for an organization Description DDI A description of the organization Keyword A comma separated list of keywords used to classify the organization or its activities Image URL The URL of an image of the organization s logo Relationships Using the Relationships tab you can specify the relationship of one organization to another 44 Chapter 8 Manage Classifications In this chapter e Classifications in Colectica e Category Lists e Code Lists e Generate a Code List from a Category List Classifications in Colectica Colectica allows you to manage two types of classifications category lists and code lists A category is generic term for items at any level within a classification OECD Glossary of Statistical Terms A sample category scheme for genders might have two items Male
62. kare apo F 1868 amp r Label xml lang es gt Propiedad suya o de alguien en este hogar libre y sin deuda sin una hipoteca o pr stamo lt r Lat 1861 amp r label xml lang sw gt Unaimiliki au mtu mwingine katika kaya nyumba hii bila ya mkopa3 r Label 1862 amp r Label xml lang fr Ont ils t achet s sans cr dit par vous ou quelqu un de votre foyer 2 lt r Label gt 1863 amp r Label xml langs de geh rt Ihnen oder einer Person in diesem Haushalt ohne jegliche Belastung ohne Hypothek oder Dar 1864 riLabel xml lang zh CHs BiTimnsgUrIP 9sTam egiueme EMRE lt r label gt Export DDI 2 Figure 79 A DDI 3 1 file generated by Colectica Colectica can export your project to DDI 2 format 1 Click the Generate DDI 2 button in the Export ribbon tab Colectica Import Help Commands uj di E OG I E74 lt ddi gt ee m Ls Add Add Resource Update E Gather Generate Generate Import Harmonization Generate tium Study Package Item Referenced Items DDI3 DDI2 Sheet Documentation Add Repository Export Import Documentation Figure 80 The Export ribbon with the Generate DDI 2 button 2 Using the Save As dialog select the file where you would like to save the DDI 2 CZ Save As ss gt c Lid Computer Local Disk D work Search work yo Organize v New folder Ek ij Recent Places Name Date modified Type census2010 ddi3 xml 4 21 2010 4 22 PM 3 5 2010 1 43 PM 164 KB 3 182
63. lectica ddi ddi ddi Import DDI Import Import Import 3Fragment DDI3 DDI2 E D SPSS jJ DDI Survey Instrum Data The Help tab has links to online help resources 17 e igJi Colectica Designer Colectica Import Help e lt ddi gt da ddi Manual Colectica and DDI Colectica DDI Colectica Survey Metadata DDI Support Samples Training Training Customization Development Preparation Samples Training Services The Navigator Javigator The navigation bar is the column on the left hand side of the Advanced Colectica window It is designed to help you find the ib cuu information you want to view and edit a Search Ll Checkouts The top level items that are displayed depend on which Ul Cars Colectica desktop application you are using Seri MADRE In Colectica Express the top level items in the navigator JJ Studies represent open files 4 Bl Cars p Datasets In Colectica Designer the top level items in the navigator Resource Packages represent local checkouts and any remote repositories you S Resource Packages have configured 4 li Commute 4 li Example b ee Local Items d ae midus colectica org d a localhost Figure 9 The Navigation bar with the Project pane activated Navigator Toolbar The first button on the navigation bar collapses all items and restores any root items in case you have drilled down into a specific item The second button refresh
64. lectica Portal interact with Colectica Repository using standard communications protocols Although Colectica Repository is not accessed directly by end users it is the backbone of the Colectica platform e DDl based server for metadata storage and versioning e Authoritative source for one or more DDI agencies e Enables collaborative workflows e Manage metadata in multiple languages e Secure role based authorization system e ISO 11179 compliant Colectica Portal Colectica Portal is a web application powered by Colectica Repository which enables data and metadata publication and discovery e Web application for metadata publication and discovery e Search and browse contents of Colectica Repository e Publishes linked data and RDFa metadata e Provides metadata rich home pages for agencies and studies e Comment on rate and share metadata items Part 2 Colectica Desktop Applications Colectica offers three desktop applications Colectica Reader Colectica Express and Colectica Designer For a comparison of these applications see Table 1 Desktop applications comparison 10 Chapter3 Installation Step 1 Download Colectica Designer or Colectica Express 1 http www colectica com resources dl 2 ColecticaDesignerSetup exe or ColecticaExpressSetup exe where 8 is filled in with a specific version number Step 2 Download Prerequisites If Not Previously Installed 1 Net Framework 4 0 Full a http www microsoft com d
65. m templates are provided You do not need to provide every file to make your own template If you omit any of the files Colectica s default template will be used This means if you only want to change the format of a Variable s documentation for example you would only need to provide the Variable txt file in your template directory If you include a subdirectory named files within your template directory all the files in the subdirectory can be referenced in your template and will be copied to the documentation output location if HTML documentation is generated This means you can include custom CSS and images in your custom templates Template Format Each template file uses Microsoft s Razor template format which is a combination of HTML and CH A master txt template may look like this sample IDOCTYPE html html head title Documentation title link rel stylesheet title Default href files styles css type text css lt head gt lt body gt lt div class page gt div id content gt AddMainContent lt div gt lt div gt lt body gt lt html gt 8 This is basically just HTML but with some special items added For example the 9 AddMainContent indicates that the main information being generated will be placed in that location In Razor when something begins with the symbol it indicates a transition to CH code Helper Methods Colectica provides the followi
66. mport Wizard To get started choose the file s you would like to import Choose input files Clear file s D tmp MyData sav Cancel Ne Figure 75 SPSS import file selection page 3 Colectica will read your files and show you a summary of the imported contents Click the Next button 100 F CZ Import Wizard Import Wizard Colectica will import the following items Variable Code Set 49 3 Category Set Resource Package 3 1 Cancel Finish Figure 76 SPSS import summary 4 Click the Finish button 5 Colectica will import your data Depending on the size of your data file this may take a few minutes 101 Chapter 14 In this chapter Export from Colectica e Export DDI 3 e Export DDI 2 Export DDI 3 This feature is only available in Colectica Designer Colectica Express uses DDI 3 as its native file format To export DDI 3 from Colectica Express simply save a file the generated XML is the DDI 3 Colectica Designer can export your project to DDI 3 format 1 Click the Generate DDI 3 1 button in the Export ribbon tab Colectica Import Help Commands of 3 Gee lt a P Add Add Add Resource Update Publish Tag Gather Generate Generate Import Harmonization Generate Series Study Packager Item Referenced Items DDI3 DDI2 Sheet Documentation Add Repository Export Import Documentation Figure 77 The ribbon with the Generate DDI 3 1 button 2 Us
67. mport ribbon with the Import DDI 3 button 2 The Import Wizard will open Click the Choose input files button to select the file you wish to import Click the Next button 90 c Import Wizard Import Wizard To get started choose the file s you would like to import Choose input files Clear file s D workycensus2010 ddi3 xml Figure 61 DDI 3 import file selection page 3 Colectica will read the DDI 3 file and show you a summary of its contents C Import Wizard Import Wizard Colectica will import the following items Variable Code Set 49 3 Category Set Resource Package 3 1 P revious Figure 62 DDI 3 import summary 4 Click the Finish button 91 5 Colectica will import your data Depending on the size of the DDI 3 file this may take a few minutes Import DDI 2 Nesstar Colectica is able to import DDI 2 files as produced by Nesstar a product of the Norwegian Social Science Data Services Importing other types of DDI 2 files may also work but is not explicitly tested or supported Please contact us if you have existing data you would like to import and we can work with you to support your formats You can import a DDI 2 file using the Import Wizard 1 Click the Import DDI 2 Nesstar button from the Import ribbon tab Import Import 3 Fragment DDI3 DDI2 Blaise CASES SPSS Stata DDI Survey Instrum Data Figure 63 The Import
68. nality and residence commonly help to delineate a given universe but any of a number of factors may be involved such as sex race income veteran status criminal convictions etc The universe may consist of elements other than persons such as housing units court cases deaths countries etc In general it should be possible to tell from the description of the universe whether a given individual or element hypothetical or real is a member of the population under study Funding Add a New Funding Source 31 To describe a funding source for your study simply start typing a grant number or description in the list of funding sources Edit a Funding Source To edit a funding source 1 Select a funding source from the list of funding sources 2 Inthe detail view below the list make the desired changes The Funding Source view allows you to edit several elements United States Census 2010 Agency colectica com Revision 53 last Updated 2010 03 26 G FEE View ODI Description Funding Citation Grant Number Description Funding Agency Me Funding for the United States 2010 Census US Census Bureau Funding Information Funding Description Funding for the United States 2010 Census Organization Search for an item US Census Bureau US Census Bureau Figure 30 The Funding Source view Grant Number DDI The identification code of the grant which provided funding for the described object Role DDI The
69. neral Output Options Title Car Analysid Subtitle Header Text Footer Text August 27 2012 Output Location Please choose the location where the documentation should be written Figure 58 The Generate Documentation dialog Formats General Formats PDF HTML RTF Template Override the default template Figure 59 The Formats tab of the Generate Documentation dialog You can generate documentation in the following formats 85 e PDF Portable Document Format This can be opened by a number of free applications e HTML Hypertext Markup Language This is the format commonly used on the Web e RTF Rich Text Format This can be opened by Microsoft Word or other word processing applications Choose the Override the default template option to choose your own template that specifies the look and layout of the generated documentation The template language is described in the next section Generate Documentation After choosing your settings click the Generate button and Colectica will create your documentation Customize Documentation Templates Colectica provides a powerful template engine that lets you completely customize the content and style of your generated documentation The Generate Documentation dialog lets you choose a custom template in its Formats tab The templates you can choose from are located on your file system in Sprogramdata s Algenta Colectica Templates If
70. ng helper methods that you can call from your templates using the 9 syntax Add Items Method Description AddMainContent Adds the main content for the documentation Only useful in master txt Addlitem item Adds documentation for the provided item using the template with the same name as the item type For example Addlitem variable will add the content for the variable using the Variable txt template Additem templateName item Adds documentation for the provided item using a custom template For example Additem variable Custom will add the content for the variable using the custom txt template Formatting Method Description AddBodyText text Adds text to the documentation This method takes care of formatting any XHTML and other processing AddKeyValue key value Adds a key and value to the documentation If no value is present nothing will be written AddHeaderedText header text Adds text with a header on top If no text is present nothing will be written Content Helpers Method AddCitation citation AddDescriptivelnformation item AddVersionablelnformation item AddOtherMaterials otherMaterialsList header AddCoverage coverage Headers and Indentation 88 Description Adds Dublin Core citation information to the documentation Adds general descriptive information to the documentation This includes the item s name label and description Adds an item s UserlDs
71. nnotation and Custom Fields e Configure Custom Fields Overview Sometimes it may be useful to document additional information beyond what the default metadata fields allow you to record Colectica allows you to add additional information about items in the form of annotations and custom fields An annotation is a simple note added to an item It includes a title and content A custom field provides a more formal way to add information to an item The following properties are used to define a custom field Title The label for the custom field Description Detailed information about the field This is displayed as help text in the form Item Type The type of item to which the field applies Value Type The type of value Currently supported types include String MultilingualString Uri hyperlink and Controlled Vocabulary After defining a custom field all forms for the relevant item type will include data entry fields corresponding to the definition Configure Custom Fields To add a custom field 1 Fromthe File menu choose the Manage Custom Fields item The Manage Custom fields dialog will appear 2 Click the Add button 3 Choose the item type to which the field should apply 4 Entera title and description for the custom field 82 5 Choose the value type of the item 6 Close the dialog The custom field will now be available for items of the relevant type To remove a custom field 1 Choose the Manage Cu
72. ns and survey instruments Sharing questions among multiple studies enables easy comparability of data Data The fastest way to describe your existing datasets is to import them into Colectica Colectica will automatically extract reusable classification and variable descriptions Agencies An agency is the organization responsible for a study or a set of metadata elements DDI agency identifiers can be registered at http registry ddialliance org Chapter2 The Colectica Platform Desktop Applications Colectica offers three desktop applications Colectica Reader Colectica Express and Colectica Designer Colectica Reader Colectica Express Colectica Designer View DDI 3 metadata Y Y v Multilevel metadata S J y validation Create and edit study metadata Create and edit dataset metadata Questionnaire designer Import from DDI 2 Nesstar Import from SPSS Generate statistical source code Generate publishable documentation PDF RTF Import from Blaise and CASES Generate computer assisted interviewing system source code Browse contents of Colectica Repository Synchronize with Colectica Repository Publish to Colectica Repository Table 1 Desktop applications comparison Colectica Repository Colectica Repository is a centralized storage system for managing data resources enabling multi user workflows and providing automatic version control Client applications such as Colectica Designer and Co
73. nse Domains For questions with multiple response domains you can specify how a respondent will answer the question Choices are e A single response domain e One or more response domains e Every response domain Response Options Add Response Domain Responses come from every response domain Figure 49 Choose for which domains a respondent should provide data Interviewer Instructions For surveys administered by an interviewer any directions intended for the interviewer External Aids The External Aids tab lets you add links to media that may be associated with the question For example you can add a link to an audio or video file that the respondent is presented with before answering the question Concepts Specify the concepts related to the question Question Intent The purpose of the question Estimated Time An estimate of the amount of time it will take the respondent to understand and answer the question This is used by Colectica s instrument analytics feature to create an estimate of the total time a survey instrument might take If you leave the estimate as O Colectica will estimate the time based on average English speaking time 54 Create and Manage Survey Instruments Colectica lets you design new survey instruments or document existing survey instruments When using Colectica s survey designer you can define the sequence of questions and any routing that takes place within the survey Starting with this
74. nstalling Colectica on your computer Click Install to continue with the installation or click Back if you want to review or Additional tasks Additional icons Create a desktop icon Installing Please wait while Setup installs Colectica on your computer Figure 5 Installer Screen 5 Installation progress 13 Completing the Colectica Setup Wizard Setup has finished installing Colectica on your computer The application may be launched by selecting the installed icons Click Finish to exit Setup Figure 6 Installer Screen 6 Installation complete After installation you can launch Colectica from the Windows Start menu 14 Chapter 4 Getting Started In this chapter e Introduction e The Ribbon e The Navigation Bar e Work with Text e Save Items e Specify your Agency e View Revision Information e View Differences between Revisions e Send Feedback Introduction Colectica allows you to create manage view and publish all the elements of your study This section describes the basics of the Colectica desktop applications user interfaces Although Colectica Reader Colectica Express and Colectica Designer offer somewhat different feature sets the user interface style is common among them For instructions on how to manage particular study elements and how to perform certain tasks please consult the chapters that follow The Ribbon The ribbon is designed to help you quickly find th
75. on click the Search for an item button and use the item picker to choose an item To remove a reference to a data collection description select the item from the list and press the Delete key on your keyboard External Materials The External Materials editor allows you to link to information managed outside Colectica This could include PDF documents web sites or any other type of material Resources Both series and studies can reference one or more Metadata Packages For details on Metadata Packages see Metadata Packages page 35 To add a reference to a metadata package click the Search for an item button and use the item picker to choose an item 34 To remove a reference to a metadata package select the item from the list and press the Delete key on your keyboard Extended The Extended editor lets you add additional information to describe a series or a study For details on using the Extended editor see Annotations and Custom Fields page 82 Metadata Packages A Metadata Package is a container for almost any type of item managed in Colectica For example Questions Variables and Concepts can all be stored in a metadata package The only items not stored in metadata packages are Projects Series and Studies The items in a metadata package can be reused by one or more studies When studies reuse already existing items they are more comparable with other studies Edit a Metadata Package Description Besides the
76. op 2010 Instrument Agency example org Revision 3 Last Updated 2011 04 05 04 04 Design BasicInformation s i HBHH T W Sequence F T Ya x CF LO How many people wer w CO Were there any additic O CD Is this house apartmer LIJ CD What is your telephon LJ d o PersonCounter Q1 C BAINL REPI Agency example org t Sequence Last Updated 2011 04 05 04 04 pal jJ Add a Question te Order Add a Statement MAppearance Add a new Sequence Reuse a Sequence Add Custom Code Add a For Loop Add a Until Loop 70 Step Title Basic Information Sd Main Section D How many people were living or H 2 Were there any additional peopl CD Is this house apartment or mob 25 What is your telephone number k o PersonCounter Q1 D Thank you for completing the 20 5 moreHouseholdMembers o moreHouseholdMembers false Step detail text Specify the Condition for a While Loop While 4gencyintexample Revision 1 Last LU 2012 10 31 10 52 moreHouseholdMembers true Enter the condition that must remain true for the items in the loop to continue to be executed Specify the Condition for an Until Loop t Repeat until no more household members Agency int example Revision 1 Last Updated 2012 10 31 10 52 moreHouseholdMembers false Enter the condition that must become true in order to exit the loop 71 Specify Exp
77. or someone in this household with a mortgage or loan Include home equity loans 1848 r label xml lang sq gt Esht n pron sin tuaj apo t ndonj banori tjet r t k saj sht pie me garanci hipotekare apo ht 1849 amp r rLabel xml lang e5 gt Propiedad suya o de alguien en este hogar con una hipoteca o pr stamo Incluya los pr stamos sobr 1858 amp r Label xml lang sw gt Unaimiliki au mtu mwingine katika nyumba hii kwa malipo benki au mkopo Jumuisha mikopo ya hisa 1851 amp r Label xml lang fr NMum roOnt ils t achet s 8 cr dit par vous ou quelqu un de votre foyer Incluez les prets sur 1852 lt riLabel xml langs2 de geh rt Ihnen oder einer Person in diesem Haushalt nit einer Hypothek oder einem Darlehen Das umf 1853 amp r Label xml lange zh CHs ECFATERATCEP BERTA SBR EES ARR lt r label gt 1854 lt 1 Category gt 1855 l Category id z ele358d6 132b 4a74 b3b8 Af6b39fabSel version z 17 8 0 versionDate z 2018 83 26T803 04 58 missing false gt 1856 lt riUserID type 11179 IRDI colectica com ele35e d6 132b 4a74 b3b8 4F6039fab9e1 17 lt r UserID gt 1857 amp r VersionRationale xml lang en US gt Publishing study lt r VersionRationale gt 1858 amp r Label xml lang en US gt Owned by you or someone in this household free and clear without a mortgage or loan lt r Labe 1859 r ilabel xml lang sq Esht amp n pron sin tuaj apo t ndonj banori tjet r t k saj sht pie pa garanci hipote
78. ormat of a dataset Dataset A file containing data Item Type Description Conceptual Component A collection of Concept Sets and Universe Sets A collection of Classifications Variable Sets and Data L P ogical Product Relationships H Physical Data Product A collection of Physical Structure Sets and Record Layout Sets General and Conceptual Information Concepts describe the basic ideas being explored by a study By defining the concepts behind your study you can more easily create well organized documentation Sharing concepts among multiple studies enables quick painless data harmonization Classifications Colectica allows you to manage two types of classifications category schemes and code schemes A category is generic term for items at any level within a classification OECD Glossary of Statistical Terms A sample category scheme for genders might have two items Male and Female A code associates a value with a category The value is often numeric but could be any string A code scheme allows a collection of codes to be specified in either a flat or hierarchical manner Multiple code schemes may be associated with the same category scheme For example one code scheme might assign values to the gender category scheme as follows Value Category Another code scheme might assign different values to the same categories Value Category Data Collection Colectica allows you to create manage and reuse questio
79. ownload en details aspx id 17718 Step 4 Install Colectica Designer or Colectica Express Installation Screens Welcome to the Colectica Setup Wizard This will install Colectica 3 0 Release on your computer It is recommended that you close all other applications before continuing Click Mext to continue or Cancel to exit Setup Figure 1 Installer Screen 1 Welcome 11 Please read the following important information before continuing Please read the following License Agreement You must accept the terms of this Colectica End User License Agreement This Colectica End User License Agreement EULA is a legal agreement between you either an individual or a single entity and Algenta Technologies for the Colectica software product s which may include associated software components media printed materials and online or electronic documentation CSOFTWARE PRODUCT By installing copying or otherwise using the SOFTWARE PRODUCT you agree to be bound by the terms of this EULA This license agreement represents the entire agreement concerning the program accept the agreement Which additional tasks should be performed Select the additional tasks you would like Setup to perform while installing Colectica then click Next Additional icons Create a desktop icon Create a Quick Launch icon Figure 3 Installer Screen 3 Choose shortcuts 12 ie Setup Ready to Install Setup is now ready to begin i
80. puter You can also publish these projects to a server running Colectica Repository This allows you to collaborate with multiple people while working on the same project Colectica automatically takes care of tracking versions and helps you resolve conflicts When working with a repository the main unit being managed is referred to as a checkout While this managed item will usually be a Project or a Study it can be any type you would like Checkouts can be published to a server You can also update a checkout to pull any changes made by other users Configure a Remote Repository Before synchronizing with a remote repository the repository must be configured in Colectica Designer From the File menu choose Manage Repositories Click the Add button Enter the URL user name and password as provided by your repository administrator Click the Save button xd E 105 Manage Repositories Hostname example org User Name Password Authentication UserName NN Transport NetTcp Current Agency Identifier example org Figure 83 The Manage Repositories dialog window Create a New Checkout To create a new checkout 4 Fromthe Colectica ribbon tab choose Create New Checkout 5 nthe Create New Checkout dialog choose the type of item you would like to manage and enter a name for the item Project Types JY Low 3 Study Series prae Conceptual Classificati Data Collection Data
81. r PDF and RTF formats include e font family e font size e color e font weight e font style e text decoration To specify font sizes use pixels e g 12px To specify colors use RGB e g HOOFFOO instead of Green Conditional Statements Loops and Other Code In addition to the helper methods described above the Razor template system allows you to perform any action that is possible from general CH code This includes conditional statements looping and much more For a general introduction to Razor please see htto www w3schools com aspnet razor intro as 89 Chapter 13 Import Existing Resources In this chapter e Import DDI 3 e Import DDI 2 Nesstar e Import from Spreadsheets or Delimited Files e Import Blaise Survey Instruments e Import CASES Survey Instruments e Import SPSS Files e Import Data Files Colectica can import data from a number of sources Import DDI 3 This feature is only available in Colectica Designer Colectica Express and Colectica Reader use DDI 3 as their native file formats so an import feature is not needed To open a DDI 3 file in Colectica Express or Colectica Reader simply choose the Open button from the Colectica ribbon Colectica is able to import DDI 3 1 Click the Import DDI 3 button from the Import ribbon tab Colectica Import Help Import Import 3 Fragment DDI3 DDI2 Blaise CASES SPSS Stata DDI survey Instrum Data Figure 60 The I
82. rance OF Haar ic thic moarnen nalblafas tta Sequence Order When a section is selected you can edit its label and other details by clicking the arrow next the section s title 65 Add Items to a Section There are several ways to add items to a section 1 Right click the section and choose the type of item you would like to add 2 Drag and drop a question or sequence from the main navigator into the section 3 Drag and drop an item from the survey navigator into the section Edit the Order of Items in a Section t Main Section Agency example org Revision 3 Last Updated 2011 04 05 04 04 Sequence Order InOrderOtAppearance InOrderOf Appearance Random Rotate Other You can specify the order that respondents receive items in a given section by choosing the section s Sequence Order For example in some sections the question order may be randomized 66 Add and Edit Conditional Branches Add a Conditional Branch 2010 Instrument Agencyexample org Revision 3 Last Updated 2011 04 05 04 04 Design Basic Information HE F TE I Seguence Agency example org Aevi ex C Adda Question LD How many per 7 E Sequence Order D Were there an Add a Statement nOrderOf Appearance 35 Is this house z L Add a new Sequence us What is your t ESI Reuse a Sequence b PersonCounte E b rl Qo Adda Conditions M Adda While Loop Adda Until Loop E rg To add a branch that i
83. rate G3enerat E Sequence Item DDI3 Instrument Paper Form Source Cade Documentation Dataset Add Export Remove Instrument Documentation Dataset Figure 50 The Analyze Instrument button in the ribbon The results of your analysis will open in a new tab 73 I Question Counts Text Questions Code Questions Numeric Questions Date Time Questions Mixed Questions Total Questions Time Estimates All Questions 00 01 48 5000000 Figure 51 Instrument Analysis results Generate a Paper Questionnaire Colectica is able to generate a paper questionnaire based on your survey design To generate a paper questionnaire 1 Use the Navigator to navigate to your survey instrument Ee lt ddi gt x Q 4 LJ Generate Generate Add Duplicate Generate Remove Analyze Generate Generate Sequence Item DDI3 Instrument Paper Form Source Code Documentation Dataset Add Export Remove Instrument Documentation Dataset 3 Using the Generate Questionnaire dialog choose the file formats output options and output location for your questionnaire For detailed information on these options see Generate Documentation page 84 74 me E General Formats Output Options Title 2010 Instrument Subtitle Header Text Footer Text Output Location Please choose the location where the documentation should be written dAColecticaOutput m Generate Survey Instrument
84. re biet eae ieee darn 82 Chapter 12 Generate Documentation io a Ive e ei d Leger o A 84 Chapter 13 Import Existing ResoUfcCes ione ti pedo devas evans si vera eo o a rene o EE ove EV Eno de Ve o ord ee va Ree en 90 Chapter 14 Export Trot COleCLICa sitse donet aopus tt bosse a vbveuet Casca bte been utet edat tabat ess duv tede euttE 102 Chapter ls Se abchusodeissiei ens des ces BN CHI pUE S bete MS opc uu uu Ld epi M qoem IN LAE eM E I IC Me MUNI 104 Chapter 16 Synchronize with a Remote Repository eeesssseeeeseeeeneeenen nennen enne 105 Chapter e DDIa Helper Featur 6 etsi beris TOi Pr PE vier E tribe ardet d HER Ea EHI Eb eri teris 111 Chapter PSs AGMINE eaea ian P utebueb A idu ieu Mu LI LI ID ED Pee qUEDUE 113 Parts ODEN tandirda enee ctus Dope ve MUI M EE LR D PM M M 119 Chapter 19 Data Documentation Initiative DDI eeessseeeeeenennnn nennen 120 Chapter ZO ISO IEC TIT Guest tias cai e etai E tue sud eoo c ia Ce tEobee ete ULIS 121 Part4 Additonal ResoUFCOS scatet E cokes A dab atas rtc deRs 122 Chaptep2 T Colecutd TENNE cesar ees ce becacon heen stus sapie a dec ID ote SLE ceca e cans 123 Chapter22 Standards TESIBIBB serrin a ie bouaahederkenstaguiiietdeuuie fa suu et sms adu eU Ope DM 126 Chapter 23 5 SCRVICES iis cae laterite ese ae utto tas toc ut ocu Ese taa cM o o e Ee 127 Part 1 Introduction Chapter 1 Managing Projects with Colectica Managed Item Types Projects Item Type Descrip
85. ressions for a For Loop d Loop Agency example org Revision 4 Lost Updated 2012 10 16 08 42 Initializer PersonCount Loop While PersonCounter 1 Step e The Initializer code is what happens before the loop starts e The Loop While code is the condition that must remain true for the loop to continue executing e The Step code is what happens at the end of each iteration of a loop For example you may increase the value of a counter variable 72 Remove an Item Remove an Item Basic Information M Sequence 3 How many people were living or sta CO Were ther 7X Remove eople stayin CH Is this house apartmen s What is your telephone number We m P o PersonCounter Q1 To remove an item right click the item and choose Remove The item will be removed from your survey Analyze a Survey Instrument Colectica Designer automatically detects several types of common problems with survey instruments These diagnostics can be applied to instruments designed in Colectica as well as those imported from existing source code Types of issues that can be detected include e Survey item is unreachable e Dead ends e Missing goto targets e Endofa survey is unreachable To analyze a survey instrument click the Analyze Instrument button in the Ribbon OTI 7 Colectica Import Help Commands H da 4 X Q E o Add Duplicate Generate Remove Analyze Generate Generate Gene
86. rocessing applications Choose the Override the default template option to choose your own template that specifies the look and layout of the generated documentation The template language is described in the next section Generate Documentation After choosing your settings click the Generate button and Colectica will create your documentation Customize Documentation Templates page 84 for details on the template format 118 Part 3 Open Standards 119 Chapter 19 Data Documentation Initiative DDI The Data Documentation Initiative DDI is an international project to create a standard for information describing statistical and social science data Begun in 1995 the effort brings together data professionals from around the world to develop the standard The DDI specification written in XML provides a format for content exchange and preservation of information Version 3 of the DDI standard was released in April 2008 Data Documentation Initiative 2010 May 4 In Wikipedia The Free Encyclopedia Retrieved 04 25 May 7 2010 from http en wikipedia org w index php titlezData Documentation Initiative amp oldid 360110974 Colectica and DDI Most of the information stored in Colectica is stored natively in DDI format The support for open standards ensures that your data is never locked in a black box You can always extract your information and use it with other tools too Several of the Colectica developers serve
87. rogram eligibility This field identifies the criterion for a recipi Household composition This field describes the program category a Figure 55 A list of variables Edit a Variable To edit a variable 3 Use the Navigator to navigate to the variable set you would like to edit 4 Usethe variable list to edit a variable s name label or description Alternatively select a variable and use the Variable view to edit a variable s details The Variable view allows you to edit several elements 78 YOB Year of birth of recipient Agency example org Revision 8 Last Updated 2010 07 17 10 35 Representation Details conceptual sources External Materials Extended Name Label Year of birth af recipient mean of year of birth pia for uas attemsas B in 1 the redpient 5 state of IS residence Description The field YOB is topcodec when it is after 1997 Instead dt LC ICO ed year of birth i is seed with 1999 which is the national mean of all those born after 1997 Representation Type Date Time Blank values represent missing values Editor Figure 56 The Variable view Name A name for the concept Label A display label for the concept Description The definition of the concept Representation Type The type of data in the column described by the variable For details see Response Options page 52 Role Describes a specific function of the variable such as identity weight geographic varia
88. roject r CZ Import Wizard lole eS Import Wizard Colectica found 4 items Click Finish to add these to your study Cancel Previous Finish Import Blaise Survey Instruments This feature is only available in Colectica Designer Colectica can import Blaise survey instruments Blaise is a product of Statistics Netherlands You can import a Blaise instrument using the Import Wizard 1 Click the Import Blaise button from the Import ribbon tab Colectica Import ddi ddi ddi reas Import DDI Import Import Import Import Import Import 3 Fragment DDI3 DDI2 Blaise CASES SPSS Stata DDI Survey Instrum Data Figure 67 The Import ribbon with the Import Blaise button 2 The Import wizard will open Click the Choose input files button to select the bla file that contains your survey instrument s data model Click the Next button 96 C Import Wizard Import Wizard To get started choose the file s you would like to import Choose input files Clear file s D workyexample1 bla Figure 68 Blaise import file selection page 3 Colectica will read your survey instrument to discover all languages used in the instrument You can assign the destination and ISO language of each discovered language by using the Metadata Element and ISO Language columns Click the Next button Import Wizard Blaise Options Colectica discovered the following languages in your Blaise
89. role of the funding agency Funding Description DDI Additional information regarding the role and actions of the funding source 32 Organization DDI The organization or individual that served as the funding source Coverage To specify what topics time periods and geographical areas a study covers choose the Coverage tab in the Study view The Coverage view allows you to edit several elements Topical Coverage 3 Subjects one per line Keywords one per line Temporal Coverage 3 Time Periods Add a date DateTime 1 1 2010 W through DateTime 12 31 2010 Remove Spatial Information Bounding Box South Latitude West Longitude North Latitude TIT 3 East Longitude Citation To edit a study citation choose the Citation tab in the Study view The Citation view allows you to edit several elements 33 Study Citation Title United States Census 2010 Publisher Publication Date iSelect a date Identifier Figure 31 The Citation view Data Collection A Data Collection describes the process of collecting data Both series and studies can reference a data collection description Description Studies Series Funding Coverage ctation Data Collection moauies External Materials Resources Extended Search foran item Name Label Description 2010 Data Collection Figure 32 The Data Collection reference editor To add a reference to a data collection descripti
90. rvice Colectica Interoperability Workshop The Colectica Interoperability Workshop is aimed at developers who wish to develop applications that interact with the Colectica Repository The workshop consists of an in depth description of the Colectica Repository s design followed by hands on development The length of the workshop is dependent on the goals of the participants and will be determined on an individual basis This workshop covers the following topics e Accessing the Colectica Repository through web services 124 O Searching for items o Retrieving items o Committing items Repository item identification and versioning Repository item serialization DDI 3 extensions Hands on development 125 Chapter 22 Standards Training DDI Developer Workshop The DDI Developer Workshop is aimed at developers who wish to create programs that use DDI 3 The workshop consists of in depth discussion of the DDI 3 standard development patterns that allow developers to implement standard conforming applications and tools that are available to increase development productivity This course can be targeted toward developers working on in house projects those creating open source applications or those creating commercial solutions The development environment can be tailored as appropriate for the participants possibilities include NET Java Perl and others The workshop is applicable for desktop web and mobile applications The DDI
91. s only executed when a certain condition is true select the location where you would like to add the branch and choose Add a Conditional Edit the Condition Design Basic Information Fj ee t Agerncyint example Hevision l Last Updated 2012 10 31 09 31 T qi Main Section PersonCounter 1 CD How many people were living or EF 4 k i D Were there any additional peopl CD Is this house apartment or mob i n What is your telephone number o PersonCounter Q1 i i Conditional bs T PersonCounter 1 M Branch CE How is this person related to m m rm With your branch selected you can edit the condition that must be true in order for items in the branch to be executed 67 Add an Item in a Branch Basic Information t Agency intexample bul H Main Section PeraonCounter 1 CH How many people were living or s Were there any additional peopl so Is this house apartment or mob D What is your telephone number o PersonCounter Q1 g h Conditional M PersonCounter 1 a Branch CD How is this person relati noe sear nee D Does Person PersonCol Add a new Sequence CD What is Person Persont Reuse a Sequence s What is Person fPersont Add Custom Cade E t 4 D m What is Person Personi Add a Conditional Dm Is Person PersonCount Add a For Loop GG i Dm What is Person Personi Add a While Loop O Thank
92. s yourself Algenta and its affiliates can deploy it for you Our deployment services include installation configuration and testing of the selected Colectica components as well as all dependencies In some cases we are able to provide deployment services remotely Colectica Customization While the Colectica platform contains many features you may require additional functionality in order to get the most out of Colectica The Colectica development team can add specific features or create a customized edition of the Colectica platform for your organization Integration with Existing Systems If your organization has existing data and metadata systems we can create custom bridges that enable Colectica to work with your existing data and for your existing systems to make use of data and metadata generated through Colectica We can work with other DDI based systems other standards or proprietary formats Import from Legacy Systems If you have data and metadata in legacy formats that you would like migrated to Colectica s standards based system we are able to develop importers that enable this Localization If the Colectica user interface has not already been translated to your language we are able to create a localized version 127 Survey Development Creating survey instruments for Computer Assisted Interviewing CAI systems often requires knowledge of specialized computer languages For organizations that do not specialize in this
93. select the QFILE or q file that contains your survey instrument Click the Next button 98 amp Import Wizard Import Wizard To get started choose the file s you would like to import Choose input files Clear file s DworkVcensus q Figure 72 CASES import file selection page 3 Colectica will read your files and show you a summary of the imported contents Click the Next button CZ Import Wizard Import Wizard Colectica will import the following items Question Code Set 1 Resource Package 76 16 Category Set Question Set 16 14 Figure 73 Survey instrument import summary 4 Click the Finish button 5 Colectica will import your data Depending on the size of your instrument this may take a few minutes 99 Import SPSS and Stata Files Colectica can import data from SPSS and Stata data files SPSS is a product of IBM Stata is a product of StataCorp You can import an SPSS and Stata files using the Import Wizard 1 Click the Import SPSS or Import Stata button from the Import ribbon tab Colectica lt ddi gt lt ddi gt lt ddi gt Import DDI Import Import Import Impo Import Import 3 Fragment DDI3 DDI2 Blaise CASES SPSS Stata DDI Survey Instrum Data Figure 74 The Import ribbon with the Import SPSS button 2 The Import wizard will open Click the Choose input files button to select your data file Click the Next button Import Wizard I
94. son PersonCoun Ls After adding a question you can select the question to see its details Edit Question Details To edit question text or other details navigate to the question in the main navigator For details see the Create and Manage Survey Questions in the main Colectica User Manual 63 Add and Edit Statements Add a Statement 2010 Instrument Agency example org Revision 3 Last Updated 2011 04 05 04 04 Design Basic Information da ry SLT Sequence Agency example org Revi Last Updated 2011 04 05 04 04 T M Sequence NINE _ _ Em order bet 7C Em pl i LJ ACC d HeW i quence 2 How many people were CO Were there any addit al 7 Is this house apartmen CD What is your telephone L4 Reuse a Sequence o PersonCounter Q1 Add Custom Code Add a Conditional Add a For Loop Add a While Loop GGG zU Add a Until Loop Edit a Statement Design Basic Information gt num t Statement gencyintexample Revision 1 Last Updated 2012 10 31 10 78 m Sequence CO How many people were living or C Were there any additional peopl CD Is this house apartment or mob CO What is your telephone number o PersonCounter Q1 g h Conditional T PersonCounter 1 we Branch Instructions CO How is this person related to CO Does Person PersonCounter CD What is Person PersonCoun Statement Thank yau far completing th
95. ssues Alternate Title 82 jeremy 12 2 2012 6 32 20 AM Fix an encoding issue Creator en US 8l barry 10 11 2012 8 16 43 AM Publisher en US 80 barry 10 10 2012 4 11 57 PM Contributor en Us 79 barry 10 10 2012 4 09 23 PM Eublicatien Dale Select a date 78 jeremy 10 10 2012 4 03 23 PM Identifier en U5 77 jeremy 9 12 2012 6 29 03 PM Fix some encoding issues Convriaht en U5 76 jeremy 9 4 2012 5 39 44 PM Update M1 Pl summary statistics Editor Figure 22 The Revision History view Revision history includes the date and time a change was made the identity of the person who made the change and any notes the person may have entered when saving the changes You can choose to view either the Remote History or the Local History using the dropdown button above the history list Future versions of Colectica Designer will allow you to revert to older revisions of an item View Differences between Revisions Colectica can show what changes have been made between two versions of an item 1 Select two versions in the Revision History window 2 Right click your selection and choose the Compare Versions command Colectica will display a difference viewer containing the properties that have changed Send Feedback Colectica Designer allows you to send your feedback to the Colectica developers directly from within the program 1 Fromthe File menu click the Send Feedback button 25 2 Fill out the contact form and
96. stom Fields item from the main menu The Manage Custom fields dialog will appear 2 Select the custom field you wish to remove 3 Click the Remove button 4 Close the dialogs If individual items have values for a custom field and the custom field is removed the values are not removed This only prevents the custom field from appearing for items that do not already have a value defined 83 Chapter 12 Generate Documentation In this chapter e Create documentation e Customize documentation templates Create Documentation Colectica can generate documentation for any item Your documentation can be made in PDF HTML or Rich Text format To generate documentation for an item click the Generate Documentation button on the ribbon Calectica Import Help Commands w p E 3 9 lt dd gt lt ddi gt X Add Add Resource Duplicate Generate Generate Remove Import Harmonization Generate m Study Package Item DDI3 DDI2 Sheet Documentation Add Export Remove Import Documentation Figure 57 The Generate Documentation button on the Ribbon After clicking the Generate Documentation button the Generate Documentation dialog will appear This dialog lets you set some options for your documentation General Options You can specify the title and subtitle as well as custom header and footer text to be included in your documentation In the Output Location field select the directory where the output should be written Ge
97. t or mo o What is pour tepron numbe CO What is Person Person Counter d O a ee M What is Person Person Counter 25 What is Person PersonCounter i P Is Person jPersonCounter of Hi D What is Person Person Counter cD Does Person Persan Counter 5 C How is this person related ta Pi zz Sequences z Instruments z 2010 Instrument Data b Modules E Ss You can use the main Navigator to find a question and drag the item onto your survey in the desired location The question will be inserted into the survey 61 Add a Question method Z 2010 Instrument Agency example org Design BasicInformation Fj num j Sequence Agency example org M Sequence Last Updated 2011 04 05 04 04 fence Order InOrderOfAppearance Add a new Sequence Reuse a Sequence Add Custom Code Add a Conditional Add a Far Loop Add a While Loop Add a Until Loop Alternatively you can right click the location where you would like to add a question and choose Add a Question Add a Question method 2 gt S D How many people were living or staying in this house apartment or mobile hom amp J United States Census 2010 44 2010 Questions oF D Were there any additional people staying here April 1 2010 that you did not inclu Is this house apartment or mobile home D What is your telephone number We may call if we don t understand an answer D What is Person PersonCounter s n
98. t specified for a given RepositoryConnectionInfo element the user will be prompted for this information the first time they attempt to access the repository lt xml version 1 0 encoding utf 8 lt RepositoryManager xmlns xsdz http www w3 0rg 2001 XMLSchema xmlns xsi http www w3 org 2001 XMLSchema instance gt lt Repositories gt RepositoryConnectionInfo Url repository1 example org Url lt UserName gt user1 lt UserName gt lt Password gt password lt Password gt lt RepositoryConnectionInfo gt RepositoryConnectionInfo Url repository2 example org Url RepositoryConnectionInfo Repositories AgencyID example org AgencyID lt The default agency ID gt lt RepositoryManager gt Workflow Server Configuration File Format The workflow server configuration file is an XML format A sample appears below ArrayOfWorkflowServerConnectionInfo xmlns xsdz http www w3 0rg 2001 XMLSchema xml ns xsi http www w3 org 2001 XMLSchema instance gt lt WorkflowServerConnectionInfo gt Url http localhost 1943 Url AuthenticationMethod UserName AuthenticationMethod UserName admin UserName lt Password gt password lt Password gt WorkflowServerConnectionInfo 114 ArrayOfWorkflowServerConnectionInfo Agency Identifiers and Repository Selection For each repository configured in Colectica Designer the application requests a list of agency identifiers for w
99. tion k Project A group of related studies and resources Mn Series A group of repeated studies di Study A data centric study a Metadata Package A collection of reusable metadata definitions General and Conceptual Information Item Type Description Concept Describe the basic ideas being explored by a study Concept Set A set of related concepts i Universe Describes the population being studied Universe Set A set of related universes Jeu Organization An institution company or other organization c Organization Set A set of related organizations Classifications Item Type Description Category Generic term for items at any level within a classification Category Set A set of related categories Code Associates a numeric or alphanumeric value with a category Code Set A set of related codes Data Collection Item Type Description Data Collection Information about the data collection process Question A question that is asked to a survey respondent gt Question Set A set of related questions Sequence A reusable sequence of questions and control constructs Instrument A questionnaire Data Item Type Description i Variable A reusable logical description of a column of data T Variable Set A set of related variables Data Relationship Describes the layout of a data file Record Layout Describes which variables appear in which order within a dataset Physical Structure Describes the f
100. type of development the burden of learning the intricacies of a CAI system may not prove cost effective Algenta will create a CAI instrument to your specifications We have experience working with many CAI systems including Blaise CASES CS Pro and others In addition to receiving the executable source code you will receive full documentation in the form of diagrams codebooks and DDI 3 metadata Metadata Preparation Large metadata preparation projects are labor intensive Since these projects are often done infrequently it can be a burden for organizations to hire and train staff who will only be employed for a short period of time Algenta s metadata preparation services can solve this problem In most cases Algenta will develop tools to parse your existing data from its source form and publish it to a Colectica Repository from which you have full access to your metadata over the web through the Colectica Designer or in standards based formats In situations where automatic data migration is not possible Algenta can manually process your data We have experience preparing many types of metadata Survey Instruments Algenta can create publishable instrument diagrams and code books from your existing data collection instruments By linking data documentation to documentation of the origin of the data researchers can get a clearer picture of the data with which they are working Classification Development Algenta can create
101. ype File Location Repository GlobalRepositoryConfigurationPath Workflow Server GlobalWorkflowServerConfigurationPath Server List File Format The format for the server list file is simply one server per line Each line may contain three fields separated by a comma e The first field is the URL of the server If no port is specified Colectica uses the default For Colectica Repository this is 19893 113 e The second field is optional and specifies the authentication type Windows or Username If the field is not specified Username is used as the default If Windows authentication is specified the user will not be prompted for a username and password when accessing a repository but the user s Windows credentials will be used instead e The third field is optional and specifies the transport method NetTcp HttpsBasic HttpsWs or HttpPlainText repositoryl example org repository2 example org 19899 repository3 example org Windows repository4 example org Windows NetTcp Sample repository list file Configuration location for individual users To deploy a server configuration for a single user deploy the configuration file as Server Type File Location Repository Sappdatas Algenta Colectica repositories xml Workflow Server Sappdata s Algenta Colectica workflowServers xml Repository Configuration File Format The repository configuration file is an XML format A sample appears below If the UserName and Password are no

Colectica User Manual

Contents

Download Pdf Manuals

Related Search

Related Contents