- Introduction to WorkXpress
- Building Your Application
- Examples and Best Practices
- Technical Manual
This shows you the differences between two versions of the page.
action type - report [2016/09/14 18:19] |
action type - report [2016/09/14 18:19] (current) |
||
---|---|---|---|
Line 1: | Line 1: | ||
+ | ====== Generate a Report ====== | ||
+ | You can run a report when a user clicks a button or when other actions trigger the action to run a report. | ||
+ | ===== Settings ===== | ||
+ | ==== Open in Popup ==== | ||
+ | |||
+ | === Choose a Report to Run === | ||
+ | You will get a dropdown that allows you to choose "I know which report will run..." or "The report is stored on a record." | ||
+ | * **"I know which report will run..."** - Use the search field to select your report. | ||
+ | * **"The report is stored on a record."** - Select the field that the holds the report selection. | ||
+ | |||
+ | === Choose Output Type === | ||
+ | There are eight types of outputs available. | ||
+ | |||
+ | * **Comma Separated Values** - This will download a text file where fields of each record are separated by a comma (.csv file extension). | ||
+ | * **Excel** - This will download an Excel file compatible with all versions of Excel (.xls file extension). | ||
+ | * **Excel 2007+** This will download an Excel file compatible with newer versions (.xlsx file extension). | ||
+ | * **On Screen Viewable** - This will open the report in a popup. | ||
+ | * **PDF - Best For Printing** - You will get a selection field to choose the [[WX Table - Word Templates|template]] for the report. | ||
+ | * **Unmodified Text** - This will download a text file (.txt extension). | ||
+ | * **Word XP/2000** - This will download a Word file compatible with all versions of Microsoft Word (.doc file extension). | ||
+ | * **Word 2007** - This will download a Word file compatible with newer versions (.docx file extension). | ||
+ | |||
+ | === Choose popup size === | ||
+ | Select a popup size or choose your own. | ||
+ | |||
+ | === Describe this action === | ||
+ | Useful as a comment, this description will overwrite the automatically generated description in the [[Action Manager|Action Manager]]. | ||
+ | |||
+ | ==== Save as a File ==== | ||
+ | === Choose a Report to Run === | ||
+ | You will get a dropdown that allows you to choose "I know which report will run..." or "The report is stored on a record." | ||
+ | * **"I know which report will run..."** - Use the search field to select your report. | ||
+ | * **"The report is stored on a record."** - Select the field that the holds the report selection. | ||
+ | |||
+ | === Choose Output Type === | ||
+ | There are eight types of outputs available. | ||
+ | |||
+ | * **Comma Separated Value*** - This will download a text file where fields of each record are separated by a comma (.csv file extension). | ||
+ | * **Excel** - This will download an Excel file compatible with all versions of Excel (.xls file extension). | ||
+ | * **Excel 2007+** This will download an Excel file compatible with newer versions (.xlsx file extension). | ||
+ | * **On Screen Viewable** - This will open the report in a popup. | ||
+ | * **PDF - Best For Printing** - You will get a selection field to choose the [[WX Table - Word Templates|template]] for the report. | ||
+ | * **Unmodified Text** - This will download a text file (.txt extension). | ||
+ | * **Word XP/2000** - This will download a Word file compatible with all versions of Microsoft Word (.doc file extension). | ||
+ | * **Word 2007** - This will download a Word file compatible with newer versions (.docx file extension). | ||
+ | |||
+ | === Describe this action === | ||
+ | Useful as a comment, this description will overwrite the automatically generated description in the Action Manager. | ||
+ | |||
+ | === Location to Store File === | ||
+ | You can choose to store the file within in the application in a [[Field Type - File Attachment|file attachment field]] or remotely using FTP. | ||
+ | == Remote Server, via FTP == | ||
+ | * **FTP URL** - Build the URL for the FTP server on which you wish to save this file. This can be an IP address (e.g. 255.255.255.0) or text-based domain name (e.g. ftp.myserver.com). | ||
+ | * **FTP Server Username** - Select the field that contains the username for the FTP server or enter it directly. | ||
+ | * **FTP Server Password** - Select the field that contains the password for the FTP server or enter it directly. | ||
+ | * **Folder Path on FTP Server** - Build the path on the FTP server where the file will be stored. | ||
+ | |||
+ | == WorkXpress, in a file field== | ||
+ | * **Report File Field** - Search for and select the file attachment field in which to save the report file. | ||
+ | * **File Name** - Build the name for the file. |