Difference: 0LASubrFileCsvExport (4 vs. 5)

Revision 52019-09-26 - JeanNeron

Line: 1 to 1
 
META TOPICPARENT name="FullAPIList"

.FILE CSV EXPORT

This subroutine is called to export an APPX file in CSV format. Release 5.4.0 & up.


Usage:

*     PASS         <error_msg>                FIELD            SHARE? Y
*     PASS         <file_name>                FIELD            SHARE? N
*     PASS         <application>              FIELD            SHARE? N
*     PASS         <database>                 FIELD            SHARE? N
*     PASS         <count success>            FIELD            SHARE? Y
*     PASS         <count total>              FIELD            SHARE? Y
*     PASS         <count fail>               FIELD            SHARE? Y
*     PASS         <path & file name>         FIELD            SHARE? N
*     PASS         <include headings>         FIELD            SHARE? N
*     GOSUB    --- .FILE CSV EXPORT
      *        Check for errors
*     IF       --- .FILE CSV EXPORT           NE

Description:

This subroutine will export the specified file in CSV format.

<error_message> contains additional error information if the command fails (Required). Must be PASSed with Share "Y".

<file_name> is the name of the APPX file to export (Required).

<application> is the name of the application containing the file to export. This is optional and if not specified it will default to the current application.

<database> is the name of the database containing the file to export. This is optional and if not specified it will default to the current database.

<count_success> is the count of records successfully exported. This is optional and must be PASSed with Share "Y" to return a value.

<count_total> is the total count of records processed, whether they were successfully exported or not. This is optional and must be PASSed with Share "Y" to return a value.

<count_error> is the count of records that were not exported. This is optional and must be PASSed with Share "Y" to return a value.

<path & file name> is an optional location for the exported data (5.4.5 and higher only).

<include headings> is a Y/N flag to determine whether the first line should contain column headings or not (5.4.7 / 6.0.1 and higher only). Optional, defaults to "N".

The exported file is always exported to the $APPXPATH/<database>/<application>/Portdata/ folder and named <file_name>.csv. If you specified a <path & file name>, it will be copied to that location for you.

Added:
>
>
NOTE: The user must have Data Management rights for the Database / Application you want to export, or be an APPX System Administrator.
 

Comments:

Read what other users have said about this page or add your own comments.


<--/commentPlugin-->

-- PeteBrower - 2011-08-12 \ No newline at end of file

 
This site is powered by the TWiki collaboration platform Powered by PerlCopyright © 2008-2024 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback