Documenting the VA Topic

Morgan Berry
Tera Contributor

I have a requirement to document our changes to our VA Topics and was wondering if anyone had any tips of a report or export that could give each piece of the topic and its associated settings to allow for quick re-builds and documenting changes between sprints.

 

Also, not sure if I am crazy or not, but I could have sworn there was a way to export the workflow image to an image or a PDF (without taking and merging screenshots), but cannot seem to see it anymore, or documentation.

 

Anyone?

1 ACCEPTED SOLUTION

Chris D
Kilo Sage
Kilo Sage

Yes, you can output the topic flow to a png by opening it in VA Designer, then clicking the camera button on the top right corner (then right click > save image after it opens in a new tab):

ChrisD_0-1701959808607.png

This is the best, easiest, and (I'm fairly sure) only way to export a topic for documentation/requirement purposes. This exemplifies the importance of having good, clear node naming conventions which is the single best thing you can do: use plain, concise English, avoid abbreviations (unless maxed out character limits), and name all your decision blocks and decision outputs (don't keep the defaults). Personally I avoid special characters in input nodes so that the variable names are short and clean, but decision blocks and other outputs I use special characters (question mark is helpful for decisions) to ensure those are descriptive and clear.

The only other tip I can give you working with customers/topic SME's is to have a live meeting with them and walk them through the entire flow step by step in VA Designer so they can see the wording and specific settings.

View solution in original post

5 REPLIES 5

Chris D
Kilo Sage
Kilo Sage

Yes, you can output the topic flow to a png by opening it in VA Designer, then clicking the camera button on the top right corner (then right click > save image after it opens in a new tab):

ChrisD_0-1701959808607.png

This is the best, easiest, and (I'm fairly sure) only way to export a topic for documentation/requirement purposes. This exemplifies the importance of having good, clear node naming conventions which is the single best thing you can do: use plain, concise English, avoid abbreviations (unless maxed out character limits), and name all your decision blocks and decision outputs (don't keep the defaults). Personally I avoid special characters in input nodes so that the variable names are short and clean, but decision blocks and other outputs I use special characters (question mark is helpful for decisions) to ensure those are descriptive and clear.

The only other tip I can give you working with customers/topic SME's is to have a live meeting with them and walk them through the entire flow step by step in VA Designer so they can see the wording and specific settings.

See, I knew I wasn't going crazy, but it has disappeared.  Are you on Vancouver?

MorganBerry_0-1702037371935.png

 

I did find that if I go to the topic in sys_cs_topic (Definition field), I can export a blob of the data.  This could be helpful, as we could “paste” it back in if we needed to fallback, or even compare two states using a document compare.  But would be nice if I could parse this into a helpful report., unless someone out there has already done this.

 

According to ServiceNow Vancouver release note at https://docs.servicenow.com/bundle/vancouver-release-notes/page/release-notes/now-platform-capabilit..., the Save as Image button has been removed.

Whoops sorry for the delay - that screenshot I shared was from Utah - but yeah they removed it in Vancouver, no idea why. Now that we're on Washington DC and I've been needing to share topic flows with customers, I'm incredibly frustrated by this omission.

I've just been doing my best to zoom in to the widest level that is still readable, do a screen clipping, scroll down to the next chunk (trying to line it up based on the previous crop), screen clip, rinse and repeat - several times for some topics. I don't know a quick way to stitch them all together to somewhat resemble the previous functionality so I'll just send all the images to my customer(s) 😠

 

I'm annoyed enough that I just submitted an idea, so feel free to upvote if you're similarly frustrated 🙂 
View Idea Page - Now Support (servicenow.com)