Xcelsius 2008
Xcelsius 2008
Refresh On Load option
Abstract
Refresh On Load is presented as an option in certain Data Connections, as well as the Connection Refresh
Button component. This whitepaper will detail the functional differences when the option is enabled in a
Data Connection versus when it is enabled in the Connection Refresh Button. The following is applicable
with the SP1 release of Xcelsius Engage 2008, Xcelsius Engage Server 2008 and BusinessObjects Xcelsius
Enterprise 2008. By reading this whitepaper you will gain understanding of the functionality of the
Refresh On Load option in both a Data Connection and the Connection Refresh Button component, as
well as uses for the option in both instances.
Document Background
Creation Date: Monday, September 15, 2008
Author Name and Title: Amy Williams, Technical Writer
Company: SAP Business Objects
9/15/2008 12:49:00 PM
Copyright © 2008 Business Objects. All rights reserved.
Page 1
Product Name
Document Title
Contents
INTRODUCTION .......................................................................................................................................... 2
FUNCTIONALITY IN A DATA CONNECTION ..................................................................................................... 2
Enable Refresh On Load .................................................................................................................................. 2
Function in SWF file ....................................................................................................................................... 3
FUNCTIONALITY IN THE CONNECTION REFRESH BUTTON................................................................................ 3
Enable Refresh On Load .................................................................................................................................. 3
Function in SWF file ....................................................................................................................................... 3
USE CASES .............................................................................................................................................. 3
Use in a Data Connection ................................................................................................................................ 4
Use in the Connection Refresh Button ............................................................................................................. 4
Use in both a Data Connection and the Connection Refresh Button .................................................................. 4
Introduction
In the initial release of Xcelsius 2008, Refresh On Load was an option available only in certain data
connections: Query as a Web Service, Web Service Connection, and XML Data. With the release of
Xcelsius 2008 SP1, the Refresh On Load option was added to the Connection Refresh Button component.
Although the option has the same basic function in each instance, it does operate differently. The addition
of this option to the Connection Refresh Button enables users to mirror a functionality that is present in
Crystal Xcelsius Designer 4.5. Below we will explore the functionality of Refresh On Load in a Data
Connection, then in the Connection Refresh Button component. Lastly, we will present use cases for the
two applications of Refresh On Load.
Functionality in a Data Connection
In this section we will cover how to enable the Refresh On Load option in a Data Connection, then how
the option functions in the SWF file.
Enable Refresh On Load
The following steps enable the Refresh On Load option in a sample Data Connection.
1.
Launch Xcelsius 2008.
2.
Open the Data Manager (from the main menu go to Data > Connections…).
3.
Click Add.
4.
Select XML Data.
5.
Click the Usage tab.
6.
Under Refresh Options, check the box next to Refresh On Load.
9/15/2008 12:49:00 PM
Copyright © 2008 Business Objects. All rights reserved.
Page 2
filename.pdf
Product Name
Document Title
Function in SWF file
When the SWF file is launched, data is retrieved from the spreadsheet and any data connections, and then
dashboard components are generated. Data that is retrieved, just prior to the components’ generation, is
used by the components’ as default data set.
The Refresh On Load option forces the Data Connection to retrieve data from the source before the
components are generated. Therefore, the components will use the data retrieved by the Data Connection
upon load as the default data set.
In Crystal Xcelsius 4.5, this functionality would have been observed when enabling the Use Web Service
option, under File > Export Settings.
Functionality in the Connection Refresh Button
In this section we will cover how to enable the Refresh On Load option in Connection Refresh Button
component, then how the option functions in the SWF file.
Enable Refresh On Load
The following steps enable the Refresh On Load option in the Connection Refresh Button component.
1.
Launch Xcelsius 2008.
2.
On the Components browser, under the Categories tab, click Web Connectivity.
3.
Click Connection Refresh Button and drag it to the Canvas.
4.
On the Properties Panel, click the Behavior tab.
5.
On the Common tab, under Trigger Behavior, check the box next to Refresh On Load.
Function in SWF file
When the SWF file is launched, data is retrieved from the spreadsheet and any data connections, and then
dashboard components are generated. Data that is retrieved, just prior to the components’ generation, is
used by the components’ as default data set.
As a component, the Connection Refresh Button must be generated before its selected options can be
acted upon. The Refresh On Load option forces the Connection Refresh Button component to retrieve
data from the source using its associated data connection, after the component is generated. Therefore,
the data retrieved by the Connection Refresh Button upon load is not used as the default data set.
In Crystal Xcelsius 4.5, this functionality would have been observed when enabling certain Web
Connectivity button components’ Refresh On Load option, on the Behavior tab.
Use Cases
In this section we will discuss the benefits of enabling the Refresh On Load option in a Data Connection,
the Connection Refresh Button component, and simultaneously in both.
9/15/2008 12:49:00 PM
Copyright © 2008 Business Objects. All rights reserved.
Page 3
filename.pdf
Product Name
Document Title
Use in a Data Connection
Data is retrieved before the components are displayed, avoiding a screen flicker when changing from
spreadsheet data to connection data.
The data retrieved on load by a Data Connection is included as part of the default state of the model,
providing the data set for bound component features like initial limits and the Reset Button.
Use in the Connection Refresh Button
Data is retrieved after the components are displayed. This may be perceived as faster initialization,
because the loading bar may displayed for a shorter period of time.
Data is retrieved after the selector components insert their data, thereby allowing components to provide
parameters necessary for the data connection associated with the Connection Refresh Button.
The data retrieved on load by the Connection Refresh Button is not included as part of the default state of
the model, therefore there is no data set for bound component features like initial limits and the Reset
Button.
Use in both a Data Connection and the Connection Refresh Button
This usage scenario is not recommended. The best practice would be to choose to enable the Refresh On
Load option in only one, either in a Data Connection or in the Connection Refresh Button component.
Enabling the option in both instances would retrieve the same data twice, creating excess network traffic
and clutter within the application.
Business Objects Diamond Technical Community
http://diamond.businessobjects.com
www.businessobjects.com
No part of the computer software or this document may be reproduced or transmitted in any form or by any means, electronic or mechanical, including
photocopying, recording, or by any information storage and retrieval system, without permission in writing from Business Objects.
The information in this document is subject to change without notice. Business Objects does not warrant that this document is error free.
This software and documentation is commercial computer software under Federal Acquisition regulations, and is provided only under the Restricted Rights of
the Federal Acquisition Regulations applicable to commercial computer software provided at private expense. The use, duplication, or disclosure by the U.S.
Government is subject to restrictions set forth in subdivision (c) (1) (ii) of the Rights in Technical Data and Computer Software clause at 252.227-7013.
The Business Objects product and technology are protected by US patent numbers 5,555,403; 6,247,008; 6,578,027; 6,490,593; and 6,289,352. The
Business Objects logo, the Business Objects tagline, BusinessObjects, BusinessObjects Broadcast Agent, BusinessQuery, Crystal Analysis, Crystal
Analysis Holos, Crystal Applications, Crystal Enterprise, Crystal Info, Crystal Reports, Rapid Mart, and WebIntelligence are trademarks or registered
trademarks of Business Objects SA in the United States and/or other countries. Various product and service names referenced herein may be
trademarks of Business Objects SA. All other company, product, or brand names mentioned herein, may be the trademarks of their respective
owners. Specifications subject to change without notice. Not responsible for errors or omissions.
Copyright © 2008 Business Objects SA. All rights reserved.
9/15/2008 12:49:00 PM
Copyright © 2008 Business Objects. All rights reserved.
Page 4
filename.pdf
