Leum gu prìomh susbaint

Cuir Sreath de Thagraidhean

Bidh batch a’ buidheachadh grunn sgrìobhainnean ann an aon ghnìomh-sgaoileadh. Faodaidh gach sgrìobhainn a dhol gu diofar luchd-faighinn agus a chleachdadh teamplaid eadar-dhealaichte. Bidh thu ag smachdachadh air òrdugh cuir a-mach nan sgrìobhainnean agus a bheil luchd-sgrìobhaidh air am fiosrachadh nuair a bhios sgrìobhainnean nas tràithe anns a’ bhathach deiseil.

Tha an eòlas-sgrìobhaidh airson bathain cuideachd eadar-dhealaichte bho chur a-mach sgrìobhainn àbhaisteach. Thèid na sgrìobhainnean eile anns a’ bhathach a thaisbeanadh do luchd-sgrìobhaidh mar phàirt den t-sruth sgrìobhaidh aca, a’ toirt seachad follaiseachd dhaibh air an t-sreath iomlan de sgrìobhainnean a dh’ fheumas iad a shoidhnigeadh. Tha smachd fhathast aig sequentialSigning (òrdugh a bhios pàrtaidhean a’ soidhnigeadh taobh a-staigh aon sgrìobhainn) agus enforceOrder (òrdugh a bheir air sgrìobhainnean a bhith air an cur a-mach anns a’ bhathach) air cuin agus an gabh neach-sgrìobhaidh gnothach a dhèanamh air gach sgrìobhainn. Faic The four batching workflows airson mìneachadh làn air mar a tha na roghainnean seo ag obair còmhla.

Tha am pròiseas triùir cheumannan:

  1. Cruthaich am bathach — faigh ID bathach
  2. Cuir sgrìobhainnean ris a’ bhathach — aon atharrachadh gach sgrìobhainn
  3. Tòisich am bathach — cuir sgaoileadh gu bàs

Prerequisites​

  • Cunntas Legalesign le cothrom API agus na creideasan dearbhaidh agad (faic authenticate)
  • Co-dhiù aon teamplaid le dreuchdan rèiteachadh, agus an ID teamplaid aige
  • Do ID buidhne

Step 1: Create the Batch​

Cuir sendBatch an gnìomh gus am bathach a thòiseachadh agus ID bathach fhaighinn. Cleachdaidh tu an ID seo anns a h-uile gairm a leanas.

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

Response:

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

Cùm an ID a thillidh — is e seo an batchId agad airson a h-uile gairm às dèidh sin.

Raointean cudromach:

  • enforceOrder: true — thèid sgrìobhainnean a chur ann an òrdugh sendOrder; cha thèid an ath sgrìobhainn a chur a-mach gus an tè a bh’ ann roimhe a chrìochnachadh
  • notifySender / notifyParticipants — smachd air fiosan post-d nuair a bhios crìoch air
  • notifySenderAttach / notifyParticipantsAttach — an tèid am PDF foirmeil a chur ris na fiosan sin

Faic SendBatchInput airson gach raon.

Step 2: Add Documents to the Batch​

Cuir sendBatchDocument a-steach aon turas airson gach sgrìobhainn. Cleachd sendOrder gus an òrdugh smachdachadh (tòiseachadh aig 0).

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"
  }
}

Tha an freagairt a’ nochdadh an batchId a-rithist — chan ann ID sgrìobhainn.

Second document (sendOrder: 1)​

Dèan an atharrachadh a-rithist le teamplaid eadar-dhealaichte, sendOrder: 1, agus luchd-faighinn an aon rud no eadar-dhealaichte:

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 ris an àireamh de sgrìobhainnean a tha feumach mus gluais thu gu Ceum 3.

comhairle

Faodaidh gach sgrìobhainn teamplaid eadar-dhealaichte agus luchd-faighinn eadar-dhealaichte a chleachdadh. Bidh luach sendOrder a’ dearbhadh an t-sreath nuair a tha enforceOrder true.

Faic SendBatchDocumentInput airson gach raon. Tha an nì document a tha fo-thogte a’ cumail ris na riaghailtean dearbhaidh mar DocumentSendSettingsInput.

Step 3: Start the Batch​

Nuair a bhios na sgrìobhainnean uile air an cur ris, cuir startBatch gus am bathach a chomharrachadh mar deiseil. Bidh seo a’ brosnachadh a’ chuirt-allaidh.

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

Response:

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

An dèidh startBatch, thèid na sgrìobhainnean a chur air clàr ann an Legalesign. Ma tha enforceOrder true, thèid a’ chiad sgrìobhainn (sendOrder: 0) a chur a-mach sa bhad agus thèid na sgrìobhainnean às dèidh sin a chumail gus an tè roimhe crìochnaichte.

Tracking Batch Progress​

Tha sealladh sònraichte aig bathain anns an app lìn Legalesign, a’ toirt sealladh coileanta air na sgrìobhainnean uile anns a’ bhathach agus an staid sgrìobhaidh aca — feumail airson a bhith a’ cumail sùil air adhartas gun a bhith a’ cleachdadh API.

Gus inbhe an bathach a cheasnachadh gu prògramaichte, cleachd ID a’ bhathach:

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

Faodaidh tu cuideachd fo-sgrìobhaidhean a chleachdadh airson ùrachaidhean beò a bhith agad — faic Track Document and Recipient Lifecycle with Subscriptions.

Export This Article

Save a copy of this page as PDF or plain text.