Installation Instructions

Preparations

• Check that the requirements are met.

Installation

Step-by-step instructions on how to perform a new installation of the add-on.

1. Add Package Dependency

Add limepkg-add-to-campaign as a dependency to your solution.

poetry add limepkg-add-to-campaign

To avoid limepkg-add-to-campaign from updating by mistake when working with the solution it is recommended to lock down the version. If you do so, make sure to lock down all its dependencies as well.

After adding the package, you can list the installed version:

poetry show limepkg-add-to-campaign

Then update the pyproject.toml for the package, just edit it in the [tool.poetry.dependencies] section with the exact version number from the output. Below is an example what it might look like:

[tool.poetry.dependencies]
limepkg-add-to-campaign = '1.1.3'

Finally run poetry lock to make sure the new version locks work together in practice.

Remember, with this change it is no longer enough to just do poetry update to get the latest version of Add To Campaign. You will have to update each of these version locked dependencies yourself.

2. Application Config

• In your a application_config.yaml, .

      NAME OF LIME APPLICATION:
        config:
          limepkg_add_to_campaign:
            sql: false
  

If the users in your solution adds alot of participants at once, it is possible to increase performance by bypassing all the python logic and make the update directly in the database.

Warning

If the bypass is activated, no custom limeobject logic will be triggered. This also means that the created objects will not be indexed. If it is important that participants are searchable in the webclient, schedule a nightly update of the search index (on prem).

• To activate the bypass. Simply set the sql-flag to true.

      NAME OF LIME APPLICATION:
        config:
          limepkg_add_to_campaign:
            sql: true
  

Client Setup

Web Client

To be able to use the webcomponent you need to configure a command on the table-view of the limetypes you create participants from.

The command (or Action) has the Action ID: limepkg_add_to_campaign.add-to-campaign. Parameters can then be passed in to the component, read more here (Configuration).

Desktop Client

1. Install the Lip package.
2. Add the AddToCampaign app to the Actionpads\apps folder.
3. Add the call to the app in the index.html file.

   <div data-bind="vba:'AO_AddToCampaign.OpenAddToCampaign', , text:'Koppla deltagare till kampanj', icon:'fa-bullseye'"></div>
   

You should now be done with the installation of Add To Campaign 🎉🎉🎉