How do i use the QUBEdocs framework to narrate my rule scripts?
You can optionally use the following special tags in your rule files to provide additional commentary on your business rules. Just copy the sample tags below and paste them above the block of rules in the rule script that you want to document and away you go.
|#NAME||The name for a specific rule or block of rules|
|#DESC||A brief description of what a rule should be used for|
|#DATE||The last date at which an individual rule was updated|
|#AUTHOR||The last person to have edited the rule|
Note that once these tags are defined, an alternate business view will be available for viewing the rules in the documentation.
How do I use the QUBEdocs framework to narrate my process scripts?
You can optionally use the following special tags in your TurboIntegrator files to provide additional commentary on your processes. Just copy and paste the sample tags below into the prolog procedure of your process and update the descriptions.
|#LASTCHANGE||A brief discussion of any change(s) made to the TI process|
|#GENERALCOMMENT||A brief overview of the TI process.|
|#DATASOURCECOMMENT||A brief description of the data source used and any changes the TI may make to the data source during runtime.|
|#PROLOGCOMMENT||A brief overview of what occurs in the Prolog tab.|
|#METADATACOMMENT||A brief overview of what occurs in the Metadata tab.|
|#DATACOMMENT||A brief overview of what occurs in the Data tab.|
|#EPILOGCOMMENT||A brief overview of what occurs in the Epilog tab.|
Note that Multiple lines are supported, you just need to repeat the tags.
It is worth noting that these tags are not required in order for the documentation to be complete. They just provide additional information which is useful in understanding more about what a process is used for and how it works.