Skip to content

System / Data Export List

Introduction

Clicking on the System / Data Export List menu displays the Data Export List page, which shows the reports and scheduled actions to export data from NovaStar to other systems. This page facilitates the creation, modification, and deletion of a data exports.

A new NovaStar system will display an empty Data Export List.

Data Export List

The following image illustrates the System / Data Export List page after a data export has been selected in the list at the top of the page.

data exports

Data Export List (see full-size image)

The Data Export List page conforms to a layout similar to many data types which includes a list of data items. See List Functionality and Application Functionality for more information detailing page navigation; adding, copying and deleting data exports; and modifying existing data exports.

Identification

This section defines the name and decription of the data export.

identification

Data Exports Identification (see full-size image)

Data Label Description
Name Name must be unique for each data export and should describe the export. The name is used on pick lists. Max: 100 characters. Hovering over the Name label displays the index of the record in the database. Clicking the Name label displays the record index above the Name.
Description Use this field to describe the action functionality. Max: 1000 characters.

Owner

The owner section defines the owner of the data export and the display scope: private or public. Private scope only displays this data export for the owner, the owner group supervisors, and administrators. Public scope displays this data export for all group members and administrators.

owner

Owner (see full-size image)

Data Label Description
User Owner of the data export. Click the user icon person to assign the current user.
Scope Public or private.

User Groups

The User groups table shows the user groups currently assigned to the data export. For more information, see the User Groups documentation.

user groups

User Groups Assigned (see full-size image)

Product List

The Product List displays the data export products to export to other systems. Data export products have the following types: Map, Plot, Plot Image, Report, and Table.

When a data export record is first defined, no products records are assigned to the record.

action list

Product List (see full-size image)

To remove an item from the product list, click the trash icon trash icon on the item.

Clicking Add or the pencil icon in the Product List displays a popup, which facilitates editing the product.

product popup

Product Definition (see full-size image)

Data Label Description
Type Map, Plot, Plot Image, Report or Table.
Map Displayed when Map product type is selected. Select the map to export.
Plot Displayed when Plot or Plot Image product type is selected. Select the plot to export.
Report Displayed when Report product type is selected. Select the report to export.
File name Enter the file name for the product when it is made. The location of the file is determined by the data export action. This value may be edited directly, but can also contains variables. Click the down arrow button to the right of the filename field to expand the variable options. See the Product Filename Variables section below.
Options Enter command options to control how the product is made by the data display pages View Maps, View Plots, View Reports, and View Tables .
Timeout Select the product creation timeout. The data export is canceled if the product cannot be made with in the timeout interval. Default: 60 seconds.

Product Filename Variables

The filename may contains variables, defined by the data itself. Clicking the down arrow button to the right of the product filename field reveals a list of variable options. Clicking the up arrow button to the right of any of the parameters adds that variable to the end of the filename. Any number of parameters may be added.

product popup with parameters revealed

Filename Variable Options (see full-size image)

Action List

The Action List displays the data export actions to deliver the products from local or remote servers. Data export actions have the following types: None, COPY, FTP, LFTP, PFTP, and SFTP.

Multiple actions can be assigned to each product. When a data export record is first defined, no action records are assigned to the record.

action list

Action List (see full-size image)

To remove an item from the action list, click the trash icon trash icon on the item. To change the order of actions, use the reorder icon reorderIcon by pressing the left mouse button on the reorder button, drag to the new order, and release the left mouse button (basic drag and drop functionality).

Clicking Add or the pencil icon in the Action List displays a popup, which facilitates editing the action.

action popup

Action List (see full-size image)

Data Label Description
Type Select how the product is sent to the local or remote server:

None No action is taken.

Copy The file is copied using a shared file system. The destination folder and file name are required.

FTP Copy the product file with file transfer protocol. The destination host name, login name, password, folder and file name are required.

LFTP Copy the product file with sophisticated file transfer protocol. The destination host name, login name, password, folder and file name are required.

PFTP Copy the product file with passive file transfer protocol. The destination host name, login name, password, folder and file name are required.

SFTP Copy the product file with secured file transfer protocol. The destination host name, login name, password, folder and file name are required.
Host name Enter the destination host name as a URL or IP address
Login name Enter the login name for the destination host.
Password Enter the password for the login name.
Folder Enter the destination folder for the file transfer. If blank then the home folder is used.
Timeout Select the file transfer timeout. The data export is canceled if the product cannot be transferred with in the timeout interval. Default: 60 seconds.

Schedule List

The Schedule List displays the data export schedules to deliver the products to local or remote servers. When a data export record is first defined, no schedule records will be assigned to the record. Data export schedules are stored in the cron system file:

/etc/cron.d/novastar5-dataexport

To remove an item from the schedule list, click the trash icon trash icon on the item.

schedule list

Schedule List (see full-size image)

Clicking Add or the pencil icon in the Schedule List displays a popup, which facilitates editing the schedule.

action popup

Schedule List (see full-size image)

Data Label Description
Effective time Enter the time for the next scheduled action. If a past time is entered, the scheduler will adjust the time to the next scheduled time based on the schedule Interval. The default if no value is entered for the Effective time is the current time. Click the calendar with an X button to assign the current time.
Interval Enter how often the scheduled action should execute. Select from the list of intervals provided.
Day of Week Select from the Day of Week multiple choice pick list for days of the week. If the scheduled action should execute only on Fridays, set the schedule Interval to 1 day and select only Friday from the Day of Week list. Multiple days can be selected.
Enabled Select true to execute the data export at the scheduled time. Select false to leave the data export in the configuration list but do not execute it.

Command

The Command displays the command to execute this data export. Data export commands are programs or scripts which export data from outside sources into NovaStar.

command

Command (see full-size image)

Data Label Description
Command Enter the command, including options, to be executed at the scheduled time. Commands are stored in the /local/bin folder which is linked to the /usr/ns/cus folder for command execution by the scheduler. Click the View button to display a script command file. The default command is nsdataexport -G#, where # is the data export record index (hover over name in the identification section). Click the Refresh button to reset command. When copying or adding a new Command, the number after the -G is automatically filled in if the command is the default. See the nsdataexport documentation

Command Execution

The final section on the Data Export List page is the command execution area.
Hovering over the Run button run displays the command which will be run as depicted in the following image. Click the Run command button to execute the data export command; activity is shown in the display window.

execute

Data Export Execute (see full-size image)

Data Label Description
Time Limit Selecting true displays the Starting Time and Ending Time. Selecting false indicates the export all data from 01/01/1980 current.
Starting Time Set the starting time for data filing.
Ending Time Set the ending date/time for data filing.
Timeout Select the data export command timeout. The data export is canceled if the products cannot be made and transferred with in the timeout interval. Default: 60 seconds.

For more information about running commands in this area, see the Command functionality documentation.

Data Export Delete

To delete an export from the Data Export List, click that data export's row in the table, click Edit to enter into edit mode, and then click Delete. A confirmation dialog is shown to confirm that the data export should be deleted, detailing which additional data will also be deleted, including actions and scheduling. Clicking Delete again on the confirmation dialog deletes the data export. It is export to note that automatic execution of a data export can be suspended without deleting the record by setting the schedule Enabled state to false.

For more information, see Application Functionality.