Last modified by jhurst on 2024/04/02 14:25
Hide last authors
mrochelle 1.1 1 {{ddtoc/}}
2
3 = Introduction =
4
5
6 DigDash can be embedded at multiple “levels” in external websites:
7
8 -Dashboard
9
10 -Dashboard page
11
12 -Information Flow
13
14 In this document we will present url that works in the following context:
15
16 Server name: ddsrv
17
18 Port: 8080
19
20 DigDash Domain: ddenterpriseapi
21
22 DigDash Dashboard Domain: digdash_dashboard
23
24
25 = Dashboard =
26
27
28 At this level you can embed multiple pages in an iframe.
29
30 URL : http:~/~/ddsrv:8080/digdash_dashboard/index.html
31
32 Available parameters:
33
34 * login=<user> User to authenticate
35
36 * pass=<password> Password for the user
37
38 * domain=<domainname>// //DigDash Enteprise domain name
39 Example: ddenterpriseapi
40 * server=<server URL> DigDash Enterprise domain server URL
41 Example : http:~/~/localhost:8080
42
43 * hideBanner=<true|false> Hide (true) or show (false) the main title bar
44
45 * hideFilters=<true|false> Hide (true) or show (false) the filter bar
46
47 * <variableName>=<value> Specify a value for the variable variableName
48
49 * <filterselection> See section V below
50
51 **Example**
52
53 (% class="box" %)
54 (((
55 http:~/~/ddsrv:8080/digdash_dashboard/index.html?server=http:~/~/localhost:8080&domain=ddenterpriseapi&login=user1&pass=pass1&hideBanner=true&hideFilters=true&var=1
56 )))
57
58 = Dashboard Page =
59
60 At this level you can embed one page or all the pages of a dashboard role into an iframe
61
62 URL:
63
64 http:~/~/ddsrv:8080/digdash_dashboard/index.html?page=<user|role>[.<pagename>]
65
66 If you want one page you specify the page name otherwise you will get all the pages of the user or role selected.
67
68 Available parameters:
69
70 * page=<user|role>[.<pagename>] Page name prefixed by role or user name
71 * login=<user> User to authenticate
72
73 * pass=<password> Password for the user
74 * domain=<domainname>// //DigDash Enteprise domain name
75 Example: ddenterpriseapi
76 * server=<server URL> DigDash Enterprise domain server URL
77 Example : http:~/~/localhost:8080
78 * hideBanner=<true|false> Hide (true) or show (false) the main title bar
79 * hideFilters=<true|false> Hide (true) or show (false) the filter bar
80 * <variableName>=<value> Specify a value for the variable variableName
81 * <filterselection> See section V below
82
83 **Example**
84
85 (% class="box" %)
86 (((
87 [[http:~~/~~/ddsrv:8080/digdash_dashboard/index.html?page=user1.page1&domain=ddenterpriseapi&login=user1&pass=pass1&hideBanner=true&hideFilters=true&var=1>>url:http://ddsrv:8080/digdash_dashboard/index.html?page=user1.page1&domain=ddenterpriseapi&login=user1&pass=pass1&hideBanner=true&hideFilters=true&var=1]]
88 )))
89
90
91 = Information Flow =
92
93
94 At this level you can embed one information flow (graphic component) of your information wallet into an iframe
95
96 URL: http:~/~/ddsrv:8080/ddenterpriseapi/viewflow?flowId=<flowid>
97
98 There is an easy way to get that URL for a specific flow from the information wallet configuration by clicking on “copy flow URL”
99
100 Available parameters:
101
102 * flowId=<flow> Identifier for the flow to display
103 * user=<user> User to authenticate
104
105 * pass=<password> Password for the user
106
107 * hideFilters=<true|false> Hide (true) or show (false) the filter bar
108
109 * <variableName>=<variableValue> Specify the value of variable variableName
110
111 * <filterselection> See section V below
112
113 **Example:**
114
115 (% class="box" %)
116 (((
117 http:~/~/ddsrv:8080/ddenterpriseapi/viewflow?flowId=2340fd0&user=user1&pass=pass1&hideFilters=true&var=1
118 )))
119
120 = Filters =
121
122 You can specify pre-defined filters when for your iframe integration by setting some dimension filter parameters.
123
124 Filters are on the form:
125
126 DimensionName=FilterValue
127
128 If the dimension contains one or more Hierarchies you can select the desired Hierarchy and Level by adding
129
130 **H**DimensionName=HierarchyName
131
132 **L**DimensionName=LevelName
133
134 **Example**
135
136 (% class="box" %)
137 (((
138 http:~/~/ddsrv:8080/ddenterpriseapi/viewflow?flowId=2340fd0&user=user1&pass=pass1&Geo=France&HGeo=Geography&LGeo=Country
139 )))
140
141
142
143
144