Skip to main content
Skip table of contents

Guide

1. Activate the integration

  • May perform an user with role System manager

  • On the main screen choose Integrations → Circularo Integration

image-20240405-123313.png

Enable the integration

  • Enable and choose where to show the integration button:

    • View settings:

      • Form view - Detail of one record, see below

      • List view - List of multiple records, see below

    • DocType settings:

      • Either specify individual DocTypes or activate for all of them

      • Singleton is DocType where only one record may exists

        • Usually used in settings - Circularo Integration is singleton DocType

  • Then create API Token

image-20240405-123343.png

Create API Token

  • All fields are validated and signature must be already present in Circularo account.

image-20240405-123411.png

Created API Token

  • Now the integration is activate.

2. Use the integration

  • Integration actions may perform any logged in user

  • The integration button is by default visible in List View

image-20240405-123446.png

Integration in ListView

  • Add in Form View

image-20240405-123514.png

Integration in Form View

a) Send to Circularo

  • Archives a document in Circularo.

image-20240405-123558.png

Archiving two documents in Circularo

image-20240405-123621.png

Documents have been archived

  • You can click the document title to go to history (see bellow)

b) Sign in Circularo

  • Manually sign a document in Circularo

image-20240405-123714.png

Preparing document to be signed

image-20240405-123724.png

Document is ready to be signed

  • You can click the document title to go to history (see bellow)

  • Manually signed document can be downloaded to frappe system on request

    • In document history click Download signed file

image-20240405-123817.png

Download manually snipped document

  • If the document has not been signed yet, you will be notified, otherwise the document is downloaded.

image-20240405-123851.png

Document has not been signed yet

c) Auto-sign in Circularo

  • Document is automatically signed and downloaded back to frappe (and send to an e-mail)

image-20240405-123929.png

Signing document in Circularo

image-20240405-123954.png

Document has been signed

  • You can click the document title to go to history (see bellow)

    • You can view the signed file here

  • Document has been automatically sent to user’s e-mail

    • SMTP server must be configured properly

    • Automatic e-mail send must be allowed in Circularo Integration → Advanced Settings

image-20240405-124032.png

Automatically signed document has been sent to an e-mail

3. History

  • On the main screen choose Circularo Documents

  • Shows history of all sent/signed documents

image-20240405-124117.png

List of all sent/signed documents

  • Each record contains information about the document and performed action

image-20240405-124152.png

Record detail

You can use following buttons:

  • Open document - Opens original document in frappe system

  • View in Circularo - Opens document in Circularo

  • View PDF file - Opens PDF file in frappe, depends on used action:

    • Send to Circularo - Opens archived / not signed file

    • Sign in Circularo - Signed file must be downloaded first (see above)

    • Auto-sign in Circularo - Opens signed file

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.

Contact Support Close