Difference between revisions of "ExportSettingsInspireFile class"

From Catglobe Wiki
Jump to: navigation, search
(Created page with "{{CGscriptClass_Template |Name=ExportSettingsInspireFile |Description=Export settings for the Inspire, Trace and Sas File format. |Methods= {{CGscriptMethods_Template|ReturnTy...")
 
Line 30: Line 30:
 
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=TypeInformation|HasGetter=1|Description=Get information about this class.}}
 
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=TypeInformation|HasGetter=1|Description=Get information about this class.}}
 
}}
 
}}
 +
=== <span style="color:#DF8621">'''Examples'''</span> ===
 +
'''Example: '''
 +
<source lang="javascript">
 +
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();
 +
</source>

Revision as of 07:46, 24 April 2017

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
  • 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

Example:

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();