m (formatting) |
|||
| Line 11: | Line 11: | ||
===Report generation=== | ===Report generation=== | ||
| − | ;<code>[gn:act_generateReport]|[reportId,outputType;toRecipient{n};ccRecipient{n};bccRecipient{n};subject,body;tableId{n};saveToDocument{n};parameters{m}{n}]</code> | + | :;<code>[gn:act_generateReport]|[reportId, outputType;toRecipient{n};ccRecipient{n};bccRecipient{n};subject, body;tableId{n};saveToDocument{n};parameters{m}{n}]</code> |
| − | {| class="wikitable sortable" style="font-size: 85%; text-align: left;" | + | :{| class="wikitable sortable" style="font-size: 85%; text-align: left;" |
|- | |- | ||
! scope="col" | Parameter | ! scope="col" | Parameter | ||
! scope="col" | Description | ! scope="col" | Description | ||
|- | |- | ||
| − | | [[source|reportId]]{n} | + | | <code>[[source|reportId]]{n}</code> |
| − | | [[source]] from where reportId will be retrieved | + | | [[source]] from where <code>reportId</code> will be retrieved |
* Valid [[source|sources]]: | * Valid [[source|sources]]: | ||
| − | ** [[Datatypes#text|text]] | + | ** <code>[[Datatypes#text|text]]</code> |
|- | |- | ||
| − | | [[source|outputType]]{n} | + | | <code>[[source|outputType]]{n}</code> |
| − | | [[source]] from where reportId will be retrieved | + | | [[source]] from where <code>reportId</code> will be retrieved |
* Valid [[source|sources]]: | * Valid [[source|sources]]: | ||
| − | ** [[Datatypes#text|text]] | + | ** <code>[[Datatypes#text|text]]</code> |
| − | < | + | * Possible values: |
| + | ** <code>pdf</code> | ||
| + | ** <code>excel</code> | ||
| + | ** <code>csv</code> | ||
|- | |- | ||
| − | | [[source|toRecipients]]{n} | + | | <code>[[source|toRecipients]]{n}</code> |
| − | | <div style="text-align: right;">'''optional'''</div> | + | | <div style="text-align: right; background-color: #e5e5e5; padding-right: 7px">'''optional'''</div> |
[[source]] from where "to" emails will be retrieved | [[source]] from where "to" emails will be retrieved | ||
* Valid [[source|sources]]: | * Valid [[source|sources]]: | ||
| − | ** [[Datatypes#text|text]] | + | ** <code>[[Datatypes#text|text]]</code> |
|- | |- | ||
| − | | [[source|ccRecipients]]{n} | + | | <code>[[source|ccRecipients]]{n}</code> |
| − | | <div style="text-align: right;">'''optional'''</div> | + | | <div style="text-align: right; background-color: #e5e5e5; padding-right: 7px">'''optional'''</div> |
[[source]] from where "cc" emails will be retrieved | [[source]] from where "cc" emails will be retrieved | ||
* Valid [[source|sources]]: | * Valid [[source|sources]]: | ||
| − | ** [[Datatypes#text|text]] | + | ** <code>[[Datatypes#text|text]]</code> |
|- | |- | ||
| − | | [[source|bccRecipients]]{n} | + | | <code>[[source|bccRecipients]]{n}</code> |
| − | | <div style="text-align: right;">'''optional'''</div> | + | | <div style="text-align: right; background-color: #e5e5e5; padding-right: 7px">'''optional'''</div> |
[[source]] from where "bcc" emails will be retrieved | [[source]] from where "bcc" emails will be retrieved | ||
* Valid [[source|sources]]: | * Valid [[source|sources]]: | ||
| − | ** [[Datatypes#text|text]] | + | ** <code>[[Datatypes#text|text]]</code> |
|- | |- | ||
| − | | [[source|subject]] | + | | <code>[[source|subject]]</code> |
| − | | <div style="text-align: right;">'''optional'''</div> | + | | <div style="text-align: right; background-color: #e5e5e5; padding-right: 7px">'''optional'''</div> |
[[source]] from where email subject will be retrieved | [[source]] from where email subject will be retrieved | ||
* Valid [[source|sources]]: | * Valid [[source|sources]]: | ||
| − | ** [[Datatypes#text|text]] | + | ** <code>[[Datatypes#text|text]]</code> |
|- | |- | ||
| − | | [[source|body]] | + | | <code>[[source|body]]</code> |
| − | | <div style="text-align: right;">'''optional'''</div> | + | | <div style="text-align: right; background-color: #e5e5e5; padding-right: 7px">'''optional'''</div> |
[[source]] from where email body will be retrieved | [[source]] from where email body will be retrieved | ||
* Valid [[source|sources]]: | * Valid [[source|sources]]: | ||
| − | ** [[Datatypes#text|text]] | + | ** <code>[[Datatypes#text|text]]</code> |
|- | |- | ||
| − | | [[source|tableId]]{n} | + | | <code>[[source|tableId]]{n}</code> |
| [[source]] from which tables for report generation will be retrieved | | [[source]] from which tables for report generation will be retrieved | ||
* Valid [[source|sources]]: | * Valid [[source|sources]]: | ||
| − | ** [[Datatypes#text|text]] | + | ** <code>[[Datatypes#text|text]]</code> |
|- | |- | ||
| − | | [[source|saveToDocument]]{n} | + | | <code>[[source|saveToDocument]]{n}</code> |
| [[source|sources]] from which document id and column name where the report will be stored will be retrieved | | [[source|sources]] from which document id and column name where the report will be stored will be retrieved | ||
* Valid [[source|sources]]: | * Valid [[source|sources]]: | ||
| − | ** [[Datatypes#text|text]] | + | ** <code>[[Datatypes#text|text]]</code> |
| − | {n} = [[Datatypes#text|documentId]],[[Datatypes#text|columnName]] | + | <code>{n}</code> = <code>[[Datatypes#text|documentId]],[[Datatypes#text|columnName]]</code> |
|- | |- | ||
| − | | [[source|parameters]]{m}{n} | + | | <code>[[source|parameters]]{m}{n}</code> |
| [[source|sources]] from which report parameter definitions will be retrieved | | [[source|sources]] from which report parameter definitions will be retrieved | ||
* Valid [[source|sources]]: | * Valid [[source|sources]]: | ||
| − | ** [[Datatypes#text|text]] | + | ** <code>[[Datatypes#text|text]]</code> |
| − | parameters{m} = parameter{n};parameter{n}<br> | + | <code>parameters{m}</code> = <code>parameter{n};parameter{n}</code><br> |
| − | parameter{n} = [[Datatypes#text|parameterName]], settingPair{n}<br> | + | <code>parameter{n}</code> = <code>[[Datatypes#text|parameterName]], settingPair{n}</code><br> |
| − | settingPair = [[Datatypes#text|settingName]], [[Datatypes#text|settingValue]] | + | <code>settingPair</code> = <code>[[Datatypes#text|settingName]], [[Datatypes#text|settingValue]]</code> |
|- | |- | ||
|} | |} | ||
====Example==== | ====Example==== | ||
| − | <code>@variable/reportId</code> - report id<br> | + | :<code>@variable/reportId</code> - report id<br> |
| − | <code>@variable/outputType</code> - report output type<br> | + | :<code>@variable/outputType</code> - report output type<br> |
| − | <code>@variable/emailTo1,@variable/emailTo2</code> - email to recipients<br> | + | :<code>@variable/emailTo1,@variable/emailTo2</code> - email to recipients<br> |
| − | <code>@variable/emailCc1,@variable/emailCc2</code> - email cc recipients<br> | + | :<code>@variable/emailCc1,@variable/emailCc2</code> - email cc recipients<br> |
| − | <code>@variable/emailBcc1,@variable/emailBcc2</code> - email bcc recipients<br> | + | :<code>@variable/emailBcc1,@variable/emailBcc2</code> - email bcc recipients<br> |
| − | <code>@variable/emailSubject</code> - email subject<br> | + | :<code>@variable/emailSubject</code> - email subject<br> |
| − | <code>@variable/emailBody</code> - email body<br> | + | :<code>@variable/emailBody</code> - email body<br> |
| − | <code>@variable/tableId1,@variable/tableId2</code> - table ids required to generate report<br> | + | :<code>@variable/tableId1,@variable/tableId2</code> - table ids required to generate report<br> |
| − | <code>@variable/documentId1,@variable/documentColumnId1,@variable/documentId2,@variable/documentColumnId2</code> - list of document ids and column names where generated report will be stored<br> | + | :<code>@variable/documentId1,@variable/documentColumnId1,@variable/documentId2, @variable/documentColumnId2</code> - list of document ids and column names where generated report will be stored<br> |
| − | <code>@variable/parameterName1,@variable/settingName11,@variable/settingValue11,@variable/settingName12,@variable/settingValue12;@variable/parameterName2,@variable/settingName21,@variable/settingValue21,@variable/settingName22,@variable/settingValue22</code> - list of report parameters with defined sub parameters | + | :<code>@variable/parameterName1,@variable/settingName11,@variable/settingValue11, @variable/settingName12, @variable/settingValue12;@variable/parameterName2, @variable/settingName21, @variable/settingValue21, @variable/settingName22, @variable/settingValue22</code> - list of report parameters with defined sub parameters<br> |
| − | <code>[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]]</code> | + | :; ⤷ <code>[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]]</code> |
<hr> | <hr> | ||
Latest revision as of 16:57, 12 July 2017
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 reportIdwill be retrievedoutputType{n}source from where reportIdwill be retrievedtoRecipients{n}optionalsource from where "to" emails will be retrieved
ccRecipients{n}optionalsource from where "cc" emails will be retrieved
bccRecipients{n}optionalsource from where "bcc" emails will be retrieved
subjectoptionalsource from where email subject will be retrieved
bodyoptionalsource 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,columnNameparameters{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]]
- ⤷
