Adding a Web service client
Before a Web service client can be used (in Workflows, Adapterflows or Scripts), it must be added to the iCore system. A new Web service client is added just like any other entity (see Add a new entity), but also requires that the following properties are set:
- Client type – the type of client to add.
- SOAP – Add a SOAP based client using a WSDL or mex definition.
- REST – Add a REST based client providing an OpenAPI description (formerly known as Swagger).
- URI – The location of the WSDL or OpenAPI description for the web service.
- Namespace – Namespace to be used in the generated web service consumer activities.
- Description – The description of the web service.
- Version – The version of the web service client.
- Enable schema generation – Enables/disables generation of XML schemas.
- SOAP Specific options – Specifies which option to use for generation of SOAP web service clients and schemas. The following options are available:
- UseLegacySchemaGeneration – If this option is selected, all elements are placed in a schema with the same target namespace as the web service client (instead of using the namespace which the type of the elements belong to). This option is used to guarantee compatibility with older versions of iCore Integration Suite.
- ForceAllTypesIntoNamespace – If this option is selected, all types in the web service are placed in a single namespace to be used by Adapterflow activities. The option is useful when conflicting type names in the generated code prevents the web service client from being compiled. The name of the single namespace is a combination of the web service client 'Namespace' property and its current version. For Workflow activities, this is the default behavior and cannot be changed.
- REST Specific options – Specifies the option to use for generation of REST web service clients and schemas. The following options are available:
- Generation mode – Specifies how to generate client(s). The following options are available:
- Single client – A single client is generated.
- Multiple clients from operation Id – Multiple clients are generated. Client type names are based on the operation ID.
- Multiple clients from path segments – Multiple clients are generated. Client type names are based on the path segments.
- Custom client prefix class name – The prefix for the client class name (Optional).
- Custom client suffix class name – The suffix for the client class name (Optional).
- Schema target namespace – Namespace to use when the generator is decorating types with XmlRootAttribute (Optional).
- Generation mode – Specifies how to generate client(s). The following options are available:
A successful import of the WSDL file or OpenAPI description creates a new Web service client. The created Web service client contains:
- Client activities for Adapterflows, if Service type is SOAP.
- Client activities for Workflows.
- Client types for Web APIs, if Service type is REST.
- XML schemas, if generation is enabled.