FAQ-WSA
Back to current versionRestore this version

Frequently Asked Questions - Web Site Administrator Self Service#

Web Site Administrator Questions#

Q:HOW DO I CREATE A FUNCTION?#

A:When you create a function, you will actually need to complete two processes. You will first create the function and then attach that function to a screen.

Only external and manual functions may be created. (i.e. creating a link to your company’s web site.) All other functions are only created either by High Line or under High Line’s direction. You may, however, copy an existing function in order to modify the form.

Create a Function
  1. Access the Maintain Function form through the Web Site Administrator main menu or through the Navigation tree. You will be presented with a list of functions.
  2. Click the Add icon found at the bottom of this list. A blank row will now appear in the list.
  3. Ensure your cursor is on this row. Directly beneath the list are fields that allow you to define the function you wish to enter.
  4. Enter the Product to which the function belongs. e.g. BE
  5. In the appropriate fields, enter the function’s
    1. Name,
    2. Description,
    3. Usage (User Defined),
    4. Type (External or Manual), and
    5. Purpose.
  6. Enter either the URL in the Web Address field or the external function path in PL/SQL Block field.
  7. Define the general execution rights for this function through the Create Allowed, Retrieve Allowed, Update Allowed and Delete Allowed booleans. Normally, external functions are Retrieve Allowed only.
  8. Define the execution rights to this function for a specific role in the Execution Rights tab at the bottom of this form.
  9. Once you are satisfied with the data you have provided, Save the file.
Attach Function to Form
The new function must be attached to a form in order to be accessed.
  1. Access the Create Menus form either through the Web Site Administrator main menu or through the Navigation tree.
  2. Select the menu you wish to add the new function to.
  3. Click the Add icon found at the bottom of the list of the menu’s functions and sub-menus; Located below the Menu Code and Menu Usage. A blank row will now appear in the list.
  4. Ensure your cursor is on that row.
  5. Identify the menu items (functions or menus) that will compose your menu and the order in which they should appear through the Sequence, Code and Type fields.
  6. Enter the name of the new function in the Call Function field
  7. Complete the Label field and if desired, the Icon Name field.
  8. Set the Menu Action Usage to User Defined. This must be completed as stated.
  9. When you are satisfied with the data you have provided, click the Save button.

Q:HOW DO I COPY/EXTEND A FUNCTION?#

A:Copying a function is referred to as ‘extending’. This is due to the fact that when a function is copied, the form attached to the function is also copied.

Functions should only be copied if you wish to make changes to the form attached to the function. (For example, customizing the Employee Time sheet (WEPTS) to your company’s time codes.)

  1. Access the Maintain Function form through the Web Site Administrator main menu, or through the Navigation tree. You will be presented with a list of functions.
  2. Select the function you wish to extend.
  3. Click on Extend Form button located directly beneath the execution rights booleans on the right side of the form.
  4. Find the original function. You will see that you have a new function with CPY added to the original function. In addition, the usage field on the function as well as the form for the function in IMFD have been marked as User Defined.
  5. Go to the Function Name and rename the new function to something more meaningful. i.e. WEPTS CPY can be renamed WEPTS_HL
If you copy/extend a function you should go to IMMS and copy the ‘_FIND’ code as well. i.e. You copy WAPPT and call it WAPPT_HL. Copy the WAPPT_FIND and call it WAPPT_HL_FIND.

Q:HOW DO I DELETE/REMOVE A FUNCTION?#

A:Only functions that you created yourself should be removed. NEVER remove a High Line ‘Pre-loaded’ function.
  1. Access the Maintain Function form through the Web Site Administrator main menu, or through the Navigation tree. You will be presented with a list of functions.
  2. Select the function you wish to remove.
  3. If not already marked as such, change the Function Usage to User Defined.
  4. Save the file.
  5. Re-select the function you wish to remove.
  6. Click the Remove icon within the function.

Q:HOW DO I CREATE A FORM?#

A: You are restricted from creating new forms. All forms are created by High Line or under High Line’s direction. You may, however, copy an existing function in order to modify the form - see How Do I Copy a Function?.

Q:HOW DO I COPY A FORM?#

A:You are restricted from copying new forms. You may, however, copy an existing function in order to modify the form - see How Do I Copy a Function?.

Q: HOW DO I ADD A HEADER OR FOOTER TO A SCREEN?#

A: Although headers and footers appear on the form, they are set up at the Function level.
  1. Access the Maintain Function form through the Web Site Administrator main menu, or through the Navigation tree. You will be presented with a list of functions.
  2. Select the function to which you wish to add the Header and/or Footer.
  3. Click on the Preferences tab.
  4. Click the Add icon found at the bottom of the list of functions.
  5. Enter a Seq. number. We recommend using numbers increased by increments of ten. (e.g. 10, 20, 30, etc.)
  6. Enter in the Preference; HEADER INFO or FOOTER INFO.
  7. Enter the location of the html or jsp file in the Value field i.e. docs/WEDPN_Header.html
  8. Save the file.

High Line has created various sample screen headers and footers throughout Self Service. These headers and footers are either HTML or JSP files which are saved in the "docs" folder under selfService on your 9ias server.

The headers and footers provided can be edited to your requirements. It is recommended, however, that you follow High Line's naming conventions for these files.

Header
Each header is named as follows: FUNCTION_Header.html or FUNCTION_Header.jsp, where FUNCTION is the name of the function to which you will be applying this header (e.g. WEEPP_Header.html).
Footer
Each footer is named as follows: FUNCTION_Footer.html or FUNCTION_Footer.jsp, where FUNCTION is the name of the function to which you will be applying this footer (e.g. WEEP_Footer.html).

A header and/or footer will only appear on a screen if the Header Info and/or Footer Info preferences have been properly setup via the Maintain Functions (IMFN) screen in Self Service Administration module to call the appropriate HTML or JSP document from the "docs" directory.

Whenever Self Service software updates are provided by High Line that all of the documents in the "docs" folder will be overwritten. To avoid losing any newly created documents or changes made to the delivered documents, we recommend that you keep a master copy of ALL required headers and footers outside of the server environment.

Q: HOW DO I CREATE A MENU?#

A:
  1. Access the Create Menus form through the Web Site Administrator main menu, or through the Navigation tree. You will be presented with a list of menus.
  2. Click the Add icon found at the bottom of this list. A blank row will now appear in the list.
  3. Ensure your cursor is on that row. Directly beneath the list, there are a series of fields allowing you to define the new menu.
  4. Fill in the name of the menu in the Menu Code field.
  5. Complete the Sequence, Code and Type fields to identify the menu items (functions or menus) that will compose your menu and the order in which they should appear.
  6. Complete either the Call Function or Call Menu field for each menu item. A menu item may only call either a function or a menu, so you will fill in only one of these two fields.
  7. Complete the Label field and if desired, the Icon Name field.
  8. Set the Menu Action Usage must be User Defined. This must be completed.
  9. Once you are satisfied with the data you have provided, click the Save button.

Q:HOW DO I CREATE A USER NAME?#

A:
  1. Access the Create User (IMUS) form through the Web Site Administrator main menu, or through the Navigation tree. You will be presented with a list of users.
  2. Click the Add icon found at the bottom of this list. A blank row will now appear in the list;
  3. A ensure your cursor is on that row. Directly beneath the list are the fields that allow you to define the user you wish to enter.
  4. Enter the user’s ID/Name and Description in the appropriate fields.
  5. If the user should have access for a limited time period, you may define that time period through the Start Date and End Date fields.
  6. You may provide an Email Address and Password in the appropriate fields
  7. Define the general execution rights for this user through the Create Allowed, Retrieve Allowed, Update Allowed and Delete Allowed booleans.
  8. Define execution rights to a specific function for this user through the Execution Rights tab at the bottom of the form.
  9. At this point you may also define the role’s Preferences and assign Roles.
  10. Once you are satisfied with the data you have provided, click the Save button.

Q: HOW DO I SET UP A GENERIC USER OR USER PROFILE?#

This procedure is a two step process. There are a set of instructions on how to create and assign the Generic User (Group, Shared) or User Profile to multiple employees. Following those instructions are the steps the employee must do when they first enter the application.

Be careful to follow these steps exactly. Create and Assign Generic User or User Profile

  1. Create a generic user profile through Create Users (IMUS) in the Self Service application as specified in How do I create a User Name? For example, EMPLOYEE_PT.
  2. Leave the Self Service application
  3. Access the P2K application.
  4. Go to the Define Identity Information (IEID) form.
  5. From the list of employees, pick the employee to whom you would like to give the new User Profile. For example, Jacqueline Myers.
  6. Click on the User Name field; found in the Access section on the bottom right corner of the form.
  7. Enter the name of User Profile you created in Self Service. As Professional and Self Service are on the same database, any data created in Self Service may be called up in Professional. In the example we are using, you would enter EMPLOYEE_PT. IMPORTANT - at this point you must save the form before you go anywhere else.
  8. Make note of the Person Code. For example, # 4112.
  9. Access the Reset Pin Number (IMRE) form.
  10. Click F7 - Enter Query; You will notice the fields turn black.
  11. Type in the Person Code. In our example, 4112.
  12. Click F8 - Execute Query; You will no longer be in Query mode and your cursor will be in the New PIN# field.