Open topic with navigation

Configure > Setting Up the Application > Using the Business Object Uploader > Bulk Upload Configuration

Bulk Upload Configuration

The HEAT system provides two tools for uploading business objects: the Bulk Uploader, which uses a web client, and the Business Object Uploader. The Business Object Uploader tool is a legacy desktop client.  See Using the Business Object Uploader for information about using this tool.

The Bulk Uploader tool is a server-side tool for uploading business objects to the HEAT database.

Use the Bulk Uploader tool to submit XML, CSV, or Microsoft Excel XML files containing information about individual business objects. You can upload these files from a web service, a remote location (such as an FTP site), or a shared network folder, or you can import them manually from your local environment. These groupings of input files, upload processes, and target business objects are called pipelines.

Before configuring the pipeline, see Using the Business Object Uploader for information about creating your mapping file for upload.
ClosedCreating an Upload Pipeline
1. From the Configuration Console main menu, choose Extend > Integration Tools > Legacy Bulk Uploader > Configuration. A list of pipelines appears.
2. Click Samples to view sample mapping files in different formats or click a pipeline name link to view an existing pipeline.
3. Click Add New. An empty pipeline form appears.
4. Enter information into the fields.
Closed--fields--

Bulk Uploader Fields

Field Description
Name A unique name for this pipeline.
Location Type

To retrieve the pipeline file from somewhere other than the server (by using the Execute command), select a source for the pipeline file.

To use FTP or HTTP, contact FrontRange Support for assistance on opening the client server or host.

  • Manual: A local pipeline file. You do not have to enter a corresponding path in the Location field.
  • Web: A URL. Enter the URL in the Location field. You cannot download files from Google Docs, as the system requires that the URL be authenticated, which is not supported.
  • FTP: An FTP site. In the Location field, enter the location in the format ftp://<server IP address or host name>/<FolderName>/<data source file>.
  • Shared Folder: A network path. In the Location field, enter the network path in the format //<IP address>/<FolderName>.

Note: Do not select Shared Folder because the HEAT servers do not have access to the internal network location for the client. Select FTP instead and use an FTP server that you can access with your login credentials.

Location The file location. If you select a location type other than manual, the Validate Location link appears. Click the link to validate the location.
Time zone Time zone to use to set the date and time of the imported records.

Username

A valid username and password.

Password

These values are only required for certain location types. For example, a username and password is required when accessing files from an FTP site.

Data Processor

Name Read-only.
Type

File type.

  • XML: XML files, including XSD files.  XSD files contain the XML schema definition that defines the syntax of a mapping file and can be used with XML viewers and editors.
  • ExcelXml: MS Excel spreadsheets that have been saved in the XML spreadsheet 2003 format.
  • CSV: Comma-separated value files.
Transformation

The transformation code. Used with XSLT to transform XML files, or when using CSV.

  • The root node contains a list of object nodes.
  • Object nodes contains a list of fields.
  • Field names match those of the source column names in the mapping file.

The default processor for CSV files uses semicolons (;) as delimiters. To use comma-delimited items, specify the settings as configuration items and copy them into this field. For example:


Format=Delimit(,)
CurrencyThousandSymbol=,
DecimalSymbol=.

Mapping

Name Read-only.
Target Object

A business object. For example, to import a list of employee records, select Employee.  To import a list of incidents, select Incident.
Configuration Becomes active after saving the pipeline.

Schedule

This section appears if you do not select manual in the Location Type field.

Enabled Schedules the pipeline.
Type

Schedule type. You can select daily, weekly, monthly, or yearly.
Advanced Schedule details.
5. Click Save to save the pipeline. The system adds the pipeline as an entry to the Pipelines table.
6. Open the pipeline. If necessary, you can paste the mapping file content in the Configuration field.
7. Click Select File.  Browse to the file location and select it.
8. Click Select File to locate a profile file (XML or CSV content), or paste the mapping file in the Configuration field.
9. After the system saves the mapping, click one of the following links in the Pipelines table:
  • Execute File to upload if the file if it is stored on the server.
  • Execute to upload the file if it is stored remotely.
ClosedViewing Upload Results

Use the Legacy Bulk Uploader History page to track the progress of your uploads and to troubleshoot problems. You can search for upload results by date range, target object, and pipeline name.

1. Set the search criteria.
  • Pipeline Name: A valid pipeline name.
  • Min Date: Starting date (in the format mm/dd/yyyy).
  • Max Date: Ending date (in the format mm/dd/yyyy).
2. Click Search.

The results appear in table format, including success/failure information and details.

The database server shows DateTime values in UTC format. Therefore, all upload files should be formatted accordingly. Otherwise, the uploaded files appear in the DateTime format of the user associated with the current session.

Tasks

Using the Business Object Uploader

Copyright © 2011-2014 FrontRange Solutions USA Inc. | All Rights Reserved