cancel
Showing results for 
Search instead for 
Did you mean: 
cancel
693
Views
0
Helpful
4
Replies

automatically generate process documentation

davshapi
Level 1
Level 1

This is an off-the-wall question. I have 40+ processes that I need to produce AsciiDoc documentation for and I'm basically manually copy/pasting the variable names, inputs, outputs and descriptions. All this is stored in the CPO processes and I'm wondering if there's a way to access these variables on a per-process basis?

 

Our team relies heavily on CPO and we have dozens of processes today, hundreds tomorrow. It would be super handy to have a way to automatically generate documentation based on existing information in the processes. This will also make it easy to update documentation in the future as processes are refined/changed/added. 

 

Ex. document that I'm trying to achieve:

<<processName.adoc>> filename

<<Process Name and description from General > Description/Notes field>>

<<List of variables and descriptions>>

<<Process Trigger>> 

1 Accepted Solution

Accepted Solutions

Shaun Roberts
Cisco Employee
Cisco Employee

I love this idea! It does not exist already but might be worth raising a CDETS to the core CPO team. I think it could be done via content but nothing exists to that affect yet.

--Shaun Roberts
Principal Engineer, CX
shaurobe@cisco.com

View solution in original post

4 Replies 4

Shaun Roberts
Cisco Employee
Cisco Employee

I love this idea! It does not exist already but might be worth raising a CDETS to the core CPO team. I think it could be done via content but nothing exists to that affect yet.

--Shaun Roberts
Principal Engineer, CX
shaurobe@cisco.com

I have met great success with this. I pulled the necessary info from ProcessOrchestrator.DBO.Configuration and used XPath Query and Read Table from XML to get all the necessary information. From there I dumped it into an AsciiDoc but really you could load that info into anything - send it to a CMDB SQL table or save to CSV or whatever.

 

This will save us a tremendous amount of time creating and updating our documentation in the future. If such a function where to be built into future editions of CPO I'm sure it would be very well received. 

If you start something out, feel free to add me in on it and maybe we can collaborate.

--Shaun Roberts
Principal Engineer, CX
shaurobe@cisco.com

Tuan Tran
Cisco Employee
Cisco Employee

You can try the PowerShell custom command-let "Get-OrchestratorProcess" to get a list of processes.  Enumerate through each of the processes and look up their properties.

* DisplayName

* VariableDefinitions  (Enumerate through the variables to get their names, types & descriptions)

* Triggers (Enumerate through the triggers to get their names & types

Review Cisco Networking for a $25 gift card