... Please check out these following articles for scenarios where SQLPlus DSC will be used:
[Retrieving data from a database and populating a form with the data]
[Retrieving data from a database and saving as CSV file]
[Retrieving data from a database and saving as concatenated strings or lists in process variables]
|
|
| |
h3. Component: com.avoka.livecycle.sqlplus 8.0
|
...
h2. DatabaseExport Service
SQLPlus: Exports data from Database via SQL query to various formats of output.
|
h3. Operation Title: SQL to CSV (exportToCsv)
SQL to CSV: Exports data retrieved from executing SQL query into CSV format. |
| || Input Parameter || Type || Description ||
Editor || |
| | Datasource Name | java.lang.String | JNDI datasource name to connect to a database
|
| | |
| | SQL Statement | java.lang.String | Specify the query statement|
| |
| | Is parameterized SQL Statement | boolean | Specify whether the statement is a prepared statement, i.e. parameterized SQL statement. |
| |
| |
| | Statement Parameters | java.util.List | Specify list of parameters required for the prepared statement, if statement is parameterized. |
| |
| |
| | CSV Mapping Info | com.avoka.livecycle.datamanipulation.bean.CsvMappingInfoBean | Specifies the mapping information to map SQL query result into CSV format|
| |
| | Maximum Number of Rows | int | The maximum number of rows to return. 0 to return all rows.
|
| | |
| | Start at Row Index | int | Row index to start retrieving query result. 0 is the index of the first row.
|
| | |
| |
|
| || Output Parameter || Type || Description || |
| | Result | java.lang.String | Process variale to store the result CSV from executing the SQL query. |
|
|
...
|
h3. Operation Title: SQL to Delimited Strings (sqlToDelimitedString)
SQL to Delimited Strings: Extracts data retrieved from executing SQL query into individual process variable per column as delimited string. |
| || Input Parameter || Type || Description ||
Editor || |
| | Datasource Name | java.lang.String | JNDI datasource name to connect to a database.
|
| | |
| | SQL Statement | java.lang.String | Specify the query statement|
| |
| | Is parameterized SQL Statement | boolean | Specify whether the statement is a prepared statement, i.e. parameterized SQL statement. |
| |
| |
| | Statement Parameters | java.util.List | Specify list of parameters required for the prepared statement, if statement is parameterized. |
| |
| |
| | Delimited String Mapping Info | com.avoka.livecycle.datamanipulation.bean.DelimitedStringMappingInfoBean | Specifies the mapping information to map SQL query result into delimited string for each column|
| |
| | Maximum Number of Rows | int | The maximum number of rows to return. 0 to return all rows.
|
| | |
| | Start at Row Index | int | Row index to start retrieving query result. 0 is the index of the first row.
|
| | |
| |
|
| || Output Parameter || Type || Description || |
| | Number of Rows Retrieved | int | Process variable to store number of rows extracted from database |
|
|
...
|
h3. Operation Title: SQL to Lists (sqlToList)
SQL to Lists: Extracts data retrieved from executing SQL query into individual process variable per column as List. |
| || Input Parameter || Type || Description ||
Editor || |
| | Datasource Name | java.lang.String | JNDI datasource name to connect to a database
|
| | |
| | SQL Statement | java.lang.String | Specify the query statement|
| |
| | Is parameterized SQL Statement | boolean | Specify whether the statement is a prepared statement, i.e. parameterized SQL statement. |
| |
| |
| | Statement Parameters | java.util.List | Specify list of parameters required for the prepared statement, if statement is parameterized. |
| |
| |
| | List Mapping Info | com.avoka.livecycle.datamanipulation.bean.DataMappingInfoBean | Specifies the mapping information to map SQL query result into a List for each column|
| |
| | Maximum Number of Rows | int | The maximum number of rows to return. 0 to return all rows.
|
| | |
| | Start at Row Index | int | Row index to start retrieving query result. 0 is the index of the first row.
|
| | |
| |
|
| || Output Parameter || Type || Description || |
| | Number of Rows Retrieved | int | Process variable to store number of rows extracted from database |
|
|
...
|
h3. Operation Title: SQL to XML or Form Data (writeResultSetDataToXML)
SQL to XML or Form Data: Inserts data retrieved from executing SQL query into XML or Form process variable. |
| || Input Parameter || Type || Description ||
Editor || |
| | Datasource Name | java.lang.String | JNDI datasource name to connect to a database.
|
| | |
| | SQL Statement | java.lang.String | Specify the query statement|
| |
| | Is parameterized SQL Statement | boolean | Specify whether the statement is a prepared statement, i.e. parameterized SQL statement. |
| |
| |
| | Statement Parameters | java.util.List | Specify list of parameters required for the prepared statement, if statement is parameterized. |
| |
| |
| | Repeating Element | java.lang.String | Specify an XPath expression that points to the repeating element in the XML document|
| |
| | Starting Row Index | java.lang.String | Specify index of the first row in a sequence from the result set to be saved in the XML, 0, by default, means the first row.|
| |
| | Number of rows | java.lang.String | Specify number of rows starting from the row with starting row index to be saved in XML document, -1, by default, means all rows|
| |
| | Mappings | java.util.List | List of mappings between columns in the result set and subelements of the repeating element|
| |
|
|
h5.
{panel:borderStyle=solid} |
... For how to configure license information for this component service - SQLPlus, please click on the following link:
[Avoka LiveCycle ES Component License Configuration]
Please send us any questions or comments on this documentation regarding SQLPlus by clicking on the following link:
[Feedback|mailto:docfeedback@avoka.com?subject=DSC Documentation Feedback on Service: SQLPlus]
{panel}
h3. Licence Configuration:
|| Parameter || Type || Description ||
| License Key | java.lang.String | The license key. If blank this Solution Component will assume evaluation mode and allow 100 invocations or 6 hours up-time. |
| License Organisation | java.lang.String | The license organization. If blank this Solution Component will assume evaluation mode and allow 100 invocations or 6 hours up-time. | |
SQLPlus DSC
