Upgrade from Execute Stored Procedure Plug-in to OOTB Features

Appian Max Team — Tue, 23 Apr 2024 13:15:14 GMT

Current Revision posted to Guide by Appian Max Team on 4/23/2024 1:15:14 PM

Introduction

In version 22.1 Appian released support for executing stored procedures out-of-the-box using a!executeStoredProcedureForQuery(), a!executeStoredProcedureOnSave(), or the Execute Stored Procedure Smart Service. With this release, the Execute Stored Procedure plug-in was deprecated. Below is a guide for how you can upgrade the deprecated plug-in function calls and smart service nodes to the fully supported features. Note that this guide does not guarantee the success of your updates. All updates should be tested thoroughly.

When upgrading, keep in mind the following backwards compatibility considerations:

Appian Execute Stored Procedure Behavior	Plug-in Execute Stored Procedure Behavior
Result sets exceeding the max result set size of 1000 rows are truncated.	No maximum result set size.
For stored procedures that return multiple result sets, results exceeding the cumulative max size of 10,000 rows are truncated.	No maximum cumulative result set size.
Error returned when duplicate or empty column names are found.	Columns with duplicate names are silently truncated. Empty column names are allowed.
Error returned when IN or INOUT parameters are not passed in inputs.	Missing IN and INOUT parameters are defaulted to null.
Supports data source connected systems and admin console data sources.	Supports only admin console data sources.

Optionally, the fully supported Appian Execute Stored Procedure functions and smart service can be used with data source connected systems, which allow you to apply role map security to your data sources. Migrating from an admin console data source to a data source connected system is simple. From the Appian designer click to create a new connected system object, copy the connection details, and apply security. To execute stored procedures using the new data source connected system you’ll also need to create a connected system constant.

Finding all plug-in usage for a site

To find each instance that the Execute Stored Procedure plug-in is used, follow these steps:

Open the “OBJECTS” page in the Appian Designer and select the “PLUG-INS” tab.
Search and select the “Execute Stored Procedure” plug-in.
Click the “Dependents” button.

Upgrading executeStoredProcedure

Like the plug-in function, a!executeStoredProcedureForQuery should not be used to execute stored procedures that modify data. Doing so can have unintended side effects! If you’re relying on this unsupported behavior to execute a stored procedure that modifies data, we’re excited to introduce you to the new a!executeStoredProcedureOnSave smart service function. Using this function, you can safely execute stored procedures that modify data from an interface.

Upgrading to the Appian execute stored procedure functions is super easy. In most cases it will be as simple as changing the function name.

Update the function name from fn!executeStoredProcedure to a!executeStoredProcedureForQuery.
Change the dataSourceName parameter to dataSource. If you are upgrading to use a new data source connected system, use the connected system constant instead of copying the name of the admin console data source.
The a!executeStoredProcedureForQuery function requires all IN and INOUT parameters to be defined. If you have any missing IN or INOUT parameters, add them to inputs.
Test the expression.

Upgrading execute stored procedure smart service nodes

To upgrade execute stored procedure process model nodes, we recommend copying the properties from the process model documentation in a separate window and following the instructions below:

Drag and drop a new “Execute Stored Procedure” node into the process model next to the deprecated execute stored procedure plug-in node.
In the process model documentation, find the execute stored procedure plug-in node properties.
Copy each property from the process model documentation of the deprecated node. Note that the dataSourceName input will need to be copied into dataSource. The new execute stored procedure smart service requires all IN and INOUT parameters to be defined. If you have any missing IN or INOUT parameters, add them to as custom inputs. If you are upgrading to use a new data source connected system, use the connected system constant instead of copying the name of the admin console data source.
Remove the deprecated process model node.
Test the process model.

Tags: database, Architecture, plugins

Upgrade from Execute Stored Procedure Plug-in to OOTB Features

Appian Max Team — Thu, 22 Feb 2024 21:15:47 GMT

Revision 8 posted to Guide by Appian Max Team on 2/22/2024 9:15:47 PM

Introduction

When upgrading, keep in mind the following backwards compatibility considerations:

Appian Execute Stored Procedure Behavior	Plug-in Execute Stored Procedure Behavior
Result sets exceeding the max result set size of 1000 rows are truncated.	No maximum result set size.
For stored procedures that return multiple result sets, results exceeding the cumulative max size of 10,000 rows are truncated.	No maximum cumulative result set size.
Error returned when duplicate or empty column names are found.	Columns with duplicate names are silently truncated. Empty column names are allowed.
Error returned when IN or INOUT parameters are not passed in inputs.	Missing IN and INOUT parameters are defaulted to null.
Supports data source connected systems and admin console data sources.	Supports only admin console data sources.

Finding all plug-in usage for a site

To find each instance that the Execute Stored Procedure plug-in is used, follow these steps:

Open the “OBJECTS” page in the Appian Designer and select the “PLUG-INS” tab.
Search and select the “Execute Stored Procedure” plug-in.
Click the “Dependents” button.

Upgrading executeStoredProcedure

Upgrading to the Appian execute stored procedure functions is super easy. In most cases it will be as simple as changing the function name.

Update the function name from fn!executeStoredProcedure to a!executeStoredProcedureForQuery.
Change the dataSourceName parameter to dataSource. If you are upgrading to use a new data source connected system, use the connected system constant instead of copying the name of the admin console data source.
The a!executeStoredProcedureForQuery function requires all IN and INOUT parameters to be defined. If you have any missing IN or INOUT parameters, add them to inputs.
Test the expression.

Upgrading execute stored procedure smart service nodes

To upgrade execute stored procedure process model nodes, we recommend copying the properties from the process model documentation in a separate window and following the instructions below:

Drag and drop a new “Execute Stored Procedure” node into the process model next to the deprecated execute stored procedure plug-in node.
In the process model documentation, find the execute stored procedure plug-in node properties.
Copy each property from the process model documentation of the deprecated node. Note that the dataSourceName input will need to be copied into dataSource. The new execute stored procedure smart service requires all IN and INOUT parameters to be defined. If you have any missing IN or INOUT parameters, add them to as custom inputs. If you are upgrading to use a new data source connected system, use the connected system constant instead of copying the name of the admin console data source.
Remove the deprecated process model node.
Test the process model.

Tags: database, Architecture, plugins

Upgrade from Execute Stored Procedure Plug-in to OOTB Features

matt.cosenza — Wed, 01 Nov 2023 17:20:28 GMT

Revision 7 posted to Guide by matt.cosenza on 11/1/2023 5:20:28 PM

Introduction

When upgrading, keep in mind the following backwards compatibility considerations:

Appian Execute Stored Procedure Behavior	Plug-in Execute Stored Procedure Behavior
Result sets exceeding the max result set size of 1000 rows are truncated.	No maximum result set size.
For stored procedures that return multiple result sets, results exceeding the cumulative max size of 10,000 rows are truncated.	No maximum cumulative result set size.
Error returned when duplicate or empty column names are found.	Columns with duplicate names are silently truncated. Empty column names are allowed.
Error returned when IN or INOUT parameters are not passed in inputs.	Missing IN and INOUT parameters are defaulted to null.
Supports data source connected systems and admin console data sources.	Supports only admin console data sources.

Finding all plug-in usage for a site

To find each instance that the Execute Stored Procedure plug-in is used, follow these steps:

Open the “OBJECTS” page in the Appian Designer and select the “PLUG-INS” tab.
Search and select the “Execute Stored Procedure” plug-in.
Click the “Dependents” button.

Upgrading executeStoredProcedure

Upgrading to the Appian execute stored procedure functions is super easy. In most cases it will be as simple as changing the function name.

Update the function name from fn!executeStoredProcedure to a!executeStoredProcedureForQuery.
Change the dataSourceName parameter to dataSource. If you are upgrading to use a new data source connected system, use the connected system constant instead of copying the name of the admin console data source.
The a!executeStoredProcedureForQuery function requires all IN and INOUT parameters to be defined. If you have any missing IN or INOUT parameters, add them to inputs.
Test the expression.

Upgrading execute stored procedure smart service nodes

To upgrade execute stored procedure process model nodes, we recommend copying the properties from the process model documentation in a separate window and following the instructions below:

Drag and drop a new “Execute Stored Procedure” node into the process model next to the deprecated execute stored procedure plug-in node.
In the process model documentation, find the execute stored procedure plug-in node properties.
Copy each property from the process model documentation of the deprecated node. Note that the dataSourceName input will need to be copied into dataSource. The new execute stored procedure smart service requires all IN and INOUT parameters to be defined. If you have any missing IN or INOUT parameters, add them to as custom inputs. If you are upgrading to use a new data source connected system, use the connected system constant instead of copying the name of the admin console data source.
Remove the deprecated process model node.
Test the process model.

Tags: database, Architecture, plugins

Upgrade from Execute Stored Procedure Plug-in to OOTB Features

matt.cosenza — Wed, 01 Nov 2023 17:20:17 GMT

Revision 6 posted to Guide by matt.cosenza on 11/1/2023 5:20:17 PM

Introduction

In version 22.1 Appian released support for executing stored procedures out-of-the-box using a!executeStoredProcedureForQuery(), a!executeStoredProcedureOnSave(), or the Execute Stored Procedure Smart Service. With this release, the Execute Stored Procedure plug-in was deprecated. Below is a guide for how you can upgrade the deprecated plug-in function calls and smart service nodes to the fully supported features. Note that this guide does not guarantee the success of your updates. All updates should be tested thoroughly.

When upgrading, keep in mind the following backwards compatibility considerations:

Appian Execute Stored Procedure Behavior	Plug-in Execute Stored Procedure Behavior
Result sets exceeding the max result set size of 1000 rows are truncated.	No maximum result set size.
For stored procedures that return multiple result sets, results exceeding the cumulative max size of 10,000 rows are truncated.	No maximum cumulative result set size.
Error returned when duplicate or empty column names are found.	Columns with duplicate names are silently truncated. Empty column names are allowed.
Error returned when IN or INOUT parameters are not passed in inputs.	Missing IN and INOUT parameters are defaulted to null.
Supports data source connected systems and admin console data sources.	Supports only admin console data sources.

Finding all plug-in usage for a site

To find each instance that the Execute Stored Procedure plug-in is used, follow these steps:

Open the “OBJECTS” page in the Appian Designer and select the “PLUG-INS” tab.
Search and select the “Execute Stored Procedure” plug-in.
Click the “Dependents” button.

Upgrading executeStoredProcedure

Upgrading to the Appian execute stored procedure functions is super easy. In most cases it will be as simple as changing the function name.

Update the function name from fn!executeStoredProcedure to a!executeStoredProcedureForQuery.
Change the dataSourceName parameter to dataSource. If you are upgrading to use a new data source connected system, use the connected system constant instead of copying the name of the admin console data source.
The a!executeStoredProcedureForQuery function requires all IN and INOUT parameters to be defined. If you have any missing IN or INOUT parameters, add them to inputs.
Test the expression.

Upgrading execute stored procedure smart service nodes

To upgrade execute stored procedure process model nodes, we recommend copying the properties from the process model documentation in a separate window and following the instructions below:

Drag and drop a new “Execute Stored Procedure” node into the process model next to the deprecated execute stored procedure plug-in node.
In the process model documentation, find the execute stored procedure plug-in node properties.
Copy each property from the process model documentation of the deprecated node. Note that the dataSourceName input will need to be copied into dataSource. The new execute stored procedure smart service requires all IN and INOUT parameters to be defined. If you have any missing IN or INOUT parameters, add them to as custom inputs. If you are upgrading to use a new data source connected system, use the connected system constant instead of copying the name of the admin console data source.
Remove the deprecated process model node.
Test the process model.

Upgrade from Execute Stored Procedure Plug-in to OOTB Features

matt.cosenza — Tue, 17 Oct 2023 20:18:19 GMT

Revision 5 posted to Guide by matt.cosenza on 10/17/2023 8:18:19 PM

Introduction

When upgrading, keep in mind the following backwards compatibility considerations:

Appian Execute Stored Procedure Behavior	Plug-in Execute Stored Procedure Behavior
Result sets exceeding the max result set size of 1000 rows are truncated.	No maximum result set size.
For stored procedures that return multiple result sets, results exceeding the cumulative max size of 10,000 rows are truncated.	No maximum cumulative result set size.
Error returned when duplicate or empty column names are found.	Columns with duplicate names are silently truncated. Empty column names are allowed.
Error returned when IN or INOUT parameters are not passed in inputs.	Missing IN and INOUT parameters are defaulted to null.
Supports data source connected systems and admin console data sources.	Supports only admin console data sources.

Finding all plug-in usage for a site

To find each instance that the Execute Stored Procedure plug-in is used, follow these steps:

Open the “OBJECTS” page in the Appian Designer and select the “PLUG-INS” tab.
Search and select the “Execute Stored Procedure” plug-in.
Click the “Dependents” button.

Upgrading executeStoredProcedure

Upgrading to the Appian execute stored procedure functions is super easy. In most cases it will be as simple as changing the function name.

Update the function name from fn!executeStoredProcedure to a!executeStoredProcedureForQuery.
Change the dataSourceName parameter to dataSource. If you are upgrading to use a new data source connected system, use the connected system constant instead of copying the name of the admin console data source.
The a!executeStoredProcedureForQuery function requires all IN and INOUT parameters to be defined. If you have any missing IN or INOUT parameters, add them to inputs.
Test the expression.

Upgrading execute stored procedure smart service nodes

To upgrade execute stored procedure process model nodes, we recommend copying the properties from the process model documentation in a separate window and following the instructions below:

Drag and drop a new “Execute Stored Procedure” node into the process model next to the deprecated execute stored procedure plug-in node.
In the process model documentation, find the execute stored procedure plug-in node properties.
Copy each property from the process model documentation of the deprecated node. Note that the dataSourceName input will need to be copied into dataSource. The new execute stored procedure smart service requires all IN and INOUT parameters to be defined. If you have any missing IN or INOUT parameters, add them to as custom inputs. If you are upgrading to use a new data source connected system, use the connected system constant instead of copying the name of the admin console data source.
Remove the deprecated process model node.
Test the process model.

Upgrade from Execute Stored Procedure Plug-in to OOTB Features

matt.cosenza — Tue, 17 Oct 2023 20:15:47 GMT

Revision 4 posted to Guide by matt.cosenza on 10/17/2023 8:15:47 PM

Introduction

When upgrading, keep in mind the following backwards compatibility considerations:

Appian Execute Stored Procedure Behavior	Plug-in Execute Stored Procedure Behavior
Result sets exceeding the max result set size of 1000 rows are truncated.	No maximum result set size.
For stored procedures that return multiple result sets, results exceeding the cumulative max size of 10,000 rows are truncated.	No maximum cumulative result set size.
Error returned when duplicate or empty column names are found.	Columns with duplicate names are silently truncated. Empty column names are allowed.
Error returned when IN or INOUT parameters are not passed in inputs.	Missing IN and INOUT parameters are defaulted to null.
Supports data source connected systems and admin console data sources.	Supports only admin console data sources.

Finding all plug-in usage for a site

To find each instance that the Execute Stored Procedure plug-in is used, follow these steps:

Open the “OBJECTS” page in the Appian Designer and select the “PLUG-INS” tab.
Search and select the “Execute Stored Procedure” plug-in.
Click the “Dependents” button.

Upgrading fnexecuteStoredProcedure

Upgrading to the Appian execute stored procedure functions is super easy. In most cases it will be as simple as changing the function name.

Update the function name from fn!executeStoredProcedure to a!executeStoredProcedureForQuery.
Change the dataSourceName parameter to dataSource. If you are upgrading to use a new data source connected system, use the connected system constant instead of copying the name of the admin console data source.
The a!executeStoredProcedureForQuery function requires all IN and INOUT parameters to be defined. If you have any missing IN or INOUT parameters, add them to inputs.
Test the expression.

Upgrading execute stored procedure smart service nodes

To upgrade execute stored procedure process model nodes, we recommend copying the properties from the process model documentation in a separate window and following the instructions below:

Drag and drop a new “Execute Stored Procedure” node into the process model next to the deprecated execute stored procedure plug-in node.
In the process model documentation, find the execute stored procedure plug-in node properties.
Copy each property from the process model documentation of the deprecated node. Note that the dataSourceName input will need to be copied into dataSource. The new execute stored procedure smart service requires all IN and INOUT parameters to be defined. If you have any missing IN or INOUT parameters, add them to as custom inputs. If you are upgrading to use a new data source connected system, use the connected system constant instead of copying the name of the admin console data source.
Remove the deprecated process model node.
Test the process model.

Upgrade from Execute Stored Procedure Plug-in to OOTB Features

matt.cosenza — Tue, 17 Oct 2023 20:14:57 GMT

Revision 3 posted to Guide by matt.cosenza on 10/17/2023 8:14:57 PM

Introduction

When upgrading, keep in mind the following backwards compatibility considerations:

Appian Execute Stored Procedure Behavior	Plug-in Execute Stored Procedure Behavior
Result sets exceeding the max result set size of 1000 rows are truncated.	No maximum result set size.
For stored procedures that return multiple result sets, results exceeding the cumulative max size of 10,000 rows are truncated.	No maximum cumulative result set size.
Error returned when duplicate or empty column names are found.	Columns with duplicate names are silently truncated. Empty column names are allowed.
Error returned when IN or INOUT parameters are not passed in inputs.	Missing IN and INOUT parameters are defaulted to null.
Supports data source connected systems and admin console data sources.	Supports only admin console data sources.

Finding all plug-in usage for a site

To find each instance that the Execute Stored Procedure plug-in is used, follow these steps:

Open the “OBJECTS” page in the Appian Designer and select the “PLUG-INS” tab.
Search and select the “Execute Stored Procedure” plug-in.
Click the “Dependents” button.

Upgrading fn!executeStoredProcedure

Upgrading to the Appian execute stored procedure functions is super easy. In most cases it will be as simple as changing the function name.

Update the function name from fn!executeStoredProcedure to a!executeStoredProcedureForQuery.
Change the dataSourceName parameter to dataSource. If you are upgrading to use a new data source connected system, use the connected system constant instead of copying the name of the admin console data source.
The a!executeStoredProcedureForQuery function requires all IN and INOUT parameters to be defined. If you have any missing IN or INOUT parameters, add them to inputs.
Test the expression.

Upgrading execute stored procedure smart service nodes

To upgrade execute stored procedure process model nodes, we recommend copying the properties from the process model documentation in a separate window and following the instructions below:

Drag and drop a new “Execute Stored Procedure” node into the process model next to the deprecated execute stored procedure plug-in node.
In the process model documentation, find the execute stored procedure plug-in node properties.
Copy each property from the process model documentation of the deprecated node. Note that the dataSourceName input will need to be copied into dataSource. The new execute stored procedure smart service requires all IN and INOUT parameters to be defined. If you have any missing IN or INOUT parameters, add them to as custom inputs. If you are upgrading to use a new data source connected system, use the connected system constant instead of copying the name of the admin console data source.
Remove the deprecated process model node.
Test the process model.

Upgrade from Execute Stored Procedure Plug-in to OOTB Features

matt.cosenza — Tue, 17 Oct 2023 20:03:16 GMT

Revision 2 posted to Guide by matt.cosenza on 10/17/2023 8:03:16 PM

Introduction

When upgrading, keep in mind the following backwards compatibility considerations:

Appian Execute Stored Procedure Behavior	Plug-in Execute Stored Procedure Behavior
Result sets exceeding the max result set size of 1000 rows are truncated.	No maximum result set size.
For stored procedures that return multiple result sets, results exceeding the cumulative max size of 10,000 rows are truncated.	No maximum cumulative result set size.
Error returned when duplicate or empty column names are found.	Columns with duplicate names are silently truncated. Empty column names are allowed.
Error returned when IN or INOUT parameters are not passed in inputs.	Missing IN and INOUT parameters are defaulted to null.
Supports data source connected systems and admin console data sources.	Supports only admin console data sources.

Finding all plug-in usage for a site

To find each instance that the Execute Stored Procedure plug-in is used, follow these steps:

Open the “OBJECTS” page in the Appian Designer and select the “PLUG-INS” tab.
Search and select the “Execute Stored Procedure” plug-in.
Click the “Dependents” button.

Upgrading fn!executeStoredProcedure

Upgrading to the Appian execute stored procedure functions is super easy. In most cases it will be as simple as changing the function name.

Update the function name from fn!executeStoredProcedure to a!executeStoredProcedureForQuery.
Change the dataSourceName parameter to dataSource. If you are upgrading to use a new data source connected system, use the connected system constant instead of copying the name of the admin console data source.
The a!executeStoredProcedureForQuery function requires all IN and INOUT parameters to be defined. If you have any missing IN or INOUT parameters, add them to inputs.
Test the expression.

Upgrading execute stored procedure smart service nodes

To upgrade execute stored procedure process model nodes, we recommend copying the properties from the process model documentation in a separate window and following the instructions below:

Drag and drop a new “Execute Stored Procedure” node into the process model next to the deprecated execute stored procedure plug-in node.
In the process model documentation, find the execute stored procedure plug-in node properties.
Copy each property from the process model documentation of the deprecated node. Note that the dataSourceName input will need to be copied into dataSource. The new execute stored procedure smart service requires all IN and INOUT parameters to be defined. If you have any missing IN or INOUT parameters, add them to as custom inputs. If you are upgrading to use a new data source connected system, use the connected system constant instead of copying the name of the admin console data source.
Remove the deprecated process model node.
Test the process model.

Upgrade from Execute Stored Procedure Plug-in to OOTB Features

joel.larin — Wed, 06 Sep 2023 13:38:15 GMT

Revision 1 posted to Guide by joel.larin on 9/6/2023 1:38:15 PM

Introduction

When upgrading, keep in mind the following backwards compatibility considerations:

Appian Execute Stored Procedure Behavior	Plug-in Execute Stored Procedure Behavior
Result sets exceeding the max result set size of 1000 rows are truncated.	No maximum result set size.
For stored procedures that return multiple result sets, results exceeding the cumulative max size of 10,000 rows are truncated.	No maximum cumulative result set size.
Error returned when duplicate or empty column names are found.	Columns with duplicate names are silently truncated. Empty column names are allowed.
Error returned when IN or INOUT parameters are not passed in inputs.	Missing IN and INOUT parameters are defaulted to null.
Supports data source connected systems and admin console data sources.	Supports only admin console data sources.

Finding all plug-in usage for a site

To find each instance that the Execute Stored Procedure plug-in is used, follow these steps:

Open the “OBJECTS” page in the Appian Designer and select the “PLUG-INS” tab.
Search and select the “Execute Stored Procedure” plug-in.
Click the “Dependents” button.

Upgrading fn!executeStoredProcedure

Upgrading to the Appian execute stored procedure functions is super easy. In most cases it will be as simple as changing the function name.

Update the function name from fn!executeStoredProcedure to a!executeStoredProcedureForQuery.
Change the dataSourceName parameter to dataSource. If you are upgrading to use a new data source connected system, use the connected system constant instead of copying the name of the admin console data source.
The a!executeStoredProcedureForQuery function requires all IN and INOUT parameters to be defined. If you have any missing IN or INOUT parameters, add them to inputs.
Test the expression.

Upgrading execute stored procedure smart service nodes

To upgrade execute stored procedure process model nodes, we recommend copying the properties from the process model documentation in a separate window and following the instructions below:

Drag and drop a new “Execute Stored Procedure” node into the process model next to the deprecated execute stored procedure plug-in node.
In the process model documentation, find the execute stored procedure plug-in node properties.
Copy each property from the process model documentation of the deprecated node. Note that the dataSourceName input will need to be copied into dataSource. The new execute stored procedure smart service requires all IN and INOUT parameters to be defined. If you have any missing IN or INOUT parameters, add them to as custom inputs. If you are upgrading to use a new data source connected system, use the connected system constant instead of copying the name of the admin console data source.
Remove the deprecated process model node.
Test the process model.