From 70abddec3aa1b7ba25e92701c7275ad606400623 Mon Sep 17 00:00:00 2001 From: pravin Date: Mon, 19 May 2025 19:17:25 +0530 Subject: [PATCH 01/12] Create Preferences.md Preferences page added --- docs/docs/help/Settings/Preferences.md | 102 +++++++++++++++++++++++++ 1 file changed, 102 insertions(+) create mode 100644 docs/docs/help/Settings/Preferences.md diff --git a/docs/docs/help/Settings/Preferences.md b/docs/docs/help/Settings/Preferences.md new file mode 100644 index 000000000..def63dd3e --- /dev/null +++ b/docs/docs/help/Settings/Preferences.md @@ -0,0 +1,102 @@ +--- +sidebar_position: 4 +title: Preferences +--- + +# 🔧 Preferences + +The **Preferences** page in **OpenSign™** allows users and administrators to tailor the signing experience to suit individual, team, or organizational needs. Below is a breakdown of all configurable options and what they control. + +--- + +## 📌 Signature Types Control + +The **Allowed Signature Types** section defines which signature methods are available to signers: + +- ✅ **Draw**: Create a handwritten signature using a mouse, stylus, or finger. +- ✅ **Type**: Type your name and apply it using pre-set font styles. +- ✅ **Upload**: Upload a scanned or saved image of your signature. +- ✅ **Default**: Use the default signature stored under *My Signature* in settings. + +⚙️ The options selected here will determine what appears in the signature widget during the signing process. + +--- + +## 🔄 Multi-Level Signature Type Control + +**OpenSign™ v2.6.0** introduces flexible control over signature options at three levels: + +### 📄 Document-Level +Set different signature types per document, ideal for adapting to specific legal or regulatory requirements. + +### 👤 User-Level +Each user can define their preferred signature options, ensuring a familiar and consistent signing experience. + +### 🏢 Organization-Level +Admins can enforce company-wide signing policies by restricting signature methods platform-wide. + +> This layered control helps teams maintain compliance while optimizing usability. + +--- + +## 🔔 Notify on Signatures + +Enable or disable email or in-app notifications when a document is signed. + +- **Yes** – Receive alerts for each completed signature. +- **No** – Notifications are turned off. + +**Details:** +The document creator will receive an email notification whenever a signer signs the document. +**Note**: Regardless of this setting, a completion email with the signed document and completion certificate attached is always sent to all signers and the document owner. + +--- + +## 📬 Send in Order + +Decide whether the document should be signed sequentially or simultaneously by multiple signers. + +- **Yes** – Signers receive the document in a set order. +- **No** – All signers receive the document at once. + +**Details:** +Choose how you want the signing requests to be sent to the document signers: + +- **Yes**: Sends the signing request to the first signer initially. Once the first signer completes their part, the next signer in the sequence receives the request. This continues until all signers have signed. This ensures the document is signed in a specific order. + +- **No**: Sends signing links to all signers simultaneously. Each signer can sign at their convenience, regardless of whether others have signed. This method is faster but does not enforce any order. + +Select the option that best suits your document processing needs. + +--- + +## 🧭 Timezone & Date Format + +Customize the **Timezone** and **Date Format** according to your regional preferences. + +- Supports **12-hour** or **24-hour** time formats. +- Affects the timestamp shown on the platform and audit trails. + +--- + +## 🧪 LTV Enabled Signatures (BETA) + +Enable **Long-Term Validation (LTV)** to ensure the authenticity of the signature over time. +*Currently in beta testing.* + +--- + +## 🚫 Enable Tour + +The tour feature provides guidance for first-time users. You can turn this off for a cleaner, uninterrupted experience: + +- **Yes** – Show onboarding tips. +- **No** – Disable tour prompts *(recommended for experienced users)*. + +**Details:** +- **Yes**: Enables a guided tour for signers, providing instructions during the signing process. +- **No**: Disables the guided tour, ensuring a faster, uninterrupted experience. + +**Tip**: If your signers are familiar with OpenSign™ and use it frequently, disabling the tour can create a more seamless experience. Choose the option that best fits your document signing needs. + +--- From c059e95fa963762544b0ffc0cbee08d16d7b4e2b Mon Sep 17 00:00:00 2001 From: pravin Date: Tue, 20 May 2025 11:26:49 +0530 Subject: [PATCH 02/12] Update Preferences.md updated Preferences page contents. --- docs/docs/help/Settings/Preferences.md | 175 +++++++++++++++++++------ 1 file changed, 136 insertions(+), 39 deletions(-) diff --git a/docs/docs/help/Settings/Preferences.md b/docs/docs/help/Settings/Preferences.md index def63dd3e..f616fb8c3 100644 --- a/docs/docs/help/Settings/Preferences.md +++ b/docs/docs/help/Settings/Preferences.md @@ -18,24 +18,29 @@ The **Allowed Signature Types** section defines which signature methods are avai - ✅ **Upload**: Upload a scanned or saved image of your signature. - ✅ **Default**: Use the default signature stored under *My Signature* in settings. -⚙️ The options selected here will determine what appears in the signature widget during the signing process. +⚙️ The options selected here will determine what appears in the signature widget during document creation and signing. You can also change these preferences while creating the document. --- ## 🔄 Multi-Level Signature Type Control -**OpenSign™ v2.6.0** introduces flexible control over signature options at three levels: - -### 📄 Document-Level -Set different signature types per document, ideal for adapting to specific legal or regulatory requirements. - -### 👤 User-Level -Each user can define their preferred signature options, ensuring a familiar and consistent signing experience. +**OpenSign™** introduces flexible control over signature options at three levels: ### 🏢 Organization-Level + Admins can enforce company-wide signing policies by restricting signature methods platform-wide. -> This layered control helps teams maintain compliance while optimizing usability. +> In the **Console Application > General**, admins can set allowed signature types at the organization level. Only the selected types will be shown on the **Preferences > Signature** page for users. + +### 👤 User-Level + +> Navigate to **Settings > Preferences** to configure user-level signature types. +If a user sets preferred types here, only these will be shown when adding signature or initial widgets during document creation. + +### 📄 Document-Level + +> While creating a document, users can set specific allowed signature types. +Only these will be available to the signer—useful for legal or regulatory requirements. --- @@ -46,43 +51,28 @@ Enable or disable email or in-app notifications when a document is signed. - **Yes** – Receive alerts for each completed signature. - **No** – Notifications are turned off. -**Details:** -The document creator will receive an email notification whenever a signer signs the document. -**Note**: Regardless of this setting, a completion email with the signed document and completion certificate attached is always sent to all signers and the document owner. +> User can change this option while creating the document or template. + +**Details**: +The document creator will receive an email notification whenever a signer signs the document. + +**Note**: Regardless of this setting, a **completion email** with the signed document and completion certificate is **always sent** to all signers and the document owner. --- ## 📬 Send in Order -Decide whether the document should be signed sequentially or simultaneously by multiple signers. +Decide whether the document should be signed **sequentially** or **simultaneously** by multiple signers. - **Yes** – Signers receive the document in a set order. - **No** – All signers receive the document at once. -**Details:** -Choose how you want the signing requests to be sent to the document signers: +> User can change this option while creating the document or template. -- **Yes**: Sends the signing request to the first signer initially. Once the first signer completes their part, the next signer in the sequence receives the request. This continues until all signers have signed. This ensures the document is signed in a specific order. +**Details**: -- **No**: Sends signing links to all signers simultaneously. Each signer can sign at their convenience, regardless of whether others have signed. This method is faster but does not enforce any order. - -Select the option that best suits your document processing needs. - ---- - -## 🧭 Timezone & Date Format - -Customize the **Timezone** and **Date Format** according to your regional preferences. - -- Supports **12-hour** or **24-hour** time formats. -- Affects the timestamp shown on the platform and audit trails. - ---- - -## 🧪 LTV Enabled Signatures (BETA) - -Enable **Long-Term Validation (LTV)** to ensure the authenticity of the signature over time. -*Currently in beta testing.* +- **Yes**: Signers are notified one after another. The next signer gets access only after the previous has completed signing. +- **No**: All signers receive links at the same time. They can sign independently of one another. --- @@ -93,10 +83,117 @@ The tour feature provides guidance for first-time users. You can turn this off f - **Yes** – Show onboarding tips. - **No** – Disable tour prompts *(recommended for experienced users)*. -**Details:** -- **Yes**: Enables a guided tour for signers, providing instructions during the signing process. -- **No**: Disables the guided tour, ensuring a faster, uninterrupted experience. +> User can change this option while creating the document or template. -**Tip**: If your signers are familiar with OpenSign™ and use it frequently, disabling the tour can create a more seamless experience. Choose the option that best fits your document signing needs. +**Details**: + +- **Yes**: Enables guided tooltips for the signer during the signing process. +- **No**: Disables the tour, speeding up the signing experience. + +💡 **Tip**: Disable if your users are already familiar with OpenSign™. --- + +## 🧭 Timezone & Date Format + +Customize the **Timezone** and **Date Format** according to your regional preferences. +These settings are reflected in: + +- Document Completion Certificates +- Signing Logs +- Webhooks + +### 📅 Date Format +- Used as the **default format** for date widgets when creating documents. +- Applies in all flows including APIs. + +### 🕒 Time Format +- Supports **12-hour** and **24-hour** formats. +- Affects timestamps in certificates, logs, and webhooks. + +--- + +## 🧪 LTV Enabled Signatures + +**LTV (Long-Term Validation)** ensures that signatures remain valid and verifiable even after certificates expire or are revoked. + +### 🔐 Key Features: +- Embeds certificate chain +- Includes CRLs and OCSP responses +- Enables offline verification +- Complies with PDF standards like **PAdES** + +### 📌 Why It Matters: +Even if a certificate becomes invalid in the future, the LTV-enabled signature stays verifiable. + +### ✅ Use Cases: +- Legal Contracts +- Financial or Medical Records +- Long-term archiving requirements + +--- + +## 📧 Email Templates + +In the **Preferences > Email** tab, users can customize email templates for: + +### ✉️ Request Signature Email +Once set, all signers will receive the customized request email. + +### 📩 Document Completion Email +On completion, all signers receive the custom-formatted email with the signed document. + +--- + +## 🔒 Security + +### ✅ Two-Factor Authentication (2FA) + +Adds a second verification step when logging in. + +### Benefits: +- Enhances account protection +- Requires time-based code from an app like Google Authenticator + +### How to Enable: +1. Go to **Security > Setup 2FA** +2. Scan the QR Code with an authenticator app +3. Save Recovery Codes for backup +4. Enter verification code to complete setup + +> If 2FA is enabled, you’ll be prompted for a verification code after entering your password. + +--- + +### 🛡️ Passkey Authentication + +Passkeys offer **passwordless** and **phishing-resistant** sign-in. + +#### 🔐 Key Features: +- Use fingerprint, face ID, or device PIN +- Passwordless and secure +- Reduces credential theft risks + +### 🛠 How to Register a Passkey: +1. Click **Register another passkey** +2. Your device prompts biometric or PIN-based authentication +3. On success, the passkey is saved and listed under **Your Passkeys** + +### 🧾 Managing Your Passkeys + +Each passkey entry shows: +- Name (e.g., "Windows Edge") +- Created Date +- Last Used Date +- Credential ID + +#### ✏️ Rename: +Click the **pencil icon** to rename a passkey. + +#### 🗑 Delete: +Click the **trash icon** to remove a passkey. +⚠️ This revokes access via that method. + +--- + +For more assistance with OpenSign™ features or APIs, contact our support team at **[support@opensignlabs.com](mailto:support@opensignlabs.com)**. From a01e361d145f1ac0bd3379b1548a2feb2452dfa1 Mon Sep 17 00:00:00 2001 From: pravin Date: Tue, 20 May 2025 13:07:41 +0530 Subject: [PATCH 03/12] Update Preferences.md Updated the preferences page content --- docs/docs/help/Settings/Preferences.md | 122 +++++++++++++------------ 1 file changed, 65 insertions(+), 57 deletions(-) diff --git a/docs/docs/help/Settings/Preferences.md b/docs/docs/help/Settings/Preferences.md index f616fb8c3..49646cf60 100644 --- a/docs/docs/help/Settings/Preferences.md +++ b/docs/docs/help/Settings/Preferences.md @@ -18,7 +18,7 @@ The **Allowed Signature Types** section defines which signature methods are avai - ✅ **Upload**: Upload a scanned or saved image of your signature. - ✅ **Default**: Use the default signature stored under *My Signature* in settings. -⚙️ The options selected here will determine what appears in the signature widget during document creation and signing. You can also change these preferences while creating the document. +⚙️ The options selected here determine what appears in the signature widget during document creation and signing. You can also change these preferences while creating the document. --- @@ -30,49 +30,51 @@ The **Allowed Signature Types** section defines which signature methods are avai Admins can enforce company-wide signing policies by restricting signature methods platform-wide. -> In the **Console Application > General**, admins can set allowed signature types at the organization level. Only the selected types will be shown on the **Preferences > Signature** page for users. +In **Console Application > General**, admins can set allowed signature types at the organization level. Only the selected types will appear on the **Preferences > Signature** page for users. + +Signature type setup console ### 👤 User-Level -> Navigate to **Settings > Preferences** to configure user-level signature types. -If a user sets preferred types here, only these will be shown when adding signature or initial widgets during document creation. +Navigate to **Settings > Preferences** to configure user-level signature types. + +If a user sets preferred types here, only these will appear when adding signature or initial widgets during document creation. + +Signature type setup preferences ### 📄 Document-Level -> While creating a document, users can set specific allowed signature types. +While creating a document, users can set specific allowed signature types. + Only these will be available to the signer—useful for legal or regulatory requirements. +Signature type setup signature widget + --- ## 🔔 Notify on Signatures -Enable or disable email or in-app notifications when a document is signed. +The document owner will receive email notifications when a document is signed. - **Yes** – Receive alerts for each completed signature. - **No** – Notifications are turned off. -> User can change this option while creating the document or template. - -**Details**: -The document creator will receive an email notification whenever a signer signs the document. +> Users can change this option while creating the document or template. **Note**: Regardless of this setting, a **completion email** with the signed document and completion certificate is **always sent** to all signers and the document owner. +Preferences setup + --- ## 📬 Send in Order Decide whether the document should be signed **sequentially** or **simultaneously** by multiple signers. -- **Yes** – Signers receive the document in a set order. -- **No** – All signers receive the document at once. +- **Yes** – Signers receive the document in a set order. The next signer gets access only after the previous one has completed signing. +- **No** – All signers receive the document at once and can sign independently of one another. -> User can change this option while creating the document or template. - -**Details**: - -- **Yes**: Signers are notified one after another. The next signer gets access only after the previous has completed signing. -- **No**: All signers receive links at the same time. They can sign independently of one another. +> Users can change this option while creating the document or template. --- @@ -80,15 +82,10 @@ Decide whether the document should be signed **sequentially** or **simultaneousl The tour feature provides guidance for first-time users. You can turn this off for a cleaner, uninterrupted experience: -- **Yes** – Show onboarding tips. -- **No** – Disable tour prompts *(recommended for experienced users)*. +- **Yes** – Show onboarding tips. Enables guided tooltips for the signer during the signing process. +- **No** – Disable tour prompts *(recommended for experienced users)*. Speeds up the signing experience. -> User can change this option while creating the document or template. - -**Details**: - -- **Yes**: Enables guided tooltips for the signer during the signing process. -- **No**: Disables the tour, speeding up the signing experience. +> Users can change this option while creating the document or template. 💡 **Tip**: Disable if your users are already familiar with OpenSign™. @@ -104,13 +101,17 @@ These settings are reflected in: - Webhooks ### 📅 Date Format -- Used as the **default format** for date widgets when creating documents. -- Applies in all flows including APIs. + +- The selected date format will be applied by default to the date widget if no specific format is chosen during document creation. +- This default format applies in all flows including APIs. ### 🕒 Time Format + - Supports **12-hour** and **24-hour** formats. - Affects timestamps in certificates, logs, and webhooks. +Preferences setup + --- ## 🧪 LTV Enabled Signatures @@ -118,17 +119,20 @@ These settings are reflected in: **LTV (Long-Term Validation)** ensures that signatures remain valid and verifiable even after certificates expire or are revoked. ### 🔐 Key Features: -- Embeds certificate chain -- Includes CRLs and OCSP responses -- Enables offline verification + +- Embeds certificate chain +- Includes CRLs and OCSP responses +- Enables offline verification - Complies with PDF standards like **PAdES** ### 📌 Why It Matters: + Even if a certificate becomes invalid in the future, the LTV-enabled signature stays verifiable. ### ✅ Use Cases: -- Legal Contracts -- Financial or Medical Records + +- Legal Contracts +- Financial or Medical Records - Long-term archiving requirements --- @@ -138,10 +142,12 @@ Even if a certificate becomes invalid in the future, the LTV-enabled signature s In the **Preferences > Email** tab, users can customize email templates for: ### ✉️ Request Signature Email -Once set, all signers will receive the customized request email. + +All signers will receive the customized request email once it is set. ### 📩 Document Completion Email -On completion, all signers receive the custom-formatted email with the signed document. + +All signers receive a custom-formatted email with the signed document upon completion. --- @@ -151,18 +157,22 @@ On completion, all signers receive the custom-formatted email with the signed do Adds a second verification step when logging in. -### Benefits: -- Enhances account protection -- Requires time-based code from an app like Google Authenticator +#### Benefits: -### How to Enable: -1. Go to **Security > Setup 2FA** -2. Scan the QR Code with an authenticator app -3. Save Recovery Codes for backup -4. Enter verification code to complete setup +- Enhances account protection +- Requires a time-based code from an app like Google Authenticator + +#### How to Enable: + +1. Go to **Security > Setup 2FA** +2. Scan the QR Code with an authenticator app +3. Save recovery codes for backup +4. Enter the verification code to complete setup > If 2FA is enabled, you’ll be prompted for a verification code after entering your password. +[![how to setup 2fa](https://img.youtube.com/vi/cgVBBetnbO8/0.jpg)](https://www.youtube.com/watch?v=cgVBBetnbO8) + --- ### 🛡️ Passkey Authentication @@ -170,27 +180,25 @@ Adds a second verification step when logging in. Passkeys offer **passwordless** and **phishing-resistant** sign-in. #### 🔐 Key Features: -- Use fingerprint, face ID, or device PIN -- Passwordless and secure + +- Use fingerprint, Face ID, or device PIN +- Passwordless and secure - Reduces credential theft risks -### 🛠 How to Register a Passkey: -1. Click **Register another passkey** -2. Your device prompts biometric or PIN-based authentication +#### 🛠 How to Register a Passkey: + +1. Click **Register another passkey** +2. Your device prompts biometric or PIN-based authentication 3. On success, the passkey is saved and listed under **Your Passkeys** - -### 🧾 Managing Your Passkeys -Each passkey entry shows: -- Name (e.g., "Windows Edge") -- Created Date -- Last Used Date -- Credential ID +#### 🧾 Managing Your Passkeys + +##### ✏️ Rename: -#### ✏️ Rename: Click the **pencil icon** to rename a passkey. -#### 🗑 Delete: +##### 🗑 Delete: + Click the **trash icon** to remove a passkey. ⚠️ This revokes access via that method. From 6b5815f52a7aa733e9e025c5e82a2b3483d817e5 Mon Sep 17 00:00:00 2001 From: pravin Date: Tue, 20 May 2025 13:08:36 +0530 Subject: [PATCH 04/12] Update disabledocumentid.md updated the menu option preference for disabled docuemnt id tab --- docs/docs/help/Settings/disabledocumentid.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/help/Settings/disabledocumentid.md b/docs/docs/help/Settings/disabledocumentid.md index 6f31b7f14..1f9696184 100644 --- a/docs/docs/help/Settings/disabledocumentid.md +++ b/docs/docs/help/Settings/disabledocumentid.md @@ -1,5 +1,5 @@ --- -sidebar_position: 4 +sidebar_position: 7 title: Disable DocumentId --- From a0c1e0809125f16a6b3cbae2bcec6e0b6f2213b6 Mon Sep 17 00:00:00 2001 From: pravin Date: Mon, 2 Jun 2025 11:52:01 +0530 Subject: [PATCH 05/12] Update Preferences.md updated the preferences page. --- docs/docs/help/Settings/Preferences.md | 109 +++++++------------------ 1 file changed, 30 insertions(+), 79 deletions(-) diff --git a/docs/docs/help/Settings/Preferences.md b/docs/docs/help/Settings/Preferences.md index 49646cf60..630f90e4e 100644 --- a/docs/docs/help/Settings/Preferences.md +++ b/docs/docs/help/Settings/Preferences.md @@ -9,6 +9,14 @@ The **Preferences** page in **OpenSign™** allows users and administrators to t --- +## 🚀 Steps to Navigate to Preferences + +**Step 1:** Log in to your OpenSign account using valid credentials. + +**Step 2:** Navigate to the **Settings** section and click on **Preferences**. + +--- + ## 📌 Signature Types Control The **Allowed Signature Types** section defines which signature methods are available to signers: @@ -18,7 +26,7 @@ The **Allowed Signature Types** section defines which signature methods are avai - ✅ **Upload**: Upload a scanned or saved image of your signature. - ✅ **Default**: Use the default signature stored under *My Signature* in settings. -⚙️ The options selected here determine what appears in the signature widget during document creation and signing. You can also change these preferences while creating the document. +⚙️ The options selected here determine what appears in the signature widget during document creation and signing. You can also change these preferences while creating a document. --- @@ -28,23 +36,27 @@ The **Allowed Signature Types** section defines which signature methods are avai ### 🏢 Organization-Level -Admins can enforce company-wide signing policies by restricting signature methods platform-wide. +Admins can enforce company-wide signing policies by restricting available signature methods platform-wide. -In **Console Application > General**, admins can set allowed signature types at the organization level. Only the selected types will appear on the **Preferences > Signature** page for users. +Step 1: Open the profile menu and select Console Application to launch the console. + +Step 2: Once the Console Application loads, navigate to the General menu. Here, admins can configure the allowed signature types at the organization level. + +After the signature types are set, only those selected options will appear in the Preferences page and in the Signature, Initial Widgets during both document creation and signing. Signature type setup console ### 👤 User-Level -Navigate to **Settings > Preferences** to configure user-level signature types. +Navigate to **Settings > Preferences** to configure user-level signature types. -If a user sets preferred types here, only these will appear when adding signature or initial widgets during document creation. +If a user sets preferred types here, only those will appear when adding signature or initial widgets during document creation. Signature type setup preferences ### 📄 Document-Level -While creating a document, users can set specific allowed signature types. +While creating a document, users can specify allowed signature types. Only these will be available to the signer—useful for legal or regulatory requirements. @@ -59,7 +71,7 @@ The document owner will receive email notifications when a document is signed. - **Yes** – Receive alerts for each completed signature. - **No** – Notifications are turned off. -> Users can change this option while creating the document or template. +> Users can change this option while creating the document or a template. **Note**: Regardless of this setting, a **completion email** with the signed document and completion certificate is **always sent** to all signers and the document owner. @@ -71,10 +83,10 @@ The document owner will receive email notifications when a document is signed. Decide whether the document should be signed **sequentially** or **simultaneously** by multiple signers. -- **Yes** – Signers receive the document in a set order. The next signer gets access only after the previous one has completed signing. -- **No** – All signers receive the document at once and can sign independently of one another. +- **Yes** – Signers receive the document in a set order. The next signer gains access only after the previous one completes signing. +- **No** – All signers receive the document at once and can sign independently. -> Users can change this option while creating the document or template. +> Users can change this option while creating the document or a template. --- @@ -85,7 +97,7 @@ The tour feature provides guidance for first-time users. You can turn this off f - **Yes** – Show onboarding tips. Enables guided tooltips for the signer during the signing process. - **No** – Disable tour prompts *(recommended for experienced users)*. Speeds up the signing experience. -> Users can change this option while creating the document or template. +> Users can change this option while creating the document or a template. 💡 **Tip**: Disable if your users are already familiar with OpenSign™. @@ -103,7 +115,7 @@ These settings are reflected in: ### 📅 Date Format - The selected date format will be applied by default to the date widget if no specific format is chosen during document creation. -- This default format applies in all flows including APIs. +- This default format also applies in all API flows. ### 🕒 Time Format @@ -114,7 +126,7 @@ These settings are reflected in: --- -## 🧪 LTV Enabled Signatures +## 🧪 LTV-Enabled Signatures **LTV (Long-Term Validation)** ensures that signatures remain valid and verifiable even after certificates expire or are revoked. @@ -127,7 +139,7 @@ These settings are reflected in: ### 📌 Why It Matters: -Even if a certificate becomes invalid in the future, the LTV-enabled signature stays verifiable. +Even if a certificate becomes invalid in the future, the LTV-enabled signature remains verifiable. ### ✅ Use Cases: @@ -137,71 +149,10 @@ Even if a certificate becomes invalid in the future, the LTV-enabled signature s --- -## 📧 Email Templates +## 📧 Email Templates +For details, visit: [https://docs.opensignlabs.com/docs/help/Settings/Teams](https://docs.opensignlabs.com/docs/help/Settings/Teams) -In the **Preferences > Email** tab, users can customize email templates for: - -### ✉️ Request Signature Email - -All signers will receive the customized request email once it is set. - -### 📩 Document Completion Email - -All signers receive a custom-formatted email with the signed document upon completion. - ---- - -## 🔒 Security - -### ✅ Two-Factor Authentication (2FA) - -Adds a second verification step when logging in. - -#### Benefits: - -- Enhances account protection -- Requires a time-based code from an app like Google Authenticator - -#### How to Enable: - -1. Go to **Security > Setup 2FA** -2. Scan the QR Code with an authenticator app -3. Save recovery codes for backup -4. Enter the verification code to complete setup - -> If 2FA is enabled, you’ll be prompted for a verification code after entering your password. - -[![how to setup 2fa](https://img.youtube.com/vi/cgVBBetnbO8/0.jpg)](https://www.youtube.com/watch?v=cgVBBetnbO8) - ---- - -### 🛡️ Passkey Authentication - -Passkeys offer **passwordless** and **phishing-resistant** sign-in. - -#### 🔐 Key Features: - -- Use fingerprint, Face ID, or device PIN -- Passwordless and secure -- Reduces credential theft risks - -#### 🛠 How to Register a Passkey: - -1. Click **Register another passkey** -2. Your device prompts biometric or PIN-based authentication -3. On success, the passkey is saved and listed under **Your Passkeys** - -#### 🧾 Managing Your Passkeys - -##### ✏️ Rename: - -Click the **pencil icon** to rename a passkey. - -##### 🗑 Delete: - -Click the **trash icon** to remove a passkey. -⚠️ This revokes access via that method. - ---- +## 🔒 Security +For details, visit: [https://docs.opensignlabs.com/docs/help/Settings/Teams](https://docs.opensignlabs.com/docs/help/Settings/Teams) For more assistance with OpenSign™ features or APIs, contact our support team at **[support@opensignlabs.com](mailto:support@opensignlabs.com)**. From f09562913419e4e9cf1ef89f423faf59f54703dc Mon Sep 17 00:00:00 2001 From: pravin Date: Mon, 2 Jun 2025 12:15:08 +0530 Subject: [PATCH 06/12] Create Custom-email-templates.md added the page for custom email template --- .../help/Settings/Custom-email-templates.md | 46 +++++++++++++++++++ 1 file changed, 46 insertions(+) create mode 100644 docs/docs/help/Settings/Custom-email-templates.md diff --git a/docs/docs/help/Settings/Custom-email-templates.md b/docs/docs/help/Settings/Custom-email-templates.md new file mode 100644 index 000000000..138a5239f --- /dev/null +++ b/docs/docs/help/Settings/Custom-email-templates.md @@ -0,0 +1,46 @@ +--- +sidebar_position: +title: Custom Email Templates +--- + +# 📧 Email Templates + +In the **Preferences > Email** tab, users can customize email templates to personalize the communication experience for signers and stakeholders. This feature helps maintain brand consistency and improve engagement throughout the signing workflow. + +--- + +## 🚀 Steps to Set Up Custom Email Templates + +**Step 1:** Log in to your OpenSign account using valid credentials. +**Step 2:** Navigate to the **Settings** section and click on **Preferences**. +**Step 3:** Click on the **Email** tab. Here, users can configure and edit custom email templates for different stages of the document lifecycle. + +--- + +## ✉️ Request Signature Email + +This email is sent to all signers when a document is shared with them for signing. + +- You can customize the subject line, greeting, message body, and footer. +- Use dynamic placeholders (e.g., `{{document_title}}}`, `{{receiver_name}}`,`{{signing_url}}`) to personalize each message. +- This improves open rates and helps recipients understand the context of the request. + +## 📩 Document Completion Email + +This email is sent to all signers and the document owner once the signing process is complete. + +- Includes a summary message along with the signed document and completion certificate as attachments. +- Template customization allows teams to reinforce brand messaging post-signature. +- Ideal for legal confirmations, audit trails, and archival communication. + +--- + +## 🛠️ Additional Notes + +- All custom email templates support **rich text formatting** and **variables** for dynamic content. +- Changes to templates take immediate effect and apply to all new documents created after the update. +- Organizations can define a consistent template style across all teams to ensure compliance and branding. + +> 💡 **Tip:** Preview your templates before saving to ensure correct formatting and placeholder usage. + +For more assistance with OpenSign™ features or APIs, contact our support team at **[support@opensignlabs.com](mailto:support@opensignlabs.com)**. From 72a61bc621bc85cea54e43cb7628e739daad9350 Mon Sep 17 00:00:00 2001 From: pravin Date: Mon, 2 Jun 2025 13:40:11 +0530 Subject: [PATCH 07/12] Create SecurityManagement.md Added the security management tab --- docs/docs/help/Settings/SecurityManagement.md | 62 +++++++++++++++++++ 1 file changed, 62 insertions(+) create mode 100644 docs/docs/help/Settings/SecurityManagement.md diff --git a/docs/docs/help/Settings/SecurityManagement.md b/docs/docs/help/Settings/SecurityManagement.md new file mode 100644 index 000000000..fbe696c50 --- /dev/null +++ b/docs/docs/help/Settings/SecurityManagement.md @@ -0,0 +1,62 @@ +--- +sidebar_position: +title: Security Management +--- + +## 🔒 Security + +### ✅ Two-Factor Authentication (2FA) + +Adds a second verification step when logging in. + +#### Benefits: + +- Enhances account protection +- Requires a time-based code from an app like Google Authenticator + +#### How to Enable: + +1. Go to **Preferences > Security > Setup 2FA** +2. Scan the QR Code with an authenticator app +3. Save recovery codes for backup +4. Enter the verification code to complete setup + +> If 2FA is enabled, you’ll be prompted for a verification code after entering your password. + +[![how to setup 2fa](https://img.youtube.com/vi/cgVBBetnbO8/0.jpg)](https://www.youtube.com/watch?v=cgVBBetnbO8) + +--- + +### 🛡️ Passkey Authentication + +Passkeys offer **passwordless** and **phishing-resistant** sign-in. + +#### 🔐 Key Features: + +- Use fingerprint, Face ID, or device PIN +- Passwordless and secure +- Reduces credential theft risks + +#### 🛠 How to Register a Passkey: + +1. Go to **Preferences > Security** +2. Click **Register passkey** +3. Your device prompts biometric or PIN-based authentication +4. On success, the passkey is saved and listed under **Your Passkeys** + +[![how to setup passkey]()](https://www.youtube.com/embed/lLfcu9oSbew?si=yODZcEveYZSbQQXw) + +#### 🧾 Managing Your Passkeys + +##### ✏️ Rename: + +Click the **pencil icon** to rename a passkey. + +##### 🗑 Delete: + +Click the **trash icon** to remove a passkey. +⚠️ This revokes access via that method. + +--- + +For more assistance with OpenSign™ features or APIs, contact our support team at **[support@opensignlabs.com](mailto:support@opensignlabs.com)**. From e16c5e08a8232b92d601cd7ea27e0872f6529368 Mon Sep 17 00:00:00 2001 From: pravin Date: Mon, 2 Jun 2025 13:55:24 +0530 Subject: [PATCH 08/12] Update SecurityManagement.md Updated the security management page. --- docs/docs/help/Settings/SecurityManagement.md | 68 ++++++++++++------- 1 file changed, 45 insertions(+), 23 deletions(-) diff --git a/docs/docs/help/Settings/SecurityManagement.md b/docs/docs/help/Settings/SecurityManagement.md index fbe696c50..4aad91af4 100644 --- a/docs/docs/help/Settings/SecurityManagement.md +++ b/docs/docs/help/Settings/SecurityManagement.md @@ -7,55 +7,77 @@ title: Security Management ### ✅ Two-Factor Authentication (2FA) -Adds a second verification step when logging in. +Two-Factor Authentication (2FA) adds a second layer of security to your account by requiring **not just your password, but also a time-sensitive code** from a trusted device. -#### Benefits: +#### 🔐 What is 2FA? -- Enhances account protection -- Requires a time-based code from an app like Google Authenticator - -#### How to Enable: +2FA combines **something you know** (your password) with **something you have** (like a smartphone or hardware token). This significantly reduces the risk of unauthorized access—even if someone has your password. -1. Go to **Preferences > Security > Setup 2FA** -2. Scan the QR Code with an authenticator app -3. Save recovery codes for backup -4. Enter the verification code to complete setup +#### 🛡️ Benefits: -> If 2FA is enabled, you’ll be prompted for a verification code after entering your password. +- Enhances account protection against phishing and brute-force attacks +- Reduces the risk of unauthorized access from compromised credentials +- Helps meet compliance requirements for security-conscious organizations +- Only the account owner with access to the authenticator app can log in + +#### 📲 How to Enable: + +1. Go to **Settings > Preferences > Security** +2. Click "Setup 2FA" button and scan the displayed QR code with an app like Google Authenticator, Authy, or Microsoft Authenticator. +3. Save the recovery codes in a secure location (they allow access if you lose your phone) +4. Enter the 6-digit verification code shown in your app to complete setup + +> 🔁 The verification code refreshes every 30 seconds and is unique to your device. +> 🔐 If 2FA is enabled, you will be prompted for a verification code every time you log in. + +#### 📹 Watch the Setup Tutorial: [![how to setup 2fa](https://img.youtube.com/vi/cgVBBetnbO8/0.jpg)](https://www.youtube.com/watch?v=cgVBBetnbO8) ---- - ### 🛡️ Passkey Authentication -Passkeys offer **passwordless** and **phishing-resistant** sign-in. +Passkeys offer **passwordless**, **phishing-resistant**, and **device-bound** sign-in using modern authentication standards. -#### 🔐 Key Features: +#### 🔐 What Are Passkeys? -- Use fingerprint, Face ID, or device PIN -- Passwordless and secure -- Reduces credential theft risks +Passkeys are cryptographic credentials tied to your device and identity, replacing traditional passwords. They’re based on **FIDO2/WebAuthn** standards and work using **public-private key encryption**, making them highly secure. + +- Instead of typing passwords, you authenticate using biometrics (like Face ID or fingerprint) or a device PIN. +- A passkey is stored securely on your device and never shared—so even if attackers phish you, they can’t steal your login info. + +#### 💡 Key Features: + +- Use **fingerprint**, **Face ID**, or **device PIN** +- **Passwordless** and **secure** authentication +- Resistant to **phishing** and **credential stuffing** +- Syncs across devices (when using platforms like iCloud Keychain or Google Password Manager) +- Fast, one-tap login experience #### 🛠 How to Register a Passkey: -1. Go to **Preferences > Security** +1. Go to **Settings > Preferences > Security** 2. Click **Register passkey** 3. Your device prompts biometric or PIN-based authentication 4. On success, the passkey is saved and listed under **Your Passkeys** - -[![how to setup passkey]()](https://www.youtube.com/embed/lLfcu9oSbew?si=yODZcEveYZSbQQXw) + +> 📌 A passkey is unique to each device/browser combination. You can register multiple passkeys for different environments. + +#### 📹 Watch the Setup Tutorial: + +[![How to Setup Passkey](https://img.youtube.com/vi/lLfcu9oSbew/0.jpg)](https://www.youtube.com/embed/lLfcu9oSbew?si=yODZcEveYZSbQQXw) #### 🧾 Managing Your Passkeys ##### ✏️ Rename: -Click the **pencil icon** to rename a passkey. +Click the **pencil icon** to rename a passkey for easy identification. ##### 🗑 Delete: Click the **trash icon** to remove a passkey. -⚠️ This revokes access via that method. +⚠️ This revokes access via that method and may require alternate login or re-registration. + +> 🔐 Tip: Register multiple passkeys on different devices for redundancy and ease of access. --- From 998a50412a512c5ff403f4d7c02f1a04d43eb00a Mon Sep 17 00:00:00 2001 From: pravin Date: Mon, 2 Jun 2025 14:15:07 +0530 Subject: [PATCH 09/12] Update Custom-email-templates.md Updated the custom email template text --- docs/docs/help/Settings/Custom-email-templates.md | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/docs/docs/help/Settings/Custom-email-templates.md b/docs/docs/help/Settings/Custom-email-templates.md index 138a5239f..23df0f504 100644 --- a/docs/docs/help/Settings/Custom-email-templates.md +++ b/docs/docs/help/Settings/Custom-email-templates.md @@ -15,15 +15,17 @@ In the **Preferences > Email** tab, users can customize email templates to perso **Step 2:** Navigate to the **Settings** section and click on **Preferences**. **Step 3:** Click on the **Email** tab. Here, users can configure and edit custom email templates for different stages of the document lifecycle. +add team + --- ## ✉️ Request Signature Email -This email is sent to all signers when a document is shared with them for signing. +This email is automatically sent to all signers when a document is shared with them for signing. -- You can customize the subject line, greeting, message body, and footer. -- Use dynamic placeholders (e.g., `{{document_title}}}`, `{{receiver_name}}`,`{{signing_url}}`) to personalize each message. -- This improves open rates and helps recipients understand the context of the request. +- Customize the subject line, greeting, message body, and footer to match your tone and branding. +- Use dynamic placeholders like `{{document_title}}`, `{{receiver_name}}`, and `{{signing_url}}` to personalize each message. +- Personalized messages improve open rates and help recipients understand the context of the request. ## 📩 Document Completion Email @@ -32,6 +34,11 @@ This email is sent to all signers and the document owner once the signing proces - Includes a summary message along with the signed document and completion certificate as attachments. - Template customization allows teams to reinforce brand messaging post-signature. - Ideal for legal confirmations, audit trails, and archival communication. +- +### 🔄 Reset Template Text + +Click the **Reset** button to restore the template content to its default version. +Don’t forget to click **Save** afterward to apply the changes. --- From 98f7de5e0ca4566b2109e55b9c606805f5e0d383 Mon Sep 17 00:00:00 2001 From: pravin Date: Mon, 2 Jun 2025 14:20:47 +0530 Subject: [PATCH 10/12] Update Custom-email-templates.md Updated the custom email template page content --- docs/docs/help/Settings/Custom-email-templates.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/docs/docs/help/Settings/Custom-email-templates.md b/docs/docs/help/Settings/Custom-email-templates.md index 23df0f504..940df0913 100644 --- a/docs/docs/help/Settings/Custom-email-templates.md +++ b/docs/docs/help/Settings/Custom-email-templates.md @@ -5,10 +5,6 @@ title: Custom Email Templates # 📧 Email Templates -In the **Preferences > Email** tab, users can customize email templates to personalize the communication experience for signers and stakeholders. This feature helps maintain brand consistency and improve engagement throughout the signing workflow. - ---- - ## 🚀 Steps to Set Up Custom Email Templates **Step 1:** Log in to your OpenSign account using valid credentials. From 0b8c4eac6ea51e18c7c065d4f9d97ee576e38c87 Mon Sep 17 00:00:00 2001 From: pravin Date: Mon, 2 Jun 2025 14:45:40 +0530 Subject: [PATCH 11/12] Update Preferences.md updated the preferences page content. --- docs/docs/help/Settings/Preferences.md | 27 ++++++++++++++++++++++---- 1 file changed, 23 insertions(+), 4 deletions(-) diff --git a/docs/docs/help/Settings/Preferences.md b/docs/docs/help/Settings/Preferences.md index 630f90e4e..4c5f2faa4 100644 --- a/docs/docs/help/Settings/Preferences.md +++ b/docs/docs/help/Settings/Preferences.md @@ -149,10 +149,29 @@ Even if a certificate becomes invalid in the future, the LTV-enabled signature r --- -## 📧 Email Templates -For details, visit: [https://docs.opensignlabs.com/docs/help/Settings/Teams](https://docs.opensignlabs.com/docs/help/Settings/Teams) +## 📧 Email Templates -## 🔒 Security -For details, visit: [https://docs.opensignlabs.com/docs/help/Settings/Teams](https://docs.opensignlabs.com/docs/help/Settings/Teams) +In the **Preferences > Email** tab, users can customize email templates to personalize communication with signers and stakeholders. +This feature helps maintain brand consistency and enhances engagement throughout the signing workflow. + +👉 For a step-by-step guide on setting up custom email templates: [📄 View Email Template Guide](https://docs.opensignlabs.com/docs/help/Settings/Custom-email-templates) + +--- + +## 🔒 Security + +The **Security** tab in OpenSign (found under **Settings > Preferences > Security**) allows users to manage key authentication methods to protect their account access. + +### 🧩 Features Available: + +#### ✅ Two-Factor Authentication (2FA) + +Enhance your account security by enabling 2FA. Once activated, you'll enter a time-based code from an authenticator app each time you log in. + +#### 🛡️ Passkey Authentication + +Passkeys offer a **passwordless**, **phishing-resistant** login experience using your device’s built-in security features such as fingerprint, Face ID, or PIN. + +👉 For full details on setting up **Two-Factor Authentication (2FA)** and **Passkey Authentication**: [🔒 View Security Setup Guide](https://docs.opensignlabs.com/docs/help/Settings/SecurityManagement) For more assistance with OpenSign™ features or APIs, contact our support team at **[support@opensignlabs.com](mailto:support@opensignlabs.com)**. From d96504bb3021eb99a964d2550ce29fe58a536e67 Mon Sep 17 00:00:00 2001 From: pravin Date: Mon, 2 Jun 2025 16:40:31 +0530 Subject: [PATCH 12/12] Update Preferences.md updated the Preferences page content. --- docs/docs/help/Settings/Preferences.md | 44 +++++++++++++++++--------- 1 file changed, 29 insertions(+), 15 deletions(-) diff --git a/docs/docs/help/Settings/Preferences.md b/docs/docs/help/Settings/Preferences.md index 4c5f2faa4..8fc69fc43 100644 --- a/docs/docs/help/Settings/Preferences.md +++ b/docs/docs/help/Settings/Preferences.md @@ -38,13 +38,22 @@ The **Allowed Signature Types** section defines which signature methods are avai Admins can enforce company-wide signing policies by restricting available signature methods platform-wide. -Step 1: Open the profile menu and select Console Application to launch the console. +**Step 1:** Open the profile menu and select **Console Application** to launch the console. -Step 2: Once the Console Application loads, navigate to the General menu. Here, admins can configure the allowed signature types at the organization level. +**Step 2:** Once the Console Application loads, navigate to the **General** menu. Here, admins can configure the allowed signature types at the organization level. -After the signature types are set, only those selected options will appear in the Preferences page and in the Signature, Initial Widgets during both document creation and signing. +All users created under your account will only see the signing methods you enable here in their **Preferences**. They will be restricted from using any methods you don't select. -Signature type setup console +**Example:** +Adam, the administrator of your company account, disables the **Typed** signature option in the **Manage Signature Types** settings. As a result, Ursula, a team member, will no longer see the **Typed** signature option in her preferences. + +Ursula can enable or disable any of the remaining three signature methods for each document she creates. + +When she sends a document to Sofia, a signer, Sofia will only see the signature methods that Ursula selected during the document creation process. + +**Note:** Managing **Signature Types** at the organization level is only available on the **Teams** plan. This feature is not included in the **Professional** or **Free** plans. + +![Signature type setup console](https://github.com/user-attachments/assets/c8c3de19-e82e-464a-977b-cdf3fd12aed7) ### 👤 User-Level @@ -52,7 +61,7 @@ Navigate to **Settings > Preferences** to configure user-level signature types. If a user sets preferred types here, only those will appear when adding signature or initial widgets during document creation. -Signature type setup preferences +![Signature type setup preferences](https://github.com/user-attachments/assets/ae413b24-fe53-4aa9-9242-624574f1d7b3) ### 📄 Document-Level @@ -60,22 +69,24 @@ While creating a document, users can specify allowed signature types. Only these will be available to the signer—useful for legal or regulatory requirements. -Signature type setup signature widget +![Signature type setup signature widget](https://github.com/user-attachments/assets/d64510e1-df14-44fe-8020-45b17c612238) --- ## 🔔 Notify on Signatures -The document owner will receive email notifications when a document is signed. +The document owner can choose to receive email notifications when a document is signed. -- **Yes** – Receive alerts for each completed signature. -- **No** – Notifications are turned off. +- **Yes** – Get notified each time a signer completes their part. +- **No** – Turn off real-time signature notifications. -> Users can change this option while creating the document or a template. +This setting can be adjusted while creating a document or template. -**Note**: Regardless of this setting, a **completion email** with the signed document and completion certificate is **always sent** to all signers and the document owner. +Regardless of this preference, a **final completion email**—including the signed document and completion certificate—is **always sent** to both the document owner and all signers. -Preferences setup +**Note:** Notify on Signatures feature is only available on the **Professional** and higher plans—it is not included in the **Free** plan. + +![Preferences setup](https://github.com/user-attachments/assets/5adad567-6c01-4766-9b10-db3f95ad65d3) --- @@ -122,7 +133,7 @@ These settings are reflected in: - Supports **12-hour** and **24-hour** formats. - Affects timestamps in certificates, logs, and webhooks. -Preferences setup +![Preferences setup](https://github.com/user-attachments/assets/5bb9ad1a-f3c7-4b6e-9469-1bb003e1eec0) --- @@ -154,7 +165,9 @@ Even if a certificate becomes invalid in the future, the LTV-enabled signature r In the **Preferences > Email** tab, users can customize email templates to personalize communication with signers and stakeholders. This feature helps maintain brand consistency and enhances engagement throughout the signing workflow. -👉 For a step-by-step guide on setting up custom email templates: [📄 View Email Template Guide](https://docs.opensignlabs.com/docs/help/Settings/Custom-email-templates) +👉 [📄 Step-by-step guide to setting up custom email templates](https://docs.opensignlabs.com/docs/help/Settings/Custom-email-templates) + +**Note:** The custom email templates feature is only available on the **Professional** and higher plans—it is not included in the **Free** plan. --- @@ -172,6 +185,7 @@ Enhance your account security by enabling 2FA. Once activated, you'll enter a ti Passkeys offer a **passwordless**, **phishing-resistant** login experience using your device’s built-in security features such as fingerprint, Face ID, or PIN. -👉 For full details on setting up **Two-Factor Authentication (2FA)** and **Passkey Authentication**: [🔒 View Security Setup Guide](https://docs.opensignlabs.com/docs/help/Settings/SecurityManagement) +👉 For full details on setting up **Two-Factor Authentication (2FA)** and **Passkey Authentication**: +[🔒 View Security Setup Guide](https://docs.opensignlabs.com/docs/help/Settings/SecurityManagement) For more assistance with OpenSign™ features or APIs, contact our support team at **[support@opensignlabs.com](mailto:support@opensignlabs.com)**.