Use this checklist when building a new PAT so you don't forget something.
1. Prepare PAT
Steps to ensure that the PAT is ready for use. Presumes that the PAT is a Word doc.
Step | Description | Done |
---|---|---|
For Word documents: ensure that there is a header with the following items in it:
| ||
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
Step | Description | Done |
---|---|---|
1. | Go to the PAT Database.
| |
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.
| |
3. | Fix the title of the new page
| |
4. | Open the attachments for the new PAT page:
| |
5. | Open the page in the editor:
| |
6. | Open the page again using "Edit Contents" - this will build the database entry
| |
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
Step | Description | Done |
---|---|---|
1. | Edit the target page, at the location of the PAT, make changes in the text preceding
| |
2. | In the place where the PAT should appear.
| |
3. | Check to see that the PAT appears in the location properly.
|
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.
Step | Description | Done |
---|---|---|
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:
| |
3. | Edit the target page, in the Resources tab:
|
5. PATs added to a PAT Category
Some PATs are also a member of one or more categories (see PAT Categories)
Step | Description | Done |
---|---|---|
1. | If the PAT should be in an existing Category (see the list in PAT Categories), | |
2. | To add a Category Report to a target page:
|
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.
Step | Description | Done |
---|---|---|
1. | Review the list of categories and codes in the page PAT Categories
| |
2. | To create a new category, go to PAT Categories:
| |
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
| |
5. | Add the new category report into other SWE, Topic, or Other pages as appropriate. Add to Resources tab as appropriate. |