Bookshelf v8.0: Filter Attribute Definitions

Configuration Guide for Siebel Offline Client for Life Sciences > Configuration Files, Filter Definitions, and Calculated Expressions > Filter Definitions >

Filter Attribute Definitions

This topic describes filter attribute definitions:

ObjectFilter Attributes

Table 13 describes ObjectFilter attributes for the Filter schema.

Table 13. ObjectFilter Attributes
Attribute Name	Required or Optional	Default Value	Value
WSID	Required	None	OP
WSID	Required	None	OP

TopLevelObjectList Attributes

Table 14 describes TopLevelObjectList attributes for the Filter schema.

Table 14. TopLevelObjectList Attributes
Attribute Name	Required or Optional	Default Value	Value	Function Description
Inactive	Optional	N	Y	The data in this attribute is not part of the data model for the client application.
Inactive	Optional	N	N	The data in this attribute is part of the data model for the client application.
NoSync	Optional	N	Y	The data in this attribute is for use in the local computer only. It will not be downloaded from or uploaded to the Siebel CRM Server.
NoSync	Optional	N	N	The data in this attribute is downloaded from the Siebel CRM Server, and local updates are uploaded to the server.
Proprietoryship	Optional	Client	Client	Initiates updates in the local computer to override the updates in the server in the event of conflict.
Proprietoryship	Optional	Client	Server	Prevents updates in the local computer overriding the updates in the server in the event of conflict.
Type	Required	None	EntityList	The value EntityList is a list of objects.

TopLevelObject Attributes

Table 15 describes TopLevelObject attributes for the Filter schema.

Table 15. TopLevelObject Attributes
Attribute Name	Required or Optional	Default Value	Value	Function Description
CascadeDelete	Optional	N	Y	Deletes all child records when the parent record is deleted.
CascadeDelete	Optional	N	N	Prevents the deletion of child records when the parent record is deleted.
Entity	Required	None	Object	Specifies the name of the object; that is, the name of the local database table.
Inactive	Optional	N	Y	The data in this attribute is not part of the data model for the client application.
Inactive	Optional	N	N	The data in this attribute is part of the data model for the client application.
NoSync	Optional	N	Y	The data in this attribute is for use in the local computer only. It is not downloaded from or uploaded to the Siebel CRM Server.
NoSync	Optional	N	N	The data in this attribute is downloaded from the server, and local updates are uploaded to the Siebel CRM Server.
SearchSpec	Optional	N	Expression	Downloads only records meeting the condition specified in the value Expression from the Siebel CRM Server. If this attribute is not specified, all records accessible by the user are downloaded.
Type	Required	None	Entity	This value Entity is an object.

ObjectList Attributes

Table 16 describes 1MObjectList attributes for the Filter schema.

Table 16. 1MObjectList Attributes
Attribute Name	Required or Optional	Default Value	Value	Function Description
Associate	Optional	N	Y	Associates records with or disassociates records from a parent object.
Associate	Optional	N	N	Disables the association of a record with or disassociation of a record from a parent object.
CascadeDelete	Optional	N	Y	Deletes all child records when the parent record is deleted.
CascadeDelete	Optional	N	N	Disables the deletion of child records when the parent record is deleted.
Inactive	Optional	N	Y	The data in this attribute is not part of the data model for the client application.
Inactive	Optional	N	N	Indicates that the data is part of the data model for the client application.
Insert	Optional	Y	Y	Creates new records for this object. Records are removed from the local database after deletion.
Insert	Optional	Y	N	Disables the creation of new records for this object.
NoSync	Optional	N	Y	Indicates that data is for use in the local computer only. Synchronization does not occur. Data is not downloaded from or uploaded to the server.
NoSync	Optional	N	N	Indicates that data is downloaded from the server and local updates are uploaded to the server. Synchronization is allowed.
Type	Required	None	EntityList	The value EntityList is a list of objects.

ObjectList Attributes

Table 17 describes MMObjectList attributes for the Filter schema.

Table 17. MMObjectList Attributes
Attribute Name	Required or Optional	Default Value	Value	Function Description
Associate	Optional	N	Y	Associates records with or to disassociate records from a parent object.
Associate	Optional	N	N	Prevents the association of records with or the disassociation of records from a parent object.
CascadeDelete	Optional	N	Y	Deletes all child records when the parent record is deleted.
CascadeDelete	Optional	N	N	Deletes no child records when the parent record is deleted.
ChildKey	Required	None	ObjectId1, ObjectId2	The ObjectId1 and ObjectId2 values are foreign keys in the intersection table. These values correspond to the list in ParentKey attribute.
Entity	Required	None	Object	Indicates the name of the intersection table of the many-to-many relationship.
Inactive	Optional	N	Y	Indicates that the data is not part of the data model for the client application.
Inactive	Optional	N	N	Indicates that the data is part of the data model for the client application.
Insert	Optional	Y	Y	Indicates that new records can be created for this object. Records are removed from the local database when they are deleted.
Insert	Optional	Y	N	Indicates that new records cannot be created for this object.
NoSync	Optional	N	Y	Indicates that data is for use in the local computer only. Data is not downloaded from or uploaded to the server. No synchronization occurs.
NoSync	Optional	N	N	Indicates that data is downloaded from the server and local updates are uploaded to the server. Synchronization does occur.
ParentKey	Required	None	Object1.ObjectId1, Object2.ObjectId2	The values in the ParentKey attribute are joined-in fields, used to form many-to-many relationships.
Type	Required	None	EntityList	This value EntityList is a list of objects.

Object Attributes

Table 18 describes object attributes for the Filter schema.

Table 18. Object Attributes
Attribute Name	Required or Optional	Default Value	Value	Function Description
CascadeDelete	Optional	N	Y	Deletes all child records when the parent record is deleted.
CascadeDelete	Optional	N	N	Deletes no child records when the parent record is deleted.
ChildKey	Required	None	ObjectId	The ChildKey attribute is the foreign key for joining in the parent object.
Entity	Required	None	Object	Specifies the name of the object; that is, the name of the local database table.
ParentKey	Required	None	Object.ObjectId	The values in the ParentKey attribute are joined-in fields for the parent object.
Type	Required	None	Entity	The value Entity is an object.

Field Attributes

Table 19 describes Field attributes for the Filter schema.

Table 19. Field Attributes
Attribute Name	Required or Optional	Default Value	Value	Function Description
Attribute	Required	None	Field	Specifies the name of the field in the local database.
AttributeDestination	Optional	None	Field	Specifies the target object field to be joined in.
CascadeDelete	Optional	N	Y	Deletes all child records when the parent record is deleted.
CascadeDelete	Optional	N	N	Deletes no child records when the parent record is deleted.
Data	Optional	N	Y	This is a joined-in field of binary data type.
Data	Optional	N	N	This is not a joined-in field of binary data type.
Datatype	Optional	None	DTYPE_BOOL	Specifies that the field data type is Boolean.
Datatype	Optional	None	DTYPE_BLOB	Specifies that the field data type is Binary Large Object (BLOB) data for images.
Datatype	Optional	None	DTYPE_CURRENCY	Specifies that the field data type is Currency.
Datatype	Optional	None	DTYPE_DATE	Specifies that the field data type is Date only.
Datatype	Optional	None	DTYPE_DATETIME	Specifies that the field data type is Date and time.
Datatype	Optional	None	DTYPE_ID	Specifies that the field data type is Identifier field.
Datatype	Optional	None	DTYPE_INTEGER	Specifies that the field data type is Integer.
Datatype	Optional	None	DTYPE_NOTE	Specifies that the field data type is Text.
Datatype	Optional	None	DTYPE_NUMBER	Specifies that the field data type is Float.
Datatype	Optional	None	DTYPE_PHONE	Specifies that the field data type is Phone number.
Datatype	Optional	None	DTYPE_TEXT	Specifies that the field data type is Text.
Datatype	Optional	None	DTYPE_TIME	Specifies that the field datatype is Time only.
Datatype	Optional	None	DTYPE_REAL	Real number.
Datatype	Optional	None	DTYPE_UTCDATETIME	Date and time in Coordinated Universal Time (UTC) format.
Datatype	Optional	None	DTYPE_XML	XML
Datalength	Optional	None	Number	Specifies the length of field data in bytes.
DefaultValue	Optional	None	Value	Specifies a default value for the field.
DestinationKey	Optional	None	Field	The field located in the joined-in object, which is used to identify the record to be joined in.
Entity	Required	None	Object	Specifies the name of the object; that is, the name of the local database table.
Filterable	Optional	None	Y	This attribute is applicable to WSDL. The value Y means that this field is searchable.
Filterable	Optional	None	N	This attribute is applicable to WSDL . The value N means that this field is not searchable.
ForeignKeyTo	Optional	None	Field	Links the Field value to a record in another object. Can be used for establishing a one-to-many relationship.
Inactive	Optional	N	Y	The data in this attribute is not part of the data model for the client application.
Inactive	Optional	N	N	The data in this attribute is part of the data model for the client application.
LOVType	Optional	None	LOVType	Specifies the LOV type (List of Value type) for a LOV picklist.
NoColumn	Optional	N	Y	Indicates that no database column exists for this field.
NoColumn	Optional	N	N	Indicates that a database column does exist for this field.
NoSync	Optional	N	Y	The data in this attribute is for use in the local computer only. It is not downloaded from or uploaded to the server.
NoSync	Optional	N	N	The data in this attribute is downloaded from the server and local updates are uploaded to the server.
ParentLOVField	Optional	None	ParentLOVField	The parent LOV language-independent code for hierarchical picklists.
ReadOnly	Optional	N	Y	This field is read-only. Set this attribute to Y for joined-in fields.
ReadOnly	Optional	N	N	This field is updatable.
Required	Optional	N	Y	Indicates that the field is a required field and cannot be left blank.
Required	Optional	N	N	This field is not required.
RowId	Required	N	Y	Specifies that an Id field is required for the object. There must be only one Id field for each object. The Id field usually has the name Id in the WSDL.
RowId	Required	N	N	Specifies that an Id field is not required for the object.
SearchSpec	Optional	N	Expression	Specifies that only records matching the value Expression are downloaded from the server. If this attribute is not specified, all records accessible by the user are downloaded.
SourceKey	Optional	None	Field	Specifies the foreign key needed to perform a join-in between a join-in field and another object.
SystemField	Optional	N	Y	This field is generated by the Offline Client for Life Sciences.
SystemField	Optional	N	N	This field is not generated by the Offline Client for Life Sciences.
Type	Required	None	Field	This element is a field.
UserKey	Optional	Null	0	This field is the user key. You can use only one user key for each object, which is usually the Id field.
UserKey	Optional	Null	Null	This field is not the user key.

Field Constraint

Table 20 describes the field constraint for the Filter schema.

Table 20. Field Constraint
Attribute Name	Required or Optional	Default Value	Value	Function
ID	Required	None	UNIQUE	There can be only one record with this value in this field.
ID	Required	None	NOT NULL	Indicates that this field must not be empty.

Table Constraints for the Filter Schema

Table 21 describes the table constraints for the Filter schema.

Table 21. Table Constraint
Attribute Name	Required or Optional	Default Value	Value	Function
Entity	Required	None	Object	Name of the object this contraint is applied to
UniqueConstraint	Required	None	Field[, Field]*	Specifies one or more fields which make up the unique constraint for this object.

Configuration Guide for Siebel Offline Client for Life Sciences		Copyright © 2011, Oracle and/or its affiliates. All rights reserved. Legal Notices.