Altair® Monarch® Server

 

DataPrep Elements

DataPrep elements in the Process Designer tool are used for executing data preparation operations upon process inputs. These elements consist of Workspace and DataPrep Export.

Note: A Hub element can be added between a Workspace element and a DataPrep Export element to process multiple input files individually or by group on a workspace.

The table below specifies functionality of the DataPrep group elements.

Element Name

Description

Properties and Comments

Workspace

Performs operations upon process inputs.

  • Name — name of the graphic element.

  • Workspace Path — path to the required input file location.

Actions to select the workspace path:

    1. Click the Browse button to open the Browse dialog.

    2. Select among server library.

    3.  If you have slow data source connections, you can select the Delay data source connections validation check box. In this case, you can cancel the validation of Data source connections when loading workspace by clicking the Cancel button in the Properties panel. You can also cancel the validation of Data source connections when opening a process which contains a workspace.

    4. Click OK.

  • Load Plans — the list of available export load plans, including:

    • Provider type. This shows the type of provider.

    • File Name. If your Workspace input is a file of a certain format, you can substitute it with the file from the process input. Do the following. For the PDF Report, Text Report and Delimited Text file formats add a File input item to your visual process design form. For Microsoft Access and Microsoft Excel formats add a Database input item. Connect this item with your Workspace element. Set up the Input path for your File input or Database input. Then in the File Name drop-down list for your load plan select a File input or a Database input option.

    NOTE: When the Database Input option is selected, the table name automatically changes to the table name from the database input. The table name may be changed manually.

    NOTE: Database Input is required for Excel formats and must include the extension even with wildcards.

  1. NOTE: Additional options are available for Excel Worksheet Design. They are detailed here.

    • Source. If the workspace input is a database, then this field displays the database name. If the source type is SQL Server, ODBC, or OLE DB, there is the possibility to rewrite/edit the Database Data Source. To do so, click the Edit Table Info button, and then edit the Connection String, Table, etc. If the plugin is Google Analytics, the settings can be changed by clicking the Edit Table Info button. In the Google Analytics window, edit the Service Account Email, Profile ID, Start Date, End Date, etc. If the plugin is Oracle, edit the settings by clicking the Edit Table Info button. In the Oracle window, edit the connection type and settings (including host name, port, service name, user ID, password, etc.). Tables and views, as well as queries, can also be edited from this window.

    NOTE: Additional options for SQL Server, OLE DB, and Oracle source types are provided below.

    • Change History — additional operations to be executed with the input. Click the Add Change List button and select a change list from the Server Library to add to the workspace. You can also add new item to Server Library via the Add Change List dialog box. Upon selecting a change list, you will see a Change History list. You can add multiple change lists via the little Add Change List button on the right, or remove all change lists via the Reset Change History button. You can also disable certain changes to your workspace by clicking the respective Undo button (all the following change items will be disabled as well). Click the Redo button to enable the changes back. Non-applicable changes appear as disabled and accompany with a warning sign. You can remove such changes via the Delete button.

DataPrep Export

Exports data from data preparation workspace.

  • Name — name of the graphic element.

  • Load Plan to be Exported — select a load plan for exporting.

The user can select several load plans for the export by ticking their corresponding checkboxes. To export all load plans, select the All Load Plans check box.

  • Export Destination — path to required export file.

  • Export Type — the type of export file. Further settings depend on the type of file and are described as advanced options below.

Note: You may also use the naming macros to name the exported files and destination folder. To do this, click the Insert Macro icon (Insert Macro icon) and select the naming macros from the drop-down list.

NOTE: The Input File Name macro is available to specify one or more input file names. If there are several inputs in a Load Plan (Join/Union), the names of the export files will contain a combination of these input files. When the Input files are processed by group, the Input File Name macro will only hold the first file name.

 

Advanced options for Workspace element

Additional options for excel worksheet design

  1. When dealing with multiple inputs, the Parse inputs for sheet names option becomes available. Select the check box if you want to parse the inputs for specific sheets.

    • When selected, changes can be applied to the following:

      • All worksheets

      • First sheet

      • Last sheet

      • Selected Sheet by Name

    • When not selected, changes can be applied to the following:

      •  Selected Sheet by Name

      • Selected Sheet by Number

  2. When dealing with only one input, modifications can be applied to the following:

      • All worksheets

      • First sheet

      • Last sheet

      • Selected Sheet by Name

 

Additional options for SQL Server, OLE DB, and Oracle source types

  1. In the column list in the SQL Server/OLE DB/Oracle dialog box, select the column to use.

Select from the following options:

    • Aggregate: Select the check box if the column data should be aggregated (i.e., grouped together) and then select the aggregation method to apply from the drop-down menu. The following aggregation methods are available:

      • Sum: Applies to numeric data; returns the total value of all values in the column

      • Count: Applies to numeric data and dates; returns the number of entries in the column

      • Min: Applies to numeric data and dates; returns the lowest value in the column

      • Max: Applies to numeric data and dates; returns the highest value in the column

      • Group by: Applies to numeric data, dates, and text; returns grouped values and is often used with functions such as SUM and COUNT.

    • Apply Filter: Select the check box if the column data should be filtered and then select the filter method to apply from the drop-down menu. Enter the filter value to use in the corresponding Filter Value box.

The following filter methods are available:

      • Equalto: Applies to numeric data, dates, and text; returns all values that contain the specified filter value

      • NotEqualTo: Applies to numeric data, dates, and text; returns all values except those that contain the specified filter value

      • GreaterThan: Applies to numeric data and dates; returns all values that are greater than the specified filter value

      • GreaterThanEqual: Applies to numeric data and dates; returns all values that are greater than or equal to the specified value

      • LessThan: Applies to numeric data and dates; returns all values that are less than the specified filter value

      • LessThanEqual: Applies to numeric data and dates; returns all values that are less than or equal to the specified filter value

      • Contains: Applies to text; returns all values that contain the specified filter value

      • StartsWith: Applies to text; returns all values that start with the specified filter value

      • EndsWith: Applies to text; returns all values that end with the specified filter value

Advanced options for DataPrep Export element

Additional options for altair knowledge studio file types

  1. In the When output file exists drop-down menu, select Overwrite to substitute files with the same file names.

 

Additional options for CSV file typeS

  1. In the When output file exists drop-down menu, select Overwrite to substitute files with the same file names.

  2. Delimiter sets the separator symbol between columns. The delimiter characters available are comma, semicolon, tab, pipe, and space. Choose Other to specify a different character.

  3. Qualifier sets the wrapper symbol type.

  4. Choose the Encoding Type to apply to the CSV file. The following options are available:

    • Code Page

    • UTF-8

    • UTF-16LE

    • UTF-16BE

  1. Set the Code Page to apply to the CSV file. The following options are available:

  • OEM United States  

  • Greek (DOS)

  • Baltic (DOS)  

  • Western European (DOS)  

  • Central European (DOS)  

  • OEM Cyrillic  

  • Turkish (DOS)  

  • Portuguese (DOS)  

  • Icelandic (DOS)  

  • French Canadian (DOS)  

  • Nordic (DOS)  

  • Cyrillic (DOS)  

  • Greek, Modern (DOS)  

  • Japanese (Shift-JIS)  

  • Central European (Windows)  

  • Cyrillic (Windows)  

  • Western European (Windows)  

  • Greek (Windows)  

  • Turkish (Windows)  

  • Baltic (Windows)  

  • Cyrillic (KOI8-R)  

  • Cyrillic (KOI8-U)

  • Western European (ISO)  

  • Central European (ISO)  

  • Latin 3 (ISO)  

  • Baltic (ISO)  

  • Cyrillic (ISO)  

  • Greek (ISO)  

  • Turkish (ISO)  

  • Estonian (ISO)  

  • Latin 9 (ISO)  

  • Japanese (JIS)  

  • Japanese (EUC)

 

  1. Select the Include Column Header check box to include headers in your file.

  2. Click Summary Export to specify the summary that you want to export.

In the Summary dialog box that displays,

    • select the summary to export from the Summary drop-down menu,

    • select the active measure to apply to the summary from the Active Measure drop-down menu,

    • select the drill level to apply to the summary from the Drill Level drop-down menu.

NOTES

Drilling up and drilling down is to collapse and expand a summary data set, respectively.

A lower drill level (e.g., Level 1) results in fewer columns in the exported table.

Click Ok.

 

ADditional options for fixed text file types

  1. In the When output file exists drop-down menu, select Overwrite to substitute files with the same file names.

  2. Click Column sizes to adjust the sizes of the columns in your file.

 

additional options for microsoft excel file types

  1. In the When output file exists drop-down menu, select Overwrite to substitute files with the same file names.

  2. Enter your Table Name.

NOTE: Click the Existing Tables button () to display the names of the tables in the export file when exporting to a file that already exists. Select the desired table name.

  1. In the When table exists drop-down menu,

    • select Overwrite to substitute the data table,

    • select Append to append to new rows,

    • select Update to update existing rows,

    • select Update and append to update existing rows and append new ones.

  1. When Overwrite, Update, Update and append, or Skip is selected, select the Suppress column header row check box if you prefer to hide the column headers in the exported Exel file.

  2. Click Summary Export to specify the summary that you want to export.

NOTE: If Summary Export is selected, mapping and the Do not match column names checkbox are not available.

In the Summary dialog box that displays,

    • select the summary to export from the Summary drop-down menu,

    • select the active measure to apply to the summary from the Active Measure drop-down menu,

    • select the drill level to apply to the summary from the Drill Level drop-down menu.

NOTES

Drilling up and drilling down is to collapse and expand a summary data set, respectively.

A lower drill level (e.g., Level 1) results in fewer columns in the exported table.

Click Ok.

  1. When Append is selected, modify the following:

    • Suppress column header row: Column headers in the exported Excel file are hidden.

    • Do not match column names: Columns from potentially different tables are left aligned regardless of column names or data types.

Additional options for Microsoft Access file types

  1. In the When output file exists drop-down menu, select Overwrite to substitute files with the same file names.

  2. Enter your Table Name.

NOTE: Click the Existing Tables button () to display the names of the tables in the export file when exporting to a file that already exists. Select the desired table name.

 

  1. In the When table exists drop-down menu,

    • select Overwrite to substitute the data table,

    • select Update to update existing rows,

    • select Update and append to update existing rows and append new ones.

  1. When Update or Update and append is selected, modify the following:

    • Column Mapping: Maps the export column to the destination column.

    • When update match not found: Select the Export to delimited text file check box to export the unmatched record(s) to a delimited text file when updating existing rows in a table if a matching row is not found in the destination table.

  1. When Overwrite, Append, or Skip is selected, modify the following:

    • Export all: Exports all the columns in the export table.

    • Column Mapping: Maps the export column to the destination column.

 

Additional options for ALTAIR PANOPTICON designer file types

  1. In the When output file exists drop-down menu, select Overwrite to substitute files with the same file names.

  2. Enter your Table Name.

NOTE: Click the Existing Tables button () to display the names of the tables in the export file when exporting to a file that already exists. Select the desired table name.

 

  1. In the When table exists drop-down menu,

    • select Overwrite to substitute the data table,

    • select Update to update existing rows,

    • select Update and append to update existing rows and append new ones.

 

Additional options for Qlik FILE TYPES

  1. In the When output file exists drop-down menu, select Overwrite to substitute files with the same file names.

 

Additional options for Tableau file types

  1. In the When output file exists drop-down menu, select Overwrite to substitute files with the same file names.

Note: Export to Tableau is performed in .tde format.

  1. To publish the Tableau export file to Tableau Server, click the Publish to Tableau Server check box under the Publish to Tableau Server options. This displays the following Tableau Server settings.

    • Data Source Name: The name of the Data Source on the Tableau Server.

    • Site: The address of the data source.

    • Path to TABCMD: The route to the executable file of the TableauServerTabcmd application.

    • Server Address: The address of the Tableau Server.

    • Username: The login name for the Tableau Server.

    • Use Password File: Allows the use of .txt file with the password.

    • Password: The password to the Tableau Server (if the option Use Password File is enabled, it allows to specify the path to the Password File).

    • Proxy Address: The address of the proxy server (in HOST:PORT format).

    • Publish Type: Allows to specify an action for the Data Source:

      • Overwrite Data Source: Overwrites the data in the Data Source with the data from the export table (date modified is changed);

      • Replace Data: Replaces the data in the Data Source with the data from the export table (date modified is not changed);

      • Append Data: Adds data from the export table to the end of the Data Source table.

 

Additional options for OleDb and ODBC file types

  1. Type in the Connection String or select it via the Data Link Wizard with all the required data.

  2. Select the Include password check box to input a password.

  3. Select the Bulk Behavior check box to enhance export performance.

NOTE: This option is applicable for Oracle Database and Microsoft SQL Server OLEDB providers only.  

  1. Select the Use Transaction check box to revert the export via rollback if an error occurs during the export.

    • The Use Transaction check box is only available when the Bulk Behavior check box is selected.

    • Selecting this option will affect the performance of the table export and may require a large amount of system resources, especially for the target destination. Therefore, make sure to test this option first and then make the necessary adjustments.

    • The transaction is valid for the export operation only and not for the overall process.

  2. Enter your Table Name.

  3. In the When table exists drop-down menu,

    • select Overwrite to substitute the data table,

    • select Update to update existing rows,

    • select Update and append to update existing rows and append new ones.

  1. When Update or Update and append is selected, modify the following:

    • Click Column Mapping to map the export column to the destination column.

    • When update match not found: Select the Export to delimited text file check box to export the unmatched record(s) to a delimited text file when updating existing rows in a table if a matching row is not found in the destination table.

  1. When Overwrite, Append, or Skip is selected, modify the following:

    • Export all: Exports all the columns in the export table.

    • Click Column Mapping to map the export column to the destination column.

  

 

Additional options for Microsoft Power BI file types

  1. Enter your Table Name.

  2. Select a value from the When table exists drop-down list.

  3. Click the Set Power BI Login Data button to open the Power BI Login form.

Note: If the data on logged in user has been already received, then the button name becomes Update Power BI Login Data.

 

Additional options for IBM Cognos Analytics file types

  1. Enter your Table Name.

  2. Select some value from the When table exists drop-down list.

  3. Type the value of the Cognos Analytics server URL to the Server Url field.

  4. Click the Test button to get all namespaces.

  5. Select the corresponding Namespace.

  6. Type the correct Username and Password.

  7. Click the Check Credentials button to validate credentials.

Note: If you want to log in anonymously, select the Is Anonymous check box.

 

Additional options for SAs transport format file types

  1. In the When output file exists drop-down menu, select Overwrite to substitute files with the same file names.

  2. Enter your Table Name.

NOTE: Click the Existing Tables button () to display the names of the tables in the export file when exporting to a file that already exists. Select the desired table name. The table name is limited to 8 characters in length.

 

Additional options for JSON file types

  1. In the When table exists drop-down menu,

    • select Overwrite to substitute files with the same file names,

    • select Add data to add the new data to the existing one,

    • select Skip to stop the export operation from overwriting an existing data.

Automator supports the following plug-ins

Datawatch.DataPrep.Engine

  • PDF Report

  • Text Report

  • Delimited Text

  • JSON

  • XML

  • HTML

  • Microsoft Access

  • Microsoft Excel

  • ODBC

Panopticon.DataDirect

  • DB2

  • Hadoop Hive

  • Cloudera Impala

  • Informix

  • MonogoDB

  • MySql

  • Oracle

  • PostgreSQL

  • Amazon Redshift

  • Salesforce

  • SqlServer

  • SybaseIQ

  • Teradata

Panopticon.CloudantPlugin   

  • IBM Cloudant

Panopticon.DatawatchPlugin

  • Monarch Server - Content

Panopticon.ODataPlugin

  • Odata

Panopticon.SplunkPlugin

  • Splunk

Panopticon.BusinessObjectsUniversePlugin

  • Business Objects Universe

Panopticon.GoogleAnalyticsPlugin

  • Google Analytics