Configuration

All the configuration should be done with parameters that can be set in the application config.

Overrideable functionality

Signed document

You are able to override how to process a signed document that comes from Verified.

How to override

Create a custom limeobject for document and create a member function called: verified_handle_signed_document with the following parameters:

Name Type Description
envelope any The envelope object from verified
new_file_stream BytesIO File content of signed document
uow UnitOfWork Unit of work that addon-verified commits

Above function will be run instead of the default behaviour.

Application config

Windows on-prem customer

For Windows on-premise installations, the application level configuration is expressed in the file %ProgramData%\Lundalogik\LIME Pro Server\application_config.yaml. If it does not already exist, just create it.

Restart the web server and the task handler after saving the new configuration.

Example 1

YOUR_APPLICATION_NAME:
    config:
        addon-verified: 
            user: verified_integration_user@customer_name.com
            document_name_field: comment
            attachment_limetypes: 
              - deal
            verified_company: 
              type: option
              prop: organisation
              list:
                finance: VERIFIED_COMPANY_ID
                expert: VERIFIED_COMPANY_ID
            recipient_limetypes:
              - limetype: person
                firstname: firstname
                lastname: lastname
                email: email
    secrets:
        addon_verified:
            password: SUPER_SECRET_PASSWORD

Example 2

YOUR_APPLICATION_NAME:
    config:
        addon-verified: 
        user: verified_integration_user@customer_name.com
        document_name_field: comment
        attachment_limetypes: 
          - deal
        verified_company: 
          type: relation
          prop: department
          key: name
          list:
            Finance: VERIFIED_COMPANY_ID
            Expert Service: VERIFIED_COMPANY_ID
        recipient_limetypes:
          - limetype: person
            firstname: firstname
            lastname: lastname
            email: email
    secrets:
        addon_verified:
            password: SUPER_SECRET_PASSWORD

Example 3

YOUR_APPLICATION_NAME:
    config:
        addon-verified: 
        user: verified_integration_user@customer_name.com
        document_name_field: comment
        attachment_limetypes: 
          - deal
        verified_company: 
          type: one_id
          list:
            one_id: VERIFIED_COMPANY_ID
        recipient_limetypes:
          - limetype: person
            firstname: firstname
            lastname: lastname
            email: email
    secrets:
        addon_verified:
            password: SUPER_SECRET_PASSWORD

Example with an cloud customer

Config section

addon-verified:
    user: verified_integration_user@customer_name.com
    ...
    see the on-prem examples above
    ...

Secrets section

addon-verified:
    password: SUPER_SECRET_PASSWORD

Available Parameters

Property Default Value Mandatory Comment
addon-verified N/A Yes -
addon-verified.user N/A Yes Verified integration user. Is used for fetching signed documents and get company/user settings from Verified.
addon-verified.password N/A Yes Password for Verified integration user.
addon-verified.document_name_field N/A Yes Database field name on document in Lime. Eg. 'comment'.
addon-verified.attachment_limetypes N/A Yes List of related limetype(s) on document where all documents will be collected for possible attachment to main document.
addon-verified.verified_company N/A Yes Config how to match company/organisation in Verified with logged in coworker in Lime.
addon-verified.verified_company.type N/A Yes Choose from 'option' (Option list on coworker), 'relation' (Related limetype from coworker) and 'one_id' (Only one company/organsation in Verified).
addon-verified.verified_company.prop N/A No Database field name on coworker. Only to be used if 'addon_verified.verified_company.type' is set to 'option' or 'relation'.
addon-verified.verified_company.key N/A No Database field name on related limetype. Only to be used if 'addon_verified.verified_company.type' is set to 'relation'.
addon-verified.verified_company.list N/A Yes List of keys in Lime and Verified company ids. For 'option' key is option list key. For 'relation' key is database field name on related limetype. For 'one_id' only one item in the list and key should be 'one_id'.
addon-verified.recipient_limetypes N/A Yes Related limetype on document from where default recipient should be collected.
addon-verified.recipient_limetypes.limetype N/A Yes Limetype name. Eg. 'person'.
addon-verified.recipient_limetypes.firstname N/A Yes Database field name. Eg. 'firstname'.
addon-verified.recipient_limetypes.lastname N/A Yes Database field name. Eg. 'lastname'.
addon-verified.recipient_limetypes.email N/A Yes Database field name. Eg. 'email'.