ARGetSchemaWithExtensionsFromXML
Description
Retrieves information about the form with the indicated name from the specified server. This information does not include the form's field definitions.
Privileges
All users.
Synopsis
int ARGetSchemaWithExtensionsFromXML(
ARControlStruct *control,
ARNameType schemaName,
ARNameType appBlockName,
ARCompoundSchema *compoundSchema,
ARPermissionList *permissionList,
ARPermissionList *addedPermissionList,
ARInternalIdList *subAdminGrpList,
ARInternalIdList *addedSubAdminGrpList,
AREntryListFieldList *getListFields,
ARSortList *sortList,
ARIndexList *indexList,
ARIndexList *addedIndexList,
ARArchiveInfoStruct *archiveInfo,
ARAuditInfoStruct *auditInfo,
ARNameType defaultVUI,
ARInternalId *nextFieldID,
ARULong32 *coreVersion,
int *upgradeVersion,
ARExportFieldInfoList *fieldInfoList,
ARVuiInfoList *vuiInfoList,
ARAccessNameType owner,
ARAccessNameType lastModifiedBy,
ARTimestamp *modifiedDate,
char **helpText,
char **changeHistory,
ARPropList *objPropList,
unsigned int *arDocVersion,
ARStatusList *status
)
Input arguments
control
The control record for the operation. It contains information about the user requesting the operation, where that operation is to be performed, and which session is used to perform it. The user, sessionId, and server fields are required.
schemaName
Name of the schema. Each schema name must be unique.
appBlockName
For a deployable application, this is the application block name of the schema (form).
Return values
compoundSchema
The definition of the candidate form or table that contains the candidate field to retrieve.
permissionList
A list of zero or more groups who can access the form. Access to this information is limited to users with BMC Remedy AR System administrator privileges only. Specify NULL for this parameter if you do not want to retrieve the group list.
addedPermissionList
The addedPermissionList is a set of groups that is added to the permission list when the permissions of an overlay component are additive. The list will be empty if an overlay is not retrieved or if the permissions of the overlay component are not of additive type.
Specify NULL for this parameter if you do not want to retrieve this value.
subAdminGrpList
A list of zero or more groups who can administer this form (and the associated filters, escalations, and active links). Users must belong to both a specified group and the Subadministrator group to obtain these privileges. Specify NULL for this parameter if you do not want to retrieve the administrator group list.
addedSubAdminGrpList
The addedSubAdminGrpList is a set of groups that is added to the subadministrator group list when the permissions of an overlay component are additive. The list will be empty if an overlay is not retrieved or if the permissions of the overlay component are not of additive type.
Specify NULL for this parameter if you do not want to retrieve this value.
getListFields
A list of zero or more fields that identifies the default query list data for retrieving form entries. Specify NULL for this parameter if you do not want to retrieve this value.
sortList
A list of zero or more fields that identifies the default sort order for retrieving form entries. Specify NULL for this parameter if you do not want to retrieve the default sort fields.
indexList
The set of zero or more indexes for the form. Specify NULL for this parameter if you do not want to retrieve the index list.
addedIndexList
A set of groups that is added to the index list when the permissions of an overlay component are additive. The list will be empty if an overlay is not retrieved or if the permissions of the overlay component are not of additive type.
Specify NULL for this parameter if you do not want to retrieve this value.
archiveInfo
If the form is to be archived, this is the archive information for the form. Specify NULL for this parameter if you do not want to retrieve the archive information. The following are the options for archive type:
In addition to the archive type, archiveInfo also stores the form name (if archive type is AR_ARCHIVE_FORM), time to trigger the archive, archive qualification criteria, and name of the main form that is being archived.
auditInfo
If a form is to be audited, this is the audit information for the form. Specify NULL for this parameter if you do not want to retrieve the audit information. These are the values for audit type:
In addition to the audit type, auditInfo also stores the form name (if audit type is AR_AUDIT_COPY or AR_AUDIT_LOG) and the audit qualification criteria.
defaultVui
The label for the default view.
nextFieldID
The next default field identification number, which the server generates if users do not specify it.
coreVersion
The version number of the core fields.
upgradeVersion
The upgrade version for auto generated internal server schemas.
fieldInfoList
The list of schema fields.
vuiInfoList
The list of schema views.
owner
The schema owner.
lastModifiedBy
The user who last modified the schema.
modifiedDate
The date that the schema was last modified.
helpText
The help text associated with the schema. Specify NULL for this parameter if you do not want to retrieve the help text (which is useful if you are calling this function to verify whether an instance of this object exists).
changeHistory
The change history of the schema.
objPropList
The object properties of the schema.
arDocVersion
The XML document version.
status
A list of zero or more notes, warnings, or errors generated from a call to this function. For a description of all possible values, see Error-checking.
See also