Defining report types
The ReportType form defines the environment that supports creating, editing, and running reports on the Web. The following report types are defined in the ReportType form:
- AR System
- Web
You can create report type entries, but they should follow the syntax described in the Run Command URL keywords and descriptions table below. Only administrators can submit or modify entries to the ReportType form.
Recommended entries for native reports
The following entries are recommended for Remedy AR System. These entries are loaded automatically during Remedy AR System installation, and you can see them in the ReportType form in Search mode.
- Report Type—AR System
By default, the Report Type is AR System, but you can enter any name. - Query Converter Class—Leave blank
- Query Override Capability—Yes
- Run Command—/servlet/NativeReportServlet?O=$RPTOP$&U=$USR$&P=$PWD$&Q=$RPTQUERY$&QR=$RPTQOVR$&S=$RPTSVR$&F=$RPTFORM$&VW=$RPTVIEW$&VWEXT=$RPTVIEWEXT$&APP=$RPTAPP$&R=$RPTNAME$&RF=$RPTFILE$&LOC=$LOC$&TZ=$TIMEZONE$&LNG=$LANGUAGE$&CTRY=$COUNTRY$&enc=$RPTENC$&RPTCHARSET=USESERVER&RPTDEST=FILE
- Edit Command—Leave blank (not supported)
- Create Command—Leave blank (not supported)
To define a report
- In a browser, open the ReportType form in New mode.
http:host/contextPath/forms/<serverName>/ReportType
- In the Report Type field, enter a name for the supporting report engine.
uses the following names. Do not use them as it would violate a unique index that has already been defined.- AR System
- Web
- In the Query Converter Class field, enter the name of the Java class that converts a query string into a query string format recognized in the web reporting interface.
- In the Query Override Capability field, select Yes or No.
The Yes option gives this report type permission to override a query stored in a report. The No option denies this permission.
This field also is displayed on the ReportSelection form, with the selected value. In the Run Command field, enter the URL that is used to connect a report to the report engine.
The Run command begins the processing of the selected report.
The recommended Run Command is a single-line entry with no spaces. The keyword portion of the URL corresponds to parameters that are passed to the web reporting environment. The following table lists allowable URL keywords that can be used to build the Run command. These keywords listed are for reporting purposes only. They are not keywords.Run Command URL keywords and descriptions
Keyword
Description
$ARSERVER$
name for report data.
$ARAUTHENTICATION$
Authentication string used by the user.
$CRTXILOC$
Location of BusinessObjects Enterprise XI. This path is stored on the Report Settings page of the Remedy Mid Tier Configuration Tool.
$USR$
User name.
$PWD$
User's password.
$RPTAPP$
Application that the form belongs to.
$RPTENC$
HTML charset encoding.
$RPTOP$
Operations (Run, Edit, Create).
$RPTFORM$
Form the report is being run against.
$RPTSVR$
Name of the server where the form is located.
$RPTNAME$
Name of the report.
$RPTLOC$
Report location relative to the base directory for reports as indicated in the Remedy Mid Tier Configuration Tool.
$RPTFILE$
The report on the web server. An absolute pointer to where the report file is found.
$RPTQUERY$
Query string.
$RPTQOVR$
Query override.
$RPTVIEW$
View that the report is being run against.
$RPTVIEWEXT$
Extension to view.
$LOC$
Locale used for generating locale-specific prompts, labels, and formatting data.
$TIMEZONE$
Time zone to use for generating date and time strings; for example, PST.
$LANGUAGE$
Language to use for formatting data.
$COUNTRY$
Country where the language is spoken.
$UPRPTSVR$
that is specified in the user preferences as the Report Server.
$RPTCHARSET$
The character set to be applied to the report.
$RPTDEST$
The selected destination for the report; for example, File or Screen.
The Edit and Create commands are no longer supported.