DS - Excel datasources

Nazwa wtyczki	Data utworzenia	Data ostatniej aktualizacji	Link do instalki	Krótki opis	Dział utrzymujący	Dokumentacja dla klienta	Typ licencji	Typ wtyczki	Id wtyczki
DS - Excel datasources	2019-10-22	2024-11-13	Link	Wtyczka zawiera implementację źródeł danych operujących na arkuszach danych. Obsługiwane typy plików: .xls, .xlsx i pochodne.	Dev CUF		Płatna	Wtyczka	com.suncode.plugin-excel-datasources

General info

Category: Spreadsheets

Download: >>LINK<<

Description

The plugin includes the implementation of data sources running on spreadsheets. Supported file types: .xls, .xlsx and derivatives.

By means of the described data sources, it is possible to read and write data to spreadsheets in Microsoft's formats.

Supported spreadsheets must contain column headings in the first row.

Supported sheet sample:

All configuration examples in the further part of the documentation operate on the above file.

Starting from Plusworkflow System version 4.0.38 - datasource informs user about configuration errors (ex. file not found).

Configuration

Read

Parameter name	Parameter description	Required	Remarks
File source	The source on which the file indicated in the path is located.	True	The "Google Drive" option requires the Plus Google Cloud Integrator plug-in to be installed to function properly.
Google Cloud connection configuration ID	Connection configurations are carried out in the "Plugins configuration" (PCM) tab.	False	Parameter related to the "File source" option = "Google Drive"
Google file Id	The Google Drive File ID. The File ID can be found in the URL of the file when it is opened on Google Drive. It is the combination of letters and numbers that appear after "d/" in the link: https://docs.google.com/spreadsheets/d/*ThisIsFileID*/edit#gid=123456789.	False	Parameter related to the "File source" option = "Google Drive"
Filepath	An absolute path to a file on disk. Tags available from version 1.0.6 {PWFL_HOME} - automatically inserts the path to the Plusworkflow home directory. {WORKING_DIRECTORY} - automatically inserts the path to the temporary directory set in the system parameters ("WorkingDirectory"). FILEID:{<file_id>} - automatically inserts the path to the file on the system with the given id. The <file_id> keyword should be replaced with the specific file ID from your system.	True
Sheet name	The name of a specific sheet in the file.	True
Default numeric format	Default numeric format gets values "as seen" in document. No formatting applied when unchecked.	True	Default value: True Default data formatter have an effect in: number datatype defined in Excel file. For example: Excel number formatted cell value 2002,9632 will be read as 2,002.9632 With data formatter option turned off, numeric value wil be read as 2002.9632
[Path parameters] Id	Path parameter id substituted to the filepath.	False
[Path parameters] Name	The name of the path parameter shown in the PWFL system.	False
[Spreadsheet output parameters definition] Output parameter id	Spreadsheet output parameter id.	True
[Spreadsheet output parameters definition] Output parameter name	The name of the spreadsheet output parameter shown in the PWFL system.	True
[Spreadsheet output parameters definition] Headers	The headings of the spreadsheet columns whose values will be mapped to the defined parameter.	True

The result of the above configuration:

Update

Parameter name	Parameter description	Required
Filepath	An absolute path to a file on disk. Tags available from version 1.0.6 {PWFL_HOME} - automatically inserts the path to the Plusworkflow home directory. {WORKING_DIRECTORY} - automatically inserts the path to the temporary directory set in the system parameters ("WorkingDirectory").	True
Sheet name	The name of a specific sheet in the file.	True
Handle unexisting data	Handling the case when no record with the given primary key exists in the spreadsheet. Available values: Add - a record with a primary key that does not exist in the sheet will be added to the end of the sheet Block - the update will be blocked, and appropriate information about the error will appear in the system logs Pass - the update will not add a new record with a non-existent master key to the sheet, but it will allow the processing of any subsequent lines if the update concerns many records	True
[Path parameters] Id	Path parameter id substituted to the filepath.	False
[Path parameters] Name	The name of the path parameter shown in the PWFL system.	False
Headers	Spreadsheet headers that are either a primary key or an updateable parameter.	True
Parameter types	Determines whether the given header is a primary key based on which selected rows will be updated, or a parameter that should be updated.	True

The above configuration will change the value in the Last Name column to "Ebby" in all records containing the value "Abby" in the First Name column.

Delete

Parameter name	Parameter description	Required
Filepath	An absolute path to a file on disk. Tags available from version 1.0.6 {PWFL_HOME} - automatically inserts the path to the Plusworkflow home directory. {WORKING_DIRECTORY} - automatically inserts the path to the temporary directory set in the system parameters ("WorkingDirectory").	True
Sheet name	The name of a specific sheet in the file.	True
[Path parameters] Id	Path parameter id substituted to the filepath.	False
[Path parameters] Name	The name of the path parameter shown in the PWFL system.	False
Headers	The column headings from the spreadsheet, based on the values of which, the records will be deleted from the sheet.	True

The above configuration will remove all records containing "Abby" in the First Name column from the spreadsheet.

Insert

Parameter name	Parameter description	Default Value	Required
Filepath	An absolute path to a file on disk. Tags available from version 1.0.6 {PWFL_HOME} - automatically inserts the path to the Plusworkflow home directory. {WORKING_DIRECTORY} - automatically inserts the path to the temporary directory set in the system parameters ("WorkingDirectory").		True
Sheet name	The name of a specific sheet in the file.		True
Handle existing file	Specifies the action that will be performed if a file already exists in the location specified in the 'Filepath' parameter. Available values: Extend - will add values to an existing file or create a new one when the file does not exist Overwrite - will overwrite all values in an existing file or create a new one when the file does not exist	Extend	True
[Path parameters] Id	Path parameter id substituted to the filepath.		False
[Path parameters] Name	The name of the path parameter shown in the PWFL system.		False
Headers	The headings of the columns from the spreadsheet to which the data will be added.		True

The above configuration will add two records to the sheet:

First Name	Last Name	Nr	Gender
Jenny	Champ	111	Female
John	Doe	112	Male

Path parameters

The data source allows you to parameterize the path to the spreadsheet on the disk. Thanks to this, it is possible, among others creating new spreadsheet files based on the variable/variables from the process.

To do this, you should embed the Id of the path parameter in special tags - { } - in the Filepath parameter in the data source configuration eg. C:\folder\arkusz_{data}.xls

Then, in the Path parameters section in the data source configuration, add the parameter with Id "data".

This will enable dynamic passing a value of the path's parameter with Id "data" when calling the data source.

The license could not be verified: License Certificate has expired!

The plugin includes the implementation of data sources running on spreadsheets. Supported file types: .xls, .xlsx and derivatives.

1 Child Page

0 Comments