1. Class export

    Article: AN0002143Updated: 12.05.2020

    There are detailed settings of an export from a class displayed on this page.


    Icon Description
    Return to the list of exports.
    Creation of a new export.
    Saving changes in the export.
    Deletion of the export.
    Starting export (without saving and taking into account possible changes in the export).
    Displaying history of export use.

    TAB - Basic properties

    Section: Basic properties

    • Code - Export identifier, which is used by export and import of model metadata between various application instances.
    • Name - Export name.
    • Note - Description of the export.
    • Enabled - Information if the export can be used.
    • Integration export - Information if the export start is conditioned by enabling integration interfaces on page Information about application.

    Section: What to export

    • Model - Selection of the model containing class, that shall be exported.
    • Exported class - After selecting model it is necessary to select class of the model that shall be exported.
    • Exported query - If class is not selected it is necessary to select query from the model that shall be exported.
    • What to export - Defines type of records that shall be exported from the class.
      • Only active records - only records, that are not deleted, are exported.
      • All the records - all the records (both not deleted and logically deleted) are exported.
      • Only deleted records - only logically deleted records are exported.
    • Columns
      • After selecting model and the class/query the page is reloaded and list of all the attributes (including system ones) appears.
      • In the column Export check those columns that you want to export.
      • In the column Code we can state the code of the column, that will be used in the header of the exported file. If we do not use the field, code from the class will be used.
      • In the column Name we can select by attributes of the reference data type, wheather we want to export Id (Id of the record from the refered class) or Name (Short description of the record we refer to).
        • In the columns Text before and Text after we can define the text that should be added to the exported values.

    Section: How to export

    • Type - Selection of the file type that shall be used for the export.
    • Encoding - Code set that should be used for the export.
    • CSV separator - Defines value separator in the records of the exported file.
    • Include column headers - Defines if the first row in the csv file should include names of exported attributes/columns.
    • Replace row ends with sign - Defines if possible signs of the row end shall be replaced by another sign. This is important in case when values in the records can contain sign of the row end (e.g. by attribute of the long text type). If the row end sign is not replaced, one record would be divided into more rows in the CSV file according to the number of the row end signs in the text attributes of the exported record.
    • New sign of the row end - Enables to define a new sign of the row end, if "Replace row ends with sign" was selected.
    • Put text in quotation marks - Defines if the values of the record attributes shall be exported in quatation marks.
    • XSLT transformation - Enables to define XSLT transformation.

    Section: What to perform with the export

    • What with import - Defines if the exported file shall be saved on the disk or returned on the page Export data.
    • Target folder - Defines the path on the server to which the exported file shall be saved.
    • File name - Defines the name of the exported file.

    Section: Audit records

    • Created by - User that created the record (export)
    • Created on - Date and time of the record (export) creation
    • Last changed by - User that made the last modification of any data in the record (export)
    • Last changed on - Date and time of the last change of the record (export)

    TAB - Roles and display

    Section: List of roles

    • Role - Definition of the access right type to the given export for roles working with the model. Access rights can be assigned only to roles enabled for the model, to which the export belongs to.
    • Operations - Definition of possible activities for the selected role:
      • Display log - user is authorized to display log of export
      • Start export - user is authorized to start the export

    TAB - Notifications

    Section: Notifications

    • When to send - Defines when the notification should be sent.
    • Notification - Definition which notification shall be sent.
    • Distribution list - Definition to which distribution list the notification shall be sent.
    • Enabled - Defines wheather the notification shall be sent.
    • Export as an attachment - Defines whether the exported file should be attached to the notification email.

    TAB - Scripts

    Section: Scripts

    • Start before export start - Script, that shall be executed before start of the export.
    • Start after export end - Script, that shall be executed after end of the export.