Skip to content

justFredster/lip

BranchesTags
 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

293 Commits
python
python
 
 
sql
sql
 
 
vba
vba
 
 
.gitattributes
.gitattributes
 
 
.gitignore
.gitignore
 
 
readme.md
readme.md
 
 

Repository files navigation

#LIP - Package Management for LIME Pro

LIP is a package management tool for LIME Pro. A package can currently contain declarations for fields and tables, VBA modules, localizations and LIME Bootstrap Apps. LIP downloads and installs packages from Package and App Stores. A Package Store is any valid source which serves correct JSON-files and package.zip files. You can configure which stores to use in the packages.json-file in your actionpad-folder.

LIP is inspired from Pythons PIP and Nodes NPM but adapted for LIME Pro.

##Using LIP The current implementation is written in VBA and is used in the immediate window in LIME Pro's VBA-editor.

###Get started Before you can start installing packages, you need to install LIP to your Lime CRM database. Download the zip-file of the latest release under https://github.com/Lundalogik/lip/releases/, which includes all necessary files to get started, and follow these steps:

  1. Download the latest LIP release from the link above.
  2. Add the SQL-procedures to your database by running the SQL-scripts (Important! Make sure you run the scripts on your database and NOT the master-database by selecting the correct database in the upper left corner)
  3. Run exec lsp_setdatabasetimestamp on your database
  4. Restart the Lime Server component service (LDC)
  5. Restart the Lime CRM client.
  6. Import the vba/lip.bas file to your VBA.
  7. Import the vba/FormProgress.frm to your VBA.
  8. Type the command lip.InstallLIP in the Immediate-window of the VBA and press Enter to install all necessary modules.
  9. Compile and save the VBA
  10. Publish actionpads

###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") Standard installation of package. Searches for the package on the stores configured in your packages.json-file in the actionpad-folder.

lip.InstallFromZip() Install a package from a zip-file, displays a file dialog where you can point out the zip file.

lip.InstallFromPackageFile All installed packages are kept tracked of inside the packages.json-file in the ActionPad folder. If you transfer this file to a new LIME Pro database you can use this file to conduct a brand new install by typing the command above.

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

lip.UpgradePackage("ExamplePackage")

###Remove a package Not yet implemented! Should remove a specified package

lip.Remove "ExamplePackage"

###Freeze a solution to a package Not yet implemented! Compare to pip freeze > requirement.txt. Creates a package from a LIME Pro solution.

lip.Freeze

###List of things that LIP does not currently handle

  • Policies
  • Record access
  • Virtual tables
  • Filters
  • Views
  • Templates
  • Reports
  • Table icon (partly)
  • Set lists for fields
  • SQL-procedures/functions
  • SQL on update/new/expression (The code is still exported to a .txt for easy copy/paste, but not automatically installed.)

##Behind the scene

A Package

A package is a ZIP-file containing all required resources to install a package

A Package Store

A Package Store could either be file based or web based. A store has a fixed URL (example "http://limebootstrap.lundalogik.se/api/apps"). The URL has subdirectories for each app (example "./checklist"). If the source is a file-based a /app.json should automatically be append.

Specifying own package stores

Open the packages.json-file in the actionpad-folder and add your own stores in the "stores"-node. Give the store a name and provide the address. Example: "AppStore":"http://limebootstrap.lundalogik.com/api/apps/" When installing or upgrading a package, the stores will be searched from the top to the bottom, meaning your first store will be searched for the package first, then the second store and so on.

app.json

An example of how the app.json-file could look like:

{
    "name": "[NAME OF PACKAGE]",
    "author":"[AUTHORS NAME]",
    "status":"[STATUS OF THE PACKAGE, CAN BE: 'release', 'beta' OR 'Development']",
    "shortDesc":"[A short text to describe the package]",
    "versions":[
            {
            "version":"1",
            "date":"2014-02-06",
            "comments":"Css improvements!"
        },
        {
            "version":"0.9",
            "date":"2013-11-18",
            "comments":"The first stable beta of the Business Funnel"
        }
    ],
    "dependencies":{
        "vba_json":"1.0",
        "lime_basic":"5.0"
    },
    "install": {
        "localize": [
            {
                "owner": "checklist",
                "context": "title",
                "sv": "Test",
                "en_us": "Test",
                "no": "Test",
                "fi": "Test"
            },
            {
                "owner": "checklist",
                "context": "description",
                "sv": "A short description",
                "en_us": "A short description",
                "no": "A short description",
                "fi": "A short description"
            }
        ],
        "vba": [
            {
                "relPath": "Install/Test.bas",
                "name": "Checklist"
            }
        ],
        "tables": [
            {
                "name": "test",
                "localname_singular": 
                {
                    "sv": "Test",
                    "en_us": "Test"
                },
                "localname_plural": 
                {
                    "sv": "Test",
                    "en_us": "Test"
                },
                "attributes": {
                    "tableorder": "3",
                    "invisible": "2",
                    "descriptive":"[test].[title]",
                    "syscomment": "My comment",
                    "label": "15",
                    "log": "1",
                    "actionpad": "lbs.html"
                },
                "fields": [
                    {
                        "name": "title",
                        "localname": {
                            "sv": "Titel",
                            "en_us": "Title"
                        }, 
                        "attributes": {
                            "fieldtype": "text",
                            "limereadonly": "1",
                            "invisible": "0",
                            "required": "1",
                            "width": "3",
                            "height": "1",
                            "length": "256",
                            "defaultvalue": "Lund",
                            "limedefaultvalue": "Application.ActiveUser.Record.Id",
                            "limerequiredforedit": "0",
                            "newline": "2",
                            "fieldorder": "4",
                            "isnullable": "0",
                            "type": "1",
                            "relationtab": "1",
                            "syscomment": "My private comment",
                            "formatsql": "0",
                            "limevalidationrule": "My validation rule",
                            "label": "18",
                            "adlabel": "31"
                        },
                        "separator": {
                            "sv": "Testseparator",
                            "en_us": "Test separator"
                        },
                        "limevalidationtext": {
                        	"sv": "Min valideringstext",
                        	"en_us": "My validation text"
                        },
                        "comment": {
                        	"sv": "Min kommentar",
                        	"en_us": "My comment"
                        },
                        "description": {
                        	"sv": "Min beskrivning",
                        	"en_us": "My tooltip"
                        },
                        "options": [
                        	{
                        		"sv": "Alt 1",
                        		"en_us": "Alt 1",
                        		"key": "alt1",
                        		"color": "65535",
                        		"default": "true"
                        	},
                        	{
                        		"sv": "Alt 2",
                        		"en_us": "Alt 2",
                        		"key": "alt2",
                        		"color": "255"
                			}
        				]
                    }
                ]
            }
        ],
	"relations": [
	{
		"table1": "company",
		"field1": "person",
		"table2": "person",
		"field2": "company"
	},
	{
		"table1": "business",
		"field1": "responsible",
		"table2": "coworker",
		"field2": "business"
	}
	]
    }
}

####localize Here you can specify posts to be added in the localize-table of LIME Pro. Example:

"localize": [
    {
        "owner": "checklist",
        "context": "title",
        "sv": "Test",
        "en_us": "Test",
        "no": "Test",
        "fi": "Test"
    },
    {
        "owner": "checklist",
        "context": "description",
        "sv": "A short description",
        "en_us": "A short description",
        "no": "A short description",
        "fi": "A short description"
    }
]

vba

Here you can specify VBA-modules (Forms and Class Modules are also supported) that should be installed. Please note that the VBA-file MUST be included in the zip-file of your package. Please specify the relative path to the VBA-file and the name of the VBA-module. When adding forms, please include both form-files (.frm and .frx) and specify the .frm-file in "relPath". Example:

"vba": [
    {
        "relPath": "Install/MyForm.frm",
        "name": "MyForm"
    },
    {
        "relPath": "Install/MyClassModule.cls",
        "name": "MyClassModule"
    }
]

tables

name (mandatory)

Database name of the table. Example:

"name": "goaltable"
localname_singular (mandatory)

Localnames in singular. Each line in this node should represent one language. Valid languages are all languages LIME Pro supports. Example:

"localname_singular": {
"sv": "Måltabell",
"en_us": "Goal table"
}
localname_plural (mandatory)

Localnames in plural. Each line in this node represent a language. Valid languages are all languages LIME Pro supports. Example:

"localname_plural": {
"sv": "Måltabeller",
"en_us": "Goal tables"
}
attributes

Sets attributes for the table. Each line in this node represent an attribute.

"attributes": {
                    "tableorder": "3",
                    "invisible": "2",
                    "descriptive": "[test].[title]",
                    "syscomment": "My comment",
                    "label": "15",
                    "log": "1",
                    "actionpad": "lbs.html"
                }

Valid attributes:

Attribute Mandatory Possible values Value if not provided
tableorder No Integer Placed last
descriptive No text Record ID
invisible No 1/2 ("Yes"/"Yes, for everyone but administrators") "No"
syscomment ("Comment") No text
label No Integer No label
log ("Log all changes") No 0/1 (No/Yes) Default
actionpad No text

#####fields

name (mandatory)

The database name of the field. Example:

"name": "customernbr"
localname (mandatory)

Localnames for the field. Each line in this node represent a language. Valid languages are all languages LIME Pro supports. Example:

"localname": {
"sv": "Kundnummer",
"en_us": "Customer number"
}
separator

Adds a separator to the field. The separator is placed BEFORE the field. Specify the localnames for the separator inside this node. Example:

"separator": {
"sv": "Administrativ information",
"en_us": "Administrative information"
}
limevalidationtext

Adds validation text to the field. Specify the localnames for the validation text inside this node. Example:

"limevalidationtext": {
    "sv": "Min valideringstext",
    "en_us": "My validation text"
}
comment

Adds a comment to the field. Specify the localnames for the comment inside this node. Example:

"comment": {
    "sv": "Min kommentar",
    "en_us": "My comment"
}
description

Adds tooltip to the field. Specify the localnames for the tooltip inside this node. Example:

"description": {
    "sv": "Min beskrivning",
    "en_us": "My tooltip"
}
options

Adds options to an option field, set field or textfield. Every option must be specified as an own node and localnames and other attributes are placed inside this node.

Important! Localize rows must be placed first in the node. If you place the color or default attribute first, these attributes won't be set.

Some color-examples: red=255, yellow=65535, blue=16711680, green=32768.

Example:

"options": [
	{
		"sv": "Alt 1",
		"en_us": "Alt 1",
		"key": "alt1",
		"color": "65535",
		"default": "true"
	},
	{
		"sv": "Alt 2",
		"en_us": "Alt 2",
		"key": "alt2",
		"color": "255"
	}
]
attributes

Sets attributes for the field. Each line in this node represent an attribute.

"attributes": {
    "fieldtype": "text",
    "limereadonly": "1",
    "invisible": "0",
    "required": "1",
    "width": "3",
    "height": "1",
    "length": "256",
    "defaultvalue": "Lund",
    "limedefaultvalue": "Application.ActiveUser.Record.Id",
    "limerequiredforedit": "0",
    "newline": "2",
    "fieldorder": "4",
    "isnullable": "0",
    "type": "1",
    "relationtab": "1",
    "syscomment": "My private comment",
    "formatsql": "0",
    "limevalidationrule": "My validation rule",
    "label": "18",
    "adlabel": "31"
}

Valid attributes:

Attribute Mandatory Possible values Value if not provided
fieldtype Yes string/integer/decimal/time/html xml/link/yesno/file/relation/geography set/option/formatedstring/color/sql -
invisible No 0/1/2/65535 (No/On forms/In lists/Everywhere) Default
length No integer (can only be set for textfields) nvarchar(max)
required No 0/1 0
fieldorder No Integer Put last
height No Integer Default
width No Integer Default
newline (width properties) No 0/1/2/3 ("Variable width"/ "Variable width on New line"/ "Fixed width"/ "Fixed width on new line") 2 (Fixed Width)
defaultvalue No text Default
limedefaultvalue No text Default
isnullable No 0/1 0
limereadonly No 0/1 Default
limerequiredforedit No 0/1 Default
type No Timefields: 0/1/2/3/4/5/6/7/8/9 ("Date" / "Date and Time" / "Time" / "Year" / "Half a Year" / "Four Months" / "Quarter" / "Month" / "Week" / "Date and Time (with Seconds)" Optionlists: 0/1 ("Color and Text"/"Only Color") 0
relationtab No 0/1 (actually corresponds to relationmaxcount, the name is misleading. Only valid when creating a relation) 0
syscomment (private comment) No text
formatsql No 0/1 (False/True) Default
limevalidationrule No text
label No Integer No label
adlabel No Integer No AD-label

relations

Here you specify which relations to create. This section only contains information about which fields/tabs to create a relation between, the rest of the information about each field you specify in the field-section. There you also specify whether the field should be an actual field or a tab (attribute relationtab, which actually corresponds to attribute relationmaxcount). Example:

	"relations": [
	{
		"table1": "company",
		"field1": "person",
		"table2": "person",
		"field2": "company"
	},
	{
		"table1": "business",
		"field1": "responsible",
		"table2": "coworker",
		"field2": "business"
	}
	]

Versioning

####Package versioning Packages should adhere to semantic versioning, example 1.0.0 or MAJOR.MINOR.PATCH. Please read this.

Simplified: MAJOR: Breaks backwards compatibility MINOR: Adds new features but backward compatible PATCH: Bugfixes

Minor and Patchs should always be upgrade to automatically if a dependency require it.

Major versions can only be upgraded to if explicit Upgrade command is used

####Dependency versioning Stateing dependency verisons should adhere to NPMs versioning

A version range is a set of comparators which specify versions that satisfy the range.

A comparator is composed of an operator and a version. The set of primitive operators is:

  • < Less than
  • <= Less than or equal to
  • > Greater than
  • >= Greater than or equal to
  • = Equal. If no operator is specified, then equality is assumed, so this operator is optional, but MAY be included.

For example, the comparator >=1.2.7 would match the versions 1.2.7, 1.2.8, 2.5.3, and 1.3.9, but not the versions 1.2.6 or 1.1.0.

About

Package Management for Lime CRM

Resources

Readme
Activity

Stars

0 stars

Watchers

2 watching

Forks

0 forks
Report repository

Releases

3 tags

Packages

No packages published

Languages

  • Visual Basic .NET 62.5%
  • SQLPL 32.1%
  • Python 5.4%