view release on metacpan or  search on metacpan

ARSTools.pod  view on Meta::CPAN

=item	"filter"
=item	"active_link"
=item	"char_menu"
=item	"escalation"
=item	"dist_map"
=item	"container"
=item	"dist_pool"

=back

=item	UpdateCache	(optional, default value: 0)

if a non-zero value is set on this option, Remedy::ARSTools will insert the newly created object into it's cache
after import is compelted.

=item	OverwriteExistingObject		(optional, default value: 0)

if a non-zero value is set on this option, we will NOT generate an error if an object with the same name & type
already exists (in that case we will simply overwrite it with the new version), otherwise we're gonna throw an error.
This defaults to 0 (off -- i.e. throwing errors if the object already exists). Turn off with caution.

=back


=head1	ExportDefinition

export a serialized object definition from the ARServer.

=head2  syntax

        $Remedy->ImportDefinition( [options] ) || die $Remedy->{'errstr'}

=head2  options

=over

=item	ObjectName	(required)

indicates the name of the object to export

=item	ObjectType	(required)

indicates the type of object to export. This is one of the following:

=over

=item 	"schema"
=item	"filter"
=item	"active_link"
=item	"char_menu"
=item	"escalation"
=item	"dist_map"
=item	"container"
=item	"dist_pool"

=back

=item	DefinitionType	(required)

a value of either "xml" or "def" identifies the format to export the serialized object definition into
NOTE: as of ARS 7.6.04 XML definition export of forms with overlays applied does NOT work (though def format does).
BMC Support Ticket: ISS04238696 is open on this issue.

=back

=head1	DeleteObjectFromServer

this will delete an ARS Object from the ARServer. It probably goes without saying but you know ...
indescriminate use of this function can turn a perfectly good day of gainful employment into a hellacious nightmare
that ends with standing in line at the unemployment office ... so ... be careful m'kay?

BE AWARE: deleting schemas causes ARS to cascade delete all the workflow associated to that form that isn't shared.

=head2  syntax

        $Remedy->DeleteObjectFromServer( [options] ) || die $Remedy->{'errstr'}

=head2  options

=over

=item	ObjectName	(required)

indicates the name of the object to DELETE from the ARServer.

=item	ObjectType	(required)

indicates the type of object to DELETE. This is one of the following:

=over

=item 	"schema"
=item	"filter"
=item	"active_link"
=item	"char_menu"
=item	"escalation"

=back

=back

=head1	TunnelSQL

this will tunnel an SQL statement over the API. The SQL statement will execute as the 'aradmin' database user. Like DeleteObjectFromServer
this is a function you can EASILY hork an ARServer with, if you're not careful. With great power, comes great responsibility and all that.

Data is returned in an array of arrays. Each nested array represents a row of data returned. Fields are returned in the order they were specified
in the SQL query. For instance:

my $data = $Remedy->TunnelSQL(SQL => "select schemaid, viewname from arschema where name = 'User'");
$data->[0]->[0] == the value of schemaid column
$data->[0]->[1] == the value of viewname column

=head2  syntax

        $data = $Remedy->TunnelSQL( [options] ) || die $Remedy->{'errstr'}

=head2  options

=over