Difference between revisions of "ImportManager class"

From Catglobe Wiki
Jump to: navigation, search
Line 1: Line 1:
 
{{CGscriptClass_Template
 
{{CGscriptClass_Template
−
|Name=<nowiki>ImportManager</nowiki>
+
|Name=ImportManager
−
|Description=<nowiki>Import data and users.</nowiki>
+
|Description=Import data and users.
 
|Constructors=
 
|Constructors=
 
{{CGscriptConstructors_Template|Parameters=
 
{{CGscriptConstructors_Template|Parameters=
−
{{CGscriptParameters_Template|Type=array|Name=<nowiki>Headers</nowiki>|Description=<nowiki>A list of string that are the header names</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=array|Name=<nowiki>data</nowiki>|Description=<nowiki>Data to import. An array of arrays of equal length as the headers</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>advancedMode</nowiki>|Description=<nowiki>Enable setting advanced settings - Requires special navigation access</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=number|Name=<nowiki>groupResourceId</nowiki>|Description=<nowiki>Group to add users to new users to and/or sample rule. Set to 0 to not add to group</nowiki>}}
+
{{CGscriptParameters_Template|Type=array|Name=Headers|Description=A list of string that are the header names|Comma=,}}{{CGscriptParameters_Template|Type=array|Name=data|Description=Data to import. An array of arrays of equal length as the headers|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=advancedMode|Description=Enable setting advanced settings - Requires special navigation access|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=groupResourceId|Description=Group to add users to new users to and/or sample rule. Set to 0 to not add to group}}
−
|Description=<nowiki>Make a new import with the given data</nowiki>}}
+
|Description=Make a new import with the given data}}
 
|Methods=
 
|Methods=
−
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Import</nowiki>|Description=<nowiki>Run the Import. Note that this will commit any pending changes</nowiki>}}
+
{{CGscriptMethods_Template|ReturnType=Empty|Name=Import|Description=Run the Import. Note that this will commit any pending changes}}
−
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>SetDataImportOptions</nowiki>|Parameters=
+
{{CGscriptMethods_Template|ReturnType=Dictionary|Name=SetDataImportOptions|Parameters=
−
{{CGscriptParameters_Template|Type=number|Name=<nowiki>projectQuestionnaireResourceId</nowiki>|Description=<nowiki>The resource Id of where the data should be added/updated</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=number|Name=<nowiki>type</nowiki>|Description=<nowiki>How to treat when already have existing answer sheets. 1 for Zero or One AnswerSheet, 2 for delete existing and create new, 3 for mapping to rpqIdColumnName</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>rpqIdColumnName</nowiki>|Description=<nowiki>Mapping for column name in case type is 3</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>isCommaSeparatedFormat</nowiki>|Description=<nowiki>Import multi questions as comma separated format</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=Dictionary|Name=<nowiki>mapping</nowiki>|Description=<nowiki>Mapping between header names and import names. If empty, automapping is used</nowiki>}}
+
{{CGscriptParameters_Template|Type=int|Name=projectQuestionnaireResourceId|Description=The resource Id of where the data should be added/updated|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=type|Description=How to treat when already have existing answer sheets. 1 for Zero or One AnswerSheet, 2 for delete existing and create new, 3 for mapping to rpqIdColumnName|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=rpqIdColumnName|Description=Mapping for column name in case type is 3|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=isCommaSeparatedFormat|Description=Import multi questions as comma separated format|Comma=,}}{{CGscriptParameters_Template|Type=Dictionary|Name=mapping|Description=Mapping between header names and import names. If empty, automapping is used}}
−
|Description=<nowiki>Set specific options for importing data or altering existing data</nowiki>}}
+
|Description=Set specific options for importing data or altering existing data}}
−
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>SetUserImportOptions</nowiki>|Parameters=
+
{{CGscriptMethods_Template|ReturnType=Empty|Name=SetDefaultNewUser|Parameters=
−
{{CGscriptParameters_Template|Type=string|Name=<nowiki>userIdColumnName</nowiki>|Description=<nowiki>The header name of the userId column</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>userNameMask</nowiki>|Description=<nowiki>The mask used to create new usernames - an advanced setting</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>generatePasswords</nowiki>|Description=<nowiki>Generate passwords during import</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>importUserInfo</nowiki>|Description=<nowiki>Import or Update users</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>importPhoneNumber</nowiki>|Description=<nowiki>Import or Update phonenumbers</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>importAddress</nowiki>|Description=<nowiki>Import or Update addresses</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>importPoints</nowiki>|Description=<nowiki>Import or Update points</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>importQualification</nowiki>|Description=<nowiki>Import or Update qualifications</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=array|Name=<nowiki>permissions</nowiki>|Description=<nowiki>Determine which groups should have access to the new users</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=Dictionary|Name=<nowiki>mapping</nowiki>|Description=<nowiki>Mapping between header names and import names. If empty, automapping is used</nowiki>}}
+
{{CGscriptParameters_Template|Type=string|Name=languageIso|Description=Default language|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=cultureIso|Description=Default culture|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=currency|Description=Default currency}}
−
|Description=<nowiki>OBSOLETE. Use the new overload with parentResourceId.</nowiki>}}
+
|Description=Defaults for new users. If empty or not set, uses the global defaults}}
−
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>SetUserImportOptions</nowiki>|Parameters=
+
{{CGscriptMethods_Template|ReturnType=Empty|Name=SetUserImportOptions|Parameters=
−
{{CGscriptParameters_Template|Type=string|Name=<nowiki>userIdColumnName</nowiki>|Description=<nowiki>The header name of the userId column</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>userNameMask</nowiki>|Description=<nowiki>The mask used to create new usernames - an advanced setting</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>generatePasswords</nowiki>|Description=<nowiki>Generate passwords during import</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>importUserInfo</nowiki>|Description=<nowiki>Import or Update users</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>importPhoneNumber</nowiki>|Description=<nowiki>Import or Update phonenumbers</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>importAddress</nowiki>|Description=<nowiki>Import or Update addresses</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>importPoints</nowiki>|Description=<nowiki>Import or Update points</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>importQualification</nowiki>|Description=<nowiki>Import or Update qualifications</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=number|Name=<nowiki>parentResourceId</nowiki>|Description=<nowiki>Resource Id of the parent of the new users. Ignored if updating users</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=Dictionary|Name=<nowiki>mapping</nowiki>|Description=<nowiki>Mapping between header names and import names. If empty, automapping is used</nowiki>}}
+
{{CGscriptParameters_Template|Type=string|Name=userIdColumnName|Description=The header name of the userId column|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=userNameMask|Description=The mask used to create new usernames - an advanced setting|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=generatePasswords|Description=Generate passwords during import|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=importUserInfo|Description=Import or Update users|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=importPhoneNumber|Description=Import or Update phonenumbers|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=importAddress|Description=Import or Update addresses|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=importPoints|Description=Import or Update points|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=importQualification|Description=Import or Update qualifications|Comma=,}}{{CGscriptParameters_Template|Type=array|Name=permissions|Description=Determine which groups should have access to the new users|Comma=,}}{{CGscriptParameters_Template|Type=Dictionary|Name=mapping|Description=Mapping between header names and import names. If empty, automapping is used}}
−
|Description=<nowiki>Set specific options for importing new users or altering existing users</nowiki>}}
+
|Description=OBSOLETE. Use the new overload with parentResourceId.}}
−
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}}
+
{{CGscriptMethods_Template|ReturnType=Dictionary|Name=SetUserImportOptions|Parameters=
−
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>Validate</nowiki>|Description=<nowiki>Same as Validate(true)</nowiki>}}
+
{{CGscriptParameters_Template|Type=string|Name=userIdColumnName|Description=The header name of the userId column|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=userNameMask|Description=The mask used to create new usernames - an advanced setting|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=generatePasswords|Description=Generate passwords during import|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=importUserInfo|Description=Import or Update users|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=importPhoneNumber|Description=Import or Update phonenumbers|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=importAddress|Description=Import or Update addresses|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=importPoints|Description=Import or Update points|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=importQualification|Description=Import or Update qualifications|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=parentResourceId|Description=Resource Id of the parent of the new users. Ignored if updating users|Comma=,}}{{CGscriptParameters_Template|Type=Dictionary|Name=mapping|Description=Mapping between header names and import names. If empty, automapping is used}}
−
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>Validate</nowiki>|Parameters=
+
|Description=Set specific options for importing new users or altering existing users}}
−
{{CGscriptParameters_Template|Type=bool|Name=<nowiki>errorOnSemiOpenQuestion</nowiki>|Description=<nowiki>Set to false if you need to import to questions with open parts and know that it may partially delete existing data</nowiki>}}
+
{{CGscriptMethods_Template|ReturnType=string|Name=ToString|Description=The string representation of the object.}}
−
|Description=<nowiki>Validate prior to actual importing. Throws if errors, otherwise returns warning.</nowiki>}}
+
{{CGscriptMethods_Template|ReturnType=string|Name=Validate|Description=Same as Validate(true)}}
 +
{{CGscriptMethods_Template|ReturnType=string|Name=Validate|Parameters=
 +
{{CGscriptParameters_Template|Type=bool|Name=errorOnSemiOpenQuestion|Description=Set to false if you need to import to questions with open parts and know that it may partially delete existing data}}
 +
|Description=Validate prior to actual importing. Throws if errors, otherwise returns warning.}}
 
|Properties=
 
|Properties=
−
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}}
+
{{CGscriptProperties_Template|ReturnType=string|Name=ObjectTypeName|HasGetter=1|Description=The name of the type of object.}}
−
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}}
+
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=TypeInformation|HasGetter=1|Description=Get information about this class.}}
 +
{{CGscriptProperties_Template|ReturnType=bool|Name=UseLoggedInUsersCultureDuringImport|HasGetter=1|HasSetter=1|Description=Get/set if the culture used during import is the same as the logged in user or invariant culture. Default is invariant}}
 
}}
 
}}

Revision as of 07:30, 17 November 2016

ImportManager



Import data and users.

Constructors

  • (array Headers "A list of string that are the header names", array data "Data to import. An array of arrays of equal length as the headers", bool advancedMode "Enable setting advanced settings - Requires special navigation access", int groupResourceId "Group to add users to new users to and/or sample rule. Set to 0 to not add to group") - Make a new import with the given data

Methods

  • Empty Import() - Run the Import. Note that this will commit any pending changes
  • Dictionary SetDataImportOptions(int projectQuestionnaireResourceId "The resource Id of where the data should be added/updated", int type "How to treat when already have existing answer sheets. 1 for Zero or One AnswerSheet, 2 for delete existing and create new, 3 for mapping to rpqIdColumnName", string rpqIdColumnName "Mapping for column name in case type is 3", bool isCommaSeparatedFormat "Import multi questions as comma separated format", Dictionary mapping "Mapping between header names and import names. If empty, automapping is used") - Set specific options for importing data or altering existing data
  • Empty SetDefaultNewUser(string languageIso "Default language", string cultureIso "Default culture", string currency "Default currency") - Defaults for new users. If empty or not set, uses the global defaults
  • Empty SetUserImportOptions(string userIdColumnName "The header name of the userId column", string userNameMask "The mask used to create new usernames - an advanced setting", bool generatePasswords "Generate passwords during import", bool importUserInfo "Import or Update users", bool importPhoneNumber "Import or Update phonenumbers", bool importAddress "Import or Update addresses", bool importPoints "Import or Update points", bool importQualification "Import or Update qualifications", array permissions "Determine which groups should have access to the new users", Dictionary mapping "Mapping between header names and import names. If empty, automapping is used") - OBSOLETE. Use the new overload with parentResourceId.
  • Dictionary SetUserImportOptions(string userIdColumnName "The header name of the userId column", string userNameMask "The mask used to create new usernames - an advanced setting", bool generatePasswords "Generate passwords during import", bool importUserInfo "Import or Update users", bool importPhoneNumber "Import or Update phonenumbers", bool importAddress "Import or Update addresses", bool importPoints "Import or Update points", bool importQualification "Import or Update qualifications", int parentResourceId "Resource Id of the parent of the new users. Ignored if updating users", Dictionary mapping "Mapping between header names and import names. If empty, automapping is used") - Set specific options for importing new users or altering existing users
  • string ToString() - The string representation of the object.
  • string Validate() - Same as Validate(true)
  • string Validate(bool errorOnSemiOpenQuestion "Set to false if you need to import to questions with open parts and know that it may partially delete existing data") - Validate prior to actual importing. Throws if errors, otherwise returns warning.

Properties

  • string ObjectTypeName { get; } - The name of the type of object.
  • TypeInformation TypeInformation { get; } - Get information about this class.
  • bool UseLoggedInUsersCultureDuringImport { get; set; } - Get/set if the culture used during import is the same as the logged in user or invariant culture. Default is invariant
Retrieved from "http://wiki.catglobe.com/index.php?title=ImportManager_class&oldid=25780"