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

Standardizing the template includes the following items:

• No logos or other Header information in the template. If a project wants that, they can apply it themselves.
• Header block with the following items at a minimum:
  • Dates of use (example Audit Dates)
  • Project
  • User name (example: Auditors) – people filling out or using the template in the project
  • Some indicator for the version of the template. This can be version number or version date
• Usage instructions – minimal instructions for the user when filling out / using the template
• Table of checklist items, steps, or other list items with some form of
  • Col 1 - numbering system for the checklist
  • Col 2 - instruction or item 
  • Col 3 - acknowledgement of use (example Yes/No)
  • Col 4 - Comment area
  • Col 5 - Initials of the user (optional)
• Other customizations are optional such as:
  • Heading styles
  • Colorizing table areas
  • Addition of summary or comment areas
• Naming PAT item preparing it for attachment to individual PAT pages. examples
  • PAT-001 - FCA Checklist
  • PAT-002 - PCA Checklist
• Each attachment is affixed to the appropriate PAT page
• PAT pages are children of the PAT Database page under SITE:Home page
• See "Add a New Pat" for instructions on building a PAT page. 

Make sure you have the following items ready for use: ;

• Asset is ready to be attached to the new PAT - verify that it is in standardized format.  File name should not contain version coding. 
• Screenshots of Asset have been prepared - one shot per page of the document. Image title should be the Asset Name, version code, and sequence number (if more than one shot). 

Perform the following steps: 

1. Open the PAT Database in a new tab. 
2. Review the existing PATs and make a note of the next unused PAT number. Do not reuse any retired PAT numbers. There are plenty of new numbers available after the last one in the database. 
3. Open an existing PAT in a new tab. Initiate a copy command to create a new PAT. Alternatively, you can open the PAT-000 - PAT Template Page to get started. 
   1. Space and Parent page should not be changed. 
   2. Uncheck the "Include attached files and images" box - These will be added after the new page is created. 
   3. Click Copy to complete the action. 
4. The new page is opened in Edit mode. Cleanup the new page: 
   1. Initially, the title will start with "Copy of", remove this. 
   2. Change the title to be the new PAT number followed by the name of the asset. 
   3. Delete any "Unknown Attachment" markers created by building the copy without the old attachments. 
   4. Save the new PAT. 
   5. Verify that the new page was created by looking at the PAT Database (refresh if necessary). 
5. Attach the Asset and Screenshots to the new PAT. Drag and drop is a quick way to do that. See SWEHBDOC - Managing Attachments for more details.  
   1. For the asset, use the Properties option to add a Comment if you want to put version information for the attachment. Version information should not be built into the asset title.  
   2. Click on each of the attachments to ensure that the viewer opens and displays the file properly. 
   3. Right click on the attachment that is the actual PAT, select "Copy link address" this will store the link address in the past buffer in preparation for the next step. 
   4. Once you are satisfied that the attachments are all ready for use, go back to View Page. 
6. Select "Edit Contents" to open the Live Template at the bottom of the page (embedded in a Show-If macro. Add the PAT attributes: 
   1. Link - paste the Link Address, from the past buffer in the previous step, into the Link data cell. 
   2. Title - provide the full name of the PAT - example: "PAT-999 New Asset"
      1. using the PAT number in the title ensure that the asset will not get confused with a non-PAT document. 
   3. SWE or Topic - Put in the appropriate codes for the pages on which this asset appears. Also includes codes for categories of which this asset is a member.
      1. All entries must be separated by a comma and a space. 
      2. Last entry ends with a comma and a space. 
      3. DO NOT ADD A CARRIAGE RETURN ("ENTER") AT THE END OF THE FIELD - this will corrupt the report filter. 
      4. for example: "SWE-999, Topic 9.88, AudCK, "
   4. Origin - Enter the code and location for the first use of this asset. Typically it is a SWE or Topic. 
   5. Notes - Enter any other information of interest about the asset. 
   6. Save the page and review the PAT in the PAT Database to
      1. verify that the information is visible
      2. view the "Reports for Asset Categories" and select the reports for which the asset should appear (entries in the SWE or Topic field) 
7. Select "Edit" to configure the parts of the PAT page that will be displayed on other SWEHB pages. 
   1. In the Excerpt macro, ensure that the Hidden parameter is set to "true". This will hide the excerpt when the entire PAT is included in a SWEHB page. 
   2. Ensure that the text in the Excerpt body makes sense.
      1. Currently the text is set at "Click on the image to preview the file. From the preview, click on Download to obtain a usable copy."
   3. Check the Panel macro inside the Excerpt. Click on "edit" to change Panel parameters. 
      1. title should be the title of the asset, without the PAT number. It should match the title of the document that is in the document. 
      2. Border Color should be set to green. 
   4. In the body of the Panel, insert the image corresponding to the first page of the PAT. Use the "Insert Files and Images icon in the edit menu. 
      1.  Size of the image set to "800"
      2. Border should be set to "on"
      3. Link should be set to the PAT document attached to the page. 
      4. Image should be set to Centered on the edit menu. 
   5. Testing will be done later
   6. Below the excerpt macro is the balance of the page body. This will be displayed if included into a SWEHB page
      1. Ensure that the text in the page body makes sense. Currently the text is set at "Click on the image to preview the file. From the preview, click on Download to obtain a usable copy."
      2. Below the body text is the Panel macro containing all of the images of the PAT pages. This is used in instances where it is desirable to display the whole document on the SWEHB page. This panel is formatted identically to the panel in the excerpt. 
      3. In the body of the Panel, insert the image corresponding to the first page of the PAT. Use the "Insert Files and Images icon in the edit menu. 
         1.  Size of the image set to "800"
         2. Border should be set to "on"
         3. Link should be set to the PAT document attached to the page. 
         4. Image should be set to Centered on the edit menu.
         5. Continue these steps, adding the rest of the images 
      4. Save the page 
8. Testing the PAT before using ensures that all parts of the page are working. 
   1. Use the page: PAT Test Page
   2. Test and fix problems until the test page performs as expected.
9. You are now ready to deploy the PAT into SWEHB pages. 

On a SWE or Topic Page 

In "Edit" mode: 

1. Go to the location where the PAT is to be inserted. It may be an existing subheading in a tab, or a new subheading may need to be created. 
2. If you want to pull in only a single image, use the "Excerpt Include" macro to bring in just the first page image. Otherwise, go to step 3 below. 
   1. Be sure to get the PAT from the SITE: space
   2. Check the box to "Remove Surrounding Panel"
   3. Pull in the PAT to preview it and make sure the location can be found
   4. Go to step 4. 
3. If is is appropriate to pull in all of the pages of a document, use the instructions here: 
   1. Use the "Include Page" macro to bring in the whole of the PAT
   2. Be sure to get the PAT page name from the SITE: space
   3. Pull in the PAT to preview it and make sure the location can be found
   4. Note that the include page will pull in the Live Template information but that will be only seen by editors, not users. 
4. Save the page to ensure that the PAT is visible and located where you want it. 
5. Return to edit mode and insert any "SWEREFN" macros to point the user to the resources tab. This is done just like the references. 
6. Go to tab 5 and add subheading 5.3 if necessary. 
   1. use an "Include Page" macro to pull in the appropriate PAT report page for the PATs in the SWE or Topic. 
   2. the PAT is pulled into these reports based on the codes in the Affiliated SWE section of the live template. 

Building a PAT Report Page

PAT Report pages are children of the SITE: Reports for Asset Categories page. 

1. Find the page for the page you are adding the topic or SWE into, if a new page is needed, build a new page from a copy of an existing page. 
   1. Copy the existing page. 
   2. Change the SWE or Topic title as appropriate.
   3. In the Text Filter, change the Include parameter to the SWE-999 or Topic 9.99 designation so the report can be built properly.
   4.  Save all
   5. Test to see if the correct PATs are included in the report page. 
2. Once the page exists, the report is built based on the include code for the SWE or Topic you are inserting it into. Check to see that the PAT appears in the report. 
3. Once the report page is working, insert it into section 5.3 (or appropriate subheading on the Resources page. 

Publish a Blog Post Announcing the New PAT

• Blog post - the simplest way to make users aware of the new PAT is to create a Blog post and publish it. It will appear on the SWEHB Book A. Introduction  page in the right column. See SWEHBDOC Blogs In SWEHB for details on creating and publishing a Blog entry in SWEHB. 

PAT Categories

Many PATs are related to each other because they are used in a particular phase of a project such as Project Planning. Others are used for a particular function such as Peer Review or Audits. For each category there is a unique code assigned and that code is used in the PAT Database to identify a PAT as a member of that category. 

Also, for each category, there is a report created and maintained that presents a list of all the PATs in that category. These reports are included in various SWEs and Topics where they are appropriate. The sections below describe how the categories are created, assigned, and how reports built and distributed. 

Category Codes

Category codes are short mnemonics that capture the essence of what the category is about. For example, the code "Haz" is used for "Hazard Analysis Process Asset Templates." This code is then used in the "SWE" field of the PAT Database entry for each PAT that is associated with Hazard Analysis.  

There is no list of all the category codes in use. However, in the instructions below, you will create a report under the PAT Categories page. That report will contain the code and be displayed as part of the PAT Categories page that lists all the reports. The code will be displayed there along with all the other codes. This gives you a place to see all the assigned codes so you can avoid duplication.  

Category Reports

There are two pages in the hierarchy where reports live: 

• PAT Categories - This is for reports that have one or more PAT entries
• PAT Categories - MT - This is for reports that do not yet have any PAT entries. These reports are waiting for PATs to be created and will be moved under the PAT Categories page when they have members. 

Building a Category Report

The easiest way to build a new report is to copy an existing report. 

1. Open an existing report in a new tab. 
2. Select "Copy" from the "..." menu and accept the default parameters. 
3. When you are in edit in the the copy, it will have "Copy of" at the front of the title. 
   1. Delete the "Copy of" .
   2. Change the title of the page to the new report name. 
   3. Save the report.
   4. Verify that the page has the appropriate title and produces the same report as the one you copied from. 
4. Next, make sure you have at least one PAT with the new Category code in it. You may put the new code into the PAT-999 - PAT Test Page if you don't have it in any real PAT. This is a good way to test codes before you start distributing them. 
5. Edit the new report and go down to the "Text Filter" macro. Click on it and select "Edit" 
   1. Leave the "Key" set to "data:SWE"
   2. scroll down to the "Include" parameter. Replace the old code with the new code for the report. Be sure to leave the dot asterisk, ".*" both before and after the code. These are the wildcard characters that let Confluence pick the code out of all the characters in the SWE field. 
   3. Save the Text Filter and Save the report page. 
   4. Verify that the appropriate PAT appears in the report. 
      1. Only the PATs with the code should appear in the report. 
   5. Edit the report again, once you know it is working and update the entry in the Excerpt macro:
      1. Fix the category code.
      2. Update the date.
      3. Update the number of items that appear in the report. 
   6. Verify that the the report appears in the PAT Categories page in the "With Entries" section that will verify that the new report is in the appropriate location in the hierarchy. 

Deploy Category Reports

Once you know that the report is working and appears in the PAT Categories page you are ready to deploy the report into SWEs and Topics. 

1. Determine which SWEs and Topics need to have a copy of the category report in them. Usually this is done in the "Resources" tab. 
2. Open the target page in "Edit" mode, and go to the tab you want to put the report into. 
3. Add a section called "Process Asset Templates for Category xxxxxx" - with xxxxx replaced by the actual category you are using. 
4. In this new section add an Include Page macro to pull the report into the page. You will need to call up the page from the SITE space so Confluence can find it. 
5. Save the page. 
6. Verify that the category report appears in the proper location. Fix any problems found.

Updated PAT Asset

1. Download the PAT asset to your local computer. 
2. Edit the asset and make appropriate changes. 
3. Save the asset without changing the asset filename. 
4. Verify that the asset looks and works as desired. 
5. Drag and drop the asset into the Attachments area of the PAT.
6. Verify that the updated asset is in the PAT and is the current version. Look at the version list to verify this. 
7. Add a Comment to provide additional versioning information and describe changes made to the asset. 

NEW Images

A new set of screen shot images for the updated asset must be created for inclusion into the page. 

1. Open the asset as though you are going to edit it. 
2. Size the editor window so that a full page of the asset is visible. 
3. Use the Snipping Tool to grab an entire page at a time. 
4. Snip and save all pages of the document as images
5. Name the images: Asset name, sequence number (page number), version code (number or date to match the asset versioning)
   1. Example: "SS1-pat-999." for Screen Shot 1 of PAT-999
6. Drag and drop the new images onto the attachments area of the PAT page. 
7. Verify that each image opens in the viewer when you click on it. 

Putting New Asset into the PAT page

Once the Asset and screenshots are in the attachments area of the page, you are ready to rebuild the page. 

1. Select "Edit" in the menu bar. 
2. In the Excerpt section, click on the image and select the appropriate screenshot from the list of attachments.  
3. In the body of the PAT, click on each of the images select the appropriate screenshot from the list of attachments.  
4. Click the image in the excerpt macro, change, if necessary, the following: 
   1. select the image corresponding to the first page of the asset. 
   2. configure the asset image
      1. Size should be 800 
      2. Click the Border option
      3. Click on Link and select the updated asset from the Files list
   3. Click on the image just added and click on the Center option  in the editor to center it on the page. 
5. Put the cursor in the Panel section of the Body of the page, For each image (for all of the pages of the asset)
   1. select the image corresponding to the page of the asset. 
   2. configure the asset image
      1. Size should be 800 
      2. Click the Border option
      3. Click on Link and select the updated asset from the Files list
   3. Click on the image just added and click on the Center option  in the editor to center it on the page. 
   4. Continue for all the images for the updated asset
6.  When all images have been added to the body, save the page and verify:
   1. Clicking on each image should put you in preview mode. 
   2. Clicking download from any image should download the full document. 
7. Update the Database entries by
   1. Link - go to the attachments and right click on the asset, select "Copy link address", this puts the address into the paste buffer. 
   2. Select "Edit Contents" to add the PAT attributes: 
   3. Link - paste the link address of the PAT Asset 
   4. Title - this is the full name of the PAT - example: "PAT-999 New Asset"
   5. SWE or Topic - Put in the appropriate codes for the pages on which this asset appears. Also includes codes for categories of which this asset is a member
      1. All entries are separated by a comma and a space
      2. Last entry ends with a comma and a space. 
      3. DO NOT ADD A CARRIAGE RETURN AT THE END OF THE FIELD
      4. for example: "SWE-999, Topic 9.88, AudCK, 
   6. Origin - Enter the code and location for the first use of this asset. Typically it is a SWE or Topic. 
   7. Notes - Enter any other information of interest about the asset. 
   8. Save the page and review the PAT in the PAT Database to
      1. verify that the information is visible
      2. view the "Reports for Asset Categories" and select the reports for which the asset should appear (entries in the SWE or Topic field)

On a SWE or Topic Page 

In "Edit" mode: 

1. Go to the location where the PAT is to be inserted. It may be an existing subheading in a tab, or a new subheading may need to be created. 
2. If you want to pull in only a single image, use the "Excerpt Include" macro to bring in just the first page image. Otherwise, go to step 3 below. 
   1. Be sure to get the PAT from the SITE: space
   2. Check the box to "Remove Surrounding Panel"
   3. Pull in the PAT to preview it and make sure the location can be found
   4. Go to step 4. 
3. If is is appropriate to pull in all of the pages of a document, use the instructions here: 
   1. Use the "Include Page" macro to bring in the whole of the PAT
   2. Be sure to get the PAT page name from the SITE: space
   3. Pull in the PAT to preview it and make sure the location can be found
   4. Note that the include page will pull in the Live Template information but that will be only seen by editors, not users. 
4. Save the page to ensure that the PAT is visible and located where you want it. 
5. Return to edit mode and insert any "SWEREFN" macros to point the user to the resources tab. This is done just like the references. 
6. Go to tab 5 and add subheading 5.3 if necessary. 
   1. use an "Include Page" macro to pull in the appropriate PAT report page for the PATs in the SWE or Topic. 
   2. the PAT is pulled into these reports based on the codes in the Affiliated SWE section of the live template. 

Building a PAT Report Page

PAT Report pages are children of the SITE: Reports for Asset Categories page. 

1. Find the page for the page you are adding the topic or SWE into, if a new page is needed, build a new page from a copy of an existing page. 
   1. Copy the existing page. 
   2. Change the SWE or Topic title as appropriate.
   3. In the Text Filter, change the Include parameter to the SWE-999 or Topic 9.99 designation so the report can be built properly.
   4.  Save all
   5. Test to see if the correct PATs are included in the report page. 
2. Once the page exists, the report is built based on the include code for the SWE or Topic you are inserting it into. Check to see that the PAT appears in the report. 
3. Once the report page is working, insert it into section 5.3 (or appropriate subheading on the Resources page. 

Publish a Blog Post Announcing the New PAT

• Blog post - the simplest way to make users aware of the new PAT is to create a Blog post and publish it. It will appear on the SWEHB Book A. Introduction  page in the right column. See SWEHBDOC Blogs In SWEHB for details on creating and publishing a Blog entry in SWEHB. 

When an attachment is added,

• Ensure that the asset name is spelled out fully, don't use abbreviations if possible, 
• Don't include any version coding in the asset name. Embed the versioning code in the document Properties or in a Header in the document itself. Confluence has it's own versioning system that is independent of the title. 
  • You may use the "Comment" field in the attachments page to contain version information. 
• Drag and drop the asset onto the appropriate box in the "Attach Files" area.
• Use the Properties option to add a Comment to an attachment. The Comment can be used to contain the version information. 

When an asset is to be updated,

1. Download the asset from the PAT page. 
2. Make updates to the asset as necessary.
3. Embed a version code into the document. Either as part of the Header of the document or in the document Properties (in Word, go to  File, Info, Properties, Comments.) 
4. Save the document to your local drive. ensure that the filename has not changed. 
5. Drag and Drop the asset onto the Attach Files section of the PAT page attachments.
6. If you want to add a Comment to the attachment with version information do that now.  
7. Verify that the file has been updated in the PAT page.

The Configuration Management features of Confluence will recognize that there is now a new version of the same document. View all the versions by clicking on the ">" to the left of the document attached to the PAT. You should see all the versions stored in the page along with any Comments that were added.