Skip to content

Commit 79133b5

Browse files
Update Variable Mapping file
1 parent 75e5d43 commit 79133b5

15 files changed

Lines changed: 162 additions & 0 deletions

docs/E_Sign/variable_mapping.md

Lines changed: 158 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,158 @@
1+
# How to Use Variable Mapping in a CSV File?
2+
3+
Variable mapping enables dynamic personalization of bulk emails or documents by linking template placeholders to corresponding data fields in a CSV file. Each row in the CSV represents a unique recipient, allowing the system to generate customized content at scale.
4+
5+
---
6+
7+
## Step 1: Configure the E-Sign
8+
9+
- Navigate to Documents and select the appropriate folder.
10+
- Open the file action menu and click E-Sign.
11+
- Add a Required Variable Field.
12+
- Drag and drop the required field into the document at the desired location.
13+
14+
<img src=" screenshots\Variable_Mapping\Variable_Mapping.png" style="border:2px solid black; border-radius:4px; width:100%; max-width:800px;" alt="Screenshot for Document">
15+
16+
---
17+
18+
## Step 2: Configure Field Scope (Current)
19+
20+
To assign values specific to individual recipients:
21+
22+
- Add another Variable Field to the document.
23+
- Open the Settings Panel for the field.
24+
- Set the Scope to **Current**.
25+
- Enter a relevant Label Name for identification
26+
27+
<img src=" screenshots\Variable_Mapping\Variable_Mapping2.png" style="border:2px solid black; border-radius:4px; width:100%; max-width:800px;" alt="Screenshot for Document">
28+
29+
---
30+
31+
## Step 2: Send Bulk Mail
32+
33+
- After configuring the E-Sign document, click Send Mail.
34+
- Select the Bulk Mail option.
35+
- Enable the **Include Variables in CSV File** option.
36+
37+
<img src=" screenshots\Variable_Mapping\Variable_Mapping4.png" style="border:2px solid black; border-radius:4px; width:100%; max-width:800px;" alt="Screenshot for Document">
38+
39+
---
40+
41+
## Step 3: Configure Recipient Data
42+
43+
### Option 1: Upload CSV File
44+
45+
Uploading a CSV file is the most efficient method for large-scale distribution.
46+
<details open>
47+
<summary><b>Steps to Upload CSV File</b></summary>
48+
49+
1. Click Upload CSV File.
50+
2. Select a properly formatted CSV file.
51+
3. Each row will be treated as a unique recipient.
52+
4. Click Validate to verify email format and data structure.
53+
54+
#### CSV File Format Example
55+
56+
- CSV File Format Example
57+
- Column headers must match the variable label names defined in the document.
58+
- Each row should contain recipient-specific values.
59+
60+
<p>
61+
<a href="files/Variable_Mapping_CSV_File.csv" target="_blank"
62+
style="display:inline-block; background-color:#007bff; color:white; padding:10px 20px; border-radius:6px; text-decoration:none;">
63+
📄 Download CSV Example
64+
</a>
65+
</p>
66+
67+
68+
<img src=" screenshots\Variable_Mapping\Variable_Mapping4.png" style="border:2px solid black; border-radius:4px; width:100%; max-width:800px;" alt="Screenshot for Document">
69+
70+
71+
### Option 2: Enter Recipients Manually
72+
73+
For smaller distributions, recipient details can be entered manually.
74+
75+
<details open>
76+
<summary><b>Steps to Enter Recipients Manually</b></summary>
77+
78+
1. Enter recipient details in the Recipients text area.
79+
2. Follow the on-screen sample format.
80+
3. Enter Details for each recipient.
81+
4. Each line represents one recipient.
82+
83+
</details>
84+
85+
> Party 1 Fullname,Party 1 Email Address,Party 1 Name,Party 1 Address,Party 1 Mobile Number <br>
86+
> John Doe,johndoe@example.com,John Doe,910 Pine Road Dallas TX 75201 USA,5552136984 <br>
87+
> John Thompson,johnthompson@example.com,John Thompson,245 Cedar Lane Albany NY 12207 USA,3336548972
88+
89+
**Screenshot 1**
90+
91+
<img src=" screenshots\Variable_Mapping\Variable_Mapping5.png" style="border:2px solid black; border-radius:4px; width:100%; max-width:800px;" alt="Screenshot for Document">
92+
93+
**Screenshot 2**
94+
95+
<img src=" screenshots\Variable_Mapping\Variable_Mapping6.png" style="border:2px solid black; border-radius:4px; width:100%; max-width:800px;" alt="Screenshot for Document">
96+
97+
---
98+
99+
## Step 3: variable registry
100+
101+
- When using Current Scope, all variable fields are processed per recipient.
102+
- Values are dynamically populated from the CSV file for each row.
103+
- No global variable registry is required in this configuration.
104+
105+
<img src=" screenshots\Variable_Mapping\Variable_Mapping7.png" style="border:2px solid black; border-radius:4px; width:100%; max-width:800px;" alt="Screenshot for Document">
106+
107+
---
108+
109+
## Step 4: Recipient View
110+
111+
- Each recipient receives a personalized document.
112+
- All mapped variables are replaced with corresponding CSV values.
113+
- The final document reflects accurate, recipient-specific data.
114+
115+
**Bulk Recipient 1**
116+
117+
<img src=" screenshots\Variable_Mapping\Variable_Mapping10.png" style="border:2px solid black; border-radius:4px; width:100%; max-width:800px;" alt="Screenshot for Document">
118+
119+
**Bulk Recipient 2**
120+
121+
<img src=" screenshots\Variable_Mapping\Variable_Mapping11.png" style="border:2px solid black; border-radius:4px; width:100%; max-width:800px;" alt="Screenshot for Document">
122+
123+
> The above **Screenshots** represent that how to **Create an Variable Mapping in the CSV File**.
124+
125+
---
126+
127+
**Demo Video:**
128+
<!-- Inline HTML in Markdown file -->
129+
<style>
130+
.video-wrap {
131+
border: 2px solid black;
132+
border-radius: 4px;
133+
width: 100%;
134+
max-width: 800px;
135+
overflow: hidden;
136+
margin-bottom: 1rem;
137+
}
138+
.video-wrap video {
139+
display: block;
140+
width: 100%;
141+
height: auto;
142+
}
143+
</style>
144+
145+
<div class="video-wrap" role="region" aria-label="Demo: Creating a E-Sign">
146+
<!-- Use a relative path like ./videos/demo.mp4 or an absolute URL -->
147+
<video controls poster="">
148+
<source src="https://doculan-storage-public.s3.us-east-1.amazonaws.com/demo_video/Variable_Registry/Bulk_Variable.mp4" type="video/mp4">
149+
<source src=https://doculan-storage-public.s3.us-east-1.amazonaws.com/demo_video/Variable_Registry/Bulk_Variable.webm" type="video/webm">
150+
<!-- Fallback link if browser can't play video -->
151+
Your browser does not support the video tag.
152+
<a href="https://doculan-storage-public.s3.us-east-1.amazonaws.com/demo_video/Variable_Registry/Bulk_Variable.mp4" target="_blank" rel="noopener">Download / Open video</a>
153+
</video>
154+
</div>
155+
156+
> The above **Video** represent that how to **Create an Variable Mapping in the CSV File**.
157+
158+
© Doculan by [Virtualan Software](https://www.virtualan.io)

docs/_sidebar.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
- [How to use the default E-Sign Document?](E_Sign/default_e-sign-document.md)
1313
- [How to use self sign feature?](E_Sign/self-sign-document.md)
1414
- [How to use Variable field?](E_Sign/variable-fields.md)
15+
- [How to Use Variable Mapping in a CSV File?](E_Sign/variable_mapping.md)
1516
- [How to use Delegate Email?](E_Sign/delegate-email.md)
1617
- [How to Schedule an Email?](E_Sign/schedule-email.md)
1718
- [How to Rename the File?](E_Sign/rename-file.md)
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
Party 1 Fullname,Party 1 Email Address,Party 1 Name,Party 1 Address,Party 1 Mobile Number
2+
John Doe,johndoe@example.com,Sample Value,Sample Value,Sample Value
3+
John Thompson,johnthompson@example.com,Sample Value,Sample Value,Sample Value
136 KB
Loading
164 KB
Loading
165 KB
Loading
161 KB
Loading
163 KB
Loading
162 KB
Loading
105 KB
Loading

0 commit comments

Comments
 (0)