Creating a Web Service Solution with the Web Service Integration Wizard

Creating a Web Service Solution with the Web Service Integration Wizard

Prerequisite

• To bind to a web service eith the service tyoe "WCF", the file SvcUtil,exe must exist in the One Identity Manager installation directory.

  Refer to Microsoft for information about where you can purchase this file.

• To bind a web service to the service type "SOAP", the file WSDL.exe must be on the server, which ran provisioning.

  Refer to Microsoft for information about where you can purchase this file.

To integrate a new web service

1. Select the category Base Data | General | Web services in the Designer.
2. Select Integrate new web service from the task view.

   This start the Web Service Integration Wizard.

3. On the start page, click Next..
4. Enter the access data and general web service properties on the Integrate new web service page.

   Table 328: General Web Service properties

   Properties	Description
   Web service name	Display name for the web service in One Identity Manager.
   Description	Spare text box for additional explanation.
   .Net namespace for the proxy code	Unique identifier for the .NET namespace.
   Web service URL	URL under which the web service is run.
   WSDL files URL	URL, under which the web service's WSDL.exe can be reached. If the WSDL.exe is not publicly available, it can also be saved locally. NOTE: If the web service operator changes the WSDL file, run the Web Service Integration Wizard again in order to make use of the changes.
   Service type	Type of web service.
   Locked	Specifies whether the web service can be used.
   User name	User name for logging in to the web service.
   User domain	User's domain.
   User password and password confirmation	Password data for logging in to the web service.
   Proxy code generator	Path and file name for the proxy code generator. If the service type "WCF" is selected, path to file SvcUtil.exe. If the service type "SOAP" is selected, path to file WSDL.exe.

   Table 329: Web Services extended properties

   Property	Description
   Proxy server URL	URL of the proxy server, if communication is diverted over a proxy server.
   Proxy server user name	User name for logging in to the proxy server.
   Proxy server domain	Domain of the proxy server.
   Proxy server password and password confirmation	Password and password confirmation for logging in to the proxy server.
   Timeout for WSDL.exe	Timeout for accessing the WSDL file.
   User defined command line	Command line for calling the proxy code generator. The command line can extended by another parameter if required. Default command: /nologo /language:VB "/namespace:%Namespace%" "/out:{0}" %WsdlUrl% Example: /nologo /language:VB "/namespace:EnricoHolidayWebservice" "/out:{0}" http://kayaposoft.com/enrico/ws/v1.0/index.php?wsdl

   1. Click Check...

      This tests access to the web service.

   2. If the test is successful, click Next.
5. The generated proxy code is shown on the page, Create proxy code.

   The proxy code contains all web service methods, which are defined in the WSDL file and makes them available to the One Identity Manager script components.

6. Select the web service methods you want to use in One Identity Manager on the Select method calls page. A script is generated for each of the selected methods in the next step.
7. A script is generated to call the selected method on the Generate web service call page. Enter all the required parameter and properties for this.
   • Click to specify the type of method call.

     Table 330: Method Call Type

     Type	Description
     Self-defined web service call	For more information, see Self-Defined Web Service Call.
     Direct web service call	For more information, see Direct Web Service Call.
     Generic web service call	For more information, see Generic Web Service Call.

   Table 331: Script properties

   Property	Description
   Script name	Name of the script. Label custom scripts with the prefix "CCC_". Script names for the generic method call must follow the following format:<customer prefix>_<table>_<target system>_<event> Select the table, target system and event to create the script for. Parameter, value type and data table are automatically determined from the selected table.
   Parameter	Name of the parameter.
   Value type	Data type of the parameters.
   Data table	Data table, which contains the data to be passed to the web service.
   Return value	Data type of the parameter that contains the return value.

   Table 332: Data mapping

   Property	Description
   Parameter	Parameter passed to the web service.
   Value type	Data type of the parameters.
   Mapped from	Parameter from the defined script properties. Open the menu and assign the associated parameters. If necessary, select the column from the data table which contains the value to be passed.

   You will see the generated script in the script code view. You can use extended edit mode to edit the script.

   TIP: The script call the function VID_GetWcfWebService, which in turn, uses the functions GetWcfBinding and GetWcfEndpointAddress. These three functions can be overwritten.

8. To end the Web Service Integration Wizard, click Finish.
9. Save the changes.
10. Compile the database.

Related Topics

• One Identity Manager Scripts
• Support for Scripting
• Overriding Scripts

Changing a Web Service Solution

You can change or extend an existing web service solution at any time. This overwrites the existing script or adds new scripts.

To extend a web service solution

1. Select the category Base Data | General | Web services in the Designer.
2. Select the web service in the List Editor.
3. Select Create web service call in the task view.

   This start the Web Service Integration Wizard.

4. Follow the wizard's instructions.
5. Save the changes.
6. Compile the database.

To edit a web service solution

1. Select the category Base Data | General | Web services in the Designer.
2. Select the web service in the List Editor.
3. Select Edit web service <web service name> from the task view.

   This start the Web Service Integration Wizard.

4. Follow the wizard's instructions.
5. Save the changes.
6. Compile the database.

Detailed information about this topic

• Creating a Web Service Solution with the Web Service Integration Wizard

Deleting a Web Service Solution

To delete a web service solution from the database

1. Delete the web service.
2. Delete all associated custom scripts.
3. Determine all other custom element of your web service solution and delete them.
4. Save the changes.
5. Compile the database.

SOAP Web Service

SOAP Web Service

The One Identity Manager's SOAP Web Service provides an SOAP interface for accessing the One Identity Manager object model. The SOAP Web Service manages a connection pool. Not every call opens a new connection. Not all object layer functions are support by the SOAP Web Service. The SOAP Web Service supplies methods for single objects, object lists and function call.

Detailed information about this topic

• Installing and Configuring the SOAP Web Service
• Examples of Calls