Seol Baisce Doiciméad

Buaileann batch roinnt doiciméad isteach i n-ibhirt amháin. Is féidir le gach doiciméad dul chuig faighteoirí éagsúla agus teimpléad éagsúil a úsáid. Rialóidh tú an t-ord doiciméad a sheoltear agus an ndéantar fógra a chur ar sínitheoirí nuair a chríochnaíonn doiciméid níos luaithe sa batch.

Tá an taithí sínithe do bhataí difriúil freisin ó sheoladh caighdeánach doiciméid. Taispeántar don síníoirí na doiciméid eile sa batch mar chuid dá bpróiseas sínithe, rud a thugann léargas dóibh ar an tsraith iomlán doiciméad ar chóir dóibh a shíniú. Tá sé fós á rialú ag sequentialSigning (an t-ord ina síníonn páirtithe laistigh deiciméad amháin) agus enforceOrder (an t-ord ina scaoiltear doiciméid laistigh den batch) cathain agus an féidir le síniú amháin gníomh a dhéanamh ar gach doiciméad. Féach The four batching workflows le haghaidh mionchuidithe iomlán ar an mbealach a chomhcheanglaíonn na socruithe seo beirt.

Is iad na trí chéim sa phróiseas:

1. Cruthaigh an batch — faigh aitheantas batch
2. Cuir doiciméid leis an batch — athrú amháin in aghaidh gach doiciméid
3. Tosaigh an batch — spreagann seoladh

Prerequisites

• Cuntas Legalesign le rochtain API agus do chuid cruthaithe go fíordheimhnithe (féach authenticate)
• Ar a laghad teimpléad amháin le róil cumraithe, agus a aitheantas teimpléid
• D’aitheantas grúpa

Step 1: Create the Batch

Glaoigh ar sendBatch chun an batch a thosú agus aitheantas batch a fháil. Úsáidfidh tú an aitheantas seo i ngach glao ina dhiaidh sin.

mutation CreateBatch {
  sendBatch(input: {
    batchName: "August contracts"
    groupId: "Z3JwWW91ckdyb3VwSWQ="
    enforceOrder: true
    notifySender: true
    notifySenderAttach: false
    notifyParticipants: true
    notifyParticipantsAttach: false
  })
}

Freagra:

{
  "data": {
    "sendBatch": "dHNrWW91ckJhdGNoSWQtMDAwMC0wMDAwLTAwMDAtMDAwMDAwMDAwMDAw"
  }
}

Coimeád an t-aitheantas a ghnótar — seo é do batchId do gach glao ina dhiaidh sin.

Réimsí tábhachtacha:

• enforceOrder: true — seoltar na doiciméid de réir an tsolaiseáin sendOrder; ní sheoltar an doiciméad seoil ach tar éis an doiciméid roimhe sin a chríochnú
• notifySender / notifyParticipants — rialáil fógraí ríomhphoist nuair a chríochnaítear
• notifySenderAttach / notifyParticipantsAttach — an gcuirtear an PDF sínithe le na fógraí sin

Féach SendBatchInput le haghaidh na réimsí go léir.

Step 2: Add Documents to the Batch

Glaoigh ar sendBatchDocument uair amháin do gach doiciméad. Úsáid sendOrder chun an t-ord a rialú (tús le 0).

Doiciméad chéad ceann (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
        }
      ]
    }
  })
}

Freagra:

{
  "data": {
    "sendBatchDocument": "dHNrWW91ckJhdGNoSWQtMDAwMC0wMDAwLTAwMDAtMDAwMDAwMDAwMDAw"
  }
}

Aisghlaonn an freagra an batchId — ní aitheantas don doiciméad é.

Doiciméad dara ceann (sendOrder: 1)

Athdhéan an t-athrú le teimpléad eile, sendOrder: 1, agus faighteoirí céanna nó éagsúla:

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
        }
      ]
    }
  })
}

Cuir isteach chomh leor doiciméad agus is gá sula dtéann tú go dtí Céim 3.

leide

Is féidir le gach doiciméad teimpléad difriúil agus faighteoirí difriúla a úsáid. Socraíonn an luach sendOrder an t-ord nuair atá enforceOrder true.

Féach SendBatchDocumentInput le haghaidh na réimsí go léir. Leanann an réad document i bhfolach na rialacha fíordheimhniú céanna le DocumentSendSettingsInput.

Step 3: Start the Batch

Nuair a chuirtear na doiciméid uile leis, glaoigh ar startBatch chun an batch a mharcáil mar réidh. Spreagann sé seo an seoladh.

mutation StartBatch {
  startBatch(input: {
    batchId: "dHNrWW91ckJhdGNoSWQtMDAwMC0wMDAwLTAwMDAtMDAwMDAwMDAwMDAw"
    groupId: "Z3JwWW91ckdyb3VwSWQ="
  })
}

Freagra:

{
  "data": {
    "startBatch": "dHNrWW91ckJhdGNoSWQtMDAwMC0wMDAwLTAwMDAtMDAwMDAwMDAwMDAw"
  }
}

Tar éis startBatch, cuireann Legalesign na doiciméid i gclár feithimh. Má tá enforceOrder true, seoltar an chéad doiciméad (sendOrder: 0) láithreach agus coinnítear na doiciméid ina dhiaidh sin go dtí go gcomhlíonann an ceann roimhe sin iad.

Tracking Batch Progress

Tá radharc tiomnaithe ag bataí freisin sa aip Gréasáin Legalesign, a thugann forlíontóir cothrom le dáta duit ar na doiciméid go léir sa batch agus a stádas sínithe — úsáideach chun dul chun cinn a mhonatóireacht gan fiosrú an API.

Chun stádas batch a fhiosrú go cliste, bain úsáid as an batch ID:

query GetBatch {
  batch(id: "dHNrWW91ckJhdGNoSWQtMDAwMC0wMDAwLTAwMDAtMDAwMDAwMDAwMDAw") {
    id
    status
    documents {
      edges {
        node {
          id
          title
          status
        }
      }
    }
  }
}

Is féidir leat síntiúis a úsáid freisin chun nuashonruithe fíor-ama a fháil — féach Track Document and Recipient Lifecycle with Subscriptions.

Related

• sendBatch
• sendBatchDocument
• startBatch
• SendBatchInput
• SendBatchDocumentInput
• Batch type
• Troubleshoot Send Validation