Importing and exporting and structures
Both the ARExport and ARImport functions use the ARStructItemList structure to represent BMC Remedy AR System objects to export or import. This list contains zero or more ARStructItemStruct items (see the following figure).
Structures used to import and export BMC Remedy AR System objects
Each ARStructItemStruct represents a particular object to export or import:
| Integer that specifies the type of BMC Remedy AR System object (see the following table). |
| Name associated with the BMC Remedy AR System object. |
| During export and import operations, this parameter is used only when processing data of the following types:
|
| Schema view name. An empty string specifies views with no defined locales. |
Item type values for ARStructItemStruct (Remedy AR System format)
1 | AR_STRUCT_ITEM_SCHEMA | Schema definition, including views, help text, and change diary information. |
2 | AR_STRUCT_ITEM_SCHEMA_DEFN * | Structure definition for configuring BMC Remedy User cache (special purpose export). |
3 | AR_STRUCT_ITEM_SCHEMA_VIEW * | Display definition for configuring BMC Remedy User cache (special purpose export). |
4 | AR_STRUCT_ITEM_SCHEMA_MAIL | Email template for submitting requests (special purpose export). |
5 | AR_STRUCT_ITEM_FILTER | Filter definition. |
6 | AR_STRUCT_ITEM_ACTIVE_LINK | Active link definition. |
7 | AR_STRUCT_ITEM_ADMIN_EXT | No longer supported. |
8 | AR_STRUCT_ITEM_CHAR_MENU | Character menu definition. |
9 | AR_STRUCT_ITEM_ESCALATION | Escalation definition. |
10 | (For On-premises deployments only) | Mapping definition for Distributed Server Option (DSO). |
11 | AR_STRUCT_ITEM_SCHEMA_VIEW_MIN * | Display definition without bitmaps for BMC Remedy User. |
12 | AR_STRUCT_ITEM_CONTAINER | Container definition. |
13 | AR_STRUCT_ITEM_DIST_POOL | Pool definition for the attachments. |
14 | AR_STRUCT_ITEM_VUI | View definition. |
15 | AR_STRUCT_ITEM_FIELD | Field definition. This item is supported only in the XML API. |
16 | AR_STRUCT_ITEM_APP | Application definition. |
18 | AR_STRUCT_ITEM_LOCALE_VUI | Local-based views. |
30 | AR_STRUCT_ITEM_SCHEMA_DATA | Schema data definition. |
103 | AR_STRUCT_ITEM_SCHEMA_VIEW_2 | Definition tag for all schema views instead of just one. |
Values marked with an asterisk (*) are available for legacy environments that use BMC Remedy User, which is no longer shipped with BMC Remedy AR System.
XML format
1073741825 | AR_STRUCT_ITEM_XML_SCHEMA | Schema definition, including views, help text, and change diary information. |
1073741829 | AR_STRUCT_ITEM_XML_FILTER | Filter definition. |
1073741830 | AR_STRUCT_ITEM_XML_ACTIVE_LINK | Active link definition. |
1073741831 | AR_STRUCT_ITEM_XML_ADMIN_EXT | No longer supported. |
1073741832 | AR_STRUCT_ITEM_XML_CHAR_MENU | Character menu definition. |
1073741833 | AR_STRUCT_ITEM_XML_ESCALATION | Escalation definition. |
1073741834 | (For On-premises deployments only) | Mapping definition for DSO. |
1073741836 | AR_STRUCT_ITEM_CONTAINER | Container definition. |
1073741837 | AR_STRUCT_ITEM_DIST_POOL | Pool definition for the attachments. |
1073741838 | AR_STRUCT_ITEM_XML_VUI | View definition. |
1073741839 | AR_STRUCT_ITEM_XML_FIELD | Field definition. This item is supported only in the XML API. |
1073741840 | AR_STRUCT_ITEM_XML_APP | Application definition. |
1073741842 | AR_STRUCT_ITEM_XML_LOCALE_VUI | Local-based views. |
To export a form that you want to import to another server, you must specify AR_STRUCT_ITEM_SCHEMA. The three partial form types do not contain complete form definitions and are used only for caching purposes.
The AR_STRUCT_XML_OFFSET (1 << 30) bitmask is used to derive the XML structure item types. The XML type is the logical-OR of the non-XML type and the XML offset. For example, AR_STRUCT_ITEM_XML_SCHEMA is defined in the ar.h file as (AR_STRUCT_XML_OFFSET | AR_STRUCT_ITEM_SCHEMA ).
Note
To import all structures in the import buffer, specify NULL for the structItems parameter or an ARStructItemList with zero items.
Comments
Log in or register to comment.