Web Operations (PDM)

A web operation allows you to define the SQL statement of a web service and to display its parameters and result columns.

Creating a Web Operation

You can create a Web operation in the following ways:
  • Open the Operations tab in the property sheet of a web service, and click the Add a Row tool.
  • Right-click a web service in the Browser, and select New > Web Operation.

Web Operation Properties

To view or edit a web operation's properties, double-click its Browser or list entry. The property sheet tabs and fields listed here are those available by default, before any customization of the interface by you or an administrator. The General tab contains the following properties:

Property

Description

Name/Code/Comment

Identify the object. The name should clearly convey the object's purpose to non-technical users, while the code, which is used for generating code or scripts, may be abbreviated, and should not normally include spaces. You can optionally add a comment to provide more detailed information about the object. By default the code is generated from the name by applying the naming conventions specified in the model options. To decouple name-code synchronization, click to release the = button to the right of the Code field.

In URIs, the name of the web operation comes after the name of the web service followed by a slash, and should not start with a slash nor contain two consecutive slashes.

Stereotype

Extends the semantics of the object. You can enter a stereotype directly in this field, or add stereotypes to the list by specifying them in an extension file.

Web Service

Code of the web service containing the web operation. Click the Properties tool to open the web service property sheet

Owner

[ASE 15 only] Specifies the owner of the operation.

Operation Type

[IBM DB2 only] Specifies the type of operation. You can choose from the following:
  • call - invokes a stored procedure with parameters and result columns for the web operation

  • query - retrieves relational data using the SQL select statement in the Implementation tab

  • retrieveXML - retrieves an XML document from relational data. The mapping of relational data to XML data is defined by a DAD file with SQL or RDB as MappingType

  • storeXML - stores an XML document as relational data. The mapping of XML data to relational data is defined by a DAD file, with RDB as MappingType

  • update - executes the SQL update statement with optional parameters. Parameters can be created from the Parameters tab in the web operation property sheet

Keywords

Provide a way of loosely grouping objects through tagging. To enter multiple keywords, separate them with commas.

The following tabs are also available:
  • Implementation - Contains the SQL statement of the Web operation to select which data you want to retrieve from the database. For DISH web services, SQL statements are defined in the SOAP web services bearing their prefix name. For information about the tools on this tab, see Writing SQL Code in PowerDesigner.

  • Security - [SQL Anywhere/IQ] Displays the following properties:

    Property

    Description

    Secured connection

    Requires an HTTPS connection.

    Required authorization

    Requires users to provide a name and a password.

    Connection User

    When authorization is required, you can select the default <None> (all users are granted access), or a list of user names. When authorization is not required, you must select a user name.

  • Parameters - Lists the parameters associated with the Web operation, which are part of the SQL statement defined on the Implementation tab (see Web Parameters (PDM)).
  • Result Columns - Lists the result columns associated with the Web operation (see Web Result Columns (PDM)).
  • Sybase - [ASE] Displays Sybase-specific options (see SAP Sybase Adaptive Server Enterprise).