Customizing client code

This section describes the very simplest client customization, step-by-step, to help you getting started doing changes using the LAA concepts.

Scenario

There are two different scenario described. First one where you create a new window in your customization and the second one, using an existing core window that is being customized.
Customized component is ENTERP.

Pre-Requirements

• Visual Studio 2013
• APF Development Tools 90.452.x.x
• ISD with the Core project downloaded in to workspace folder

  (How ISD should be used in this context is described in: IFS Application 9 Layered Customization Development Support)
   

Creating a customization project

• Open Ifs.Application.Enterp.sln (<root>\enterp\source\enterp\client\Ifs.Application.Enterp) using Visual Studio 2013 (VS)
• Using Solution Explorer, select the project Ifs.Application.Enterp, RMB click it and choose Customize this project
• Select the Cust layer in the Layer dialog and press OK
  A new solution, named Ifs.Application.Enterp_Cust.sln will be created and then opened in Visual Studio 2013.
  It's physically located side-by-side with the original solution (<root>\enterp\source\enterp\client\Ifs.Application.Enterp_Cust)
  The original solution, Ifs.Application.Enterp.sln, will be closed
• From here, go to Add a new window or Customize an exiting window

Add a new window

• In VS, go to the Solution Explorer and expand the customization project Ifs.Application.Enterp_Cust
• Select  Forms, RMB click it and choose Add, then New Item...
• In the Add New Item dialog, select the IFS Application Forms templates and then Form Window
• Name the window frmCompanyCar and press the Add button
  A cFormWindow named frmCompanyCar will be created in the Ifs.Application.Enterp_Cust project
• Open the toolbar menu IFS Development Tools and choose Generate Dictionary
• In the Add Projects to Dictionary dialog, ensure that your customized project is checked together with Merge Team Server Dictionary and press OK
  MSBuild will rebuild the client dictionary, adding the customized assembly and its new window.
  In the Summary, there should be an entry stating that there's a layer named Cust, containing 1 new form
• Close the MSBuild script window
• In VS, open the toolbar menu IFS Development Tools and choose Edit Navigator
• In the left pane, select IFS Applications -> Application Base Setup -> Enterprise
• RMB click it and choose Add Entry
• Change Type to Form Window
• Set Name to Company Car
• Set Form Name to frmCompanyCar
• Change the File to ...\navigator-functional_cust.xml
• Press OK
  A new navigator entry will be  created at the bottom of the Enterprise sub folder
• Change its Ordinal from 0 to 450
  The navigator entry will be placed between the Supplier and the Person windows
• In the toolbar, press Save
  A notification message will pop up telling that the changes has been saved to the ...\navigator-functional_cust.xml file.
• Do not close the Navigator Editor. First, press the Deploy Navigator Files button in the toolbar
  Another notification message will show "Generation complete. Start IFS Enterprise Explorer to user the new navigator"
• Press OK and close the Navigator Editor.
• Go to the common section Presentation Object Scanning and run follow its steps, before you continue with the remaining steps here.
• Logon the IEE
• Open Application Base Setup -> Enterprise
• Your new form, Company Car, should now be visible, being found between the Supplier and Person

Customize an existing window

• In VS, go to the Solution Explorer, expand the original project Ifs.Application.Enterp
• Select the form you want to customize, in this example the frmPersonInfo.cs
• RMB click it and choose Customize this item
  This will result in getting a new window named frmPersonInfo_Cust.cs in the Ifs.Application.Enterp_Cust project
  The window frmPersonInfo_Cust derives from frmPersonInfo and contains only changed code (which is the object name and System Methods)
• Open the toolbar menu IFS Development Tools and choose Generate Dictionary
• In the Add Projects to Dictionary dialog, ensure that your customized project is checked together with Merge Team Server Dictionary and press OK
  MSBuild will rebuild the client dictionary, adding the customized assembly and its window.
  In the Summary, there should be an entry stating that there's a layer named Cust, containing 1 extended form
• Go to the common section Presentation Object Scanning and run follow its steps, before you continue with the remaining steps here.
• Logon the IEE
• Open Application Base Setup -> Enterprise -> Person
• The Person form is now be replaced, navigating to frmPersonInfo_Cust instead of frmPersonInfo.
  Test that by opening the window Person and check for its customized URL (in the address bar in the upper part of IEE).

Presentation Object Scanning

• Compile the solution and start IEE, logging on as app-owner or an admin user.
• Open window Developer Tools -> Presentation Object Scanner
• Select ENTERP as the component for scanning in the drop down.
• To the right of the Source Filed list view window, click the link named Add Folder
• Browse the customized project folder, <root>\enterp\source\enterp\client\Ifs.Application.Enterp_Cust and select it
• Press Start scan
  This might take some seconds since the scanner writes the scan result to the database.
• Once the scan completes, press the link View scan results and ensure you have globalENTERP_Cust listed among the extracted PO objects
  Apart from the global object, you should also have following PO object depending on if it's a added window or a customized window

  Added window -> Ensure you have frmCompanyCar in the list of extracted PO objects
  Customized window -> Ensure you have frmPersonInfo_Cust with a Extended From dependency to its parent form frmPersonInfo.

• Press the link Transfer scan result to live repository
  This deploys the scan result and activates it in the the system.
• Press Export, browse to the <root>\enterp\database\enterp folder and press OK
  This will create the PO repository file, EnterpPresObjectRepository-Cust.ins, that should later be checked in using ISD together with the rest of the customization source code.
• Open window Refresh Server Cache
• Check the row having Cache Type set to Security and press Refresh
• Logoff