|
5.1 Action Request System Java API | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Object | +--com.remedy.arsys.api.Util
The Util class combines all the functions not related
to specific server objects into a "catch-all" class.
For all the methods in the Util class,
there is a corresponding C API function.
You can read full descriptions of their functionality in the
Action Request System Programmer's Guide.
| Constructor Summary | |
Util()
|
|
| Method Summary | |
static CharMenuInfo |
ARConvertStringToListMenu(ARServerUser context,
java.lang.String menuString)
Converts a string to a CharMenuInfo object |
static EntryID |
ARCreateAlertEvent(ARServerUser context,
AccessNameID user,
java.lang.String alertText,
int priority,
NameID sourceTag,
ServerNameID server,
NameID formName,
java.lang.String objectId)
Enters an alert event into the system. |
static AlertMessageInfo |
ARDecodeAlertMessage(ARServerUser context,
AlertMessageCriteria criteria,
java.lang.String message,
int length)
Decodes supplied alert message and return their component parts. |
static AssignInfo |
ARDecodeARAssignStruct(ARServerUser ctx,
java.lang.String assignString)
Decode of ARAssignStruct. |
static QualifierInfo |
ARDecodeARQualifierStruct(ARServerUser ctx,
java.lang.String queryString)
Decode of ARQualificationStruct. |
static DiaryInfo[] |
ARDecodeDiary(ARServerUser ctx,
java.lang.String str)
Takes a diary string as input and decodes it into an ARDiaryList for easier processing. |
static StatusHistoryInfo[] |
ARDecodeStatusHistory(ARServerUser ctx,
java.lang.String str)
Takes a status history string as input and decodes it into an ARStatusHistoryList. |
static void |
ARDeregisterForAlerts(ARServerUser context,
int clientPort)
Deregister a client with the server so they no longer receive alert indicators. |
static java.lang.String |
AREncodeARAssignStruct(ARServerUser ctx,
AssignInfo asn)
Encode of ARAssignStruct. |
static java.lang.String |
AREncodeARQualifierStruct(ARServerUser ctx,
QualifierInfo qual)
Encode of ARQualificationStruct. |
static java.lang.String |
AREncodeDiary(ARServerUser ctx,
DiaryInfo[] diary)
Takes an ARDiaryList as input and encodes it into a
diary string. |
static java.lang.String |
AREncodeStatusHistory(ARServerUser ctx,
StatusHistoryInfo[] statHist)
Takes an ARStatusHistoryList as input and encodes it
into a status history string. |
static ProcessResult |
ARExecuteProcess(ARServerUser context,
java.lang.String command,
boolean waitFlag)
Performs the indicated command on the specified server. |
static ProcessResult |
ARExecuteProcessForActiveLink(ARServerUser context,
NameID actlinkName,
int actionIndex,
int actionType,
InternalID fieldId,
Timestamp timestamp,
EntryItem[] keywordList,
EntryItem[] parameterList,
boolean waitFlag)
Executes a process on the server. |
static java.lang.String |
ARExport(ARServerUser context,
StructItemInfo[] items,
NameID displayTag,
int vuiType)
Exports the indicated structure definitions from the specified server to a buffer. |
static int |
ARGetAlertCount(ARServerUser context,
QualifierInfo qual)
Gets number of alert events that meet the specified criteria. |
static HostID[] |
ARGetAllLocalHostIDs(ARServerUser context)
Get all local HostID's. |
static java.lang.String |
ARGetApplicationRequestedInfo(ARServerUser context,
java.lang.String str)
For internal use only. |
static CompactQueryResult |
ARGetCompactEntryList(ARServerUser context,
EntryListCriteria entryListCriteria,
EntryCriteria entryCriteria,
java.lang.Integer nMatches)
AR System internal use only. |
static java.math.BigDecimal |
ARGetCurrencyRatio(java.lang.String currencyRatioSet,
java.lang.String fromCurrencyCode,
java.lang.String toCurrencyCode)
Search through a supplied currency ratios string to find an entry that matches the requested currency codes. |
static void |
ARGetEntryBlob(ARServerUser context,
NameID schemaID,
EntryID entryID,
FieldID fldID,
AttachmentInfo attach)
Returns the attachment, or binary large object (blob), stored for the attachment field with the indicated ID on the specified server. |
static StatisticsResultInfo[] |
ARGetEntryStatistics(ARServerUser context,
SchemaKey schemaKey,
QualifierInfo qual,
ArithmeticOrRelationalOperand target,
int statistic,
InternalID[] groupByList)
Computes the indicated statistic for the form entries that match the conditions specified by the qualifier parameter. |
static FullTextInfo[] |
ARGetFullTextInfo(ARServerUser context,
int[] requestList)
Returns the requested Full Text Search (FTS) information for the specified server. |
static AccessNameID[] |
ARGetListAlertUser(ARServerUser context)
Gets list of registered users. |
static CompoundSchemaInfo[] |
ARGetListExtSchemaCandidates(ARServerUser context,
int schemaType)
Returns a list of all the external schemas candidates that are able to be converted into AR System schemas. |
static GroupInfo[] |
ARGetListGroup(ARServerUser context,
AccessNameID user,
AccessNameID password)
Returns a list of access control groups on the specified server. |
static LicenseInfo[] |
ARGetListLicense(ARServerUser context,
LicenseNameID licenseType)
Returns list of license info. |
static ServerNameID[] |
ARGetListServer(ARServerUser context)
Returns the list of available AR System servers defined in the ar directory file (UNIX only). |
static SQLResult |
ARGetListSQL(ARServerUser context,
java.lang.String sqlCommand,
int maxRetrieve,
boolean retrieveTotalMatches)
Returns a list of rows from the underlying SQL database on the specified server. |
static SQLResult |
ARGetListSQLForActiveLink(ARServerUser context,
NameID actlinkName,
int actionIndex,
int actionType,
Timestamp timestamp,
EntryItem[] keywordList,
EntryItem[] parameterList,
int maxRetrieve,
boolean retrieveTotalMatches)
Returns a list of SQL values as specified in the given SQL command from the AR System. |
static UserInfo[] |
ARGetListUser(ARServerUser context,
int type,
Timestamp changedSince)
Returns a list of users on the specified AR System server. |
static java.lang.String |
ARGetLocalHostID(ARServerUser context)
Get License HostID. |
static LocalizedValueInfo |
ARGetLocalizedValue(ARServerUser ctx,
LocalizedValueCriteria criteria,
LocalizedRequestInfo request)
Gets a localized text string from the message catalog schema. |
static java.lang.String[] |
ARGetMultipleCurrencyRatioSets(ARServerUser context,
Timestamp[] ratioTimestamps)
Retrieves multiple sets of currency ratios for specified points in time. |
static ExtFieldCandidatesInfo[] |
ARGetMultipleExtFieldCandidates(ARServerUser context,
CompoundSchemaInfo schema)
Returns information about all the columns/fields candidates for an external schema. |
static LocalizedValueInfo[] |
ARGetMultipleLocalizedValues(ARServerUser ctx,
LocalizedValueCriteria criteria,
LocalizedRequestInfo[] requests)
Gets multiple localized texts from the catalog file. |
static QualifierInfo |
ARGetQualifier(ARServerUser ctx,
java.lang.String queryString,
Field[] fieldList1,
Field[] fieldList2,
int queryContext)
Constructs a QualifierInfo object given a string representation. |
static java.lang.String |
ARGetQualifierString(ARServerUser ctx,
QualifierInfo qual,
Field[] fieldList1,
Field[] fieldList2,
int queryContext,
boolean isEscalation)
Constructs a String object containing the string representation of a
given qualifier object. |
static ServerInfo[] |
ARGetServerInfo(ARServerUser context,
int[] requestList)
Returns the requested configuration information for the specified server. |
static ServerInfo[] |
ARGetServerStatistics(ARServerUser context,
int[] requestList)
Returns the requested statistics for the specified server. |
static Value |
ARGetSessionConfiguration(ARServerUser context,
int tag)
Gets session variable for an API session. |
static java.lang.String |
ARGetTextForErrorMessage(ARServerUser context,
int msgId)
Returns the message text for the specified error from the local catalog (in the local language). |
static void |
ARImport(ARServerUser context,
StructItemInfo[] items,
int importOption,
java.lang.String importBuffer)
Imports the indicated structure definitions to the specified server. |
static void |
ARRegisterForAlerts(ARServerUser context,
int clientPort,
int registrationFlags)
Register a client with the server to receive alert signals. |
static void |
ARSetFullTextInfo(ARServerUser context,
FullTextInfo[] infos)
Updates the indicated Full Text Search (FTS) information for the specified server. |
static void |
ARSetServerInfo(ARServerUser context,
ServerInfo[] infos)
Updates the indicated configuration information for the specified server. |
static void |
ARSetServerPort(ARServerUser context,
NameID server,
int port,
int progNum)
Specifies the port that your program will use to communicate with the AR System server, and whether to use a private server. |
static void |
ARSetSessionConfiguration(ARServerUser context,
int tag,
Value value)
Sets session variable for the API session. |
static LicenseValidInfo |
ARValidateLicense(ARServerUser context,
LicenseNameID licenseType)
Validates license info. |
static LicenseValidInfo[] |
ARValidateMultipleLicense(ARServerUser context,
LicenseNameID[] licenseTypes)
Validates multiple license info. |
static java.lang.String |
ARXMLCreateEntry(ARServerUser context,
java.lang.String inputMapping,
java.lang.String inputDoc,
java.lang.String outputMapping,
java.lang.String optionDoc)
AR System internal use only. |
static java.lang.String |
ARXMLGetEntry(ARServerUser context,
java.lang.String queryMapping,
java.lang.String queryDoc,
java.lang.String outputMapping,
java.lang.String optionDoc)
AR System internal use only. |
static java.lang.String |
ARXMLSetEntry(ARServerUser context,
java.lang.String queryMapping,
java.lang.String queryDoc,
java.lang.String inputMapping,
java.lang.String inputDoc,
java.lang.String outputMapping,
java.lang.String optionDoc)
AR System internal use only. |
static java.lang.String |
getConvertedEncoding()
AR System internal use only. |
static java.lang.String |
getConvertedEncodingForDeploy()
AR System internal use only. |
static java.lang.String |
getWebEncodingForDeploy()
AR System internal use only. |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
public Util()
| Method Detail |
public static void ARGetEntryBlob(ARServerUser context,
NameID schemaID,
EntryID entryID,
FieldID fldID,
AttachmentInfo attach)
throws ARException
ARServerUser parameter.
User permissions are verified for the specified field. If
the user cannot access the field, the system returns an error message.NullPointerException - if invalid ARServerUser objectARException - if blob attachment is not returned
public static void ARSetSessionConfiguration(ARServerUser context,
int tag,
Value value)
throws ARException
AR_SESS_CHUNK_RESPONSE_SIZE - AR_SESS_CHUNK_RESPONSE_SIZE or 1 is the maximum size of a single response.AR_SESS_TIMEOUT_NORMAL - AR_SESS_TIMEOUT_NORMAL or 2 is the timeout for normal operations.AR_SESS_TIMEOUT_LONG - AR_SESS_TIMEOUT_LONG or 3 is the timeout for long operations.AR_SESS_TIMEOUT_XLONG - AR_SESS_TIMEOUT_XLONG or 4 is the timeout for extra long operations.AR_SESS_TIMEOUT_TC - AR_SESS_TIMEOUT_TC or 5 is timeout for TC server operations.AR_SESS_TRY_UNENCRYPTED_PASSWORD - AR_SESS_TRY_UNENCRYPTED_PASSWORD or 6 lets you try an unencrypted password.AR_SESS_LOCK_TO_SOCKET_NUMBER - AR_SESS_LOCK_TO_SOCKET_NUMBER or 7 is a socket number to lock to.AR_SESS_LAST_COUNT - AR_SESS_LAST_COUNT or 8 is the last search count.AR_SESS_LAST_ID - AR_SESS_LAST_ID or 9 is the last created entry identifier.AR_SESS_USING_PRIVATE_SERVER - AR_SESS_USING_PRIVATE_SERVER
or 10 is a flag that indicates if using private server.AR_SESS_POOLED - AR_SESS_POOLED
or 11 indicates if the session is pooled.AR_SESS_CLIENT_TYPE - AR_SESS_CLIENT_TYPE
or 12 indicates client type of the API programAR_SESS_VUI_TYPE - AR_SESS_VUI_TYPE
or 13 indicates VUI type of the VUI.NullPointerException - if invalid ARServerUser objectARException - if session is not set
public static Value ARGetSessionConfiguration(ARServerUser context,
int tag)
throws ARException
AR_SESS_CHUNK_RESPONSE_SIZE),
and return the value of the session variable.
Use any of following session variables:AR_SESS_CHUNK_RESPONSE_SIZE - AR_SESS_CHUNK_RESPONSE_SIZE or 1 is the maximum size of a single response.AR_SESS_TIMEOUT_NORMAL - AR_SESS_TIMEOUT_NORMAL or 2 is the timeout for normal operations.AR_SESS_TIMEOUT_LONG - AR_SESS_TIMEOUT_LONG or 3 is the timeout for long operations.AR_SESS_TIMEOUT_XLONG - AR_SESS_TIMEOUT_XLONG or 4 is the timeout for extra long operations.AR_SESS_TIMEOUT_TC - AR_SESS_TIMEOUT_TC or 5 is timeout for TC server operations.AR_SESS_TRY_UNENCRYPTED_PASSWORD - AR_SESS_TRY_UNENCRYPTED_PASSWORD or 6 lets you try an unencrypted password.AR_SESS_LOCK_TO_SOCKET_NUMBER - AR_SESS_LOCK_TO_SOCKET_NUMBER or 7 is a socket number to lock to.AR_SESS_LAST_COUNT - AR_SESS_LAST_COUNT or 8 is the last search count.AR_SESS_LAST_ID - AR_SESS_LAST_ID or 9 is the last created entry identifier.AR_SESS_USING_PRIVATE_SERVER - AR_SESS_USING_PRIVATE_SERVER
or 10 is a flag that indicates if using private server.NullPointerException - if invalid ARServerUser objectARException - if session is not returned
public static java.lang.String ARExport(ARServerUser context,
StructItemInfo[] items,
NameID displayTag,
int vuiType)
throws ARException
NullPointerException - if invalid ARServerUser objectARException - if structure definition is not exported
public static void ARImport(ARServerUser context,
StructItemInfo[] items,
int importOption,
java.lang.String importBuffer)
throws ARException
NullPointerException - if invalid ARServerUser objectARException - if structure definition is not imported
public static ServerInfo[] ARGetServerInfo(ARServerUser context,
int[] requestList)
throws ARException
Server Options Whose Values Can Be Retrieved
AR_SERVER_INFO_EXPORT_VERSION - The AR_SERVER_INFO_EXPORT_VERSION
integer indicates the server's export version number. This setting allows
you to set the export version for object definitions of the server to ensure
compatibility with older clients.
AR_SERVER_INFO_ALLOW_GUESTS - The AR_SERVER_INFO_ALLOW_GUESTS
flag indicates whether the server accepts guest users. Guest users are users
not registered with the AR System. If allowed, guest users have no
permissions but are allowed to perform some basic operations. Guest users
can submit entries to forms for which permission has been given to the Public
group and enter data in fields that have been defined as allowing any user to
submit. If not allowed, unregistered users have no access to the system. Valid
values for this option are 1 (TRUE) and 0 (FALSE). The default value is 1
(allow guest users).AR_SERVER_INFO_USE_ETC_PASSWD - The AR_SERVER_INFO_USE_ETC_PASSWD
flag indicates whether the /etc/passwd file is used to validate users not
registered with the AR System (UNIX only). If so, users in
/etc/passwd are considered valid users of the AR System and are assigned
to a group identified by the UNIX group ID. Valid values for this option are 1
(TRUE) and 0 (FALSE). The default value is 1 (use password file).AR_SERVER_INFO_XREF_PASSWORDS - The AR_SERVER_INFO_XREF_PASSWORDS
flag indicates whether the /etc/passwd file is cross-referenced if an
AR System user has no password (UNIX only). This option enables you to
manage group membership and other support information by using the
AR System but still manage passwords using the /etc/passwd file. Valid
values for this option are 1 (TRUE) and 0 (FALSE). The default value is 0
(blank passwords are not cross referenced).AR_SERVER_INFO_DEBUG_MODE - The AR_SERVER_INFO_DEBUG_MODE
mask indicates the server debug modes.
AR_SERVER_INFO_SQL_LOG_FILE).
AR_SERVER_INFO_FILTER_LOG_FILE).
AR_SERVER_INFO_USER_LOG_FILE).
AR_SERVER_INFO_ESCALATION_LOG_FILE).
AR_SERVER_INFO_API_LOG_FILE).
AR_SERVER_INFO_THREAD_LOG_FILE).
AR_SERVER_INFO_CACHE_LOG_FILE).
AR_SERVER_INFO_DS_LOG_FILE).
AR_SERVER_INFO_DB_PASSWORD - AR_SERVER_INFO_DB_PASSWORD is the
database password associated with the ARSystem database or tablespace
(applicable to Sybase and Oracle databases only). The password is stored in
encrypted form.AR_SERVER_INFO_ACTLINK_DIR - AR_SERVER_INFO_ACTLINK_DIR is the
name of a directory where all external processes to be run by active links
must reside. If the value is NULL, active links can run processes located anywhere.AR_SERVER_INFO_ACTLINK_SHELL - AR_SERVER_INFO_ACTLINK_SHELL is the
name of a shell to use when running external processes from an active
link. If the value is NULL, processes are run from /bin/sh (UNIX) or without
a shell (Windows NT).AR_SERVER_INFO_USER_CACHE_UTILS - AR_SERVER_INFO_USER_CACHE_UTILS is the
flag indicating whether the ARCACHE and ARRELOAD utilities are disabled.
Valid values for this option are 1 (disabled) and 0 (enabled).AR_SERVER_INFO_SET_PROC_TIME - AR_SERVER_INFO_SET_PROC_TIME is the
number of seconds the server waits before ending a set fields process that
has not completed. Valid values for this option are 1 through 20. The default
value is five seconds.AR_SERVER_INFO_EMAIL_FROM - AR_SERVER_INFO_EMAIL_FROM is the
sender name to use for filter-generated email notifications where no
subject is specified. Only "trusted" email users can use this name (refer to
documentation about the /etc/sendmail.cf file for more information
about trusted users).AR_SERVER_INFO_SQL_LOG_FILE - AR_SERVER_INFO_SQL_LOG_FILE is the
The name of the file to use if SQL tracing is turned on (see
AR_SERVER_INFO_DEBUG_MODE).AR_SERVER_INFO_FLOAT_TIMEOUT - AR_SERVER_INFO_FLOAT_TIMEOUT is the
number of hours the server waits before disconnecting inactive users. If a
user is holding a floating write license token, the system also frees the token
at this time.AR_SERVER_INFO_UNQUAL_QUERIES - AR_SERVER_INFO_UNQUAL_QUERIES is the flag indicating whether the server allows unqualified queries. Unqualified
queries are calls in which the qualifier parameter is
either NULL or has an operation value of 0 (AR_COND_OP_NONE). These
queries can cause performance problems, especially for large forms, because
they return all entries for a given form. If not allowed, you can return all form
entries by specifying a “ dummy” qualification such as 1 = 1. Valid values for
this option are 1 (TRUE) and 0 (FALSE). The default value is 1 (allow unqualified queries).AR_SERVER_INFO_FILTER_LOG_FILE - AR_SERVER_INFO_UNQUAL_QUERIES is the name of the file to use if filter tracing is turned on (see
AR_SERVER_INFO_DEBUG_MODE).AR_SERVER_INFO_USER_LOG_FILE - AR_SERVER_INFO_USER_LOG_FILE is the name of the file to use if user tracing is turned on (see
AR_SERVER_INFO_DEBUG_MODE).AR_SERVER_INFO_MAX_ENTRIES - AR_SERVER_INFO_MAX_ENTRIES is the maximum number of entries returned by a single query. Because users
can also specify the maximum number of entries returned (in query
preferences), the actual maximum is the lower of these two values. The
default value is no (server-defined) maximum.AR_SERVER_INFO_ESCALATION_LOG_FILE - AR_SERVER_INFO_ESCALATION_LOG_FILE is the name of the file to use if escalation tracing is turned on (see
AR_SERVER_INFO_DEBUG_MODE).AR_SERVER_INFO_SUBMITTER_MODE - AR_SERVER_INFO_SUBMITTER_MODE is the value indicating whether the Submitter field can be changed and whether
the submitter of an entry must have a license to modify it. In locked mode, the
Submitter field cannot be changed after submit, and the submitter can modify
the entry with or without a write license (if the Submitter group has Change
permission). In changeable mode, the Submitter field can be changed after
submit, but the submitter must have a write license to modify the entry (if the
Submitter group has Change permission). Valid values for this option are 1
(locked) and 2 (changeable). The default value is 2 (changeable).AR_SERVER_INFO_API_LOG_FILE - AR_SERVER_INFO_API_LOG_FILE is the name of the file to use if API tracing is turned on (see
AR_SERVER_INFO_DEBUG_MODE).AR_SERVER_INFO_FTEXT_TIMEOUT - AR_SERVER_INFO_FTEXT_TIMEOUT is the number of hours the server waits before disconnecting inactive users
with Full Text licenses. If a user is holding a floating Full Text license token,
the system also frees the token at this time.AR_SERVER_INFO_DS_RPC_SOCKET - AR_SERVER_INFO_DS_RPC_SOCKET is the specific server socket to use for the distributed server. Valid values for
this option are 390600 and 390680 through 390694. Any other value causes
the distributed server to use the default server.AR_SERVER_INFO_DS_LOG_FILE - AR_SERVER_INFO_DS_LOG_FILE is the name of the file to use if distributed server tracing is turned on (see
AR_SERVER_INFO_DEBUG_MODE).AR_SERVER_INFO_SUPPRESS_WARN - AR_SERVER_INFO_SUPPRESS_WARN is a series of zero or more message numbers (separated by spaces) that identify
the informational or warning messages that the system suppresses.AR_SERVER_INFO_SAVE_LOGIN - AR_SERVER_INFO_SAVE_LOGIN is a value indicating whether users must log in to client tools.
AR_SERVER_INFO_ADMIN_ONLY - AR_SERVER_INFO_ADMIN_ONLY is a flag indicating whether the server is in Administrator Only mode (1) or not
(0). When not in Administrator Only mode, subadministrators can also
perform administrator duties. The default value is 0 (Not in Administrator
Only mode).AR_SERVER_INFO_FLASH_DAEMON - AR_SERVER_INFO_FLASH_DAEMON is a flag indicating whether Flashboards is installed (1) or not (0). The default
value is 1 if the server has one or more Flashboards licenses, and 0 if the
server has no licenses.AR_SERVER_INFO_THREAD_LOG_FILE - AR_SERVER_INFO_THREAD_LOG_FILE is the name of the file to use if thread tracing is turned on (see
AR_SERVER_INFO_DEBUG_MODE) (Windows NT only).AR_SERVER_INFO_TCD_TCP_PORT - AR_SERVER_INFO_TCD_TCP_PORT is the TCP port that the AR System server will use.AR_SERVER_INFO_DSO_DEST_PORT - AR_SERVER_INFO_DSO_DEST_PORT is the TCP port that the distributed server option uses to communicate with the
AR System server.AR_SERVER_INFO_NFY_TCP_PORT - AR_SERVER_INFO_NFY_TCP_PORT is the TCP port that the Notifier server will use.AR_SERVER_INFO_FILT_MAX_TOTAL - AR_SERVER_INFO_FILT_MAX_TOTAL is the maximum number of filters that the server will execute for a given
operation. The default value is 10000.AR_SERVER_INFO_FILT_MAX_STACK - AR_SERVER_INFO_FILT_MAX_STACK is the maximum number of levels of recursion allowed for a given operation.
The data modification performed by an AR_FILTER_ACTION_FIELDP filter
action could trigger a second set, or level, of filters, one of which could trigger
filters a third level down and so on. This option limits the number of times
such recursion can happen, preventing the server crash that would occur if
the recursion continued indefinitely. The default value is 25.AR_SERVER_INFO_DEFAULT_ORDER_BY - AR_SERVER_INFO_DEFAULT_ORDER_BY is an integer (1 or 0) indicating the default order of requests in a form when
issuing ARGetListEntry calls, so that the sorting is done on the database
and before the results are returned. Valid values for this option are 0 (no sort
order) or 1 (use EntryId order). The default value is 1.AR_SERVER_INFO_DELAYED_CACHE - AR_SERVER_INFO_DELAYED_CACHE is a flag indicating whether to disable recacheing of the shared cache after a
time-out (1) or not (0). The default value is 0 (delayed recache not disabled).AR_SERVER_INFO_DSO_MERGE_STYLE - AR_SERVER_INFO_DSO_MERGE_STYLE is an integer (1 or 0) indicating the merge style to use for the Distributed Server
Option. A 0 indicates the new style; 1 indicates the old style. The default is 0.
For a 1 value (old style), the merge style overwrites entries; for a 0 value (new
style), a true merge is performed according to the rules of the Distributed
Server Option setup. For backward compatibility, this server option can be set
to 1.AR_SERVER_INFO_EMAIL_LINE_LEN - AR_SERVER_INFO_EMAIL_LINE_LEN is the maximum line length of e-mail messages.AR_SERVER_INFO_EMAIL_SYSTEM - AR_SERVER_INFO_EMAIL_SYSTEM is a character string that indicates the email system on UNIX.AR_SERVER_INFO_INFORMIX_RELAY_MOD - AR_SERVER_INFO_INFORMIX_RELAY_MOD is a character string that indicates the Informix relay module.AR_SERVER_INFO_PS_RPC_SOCKET - AR_SERVER_INFO_EMAIL_LINE_LEN is the RPC program number and port pairs the Private Servers will use. A value
of 0 for the port means no port was specified.AR_SERVER_INFO_REGISTER_PORTMAPPER - AR_SERVER_INFO_REGISTER_PORTMAPPER is a flag indicating whether to register with the portmapper (1) or not (0). The
default value is 1.AR_SERVER_INFO_SERVER_NAME - AR_SERVER_INFO_SERVER_NAME is an alias server name that is always interpreted as the current server. The
name is not fully qualified. For example, the server alpha.remedy.com
would have the value alpha. See also “ Server-Name” in ar.conf.AR_SERVER_INFO_DBCONF - AR_SERVER_INFO_DBCONF is the complete contents of the db.conf (ardb.cfg) file.AR_SERVER_INFO_AP_RPC_SOCKET - AR_SERVER_INFO_AP_RPC_SOCKET is the RPC program number the approval server will use when contacting the
AR System. This allows you to define a specific AR System server for private
use by the approval server.AR_SERVER_INFO_AP_LOG_FILE - AR_SERVER_INFO_AP_LOG_FILE is the name of the file to use if approval tracing is turned on (see
AR_SERVER_INFO_DEBUG_MODE).AR_SERVER_INFO_AP_DEFN_CHECK - AR_SERVER_INFO_AP_DEFN_CHECK is the length of time in seconds between checks by an application service to
verify that definitions it is using from the AR System are correct. The value
can be from 0 to 3600 seconds (1 hour). A value of 0 means to check
definitions with each command. A larger value means a slight delay in
recognizing changes to some definition, while a smaller value means the
significant overhead of checking the definitions often. The default value is 300
seconds (5 minutes).AR_SERVER_INFO_MAX_LOG_FILE_SIZE - AR_SERVER_INFO_MAX_LOG_FILE_SIZE is the maximum size for system log files. The default value is 0 (no limit).AR_SERVER_INFO_CLUSTERED_INDEX - AR_SERVER_INFO_CLUSTERED_INDEX is a value that indicates whether a clustered index is created on the Entry-Id
field when a new form is created. Valid values for this option are 1 (create a
clustered index) and 0 (create a unique index). The default value is 1
(clustered), but you can override this in the AR configuration file.AR_SERVER_INFO_EMAIL_TIMEOUT - (UNIX only) AR_SERVER_INFO_EMAIL_TIMEOUT is the length of time in seconds before the system closes the pipe
to sendmail to unblock the AR System server. Valid values for this option are
from 1 to 300. The default value is 10.AR_SERVER_INFO_SCC_ENABLED - AR_SERVER_INFO_SCC_ENABLED is a value indicating whether a source code control system is being used with
the AR System. A 0 value (default) means a source code control system is not
present.AR_SERVER_INFO_SCC_PROVIDER_NAME - AR_SERVER_INFO_SCC_PROVIDER_NAME is a character string for the source code control system provider name. If none
is present, this value is NULL. This string is limited to 255 characters.AR_SERVER_INFO_SCC_TARGET_DIR - AR_SERVER_INFO_SCC_TARGET_DIR is a character string for the source code control system target directory. If none
is present, this value is NULL. This string is limited to 255 characters.AR_SERVER_INFO_SCC_COMMENT_CHECKIN - AR_SERVER_INFO_SCC_COMMENT_CHECKIN is an integer (0 or 1) value indicating whether or not a source code control
integration requires you to entire a comment at checkin time. A 0 value
means no comment is required.AR_SERVER_INFO_SCC_COMMENT_CHECKOUT - AR_SERVER_INFO_SCC_COMMENT_CHECKOUT is an integer (0 or 1) value indicating whether or not a source code control
integration requires you to entire a comment at checkout time. A 0 value
means no comment is required.AR_SERVER_INFO_SCC_INTEGRATION_MODE - AR_SERVER_INFO_SCC_INTEGRATION_MODE is an integer (0 or 1) value indicating the level of source code control
integration. A 0 (the default) value indicates an advisory level of integration,
which means you can modify and save an object without having it checked
out from the source code control application. A 1 value means enforced
integration, which has strict rules for controlling source files (for example,
enforced integration means that other administrators will not be able to
modify and save changes on an object that you have checked out).integration, which has strict rules for controlling source files (for example,
enforced integration means that other administrators will not be able to
modify and save changes on an object that you have checked out).AR_SERVER_INFO_EA_RPC_SOCKET - AR_SERVER_INFO_EA_RPC_SOCKET is the RPC socket number on which an external authentication server awaits
requests for authentication. A 0 value means external authentication will not
be used. This attribute persists in the ar.cfg/ar.conf file. The default value is 0.AR_SERVER_INFO_EA_RPC_TIMEOUT - AR_SERVER_INFO_EA_RPC_TIMEOUT is the RPC timeout (seconds) used when making calls to the authentication
(AREA) server (for example, 30 seconds). This attribute persists in the ar.cfg/
ar.conf file. The default value is 30 seconds.AR_SERVER_INFO_EA_SYNC_TIMEOUT - AR_SERVER_INFO_EA_SYNC_TIMEOUT is the internal (seconds) the AR server uses to periodically invoke the external
authentication server’s AREANeedToSyncCallback() function, which
instructs the AR System server to renew its internally stored user information
in the event there are changes made to the source used to authenticate users.
A 0 value means that the AR System server will not invoke the call to the
external authentication (AREA) server. This attribute persists in the ar.cfg/
ar.conf file. The default value is 300 seconds.AR_SERVER_INFO_LOGFILE_APPEND - AR_SERVER_INFO_LOGFILE_APPEND is an integer (0/1) value that indicates whether to create a separate*.bak file or
to append to the existing log file. A 0 value creates a *.bak file; 1 indicates that
new log information be appended to the existing file.AR_SERVER_INFO_MINIMUM_API_VER - AR_SERVER_INFO_MINIMUM_API_VER is a value indicating the minimum API version that the server supports. The
API versions are:
Server Options Whose Values Can Be Read But Not Set
AR_SERVER_INFO_DB_TYPE - AR_SERVER_INFO_DB_TYPE is the underlying database type (character string).AR_SERVER_INFO_SERVER_LICENSE - AR_SERVER_INFO_SERVER_LICENSE is the server license type (character string).AR_SERVER_INFO_FIXED_LICENSE - AR_SERVER_INFO_FIXED_LICENSE is the number of fixed user licenses (int).AR_SERVER_INFO_VERSION - AR_SERVER_INFO_VERSION is the AR System server version (character string).AR_SERVER_INFO_DB_NAME - AR_SERVER_INFO_DB_NAME is the name of the underlying SQL database (not applicable for Oracle
databases). The default value is ARSystem.AR_SERVER_INFO_HARDWARE - AR_SERVER_INFO_HARDWARE is the server hardware type (character string).AR_SERVER_INFO_OS: - AR_SERVER_INFO_OS is a character string that indicates the server operating system which includes
the version number.AR_SERVER_INFO_SERVER_DIR - AR_SERVER_INFO_SERVER_DIR is the data directory for the AR System. This directory contains support files for
the underlying SQL database (but no actual database files). For flat file
databases, this directory contains both database definition and data files.AR_SERVER_INFO_DBHOME_DIR - AR_SERVER_INFO_DBHOME_DIR is the home directory for the underlying database (applicable for SQL
databases only).AR_SERVER_INFO_FLOAT_LICENSE - AR_SERVER_INFO_FLOAT_LICENSE is the number of floating write licenses defined.AR_SERVER_INFO_REM_SERV_ID - AR_SERVER_INFO_REM_SERV_ID is the AR System server ID associated with the license (character string).AR_SERVER_INFO_MULTI_SERVER - AR_SERVER_INFO_MULTI_SERVER is an integer (0/1) value indicating the use of the multi-server option. A 0
value indicates a single server; a 1 value indicates the use of the multi-server
option.AR_SERVER_INFO_EMBEDDED_SQL - AR_SERVER_INFO_EMBEDDED_SQL is a value indicating whether the underlying SQL database is embedded
(bundled with the Action Request System). Valid values for this option are 0
(not embedded) and 1 (embedded).AR_SERVER_INFO_MAX_SCHEMAS - AR_SERVER_INFO_MAX_SCHEMAS is the maximum number of forms allowed. The default value is 0 (no limit).AR_SERVER_INFO_DB_VERSION - AR_SERVER_INFO_DB_VERSION is the underlying database version (character string).AR_SERVER_INFO_FTEXT_FIXED - AR_SERVER_INFO_FTEXT_FIXED is the number of fixed Full Text licenses defined.AR_SERVER_INFO_FTEXT_FLOAT - AR_SERVER_INFO_FTEXT_FLOAT is the number of floating Full Text licenses defined.AR_SERVER_INFO_SERVER_IDENT - AR_SERVER_INFO_SERVER_IDENT is the unique identifier for the server (character string).AR_SERVER_INFO_DS_SVR_LICENSE - AR_SERVER_INFO_DS_SVR_LICENSE is the distributed server license type (character string).AR_SERVER_INFO_DS_MAPPING - AR_SERVER_INFO_DS_MAPPING is the name of the form that contains distributed mapping definitions
(applicable for Distributed Server Option only).AR_SERVER_INFO_DS_PENDING - AR_SERVER_INFO_DS_PENDING is the name of the form that contains the pending operation list (applicable for
Distributed Server Option only).AR_SERVER_INFO_HOSTNAME - AR_SERVER_INFO_HOSTNAME is the host name of the server (“ short” machine name).AR_SERVER_INFO_FULL_HOSTNAME - AR_SERVER_INFO_FULL_HOSTNAME is the full DNS host name of the server (“ long” machine name).AR_SERVER_INFO_U_CACHE_CHANGE - AR_SERVER_INFO_U_CACHE_CHANGE is the time of the last change to the user cache.AR_SERVER_INFO_G_CACHE_CHANGE - AR_SERVER_INFO_G_CACHE_CHANGE is the time of the last change to the group cache.AR_SERVER_INFO_STRUCT_CHANGE - AR_SERVER_INFO_STRUCT_CHANGE is the last structure change (for this run of the server).Int.AR_SERVER_INFO_CASE_SENSITIVE - AR_SERVER_INFO_CASE_SENSITIVE is a value indicating whether the underlying database is case-sensitive. Valid
values for this option are 0 (case-sensitive) and
1 (case-insensitive). The default value is 1 (case-insensitive).AR_SERVER_INFO_SERVER_LANG - AR_SERVER_INFO_SERVER_LANG is the local language setting of the server.AR_SERVER_INFO_INFORMIX_DBN - AR_SERVER_INFO_INFORMIX_DBN is the Informix database server name. This option has a value only if you are using
an Informix database.AR_SERVER_INFO_INFORMIX_TBC - AR_SERVER_INFO_INFORMIX_TBC is the Informix configuration file. This option has a value only if you are using
an Informix database. The default value is onconfig.AR_SERVER_INFO_ORACLE_TWO_T - AR_SERVER_INFO_ORACLE_TWO_T is the two-task environment setting for remote access to an Oracle database.
This option has a value only if you are using an Oracle database.AR_SERVER_INFO_SYBASE_CHARSET - AR_SERVER_INFO_SYBASE_CHARSET is the character set being used to access a Sybase database. This option has a
value only if you are using a Sybase database.AR_SERVER_INFO_SYBASE_SERV - AR_SERVER_INFO_SYBASE_SERV is the Sybase logical server name. This option has a value only if you are using
a Sybase database. The default value is SYBASE.AR_SERVER_INFO_SHARED_MEM - (UNIX only) AR_SERVER_INFO_SHARED_MEM is a flag indicating whether the shared memory is disabled or
enabled. Valid values for this option are 1 (shared memory enabled) and 0
(shared memory disabled).AR_SERVER_INFO_DB_USER - AR_SERVER_INFO_DB_USER is the user name the Action Request System uses to access the underlying
database.AR_SERVER_INFO_APPL_PENDING - AR_SERVER_INFO_APPL_PENDING is the name of the form that contains the pending list of application commands
to be processed. This form is specific to the use of Application-Commands.AR_SERVER_INFO_SERVER_TIME - AR_SERVER_INFO_SERVER_TIME is the AR System server time.NullPointerException - if invalid ARServerUser objectARException - if configuration information is not returned
public static void ARSetServerInfo(ARServerUser context,
ServerInfo[] infos)
throws ARException
Server Options Whose Values Can Be Retrieved
AR_SERVER_INFO_EXPORT_VERSION - The AR_SERVER_INFO_EXPORT_VERSION
integer indicates the server's export version number. This setting allows
you to set the export version for object definitions of the server to ensure
compatibility with older clients.
AR_SERVER_INFO_ALLOW_GUESTS - The AR_SERVER_INFO_ALLOW_GUESTS
flag indicates whether the server accepts guest users. Guest users are users
not registered with the AR System. If allowed, guest users have no
permissions but are allowed to perform some basic operations. Guest users
can submit entries to forms for which permission has been given to the Public
group and enter data in fields that have been defined as allowing any user to
submit. If not allowed, unregistered users have no access to the system. Valid
values for this option are 1 (TRUE) and 0 (FALSE). The default value is 1
(allow guest users).AR_SERVER_INFO_USE_ETC_PASSWD - The AR_SERVER_INFO_USE_ETC_PASSWD
flag indicates whether the /etc/passwd file is used to validate users not
registered with the AR System (UNIX only). If so, users in
/etc/passwd are considered valid users of the AR System and are assigned
to a group identified by the UNIX group ID. Valid values for this option are 1
(TRUE) and 0 (FALSE). The default value is 1 (use password file).AR_SERVER_INFO_XREF_PASSWORDS - The AR_SERVER_INFO_XREF_PASSWORDS
flag indicates whether the /etc/passwd file is cross-referenced if an
AR System user has no password (UNIX only). This option enables you to
manage group membership and other support information by using the
AR System but still manage passwords using the /etc/passwd file. Valid
values for this option are 1 (TRUE) and 0 (FALSE). The default value is 0
(blank passwords are not cross referenced).AR_SERVER_INFO_DEBUG_MODE - The AR_SERVER_INFO_DEBUG_MODE
mask indicates the server debug modes.
AR_SERVER_INFO_SQL_LOG_FILE).
AR_SERVER_INFO_FILTER_LOG_FILE).
AR_SERVER_INFO_USER_LOG_FILE).
AR_SERVER_INFO_ESCALATION_LOG_FILE).
AR_SERVER_INFO_API_LOG_FILE).
AR_SERVER_INFO_THREAD_LOG_FILE).
AR_SERVER_INFO_CACHE_LOG_FILE).
AR_SERVER_INFO_DS_LOG_FILE).
AR_SERVER_INFO_DB_PASSWORD - AR_SERVER_INFO_DB_PASSWORD is the
database password associated with the ARSystem database or tablespace
(applicable to Sybase and Oracle databases only). The password is stored in
encrypted form.AR_SERVER_INFO_ACTLINK_DIR - AR_SERVER_INFO_ACTLINK_DIR is the
name of a directory where all external processes to be run by active links
must reside. If the value is NULL, active links can run processes located anywhere.AR_SERVER_INFO_ACTLINK_SHELL - AR_SERVER_INFO_ACTLINK_SHELL is the
name of a shell to use when running external processes from an active
link. If the value is NULL, processes are run from /bin/sh (UNIX) or without
a shell (Windows NT).AR_SERVER_INFO_USER_CACHE_UTILS - AR_SERVER_INFO_USER_CACHE_UTILS is the
flag indicating whether the ARCACHE and ARRELOAD utilities are disabled.
Valid values for this option are 1 (disabled) and 0 (enabled).AR_SERVER_INFO_SET_PROC_TIME - AR_SERVER_INFO_SET_PROC_TIME is the
number of seconds the server waits before ending a set fields process that
has not completed. Valid values for this option are 1 through 20. The default
value is five seconds.AR_SERVER_INFO_EMAIL_FROM - AR_SERVER_INFO_EMAIL_FROM is the
sender name to use for filter-generated email notifications where no
subject is specified. Only "trusted" email users can use this name (refer to
documentation about the /etc/sendmail.cf file for more information
about trusted users).AR_SERVER_INFO_SQL_LOG_FILE - AR_SERVER_INFO_SQL_LOG_FILE is the
The name of the file to use if SQL tracing is turned on (see
AR_SERVER_INFO_DEBUG_MODE).AR_SERVER_INFO_FLOAT_TIMEOUT - AR_SERVER_INFO_FLOAT_TIMEOUT is the
number of hours the server waits before disconnecting inactive users. If a
user is holding a floating write license token, the system also frees the token
at this time.AR_SERVER_INFO_UNQUAL_QUERIES - AR_SERVER_INFO_UNQUAL_QUERIES is the flag indicating whether the server allows unqualified queries. Unqualified
queries are calls in which the qualifier parameter is
either NULL or has an operation value of 0 (AR_COND_OP_NONE). These
queries can cause performance problems, especially for large forms, because
they return all entries for a given form. If not allowed, you can return all form
entries by specifying a “ dummy” qualification such as 1 = 1. Valid values for
this option are 1 (TRUE) and 0 (FALSE). The default value is 1 (allow unqualified queries).AR_SERVER_INFO_FILTER_LOG_FILE - AR_SERVER_INFO_UNQUAL_QUERIES is the name of the file to use if filter tracing is turned on (see
AR_SERVER_INFO_DEBUG_MODE).AR_SERVER_INFO_USER_LOG_FILE - AR_SERVER_INFO_USER_LOG_FILE is the name of the file to use if user tracing is turned on (see
AR_SERVER_INFO_DEBUG_MODE).AR_SERVER_INFO_MAX_ENTRIES - AR_SERVER_INFO_MAX_ENTRIES is the maximum number of entries returned by a single query. Because users
can also specify the maximum number of entries returned (in query
preferences), the actual maximum is the lower of these two values. The
default value is no (server-defined) maximum.AR_SERVER_INFO_ESCALATION_LOG_FILE - AR_SERVER_INFO_ESCALATION_LOG_FILE is the name of the file to use if escalation tracing is turned on (see
AR_SERVER_INFO_DEBUG_MODE).AR_SERVER_INFO_SUBMITTER_MODE - AR_SERVER_INFO_SUBMITTER_MODE is the value indicating whether the Submitter field can be changed and whether
the submitter of an entry must have a license to modify it. In locked mode, the
Submitter field cannot be changed after submit, and the submitter can modify
the entry with or without a write license (if the Submitter group has Change
permission). In changeable mode, the Submitter field can be changed after
submit, but the submitter must have a write license to modify the entry (if the
Submitter group has Change permission). Valid values for this option are 1
(locked) and 2 (changeable). The default value is 2 (changeable).AR_SERVER_INFO_API_LOG_FILE - AR_SERVER_INFO_API_LOG_FILE is the name of the file to use if API tracing is turned on (see
AR_SERVER_INFO_DEBUG_MODE).AR_SERVER_INFO_FTEXT_TIMEOUT - AR_SERVER_INFO_FTEXT_TIMEOUT is the number of hours the server waits before disconnecting inactive users
with Full Text licenses. If a user is holding a floating Full Text license token,
the system also frees the token at this time.AR_SERVER_INFO_DS_RPC_SOCKET - AR_SERVER_INFO_DS_RPC_SOCKET is the specific server socket to use for the distributed server. Valid values for
this option are 390600 and 390680 through 390694. Any other value causes
the distributed server to use the default server.AR_SERVER_INFO_DS_LOG_FILE - AR_SERVER_INFO_DS_LOG_FILE is the name of the file to use if distributed server tracing is turned on (see
AR_SERVER_INFO_DEBUG_MODE).AR_SERVER_INFO_SUPPRESS_WARN - AR_SERVER_INFO_SUPPRESS_WARN is a series of zero or more message numbers (separated by spaces) that identify
the informational or warning messages that the system suppresses.AR_SERVER_INFO_SAVE_LOGIN - AR_SERVER_INFO_SAVE_LOGIN is a value indicating whether users must log in to client tools.
AR_SERVER_INFO_ADMIN_ONLY - AR_SERVER_INFO_ADMIN_ONLY is a flag indicating whether the server is in Administrator Only mode (1) or not
(0). When not in Administrator Only mode, subadministrators can also
perform administrator duties. The default value is 0 (Not in Administrator
Only mode).AR_SERVER_INFO_THREAD_LOG_FILE - AR_SERVER_INFO_THREAD_LOG_FILE is the name of the file to use if thread tracing is turned on (see
AR_SERVER_INFO_DEBUG_MODE) (Windows NT only).AR_SERVER_INFO_TCD_TCP_PORT - AR_SERVER_INFO_TCD_TCP_PORT is the TCP port that the AR System server will use.AR_SERVER_INFO_DSO_DEST_PORT - AR_SERVER_INFO_DSO_DEST_PORT is the TCP port that the distributed server option uses to communicate with the
AR System server.AR_SERVER_INFO_NFY_TCP_PORT - AR_SERVER_INFO_NFY_TCP_PORT is the TCP port that the Notifier server will use.AR_SERVER_INFO_FILT_MAX_TOTAL - AR_SERVER_INFO_FILT_MAX_TOTAL is the maximum number of filters that the server will execute for a given
operation. The default value is 10000.AR_SERVER_INFO_FILT_MAX_STACK - AR_SERVER_INFO_FILT_MAX_STACK is the maximum number of levels of recursion allowed for a given operation.
The data modification performed by an AR_FILTER_ACTION_FIELDP filter
action could trigger a second set, or level, of filters, one of which could trigger
filters a third level down and so on. This option limits the number of times
such recursion can happen, preventing the server crash that would occur if
the recursion continued indefinitely. The default value is 25.AR_SERVER_INFO_DEFAULT_ORDER_BY - AR_SERVER_INFO_DEFAULT_ORDER_BY is an integer (1 or 0) indicating the default order of requests in a form when
issuing ARGetListEntry calls, so that the sorting is done on the database
and before the results are returned. Valid values for this option are 0 (no sort
order) or 1 (use EntryId order). The default value is 1.AR_SERVER_INFO_DELAYED_CACHE - AR_SERVER_INFO_DELAYED_CACHE is a flag indicating whether to disable recacheing of the shared cache after a
time-out (1) or not (0). The default value is 0 (delayed recache not disabled).AR_SERVER_INFO_DSO_MERGE_STYLE - AR_SERVER_INFO_DSO_MERGE_STYLE is an integer (1 or 0) indicating the merge style to use for the Distributed Server
Option. A 0 indicates the new style; 1 indicates the old style. The default is 0.
For a 1 value (old style), the merge style overwrites entries; for a 0 value (new
style), a true merge is performed according to the rules of the Distributed
Server Option setup. For backward compatibility, this server option can be set
to 1.AR_SERVER_INFO_EMAIL_LINE_LEN - AR_SERVER_INFO_EMAIL_LINE_LEN is the maximum line length of e-mail messages.AR_SERVER_INFO_EMAIL_SYSTEM - AR_SERVER_INFO_EMAIL_SYSTEM is a character string that indicates the email system on UNIX.AR_SERVER_INFO_INFORMIX_RELAY_MOD - AR_SERVER_INFO_INFORMIX_RELAY_MOD is a character string that indicates the Informix relay module.AR_SERVER_INFO_PS_RPC_SOCKET - AR_SERVER_INFO_EMAIL_LINE_LEN is the RPC program number and port pairs the Private Servers will use. A value
of 0 for the port means no port was specified.AR_SERVER_INFO_REGISTER_PORTMAPPER - AR_SERVER_INFO_REGISTER_PORTMAPPER is a flag indicating whether to register with the portmapper (1) or not (0). The
default value is 1.AR_SERVER_INFO_SERVER_NAME - AR_SERVER_INFO_SERVER_NAME is an alias server name that is always interpreted as the current server. The
name is not fully qualified. For example, the server alpha.remedy.com
would have the value alpha. See also “ Server-Name” in ar.conf.AR_SERVER_INFO_DBCONF - AR_SERVER_INFO_DBCONF is the complete contents of the db.conf (ardb.cfg) file.AR_SERVER_INFO_AP_RPC_SOCKET - AR_SERVER_INFO_AP_RPC_SOCKET is the RPC program number the approval server will use when contacting the
AR System. This allows you to define a specific AR System server for private
use by the approval server.AR_SERVER_INFO_AP_LOG_FILE - AR_SERVER_INFO_AP_LOG_FILE is the name of the file to use if approval tracing is turned on (see
AR_SERVER_INFO_DEBUG_MODE).AR_SERVER_INFO_AP_DEFN_CHECK - AR_SERVER_INFO_AP_DEFN_CHECK is the length of time in seconds between checks by an application service to
verify that definitions it is using from the AR System are correct. The value
can be from 0 to 3600 seconds (1 hour). A value of 0 means to check
definitions with each command. A larger value means a slight delay in
recognizing changes to some definition, while a smaller value means the
significant overhead of checking the definitions often. The default value is 300
seconds (5 minutes).AR_SERVER_INFO_MAX_LOG_FILE_SIZE - AR_SERVER_INFO_MAX_LOG_FILE_SIZE is the maximum size for system log files. The default value is 0 (no limit).AR_SERVER_INFO_CLUSTERED_INDEX - AR_SERVER_INFO_CLUSTERED_INDEX is a value that indicates whether a clustered index is created on the Entry-Id
field when a new form is created. Valid values for this option are 1 (create a
clustered index) and 0 (create a unique index). The default value is 1
(clustered), but you can override this in the AR configuration file.AR_SERVER_INFO_EMAIL_TIMEOUT - (UNIX only) AR_SERVER_INFO_EMAIL_TIMEOUT is the length of time in seconds before the system closes the pipe
to sendmail to unblock the AR System server. Valid values for this option are
from 1 to 300. The default value is 10.AR_SERVER_INFO_SCC_ENABLED - AR_SERVER_INFO_SCC_ENABLED is a value indicating whether a source code control system is being used with
the AR System. A 0 value (default) means a source code control system is not
present.AR_SERVER_INFO_SCC_PROVIDER_NAME - AR_SERVER_INFO_SCC_PROVIDER_NAME is a character string for the source code control system provider name. If none
is present, this value is NULL. This string is limited to 255 characters.AR_SERVER_INFO_SCC_TARGET_DIR - AR_SERVER_INFO_SCC_TARGET_DIR is a character string for the source code control system target directory. If none
is present, this value is NULL. This string is limited to 255 characters.AR_SERVER_INFO_SCC_COMMENT_CHECKIN - AR_SERVER_INFO_SCC_COMMENT_CHECKIN is an integer (0 or 1) value indicating whether or not a source code control
integration requires you to entire a comment at checkin time. A 0 value
means no comment is required.AR_SERVER_INFO_SCC_COMMENT_CHECKOUT - AR_SERVER_INFO_SCC_COMMENT_CHECKOUT is an integer (0 or 1) value indicating whether or not a source code control
integration requires you to entire a comment at checkout time. A 0 value
means no comment is required.AR_SERVER_INFO_SCC_INTEGRATION_MODE - AR_SERVER_INFO_SCC_INTEGRATION_MODE is an integer (0 or 1) value indicating the level of source code control
integration. A 0 (the default) value indicates an advisory level of integration,
which means you can modify and save an object without having it checked
out from the source code control application. A 1 value means enforced
integration, which has strict rules for controlling source files (for example,
enforced integration means that other administrators will not be able to
modify and save changes on an object that you have checked out).integration, which has strict rules for controlling source files (for example,
enforced integration means that other administrators will not be able to
modify and save changes on an object that you have checked out).AR_SERVER_INFO_EA_RPC_SOCKET - AR_SERVER_INFO_EA_RPC_SOCKET is the RPC socket number on which an external authentication server awaits
requests for authentication. A 0 value means external authentication will not
be used. This attribute persists in the ar.cfg/ar.conf file. The default value is 0.AR_SERVER_INFO_EA_RPC_TIMEOUT - AR_SERVER_INFO_EA_RPC_TIMEOUT is the RPC timeout (seconds) used when making calls to the authentication
(AREA) server (for example, 30 seconds). This attribute persists in the ar.cfg/
ar.conf file. The default value is 30 seconds.AR_SERVER_INFO_EA_SYNC_TIMEOUT - AR_SERVER_INFO_EA_SYNC_TIMEOUT is the internal (seconds) the AR server uses to periodically invoke the external
authentication server’s AREANeedToSyncCallback() function, which
instructs the AR System server to renew its internally stored user information
in the event there are changes made to the source used to authenticate users.
A 0 value means that the AR System server will not invoke the call to the
external authentication (AREA) server. This attribute persists in the ar.cfg/
ar.conf file. The default value is 300 seconds.AR_SERVER_INFO_LOGFILE_APPEND - AR_SERVER_INFO_LOGFILE_APPEND is an integer (0/1) value that indicates whether to create a separate*.bak file or
to append to the existing log file. A 0 value creates a *.bak file; 1 indicates that
new log information be appended to the existing file.AR_SERVER_INFO_MINIMUM_API_VER - AR_SERVER_INFO_MINIMUM_API_VER is a value indicating the minimum API version that the server supports. The
API versions are:
Server Options Whose Values Can Be Read But Not Set
AR_SERVER_INFO_DB_TYPE - AR_SERVER_INFO_DB_TYPE is the underlying database type (character string).AR_SERVER_INFO_SERVER_LICENSE - AR_SERVER_INFO_SERVER_LICENSE is the server license type (character string).AR_SERVER_INFO_FIXED_LICENSE - AR_SERVER_INFO_FIXED_LICENSE is the number of fixed user licenses (int).AR_SERVER_INFO_VERSION - AR_SERVER_INFO_VERSION is the AR System server version (character string).AR_SERVER_INFO_DB_NAME - AR_SERVER_INFO_DB_NAME is the name of the underlying SQL database (not applicable for Oracle
databases). The default value is ARSystem.AR_SERVER_INFO_HARDWARE - AR_SERVER_INFO_HARDWARE is the server hardware type (character string).AR_SERVER_INFO_OS: - AR_SERVER_INFO_OS is a character string that indicates the server operating system which includes
the version number.AR_SERVER_INFO_SERVER_DIR - AR_SERVER_INFO_SERVER_DIR is the data directory for the AR System. This directory contains support files for
the underlying SQL database (but no actual database files). For flat file
databases, this directory contains both database definition and data files.AR_SERVER_INFO_DBHOME_DIR - AR_SERVER_INFO_DBHOME_DIR is the home directory for the underlying database (applicable for SQL
databases only).AR_SERVER_INFO_FLOAT_LICENSE - AR_SERVER_INFO_FLOAT_LICENSE is the number of floating write licenses defined.AR_SERVER_INFO_REM_SERV_ID - AR_SERVER_INFO_REM_SERV_ID is the AR System server ID associated with the license (character string).AR_SERVER_INFO_MULTI_SERVER - AR_SERVER_INFO_MULTI_SERVER is an integer (0/1) value indicating the use of the multi-server option. A 0
value indicates a single server; a 1 value indicates the use of the multi-server
option.AR_SERVER_INFO_EMBEDDED_SQL - AR_SERVER_INFO_EMBEDDED_SQL is a value indicating whether the underlying SQL database is embedded
(bundled with the Action Request System). Valid values for this option are 0
(not embedded) and 1 (embedded).AR_SERVER_INFO_MAX_SCHEMAS - AR_SERVER_INFO_MAX_SCHEMAS is the maximum number of forms allowed. The default value is 0 (no limit).AR_SERVER_INFO_DB_VERSION - AR_SERVER_INFO_DB_VERSION is the underlying database version (character string).AR_SERVER_INFO_FTEXT_FIXED - AR_SERVER_INFO_FTEXT_FIXED is the number of fixed Full Text licenses defined.AR_SERVER_INFO_FTEXT_FLOAT - AR_SERVER_INFO_FTEXT_FLOAT is the number of floating Full Text licenses defined.AR_SERVER_INFO_SERVER_IDENT - AR_SERVER_INFO_SERVER_IDENT is the unique identifier for the server (character string).AR_SERVER_INFO_DS_SVR_LICENSE - AR_SERVER_INFO_DS_SVR_LICENSE is the distributed server license type (character string).AR_SERVER_INFO_DS_MAPPING - AR_SERVER_INFO_DS_MAPPING is the name of the form that contains distributed mapping definitions
(applicable for Distributed Server Option only).AR_SERVER_INFO_DS_PENDING - AR_SERVER_INFO_DS_PENDING is the name of the form that contains the pending operation list (applicable for
Distributed Server Option only).AR_SERVER_INFO_HOSTNAME - AR_SERVER_INFO_HOSTNAME is the host name of the server (“ short” machine name).AR_SERVER_INFO_FULL_HOSTNAME - AR_SERVER_INFO_FULL_HOSTNAME is the full DNS host name of the server (“ long” machine name).AR_SERVER_INFO_U_CACHE_CHANGE - AR_SERVER_INFO_U_CACHE_CHANGE is the time of the last change to the user cache.AR_SERVER_INFO_G_CACHE_CHANGE - AR_SERVER_INFO_G_CACHE_CHANGE is the time of the last change to the group cache.AR_SERVER_INFO_STRUCT_CHANGE - AR_SERVER_INFO_STRUCT_CHANGE is the last structure change (for this run of the server).Int.AR_SERVER_INFO_CASE_SENSITIVE - AR_SERVER_INFO_CASE_SENSITIVE is a value indicating whether the underlying database is case-sensitive. Valid
values for this option are 0 (case-sensitive) and
1 (case-insensitive). The default value is 1 (case-insensitive).AR_SERVER_INFO_SERVER_LANG - AR_SERVER_INFO_SERVER_LANG is the local language setting of the server.AR_SERVER_INFO_INFORMIX_DBN - AR_SERVER_INFO_INFORMIX_DBN is the Informix database server name. This option has a value only if you are using
an Informix database.AR_SERVER_INFO_INFORMIX_TBC - AR_SERVER_INFO_INFORMIX_TBC is the Informix configuration file. This option has a value only if you are using
an Informix database. The default value is onconfig.AR_SERVER_INFO_ORACLE_TWO_T - AR_SERVER_INFO_ORACLE_TWO_T is the two-task environment setting for remote access to an Oracle database.
This option has a value only if you are using an Oracle database.AR_SERVER_INFO_SYBASE_CHARSET - AR_SERVER_INFO_SYBASE_CHARSET is the character set being used to access a Sybase database. This option has a
value only if you are using a Sybase database.AR_SERVER_INFO_SYBASE_SERV - AR_SERVER_INFO_SYBASE_SERV is the Sybase logical server name. This option has a value only if you are using
a Sybase database. The default value is SYBASE.AR_SERVER_INFO_SHARED_MEM - (UNIX only) AR_SERVER_INFO_SHARED_MEM is a flag indicating whether the shared memory is disabled or
enabled. Valid values for this option are 1 (shared memory enabled) and 0
(shared memory disabled).AR_SERVER_INFO_DB_USER - AR_SERVER_INFO_DB_USER is the user name the Action Request System uses to access the underlying
database.AR_SERVER_INFO_APPL_PENDING - AR_SERVER_INFO_APPL_PENDING is the name of the form that contains the pending list of application commands
to be processed. This form is specific to the use of Application-Commands.AR_SERVER_INFO_SERVER_TIME - AR_SERVER_INFO_SERVER_TIME is the AR System server time.NullPointerException - if invalid ARServerUser objectARException - if configuration information is not updated
public static ServerNameID[] ARGetListServer(ARServerUser context)
throws ARException
NullPointerException - if invalid ARServerUser objectARException - if list is not returned
public static ServerInfo[] ARGetServerStatistics(ARServerUser context,
int[] requestList)
throws ARException
Can be performed by all users.
requestlist - Returns a list of one or more statistics.AR_SERVER_STAT_API_REQUESTS - (integer)
AR_SERVER_STAT_API_REQUESTS is the total number of API requests received.AR_SERVER_STAT_API_TIME - (integer)
AR_SERVER_STAT_API_TIME is the total processor time spent performing API function calls.AR_SERVER_STAT_BAD_PASSWORD - (integer)
AR_SERVER_STAT_BAD_PASSWORD is the total number of times an incorrect password was specified during login.AR_SERVER_STAT_CACHE_TIME - (integer)
AR_SERVER_STAT_CACHE_TIME is the total processor time spent loading the internal cache to improve
performance.AR_SERVER_STAT_CPU - (integer)
AR_SERVER_STAT_CPU is the total CPU time used by the server.AR_SERVER_STAT_CREATE_E_COUNT - (integer)
AR_SERVER_STAT_CREATE_E_COUNT is the total number of calls made to the ARCreateEntry function.AR_SERVER_STAT_CREATE_E_TIME - (integer)
AR_SERVER_STAT_CREATE_E_TIME is the total processor time spent performing the ARCreateEntry function.AR_SERVER_STAT_CURRENT_USERS - (integer)
AR_SERVER_STAT_CURRENT_USERS is the total number of users currently accessing the system.AR_SERVER_STAT_DELETE_E_COUNT - (integer)
AR_SERVER_STAT_DELETE_E_COUNT is the total number of calls made to the ARDeleteEntry function.AR_SERVER_STAT_DELETE_E_TIME - (integer)
AR_SERVER_STAT_DELETE_E_TIME is the total processor time spent performing the ARDeleteEntry function.AR_SERVER_STAT_ENTRY_TIME - (integer)
AR_SERVER_STAT_ENTRY_TIME is the total processor time spent performing API function calls that manipulate
entries.AR_SERVER_STAT_ESCL_DISABLE - (integer)
AR_SERVER_STAT_ESCL_DISABLE is the total number of escalations that were evaluated but skipped because they
were marked disabled.AR_SERVER_STAT_ESCL_FAILED - (integer)
AR_SERVER_STAT_ESCL_FAILED is the total number of escalations that were skipped (qualification criteria not
met).AR_SERVER_STAT_ESCL_FIELDP - (integer)
AR_SERVER_STAT_ESCL_FIELDP is the total number of push fields escalation actions performed.AR_SERVER_STAT_ESCL_FIELDS - (integer)
AR_SERVER_STAT_ESCL_FIELDS is the total number of set fields escalation actions performed.AR_SERVER_STAT_ESCL_LOG - (integer)
AR_SERVER_STAT_ESCL_LOG is the total number of log escalation actions performed.AR_SERVER_STAT_ESCL_NOTIFY - (integer)
AR_SERVER_STAT_ESCL_NOTIFY is the total number of notify escalation actions performed.AR_SERVER_STAT_ESCL_PASSED - (integer)
AR_SERVER_STAT_ESCL_PASSED is the total number of escalations that were executed (qualification criteria met).AR_SERVER_STAT_ESCL_PROCESS - (integer)
AR_SERVER_STAT_ESCL_PROCESS is the total number of run process escalation actions performed.AR_SERVER_STAT_ESCL_SQL - (integer)
AR_SERVER_STAT_ESCL_SQL is the total number of direct SQL escalation actions performed.AR_SERVER_STAT_ESCL_TIME - (integer)
AR_SERVER_STAT_ESCL_TIME is the total processor time spent checking and processing escalations.AR_SERVER_STAT_E_STATS_COUNT - (integer)
AR_SERVER_STAT_E_STATS_COUNT is the total number of calls made to the ARGetEntryStatistics function.AR_SERVER_STAT_E_STATS_TIME - (integer)
AR_SERVER_STAT_E_STATS_TIME is the total processor time spent performing the ARGetEntryStatistics
function.AR_SERVER_STAT_FILTER_DISABLE - (integer)
AR_SERVER_STAT_FILTER_DISABLE is the total number of filters that were evaluated but skipped because they were
marked disabled.AR_SERVER_STAT_FILTER_FAILED - (integer)
AR_SERVER_STAT_FILTER_FAILED is the total number of filters that were skipped (qualification criteria not met).AR_SERVER_STAT_FILTER_FIELDP - (integer)
AR_SERVER_STAT_FILTER_FIELDP is the total number of push fields filter actions performed.AR_SERVER_STAT_FILTER_FIELDS - (integer)
AR_SERVER_STAT_FILTER_FIELDS is the total number of set fields filter actions performed.AR_SERVER_STAT_FILTER_LOG - (integer)
AR_SERVER_STAT_FILTER_LOG is the total number of log filter actions performed.AR_SERVER_STAT_FILTER_MESSAGE - (integer)
AR_SERVER_STAT_FILTER_MESSAGE is the total number of message filter actions performed.AR_SERVER_STAT_FILTER_MESSAGE - (integer)
AR_SERVER_STAT_FILTER_NOTIFY is the total number of notify filter actions performed.AR_SERVER_STAT_FILTER_MESSAGE - (integer)
AR_SERVER_STAT_FILTER_PASSED is the total number of filters that were executed (qualification criteria met).AR_SERVER_STAT_FILTER_MESSAGE - (integer)
AR_SERVER_STAT_FILTER_PROCESS is the total number of run process filter actions performed.AR_SERVER_STAT_FILTER_SQL - (integer)
AR_SERVER_STAT_FILTER_SQL is the total number of direct SQL filter actions performed.AR_SERVER_STAT_FILTER_TIME - (integer)
AR_SERVER_STAT_FILTER_TIME is the total processor time spent checking and processing filters.AR_SERVER_STAT_FTS_SRCH_COUNT - (integer)
AR_SERVER_STAT_FTS_SRCH_COUNT is the total number of Full Text Search operations performed.AR_SERVER_STAT_FTS_SRCH_TIME - (integer)
AR_SERVER_STAT_FTS_SRCH_TIME is the total processor time spent performing Full Text Search operations.AR_SERVER_STAT_FULL_FIXED - (integer)
AR_SERVER_STAT_FULL_FIXED is the total number of connected users with fixed Full Text licenses.AR_SERVER_STAT_FULL_FLOATING - (integer)
AR_SERVER_STAT_FULL_FLOATING is the total number of connected users with floating Full Text licenses.AR_SERVER_STAT_FULL_NONE - (integer)
AR_SERVER_STAT_FULL_NONE is the total number of connected users with no Full Text license.AR_SERVER_STAT_GETLIST_E_COUNT - (integer)
AR_SERVER_STAT_GETLIST_E_COUNT is the total number of calls made to the ARGetListEntry function.AR_SERVER_STAT_GETLIST_E_TIME - (integer)
AR_SERVER_STAT_GETLIST_E_TIME is the total processor time spent performing the ARGetListEntry function.AR_SERVER_STAT_GET_E_COUNT - (integer)
AR_SERVER_STAT_GET_E_COUNT is the total number of calls made to the ARGetEntry function.AR_SERVER_STAT_GET_E_TIME - (integer)
AR_SERVER_STAT_GET_E_TIME is the total processor time spent performing the ARGetEntry function.AR_SERVER_STAT_IDLE_TIME - (integer)
AR_SERVER_STAT_IDLE_TIME is the total idle time when the server is not processing any requests.AR_SERVER_STAT_MERGE_E_COUNT - (integer)
AR_SERVER_STAT_MERGE_E_COUNT is the total number of calls made to the ARMergeEntry function.AR_SERVER_STAT_MERGE_E_TIME - (integer)
AR_SERVER_STAT_MERGE_E_TIME is the total processor time spent performing the ARMergeEntry function.AR_SERVER_STAT_NET_RESP_TIME - (integer)
AR_SERVER_STAT_NET_RESP_TIME is the total time spent on the network responding to the client.AR_SERVER_STAT_NO_FULL_TOKEN - (integer)
AR_SERVER_STAT_NO_FULL_TOKEN is the total number of times a user tried to connect and no floating Full Text
token was available.AR_SERVER_STAT_NO_WRITE_TOKEN - (integer)
AR_SERVER_STAT_NO_WRITE_TOKEN is the total number of times a user tried to connect and no floating write token
was available.
AR_SERVER_STAT_NUMBER_BLOCKED (integer)
AR_SERVER_STAT_NUMBER_BLOCKED is the total number of blocked processes.
This statistic, in conjunction with the
AR_SERVER_STAT_TIMES_BLOCKED statistic, enables you to determine the
approximate number of processes being blocked per instance. For example, if
AR_SERVER_STAT_TIMES_BLOCKED is three and
AR_SERVER_STAT_NUMBER_BLOCKED is six, the six blocked processes could
be distributed in three possible ways:
In this example, the blocked processes could not be distributed as five in one
instance, one in one instance, and none in one instance because, by definition,
the number of instances represents those times when at least one process is
blocked.AR_SERVER_STAT_OTHER_TIME - (integer)
AR_SERVER_STAT_OTHER_TIME is the total processor time spent performing API function calls that do not
manipulate entries or restructure the database.AR_SERVER_STAT_RESTRUCT_TIME - (integer)
AR_SERVER_STAT_RESTRUCT_TIME is the total processor time spent performing API function calls that restructure
the database.AR_SERVER_STAT_SET_E_COUNT - (integer)
AR_SERVER_STAT_SET_E_COUNT is the total number of calls made to the ARSetEntry function.AR_SERVER_STAT_SET_E_TIME - (integer)
AR_SERVER_STAT_SET_E_TIME is the total processor time spent performing the ARSetEntry function.AR_SERVER_STAT_SINCE_START - (integer)
AR_SERVER_STAT_SINCE_START is the number of seconds since the server was started (i.e. the total real time that
the server process has been running).AR_SERVER_STAT_SQL_DB_COUNT - (integer)
AR_SERVER_STAT_SQL_DB_COUNT is the total number of SQL commands sent to the database.AR_SERVER_STAT_SQL_DB_TIME - (integer)
AR_SERVER_STAT_SQL_DB_TIME is the total processor time spent performing SQL commands.AR_SERVER_STAT_START_TIME - (time stamp)
AR_SERVER_STAT_START_TIME is the UNIX time at which this server was started.AR_SERVER_STAT_TIMES_BLOCKED - (integer)
AR_SERVER_STAT_TIMES_BLOCKED is the total number of instances in which at least one process was blocked by
the current process. This statistic, in conjunction with the
AR_SERVER_STAT_NUMBER_BLOCKED statistic enables you to determine the
approximate number of processes being blocked per instance.AR_SERVER_STAT_WRITE_FIXED - (integer)
AR_SERVER_STAT_WRITE_FIXED is the total number of connected users with fixed write licenses.AR_SERVER_STAT_WRITE_FLOATING - (integer)
AR_SERVER_STAT_WRITE_FLOATING is the total number of connected users with floating write licenses.AR_SERVER_STAT_WRITE_READ - (integer)
AR_SERVER_STAT_WRITE_READ is the total number of connected users with no write license.NullPointerException - if invalid ARServerUser objectARException - if statistics are not returned
public static void ARSetServerPort(ARServerUser context,
NameID server,
int port,
int progNum)
throws ARException
port - Port number that your program will use to communicate with the AR System
server. If you do not specify this parameter or provide 0 for the port number, your
program will use the port number supplied by the portmapper. This parameter is
overridden by the ARTCPPORT environment variable.progNum - RPC program number of the server. Specify 390600 to use the admin queue,
a number from 390621 to 390634 or 390636 to 390669 or 390680-390694 to
use a private queue, or 0 (default) to use the fast or list server queue. This
parameter is overridden by the ARRPC environment variable.NullPointerException - if invalid ARServerUser objectARException - if port is not specified
public static GroupInfo[] ARGetListGroup(ARServerUser context,
AccessNameID user,
AccessNameID password)
throws ARException
Group information for the current user can be retrieved by all users. Access to group information for other users is limited to users with AR System administrator privileges only.
NullPointerException - if invalid ARServerUser objectARException - if list is not returned
public static UserInfo[] ARGetListUser(ARServerUser context,
int type,
Timestamp changedSince)
throws ARException
Information about the current user can be retrieved by all users. Access to information about other users is limited to users with AR System administrator privileges only.
For type, enter one of the following:
AR_USER_LIST_MYSELF to retrieve the current user.
AR_USER_LIST_REGISTERED to retrieve all registered users.
AR_USER_LIST_CURRENT to retrieve all users currently
accessing the server.
changedSince A time stamp that limits the users retrieved to those modified after the specified time. Specify
null for this parameter if you do not want to retrieve users with any modification
time stamp. This parameter has only effect for list of registered users.
NullPointerException - if invalid ARServerUser objectARException - if list is not returned
public static FullTextInfo[] ARGetFullTextInfo(ARServerUser context,
int[] requestList)
throws ARException
Enter a list of one or more FTS options to return:
AR_FULLTEXTINFO_CASE_SENSITIVE_SRCH indicates whether
full text searches are case-sensitive. Valid values for this option are
0 (case-sensitive) and 1 (case-insensitive). The default value is 1 (case-insensitive).
AR_FULLTEXTINFO_COLLECTION_DIR indicates collection directory
for the FTS engine. This directory contains all defined FTS indexes.
This directory is not used if no fields are indexed for FTS.
AR_FULLTEXTINFO_FTS_MATCH_OP indicates type of match operation used.
AR_FULLTEXT_FTS_MATCH_FORCE_L_T_WILD appends leading and
trailing wild cards to every word. Produces highest number of matches but slows performance the most.
AR_FULLTEXT_FTS_MATCH_FORCE_T_WILD truncates all leading
wild cards and append trailing wild cards to every word. Produces a reasonable
number of matches while still being efficient.
AR_FULLTEXT_FTS_MATCH_IGNORE_L_WILD truncates all
leading wild cards (do not truncate or append trailing wild cards).
AR_FULLTEXT_FTS_MATCH_REMOVE_WILD truncates all wild cards.
The most efficient match operation type but produces the lowest number of matches.
AR_FULLTEXT_FTS_MATCH_UNCHANGED leaves all wild cards as
specified by the user. Requires that users understand both how to use wild cards
and their impact on performance
AR_FULLTEXTINFO_STATE indicates whether FTS is enabled.
Valid values for this option are 0 (off) and 1 (on). The default value is 1 (FTS on).
AR_FULLTEXTINFO_STOPWORD contains all defined words to ignore for the FTS collection.
NullPointerException - if invalid ARServerUser objectARException - if information is not returned
public static void ARSetFullTextInfo(ARServerUser context,
FullTextInfo[] infos)
throws ARException
AR_FULLTEXTINFO_CASE_SENSITIVE_SRCH - AR_FULLTEXTINFO_CASE_SENSITIVE_SRCH indicates whether full text searches are case-sensitive. Valid values
for this option are 0 (case-sensitive) and 1 (case-insensitive). The default
value is 1 (case-insensitive).AR_FULLTEXTINFO_COLLECTION_DIR - AR_FULLTEXTINFO_COLLECTION_DIR is the collection directory for the FTS engine. This directory contains all defined
FTS indexes. This directory is not used if no fields are indexed for FTS.AR_FULLTEXTINFO_FTS_MATCH_OP: - AR_FULLTEXTINFO_FTS_MATCH_OP indicates the type of match operation used.
AR_FULLTEXT_FTS_MATCH_FORCE_L_T_WILD Append leading and trailing wild cards to every word. This option produces the
highest number of matches but causes the largest performance impact.
AR_FULLTEXT_FTS_MATCH_FORCE_T_WILD Truncate all leading wild cards and append trailing wild cards to every word. This
option produces a reasonable number of matches while still being efficient.
AR_FULLTEXT_FTS_MATCH_IGNORE_L_WILD Truncate all leading wild cards (do not truncate or append trailing wild cards).
AR_FULLTEXT_FTS_MATCH_REMOVE_WILD Truncate all wild cards. This option is the most efficient match operation type but
produces the lowest number of matches.
AR_FULLTEXT_FTS_MATCH_UNCHANGED Leave all wild cards as specified by the user. This option requires that users
understand both how to use wild cards and their impact on performance.
AR_FULLTEXTINFO_REINDEX: - AR_FULLTEXTINFO_REINDEX indicates whether the system rebuilds FTS indexes. Valid values for
this option are 0 (no) and 1 (yes). The default value is
0 (do not rebuild).AR_FULLTEXTINFO_STATE: - AR_FULLTEXTINFO_STATE indicates whether FTS is enabled. Valid values for this option are 0
(off) and 1 (on). The default value is 1 (FTS on).AR_FULLTEXTINFO_STOPWORD: - AR_FULLTEXTINFO_STOPWORD contains all defined words to ignore for the FTS collection.NullPointerException - if invalid ARServerUser objectARException - if information is not updated
public static java.lang.String ARGetTextForErrorMessage(ARServerUser context,
int msgId)
throws ARException
AR_MAX_MESSAGE_SIZE (255 bytes).
This operation can be performed by all users.msgID - Error number whose message text you want to retrieve.NullPointerException - if invalid ARServerUser objectARException - if message text is not returned
public static StatisticsResultInfo[] ARGetEntryStatistics(ARServerUser context,
SchemaKey schemaKey,
QualifierInfo qual,
ArithmeticOrRelationalOperand target,
int statistic,
InternalID[] groupByList)
throws ARException
ARServerUser. All statistics, therefore, are limited to
entries the user can access (users must have permission for the EntryID field
to access and retrieve entries).
For statistic type, enter one of the following:
AR_STAT_OP_COUNT for total number of matching entries.
AR_STAT_OP_SUM for the sum of values for each group.
AR_STAT_OP_AVERAGE for the average value for each group.
AR_STAT_OP_MINIMUM for the minimum value for each group.
AR_STAT_OP_MAXIMUM for the maximum value for each group.
NullPointerException - if invalid ARServerUser objectARException - if statistic is not computed
public static SQLResult ARGetListSQL(ARServerUser context,
java.lang.String sqlCommand,
int maxRetrieve,
boolean retrieveTotalMatches)
throws ARException
Can be performed by users with AR System administrator privileges only.
sqlcommand - SQL command to execute (following the syntax rules for the
underlying database). The owner of the AR System server process must have
permission to perform the specified SQL operation.maxRetrieve - Enter a boolean value of TRUE to retrieve the maximum number of rows.retrieveTotalMatches - Enter an integer value to limit the number of rows retrieved.NullPointerException - if invalid ARServerUser objectARException - if list is not returned
public static ProcessResult ARExecuteProcess(ARServerUser context,
java.lang.String command,
boolean waitFlag)
throws ARException
command - to execute. Must be a valid command on the specified server.waitFlag - To Execute Process, an independent process is spawned on server.
Enter a boolean value of FALSE if you do not wait for the process to complete.NullPointerException - if invalid ARServerUser objectARException - if command is not performed
public static QualifierInfo ARGetQualifier(ARServerUser ctx,
java.lang.String queryString,
Field[] fieldList1,
Field[] fieldList2,
int queryContext)
throws ARException
QualifierInfo object given a string representation.ctx - ARServerUser objectqueryString - String objectfieldList1 - An array of Field objects of the form.
(fieldList1 parameter is used in two different modes.)
First mode - is for parsing the queries similar to the ones created in AR System User
Tool advanced query bar. This type of queries are always defined in terms
of a single form. In this case, the Field objects be from
the form to which this qualifier is going to be applied.
Second mode - is applicable when a qualification deals with
two forms. For example, a qualification in SetFields, PushFields etc
active link actions, can be defined in terms of two forms - one to which
the active link belongs and the other form to/from which the data
will be set. The later is termed as remote form. In this case,
specify the array of Field objects of the remote form.fieldList2 - An array of Field objects of a form.
First mode - this parameter is not applicable and can be null.
Second mode - applicable only in this mode. In this mode, this array
of Field objects comes from the local form.queryContext - Default value is AR_QUALCONTEXT_DEFAULT. Different parsing
rules apply when a query line is encountered within an Active Link (in
SetFields action, Run If condition etc), Filter, Escalation or in a
Menu definition. Indicate appropriate value using
AR_QUALCONTEXT_ACTIVE_LINK, AR_QUALCONTEXT_ESCALATION,
AR_QUALCONTEXT_FILTER, or AR_QUALCONTEXT_MENU_DEFS.NullPointerException - if invalid ARServerUser objectARException - if object is not constructed
public static java.lang.String ARGetQualifierString(ARServerUser ctx,
QualifierInfo qual,
Field[] fieldList1,
Field[] fieldList2,
int queryContext,
boolean isEscalation)
throws ARException
String object containing the string representation of a
given qualifier object.ctx - ARServerUser objectqual - QualifierInfo objectfieldList1 - An array of Field objects of the form.
(fieldList1 parameter is used in two different modes.)
First mode - is for parsing the queries similar to the ones created in AR System User
Tool advanced query bar. This type of queries are always defined in terms
of a single form. In this case, the Field objects be from
the form to which this qualifier is going to be applied.
Second mode - is applicable when a qualification deals with
two forms. For example, a qualification in SetFields, PushFields etc
active link actions, can be defined in terms of two forms - one to which
the active link belongs and the other form to/from which the data
will be set. The later is termed as remote form. In this case,
specify the array of Field objects of the remote form.fieldList2 - An array of Field objects of a form.
First mode - this parameter is not applicable and can be null.
Second mode - applicable only in this mode. In this mode, this array
of Field objects comes from the local form.queryContext - Default value is AR_QUALCONTEXT_DEFAULT.
Different parsing
rules apply when a query line is encountered within an Active Link (in
SetFields action, Run If condition etc), Filter, Escalation or in a
Menu definition. Indicate appropriate value using
AR_QUALCONTEXT_ACTIVE_LINK, AR_QUALCONTEXT_ESCALATION,
AR_QUALCONTEXT_FILTER, or AR_QUALCONTEXT_MENU_DEFS.isEscalation - Default is false. Specify true only when in the context of
a escalation's query line. When unsure specify 'false'.NullPointerException - if invalid ARServerUser objectARException - if object is not constructed
public static void ARRegisterForAlerts(ARServerUser context,
int clientPort,
int registrationFlags)
throws ARException
context - ARServerUser objectclientPort - The client port number.registrationFlags - This value is reserved for future use and should be set to zero.NullPointerException - if invalid ARServerUser objectARException - if client is not registered
public static void ARDeregisterForAlerts(ARServerUser context,
int clientPort)
throws ARException
NullPointerException - if invalid ARServerUser objectARException - if client is not deregistered
public static EntryID ARCreateAlertEvent(ARServerUser context,
AccessNameID user,
java.lang.String alertText,
int priority,
NameID sourceTag,
ServerNameID server,
NameID formName,
java.lang.String objectId)
throws ARException
context - ARServerUser objectuser - The user who receives the alert. Specify * (AR_REGISTERED_BROADCAST) to
create an alert event for all users that are currently registered to receive alerts
with the AR System server. You cannot specify a group name for this argument.alertText - The text that the alert contains.priority - A relative value that represents the priority for this alert. The range of acceptable
values is between 0 and 10.sourceTag - A string that identifies the source of the alert.
The AR System provides two predefined values for this string:
AR - alert originated from the AR System
FB - alert originated from Flashboardsserver - The name of the server that is the source of the alert. Use @ to specify the current
server. Specify NULL for this parameter if the parameter is not applicable to the
type of alert that this call creates.formName - The name of the form that is the source of the alert. For Flashboards, this is the
name of the Flashboard that generated the alert. Specify NULL for this parameter
if the parameter is not applicable to the type of alert that this call creates.objectId - For AR System, this value is the Entry ID of the originating request. For
Flashboards, this value is the name of the Flashboard event that the user
provides. Specify NULL for this parameter if the parameter is not applicable to the
type of alert that this call creates.NullPointerException - if invalid ARServerUser objectARException - if alert event is not entered
public static AccessNameID[] ARGetListAlertUser(ARServerUser context)
throws ARException
NullPointerException - if invalid ARServerUser objectARException - if list is not returned
public static int ARGetAlertCount(ARServerUser context,
QualifierInfo qual)
throws ARException
NullPointerException - if invalid ARServerUser objectARException - if alert count is not returned
public static java.lang.String AREncodeARQualifierStruct(ARServerUser ctx,
QualifierInfo qual)
throws ARException
ARQualificationStruct. Converts ARQualificationStruct to serialized
qualification string.NullPointerException - if invalid ARServerUser objectARException - if ARQualificationStruct is not encoded
public static QualifierInfo ARDecodeARQualifierStruct(ARServerUser ctx,
java.lang.String queryString)
throws ARException
ARQualificationStruct. Converts serialized qualifier string to
ARQualificationStruct.NullPointerException - if invalid ARServerUser objectARException - if ARQualificationStruct is not decoded
public static java.lang.String AREncodeARAssignStruct(ARServerUser ctx,
AssignInfo asn)
throws ARException
ARAssignStruct. Converts ARAssignStruct to serialized qualification string.
public static AssignInfo ARDecodeARAssignStruct(ARServerUser ctx,
java.lang.String assignString)
throws ARException
ARAssignStruct.
Converts serialized Assign string to ARAssignStruct.NullPointerException - if invalid ARServerUser objectARException - if ARAssignStruct is not decoded
public static java.lang.String AREncodeStatusHistory(ARServerUser ctx,
StatusHistoryInfo[] statHist)
throws ARException
ARStatusHistoryList as input and encodes it
into a status history string.NullPointerException - if invalid ARServerUser objectARException - if ARStatusHistoryList is not encoded
public static StatusHistoryInfo[] ARDecodeStatusHistory(ARServerUser ctx,
java.lang.String str)
throws ARException
ARStatusHistoryList.NullPointerException - if invalid ARServerUser objectARException - if ARStatusHistoryList is not decoded
public static java.lang.String AREncodeDiary(ARServerUser ctx,
DiaryInfo[] diary)
throws ARException
ARDiaryList as input and encodes it into a
diary string.NullPointerException - if invalid ARServerUser objectARException - if ARDiaryList is not encoded
public static DiaryInfo[] ARDecodeDiary(ARServerUser ctx,
java.lang.String str)
throws ARException
ARDiaryList for easier processing.NullPointerException - if invalid ARServerUser objectARException - if ARDiaryList is not decoded
public static LocalizedValueInfo ARGetLocalizedValue(ARServerUser ctx,
LocalizedValueCriteria criteria,
LocalizedRequestInfo request)
throws ARException
NULL return if there was nothing found -- not
even a default.ctx - ARServerUser objectcriteria - The localized value to be retrieved. The value can be a character value or an
attachment. Specify NULL for this argument if you do not want to retrieve this
value.request - Identification for the localized value to be retrieved from the AR System Message
Catalog. It contains the type of value, , value name, and, for some types of values,
unique identification numbers.NullPointerException - if invalid ARServerUser objectARException - if string is not returned
public static LocalizedValueInfo[] ARGetMultipleLocalizedValues(ARServerUser ctx,
LocalizedValueCriteria criteria,
LocalizedRequestInfo[] requests)
throws ARException
ARGetLocalizedValue(com.remedy.arsys.api.ARServerUser, com.remedy.arsys.api.LocalizedValueCriteria, com.remedy.arsys.api.LocalizedRequestInfo) but is easier to
use and more efficient than retrieving multiple values one by one.ctx - ARServerUser objectcriteria - A list of the localized values to be retrieved. The values can be a character value
or an attachment. Specify NULL for this argument if you do not want to retrieve a
value.requests[] - A list of identifications for the localized value to be retrieved. The list contains
the type of value, value name, and, for some types of values, unique
identification numbers.NullPointerException - if invalid ARServerUser objectARException - if localized texts are are not returned
public static SQLResult ARGetListSQLForActiveLink(ARServerUser context,
NameID actlinkName,
int actionIndex,
int actionType,
Timestamp timestamp,
EntryItem[] keywordList,
EntryItem[] parameterList,
int maxRetrieve,
boolean retrieveTotalMatches)
throws ARException
context - ARServerUser object.actlinkName - Name of the active link.actionIndex - Action number of the active link in the database.ifElse - The field ID used in a Set Fields action.keywordList - List of keywords requested by the server.parameterList - A list of zero or more (accessible) rows that match the criteria defined by the
sqlCommand parameter. Each item in the list represents one matching row, each
of which contains a list of the selected column values. The system returns a list
with zero items if no rows match the specified criteria.maxRetrieve - The maximum number of rows to retrieve. Use this parameter to limit the
amount of data returned if the SQL query does not sufficiently narrow the list.
Specify 0 (Constants.AR_NO_MAX_LIST_RETRIEVE) to assign no maximum.retrieveTotalMatches - The total number of (accessible) rows that match the SQL selection criteria. This
value does not represent the number of rows returned unless the number of matching rows is less than or equal to the maxRetrieve value. Specify NULL for
this parameter if you do not want to retrieve this value.NullPointerException - if invalid ARServerUser objectARException - if list is not returned
public static ProcessResult ARExecuteProcessForActiveLink(ARServerUser context,
NameID actlinkName,
int actionIndex,
int actionType,
InternalID fieldId,
Timestamp timestamp,
EntryItem[] keywordList,
EntryItem[] parameterList,
boolean waitFlag)
throws ARException
context - ARServerUser objectactlinkName - Name of the active link.actionIndex - Action number of the active link in the database.ifElse - The field ID used in a Set Fields action.keywordList - List of keywords requested by the server.parameterList - A list of zero or more (accessible) rows that match the criteria defined by the
sqlCommand parameter. Each item in the list represents one matching row, each
of which contains a list of the selected column values. The system returns a list
with zero items if no rows match the specified criteria.NullPointerException - if invalid ARServerUser objectARException - if process is not executed
public static ExtFieldCandidatesInfo[] ARGetMultipleExtFieldCandidates(ARServerUser context,
CompoundSchemaInfo schema)
throws ARException
NullPointerException - if invalid ARServerUser objectARException - if information is not returned
public static CompoundSchemaInfo[] ARGetListExtSchemaCandidates(ARServerUser context,
int schemaType)
throws ARException
NullPointerException - if invalid ARServerUser objectARException - if list is not returned
public static AlertMessageInfo ARDecodeAlertMessage(ARServerUser context,
AlertMessageCriteria criteria,
java.lang.String message,
int length)
throws ARException
NullPointerException - if invalid ARServerUser objectARException - if message is not decoded
public static java.lang.String ARGetLocalHostID(ARServerUser context)
throws ARException
NullPointerException - if invalid ARServerUser objectARException - if HostID is not returned
public static HostID[] ARGetAllLocalHostIDs(ARServerUser context)
throws ARException
public static LicenseValidInfo ARValidateLicense(ARServerUser context,
LicenseNameID licenseType)
throws ARException
LicenseValidInfo.NullPointerException - if invalid ARServerUser objectARException - if information is not validated
public static LicenseValidInfo[] ARValidateMultipleLicense(ARServerUser context,
LicenseNameID[] licenseTypes)
throws ARException
LicenseValidInfo.NullPointerException - if invalid ARServerUser objectARException - if information is not validated
public static LicenseInfo[] ARGetListLicense(ARServerUser context,
LicenseNameID licenseType)
throws ARException
LicenseInfo.NullPointerException - if invalid ARServerUser objectARException - if list is not returned
public static CharMenuInfo ARConvertStringToListMenu(ARServerUser context,
java.lang.String menuString)
throws ARException
CharMenuInfo objectNullPointerException - if invalid ARServerUser objectARException - if string is not converted
public static CompactQueryResult ARGetCompactEntryList(ARServerUser context,
EntryListCriteria entryListCriteria,
EntryCriteria entryCriteria,
java.lang.Integer nMatches)
throws ARException
public static java.lang.String ARXMLCreateEntry(ARServerUser context,
java.lang.String inputMapping,
java.lang.String inputDoc,
java.lang.String outputMapping,
java.lang.String optionDoc)
throws ARException
public static java.lang.String ARXMLSetEntry(ARServerUser context,
java.lang.String queryMapping,
java.lang.String queryDoc,
java.lang.String inputMapping,
java.lang.String inputDoc,
java.lang.String outputMapping,
java.lang.String optionDoc)
throws ARException
public static java.lang.String ARXMLGetEntry(ARServerUser context,
java.lang.String queryMapping,
java.lang.String queryDoc,
java.lang.String outputMapping,
java.lang.String optionDoc)
throws ARException
public static java.lang.String getConvertedEncoding()
public static java.lang.String getConvertedEncodingForDeploy()
public static java.lang.String getWebEncodingForDeploy()
public static java.lang.String[] ARGetMultipleCurrencyRatioSets(ARServerUser context,
Timestamp[] ratioTimestamps)
throws ARException
public static java.math.BigDecimal ARGetCurrencyRatio(java.lang.String currencyRatioSet,
java.lang.String fromCurrencyCode,
java.lang.String toCurrencyCode)
throws ARException
public static java.lang.String ARGetApplicationRequestedInfo(ARServerUser context,
java.lang.String str)
throws ARException
|
5.1 Action Request System Java API | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||