From wiki.ginstr.com
Revision as of 16:57, 12 July 2017 by Mark (talk | contribs) (formatting)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

gn:act_generateReport

Description
Action used to initiate report generation on server side.
Check how to create reports on server side here.
Action returns
void

Action signatures

Report generation

[gn:act_generateReport]|[reportId, outputType;toRecipient{n};ccRecipient{n};bccRecipient{n};subject, body;tableId{n};saveToDocument{n};parameters{m}{n}]
Parameter Description
reportId{n} source from where reportId will be retrieved
outputType{n} source from where reportId will be retrieved
toRecipients{n}
optional

source from where "to" emails will be retrieved

ccRecipients{n}
optional

source from where "cc" emails will be retrieved

bccRecipients{n}
optional

source from where "bcc" emails will be retrieved

subject
optional

source from where email subject will be retrieved

body
optional

source from where email body will be retrieved

tableId{n} source from which tables for report generation will be retrieved
saveToDocument{n} sources from which document id and column name where the report will be stored will be retrieved

{n} = documentId,columnName

parameters{m}{n} sources from which report parameter definitions will be retrieved

parameters{m} = parameter{n};parameter{n}
parameter{n} = parameterName, settingPair{n}
settingPair = settingName, settingValue

Example

@variable/reportId - report id
@variable/outputType - report output type
@variable/emailTo1,@variable/emailTo2 - email to recipients
@variable/emailCc1,@variable/emailCc2 - email cc recipients
@variable/emailBcc1,@variable/emailBcc2 - email bcc recipients
@variable/emailSubject - email subject
@variable/emailBody - email body
@variable/tableId1,@variable/tableId2 - table ids required to generate report
@variable/documentId1,@variable/documentColumnId1,@variable/documentId2, @variable/documentColumnId2 - list of document ids and column names where generated report will be stored
@variable/parameterName1,@variable/settingName11,@variable/settingValue11, @variable/settingName12, @variable/settingValue12;@variable/parameterName2, @variable/settingName21, @variable/settingValue21, @variable/settingName22, @variable/settingValue22 - list of report parameters with defined sub parameters
[gn:act_generateReport]|[@variable/reportId, @variable/outputType;@variable/emailTo1, @variable/emailTo2;@variable/emailCc1, @variable/emailCc2;@variable/emailBcc1, @variable/emailBcc2;@variable/emailSubject, @variable/emailBody;@variable/tableId1, @variable/tableId2;@variable/documentId1, @variable/documentColumnId1,@variable/documentId2, @variable/documentColumnId2;@variable/parameterName1, @variable/settingName11, @variable/settingValue11, @variable/settingName12, @variable/settingValue12;@variable/parameterName2, @variable/settingName21, @variable/settingValue21, @variable/settingName22, @variable/settingValue22]]