- XML Tag: <dataset>
Parent tag: <data> |
Attributes: |
name
|
This is an internal name that uniquely identifies the data set. Dependent data sets in the same data set family specify this name in the <dependson> tag.
|
Type: String
|
Required: Yes
|
|
rank
|
This attribute indicates the order in which the data set will appear in the advanced area of the Disconnected Analytics Application Manager and the order in which the Disconnected Analytics Application Manager will process the data set. The attribute must be a non-negative integer. Multiple data sets may have the same rank, in which case the Disconnected Analytics Application Manager will display and process them in the ascending alphabetical order of their respective names.
|
Type: Number
|
Required: Yes
|
|
validitytype
|
This attribute specifies which validity scheme to use for the data set. The Disconnected Analytics Application Manager uses one of two validation schemes for determining whether to download a given data set: date-based and rolling-period. For the date-based scheme, the Disconnected Analytics Application Manager (potentially) needs to verify that the data set's most recent successful synchronization date exceeds or equals a specified start date (see the start attribute) and that the current date (always) precedes an end date if specified (see the expiry attribute). For the rolling-period scheme, the Disconnected Analytics Application Manager must verify that the data set's most recent successful synchronization date falls within a specified time interval ending at the current date. The attributes period and periodunit define this interval.
|
Type: Keyword (valid values are date-based and rolling-period)
|
Required: Yes
|
|
start
|
For the date-based validity option, the data set's most recent synchronization date must equal or exceed this date for the data set to be valid. This only applies to incremental data sets, however; for full data sets, the Disconnected Analytics Application Manager ignores this attribute entirely. Specifying this attribute for an incremental data set necessarily implies that the incremental data set must be downloaded after the full data set in a separate download. To allow the initial downloading of the full data set and all its dependent incremental data sets in a single download, do not specify this attribute.
|
Type: date
|
Required: No-default is just before the beginning of time (negative infinity).
|
|
expiry
|
For the date-based validity option, the current date must precede this date for the data set to be valid.
|
Type: date
|
Required: No-default is just after the end of time (positive infinity).
|
|
period
|
For the rolling-period validity option, this attribute specifies the length of the periodic interval in terms of units specified with the periodunit attribute below. It must equal a non-negative integer.
|
Type: number
|
Required: Yes, but only if the validitytype attribute equals rolling-period.
|
|
periodunit
|
For the rolling-period validity option, this attribute specifies the units for the periodic interval: years, months, and so on.
|
Type: keyword-valid values are year, quarter, month, week, and day.
|
Required: Yes, but only if the validitytype attribute equals rolling-period.
|
|
dependson
|
For all data sets in a data set family except the parent data set, this attribute specifies the name of the parent data set in the family. For example, all incremental data sets will have this field set to the name of the full data set.
|
Type: String
|
Required: No
|
|
syncdefaultfirsttime
|
True if the data set should be downloaded by default for the first sync of the data set family on a given disconnected (laptop) machine, false otherwise. Although sophisticated end users may wish to use the advanced area of the Disconnected Analytics Application Manager to specify precisely which data sets to download for a given sync operation, novice users may prefer to avoid the advanced area and take the default option.
|
Type: boolean keyword-true or false. (yes and no may be supported later.)
|
Required: No
|
|
syncdefaultsubsequenttimes
|
True if the data set should be downloaded by default for all subsequent sync operations (after the first synchronization) of the data set family on a given disconnected machine, false otherwise. Again, sophisticated end users may wish to use the advanced area of the Disconnected Analytics Application Manager to specify precisely which data sets to download for a given sync operation, but novice users may prefer to avoid the advanced area and take the default option.
|
Type: boolean keyword-true or false. (yes and no may be supported later.)
|
Required: No
|
|
syncmode
|
Synchronization can take place in one of two ways: preprocessed or online. For the online option, Siebel Analytics Web on the enterprise server will run a sourcing report to generate the data files for the data set as part of the sync operation. Administrators typically use the online option for real-time data.
|
For the pre-processed option, Siebel Analytics Web on the enterprise server will look for existing data files to download and will only run the sourcing report if no such preprocessed files exist.
|
Type: keyword-valid values are pre-processed and online.
|
Required:No
|
|
forcesync
|
The advanced mode of the Disconnected Analytics Application Manager allows users to choose not to download a particular data set. The forcesync attribute allows the administrator to override that choice, forcing the Disconnected Analytics Application Manager to perform the download. Administrators typically use this attribute for system-related data and for commonly-used dimension tables such as a time dimension.
|
Type: boolean keyword-true or false. (yes and no may be supported later.)
|
Required: No
|
|
subjectarea
|
The name of the subject area in the enterprise repository associated with the disconnected application. Siebel Analytics Web on the enterprise server uses this name when storing filters for the application in the enterprise Web Catalog.
|
Type: String
|
Required:Yes
|
|
- XML Tag: <displayname>
This identifies the descriptive name of either an application or a data set in a specified language. The descriptive name for an application appears in the Disconnected page of Siebel Analytics Web on the enterprise server and in the application pull-down menu of the Disconnected Analytics Application Manager on the disconnected machine. The descriptive names for all data sets appear in the advanced section of the Disconnected Analytics Application Manager and on the Disconnected Filter page of Siebel Analytics Web.
An application or data set may have multiple <displayname> tags each corresponding to a different language. Users logging in to Siebel Analytics Web specify their choice of language. Based on this choice, the corresponding display name will appear.
If a data set contains no <displayname> tag (or if a user specifies a language for which no <displayname> tag exists), the data set's internal name appears in the advanced section of the Disconnected Analytics Application Manager.
If an application contains no <displayname> tag (or if a user specifies a language for which no <displayname> tag exists), the application's default display name appears instead.
NOTE: For applications, the <displayname> tag must follow the <webcatalog> tag and the <postdbschema> tag (if specified); for data sets, the <displayname> tag must precede the first <table> tag.
Parent tag: <application> or <dataset> |
|
Attributes: |
|
|
lang
|
|
|
(A code that represents display name language. Siebel Disconnected Analytics currently supports the following languages their corresponding codes:
|
|
|
"cs" |
|
|
|
"da" |
|
|
|
"de" |
|
|
|
"en" |
|
|
|
"es" |
|
|
|
"fi" |
|
|
|
"fr" |
|
|
|
"it" |
|
|
|
"ja" |
|
|
|
"ko" |
|
|
|
"nl" |
|
|
|
"pt" |
|
|
|
"pt-br" |
|
|
|
"sv" |
|
|
|
"zh" |
|
|
|
"zh-tw" |
|
Type: String (code for the display name language.)
|
Required: Yes
|
|
|
|
|
|
value
|
|
|
The actual text of the display name in the appropriate language.
|
Type: String
|
|
|
Required: Yes
|
|
|
- XML Tag: <filterables>
An administrator may optionally use this tag to enumerate a set of columns from the sourcing report that end users can specify in filters to restrict what rows get downloaded to the table on the disconnected (laptop) machine.
Parent tag: <sourcingreport>
Attributes: None
- XML Tag: <formula>
This tag identifies a particular column from the sourcing report as available for use in filters. For example, in the Retail database described in Scenario for Using SQL Scripts to Create Disconnected Tables and Indexes, the Store sourcing report has columns such as Store.Name (with values such as Downtown and West End) and Store.city (with values such as San Francisco and Seattle). Administrators wanting to make these columns available for filtering would specify the following tags:
<sourcingreport name = "Store" file = "Store.csv">
<filterables>
<formula>Store.Name</formula>
<formula>Store.City</formula>
</filterables>
</sourcingreport>
End users could then add more filters to the sourcing report. For example, they could add a filter to download only the Store records for San Francisco and Seattle.
Alternatively, administrators can supply * as the column name. This indicates that all filterable columns previously specified in the data set apply to the sourcing report. For example, suppose the SalesFact sourcing report has the following filter specified:
<sourcingreport name = "SalesFact" file = "SalesFact.csv">
<filterables>
<formula>*</formula>
</filterables>
</sourcingreport>
This means that all filterable columns on previous sourcing reports (Store.Name and Store.color in our example), also apply to the SalesFact sourcing report. Therefore, if an end user adds filters to download only the Store records for San Francisco and Seattle, then only the fact table records for San Francisco and Seattle will be downloaded as well.
Note that administrators can only specify the * option for the last sourcing report in a data set.
Parent tag: <filterables>
Attributes: none
- XML Tag: <indexsql>
Parent tag: <table>
Attributes:
name
The name of a SQL script file that the Disconnected Analytics Application Manager will use for creating one or more indexes on a table downloaded to the disconnected (laptop) machine.
Type: String
Required: Yes
- XML Tag: <messages>
Parent tag: <application>
Attributes:
dir
The name of the disconnected application message directory described in Disconnected Application Message Directory. This directory contains the message localization XML files for the disconnected Web Catalog of the application.
Type: String
Required: Yes
- XML Tag: <postdbschema>
The <postdbschema> tag is optional, but if specified, it must follow the <webcatalog> tag.
Parent tag: <application>
Attributes:
name
The name of a SQL script file that the Disconnected Analytics Application Manager will run once it has loaded all data for the application into the SQL Anywhere database on the disconnected (laptop) machine. Administrators might set up such a script file for updating statistics or reorganizing the database.
Type: String
Required: Yes
- XML Tag: <remotecfg>
This tag that brackets the entire XML file, identifying it as a disconnected application configuration file.
Parent tag: none
Attributes: none
- XML Tag: <repository>
The <repository> tag is mandatory and must precede the <webcatalog> tag.
Parent tag: <application>
Attributes:
name
The name of the disconnected application repository. The Analytics Server on the disconnected machine uses this repository as its source for analytics metadata.
Type: String
Required: Yes
- XML Tag: <sourcingreport>
Parent tag: <table>
Attributes:
name
The name of the Siebel Analytics Web report that generates the data for a particular table on the disconnected (laptop) machine.
Type: String
Required: No, not necessary for externally generated data files.
file
The name of the output file generated from the sourcing report, or alternatively, it could be the name of an externally generated file (for example, syndicated data). This file is sent to the disconnected machine and used to load the table. This attribute need not be specified; by default the output file name is the same as the name attribute followed by a CSV suffix.
Type: String
Required: Yes, only if the name attribute is not specified.
- XML Tag: <table>
Parent tag: <dataset>
Attributes:
name
The name of the table stored in the SQL Anywhere database on the disconnected (laptop) machine.
Type: String
Required: Yes
- XML Tag: <tablesql>
Parent tag: <table>
Attributes:
name
The name of the script file that the Disconnected Analytics Application Manager will use for creating or updating the relevant table on the disconnected (laptop) machine. For full data sets, the script file will typically contain a DROP TABLE statement followed by a CREATE TABLE statement. For incremental data sets, the table already exists on the disconnected machine, so the script file will typically contain DELETE statements followed (optionally) by INSERT statements.
Type: String
Required: Yes
- XML Tag: <webcatalog>.
The <webcatalog> tag is mandatory and must follow the <repository> tag.
Parent tag: <application>
Attributes:
name
The name of the disconnected application Web Catalog. The disconnected Analytics Web Server uses this Web Catalog to store dashboards and reports.
Type: String
Required: Yes
