Creating Custom Provisioning Operations
For users comfortable with SQL, it is possible to harness the power of the Provisioning Service to perform simple or complex bulk operations in WorkSite for one-off or repeated jobs. These custom operations can then be made available to Milan users either through the Ad Hoc Operations tab in Report Center or the Scheduled Operations button on the Provisioning Service tab in Service Center.
Creating a Custom Provisioning Service Job
To create your own custom Provisioning Service jobs, you must:
- Write an SQL script to insert Provisioning Service jobs into the Milan.WorkspaceQueue and Milan.WorkspaceDetailQueue tables
- Install the script as a stored procedure in the Milan database
- Configure the custom operations dialog for inputting parameter values in the Milan web client
For detailed information on how to create a custom operation script, refer to Creating Provisioning Jobs Through the SQL API.
Installing a Stored Procedure
To create a stored procedure in the Milan database:
- Create a new script file in Microsoft SQL Server Management Studio.
- Add a CREATE PROCEDURE statement.
- Define the parameters used in the script.
- Insert the code for your custom script between BEGIN and END statements.
- Execute the script against your Milan database.
The following code can be used as a template for creating new stored procedures.
SET ANSI_NULLS ON
GO
SET QUOTED_IDENTIFIER ON
GO
-- =============================================
-- Comments section for script details, description, etc.
-- =============================================
CREATE PROCEDURE <Procedure_Name, sysname, ProcedureName>
-- Define parameters for the stored procedure here
<@Param1, sysname, @p1> <Datatype_For_Param1, , int> = <Default_Value_For_Param1, , 0>,
<@Param2, sysname, @p2> <Datatype_For_Param2, , int> = <Default_Value_For_Param2, , 0>
AS
BEGIN
-- SET NOCOUNT ON added to prevent extra result sets from
-- interfering with SELECT statements.
SET NOCOUNT ON;
-- Insert statements for procedure here
SELECT <@Param1, sysname, @p1>, <@Param2, sysname, @p2>
END
GO
Configuring a Web Client Dialog
To configure the web client dialog for a custom operation:
- Open C:\Program Files\Prosperoware.Milan\data\service.sp.config in a text or XML editor.
- Under the <serviceProperties> tag, insert a new empty element tag <serviceProperty /> for each parameter in the stored procedure.
- Within each <serviceProperty> tag, insert the following attributes and assign appropriate values based on the specific parameter.
Attribute Description name The name of the parameter in the stored procedure description The label to be displayed next to the control in the custom operation dialog type The type of control to display; valid values include textfield, checkbox, radio, combo, superselectbox (multi-select combo box,), datefield, numberfield, and button attrId The name of an imProfile field to map to the control; this attribute should only be set with the superselectbox type isCriterion In order for the control to be visible in any dialog, this attribute must be set to true. - Under the <services> tag, insert a new empty element tag <service/>.
- Within the <service /> element, insert the following attributes.
Attribute Description name The name of the operation op The name of the stored procedure to associate with the dialog title The text displayed in the title bar of the dialog buttonTitle The text displayed in either the Adhoc Operations or Scheduled Operations list handler A unique handler name for the operation; the value must be in the format "showService('name')", where name is the value of the name attribute listed above jobtype Specifies where the operation will be displayed in the web client
Value Custom Operation Displayed In adhoc Adhoc Operations tab in Report Center schedule Scheduled Operations menu on Provisioning Service tab in Service Center
- Under the service tag created in the previous two steps, insert a copy of the tag <serviceProperty /> for each parameter.
- In each <serviceProperty /> tag, insert the attribute ref and set the value to a parameter name. For example, <serviceProperty ref="p_custom2"/>.
- Save your changes to service.sp.config. If you have the Service Center or Report Center tab open, refresh the page to see the new option.
