Mini-Documentor, query and display form data, display field
and active link, filter lists via JSP and the Java API.
The Mini-Documentor 'Mdoc' utility is a collection of seven example JSP files
(listed below) that when installed, retrieves a list of schemas(forms). Once the
schema list is loaded, the utility can query and display a form's data, retrieve
and display a list of a form's fields, or display a form's active link and filter list.
The Mdoc JSP files make use of the AR System (Remedy) Java API library.
Some have used these examples as a start for their own thin-web app.
The code is released with an open 'AS IS' license,
see LICENSE INFO.
Download zip archive of all program files here.
View Mini-Documentor program files here.
High level pseudo code map and program flow of 'Mdoc' JSP files:
- Gather, check and validate web user input. Login or re-direct to login page
if necessary.
- Create criteria for object structure to retrieve.
- Retrieve object list.
- Loop through list, display list items in minimal HTML format.
- Release objects if needed.
- Logout.
Please note that these working examples are purposefully 'flattened' and unencapsulated as a starting point to expose how the AR System Java API functions. On large OO projects you may wish to roll up whatever classes and methods are needed in your own custom API.
MdocSchemaList.jsp
Retrieves a server's forms-schema list for the action form dispatcher.
This program displays a server's schema list after a user logs in. It works with companion Mdoc*.jsp programs listed below. Browse to this program first to login.
MdocSchemaDetail.jsp
This program retrieves a form's field list and field info (label string and ID num)
when called from the displayed links on the companion program 'MdocSchemaList.jsp'.
MdocActiveLinkList.jsp
Retrieves a form's active link list (lists trigger,status,last mod,if/else, run qual).
MdocFilterList.jsp
Retrieves a form's fitler list (lists trigger,status,last mod,if/else, run qual).
MdocQbuilder.jsp
Form to build query qualifier string, with form field list.
MdocFormResultList.jsp
Tests and parses query string, displays result list from query, with links to
form entry details.
MdocEntryDisplay.jsp
Displays a single form entry with formatted char/date/diary fields.
For the Mdoc utility to work all seven jsp files above must be located in the same directory.
create_entry.java
Simple working command line example for creating and saving a form entry via Java API
(not JSP).
INSTALLATION:
This code must run from a java servlet/jsp 'java server page' server such as ServletExec or Apache's Tomcat/Jakarta engine. These programs also use server side session variables (which are usually turned on by default). The jsp server's CLASSPATH
also MUST include the API jar files (arapi50.jar,jlicapi50.jar,arutil50.jar) to run. For the Mdoc utility to work all six jsp files must be located in the same directory. Access MdocSchemaList.jsp first to login.
On Tomcat 4.1.18/Win2000, java.library.path inherits the PATH env variable, so PATH must include API files, as well as ..\WEB-INF\lib directory.
PLATFORM'S TESTED ON:
AR System 5.0.1 (Remedy) running on Solaris 8/Oracle 8.1.7 with New Atlanta ServletExec 4.1.
AR System 5.0.1 (Remedy) running on Win2000/MS-SQL2000 with Apache Tomcat 4.1.18.
Created by Tom Jamate
If you find this utility useful, or have comments/suggestions
send (email) feedback to: tomas < at > oit.umass.edu
< at > equals @
Mdoc LICENSE INFO.
Other interesting approaches to AR System API development.
-
ARSPerl.
A Perl interface to the Remedy API.
-
ARSjython.
Do you like the power of Java and the clean readably of Python ?
Tim Widowfield has put together ARSjython, a Jython helper class that lets
you create Jython scripts that look like ARSperl scripts.
Gratuitous data-structure garden gnome image link.
