Using Configuration Console to create a defined web service

Use this procedure to define a web service configuration in the Configuration Console. To access the web services builder in Configuration Console, you must have a security role that includes one of several security classes or their equivalent. For more information, see the Configuration Console User Guide.

To create a web service configuration

  1. Access the Configuration Console for Web Services. Start > Configure > Web Services.
  2. Click the New button at the top of the left pane.
  3. Provide the basic definition for the web service. Consider the following fields:
    Web Service

    Type a name for the web service. You will use this name in URL calls, so consider keeping the name short and meaningful.

    Active

    Select the Active check box to make the web service available.

    Production

    Select the Production check box to indicate that the web service is ready for a production environment. If this check box is selected, then the servlet container will cache the web service definition. Then, each time a system accesses the web service, the servlet container will not check for an updated definition. If you are testing a web service, you should leave this check box unselected.

  4. From the Actions menu, select Save.
  5. You can select Action > Fetch Runtime WSDL to see the URL you need to access the web service you are defining. When Fetch Runtime WSDL Completes, the Runtime WSDL field populates with your server name and URL for the defined service WSDL. Defined web services syntax

    The URL uses the sytanx: LandmarkURL/dataarea/soap/lwsdl/webservicename

    Note: 

    The WSDL button on this form was meant to open browser window in the UI to see the WSDL XML, but depending on your canvas and browser control, this may not work.

  6. Decide whether the web service will involve form-based operations, list-based, or both and define them.

    To define form-based operations

    1. On the web service definition form, click the Form Based Operations tab.
    2. From the Actions menu on the tab, select Create.
    3. On the Form Based Operation window, define the operation
      Form Operation

      Type a name for the form operation. You will be using this name in URL calls, so consider keeping it short and meaningful.

      Module

      Select the module that the business class for the form belongs to. This will help narrow the list of business classes to select from.

      Busclass

      Select the business class that the form belongs to. If you know the exact name of the business class, you can also type it here.

      Action

      Required. Select the action on the business class you want to use. Note that you must have a business class in the Busclass field before you select an action.

      Status Message

      Select this check box if you want a status message included. This is the message the application returns, such as "change complete."

      Active

      Select this check box to indicate that this operation is active.

    4. Click Save. The Input Fields and Output Fields tabs display.
    5. Define the input fields for the form-based operation.

      • On the Form Input Fields tab, click the Helper List icon.

      • Select the fields you want.

      • Click Attach Input Fields To Form Operation. This adds the fields to the tab and saves the record.

    6. When you are done adding input fields, close the Helper List.
    7. Define the output fields for the form-based operation.

      • On the Form Output Fields tab, click the Helper List icon.

      • Select the fields you want.

      • Click Attach Output Fields To Form Operation. This adds the fields to the tab and saves the record.

    8. When you are done adding output fields, close the Helper List.
    9. When you are done adding operations, close the Form Based Operation window and return to the Web Service Record.

    To define list-based operations

    1. On the web service definition form, click the List Based Operations tab.
    2. From the Actions menu on the tab, select Create.
    3. On the List Based Operation window, define the operation
      List Operation

      Type a name for the list operation. You will be using this name in URL calls, so consider keeping it short and meaningful.

      Module

      Select the module that the business class for the list belongs to. This will help narrow the list of business classes to select from.

      Busclass

      Select the business class that the list belongs to. If you know the exact name of the business class, you can also type it here.

      List

      Select the list that you want to use for the operation.

      Active

      Select this check box to indicate that this operation is active.

    4. Click Save. The Input Fields and Output Fields tabs display.
    5. Define the input fields for the list-based operation.

      • On the Input Fields tab, click the Helper List icon.

      • Select the fields you want.

      • Click Attach Input Fields To List Operation. This adds the fields to the tab and saves the record.

    6. When you are done adding input fields, close the Helper List.
    7. Define the output fields for the list-based operation.

      • On the Output Fields tab, click the Helper List icon.

      • Select the fields you want.

      • Click Attach Output Fields To List Operation. This adds the fields to the tab and saves the record.

    8. When you are done adding output fields, close the Helper List.
    9. When you are done adding operations, close the List Based Operation window and return to the Web Service Record.
  7. Once the web service operations are defined and the record is saved and active, you can invoke the web service via standard SOAP/WSDL or REST protocols. Defined web services syntax