Anfon Swmp o Ddogfennau
Batch yw grŵp o ddogfennau lluosog mewn un weithred anfon. Gall pob dogfen fynd at dderbynyddion gwahanol a defnyddio templed gwahanol. Reolaist yr urddas y caiff dogfennau eu hanfon a pha un sy'n cael rhybudd pan fydd dogfennau cynharach yn y batch wedi'u cwblhau.
Mae'r profiad llofnodi ar gyfer batch hefyd yn wahanol i anfon dogfen safonol. Rhoddir i lofnodwyr weld y dogfennau eraill yn y batch fel rhan o'u llif llofnodi, gan roi gweledigaeth iddynt o'r set lawn o ddogfennau y mae eu hangen arnynt i'w llofnodi. Mae'n parhau i fod yn cael ei reoli gan sequentialSigning (urddas y partïon sy'n llofnodi o fewn un ddogfen) a enforceOrder (urddas rhyddhau dogfennau o fewn y batch) pa bryd a pha un sy'n gallu gweithredu ar bob dogfen. Gweler The four batching workflows am dorriad llawn o sut y mae'r ddwy osodiad hyn yn cyfuno.
Mae'r broses yn dair cam:
- Creu'r batch — cael ID batch
- Ychwanegu dogfennau i'r batch — un mutasiwn fesul dogfen
- Dechrau'r batch — yn sbarduno anfon
Prerequisites
- Cyfrif Legalesign gyda mynediad API a'ch manylion dilysu (gweler authenticate)
- O leiaf un templed gyda rolau wedi'u ffurfweddu, a'i ID templed
- Eich ID grŵp
Step 1: Create the Batch
Galwch sendBatch i gychwyn y batch a derbyn ID batch. Byddwch yn defnyddio'r ID hwn ym mhob galwad dilynol.
mutation CreateBatch {
sendBatch(input: {
batchName: "August contracts"
groupId: "Z3JwWW91ckdyb3VwSWQ="
enforceOrder: true
notifySender: true
notifySenderAttach: false
notifyParticipants: true
notifyParticipantsAttach: false
})
}
Response:
{
"data": {
"sendBatch": "dHNrWW91ckJhdGNoSWQtMDAwMC0wMDAwLTAwMDAtMDAwMDAwMDAwMDAw"
}
}
Cadwch yr ID a ddychwelwyd — hwn yw'ch batchId ar gyfer pob galwad nesaf.
Meini allweddol:
enforceOrder: true— caiff dogfennau eu hanfon yn ôl urddassendOrder; dim dogfen nesaf yn cael ei hanfon nes bod y dogfen flaenorol wedi'i chwblhaunotifySender/notifyParticipants— rheoli hysbysiadau e-bost ar gwblhaunotifySenderAttach/notifyParticipantsAttach— a yw'r PDF wedi'i lofnodi i'w atodi at yr hysbysiadau hynny
Gweler SendBatchInput am yr holl feysydd.
Step 2: Add Documents to the Batch
Galwch sendBatchDocument unwaith i bob dogfen. Defnyddiwch sendOrder i reoli'r urddas (cyfrif o sero).
First document (sendOrder: 0)
mutation AddDocumentToBatch {
sendBatchDocument(input: {
batchId: "dHNrWW91ckJhdGNoSWQtMDAwMC0wMDAwLTAwMDAtMDAwMDAwMDAwMDAw"
sendOrder: 0
document: {
title: "Service Agreement"
templateId: "dHBsWW91clRlbXBsYXRlSWQtMDAwMC0wMDAwLTAwMDA="
groupId: "Z3JwWW91ckdyb3VwSWQ="
tag: ""
pdfPassword: ""
retainPdfPassword: false
allowPrinting: true
allowCopying: true
sequentialSigning: true
documentCCEmail: []
senderFields: [
{ id: "ZWxlWW91clNlbmRlckZpZWxkSWQ=", value: "Acme Ltd" }
]
participantFields: [
{ id: "ZWxlUGFydGljaXBhbnRGaWVsZDE=", value: "" }
{ id: "ZWxlUGFydGljaXBhbnRGaWVsZDI=", value: "" }
{ id: "ZWxlUGFydGljaXBhbnRGaWVsZDM=", value: "" }
]
recipients: [
{
order: 0
signerIndex: 1
roleId: "cm9sWW91clJvbGVJZA=="
experience: "ZXhwWW91ckV4cGVyaWVuY2VJZA=="
firstName: "Alex"
lastName: "Taylor"
email: "alex.taylor@example.com"
phoneNumber: ""
expiryDate: null
timeZone: "Europe/London"
skipped: false
}
]
}
})
}
Response:
{
"data": {
"sendBatchDocument": "dHNrWW91ckJhdGNoSWQtMDAwMC0wMDAwLTAwMDAtMDAwMDAwMDAwMDAw"
}
}
Mae'r ymateb yn adlewyrchu'r batchId yn ôl — nid ID dogfen.
Second document (sendOrder: 1)
Ailadroddwch y mutasiwn gyda templed gwahanol, sendOrder: 1, a derbynyddion yr un fath neu wahanol:
mutation AddDocumentToBatch {
sendBatchDocument(input: {
batchId: "dHNrWW91ckJhdGNoSWQtMDAwMC0wMDAwLTAwMDAtMDAwMDAwMDAwMDAw"
sendOrder: 1
document: {
title: "Data Processing Agreement"
templateId: "dHBsWW91clNlY29uZFRlbXBsYXRlSWQ="
groupId: "Z3JwWW91ckdyb3VwSWQ="
tag: ""
pdfPassword: ""
retainPdfPassword: false
allowPrinting: true
allowCopying: true
sequentialSigning: true
documentCCEmail: []
senderFields: [
{ id: "ZWxlU2VuZGVyRmllbGRBMQ==", value: "" }
{ id: "ZWxlU2VuZGVyRmllbGRBMg==", value: "Acme Ltd" }
]
participantFields: [
{ id: "ZWxlUGFydGljaXBhbnRGaWVsZEEx", value: "" }
{ id: "ZWxlUGFydGljaXBhbnRGaWVsZEEy", value: "" }
{ id: "ZWxlUGFydGljaXBhbnRGaWVsZEEz", value: "" }
]
recipients: [
{
order: 0
signerIndex: 1
roleId: "cm9sU2Vjb25kUm9sZUlk"
experience: "ZXhwWW91ckV4cGVyaWVuY2VJZA=="
firstName: "Alex"
lastName: "Taylor"
email: "alex.taylor@example.com"
phoneNumber: ""
expiryDate: null
timeZone: "Europe/London"
skipped: false
}
]
}
})
}
Ychwanegwch gymaint o ddogfennau ag sydd eu hangen cyn symud at Cam 3.
Gall pob dogfen ddefnyddio templed a derbynyddion gwahanol. Mae gwerth sendOrder yn penderfynu'r drefn pan fo enforceOrder yn true.
Gweler SendBatchDocumentInput am yr holl feysydd. Mae gwrthrych cyfun document yn dilyn yr un rheolau dilysu â DocumentSendSettingsInput.
Step 3: Start the Batch
Unwaith y bydd pob dogfen wedi cael ei hychwanegu, galwch startBatch i nodi bod y batch yn barod. Mae hyn yn sbarduno'r anfon.
mutation StartBatch {
startBatch(input: {
batchId: "dHNrWW91ckJhdGNoSWQtMDAwMC0wMDAwLTAwMDAtMDAwMDAwMDAwMDAw"
groupId: "Z3JwWW91ckdyb3VwSWQ="
})
}
Response:
{
"data": {
"startBatch": "dHNrWW91ckJhdGNoSWQtMDAwMC0wMDAwLTAwMDAtMDAwMDAwMDAwMDAw"
}
}
Ar ôl startBatch, mae Legalesign yn rhestri'r dogfennau i'w hanfon. Os yw enforceOrder yn true, bydd y ddogfen gyntaf (sendOrder: 0) yn cael ei hanfon yn syth a bydd dogfennau dilynol yn cael eu dal nes bod y dogfen flaenorol wedi'i chwblhau.
Tracking Batch Progress
Mae gan batchi eu golwg neilltuol eu hunain yn y Legalesign web app, gan roi trosolwg cyfannol o'r holl ddogfennau yn y batch a'u statws llofnodi — yn ddefnyddiol i olrhain cynnydd heb holi'r API.
I holi statws batch yn raglenedig, defnyddiwch ID batch:
query GetBatch {
batch(id: "dHNrWW91ckJhdGNoSWQtMDAwMC0wMDAwLTAwMDAtMDAwMDAwMDAwMDAw") {
id
status
documents {
edges {
node {
id
title
status
}
}
}
}
}
Gallwch hefyd ddefnyddio tanysgrifio i dderbyn diweddariadau mewn amser real — gweler Track Document and Recipient Lifecycle with Subscriptions.