将文档添加到草稿信封中而无需签名HereTabs

时间:2019-03-25 16:52:34

标签: docusignapi

我们正在使用REST API的Java库开发一种对多个文档进行签名的过程,其中使用signHereTabs中的anchorString为每个签名者设置签名位置(anchorString是插入要签名的文档中的字符串); 由于我们的文档大小大于25MB,因此我们使用https://developers.docusign.com/esign-rest-api/guides/resource-limits中报告的内容,即,我们创建了草稿信封(状态=已创建),然后用文件更新了信封; 问题在于,当我们将信封的状态设置为“已发送”时,签名者会收到电子邮件,打开指向DocuSign的链接,但是只有第一个文档允许访问anchorString。 是否有任何特定方法可以更新信封草稿中的文档列表?

谢谢

...

// add a recipient to sign the document, identified by name and email we used above
int recipientId = 0;
List<Signer> signerList = new ArrayList<Signer>();

/* to fix the position where the signature has to be inserted */
int buyerIdx = 0;
int supplierIdx = 0;
for(DSSignerInfo signerInfo : signers) {
  Tabs tabs = new Tabs();

  Signer signer = new Signer();
  signer.setEmail(signerInfo.getEmail());
  signer.setName(signerInfo.getName());
  signer.setRecipientId(String.valueOf(++recipientId));
  signer.setRoutingOrder(String.valueOf(recipientId)); // sequential
  signer.setRoleName("role unknown");

  RecipientEmailNotification emailNotification = new RecipientEmailNotification();
  emailNotification.setEmailBody("emailBody - "+signerInfo.getName());
  emailNotification.setEmailSubject("emailSubject - "+signerInfo.getName());
  emailNotification.setSupportedLanguage(signerInfo.getLanguage());
  signer.setEmailNotification(emailNotification);

  // create a signHere tab somewhere on the document for the signer to sign
  // default unit of measurement is pixels, can be mms, cms, inches also
  for(int documentId = 1; documentId <= documentFiles.size(); documentId++) {
    SignHere signHere = new SignHere();
    signHere.setDocumentId("" + documentId);
    signHere.setPageNumber("1");
    signHere.setRecipientId(String.valueOf(recipientId));

    if(signerInfo.getRole().equalsIgnoreCase("buyer")) {
      signHere.setAnchorString("BUYER_"+buyerIdx);
    } else {
      signHere.setAnchorString("SUPPLIER_"+supplierIdx);
    }
    signHere.setAnchorXOffset("10");
    signHere.setAnchorYOffset("10");
    tabs.addSignHereTabsItem(signHere);
  }
  signer.setTabs(tabs);
  signerList.add(signer);
  if(signerInfo.getRole().equalsIgnoreCase("buyer")) {
    buyerIdx++;
  } else {
    supplierIdx++;
  }
}
Recipients recipients = new Recipients();
recipients.setSigners(signerList);
envDef.setRecipients(recipients);

try {
  String envelopeId = null;
  EnvelopesApi envelopesApi = null;

  // create a byte array that will hold our document bytes
  int documentId = 1;
  for(String documentFile : documentFiles) {
    byte[] fileBytes = null;
    try {
      // read file
      Path path = Paths.get(documentFile);
      fileBytes = Files.readAllBytes(path);
    } catch (IOException ioExcp) {
      // handle error
      System.out.println("Exception: " + ioExcp);
      return null;
    }

    // add a document to the envelope
    Document doc = new Document();
    String base64Doc = Base64.getEncoder().encodeToString(fileBytes);
    doc.setDocumentBase64(base64Doc);
    String fileName = new File(documentFile).getName();
    doc.setName(documentId+"_"+fileName);
    doc.setFileExtension(fileName.lastIndexOf('.') > 0 ? fileName.substring(fileName.lastIndexOf('.') + 1) : "");
    doc.setDocumentId("" + documentId++);

    envDef.addDocumentsItem(doc);

    if(envelopeId == null || envelopesApi == null) {
      // To save as a draft set to "created" (for test purpose I create and envelope with only one file)
      envDef.setStatus("created");
      envelopesApi = new EnvelopesApi();
      EnvelopeSummary envelopeSummary = envelopesApi.createEnvelope(accountId, envDef);
      envelopeId = envelopeSummary.getEnvelopeId();
    } else {
      // the files after the 1st are updated in the draft envelope
      envDef.setRecipients(recipients);
      List<Document> tmpDocumentList = new ArrayList<Document>();
      doc.setApplyAnchorTabs("true");
      tmpDocumentList.add(doc);
      envDef.setDocuments(tmpDocumentList);
      EnvelopeDocumentsResult envelopeDocumentsResult = envelopesApi.updateDocuments(accountId, envelopeId, envDef);
    }
  }
  Envelope envelope = envelopesApi.getEnvelope(accountId, envelopeId);
  envelope.setStatus("sent");
  envelope.setPurgeState(null);
  EnvelopesApi.UpdateOptions uo = envelopesApi. new UpdateOptions();
  uo.setAdvancedUpdate("true");
  EnvelopeUpdateSummary envelopeUpdateSummary = envelopesApi.update(accountId, envelopeId, envelope, uo);

  documentId = 1;
  for(String documentFile : documentFiles) {
    Tabs tabs = envelopesApi.getDocumentTabs(accountId, envelopeId, ""+documentId++);
    System.out.println("CARLO Tabs 3, documentId "+(documentId - 1)+": "+tabs);
  }

感谢您的回答。 更多细节: 信封里有不止一份文件; 每个文档的大小小于25MB; 所有文档的大小总和超过25MB。 我们可以使用状态为“已创建”的信封上载文档,但是当状态更改为“已发送”并且签名者进入签名页面时,则不需要对这些文档进行签名;信封状态为“创建”时,似乎添加的文档中未设置signHereTabs。

如果在设置信封状态=“发送”之后,我们执行以下代码

documentId = 1;
for(String documentFile : documentFiles) {
    Tabs tabs = envelopesApi.getDocumentTabs(accountId, envelopeId, ""+documentId++);
    System.out.println("Tabs: documentId "+(documentId - 1)+": "+tabs);
}

我们获得

标签:documentId 1:类标签{     ...     signHereTabs:[class SignHere {         anchorCaseSensitive:null         anchorHorizo​​ntalAlignment:null         anchorIgnoreIfNotPresent:null         anchorMatchWholeWord:null         anchorString:BUYER_0         anchorUnits:像素         anchorXOffset:10         anchorYOffset:-10         conditionalParentLabel:空         conditionalParentValue:null         customTabId:null         documentId:1         errorDetails:null         mergeField:null         名称:SignHere         可选:false         pageNumber:1         收件人ID:edb96dfd-9700-4328-ba45-825a1284b030         scaleValue:1.0         stampType:签名         stampTypeMetadata:null         状态:空         tabId:e484087c-70c2-431c-9825-47605e1f44c2         tabLabel:在此处签名         tabOrder:null         templateLocked:null         templateRequired:null         工具提示:null         x位置:123         y位置:297     }]     ... } 制表符:documentId 2:类制表符{     ...     signHereTabs:[]     ... }

其中在创建信封(状态为“ created”)时已上载documentId 1,并且在第二步中已上载documentId 2(documentId 1和2均包含anchorString:BUYER_0)。

3 个答案:

答案 0 :(得分:1)

如果您的文档大小大于25MB,那么将文档置于草稿模式也无济于事,相反,您必须使用ChunkedUploads添加任何小于50MB的文档。如果您的JSON请求有效载荷大于25 MB,则通过草稿添加多个文档很有用,但是如果信封中的任何文档大于25 MB,则无用。

答案 1 :(得分:0)

要添加到Amit的答案中,对DocuSign的每个单独的API请求都必须小于25MB。

由于默认技术是在JSON对象中发送Base64编码的文档,所以在单个请求中发送的所有文档的有效最大总大小约为18MB。

您可以通过将API请求作为多部分MIME消息发送来避免Base64开销。此技术使您可以将文档作为二进制对象发送。请参见scenario 10 in C#的代码示例(也可用于PHP,Java,Node.js,Python和Ruby)

其他

如果每个文档都小于18 MB,则可以使用“常规” JSON对象,并且Base64一次可以编码一个文档。如果文档大小总和大于18MB,则必须一次上传一个文件:

  1. 创建信封,包括其中一个文档。文档状态应为created,因此此时不发送信封。
  2. 将更多文档一次添加到信封中。您可以使用EnvelopeDocuments::updateList API方法。您可能希望打开查询参数apply_document_fields
  3. 使用Envelopes::update将信封状态更新为sent

要在文档中添加标签,如果使用定位标签定位,则可以在开始时定义它们。或者,您可以在将文档添加到信封中之后将选项卡添加到信封定义中。

答案 2 :(得分:0)

谢谢大家的回答。 我已经通过这种方式解决了这个问题: -步骤2:在每个已添加文件的参数apply_document_fields上进行设置, -步骤3:在将信封设置为“已发送”之前,再次在信封中设置收件人。 我认为这个问题已经解决。