This documentation supports the 9.1 version of Remedy Action Request System.

To view the latest version, select the version from the Product version menu.

ARCreateVUI

Note

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

Creates a new form view (VUI) with the indicated name on the specified server.

Privileges

BMC Remedy AR System administrator.

Synopsis

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

int ARCreateVUI(
   ARControlStruct *control,
   ARNameType schema,
   ARInternalId *vuiId,
   ARNameType vuiName,
   ARLocaleType locale,
   unsigned int vuiType,
   ARPropList *dPropList,
   char *helpText,
   ARAccessNameType owner,
   char *changeDiary,
   ARPropList *objPropList,
   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.

If a valid overlay group is specified in the control record, the ARCreate* function creates a custom object that belongs to that group. If no group is specified, the function creates an origin object. To specify an overlay group, use the AR_SESS_CONTROL_PROP_DESIGN_OVERLAYGROUP variable of the ARSetSessionConfiguration function (see ARGetSessionConfiguration).

schema

The name of the form the VUI is linked to. The VUI must be associated with a single form that currently exists on the server.

vuiId

The internal ID of the VUI to create. The IDs of all VUIs and fields associated with a given form must be unique. Specify 0 for this parameter if you want the system to generate and return the ID. Otherwise, specify a value between 536868912 and 2147483647 (limited by AR_MAX_RESERVED_FIELD_ID in arstruct.h ).

vuiName

The name of the VUI to create. The names of all VUIs and fields associated with a given form must be unique.

locale

The locale of the VUI.

vuiType

The type of VUI. Specify NULL for this parameter if you do not want to retrieve the VUI type.

0:

No VUI type (AR_VUI_TYPE_NONE).

1:

Windows type (AR_VUI_TYPE_WINDOWS) * - fields in BMC Remedy User.

2:

Web relative type (AR_VUI_TYPE_WEB) - fields in view can be adjusted.

3:

Web absolute type (AR_VUI_TYPE_WEB_ABS_POS) - fields in view are fixed.

 

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

dPropList

A list of zero or more display properties to associate with the VUI (see the Display Properties section that follows). Specify NULL for this parameter if you do not want to define any display properties.

helpText

The help text associated with the VUI. This text can be of any length. Specify NULL for this parameter if you do not want to associate help text with this object.

owner

The owner for the VUI. The owner defaults to the user performing the operation if you specify NULL for this parameter.

changeDiary

The initial change diary associated with the VUI. This text can be of any length. The server adds the user making the change and a time stamp when it saves the change diary. Specify NULL for this parameter if you do not want to associate change diary text with this object.

objPropList

A list of server object properties. If this parameter is set to NULL, a properties list with zero properties is associated with the form, and a list of zero properties is returned when an ARGetVUI is performed. See Server object properties.

Return values

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.

Display properties

  • AR_DPROP_ALIAS_ABBREV_PLURAL (character string): A very short, plural form of the name for the logical items represented by entries in the form this view is associated with (see AR_DPROP_ALIAS_SINGULAR).
  • AR_DPROP_ALIAS_ABBREV_SINGULAR (character string): A very short, singular form of the name for the logical items represented by entries in the form this view is associated with (see AR_DPROP_ALIAS_SINGULAR).
  • AR_DPROP_ALIAS_PLURAL (character string): The plural form of the name for the logical items represented by entries in the form this view is associated with (see AR_DPROP_ALIAS_SINGULAR).
  • AR_DPROP_ALIAS_SHORT_PLURAL (character string): A short, plural form of the name for the logical items represented by entries in the form this view is associated with (see AR_DPROP_ALIAS_SINGULAR).
  • AR_DPROP_ALIAS_SHORT_SINGULAR (character string): A short, singular form of the name for the logical items represented by entries in the form this view is associated with (see AR_DPROP_ALIAS_SINGULAR).
  • AR_DPROP_ALIAS_SINGULAR (character string): The singular form of the name for the logical items represented by entries in the form this view is associated with (such as help desk calls). BMC Remedy User displays this name instead of the default "request" when referring to form entries.
  • AR_DPROP_DETAIL_BANNER_VISIBILITY (unsigned long): A value that indicates whether the details pane is visible. Specify 0 for invisible, 1 for visible.
  • AR_DPROP_DETAIL_PANE_COLOR (character string): The background color of the details pane. Specify the color as #BBGGRR, a string concatenating the two-digit hexadecimal values for blue, green, and red.
  • AR_DPROP_DETAIL_PANE_HEIGHT (integer): The height of the details pane, in form coordinates.
  • AR_DPROP_DETAIL_PANE_IMAGE (ARByteList): The background image for the details pane. Specify a byte list type of 1 (AR_BYTE_LIST_WIN30_BITMAP) for images in bitmap (.bmp ) and DIB (.dib ) format. Specify 2 (AR_BYTE_LIST_JPEG) for JPEG (.jpg or .jpeg ) format (see AR_DPROP_PUSH_BUTTON_IMAGE).
  • AR_DPROP_DETAIL_PANE_WIDTH (integer): The width of the details pane, in form coordinates. Negative values are reserved for future use.
  • AR_DPROP_IMAGE_ALIGN (unsigned long): A value that indicates the vertical alignment of the background image for the details pane.

    1:

    Top-aligned (AR_DVAL_ALIGN_TOP).

    2:

    Centered (AR_DVAL_ALIGN_MIDDLE) (default setting).

    3:

    Expand to fill (AR_DVAL_ALIGN_FILL).

    4:

    Bottom-aligned (AR_DVAL_ALIGN_BOTTOM).

    5:

    Tile to fill (AR_DVAL_ALIGN_TILE).

  • AR_DPROP_IMAGE_JUSTIFY (unsigned long): A value that indicates the horizontal justification of the background image for the details pane.

    1:

    Left-aligned ( AR_DVAL_JUSTIFY_LEFT ).

    2:

    Centered ( AR_DVAL_JUSTIFY_CENTER ).

    3:

    Expand to fill ( AR_DVAL_JUSTIFY_FILL ).

    4:

    Right-aligned ( AR_DVAL_JUSTIFY_RIGHT ).

    5:

    Tile to fill ( AR_DVAL_JUSTIFY_TILE ).

  • AR_DPROP_LAYOUT_POLICY (unsigned long): This value is used for views to determine how child fields will be arranged. Specify AR_DVAL_LAYOUT_XY if the container should honor the fields bounding box (this is the default). Specify AR_DVAL_LAYOUT_FILL to have the container automatically resize all visible children to the width of the container, resize the height of all children to be equal to the container's total height, and stack the visible children vertically on top of each other.
  • AR_DPROP_PANE_LAYOUT (integer): A value that indicates how the panes of the VUI are arranged. This property also specifies whether the layout is locked to prevent the user from changing it.

    -1:

    Results pane left of details, prompt pane on top, locked.

    -2:

    Details pane left of results, prompt pane on top, locked.

    -3:

    Results pane above details, prompt pane on top, locked.

    -4:

    Details pane above results, prompt pane on top, locked.

    -5:

    Results pane left of details, prompt pane on bottom, locked.

    -6:

    Details pane left of results, prompt pane on bottom, locked.

    -7:

    Results pane above details, prompt pane on bottom, locked.

    -8:

    Details pane above results, prompt pane on bottom, locked.

    1:

    Results pane left of details, prompt pane on top, unlocked.

    2:

    Details pane left of results, prompt pane on top, unlocked.

    3:

    Results pane above details, prompt pane on top, unlocked.

    4:

    Details pane above results, prompt pane on top, unlocked.

    5:

    Results pane left of details, prompt pane on bottom, unlocked.

    6:

    Details pane left of results, prompt pane on bottom, unlocked.

    7:

    Results pane above details, prompt pane on bottom, unlocked.

    8:

    Details pane above results, prompt pane on bottom, unlocked.

  • AR_DPROP_MENU_ACCESS (character string): A list of client interface items an administrator can control. It is encoded in the same format as qualifications in .arf files. This is not supported for customer use.
  • AR_DPROP_NAMED_SEARCHES (character string): A list of administrator-defined searches. It is encoded in the same format as qualifications in .arf files. This is not supported for customer use.
  • AR_DPROP_QUERY_LIST_COLOR (character string): The name of the field whose value for a given entry controls the display color of that entry in a query results list, and a list of field values and their corresponding colors. This is not supported for customer use.
  • AR_DPROP_RESULT_BANNER_VISIBILITY(unsigned long): A value that indicates whether the results pane is visible. Specify 0 for invisible, 1 for visible.
  • AR_DPROP_TITLE_BAR_ICON_IMAGE (ARByteList): The icon image for the title bar. Specify a byte list type of 1 (AR_BYTE_LIST_WIN30_BITMAP) for images in bitmap (.bmp ) and DIB (.dib ) format. Specify 2 (AR_BYTE_LIST_JPEG) for JPEG (.jpg or .jpeg ) format.
  • AR_DPROP_VIEW_RTL (unsigned long): A flag that indicates a view to be rendered from right-to-left (web only). Valid values are FALSE (0) or TRUE (1).
  • AR_DPROP_VUI_DEFAULT (unsigned long): A flag that specifies the default view (VUI) for the form. A value of 1 identifies the default VUI (with all other VUIs having a value of 0). The system uses the first VUI returned by the ARGetListVUI function if you do not specify a default view.

See also

ARCreateField, ARDeleteVUI, ARGetVUI, ARGetListVUI, ARSetVUI. See FreeAR for: FreeARPropList, FreeARStatusList.

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

Comments