About Properties

There are properties on host transactions, client operations, host program data structures, elements, records, and Group and Elementary Items. You can edit many of these properties.

You can view and, in same cases, edit the different properties. To display a property, select the object in either the Host Transaction Editor or Client Operation Editor. All objects have properties associated with them. To edit a property, select the property and type a new value.

You can use the right-click menu to cut, copy, and paste values. When you right-click on a property and choose copy both the property and the value are placed on the clipboard.

Properties marked with an asterisk are read-only and cannot be edited.

Client Operation, Record, and Element Properties

A client operation defines how client interfaces are produced and how they will interact with the service. It has a client schema containing both input records and output records.

There are four types of elements; basic, repeating, record, and repeating record.

Basic—A node in the client schema. The basic element represents a fundamental piece of data provided by or returned to the client. A basic element has schema-like properties associated with it.
Repeating—A repeating element is either a fixed or variably sized list or table. It is similar to an array of basic elements, with the addition of properties that determine the size of the table for a particular client operation.
Record—A record is a means of grouping a fixed sized ordered list of any of the four (basic, repeating, record, repeating record) types of elements.
Repeating record—A repeating record is either a fixed or variably sized list or table. It is similar to an array of records, with the addition of properties that determine the size of the table for a particular client operation.

Client Operation Properties (Project Editor)

Property	Description
Name	The name of the client operation. Determined when creating or importing a client operation. The client operation name will be used for the name of the execution method in the generated API.
Description	The description of the client operation. Determined when creating or importing a client operation.
Default host address	The default address of the host this client operation will connect to. Will override project scoped default host address.
Default host port	The default port on the host configured for Verastream Bridge Integrator use. Will override project scoped default host port.
Default username	Security property. Will be passed to the host program. Will override project scoped default username.
Default password	Security property. Will be passed to the host program. Will override project scoped default password.

Record Properties (Client Operation Editor)

Property	Description
Name	The name of the basic element.
Description	The description of the basic element
Min Occurs	For repeating records. Sets the minimum number of times this element must occur in the instance data. In the case of a variably sized table (Occurs Depending On (ODO)), another client operation field, the ODO object, indicates the size of the input data and determines the size of the host output response data.
Max Occurs	For repeating records. Sets the maximum number of times this element must occur in the instance data. In the case of a variably sized table (Occurs Depending On (ODO)), another client operation field, the ODO object, indicates the size of the input data and determines the size of the host output response data.

Element Properties (Client Operation Editor)

Property	Description
Name	The name of the basic element.
Description	The description of the basic element.
Type	Data type of the basic element. For example, string.
Default	Specify a default value for the input element. The default value is sent to the host when the client has not supplied an input value before executing the client operation.
*Max Length (read-only for outputs)	The maximum length of the basic element in bytes. This property is used for strings and for the locale attribute.
Min Occurs	For repeating records, this sets the minimum number of times this element must occur in the instance data. In the case of a variably sized table (Occurs Depending On), another client operation field (the ODO 'object') is used to indicate the size of the input data, and to determine the size of the host output response data.
Max Occurs	When repeating, set the maximum number of times this field can occur in the data structure. The value for this property must be greater than or equal to the value for Min Occurs. Available when an ODO subject is selected.

Elementary and Group Item Properties

An elementary item is a node in Host Program data structure, usually derived from one line in the copybook. In COBOL it is the fundamental place to store data. A group item contains other items; elementary items or nested grou items. Group-level item properties are similar to elementary item properties, however some do not apply. For example, a group item can never have a picture clause.

Category	Property	Description
Info
	*Name	The name of the item
	*Picture	The COBOL description of the size and format of the elementary item
	*Data Type	The data type of the elementary item
	*Data Attributes	Elementary item only
	*Level	Advanced. Indicates the COBOL number that describes where this field fits into the heirarchy and organization of the host program data structure. For internal use only.
	*Length	The number of host bytes used to represent this field to the host program
	Default	Default value for the input element. TThe default value is sent to the host when the client has not supplied an input value before executing the client operation.
	*Declared as ODO Object	True or false. "True" if the data in this elementary item describes the size of a variably sized table in the client operation.
	*Declared as REDEFINED Object	True or false. "True" if the data defined by this element is redefined by one or more alternate data descriptions in subsequent elements.
	*Field Attribute	Advanced. For internal use only.
OCCURS (A group item contains an OCCURS clause)
	*Table Type	Fixed or variable
	*Min Table Size	Minimum table size
	*Max Table Size	Maximum table size
	*Assoc ODO Object	Points to the data field that the host program uses to establish the size of the table when the client operation is used. Only visible when table type is variable.
Associated REDEFINES Set (Properties are the same for all data items in the set)
	*REDEFINED Object	Indicates the first data item in the REDEFINES set that is being redefined
	Data Item with Condition Names (Optional)	Set to a data item that defines condition names associated with the various alternatives in this REDEFINES set. This property is typically used when Exclusive OR is set to "True" and is relevant only for data areas that have alternatives, and for which the data types and formats are usually not compatible. Condition names are identifiers associated with COBOL Level-88 fields. The Level-88 fields indicate actual runtime data used by the host program to indicate which REDEFINES alternative in in the current client operation.
	Exclusive OR	This attribute limits the client developer to only one of the available data descriptions for any single execution against the host. Set this value to: True (default)— If the data types and format of the alternatives are mutually exclusive (incompatible.) You can only "get" or "set" the data from one of the alternative data description areas. False— If the data format of the available options are compatible for each field in the data descriptions. You may "get" or "set" data from different alternative data description areas.
	Default	Set which alternative data description to use when inputting values. Which option should be used to process operation input values when no specific client intent is indicated. The default is set to the first of the available alternative data descriptions in the set.
REDEFINES (A group item contains an REDEFINES clause)	Assoc REDEFINES Condition Name	The condition name you want to associate with this REDEFINES option. This list will not be populated unless the Data Item with Condition Name property is specified in the Associated REDEFINES Set category.

*Read-only property. You cannot edit these properties.

Host Transaction Properties (Project Explorer)

The host transaction defines how the runtime service interacts with the host program and the transactions they expose. It contains a host program data structure with either a single shared layout for both input and output or two separate layouts.

Property	Description
Name	The name of the host transaction. Determined when creating or importing a host transaction.
Description	Optional. The description of the host transaction. Determined when creating a host transaction.
Program Name	The host program name associated with the Host Transaction.
Transaction ID	The transaction ID of the Host Transaction. This is the name of the group of host programs that includes the COBOL program with which you want to interact. Optional when using a CICS transaction type.
*Data Structure Support Type	The data structure of the Host Transaction. There are two options: a single shared layout for both input and output, or two separate layouts, one for input and one for output.

*Read-only property. You cannot edit these properties.

Host Program Data Structure Properties

Property	Description
*Type	IN, OUT,or INOUT
*Data Length	Length of the data

*Read-only property. You cannot edit these properties.


	Using REDEFINES in a Project
	Use Connection Configuration Properties
	Configure Connection Default Properties
	Declare a Host Transaction