Interface configuration refers to using Bizagi's Web services connector, to integrate with SOAP or REST services.
The Management Console lets you manage the parameters used by the integration points of your processes in a testing or production environment.
Editing an existing interface
Once an interface has been defined and configured in a Process, you can edit its information.
To edit an existing interface, select it in the External System list:
Select the required interface in the left panel.
In the Properties tab, you can find the following fields depending on the service type (REST or SOAP)
Property |
Description |
|---|---|
Web service URL |
The URL to access the service. For REST services, this is the Base URL. |
Username |
When the service requires HTTP basic authentication, this username is required for service access. |
Password |
When the service requires HTTP basic authentication, this password is required for service access. |
Domain |
When the service requires HTTP basic authentication, this domain is optional to complement the username, for service access. |
Logging Threshold (In Secs) |
The time in seconds of an expected service threshold for the interface. The default value is 30 seconds. The system records execution details when an invocation exceeds this time. |
Time-out (In Secs) |
The time in seconds which defines when to time out any attempt to invoke the interface. By default, the value is -1, which means that interfaces do not have an initial definition of when to timeout. The invocation times out according to this setting or the one defined for the activity if the invocation is done from an asynchronous activity (whichever has the lowest timeout definition). |
Port Name |
Provide a specific port name when you need to execute a SOAP web service that offers different service ports (i.e. SOAP 1.1, SOAP 2.0, etc.). This port name can be configured separately according to each environment (i.e Development, Test, Production).
Provide the port name exactly as specified at the end of the service's WSDL definition:
|
Max Buffer Size |
Increment this value if you need to send a content such as a large file to your Web service that would normally exceed the default limit. Corresponds to the attribute maxBufferSize of the bindings element of the Windows Communication Foundation (WCF) configuration file. Sets the maximum size of the SOAP headers. |
Max Buffer Pool Size |
Increment this value if you need to send a content such as a large file to your Web service that would normally exceed the default limit of sent information. Corresponds to the attribute maxBufferPoolSize of the bindings element of the Windows Communication Foundation (WCF) configuration file. Sets the maximum amount of memory (in bytes) allocated. |
Max String Content Length |
Increment this value if you need to send a content such as a large file to your Web service that would normally exceed the default limit of sent information. Corresponds to the attribute maxStringContentLength of the readerQuotas element of the Windows Communication Foundation (WCF) configuration file. Sets the maximum string length of the response. |
Max Array Length |
Increment this value if you need to send a content such as a large file to your Web service that would normally exceed the default limit of sent information. Corresponds to the attribute maxArrayLength of the readerQuotas element of the Windows Communication Foundation (WCF) configuration file. Sets the maximum allowed array length. |
Max Bytes Per Read |
Increment this value if you need to send a content such as a large file to your Web service that would normally exceed the default limit of sent information. Corresponds to the attribute maxBytesPerRead of the readerQuotas element of the Windows Communication Foundation (WCF) configuration file. Sets the maximum allowed bytes returned for each read. |
Max Name Table Char count |
Increment this value if you need to send a content such as a large file to your Web service that would normally exceed the default limit of sent information. Corresponds to the attribute maxNameTableCharCout of the readerQuotas element of the Windows Communication Foundation (WCF) configuration file. Sets the maximum characters allowed in a table name. |
In the Advanced options tab, you can configure the type of security you want to use to authenticate and invoke your web service.
This definition differs from the basic authentication credentials specified in the above properties (username, password, domain) which let Bizagi access the WSDL and physical resources used by the web service definition, while the definition in this configuration determines the security involved at runtime for the web service itself.
Possible definitions you can edit and manage for an interface already set in your environment are:
Option |
Description |
Specification |
|---|---|---|
Plain Header Token |
Sends the user's token (usernameToken) within the SOAP header message, according to the WS-Security standard. |
According to the technical definition at: https://www.oasis-open.org/committees/download.php/16782/wss-v1.1-spec-os-UsernameTokenProfile.pdf |
Secure Conversation Header Token |
Sends the user token according to the spec, by considering an appropriate certificate installed at the client. |
According to the technical definition at: http://docs.oasis-open.org/ws-sx/ws-secureconversation/200512 |
Basic HTTP Authentication |
Sends the credentials which apply when the service's end-point is protected (at a basic authentication level).
By default, Bizagi attempts to use Basic HTTP Authentication if no security definition is specified, and if you are relying on basic authentication to protect the service's resources (using the set credentials at the other properties: username, domain and password). |
According to the technical definition at: |
Last Updated 7/15/2022 4:00:23 PM