Documentos de Académico
Documentos de Profesional
Documentos de Cultura
User Guide
April 2014
Contents
Contents
Copyright Notice
Introduction to Xtraction
Overview of Xtraction
Xtraction Environment
5
6
7
7
7
8
9
9
11
11
11
12
12
13
13
13
14
15
17
17
17
18
18
19
19
Exporting Content
Using the Export Function
20
20
21
21
21
22
23
23
24
24
25
25
26
Page 2 of 63
Contents
Variable Condition
26
28
28
29
32
35
39
41
43
44
45
47
47
48
48
49
50
50
52
53
53
53
53
54
55
55
57
57
59
59
61
61
62
Page 3 of 63
Copyright Notice
Copyright Notice
This documentation is proprietary information belonging to Xtraction Technologies and is protected by
the copyright laws of Australia and international treaties. This material may not be copied, transferred,
reproduced, disclosed or duplicated, in whole or in part, without the prior written consent of Xtraction
Technologies.
This documentation and related computer software programs are provided to users for informational
purposes only and are subject to change or withdrawal by Xtraction Technologies at any time and
without prior notice. The use of this documentation and any product referred to in this documentation
is governed by the applicable software licence agreement. Licensed users may print a reasonable
number of copies of this documentation for their own internal use, provided that Xtraction
Technologies copyright notices and legends are affixed to each copy. Only authorised employees,
consultants and agents of the user who are bound by the confidentiality provisions of the licence for
the software are permitted to have access to such copies.
The creator of this documentation is Xtraction Technologies. To the extent permitted by applicable law,
Xtraction Technologies provides this documentation as is without warranty of any kind; including
(without limitation) any implied warranties of merchantability, fitness for a particular purpose, or noninfringement. In no event will Xtraction Technologies be liable to the end user or any third party for any
loss or damage, direct or indirect, from the use of this documentation, including (without limitation)
lost profits, business interruption, goodwill, or lost data, even if Xtraction Technologies is expressly
advised of such loss or damage.
All trademarks, trade names, service marks and logos referenced herein belong to their respective
owners.
Page 4 of 63
Introduction to Xtraction
Introduction to Xtraction
Overview of Xtraction
Xtraction is a visualisation tool enabling simplification of status reporting by dragging data from within
your application databases into Dashboards or Documents for onscreen presentation or export into
external applications such as MS Word. To do this, the data is presented for use within designer tools in
the form of Components defined within the Xtraction Data Model from the attached Data Sources.
The main goals of Xtraction are:
Output can be produced in many forms, from an interactive real time Dashboard to information
exported in various formats using pre-defined templates. Dashboards and status reports can be setup
for one or more of your databases and can be displayed within a single view.
Data can be captured permanently and easily, from simple screen shots to scheduled exports of predefined reports comprising multiple Components.
The following example shows three Components within a Dashboard in the Details Pane.
Page 5 of 63
Introduction to Xtraction
Xtraction Environment
Xtraction architecture is simple and demand for hardware and software minimal. Installed on a
Windows server (2003 or greater), the application requires little more resources than what the
operating system requires. Xtraction can connect to one or more target application databases (Data
Sources) and present the information back to the web browser.
The Xtraction environment is made up of these Components:
The software environment can be installed on the one server or on separate servers.
Data
Sources
Page 6 of 63
Access to the Xtraction application is controlled by User Accounts and user authentication
Access to Xtraction functionality is controlled through Roles, where Groups and folder
permissions define access to Dashboards, documents and filters
Access to specific data is managed by Data Policies at the user level.
The management of user accounts, roles, groups, and data policies are handled within the
Administration dialogues, and are therefore explained in detail in the Administrator Guide.
Folder permissions are managed at the Designer level and are explained in the User Guide.
Description
Reference
Installation Guide
Data Model
Editor
User Guide
Data Model Editor
Guide
Content Designer
(collective role)
Enterprise
Designer
User Guide
Administrator
Guide
User Guide
Page 7 of 63
Role
Description
Reference
Designer
User Guide
Private Designer
User Guide
Viewer
User Guide
Allowed action
Allowed folders
Enterprise Designer
Designer
Private Designer
Open
Save, Move or Explore
Viewer
Open
Page 8 of 63
Administrator
Enterprise
Designer
Designer
Private
Designer
Administrator
Setting permissions
Setting permissions
for groups
for all
for
groups
designer
s groups
Setting permissions
for users
for all
for
users
users in
designer
s groups
Dashboard Designer
Document Designer
Report Designer
Schedule document
Insert public object
Update public object
Update object owner
View/Update private
objects owned by
others
Schedule documents
and reports
Viewer
Scheduler
Opening Xtraction
To access Xtraction, open a web browser and enter the URL provided by the Administrator. Typically,
the default URL is:
http://[SERVER]/Xtraction/
[SERVER] is the name of the server where Xtraction is installed.
Enter the User ID and password supplied by the application Administrator. Once authenticated, you are
presented with the Xtraction Application Window, with your access governed by your user privileges.
Page 9 of 63
Page 10 of 63
Relevant Modules
Everyday user
Power user
Power users are likely to review all user guides to gain a full understanding of the
power of Xtraction
Doing so adds to the understanding of key concepts, such as:
Filters Designing and managing filters
Components Working with Components
Default Columns definitions Default Columns used for Record Lists
Designing content for example Using the Dashboard Designer
Mini Glossary
Some of the concepts in focus:
Data Source The external source of data as defined by the Data Model
Data Policy Imposing restrictions on accessible data
Record List Component type displaying raw data from the Data Source
Default Columns Tailoring mechanism limiting accessible columns for each Data Source
Page 11 of 63
Description
Navigation Pane
Sidebar
Toolbox
Details Pane
The main display area for Xtraction content that you select from the
lists in the Navigation Pane
Function Links
Action Icons
Page 12 of 63
Action
Select an item from the Navigation Pane and drag it into the Auto Refresh & Cycle list
Click the
Right-click anywhere in Auto Refresh & Cycle and select Clear Items to clear the whole
list
Use the slider to set the refresh interval between 30 seconds and ten minutes
Select Refresh Enabled to have each the currently display item refreshed
Select Cycle Enabled to force Xtraction to cycle through the list and display each item
in turn
Page 13 of 63
Start Up Defaults
The Auto Refresh & Cycle options can be controlled via passing in parameters when launching
Xtraction. The options available to control are:
refresh
refreshSeconds
cycle
If this value is set to true, cycle will be enabled by default. If this is set to
true, refresh will also be enabled by default so the refresh parameter can
be omitted.
If this value is set to true, the sidebar will be collapsed by default.
collapsed
The name of the favorite to load. If this value is omitted, your default
favorite will be loaded (if setup).
favorite
As an example, the following will enable refresh & cycle, every 2 minutes, the sidebar collapsed and the
Daily favourite loaded by default:
http://[SERVER]/Xtraction/Flash/Default.aspx?cycle=true&refreshSeconds=120&collapsed=true&favorit
e=Daily
Favorites
If you have Dashboards you need to access regularly, you can store them in a named Favorites folder.
You can create more than one Favorites folder. These can then be loaded into the Auto Refresh & Cycle
list for easy access to the items contained in the folder.
Follow these steps to create a new Favorite folder:
Step
1
Action
Click
in the sidebar
Right-click in the panel on the left and select Add Favorite Folder
Adding Favorites
Once you have a Favorites folder setup, you can start adding items to it. A Favorites folder can be used
to store Dashboards, Documents and Reports. There are multiple ways to add content to a Favorites
folder.
Adding to Favorites via the Dashboard header:
Step
1
Action
At the top of a loaded Dashboard, click
You may also create a new Favorites folder at this stage if no existing folder is relevant
Page 14 of 63
Step
Action
Build a list of content items in the Auto Refresh & Cycle list
In the dialog presented, select an existing Favorites folder or create a new one
Note: selecting an existing Favorites folder will overwrite existing Favorites contained
within it
Managing Favorites
To manage existing Favorite folders:
Step
1
Action
Click
in the sidebar
Favorite Folders:
Right click in the pane to the left and select the appropriate option:
Add Favorite Folder Add a new folder
Edit Favorite Folder Edit the currently selected folder
Set As Default Set the currently selected folder as the default folder
Clear Default Remove the default folder flag from any folder
Delete Favorite Folder Delete the currently selected folder
Favorites:
Right click in the pane on the right and select the appropriate option:
Remove Item Remove the currently selected item from the folder
Clear Items Clear all items from the folder
Profile
Follow these steps to manage your profile to set some personal preferences or modify the time zone:
Step
Action
Reload Folder Structure to reassess the list and return it to the initial display
Large Display Mode to change font size for Dashboard and Component titles and
enabled better viewing on large displays
Change Password to change your password, provided authentication set up for your
installation enables it
Settings to modify Time Zone , Default Columns for Record Lists and change values for
Variables.
Page 15 of 63
Click Default Columns to open the display of columns for use in Record Lists
Click Variables to show any editable variables. The Variables tab may not show if there
are no variables that can be edited.
10
Click the button next to the value to search for a new value.
11
Administration
Follow these steps to gain access to Administrative functions (provided your profile displays the link):
Step
Action
Reload to reload either the Data Model being used or the Licence
Settings to manage a number of settings, also including some basic display settings
Page 16 of 63
Description
Dashboard
Document
Custom Report
Enables the more technical user to run raw SQL against the available
Data Sources directly from within Xtraction
The report designer determines what is to be included; though Custom
Reports are limited to a tabular presentation within a grid
The design process can include an attached template to enable
formatting of the output to meet specific needs
A Custom Report is a singular output without separate Components
Description
Time Component
Visually represents data using time slices segregated by hours, days, weeks,
months, etc; these can be presented in many formats including area, bar and
line charts; or in stacked and 100% stacked formats, which enables the data
to be portrayed in comparative context
Group Component
Pivot Component
Scorecard
Component
(Record) List
Component
Displays raw data from Data Sources without performing any summarisation
Image Component
Page 17 of 63
Page 18 of 63
incorporating any number of Components of any type (no on-screen space restrictions)
employing an MS Word template document to enable custom formatting.
Custom Reports
As with other content types, Custom Reports can be exported to a number of different formats.
Exporting a Custom Report can also involve a template to add structure to the report.
Page 19 of 63
Exporting Content
Exporting Content
All content displayed in the Details Pane enables the Export function at the level of either, all content
shown onscreen or any one of the Components. Depending on content type you can export to the
following formats:
MS Word
MS PowerPoint
MS Excel
PDF
HTML
Screenshots, saved as contentname.png image file.
Action
Click the
Select Export Screenshot to immediately save the item to an image file in the folder defined
for your browser
If the content was designed for a template, the option to Use template is offered
Click OK to save the item in the folder defined for your browser
Depending on the type of export, you may be prompted to acknowledge the Save or Open
action as displayed by your browser
Page 20 of 63
Action
In the top bar, click Tools > Folders to open the Folder form
The spot where you click in the first place determines the location of further interaction
Adding a folder creates a new folder - with the name prompted for entry
Editing a folder enables changing folder properties including the folder name, owner,
and security settings
Actions on Content
The Folders Pane also enables interaction with specific items listed in the Details Pane. Follow these
steps to interact with an item in the list:
Step
Action
Select Open Item to open it in the Designer tool for the type of content
Select Export Item to export it without first loading it in the Details Pane
Page 21 of 63
Action
In the top bar, click Tools > Folders to open the Folders form
Right-click on a folder and select Edit Folder to display the Folder form:
Managing Permissions
Options available under permissions depend on the user privileges:
most users may only select Public to release their own folders to the public
at Administration level a decision is made between public and restricted access
4
In the forms that display you can select one or more entries for inclusion in the list of
Permissions for the current folder
Page 22 of 63
Features
Standard
Advanced
Page 23 of 63
Meaning
Value-based
Date
Dynamic or fixed
Sub-query
Variable
Action
At the top of the Details Pane, click Tools > Filters > New Filter
Select the Data Source on which to impose the filter and click OK; or double-click its
name
Select Create a new filter for each condition if you want Xtraction to do so
Otherwise, all of your conditions are saved under the one filter
In Permissions select Public (accessible to everyone) if the filter is for public use
10
When all conditions have been set up, open the Folder tab
11
Select the location within the folder structure where Xtraction is to save the filter
Page 24 of 63
12
Action
The Edit Conditions form opens - its make-up depends on opening it by the above
method, or opening it directly from the
In Field, click the arrow and select the field on which to impose your condition
button
button
You have various options for interacting with filter conditions, for instance:
Add Date Condition
Clear Condition to remove it from the list
Reset Filter enabling a switch between a standard or advanced filter type
Open Saved Filter to import another filter into the set being worked on
Advanced Filters
Advanced filters differ from standard filters only by the option to create nested sets of conditions using
AND / OR operators.
The image illustrates this by the example of a possible outcome
Advanced filters are used when the flat list of conditions in a
standard filter cannot produce the correct results.
Advanced filters include the following attributes:
Creating and editing these filters involves the standard dialogues for filter management.
Page 25 of 63
Action
Under Filter click Conditions, or click anywhere in the sub-pane to display the menu
Select Add Sub Query Condition to display the Add Condition form
Under Link, click the arrow to open the list of available links for use in the sub-query
The texts listed indicate the condition encoded in the sub-query
Find and select the Filter to which the sub-query condition is to be applied
Variable Condition
A Variable Condition filter uses predefined variables to filter data based on the variables value.
The value associated with a variable may be changed by the user only if the Administrator has indicated
that the user can edit the variable value.
In the Profile function link and Variables tab you can see all variables that can be edited by the user. If
the Variables tab is not shown, then there are no editable variables for the user.
Step
1
Action
Under Filter right-click Conditions, or right-click anywhere in the sub-pane to display the
context menu
Page 26 of 63
Page 27 of 63
As you assemble content, you are working with one individual Component at a time. Each such
Component is of one of five possible types. On conclusion, you will have created content in the form of
a Dashboard, Document or Custom Report for display in the Details Pane or export to an external
application, such as MS Word or Excel.
Content of type Dashboard or Document can contain one or more Components selected from any
Component type.
Component Types
Xtraction differentiates between five Component types, each having its own design attributes:
Page 28 of 63
Time Components
Time Components visually represent the data using selected time slices segregated by hours, days,
weeks, months, etc. Time Components can be displayed and presented in many formats including area,
bar, and line charts. They are also available in stacked and 100% stacked formats, which enables the
data to be portrayed in comparative context.
Time Components can display multiple series that are independent of each other. This means you can
display data from multiple Data Sources within a single time Component.
Action
In the title bar of the Component, click
to display the Time Component form
The Time Component properties form displays with the General tab open:
General Tab
Title
Series
Output Tab
X Axis Format
Format for the label to use on the X Axis of the time Component
X Axis Label
Y Axis Label
Y Axis Range
Use a specified range for the Y Axis (or Secondary) rather than the
default automatic range
Series
Summaries
Hide 0s
Page 29 of 63
Step
Action
Show Title
Summary
Show Value
Show Percent
(Series)
Lines Tab
Any fixed text displayed when a time Component is output to a chart-based format
For example, you can type Very High in Text, enter a Value of 100 and type red in Colour
to have this displayed as a visual indicator when data exceeds that value
Format Rules Tab
Operation / Value / Text Colour / Back Colour
Enables you to select colours to use in the results triggered by values within the data
For example, if your data contains the summarised value Very High, you can define Red
to be used for the display of these values
Note that format rules at the series level will override format rules at the component
level
Notes Tab
Any Notes displayed when you hover over the
icon of the Component
Notes are also included in a Component export if Show Notes is selected for that export
Page 30 of 63
Action
On the General Tab of the Time Component Series form, double-click on an entry in Series
The Time Component Series form displays with the details for that series
General Tab
Title
Name
Data Source
Date Condition
Date filter condition used to filter the data for a date range
Time Interval
Summary
Output Tab
View Type
Value Format
Color
Chart on
Secondary Axis
Trendline
Select from the three options to tailor the output to your needs
Visible
Filter Tab
Criteria to use to filter the data from the Data Source
This data is used in combination with the date condition set up under the General Tab
Format Rules Tab
Operation / Value / Text Colour / Back Colour
Enables you to select colours to use in the results triggered by values within the data
For example, if your data contains the summarised value Very High, you can define Red to
be used for the display of these values
Note that format rules at the series level will override format rules at the component level
Page 31 of 63
Group Components
Group Components summarise data by one or more fields from your Data Source. Based on a filter,
they retrieve the result set and group by a field, providing a summary of your data rather than the full
results. Like tTime Components, Group Components can have multiple independent series, each
retrieved from different Data Sources if required.
Group Components are not dependent on date or time. Therefore, they can be displayed with or
without date and time filters being used. If filters are absent, all data within that group is displayed
from the Data Source.
Group Components require a primary series, and the top/sort values are applied based on the primary
series selected.
Action
In the title bar of the Component, click
to display the Group Component form
The Group Component properties form displays with the General tab open
General Tab
Title
Series
Output Tab
View
Display method for the series pie, doughnut, column, bar, bubble,
grid
Page 32 of 63
Step
Action
Sort
Count
X Axis Label
Y Axis Label
Y Axis Range
Use a specified range for the Y Axis rather than the default
automatic range
Hide 0s
Show Other
Show Legend
Show Title
Summary
Show Value
Show Percent
(Series)
Bubble Tab
X Axis Series
Y Axis Series
Radius Series
Colors Tab
Enables you to select colors to use in the results triggered by values within the data
For example, if your data contains the summarised value Very High, you can define the
output to display in Red for these values
Lines Tab
Any fixed text displayed when a Time Component is output to a chart-based format
For example, you can type Very High in Text, enter a Value of 100 and select red in
Color to have this displayed as a visual indicator when data exceeds that value
Page 33 of 63
Step
Action
Action
On the General Tab of the Group Component Series form, double-click on an entry in
Series
The Group Component Series form displays with the details for that Series
General Tab
Title
Name
Data Source
Group Field
Summary
Output Tab
Value Format
Show Value
Show Percent
Color
Visible
Filter Tab
Criteria to use to filter the data from the Data Source
This data is used in combination with the date condition set up under the General Tab
Format Rules Tab
Page 34 of 63
Step
Action
Operation / Value / Text Colour / Back Colour
Enables you to select colours to use in the results triggered by values within the data
For example, if your data contains the summarised value Very High, you can define Red
to be used for the display of these values
Note that format rules at the series level will override format rules at the component
level
Tree Components
Tree Components summarise data by one or more fields from your Data Source. Based on a filter, they
retrieve the result set and group the selected fields, providing a summary of your data rather than the
full results. Like Time Components, Tree Components can have multiple independent series, each
retrieved from different Data Sources if required.
Tree Components are not dependent on date or time. Therefore, they can be displayed with or without
date and time filters being used. If filters are absent, all data for the fields selected is displayed from the
Data Source.
Tree Components require a primary series, and the sort values are applied based on the primary series
selected.
A further property of the Tree Component is to break down values from a single field into the hierarchy.
Where a data field contains a hierarchy structure, eg. First.Second.Third, the Tree Component can split
this into separate values and insert them into the hierarchy using a Hierarchy Field. See the example
below. This example displays the same data but in the case on the left, Incident Area is specified as a
Hierarchy Field with a Delimiter of .. The values are then split based on the Delimiter and a hierarchy
is created.
Page 35 of 63
Action
In the title bar of the Component, click
to display the Tree Component form
The Tree Component properties form displays with the General tab open
General Tab
Title
Series
Output Tab
Sort
Hide 0s
Show Title
Summary
Show Collapsed
Page 36 of 63
Step
Action
Action
On the General Tab of the Group Component Series form, double-click on an entry in
Series
The Group Component Series form displays with the details for that Series
General Tab
Title
Name
Data Source
Field
Summary
Output Tab
Value Format
Show Value
Show Percent
Color
Visible
Filter Tab
Criteria to use to filter the data from the Data Source
This data is used in combination with the date condition set up under the General Tab
Format Rules Tab
Page 37 of 63
Step
Action
Operation / Value / Text Colour / Back Colour
Enables you to select colours to use in the results triggered by values within the data
For example, if your data contains the summarised value Very High, you can define Red
to be used for the display of these values
Note that format rules at the series level will override format rules at the component
level
Action
On the General Tab of the Tree Component Series form, double-click on an entry in
Fields
The Tree Component Field form displays with the details for that Field
Form Details
Field
Is Hierarchy
Field
Hierarchy Field
Delimiter
Page 38 of 63
Pivot Components
The Pivot Component supports a multi-dimensional pivot based on a row and a column.
Two types are possible group and time.
group pivot works like the Group Component, summarising data using a specified field
from the data source
time pivot works like a Time Component, summarizing data over a date range and splitting
up the data based on a specified time interval.
The following pivot Component shows the top five Groups vs Open Date Last Month on a daily basis.
Action
In the title bar of the Component, click
and select Component
to display the Pivot Component properties form
The Pivot Component properties form displays with the General tab open
General Tab
Title
Data Source
Row
Column
Summary
Output Tab
View Type
Display method for the series area, column, bar, line, plot,
bubble, grid
Value Format
Page 39 of 63
Step
Action
X Axis Label
Y Axis Label
Y Axis Range
Use a specified range for the Y Axis rather than the default
automatic range
Show Value
Show Title
Summary
Show Percent
(Row)
Show Percent
(Col)
Hide 0s
Show Collapsed
Filter Tab
Criteria to use to filter the data from the Data Source
This will be used in combination with the date condition set up
Colors Tab
Enables you to select colors to use in the results triggered by values within the data
For example, if your data contains the summarised value Very High, you can define the
output to display in Red for these value
Lines Tab
Any fixed text displayed when a Time Component is output to a chart-based format
For example, you can type Very High in Text, enter a Value of 100 and select red in
Color to have this displayed as a visual indicator when data exceeds that value
Format Rules Tab
Operation / Value / Text Color / Back Color
Enables you to select colours to use in the results triggered by values within the data
For example, if your data contains the summarised value Very High, you can define the
output to display in Red for this values
Notes Tab
Any Notes displayed when you hover over the
button for the Component
Notes are also included in a Component Export if Show Notes is selected for that export
Page 40 of 63
Scorecard Components
Scorecard Components summarise an entire data source without slicing by time or group. Based on a
filter, they retrieve the result set and provide a summary of your data rather than the full results. Like
Time Components, Scorecard Components can have multiple independent series, each retrieved from
different Data Sources if required.
Scorecard Components are not dependent on date or time. Therefore, they can be displayed with or
without date and time filters being used.
Action
In the title bar of the Component, click
and select Component
to display the Scorecard Component form
The Scorecard Component properties form displays with the General tab open
General Tab
Title
Series
Output Tab
View
Hide 0s
Page 41 of 63
Step
Action
Show Title
Summary
Show Series
Title
Action
On the General Tab of the Scoreboard Component form, double -click on an entry in
Series
The Scoreboard Component Series form displays with the details for that Series
General Tab
Title
Name
Data Source
Summary
Output Tab
Value Format
Visible
Filter Tab
Criteria to use to filter the data from the Data Source
This data is used in combination with the date condition set up under the General Tab
Page 42 of 63
You also have the option of editing the columns displayed in the result. You do this in the Component
properties form by selecting the columns to include.
Action
In the title bar of the Component, click
to display the List Component form
Hitting the icon above brings up the List Component automatically
The List Component properties form displays with the General tab open:
General Tab
Title
Data Source
Distinct Records
Only
Depending on the Data Model and the filter being applied to the
Component, duplicate records may be returned
Use this option to remove the duplicate records; but use it only
when required as it will increase load on the system
Show Title
Summary
Columns Tab
If you want to setup a specific set of columns for the Component, you can set them up
here
Filter Tab
Criteria to use to filter the data from the Data Source
This data is used in combination with the date condition set up
Notes Tab
Any Notes displayed when you hover over the
button for the Component
Notes are also included in a Component export if Show Notes is selected for that export
Page 43 of 63
Image Components
The Image Component can be used to display images within dashboards and documents. Images can
be uploaded to the Xtraction server or displayed via a URL. Because of this, an image can be
dynamically generated from an external application, either an application that generates images and
places them on the file system or an application that exposes a URL to dynamically generate an image.
Action
In the title bar of the Component, click
to display the Image Component form
Hitting the icon above brings up the Image Component automatically
The Image Component properties form displays with the General tab open:
General Tab
Title
Image Source
URL
This option will request an image from a URL when the Image
Component is displayed. Note that this URL will need to be
accessible by the users viewing the dashboard
Server
Output Tab
Vertical Align
Page 44 of 63
Step
Action
Horizontal Align
Scaling
Fill
Calculated Series
Calculated series are available for Time, Group and Scoreboard Components and work in a similar way
between these components. Calculated series allow you to create new series based on a mathematical
expression using values from the other series as parameters. When using calculated series, you can
hide any series just used in the calculation by setting its Visible property to false.
To add a calculated series, select the Add Calculated Series option when defining a new series from the
component dialog. The following options are available:
General Tab
Title
Name
Expression
Output Tab
This will show fields based on the type of component being used. For further
information, see the Output Tab section of the component described above.
Expressions
Expressions are used to calculate values for the series. Expressions can use values from other series as
parameters. Currently expressions are limited to returning only numerical values.
The following items can be used within an expression:
Parameters
[S1]
[S1_TOTAL]
Operators
Add
[S1] + [S2]
Subtract
[S1] - [S2]
Multiply
[S1] * [S2]
Divide
[S1] / [S2]
Modulus
[S1] % [S2]
Primary
(, )
Functions
Abs
Ceiling
Page 45 of 63
Floor
if
Parameters
Expressions can use values from other series when being evaluated. There are two ways to refer to
another series, using the series index or by using the series name (if setup).
1.
Series Index
You can refer to another series by using its index. The index for the first series is 1, the second
series is 2. Below is an example of adding two series together:
[S1] + [S2]
2.
Series Name
If a series has a name setup, you can refer to it by that name in an expression:
[INCIDENTS] + [REQUESTS]
Note that parameters need to be enclosed in square brackets and are case sensitive.
Page 46 of 63
Action
Click on an item (data point) to display a menu with options as shown in this image:
This action applies a temporary filter to all other Components in the Dashboard and
replaces any other temporary filter conditions already set up on those Components
For example, if you click this option on Assignee (786), the filter condition is applied to
any other Components in the display to show data with the corresponding focus
This action is similar to Replace but instead of replacing any existing temporary filter
conditions, a filter condition is created based on the selected item and added to the
existing temporary filter conditions
10
11
Page 47 of 63
2.
3.
The first five columns as defined by the Data Model where neither of the above exists.
You manage your own lists in your Personal settings, as defined in Profile > Settings.
Action
To Add a definition, you must first select the Data Source for which you are creating the
list of Default Columns from the form that displays for this purpose:
Navigate the structure to select the source for which to create the default column list
and double-click an item, or select it and click OK
Page 48 of 63
Step
6
Action
With the Data Source selected for a new list, or for an existing list, the Default Columns
form displays:
Where no Default Column list has been defined, the form is empty
Labels in the form have these meanings:
Column
Empty for a new list, or listing the columns from the Data Source
that constitute the current Record List
Format
Sorting
Sort order to use - drag column names into Sorting to define the list
Action
For an existing or a new list, editing the list is enabled by the Select Columns form:
Drag columns to use from Columns into the Selected Columns area
Manage the order of your list by placing columns in any desired sequence
When the list is complete, click OK to return to the Default Columns form
Page 49 of 63
Action
Open the Dashboard Designer in one of two ways:
button:
The Options form determines default options for the design; items have these meanings:
5
Apply Changes to
Filter Action
Page 50 of 63
Step
Action
Data Source
10
Default Filter
11
Filters list
12
With all settings correct, you are now ready to work on the Dashboard design
Page 51 of 63
Action
Your first action is to enter a Title for the Dashboard and select the layout for your
design
Click
in the Dashboard title bar to return to the properties form at any time
The basic design process simply involves dragging the Component to use from the
Components list in the Navigation Pane into the Details Pane
When your design is complete, click File > Save to save it in a folder of your choice
Page 52 of 63
including any number of Components of any type (no on-screen space restrictions)
employing an MS Word template document to enable custom formatting
exporting the content for review outside of Xtraction.
Xtraction assists the use of an MS Word template document by creating a framework template
document that has placeholders indicating where the content is to go. This approach adds the freedom
of tailoring the framework template to meet any requirement for presentation. All that is required for a
successful export is that placeholders remain intact within your tailored MS Word document.
Content of type Document is shown in the Navigation Pane by the same
Document Designer.
You can click any of the listed Components to display them in the central pane.
Document Parameters
Parameters can be associated with a document. When a document with parameters is viewed, the user
is prompted for the parameters. Parameter values entered are then passed to Variable Filter
Page 53 of 63
Conditions with the variables being replaced with the associated parameter values entered by the user.
To associate parameters with a Document:
Step
1
2
Action
Open the appropriate Document in the Document Designer
Click
Right click in the parameter list to display the parameter menu options and add the
appropriate parameters
When the Document is displayed, the user will be prompted for the parameter values
Action
Make sure that your document composition is complete, that is, contains all
Components to be included in the result
Page 54 of 63
Xtraction creates the document and opens the standard Windows Open/Save form
Click Save File, then OK to save the document in the folder defined for your browser
Action
Your browser opens a form enabling you to locate the template in your folders
In the Function Links, click File > Save to have the template saved with the design
Note: The Template option in the Function Links also enables you to download a
template, provided that one exists already
Action
Click the
Page 55 of 63
Under Format you can select the type of export, for example .DOC, .DOCX
Select Use template to have the Document exported into the template document
Page 56 of 63
Action
Click the
Pane
button in the header of the Document (or Custom Report) in the Details
Provide a name to identify the scheduled task and details about when it should run:
Setup a schedule:
Page 57 of 63
Once you are happy with the details, click the OK button to schedule the task
Schedule Options
Daily
Use this option to run the task daily. The time the task will run is taken
from the time entered in step 2 above
Weekly
Use this option to run every week on the days selected. The time the
task will run is taken from the time entered in step 2 above
Monthly
Use this option to run every month on the days and months selected.
The time the task will run is taken from the time entered in step 2
above
Timer
Use this option to run the task on the specified interval. Setup both the
interval amount and interval type (minutes, hours, days) and the task
will run continuously at the interval specified
Delivery Options
Xtraction
Server
File System
Filename
Page 58 of 63
Action
Open the Custom Report Designer in one of two ways:
Enter native SQL statements to be used for the report in the left-hand area
Note: Data policies cannot be applied directly to SQL because Custom Reports run
outside the Xtraction Component framework
Edit Parameter
Page 59 of 63
Step
Action
Remove Parameter
Clear Parameters
Convert To UTC/GMT
Convert To UNIX
time
Page 60 of 63
Action
In the Function Links, click Template > Export Designer Data Source
This produces a file on the server based on the content of your report and will ask you to
save it to your local file system
After saving this file, open the separate template design tool again
Page 61 of 63
Step
Action
In the Properties form of the tool, in the Data section, locate the XML Data Path
Set the XML Data Path to the location of the designer Data Source file exported earlier
10
The Field List displays all fields from the Custom Report:
11
As you design the template document you can drag the items from the Field List into the
design area of the tool
12
When the report is fully designed, click Save to save the output to a folder
Action
Open the Custom Report on which to use the template in Edit Mode
by clicking the
button
Your browser opens a form enabling you to locate the template in your folders
In the Function Links click File > Save to have the template saved with the design
Note: The Template option in the Function Links also enables you to download a
template, provided that one exists already
Page 62 of 63
Page 63 of 63