Renaming a Customization Project

If a customer or a regions posses completely new customization project, For example an extension component form a region, need may arise to rename its project, window and assembly names in accordance with new layered application architecture naming standards. In this scenario, developers can follow following steps to rename solution, project, assembly and all its underline windows to the new standards. Depending on the complexity of the customization, developers may have to carry out additional steps other than given below to complete the renaming process.

Contents

• Prerequisites
• Renaming the Solution and Project
• Renaming Windows
• Correcting the Navigator
• Updating the Dictionary
• Updating presentation object repository

Prerequisites

Prior to performing following steps, Developer must make sure that the customization is uplifted to the layered application architecture way (IFS Applications 9) by following Uplifting of a completely new form window guideline.

Renaming the Solution and Project

Following procedure describes how to rename Solution, Project and Project properties in order to adhere to new naming standards.

Procedure:

• Open the solution in Visual studio
• Build the solution to check if everything is ok
• Rename the solution by RMB on solution node -> Rename to have layer name suffixed separated by '_' character and another optional '_' character at the end to indicate private
• Rename the project by RMB on project node -> Rename to have layer name suffixed separated by '_' character and another optional '_' character at the end to indicate private
• Modify the AssemblyInfo.cs to reflect the new layer name of the project by modifying the corresponding attribute

Example:

[assembly: Ifs.Fnd.Core.FndComponent("edicom", "Ext")]

Layer name can be either Ext or Core depending on the situation

•  In project properties window (RMB the project node -> Properties) change Assembly name and Default namespace properties
  • Suffix Assembly name and  Default namespace with the layer name separated by '_' character and optionaly by another '_' character to indicate private.

    Example Assembly name and  Default namespace: ifs.Application.Edicom_Ext

Renaming Windows

Developer should apply following procedure to each and every window (Form, table or dialog) in the project to rename them in accordance with new naming standard.

Procedure:

• Rename the item to have layer name suffixed and separated with '_' character by using RMB on the window -> Rename option

Example: frmEdiComTransport.cs to frmEdiComTransport_Ext.cs

Note: when following above step, <item name>.Designer.cs and <item name>.resx files will automatically be re named

• Open the window in View Code mode and change the namespace by using RMB -> Refractor -> Rename option by suffixing namespace with the layer name separated by '_' character and optional '_' character at the end to indicate private

Example:

namespace Ifs.Application.Edicom_Ext

Note: Re factoring operation will change namespace in entire project thus this is a one time step.

• Re name the class name using RMB -> Refractor -> Rename to have class name suffixed with layer name separated by an '_' character

Example:

public partial class frmEdiComTransport_Ext : cFormWindow

• Open the <item name>.resx file and change the 'this.Name' property to have the new name

Note: Click Yes to the Visual Studio warning on editing a resource file                   

• After correcting all the windows using above steps, close Visual Studio and re name the project folder to reflect new name

Example: ../source/Ifs.Application.Edicom_Ext

Correcting the Navigator

After renaming process, existing navigator-functional.xml and its entries will become invalid. To correct them, developer may need to follow following steps

• Rename the navigator xml file

Example: from navigator-functional.xml to navigator-functional_<layer name>.xml

• Open the navigator xml and change the Source property in the FndNavigator to reflect correct name

Example: Source="<component>\client\navigator-functional_<layer name>.xml"

• Open Navigator Editor from Visual Studio using IFS Development Tools -> Edit Navigator option and update node settings to reflect re named navigator items

At this point, correcting the navigator is complete. More information on editing navigator xml using Edit Navigator option can be found here.

Updating the dictionary

After the move process, the client dictionary needs to be updated. It can be done by running the Generate Dictionary functionality available with IFS Development Tools menu in Visual Studio. More information on generating the dictionary is available here.

Updating presentation object repository

Presentation object corresponding to renamed items should be updated by scanning the entire component. Developer may follow following steps to generate correct presentation object repository.

• Scan the component to add new renamed presentation objects and their dependencies in to repository while removing old ones corresponds to previous presentation object names.
• Correct roles that uses presentation objects from re named assembly to reflect changes.
• Test the new solution well.

More information on the presentation object scanner and its usage can be found here.