SWEHBDOC - Add a New Pat

The easiest way to build a new PAT is to copy an existing PAT. By doing this you will avoid forgetting some seemingly minor feature and causing major problems. 

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.