MSSQL Server

MSSQL Server



MSSQL Server 

This plugin has several steps for MSSQL Server operations.

This plugin is tested on Microsoft SQL Server 2008 R2 on Windows.

Prerequisites:

  1. SQL Server instance/port number and access details.
  2. SQL Server Browser windows service must be enabled on remote machine.
  3. mssql-jdbc-7.0.0.jre8.jar  must be present in the lib folder of Process Studio Distribution and AutomationEdge Agent). 


Error Handling:

Refer Appendix 1: Error Handling in IT Plugins


Following is a description of MSSQL steps.


Add Data files or Log files

Description

The plugin is designed to add Data file or Log file in MSSQL server database.


Configurations 

No.

Field Name

Description

1

Step Name

Name of the step.  This name has to be unique in a single workflow.


Connection:


2

Server Name  

The IP address of remote machine on which SQL server instance is present should be given. This field is mandatory.

3

Instance Name

The instance name of the MSSQL server should be provided. If we provide Instance name, Port number field will get disabled. Either Port or Instance Name is mandatory. 

4

Port

The port number of the MSSQL server should be provided. If we provide Port number, there is no need to provide Instance name. Port number should only be an integer. Port number field is disabled if an instance name is entered. 

Either Port or Instance Name is mandatory.

5

User Name  

The username of MSSQL server to authenticate.


Password:


6

Checkbox: Accept Value as variable/static

Leave checkbox unchecked to accept Password value from a field in the previous steps of the stream using a drop down list. 

Else enable checkbox for Password field to appear as Text box.

7

Password

The Password to the username to authenticate. Validate username and password to authenticate to SQL server instance. Password is entered using a widget. The widget handles both Text Var(static value or environment variable) and Combo(drop down containing values from previous steps). This field is mandatory.


If checkbox above is enabled Password field appears as Text box. Else if checkbox above is disabled Password field appears as a drop down to select fields from previous steps.


Button:


8

Test Connection

Verifies whether the connection is established or not.

NOTE: Test Connection button does not work for Previous step fields. Test Connection button only works with static values and environment variables.


Input Tab:

No.

Field Name

Description


Input Fields:


1

Database Name

Name of the Database on which the datafile/log file is to be created or Select from the list populated by clicking Get Database Button. This field is mandatory.

2

Button: Get database

Populates the list of database from the connected Instance.

3

Logical Name

Logical name of the data file or log file that is to be created. This field is mandatory.

4

File Type

Acceptable values are Rows Data or Log. When value is Rows Data, a datafile will be created and when value is Log, log file is created. This field is mandatory.

5

File Group

Name of the file group for the File Type(Ex: Primary is the file group for Rows Data file type)

6

Button: Get File Group

Populates the list of file groups from the selected database.

7

Initial Size(in MB)

Size of the file should be mentioned in MB. This field is mandatory.

8

Folder Path

Specify the browsed folder path to create the file. This field is mandatory.

9

Button: Browse

Browse the folder path where the file needs to be created.

10

File Name

Specify the physical name of the data file or log file.  This field is mandatory.

NOTE: Get Database, Get File Group and Browse button do not work for previous step variables. All the buttons work only with static values and environment variables.


Autogrowth:

No.

Field Name

Description


Autogrowth Fields:


1

Enable Autogrowth

Acceptable values are “Yes” or “No”. These are visible when you hover over the field. When value is Yes, it is considered that you want to enable autogrowth for the file.

If No is selected any entries made in the fields below is ignored.


File Growth:


2

Growth In Percent /In MB

Acceptable values are Percent or MB. If Percent is chosen then you specify growth value in percent below. If MB is chosen you are specifying an absolute value for file growth.

3

Value

Specify the value for growth of a file in percent or MB as chosen above.


Maximum File Size:


4

Unrestricted File Growth

Acceptable values are “Yes” or “No”. These are visible when you hover over the field. When value is Yes, it is considered that you want the Unlimited growth of the file.

If Yes is selected any entries in the field below are ignored.

5

Restricted File Growth(in MB)

If Unrestricted File Growth is No, specify the Restricted size to the file in MB


Output Tab:

No.

Field Name

Description


Output Fields:


1

Result

Output field to hold the result of the successful plugin execution. This field is mandatory.


Known Errors:

When you select values for Instance name or Port field from a previous step input (i.e. Generate Rows or Microsoft Excel Input etc.) the corresponding Port or Instance name is disabled but may be unlocked when revisited


Assign Server Roles

Description

The plugin is designed to give server related roles to the particular login user to perform server operations.


Configurations 

No.

Field Name

Description

1

Step Name

Name of the step.  This name has to be unique in a single workflow.


Connection:


2

Server name

The IP address of remote machine on which MSSQL server instance is present should be given.

3

Instance name

The instance name of the MSSQL server should be provided. If we provide Instance name, Port number field will get disabled. 

4

Port

The port number of the MSSQL server should be provided. If we provide Port number, there is no need to provide Instance name. Port number should only be an integer.

5

Username

The login username of MSSQL server to authenticate.

6

Password

The password to the login username to authenticate. 

The step validates username and password to authenticate to SQL server instance.


Button:


7

Test Connection

Verifies whether the connection is established or not.

NOTE: Test Connection button does not work for Previous step fields. Test Connection button only works with static values and environment variables.


Input Tab:

No.

Field Name

Description


Input Fields:


1

Server Roles

Name of the Server Roles which is to be given to the user. This plugin is designed to assign single server role at a time.

2

Get Roles Button

Clicking on this button brings a dialog for the available Roles on that particular SQL server instance

3

Login Users

The login user on which the role is to be applied.

4

Get Users Button

Clicking on this button brings a dialog for the available Login Users on that particular SQL server instance


Output Tab:

No.

Field Name

Description


Output Fields:


1

Result

Output field to hold the result of the successful plugin execution



Create Database

Description

The step is used to create a database in MSSQL server.

Configurations 

No.

Field Name

Description

1

Step Name

Name of the step.  This name has to be unique in a single workflow.


Connection:


2

Server Name  

The Hostname/Server Name/IP of the MSSQL Server. This field is mandatory. Drop down is available.

3

Instance name

The instance name of MSSQL Server instance. One of the two fields Instance name or Port is mandatory. Only variables/static values are allowed.

4

Port

The port number of the MSSQL Server. One of the two fields Instance name or Port is mandatory. Only variables/static values are allowed.

5

Username

A username of the MSSQL Server. This field is mandatory. 


Password:


6

Checkbox: Accept Value as variable/static

Leave checkbox unchecked to accept Password value from a field in the previous steps of the stream using a drop down list. 

Else enable checkbox for Password field to appear as Text box.

7

Password

Provide the password of the username of MSSQL Server. Password is entered using a widget. The widget handles both Text Var(static value or environment variable) and Combo(drop down containing values from previous steps). This field is mandatory.


If checkbox above is enabled Password field appears as Text box. Else if checkbox above is disabled Password field appears as a drop down to select fields from previous steps.


Button:


8

Test Connection

Verifies whether the connection is established or not.

NOTE: Test Connection button does not work for previous step fields. Test Connection button only works with static values and environment variables.


Input Tab:

No.

Field Name

Description


Input Fields:


1

Database Name

The name of the new database to be created.


Output Tab:

No.

Field Name

Description


Output Field:


1

Result

Output field to hold the result of successful plugin execution. This field is mandatory.

Error Handling:

Refer Appendix 1: Error Handling in IT Plugins




Create Login User

Description

The plugin is designed to create login user for the MSSQL Server.

This plugin is only valid for SQL Server Authentication and not Windows Authentication.


Configurations 

No.

Field Name

Description

1

Step Name

Name of the step.  This name has to be unique in a single workflow.


Connection:


2

Server Name  

The IP address of remote machine on which SQL server instance is present should be given.

3

Instance Name

The instance name of the SQL server should be provided. If we provide Instance name, Port number field will get disabled. 

4

Port

The port number of the SQL server should be provided. If we provide Port number, there is no need to provide Instance name. Port number should only be an integer.

5

User Name  

A username of SQL server to authenticate.


Password:


6

Checkbox: Accept Value as variable/static

Leave checkbox unchecked to accept Password value from a field in the previous steps of the stream using a drop down list. 

Else enable checkbox for Password field to appear as Text box.

7

Password

Provide the password of the username of MSSQL Server. Password is entered using a widget. The widget handles both Text Var(static value or environment variable) and Combo(drop down containing values from previous steps). This field is mandatory.


If checkbox above is enabled Password field appears as Text box. Else if checkbox above is disabled Password field appears as a drop down to select fields from previous steps.


Button:


8

Test Connection

Verifies whether the connection is available or not.

NOTE: Test Connection button will not work for Previous step variables. Test Connection button will only work with static values and environment variables.


Input Tab:

No.

Field Name

Description


Input Fields:


1

NewUser

Name of the User which is to be created for login.

2

Password

Password given to the user. But it must have complex & fulfill windows policy.

3

Enforced Password Policy

Acceptable values are “Yes” or “No”. User can select appropriate value as per requirement (Password policy is as per windows password policy). When it is set to Yes, it is considered that the password is enforced as per the policy in the system.


  1. When input to this field is provided as workflow variable or static value then,
  1. If Yes is selected, the below two fields are auto populated with Yes. However, they can be set to No also. 
  2. If No is selected the below two fields are auto populated with No. 
  1. However, when values are chosen from drop down choosing a field from previous steps, it does not auto populate “Enforced password Expiration” and “User Must Change Password on First Login”. The default values are the same as this field or user can set these values manually. 

4

Enforced password Expiration

It manages the lifespan of the password as per Windows policy. 


Acceptable values are “Yes” or “No”. Default value is set as the value in the field above “Enforced Password Policy”. 


  1. When input to this field is provided as workflow variable or static value
  1. If Yes is set in this field the below field is auto populated with Yes. However, it can be set to No also. 
  2. If No is selected the below field is auto populated with No. Only NO is valid in this case. Setting to Yes would cause runtime error.
  1. However, when values are chosen from drop down to choose a field from previous steps, it does not auto populate “User Must Change Password on First Login”. User needs to set Yes/No. 

5

User Must Change Password at Next Login

Acceptable values are “Yes” or “No”. 

When value is Yes it asks to user to change the password on the next login.    

  1. Default value is set as the value in the field above “Enforced Password Expiration”.  If “Enforced Password Expiration” is No valid value is only No. If “Enforced Password Expiration” value is Yes both Yes and No are valid. 
  2. When it is set to blank, it is considered as “Yes” while executing the workflow.
  3. If the value is taken from previous fields that are empty then the plugin considers the value as Yes


Output Tab:

No.

Field Name

Description


Output Field:


1

Result

The output field holds the result of successful plugin execution. 

Error Handling:

Refer Appendix 1: Error Handling in IT Plugins




Delete Login User

Description

This Plugin is used to delete a Login User in Microsoft SQL Server. 

Limitation: 

This plugin is only valid for SQL Server Authentication and not Windows Authentication.

Configurations 

No.

Field Name

Description

1

Server Name/IP

The Hostname/serve name/IP of the MSSQL database. This field is mandatory.

2

Instance name

The instance name of MS SQL Server instance. Either Instance or Port Number is mandatory.

3

Port Number

The port number of the MSSQL database. Port number should only be an integer. Port number will get disabled if an instance name is entered. Either Instance or Port Number is mandatory.

4

Username

The username having permission to take database backup  (e.g.:- sa). This field is mandatory.


Password:


5

Checkbox: Accept Value as variable/static

Leave checkbox unchecked to accept Password value from a field in the previous steps of the stream using a drop down list. 

Else enable checkbox for Password field to appear as Text box.

6

Password

Provide the password of the username of MSSQL Server. Password is entered using a widget. The widget handles both Text Var(static value or environment variable) and Combo(drop down containing values from previous steps). This field is mandatory.


If checkbox above is enabled Password field appears as Text box. Else if checkbox above is disabled Password field appears as a drop down to select fields from previous steps.


Button:


7

Test Connection

Verifies whether the connection is established or not.

NOTE: Test Connection button does not work for Previous step fields. Test Connection button only works with static values and environment variables.


Input Tab:

No.

Field Name

Description


Input Fields:


1

Login Username

Specify the Login Username that needs to be deleted. Login username is mandatory.


Output Tab:

No.

Field Name

Description


Output Fields:


1

Result  

Output field to hold the result of the successful plugin execution. This field is mandatory.

Error Handling: Appendix 1: Error Handling in IT Plugins





Modify Data files or Log files

Description

The plugin is designed to modify Data file or Log file in MSSQL server database.

Following parameters can be modified:

  1. Logical Name
  2. Initial Size
  3. Auto Growth

Configurations 

No.

Field Name

Description

1

Step Name

Name of the step.  This name has to be unique in a single workflow.


Connection:


2

Server Name  

Provide the hostname/server name/IP address of SQL server instance. This field is mandatory.

3

Instance Name

The instance name of the MSSQL server should be provided. If we provide Instance name, Port number field is disabled. Either Port or Instance Name is mandatory.

4

Port

The port number of the MSSQL server should be provided. If we provide Port number, there is no need to provide Instance name. Port number should only be an integer

Port number field is disabled if an instance name is entered.

Either Port or Instance Name is mandatory.

5

User Name  

The username of MSSQL server to authenticate.


Password:


6

Checkbox: Accept Value as variable/static

Leave checkbox unchecked to accept Password value from a field in the previous steps of the stream using a drop down list. 

Else enable checkbox for Password field to appear as Text box.

7

Password

The Password to the username to authenticate. Validate username and password to authenticate to SQL server instance. Password is entered using a widget. The widget handles both Text Var(static value or environment variable) and Combo(drop down containing values from previous steps). This field is mandatory.


If checkbox above is enabled Password field appears as Text box. Else if checkbox above is disabled Password field appears as a drop down to select fields from previous steps.


Button:


8

Test Connection

Verifies whether the connection is established or not.

NOTE: Test Connection button does not work for Previous step fields. Test Connection button only works with static values and workflow parameters/variables.


Input Tab:

No.

Field Name

Description


Input Fields:


1

Database Name

Name of the Database on which the datafile/log file is to be created or Select from the list populated by clicking Get Database Button. This field is mandatory.

2

Button: Get database

Populates the list of database from the connected Instance.

3

Logical Name

Name of the data file or log file that is to be modified. This field is mandatory.

4

Button: 

Get Logical Name

Populates the list of files from the selected database.

5

New Logical Name

New name to the specified data file or log file. If value entered then Logical file name will be changed to the specified name

8

Initial Size(in MB)

Size of the file should be mentioned in MB.

If a value is provided then it is considered that you want to modify the Initial Size of the file chosen above. 

NOTE: Get Database, Get File Group and Browse button does not work for previous step variables. All the buttons work only with static values and environment variables.


Autogrowth Tab:

No.

Field Name

Description


Autogrowth Fields:


1

Enable Autogrowth

Acceptable values are “Yes” or “No”. These are visible when you hover over the field. When value is Yes, it is considered that you want to enable Autogrowth for the file.

If No is selected any entries made in the fields below is ignored.


File Growth:


2

Growth In Percent /In MB

Acceptable values are Percent or MB. If Percent is chosen then you specify growth value in percent below. If MB is chosen you are specifying an absolute value for file growth.

3

Value

Specify the value for growth of a file in percent or MB as chosen above.


Maximum File Size:


4

Unrestricted File Growth

Acceptable values are “Yes” or “No”. These are visible when you hover over the field. When value is Yes, you allow the Unlimited growth of the file. 

If Yes is selected any entries in the field below are ignored.

5

Restricted File Growth(MB)

If Unrestricted File Growth is No, specify the Restricted size to the file in MB


Output Tab:

No.

Field Name

Description


Output Fields:


1

Result

Provide the name of an output field to hold the result of the successful plugin execution. This field is mandatory.


Known Issue:

When you select values for Instance name or Port field from a previous step input (i.e. Generate Rows or Microsoft Excel Input etc.) the corresponding Port or Instance name is disabled but may be unlocked when revisited




Reset Login User Password

Description

This Plugin is used to reset the password for the specified Login User of Microsoft SQL Server.


This plugin is only valid for SQL Server Authentication and not Windows Authentication.


Configurations 

No.

Field Name

Description

1

Server Name/IP

The Hostname/serve name/IP of the MSSQL database. This field is mandatory.

2

Instance name

The instance name of MS SQL Server instance. Either Instance or Port Number is mandatory.

3

Port Number

The port number of the MSSQL database. Port number should only be an integer. Port number will get disabled if an instance name is entered. Either Instance or Port Number is mandatory.

4

Username

The username having permission to reset login user password  (e.g. sa)


Password:


5

Checkbox: Accept Value as variable/static

Leave checkbox unchecked to accept Password value from a field in the previous steps of the stream using a drop down list. 

Else enable checkbox for Password field to appear as Text box.

6

Password

The password of the user to authenticate to MSSQL servers. Password is entered using a widget. The widget handles both Text Var(static value or environment variable) and Combo(drop down containing values from previous steps). This field is mandatory.


If checkbox above is enabled Password field appears as Text box. Else if checkbox above is disabled Password field appears as a drop down to select fields from previous steps.


Button:


7

Test Connection

Verifies whether the connection is established or not.

NOTE: Test Connection button does not work for Previous step fields. Test Connection button only works with static values and environment variables.


Input Tab:

No.

Field Name

Description


Input Fields:


1

Step Name

Name of the step. This name has to be unique in a single workflow.

2

Login Username

Specify the Login username to reset the password. 

3

New Password

Specify the new password for the provided username


Output Tab:

No.

Field Name

Description


Output Field:


1

Result 

Output field to hold the result of the successful plugin execution. This field is mandatory.

Error Handling:

Refer Appendix 1: Error Handling in IT Plugins



Shrink Database

Description

The plugin is designed to shrink database in SQL server. Most databases require some free space to be available for regular day-to-day operations. If you shrink a database repeatedly and notice that the database size grows again, this indicates that the space that was shrunk is required for regular operations.


Configurations 

No.

Field Name

Description

1

Step Name

Name of the step.  This name has to be unique in a single workflow.


Connection:


2

Server Name  

The IP address of remote machine on which SQL server instance is present should be given.

3

Instance Name

The instance name of the MSSQL server should be provided. If we provide Instance name, Port number field will get disabled. 

4

Port

The port number of the MSSQL server should be provided. If we provide Port number, there is no need to provide Instance name. Port number should only be an integer. Port number field is disabled if an instance name is entered.

5

Username  

The username of MSSQL server to authenticate.


Password:


6

Checkbox: Accept Value as variable/static

Leave checkbox unchecked to accept Password value from a field in the previous steps of the stream using a drop down list. 

Else enable checkbox for Password field to appear as Text box.

7

Password

The Password to the username to authenticate. Validate username and password to authenticate to SQL server instance. Password is entered using a widget. The widget handles both Text Var(static value or environment variable) and Combo(drop down containing values from previous steps). This field is mandatory.


If checkbox above is enabled Password field appears as Text box. Else if checkbox above is disabled Password field appears as a drop down to select fields from previous steps.


Button:


8

Test Connection

Verifies whether the connection is established or not.

NOTE: Test Connection button does not work for Previous step fields. Test Connection button only works with static values and environment variables.


Input Tab:

No.

Field Name

Description

1

Input Fields:


2

Database

Name of the Database which to shrink. Field value is to be selected from the prompt by clicking on the Get databases button. This field is mandatory.

3

Button: 


4

Select databases

Clicking on this button brings a dialog for the available databases on that particular SQL server instance. This field is mandatory.


Select Database button does not work for previous step variables. Select Database button only works with static values and environment variables.


Output Tab:

No.

Field Name

Description


Output Field:


1

Result

Output field to hold the result of the successful plugin execution. This field is mandatory.

Error Handling:

Refer Appendix 1: Error Handling in IT Plugins



Shrink Files


Description

The plugin is designed to shrink the size of the data and log files in the specified database of SQL server. 


Configurations 

No.

Field Name

Description

1

Step Name

Name of the step.  This name has to be unique in a single workflow.


Connection:


2

Server Name  

The IP address of remote machine on which MSSQL server instance is present should be given.

3

Instance name

The instance name of the MSSQL server should be provided. If we provide Instance name, Port number field will get disabled.

4

Port

The port number of the MSSQL server should be provided. If we provide Port number, there is no need to provide Instance name.

Port number should only be an integer.

5

User Name  

The username of MSSQL server to authenticate.


Password:


6

Checkbox: Accept Value as variable/static

Leave checkbox unchecked to accept Password value from a field in the previous steps of the stream using a drop down list. 

Else enable checkbox for Password field to appear as Text box.

7

Password

The Password to the username to authenticate. Validate username and password to authenticate to SQL server instance. Password is entered using a widget. The widget handles both Text Var(static value or environment variable) and Combo(drop down containing values from previous steps). This field is mandatory.


If checkbox above is enabled Password field appears as Text box. Else if checkbox above is disabled Password field appears as a drop down to select fields from previous steps.


Button:


8

Test Connection

Verifies whether the connection is available or not. Validates username and password to authenticate to MSSQL server instance.

NOTE: Test Connection button will not work for Previous step variables. Test Connection button will only work with static values and environment variables.


Input Tab:

No.

Field Name

Description


Input Fields:


1

Database

Name of the Database for which data or log file is to be shrinked. Field value is to be selected from the prompt by clicking on the Select database button. 

2

Select database

Clicking on this button brings a dialog for the available databases on that particular SQL server instance.

3

File type

Type of the files to be deleted of a particular database i.e. Data files, Log files must be selected.

4

File name

Name of the file to be shrinked must be selected. Field value is to be selected from the prompt by clicking on the Select file button.

5

Select file

Clicking on this button brings a dialog for the available files of a particular database.



Output Tab:

No.

Field Name

Description


Output Fields:


1

Result

Output field to hold the result of the successful plugin execution. This field is mandatory.

Error Handling:

Refer Appendix 1: Error Handling in IT Plugins



Start SQL Agent Job

This plugin is designed to Start Agent Job to handle other automated tasks.

This step only ensures start of SQL agent job and not monitoring the completion of action(s) (successful execution) present in the job.


Prerequisites:

  1. SQL Server instance and access details
  2. SQL Server Browser service must be enabled on remote machine.
  3. SQL Server Agent must be enabled.
  4. sqljdbc4-4.0.jar must be present in lib folder of Process Studio as well as AE agent.
  5. SQL Server has the following msdb database fixed database roles, which gives administrators control over access to SQL Server Agent. The roles are:
  1. SQL Agent User Role
  2. SQL Agent Reader Role
  3. SQL Agent Operator Role


Description

This plugin is designed to Run or start Agent Job to handle other automated tasks.


Configurations 

No.

Field Name

Description

1

Step Name

Name of the step.  This name has to be unique in a single workflow.


Connection:


2

Server Name/IP

The IP address of remote machine on which MSSQL server instance is present should be given.

3

Instance name

The instance name of the MSSQL server should be provided. If we provide Instance name, Port number field will get disabled. 

4

Port Number

The port number of the MSSQL server should be provided. If we provide Port number, there is no need to provide Instance name.

5

Username

The username of MSSQL server to authenticate.

6

Password

The Password to the username to authenticate.


Button:


7

Test Connection

Verifies whether the connection is established or not. Validates username and password to authenticate to MSSQL server instance

NOTE: Test Connection button does not work for Previous step fields. Test Connection button only works with static values and environment variables.


Input Tab:

No.

Field Name

Description


Input Fields:


1

Job Name

Name of the job to start.

2

Button: Get 

Clicking on this button brings a dialog for the available jobs on that particular SQL server instance

Get Button will work for user having system admin’s permission or having agent roles mentioned below with access on msdb.dbo.sysjobs table.


Output Tab:

No.

Field Name

Description


Output Fields:


1

Result  

Output field to hold the result of the successful plugin execution




Stop Agent Job

Description

This plugin is designed to stop Agent Job of particular SQL server agent to handle other automated tasks.


Configurations 

No.

Field Name

Description

1

Step Name

Name of the step.  This name has to be unique in a single workflow.


Connection:


2

Server Name/IP

The IP address or fully qualified domain name of the machine on which MSSQL server instance is present.

3

Instance name

The instance name of the MSSQL server should be provided. If we provide Instance name, Port number field will get disabled. 

4

Port Number

The port number of the MSSQL server should be provided. If we provide Port number, there is no need to provide Instance name.

5

Username

The username of MSSQL server to authenticate.

6

Password

The Password to the username to authenticate.


Button:


7

Test Connection

Verifies whether the connection is established or not. Validates username and password to authenticate to MSSQL server instance

NOTE: Test Connection button does not work for Previous step fields. Test Connection button only works with static values and environment variables.


Input Tab:

No.

Field Name

Description


Input Fields:


1

Job Name

Name of the job to be stopped.

2

Button: Get 

Clicking on this button brings a dialog for the available jobs on that particular SQL server instance


Get Button will work for user having system admin’s permission or having agent roles mentioned below with the access on msdb.dbo.sysjobs table.



Output Tab:

No.

Field Name

Description

1

Output Fields:


2

Result

Output field to hold the result of the successful plugin execution



Unlock Login User

Description

This Plugin unlocks the Login User of Microsoft SQL Server.


Limitations:

This plugin is only valid for SQL Server Authentication and not Windows authentication.


Configurations 

No.

Field Name

Description

1

Step Name

Name of the step.  This name has to be unique in a single workflow.


Connection:


2

Server Name/IP

The Hostname/serve name/IP of the MSSQL database.

3

Instance name

The instance name of MSSQL Server instance.

4

Port Number

The port number of the MSSQL database.

5

Username

The username having permission to take database backup  (Ex:- sa)


Password:


6

Checkbox: Accept Value as variable/static

Leave checkbox unchecked to accept Password value from a field in the previous steps of the stream using a drop down list. 

Else enable checkbox for Password field to appear as Text box.

7

Password

The password of the user to authenticate to MSSQL servers. Password is entered using a widget. The widget handles both Text Var(static value or environment variable) and Combo(drop down containing values from previous steps). This field is mandatory.


If checkbox above is enabled Password field appears as Text box. Else if checkbox above is disabled Password field appears as a drop down to select fields from previous steps.


Button:


8

Test Connection

Verifies whether the connection is established or not. Validates username and password to authenticate to MSSQL server instance

NOTE: Test Connection button does not work for Previous step fields. Test Connection button only works with static values and environment variables.



Input Tab:

No.

Field Name

Description


Input Fields:


1

Login Username

Specify the Login Name which needs to be unlocked.


Output Tab:

No.

Field Name

Description


Output Fields:


1

Result  

Output field to hold the result of the successful plugin execution.is field is mandatory.

Error Handling:

Refer Appendix 1: Error Handling in IT Plugins






      Links to better reach 

            Bot Store

             EPD