Data Exporter Extension Version 1.0

Transcription

1 Data Exporter Extension Version 1.0 User Guide

2 Software Change Log... 2 Introduction and Installation... 2 About the Data Exporter Extension... 2 Installing the Data Exporter Extension... 2 Configuration and Usage... 4 Configuration... 4 Usage... 4 Compatibility... 5 Document Revision History

3 Software Change Log Version Release Date Changes /22/2016 Initial Release Introduction and Installation Extensibility is a core aspect of the architecture and design of ThingWorx. Partners, third parties, and general ThingWorx users can easilyadd new functionality into the system, seamlessly. Extensions canbe in the form of Service (function/method) Libraries, Connector Templates, Widgets, and more. This document provides installation and usage instructions for the Data Exporter Extension. About the Data Exporter Extension The Data Exporter Extension allows you to export infotables in 3 major formats: Microsoft Word, Microsoft Excel and PDF. The extension comes with a Data Exporter ThingTemplate from which is created the Data Exporter Thing and a FileRepository Thing named DataExporterRepository which will create a folder inside the Thingworx Storage that houses the exported files. The Data Exporter Extension allows you to create a Data Exporter thing in ThingWorx. The thing provides services, including: 1. ExportInfotableAsExcel 2. ExportInfotableAsPdf 3. ExportInfotableAsWord Installing the Data Exporter Extension 1. From a web browser, launch ThingWorx. 2

4 2. Loginto ThingWorxas an administrator. 3. Go to Import/Export > Import. 4. Click Choose File and select DataExporterExtension.zip 5. Click Import. Note: If an Import Successful message does not display, contact your ThingWorx System Administrator. Note: 6. Click Yes to refresh Composerafter importing the final extension. 7. Confirm that the Extension has been imported properly. Check the Application Log for potential problems. 3

5 Configuration and Usage Usage of the Data Exporter Extension requires creation ofa Data Exporter Thing in ThingWorx. Please refer to the Data Exporter Thing entity download in the Marketplace for reference. The Data Exporter Thing provides the following services: ExportInfotableAsExcel ExportInfotableAsPdf ExportInfotableAsWord Configuration Once the Data Exporter Thing is created there is no need for any configuration. All the exported files will be located in the Thingworx Storage under the repository folder named DataExporterRepository. You can manipulate the exported files in Thingworx Platform using the FileRepository thing called DataExporterRepository which comes with the extension. Usage The Data Exporter Extension can be used by invoking any one of the following services: ExportInfotableAsExcel - exports an Infotable to a Microsoft Excel file (.xlsx), locating the file inside the Thingworx Storage repository folder DataExporterRepository The service has an input parameter with the base type Infotable and returns the download link of the file for downloading it in the browser. ExportInfotableAsPdf - exports an Infotable to a PDF file (.pdf), locating the file inside the Thingworx Storage repository folder DataExporterRepository This service has an input parameter with the base type Infotable and returns the download link of the file for downloading it in the browser. ExportInfotableAsExcel - exports an Infotable to a Microsoft Word file (.docx), locating the file inside the Thingworx Storage repository folder DataExporterRepository This service has an input parameter with the base type Infotable and returns the download link of the file for downloading it in the browser. 4

6 All the exported files will be located inside the Thingworx Storage repository folder One implementation example is to have a datatable with data and use it as the input data for the services of this extension. The following code can be followed for this purpose. Compatibility This extension was tested for compatibility with the following ThingWorx Platform version(s) and Operating System(s): ThingWorx Platform Version ThingWorx OS Windows 7, Service Pack 1 5

7 Document Revision History Revision Date Version Description of Change April 22, Initial Release 6