This chapter contains the following topics:
Section 7.1, "Understanding Custom Modifications and Packages"
Section 7.4, "Using JD Edwards EnterpriseOne Package Management"
At this point, you are ready to retrofit your custom modifications into the objects delivered in the update. You may also choose to apply Oracle's suggested UDC description Data Dictionary glossary changes. This portion of the update process may involve several iterations of retrofitting and testing, so you will also be building update packages to deliver the modifications to the testing environments. This chapter also explains how to build and test the packages that you will deploy to the workstations.
If you made a backup of original specifications and business functions, you can restore this backup.
See Restoring a Backup.
This section provides an overview of retrofitting custom modifications, discusses prerequisites, and discusses how to retrofit custom modifications for:
Interactive applications
Reports
Table conversions
Tables
Named event rules
C business functions
Most users modify their software to make the functionality more applicable to their business situations. When you update to a new release, you need to transfer your modifications to the new release.
Because re-creating custom modifications each time you update the software would be a laborious process, this chapter explains how to integrate the custom modifications that you made in your current software into the updated software. This integration, called retrofitting, enables you to refit the customizations that can be merged into each new version of the software.
To retrofit modifications, you need a workstation with the upgraded software and the development tools. These tools enable you to compare the customizations that your current software merged into the new software with any path code in the system. This enables you to easily compare the upgraded modifications with a version of your modifications before the upgrade or with the pristine environment of the new release.
This table lists the requirements to retrofit custom modifications.
| Requirement | Details |
|---|---|
| Personnel | A programmer, preferably the same one who did the custom modifications, should perform this task. |
| Logon status | You must be able to log on to the workstation on which you will retrofit object modifications, typically in the development or prototype environment. |
| Package | The environment must be updated and a package must be built and deployed to the workstation being used. |
| Modified Objects | The modified objects must be checked out.
See JD Edwards EnterpriseOne Tools Object Management Workbench Guide. |
To retrofit custom modifications for an interactive application:
From Object Management Workbench (OMW), use Form Design Aid (FDA) to copy custom objects into the target application.
You can use Compare Mode, under the File menu, to help with this process. Everything custom must be copied in FDA, except for Event Rule (ER) variables and ER statements that do not reference any custom objects.
Save your changes.
Within FDA, select Edit and Event Rules.
This option enables you to use EditER to reenter all ER statements that reference any custom objects other than custom ER variables.
Save your work.
Use the JD Edwards ER Compare tool (ER Compare button in OMW or ER Compare command in FDA) to compare the updated local specifications (target) with the original, customized (source) specifications.
Copy ER variables and then ER statements from source to target.
Do not copy any statements that reference objects that existed only in the source (customized) environment. Those should have been created in step 3.
Validate the resulting ER. Save and exit JD Edwards ER Compare.
When you finish retrofitting and testing the modifications, check them back in and rebuild the package.
Test and fix the modifications, and then rebuild and redeploy the corrected package. Repeat this step until all the modifications are functioning properly.
To retrofit custom modifications for a report:
From OMW, use Report Design Aid (RDA) to re-create all custom report objects in the target UBE (universal batch engine).
Within RDA, select Edit and Event Rules.
This option enables you to use EditER to reenter all ER statements that reference custom objects other than custom ER variables.
Save your work.
Use the JD Edwards ER Compare tool (ER Compare button in OMW) to compare the updated local specifications (target) with the original, customized (source) specifications.
Copy ER variables and then ER statements from source to target.
Do not copy any statements that reference objects that existed only in the source (customized) environment. Those should have been created in step 2.
Validate the resulting ER. Save and exit JD Edwards ER Compare.
When you finish retrofitting and testing the modifications, check them back in and rebuild the package.
Test and fix the modifications, and then rebuild and redeploy the corrected package. Repeat this step until all the modifications are functioning properly.
To retrofit custom modifications for a table conversion (TC):
Within OMW, use Table Conversion Design Aid to re-create all custom parts of the target UBE.
Within Table Conversion Design Aid, click the Advanced ER button within the Mapping dialog.
This option enables you to use EditER to reenter all ER statements that reference custom objects other than custom ER variables.
Use the JD Edwards ER Compare tool (ER Compare button in OMW) to compare the updated local specifications (target) with the original, customized (source) specifications.
Copy ER variables and then ER statements from source to target.
Do not copy any statements that reference objects that existed only in the source (customized) environment. Those should have been created in step 2.
Validate the resulting ER. Save and exit JD Edwards ER Compare.
When you finish retrofitting and testing the modifications, check them back in and rebuild the package.
Test and fix the modifications, and then rebuild and redeploy the corrected package. Repeat this step until all the modifications are functioning properly.
To retrofit custom modifications for a table:
Within OMW, on the Design Tools tab, click the Table Trigger Design Aid button and use EditER to reenter all ER statements that reference custom objects other than custom ER variables.
Use the JD Edwards ER Compare tool (ER Compare button in OMW) to compare the updated local specifications (target) with the original, customized (source) specifications.
Copy the ER variables and then the ER statements from the source to the target.
Do not copy any statements that reference objects that existed only in the source (customized) environment. Those should have been created in step 1.
Validate the resulting ER. Save and exit JD Edwards ER Compare.
Use the Table Design Aid tool within OMW to update each table that needs further work.
When you finish retrofitting and testing the modifications, check them back in and rebuild the package.
Test and fix the modifications, and then rebuild and redeploy the corrected package. Repeat this step until all the modifications are functioning properly.
To retrofit custom modifications for a named event rule (NER):
Within OMW, use the JD Edwards ER Compare tool to compare the updated local specifications (target) with the original, customized (source) specifications.
Copy the ER variables and then the ER statements from the source to the target.
Do not copy any statements that reference objects that exist only in the source (customized) environment.
Save and exit JD Edwards ER Compare.
Use the Business Function Design Aid tool from OMW to select and update each business function that needs further work.
Within the Business Function Design Aid tool, select Form and Edit.
The edit option enables you to use EditER to reenter ER statements that reference custom objects. Save your work.
Validate the resulting ER.
When you finish retrofitting and testing the modifications, check them back in and rebuild the package.
Test and fix the modifications, and then rebuild and redeploy the corrected package. Repeat this step until all the modifications are functioning properly.
To retrofit custom modifications for a C business function:
Within OMW, use the JD Edwards ER Compare tool to compare the updated local business function source code (target) with the original, customized (source) code.
Select Edit, Auto Merge Application to merge the code. Save and exit JD Edwards ER Compare.
Start the Business Function Design Aid tool from OMW.
Select Form and Edit to use Microsoft Visual Studio to finish editing the code.
Select the Build Business Function button in OMW to build the business function.
When you finish retrofitting and testing the modifications, check them back in and rebuild the package.
Test and fix the modifications, and then rebuild and redeploy the corrected package. Repeat this step until all the modifications are functioning properly.
This section provides an overview of JD Edwards ER Compare and discusses how to:
Use JD Edwards Visual Compare for UDC Descriptions and Glossary tool.
Use JD Edwards ER Compare for applications and event rules.
Work with JD Edwards ER Compare.
JD Edwards EnterpriseOne provides compare/merge tools to help with the retrofit process for:
Applications.
ER.
UDC Descriptions and the Data Dictionary glossary.
The JD Edwards compare/merge tools enable you to compare two versions of JD Edwards EnterpriseOne objects (APPL, ER, NER, UDC descriptions, DD glossary). For example, if you apply an update containing an application in which you made custom modifications, you will need to retrofit that object. FDA and JD Edwards ER Compare let the developer compare the updated application and NERs to the custom object in the central objects data source of any defined path code, specifications, or Electronic Software Update (ESU) backup.
JD Edwards ER Compare provides a detailed, on-screen comparison of event rules. You can change the target object (your local version) within the utility by moving lines directly from the source. You can also remove or disable lines. In addition to providing an on-screen comparison, you can select to print a report detailing the changes as well.
Oracle's JD Edwards EnterpriseOne Visual Compare for UDC Descriptions and Glossary tool (P96472) enables you to review and apply text updates for Data Dictionary glossaries and UDCs. You can see a side-by-side comparison of the new and old text values, which enables you to choose whether to accept the changes. When you install an ESU containing UDC Description and Glossary changes, an XML file is extracted to the Special Instructions folder on the deployment server and is located in the following directory: ..\E900\SpecialInstructions. The Visual Compare for UDC Descriptions and Glossary Tool, application P96472, is run from an administrative client workstation within JD Edwards EnterpriseOne and applies the changes to the current environment. You must have installed the Planner Update, which contains Software Action Request (SAR) 7481054, completed the special instructions, and built and deployed your package.
To apply DD glossary and UDC description changes:
In the Fast Path, enter P96472.
On Work With Special Instructions, click Add.
On Search and Select Special Instructions, in the Server Share Path field, the path to the Deployment Server special instructions folder appears as the default.
If you have moved the folder or if the appropriate folder does not appear, click the browse button, navigate to the directory that contains the XML file, and select the directory. Click Find.
In the grid, click the appropriate ESU, and then click Select.
The data from the new ESU is imported and the application returns to the Work With Special Instructions form. The new ESUs appear in the grid. The Work With Special Instructions form appears. The ESUs appear in the grid.
Select the appropriate ESU.
Select one of the following options from the Row menu:
Accept: Select this option if you want to accept all updates in the ESU without reviewing them.
Reset Status: Select this option to change the status from Applied to Not Applied or from Reviewed to Not Applied.
Three types of statuses are available:
| Applied | Applied status appears if you have applied everything contained in the ESU. If you have applied parts of the ESU, but not all, then this status will not appear. |
|---|---|
| Not Applied | This status appears if you have not applied any of the ESU contents. |
| Reviewed | This status appears if you have looked at the ESU but not applied any of its contents. |
Select the UDC Description Option to access the Work with UDC Description Changes form. This option is enabled only if the ESU contains changes to UDC descriptions.
The UDCs are grouped by product code and appear in a list underneath the Available UDC Items folder. Only those UDCs that have different descriptions from the ones that already reside in your current environment appear.
You can select individual UDCs, multiple UDCs, or all UDCs. To select all UDCs, click the top-level node located under the Available UDC Items folder. Clicking any node selects all of the UDCs beneath it. To accept the UDC descriptions, click Accept.
You can opt to view all UDCs in the ESU by clicking the All items option. Or, you can opt to view only those items that have not already been reviewed by clicking the Non Reviewed Items option.
Click the double-arrow button to accept the UDC description of the currently selected UDC.
Select the DD Glossary option to access the Work with DD Glossary Changes form. This option is enabled only if the ESU contains changes to DD glossaries.
The DD items are grouped by product code and appear in a list underneath the Special Instructions folder. Only those DD items that have different glossaries from the ones that already reside in your current environment appear.
You can select individual DD items, multiple DD items, or all DD items. To select all DD items, click the top-level node located under the Special Instructions folder. Clicking any node selects all of the DD items beneath it. To accept the DD glossaries, click Accept.
You can opt to view all glossaries in the ESU by clicking the All items option. Or, you can opt to view only those items that have not already been reviewed by clicking the Non Reviewed Items option.
Click the double-arrow button to accept the DD glossary of the currently selected DD.
Select the Preceding ESU option to view a summary of changes previously applied but also contained in the selected ESU.
Select the SARs Related option to view all SARs in the selected ESU containing text changes for UDCs and glossaries.
This section provides an overview of the JD Edwards ER Compare user interface and discusses how to start JD Edwards ER Compare.
JD Edwards ER Compare is a utility that enables you to compare an application on the local workstation (target application) to the source applications defined in:
The central objects data source of any defined path code.
A TAM specifications directory.
An ESU backup.
When you start JD Edwards ER Compare, a tree-structured outline of the application appears on the left. You can change source locations with the Select Source command under the File menu.
Expand an event node in the tree to display a split window that shows the source ER on the left and corresponding target ER on the right. The ER on the right belongs to your local specifications.
The program indicates differences in color, while identical lines are normally displayed in black. Disabled lines are marked with an exclamation point. You can customize the color coding by selecting the Set Colors command from the View menu.
JD Edwards ER Compare normally displays ID numbers and technical details about the currently selected item in two small windows on the status bar. The window on the left annotates the source specification while the window on the right annotates the target specification. This information is superfluous in most cases, and can be deactivated with the Show Object IDs switch under the View menu.
The tool lets you compare a modified application to the original version of that application on the server. JD Edwards ER Compare provides a side-by-side, visual comparison of the event rules for the two applications. Moreover, JD Edwards ER Compare enables you to modify the target ER (your local version) by copying lines directly from the source application. You can also move, remove, and disable ER lines in the target application. To copy all eligible lines in the current event from source to target, use the Copy All command. To copy all eligible lines in every event from source to target, use the Auto Merge Application command in the Edit menu.
To validate your changes before saving, select the Validate Event Rules command from the File menu. A validation will automatically occur before you exit the tool if you have saved changes.
JD Edwards ER Compare can be started from FDA or directly from OMW.
When JD Edwards ER Compare starts, a window appears. On this window, entitled Select the Location of Source Specifications, select one of these locations:
Central Objects Path Code
Enter the server location of the source object (the object to which you want to compare the local ER).
Remote Specifications Location
Enter the TAM location of the source object (the object to which you want to compare the local ER). ESUs are delivered in a TAM package, so use this method to compare the local ER to an object packaged in an ESU.
Software Update Backup
After applying a software update, use this tool to retrofit custom ER from the customized copy on the ESU backup.
Note:
Starting JD Edwards ER Compare under FDA freezes all other programs running on your system, including FDA itself. Finish your work in JD Edwards ER Compare and then exit ER Compare to restore normal operation. The purpose of this action is to prevent two programs from potentially modifying the same set of specifications at the same time.Use the application tree view to identify and display specific application and ER components that have changed. If a parent node is identified as having changed, expand it to see which of its children are different. Expand an event in the tree structure to display its associated code. You can display more than one event at a time.
You can change the target ER with JD Edwards ER Compare. You can also print the ER.
Perform any of these actions to change the target ER:
| Task | Details |
|---|---|
| To copy selected lines from source to target | Select the lines to copy and then select Copy Right. |
| To copy all lines in the current event | See Merging ER in a Single Event. |
| To copy all lines in the application | See Merging ER in the Entire Application. |
| To delete selected lines from the target | Select the lines to delete, and then click Delete. |
| To enable or disable selected lines in the target | Select the lines to enable or disable, and then select Enable/Disable ER. |
| To undo the previous command | Select Undo. |
| To redo the previous command | Select Redo. |
| To reload the last saved version of the specifications | Select Refresh. |
Each command is available from the Edit menu and tool bar.
Note:
Use the Shift key to select multiple, contiguous lines and the Ctrl key to select multiple, noncontiguous lines.When you are copying ER, JD Edwards ER Compare checks ER variable references before copying and automatically fixes nonmatching variable IDs. Not only does JD Edwards ER Compare perform validity checking on ER variables, which are present in almost every ER statement, but it also does many other types of validity checking.
Caution:
Although JD Edwards ER Compare provides validity checking, which eliminates the largest source of invalid ER, you must still be vigilant when using JD Edwards ER Compare. When JD Edwards ER Compare copies ER statements, it does not check all of the object references in those statements. If the ER statements reference objects that do not exist in the target specifications or objects that have different IDs in the source and target specifications, JD Edwards ER Compare may allow the copy operation, which results in invalid ER. Different control IDs are very common for controls or objects that were not in the base version of the application. Controls that were added at separate times to separate versions of the application usually have different control IDs.When you save changes, your local application specifications are updated. JD Edwards ER Compare prompts you to save before either of these operations:
Exit
Select new source location
You can use the Print command to place a copy of the target ER in a text file. JD Edwards ER Compare will generate the text file and open it in your default text editor. You can then print the ER from the text editor.
The Copy All command copies ER lines from the source to the target, but only within the currently displayed event. The command will not delete lines from target ER if they do not exist in the source location. The command also does not necessarily copy all lines. It does not copy lines that would produce any of these types of invalid ER:
Duplicate variables.
Unbalanced IF and ENDIF statements.
Unbalanced WHILE and ENDWHILE statements.
Statements referencing an ER variable that is not defined in the target application.
Statements referencing an ER variable that is defined differently in the target application.
The Auto Merge Application command resides under the Edit menu. It lets you copy ER lines from all events in the source application to the corresponding events in the target application. It works like the Copy All command, but it works on all events at once. The command will not delete lines from target ER that do not exist in the source location. The command also attempts to avoid copying lines that would result in invalid ER.
As with any JD Edwards ER Compare command, you might create invalid ER by using the Auto Merge Application command. As of version 8.98, JD Edwards ER Compare attempts to protect you from this by disabling unsafe operations. For example, JD Edwards ER Compare prevents the accidental creation of references to undefined ER variables. However, it does not recognize references to other kinds of undefined objects. Follow the steps recommended earlier to ensure that your ER remains valid.
Regardless of how you modify the ER, you should validate event rules prior to saving. This command is found under the File menu. If any ER violations occur, delete the offending lines and use EditER to reenter them after you have exited JD Edwards ER Compare.
The package management process provides a means to create a package, to define and build a package, and to deploy packages to both servers and workstations using a step-by-step director process.
Note:
The software update process creates the package definition; you simply build and test the package.Several instances occur in which you will need to update or set up a workstation or server with the JD Edwards EnterpriseOne software. You might need to set up a new workstation, deploy custom solutions to all or to selected users, create a new path code for development, or deploy a fix.
To include any modifications (changed or added business functions or applications) into a package for deployment to workstations (for example, DV900FB or DV900PB), you must define and build one of your own.