cancel
Showing results for 
Search instead for 
Did you mean: 
Reply
NordKapp
Frequent Visitor

View custom fields with DocuSign: When an envelope status changes (Connect) Trigger

Hi,

I’m working on a flow using the DocuSign: When an envelope status changes (Connect) trigger. My goal is to file a completed document on SharePoint, after pulling the custom fields in the envelope and assigning them as metadata fields. I’ve unit tested all parts of the flow, except I’m unable to recognize custom fields. I’m following the provided example (page 4).

 

Here's what my flow looks like:a.png

 

My Docusign Template has multiple custom fields, but they are not being returned when the flow triggers:

b.PNG

 

Oddly enough, the custom fields are showing up in the trigger output for RecipientStatus > "TabStatuses":

"TabStatuses": {
      "TabStatus": [
        {
          "TabType": "FullName",
          "Status": "Signed",
          "XPosition": "144",
          "YPosition": "1192",
          "TabLabel": "Name bcd3ee67-8ff1-47b6-9b09-26e4cd59bbe1",
          "TabName": "FullName",
          "TabValue": "test",
          "DocumentID": "1",
          "PageNumber": "2"
        },
        {
          "TabType": "Title",
          "Status": "Signed",
          "XPosition": "144",
          "YPosition": "1275",
          "TabLabel": "Title 184a7b62-ebdf-4ff2-bcbd-510331c6f5de",
          "TabName": null,
          "TabValue": "test",
          "DocumentID": "1",
          "PageNumber": "2"
        },
        {
          "TabType": "Custom",
          "Status": "Signed",
          "XPosition": "146",
          "YPosition": "1533",
          "TabLabel": "NDAType",
          "TabName": "MNDA;UNDA",
          "TabValue": "MNDA",
          "DocumentID": "1",
          "PageNumber": "2",
          "OriginalValue": "MNDA",
          "ListValues": "MNDA;UNDA",
          "ListSelectedValue": "MNDA",
          "CustomTabType": "List"
        },

 I was able to pull the fields from RecipientStatus using something like: 

triggerBody()?['DocuSignEnvelopeInformation']?['EnvelopeStatus']?['RecipientStatuses']?['RecipientStatus'][0]['status']

The issue is that the trigger fires every time an envelope is completed, and the arrays aren't always in the same order and I'd need to implement some extensive error checking or lookup, which isn't easy to do in Flow...

 

Has anyone successfully used the custom fields functionality of this trigger before? If I could pull the fields in the way shown by the docusign example (linked above), this flow would be way more reliable.

 

Thanks!

1 ACCEPTED SOLUTION

Accepted Solutions

Would you please post the expression in the initiailze variable step?

Also, they gave me two options for calling the custom fields, see full ticket text below:

 

The trigger output expression ['customFields'] refers to Envelope Custom Fields rather than Document Custom Fields. Document Custom Fields are typically referred to as "tabs" rather than "custom fields" in both DocuSign Connect and the DocuSign API. You're headed in the right direction with the RecipientStatus section. Our scope of support for Flow is limited to the out-of-the-box triggers and actions, so we wouldn't typically be able to provide guidance on how to set up the trigger output expressions. That being said, I'd be happy to share the details of two methods we've identified for pulling the information.


Method 1: Uses the “tabs” section of the event notification 
Works only with text fields, Full Name, and Date Signed
x = recipient position in the Connect message, starting at 0
your_tab_name = field data label

triggerOutputs() .body.DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatus.RecipientStatus[x]['tabs']['your_tab_name'] 

Method 2: Uses the "FormData" section of the event notification.
Works with all field types
You can specify the field data to be retrieved either with the tab label or with its position (as a numeric value) in the FormData section of the event notification-- this example uses the tab label
x = recipient position in the Connect message, starting at 0
your_tab_name = field data label

triggerOutputs() .body.DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatus.RecipientStatus[x]['FormData']['xfdf']['fields']['field’]['your_tab_name']['value’]



Note: I went about this successfully using a slightly modified version of method 2

 

Capture.PNG

 

First I initialized two arrays with the following expressions:

Array 1 (Recip1Fields Array):
triggerOutputs().body.DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus[0]['FormData']['xfdf']['fields']['field']
 
Array 2 (Recip2Fields Array):
triggerOutputs().body.DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus[1]['FormData']['xfdf']['fields']['field']
 
This is because we have two senders in our template. Note that the RecipientStatus starts at zero.


Next, I initialized string variables for each of the custom fields I intended to pull out of the two arrays.

Finally, I parsed the JSON in a loop:

Capture2.PNGNDAType was my hidden ID field which I used to identify the template and decide whether to run the flow. I look for it in the Recip2Fields array and continue to run the flow if it's found.

Capture3.PNG

 

Next I repeat the process to locate all the other custom fields I care about in the Recip1Fields Array, using nested conditions:

 Capture4.PNG

 

Note: The parse JSON Steps both used the same sample payload:

{
    "type": "object",
    "properties": {
        "@@name": {
            "type": "string"
        },
        "value": {
            "type": "string"
        }
    }
}

 

Now you have all your string variables set and you can do any error checking you need to or finish your flow.

 

Hope this helps. If you still have questions, the Docusign folks are very good.

View solution in original post

7 REPLIES 7
v-yamao-msft
Community Support
Community Support

Hi @NordKapp,

 

Thanks for feedback.

The issue could be reproduced by me.

It seems that the custom field could not return a value using the function @triggerBody()?['customFields'][Region] as suggested in the doc.

I will help confirm it on my side and back to you later.

 

Best regards,

Mabel

Community Support Team _ Mabel Mao
If this post helps, then please consider Accept it as the solution to help the other members find it more quickly.

Mabel (@v-yamao-msft)

Thank you for looking into this issue! I'm looking forward to hearing more. I've also submitted a ticket with DocuSign support and am waiting to hear back from them.

 

Best,

NordKapp

Anonymous
Not applicable

Any updates?

I have a temporary workaround that involves pulling the xml data from the trigger, parsing it, and extracting the custom properties based on that. I'm still building it into my solution and will post when i've got it all figured out. Here's a short summary of the temporary workaround:

1. Add an invisible custom field to your template that has some kind of unique identifier for your flow.

 

2. In Flow, pull data from trigger using: Initialize variable (array) - custom expression: triggerOutputs().body.DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus[0]['FormData']['xfdf']['fields']['field']

This pulls all of the custom fields for the first recipient into an array.

3. repeat for each docusign recipient incrementing the bolded [0]

4. Parse JSON for each array using this schema:

{
   "type": "object",
   "properties": {
   "@@name": {
   "type": "string"
   },
      "value": {
      "type": "
 
5. Use switch case, or conditional statatements to find your unique custom field from step 1 and decide whether to run the flow.
 
6. Extract your other custom fields into variables from the parsed JSON
 
Sorry for the brevity. I'll post screenshots when my final flow is working correctly. I had to pause this project and I'm hoping to complete it by early February.
Anonymous
Not applicable

Thanks for the response! 

I'll give this a shot and let you know how it goes. 

Anonymous
Not applicable

I seem to constantly be getting this error 

 

1.PNG

Would you please post the expression in the initiailze variable step?

Also, they gave me two options for calling the custom fields, see full ticket text below:

 

The trigger output expression ['customFields'] refers to Envelope Custom Fields rather than Document Custom Fields. Document Custom Fields are typically referred to as "tabs" rather than "custom fields" in both DocuSign Connect and the DocuSign API. You're headed in the right direction with the RecipientStatus section. Our scope of support for Flow is limited to the out-of-the-box triggers and actions, so we wouldn't typically be able to provide guidance on how to set up the trigger output expressions. That being said, I'd be happy to share the details of two methods we've identified for pulling the information.


Method 1: Uses the “tabs” section of the event notification 
Works only with text fields, Full Name, and Date Signed
x = recipient position in the Connect message, starting at 0
your_tab_name = field data label

triggerOutputs() .body.DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatus.RecipientStatus[x]['tabs']['your_tab_name'] 

Method 2: Uses the "FormData" section of the event notification.
Works with all field types
You can specify the field data to be retrieved either with the tab label or with its position (as a numeric value) in the FormData section of the event notification-- this example uses the tab label
x = recipient position in the Connect message, starting at 0
your_tab_name = field data label

triggerOutputs() .body.DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatus.RecipientStatus[x]['FormData']['xfdf']['fields']['field’]['your_tab_name']['value’]



Note: I went about this successfully using a slightly modified version of method 2

 

Capture.PNG

 

First I initialized two arrays with the following expressions:

Array 1 (Recip1Fields Array):
triggerOutputs().body.DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus[0]['FormData']['xfdf']['fields']['field']
 
Array 2 (Recip2Fields Array):
triggerOutputs().body.DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus[1]['FormData']['xfdf']['fields']['field']
 
This is because we have two senders in our template. Note that the RecipientStatus starts at zero.


Next, I initialized string variables for each of the custom fields I intended to pull out of the two arrays.

Finally, I parsed the JSON in a loop:

Capture2.PNGNDAType was my hidden ID field which I used to identify the template and decide whether to run the flow. I look for it in the Recip2Fields array and continue to run the flow if it's found.

Capture3.PNG

 

Next I repeat the process to locate all the other custom fields I care about in the Recip1Fields Array, using nested conditions:

 Capture4.PNG

 

Note: The parse JSON Steps both used the same sample payload:

{
    "type": "object",
    "properties": {
        "@@name": {
            "type": "string"
        },
        "value": {
            "type": "string"
        }
    }
}

 

Now you have all your string variables set and you can do any error checking you need to or finish your flow.

 

Hope this helps. If you still have questions, the Docusign folks are very good.

Helpful resources

Announcements

Exclusive LIVE Community Event: Power Apps Copilot Coffee Chat with Copilot Studio Product Team

It's time for the SECOND Power Apps Copilot Coffee Chat featuring the Copilot Studio product team, which will be held LIVE on April 3, 2024 at 9:30 AM Pacific Daylight Time (PDT).     This is an incredible opportunity to connect with members of the Copilot Studio product team and ask them anything about Copilot Studio. We'll share our special guests with you shortly--but we want to encourage to mark your calendars now because you will not want to miss the conversation.   This live event will give you the unique opportunity to learn more about Copilot Studio plans, where we’ll focus, and get insight into upcoming features. We’re looking forward to hearing from the community, so bring your questions!   TO GET ACCESS TO THIS EXCLUSIVE AMA: Kudo this post to reserve your spot! Reserve your spot now by kudoing this post.  Reservations will be prioritized on when your kudo for the post comes through, so don't wait! Click that "kudo button" today.   Invitations will be sent on April 2nd.Users posting Kudos after April 2nd at 9AM PDT may not receive an invitation but will be able to view the session online after conclusion of the event. Give your "kudo" today and mark your calendars for April 3, 2024 at 9:30 AM PDT and join us for an engaging and informative session!

Tuesday Tip: Unlocking Community Achievements and Earning Badges

TUESDAY TIPS are our way of communicating helpful things we've learned or shared that have helped members of the Community. Whether you're just getting started or you're a seasoned pro, Tuesday Tips will help you know where to go, what to look for, and navigate your way through the ever-growing--and ever-changing--world of the Power Platform Community! We cover basics about the Community, provide a few "insider tips" to make your experience even better, and share best practices gleaned from our most active community members and Super Users.   With so many new Community members joining us each week, we'll also review a few of our "best practices" so you know just "how" the Community works, so make sure to watch the News & Announcements each week for the latest and greatest Tuesday Tips!     THIS WEEK'S TIP: Unlocking Achievements and Earning BadgesAcross the Communities, you'll see badges on users profile that recognize and reward their engagement and contributions. These badges each signify a different achievement--and all of those achievements are available to any Community member! If you're a seasoned pro or just getting started, you too can earn badges for the great work you do. Check out some details on Community badges below--and find out more in the detailed link at the end of the article!       A Diverse Range of Badges to Collect The badges you can earn in the Community cover a wide array of activities, including: Kudos Received: Acknowledges the number of times a user’s post has been appreciated with a “Kudo.”Kudos Given: Highlights the user’s generosity in recognizing others’ contributions.Topics Created: Tracks the number of discussions initiated by a user.Solutions Provided: Celebrates the instances where a user’s response is marked as the correct solution.Reply: Counts the number of times a user has engaged with community discussions.Blog Contributor: Honors those who contribute valuable content and are invited to write for the community blog.       A Community Evolving Together Badges are not only a great way to recognize outstanding contributions of our amazing Community members--they are also a way to continue fostering a collaborative and supportive environment. As you continue to share your knowledge and assist each other these badges serve as a visual representation of your valuable contributions.   Find out more about badges in these Community Support pages in each Community: All About Community Badges - Power Apps CommunityAll About Community Badges - Power Automate CommunityAll About Community Badges - Copilot Studio CommunityAll About Community Badges - Power Pages Community

Tuesday Tips: Powering Up Your Community Profile

TUESDAY TIPS are our way of communicating helpful things we've learned or shared that have helped members of the Community. Whether you're just getting started or you're a seasoned pro, Tuesday Tips will help you know where to go, what to look for, and navigate your way through the ever-growing--and ever-changing--world of the Power Platform Community! We cover basics about the Community, provide a few "insider tips" to make your experience even better, and share best practices gleaned from our most active community members and Super Users.   With so many new Community members joining us each week, we'll also review a few of our "best practices" so you know just "how" the Community works, so make sure to watch the News & Announcements each week for the latest and greatest Tuesday Tips!   This Week's Tip: Power Up Your Profile!  🚀 It's where every Community member gets their start, and it's essential that you keep it updated! Your Community User Profile is how you're able to get messages, post solutions, ask questions--and as you rank up, it's where your badges will appear and how you'll be known when you start blogging in the Community Blog. Your Community User Profile is how the Community knows you--so it's essential that it works the way you need it to! From changing your username to updating contact information, this Knowledge Base Article is your best resource for powering up your profile.     Password Puzzles? No Problem! Find out how to sync your Azure AD password with your community account, ensuring a seamless sign-in. No separate passwords to remember! Job Jumps & Email Swaps Changed jobs? Got a new email? Fear not! You'll find out how to link your shiny new email to your existing community account, keeping your contributions and connections intact. Username Uncertainties Unraveled Picking the perfect username is crucial--and sometimes the original choice you signed up with doesn't fit as well as you may have thought. There's a quick way to request an update here--but remember, your username is your community identity, so choose wisely. "Need Admin Approval" Warning Window? If you see this error message while using the community, don't worry. A simple process will help you get where you need to go. If you still need assistance, find out how to contact your Community Support team. Whatever you're looking for, when it comes to your profile, the Community Account Support Knowledge Base article is your treasure trove of tips as you navigate the nuances of your Community Profile. It’s the ultimate resource for keeping your digital identity in tip-top shape while engaging with the Power Platform Community. So, dive in and power up your profile today!  💪🚀   Community Account Support | Power Apps Community Account Support | Power AutomateCommunity Account Support | Copilot Studio  Community Account Support | Power Pages

Super User of the Month | Chris Piasecki

In our 2nd installment of this new ongoing feature in the Community, we're thrilled to announce that Chris Piasecki is our Super User of the Month for March 2024. If you've been in the Community for a while, we're sure you've seen a comment or marked one of Chris' helpful tips as a solution--he's been a Super User for SEVEN consecutive seasons!   Since authoring his first reply in April 2020 to his most recent achievement organizing the Canadian Power Platform Summit this month, Chris has helped countless Community members with his insights and expertise. In addition to being a Super User, Chris is also a User Group leader, Microsoft MVP, and a featured speaker at the Microsoft Power Platform Conference. His contributions to the new SUIT program, along with his joyous personality and willingness to jump in and help so many members has made Chris a fixture in the Power Platform Community.   When Chris isn't authoring solutions or organizing events, he's actively leading Piasecki Consulting, specializing in solution architecture, integration, DevOps, and more--helping clients discover how to strategize and implement Microsoft's technology platforms. We are grateful for Chris' insightful help in the Community and look forward to even more amazing milestones as he continues to assist so many with his great tips, solutions--always with a smile and a great sense of humor.You can find Chris in the Community and on LinkedIn. Thanks for being such a SUPER user, Chris! 💪 🌠  

Find Out What Makes Super Users So Super

We know many of you visit the Power Platform Communities to ask questions and receive answers. But do you know that many of our best answers and solutions come from Community members who are super active, helping anyone who needs a little help getting unstuck with Business Applications products? We call these dedicated Community members Super Users because they are the real heroes in the Community, willing to jump in whenever they can to help! Maybe you've encountered them yourself and they've solved some of your biggest questions. Have you ever wondered, "Why?"We interviewed several of our Super Users to understand what drives them to help in the Community--and discover the difference it has made in their lives as well! Take a look in our gallery today: What Motivates a Super User? - Power Platform Community (microsoft.com)

March User Group Update: New Groups and Upcoming Events!

  Welcome to this month’s celebration of our Community User Groups and exciting User Group events. We’re thrilled to introduce some brand-new user groups that have recently joined our vibrant community. Plus, we’ve got a lineup of engaging events you won’t want to miss. Let’s jump right in: New User Groups   Sacramento Power Platform GroupANZ Power Platform COE User GroupPower Platform MongoliaPower Platform User Group OmanPower Platform User Group Delta StateMid Michigan Power Platform Upcoming Events  DUG4MFG - Quarterly Meetup - Microsoft Demand PlanningDate: 19 Mar 2024 | 10:30 AM to 12:30 PM Central America Standard TimeDescription: Dive into the world of manufacturing with a focus on Demand Planning. Learn from industry experts and share your insights. Dynamics User Group HoustonDate: 07 Mar 2024 | 11:00 AM to 01:00 PM Central America Standard TimeDescription: Houston, get ready for an immersive session on Dynamics 365 and the Power Platform. Connect with fellow professionals and expand your knowledge. Reading Dynamics 365 & Power Platform User Group (Q1)Date: 05 Mar 2024 | 06:00 PM to 09:00 PM GMT Standard TimeDescription: Join our virtual meetup for insightful discussions, demos, and community updates. Let’s kick off Q1 with a bang! Leaders, Create Your Events!  Leaders of existing User Groups, don’t forget to create your events within the Community platform. By doing so, you’ll enable us to share them in future posts and newsletters. Let’s spread the word and make these gatherings even more impactful! Stay tuned for more updates, inspiring stories, and collaborative opportunities from and for our Community User Groups.   P.S. Have an event or success story to share? Reach out to us – we’d love to feature you!

Users online (6,035)