Skip to content

Upgrading an Existing Installation

Lime Bootstrap apps and the Actionpads must always be manually upgraded. Everything else (backend, web components) is upgraded automatically when you bump the version of the dependency to limepkg-esign.

Upgrading to v8.35.0

With the removal of the NemID signing method (provided by Lime Signatures Service), the configuration will be automatically migrated. To allow a smooth transition, the following rules apply to the migration:

  • If NemID was enabled, and MitID was not, MitID will be enabled
  • If NemID was set as a default signing method, MitID will be set as default

Unless this is what the customer wants, no action is required. Otherwise adjust the settings in eSign's configuration in Lime Admin. Also worth noting:

  • MitID must also be enabled in Lime Signatures Services to be selectable when creating a new signing. See how to here Electronic Identification Services. This only applies to customers that haven't been using MitID before.
  • Ongoing signings, where NemID has already been used to sign (before it's end of life on 31th October 2023), will continue to work during a transitioning period. Complete removal of NemID in eSign is scheduled to the end of 2024. These signings should be finished as soon as possible.
  • The nemid_da option should not be removed from signing.methods and signer.method, since they might be used on historic signings and signers.

Upgrading to v8.33.0

Previously, the BankID SE and Signatures signing services shared the same secrets config node for api_key and token. Since this version, Signatures has its own node, signatures. If a solution using Signatures is upgraded, it's recommended that the bankid node is renamed to signatures. However, eSign will fallback to look in the bankid node if the signatures node is not present!

See Application configuration for more info!

Upgrading to v8.13.0

Signing order feature is now available! Follow these steps in order to utilize this feature:

  1. Add a new integer field order to the signing table according to the instructions below:

    Field Field type Invisible Required Default Value NULL is permitted Readonly
    order Integer Everywhere False 1 True True

    Translations:

    Swedish English Danish Norwegian Finnish German Dutch
    Ordning Order Rækkefølge Rekkefølge Tilaus Reihenfolge Volgorde

  2. Map the new order field on the signing object in eSign's configuration in Lime Admin.

Upgrading to v8.x.y

Besides following the normal upgrading procedure, also do this:

  1. Add portal@limeesign user to the administrator group in LISA.
  2. Remove the limeesignportal group in LISA.

  3. For Lime CRM on-premise installations: It is important that you restart the task handler service when you upgrade eSign. Proposed upgrade order:

    1. Stop the web server service and the task handler service.
    2. Upgrade limepkg-esign.
    3. Start the task handler service, make sure the service is in status running before moving on to next step.
    4. Start the web server service.

To add and enable MitID and FTN, do the following:

  1. Add MitID to the options for the methods field on the Signing table accordingly:

    Swedish English Danish Norwegian Finnish Dutch Key
    Danskt MitID Danish MitID Dansk MitID Danske MitID Tanskan MitID Deense MitID mitid_da
    FTN (Finnish Trust Network) FTN (Finnish Trust Network) FTN (Finnish Trust Network) FTN (Finnish Trust Network) FTN (Finnish Trust Network) FTN (Finnish Trust Network) ftn_fi

  2. Add MitID and FTN to the options for the method field on the Signer table accordingly:

    Swedish English Danish Norwegian Finnish Dutch Key
    Danskt MitID Danish MitID Dansk MitID Danske MitID Tanskan MitID Deense MitID mitid_da
    FTN (Finnish Trust Network) FTN (Finnish Trust Network) FTN (Finnish Trust Network) FTN (Finnish Trust Network) FTN (Finnish Trust Network) FTN (Finnish Trust Network) ftn_fi

  3. Add MitID and FTN to the customer domain in the signatures service.

  4. Enable MitID and FTN in Lime Admin.

Upgrading to v7.16.0

Starting from this version, eSign is using a newer TRAML package, which no longer uses the event-handler. For on-prem installations, if you have TRAML config in the event-handler-config, it needs to be copied from the event-handler-config to the app-config. For more information see the TRAML docs.

Upgrading to v7.1.0

The VBA module AO_LimeEsign is no longer required, it should be removed from your solution.

Upgrading to v7.x.y

Besides following the normal upgrading procedure, also do this:

  1. Update the options for the methods field on Signing table accordingly:

    Swedish English Danish Norwegian Finnish Dutch Key
    Svenskt BankID Swedish BankID Svensk BankID Svensk BankID Ruotsin BankID Zweedse BankID bankid_se
    Norskt BankID Norwegian BankID Norsk BankID Norsk BankID Norjan BankID Noorse BankID bankid_no
    Danskt NemID Danish NemID Dansk NemID Danske NemID Tanskan NemID Deense NemID nemid_da
    Kryssruta Checkbox Afkrydsningsfelt Avkryssingsboks Valintaruutu Checkbox checkbox
    Signatur Signature Signatur Signatur Allekirjoitustavat Handtekening signature

  2. Update the options for the method field on Signer table accordingly:

    Swedish English Danish Norwegian Finnish Dutch Key
    empty
    Svenskt BankID Swedish BankID Svensk BankID Svensk BankID Ruotsin BankID Zweedse BankID bankid_se
    Norskt BankID Norwegian BankID Norsk BankID Norsk BankID Norjan BankID Noorse BankID bankid_no
    Danskt NemID Danish NemID Dansk NemID Danske NemID Tanskan NemID Deense NemID nemid_da
    Kryssruta Checkbox Afkrydsningsfelt Avkryssingsboks Valintaruutu Checkbox checkbox
    Signatur Signature Signatur Signatur Allekirjoitustavat Handtekening signature

Upgrading to v6.x.y

Besides following the normal upgrading procedure, also do these things:

The translations for the BankID option for the methods field on the Signing table and the method field on the Signer table should be updated.

  1. Go to Signing table and update the translations for the bankid option in the option field methods accordingly:

    Swedish English Danish Norwegian Finnish Dutch Key
    BankID SE BankID SE BankID SE BankID SE BankID SE BankID SE bankid

  2. Go to Signer table and update the translations for the bankid option in the option field method accordingly:

    Swedish English Danish Norwegian Finnish Dutch Key
    BankID SE BankID SE BankID SE BankID SE BankID SE BankID SE bankid

Upgrading to v5.x.y

Besides following the normal upgrading procedure, also do these things:

Two redundant runtime configuration parameters were removed in major version 5. Lime eSign will continue to work, but the next time the configuration is saved, an error message for 'Unknown field.' will be displayed. Do as follows in order to be able to save the configuration:

  1. Go to the Runtime Configuration in Lime Admin.
  2. Activate Show code editor.
  3. Remove propertySigner and propertyDocument from the "signing": {..} node.
  4. Save your new configuration.

Upgrading to v4.x.y

Besides following the normal upgrading procedure, also do these things:

Follow this order to minimize downtime in the signing portal.

  1. Prepare and build solution.
  2. Make all changes in LISA.
  3. Install your solution.
  4. Make all changes in the runtime configuration.

The database structure has been updated in this new major version. Do as follows in LISA:

  1. Go to Signing table and add opened as an option key in option field signingstatus.

    Swedish English Danish Norwegian Finnish Dutch Key
    Öppnat Opened Åbnet Åpnet Avattu Geopend opened

  2. Go to Signer table and rename receiveddate to sentdate.

    Name Swedish English Danish Norwegian Finnish Dutch
    sentdate Skickat datum Sent date Sendt dato Sendt dato Lähetyspvm Datum verstuurd

  3. Go to Signer table and add two new Date & Time fields, lastopeneddate and approveddate. Make sure the fields have these properties:

    Readonly (Only in Lime PRO): True
NULL is permitted: True
Default Value: NULL
    Name Swedish English Danish Norwegian Finnish Dutch
    lastopeneddate Senast öppnad datum Last opened date Sidst åbnet dato Sist åpnet dato Viimeksi avattu Laatst geopend datum
    approveddate Godkänt datum Approved date Godkendt dato Godkjent dato Vahvistuspvm Goedgekeurd datum

  4. Go to Signer table and update option field signerstatus accordingly:

    • Add three new option keys: sent, opened and approved.
    • Rename option key done to signed and update translations.

    When everything is done, your option field should look like this:

    Swedish English Danish Norwegian Finnish Dutch Key
    Skapad Created Skabt Opprettet Luotu Gecreëerd created
    Skickat Sent Sendt Sendt Lähetetty Verstuurd sent
    Notifierad Notified Underettet Varslet Ilmoitettu Op de hoogte gesteld notified
    Öppnat Opened Åbnet Åpnet Avattu Geopend opened
    Signerat Signed Underskrevet Signert Allekirjoitettu Ondertekend signed
    Godkänt Approved Godkendt Godkjent Vahvistettu Goedgekeurd approved
    Avbruten Canceled Annulleret Kansellert Peruutettu Geannuleerd canceled
    Fel Error Fejl Feil Virhe Fout error

The runtime configuration has also been updated in this new major version. Do as follows in order to update the configuration:

  1. Go to the Runtime Configuration in Lime Admin.
  2. Add Sent date property, Last opened date property and Approved date property on Signer limetype.
  3. Save your new configuration.

Info

If you encountering an error when saving the new configuration. Read the error message and update the configuration accordingly.

Info

You may need to update the configuration for the Signing and the Signer view as well, if you are using the web client, because the receiveddate property no longer exists.

Upgrading to v3.x.y

Besides following the normal upgrading procedure, also do these things:

The old LBS apps do not work at all with this new major version. They must be replaced. The reason is that this version has a new way of working with tasks when creating a signing.

Upgrading to v2.x.y

Besides following the normal upgrading procedure, also do these things:

A new configuration parameter was introduced in major version 2. Do as follows in order to update to this version:

  1. Go to the Runtime Configuration in Lime Admin.
  2. Add Signers relation to every configured Signer parent limetype.
  3. Save your new configuration.