Skip to content

Commit ef1197d

Browse files
eforeman-mdbeforeman-mdb
authored
(DOCSP-31737) [Charts] Refresh Behavior Section (#617)
* (DOCSP-31737) [Charts] Refresh Behavior Section * (DOCSP-31737) Conversions to procedures. * (DOCSP-31737) Edits. * (DOCSP-31737) Edits. * (DOCSP-31737) Edits. * (DOCSP-31737) Edits. * (DOCSP-31737) Edits. * (DOCSP-31737) Edits. * (DOCSP-31737) edits. * (DOCSP-31737) Indentation error fix. * (DOCSP-31737) Indentation error fix. * (DOCSP-31737) Indentation error fix. * (DOCSP-31737) Indentation error fix. * (DOCSP-31737) Indentation error fix. * (DOCSP-31737) Error fix. * (DOCSP-31737) Error fix. * (DOCSP-31737) Error fix.
1 parent c72f54b commit ef1197d

File tree

2 files changed

+99
-91
lines changed

2 files changed

+99
-91
lines changed

‎source/dashboard-refresh.txt

Lines changed: 99 additions & 91 deletions
Original file line numberDiff line numberDiff line change
@@ -28,21 +28,27 @@ behavior is to refresh when data is one hour stale.
2828

2929
To configure refresh settings for a dashboard:
3030

31-
1. Select a dashboard from the :guilabel:`Dashboards` page.
31+
.. procedure::
32+
:style: normal
3233

33-
#. Click the :guilabel:`Refresh` icon at
34-
the top of the dashboard.
34+
.. step:: Select a dashboard from the
35+
:guilabel:`Dashboards` page.
3536

36-
#. Click :guilabel:`Refresh Settings` from the dropdown.
37+
.. step:: Click the :guilabel:`Refresh` icon
38+
at the top of the dashboard.
3739

38-
#. Select your data staleness tolerance from the dropdown.
39-
|charts-short| supports the following staleness tolerances:
40+
.. step:: Click :guilabel:`Refresh Settings`
41+
from the dropdown.
4042

41-
- An increment of time between 1 minute and 30 days, or
42-
- Infinity. If you select infinity, your chart doesn't automatically
43-
refresh.
43+
.. step:: Select your data staleness tolerance
44+
from the dropdown.
4445

45-
#. Click :guilabel:`Save`.
46+
|charts-short| supports the following staleness tolerances:
47+
48+
- An increment of time between 1 minute and 30 days, or
49+
- Infinity. If you select infinity, your chart doesn't automatically refresh.
50+
51+
.. step:: Click :guilabel:`Save`.
4652

4753
Manually Refresh Data
4854
---------------------
@@ -63,11 +69,17 @@ backing your charts and render your charts with the latest data.
6369

6470
To manually refresh dashboard data:
6571

66-
1. Select a dashboard from the :guilabel:`Dashboards` page.
72+
.. procedure::
73+
:style: normal
74+
75+
.. step:: Select a dashboard from the
76+
:guilabel:`Dashboards` page.
6777

68-
#. Click the :guilabel:`Refresh` icon.
78+
.. step:: Click the :guilabel:`Refresh`
79+
icon.
6980

70-
#. Select :guilabel:`Force Refresh` from the dropdown.
81+
.. step:: Select :guilabel:`Force Refresh`
82+
from the dropdown.
7183

7284
Manually Refresh a Single Chart
7385
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -77,60 +89,65 @@ chart and render that chart with the latest data.
7789

7890
To manually refresh a single chart:
7991

80-
1. Select a dashboard from the :guilabel:`Dashboards` page.
92+
.. procedure::
93+
:style: normal
8194

82-
#. Mouse over the upper right corner of the desired chart and click the
83-
ellipsis button (:icon-mms:`ellipsis`).
95+
.. step:: Select a dashboard from the
96+
:guilabel:`Dashboards` page.
8497

85-
#. Click :guilabel:`Force Refresh`.
98+
.. step:: Hover over the upper right corner of the desired chart and click the
99+
ellipsis button (:icon-mms:`ellipsis`).
100+
101+
.. step:: Click
102+
:guilabel:`Force Refresh`.
86103

87104
Refresh Behavior
88105
----------------
89106

90-
- When |charts-short| refreshes dashboard data, only charts with data
91-
older than your specified staleness tolerance are refreshed.
92-
|charts-short| does not refresh the entire dashboard at once.
107+
When |charts-short| refreshes dashboard data, only charts with data
108+
older than your specified staleness tolerance are refreshed.
109+
|charts-short| does not refresh the entire dashboard at once.
93110

94-
- .. include:: /includes/fact-refresh-persistence.rst
111+
.. include:: /includes/fact-refresh-persistence.rst
95112

96-
- Hover over the timer at the bottom of the chart to view more
97-
information.
113+
The refresh details displayed on your charts depend on your chart viewing method
114+
and the failure status of your last refresh:
98115

99-
.. figure:: /images/charts/refresh-timer.png
100-
:figwidth: 650px
101-
:alt: Chart refresh timer.
116+
.. list-table::
117+
:widths: 33 66
118+
:stub-columns: 1
119+
:header-rows: 1
102120

103-
What you see depends on where you view the chart and if the last
104-
refresh failed:
121+
* - Viewing Method
122+
- Details You See
105123

106-
.. list-table::
107-
:widths: 33 66
108-
:stub-columns: 1
109-
:header-rows: 1
124+
* - Authenticated Dashboard
125+
-
126+
- The error code that describes why the refresh failed, if
127+
applicable.
128+
- Time since the last refresh occurred.
129+
- Time until the next automatic refresh occurs.
110130

111-
* - Viewing Method
112-
- Details You See
131+
* - Dashboard Accessed with a Public Link
132+
-
133+
- Time since the last refresh occurred.
134+
- Time until the next automatic refresh occurs.
113135

114-
* - Authenticated Dashboard
115-
-
116-
- The error code that describes why the refresh failed, if
117-
applicable.
136+
* - Embedded using an iframe or the SDK
137+
-
138+
- The :ref:`embedding error code <embedded-errors>` that
139+
describes why the refresh failed, if applicable.
140+
- If the chart is configured to automatically refresh:
118141
- Time since the last refresh occurred.
119142
- Time until the next automatic refresh occurs.
120143

121-
* - Dashboard Accessed with a Public Link
122-
-
123-
- Time since the last refresh occurred.
124-
- Time until the next automatic refresh occurs.
125-
126-
* - Embedded using an iframe or the SDK
127-
-
128-
- The :ref:`embedding error code <embedded-errors>` that
129-
describes why the refresh failed, if applicable.
130-
- If the chart is configured to automatically refresh:
131-
- Time since the last refresh occurred.
132-
- Time until the next automatic refresh occurs.
144+
You can hover over the timer at the bottom of each chart to view information about refresh times:
145+
146+
.. figure:: /images/charts/refresh-timer.png
147+
:figwidth: 450px
148+
:alt: Chart refresh timer.
133149

150+
134151
Caching Behavior
135152
~~~~~~~~~~~~~~~~
136153

@@ -144,56 +161,47 @@ on both the client and server.
144161
The data stored in the cache is encrypted with a key specific to
145162
your |charts| tenant.
146163

147-
- When a dashboard refreshes automatically:
164+
When you manually refresh an entire dashboard, |charts-short| updates
165+
all chart data by querying the data source for the latest data even if
166+
the chart data is within the specified staleness tolerance period.
148167

149-
- If a chart's data is within the staleness tolerance period,
150-
|charts-short| doesn't refresh the chart's data.
168+
When a dashboard refreshes automatically:
151169

152-
- If a chart's data is outside of the staleness tolerance period,
153-
|charts-short| returns the latest data from the server cache. If the
154-
server cache contains stale data, |charts-short| queries the data
155-
source for the latest data, refreshes the chart, and updates the
156-
data cached on both the client and server.
170+
- If a chart's data is within the staleness tolerance period,
171+
|charts-short| doesn't refresh the chart's data.
157172

158-
.. note::
173+
- If a chart's data is outside of the staleness tolerance period,
174+
|charts-short| returns the latest data from the server cache. If the
175+
server cache contains stale data, |charts-short| queries the data
176+
source for the latest data, refreshes the chart, and updates the
177+
data cached on both the client and server.
159178

160-
If your chart is embedded using
161-
:ref:`Atlas App Services Authentication <stitch-sdk-tutorial>`
162-
and
163-
:guilabel:`Fetch data using Atlas App Services` is enabled in your
164-
:ref:`Authentication Provider Settings
165-
<configure-auth-providers>`, your chart does not load data from
166-
the server cache. Your ``maxDataAge`` embedding parameter still
167-
dictates how often the chart refreshes, but the data source is
168-
always queried on each render.
169-
170-
- When you manually refresh an entire dashboard, |charts-short| updates
171-
all chart data by querying the data source for the latest data even if
172-
the chart data is within the specified staleness tolerance period.
179+
.. note::
180+
181+
If your chart is embedded using
182+
:ref:`Atlas App Services Authentication <stitch-sdk-tutorial>`
183+
and
184+
:guilabel:`Fetch data using Atlas App Services` is enabled in your
185+
:ref:`Authentication Provider Settings
186+
<configure-auth-providers>`, your chart does not load data from
187+
the server cache. Your ``maxDataAge`` embedding parameter still
188+
dictates how often the chart refreshes, but the data source is
189+
always queried on each render.
173190

174191
Refresh Failures
175192
~~~~~~~~~~~~~~~~
176193

177-
When an automatic or manual refresh fails:
178-
179-
- |charts| displays the most recently rendered chart, including all of
180-
the chart's interactive elements.
181-
182-
- If |charts| has never successfully rendered the chart, the following
183-
message is displayed: ``Unable to load data``.
194+
When an automatic or manual refresh fails, |charts| displays the most recently rendered chart, including all of the chart's interactive elements,
195+
along with an error message that reads ``Last refresh failed``. If |charts| has never successfully rendered the chart, the error message instead reads ``Unable to load data``.
184196

185-
- |charts| displays the following error message at the bottom of the
186-
chart: ``Last refresh failed``.
197+
If you're viewing a chart that is rendered on an Authenticated Dashboard or embedded using an iframe or the SDK,
198+
you can click the :guilabel:`Refresh` link in the error message to manually refresh the chart.
187199

188-
- If you're viewing the chart on an Authenticated Dashboard,
189-
click the :guilabel:`failed` link in the error message to view
190-
additional error details.
200+
If you're viewing the chart on an Authenticated Dashboard,
201+
click the :guilabel:`failed` link in the error message to view
202+
additional error details.
191203

192-
.. note::
193-
194-
This link is not available when you view charts on a dashboard
195-
from a public link or embedded using an iframe or the SDK.
204+
.. note::
196205

197-
- The error message includes a :guilabel:`Refresh` link if the chart
198-
is rendered on an authenticated dashboard or embedded using an
199-
iframe or the SDK. Click the link to manually refresh the chart.
206+
The :guilabel:`failed` link is not available when you view charts on a dashboard
207+
from a public link or embedded using an iframe or the SDK.

‎source/images/charts/refresh-timer.png

-743 KB
Loading

0 commit comments

Comments
 (0)