Automated Content Generation using Methods

One of the main features of the Technical Documentation Framework is its ability to reference Business Objects (e.g., Parts, Requirements, Processes, etc.) stored in Innovator and include this information within a Technical Document. These Business Objects (Items) are tied directly to each Technical Document that refers to them using standard Innovator Relationships. This binding allows users to see which Business Objects are related to each Technical Document and which Technical Documents relate to each Business Object using the Structure Browser. Technical Documents store the revision of each Business Object they are bound to so that when Business Objects evolve to subsequent revisions, authors can be notified and there’s visual indications provided by the Editor when bound items have changed (see section Change Management). In addition to this reference, property data from these Business Objects (and/or related Items) can be queried and used as Technical Document content as information in tables, lists or however is needed. Including information in this manner requires a Content Generator.

Custom content generation refers to the process of using configured Methods to generate XML content to be used within Technical Documents. The intent is to provide a mechanism to reference content from existing Items within Innovator or produce content as the result of a programmatic algorithm (or both) and provide this data in a format suitable for a Technical Document. Note that the term ‘suitable’ refers to content that respects the underlying document data model (schema).

Content Generators (the Methods that produce document content) can be used to create and store data statically within the document or dynamically with the content stored temporarily. In the former scenario, the Content Generator acts like a macro, automating the production of content. In the latter scenario, the Content Generator acts more like a reporting engine with the resulting content representing the most up-to-date information. Also, note in the latter scenario the generated data is transient; existing only until the content is regenerated, the document is published, or the document is closed in the Technical Documentation Framework.

Content Generators are triggered by the existence of a Document Element in the document that has been mapped to the Content Generator Method in the Document Configuration. Referring to ’Standard’ Document Type, the ItemInfo Document Element instance has been mapped to a Part. The Content Generator queries this part for various properties, which are then displayed in a Table Document Element.

Figure 37. The process works as follows:

1. The author places a Document Element within the document that has been mapped to a Content Generator
2. If this is an Item Document Element, the user will be prompted to select an Item to reference.
3. The configured Content Generator Method is called on the server to generate the Document Elements to add (as children) to the Document Element added by the author
4. The generated content is stored in the Document on the client
5. When the author saves the Technical Document, the generated content is added to the data on the server. Note that the generated content exists only on the client until it is saved.

Generated content is treated like other content created directly by the author. It can be copied and reused in other places within the document and within other Technical Documents, it can be modified, and removed. Note, however that generated content can be regenerated. Doing so will overwrite all content modified by the author.