2. Initial Implementation

The description below explains how the first two PATs were implemented. The output of this implementation is:

• Checklist for implementing a PAT
• Template for a PAT report
• Standards for Process Asset Templates in SWEHB

This describes all of the initial setup. see Maintenance for details of ongoing maintenance, adding PATs, etc.

2.1 Initial Structure 

•  the page "PATS - Process Asset Templates - Database Reports etc" was created under SITE:Home. This is a container for the PATs
  • "PAT Checklists" was created as a child and holds the "Checklists and Guidance Lists" document from Sally
  • "PAT Database" was created as a child and holds all of the actual  PAT pages
  • "Reports for Asset Categories was created and holds all of the report pages for PATS as displayed in SWEs, Topics, and categories of PATs
• The "7150:reference" template was copied into a new user template in SITE called "pat". The following changes were made to convert "reference" to "pat"
  • In the Show-if statement, "References Table" was changed to "PAT Database"
  • "Citation" was changed to "Origin"
  • In example, Reference was changed to PAT
  • The template was saved in SITE and is used as a live template for all PAT pages
• PAT Database page contains the same code as the 7150:References Table with the following changes
  • Info panel in the excerpt was changed to note the PAT database
  • Show-to contains a link to PAT Database that only editors can see
  • In the Report Table, Content reporter, scope now points to SITE:PAT Database
  • Report column for Citation was changed to Origin
  • The report on the page mimics the References Table in all of the SWEHB versions
• The "Reports for Asset Categories" page was created
  • PAT Category Codes section was added to contain all of the codes used in the "SWE or Topic" section of PATs and the reports that they appear in. 
  • "Reports by Category Code and SWE or Topic code" was added with a children macro to display all of the child pages (reports)
• Report pages were created under "Reports for Asset Categories" for: 
  • 7.10 Process Asset Templates
  • 8.17 Process Asset Templates
  • SWE-084 Process Asset Templates
  • other category reports (one for each category code)
  • "PATs Report Body" page containing report macros that are common to all reports
  •  Typical report page is structured
    • "Excerpt" macro to contain the report that is called and displayed on a page
      • Excerpt contains the text "Click on a link to download a usable copy of the template. " to alert users that they can click on a link to get a download of the item. 
    • Panel with green boarder to denote PAT contents
    • Inside the Panel is the Report list with a Content Reporter and an include page to bring in the rest of the code from the "PATs Report Body"
    • The Content reporter has parameters set to: 
      • Spaces=+SITE
      • Types= page
      • Scope= SITE:PAT Database > children
    • Reporter contains a Text Filter with parameters
      • Key = data:SWE
      • Include= .*7.10.* 
        • The .* brackets are necessary to exclude things before and after the search string
        • the "7.10" is the search string to use when building the report 
    • Reporter contains a Text Sort with parameters
      • Content = title

2.2 First asset in SWE-084 

• PAT-001 was created as a child of "PAT Database" and restructured several times 
  • In PAT-001, the Live Template was inserted using the template "pat" 
  • The Live template is inserted into a Panel with a title "PAT detail displays only if you have "edit" permission. "
  • The panel is embedded in a Show-if macro with Space Permissions set to edit. This means that only editors will be able to view the live template display on the page. 
  • This whole structure is positioned at the bottom of the display to be out of the way when the page is viewed normally. 
• PAT-001 was modified to contain the "FCA Audit Checklist"
  • The checklist was attached to PAT-001 page - FCA Checklist.doc
  • The checklist was assigned a comment - "Updated 20220415" to identify the version of the checklist - the version had been part of the title and was removed before the doc was attached to the PAT
  • The checklist was opened in Word and configured to display the header, and all of the meaningful parts of the body table (omitting extra blank rows). 
  • The checklist could be contained on one Word page and a screenshot was taken of that page. 
  • The screenshot was named "FCA Checklist 20220415" to include both the title and version information. 
  • The screenshot was attached to the PAT
• The page was edited using the "Edit Contents" function to access the contents of the live template
  • The following data was added
    • Link: https://swehb-pri.msfc.nasa.gov/download/attachments/112656614/FCA%20Checklist.docx?api=v2 - This was copied from the attachment page and is a link directly to the document attachment of the page (right click on the image and select "Copy link address)
    • Title: "PAT-001 - FCA Checklist" - This is the PAT number along with the Title of the document to make it clear what the user is viewing. 
    • SWE or Topic: SWE-084, AudCK, CM - These three attributes denote: 
      • SWE-084 - the SWE in which this PAT is displayed
      • AudCK - The Audit Checklists category of PATS in which this item should appear
      • CM - The configuration Management category of PATS in which this item should appear
    • Origin:  - SWE-084, tab 7 - denotes the original SWE (or topic page) where this asset is first introduced into the SWEHB
    • Notes: "For use on all release candidate audits." - this is used to add any other information of interest about the PAT. 
  • The page was tested to ensure that the item appeared in the appropriate report pages 
    • SWE-084 Process Asset Templates
    • Audit Checklists Process Asset Templates
    • Configuration Management Assets Process Asset Templates
• The PAT-001 page was edited using the "Edit" function to populate the balance of the viewable page
  • The Title was enhanced to contain the PAT number and the asset title
  • An Excerpt was created to contain the first displayable page of the attachment. this is what will be viewable in most SWE or Topic pages. It is inserted into the SWE or Topic page using an Excerpt-Include macro. 
    • Text in the Excerpt "Click on the image to preview the file. From the preview, click on Download to obtain a usable copy. " lets the user know how to use the table below. 
    • Edit the Excerpt macro:  check the "Hide Excerpted Content" box. 
    • Panel in the excerpt contains the image of the attachment
      • Panel Title - "FCA Checklist" is the title of the attachment
      • Panel Border Color is set to Green
    • Image is inserted into the Panel - With the cursor inside the Panel, click "Insert Files and images" on the menu bar
      • attached files and images from the page will be displayed. Select the image you want to appear on the page. 
      • the selected item will show a check mark, then select Insert
    • Once the image is inserted in the Panel, configure it: 
      • Set the size to "800" - this makes it large enough to read on the screen
      • Click on Boarder to turn that feature on
      • Click on the "Center" icon on the page edit menu to center the image on the page
      • Click on Link to associate the document with the image in the Panel
        • When you click on Link you will get a list of documents attached to the page. click on the appropriate one and then Insert it
    • The excerpt in the PAT is now ready to be used once the PAT itself has been saved. 
  • In the body of the page, configure the PAT so that it can be used with an "Include page" macro from a topic or SWE. This method is used for multiple page assets when all pages are necessary to display. When displaying only the first page, the "Excerpt Include" method is preferred. 
    • Copy the text information to the user "Click on the image to preview the file. From the preview, click on Download to obtain a usable copy. "
    • Copy the Panel from the Excerpt next. Paste it in below the text.
      • Strip out the duplicate text from the panel. This will save having to rebuild the panel and the first image. 
      • Note that the panel is already configured green and with the appropriate title
    • Add images of the remaining pages in the document that have been captured, saved with the title and version information, and attached to the PAT along with the first image. 
      • Each image should be configured the same as the first: 800 px, Boarder, Link to the doc file. 
      • Each image should be centered in the panel 
  • Save the page and test everything
    • look at the page in the PAT Database. It should appear in numeric order in the table with all the data properly displayed. 
    • Look at the appropriate Report page. The PAT should appear on all the reports that correlate to the codes in the SWE or Topic field of the Live Template. 
    • Pull the PAT into a test page using a Excerpt Include macro. You should get only the contents of the Excerpt box in the PAT - one page, properly linked. When you click the image you should be taken to a document preview window where you can view the entire document. You should also be able to download the document from the preview window. 
    • Pull the PAT into a test page using a Include Page macro. You should get only the body of the PAT - all pages, properly linked. When you click the each image you should be taken to a document preview window where you can view the entire document. You should also be able to download the document from the preview window. 
    • In this case, the tests were performed on SWE-084

2.3 Asset Standardization

Each PAT needs to have a simple structure that can be used by project teams. To ensure this reusability aspect, Assets will be created and saved as Word, Excel, or other editable format, not as a PDF. 

Each should have a simple minimalist structure for the user to embellish as they see fit.

See section 3.1 Configuring an Asset as a PAT below for the full details on standardization. 

2.4 Challenges and Workarounds

2.4.1 Creation of report macros for Resource tabs

The creation of new user macros requires using HTML instead of Wiki Markup. Since most of the legacy macros are in Wiki Markup, new macros cannot be created easily. They must be created in HTML.

This creates a future problem. Eventually, Wiki Markup macros will not work and everything will need to be rewritten in HTML.

Workaround: Build a report that uses a manual method for selecting content. This is working effectively for pages under Topic 7.18. It needs to be implemented for all pages under 7.18 and 8.16.

Strategy: I will investigate a method for converting Wiki Markup macros to HTML. There are some promising ways of doing this on the internet.

2.4.2 Including a PAT in pages outside of SITE space

Confluence is supposed to support attachments from pages in one space being referenced in another space. This has proven to be difficult to do as documented by Atlassian. 

Workaround:

• Use an Include-Page macro to pull in the whole PAT page. The PAT page must include images of the attachment as a thumbnails. Each image is displayed on the page with the document linked. The drawback to this is the Live Template that is also on the page. The Live Template is being hidden in a Show-if macro. It will be necessary to test this in production so that anonymous users can see the thumbnail but not the PAT structure detail. 
• Use an Excerpt macro to contain the linked image of the first page of an attachment.  When only one page of the attachment needs to be displayed, use the Excerpt-Include macro to pull just the excerpt.