Articles in this section

See more

Rename/Delete/Move Form Workflow

  • Updated

Background
Analysis Steps
Implementation/Development Steps

 

Background

Renaming, deleting and moving forms can have side-effects. Because forms can be called by macros, typing templates (TTs) and other forms, it's important to confirm if this request will impact other areas. If investigation shows that the form is being actively used, we may have to rethink or even abandon the request. 

Analysis Steps

On top of the usual analysis items done during Analysis Phase, both the following steps should be done:

  1. Check if the the short code Form Links has the form listed in one of their descriptions. If it is, an update to Form Links will be required.
     
  2. Ask a developer to do a Tech Impact Analysis, which searches the typing templates (TTs), print variables, letters/documents, macros, and forms. Add a subtask for the JIRA named Tech Impact Analysis and assign it to the developer, providing them the full form name. For high-level instructions on how to perform this task, review the Tech Impact Analysis article.

If form references are found, a developer should be assigned to update these to use the short code Form Links rather than be hard-coded. This will make future changes to this form much easier. See the Implementation Tips section for more details.

If the form is not called by Form Links or not found through the tech impact analysis, it's safe to rename it.

For deletion, an additional check is required: review the latest form_usage_by pos.csv internal report to confirm it is not being actively used. This report can be found in our network drive: \\vch\departments\PCAC_EMR\01 - PCCEMR\01-Reports and Data Extracts\Reports\Operational\Script Tool

Implementation/Development Steps

On top of the actual change to rename/delete the form, follow the instructions below depending what was found during Analysis:

  • If a form was detected to have the form to delete/update hardcoded into the embedded macro:
    • For name update or move: have a developer change it so it uses the short code method instead. If the code doesn't currently exist, follow the steps to add it during CC deployment. 
    • For deletion: additional analysis is required to determine if it should be replaced by a different form call or if the button/link that triggers the form launch should be deleted altogether.
       
  • If a TT was detected to have the form name hardcoded, follow the same instructions found in the Typing Template Standard Order article:
    • For name update or move:
      1. Keep note of other variables defined in the macro
      2. Re-copy and paste the Typing Template: Functional Appendix
      3. Re-add the other variables from the previous macro version
      4. Add the form code from the Form Links short code list. If the code doesn't currently exist, follow the steps to add it. 
    • For deletion: remove the reference to the form. If the only purpose is to launch open the form, you should question if the TT should also be deleted.
       
  • If a macro was detected to have the form name hardcoded:
    • For name update or move: have a developer change it so it uses short code method instead. If the code doesn't currently exist, follow the steps to add it during CC deployment. 
    • For deletion: have a developer remove the reference to the form. If the only purpose is to launch open the form, you should question if the macro should also be deleted.