-
Notifications
You must be signed in to change notification settings - Fork 0
/
biexport.json
1109 lines (1105 loc) · 33.5 KB
/
biexport.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"id": "com.biexcellence.openbi.sap.sac.export",
"version": "0.0.2",
"name": "biExport",
"description": "biExport 4 SAP SAC to PDF/PPT/DOC/XLS/CSV",
"newInstancePrefix": "biExport",
"icon": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAABegAAAXoBMrnI/AAAABl0RVh0U29mdHdhcmUAd3d3Lmlua3NjYXBlLm9yZ5vuPBoAAAJGSURBVDiNlZNPSNNxGMY/399+++OWuKaJQ0MtBItBhYwEEexQhNglECLq0EU9mZ06Ti8dIujQITqEBy+B1wjrkFEQBWqUaC3NBUtLs7ma+/v783YQl3MW9MD38uV5PvA+Ly8iwt/e8Jvj/uHJLv1fHiUi7NTIfMhF1hoUuA7UAIgtQ1o4eieC2OxSCWBkPrSPnDUjQstuI6hH6uH7c5FIKUQrhsdDLnLmp73DANItPa1ju3+LADlk3xZRtXuHi7o4Mn3kTNkIg4st7sBPPVdmt7Wn8c/dE3a+qlfTkh8DwVdL3sofffXKd7CvbcoA0AGqk84WUaVlGob7QezDpbDfp92s8gsOpcKpRJjkerzf0Tx7ARj7M4JXW98ZLuR9d+fnLp91u7TDfp/QUKM4VOek2qfjMCvvff1S4yjt4OjcmhJiAAoVn5o534mFXwMcCjy64HFChbsCpYR0siFy690xXxEQQey8wzyJKHPmbdt9KIQsFAVT2MzCSkIRWy0Q9DZxwBdkv9ffNPHC4ynZwo0TC98XYgPtqZRnwJY0hpkiYxgkMibLGxmWN35RsDUEjcbqZnTcjcUSt7Xy7fQVHF2WLY/HDSvemc276iwLMpoBKs3i2hIBXxXR1XnyhmOpDCDQhjjrhZ5eCzNhW6+fmXY0q6uNAKRbp+MrVbZkcpYEr04OTSbLAEAMaN8qUw/YdHQVpIPC1oY3ESMqyjma9mRGtwMlADOr9esemQU5hVK1ILYgawrmNOF5zgo8eXmtIbszU3aN/6vfbVAouCAyeN4AAAAASUVORK5CYII=",
"vendor": "bi excellence software GmbH",
"supportsMobile": true,
"eula": "",
"license": "",
"imports": [ "input-controls" ],
"webcomponents": [
{
"kind": "main",
"tag": "com-biexcellence-openbi-sap-sac-export",
"url": "https://biexcellence.github.io/biexport-sac/biexport.js",
"integrity": "",
"ignoreIntegrity": true
},
{
"kind": "styling",
"tag": "com-biexcellence-openbi-sap-sac-export-aps",
"url": "https://biexcellence.github.io/biexport-sac/biexport_aps.js",
"integrity": "",
"ignoreIntegrity": true
}
],
"types": {
"biExportParameter": {
"description": "A parameter with name and value",
"properties": [
{
"name": "name",
"type": "string",
"description": "The name of the parameter",
"mandatory": true
},
{
"name": "value",
"type": "string",
"description": "The value of the parameter",
"mandatory": true
}
]
},
"biExportSchedule": {
"description": "A schedule",
"properties": [
{
"name": "name",
"type": "string",
"description": "The name of the schedule",
"mandatory": true
}
]
},
"biExportScheduleEvent": {
"extends": "biExportSchedule",
"description": "A event based schedule",
"properties": [
{
"name": "eventName",
"type": "string",
"description": "The name of the event",
"mandatory": true
},
{
"name": "eventValue",
"type": "string",
"description": "The value of the event",
"mandatory": true
}
]
},
"biExportScheduleTime": {
"extends": "biExportSchedule",
"description": "A time based schedule",
"properties": [
{
"name": "start",
"type": "string",
"description": "The start of the schedule. Use Date.toISOString()"
},
{
"name": "end",
"type": "string",
"description": "The end of the schedule. Use Date.toISOString()"
},
{
"name": "timeZone",
"type": "string",
"description": "The time zone of the schedule. (IANA ID)"
},
{
"name": "frequence",
"type": "biExportScheduleTimeFrequence",
"description": "The frequence of the schedule",
"mandatory": true
},
{
"name": "periodicGap",
"type": "integer",
"description": "Run schedule every N of frequence"
}
]
},
"biExportScheduleTimeFrequence": {
"extends": "Enum",
"description": "Frequence of schedule",
"properties": [
{
"name": "MINUTE",
"description": "Minute"
},
{
"name": "HOUR",
"description": "Hour"
},
{
"name": "DAY",
"description": "Day"
},
{
"name": "WEEK",
"description": "Week"
},
{
"name": "MONTH",
"description": "Month"
},
{
"name": "YEAR",
"description": "Year"
},
{
"name": "ONCE",
"description": "Once"
}
]
}
},
"properties": {
"serverURL": {
"type": "string",
"description": "The URL to the open bi Repository installation that handles the export. If you use an installation on your local machine, change this property to http://localhost:9091, otherwise to the address and port of your installation.",
"default": "https://designstudioexport.biexcellence.com"
},
"licenseKey": {
"type": "string",
"description": "The license key to be used for sending the notification (for usage tracking, usage limits, special smtp server configuration)",
"default": ""
},
"filename": {
"type": "string",
"description": "The file name of the export document. The extension will be determined automatically. You can use placeholders (manual section 3.9).",
"default": "SACExport_%EXECUTION_DATE_SHORT%_%EXECUTION_TIME_SHORT%"
},
"exportLanguage": {
"type": "string",
"description": "By default, the export determines the language for the export document from the web client. The export language is used to render the correct format for date and time placeholders (manual section 3.10) and to interpret number formats correctly for Excel export (manual secion 3.11). You can set this property explicitly to overrule the automatic determination.",
"default": ""
},
"screenWidth": {
"type": "integer",
"description": "By default the export uses the screen width of the user to create an export document that resembles the screen display. If you experience extensive white spaces or to small font sizes, you can set this property to a static value, e.g. 1000 pixels.",
"default": 0
},
"screenHeight": {
"type": "integer",
"description": "If you make extensive use of relative height definitions, exports to PowerPoint, Word or Excel might show to small font sizes. In this case, you can set this property to a static value, e.g. 800 pixels. You might have to combine with a Static Screen Width.",
"default": 0
},
"parseCss": {
"type": "boolean",
"description": "If the Export does not show icons or images, you can set this property to true. This activates the collection of all images of the SAC application and sends them to the Export service.",
"default": false
},
"biAnalyticsDocument": {
"type": "boolean",
"description": "If set to true, the export automatically creates native Office objects when possible - charts, tables, dropdowns, texts etc.",
"default": false
},
"tablesCellLimit": {
"type": "integer",
"description": "Styled table cell limit, when set no cell styles for tables with more cells than specified will be retrieved."
},
"pdfTemplate": {
"type": "string",
"description": "As an alternative to the HTML Template property, you can also specify a DOC, DOCX, PPT or PPTX template which will be used as a fully formatted template for your PDF export",
"default": ""
},
"pptSeparate": {
"type": "boolean",
"description": "This property only takes affect if you are not using an Export Template. If set to `false` the application is rendered onto one slide. If you set this property to `true`, each component is rendered to a separate slide.",
"default": true
},
"pptTemplate": {
"type": "string",
"description": "By specifying a template for the PowerPoint Export (in PPT or PPTX formats) you can generate complete presentations in your corporate design and with standard text",
"default": ""
},
"docTemplate": {
"type": "string",
"description": "By specifying a template for the Word Export (in DOC or DOCX formats) you can generate complete Word documents in your corporate design and with standard text",
"default": ""
},
"xlsTemplate": {
"type": "string",
"description": "By specifying a template for the Excel Export (in XLS or XLSX formats) you can generate complete Word documents in your corporate design and with standard text",
"default": ""
},
"publishMode": {
"type": "string",
"description": "Controls the way the Export document is delivered: ONLINE, MAIL, FILE etc.",
"default": ""
},
"publishSync": {
"type": "boolean",
"description": "If set to true, the export process runs synchronuously even if the file shall not be returned to the user",
"default": false
},
"mailFrom": {
"type": "string",
"description": "The sender of the mail (Publish Mode must be set to MAIL)",
"default": ""
},
"mailTo": {
"type": "string",
"description": "The recipients of the mail (Publish Mode must be set to MAIL)",
"default": ""
},
"mailSubject": {
"type": "string",
"description": "The subject of the mail (Publish Mode must be set to MAIL)",
"default": ""
},
"mailBody": {
"type": "string",
"description": "The mail body (Publish Mode must be set to MAIL)",
"default": ""
},
"showIcons": {
"type": "boolean",
"description": "Show icons in the export buttons",
"default": true
},
"showTexts": {
"type": "boolean",
"description": "Show texts in the export buttons",
"default": true
},
"showViewSelector": {
"type": "boolean",
"description": "Show view selector before exporting",
"default": false
},
"showComponentSelector": {
"type": "boolean",
"description": "Show component selector before exporting",
"default": false
},
"enablePdf": {
"type": "boolean",
"description": "Show PDF option",
"default": true
},
"enablePpt": {
"type": "boolean",
"description": "Show PowerPoint option",
"default": true
},
"enableDoc": {
"type": "boolean",
"description": "Show Word option",
"default": true
},
"enableXls": {
"type": "boolean",
"description": "Show Excel option",
"default": true
},
"enableCsv": {
"type": "boolean",
"description": "Show CSV Export option",
"default": false
},
"enablePng": {
"type": "boolean",
"description": "Show Images Export option",
"default": true
},
"pdfHeader": {
"type": "string",
"description": "The PDF Header",
"default": "<table width=1000px style=\"font-family: Arial; \"><tr><td width=850px>SAC Export</td><td width=150px><img src=\"\" width=150px></table>"
},
"pdfFooter": {
"type": "string",
"description": "The PDF Footer",
"default": "<table width=1000px style=\"font-family: Arial;\"><tr><td>%PAGE% of %PAGES%</td></tr></table>"
},
"pdfOrient": {
"type": "string",
"description": "The PDF Orientation",
"default": "L"
},
"tablesSelectedWidgets": {
"type": "string",
"description": "Selected Widgets for Meta Data / Result Set Retrieve",
"default": ""
},
"pdfSelectedWidgets": {
"type": "string",
"description": "Selected Widgets for PDF export",
"default": ""
},
"pptSelectedWidgets": {
"type": "string",
"description": "Selected Widgets for PowerPoint export",
"default": ""
},
"docSelectedWidgets": {
"type": "string",
"description": "Selected Widgets for Word export",
"default": ""
},
"xlsSelectedWidgets": {
"type": "string",
"description": "Selected Widgets for Excel export",
"default": ""
},
"pngSelectedWidgets": {
"type": "string",
"description": "Selected Widgets for Images export",
"default": ""
},
"csvSelectedWidgets": {
"type": "string",
"description": "Selected Widgets for CSV export",
"default": ""
},
"oauth": {
"type": "string",
"description": "For internal use",
"default": ""
}
},
"methods": {
"getServerUrl": {
"returnType": "string",
"description": "Get the Server URL",
"parameters": []
},
"setServerUrl": {
"description": "Set the Server URL",
"parameters": [
{
"name": "value",
"type": "string",
"description": "The new Server URL"
}
]
},
"getLicenseKey": {
"returnType": "string",
"description": "Get the License Key",
"parameters": []
},
"setLicenseKey": {
"description": "Set the License Key",
"parameters": [
{
"name": "value",
"type": "string",
"description": "The new License Key"
}
]
},
"getFilename": {
"returnType": "string",
"description": "Get the filename",
"parameters": []
},
"setFilename": {
"description": "Set the filename",
"parameters": [
{
"name": "value",
"type": "string",
"description": "The new filename"
}
]
},
"getExportLanguage": {
"returnType": "string",
"description": "Get the Export Language",
"parameters": []
},
"setExportLanguage": {
"description": "Set the Export Language",
"parameters": [
{
"name": "value",
"type": "string",
"description": "The new Export Language"
}
]
},
"getStaticWidth": {
"returnType": "integer",
"description": "Get the Static Width",
"parameters": []
},
"setStaticWidth": {
"description": "Set the Static Width",
"parameters": [
{
"name": "value",
"type": "integer",
"description": "The new Static Width"
}
]
},
"getStaticHeight": {
"returnType": "integer",
"description": "Get the Static Height",
"parameters": []
},
"setStaticHeight": {
"description": "Set the Static Height",
"parameters": [
{
"name": "value",
"type": "integer",
"description": "The new Screen Height"
}
]
},
"getParseCss": {
"returnType": "boolean",
"description": "Get whether Parse CSS is enabled or not",
"parameters": []
},
"setParseCss": {
"description": "Set whether Parse CSS is enabled or not",
"parameters": [
{
"name": "value",
"type": "boolean",
"description": "The new Parse CSS"
}
]
},
"getBiAnalyticsDocument": {
"returnType": "boolean",
"description": "Get whether biAnalytics Document is enabled or not",
"parameters": []
},
"setBiAnalyticsDocument": {
"description": "Set whether biAnaltics Document is enabled or not",
"parameters": [
{
"name": "value",
"type": "boolean",
"description": "The new biAnalytics Document"
}
]
},
"getPdfTemplate": {
"returnType": "string",
"description": "Get the PDF Template",
"parameters": []
},
"setPdfTemplate": {
"description": "Set the PDF Template",
"parameters": [
{
"name": "value",
"type": "string",
"description": "The new PDF Template"
}
]
},
"getPptSeparateSlides": {
"returnType": "boolean",
"description": "Gets the Property 'One Component by Slide' for PowerPoint Export",
"parameters": []
},
"setPptSeparateSlides": {
"description": "Sets the Property 'One Component by Slide' for PowerPoint Export",
"parameters": [
{
"name": "value",
"type": "boolean",
"description": "The new biAnalytics Document"
}
]
},
"getPptTemplate": {
"returnType": "string",
"description": "Get the PPT Template",
"parameters": []
},
"setPptTemplate": {
"description": "Set the PPT Template",
"parameters": [
{
"name": "value",
"type": "string",
"description": "The new PPT Template"
}
]
},
"getDocTemplate": {
"returnType": "string",
"description": "Get the DOC Template",
"parameters": []
},
"setDocTemplate": {
"description": "Set the DOC Template",
"parameters": [
{
"name": "value",
"type": "string",
"description": "The new DOC Template"
}
]
},
"getXlsTemplate": {
"returnType": "string",
"description": "Get the XLS Template",
"parameters": []
},
"setXlsTemplate": {
"description": "Set the XLS Template",
"parameters": [
{
"name": "value",
"type": "string",
"description": "The new XLS Template"
}
]
},
"getExportTemplate": {
"description": "Get the Export Template",
"parameters": [
{
"name": "format",
"type": "string",
"description": "The export format: \"PDF\", \"PPT\", \"DOC\", \"XLS\""
}
]
},
"setExportTemplate": {
"description": "Set the Export Template",
"parameters": [
{
"name": "format",
"type": "string",
"description": "The export format: \"PDF\", \"PPT\", \"DOC\", \"XLS\""
},
{
"name": "value",
"type": "string",
"description": "The new Export Template"
}
]
},
"getPublishMode": {
"returnType": "string",
"description": "Get the Publish Mode",
"parameters": []
},
"setPublishMode": {
"description": "Set the Publish Mode",
"parameters": [
{
"name": "value",
"type": "string",
"description": "The new Publish Mode"
}
]
},
"getPublishSync": {
"returnType": "boolean",
"description": "Get the Publish Sync",
"parameters": []
},
"setPublishSync": {
"description": "Set the Publish Sync",
"parameters": [
{
"name": "value",
"type": "boolean",
"description": "The new Publish Sync"
}
]
},
"getMailFrom": {
"returnType": "string",
"description": "Get the Mail From",
"parameters": []
},
"setMailFrom": {
"description": "Set the Mail From",
"parameters": [
{
"name": "value",
"type": "string",
"description": "The new Mail From"
}
]
},
"getMailTo": {
"returnType": "string",
"description": "Get the Mail To",
"parameters": []
},
"setMailTo": {
"description": "Set the Mail To",
"parameters": [
{
"name": "value",
"type": "string",
"description": "The new Mail To"
}
]
},
"getMailSubject": {
"returnType": "string",
"description": "Get the Mail Subject",
"parameters": []
},
"setMailSubject": {
"description": "Set the Mail Subject",
"parameters": [
{
"name": "value",
"type": "string",
"description": "The new Mail Subject"
}
]
},
"getMailBody": {
"returnType": "string",
"description": "Get the Mail Body",
"parameters": []
},
"setMailBody": {
"description": "Set the Mail Body",
"parameters": [
{
"name": "value",
"type": "string",
"description": "The new Mail Body"
}
]
},
"getButtonIconVisible": {
"returnType": "boolean",
"description": "Get the visibility of the button icon",
"parameters": []
},
"setButtonIconVisible": {
"description": "Set the visibility of the button text",
"parameters": [
{
"name": "value",
"type": "boolean",
"description": "The new visibility"
}
]
},
"getButtonTextVisible": {
"returnType": "boolean",
"description": "Get the visibility of the button text",
"parameters": []
},
"setButtonTextVisible": {
"description": "Set the visibility of the button text",
"parameters": [
{
"name": "value",
"type": "boolean",
"description": "The new visibility"
}
]
},
"getViewSelectorVisible": {
"returnType": "boolean",
"description": "Get the visibility of the view selector",
"parameters": []
},
"setViewSelectorVisible": {
"description": "Set the visibility of the view selector",
"parameters": [
{
"name": "value",
"type": "boolean",
"description": "The new visibility"
}
]
},
"getWidgetSelectorVisible": {
"returnType": "boolean",
"description": "Get the visibility of the widget selector",
"parameters": []
},
"setWidgetSelectorVisible": {
"description": "Set the visibility of the widget selector",
"parameters": [
{
"name": "value",
"type": "boolean",
"description": "The new visibility"
}
]
},
"getPdfButtonVisible": {
"returnType": "boolean",
"description": "Get the visibility of the PDF export button",
"parameters": []
},
"setPdfButtonVisible": {
"description": "Set the visibility of the PDF export button",
"parameters": [
{
"name": "value",
"type": "boolean",
"description": "The new visibility"
}
]
},
"getPptButtonVisible": {
"returnType": "boolean",
"description": "Get the visibility of the PowerPoint export button",
"parameters": []
},
"setPptButtonVisible": {
"description": "Set the visibility of the PowerPoint export button",
"parameters": [
{
"name": "value",
"type": "boolean",
"description": "The new visibility"
}
]
},
"getDocButtonVisible": {
"returnType": "boolean",
"description": "Get the visibility of the Word export button",
"parameters": []
},
"setDocButtonVisible": {
"description": "Set the visibility of the Word export button",
"parameters": [
{
"name": "value",
"type": "boolean",
"description": "The new visibility"
}
]
},
"getXlsButtonVisible": {
"returnType": "boolean",
"description": "Get the visibility of the Excel export button",
"parameters": []
},
"setXlsButtonVisible": {
"description": "Set the visibility of the Excel export button",
"parameters": [
{
"name": "value",
"type": "boolean",
"description": "The new visibility"
}
]
},
"getPngButtonVisible": {
"returnType": "boolean",
"description": "Get the visibility of the Images export button",
"parameters": []
},
"setPngButtonVisible": {
"description": "Set the visibility of the Images export button",
"parameters": [
{
"name": "value",
"type": "boolean",
"description": "The new visibility"
}
]
},
"getCsvButtonVisible": {
"returnType": "boolean",
"description": "Get the visibility of the CSV export button",
"parameters": []
},
"setCsvButtonVisible": {
"description": "Set the visibility of the CSV export button",
"parameters": [
{
"name": "value",
"type": "boolean",
"description": "The new visibility"
}
]
},
"addSelectedWidget": {
"description": "Add a widget to be exported",
"parameters": [
{
"name": "format",
"type": "string",
"description": "The export format: \"PDF\", \"PPT\", \"DOC\", \"XLS\", \"PNG\", \"CSV\", \"TABLES\""
},
{
"name": "widget",
"type": "string",
"description": "The name of the Widget"
},
{
"name": "isSelected",
"type": "boolean",
"description": "Set to true to select, set to false to exclude"
}
]
},
"clearSelectedWidgets": {
"description": "Clears all widgets to be exported",
"parameters": [
{
"name": "format",
"type": "string",
"description": "The export format: \"PDF\", \"PPT\", \"DOC\", \"XLS\", \"PNG\", \"CSV\", \"TABLES\""
}
]
},
"addCustomText": {
"description": "Add a Custom Text to replace a placeholder in the export",
"parameters": [
{
"name": "name",
"type": "string",
"description": "The name of the placeholder"
},
{
"name": "value",
"type": "string",
"description": "The text to be displayed for the placeholder"
}
]
},
"clearCustomTexts": {
"description": "Clears all Custom Texts"
},
"addExportApplication": {
"description": "Add an application to be exported during background execution",
"parameters": [
{
"name": "id",
"type": "string",
"description": "The id of the application"
}
]
},
"addExportStory": {
"description": "Add a story to be exported during background execution",
"parameters": [
{
"name": "id",
"type": "string",
"description": "The id of the story"
}
]
},
"clearExportApplications": {
"description": "Clears all applications and stories to be exported during background execution"
},
"addURLParameter": {
"description": "[DEPRECATED] Add an URL parameter and value which is used during background execution",
"parameters": [
{
"name": "name",
"type": "string",
"description": "The name of the URL parameter"
},
{
"name": "values",
"type": "string[]",
"description": "The values of the URL parameter"
},
{
"name": "iterative",
"type": "boolean",
"description": "Whether the URL parameter values should be iterated over"
},
{
"name": "storyIds",
"type": "string[]",
"description": "The stories or applications for which the URL parameter will be used, if empty the URL parameter is used for all stories and applications"
}
]
},
"addURLParameters": {
"description": "Adds URL parameters which are used during background execution",
"parameters": [
{
"name": "parameters",
"type": "biExportParameter[]",
"description": "The URL parameters for a single iteration"
},
{
"name": "storyId",
"type": "string",
"description": "The story or application for which the URL parameters will be used"
},
{
"name": "separateFileId",
"type": "string",
"description": "The id to generate separate files. Can be left empty when a single file should be generated"
},
{
"name": "settings",
"type": "biExportParameter[]",
"description": "The custom settings for this iteration"
}
]
},
"clearURLParameters": {
"description": "Clears all URLs parameters which are used during background execution"
},
"addPdfSection": {
"description": "Add a PDF Section as an Export Template",
"parameters": [
{
"name": "name",
"type": "string",
"description": "The name of the PDF Section. May be empty"
},
{
"name": "header",
"type": "string",
"description": "The page header for the PDF Section"
},
{
"name": "footer",
"type": "string",
"description": "The page footer for the PDF Section"
},
{
"name": "content",
"type": "string",
"description": "The page content for the PDF Section"
},
{
"name": "orientation",
"type": "string",
"description": "(P)ortrait or (L)andscape"
},
{
"name": "iterative",
"type": "boolean",
"description": "Whether the URL parameter values should be iterated over"
}
]
},
"clearPdfSections": {
"description": "Clears all PDF Sections"
},
"addBriefingBookDefinition": {
"description": "[PREVIEW] Add a Briefing Book Definition which is used during background execution",
"parameters": [
{
"name": "parameters",
"type": "string[]",
"description": "The url parameters to be passed to the application or story in JSON notation {\"name\": \"myUrlParameter\", \"value\": \"itsValue\"}"
},
{
"name": "index",
"type": "integer",
"description": "Ordinal of the execution"
},
{
"name": "filename",
"type": "string",
"description": "Optional:The filename to which the results of the application or story shall be added"
},
{
"name": "template",
"type": "string",
"description": "Optional: The Export Template which shall be used for this particular execution"
},
{
"name": "customTexts",