CLASS XMLImport
This class requires no license. It uses standard functions and actions to perform XMLImport related operations.
Class Field Properties
| Name | Codename | Description | Ability | Length |
|---|---|---|---|---|
| created | Created | Created | RO | 255 |
| created_by | CreatedBy | Created By | RO | 255 |
| updated | Updated | Updated | RO | 255 |
| updated_by | UpdatedBy | Updated By | RO | 255 |
| importpercent | ImportPercent | Import Percent Complete | RO | 255 |
| validpercent | ValidPercent | Validation Percent Complete | RO | 255 |
| commitpercent | CommitPercent | Commit Percent Complete | RO | 255 |
| changelog | changeLog | Import Log | RO | 255 |
| totalres | totalres | Total Resources | RO | 255 |
| selectres | selectres | Selected Resources | RO | 255 |
| totalascres | totalascres | Total Associations | RO | 255 |
| selectascres | selectascres | Selected Associations | RO | 255 |
| validrest | validrest | Total Validated Resources | RO | 255 |
| validress | validress | Selected Validated Resources | RO | 255 |
| validresf | validresf | Failed Validated Resources | RO | 255 |
| validresasct | validresasct | Total Resource Associations | RO | 255 |
| validresascs | validresascs | Selected Resource Associations | RO | 255 |
| validresascf | validresascf | Failed Resource Associations | RO | 255 |
| imperrcnt | imperrcnt | Import Error Count | RO | 255 |
| valerrcnt | valerrcnt | Validation Error Count | RO | 255 |
| cmterrcnt | cmterrcnt | Commit Error Count | RO | 255 |
Class Functions
| Name | Description |
|---|---|
| static add | XMLImport.add(name) takes an argument, UserPreference name. The UserPreference name can be explicit or checked for existence then retrieved with UserPreference.getNames(). User must have create privileges. UserPreference.add() creates a named UserPreference object. |
| static cancel | cancel() takes no arguments. User must have cancel privileges. This standard function removes any pending edits on the object. Used with UserPreference.get(name). |
| static CfgXMLImp | CfgXMLImp(comptype,reskey,assoc,asckey,selected) takes arguments, component type, resource key, association, association key, and selected all strings. This action configures the XML import based on the arguments. |
| static close | XMLImport.close() takes no arguments. |
| static connect | XMLImport.connect() takes no arguments. |
| static create | XMLImport.create() takes no arguments. |
| static delete | delete() takes no arguments. User must have delete privileges. This standard function deletes an existing named object. Otherwise, it throws an exception. Used with UserPreference.get(name). |
| static ExclusiveConnect | XMLImport.ExclusiveConnect() takes no arguments. |
| static exists | XMLImport.exists() takes no arguments. |
| static get | XMLImport.get(name) takes an argument, name. This standard function gets and returns the named UserPreference object. If the object name exists, it returns the object name. If the object name does not exist, it throws an exception. |
| static getCount | XMLImport.getCount() takes no arguments. This standard function gets the number of defined UserPreference resources. |
| static getFetchLevel | XMLImport.getFetchLevel() takes no arguments. |
| static getList | XMLImport.getList() takes no arguments. This standard function gets and returns an arrary (list) of UserPreference resources. |
| static getLog | XMLImport.getLog() takes no arguments. |
| static getLogCalendar | XMLImport.getLogCalendar() takes no arguments. |
| static getNames | XMLImport.getNames() takes no arguments. This standard function gets and returns an array of strings object with the UserPreference names. |
| static getRange | XMLImport.getRange() takes no arguments. |
| static getUsage | XMLImport.getUsage() takes no arguments. |
| static isConnected | XMLImport.isConnected() takes no arguments. |
| static isNew | isNew() takes no arguments and returns a boolean value. This standard function checks for object existence, to create or update when save is called. The function returns true if the object does not exist on the server and will create one when save() is called. It returns false if the object exists and will update the object when save() is called. |
| static log | XMLImport.log() takes no arguments. |
| static logScannable | XMLImport.logScannable() takes no arguments. |
| static monitor | XMLImport.monitor() takes no arguments. |
| static read | XMLImport.read() takes no arguments. |
| static refresh | XMLImport.refresh() takes no arguments. |
| static save | save() takes no arguments. User must have save privileges. This standard function saves to the server a UserPreference object and the appropriate logs. This includes any pending edits made on the object. save() throws an exception if validation or save fails. |
| static setFetchLevel | XMLImport.setFetchLevel() takes no arguments. |
| static update | XMLImport.update() takes 7 arguments. |
| static ValidateImport | ValidateImport() takes no arguments. This action validates the import of the XML document. |
| static write | XMLImport.write() takes no arguments. |
| static XMLCommit | XMLCommit(description) takes an argument, description string. This action commits to the XML document the argument. |