Action Export

The Action Export feature allows you to extract and download data from the action table. The configured output can be viewed in the application and in the \app\export folder where the Shop Floor Time application is installed. Only events that can post to the action table and that have an ACTION_EXPORT record in the Process Status form can be exported via the action export. To run an export, you must first configure the events you want to export and configure the export definition. See below for details.

Note: You can also run action exports by running the EXPORT service. When you run an action export using the EXPORT service, you can specify which facilities and charge types to include. You can also schedule the service to run. However, when you run the EXPORT service, you cannot include Previously Exported Records.

See Also:

Configuration

Run the Action Export

Download/View/Save the Payroll Export Data

 

Configuration

To configure an Action Export, follow all the steps below.

 

1. Configure the events you want to make available for download via Action Export (for example, CLOCK).

Each event must be configured with the following:

Validation Stage: Post Validation

Std Validation ID: Insert Action Process Status to Export Action records.

By configuring an event with this Std Validation ID, the event will have an ACTION_EXPORT record in the Process Status form once it posts to the Action table. Only events that can post to the action table and that have an ACTION_EXPORT record on the Process Status form can be exported as an action export.

Form to Use: Event Validation

 

2. Create an Export.

When you create an export, you define the output file name and the output file location. The location must reside within the \app\export folder where the Shop Floor Time application is installed.

Form to Use: Export

 

3. Configure the data output.

By configuring the export, you format the output of the data that can be extracted from system tables. For example, you create a fixed length or comma separated values file. You can configure how you want the header, detail, and trailer to look in your output. The available output formats are CSV, CSV with Header, and Fixed Length.

Form to Use: Export Definition

 

4. Configure the data output format.

Note: This step is not required.

You can modify the format of the output data. For example, you can determine the output of positive and negative values.

Form to Use: Field Function

 

5. Configure the EXPORT service instance.

Note: This step is only required if you want to run the export via the Service Monitor. You can also run the export via the Run Exports button on the Exports form.

Form to Use: Service Instance

To configure the service:

  1. Click Main Menu > Configuration > Services > Service Instance.

  2. Select Export Service from the Process Name filter and click Find.

  3. Click the Service Parameters tab.

  4. In the MODE field, select TODAY or DATE_RANGE. The default value is TODAY, which causes the service to export all unprocessed records (in other words, records with a status of Ready) up until today. DATE_RANGE allows you to run the service for a specific date range.

  5. If you select DATE_RANGE in the MODE field, you must select/enter a START DATE. The START DATE specifies the first day that the service should include in the instance. You must also select/enter an END DATE. The END DATE specifies the last day that the service should include in the instance.

  6. Select an Export Name in the EXPORT_DEFINITION field. This identifies which Exports record the instance should run for.

  7. Select an EXPORT_CREATOR. This identifies who the export belongs to. The default value is Admin User. The Export creator is the only person who can view the output file in the Output form.

  8. Select the Charge Types that will be exported. To include a Charge Type in the output file, move it from the Available column to the Selected column. The items in the Selected Column will be processed by the EXPORT service.

  9. If you only want to export records from a specific facility, select it from the FACILITY_CODE drop-down list. Otherwise, records from all facilities will be exported.

  10. Click Save.

  11. To schedule the service to run on a regular schedule, click the Service Schedule tab.

Note: It is not possible to select previously exported records in the Service Parameters. If you want to process previously exported records, go to the Action form and select the event that contains the data you want to export. Select the READ_ACTION record on the Process Status tab and click Re-Process in order to set the status to Ready.

 

Run the Action Export

You can run an export via the Run Export button on the Exports form, or via the EXPORT service in the Service Monitor. Both options are described below.

 

Run Export via Export Button

  1. Click Main Menu > Payroll > Exports.

  2. Select an Export Name from the Export Name drop-down list (for example, the Export Name you created in Step 2 in configuration) and click Find to display the export record.

  3. Enter an Output Name. This is the identifying name of the export instance.

  4. If you want to include records that have not yet been exported, select the New Records check box.

  5. If you want to include previously exported records, select the Prev Exp Records check box.

  6. If you selected the Prev Exp Record check box, use the Prev Exp Start and Prev Exp End date fields to specify the dates when the records were previously exported.

  7. Modify the Start Date and End Date of the Parameter Name “Action” as necessary.

    When you run an action export, the Parameter Name column in the Exports form displays one option, “Action.” The Start and End Date of this parameter indicates the date range of the records to include in the export.

  8. Click Run Export on the toolbar.

 

Run Export via Service Monitor

Note: Before you run the service, ensure that the Export Service parameters are configured. See Step 5 in the Configuration section.

The EXPORT service extracts data from records in the Action table that have the following:

  1. A READ_ACTION record on the Process Status tab.

  2. The READ_ACTION record is set to Ready (in the Process Status field).

To run the service:

  1. Click Main Menu > Administration > Services > Service Monitor.

  2. Click the Filter button to display the filter field.

  3. Select Export Service in the Process Name field and click Find.

  4. Click Schedule Immediately. A status message will display on the form (Successful or Error).

The export is available on the Output tab, but will display only to the person identified in the EXPORT_CREATOR field on the service parameters tab. The output is also available in the \app\export location to anyone that has access to that location.

 

Download/View/Save the Action Export Data

You can download, view, and save the output data via the Output tab in the Exports form. The steps listed below are also available in the Output section.

  1. Click Main Menu > Payroll > Exports.

  2. Navigate to the Output tab.

  3. Click the Filter button and use the filter fields to find an output file.

  4. Select the record and click Download on the toolbar. You can open or save the file.