...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
| Table of Contents |
|---|
Introduction
The custom export functionality is intended for creating an export template file with a set of dynamic and static properties. Once created, the export template is delivered to a customer who can execute it on the real data.
...
Go to the Setup ribbon tab and click the General Codes button.
On the Structure pane, click the Custom Export code category to expand it and select Export.
Click the New button in the Actions group of the Manage ribbon tab. The General Code Editor (Export) dialog then appears:
Within the dialog, create an export file by filling in the fields below:
Enter a Code (mandatory field), a unique alpha-numeric APM code.
In the Text field, indicate the name of an export file and its alternative name, if needed, in the Alternative field.
In the Sort field, define the order number of a record (where 0 means the first record in the list).
In the Template sector, create groups and sections. For more information, see Create Groups, Sections, Fields.
In the Parameters sector, define the export file parameters. For more information, see Define Parameters.
In the Export Format sector, select the format of the file to be exported. For more information, see Set File Format.
...
Property | Description |
Date-Time Format | The property is available for the DateTime type. Set the format in which you want to display the date and time. For example: yyyy/mm/dd, dd.mm.you. |
Sign Position | The property is available for the Integer and Float field types. Specify the position of a sign (plus or minus) by selecting one of the options:
|
Visible Sign | The property is available for the Integer and Float field types. Specify whether the defined sign (plus or minus) is to be available in the output file. For this, select one of the options:
|
Fractional Decimal Count | The property is available for the Float field type. Enter the number of digits you want to be displayed to the right of the decimal point. |
Show Fractional Part | The property is available for the Float field type. Choose whether you want to display the decimal part of a numeric value by selecting one of the options:
|
Decimal Separator | The property is available for the Float field type. Enter a decimal separator that is used to separate the integer part from the decimal part. |
Type | The property is available for all the fields. Define the type of the data source in a field by selecting one of the options: ftDataField, ftParamField. If ftParamField is set for the field, then a user of an export file will be able to enter a value in the dialog form, and this value will be as a data source. The engine automatically creates the corresponding input parameters in the Parameters sector (see Define Parameters). Otherwise, in case the Type property is set to ftDataField, the data source will be fetched from the SQL statement in the parent section. |
Field Name | The property is available for all the fields. Enter the name of a new parameter. The value is fetched to the Parameters sector in case FieldType equals ftParamField. For more information, see Define Parameters. |
The property is available for all the fields. Specify the value to be used by default in case the value itself is empty in the data source. The value is fetched to the Parameters sector in case FieldType equals ftParamField. For more information, see Define Parameters. | |
Caption | The property is available for all the fields. Specify the title of the column in the output template file. The value will be fetched to the Parameters sector. This property can be used with the MS Excel and Comma Separated Values output file formats. For more information, see Set File Format. |
Length | The property is available for all the fields. Enter a numeric value that defines the actual length of the column. If the property is set to 0, the export engine does not restrict the column length. |
Max Length | The property is available for all the fields. Enter a numeric value that defines the maximum length of the field. |
Filler | The property is available for all the fields. Enter the symbol to be used to fill empty spaces at the end of the output string. If not specified, spaces are used as default |
Align | The property is available for all the fields. Set the value alignment in a column by selecting one of the options:
|
...
The text allows entering any values into a field. On setting the parameter type, the Mask column becomes active. In the column, you can limit the value types to be entered.
Date allows entering dates into the field.
The number allows entering only numeric values.
DropDown gives the possibility to set the predefined list of values. On setting the DropDown type, click the
button in the Mask column. This opens the List editor dialog where you can add the values one by one by clicking the Add Item button:
Click OK to save the records and exit the dialog.Lookup enables you to define the list of values based on the General Code values. On setting the Lookup type, click the
button in the Mask column. This opens the List editor dialog where you can select the general code to be displayed in the output file:
Click OK to save the records and exit the dialog.
...
Add an inline parameter into the SQL statement considering the syntax:
Create a new field with the respective name:
Info The Type property must equal ftDataField. This allows an export engine to fetch data defined in the SQL statement
On the Template pane, click the Export Template root node. In the Parameters sector, you can see the added parameter:
Fill in the fields: Caption, Type, and/or Mask. For more information on parameter properties, see Define Parameters.
...
Click the Template button under the Template pane. This opens the menu, where you can select the Export option:
When the Save As system dialog appears, specify the save location, enter a file name and click Save:
Info A template is exported in the XML file format only.
...