Invalid license: Your evaluation license of Refined expired.
bannerd

A. Introduction

B. Institutional Requirements

C. Project Software Requirements

D. Topics

E. Tools, References, and Terms

F. SPAN
(NASA Only)

Use these checklists when building a new PAT or updating a PAT so you don't forget something. 

UNDER CONSTRUCTION

Checklists for PATs
This page contains macros or features from a plugin which requires a valid license.

You will need to contact your administrator.

1. Configure The Doc Or Other Item Into The PAT Format

Steps to ensure that the PAT is ready for use. Presumes that the PAT is a Word doc.

StepDescriptionDone

For Word documents: ensure that there is a header with the following items in it: 

  • Title for the document
  • Project field
  • Revision Field - usually a date

For Excel documents ensure that the first tab in the spreadsheet is formatted with instructions on using the worksheet. 

  • make sure there is a statement near the top of the sheet instructing the user to download the whole workbook so they can use it as a real Excel workbook.  

2. Check pagination to remove blank pages.
3. Add "PAT" prefix to the revision date.
4. Save the document removing any revision marks in the filename. Keep the filename the same as the document name. 
5. 

Open the doc and make a set of screenshots using the naming convention: 

PAT-###-SS1, PAT-###-SS2. etc.  

Using this convention will mean less work later. If the screenshots change and you upload the new shots using the same numbers, they will automatically appear in the PAT page wothout any additional editing of the images in the page.  


6. You are now ready to built the PAT page.

2. Build New PAT Page

StepDescriptionDone
1.

Go to the PAT Database. 

  • Note the last used PAT number in the database so you can apply the next number to your new PAT
  • Open the PAT-000 - PAT Template Page. This page contains all the structure you will need for the new page. 

2. 

Use a Copy command to create a new page. This page will contain a copy of the template page saving a lot of time reconstructing the page structure. 

  • be sure to uncheck the option to copy attachments - you will add new ones later

3. 

Fix the title of the new page

  • remove "Copy of" 
  • fix the PAT number
  • Replace the title "PAT Template Page" with the new PAT title
  • Save the new PAT page
  • Check the PAT Database to see that the new page is added

4. 

Open the attachments for the new PAT page: 

  • Add the new PAT doc into the attachments
  • Add the Screenshots into the attachments
  • Check the attachments to see that they are all there in the PAT page

5. 

Open the page in the editor: 

  • For each of the "Unknown Attachment" macros, highlight it and insert the new screenshot. 

    • In the "Excerpt" Panel: 

      • Insert Image macro - use SS1 image
      • Size to 800 pixels
      • Add border
      • Edit Link - point to the doc and save
      • Center the image

    • In the body / Panel insert all screenshots SS1 thru SSx

      • Insert Image macro - use SS1 image
        • Size to 800 pixels
        • Add border
        • Edit Link - point to the doc and save
        • Center the image
      • Repeat these actions for the remaining Screen Shots thru SSx


  • copy the title of the PAT into the 2 Panel macros - one in the excerpt, and the other in the body of the page. 
    • Replace "PAT-000 New Asset" with the new title - Format: PAT-### - Title

  • Save the page when done. 

  • Check to see that all the screenshots are displayed in the body of the PAT page. 

6. 

Open the page again using "Edit Contents" - this will build the database entry

  • In Link, paste the URL for the doc - get from doc attachment - "Copy link address"
  • In Title, paste a copy of the doc title including the PAT number as a prefix
  • In SWE or Topic, add SWE code, category codes,  page codes, or Topic codes for the pages on which the PAT is included
    • use a comma as a separator for the codes
    • use a comma and a space at the end of the string
    • DO NOT HIT A RETURN AFTER THE LAST COMMA. A RETURN WILL BREAK THE FILTER AND THE PAT WILL NOT BE INCLUDED IN ANY REPORTS
  • In Origin, put the page code and tab for where the PAT comes from
  • In Notes, put page codes for other places where the PAT can be found including and category codes. 
  • Save the page when done. 
  • Check the entry in the database
    • Open the PAT Database and scroll to the PAT number. The new PAT should be there
    • Ensure that all the fields are properly filled out (compare to other PAT entries)

7. Test the new PAT using the PAT Test Page. Follow instructions on that page to test and verify the new PAT prior to deployment. 

3. Deploy PAT to Target Pages

StepDescriptionDone
1.

Edit the target page, at the location of the PAT, make changes in the text preceding
the PAT to properly introduce it: 

  • add the title of the PAT in an appropriate spot - make sure title is in bold font
  • add a SWEREFN macro after the title to take the user to the Resources page 
    • enter the PAT number in the format "PAT-###" into the SWEREFN macro and hit save. 
  • Add any other introductory text , as necessary. 

2.

In the place where the PAT should appear.

  • If you want just the first screenshot to appear, insert an "Excerpt-Include" macro 
    • insert the PAT page name with a "SITE:" prefix
    • ensure that the "Remove Surrounding Panel" option is checked
  • If you want ALL the screenshots to appear, insert an "Include-Page" macro 
    • insert the PAT page name with a "SITE:" prefix
  • Save the page

3. 

Check to see that the PAT appears in the location properly.

  • Look at the PAT in the location you placed it. 
    • Make sure the introductory text look right
    • Make sure that the superscript link to the Resources page works - click on it to go to the Resources page. 
    • Make sure the excerpt (single screenshot) or include page (all the screenshots) display properly. 
    • click on a screenshot to get into the previewer. check to see that the doc is displayed and you can scroll to all pages. 
    • click on download and make sure that the system offers to download the doc to your hard drive. 
  • Fix any problems

4. Build and Deploy Reports of PATs on a Page

When one or more PATs appear on a SWE, Topic, or Other page, a list of them should appear in the tab containing the Resources. 

StepDescriptionDone
1. 

On the Resources tab, add a section for "Process Asset Templates" below the Tools entry, if necessary. 


2. 

Check the following links to see if a report page exists for the type of page you are adding the PAT to. 

If the report page exists, check to make sure that the new PAT appears in the report. 

If there is no report page, build a report page for the PATs in the target page:

  • For a SWE target page, go to SWE Reports for Process Asset Templates and
    open one of the pages below it. 
    • Copying the page ensures that a copy is made under SWE Reports for Process Asset Templates
    • Fix the title of the new page so that it points to the proper SWE
    • Edit the report "Text Filter", Include parameter, to contain the right SWE number
    • Save the macro and the page.
    • Check to see that the report contains the appropriate PAT
  • For a Topic target page, go to Topic Reports for Process Asset Templates and
    open one of the pages below if. 
    • Copying the page ensures that a copy is made under Topic Reports for Process Asset Templates
    • Fix the title of the new page so that it points to the proper Topic
    • Edit the report "Text Filter", Include parameter, to contain the right Topic number
    • Save the macro and the page.
    • Check to see that the report contains the appropriate PAT
  • For an Other target page, go to Other Reports for Process Asset Templates and
    open one of the pages below if. 
    • Copying the page ensures that a copy is made under Other Reports for Process Asset Templates
    • Fix the title of the new page so that it points to the proper page code
    • Edit the report "Text Filter", Include parameter, to contain the right page code
    • Save the macro and the page.
    • Check to see that the report contains the appropriate PAT

3. 

Edit the target page, in the Resources tab: 

  • In the new Process Asset Templates section, add an Include-page macro pointing to the
    new report page you just created. 
  • Save the page
  • Check to see that the report contains the appropriate PAT

5. PATs added to a PAT Category

Some PATs are also a member of one or more categories (see PAT Categories) 

StepDescriptionDone
1.

If the PAT should be in an existing Category (see the list in PAT Categories),
just make sure that the category code is entered into the database entry in the "SWE or Topic" field


2. 

To add a Category Report to a target page: 

  • edit the target page, Resources tab, 
    • Add a new section for the category of PATS
    • Add an "Include-page" to pull in the appropriate category report 
  • Save the target page. 
  • Check to see that the new report appears in the appropriate place. 

6. Create a New Category

When creating a new category of PATs, you must ensure that it is unique and has a unique code for use in the PAT database. 

StepDescriptionDone
1.

Review the list of categories and codes in the page PAT Categories

  • Note that each category page name has an excerpt listed next to it with an
    embedded category code 
  • The new category should not be a duplicate of an existing category. Review the
    existing codes to see if any are close to the proposed new code
  • Create a new, unique code to go with the new category 

2. 

To create a new category, go to PAT Categories:

  • Open an existing page
  • Copy that page, so that the new report appears under  PAT Categories:
  • Fix the title:
    • Remove the "Copy to"
    • Fix the title to remove the old category name and add the new category name
    • Edit the "Text Filter" to replace the old category code with the new category code
    • Edit the "Excerpt" to replace the old category code with the new category code
  • Save the report.
  • Check to see that the report doesn't display errors.
    • Note that initially, there will be a note in the report that there are no entries to report

3. Check in PAT Categories to see that the new report page appears as expected
4. 

For each PAT that belongs in the new category, open that PAT's entry in the PAT Database and
add the category code into the "SWE or Topic" field.

  • Verify that the PATs now appear in the new Category Report. 

5. Add the new category report into other SWE, Topic, or Other pages as appropriate. Add to Resources tab as appropriate. 

 2. Update a PAT

Use this checklist when updating a PAT so you don't forget something. 

2. Update the PAT Page

StepDescriptionDone
1.

Go to the PAT Database. 

  • open the PAT page in a new tab. 

2. 

Open the attachments for the PAT page: 

  • Add the new PAT doc into the attachments - since the filename should be the same, a new version will be created in the PAT page. 
  • Add the Screenshots into the attachments - since the filenames should be the same, new versions will be created in the PAT page. 
  • Check the attachments to see that they are all there in the PAT page

3. 

Open the page in the editor: 

  • Check to see that the images have been properly updated. 
  • If there are more screenshots to add, insert them as necessary  

    • In the body / Panel 

      • Insert Image macro - use the next image
        • Size to 800 pixels
        • Add border
        • Edit Link - point to the doc and save
        • Center the image
      • Repeat these actions for the remaining Screen Shots


  • If the title of the PAT has changed, copy the title of the PAT into the 2 Panel macros - one in the excerpt, and the other in the body of the page
    • Format: PAT-### - Title

  • Save the page when done. 

  • Check to see that all the screenshots are displayed in the body of the PAT page. 

4. 

Open the page using "Edit Contents" - this will build the database entry

  • In Link, paste the URL for the doc - get from doc attachment - "Copy link address"
    • Use the latest version of the doc. 
  • In Title, if the title has changed, paste a copy of the doc title including the PAT number as a prefix
  • If necessary, in SWE or Topic, add SWE code, category codes,  page codes, or Topic codes for the pages on which the PAT is included
    • use a comma as a separator for the codes
    • use a comma and a space at the end of the string
    • DO NOT HIT A RETURN AFTER THE LAST COMMA. A RETURN WILL BREAK THE FILTER AND THE PAT WILL NOT BE INCLUDED IN ANY REPORTS
  • In Origin, if necessary, update the page code and tab for where the PAT comes from
  • In Notes, put page codes for other places where the PAT can be found including and category codes. 
  • Save the page when done. 
  • Check the entry in the database
    • Open the PAT Database and scroll to the bottom. The new PAT should be there
    • Ensure that all the fields are properly filled out (compare to other PAT entries)

5. Test the new PAT using the PAT Test Page. Follow instructions on that page to test and verify the new PAT prior to deployment. 

3. Deploy PAT to Target Pages

StepDescriptionDone
1.

Check the target page to verify that the updates to the PAT appear as expected. 

If necessary, edit the target page, at the location of the PAT, make changes in the text preceding
the PAT to properly introduce it: 

  • add the title of the PAT in an appropriate spot - make sure title is in bold font
  • add a SWEREFN macro after the title to take the user to the Resources page 
    • enter the PAT number in the format "PAT-###" into the SWEREFN macro
  • Add any other introductory text , as necessary. 

2.

In the place where the PAT should appear.

  • If you want just the first screenshot to appear, insert a "Excerpt-Include" macro 
    • insert the PAT page name with a "SITE:" prefix
    • ensure that the "Remove Surrounding Panel" option is checked
  • If you want all the screenshots to appear, insert a "Include-Page" macro 
    • insert the PAT page name with a "SITE:" prefix
  • Save the page
  • Check to see that the PAT appears in the location properly. Fix any problems

4. Build and Deploy Reports of PATs on a Page

When one or more PATs appear on a SWE, Topic, or Other page, a list of them should appear in the tab containing the Resources. The codes you added or updated in the database determine which reports the PAT will appear in. 

StepDescriptionDone
1. 

On the Resources tab, check to see that there is a section for "Process Asset Templates" below the Tools entry, add one if necessary. 


2. 

Check the following links to see if a report page exists for the type of page you are adding the PAT to. 

If the report page exists, check to make sure that the new PAT appears in the report. 

If there is no report page, build a report page for the PATs in the target page:

  • For a SWE target page, go to SWE Reports for Process Asset Templates and
    open one of the pages below it. 
    • Copy the page so that a copy is made under SWE Reports for Process Asset Templates
    • Fix the title of the new page so that it points to the proper SWE
    • Edit the report "Text Filter", Include parameter, to contain the right SWE number
    • Save the macro and the page.
    • Check to see that the report contains the appropriate PAT
  • For a Topic target page, go to Topic Reports for Process Asset Templates and
    open one of the pages below if. 
    • Copy the page so that a copy is made under Topic Reports for Process Asset Templates
    • Fix the title of the new page so that it points to the proper Topic
    • Edit the report "Text Filter", Include parameter, to contain the right Topic number
    • Save the macro and the page.
    • Check to see that the report contains the appropriate PAT
  • For an Other target page, go to Other Reports for Process Asset Templates and
    open one of the pages below if. 
    • Copy the page so that a copy is made under Other Reports for Process Asset Templates
    • Fix the title of the new page so that it points to the proper page code
    • Edit the report "Text Filter", Include parameter, to contain the right page code
    • Save the macro and the page.
    • Check to see that the report contains the appropriate PAT

3. 

Edit the target page, in the Resources tab: 

  • In the new Process Asset Template section, add an Include-page macro pointing to the
    new report page you just created. 
  • Save the page
  • Check to see that the report contains the appropriate PAT

5. PATs added to a PAT Category

Some PATs are also a member of one or more categories (see PAT Categories) 

StepDescriptionDone
1.

If the PAT should be in an existing Category (see the list in PAT Categories),
just make sure that the category code is entered into the database entry in the "SWE or Topic" field


2. 

To add a Category Report to a target page: 

  • edit the target page, Resources tab, 
    • Add a new section for the category of PATS
    • Add an "Include-page" to pull in the appropriate category report 
  • Save the target page. 
  • Check to see that the new report appears in the appropriate place. 

6. Create a New Category

When creating a new category of PATs, you must ensure that it is unique and has a unique code for use in the PAT database. 

StepDescriptionDone
1.

Review the list of categories and codes in the page PAT Categories

  • Note that each category page name has an excerpt listed next to it with an
    embedded category code 
  • The new category should not be a duplicate of an existing category. Review the
    existing codes to see if any are close to the proposed new code
  • Create a new, unique code to go with the new category 

2. 

To create a new category, go to PAT Categories:

  • Open an existing page
  • Copy that page, so that the new report appears under  PAT Categories:
  • Fix the title:
    • Remove the "Copy to"
    • Fix the title to remove the old category name and add the new category name
    • Edit the "Text Filter" to replace the old category code with the new category code
    • Edit the "Excerpt" to replace the old category code with the new category code
  • Save the report.
  • Check to see that the report doesn't display errors.
    • Note that initially, there will be a note in the report that there are no entries to report

3. Check in PAT Categories to see that the new report page appears as expected
4. 

For each PAT that belongs in the new category, open that PAT's entry in the PAT Database and
add the category code into the "SWE or Topic" field.

  • Verify that the PATs now appear in the new Category Report. 

5. Add the new category into other SWE, Topic, or Other pages as appropriate. 

  • No labels
Page Editor: Tim Crumbley
NASA Official: Tim Crumbley
Accessibility
NASA Software Engineering Handbook - A service of the NASA Office of the Chief Engineer
NASA Privacy Statement
______________________________________________________________________________