Using LIP

The current implementation is written in VBA and is used through the Immediate window of the VBA editor.

Install a Package

To install a package, simply type your command in the Immediate window of the VBA. There are three different installation methods:

lip.Install("Packagename") Searches for the add-on in Lime Store based on the uniquename which is configured in the .limestore.json file in the add-on repository, then downloads and installs it.

lip.InstallFromZip Installs a deploy package or add-on from a zip file. It will open a file dialog where you can point out the zip file you wish to install.

Automatic Installation

These are the things LIP can automatically install:

  • VBA modules, class modules and forms
  • Tables
  • Fields
  • Localizations (in the localize table)
  • Actionpads (manual registration needed afterwards)

Manual Installation Required

The following things can be included in a LIP package but requires manual installation after the automatic installation has finished. In which folder in the LIP package they should be stored is stated within parenthesis. More details on how to store them can be found in the Community Add-ons requirement list (soon on Lime Prime).

  • Lime Bootstrap apps (apps)
  • VBA code snippets to insert in existing VBA modules, class modules or forms (vba)
  • SQL procedures and functions (sql)
  • Table icons (lisa\icons)
  • Option queries (lisa\optionqueries)
  • Table descriptive expressions (lisa\descriptives)
  • SQL expressions (lisa\sql_expressions)
  • SQL for new (lisa\sql_for_new)
  • SQL on update (lisa\sql_on_update)

Unsupported

Below is a list of unsupported things. Some of them may be added in the future.

  • Policies
  • Groups
  • Users
  • Record access
  • Virtual tables
  • Filters
  • Views
  • Templates
  • Reports
  • Set lists for fields

Upgrade a Package

Currently not working for all add-ons, we need a new version of Lime Store first.

If a package already exist and should be updated or reinstalled you must explicitly use the update command:

lip.UpgradePackage("ExamplePackage")

Create a Package

LIP Package Builder is a tool for creating LIP packages or new add-ons easier.

Through an easy-to-use GUI you can select your components for the LIP package. Click Generate Package to create a LIP zip file as well as everything you need when you are creating a new add-on.

  1. Open the Package Builder GUI by running LIPPackageBuilder.OpenPackageBuilder in the immediate window in the VBA editor. Note that the user you are logged in as need to have a coworker card for it to work.
  2. If you want to create a new version of an existing package, click the Open Existing Package button and select the relevant LIP zip file.
  3. Enter the information on the Details tab.
  4. Select the objects that should be included in the package.
  5. Click the button "Create Package". Choose where to save the generated files. The folder created will be opened in a Windows explorer. The output is two things:
    1. A folder called add-on that will contain everything you need to put in the GitHub repository if you are creating a new add-on. This follows the requirements for Community Add-ons. This folder is only generated if you select "Add-on" in the Package Builder GUI on the Details tab.
    2. A LIP zip file of the content of the folder add-on\lip. This is the zip file that you should use to install the package in another Lime CRM application. The file lip.json in the zip file follows the structure described in the LIP repository.
  6. If working with a new version of an add-on: Add the content of the add-on folder to a GitHub repo.
  7. If using it as a launching tool: Logon to the target Lime CRM application and use LIP to install your package by pointing out the generated zip file.

Supported Components

The following objects in a Lime CRM application can be selected in the UI:

  • Tables and fields
  • VBA modules
  • SQL functions and procedures
  • Localizations
  • Actionpads

Limitations

Some things that are not supported by the LIP installation of a zip file are exported to separate folders (according to the Community Add-ons requirements) for manual installation:

  • SQL procedures and functions
  • Option queries
  • SQL expressions, SQL for update and SQL for new on fields.
  • Table descriptive expressions
  • Table icons

Open Existing LIP Package

It is possible to open a previously created LIP zip file. The Package Builder will show which components that were part of that zip file. You can then add new or remove previously included components to create a new version of the package/add-on.