Controlling OSIS Reports with URL Parameters

OSIS Direct Links (ODL) allow users to create specific URLs for every feature of the system.  These ODLs can also include some additional parameters to further specify how the page should look and behave.  The following is a list of URL parameters for reports. Note that these can be added to the end of the standard report URL with the addition of “&” at the end.

Using these parameters helps with sending out the specific look and feel you want for users. It is also a great way to integrate OSIS reports into other systems and applications in precisely the way you choose.

Parameter Description Options
dt Display Toolbar – hides or displays the report toolbar 0 (off) or 1 (on)
dsh Display Sub Header 0 (off) or 1 (on)
dph Display Page Header 0 (off) or 1 (on)
dpf Display Page Footer 0 (off) or 1 (on)
dr Display Restrictions 0 (off) or 1 (on)
cr Clean Report – display a clean report, toggles all the above off (takes precedence over any of the above) 0 (off – has no effect) or 1 (set all off)

By default all the above are set to 0. ie., If un-specified in the URL they will be treated as having the value of 0 (off).

Sample URLs and Results
One of the first things to know about using these parameters is how to find the URL for an OSIS Report. There are several ways to do this. One way is to open the report in OSIS and then use the Create Shortcut function on the report toolbar.

blog_odl_rpturl1

Another approach is to right-click in the report you have opened and select Properties. You can then highlight and copy the URL as shown below.

blog_odl_rpturl2

Now let’s take a look at the Clean Report (cr) parameter too see what effect it has. The standard look of an OSIS Report is:

blog_odl_rptbase-1

With the Clean Report parameter added, it looks like this:

blog_odl_rptcr

Notice that the toolbar, title, headers, and restriction detail areas all disappear.

How about the Report Toolbar?
In OSIS 2.6, you can also specify the type of toolbar you want to appear with the Toolbar Type (tbt) parameter.  This is very helpful for the casual user that is not familiar with the icons in the standard OSIS Report Toolbar. The options are:

Value Toolbar Type
0 Standard – Pinned
1 Non-Flash – Full
2 Non-Flash - Basic

Toolbar Examples
The following is a set of sample URLs and the resulting Report Toolbar that loads. Notice that the only difference in the URL is the tbt (Toolbar Type) parameter at the end.

http://localhost/osis/reports/rpt_adv_main.cfm?rpt_id=151&filt=0&rt=0&ff=0&iz=1&tbt=0

blog_odl_tbt0

http://localhost/osis/reports/rpt_adv_main.cfm?rpt_id=151&filt=0&rt=0&ff=0&iz=1&tbt=1

blog_odl_rpt_tbt1

http://localhost/osis/reports/rpt_adv_main.cfm?rpt_id=151&filt=0&rt=0&ff=0&iz=1&tbt=2

blog_odl_rpt_tbt2

Leave a Reply

You must be logged in to post a comment.