Administering SAS BI Web Services

Configuring SAS BI Web Services for Java

SAS BI Web Services for Java is initially configured during installation using the SAS Deployment Wizard. To modify this initial configuration, use the Configuration Manager plug-in for SAS Management Console.

To modify common configuration properties that apply to XMLA, WebServiceMaker, and generated Web services, navigate to the BI Web Services for Java 9.2 application folder. Then navigate to the Settings tab within the Properties dialog box.

Settings Tab for the BI Web Services for Java 9.2 Properties Dialog Box

[Settings Tab for the BI Web Services for Java 9.2 Properties Dialog Box]

In the Application General Configuration section, you have the ability to modify the following configuration properties:

Acceptable SYSCC List

When a Web service operation is invoked, it in turn calls the appropriate SAS Stored Process running on the server tier. SAS execution always returns the SYSCC macro variable upon completion. By default, if this completion code is not 0, a SOAP fault is generated and returned to the invoking client. Alternatively, a comma-separated list of acceptable SAS completion codes can be specified to alter this behavior. Also, a hyphen separating two values can be used to conveniently specify a range of acceptable completion codes. In this case, the acceptable list of completion codes are treated as warnings rather than errors and do not cause a SOAP fault.

Note that SYSCC can be set directly by SAS code developers. Likewise, some SAS procedures set this value, so see the appropriate SAS documentation to determine possible values that might be returned and whether these values are errors or just warnings in your case. For example, if a SAS procedure states that a SYSCC value less than 4 is a warning and you are willing to accept those values, set this property as follows: 0-4. Therefore, if the SAS stored process returns a value of 4 or less, it is considered successful as far as the Web service is concerned and the client receives an appropriate response rather than a fault.

Enable dynamic prompts validation

When invoking Web service operations for stored processes that have been configured with dynamic prompt data parameters, you can turn off validation to obtain better throughput if you are certain that these stored processes have been written in a robust manner to handle any possible data passed by clients. Dynamic prompt validation is enabled by default so that the middle-tier Web service validates client data against data providers to ensure that incoming data meets the specified criteria before calling the appropriate stored process on the server.

SAS Stored Process timeout

Set this property if you want to limit the amount of time that a stored process is allowed to run. If the stored process fails to execute in the specified time, it is canceled and a SOAP fault is returned to the invoking client. A value of zero indicates no time-out period.

To modify configuration properties that are specific to the Web Service Maker, navigate to the WebServiceMaker folder. Then navigate to the Settings tab within the Properties dialog box.

Settings Tab for the WebServiceMaker Properties Dialog Box

[Settings Tab for the WebServiceMaker Properties Dialog Box]

In the Application General Configuration section, you have the ability to modify the following configuration properties:

Base namespace: This property is the base namespace that is concatenated with the service name to create a target namespace to uniquely identify generated Web services. For example, if the base namespace is set to http://tempuri.org, and a client creates a new service named test without specifying an overriding namespace for this new service, then the target namespace for this Web service becomes http://tempuri.org/test.
Deployment method: The method used to deploy generated Web services. Select Container to deploy a generated Web service directly to the application server (container) and make it immediately available for execution. Select Directory to copy the generated Web service artifact to a designated directory so that it can be deployed to the container at a later time.
Deployment directory: When the deployment method is Directory, this property specifies the file location to copy the generated Web service artifact.
Temporary working directory: This property specifies the directory that is used to generate Web service artifacts.
Delete temporary files: This property specifies whether to delete temporary files after a successful deployment. In most cases you should clean up temporary files after a successful deployment.
Script processing failures: Ant scripts are used to perform specific tasks. The output streams that are produced from running such tasks are analyzed for failures by searching for well-known error messages such as BUILD FAILED. More than one comma-separated value can be specified. If any of the keywords specified in this property are encountered, the generation process is ended, and a SOAP fault is returned to the invoking client.

To modify more advanced configuration properties that are specific to the Web Service Maker, navigate to the Advanced tab within the Properties dialog box.

[Configuration Manager - Advanced Properties for WebServiceMaker]

The following advanced configuration properties are available:

AddWSSecurityAuthConstraint: If Web authentication is enabled and this property is set to true, then generated Web services will be configured to require WS-Security Username Token authentication. However, to fully configure application server authentication using Java Authentication and Authorization Service (JAAS), additional configuration is necessary. For more information, see Securing SAS BI Web Services for Java. The default value for this property is true. Set this property to false if you do not want to automatically configure WS-Security for generated Web services. An example would be if you wanted to configure HTTP transport-level security instead.
JAASLoginConfigName: This property enables you to specify an alternate JAAS login configuration when using WS-Security Web authentication within the WebSphere application server. By default, the WSLogin JAAS login configuration is used.
AttachmentConformance: This property specifies the attachment conformance that should be enabled for generated Web services. There are two options: Message Transmission Optimization Mechanism (MTOM) and SOAP Messages with Attachments (SWA). The default is MTOM.
JavaHome: This property specifies the JDK to use when compiling generated code. sThe default is to use the java.home system property, which resolves to the JDK that is being used by the application server JVM.

To modify configuration properties that are specific to a generated Web service, navigate to the folder for that service. Then navigate to the Advanced tab within the Properties dialog box.

[Configuration Manager - Advanced Properties for Generated Web Service]

In this example, addintegersWS is the Web service that is being modified.

The following advanced configuration properties are available:

AcceptSysccList: See Acceptable SYSCC List. This property overrides its analogous common configuration property.
DynamicPromptsSupport: See Enable dynamic prompts validation. This property overrides its analogous common configuration property.
MaxSTPExecTime: See SAS Stored Process timeout. This property overrides its analogous common configuration property.

Changes to properties do not take effect immediately. To apply these changes, perform one of the following tasks:

Either stop and restart the application server, or stop and restart the SAS BI Web Services for Java Web application (sas.wip.services9.2.ear).
Use a Java Management Extensions (JMX) console to communicate with the com.sas.svcs:service=biws,type=ConfigMBean management bean.

The following image shows the use of the JMX console bundled with the JDK to reload the configuration metadata into a running SAS BI Web Services for Java application:

[Java Configuration Management Bean]

Top of Page