IFrame Report Access

Check Commerce provides a simple way to implement a report portal utilizing an Iframe. This utilizes the CGI interface. The Iframe is white labeled and allows you to customize the look to your needs.

Endpoints

Url

Type

/EPNReports/View.aspx

CGI

IFrame Parameters

Name

Description

Data Type / Default

Example

HideCono

Hides the Cono as an
argument to be entered

Boolean / false

HideCono=true

HideReseller

Hides any arguments that are Reseller Code

Boolean / false

HideReseller=true

Tags

Only displays Reports
matching the provided tag.

String / null

Tags=taga;tagb;tagc

OverrideOutputType

Removes the output type as
an option when retrieving a
report.

String / null

OutputType=JSON

Token Parameters

Name

Description

Data Type / Default

Example

DecodeCSS

A link to the overriding CSS
file to use instead of the
default. This link must be from
a secure source, utilizing
HTTPS.

String / null

See below.

Tags

Locks the token to the
specified set of tokens. This is
a semi colon delimited list.

If both the CGI Parameter and
token parameter are provided
they must match or there will
be an error.

String / null

See below.

OutputType

Locks the output type to the
token.

If both OutputType and
Override Output type are
provided, they must match or
there will be an error.

String / null

See below.

ASPX Page

<iframe id="frame" runat="server" visible="false" />

Code

Dictionary<string, string> params = new Dictionary<string, string>();
params.Add("Param_cono",”{Merchant Number}”);
params.Add("OutputType", "JSON");
params.Add("Tags", "TagB");
params.Add("DecodeCSS", " 
string token = CheckCommerce.SDK.ActiveReports.Token.GetToken("{Merchant Number}","{Password}", Params);
string baseUrl = "{baseUrl}/EPNReports/View.aspx";
frame.Src = $"{baseUrl}?token={token}&HideCono=True&OverrideOutputType=JSON";
frame.Visible = true;

IFrame Look

The Iframe implementation provides several CSS classes that can be utilized to customize the look and feel of the site. This, in conjunction with the DecodeCSS override, will allow for a unique experience. Below are the classes to use to target specific elements.

/*General CSS*/
.chk-report-viewer
.chk-header
.chk-output-format

/*Lists*/
.chk-list
.chk-report-list
.chk-report-list > li

/*Containers*/
.chk-element-table
.chk-string-table
.chk-readonly-table
.chk-mullti-editor-table
.chk-editor-table
.chk-header-div
.chk-date-table
.chk-datetime-table
.chk-currency-table
.chk-comment-table

/*Labels*/
.chk-label
.chk-string-table .chk-label
.chk-date-table .chk-label
.chk-datetime-table .chk-label
.chk-currency-table .chk-label
.chk-comment-table .chk-label

/*Controls*/
.chk-textbox
.chk-textbox.chk-string
.chk-textbox.chk-integer
.chk-textbox.chk-date
.chk-textbox.chk-time
.chk-textbox.chk-currency
.chk-textbox.chk-comment
.chk-radiobutton-list
.chk-checkbox

/*Buttons*/
.chk-button
.chk-save-button
.chk-cancel-button

/*Errors*/
.chk-required-class
.chk-format-error-class
.chk-error-container
.chk-error-title
.chk-error-message-container
.chk-error-message