ServiceGrid Article - Downloading Data

From DocWiki

Jump to: navigation, search

Contents

Overview

The ServiceGrid platform provides functions to supply data to other systems or users. The download functions allow distributing data manually or automatically via schedulers .

Download Formats

Downloads can be converted to the following formats:

  • CSV - Comma-Separated Values
  • XML - Extensible Markup Language
  • XLS - Microsoft Excel (download only)

CSV Syntax and Filename

The CSV format is widely used to import and export data using different different tools, for example, Microsoft Excel, Open Office, etc. The syntax of CSV files is defined by the following rules:

  • The filename has "csv" as file extension.
  • The separation character can be comma, semicolon or tabulator and can be selected via the download wizard.
  • The used text separator can be selected (e.g. "") via the download wizard.
  • The first line of every CSV-file is the column header line.

XLS Syntax and Filename

The XLS file format is used by Microsoft Excel. XLS files can only be used when downloading data from the ServiceGrid platform.

Check: Example of downloading locations records into XLS

XML Syntax and Filename

The XML file format is a widely used syntax for data interfaces. XML documents consist of a header, a root-tag, and the tags containing the data values. When using XML as the download format the following XML elements will be used:

  • The header tag contains the encoding information selected.
  • The root tag is always the name of the data object downloaded, for example, locations.
  • The records are encapsulated into the tags. The record number is an attribute within the tag.
  • The fields are tags within each row having the label name of the fields of the selected setup.

Check: Example of downloading locations into XML

Encoding Options

Character encoding is supported for:

  • UTF-8
  • ISO 8859-1
  • ISO 8859-2

For more deatils go to Character Encoding.

XSL Transformation Templates

XSL transformation templates are used as an additional method to convert the SD Data structure into another XML document.

The XSLT templates read the generated XML file. Column headers are the XML tag names. The XML file is interpreted using XSL Transformation as defined in the template. Available templates must be set to:

active = Y

viewable = N

How to perform a Manual Download

The manual download functions are in most lists on the screen. The download and upload function can be switched on or off via the list setup master data, BasicData.

Step 1: Select a setup

Decide which data list should be downloaded. A standard or customer specific setup can be selected. The results of the provided list can be narrowed by using the filter options provided on top of the results. The download function will always download all selected/filtered records including all displayed fields. If the list is longer than what the screen display shows, all the records not displayed will also be downloaded. Hidden fields of a setup will not be downloaded.

Functions:

FunctionDescription

Download list: The selected records will be downloaded either as CSV , XML, or XLS file After clicking on the download function link the download form will be displayed for selecting further parameters.

Step 2: Fill in the Download Form Parameters

Output The output form (CSV, XLS, XML)
Encoding The encoding (ISO-8859-1, ISO-8859-2, UTF-8)
Template The (optional) template to be used
Filename The generated filename 
Field separator The field separator in case of CSV output
Text separator The text separator in case of CSV output. 

Click on the GO button to start downloading the data.

Parameters for Download as CSV file

The following parameters are used when CSV is the download format:

Output Select CSV as output format
Encoding Select the encoding (ISO-8859-1, ISO-8859-2, UTF-8)
Template Not used with CSV
Filename Type the filename for the generated file
Field separator Select the field separator
Text separator Select the text separator 

Click on the GO button to start downloading the data. Depending on the local browser and operating system settings, the file will be opened immediately or will be stored on the local file system.

Parameters for Download as XLS file

The following parameters are used when using XLS as download format:

Output Select XLS as output format
Encoding Select the encoding (ISO-8859-1, ISO-8859-2, UTF-8)
Template Not used with XSL
Filename Type the filename for the generated file
Field separator Not used with XSL
Text separator Not used with XSL

Click on the GO button to start downloading the data. Depending on the local browser and operating system settings, the file will be opened immediately or will be stored on the local file system.

Parameters for Download as XML document

The following parameters are used when using XML as download format:

Output Select XML as output format
Encoding Select the encoding (ISO-8859-1, ISO-8859-2, UTF-8)
Template Select the (optional) XML template (see section XSL template)
Filename Type the filename for the generated file
Field separator Not used with XML
Text separator Not used with XML

Click on the GO button to start downloading the data. Depending on the local browser and operating system settings, the file will be opened immediately or will be stored on the local file system.

Using XSL Transformation Templates

The following parameters are used when using XML together with a XSL Template as download format:

Output Select XML as output format
Encoding Select the encoding (ISO-8859-1, ISO-8859-2, UTF-8)
Template Select the XSL template (see section XSL template)
Filename Type the filename for the generated file
Field separator Not used with XML
Text separator Not used with XML

Click on the GO button to start downloading the data.

Automatic Download Functions

Automatic downloads are used to download data at a scheduled time via SMTP attachment to one or many receiver mail account(s). Automatic downloads can only be used together with customer specific list setups. Automatic downloads are managed by the SD.DataBroker functions.

SD.DataBroker - Download Manager

The Download Manager shows all the scheduled downloads of the organization.

The following fields are displayed:

ShortName Scheduler's short name
Name Scheduler's name
SetUpReportGroup The name of thesetup or report group
IsActive A flag specifying if the scheduler is active
Destination The destination of the download - Mail or Archive
Period The period of the download - daily, weekly, monthly or yearly
StartTime The requested start time
Receiver The short name of the receiver
ReceiverNames The names of the receiver

The following functions are available:

Add a Scheduler A new scheduler can be created
Expand ("+"-Button) The list of the data downloads contained in the scheduler is displayed. The scheduler can be updated or deleted

Create a new download scheduler

Create a scheduled download by following these steps:

  1. Identify or create a list setup
  2. Create a scheduler
  3. Select the list setup
  4. Enter the requested time and receiver

Identify or create a list setup

Before you start you have to identify which data list you want to download via automated scheduled download. An already existing customer specific list setup may be used or you have to create a new list setup.

To create a new list setup: BasicData > MyCompany > Setups

Add a scheduler

To add a new scheduler click on the Add a scheduler link in the SD.DataBroker Downloads list.

Select the list setup

All available customer specific list setups and report groups are displayed. Select therequired list setup or report group to download automatically.

Enter the requested format and time

The scheduler detail form is displayed. The format and time parameters can be entered.

ID
The internal ID of the scheduler
Setup
The selected setup
Name
The name of the scheduler
IsActive
A flag specifying if the scheduler is active
Destination
The destination of the download - Mail or Archive
Format
The format - CSV, XML, XLS
Template
The (optional) XSL template to be used
Filename
The file name including the file extension
Field seperator
The field separator character
Text seperator
The text separator character
Period
The period of the download - daily, weekly, monthly, yearly
StartTime
The requested start time
StartMonth
The requested start month
StartWeekDay
The requested start day of the week
DataSelection
A selection defining if all records, all changed records or all records if at least one record has been changed shall be sent
SendMailIfNoRecordsFound
A flag specifying if a message shall be sent if no records found
NoRecordFoundMessage
The message which should be sent if no records were found
StartDay
The start day of the scheduler
EMFrom
Email address which should be shown as sender
EMSubject
Email subject which should be shown
Description
Email content of the scheduler
NextStart
The (calculated) next start time
LastStart
The last start time

Change or delete a scheduler

After having specified the format and time parameters, the detail form is displayed.

Change the scheduler master data The scheduler format and time-parameters can be changed
Delete scheduler The scheduler will be deleted
Display receivers

The receivers are displayed

Additional receivers can be selected

Select the receiver(s)

The default receiver is always the login user having created the scheduler. If additional receivers are requested, a list is provided to select all users that will be added as receivers to the scheduler. The login user, as default receiver, can be removed from the list.




For a complete list of Cisco ServiceGrid Articles, go to the List of Articles page.

Related Articles

Databroker

Databroker Concept

Uploading Data



Rating: 0.0/5 (0 votes cast)

Personal tools