Skip to content

Custom Reports

Under Custom Reports, the Custom Export screen is where you can create a report customized to your preferred format, optionally filter questions, and export the report.

You can have as many custom Export Formats as necessary. Export Formats are not study specific and are available to the entire organization once created.

Custom Export Overview

Select Type, Format, Filter Questions, and Export

The process to generate a Custom Report consists of these steps:

  1. Select the Format Type

    Select from the Codeframe or Results format types. Export Formats are specific to a Format Type.

  2. Select the Export Format

    Select an existing Export Format or Add a new format to your specifications. See Select Export Format and Edit Custom Export Format for more information.

  3. Select Question Filter Option

    If you want to filter the questions exported, click the Question Filter button to select the questions to include.

  4. Export the Selected Export Type and Format

    Once the export format and question filters are set, click the Export Codeframe/Results button to export the codeframes/results.

Select Export Format

This section allows you to add/remove/copy new custom export formats and select the format to use.

Custom Export Format Section

Choose Format Type (Codeframe or Results)

Toggles which set of custom export formats are visible. Codeframe and Results format types are specific to codeframes or specific to results data.

Add

Add a new custom format for the organization

Copy

Copy the currently chosen export format

Remove

Delete the custom export format for the organization (not just this study).

Addtional Options

Export Do Not Use Codes

Controls the export of codes marked as "do no use". By default these codes are not exported.

Question Filter

Click Question Filter to restricts the codeframes/results export to only specific questions.

Question Filter Button

Export Codeframe or Export Data

Click the Export Codeframe or Export Data button to export the custom codeframes/results report.

Export Codeframe Button or Export Data Button


Edit Custom Export Format

Edit details of the selected custom format at each export level.

Export Format Section

Fields

Format Name

Name of this specific format

Project Start

Custom format to apply at the start of a custom export

Question Start

Custom format to apply at the start of a Question during a custom export

Net Start

Custom format to apply at the start of a Net during a custom export

Code Start

Custom format to apply at the start of a Code during a custom export

Code End

Custom format to apply at the end of a Code during a custom export

Net End

Custom format to apply at the end of a Net during a custom export

Question End

Custom format to apply at the end of a Question during a custom export

Project End

Custom format to apply at the end of a custom export

Export Format Variables

Below is a reference of the available variables that can be used in the custom export formats.

General Export Options

name description type
[Date] Current date text
[NL] Insert line break text
[Tab] Insert a tab character text
[Time] Current time text

Code/CodeNet Export Options

name description type
[CChildren] Count of children (sub-codes) of this code (integer) integer
[CColumn] Code column (starting location of code on card) (integer) if output value is 456B then the code column in 456 and punch value is B. If column to left of punch value is non numeric then 00 is used instead. text
[CDescendants] Count of descendants (subcodes and their subcodes) of this code (integer 0 for Codes) integer
[CParentNetID] DAI Field. Id of the direct parent for this code or net integer
[CEndColumn] [CColumn] + [QColumns] - 1 integer
[CGroup] Code group number (e.g. 1.3.2) (This field is ordered from 1 to n based on position in the codebook. The first net gets a netgroup of 1 and and sub codes get a value of 1. Subnets start the process over. Codes under any subnet pickup the CGroup of the net above it.) text
[CHelp] Code help - text text
[CHover] Code hover help - text text
[CID] Output code value zero padded for column width (eg. 00005) - text text
[CIndent] Insert [CLevel] tab characters text
[CInputID] Input code value zero padded for column width (eg. 00005) - text text
[CKey] Key number for code (guaranteed unique) - text output cd_ text
[CLevel] Level of code in codebook (1 = top level) - integer integer
[CList] List of all descendant code values (but no nets), separated by commas and zero padded for column width based on input ids text
[CNumber] Code row number - integer integer
[ColPunch] Same as [CColumn]'[CPunch]' – text text
[COutputID] Output code value zero padded for column width (eg. 00005) text
[COutputIDRaw] Output code minus the padding text
[CPunch] Code punch (rightmost character of code value) text
[CPunchList] List of all descendant code [ColPunch] values (but no nets), separated by commas based on output value text
[CPunchListOr] c23'534'.or.c26'18x'.or.c34'2579'... card number and punch code formatted based on card width and question width text
[CRegExp] Regular expression text
[CRelCol] [CColumn] - [QColumn] integer
[CText] Code description text
[CCodesApplied] Codes applied text

Respondent Export Options

name description type
[RID] Respondent ID text
[ARID] Alternate Respondent ID text
[RNote] Notes text
[RNoteReview] 1 if Note is reviewed, 0 if not integer
[RTrans] Transcription text
[RTransReview] 1 if Transcription is reviewed, 0 if not integer
[RTranslation] Translation text
[RTranslationReview] 1 if Translation is reviewed, 0 if not integer
[RVerbatim] Verbatim response text
[RVerbatim:QID] Verbatim response for this respondent in question QID text
[RVerbatimReview] 1 if Verbatim is reviewed, 0 if not integer

Question Export Options

name description type
[QCard] Question card zero padded to card width. Default to 00 with max up to 99999 text
[QCBKey] Key number of codebook (guaranteed unique) cb_q text
[QCodesApplied] Codes applied integer
[QColumn] Question column start position of question in layout integer
[QColumns] Question columns width of code in question layout integer
[QEndColumn] [QColumn] + [QColumns]*([QMaxCodes] - 1) + [Qcolumns] integer
[QHelp] Question help text
[QID] Question ID integer
[QKey] Key number for question (guaranteed unique) c_ text
[QLabel] Question Label text
[QMaxCodes] Maximum number of codes to output integer
[QMaxOutputID] Maximum numeric value of OutputID of non-net codes integer
[QResponsesCoded] Responses coded integer
[QResponsesCurrent] Responses current integer
[QResponsesLoaded] Responses loaded integer
[QResponsesRef] Responses referred integer
[QResponsesTranscribed] Responses transcribed integer
[QResponsesTranslated] Responses translated integer
[QText] Question text text
[QType] Question type (0: Open, 1: Closed, 2: Other specify, 3: Value) integer
[QTypeName] Question Type text

Study Export Options

name description type
[SCardCols] Columns per card / respondent integer
[SCardNumCol] Card number column start integer
[SCardNumCols] Card number columns width integer
[SClosedQuestions] Closed questions integer
[SResponsesCoded] Responses coded integer
[SDesc] Study description text
[SID] Study ID text
[SLABEL] Friendly Study Label text
[SHelp] Help on this study text
[SName] Study name text
[SOpenQuestions] Open questions integer
[SOSQuestions] Other specify questions integer
[SResponses] Responses integer
[SRespondents] Respondents integer
[SRIDCol] Respondent ID column integer
[SRIDCols] Respondent ID columns integer
[SValueQuestions] Value questions integer