• Contents
  • Index

Altair® Monarch® Server

 

Export Elements

Export elements in the Process Designer tool are sets of instructions how the parsed data is exported by Automator.

The table below specifies functionality of the Export group elements.

 

Element Name

Description

Properties and Comments

Hub

Defines in what way multiple input files should be grouped and the order in which multiple input files will be processed

  • Name — name of the graphic element.

  • File inputs processing:

    • Group — all input files are processed in a group

    • Individually (Export Only) — each input file is processed separately by the following element types: Report Export, Table Export, Summary Export, DataPrep Export, Verify Model, and Verify Workspace

    • Individually – each input file is processed by all elements after the Hub separately

    Note: When the Individually option is selected, the Process individual inputs in parallel check box is shown. Once this check box is selected, the icon of the Hub element changes from  to . This is because all actions after the Hub element are performed in parallel, meaning all actions are started consecutively and completed consecutively.

    The same change can be seen for the export elements when the Individually (Export Only) option is selected. For example,  becomes .

    As for the Individually option, the same change in the appearance of icons is observed not only in the export elements but also in the distribution and script elements.  

    Note that only 10 inputs can be processed in parallel under the Individually setting because the default Max Threads setting in the Automator Dispatcher Service Host is 10. This value can be changed in Configurator. For more details about the Max Threads setting, refer to the Configurator Guide ("Configuring Servers") in the Monarch Server Installation Guide.

 

  • Order in which to process multiple files:

    • No order — input files are processed in random order

    • Alphabetical — input files are processed alphabetically according to their names

    • Old First — input files are processed in chronological order, i.e., from oldest files to newest ones

    • New First — input files are processed in reverse chronological order, i.e., from newest files to oldest ones

Report Export

Exports data to a report (text, PRF, or PDF format)

  • Name — name of the graphic element.

  • Path — path to the required export file location.

Actions to select export file path:

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

  2. Select the data source type in the Source Type drop-down list (currently, Local, Web, or Named Paths).

  3. Depending on the selected data source type, specify the other parameters:

    • For the Local type: Location of the export file and Path to this file using the suggested folder directory;

    • For the Web type: Address which is a URL of the export file;

    • For the Named Paths type: Named Paths and path to the export  file using the Named Path Content box (use search capabilities if needed).

  4. Click the OK button.

Note: You may also use 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.

  • When output file exists — if a file of the specified name and type already exists in the export location, select one of the following options:

    • Overwrite — overwrites the data of the existing output file with the data in the current export file.

    • Add — adds the export file data to the end of the specified file.

    • Skip — is used for Automator project exports, this allows you to create a project export which will skip the export operation if a file of the same name already exists. This is useful for automated operations, where you may not want to overwrite a file that already exists.

If the export file has PRF or PDF file type, the ADVANCED OPTIONS appear.

Detailed information on the Advanced options (both for PRF and PDF) is specified below this table.

Table Export

Exports table data

  • Name — name of the graphic element.

  • Filter — filter to be applied to the table. You can select the All filters option to apply all of the available filters or the No filter option to apply none of them. If you choose the All filters option, you also need to specify the Automatic Naming options:

    • By files — produces a file for each filter (set as default)

    • By tables — produces a table for each filter

  • Sort — sorting order to the data you are exporting, it is selected from the drop-down list.

  • Output type — defines how the output will be produced, includes two options:

    • File system

    • Database

Note: If you select File system, you must specify File options. If you select Database, you must specify Connection options. See description of Connections options and File options below this table.

Detailed information on the Connection options and File options is specified below this table.

Summary Export

Exports summary data

Note: Settings of the Summary Report element are disable if the model is not specified or does not have any summary.

  • Name — name of the graphic element.

  • Summary — summary to be exported. You can select the All summaries option to export all of the available summaries. If you choose the All summaries option, you also need to specify  the Automatic Naming option:

    • By files — when exporting multiple summaries, a file is exported for each summary, and the files are named according to the summary names.

    • By tables — when exporting multiple summaries, a table is produced in the export file for each summary.

  • Drill State — you can select the following drill states:

    • Most detailed — exports the summary in the most detailed (i.e., drilled down) drill state.

    • Current — exports the summary in the current drill state.

  • Measure — is used to export summary that contains multiple measures. You can select the following options:

    • Active measure or measure grouping — exports only the current measure or measure grouping.

    • All measures as separate exports — exports all of the measures as separate exports.

Note: If you choose this option, specify the desired Automatic Naming setting, either By files or By tables.

  • Split — select the Each distinct value of the first key makes a separate file or table check box to have Automator split the summary export according to each value change in the first key (i.e., the leftmost one).

Note: If you choose this option, specify the desired Automatic Naming setting, either By files to have each distinct value of the first key make a separate file, or By tables to have each change of it make a separate table.

  • Filter — filter to be applied to the summary. You can select the All filters option to apply all of the available filters or the No filter option to apply none of them. If you choose the All filters option, you also need to specify the Automatic Naming option:

    • By files — produces a file for each filter (set as default)

    • By tables — produces a table for each filter

  • Sort — sorting order to the data you are exporting, it is selected  from the drop-down list.

  • Output type — defines how the output will be produced. You can select the following options:

    • File system

    • Database

Note: If you select File system, you must specify File options. If you select Database, you must specify Connection options.

Detailed information on the Connection options and File options is specified below this table.

 

Advanced options

Advanced options for PRF

  1. Encryption: Password-protects the portable report.

    • Select the Apply encryption check box.

    • Press the Change… button and specify a password for the PRF via the Change PRF Password dialog.

  1. Compression: Select one of the following compression options:

    • None: Specifies no compression of the portable report contents.

    • Medium (Fast): Compresses and decompresses slightly faster than the Maximum compression option, and yields a compression ratio of approximately 5:1. This compression ratio may vary depending upon the density of information in your reports.

    • Maximum: Compresses and decompresses slightly slower than the Medium compression option but typically yields a compression ratio of 10:1. This compression ratio may vary depending upon the density of information in your reports.

Note: If you plan to distribute the portable report you should compress it by selecting the Medium or the Maximum option.

Connection options

  • Connection String

    • Enter the connection string manually, or

    • click the Browse for ...  button and select Data Link Wizard to open the Data Link Wizard window. For more information, see Connection Type Wizard.

    • click the Browse for ...  button and select Connection Definitions to open the Connection Definitions window and select from the existing connection definitions. For more information, see Connection Definitions.

After you made your choice, the Connection string field displays the connection string for the data you want to connect to.

  1. Select the Include Password check box if your connection requires password. For security reasons, the password is displayed here.

 Note: Passwords are saved in an encrypted format using 1024-bit encryption strength.

  1. Select the Bulk Behavior check box to enhance table 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.

NOTE:

  • 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.

  1. Test Connection String: Tests whether or not the data link was successful (i.e., to test whether you can connect to the specified OLE DB or ODBC provider). If the connection is successful, the Test Connection Succeeded message is displayed.

File options

  • Destination

    • Path to the desired export file if File-auto-name by is None.

    • Path to the desired export folder if File-auto-name by is Filter, Summary, Measure titles or The first key value.

To select Destination:

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

    1. In the Source Type list, select the data source type from the following: Local, Web or Named Paths.

    2. Depending on the data source type specify other parameters:

      • Local: Specify export  file location and path to it;

      • Web: Specify export  file address;

      • Named Paths: Select the appropriate named path and select the export file path from the list of displayed in the Named Path Content box.

    3. Click the OK button.

  1. File auto-name by

    • None: Select if you want export produces only one file;

    • Summary: Select if you want export produces a file for each summary (this option available only if “All Summaries” filter is selected);

    • Measure titles: Select if you want export produces a file for each measure title (this option available only if “All measures as separate exports” filter is selected);

    • The first key value: Select if you want export produces a file for each key value (this option available only if “Each distinct value of the first key makes a separate file or table” filter is selected);

    • Filter: Select if you want export produces a file for each filter (this option available only if “All Filters” filter is selected).

  2. File naming: Name of the desired export file (available only if File-auto-name by is Filter, Summary, Measure titles or The first key value).

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.

  1. Export file type: Select type of export file.

The following options are available:

    • Adobe PDF (*.pdf)

    • Panopticon Designer Data Source (*.dwx)

    • dBase (*.dbf)

    • Delimited Text

    • Fixed Text

    • Microsoft Access ACCDB (*.accdb)

    • Microsoft Access MDB (*.mdb)

    • Microsoft Excel XLS (*.xls)

    • Microsoft Excel XLSX (*.xlsm)

    • Microsoft Excel XLSX (*.xlsx)

    • QlikView QVX (*.qvx)

    • SAS Transport Format (*.xpt)

    • Tableau Data (*.csv)

    • Tableau Data Extract (*.tde)

    • Web File (*.htm)

    • Web File (*.html)

    • XML File (*.xml)

NOTE: When the dBase, Microsoft Access ACCDB, or Microsoft Access MDB export file type is selected, the Export Behavior drop-down menu becomes available. The available options are:

      • Default - Use this option for all new processes.

      • ACE DAO - Use this option for better performance for large datasets. All exports in the system with this behavior will be executed concurrently. ACE OleDb will be used as fallback when output tables exist option is "Update existing rows" or "Update existing rows and append new.”

      • ACE OleDb - Use this option for better reliability. This behavior is slower than ACE DAO, but it allows to handle exports in parallel.

 

  1. When output file exists: If a file of the specified name and type already exists in the export location, select one of the following options:

    • Overwrite: Overwrites the data of the existing output file with the data in the current export file.

    • Add: Adds the export file data to the end of the specified file.

    • Skip: Used for Automator project exports, this allows you to create a project export which will skip the export operation if a file of the same name already exists. This is useful for automated operations, where you may not want to overwrite a file that already exists.

Table options

  • Table auto-name by:

    • None: Select if you want export produces only one table;

    • Summary: Select if you want export produces a table for each summary (this option available only if All Summaries filter is selected);

    • Measure titles: Select if you want export produces a table for each measure title (this option available only if the All measures as separate exports filter is selected);

    • The first key value: Select if you want export produces a table for each key value (this option available only if the Each distinct value of the first key makes a separate file or table filter is selected);

    • Filter: Select if you want export produces a table for each filter (this option available only if the All Filters filter is selected).

  • Table name: Displays the current name of the table. You can assign a new table name by entering it here.

  • Existing Tables: Press the Existing Tables button (Existing Tables button) to display the names of the tables in that file when exporting to a file that already exists.

  • When table exists options:

    • Overwrite: Overwrites the data in the existing table with the data in the export table.

    • Append: Adds the export table data to the end of the selected existing table.

    • Update: Updates the existing rows in a table.

    • Update and append: Updates existing rows in a table and appends new rows to it.

Note: In the When update match not found setting, click 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, particularly if a matching row is not found in the destination table.

    • Skip: Skips the export operation if a table of the same name already exists. This is useful for automated operations, where you may not want to overwrite a table that already exists.

PDF options (displayed if export file is PDF)

  • Open Password options:

    • Apply open password: Password-protects the PDF file.

    • Change…: Displays the Change PDF Export Open Password dialog. Use this dialog to specify the password that must be supplied to open the PDF file.

  • Permissions options:

These options let you restrict the permissions available to users of the PDF file.

    • Apply permissions: Specifies permission options for the PDF file.

    • Change…: Displays the Change PDF Export Permission Password dialog, with which you can specify a password for the exported PDF file(s).

    • Printing allowed: Allows the PDF file to be printed.

    • Content extraction allowed: Allows copying (e.g., cut and paste) of the PDF file's content.

    • Editing allowed: Allows editing of the PDF file.

    • Annotation (comments) allowed: Allows comments to be added to the PDF file.

Note: If you do not specify PDF file permissions, users will have full access to it.

  1. Encryption options:

Select one of the following encryption options.

Note: One (or both) of the passwords must be applied to enable encryption.

    • RC4 (128-bit): Encrypts the PDF file with RC4 encryption. WARNING: This option is not recommended for extremely confidential data. Use the AES option instead.

    • AES: Encrypts the PDF file with the Advanced Encryption Standard. Note: If you choose this encryption method, Adobe Acrobat 7 or higher must be used to open the PDF file, as earlier versions of Acrobat do not support AES encryption.

Excel advanced options (displayed if export file is XLS/XLSX)

The following options are available for Summary Exports:

  • Embed the Page Setup header in the Worksheet Title: Click this option to make the Summary page header (defined using the Page Setup dialog) part of title of exported Excel Worksheet.

  • Include Outline to Enable Drill Up/Down in Excel: Click this option to include an outline in the exported Excel worksheet. The outline will allow you to drill up and down in Excel.

  • Include Formulas to Facilitate Editing in Excel: Click this option if you want Automator to attempt to translate subtotal and grand total calculations into Excel formulas in the exported Excel file.

  • Conditional Formats implement measure coloring rules rather than as fixed formats...Use conditional formatting if required conditions are fewer than: This option implements Conditional Formatting Rules in the exported Excel file, as long as the number of rules would not exceed the specified amount. The Conditional Formatting feature in Excel provides a mechanism to modify the display attributes of a cell based upon the value of that cell. Automator leverages this feature by creating conditional formats from the rules specified on the Coloring and Limits dialog of a measure's properties. Depending upon the rules defined for each measure, up to 3 conditional formatting rules can be generated for each value of an exported measure.

The following option is available for XLS Table Exports:

  • Filter:

    • Add AutoFilter drop down lists to column labels in the Table: Select this check box to enable Excel's AutoFIlter feature so that it is ready and active upon opening the exported Excel file.

The following option is available for XLSX Table Exports:

  • Filter:

    • Add AutoFilter drop down lists to column labels in the Table: Select this check box to enable Excel's AutoFIlter feature so that it is ready and active upon opening the exported Excel file.

  • Pivot:

    • Include Pivot Table sheet: This option is available for Table exports to XLSX files. To modify the pivot settings, click Pivot Table.

      • Pivot Table Settings dialog box

        • Fields tab: Use this tab to set the desired pivot field filters, columns, rows, and values.

        • Options tab: Use this tab to specify the Pivot Table name, corresponding action if the Pivot Table exists, style, and grand total parameters.

Publish to Tableau Server options (displayed if export file is TDE)

This option allows to publish Tableau export to Tableau Server.

  • Publish to Tableau Server: Select this option to display 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.