Creating a New Web Service Object in Web Tools
The Web Service Wizard lets you define Web services by importing WSDL or JSON files in to the Siebel CRM Repository. This provides a way to connect to external Web services without the need to manually define the external Web services (by creating, for example, the required integration objects and business services). The following procedure shows how to create a new Web service object, using the Web Service Wizard, in Web Tools.
To create a new Web service object in Web Tools
-
Click New Object Wizards (the magic wand icon) on the application banner.
The following message appears if you are in a non editable Workspace: Workspace is not editable. (SBL-DAT-60352).
For more information about New Object Wizards, see Using the New Object Wizard.
-
Select Web Service from the list of wizards that appear and then click Start to start the Web Service Wizard.
-
Click Upload File to select the WSDL/JSON file, containing the Web service definition, you want to import.
The name of the WSDL/JSON file appears in the File Name field. Alternatively, you can specify a URL from which to download the JSON/WSDL to import. To do this, click the radio button next to the URL. This will enable the field in which you can paste a URL.
-
Click Next to continue.
The Web Service Wizard validates the WSDL/JSON file and displays a summary of the actions it will take. The wizard also generates some files for download, including the following:
-
The original input file (that you uploaded in step 3).
-
Intermediate transformation files, showing how the input was converted into a business service and integration objects.
-
Log files, which might help if the import fails or is successful but the result is not what you were expecting.
-
XML file for use in the runtime configuration.
If you want to download these files, then you should do so now since these are temporary files which will be removed when you finish the wizard. If you forget to download the runtime configuration data file (the most important file), you can regenerate it from the Web Services Administration view.
-
-
Click Submit when you are ready to commit the changes.
The XML runtime file will be generated.
-
Click Finish to close the wizard.
The integration objects and business service will be placed in to the current Workspace and the XML runtime file will be available. If the file that you uploaded is not valid, then the wizard will show an error in the Validation Results window. In some failure cases, you can download additional log or intermediate files to get more information (these will only be available if the wizard was able to get far enough to generate them).
Representing JSON data types in Integration Component Fields
When the Web Service wizard imports JSON, a mapping must be done between the datatypes found in the incoming JSON, and how Siebel CRM can represent them in the created Integration Components. One of the ways it does this is to use the “format” Integration Component Field User Property. For certain types of data such as dates and times, the import wizard will create the format user property as a hint to Siebel CRM to determine what type of data is expected in that field. The formats that will be implemented for these Fields using the format user property are compliant with the current swagger format and a reference to them can be found here:
https://swagger.io/docs/specification/v3_0/data-models/data-types
For example, dates and date-time data will be represented in this way:
Field User Property Name | Field Datatype | Value | Data Example |
---|---|---|---|
format | DTYPE_DATE | date | 2017-07-21 |
format | DTYPE_DATETIME | date-time | 2017-07-21T17:32:28Z |
There are many other data types found in the swagger specification. The Web Service Import Wizard will apply the appropriate format user property to each.