Skip to main content
warning

Deprecated Technology:
Legacy SOAP web services are deprecated and should not be used in new projects.
For new integrations, use modern RESTful APIs or supported alternatives.

Overview​

Legacy SOAP web services in ADITO allow external systems to trigger processes and exchange data using the SOAP protocol. This technology is deprecated and maintained only for legacy compatibility.
Do not use legacy SOAP web services in new projects.

Setup​

Activating Legacy Web Services​

To activate legacy SOAP web services:

  1. Open ADITO Designer and go to Preferences > Web Services.
  2. Configure the following settings:
    • Enable: Turns web services on or off.
    • Address: The network address where the web service is available.
    • Port: The port for accessing the service.
    • Path: The endpoint path for the web service.
  3. Restart the ADITO server after changes.

On successful startup, the log will indicate the web service is running, e.g.:

H-44-Z-0022-S Web services started. [->] Address: http://127.0.0.1:7937/run-process

Test availability by visiting the WSDL URL (append ?wsdl), e.g.:

http://127.0.0.1:7937/run-process?wsdl

The WSDL (Web Service Description Language) file describes the available functions, data types, and protocols for the web service.

    <!--
        Published by JAX-WS RI at http://jax-ws.dev.java.net. RI's version is JAX-WS RI 2.2.4-b01.
    -->
    <!--
        Genereated by JAX-WS RI at http://jax-ws.dev.java.net. RI's version is JAX-WS RI 2.2.4-b01.
    -->
    <definitions targetNamespace="http://adito.de/webservice/" name="AditoService">
        <types>
            <xsd:schema>
                <xsd:import namespace="http://adito.de/webservice/" schemaLocation="http://127.0.0.1:7937/run-process?xsd=1"/>
            </xsd:schema>
        </types>
        <message name="runprocess">
            <part name="name" type="xsd:string"/>
            <part name="parameter" type="xsd:string"/>
            <part name="user" type="xsd:string"/>
            <part name="password" type="xsd:string"/>
            <part name="concurrent" type="xsd:boolean"/>
        </message>
        <message name="runprocessResponse">
            <part name="result" type="xsd:string"/>
        </message>
        <message name="AditoWebserviceException">
            <part name="fault" element="tns:AditoWebserviceException"/>
        </message>
        <portType name="Adito">
            <operation name="runprocess" parameterOrder="name parameter user password concurrent">
                <input wsam:Action="http://adito.de/webservice/Adito/runprocessRequest" message="tns:runprocess"/>
                <output wsam:Action="http://adito.de/webservice/Adito/runprocessResponse" message="tns:runprocessResponse"/>
                <fault message="tns:AditoWebserviceException" name="AditoWebserviceException" wsam:Action="http://adito.de/webservice/Adito/runprocess/Fault/AditoWebserviceException"/>
            </operation>
        </portType>
    <binding name="AditoPortBinding" type="tns:Adito">

Required parameters for the ADITO web service:

  • name: Name of the process to be executed.
  • parameter: String parameter(s) for the process.
  • user: Username for authentication, In extended properties, set Webservice enabled to Yes.
  • password: Password for authentication.
  • concurrent: If true, the process is started asynchronously; if false, the client waits for completion.

Creating a User​

To allow access to the web service, create a user in ADITO Designer:

  1. Go to User in the ADITO Designer.
  2. Create a new user (no group/employee assignment required).
  3. In extended properties, set Webservice enabled to Yes.
  4. Assign the Webservices role to the user.

Creating the Process​

To make a process available via the web service:

  1. In ADITO Designer, select the process.
  2. Enable the Webservice property (checkbox).

Webservice-enabled process

Example process (echo)​

import { vars, result } from "@aditosoftware/jdito-types";

const input = vars.getString("$local.param");
result.string("Received: " + input);

The input parameter is available as a string variable ($local.param). Arrays or complex data can be passed as XML-formatted strings. Return values are provided via the result.* methods.

JDito-based SOAP Web Services​

JDito-based SOAP web services are server-side web services provided by JDito processes. Unlike the standard web service endpoint, each function of a JDito process is exposed as a separate WSDL operation.

Setup​

To activate a JDito-based SOAP web service:

  1. In the process properties, enable publishAsWebservice.
  2. Optionally, set the binding style (rpc or document).

JDito Webservice Properties

The web service is available at: http://127.0.0.1:7936/playgroundproc?wsdl where playgroundproc is the process name.

WSDL Customization​

As of ADITO 2019, you can provide a custom WSDL file in the wsdl field for the SOAP web service.
This allows customization for infrastructure requirements (e.g., proxies).

Custom WSDL field