Error: Invalid spaceKey on retrieving a related space config.

Server object properties and structures

A server object is an object in the AR System server that can be discretely exported and whose change history can be tracked. AR System has the following server objects:

  • Active links
  • Associations
  • Character menus
  • Containers
  • Distributed mappings
  • Escalations
  • Fields
  • Filters
  • Forms

The ARCreate Object, ARGet Object, and ARSet Object functions for server objects have an objPropList parameter that defines the set of one or more custom properties (AR_OPROP_*) associated with an object.

To define server object properties, use tag-value pairs (see Server object property tags). The C API uses the ARPropStruct data structure to store the tag and an ARValueStruct, which stores the tag value. ARPropStruct structures are stored in the ARPropList data structure (see the following figure).

Note

ARPropStruct structures also store display properties (AR_DPROP_*) for objects such as fields.



ARPropList data structure for server object properties 

 

If the objPropList parameter is set to NULL, an object property list with zero properties is associated with the server object.

Server object property tags

You define server object property tags in the following file: ARSystemInstallDir\ Arserver\api\include\ar.h file.

Tags with a number of 60000 (AR_OPROP_RESERVED) or less are reserved. API programmers can define any server object property tag with a number greater than AR_OPROP_RESERVED, but the number of the last reserved tag might increase in a later release, requiring a program update.

The following server object property tags are predefined in the AR System server. You can specify them in any order in a server object property list (ARPropList). You can also include multiple instances of the same tag in a property list; however, API programs might ignore duplicate instances of properties.

AR_OPROP_VENDOR_NAME: (CHAR):
Name of the company that produces the product, for example, "Arrow Systems, Inc."

AR_OPROP_VENDOR_PRODUCT (CHAR):
Product name, for example, "BMC Remedy AR System."

AR_OPROP_VENDOR_VERSION: (CHAR):
Product version, for example, "7.5.00."

AR_OPROP_GUID: (CHAR):
Globally unique identifier for the object.

AR_OPROP_COPYRIGHT: (CHAR):
Copyright string.

AR_OPROP_POOL_NUMBER: (INT):
Pool number for an escalation if the object is assigned to a pool.

AR_OPROP_CORE_FIELDS_OPTION_MASK: (INT):
Bitmask of options for core fields of the schema. A value of AR_CORE_FIELDS_OPTION_NONE means no options are set. A value of AR_CORE_FIELDS_OPTION_DISABLE_STATUS_HISTORY means that status history recording and retrieval is disabled for the schema.

AR_OPROP_CACHE_DISP_PROP: (INT):
Bitmask of options that control whether VUI and field display properties are cached for the schema. If this property is absent, the server uses the default specified by the AR_SERVER_INFO_CACHE_DISP_PROP property.

  • No bits — Do not cache VUI or field display properties (AR_CACHE_DPROP_NONE).
  • Bit 1 — Cache VUI display properties (AR_CACHE_DPROP_VUI).
  • Bit 2 — Cache field display properties (AR_CACHE_DPROP_FIELD).
  • Bits 1 and 2 — Cache VUI and field display properties (AR_CACHE_DPROP_ALL).

AR_OPROP_OVERLAY_EXTEND_MASK: (INT):
Bitmask options that indicate what is extended in an overlay. The options are:

1

AR_GRANULAR_PERMISSIONS

Extends permissions. You can use this bit for forms, fields, active links, active link guides, applications, and packing lists.

2

AR_GRANULAR_FORM_LIST

Extends forms to which this workflow is attached. You can use this bit for active links, active link guides, filters, filter guides, and escalations.

4

AR_GRANULAR_INDEX

Extends indexes. You can use this bit for forms.

8

AR_GRANULAR_OTHER

No object currently allows extension of the other properties.

16AR_GRANULAR_ASSOC_LISTExtend associations to follow for archive. You can use this bit only for forms.

AR_OPROP_OVERLAY_INHERIT_MASK: (INT):
Bitmask options that indicate what is inherited in an overlay. The options are:

1

AR_OVERLAY_PERMISSIONS

Inherits permissions. You can use this bit for forms, fields, active links, active link guides, applications and packing lists.

2

AR_OVERLAY_FORM_LIST

Inherits forms to which this workflow is attached. You can use this bit for active links, active link guides, filters, filter guides, and escalations.

4

AR_OVERLAY_INDEX

Inherits indexes. You can use this bit for forms.

8

AR_OVERLAY_OTHER

Inherits everything that is not included in the previous bits.

16AR_GRANULAR_ASSOC_LISTExtend associations to follow for archive. You can use this bit only for forms.

Note

The AR_OPROP_OVERLAY_EXTEND_MASK and AR_OPROP_OVERLAY_INHERIT_MASK masks are mutually exclusive. Overwritten parts of the granular overlay are defined by which bits are not set in either mask. Anything that is not extended or inherited is overwritten.

Set and Get functions access the masks through object properties. You must inherit or extend indexes. They cannot be overwritten, so the AR_OVERLAY_INDEX bit must appear in the AR_OPROP_OVERLAY_EXTEND_MASK or AR_OPROP_OVERLAY_INHERIT_MASK object property.

Server-managed object property tags

The BMC Remedy AR System server has the following object property tags (AR_SMOPROP_*) that are managed exclusively by the server.

AR_SMOPROP_APP_OWNER
Name of the application owner for the object.

AR_SMOPROP_OBJECT_LOCK_TYPE
Object lock type.The following table lists valid values for the lock type.

0

AR_LOCK_TYPE_NONE

Export the objects as unlocked.

1

AR_LOCK_TYPE_READONLY

Export the objects with read-only lock. When the objects are imported, they are readable but not modifiable.

2

AR_LOCK_TYPE_HIDDEN

Export the objects with hidden lock. When the objects are imported, they are neither readable nor modifiable.

AR_SMOPROP_OBJECT_LOCK_KEY
Object lock key. This string is used as a key (or password) to enforce locking.

AR_SMOPROP_ENTRYPOINT_DEFAULT_NEW_ORDER
Entry point order in entry point list.

AR_SMOPROP_ENTRYPOINT_DEFAULT_SEARCH_ORDER
Entry point order in entry point list.

AR_SMOPROP_APP_STAT_FORM
Integer that indicates whether the object participates in application statistics.

AR_SMOPROP_APP_LIC_VERSION
License version for applications and forms.

AR_SMOPROP_APP_LIC_DESCRIPTOR
License descriptor for applications and forms.

AR_SMOPROP_APP_LIC_USER_LICENSABLE
Numeric Boolean value that indicates whether the form is user licensable.

AR_SMOPROP_APP_ACCESS_POINT
Integer that indicates whether the object is an access point. Zero (0) denotes that the object is not an access point. One (1) denotes that the object is an access point.

AR_SMOPROP_APP_BSM_TAG
For internal use only.

AR_SMOPROP_PRIMARY_FIELDSET
Set of fields used as a unique index for importing application-specific data. This property applies only if the schema includes fields 61000 and 61001.

Was this page helpful? Yes No Submitting... Thank you

Comments