ARSperl

 view release on metacpan or  search on metacpan

html/index.html  view on Meta::CPAN

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
  <title>ARSperl: BMC Remedy v2-v7 / Perl5 Integration Kit</title>


</head>

 <body style="background-color: rgb(255, 255, 255);">

<img alt="ARSPerl" src="arsperl-logo.gif">
<h2> Overview </h2>

<b>ARSperl</b> is an integration kit for <a href="http://www.perl.com/perl">Perl5</a> and <a href="http://www.remedy.com">Remedy ARS</a> version 5
- version 7 API. It provides a large subset of the functionality found
in the ARS C API. The source code to the integration kit and example
scripts is made available under the <a href="artistic.txt">licensing
terms of Perl itself</a>.
<p> We hope that other ARS fans find the kit useful. </p>

html/manual/ars_APIVersion.html  view on Meta::CPAN

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <title>
      ARSperl Programmer's Manual
    </title>
    <style type="text/css">
/*<![CDATA[*/
    body.c2 {background-color: rgb(255, 255, 255);}
    dt.c1 {font-weight: bold}
    /*]]>*/
    </style>
  </head>
  <body class="c2">
    <h2>
      <code>$version = ars_APIVersion()</code>
    </h2>
    <p>
      This routine returns the "major" version of the API that the ARSperl module was compiled

html/manual/ars_CreateEntry.html  view on Meta::CPAN

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
  <title>ars_CreateEntry</title>


</head>

<body style="background-color: rgb(255, 255, 255);">

<h2><code>ars_CreateEntry(ctrl, schema, field_id1, value1,
...)</code></h2>

This function creates a new entry (row) in the schema. This is the same
as ``submitting a new ticket''. Pairs of field ids and values should
follow the schema name. Data types are automatically converted.
<dl>

  <dt><b>On success</b></dt>

html/manual/ars_ExecuteProcess.html  view on Meta::CPAN

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <title>
      ARSperl Manual - ars_ExecuteProcess
    </title>
    <style type="text/css">
/*<![CDATA[*/
    body {
    background-color: #FFFFFF;
    }
    dt.c1 {font-weight: bold}
    p.c1 {font-style: italic}
    /*]]>*/
    </style>
  </head>
  <body>
    <h2>
      <code>ars_ExecuteProcess(ctrl, command, runOption=0)</code>
    </h2>Execute the given command on the server host as the user-id that the server process is

html/manual/ars_GetListEntry.html  view on Meta::CPAN

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <title>
      ARSperl Manual - ars_GetListEntry
    </title>
    <style type="text/css">
/*<![CDATA[*/
    body {
    background-color: #FFFFFF;
    }
    p.c2 {font-style: italic}
    dt.c1 {font-weight: bold}
    /*]]>*/
    </style>
  </head>
  <body>
    <h2>
      <code>ars_GetListEntry(ctrl, schema, qualifier, maxRetrieve=0, firstRetrieve=0,...)</code>
    </h2>This function is used to retrieve the list of <code>entry_id</code>s and results list

html/manual/ars_GetListEntryWithFields.html  view on Meta::CPAN

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <title>
      ARSperl Manual - ars_GetListEntryWithFields
    </title>
    <style type="text/css">
/*<![CDATA[*/
    body {
    background-color: #FFFFFF;
    }
    dt.c1 {font-weight: bold}
    /*]]>*/
    </style>
  </head>
  <body>
    <h2>
      <code>ars_GetListEntryWithFields( ctrl, schema, qualifier, maxRetrieve=0, firstRetrieve=0, #
      standard [ fieldID_list ], # OPTIONAL sortID1,sortdir1,sortID2,sortdir2,...) #
      OPTIONAL</code>

html/manual/ars_GetListField.html  view on Meta::CPAN

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
  <title>ARSperl Manual - ars_GetListField</title>


</head>

<body style="background-color: rgb(255, 255, 255);">

<h2><code>ars_GetListField(control,schema,changedsince=0,fieldType)</code></h2>

Fetches the Field ID's for all fields in the schema specified. <code>changedsince</code>
is an optional unix timestamp and defaults to 0.
<ul>

The <code>fieldType</code> parameter allows you to specify
what field type(s) to retrieve. This is a bitmask.
  <ul>

html/manual/ars_GetListGroup.html  view on Meta::CPAN

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
  <title>ars_GetListGroup</title>


</head>


<body style="background-color: rgb(255, 255, 255);">

<h2><code>ars_GetListGroup(ctrl, userName=NULL,
password=NULL)</code></h2>

Fetch information about the available groups on a server, optionally
restricting the list to a particular username/password combination.<br>

<br>

If you do not specify the userName string, the call requires

html/manual/ars_VerifyUser.html  view on Meta::CPAN

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
  <title>ARSperl Manual - ars_VerifyUser</title>


</head>

<body style="background-color: rgb(255, 255, 255);">

<h2><code>ars_VerifyUser(ctrl)</code></h2>

This function fetches information regarding the logged in user.
<dl>

  <dt><b>On success</b></dt>

  <dd>returns a reference to a <a href="ds_verifyuser_hash.html">HASH</a> </dd>

html/manual/ds_verifyuser_hash.html  view on Meta::CPAN

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
  <title>ARSperl Manual - VerifyUser Attributes</title>


</head>

<body style="background-color: rgb(255, 255, 255);">

<h2>Verify User structure</h2>

This HASH structure is returned by function <a href="ars_VerifyUser.html">ars_VerifyUser</a>.
<pre>{<br> "customFlag" =&gt; <i><span style="font-family: monospace;">boolean</span></i>,<br> "subAdminFlag" =&gt; <i><span style="font-family: monospace;">boolean,</span></i><br> "adminFlag" =&gt; boolean<br>}<br><br></pre>

<span style="font-family: monospace;"></span>
<hr width="30%">
<p><a href="toc.html"><img alt="&lt;--" src="arrow.gif" align="middle"> Table of Contents </a>
</p>

html/manual/toc.html  view on Meta::CPAN

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <title>
      ARSperl Manual
    </title>
    <style type="text/css">
/*<![CDATA[*/
    body {
    background-color: #FFFFFF;
    }
    dt.c1 {font-weight: bold}
    /*]]>*/
    </style>
  </head>
  <body>
    <h1>
      ARSperl Programmer's Manual
    </h1>
    <h2>



( run in 2.568 seconds using v1.01-cache-2.11-cpan-d8267643d1d )