ExportManager class - Revision history

Administrator at 05:00, 28 July 2022

2022-07-28T05:00:49Z

← Older revision		Revision as of 05:00, 28 July 2022
Line 74:		Line 74:
	<source lang="javascript">		<source lang="javascript">
	//create new export job		//create new export job
	~~number~~ ResourceName={"Test - export"};		string ResourceName="Test - export";
	number qnaire = {15638322};		number qnaire = 15638322;
	ExportManager EM= new ExportManager (ResourceName, qnaire );		ExportManager EM= new ExportManager (ResourceName, qnaire );
	EM.AddQuestionnaire(qnaire);		EM.AddQuestionnaire(qnaire);

Administrator at 07:03, 2 July 2020

2020-07-02T07:03:42Z

Administrator at 10:41, 4 February 2020

2020-02-04T10:41:51Z

← Older revision		Revision as of 10:41, 4 February 2020
Line 49:		Line 49:
	{{CGscriptProperties_Template\|ReturnType=string\|Name=<nowiki>UnicodeCodePage</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Get/set the codepage used in the files</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=string\|Name=<nowiki>UnicodeCodePage</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Get/set the codepage used in the files</nowiki>}}
	}}		}}

Nguyenduyan at 02:44, 20 June 2018

2018-06-20T02:44:03Z

@@ Line 72: / Line 72: @@
 EM.Save();
 //EM.Export();
 </source>

Nguyenduyan at 08:22, 31 May 2018

2018-05-31T08:22:36Z

Show changes

14.186.190.165 at 09:24, 16 May 2017

2017-05-16T09:24:50Z

← Older revision		Revision as of 09:24, 16 May 2017
Line 53:		Line 53:
	//get an existing export		//get an existing export
	number ExportRId = ;		number ExportRId = ;
	~~ExportManger~~ EM = new ~~ExportManger~~(ExportRId);		ExportManager EM = new ExportManager(ExportRId);
	ExportSettingsExcelCsvFile exportSetting = EM.ExportSettingsExcelCsvFile;		ExportSettingsExcelCsvFile exportSetting = EM.ExportSettingsExcelCsvFile;
	exportSetting.Clear();		exportSetting.Clear();
Line 61:		Line 61:
	bool exportToCsv = true;		bool exportToCsv = true;
	bool exportToExcel = false;		bool exportToExcel = false;
	exportSetting.~~AddAllQuestions~~(questionnaireResourceId, questionLabel, presentAsText, exportToCsv, exportToExcel );		exportSetting.AddQuestion(questionnaireResourceId, questionLabel, presentAsText, exportToCsv, exportToExcel );
	exportSetting.ExcelFileOptionsUseCommaSeparatedFormat = true;		exportSetting.ExcelFileOptionsUseCommaSeparatedFormat = true;
			exportSetting.ExportAddressInformation= false;
			exportSetting.ExportPhoneNumbers = false;
			exportSetting.ExportUserAccountInformation = false;
			exportSetting.ExportUserEmail = false;
	EM.Save();		EM.Save();
	EM.Export();		//EM.Export();
	</source>		</source>

14.186.190.165 at 09:09, 16 May 2017

2017-05-16T09:09:19Z

← Older revision		Revision as of 09:09, 16 May 2017
Line 48:		Line 48:
	{{CGscriptProperties_Template\|ReturnType=string\|Name=UnicodeCodePage\|HasGetter=1\|HasSetter=1\|Description=Get/set the codepage used in the files}}		{{CGscriptProperties_Template\|ReturnType=string\|Name=UnicodeCodePage\|HasGetter=1\|HasSetter=1\|Description=Get/set the codepage used in the files}}
	}}		}}

			=== <span style="color:#DF8621">'''Examples'''</span> ===
			<source lang="javascript">
			//get an existing export
			number ExportRId = ;
			ExportManger EM = new ExportManger(ExportRId);
			ExportSettingsExcelCsvFile exportSetting = EM.ExportSettingsExcelCsvFile;
			exportSetting.Clear();
			number questionnaireResourceId = ;
			string questionLabel = "";
			bool presentAsText = false;
			bool exportToCsv = true;
			bool exportToExcel = false;
			exportSetting.AddAllQuestions(questionnaireResourceId, questionLabel, presentAsText, exportToCsv, exportToExcel );
			exportSetting.ExcelFileOptionsUseCommaSeparatedFormat = true;
			EM.Save();
			EM.Export();
			</source>

Nguyenduyan: Created page with "{{CGscriptClass_Template |Name=ExportManager |Description=Export data and users. |Constructors= {{CGscriptConstructors_Template|Parameters= {{CGscriptParameters_Template|Type=..."

2017-03-02T05:24:03Z

Created page with "{{CGscriptClass_Template |Name=ExportManager |Description=Export data and users. |Constructors= {{CGscriptConstructors_Template|Parameters= {{CGscriptParameters_Template|Type=..."

New page

{{CGscriptClass_Template
|Name=ExportManager
|Description=Export data and users.
|Constructors=
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=int|Name=ResourceId|Description=Resource Id of the Export}}
|Description=Instanciate an existing instance using the resource id of an export}}
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=string|Name=ResourceName|Description=Resource name of the new export|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=parentResourceId|Description=Parent to store the DCS export under}}
|Description=Create a new export}}
|Methods=
{{CGscriptMethods_Template|ReturnType=bool|Name=AddQuestionnaire|Parameters=
{{CGscriptParameters_Template|Type=int|Name=questionnaireResourceId|Description=Resource id of the questionnaire to export data from}}
|Description=Add questionnaire to export data from. Return false if already added}}
{{CGscriptMethods_Template|ReturnType=string|Name=Export|Description=Run the export. Implicitly commits the current transaction}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=Reset|Description=Remove all questionnaires from the export and clear all format settings}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=Save|Description=Save the DataCache}}
{{CGscriptMethods_Template|ReturnType=string|Name=ToString|Description=The string representation of the object.}}
|Properties=
{{CGscriptProperties_Template|ReturnType=DateTime|Name=CGEndTimeFrameUTC|HasGetter=1|HasSetter=1|Description=Get/set the maximum end time of QAS}}
{{CGscriptProperties_Template|ReturnType=DateTime|Name=CGStartTimeFrameUTC|HasGetter=1|HasSetter=1|Description=Get/set the minimum end time of QAS}}
{{CGscriptProperties_Template|ReturnType=ExportSettingsAsciiFile|Name=ExportSettingsAsciiFile|HasGetter=1|Description=Get settings for specific format}}
{{CGscriptProperties_Template|ReturnType=ExportSettingsExcelCsvFile|Name=ExportSettingsExcelCsvFile|HasGetter=1|Description=Get settings for specific format}}
{{CGscriptProperties_Template|ReturnType=ExportSettingsInspireFile|Name=ExportSettingsInspireSasTraceFile|HasGetter=1|Description=Get settings for specific format}}
{{CGscriptProperties_Template|ReturnType=ExportSettingsNipoFile|Name=ExportSettingsNipoFile|HasGetter=1|Description=Get settings for specific format}}
{{CGscriptProperties_Template|ReturnType=ExportSettingsSpssFile|Name=ExportSettingsSpssFile|HasGetter=1|Description=Get settings for specific format}}
{{CGscriptProperties_Template|ReturnType=ExportSettingsTripleSFile|Name=ExportSettingsTripleSFile|HasGetter=1|Description=Get settings for specific format}}
{{CGscriptProperties_Template|ReturnType=bool|Name=IncludedDeletedUsers|HasGetter=1|HasSetter=1|Description=Get/set if include QAS on deleted users or not}}
{{CGscriptProperties_Template|ReturnType=bool|Name=IncludedDisabledUsers|HasGetter=1|HasSetter=1|Description=Get/set if include QAS on disabled users or not}}
{{CGscriptProperties_Template|ReturnType=bool|Name=IncludedTestData|HasGetter=1|HasSetter=1|Description=Get/set if include test QAS or not}}
{{CGscriptProperties_Template|ReturnType=string|Name=Language|HasGetter=1|HasSetter=1|Description=Get/set the language used when exporting text}}
{{CGscriptProperties_Template|ReturnType=int|Name=LimitToGroupResourceId|HasGetter=1|HasSetter=1|Description=Get/set the group that limits the people included in the export}}
{{CGscriptProperties_Template|ReturnType=string|Name=Name|HasGetter=1|HasSetter=1|Description=Get/set the name of the export}}
{{CGscriptProperties_Template|ReturnType=string|Name=ObjectTypeName|HasGetter=1|Description=The name of the type of object.}}
{{CGscriptProperties_Template|ReturnType=bool|Name=QasCompleted|HasGetter=1|HasSetter=1|Description=Get/set if include Completed QAS or not}}
{{CGscriptProperties_Template|ReturnType=bool|Name=QasInterviewFailed|HasGetter=1|HasSetter=1|Description=Get/set if include QAS with interview failed status or not}}
{{CGscriptProperties_Template|ReturnType=bool|Name=QasInterviewSucceded|HasGetter=1|HasSetter=1|Description=Get/set if include QAS with interview successed status or not}}
{{CGscriptProperties_Template|ReturnType=bool|Name=QasNormal|HasGetter=1|HasSetter=1|Description=Get/set if include QAS with normal status or not}}
{{CGscriptProperties_Template|ReturnType=bool|Name=QasNotStarted|HasGetter=1|HasSetter=1|Description=Get/set if include unstarted QAS or not}}
{{CGscriptProperties_Template|ReturnType=bool|Name=QasOutsideTarget|HasGetter=1|HasSetter=1|Description=Get/set if include QAS with outside target status or not}}
{{CGscriptProperties_Template|ReturnType=bool|Name=QasPartly|HasGetter=1|HasSetter=1|Description=Get/set if include partly Completed QAS or not}}
{{CGscriptProperties_Template|ReturnType=bool|Name=QasQuotaFull|HasGetter=1|HasSetter=1|Description=Get/set if include QAS with quota full status or not}}
{{CGscriptProperties_Template|ReturnType=int|Name=ResourceId|HasGetter=1|Description=Get the resource id of the export}}
{{CGscriptProperties_Template|ReturnType=array|Name=SecondaryQasMergeAvailableMethods|HasGetter=1|Description=Get which methods are available for SecondaryQasMergeMethod}}
{{CGscriptProperties_Template|ReturnType=string|Name=SecondaryQasMergeMethod|HasGetter=1|HasSetter=1|Description=Get/set which method to use to link together QAS from the secondary questionnaires to the primary, when there is more than 1}}
{{CGscriptProperties_Template|ReturnType=bool|Name=SelectTimeFrame|HasGetter=1|HasSetter=1|Description=Get/set if CGStartTimeFrameUTC and CGEndTimeFrameUTC are used or not}}
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=TypeInformation|HasGetter=1|Description=Get information about this class.}}
{{CGscriptProperties_Template|ReturnType=string|Name=UnicodeCodePage|HasGetter=1|HasSetter=1|Description=Get/set the codepage used in the files}}
}}

← Older revision		Revision as of 07:03, 2 July 2020
Line 2:		Line 2:
	\|Name=<nowiki>ExportManager</nowiki>		\|Name=<nowiki>ExportManager</nowiki>
	\|Description=<nowiki>Export data and users.</nowiki>		\|Description=<nowiki>Export data and users.</nowiki>
	\|Constructors=		\|InheritsFrom=object\|Constructors=
	{{CGscriptConstructors_Template\|Parameters=		{{CGscriptConstructors_Template\|Parameters=
	{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>ResourceId</nowiki>\|Description=<nowiki>Resource Id of the Export</nowiki>}}		{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>ResourceId</nowiki>\|Description=<nowiki>Resource Id of the Export</nowiki>}}
Line 16:		Line 16:
	{{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>Reset</nowiki>\|Description=<nowiki>Remove all questionnaires from the export and clear all format settings</nowiki>}}		{{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>Reset</nowiki>\|Description=<nowiki>Remove all questionnaires from the export and clear all format settings</nowiki>}}
	{{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>Save</nowiki>\|Description=<nowiki>Save the DataCache</nowiki>}}		{{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>Save</nowiki>\|Description=<nowiki>Save the DataCache</nowiki>}}
	{{CGscriptMethods_Template\|ReturnType=string\|Name=<nowiki>ToString</nowiki>\|Description=<nowiki>The string representation of the object.</nowiki>}}		{{CGscriptMethods_Template\|ReturnType=string\|Name=<nowiki>ToString</nowiki>\|Inherited=object\|Description=<nowiki>The string representation of the object.</nowiki>}}
	\|Properties=		\|Properties=
	{{CGscriptProperties_Template\|ReturnType=DateTime\|Name=<nowiki>CGEndTimeFrameUTC</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Get/set the maximum end time of QAS</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=DateTime\|Name=<nowiki>CGEndTimeFrameUTC</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Get/set the maximum end time of QAS</nowiki>}}
Line 46:		Line 46:
	{{CGscriptProperties_Template\|ReturnType=string\|Name=<nowiki>SecondaryQasMergeMethod</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Get/set which method to use to link together QAS from the secondary questionnaires to the primary, when there is more than 1</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=string\|Name=<nowiki>SecondaryQasMergeMethod</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Get/set which method to use to link together QAS from the secondary questionnaires to the primary, when there is more than 1</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=bool\|Name=<nowiki>SelectTimeFrame</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Get/set if CGStartTimeFrameUTC and CGEndTimeFrameUTC are used or not</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=bool\|Name=<nowiki>SelectTimeFrame</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Get/set if CGStartTimeFrameUTC and CGEndTimeFrameUTC are used or not</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=TypeInformation\|Name=<nowiki>TypeInformation</nowiki>\|HasGetter=1\|Description=<nowiki>Get information about this class.</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=TypeInformation\|Name=<nowiki>TypeInformation</nowiki>\|HasGetter=1\|Inherited=object\|Description=<nowiki>Get information about this class.</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=string\|Name=<nowiki>UnicodeCodePage</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Get/set the codepage used in the files</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=string\|Name=<nowiki>UnicodeCodePage</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Get/set the codepage used in the files</nowiki>}}
	}}		}}


	=== <span style="color:#DF8621">'''Examples'''</span> ===		=== <span style="color:#DF8621">'''Examples'''</span> ===