Rule Maintenance Documentation Procedures - Revision history

Freddy at 18:55, 13 December 2018

2018-12-13T18:55:03Z

Freddy at 18:54, 13 December 2018

2018-12-13T18:54:03Z

Freddy at 18:49, 13 December 2018

2018-12-13T18:49:12Z

Freddy at 18:47, 13 December 2018

2018-12-13T18:47:45Z

Freddy at 18:42, 13 December 2018

2018-12-13T18:42:14Z

Freddy: Created page with " ==PURPOSE== To formalize the expectations and procedures for documenting new Rule Maintenance records or updates to existing Rule Maintenance records in the Adjutant Wiki...."

2018-12-13T18:41:02Z

Created page with " ==PURPOSE== To formalize the expectations and procedures for documenting new Rule Maintenance records or updates to existing Rule Maintenance records in the Adjutant Wiki...."

New page

==PURPOSE==

To formalize the expectations and procedures for documenting new Rule Maintenance records or updates to existing Rule Maintenance records in the Adjutant Wiki.

==APPLICABILITY ==

This applies to any ECR development that affects a Rule Maintenance record, whether it is a customer-facing development, or an internal development that is not intended for release notes. Any Rule Maintenance additions or changes should be properly documented in the Adjutant Wiki.

==POLICY (The goal/expectation/standard to reinforce)==

Every development that affects a Rule Maintenance record should be fully documented so that we have a complete resource for internal support teams and for our customers.

Ideally, the Rule Maintenance Wiki should include details like:
*Which application(s) the rule affects
*How the rule is used
*If it is part of a larger development, it should include links/references to any other required setups needed
*ALL rule text, number, and logic fields should be documented - even if it is to document that no number or logic fields are in use

New rule records MUST be added with the appropriately formatted page name (see details below), so that he F12 Wiki link opens the correct page.

==PROCEDURES (Steps/Action Items/Behaviors taken to meet expectations)==

===Creating the correct page name===

When creating a new page, use the 'Specify page name manually' link to open up the "Page Name' field for editing.
*The Wiki Page Name must be saved as ‘RULE-XXXXXX’ where XXXXXX is the internal key name for the rule. If the page is created following this format, the F12 Wiki jump will open the exact page.
**If you miss this step before saving, the 'Admin' button can be used to select the 'Administrate' option and rename the page to the correct format.

===Page Title Standard===
The Wiki Page Title should be the standard Rule Description. We do not want to use the internal key name, but rather the ‘friendly’ description. For example, instead of PROJREVSOT, the Page Title should be Project Review SO Types.

Follow the naming guidelines from the MASTER standards rule names.
*If the rule relates to Item controls, the first word in the rule should be Item (or Project for Projects, AP for Accounts Payable, etc).
*This helps keep all of the related rules sorted together and makes it easier to find them for our customers
*Review the MASTER rules to confirm the expected abbreviation

===Image Standards===

When creating an image for a new rule, choose an image that has data in the rule. This makes it easier to understand how the rule should be filled out.
*Avoid using junky data in the rule. Use realistic, business examples rather than cats and flowers.
*If the rule is complex, and needs additional clarification on how the rule pieces work together, consider using image markups to highlight certain sections or areas that need additional information

Use the Rule Maintenance folder as the standard folder when uploading images. Do not use the Rules folder, and do not place the images in the root folder.

Images should be saved with the file name matching the page file name, but with a _1, _2, _3 sequence indicator. For example, if your page file name is RULE-SHIPVIA, and you upload 3 image files, they should be named RULE-SHIPVIA_1.JPG, RULE-SHIPVIA_2.JPG, and RULE-SHIPVIA_3.JPG.

Use the Insert Image button to insert any image files. Select Auto as the alignment. Fill in the caption field.

===Page Categories===

Verify that you have selected the appropriate Page Categories checkboxes. Rule Maintenance should always be checked, and each associated application module should also be checked.

===Sample Format===

You can either copy an existing Rule Maintenance page that has been created with the correct formatting, or you can copy and paste the text below as a template. Review and adjust the spacing as needed.

{TOC}

===General Information===

'''Default Menu Location''' Maintain >> System >> Rule Maintenance

'''Function''' Enter one or two sentences about the purpose or intended use of the rule. Include any associated applications and helpful information about how the rule is used.

*** (insert an image of the rule maintenance record, with reasonable settings)

===Rule Setup – Text Fields===

'''TEXT1 LABEL:''' Enter a brief statement about the purpose and use of TEXT1.
'''TEXT2 LABEL:''' Enter a brief statement about the purpose and use of TEXT2.
'''TEXT3 LABEL:''' Enter a brief statement about the purpose and use of TEXT3.
'''TEXT4 LABEL:''' Enter a brief statement about the purpose and use of TEXT4.

===Rule Setup – Number Fields===

'''NUM1 LABEL:''' Enter a brief statement about the purpose and use of NUM1.
'''NUM2 LABEL:''' Enter a brief statement about the purpose and use of NUM2.
'''No Number Fields In Use''' (Leave this line in place if there are no Num records – makes it clear that the Num area is blank intentionally)

===Rule Setup – Logic Fields===

'''LOGIC1 LABEL:''' Enter a brief description about the purpose and use of LOG1.
'''LOGIC2 LABEL:''' Enter a brief description about the purpose and use of LOG2.

===Additional Details===

Enter any freeform notes, procedures, helpful information, or examples that add value. If there are no additional notes needed, remove this section.

[[Category: SOP Guides]]
[[Category: Documentation]]

@@ Line 68: / Line 68: @@
 ===Sample Format===
-You can either copy an existing Rule Maintenance page that has been created with the correct formatting, or you can use TST file template below. Review and adjust the spacing as needed.
+You can either copy an existing Rule Maintenance page that has been created with the correct formatting, or you can copy the text below to use as a template. Review and adjust the spacing as needed.
   <nowiki>

@@ Line 70: / Line 70: @@
 You can either copy an existing Rule Maintenance page that has been created with the correct formatting, or you can use TST file template below. Review and adjust the spacing as needed.
- <nowiki>{TOC}
+===General Information===
- <nowiki>'''Function'''  Enter one or two sentences about the purpose or intended use of the rule. Include any associated applications and helpful information about how the rule is used.
+'''Default Menu Location''' Maintain >> System >> Rule Maintenance
-  <nowiki>*** (insert an image of the rule maintenance record, with reasonable settings)
+'''Function'''  Enter one or two sentences about the purpose or intended use of the rule. Include any associated applications and helpful information about how the rule is used.
- <nowiki>===Rule Setup – Text Fields===
+'''TEXT1 LABEL:'''  Enter a brief statement about the purpose and use of TEXT1.
 '''TEXT2 LABEL:'''  Enter a brief statement about the purpose and use of TEXT2.
- <nowiki>'''TEXT1 LABEL:'''  Enter a brief statement about the purpose and use of TEXT1.
+'''TEXT3 LABEL:'''  Enter a brief statement about the purpose and use of TEXT3.
- <nowiki>'''TEXT2 LABEL:'''  Enter a brief statement about the purpose and use of TEXT2.
+'''TEXT4 LABEL:'''  Enter a brief statement about the purpose and use of TEXT4.
-  <nowiki>===Rule Setup – Logic Fields===
+'''NUM1 LABEL:'''  Enter a brief statement about the purpose and use of NUM1.
- <nowiki>Enter any freeform notes, procedures, helpful information, or examples that add value.  If there are no additional notes needed, remove this section.
+===Additional Details===
 [[Category: SOP Guides]]
 [[Category: Documentation]]

@@ Line 33: / Line 33: @@
 *The Wiki Page Name must be saved as ‘RULE-XXXXXX’ where XXXXXX is the internal key name for the rule. If the page is created following this format, the F12 Wiki jump will open the exact page.
 **If you miss this step before saving, the 'Admin' button can be used to select the 'Administrate' option and rename the page to the correct format.
 ===Page Title Standard===
@@ Line 41: / Line 43: @@
 *This helps keep all of the related rules sorted together and makes it easier to find them for our customers
 *Review the MASTER rules to confirm the expected abbreviation
 ===Image Standards===
@@ Line 53: / Line 57: @@
 Use the Insert Image button to insert any image files. Select Auto as the alignment. Fill in the caption field.