NAME
Remedy::Ar - Interface to Remedy's Action Request (Version 1.2)
DESCRIPTION
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 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 entry is equivalent to a record.
Data structures
- $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.
- $schema
-
The name of a schema to operate on.
- $server
-
The name of a server to connect to.
- $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.
- $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.
Entry Operations
- $entryId = CreateEntry($control, $schema, $fieldList)
-
Adds a new entry to the specified schema.
(Not Yet Implemented)
- DeleteEntry($control, $schema, $entryId)
-
Removes an entry from the specified schema. This action requires administrator access.
(Not Yet Implemented)
- $fieldList = GetEntry($control, $schema, $entryId)
-
Returns all fields from the entry associated with $entryId in $schema.
- SetEntry
-
(Not Yet Implemented)
- GetListEntry($control, $schema, $qualifier, $maxRetrieve)
- MergeEntry
-
(Not Yet Implemented)
Schema Operations
- CreateSchema
-
(Not Yet Implemented)
- DeleteSchema
-
(Not Yet Implemented)
- GetSchema(control, schema)
- SetSchema
-
(Not Yet Implemented)
- GetListSchema(control, changedSince)
Field Operations
- CreateField
-
(Not Yet Implemented)
- DeleteField
-
(Not Yet Implemented)
- GetField(control, schema, fieldId)
- SetField
-
(Not Yet Implemented)
- GetListField(control, schema, changedSince)
Menu Operations
- CreateCharMenu
-
(Not Yet Implemented)
- DeleteCharMenu
-
(Not Yet Implemented)
- ExpandCharMenu
-
(Not Yet Implemented)
- GetCharMenu
-
(Not Yet Implemented)
- SetCharMenu
-
(Not Yet Implemented)
- GetListCharMenu
-
(Not Yet Implemented)
Filter Operations
- CreateFilter
-
(Not Yet Implemented)
- DeleteFilter
-
(Not Yet Implemented)
- GetFilter
-
(Not Yet Implemented)
- SetFilter
-
(Not Yet Implemented)
- GetListFilter
-
(Not Yet Implemented)
Active Link Operations
- CreateActiveLink
-
(Not Yet Implemented)
- DeleteActiveLink
-
(Not Yet Implemented)
- GetActiveLink
-
(Not Yet Implemented)
- SetActiveLink
-
(Not Yet Implemented)
- GetListActiveLink
-
(Not Yet Implemented)
AdminExt Operations
- CreateAdminExt
-
(Not Yet Implemented)
- DeleteAdminExt
-
(Not Yet Implemented)
- GetAdminExt
-
(Not Yet Implemented)
- SetAdminExt
-
(Not Yet Implemented)
- GetListAdminExt
-
(Not Yet Implemented)
- ExecuteAdminExt
-
(Not Yet Implemented)
Miscellaneous Operations
- VerifyUser(control)
- GetListServer()
- Export
-
(Not Yet Implemented)
- Import
-
(Not Yet Implemented)
- GetListGroup(control)
- GetServerInfo
-
(Not Yet Implemented)
- SetServerInfo
-
(Not Yet Implemented)
- DecodeStatusHistory
-
(Not Yet Implemented)
- DecodeDiary
-
(Not Yet Implemented)
- LoadARQualifierStruct(control, schema, qualString)
Miscellaneous Support Functions (Not part of the AR API)
- newcontrol()
- printcontrol(control)
- setuser(control, user, password)
- setlanguage(control, language)
- setserver(control, server)
AUTHOR
Copyright (c) 1995 Rik Harris (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.
20 POD Errors
The following errors were encountered while parsing the POD:
- Around line 9:
You forgot a '=back' before '=head2'
- Around line 21:
'=item' outside of any '=over'
- Around line 47:
You forgot a '=back' before '=head2'
- Around line 49:
'=item' outside of any '=over'
- Around line 76:
You forgot a '=back' before '=head2'
- Around line 78:
'=item' outside of any '=over'
- Around line 94:
You forgot a '=back' before '=head2'
- Around line 96:
'=item' outside of any '=over'
- Around line 112:
You forgot a '=back' before '=head2'
- Around line 114:
'=item' outside of any '=over'
- Around line 138:
You forgot a '=back' before '=head2'
- Around line 140:
'=item' outside of any '=over'
- Around line 160:
You forgot a '=back' before '=head2'
- Around line 162:
'=item' outside of any '=over'
- Around line 182:
You forgot a '=back' before '=head2'
- Around line 184:
'=item' outside of any '=over'
- Around line 208:
You forgot a '=back' before '=head2'
- Around line 210:
'=item' outside of any '=over'
- Around line 242:
You forgot a '=back' before '=head2'
- Around line 244:
'=item' outside of any '=over'