Setting properties for a custom component in EAServer

You add as many of the following properties as needed for your custom component. The properties are divided into two groups: general and database connection.

For boolean properties, values can be true or false, or yes or no.

General properties These properties specify settings that take effect when the component is instantiated.

Table 7-1: General properties to add for custom component

General property

Description

com.sybase.datawindow. sourceFileName

Specifies the PBL, the PBD that contains the DataWindow object for the component, or the SRD or PSR file that is the DataWindow object.

See also the SetDWObject method in the online Help or DataWindow Reference.

com.sybase.datawindow. dwObjectName

The name of the DataWindow object in the PBL or PBD specified for sourceFileName.

See also the SetDWObject method.

com.sybase.datawindow. fixed

Whether component properties can be modified from server-side script (SetDWObject, Create, Modify, and SetTrans methods) that instantiates the component. Values are:

  • Yes — Properties are fixed and cannot be changed.

  • No — Properties can be changed.

com.sybase.datawindow. serverServiceClasses

A list of PowerBuilder user objects that are in the PBL or PBD specified in sourceFileName. The class names should be separated by semicolons (;). The user objects implement custom events for data validation.

For information on custom events, see the SetServerServiceClasses method in the online Help or DataWindow Reference.

com.sybase.datawindow. serverSideState

Specifies whether the server attempts to maintain its state between method calls. Values are:

  • Yes — The server component keeps the result set and keeps the transaction open if possible.

  • No — (Default) The result set is not saved and the server component uses information passed back from the client to retrieve the result set again and restore any uncommitted changes.

com.sybase.datawindow. trace

Whether calls to component methods are included in the EAServer server log. Values are:

  • Yes — Calls to component methods are listed in the log.

  • No — (Default) Calls to component methods are not logged.

com.sybase.datawindow. HTMLObjectName

The name used for the Web DataWindow client control in the generated code. The name is used to implement client-side events and to allow client-side scripting

Set this property when there will be more than one Web DataWindow on a Web page so that they do not conflict.

See also the SetHTMLObjectName method.

com.sybase.datawindow. modifyString

A string that is used as an argument to the Modify method for setting properties of the DataWindow object. The component calls the Modify method when it is initialized.

For information on syntax, see the Modify method.

Database connection properties For the database connection properties, you must add com.sybase.datawindow.trans.dbms. This property must be set for any of the other trans properties to be recognized. When trans.dbms is set, any unspecified connection properties default to an empty string.

For more information about database connections, see the SetTrans method in the DataWindow Reference.

Table 7-2: Database connection properties to add for custom component

Database connection property

Description

com.sybase.datawindow. trans.dbms

A database vendor identifier, as displayed in the PowerBuilder Connection Profiles dialog box.

com.sybase.datawindow. trans.dbparm

DBMS-specific connection parameters.

com.sybase.datawindow. trans.lock

The isolation level. See the online Help for information about database preferences.

com.sybase.datawindow. trans.logid

The name or ID of the account the component uses when it logs on to the database server.

com.sybase.datawindow. trans.logpass

The password used to log on to the database server.

com.sybase.datawindow. trans.database

The name of the database to which the component is connecting. Ignored for ODBC.

com.sybase.datawindow. trans.servername

The name of the server on which the database resides.