Lewati ke konten
AutomaDocAutomaDoc

Menempatkan kolom secara otomatis

Menempatkan kolom secara manual tidak masalah untuk satu dokumen. Untuk kontrak yang Anda kirim setiap minggu, atau dokumen yang dibuat AutomaDoc, tulis tag di dalam dokumen: [[sign:Client]] di tempat klien menandatangani, [[date:Client]] di tempat tanggalnya. Saat dokumen disiapkan, AutomaDoc menemukan setiap tag dan menempatkan kolom di sana. Pengguna API yang tidak dapat mengubah dokumen dapat memakai anchor: kolom yang ditempatkan relatif terhadap teks yang sudah ada di dokumen.

Tag teks

Section titled “Tag teks”

Contoh di Word

Section titled “Contoh di Word”

Ketik tag sebagai teks biasa di tempat kolom seharusnya berada:

Signed for the client:


[[sign:Client]]


Name: [[name:Client]]          Date: [[date:Client]]
Company: [[company:Client]]
Purchase order: [[text:Client:PO number;optional]]


[[check:Client:Terms]] I have read and accept the terms.


Signed for the supplier:


[[sign:Supplier;w=180;h=50]]
Initials on every page: [[initials:Supplier]]

Saat Anda menambahkan dokumen ini ke permintaan, dokumen itu memiliki dua slot, Client dan Supplier. Berikan setiap slot kepada seorang penerima, dan semua kolom dengan peran itu menjadi milik orang tersebut. Dari API, atur autoTags: true dan berikan slot kepada setiap penerima.

Tag berfungsi sama di file PDF, Word, Excel, atau PowerPoint, maupun di template AutomaDoc: proses pembuatan dokumen tidak menyentuh kurung siku, sehingga dokumen yang dibuat dari template bertag masuk ke permintaan dengan kolom yang siap ditempatkan. Itulah sebabnya tag memakai [[ ]], bukan { } milik placeholder template.

Tata bahasa

Section titled “Tata bahasa”
[[ kind : role ]]
[[ kind : role : label ]]
[[ kind : role ; option ; option ]]
[[ kind : role : label ; option ]]

Kind (huruf besar atau kecil) menentukan jenis kolom:

Kind Bisa juga ditulis Kolom
sign signature Tanda tangan
initials initial Paraf
name Nama
date Tanggal tanda tangan (diisi otomatis)
text Teks
check checkbox Kotak centang
company Perusahaan
email Email

Role adalah slot pemilik kolom: 1 sampai 60 huruf, angka, tanda aksen, atau garis bawah, dalam aksara apa pun (Client, Witness_1, 客户). Tanpa spasi. Huruf besar dan kecil dibedakan: Client dan client adalah dua slot. Tanda # yang diikuti angka setelah peran dicadangkan untuk keperluan AutomaDoc sendiri.

Label, opsional, berisi 1 sampai 100 karakter yang ditampilkan kepada penanda tangan sebagai nama kolom, misalnya [[text:Client:PO number]]. Label tidak boleh memuat [, ], ;, atau :.

Option, masing-masing setelah ;, dengan huruf besar atau kecil:

Option Arti
w=180 Lebar dalam poin (1 poin = 1/72 inci), dari 8 sampai 1000, hingga dua angka desimal
h=50 Tinggi dalam poin, dari 8 sampai 1000
optional Penanda tangan boleh membiarkan kolom kosong
required Penanda tangan wajib mengisinya (bawaan)

Spasi dan baris baru diperbolehkan di sekitar setiap bagian, jadi [[ sign : Client ]] berfungsi, begitu pula tag yang terpotong ke baris kedua di antara dua bagiannya. Baris baru di tengah kata (misalnya di tengah Client) membuat tag tidak terbaca.

Panjang tag paling banyak 200 karakter dari [[ sampai ]]. Jika lebih panjang, atau tanpa ]] penutup, tag dianggap teks biasa dan diabaikan.

Letak kolom

Section titled “Letak kolom”

Sudut kiri atas kolom adalah sudut kiri atas tag. Ukurannya adalah w dan h dari tag, atau jika tidak ada, ukuran bawaan kolom (dalam poin: tanda tangan 160 × 48, paraf 64 × 40, kotak centang 14 × 14, email 180 × 20, tanggal 110 × 20, kolom teks lainnya 160 × 20). Tanpa h, kolom tidak pernah lebih pendek dari teks tagnya. Kolom yang akan keluar dari halaman dipindahkan ke dalamnya.

Jadi sisakan ruang di sebelah kanan dan di bawah setiap tag: kolom tanda tangan menjangkau 48 poin (sekitar 1,7 cm) ke bawah dari bagian atas tagnya.

Jika ada yang salah

Section titled “Jika ada yang salah”

[[…]] yang tidak mengikuti tata bahasa tidak pernah ditebak: teks itu tetap tampil di halaman, tidak ada kolom yang dibuat, dan pengirim diperingatkan dengan menampilkan tag seperti yang ditulis (50 pertama per dokumen). Penyebab yang umum adalah peran yang hilang, spasi di dalam peran, kind atau option yang tidak dikenal, atau ukuran di luar rentang 8 sampai 1000.

Batas lainnya:

  • paling banyak 500 tag per halaman yang dibaca, dan 500 per dokumen; selebihnya diabaikan dengan peringatan;
  • hanya teks yang benar-benar ada di PDF yang dicari: halaman hasil pindaian adalah gambar, dan tag di dalamnya tidak ditemukan;
  • tag yang perannya tidak diberikan kepada penerima mana pun tidak menghasilkan kolom. Permintaan tidak dapat dikirim jika ada penanda tangan yang tidak punya kolom sama sekali.

Menerapkan tag lagi akan mengganti kolom yang dibuat dari tag. Kolom yang Anda tempatkan secara manual tetap ada.

Anchor dari API

Section titled “Anchor dari API”

Anchor menempatkan kolom relatif terhadap teks yang sudah ada di dokumen, misalnya “Client signature:”. Anchor ditujukan untuk dokumen yang tidak dapat Anda ubah. Anchor adalah bagian dari POST /api/v1/envelopes (lihat API Envelopes). Di sini permintaan dikirim sebagai multipart/form-data: JSON ini di bagian bernama envelope, dan PDF-nya di bagian bernama contract.

{
  "title": "Service agreement",
  "documents": [{ "file": "contract" }],
  "recipients": [
    { "key": "client", "role": "signer", "name": "Ana Lim", "email": "ana@example.com" }
  ],
  "anchors": [
    { "anchor": "Client signature:", "recipient": "client", "type": "signature", "offsetY": 14 },
    { "anchor": "Date:", "occurrence": 2, "recipient": "client", "type": "date_signed", "offsetX": 30, "offsetY": -2 }
  ],
  "send": true
}
Properti
anchor Teks yang dicari, 1 sampai 200 karakter. Wajib.
recipient key dari seorang penerima dalam permintaan yang sama. Wajib.
type signature, initials, name, date_signed, text, checkbox, company, atau email. Wajib.
occurrence "all" (bawaan) atau sebuah angka: kecocokan ke-1, ke-2, dan seterusnya di seluruh permintaan.
offsetX, offsetY Jarak dalam poin dari sudut kiri atas teks yang cocok, dari -2000 sampai 2000. Nilai positif bergeser ke kanan dan ke bawah. Bawaan 0.
w, h Ukuran dalam poin, dari 8 sampai 1000. Bawaan: ukuran jenis kolomnya.
required true secara bawaan.
label Ditampilkan kepada penanda tangan sebagai nama kolom.

Satu permintaan dapat memuat hingga 50 anchor.

Cara teks dicocokkan

Section titled “Cara teks dicocokkan”
  • Persis dan membedakan huruf besar dan kecil: Signature: tidak cocok dengan signature: atau Signature.
  • Setiap deretan spasi, tab, atau baris baru di anchor cocok dengan deretan apa pun dari karakter itu di dokumen, karena teks PDF tidak menyimpan spasi secara andal. Spasi di awal atau akhir anchor diabaikan.
  • Kecocokan tidak pernah tumpang tindih.
  • Kemunculan dihitung di seluruh permintaan sesuai urutan baca: dokumen sesuai urutannya, lalu halaman demi halaman, dari atas ke bawah, dari kiri ke kanan. "occurrence": 2 adalah kecocokan kedua di mana pun dalam permintaan, bukan kecocokan kedua di setiap halaman.
  • Paling banyak 200 kecocokan per anchor. Lebih dari itu dianggap kesalahan: tulis anchor yang lebih panjang.

Anchor yang tidak cocok dengan apa pun tidak menghasilkan kolom, dan dokumen mencatat peringatan anchor_not_found. Seperti pada tag, kolom anchor yang akan keluar dari halaman dipindahkan ke dalamnya, dan penanda tangan yang tidak punya kolom sama sekali membuat permintaan tidak dapat dikirim: GET /api/v1/envelopes/:id lalu melaporkan alasannya di sendError.

Anda dapat menggabungkan kolom berdasarkan koordinat, tag (autoTags), dan anchor dalam satu permintaan, hingga total 500 kolom.