Vine Client for Windows

Installing Client Components

To install or upgrade Vine Client for Windows, double-click the self-extracting setup file to start the installation process. Follow the instructions given by the setup program. By default the setup will install Vine client for Windows to

\Program Files (x86)\Vine\Vine

If you want Vine client for Windows to be located in another directory, you can change the installation directory when prompted by the setup.

Note: To install Vine, you must have the Administrator rights on the computer or be able to provide the Administrator password when the installer asks for it.

Upgrading Vine through Vine Database

A major version upgrade of Vine for all users of a Vine database can be done by placing the Vine .msi installer to the database.

Full Version Upgrade

To perform a full version upgrade of Vine, please add the new Vine setup .msi file as a plug-in:

Now Vine can be started on a client PC.

Please note that Vine 5 and higher requires Microsoft .NET Framework 4.x Client Profile. The installer of Vine checks if the operating system has the needed version and informs if it needs to be installed.

Upgrading Separate Components

You can update a Vine component to a newer version or add a completely new component by uploading it to the Vine database as a plug-in of type “Vine for Windows Component” (or “.Net Tool Tab” for a Tool Tab component).

Please also note the following for upgrades to run smoothly:

You should always enter the correct version of the component to be upgraded. Failing to do so may result in broken Vine client for Windows.

Vine will start downloading components after a one hour delay to make sure that all the needed files have been already uploaded.

Note: Vine does not need additional rights or/and UAC confirmation to install its updates and plug-ins. The Vine Update Windows service has all the needed rights to install Vine updates and plug-ins.

Distributing Vine through Active Directory Group Policy

If your company uses the Microsoft Active Directory environment, you can easily distribute Vine client for Windows to client computers through Group Policy. You will have to:

Place Vine.msi on a network share available for client user and/or computer accounts.
Create a new or edit an existing GPO (Group Policy Object) for your domain.
Add the .msi as a new software package in the "Computer (or User) Configuration->Software Settings->Software installation" section of this GPO.

For detailed information and step-by-step instructions, please see: HOW TO: Use Group Policy to Remotely Install Software

Additional Vine Installation Options

If you need a custom installation you can use the command line options of the Windows Installer (msiexec.exe) to set its switches and public properties.

Note: Please note that for a successful per-machine installation the user must have the administrative rights on the computer.

The following examples assume that the Vine.msi package is located in the current directory:

The following command will attempt a silent per-machine installation (shortcuts will be created in the All Users profile):

msiexec /i “Vine.msi” /qn ALLUSERS=1

Please note that for a successful per-machine installation the user must have the administrative rights on the computer.

This command will additionally install the Vine desktop shortcut:

msiexec /i “Vine.msi” /qn ALLUSERS=1 SHORTCUT_DESKTOP=1

Using the INSTALLDIR property you can change the folder where Vine will be installed:

msiexec /i “Vine.msi” /qn ALLUSERS=1 INSTALLDIR="C:\Vine"

Vine Login Data

To connect to the server database Vine client for Windows asks the user for the following settings:

The user must have enough information in order to enter correct data.

Types of Server Connection

Vine client for Windows can use two types of server connection: direct connection to the Vine server on Oracle - Oracle Connection or connection through a Vine Application Server - VAS Connection. By default, Vine always uses a VAS connection. If you want to use an Oracle connection you have to use a special application DatabaseChanger.exe available in the installation folder of Vine.

VAS Connection

The user avoids installing Oracle client software by using VAS connections. VAS is an intermediary server that connects Vine client for Windows to the Oracle server. You should set up the VAS server and provide users with the needed login settings:

Server Type: VAS

Server name. The network name (or IP address) of the computer where VAS is installed.

User name.

User password.

The user normally does not need to enter the port number, unless you have changed the default ports used by VAS. Please note that by default, port 6202 is used. Port 443 is used by default for special connections such as vas.myvineyard.biz, koulutusvas.vineyard.fi, login.vineyard.fi, and login.vine.eu

Changing User Passwords

Initially, you assign users their user names and passwords. After that, it is recommended that users periodically change their passwords. Please note that if you are using Windows domain authentication then users cannot change their domain passwords in Vine.

Customizing Today Pages

It is possible to customize the Today pages to show the information you want. The layouts of today pages are stored in today_.xml files for each role. The structure of today xml is defined in the today.xsd file.

For more information about how to edit today.xml files please refer to Vine Developer's Guide.

The customized today.xml files should be added to the Vine database as "support file" plug-ins. Please note that the name of a today page plug-in must be the same as its file name.

Vine needs to be restarted twice to load the new today page.

Note: Please note that if you add an image as a plug-in then you also have to enter its file name in the name field and use the "support file" type.

Supporting Crystal Reports

Vine supports automatic installation of .NET Framework 4 Extended (by using the Update Service). You need to download (http://www.microsoft.com/download/en/details.aspx?displaylang=en&id=17718) and put dotNetFx40_Full_x86_x64.exe (using exactly this file name) to the Vine database as a plug-in with the following parameters:

Type – V4 Component

Version - 4.0.30319

Windows Registry Settings

Setting Variables

Vine registry settings for plug-in and local database locations use data stored in the following variables:

APPDATA is a common directory for application and user-specific data in Microsoft Windows. A typical path in Vista/Windows 7 is “C:\Users\username\AppData\Roaming”.

VYFOLDER contains the Vine connection-specific part of the data folder path. It has the following structure:

CONNECTIONTYPE#SERVER@PORT#USERNAME. Examples are:

"Oracle#Vine#lisa", "VAS#vyserver@6202#lisa"

Local Database

Vine automatically saves its local database in the localdb.vy4 file at the following path:

%APPDATA%\Vintage\%VYFOLDER%\localdb.vy4

This can be changed by adding the following registry setting:

HKEY_CURRENT_USER\Software\Vine International\Vintage\Login\LocalDBPath

HKEY_LOCAL_MACHINE\Software\Vine International\Vintage\Login\LocalDBPath

Note: Please note that the registry setting should be of the "Expandable String" type (REG_EXPAND_SZ) if you want to use system variables like %LOCALAPPDATA%

Vine will first look for the setting in the HKEY_CURRENT_USER branch and then in HKEY_LOCAL_MACHINE.

If it finds a non-empty LocalDBPath setting, it will substitute APPDATA with the value of LocalDBPath and will save the local database in the

%LocalDBPath%\Vintage\%VYFOLDER%\localdb.vy4 file.

Plug-in Files

Vine first saves its plug-in files in the folder where the local database is located:

%APPDATA%\Vintage\%VYFOLDER%\

or, if LocalDBPath is not empty:

%LocalDBPath%\Vintage\%VYFOLDER%\

Using Vine on a Terminal Server

In some environments, for example when used on a terminal server, Vine must not register plug-ins and install updates for each individual user. The recommended procedure is as follows:

The administrator installs Vine and/or its updates.
The administrator makes sure the Vine Update service is started.
Vine is started so that all the plug-ins that need registration are properly registered.
The administrator uses the DisableUpdateService registry setting to disable the Vine Update service.

Now individual users can use Vine.

When a new version of Vine or new components are released the administrator again has to enable the service and run Vine once for it to download, install and register all the components and plug-ins.

For Vine to ignore the Vine Update Service, the following registry setting should be used:

[HKEY_LOCAL_MACHINE\SOFTWARE\Vine International\Vintage4Path] on x32 systems

[HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Vine International\Vintage4Path] on x64 systems

"DisableUpdateService"= dword:00000001

If DisableUpdateService set to 1 then the Vine Update service can be safely disabled.

Note: If DisableUpdateService set to 1, then Vine ignores updates but downloads plug-ins without attempting to register those.

Closing Vine Reminder

If the following registry setting exists and is set to "True":

[HKEY_LOCAL_MACHINE\Software\Vine International\Reminder] "QuitReminder"="True"

Vine Reminder will quit when Vine quits.

Forgot Your Password Link

If the WebUrl registry setting exists then Vine Login includes a special link Forgot your password? on the Vine login screen. The setting defines an address of a password change web page which opens if the user clicks the link.

Normally, this setting should be created automatically. It can be created either when the user opens a special Vine login link (for example, included in an email) or it can be overwritten by the value of the VS_Forgot_Password_Url system setting.

Running Vine in Compatibility Mode

By default, if the Compatibility mode is enabled on Windows 8 or later then an error message is displayed and Vine quits.

However, if Vine must be started in the Compatibility mode then the DisableManagedExceptionHook registry setting must be added with the type: DWORD and value 1 to HKEY_CURRENT_USER\Software\Vine International\Vintage. (In this case, some of error reporting functionality, which cannot work in the Compatibility mode, is disabled and Vine is started.)

Using Not Supported Versions of Vine Database and VAS

When Vine starts, it verifies the versions of the Vine database and Vine Application Server (VAS). If the versions are no longer supported then Vine shows an error and suggests updating the Vine database and VAS to the latest versions.

In some rare cases, however, it might be needed to get around this error and login to the database. It is possible to do so by creating the following registry setting:

[HKEY_CURRENT_USER\Software\Vine International\Vintage\Login]

"SkipServerVersionCheck"=dword:00000001

Note: This possibility is not recommended and the behaviour of old versions of VAS and Vine database is not supported in any way.

Vine windows client Logging

Instructions for turning on Vine windows client logging:

Create a logger configuration file. This file should contain the following line:
filelog=<log file name>, e.g.

filelog=C:\Users\Admin1\Documents\Vintage.log

Create LoggerConfig REG_SZ value under “HKEY_CURRENT_USER\Software\Vine International\Vintage” key. This value should contain full file name of logger configuration file created on step1.

Restart Vine windows client.

Vine System Settings

New person/company country

It is possible to specify the default country for new persons and companies.

Default country ID can be set as STRINGVALUE using the VY_DEFAULT_COUNTRYNAME system setting.

Latest News

The Latest News list on the Today page shows company-wide events located in a special collection which is set by the vy_intra_messages system setting.

Calendar Change Confirmation

If users want to get confirmation dialog for each event change they do in their Calendar (e.g. resizing an event or moving it to another time slot) you can use the Vintage_Calendar_Confirm_Changes setting. Set the setting to “1” for changes to be confirmed by the user and to “0” to disable confirmation. By default, i.e. when there is no setting, the confirmation dialog is not shown. Set the showgroup to a correct value to make the setting viable to users who need confirmations.

Add Persons to Calendar

The setting VS_Organization_Collection defines the parent collection which holds all person collections listed in the "Add persons to calendar" dialog. The setting can be created using the System Setup wizard or the System Settings Editor.

Remember Password Option in Login

Set the setting VS_Allow_Remember_Password to 1(Allow) for the Remember password option to appear in Vine Settings on the General tab. Please note that the Single sign-on (SSO) support setting must be set to Disallow for this setting to take effect.

Single sign-on (SSO) support

If the setting VS_Allow_SSO is set to 1(Allow), Vine will attempt SSO login if the name of the Vine user is the same as the name of the Windows user (without domain).

Send Sales Email Event Types

By default, when the Send Sales Email command is used, an event of the type "-5" is created. The same type of events is also created by Vine Email Reader. You can set a special type of events for the Send Sales Email command using the vx_mailwizard_salesemaileventtype setting.

This can be useful, for example, to make the Sales Emails metrics to include only emails sent using the Send Sales Email command. Without this setting, the metric also includes emails processed by Vine Email Reader.

Vine Web Server URL

The setting vx_webURL defines the web server part of URL plug-ins and make "relative" URL plug-ins such as the following "Create RSS Feed" URL plug-in possible:

/Vine/pageloader.jsp?username=<USERNAME>&password=<PASSWORD>&loadpage=/Vine/tableview/rssList.jsp

In this example, vx_webURL can be set to "http://Vine:8080/Vine"

Error Reporting

When Vine crashes, it sends a brief technical summary of the crash (which does not include any personal data) to Vine and opens up a dialog where the user can choose to send an error report and a screenshot of the crash.

The following table clarifies what data is sent depending on what the user selects:

Data sent by error reporting component:

User selection	Data sent
Nothing selected	Only technical summary sent to error reporting service No data is sent by email
Only Send Error Report selected	Technical summary and crash report sent
Send Error Report AND Attach screenshot selected	Technical summary, crash report and screenshot are sent

The following Vine system settings can be used to configure Vine windows client problem reporting:

VintageError_ToAddress. If the setting does not exist Vine uses “CrashReport@Vine.fi”

VintageError_SmtpServer. If the setting does not exist Vine uses “mail.Vineinc.com”

DisableErrorReportingWebService. Set this system setting to "1" in order to disable the use of Vine reporting web service

Configuring Vine Problem Reporting

Configuration	Action
Default (DisableErrorReportingWebService and VintageError_ToAddress settings are not set)	Error report is sent to error reporting web service
DisableErrorReportingWebService not set VintageError_ToAddress set	Error report is sent to error reporting service and to email address specified by VintageError_ToAddress
DisableErrorReportingWebService set to 1 VintageError_ToAddress set	Error report is sent to email address specified by VintageError_ToAddress

New user email VAS settings

This setting ACNewUser_VASSettings helps to distribute the VAS server and port information to new users as it is included in a Vine invitation email sent to a new user when it is created in the console.

Email Address for Email Reader

The EMR-ToVine_email setting defines the email address used by the Save to Vine add-on in Microsoft Outlook. Vine Email Reader should read this email box and add received emails to Vine database.

Please note that:

This add-on only works with Microsoft Office 2010/2013/2016.
This add-on is installed by Vine windows client. It is recommended to close Microsoft Outlook and other Office applications when installing or uninstalling Vine.
This add-on works properly without Vine windows client running, but it is enabled only after Vine started once.

Settings for Email Reader in ASP environment

The following setting has to be first created manually for Email Reader to work in the ASP environment: MW_FromAddresses_patterns

For example:

tocrm-<organizationid>@Vinecrm.com,support- <organizationid>@Vinecrm.com

The setting’s visibility must be set to “ALL”. The first entry in the setting must be a template for an organization email address in the mail server, and all entries are templates for email addresses the users will see in the “From Address” list when using Mail Wizard.

Based on MW_FromAddresses_patterns the following system settings will be automatically created for each new organization by replacing the <organizationid> entry with a real organization id in the Vine database:

EMR-ToVine_email For example, “tocrm-12345@Vinecrm.com”. This address will be used by the Vine Outlook Add-on to save emails to the Vine database (see the previous chapter).

MW_FromAddresses. For example, “tocrm-12345@Vinecrm.com, support-12345@Vinecrm.com”. When using Mail Wizard, the user will see these email addresses added to the “From Address” list.

Forgot Password Page Address

If a VS_Forgot_Password_Url setting is available for the current Vine user then the registry setting WebUrl is set to the value of this system setting.

The setting should include a web address of the web page which resets the user’s password, for example:

https://myVine.biz/extranet/verification/reset_pass.jsp

The Security tab is shown in Vine windows client if VS_Forgot_Password_Url is set.

Object Summary View Profiles Classifications

You can add a custom parent classification collection to be used in the Profiles pane in an object's summary view. This can be configured using the following Vine system setting for each object type separately.

VY_PERSON_SummaryViewClassificators

“VY_PERSON” can be replaced with any object type.

A comma-separated list of collection ID values can be used as teh value of teh setting.

For example:

STATIC

VY_PERSON_SummaryViewClassificators

314189291,313725179

Where 314189291 is the ID of the “Hobbies” collection and 313725179 – the ID of the “Job Responsibility” collection

Task List Collection

The collection Vine uses to connect events visible in the Task List tool are set by the

VX_EMAILSAVER_UNKNOWN_COLLECTION system setting.

Minimum Required Vine Version

It is possible to force users to install new Vine versions. MinRequiredVintageVersion system setting should contain minimal Vine version that can be used.

If the user clicks Later in “Vine Updates” dialog and his Vine version is earlier than MinRequiredVintageVersion then upgrade is forced at next Vine login as follows: When the user clicks OK in “Vine Login” dialog, the “Vine Updates” dialog with a single Install button is displayed. The user can’t start working with Vine without installing this update.

Mail Wizard Users

Please note that to use Vine Mail Wizard, users must be included in both the Mail Wizard and Document Manager license groups.