| query=[Group.Code] |
The Published Report Group and Code
e.g /Report/?query=ADVW.
SampleFor a list of Published Reports use query=publishlist and for Entry Forms use query=entrylistAlso queries don’t always have to be published in Publisher they can be inline where their contents are encrypted and compressed.
To build an inline Query use Query Builder and Preview, then select Save – Query as URL
e.g /Report/?query=_Qr1WQs%2f3aKmErkawx…………..104ba7d4fZ |
| showTitle=[1|0] |
Show Report Title. Defaults to Publisher settings |
| showDesc=[1|0] |
Show Report Description. Defaults to Publisher settings |
| showHeader=[1|0] |
Show Report Header. Defaults to Publisher settings |
| headerFreeze=[1|0] |
Freeze Table, Table Grid or Table Basic Header row so it’s fixed at the top when scrolling. Defaults to Publisher Table settings |
| showTitlePrompt=[1|0] |
Show Report Prompt Title Bar. Defaults to Publisher settings |
| showPageHeader=[1|0] |
Show Report Branding Header. Defaults to Publisher settings |
| showPageHeaderTabs=[1|0] |
Show Report Branding Header when Tab Splits are used.
Defaults to Publisher settings |
| showPageFooter=[1|0] |
Show Report Branding Footer.
Defaults to Publisher settings |
| showLegend=[1|0] |
Show Chart Legend. Used with Charts are involved.. Defaults to Publisher settings |
| showTooltip=[1|0] |
Show Tooltips on Chart sections default is Yes |
| showMenu=[1|0] |
Show or Hide the right click menu |
| showMenuDrillOnly=[1|0] |
Show only the Drilldown menus on right click menu |
| showMenuSaveAs=[1|0] |
Show or Hide the ‘Save As’ right click menu |
| showMenuSaveAsPDF=[1|0] |
Show or Hide the ‘Save As PDF’ right click menu (Only valid if PDF tool is installed) |
| showMenuRefresh=[1|0] |
Show or Hide the ‘Refresh’ right click menu |
| showMenuPrint=[1|0] |
Show or Hide the ‘Print’ right click menu |
| showMenuNav=[1|0] |
Show or Hide the Pivot Navigation right click menu options |
| showMenuSignOut=[1|0] |
Show or Hide the User Sign Out right click menu options |
| showMenuOther=[1|0] |
Show or Hide the ‘Other’ right click menu |
| showMenuOptions=[1|0] |
Show or Hide the ‘Options’ right click menu |
| showPageNav=[1|0] |
Show or Hide the Table Grid Page Navigation Toolbar at bottom |
| showRowSelect=[1|0] |
Override the show row select logic in Tables |
| showRowHover=[1|0] |
Override the show row hover select logic in Tables |
| showContextMenu=[1|0] |
Override the table context Menu. Touch devices show menu on row click while PC devices show on right click. You can suppress or force it to display on single click |
| showFilter[Name]=[1|0|single|dropdown] |
Override the Filter logic to hide or show a Prompt Filter by name.
e.g &showFilterAccCode=0 This will hide the Filter
Table Grid writebacks use the Datamodel field properties to auto generate the filters in the prompt area based on unique keys and other settings.
To add additional filters to the auto generated list use &showFilterName=1 or for single filters use &showFilterName=single
or for a dropdown multiple select filter use &showFilterName=dropdown
The Name part of will be the Datamodel code for the field.
e.g &showFilterAccCode=1 or &showFilterCategory=1 |
| lockFilter[Name]=[1|0] |
Override the default Filter logic to Lock or unlock a Prompt Filter by name so the user cannot change the value.
e.g &lockFilterAccCode=1 This will lock the Filter |
| hideOutputs=[Name+Name2+..Name(n)] |
Hide outputs based on the output Code Path or Description.
e.g &hideOutputs=Company or &hideOutputs=Company+Department |
| showOutputs=[Name+Name2+..Name(n)] |
Show outputs based on the output Code Path or Description.
e.g &showOutputs=Company or &showOutputs=Company+Department |
| lockOutputs=[Name+Name2+..Name(n)] |
Lock grid writeback outputs based on the output Code Path or Description.
e.g &lockOutputs=Company or &lockOutputs=Company+Department |
formatOutputs=
[Name1{style}+Name2{style}+..Name(n){style}] |
Useful for formatting grid writeback output columns based on the output Code Path or Description
e.g &formatOutputs=Company{width:100|bcolor:black|fcolor:white|halign:left}
e.g &formatOutputs=Amount{width:80|curr:$|decP:2|negR:1|negB:1|halign:center}
or
&formatOutputs=Company{width:100}+Amount{width:80|curr:$|decP:2|negR:1|negB:1}+DOB{datF:yyyy-MM-dd} |
tableColAttr=
[Name1:attr+Name(n):attr] |
This is simular to URL parameter formatOutputs but provides and different syntax and more flexibility
Override the Table column attributes defaults defined in Publisher such as width, aligment, colour, text and format
Normally the output column attributes are set on Query Builder – Output Options format Tab
However the Writeback table grid is auto generated so this option is the best way to setting the column attributes.
The other way is &customHtml=group.code where another Published reports header, footer and CSS is applied.
The column Name can be the Description (without spaces) or Output Name or the orginal column position where 3 is column three.
To set multiple columns with the same attribures use the range syntax(n)..(n).
e.g. &tableColAttr=3..5:75|center|blue There size attributes segments, width(0..999)|alignment(left,center,right)|background(#HTML-color)|foreColor(#HTML-color)|text{xxx}|fmt{#%2C##0.00} separated by pipes |
However it is possible can skip segments.
e.g. &tableColAttr=Code:#202020 or &tableColAttr=Code:black|white
If the width is set to zero then the column is auto sized
HTML colors can be the color names such as red or darkred or the HTML hex color.
e.g. #a0a0a0 or a0a0a0
Note: take care to url escape special charators such a commas to prevent parsing errors
e.g.
&tableColAttr=Code:75|right|red+Project:200+DOB:center+Address:0|#404040+City:blue
&tableColAttr=5..9:center+Project:blue|white+Comments:0
&tableColAttr=1..99:0 Set all columns to auto size
&tableColAttr=12..12:text{Revenue}+13..13:text{Expense} Set column 12 to Revenue and 13 to Expense
&tableColAttr=12..15:center Set columns 12 to 15 to center alignment
&tableColAttr=1..99:0+BirthDate:90|right|fmt{yyyy MMMM dd} Set all columns to auto size and then set Birth Date column width to 90, right align and format as yyyy MMMM dd
&tableColAttr=Amount:fmt{0} format number as 12600
&tableColAttr=Amount:fmt{0.0} format number as 12600.0
&tableColAttr=Amount:fmt{$#%2C##0.00} format number as $12,600.00
&tableColAttr=Amount:fmt{$#%2C##0.00;red;0} format number as $12,600.00 and show negative number as red and suppress zeros
&tableColAttr=Amount:fmt{(#%2C##0);red} format postive numbers as 12,600 and negative numbers in red as (12,600) |
| title=[text] |
Change the default Title |
titleAlign=
[left|center|right] |
Title Alignment also aligns description unless otherwise specified set e.g &titleAlign=left&descAlign=right |
| titleFont=[fontName] |
Title Font Name e.g &titleFont=Courier&descFont=Arial |
titleColor=
[color|#htmlColor] |
Set the Title font color e.g &titleColor=red &titleColor=#002ab3 |
titleSize=
[7..(n)] |
Set the Title font size. If not set then the font size is auto determined. e.g. &titleSize=12 it is also possible to use &fontSize=12 |
| titleEditMain=[text] |
Set a Title in a Grid Writeback on the Tool Bar area &titleEditMain=Header Details |
| titleEditDetail=[text] |
Set a Title in a Grid Writeback on the Tool Bar area of the Sub Grid Detail &titleEditDetail=Line Details |
| description=[text] |
Change the default Description |
descAlign=
[left|center|right] |
Description Alignment e.g &descAlign=right |
| descFont=[fontName] |
Description Font Name e.g &descFont=Courier |
descColor=
[color|#htmlColor] |
Set the Description font color e.g &descColor=red &descColor=#002ab3 |
| descSize=[7..(n)] |
Set the Description font size. If not set then the font size is auto determined. e.g. &descSize=12 it is also possible to use &fontSize=12 |
| promptTitle=[text] |
Change the Prompt default Title |
| promptTitleColor=[color] |
Change the Prompt Title Background Color &promptTitleColor=#CC0000 or promptTitleColor=red |
| promptSuppress=[1|0] |
Suppress the Prompting at the top of the report and go straight to the default report media which is Table, Chart or Pivot etc |
| promptLock=[1|0] |
Lock all the filters in the Prompt so the user can see them but not change them |
| promptSubmitByDefault=[1|0] |
Submit the filter values by default |
| promptCollapse=[1|0] |
Collapse or Expand the Prompting area |
| promptOnly=[1|0] |
Use the Prompt Section without showing any of the Report Section below. Useful for dashboards where you want a Prompt section across the top |
| lookupUseWin=[1|0] |
Show lookups in a overlay dialog window instead the area below the prompt section |
| tabCacheDef=[1|0] |
When Tabs are present in a Layout the default is to cache the content. This can be override the default so the content is always refreshed on selection use &tabCacheDef=0 |
| tabCached[1..(n)]=[1|0] |
Turn on or off the Tab caching of content by it’s index position where tabCached3=1 is the third tab e.g. &tabCached2=0 |
| tabHide[1..(n)]=[1|0] |
Hide / Remote the Tab based on it’s index position where tabHide3=1 is the third tab e.g. &tabHide2=1 |
| tabActive=[1..(n)] |
Set a tab as active based on it’s index position where tabActive=3 is the third tab e.g. &tabActive=5 |
| tabSecHeight=[1..(n)] |
When using splits the tab section height is auto calculated and the content height is taken from that estimate. If you find the content is still cropped with scrollbars you can set your own height for the tab section in pixels e.g. &tabSecHeight=100 |
| submitLabel=[text] |
Override the default Sumit button Label &submitLabel=Execute |
| drowlimit=[0..(n)] |
Override or set the data row limit. Defaults to Publisher settings &drowlimit=25000 |
| connTimeout=[0..{milliseconds}] |
Control the data retrieve timeout in milliseconds &connTimeout=99999. Defaults to 0 |
| refreshSec=[0..{seconds}] |
Force the page to fresh after specified seconds &refreshSec=30. Defaults to 0 |
| pageSize=[1..(n)] |
Number of rows per Page. Defaults to Publisher settings &pageSize=100 |
openInWin=
[_blank|_parent|_self|_top|name] |
Override the default behaviour of opening Drill Through links in a new Window. For example to open a Drill Through in the same frame use &openInWin=_self and &openInWin=_top to replace the whole page in the same tab
|
| width=[0..(n)px] |
Override the width defaults defined in Publisher e.g. width=500px |
| height=[0..(n)px] |
Override the height defaults defined in Publisher e.g. height=500px |
| zoomAll=[0.3..5] |
Apply zoom to reports in general, including subcontent where 1 is 100% and 0.5 is 50% e.g. zoomAll=0.8 |
| zoomPrompt=[0.3..5] |
Apply zoom to report prompt area only, where 1 is 100% and 0.5 is 50% e.g. zoomPrompt=0.8 |
| zoomContent=[0.3..5] |
Apply zoom to report content area only, where 1 is 100% and 0.5 is 50% e.g. zoomContent=0.8 |
| bcolor=[red|#00FF00..] |
Override the background color defined in Publisher e.g. bcolor=blue or bcolor=%23FFEEEE |
| allowParentOverlay=[1|0] |
Allow the report to appear in the parent document as a overlay when calling WinOverlayExtShow in JavaScript e.g &allowParentOverlay=1 |
| css=[CSS_Styling] |
Inject CSS styling into the report and it’s sub content
This is used for example to set the default print css styling @page etc. when using Chrome Headless in Scheduler
e.g.
&css=@page{size:A4 landscape; margin:auto;}
&css=div{color:red;}
&css=body{zoom:50%;} |
overflow=
[auto|visible|hidden|scroll] |
Control the HTML overflow, useful when doing dashboards and Scroll bars are appearing &overflow=hidden. Defaults to auto http://www.w3schools.com/cssref/pr_pos_overflow.asp |
| accesscode=[Code] |
Published Report can have a security Access Code in addition to the Sign security &accesscode=123456 |
| rtype=[typecode] |
Override the default reporting media type valid values are
table, tablebasic, tablegrid, grid, tablecustom, tablesilverlight, silverlight, chart, pivot,
page, pagepdf, pdf, pagehtml, html, pageword, word, pageexcel, excel, pageimage, image,
menu, menuhorz, menuhorzslide, menuvert, menuvertslide, menupanel, menupanelslide, menutree, menutreeslide, menutabtop, menutabbottom, menutableft, menutabright, menuscrollview
rss and atom |
| rowSelectFilter=[0..(n)] |
The Row selection level used to pass output name values as Filters to other sections of a Report Layout or Dashboard.
The number denotes what level the row selector is where 1 is the topmost and higher numbers are only refreshed by lower numbers.
Filters will be syned where the Driver Report Output names match the Filter names in the other Reports
Basically a Report Row or Chart element is clicked and the filter values are passed to other reports and refreshed.
e.g. &rowSelectFilter=1 or &rowSelectFilter=2 |
| rowSelectIgnor=[1|0] |
This is used in combination with rowSelectFilter to specifiy that a Report should be excluded from receiving any Row Selection Filters when a Row or Chart element is clicked |
| language=[en|de|es|ja…] |
Override the default user account language. Defaults to English if no translations exist
language=es |
| flt[Name]=[Value] |
Set the Prompt Filter Value for a Published Report’s named Filter. e.g fltAccountCode=12345If you want to redirect the values of another parameter into the this filter use the _redirect_[name] command tag.&fltAccountCode=_redirect_id&id=AB123In this example the value of &id=AB123 is transfered to &fltAccount so that it returns AB123 |
| flt[Name]_2=[Value] |
Set the Prompt Filter to Value for a Published Report’s named Filter. e.g fltAccountCode_2=zzzzz |
| fltSplit=[FilterName] |
Override the split tabs function by naming the Filter you want to split by (Reserved filter name). e.g fltSplit=Departments |
| fltMediaType=[FilterName] |
Override the default report media type (Reserved filter name).
some valid types are PDF,PagePDF,Html,PageHTML,Table,TableBasic,Chart,Pivot,Silverlight
e.g fltMediaType=PDF |
| style=[Value] |
Override the colours and border styles of Table Reports. Use ‘-‘ to separate the options
for example
&style=grey-flat
&style=dark-red-flat
&style=solid2-green-borders
&style=flat-solid-white-prompt
&style=flat-solid-dark-grey
There are various basic parts that make up a style theme [colour]-[border]-[solid]-[prompt]-[tile]-[bg] where all categories are options and valid values are
[colour] = white,grey,black,red,yellow,orange,blue,sky,green,brown,purple,dark-grey,dark-red,dark-yellow,dark-orange,dark-blue,dark-sky,dark-green,dark-brown,dark-purple
[solid] = solid..solid7 Table header, lines and totals theme
[tile] = solid..tile7 Dashboard Tile theme
[prompt] = prompt..prompt7 Prompt area theme
[bg] = bg..bg7 Background colour
[border]= flat,flat2,flat3,flat4,flat5,borders Turns off various borders for a flat simple style
[pad]= pad Remove Padding
Please see the Publisher Theme builder on the options tab for more details. |
| productcode=[Value] |
When redirecting a query’s dataset to a Writeback table this parameter is used in conjunction with tablecode=xxx |
| supercode=[Value] |
When redirecting a query’s dataset to a Writeback table this parameter is used in conjunction with productcode=xxx. Only use if the product has a Super field |
| tablecode=[Value] |
When redirecting a query’s dataset to a Writeback table this parameter is used in conjunction with productcode=xxx |
glColor=
[ReportGroup,Group2,Group3] |
Used the Custom Colors defined in the current Published Report and apply them to all Published Reports Groups prefixed with the specified value
&glColor=FINANCE
&glColor=FINANCE,HR,GL |
glChartColor=
[ReportGroup,Group2,Group3] |
Used the Chart Custom Colors defined in the current Published Report and apply them to all Published Reports Groups prefixed with the specified &glChartColor=FINANCE |
glCSS=
[ReportGroup,Group2,Group3] |
Used the Custom CSS styling defined in the current Published Report and apply them to all Published Reports Groups prefixed with the specified value &glCSS=FINANCE |
glHeader=
[ReportGroup,Group2,Group3] |
Used the Custom Header defined in the current Published Report and apply it to all Published Reports Groups prefixed with the specified value &glHeader=FINANCE |
glFooter=
[ReportGroup,Group2,Group3] |
Used the Custom Footer defined in the current Published Report and apply it to all Published Reports Groups prefixed with the specified value &glHeader=FINANCE |
