Skip to content

Update StoredProc.md #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
bzerangue wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update StoredProc.md #11

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions Widgets/WidgetTemplate/StoredProc/StoredProc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
# Stored Procedure Definition

Use this folder to include any sql scripts designed to install Stored Procedures required for the Csutom Widget to work. Please follow the pattern of including a fully installable script including required MinistryPlatform metadata. Examplesa are included to aid in quickly developing installable Stored Procedure scripts
Use this folder to include any SQL scripts designed to install stored procedures required for the Custom Widget to work. Please follow the pattern of including a fully installable script including required MinistryPlatform metadata. Examples are included to aid in quickly developing installable Stored Procedure scripts.

## Installation Notes

All examples in this repository will install the stored procedure, then check API_Procudures for the relevant metadata that defines the stored procedure. Additionally, install scripts will give the Administrators security role access to the script.
All examples in this repository will install the stored procedure, then check API_Procedures for the relevant metadata that defines the stored procedure. Additionally, the install scripts will give the Administrators security role access to the script.

## Standard Parameters

The Custom Widget API will attempt to pass @UserName when the website user is logged into widgets. It is highly recommend that you include the @UserName parameter in all Custom Widget Stored Procedures. If @UserName is not required, you should default this parameter to null. When NOT NULL, the absense of this parameter will cause the stored procedure to fail.
The Custom Widget API will attempt to pass `@UserName` when the website user is logged into widgets. It is highly recommended that you include the `@UserName` parameter in all Custom Widget Stored Procedures. If `@UserName` is not required, you should default this parameter to null. When NOT NULL, the absence of this parameter will cause the stored procedure to fail.

Example:

```
```sql
@UserName nvarchar(75) = null
```