@node Remedy/Ar, Resources, Religion, Module List
@unnumbered Interface to Remedy@'s Action Request (Version 1.2)


@unnumberedsec NAME

Remedy::Ar - Interface to Remedy@'s Action Request (Version 1.2)

@unnumberedsec DESCRIPTION

@unnumberedsubsec Terminology

Action Request uses terminology which may not be familiar to some
people.  Action Request can be viewed as graphical interface to a RDB
(although flat files can also be used at the backend).  A @strong{schema} is
roughly equivalent to a table in other database terminology.  In the
graphical interface only fields from one schema can be present
(although it is possible to fill some fields from other schema.  An
@strong{entry} is equivalent to a record.

@unnumberedsubsec Data structures

@table @asis
@item $control
This is a private tag which is used to keep track of multiple
connections.  The newcontrol() returns a new $control tag, which
can then be used for all other operations.

@item $schema
The name of a schema to operate on.

@item $server
The name of a server to connect to.

@item $entryId
A unique string representing an individual entry.  Once you have an
$entryId, you can use it with GetEntry to retrieve detailed
information about the record.

@item $fieldList
A $fieldList is a reference to an associative array containing field
name/contents pairs.  The field name used is the label displayed for
the schema, using the default display tag.

@end table
@unnumberedsubsec Entry Operations

@table @asis
@item $entryId = CreateEntry($control, $schema, $fieldList)
Adds a new entry to the specified schema. 

(Not Yet Implemented)

@item DeleteEntry($control, $schema, $entryId)
Removes an entry from the specified schema.  This action requires
administrator access.

(Not Yet Implemented)

@item $fieldList = GetEntry($control, $schema, $entryId)
Returns all fields from the entry associated with $entryId in $schema.

@item SetEntry
(Not Yet Implemented)

@item GetListEntry($control, $schema, $qualifier, $maxRetrieve)
@itemx MergeEntry
(Not Yet Implemented)

@end table
@unnumberedsubsec Schema Operations

@table @asis
@item CreateSchema
(Not Yet Implemented)

@item DeleteSchema
(Not Yet Implemented)

@item GetSchema(control, schema)
@itemx SetSchema
(Not Yet Implemented)

@item GetListSchema(control, changedSince)
@end table
@unnumberedsubsec Field Operations

@table @asis
@itemx CreateField
(Not Yet Implemented)

@item DeleteField
(Not Yet Implemented)

@item GetField(control, schema, fieldId)
@itemx SetField
(Not Yet Implemented)

@item GetListField(control, schema, changedSince)
@end table
@unnumberedsubsec Menu Operations

@table @asis
@itemx CreateCharMenu
(Not Yet Implemented)

@item DeleteCharMenu
(Not Yet Implemented)

@item ExpandCharMenu
(Not Yet Implemented)

@item GetCharMenu
(Not Yet Implemented)

@item SetCharMenu
(Not Yet Implemented)

@item GetListCharMenu
(Not Yet Implemented)

@end table
@unnumberedsubsec Filter Operations

@table @asis
@item CreateFilter
(Not Yet Implemented)

@item DeleteFilter
(Not Yet Implemented)

@item GetFilter
(Not Yet Implemented)

@item SetFilter
(Not Yet Implemented)

@item GetListFilter
(Not Yet Implemented)

@end table
@unnumberedsubsec Active Link Operations

@table @asis
@item CreateActiveLink
(Not Yet Implemented)

@item DeleteActiveLink
(Not Yet Implemented)

@item GetActiveLink
(Not Yet Implemented)

@item SetActiveLink
(Not Yet Implemented)

@item GetListActiveLink
(Not Yet Implemented)

@end table
@unnumberedsubsec AdminExt Operations

@table @asis
@item CreateAdminExt
(Not Yet Implemented)

@item DeleteAdminExt
(Not Yet Implemented)

@item GetAdminExt
(Not Yet Implemented)

@item SetAdminExt
(Not Yet Implemented)

@item GetListAdminExt
(Not Yet Implemented)

@item ExecuteAdminExt
(Not Yet Implemented)

@end table
@unnumberedsubsec Miscellaneous Operations

@table @asis
@item VerifyUser(control)
@itemx GetListServer()
@itemx Export
(Not Yet Implemented)

@item Import
(Not Yet Implemented)

@item GetListGroup(control)
@itemx GetServerInfo
(Not Yet Implemented)

@item SetServerInfo
(Not Yet Implemented)

@item DecodeStatusHistory
(Not Yet Implemented)

@item DecodeDiary
(Not Yet Implemented)

@item LoadARQualifierStruct(control, schema, qualString)
@end table
@unnumberedsubsec Miscellaneous Support Functions (Not part of the AR API)

@table @asis
@itemx newcontrol()
@itemx printcontrol(control)
@itemx setuser(control, user, password)
@itemx setlanguage(control, language)
@itemx setserver(control, server)
@end table
@unnumberedsec AUTHOR

Copyright (c) 1995 Rik Harris (@strong{rik.harris@@fulcrum.com.au}). All
rights reserved.  This program is free software; you can redistribute
it and/or modify it under the same terms as Perl itself.

The Ar perl extension, and this documentation were derived from the
information found in the Action Request include files, and the Action
Request System Programmer@'s Guide (Remedy Part Number: AXA-120-DA4-01).

Action Request System and AR System are tracemarks of Remedy
Corporation.
