Professional Documents
Culture Documents
Sample TEch Writing - Process Documentation, Ritzie Edson V. Lamina
Sample TEch Writing - Process Documentation, Ritzie Edson V. Lamina
GRI
Company XXX
1
2
Table of Contents
1. Introduction ................................................................................................ 3
2. Process Diagram ........................................................................................ 3
3. Procedure................................................................................................... 4
Pre-requisites: ............................................................................................ 4
Step 1 ......................................................................................................... 4
Step 2 ......................................................................................................... 5
Step 3 ......................................................................................................... 6
Step 4 ......................................................................................................... 7
Step 5 ......................................................................................................... 8
Step 6 ......................................................................................................... 9
Step 7 ......................................................................................................... 9
Step 8 ......................................................................................................... 9
Step 9 ......................................................................................................... 9
Step 10 ..................................................................................................... 10
4. Common Issues........................................................................................... 11
Footer
3
1. Introduction
This document describes the process of customizing tabs for GRI.
2. Process Diagram
START
Pre-requisites
are met
Type of DELETE
ADD
change?
EDIT
Delete tabs in details.ftl
Add tabs in details.ftl and role_tabset.ftl
and role_tabset.ftl
Open details.ftl and Save Changes
Save Changes role_tabset.ftl
Check Changes in
Supplier page
STOP
Footer
4
3. Procedure
Pre-requisites:
The below items should be met first before proceeding to the next steps:
1) Java Developer tools and editor (i.e. Eclipse) are installed.
2) Developer access to customer-hicxsesm-fri-common package is provided.
3) Software Developer version control is installed (i.e. GitHub).
Step 1
Open Java Editor (i.e. Eclipse) and open customer-hicxsesm-fri-common
package.
Footer
5
Step 2
Search for details.ftl file under supplier = "partner" folder.
Footer
6
Step 3
Open the details.ftl file. The object for the tabs will be under the <#assign
TabMeta ={…}> tag.
Footer
7
Step 4
Update the tab objects according to need or purpose:
a) To ADD tabs:
- Add another tab by typing in a tab object within the brackets under
the <#assign TabMeta ={…}> tag.
- Separate each tab object with a comma.
- Ensure correct syntax is still in place.
b) To EDIT tabs:
- Select and highlight the object tabs to be updated.
- Update the name of the tab.
- Ensure correct syntax is still in place.
c) To REMOVE tabs:
- Select and highlight the object tabs.
- Delete the tabs.
- Ensure correct syntax is still in place.
Footer
8
As best practice:
1) Always remove the tabs you don’t need.
2) Always copy tab objects from other package or file.
Step 5
Search for role_tabset.ftl file under supplier = "partner" folder. We will do the
same changes we did in Step 4 above with this file.
Footer
9
Step 6
Open the role_tabset.ftl file. The same object for the tabs in Step 3 above will be
under the <#assign TabMeta ={…}> tag.
Step 7
Do the same changes performed in Step 4 with the tab objects in the
role_tabset.ftl file.
Step 8
Review the changes done.
Step 9
Save the changes in the Java Editor (i.e. Eclipse).
Footer
10
Step 10
Check the changes in the Supplier page. Ensure the cache is deleted before
loading the Supplier page.
- Go to “Recent Suppliers”
- Select a Supplier to open the details
- Click “Master Data”
- Click Supplier Master Details
Footer
11
4. Common Issues
The following issue can be encountered:
a. Debugger Error
Footer