Difference between revisions of "ExportSettingsInspireFile class"

From Catglobe Wiki
Jump to: navigation, search
Line 1: Line 1:
 
{{CGscriptClass_Template
 
{{CGscriptClass_Template
−
|Name=ExportSettingsInspireFile
+
|Name=<nowiki>ExportSettingsInspireFile</nowiki>
−
|Description=Export settings for the Inspire, Trace and Sas File format.
+
|Description=<nowiki>Export settings for the Inspire, Trace and Sas File format.</nowiki>
 
|Methods=
 
|Methods=
−
{{CGscriptMethods_Template|ReturnType=Empty|Name=AddAllQuestions|Parameters=
+
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>AddAllQuestions</nowiki>|Parameters=
−
{{CGscriptParameters_Template|Type=int|Name=questionnaireResourceId|Description=The questionnaire the question is located in|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=exportToSas|Description=Export to the given format|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=exportToTrace|Description=Export to the given format|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=exportToInspire|Description=Export to the given format}}
+
{{CGscriptParameters_Template|Type=int|Name=<nowiki>questionnaireResourceId</nowiki>|Description=<nowiki>The questionnaire the question is located in</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>exportToSas</nowiki>|Description=<nowiki>Export to the given format</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>exportToTrace</nowiki>|Description=<nowiki>Export to the given format</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>exportToInspire</nowiki>|Description=<nowiki>Export to the given format</nowiki>}}
−
|Description=Add all questions to the export}}
+
|Description=<nowiki>Add all questions to the export. Default ignore GDPR classified questions.</nowiki>}}
−
{{CGscriptMethods_Template|ReturnType=Empty|Name=AddQuestion|Parameters=
+
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>AddAllQuestions</nowiki>|Parameters=
−
{{CGscriptParameters_Template|Type=int|Name=questionnaireResourceId|Description=The questionnaire the question is located in|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=questionLabel|Description=Label of the question|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=exportToSas|Description=Export to the given format|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=exportToTrace|Description=Export to the given format|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=exportToInspire|Description=Export to the given format}}
+
{{CGscriptParameters_Template|Type=int|Name=<nowiki>questionnaireResourceId</nowiki>|Description=<nowiki>The questionnaire the question is located in</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>exportToSas</nowiki>|Description=<nowiki>Export to the given format</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>exportToTrace</nowiki>|Description=<nowiki>Export to the given format</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>exportToInspire</nowiki>|Description=<nowiki>Export to the given format</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>includeQuestionWithGDPRDate</nowiki>|Description=<nowiki>Include questions marked as containing GDPR classified data</nowiki>}}
−
|Description=Add question to the export}}
+
|Description=<nowiki>Add all questions to the export</nowiki>}}
−
{{CGscriptMethods_Template|ReturnType=Empty|Name=Clear|Description=Remove format from output}}
+
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>AddQuestion</nowiki>|Parameters=
−
{{CGscriptMethods_Template|ReturnType=int|Name=GridIndex|Parameters=
+
{{CGscriptParameters_Template|Type=int|Name=<nowiki>questionnaireResourceId</nowiki>|Description=<nowiki>The questionnaire the question is located in</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>questionLabel</nowiki>|Description=<nowiki>Label of the question</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>exportToSas</nowiki>|Description=<nowiki>Export to the given format</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>exportToTrace</nowiki>|Description=<nowiki>Export to the given format</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>exportToInspire</nowiki>|Description=<nowiki>Export to the given format</nowiki>}}
−
{{CGscriptParameters_Template|Type=int|Name=questionnaireResourceId|Description=The questionnaire the question is located in|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=questionLabel|Description=Label of the question}}
+
|Description=<nowiki>Add question to the export</nowiki>}}
−
|Description=Return GridIndex of question in export}}
+
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Clear</nowiki>|Description=<nowiki>Remove format from output</nowiki>}}
−
{{CGscriptMethods_Template|ReturnType=bool|Name=IsQuestionExported|Parameters=
+
{{CGscriptMethods_Template|ReturnType=int|Name=<nowiki>GridIndex</nowiki>|Parameters=
−
{{CGscriptParameters_Template|Type=int|Name=questionnaireResourceId|Description=The questionnaire the question is located in|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=questionLabel|Description=Label of the question}}
+
{{CGscriptParameters_Template|Type=int|Name=<nowiki>questionnaireResourceId</nowiki>|Description=<nowiki>The questionnaire the question is located in</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>questionLabel</nowiki>|Description=<nowiki>Label of the question</nowiki>}}
−
|Description=Return true if question is exported}}
+
|Description=<nowiki>Return GridIndex of question in export</nowiki>}}
−
{{CGscriptMethods_Template|ReturnType=string|Name=ToString|Description=The string representation of the object.}}
+
{{CGscriptMethods_Template|ReturnType=bool|Name=<nowiki>IsQuestionExported</nowiki>|Parameters=
 +
{{CGscriptParameters_Template|Type=int|Name=<nowiki>questionnaireResourceId</nowiki>|Description=<nowiki>The questionnaire the question is located in</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>questionLabel</nowiki>|Description=<nowiki>Label of the question</nowiki>}}
 +
|Description=<nowiki>Return true if question is exported</nowiki>}}
 +
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}}
 
|Properties=
 
|Properties=
−
{{CGscriptProperties_Template|ReturnType=bool|Name=ExportAddressInformation|HasGetter=1|HasSetter=1|Description=Get/set if exporting to specific format with given option}}
+
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>ExportAddressInformation</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set if exporting to specific format with given option</nowiki>}}
−
{{CGscriptProperties_Template|ReturnType=bool|Name=ExportPhoneNumbers|HasGetter=1|HasSetter=1|Description=Get/set if exporting to specific format with given option}}
+
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>ExportPhoneNumbers</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set if exporting to specific format with given option</nowiki>}}
−
{{CGscriptProperties_Template|ReturnType=bool|Name=ExportUserAccountInformation|HasGetter=1|HasSetter=1|Description=Get/set if exporting to specific format with given option}}
+
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>ExportUserAccountInformation</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set if exporting to specific format with given option</nowiki>}}
−
{{CGscriptProperties_Template|ReturnType=bool|Name=ExportUserEmail|HasGetter=1|HasSetter=1|Description=Get/set if exporting to specific format with given option}}
+
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>ExportUserEmail</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set if exporting to specific format with given option</nowiki>}}
−
{{CGscriptProperties_Template|ReturnType=bool|Name=IsInspireFileFileExport|HasGetter=1|Description=Get if exporting to specific format}}
+
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>IsInspireFileFileExport</nowiki>|HasGetter=1|Description=<nowiki>Get if exporting to specific format</nowiki>}}
−
{{CGscriptProperties_Template|ReturnType=bool|Name=IsSasFileFileExport|HasGetter=1|Description=Get if exporting to specific format}}
+
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>IsSasFileFileExport</nowiki>|HasGetter=1|Description=<nowiki>Get if exporting to specific format</nowiki>}}
−
{{CGscriptProperties_Template|ReturnType=bool|Name=IsTraceFileFileExport|HasGetter=1|Description=Get if exporting to specific format}}
+
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>IsTraceFileFileExport</nowiki>|HasGetter=1|Description=<nowiki>Get if exporting to specific format</nowiki>}}
−
{{CGscriptProperties_Template|ReturnType=string|Name=ObjectTypeName|HasGetter=1|Description=The name of the type of object.}}
+
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}}
−
{{CGscriptProperties_Template|ReturnType=bool|Name=SasFileOptionsIncludeSasLabel|HasGetter=1|HasSetter=1|Description=Get/set if exporting to specific format with given option}}
+
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>SasFileOptionsIncludeSasLabel</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set if exporting to specific format with given option</nowiki>}}
−
{{CGscriptProperties_Template|ReturnType=int|Name=TraceFileOptionsDuration|HasGetter=1|HasSetter=1|Description=Get/set if exporting to specific format with given option}}
+
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>TraceFileOptionsDuration</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set if exporting to specific format with given option</nowiki>}}
−
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=TypeInformation|HasGetter=1|Description=Get information about this class.}}
+
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}}
 
}}
 
}}
  

Revision as of 12:30, 4 February 2020

ExportSettingsInspireFile



Export settings for the Inspire, Trace and Sas File format.


Methods

  • Empty AddAllQuestions(int questionnaireResourceId "The questionnaire the question is located in", bool exportToSas "Export to the given format", bool exportToTrace "Export to the given format", bool exportToInspire "Export to the given format") - Add all questions to the export. Default ignore GDPR classified questions.
  • Empty AddAllQuestions(int questionnaireResourceId "The questionnaire the question is located in", bool exportToSas "Export to the given format", bool exportToTrace "Export to the given format", bool exportToInspire "Export to the given format", bool includeQuestionWithGDPRDate "Include questions marked as containing GDPR classified data") - Add all questions to the export
  • Empty AddQuestion(int questionnaireResourceId "The questionnaire the question is located in", string questionLabel "Label of the question", bool exportToSas "Export to the given format", bool exportToTrace "Export to the given format", bool exportToInspire "Export to the given format") - Add question to the export
  • Empty Clear() - Remove format from output
  • int GridIndex(int questionnaireResourceId "The questionnaire the question is located in", string questionLabel "Label of the question") - Return GridIndex of question in export
  • bool IsQuestionExported(int questionnaireResourceId "The questionnaire the question is located in", string questionLabel "Label of the question") - Return true if question is exported
  • string ToString() - The string representation of the object.

Properties

  • bool ExportAddressInformation { get; set; } - Get/set if exporting to specific format with given option
  • bool ExportPhoneNumbers { get; set; } - Get/set if exporting to specific format with given option
  • bool ExportUserAccountInformation { get; set; } - Get/set if exporting to specific format with given option
  • bool ExportUserEmail { get; set; } - Get/set if exporting to specific format with given option
  • bool IsInspireFileFileExport { get; } - Get if exporting to specific format
  • bool IsSasFileFileExport { get; } - Get if exporting to specific format
  • bool IsTraceFileFileExport { get; } - Get if exporting to specific format
  • string ObjectTypeName { get; } - The name of the type of object.
  • bool SasFileOptionsIncludeSasLabel { get; set; } - Get/set if exporting to specific format with given option
  • int TraceFileOptionsDuration { get; set; } - Get/set if exporting to specific format with given option
  • TypeInformation TypeInformation { get; } - Get information about this class.


Examples

string ResourceName="test ExportManager type Sas, Trace, Inspire";
number parentResourceId = 11088827;
ExportManager EM = new ExportManager (ResourceName, parentResourceId ); 
number questionnaireResourceId = 15546533;
EM.AddQuestionnaire(questionnaireResourceId); 
ExportSettingsInspireFile exportSetting = EM.ExportSettingsInspireSasTraceFile;
bool exportToSas = true;
bool exportToTrace = true;
bool exportToInspire = true;
exportSetting.AddAllQuestions(questionnaireResourceId, exportToSas , exportToTrace , exportToInspire );
exportSetting.SasFileOptionsIncludeSasLabel = true;
exportSetting.TraceFileOptionsDuration = 1;
EM.Language ="en-GB"; 
DateTime startTime = new DateTime ("2017-4-18");
DateTime endTime = new DateTime ("2017-4-19");
EM.SelectTimeFrame =true;
EM.CGStartTimeFrameUTC = startTime;
EM.CGEndTimeFrameUTC = endTime; 
EM.QasNotStarted = false;
EM.QasPartly = false;
EM.QasCompleted = true; 
EM.QasNormal = true;
EM.QasQuotaFull = false;
EM.QasOutsideTarget = false;
EM.QasInterviewFailed = false;
EM.QasInterviewSucceded = true; 
EM.IncludedTestData= false;
EM.IncludedDeletedUsers = false;
EM.IncludedDisabledUsers = false;
EM.Save();
EM.Export();
Retrieved from "http://wiki.catglobe.com/index.php?title=ExportSettingsInspireFile_class&oldid=239484"