Configuring the Start Page¶

This guide aims to provide an introduction to configuring the start page in Lime CRM Web Client.

This feature replaces the start page grid, which will not be supported in future versions of CRM.

Some of the introduced features are: multiple start pages, configuration user interface, "just looks good" layout, and new widgets.

The new start page is available behind the feature switch useMultipleStartPages from version 2.372.0 of lime-crm.

Creating a Starting Configuration¶

When you come to the new start page configuration page, you may not have any configurations. But you can create one with ease, automatically based on your existing configuration of the old start page grid:

Go to Lime CRM Admin ➡ System ➡ Start Pages.
Press "Save" and a starting configuration will be generated automatically.

This is what happens when the new start page config is auto-generated:

Every widget in the configuration found in Lime CRM Admin ➡ Start Page Designer is added to your new configuration.

Note

The new start page does not offer distinct configurations for mobile or tablet. Therefore, any widget which has previously been "hidden" on a certain screen size is now included in the new config and will be visible on all devices.
The system does its best to pick the best widget size and a correct order, but you may still need to manually adjust the order and size of widgets.

Note

The new start page tries to avoid empty holes between widgets. This may result in widgets moving around between different screen widths. Simply resize your browser window to check the result at different screen widths.
The Object Explorer Widget and Salespipe Widget are added to your starting configuration. (Replacing the old todo widget and salespipe widget.)
Anything that might have been present in the deprecated dashboard slot is not included in the auto-generated config, but can be added manually.

Info

If you run into any errors, first have a look in the Troubleshooting section below.

Widgets¶

We call the things that are placed on the start page "widgets". (Technically they are web components, and could be used in other places too. But since everything in the web client consists of web components, and each widget will typically consist of several other web components too, we use the term "widget" to mean "a web component that you have configured to show up on the start page". It's simpler that way 😉) You can think of them in a similar way that widgets on your phone work: You have an app where you can do everything. But the app may also have one or more widgets that you can add to your home screen for easy access and overview of the most common features.

Built-in Widgets¶

Lime CRM has two widgets that are available out of the box. It is the Object Explorer Widget and the Salespipe Widget. These two replace the old todo widget and salespipe widget which are not supported going forward.

The Object Explorer Widget is used to get a small, convenient list of things, right where you start your day. By default, it is used for To-do:s but it can be used for tickets, checklist items, project activities or anything you might want. It is great for when an info tile is not enough and you need more information.

The Object Explorer Widget can be used for any lime type.

Add the Object Explorer Widget by typing limec-object-explorer-widget in the Name field.

Select which limetype to use in the Properties field and add a sorting if you like:

{
    "limetype": "todo",
    "orderBy": {
        "name": "starttime",
        "direction": "DESC"
    }
}

You can even specify which view to use. (List view is the default.)

{
    "limetype": "history",
    "view": {
        "name": "limec-history-view"
    },
    "orderBy": {
        "name": "date",
        "direction": "ASC"
    }
}

or

{
    "limetype": "helpdesk",
    "view": {
        "name": "limec-table-view"
    }
}

Examples of using the history flow view and the table view instead of the list view.

The Salespipe Widget

The salespipe is the salesperson's and sales managers' tool to keep track of all the active deals in different steps in the sales process.

The user can choose to show all deals or only their own deals by clicking the buttons in the upper right corner. At the very top, in the header of the salespipe, you get information about the total number of active deals, total weighted value and total deal value. For each grouped deal status, you receive information about the number of deals, weighted value and total deal value. You also get a progress bar for each status which indicates how much of the total value of all active deals in the salespipe is made up of deals in this particular status.

Add it by typing limec-salespipe-widget in the Name field.

Configuring the Widget¶

The configuration of the Salespipe Widget is done via Lime CRM Admin ➡ Settings ➡ Salespipe. Click “Show code editor” to access the json configuration.

Example configuration:

{
  "deal": {
    "name": "deal",
    "properties": {
      "company": {
        "name": "company"
      },
      "expecteddate": {
        "name": "expecteddate"
      },
      "name": {
        "name": "name"
      },
      "probability": {
        "name": "probability"
      },
      "responsible": {
        "name": "coworker"
      },
      "status": {
        "name": "dealstatus",
        "options": [
          "contact",
          "requirement",
          "tender"
        ]
      },
      "value": {
        "name": "value"
      },
      "weightedvalue": {
        "name": "weightedvalue"
      }
    }
  }
}

The configuration consist of a number of sections:

name (“deal” in the example above). This is the database table name for the deals to show in the salespipe.

Under the properties section:

company → name: (“company” in the example above). The field name for the relation to the company table.

expecteddate → name: (“expecteddate” in the example above). The field name for the expected date when the deal will be closed. Must be a datetime field, usually year/quarter.

name → name: (“name” in the example above). The field name for the name of the deal. Must be a string.

probability → name: (“probability” in the example above). The field name for the probability of the deal. Must be a decimal field and percent type.

responsible → name: (“coworker” in the example above). The field name for the relation to responsible coworker for the deal. Must be a relation field.

status → name: (“dealstatus” in the example above). The field name for the status of the deal. Must be an option field.

status → options: List of the options for the field dealstatus that should be shown in the salespipe. The options should be written as optionkeys and ordered according to the sales process (last active stage of the sales process should be the last option). Exclude end-stages, like "Lost" and "Won".

value → name: (“value” in the example above). The field name for the total value of the deal. Must be a decimal or integer field.

weightedvalue → name: (“weightedvalue” in the example above). The field name for the weighted value of the deal. Must be a decimal or integer field.

Adding Other Widgets to Your Start Page¶

To add your widget: enter the name of the component, choose an appropriate size, and, depending on the widget, add any required properties.

Most widgets are provided by add-ons. That means that each add-on is responsible for naming and specifying necessary configuration. So if you wonder "which properties can I add to the KPI widget?", you should look in the documentation of the KPI add-on.

An example of how the Lime BI and KPI widgets are configured. What you can configure, and how you do it, is up to each widget.

Multiple Start Pages¶

You can add as many start pages as you like. A typical use case is that you want one start page per department; Sales, Service Desk, Field Service, Management, Consulting, etc. Another use case could be to have an "About Lime" page with links to user training material, how to file tickets, service disruptions (specific for a solution), etc.

Localizing Start Pages¶

If you would like to localize your start pages, this is possible by providing a localization file and enter the localization key as the name of the start page.

Read more on how to do this in the chapter Translate sections, start pages, variants and more

FAQ¶

How can I figure out the names of all widgets?

Which widgets you have available depend on which add-ons you have installed. The two built-in widgets are:

limec-salespipe-widget
limec-object-explorer-widget

Read above on how to configure these.

The names of some other popular widgets are:

Infotiles Full documentation

Example configuration:

Name: infotiles-tile

Properties:
```
{
    "config": "Prospects"
}
```

KPI Full documentation

Example configuration:

Name: lwc-limepkg-kpi-visualize-kpi-dashboard

Properties:

{
    "config": {
        "kpi_group": [
            {
                "kpi_unique_name": "Customer Budget"
            }
        ],
        "chart_title": [
            {
                "lang": "sv",
                "text": "Kundbudget"
            },
            {
                "lang": "en",
                "text": "Customer Budget"
            }
        ]
    }
}

Lime BI Full documentation

Example configuration:

Name: limebi-graphics

Properties:
```
{
    "config": "dash"
}
```

Troubleshooting¶

I get "_schema": ["Invalid input type."] error when I try to create a starting configuration¶

We do not know what is causing this but the work around it to add each widget one by one.

Info tiles have not been migrated¶

If the info tiles configuration was not present in the configuration of the the old start page, they will not show up on new the start page. Chances are that your info tiles were only present in the so called "dashboard slot". If so, they need to be manually added to the new start page.

First, make sure you typed the name and properties correctly. If it was present in the old start page, have a look in that configuration as a cheat sheet. There have been occasions where the "config": {} part has been missing. Make sure that is not the case.

Configuring the Start Page¶

Creating a Starting Configuration¶

Widgets¶

Built-in Widgets¶

The Object Explorer Widget¶

Adding the Widget to the Start Page¶

Configuring the Widget¶

The Salespipe Widget¶

Adding the Widget to the Start Page¶

Configuring the Widget¶

Adding Other Widgets to Your Start Page¶

Multiple Start Pages¶

Localizing Start Pages¶

FAQ¶

Troubleshooting¶

I get "_schema": ["Invalid input type."] error when I try to create a starting configuration¶

Info tiles have not been migrated¶

My custom widget does not show¶