Main Concepts

Users and Groups

Before any person can run a Vine product, a user must be created by a Vine administrator and added to a corresponding product license group. For normal usage of Vine products it is important that every user has a unique username.

The number of named users of each Vine product is limited by the License Key for this product. When this limit is reached, no more new users can use it. At this point, you should order a new license.

Main Group

You can create ordinary groups of users to organize Vine users into smaller units. Users in the same group share common data and other resources. A user can be a member of any number of groups, but there can only be one Main group for a particular user. When a user creates an object, by default the Visibility and Editing fields on the edit form are assigned to the Main group of this user.

ShowInClient Setting

When creating or editing a group you can select the Show in Client check box if you want this group to be visible to users. Otherwise, the group will be marked as "Hidden" and will not be visible to Vine users.

Working with Users and Groups

You can work with Vine users and user groups in either Vine Server Setup or Vine Administrator’s Web console.

In Vine Server Setup you should use the Users page:

In Administrator’s Console the tools to manage users and groups are organized in the Users & Groups pane.

Note: Please refer to the Vine Web Administrator’s Console section for detailed instructions and information about each tool.

Here is a summary of functionality available in Vine Server Setup and Administrator’s Console:

Command	Vine Server Setup	Vine Administrator’s Console
Enter product license	Licenses page	License Editor
Create user	New on Users pane	Add User wizard
Delete users	Delete on Users pane	Users tool
Change person	Edit on Users pane	Users tool
Unlock account	-	Users tool
Set Main Group	New/Edit on Users page	Users tool
Reset User Password	Edit on Users page. The administrator can set a new password and inform the user.	Users tool. Password is generated automatically and sent to the user.
Set Authentication Type	Edit on Users page. Domain or Oracle Authentication	Type of authentication set for a new user automatically on step 3 of the Add User wizard depending on the authentication type configured on the Vine Web server.
Create group	New on Groups pane	Add Group wizard
Delete Group	Select group and hit the Delete key or click Delete	Delete User Group wizard
Add/remove users or group members	Drag users or add group members using Members/Member Of tabs of User/Group Properties Select user and hit the Delete key or click Delete	Add Group wizard
Add multiple users	-	Add Multiple Users wizard. Helps to create multiple Vine user accounts at once and associate them with persons. For each user, it is enough to enter a full e-mail address.
Organize users and groups	-	Organize Users And Groups tool. The administrator can freely organize users and groups. Add/remove users or subgroups to/from any group
View All Groups of User	Use "Member Of" tab of User Properties

Parameters

About Parameters

Vine objects can have parameter fields, i.e. fields which can take only a fixed set of values. Each value consists of at least a numeric ID unique for that parameter and a text name. Special so-called phase parameters have an additional "In To-Do list" flag. When the flag is set the corresponding Vine objects in this phase will be shown in the To-Do list.

Each parameter type has a unique ID. IDs are used internally within the database. Negative IDs are used for standard parameter values which cannot be changed and are present in any Vine installation.

By default, Vine shows lists of parameter values ordered by their IDs, but you can change the position of any parameter using the Edit Parameter Values tool in the Administrator’s Console.

Example: Projects have a parameter field called Phase. The set of available values for that field is defined by the PROJECTPHASE parameter, e.g. "Active", "Ready", "Cancelled", etc. If, for instance, the "Active" value has the "In To-Do list" flag set, then projects in the Active phase will be shown in the To-Do list by Vine.

Note: You cannot add or remove values of certain parameters such as EVENTPHASE, COLL_TOPLEVEL, COLL_EXCLUDING parameters. You can only edit the text values of these parameters.

Obsolete Field Values

0 - normal
1 – Obsolete. You can declare a type or phase parameter value as "obsolete". Then 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.

Use the Tools and Settings tool in the Vine Administrator's Web Console to set the obsolete field of a parameter.

Customizing Parameters

Using parameters you can fine-tune the functionality of Vine products. The administrator’s duty is to create or edit parameters. This can be done using the Vine Web Administrator’s Console or Vine Object Manager. Parameter modifications made in the Administrator’s Console can be used instantly in Vine after the next synchronization.

All parameter types are set during the installation to meet the most common objectives; however, it is certain that you will need to modify some parameter types to adjust Vine to your organization’s needs. Additional types of parameters can be introduced for add-on products and plug-ins.

Use the Edit Parameter Values tool in Administrator’s Console to customize Vine parameters.

Note: Please refer to the Vine Web Administrator’s Console section for detailed instructions and information about parameter editing.

Connection Types

About Connection Types

With connection types you can adjust Vine system to your organization's business practices. Connection types control the way Vine objects can be linked to each other. A connection between a couple of objects can be created only if a corresponding connection type having a unique ID exists in the database.

A connection type is a connection template that defines the following parameters of each connection:

"From" and "Target" types of objects, e.g. FROM - Company, TARGET - Person;

Names of both connection directions, e.g. From company side: "Employee", From person side: "Employer";

Default option. The connection type marked as Default will be automatically selected in the connection type selection dialog.

Only one option. Each direction of a connection type has the Only one check box. If the check box is selected then the object to be connected can only have a single connection in that direction. Otherwise, any number of connections are allowed.

Each connection type has a unique ID. IDs are used internally within the database. It is not recommended to create new connection types with IDs in the 1 - 1000 range since that range is reserved for standard connection types. You should choose an ID above 1000 for a new connection type.

Connection types cannot be modified through Vine client applications.

Obsolete Connection Types

You can declare a connection type to be "obsolete" if it should be no longer possible for users to create new connections of this type but existing connections still have to be fully supported.

Use the Vine Administrator's Web Console to mark a connection type "obsolete".

After a connection type has been marked as "obsolete", it can no longer be selected when connecting objects. However, objects already connected with an "obsolete" connection type will retain their connection until it is removed.

Customizing Connection Types

Connection types are set to initial values in the Vine system installation.

Use the Edit Connection Types tool in Administrator’s Console to customize Vine connection types.

Note: Please refer to the Vine Web Administrator’s Console section of this guide for detailed instructions and information about connection type editing.

Local Database of Vine Client for Windows

The local database acts as a "cache" between the user interface and the server database. Vine objects are copied to the local database when the user opens an object window. Eventually, most of the user's customers, contact persons and projects will be located in the local database, thus gradually reducing traffic between the client and the server.

The local database permits using Vine without a server connection. The local database is a subset of the server database. The possibility of loss of data is limited to the changes made during the last stand alone session. The local database can be deleted if desired, but you must ensure that the information has been transferred to the server. This is done by creating a server connection. The next time Vine is opened, a new local database will be created. The changes that have been made without a connection to the server are updated when the server connection is created. If information in the server has been altered, the user has to choose which of the changed pieces of information is saved.

Vine synchronizes local databases with the server database automatically. When a user is connected to the server, all changes are stored directly in the server database. Clients check for changes made in the server database at regular intervals. Each local database has an account in the server database. The synchronization mechanism looks for changes made to objects listed in this account. When Vine is used without the server connection (stand alone), changes made to the local database are forwarded to the server database the next time the user connects to the server. At this point, Vine checks and informs the user of any conflicts. New objects are checked (by name) for duplicates and modified objects are checked for changes made by other users.

All synchronization is done in the background without user assistance. Synchronization operations have a lower priority than user's requests (e.g. find, save, open, etc.). Synchronization is deferred if there is any user activity. A user can start synchronization from the Vine client.

System Settings

System settings are special configuration variables stored in the VY_USERSETTING table, which are used in Vine in much the same way as the operating system's environment variables are used by Windows applications.

System settings are created using the System Setting Editor wizard in the Administrator’s Console.

A system setting has the following attributes:

Setting Name is the name of a setting. Setting names should be unique. It is recommended to add a prefix stating the producer.

For example, the VY_ReportRecipients name can be used for a setting used by a plug-in that sends a specific report to a collection of involved people. The "VY_" prefix shows that this is a setting created by Vine.

Setting ID is the ID of a setting. Generated automatically.

Setting Type is the type of a setting. The type specifies what values the setting can take. The type can be the name of a database table or an additional STATIC type.

For example: the type of the VY_ReportRecipients setting is VY_COLLECTION.

Setting Value is the value of a setting. If a setting's type is the name of a database table, such as VY_COMPANY, VY_EVENTTYPE, VY_CONNECTIONTYPE, etc. then the setting can take as its value only the name of an entry from that table. If a setting's type is STATIC then its value can be any number or any text string.

For example: the value of the VY_ReportRecipients setting can be 'Sales Team'. Where 'Sales Team' is the name of an existing collection.

Showgroup. This is the standard Vine visibility restriction. Only members of a group assigned to the given showgroup will see the setting. Please note that for all new system settings you should use showgroup instead of “Setting User”.