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.

ARSetSessionConfiguration

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

Sets an API session variable.
If you perform a set operation on an overlay and you provide values for an inherited grain, the values are ignored. Only values for extended or overwritten grains of the overlay are set.

Privileges

This operation can be performed by all users.

Synopsis

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

int ARSetSessionConfiguration(
   ARControlStruct *control,
   unsigned int variableId,
   ARValueStruct *variableValue,
   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 sessionId fields are required.

variableId

Identification of the variable type:

1:

Maximum size for a single response (AR_SESS_CHUNK_RESPONSE_SIZE).

2:

Timeout for normal operations (AR_SESS_TIMEOUT_NORMAL).

3:

Timeout for long operations (AR_SESS_TIMEOUT_LONG).

4:

Timeout for extra long operations (AR_SESS_TIMEOUT_XLONG).

5:

Socket number to lock to (AR_SESS_LOCK_TO_SOCKET_NUMBER).

6:

Flag with Boolean value that indicates if the session is pooled (AR_SESS_POOLED).

7:

API program client type (AR_SESS_CLIENT_TYPE).

8:

Type of VUI view (AR_SESS_VUI_TYPE).

9:

Flag with Boolean value that indicates if the user would like to override the session from the previous IP (AR_SESS_OVERRIDE_PREV_IP).

10:

The name of the API command log (AR_SESS_API_CMD_LOG).

11:

The name of the API result log (AR_SESS_API_RES_LOG).

12:

Overlay group used at design time (AR_SESS_CONTROL_PROP_DESIGN_OVERLAYGROUP).

13:

Overlay group used at runtime (AR_SESS_CONTROL_PROP_API_OVERLAYGROUP).

14:

Granular overlay mode used at runtime. For extended properties, determines whether full lists or only extensions are retrieved. (AR_SESS_CONTROL_PROP_GRANULAR_OVERLAY_RETRIEVE_MODE).

 

variableValue

Configuration variable value:

  • AR_SESS_CHUNK_RESPONSE_SIZE (integer): An integer value for the maximum data packet size returned from the server to the client in one transmission.
  • AR_SESS_TIMEOUT_NORMAL (integer): An integer value for the client timeout value used in fast server operations.
  • AR_SESS_TIMEOUT_LONG (integer): An integer value for the client timeout value used in list server operations.
  • AR_SESS_TIMEOUT_XLONG (integer): An integer value for the client timeout value used in definition updating and in import/export operations.
  • AR_SESS_LOCK_TO_SOCKET_NUMBER (integer): An integer value for the socket number that the client locks to for all server interaction.
  • AR_SESS_POOLED (integer): An integer value for the flag that indicates if the session is pooled. Valid values for this option are 0 (No ) and 1 (Yes).
  • AR_CLIENT_TYPE_* (integer): An integer value for the client type. For more information, see AR_CLIENT_TYPE_* in the ar.h file.
    Range of values for user-defined, client-type variables: AR_CLIENT_TYPE_END_OF_RESERVED_RANGE: > 5000.
  • AR_SESS_VUI_TYPE (integer): An integer value for the type of VUI. For more information, see AR_VUI_TYPE_* in the ar.h file.
  • AR_SESS_OVERRIDE_PREV_IP (integer): An integer value for the flag that indicates if the session can be overridden. Valid values for this option are 0 (No) and 1 (Yes).
  • AR_SESS_CONTROL_PROP_DESIGN_OVERLAYGROUP (character): A character value that indicates whether to use an object's real or resolved name in administrative and design-time operations (ARCreate, ARDelete, and ARSet calls) and whether to perform the operation only on objects in a specified overlay group. (Unmodified objects are members of all groups, so they are included in all operations regardless of the value of this variable.)
    Valid values for this option are the following strings:

    • None or 0 — Use real names; perform operation on origin (overlaid and unmodified) objects.
    • overlayGroupID — Use resolved names; perform operation on objects in the specified overlay group. (In AR System 7.6.04, you can only specify group ID 1.)
    • -1 — (Base Development mode) Use real names; perform operation on origin (overlaid and unmodified) objects.
    • -2 — (Full Development mode) Use real names; perform operation on all objects (overlay, overlaid, unmodified, and custom).

  • AR_SESS_CONTROL_PROP_API_OVERLAYGROUP (character): A character value that indicates whether to use an object's real or resolved name in runtime operations (ARGet, ARGetList, and ARGetMultiple calls) and whether to perform the operation only on custom and overlay objects in a specified overlay group. (Unmodified objects are members of all groups, so they are included in all operations regardless of the value of this variable.)
    Valid values for this option are the following strings:

    • None or 0 — Use real names; perform operation on origin (overlaid and unmodified) objects.
    • overlayGroupID — Use resolved names; perform operation on objects in the specified overlay group. (In AR System 7.6.04, you can only specify group ID 1.)
    • -1 — (Base Development mode) Use real names; perform operation on origin (overlaid and unmodified) objects.
    • -2 — (Full Development mode) Use real names; perform operation on all objects (overlay, overlaid, unmodified, and custom).

  • AR_SESS_CONTROL_PROP_GRANULAR_OVERLAY_RETRIEVE_MODE (int): An integer value that defines what type of object definition is returned. Valid values for this option are:
    • 0 (the default): All Get<object> calls return the complete object definition.
    • 1: For grains of overlays that can be extended (form lists, permissions, and indexes), Get<object> calls return only the values used to extend or overwrite the values retrieved from the origin object.
      For all other grains, the inherited or overwritten values are returned.
  • AR_SESS_API_CMD_LOG (char): A character value for the name of the API client side logging command file.
  • AR_SESS_API_RES_LOG (char): A character value for the name of the API client side logging result file.

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.

See also

ARGetSessionConfiguration.

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

Comments