URL Structure

URL Structure

The following URL is entered using Vine Administrator’s Console when installing a Web Plug-in (for detailed information about plug-ins installation, please refer to the Vine Administrator's guide):

http://server:port/vineyard/pageloader.jsp?username=<USERNAME>&password=<PASSWORD>&loadpage=/vineyard/admin/adminconsole/index.jsp

Here SERVER:PORT should be replaced with the web address and the used port number of the server where Vine Web is installed.

Vine for Windows replaces the <USERNAME> and <PASSWORD> strings with the current Vine user name and scrambled password, respectively. The DES algorithm is used to scramble the password. It can be unscrambled only by Vine Web. <CURRENTOBJECTTYPE> and <CURRENTOBJECTID> strings can also be used in the URL. If an object is selected in Vine Windows client, then the strings are replaced with the object's type and ID, respectively.

The loadpage parameter is used to pass the name of the first custom web page to pageloader.jsp

Using Object Fields

You can pass a Vine object field value into an URL by enclosing field name in angle brackets as follows: <STREETADDRESS>, <FIRSTNAME>. Thus, when you click an object in Vine Web or right-click an object in Vine for Windows and select an URL plug-in, the values of the fields of the clicked object can be passed to the plug-in URL.

Only object fields available through the corresponding object view can be used in URL plug-ins.

Please note that in order to use object fields, a URL plug-in must be registered to be used with the corresponding object type (the Use With option in the Edit Plugin tool of the Web Admin console).

Example

The following URL plugin can be used in Vine Web and Vine for Windows to locate a company on the Goggle map:

http://vineyard:8080/vineyard/pageloader.jsp?username=<USERNAME>&password=<PASSWORD>&currentobjectid=<CURRENTOBJECTID>&loadpage=http://maps.google.com/maps&f=q&hl=en&geocode=&q=<STREETADDRESS>+<ZIP>+<CITY>+<COUNTRY>

The plugin should be registered as follows:

It can be invoked for a company in Vine for Windows as follows: