Object Parameters

Object Parameters

Examples of parameter tables: VY_EVENTPHASE, VY_EVENTTYPE, VY_PROJECTPHASE, VY_RESOURCETYPE

VP_AUTOMATIONTYPE, VP_COMPANYFORM, VP_COMPANYTYPE, VP_COUNTRY, VP_COUNTRYTYPE

Any Vine object (standard or custom) can have parameter fields, i.e. fields whose values can be chosen only from a fixed set of choices. This set of choices is stored in a separate parameter table whose name is given in the TYPEPHASENAME column of the parameter field in VY_TABLE_FIELD table. Normally, the name of an object parameter table should be constituted by adding the "VP_" prefix (old parameter tables have the "VY_" prefix) to the name of the parameter field.

For example, the PROJECTPHASE parameter field of the VY_PROJECT table has the corresponding VY_PROJECTPHASE parameter table.

Internally, in a parameter field of an object the ID of a chosen entry from the parameter table is stored, while the end-user sees and operates with the parameter's names:

Figure 11. How object parameters are used 

By default, when the "API" set is created during the database installation, a number of parameter tables are created and filled with initial entries (parameters) which are imported from data_english.xml. Later these parameters can be edited and new parameters can be created.

Parameter values can be assigned a color code and Vine will highlight events with colors according to their types.

By default, lists of parameter values are ordered in Vine clients by their IDs. This can be changed using the POSITION field which all parameter tables have.

Parameter Table Fields

The following generic fields are present in almost all parameter tables ( a short list of exceptions below the table):

Table. Generic fields of parameter tables

Column Name	Data Type		Description
ID	NUMBER(9)	M	Unique numeric identifier
STATUS	CHAR(1)	M	Status of the value. Normally it is 'B'; it changes to 'D' when deleted.
CREATEDATE	DATE	R	Timestamp for the creation. By default = SYSDATE
CREATEUSER	VARCHAR2(32)	R	The name (in uppercase) of the user who has created the object.
CHANGEDATE	DATE	M	Timestamp for the last modification of the object. By default = SYSDATE
CHANGEUSER	VARCHAR2(32)	R	The name (in uppercase) of the user who last saved the object.
SHOWGROUP	NUMBER(10)	M	The visibility setting. It can be: - 0 (zero), means that any user can see the parameter; - ID of a user or a user group that can see the parameter.
XMLDATA	XMLTYPE		allows storing extra data without creating new database fields Synchronized to local Vine database XML fields should be converted to nvarchar with to_nchar-function before retrieving to client Note: The top level element must be <ROOT> and all data must be inside it. (to prevent multiple roots added by different tools)
OBSOLETE	NUMBER(1)
Description	NVARCHAR2(2000)
POSITION	NUMBER(9)
COLOR	NUMBER(10)		Used to set object’s color attribute. Vine tools such as Calendar, can check this attribute to apply color formatting to the object.

In addition to the above fields the "phase" parameter tables (tables which have "phase" in their names) have the INTODOLIST field.

Tables which have or do not have the listed generic fields:

VY_EVENTTYPE table contains SHOWINCALENDAR field

Column Name	Data Type		Description
SHOWINCALENDAR	NUMBER	M	Used to pick event to show on the Calendar If =1 then must be shown on the Calendar

VS_AREA contains a number of ICON* fields

VS_EMAIL_STATISTICSTYPE contains SORTORDER

VM_CRITERIATYPE and VM_CRITERIATYPE - EDITGROUP

VM_CRITERIATYPE doesn't contain XMLDATA field

Phase Parameters

The characteristic feature of the phase parameters is that in addition to all the generic fields they have the INTODOLIST field whose value specifies whether an object in that phase will be or will not be shown in the Vine To-Do list. The type parameters do not have such a field.

For example, when creating a new project in Vine, it is possible to choose its phase from the Phase pop-up menu. The VY_PROJECTPHASE table stores the project phases, i.e. available menu entries:

INTODOLIST in VY_PROJECTPHASE

Column Name	Data Type		Description
...	...	...	Generic fields are skipped.
InToDoList	number(1)	M	1 = projects in this phase are shown in Vine To-Do lists, 0 = projects are not shown in To-Do.

The structure of the VY_EVENTPHASE table is identical to that of VY_PROJECTPHASE. When creating a new event in Vine, it is possible to choose its phase by selecting the Done check box. The VY_EVENTPHASE stores the event phases, that can be others than 'Done', 'Not Done' which are the default event phases in Vine.

INTODOLIST in VY_EVENTPHASE

Column Name	Data Type		Description
InToDoList	number(1)	M	1 = events in this phase are shown in Vine To-Do lists, 0 = events are not shown in To-Do lists.

Type Parameters

When creating a new event in Vine, it is possible to choose its type from the Type pop-up menu. The VY_EVENTTYPE table stores the available event types.

When creating a new resource in Vine, it is possible to choose its type from the Type pop-up menu. The VY_RESOURCETYPE table stores the available collection types.

Values of Obsolete Field

• 0 - normal

• 1 – Obsolete. Users will not see that value in new objects or objects having another value of the parameter but it will still be fully supported in objects where it has already been selected. Parameters marked as “obsolete” are not shown only in object edit forms but can be shown in tools.

• 2 - Behind others. Parameters with this value of the Obsolete field will be listed after all other parameters. Usually for these parameters to be displayed the user has first to select a special option with the name ‘Other’.

• 3 – Disabled. Parameters marked as “disabled” work as “obsolete” ones. The only difference is that “disabled” parameters are not shown anywhere, that is, not only in object edit forms but also in tools.