Report

Top  Previous  Next

This context lets you access and manage a single report.

Unique Actions [?]

Preview Source Data
Schedule Report
Send Report by E-mail

Other unique actions:

SHOW REPORT (Default Action)

This action is used to build and view the report.

Action Flow:

1. [Optional] User is prompted to enter report parameters using an Edit Data UI Procedure.
2. A report template is compiled on the server and filled with data.
3. The report is shown to the user using Show Report UI Procedure.

Action Name:

show

Action Icon:

cm_report

Non-Interactive Mode:

Not Supported

Permissions:

Accessible at Observer permission level

Execution Parameters:

Report Window Location

Configure

This action is used to edit Report properties.

note_warning-wt

Changing Name field during this operation will cause renaming of current context. This may lead to malfunctioning of other system components that use context name/path as a primary identifier.

Action Type:

Configure

EDIT REPORT TEMPLATE

This action is supported in AggreGate Client only. Is starts the Report Editor and allows to edit the report template.

Action Name:

editTemplate

Non-Interactive Mode:

Not Supported

Permissions:

Accessible at Manager permission level

Common Actions [?]

Delete, Make Copy, Replicate, Edit Context Permissions, Monitor Related Events, View Status

Context States and Icons

This context has no states. It is always represented by the st_report icon.

Advanced Information

Context Information

Context Type: report

Context Name: pre-defined, different for every report

Context Description: pre-defined, different for every report

Context Path: users.USER_NAME.reports.REPORT_NAME

Context Mask: users.*.reports.*

Context Permissions: Observer

Public Variables (Properties) [?]

Common Variables: groupMembership (Group Membership)

REPORT Properties

See description of the variable and its fields here.

Variable Name:

childInfo

Records:

1

Permissions:

Readable at Observer permission level, writable at Manager permission level

Record Format:

Field Name

Field Type

Notes

name

String

1 - 50 characters

description

String

1 - 100 characters

expression

String

 

template

String

 

type

Integer

 

validityExpression

String

 

validityListeners

Data Table

 

defaultContext

String

 

Additional Report Parameters

See description of the variable and its fields here.

Variable Name:

parameters

Records:

0...unlimited

Permissions:

Readable at Observer permission level, writable at Manager permission level

Record Format:

Field Name

Field Type

Notes

parameter

String

 

value

String

 

Public Functions [?]

Send Report By Email

Fills report with data and sends it by email.

 

Function Name:

sendByMail

Permissions:

Accessible at Manager permission level

Input Records:

1

Input Format:

Name

Type

Description

recipients

String

Comma-separated list of email recipients.

format

Integer

Report format.

Output Records:

0

Output Format:

None

Public Events [?]

Common Events: info (Information)