ARS-Simple
view release on metacpan or search on metacpan
html/Simple.html view on Meta::CPAN
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<link rev="made" href="mailto:" />
</head>
<body style="background-color: white">
<ul id="index">
<li><a href="#NAME">NAME</a></li>
<li><a href="#VERSION">VERSION</a></li>
<li><a href="#SYNOPSIS">SYNOPSIS</a></li>
<li><a href="#METHODS">METHODS</a>
<ul>
<li><a href="#new">new</a></li>
<li><a href="#get_list">get_list</a></li>
<li><a href="#get_SQL">get_SQL</a></li>
<li><a href="#get_data_by_label">get_data_by_label</a></li>
<li><a href="#get_fields">get_fields</a></li>
<li><a href="#set_max_entries">set_max_entries</a></li>
</ul>
</li>
<li><a href="#PRIVATE-METHODS">PRIVATE METHODS</a>
<ul>
<li><a href="#init">_init</a></li>
<li><a href="#load_qualifier">_load_qualifier</a></li>
<li><a href="#DESTROY">DESTROY</a></li>
<li><a href="#check_initialised">_check_initialised</a></li>
<li><a href="#reset_max_entries">_reset_max_entries</a></li>
</ul>
</li>
<li><a href="#TODO">TODO</a></li>
<li><a href="#TOOLS">TOOLS</a></li>
<li><a href="#AUTHOR">AUTHOR</a></li>
<li><a href="#BUGS">BUGS</a></li>
<li><a href="#SUPPORT">SUPPORT</a></li>
<li><a href="#ACKNOWLEDGEMENTS">ACKNOWLEDGEMENTS</a></li>
<li><a href="#LICENSE-AND-COPYRIGHT">LICENSE AND COPYRIGHT</a></li>
</ul>
<h1 id="NAME">NAME</h1>
<p>ARS::Simple - The great new ARS::Simple!</p>
<h1 id="VERSION">VERSION</h1>
<p>Version 0.01</p>
<h1 id="SYNOPSIS">SYNOPSIS</h1>
<p>A simple interface to Remedy ARSystem utilising the ARSperl API interface:</p>
<pre><code> <span class="keyword">use</span> <span class="variable">ARS::Simple</span><span class="operator">;</span>
<span class="keyword">my</span> <span class="variable">$ar</span> <span class="operator">=</span> <span class="variable">ARS::Simple</span><span class="operator">-></span><span class="variable">new</span><span class="operator">(</span><span class...
<span class="string">server</span> <span class="operator">=></span> <span class="string">'my_remedy_server'</span><span class="operator">,</span>
<span class="string">user</span> <span class="operator">=></span> <span class="string">'admin'</span><span class="operator">,</span>
<span class="string">password</span> <span class="operator">=></span> <span class="string">'admin'</span><span class="operator">,</span>
<span class="operator">}</span><span class="operator">);</span>
<span class="comment"># Get the Entry-ID/Request-ID for all User's with Login starting with 'g'</span>
<span class="comment"># Here $eid is any array reference of entry-id/request-id values</span>
<span class="keyword">my</span> <span class="variable">$eid</span> <span class="operator">=</span> <span class="variable">$ar</span><span class="operator">-></span><span class="variable">get_list</span><span class="operator">(</span><span class="...
<span class="string">form</span> <span class="operator">=></span> <span class="string">'User'</span><span class="operator">,</span>
<span class="string">query</span> <span class="operator">=></span> <span class="string">qq{'Login' LIKE "g%"}</span><span class="operator">,</span>
<span class="operator">}</span><span class="operator">);</span>
<span class="keyword">print</span> <span class="variable">Data::Dumper</span><span class="operator">-></span><span class="variable">Dump</span><span class="operator">(</span><span class="operator">[</span><span class="variable">$eid</span><span c...
<span class="comment"># Get data from a form, based on a query (as you would use in the User Tool)</span>
<span class="keyword">my</span> <span class="variable">%lfid</span> <span class="operator">=</span> <span class="operator">();</span>
<span class="keyword">my</span> <span class="variable">$form</span> <span class="operator">=</span> <span class="string">'User'</span><span class="operator">;</span>
<span class="keyword">my</span> <span class="variable">$query</span> <span class="operator">=</span> <span class="string">qq('FID' = "value")</span><span class="operator">;</span>
<span class="keyword">my</span> <span class="variable">$data</span> <span class="operator">=</span> <span class="variable">$ar</span><span class="operator">-></span><span class="variable">get_data_by_label</span><span class="operator">(</span><sp...
<span class="string">form</span> <span class="operator">=></span> <span class="variable">$form</span><span class="operator">,</span>
<span class="string">query</span> <span class="operator">=></span> <span class="variable">$query</span><span class="operator">,</span>
<span class="string">lfid</span> <span class="operator">=></span> <span class="operator">{</span> <span class="variable">label1</span><span class="operator">,</span> <span class="variable">fid1</span><span class="operator">,</span> <span class="...
<span class="operator">}</span><span class="operator">);</span>
</code></pre>
<h1 id="METHODS">METHODS</h1>
<h2 id="new">new</h2>
<p>Constructor for ARS::Simple. There are three required arguments:</p>
<dl>
<dt id="server">server</dt>
<dd>
<p>The name (or possibly IP Address) of the Remedy ARSystem server you wish to connect to.</p>
</dd>
<dt id="user">user</dt>
<dd>
<p>The user you wish to connect as (this is often a user with administrator privilages). Note that while this is a required argument, it may be supplied via the configuration file to avoid lots of scripts with the user (and password) in them (less to...
</dd>
<dt id="password">password</dt>
<dd>
<p>The password to the user you wish to connect as. This may come from the configuration file if set.</p>
</dd>
</dl>
<p>There are a number of optional arguments, they are:</p>
<dl>
<dt id="max_returns">max_returns</dt>
<dd>
<p>Set a limit on how many items may be returned from certain calls. Setting this value to 0 sets unlimited returns. This parameter can also be set on individual calls. <b>Note:</b> This is a system wide configuration change and requires administrato...
<p><b>Note: You should not use a value less than the default system value for this field or you may impact normal operation of your system</b></p>
<p>Example usage:</p>
<pre><code> reset_limit => 0, # unlimited returns</code></pre>
( run in 0.998 second using v1.01-cache-2.11-cpan-39bf76dae61 )