Prerequisite
-
Before you can bind a web service with the WCF service type, the SvcUtil,exe file must exist in the One Identity Manager installation directory.
Refer to Microsoft for information about where you can purchase this file.
-
Before you can bind a web service with the SOAP service type, the WSDL.exe file must be on the server that carried out the provisioning.
Refer to Microsoft for information about where you can purchase this file.
To integrate a new web service
-
In the Designer, select the Base Data > General > Web services category.
-
Select the Integrate new web service task.
This start the Web Service Integration Wizard.
-
Click Next on the start page.
-
Enter the access data and general web service properties on the Integrate new web service page.
Table 179: General properties of a web service Property Description Web service name
Display name of the web service in One Identity Manager.
Description
Text field for additional explanation.
.NET namespace for the proxy code
Unique identifier for the .NET namespace.
Web service URL
URL at which the web service is run.
WSDL file URL
URL at which the WSDL.exe for the web service 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 implement 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 domain.
User password and password confirmation
Password for logging in to the web service.
Proxy code generator
Path and file name for the proxy code generator.
-
If the WCF service type is selected, path to SvcUtil.exe file.
-
If the SOAP service type is selected, path to WSDL.exe file.
Table 180: Advanced properties of a web service Property Description Proxy server URL
URL of the proxy server, if communication is routed through a proxy server.
Proxy server user name
User name for logging onto the proxy server.
Proxy server domain
Proxy server domain.
Proxy server password and password confirmation
Password and password confirmation for logging onto 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
-
Click Check.
This tests access to the web service.
-
If the test is sucessful, click Next.
-
-
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.
-
On the Select the service class page, select the service class that you want to use.
If more than one service classes are available, a separate web service connection must be established for each service class.
-
On Select method calls, select the web service methods you want to use in One Identity Manager. A script is generated for each of the selected methods in the next step.
-
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 181: Type of method call Type Description Self-defined web service call
Direct web service call
Generic web service call
Table 182: Script properties Property Description Script name
Name of script. Prefix custom scripts with CCC_.
Script names for the generic web service call must comply with the following pattern:
<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
Parameter data type.
Data table
Data table that contains the data to be transferred to the web service.
Return value
Data type of the parameter containing the return value.
Table 183: Data transfer Property Description Parameter
Parameter transferred to the web service.
Value type
Parameter data type.
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. In the Script code view, you see the generated script. You can use extended edit mode to edit the script.
TIP: The script calls the VID_GetWcfWebService function, which in turn, uses the GetWcfBinding and GetWcfEndpointAddress functions. These three functions can be overwritten.
-
-
To end the Web Service Integration Wizard, click Finish.
- Save the changes.
- Compile the database.