Merge pull request #1370 from pravinOpenSign/patch-25

Patch 25
2026-08-21 07:02:32 +02:00 · 2024-10-22 10:21:25 +05:30
parent c3a101bc18 08a2d8a1a4
commit 7316fcd18a
9 changed files with 126 additions and 64 deletions
@@ -2,22 +2,22 @@
 sidebar_position: 3
 title: Completed
 ---
-# Completed Documents Report
+# Completed documents report
 ---

-The "Completed Documents" report within OpenSign serves as a vital tool for managing and reviewing all finalized documents that have been processed through the platform. This guide will walk you through the key features and functionalities of the "Completed Documents" report, enabling you to efficiently navigate and manage your signed documents.
+The "Completed documents" report within OpenSign serves as a vital tool for managing and reviewing all finalized documents that have been processed through the platform. This guide will walk you through the key features and functionalities of the "Completed documents" report, enabling you to efficiently navigate and manage your signed documents.

-```note: You can only see  documents owned by you in this report.```
+```note: In this report, you can only see documents that you own.```

-### Navigating to the Completed Documents Report
+### Navigating to the Completed documents report

 1. Once logged into OpenSign, you'll see a navigation panel on the left side of your screen.
 2. Click on **"Reports"** to expand the available options.
 3. Select **"Completed"** to view the list of documents that have been fully signed and processed.

-### Understanding the Completed Documents Report
+### Understanding the Completed documents report

-The "Completed Documents" report is displayed in a tabular format, presenting key information about each finalized document. Below is a breakdown of each column and its purpose:
+The "Completed documents" report is displayed in a tabular format, presenting key information about each finalized document. Below is a breakdown of each column and its purpose:

 <img width="816" alt="OpenSign_Signyourself" src="https://github.com/user-attachments/assets/4694c9b3-ca2c-4f27-a9d9-8dca220a4124" />

@@ -37,7 +37,7 @@ The "Completed Documents" report is displayed in a tabular format, presenting ke

 ### Action buttons

-The "Completed Documents" report also includes several actions icons for each document:
+The "Completed documents" report also includes several actions icons for each document:

 - **View Document:** The eye icon allows you to preview the document directly within OpenSign without needing to download it.

@@ -0,0 +1,38 @@
+---
+sidebar_position: 7
+title: Contactbook
+---
+
+# Contactbook
+
+The **Contactbook** report in OpenSign enables you to add and manage contacts.
+
+## Accessing Contactbook
+
+To view your Contactbook:
+
+1. Log in to your OpenSign account.
+2. Navigate to the left sidebar.
+3. Click on the `Contactbook` link under the reports section.
+ 
+<img width="828" alt="Add contact" src="https://github.com/user-attachments/assets/80308df4-33a8-41ee-a240-801f775dcec0" />
+
+## Understanding the Contactbook report
+### Adding a New Contact:
+
+To add a new contact, click the red plus (+) button located at the top-right corner of the Contactbook page. 
+This will open a pop-up where you can enter the contact’s name, email, and phone number.
+
+The Contactbook page displays a list of contacts with the following columns:
+
+- **Sr.No**: A sequential number for each contact.
+- **Name**: The contact's name.
+- **Email**: The contact’s email address.
+- **Phone**: The contact’s phone number (if available).
+ 
+  <img width="828" alt="contactbook" src="https://github.com/user-attachments/assets/524a7aa7-594e-412a-ad50-caebc125c1db" />
+
+### Action buttons
+
+- **Delete**: To delete a contact, click on the trash icon located next to the contact’s details. This will remove the contact from your Contactbook. A confirmation prompt may appear to prevent accidental deletions.
+
@@ -2,19 +2,19 @@
 sidebar_position: 5
 title: Declined 
 ---
-# The "Declined Documents" Report
+# The Declined documents report

-The "Declined Documents" report within OpenSign serves as a vital tool for managing and reviewing all declined documents that have been processed through the platform. This guide will walk you through the key features and functionalities of the "Declined Documents" report, enabling you to efficiently navigate and manage your signed documents.
+The "Declined documents" report within OpenSign serves as a vital tool for managing and reviewing all declined documents that have been processed through the platform. This guide will walk you through the key features and functionalities of the "Declined documents" report, enabling you to efficiently navigate and manage your signed documents.

-### Navigating to the Declined Documents Report
+### Navigating to the Declined documents report

 1. Once logged into OpenSign, you'll see a navigation panel on the left side of your screen.
 2. Click on **"Reports"** to expand the available options.
 3. Select **"Declined"** to view the list of documents that have been fully signed and processed.

-### Understanding the Declined Documents Report
+### Understanding the Declined documents report

-The "Declined Documents" report is displayed in a tabular format, presenting key information about each finalized document. Below is a breakdown of each column and its purpose:
+The "Declined documents" report is displayed in a tabular format, presenting key information about each finalized document. Below is a breakdown of each column and its purpose:

 <img width="816" alt="OpenSign_Signyourself" src="https://github.com/user-attachments/assets/dc55e678-52c0-4e75-a1d5-b5a94690bc33" />

@@ -34,7 +34,7 @@ The "Declined Documents" report is displayed in a tabular format, presenting key

 ### Action buttons

-The "Declined Documents" report also includes several action icons for each document:
+The "Declined documents" report also includes several action icons for each document:

 - **View Document:** The eye icon allows you to preview the document directly within OpenSign without needing to download it.
 - **Delete Document:** The trash bin icon enables you to permanently delete a document from your declined list. Be cautious, as this action cannot be undone.
@@ -2,19 +2,19 @@
 sidebar_position: 4
 title: Drafts
 ---
-# The Draft Documents Report
+# The Draft documents report

-The Draft Documents section in OpenSign helps you manage all your in-progress documents easily. This feature allows you to save, review, and edit documents before sending them for signature. Here's a detailed overview of how to navigate and use the Draft Documents report effectively.
+The Draft documents section in OpenSign helps you manage all your in-progress documents easily. This feature allows you to save, review, and edit documents before sending them for signature. Here's a detailed overview of how to navigate and use the Draft Documents report effectively.

-### Navigating to the Draft Documents Report
+### Navigating to the Draft documents report

 1. Once logged into OpenSign, you'll see a navigation panel on the left side of your screen.
 2. Click on **"Reports"** to expand the available options.
 3. Select **"Drafts"** under the Reports section. This will display all your saved draft documents.

-### Understanding the Draft Documents Report
+### Understanding the Draft documents report

-The Draft Documents section provides an organized list of all documents that are saved as drafts. Each draft entry contains key details that help you quickly identify and manage your documents. Here’s a breakdown of the information available:
+The Draft documents section provides an organized list of all documents that are saved as drafts. Each draft entry contains key details that help you quickly identify and manage your documents. Here’s a breakdown of the information available:

 <img width="816" alt="Draft documents" src="https://github.com/user-attachments/assets/6f743287-6459-4e93-ad7d-064c1ed68da0" />

@@ -34,7 +34,7 @@ The Draft Documents section provides an organized list of all documents that are

 ### Action buttons

-The "Draft Documents" report also includes several actions icons for each document:
+The "Draft documents" report also includes several actions icons for each document:

 - **Edit:** If you need to make changes to your draft, click the edit (pencil) icon. This will open the document for you to make the necessary modifications before sending it for signatures.

@@ -3,11 +3,11 @@ sidebar_position: 6
 title: Expired
 ---

-# Expired Documents Report
+# Expired documents report

-The **Expired Documents** report in OpenSign allows you to manage and review documents that have reached their expiration date without being signed. This feature is essential for maintaining an organized record of inactive documents that may require follow-up or archival.
+The **Expired documents** report in OpenSign allows you to manage and review documents that have reached their expiration date without being signed. This feature is essential for maintaining an organized record of inactive documents that may require follow-up or archival.

-## Accessing Expired Documents
+## Accessing Expired documents

 To view your expired documents:

@@ -17,9 +17,9 @@ To view your expired documents:
   
 <img width="828" alt="Expired document" src="https://github.com/user-attachments/assets/01f3626f-d694-4d3b-82da-2f2b77693b76" />

-## Understanding the Report
+## Understanding the Expired documents report

-The Expired Documents report displays a list of documents that have not been signed by all parties before the designated expiration date. Each entry in the report includes the following information:
+The Expired documents report displays a list of documents that have not been signed by all parties before the designated expiration date. Each entry in the report includes the following information:

 - **Title**: The name of the document.
 - **Note**: A brief note associated with the document at the time of creation.
@@ -28,18 +28,18 @@ The Expired Documents report displays a list of documents that have not been sig
 - **Owner**: The user who uploaded or owns the document.
 - **Signers**: Lists the parties required to sign the document.

-## Actions Available
+### Action buttons

 For each expired document, you can perform several actions:

 - **Delete**: Deletes the document from your OpenSign account.
 - **View**: Opens the document in a viewer within OpenSign, allowing you to review the details and contents of the document.

-## Managing Expired Documents
+## Managing Expired documents

 Managing your expired documents effectively can help ensure that no important document is overlooked. Consider the following tips:

- **Review Regularly**: Check the Expired Documents report periodically to manage documents that require attention.
+- **Review Regularly**: Check the Expired documents report periodically to manage documents that require attention.
 - **Follow Up**: Contact the signers who have not completed their signatures informing them about the expired documents and resend the documents if necessary.
 - **Archive**: Move documents that are no longer active or needed to an archive folder to keep your workspace organized.

@@ -2,20 +2,20 @@
 sidebar_position: 2
 title: In Progress
 ---
-# In-Progress Documents Report
-The In-Progress Documents report in OpenSign helps you monitor and manage documents that are currently in the signing process. This report enables you to monitor the status of your documents, manually share the document URL, track document progress, resend reminders, revoke access, or delete documents that are no longer required. Here’s a detailed guide on how to use the In-Progress Documents report effectively.
+# In-Progress documents report
+The In-Progress documents report in OpenSign helps you monitor and manage documents that are currently in the signing process. This report enables you to monitor the status of your documents, manually share the document URL, track document progress, resend reminders, revoke access, or delete documents that are no longer required. Here’s a detailed guide on how to use the In-Progress documents report effectively.

-### Navigating to the In-Progress Documents Report
+### Navigating to the In-Progress documents report

 1. Once logged into OpenSign, you'll see a navigation panel on the left side of your screen.
 2. Click on **"Reports"** to expand the available options.
-3. Select **"In Progress"** This will display all documents that are currently awaiting signatures or are otherwise in the signing process.
+3. Select **"In progress"** This will display all documents that are currently awaiting signatures or are otherwise in the signing process.

-### Understanding the In-Progress Documents Report
+### Understanding the In-Progress documents report

-The "In Progress Documents" report is displayed in a tabular format, presenting key information about each finalized document. Below is a breakdown of each column and its purpose:
+The "In progress documents" report is displayed in a tabular format, presenting key information about each finalized document. Below is a breakdown of each column and its purpose:

-<img width="816" alt="Inprogress documents" src="https://github.com/user-attachments/assets/9fd7dedb-1d3b-4f2a-a75a-fbe9cb93a425" />
+<img width="816" alt="Inprogress documents" src="https://github.com/user-attachments/assets/60100998-1412-4331-8842-55fd9dd10307" />

 - **Sr.No:** This column displays the serial number for each document in the list, helping you quickly identify and reference documents.

@@ -27,17 +27,20 @@ The "In Progress Documents" report is displayed in a tabular format, presenting

 - **File:** Here, you will find a **"Download"** link that allows you to directly download the In-progress document to your local device for review.

- **Owner:** This column shows the name of the person who created the document.
+- **Status:** This column displays the current status of the document, indicating whether it has been viewed or signed by the signer. Once the signer has viewed or signed the document, the Owner of the document can click "View" to see the activity logs.
+  
+<img width="816" alt="Inprogress documents" src="https://github.com/user-attachments/assets/4eb43321-5eec-48ec-a3b6-75e932d31c6c" />
+

 - **Signers:** The "Signers" column displays the names and email addresses of the signers assigned to that document for signature. Click the "View" button to see the signers.

 ### Action buttons

-The "In progress Documents" report also includes several actions icons for each document:
+The "In progress documents" report also includes several actions icons for each document:

 - **Share Document:** The "Share" option in the In-Progress Documents report allows you to manually share the signing link of a document with signers or other recipients directly via email. This feature ensures that the signers can easily access the document, even if they have missed the initial notification.

-<img width="816" alt="Inprogress documents" src="https://github.com/user-attachments/assets/51fdd74a-c621-419d-8987-26b250892a9a" />
+<img width="816" alt="Inprogress documents" src="https://github.com/user-attachments/assets/7c632c2d-c784-4b51-9517-5c6817abd16f" />

 Upon clicking the Share icon, a pop-up window titled Copy link will appear. This window provides multiple options to share the document link with designated recipients. 

@@ -54,11 +57,11 @@ The pop-up will display a list of email addresses of the intended recipients or

 - **Resend:** If a signer has not responded or needs a reminder, use the resend option to send another notification. This ensures that the signing process continues without delay.
  
-<img width="816" alt="resend document" src="https://github.com/user-attachments/assets/ceee2e8f-c98f-4f1a-b554-743b3428bbe1" />
+<img width="816" alt="resend document" src="https://github.com/user-attachments/assets/c0cb3348-47ca-4d2e-a2d7-81cb3b18a0c6" />

 - **Revoke:** If there’s a mistake or you need to cancel the document, revoking stops all signing actions immediately. This is useful when changes are needed before re-sending the document.
  
-<img width="816" alt="resend document" src="https://github.com/user-attachments/assets/3aea346b-0f12-45c2-96b7-e19f0aa2d988" />
+<img width="816" alt="resend document" src="https://github.com/user-attachments/assets/b2273768-ef81-44cd-95ea-92babee429b6" />

 - **Delete :** If the document is outdated or was sent by mistake, you can permanently remove it from the list. Use this action cautiously, as deleted documents cannot be recovered.

@@ -2,18 +2,18 @@
 sidebar_position: 1
 title: Need your sign
 ---
-# Need Your Sign Report in OpenSign
+# Need your sign report

-The "Need Your Sign" feature in OpenSign is designed to simplify the process of managing documents that require your signature. This guide will walk you through the various elements of the "Need Your Sign" report, helping you to efficiently navigate and complete your pending signing tasks.
+The "Need your sign" feature in OpenSign is designed to simplify the process of managing documents that require your signature. This guide will walk you through the various elements of the "Need your sign" report, helping you to efficiently navigate and complete your pending signing tasks.

-## Accessing the "Need Your Sign" report
+## Accessing the "Need your sign" report

 - **Login to OpenSign**: Start by logging into your OpenSign account.
- **Navigate to "Need Your Sign"**: Once logged in, you will find a navigation panel on the left side of your screen. Under the "Reports" section, click on "Need Your Sign" to view all documents that require your signature.
+- **Navigate to "Need your sign"**: Once logged in, you will find a navigation panel on the left side of your screen. Under the "Reports" section, click on "Need your sign" to view all documents that require your signature.

-## Understanding the "Need Your Sign" Interface
+## Understanding the "Need your sign" report

-Upon clicking "Need Your Sign," you will be presented with a list of documents awaiting your signature. Here's a breakdown of the key elements within this interface:
+Upon clicking "Need your sign," you will be presented with a list of documents awaiting your signature. Here's a breakdown of the key elements within this interface:

 - **Sr.No**: This column provides a serial number for each document in the list, allowing for easy identification and reference.
 
@@ -31,7 +31,7 @@ Upon clicking "Need Your Sign," you will be presented with a list of documents a
  
 - **Sign**: The "SIGN" button is prominently displayed next to each document. Clicking this button will open the document in the signing interface, allowing you to review and apply your signature.

-## Action buttons
+### Action buttons

 - **View Document**: By clicking "View" under the "Signers" column, you can get more details about the document, including the list of individuals who have already signed or are expected to sign it.
  
@@ -44,7 +44,7 @@ To sign a document:
 1. Click the **SIGN** button next to the document you wish to sign.
 2. Review the document carefully within the OpenSign interface.
 3. Apply your signature following the prompts.
-4. Once signed, the document will move from the "Need Your Sign" section to the "Completed" section, indicating that the signing process is finished.
+4. Once signed, the document will move from the "Need your sign" section to the "Completed" section, indicating that the signing process is finished.

 If you require more help, feel free to reach out to our customer support on support@opensignlabs.com.

@@ -9,37 +9,45 @@ Creating a template in OpenSign is straightforward and can significantly enhance

 # How to Create a Template in OpenSign™

-### Step 1: Begin New Template Creation
+## Step 1: 
+### Begin New Template Creation

 - **Navigate to New template form**: On the left sidebar, click on "Templates" to expand the menu. and Click on the "Create template" option.

-<img width="828" alt="Create Template" src="https://github.com/user-attachments/assets/fe7b0bd0-bb45-4f64-8450-83ffb5c3d7fc" />
+<img width="828" alt="Create Template" src="https://github.com/user-attachments/assets/1cb7610f-c144-4774-85c2-ed7d70e0a73c" />

-### Step 2: Uploading Your Document
+### Uploading Your Document

 - **[1] Choose File**: Once the "New template" page opens, click here to select and upload the document file from your computer that needs to be signed. Supported formats include PDF, PNG, JPG, JPEG, and DOCX.
 - **[2] Choose File from Dropbox**: Click the dropbox icon to select the document file from your dropbox account.

-### Step 3: Entering Template Details
+### Entering Template Details

 - **[3] Title** *(Required)*: Provide a title for your template. For example, "Demo Custom Template."
 - **[4] Description**: Optionally add a description to give context or instructions regarding the template. 
 - **[5] Note**: Optionally add a note to give context or instructions regarding the document.

-### Step 4: Set the sending order
+### Set the sending order
 - **[6] Send in Order**
  - **If you choose:**
  - **Yes**: Selecting this option will send the signing request to the first signer initially. Once the first signer completes their part, the next signer in the sequence will receive the request. This process continues until all signers have signed the document. This method ensures that the document is signed in a specific order.
  - **No**: Selecting this option will send the signing links to all signers simultaneously. Every signer can sign the document at their convenience, regardless of whether other signers have completed their signatures. This method is faster but does not enforce any signing order among the participants.
 Select the option that best suits the needs of your document processing.
-### Step 5: Auto reminder (feature only avilable for the subscribed user)
+### Auto reminder (feature only avilable for the subscribed user)
 - **[7]** Once you enable the auto reminder, a text field will appear allowing you to set the reminder for a specific number of days.
 - **Remind once in every (Days)**: Here, you can set the number of days for the reminder.
-  
-### Step 6: Proceed to Template Creation Panel
+### Security Setting
+- **[8] Enable OTP Verfication** : 
+If set to "Yes," the signer will be required to complete email OTP verification before viewing and signing the document. If "Enable OTP Verification" is set to "No," the signer will not be prompted for OTP verification during the signing process.
+
+- **[9] Enable tour**: 
+If set to "Yes," the signer will see the tour guide while signing the document. If your signer is familiar with OpenSign and you prefer not to display the tour guide, you can select "No," and the tour guide will not be shown to your signers.
+
+### Proceed to Template Creation Panel
 - **Next**: Click the "Next" button to proceed to the next stage of template creation, where you can add widgets and finalize the template.
 - **Cancel**: If you need to start over or make changes, click Cancel button to clear the form.
-### Step 7: Template creation 
+## Step 2: 
+### Template creation 

 <img width="828" alt="Create Template" src="https://github.com/user-attachments/assets/986a0068-e711-4367-91b6-349dc1db8c43" />

@@ -113,16 +121,19 @@ Select the option that best suits the needs of your document processing.
    - Add Signer/Change Signer: Clicking the first icon on the Email widget allows you to change the signer. You can choose from existing signers in the dropdown or add a new signer.
    - Copy : Clicking on this you can duplicate the email widget.
      
-### Step 8: Save Template 
+### Save Template 
 **Next button**: Once you’ve organized your widgets and set their properties, simply click the “Next” button to save your template.

-After doing so, a “Create Document” popup will appear, prompting you with the question: “Do you want to create a document using the template you just created?” You’ll have the option to choose either “Yes” or “No.”
+After doing so, a “Create document” popup will appear, prompting you with the question: “Do you want to create a document using the template you just created?” You’ll have the option to choose either “Yes” or “No.”
+
 **If you select "Yes"**: It will create a document using the template you just created.
+
 **If you select "No"**: You will be redirected to the Manage templates form.

-### Step 9: Viewing and Managing Templates 
+## Step 3: 
+### Viewing and Managing Templates 

-<img width="828" alt="Manage Template" src="https://github.com/user-attachments/assets/86bf3628-987d-4ae2-89c3-b24ec1f6bdc2" />
+<img width="828" alt="Manage Template" src="https://github.com/user-attachments/assets/06b80221-5c42-451c-af03-44cc12e6aa2d" />

 On the Manage templates page you will see a list of templates you have created or have access to. The list includes details such as the template title, file, owner, signers, and whether the template is public.

@@ -136,13 +147,23 @@ On the Manage templates page you will see a list of templates you have created o

 **Quick Send**: For faster processing, the Quick Send feature allows you to swiftly create and send a document to a signer using the selected template.

+**Edit**: The "Edit" feature is crucial for keeping your document templates up-to-date and relevant. Whether you need to make minor tweaks or major changes, OpenSign's editing capabilities are user-friendly and efficient.
+Click on the three dots next to the template you want to edit.
+Select "Edit." Make the necessary changes and save them.
+
 **Share With Team**: Collaboration is essential for any successful team, and OpenSign simplifies sharing document templates with your team. Here's how you can utilize the "Share With Team" feature:
 Click on the three dots next to the template you want to share.
 Select "Share With Team."

-**Edit**: The "Edit" feature is crucial for keeping your document templates up-to-date and relevant. Whether you need to make minor tweaks or major changes, OpenSign's editing capabilities are user-friendly and efficient.
-Click on the three dots next to the template you want to edit.
-Select "Edit." Make the necessary changes and save them.
+**Embed**: The "Embed" option provides you with a code to embed the template into a website or other platforms, allowing users to interact with it directly from the external site.
+Click "Embed" to generate the code that can be copied and pasted into your desired web location. We currently support React, HTML/JavaScript and Angular-based websites.
+
+<img width="828" alt="Embed" src="https://github.com/user-attachments/assets/05dcaf5d-07b0-4069-bcd5-83e2daf71e29" />
+
+**Copy template id**: This action copies the unique ID associated with the template, which is useful for embedding or sharing with public users when your template is set to public.
+
+**Copy public URL**: This generates a public link for the template, allowing external users to access it without logging into OpenSign.
+Click "Copy Public URL" to generate the link, then share it as needed.

 **Delete**: Sometimes, it's necessary to clean up your templates to keep your workspace organized. The "Delete" feature allows you to remove outdated or unnecessary templates with ease.
 Click on the three dots next to the template you want to delete.
@@ -9,7 +9,7 @@ import ReactPlayer from 'react-player';

 Follow the official Docker installation guide based on your operating system.

-Create a Docker Hub account if you don't already have one
+Create a Docker Hub account if you don't already have one.

 **Important:** Don't forget to verify your Docker Hub account via the email verification link. If you skip this step, the deployment might fail due to unauthorized access errors when pulling Docker images.