Viewing or Modifying Web Services Properties

Display or change the properties of the selected Web service.

Prerequisites

Database Version	Web Service Privileges
SAP Sybase IQ 15.3 and 15.4	View any Web service property page – None required. Modify any Web service property – Requires DBA authority.
SAP Sybase IQ 16.0	View any Web service property page – None required. Modify any Web service property – Requires MANAGE ANY WEB SERVICE system privilege.

Database Version

Web Service Privileges

SAP Sybase IQ 15.3 and 15.4

View any Web service property page – None required.

Modify any Web service property – Requires DBA authority.

SAP Sybase IQ 16.0

View any Web service property page – None required.

Modify any Web service property – Requires MANAGE ANY WEB SERVICE system privilege.

The SAP Sybase IQ resource is authenticated and running.
(Modifying properties only) In a multiplex configuration, the coordinator node is running.

Task

From the application menu bar, select View > Open > Administration Console.
In the left pane, select IQ Servers > Compiled Objects > Web Services.
Select a Web service in the right pane, click the drop-down arrow that appears to the right, and select Properties.

View or modify Web service properties.

When modifying properties, clicking Apply before changing screens is not necessary, but will save any changes.
If you do not have privileges to modify properties, Sybase Control Center displays the properties view in read-only mode.

Area	Description
General	Name – (Read-only) Shows the name of the selected web service. Enabled – Select this option to enable the web service to listen for requests over HTTP or HTTPS. By default, database servers do not listen for web service requests, leaving no way for clients to access any services that may be defined in your database. If you clear this option, the database server keeps the definition of the web service in the database, but makes the web service unusable. Service type – Shows whether the selected web service is a RAW, XML, HTML, JSON, SOAP, or DISH web service. You can change the service type by choosing a different type from the dropdown list. URL path – Specifies whether URL paths are accepted, and if so, how they are processed. The options are: Off – Select this option if the remainder of the URL path is not permitted. If the service name ends with a forward slash (/), select Off. For example, if Off is selected and you have the URL path http://<host-name>/<service-name>/aaa/bbb/ccc, only http://<host-name>/<service-name> is permitted. The remainder of the URL path, /<aaa/bbb/ccc is not permitted. On – Select this option if the remainder of the URL path is permitted and is set as a single parameter. For example, in the URL path http://<host-name>/<service-name>/aaa/bbb/ccc, the remainder of the URL path is /aaa/bbb/ccc. It is treated as a single parameter. Elements – Select this option if the remainder of the URL path is permitted and is set as multiple parameters. For example, in the URL path http://<host-name>/<service-name>/aaa/bbb/ccc, each element of the path is treated as a separate parameter. For example, url1=aaa, url2=bbb, url3=ccc, and so on. Format – (SOAP and DISH services only.) Generates output formats compatible with various types of SOAP clients, such as .NET or Java JAX-RPC. If a SOAP service's format is not specified, the format is inherited from the service's DISH service declaration. If the DISH service does not declare a format, it defaults to DNET, which is compatible with .NET clients. A SOAP service that does not declare a format can be used with different types of SOAP clients by defining multiple DISH services, each with a different format type. Expose an explicit response object – This option only affects the WSDL document that is generated. Select this option to have the DISH service return an XML schema that explicitly describes the result set. It returns all the column names and their data types in the result set. If you don't select this option, then the DISH service returns an XML schema (a WSDL document) that describes the generic SimpleDataset object. The SimpleDataset describes a rowset consisting of rows and columns; no column name or data type information is returned. Data type – (SOAP services only.) SOAP service data typing: OFF – (Default) No data typing of inputs and outputs. ON – Supports data typing of input parameters and result set responses. IN – Supports data typing of input parameters only. OUT – Provides data type information for result set responses of all SOAP service formats. Service name prefix – (DISH services only.) Only SOAP services whose names begin with this prefix are handled by the DISH service. Methods – Select one or more of the following request methods: HEAD, GET, POST, PUT, or DELETE. Authorization required – Indicates whether users must authenticate to use this web service. When authorization is required, all users connecting to this service must provide a user name and password. If you select the User check box, you must authenticate as the specified user to use this web service. However, if User is cleared and authentication is required, then you can authenticate with any database user to use this web service. If authorization is not required, you must choose a user from the dropdown list . All requests are run using the account and permissions of the user specified. User – Shows which user account is used to execute service requests. If the service does not require authorization, you must choose a user from the dropdown list. Security required – Shows whether unsecured connections are accepted. Select this option to indicate that the web service requires security. If the web service requires security, then only secure (HTTPS) connections are accepted. If this option is cleared, then both HTTP and HTTPS connections are accepted. Comment – Text description of the Web service. For example, describe the Web service's purpose in the system.
SQL	This web service has the following SQL statement – Enables the text box where you can specify the SQL statement for the Web service. SQL statement area – Text box containing the SQL statement for the Web service.

Area

Description

General

Name – (Read-only) Shows the name of the selected web service.

Enabled – Select this option to enable the web service to listen for requests over HTTP or HTTPS. By default, database servers do not listen for web service requests, leaving no way for clients to access any services that may be defined in your database. If you clear this option, the database server keeps the definition of the web service in the database, but makes the web service unusable.

Service type – Shows whether the selected web service is a RAW, XML, HTML, JSON, SOAP, or DISH web service. You can change the service type by choosing a different type from the dropdown list.

URL path – Specifies whether URL paths are accepted, and if so, how they are processed. The options are:

Off – Select this option if the remainder of the URL path is not permitted. If the service name ends with a forward slash (/), select Off. For example, if Off is selected and you have the URL path http://<host-name>/<service-name>/aaa/bbb/ccc, only http://<host-name>/<service-name> is permitted. The remainder of the URL path, /<aaa/bbb/ccc is not permitted.
On – Select this option if the remainder of the URL path is permitted and is set as a single parameter. For example, in the URL path http://<host-name>/<service-name>/aaa/bbb/ccc, the remainder of the URL path is /aaa/bbb/ccc. It is treated as a single parameter.
Elements – Select this option if the remainder of the URL path is permitted and is set as multiple parameters. For example, in the URL path http://<host-name>/<service-name>/aaa/bbb/ccc, each element of the path is treated as a separate parameter. For example, url1=aaa, url2=bbb, url3=ccc, and so on.

Format – (SOAP and DISH services only.) Generates output formats compatible with various types of SOAP clients, such as .NET or Java JAX-RPC. If a SOAP service's format is not specified, the format is inherited from the service's DISH service declaration. If the DISH service does not declare a format, it defaults to DNET, which is compatible with .NET clients. A SOAP service that does not declare a format can be used with different types of SOAP clients by defining multiple DISH services, each with a different format type.

Expose an explicit response object – This option only affects the WSDL document that is generated. Select this option to have the DISH service return an XML schema that explicitly describes the result set. It returns all the column names and their data types in the result set. If you don't select this option, then the DISH service returns an XML schema (a WSDL document) that describes the generic SimpleDataset object. The SimpleDataset describes a rowset consisting of rows and columns; no column name or data type information is returned.

Data type – (SOAP services only.) SOAP service data typing:

OFF – (Default) No data typing of inputs and outputs.
ON – Supports data typing of input parameters and result set responses.
IN – Supports data typing of input parameters only.
OUT – Provides data type information for result set responses of all SOAP service formats.

Service name prefix – (DISH services only.) Only SOAP services whose names begin with this prefix are handled by the DISH service.

Methods – Select one or more of the following request methods: HEAD, GET, POST, PUT, or DELETE.

Authorization required – Indicates whether users must authenticate to use this web service. When authorization is required, all users connecting to this service must provide a user name and password. If you select the User check box, you must authenticate as the specified user to use this web service. However, if User is cleared and authentication is required, then you can authenticate with any database user to use this web service. If authorization is not required, you must choose a user from the dropdown list . All requests are run using the account and permissions of the user specified.

User – Shows which user account is used to execute service requests. If the service does not require authorization, you must choose a user from the dropdown list.
Security required – Shows whether unsecured connections are accepted. Select this option to indicate that the web service requires security. If the web service requires security, then only secure (HTTPS) connections are accepted. If this option is cleared, then both HTTP and HTTPS connections are accepted.

Comment – Text description of the Web service. For example, describe the Web service's purpose in the system.

SQL

This web service has the following SQL statement – Enables the text box where you can specify the SQL statement for the Web service.

SQL statement area – Text box containing the SQL statement for the Web service.

Click OK.