ARExport

Important

You can continue to use C APIs to customize your application, but C APIs are not enhanced to support new capabilities provided by Java APIs and REST APIs.

Description

Exports the indicated structure definitions from the specified server. Use this function to copy structure definitions from one AR System server to another (see ARImport).

Important

Form exports do not work the same way with ARExport as they do in Developer Studio. Other than views, you cannot automatically export related items along with a form. You must explicitly specify the workflow objects that you want to export. Also, ARExport cannot export a form without embedding the server name in the export file (something you can do with the "Server-Independent" option in Developer Studio).

Related topics

ARExportToFile

ARImport

FreeAR 

Privileges

For filters, escalations, character menus, and distributed mappings, this operation can be performed only by users with AR System administrator privileges. For forms, containers, and active links, this operation can be performed by users with access permission for the specified structure. Access to groupList information for these structures is limited to users with AR System administrator privileges.

Synopsis

#include "ar.h"
#include "arerrno.h"
#include "arextern.h"
#include "arstruct.h"

int ARExport(
  ARControlStruct *control,
  ARStructItemList *structItems,
  ARNameType displayTag,
  unsigned int vuiType,
  unsigned int exportOption,
  ARWorkflowLockStruct *lockinfo,
  char **exportBuf,
  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 and server fields are required.

The runtime overlay group setting in the control record has the following effects:

  • When the runtime group specifies a particular overlay group, exporting overlaid objects also exports their overlays, even if the overlays are not explicitly selected for export.
  • When the runtime group is set to -1, only overlaid objects, not their overlays, are exported.
  • When the runtime group is set to -2, unmodified, overlaid, overlay, and custom objects are exported using their real names.

Important

If inherited attributes are exported, they are ignored and their values are taken from the origin object on the server. Extended (additive) and overwritten attributes are always exported.

For information about runtime groups and the overlay group setting, see ARSetSessionConfiguration.

structItems

A list of zero or more structure items to export (identified by type and name). See Importing-and-exporting-and-structures.

displayTag

The label of the form view (VUI) to export. You must specify this parameter to export a particular view (AR_STRUCT_ITEM_SCHEMA_VIEW). If the specified view does not exist (or you specify NULL for this value), the system exports the default view. The system exports the first view in the list if the form does not have a default view.

vuiType

The type of VUI to export.

Fields marked with a * are available for legacy environments that use BMC Remedy User, which is no longer shipped with AR System.

exportOption

A bitmask to manage export settings when exporting a deployable application (see Defining-and-managing-applications). Use this parameter to specify shared workflow, integration workflow, and locale. This parameter takes the following values:

AR_EXPORT_DEFAULT_LOCALE and AR_EXPORT_SELECTED_LOCALES control what locales are exported. AR_EXPORT_LOCALE_ONLY controls what server objects are exported. 

lockInfo

To export objects as locked, you must supply this parameter. If exporting in unlocked mode, you can set this to NULL.

Important

The locking feature is for protecting your intellectual property. You can now export workflow as locked (either read-only lock or hidden-lock) and deliver it to your customers. When your customer imports the workflow, the system seamlessly runs that workflow but restrict the clients from getting the definition data, thus preventing human administrators or API clients from viewing or modifying the definition.

The values consist of a lock type and lock key. Valid values for the lock type are:

Lock key is a string that is to be used as a key (or a password) to enforce locking.

Return values

exportBuf

A buffer that contains the definition text for the items specified for the structItems parameter. The system returns error messages for items not exported due to error.

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.


 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*