Additional Branding Tasks

Maintaining Content References in a Custom Tabs Navigation Collection

You can use the Structure and Content component to maintain content references in a custom tabs navigation collection. This will allow you to:

• Disable a homepage tab by selecting the hide from portal navigation attribute.

• Enable the display of a homepage tab (for example, one of the tabs delivered as sample data) by deselecting the hide from portal navigation attribute.

• Manually create a content reference to a remote non-component-based item.

To access a custom tabs navigation collection in the Structure and Content component:

1. Select PeopleTools > Portal > Structure and Content.

2. Click the Portal Objects link.

3. Click the Navigation Collections link.

4. Click the link for the custom tabs navigation collection.

This example illustrates the fields and controls on the Structure and Content page for a custom tabs navigation collection.

To disable a custom homepage tab, click the Edit link for that content reference. Then, select the Hide from portal navigation option and save the definition.

To enable a custom homepage tab, click the Edit link for that content reference. Then, deselect the Hide from portal navigation option and save the definition.

Creating a Content Reference to a Remote, Non-Component-Based Item

To manually create a content reference to a remote, non-component-based item such as a remote dashboard to be used as a custom homepage tab:

1. On the Structure and Content page click the link labeled Add Content Reference.

   This example illustrates the fields and controls on the Content Ref Administration page.

   

2. Specify the node name of the portal host node, such as HRMS, ERP, or LOCAL_NODE.

   Note: For a remote dashboard, the Node Name field can specify LOCAL_NODE or can be left blank.

3. In the URL Type field, select one of the following:

   • PeopleSoft Generic URL – For remote content from a PeopleSoft application.

   • Non-PeopleSoft URL – For remote content from a non-PeopleSoft system, such as an external web site.

4. In the Portal URL field, enter a partial or full URL depending on the URL type:

   • For a PeopleSoft Generic URL, navigate to the remote item through the menu from the local system. Copy the full URL. Then, remove the server, port, servlet, site, portal, and node from the URL, leaving you with a partial URL string.

     For example, when navigating using unified navigation from a local PeopleSoft Interaction Hub system, a partial URL string would be similar to the following:

     h/?tab=REMOTEUNIFIEDDASHBOARD&unifieddashboard=y&remotedburl=http%3a%2f%2fserver%3aport%2fpsp%2fps%2fEMPLOYEE%2fHRMS%2fh%2f%3ftab%3dHC_HRS_RECRUITING_HOMEPAGE_TAB%26pslnkid%3dHC_HRS_RECRUITING_HOMEPAGE_LNK&uninavpath=Recruiting%20Dashboard{HC_HRS_RECRUITING_HOMEPAGE_TAB}

     For example, a partial URL string for a remote SmartNavigation folder would be similar to the following:

     c/ROLE_EMPLOYEE.HRCD_CO_DIRECTORY.GBL?NAVSTACK=Clear&pt_fname=HC_COMPANY_DIRECTORY&isleaf=false&abnpcode=WEBLIB_HRCD.ISCRIPT1.FieldFormula.IScript_setFolderFromTree&abnds=t&TREE_NAME=COMPANY_DIRECTORY&TREE_SETID=&TREE_USERKEY=&TREE_EFFDT=&TREE_BRANCH=&abnnode=&cmd=uninav&unabnfldr=false&uninavabnpcode=

   • For a Non-PeopleSoft URL, copy the full URL from the browser and paste it into the Portal URL field. For example:

     http://server.example.com/content/my_info.html

     Note: Alternatively, you can use the Node Definitions page to create a node definition for the non-PeopleSoft system, which would include the definition of the Content URI Text field—for example, http://server.example.com/. If you identify that non-PeopleSoft node through the NODE attribute as indicated in step 5, then you can specify a partial URL—for example, content/my_info.html. See Defining Portal Nodes for more information.

5. Define the following four content reference attributes to link the content reference to a remote menu item and enable real-time security checks:

   Name	Attribute Value
   CREFID	The name of the remote CREF as defined in the content provider system.
   LOCATION	REMOTE
   NODE	The portal host node name of the remote node.
   PORTAL	The name of remote portal. This must be the same name as the current portal in the local system—for example, EMPLOYEE.

6. Save the content reference definition.

Register Fluid Theme Style Sheet Mappings Page

Use the Register Fluid Theme Style Sheet Mappings page to register a mapped theme style sheet to the specified theme definition. This page provides an alternative to manually selecting the style sheet pair on the Assemble Themes page.

This example illustrates the fields and controls on the Register Fluid Theme Style Sheet Mappings page.

Create Data Migration Project Page

Use the Create Data Migration Project page to add the selected theme style sheets and all images they use to a Data Migration Workbench project. You can use this project to migrate all of the theme style sheets and images to a different system—for example, if you generate the theme style sheets on one system and then must distribute and register these style sheets on other systems in a cluster.

Once the project is created, you will be given the opportunity to open the project in Data Migration Workbench.

This example illustrates the fields and controls on the Create Data Migration Project page.

Example

The following provides and example of how you can use a free form style sheet to modify the display certain page elements and to invoke custom JavaScript to provide additional formatting:

1. Upload a new free form style sheet object. For example, upload the following as MY_BRANDING_DEMO:

   /* Page Titles */
   .PAPAGETITLE, .PSSRCHTITLE, .PSQRYTITLE {
     color: #FF0000;
   }
   
   /* Grid Border */
   .PSLEVEL1GRIDWBO, .PSLEVEL2GRIDWBO, .PSLEVEL3GRIDWBO {
     border-color: #FF0000;
   }
   
   /* Group Box Border */
   .PSGROUPBOXWBO {
     border-color: #FF0000;
   }
   
   /* Highlighter Active Field */
   .FIELD_HIGHLIGHTER {
     border-color: #FF0000;
     background-color: #D2D2D2;
   }

2. Upload a new JavaScript object. For example, upload the following as FIELD_HIGHLIGHTER:

   (function($) {
     $(document).ready(function(){
       $(document).delegate("input[type='text'], input[type='password'], " +
           "select, textarea", "focus", function(e) {
         // Add a style class when activated
         $(this).addClass("FIELD_HIGHLIGHTER");
       }).delegate("input[type='text'], input[type='password'], " +
           "select, textarea", "blur", function(e) {
         // Remove a style class when not active
         $(this).removeClass("FIELD_HIGHLIGHTER");
       });
     });
   })(jQuery);

3. To inject this custom branding system wide, select PeopleTools > Portal > Branding > Branding System Options.

4. In the Additional Style Sheet Objects group box, add the MY_BRANDING_DEMO style sheet.

5. In the Additional Javascript Objects group box, add this JavaScript object first: PT_JQUERY_1_6_2_JS.

6. Add a new row and add your new JavaScript as a second JavaScript object: FIELD_HIGHLIGHTER.

7. Save your changes.

8. Navigate to any page that includes a page title, group box, and grid. For example, select the User Profile - Roles page, or the Assemble Themes page. Search and select value.

   Notice the style changes to the page title, group box borders, and grid borders introduced by the additional style sheet.

9. Place the cursor in any edit box or long edit box.

   Notice the highlighting changes to the field introduced by the additional JavaScript object, which calls jQuery to perform the dynamic highlighting.

Example

The following example provides the implementation of the PTBR_BRANDING:Elements:BasicText class.

import PTPP_PORTAL:UTILITY:Collection;
import PTBR_BRANDING:Attributes:BaseAttribute;
import PTBR_BRANDING:Attributes:TextAttribute;
import PTBR_BRANDING:Elements:BaseElement;



/**
  * BasicText Class
  */
class BasicText extends PTBR_BRANDING:Elements:BaseElement
   /* --- Properties --- */
   property PTBR_BRANDING:Attributes:TextAttribute Text get;
   
   
   /* --- Methods --- */
   method BasicText(&pId As string);
   method clone() Returns PTBR_BRANDING:Elements:BaseElement;
   
   method getAttributeByID(&pId As string, &pCreate As boolean) Returns PTBR_BRANDING:Attributes:BaseAttribute;
   
   method getHTML(&pPreview As boolean) Returns string;
   
   
private
   /* --- Private Properties --- */
   Constant &cstText = ".text";
   
   
   /* --- Private Methods --- */
   
   
end-class;



/**
  * Constructor
  *
  * @param pId ID of the object.
  *
  */
method BasicText
   /+ &pId as String +/
   
   %Super = create PTBR_BRANDING:Elements:BaseElement(&pId);
   
   %This.setElementType("BasicText");
   rem %this.setAdvancedOptionsPage (Page.);
   
   /* Initialize attributes */
   %This.StyleClass = "PSTEXT";
   %This.Text.setText("");
   
end-method;



/**
  * Make an exact copy of this object.
  * NOTE: Only create the object here, do not copy any class properties.
  *       If there are new class properties, override the copyProperties
  *       method and do it there.  Should invoke the %Super.copyProperties
  *       in that method though.
  *
  * @return BaseElement New object exactly matching this object.
  *
  */
method clone
   /+ Returns PTBR_BRANDING:Elements:BaseElement +/
   /+ Extends/implements PTBR_BRANDING:Elements:BaseElement.clone +/
   
   Local PTBR_BRANDING:Elements:BasicText &newObj = create PTBR_BRANDING:Elements:BasicText(%This.ID);
   
   /* Call the copy properties function */
   %This.copyProperties(&newObj);
   
   Return &newObj;
   
end-method;



/**
  * Get Attribute By ID
  *
  * @param pId     ID of the attribute.
  * @param pCreate True - create the attribute when not exist.
  *
  * @return BaseAttribute - Attribute object
  *
  */
method getAttributeByID
   /+ &pId as String, +/
   /+ &pCreate as Boolean +/
   /+ Returns PTBR_BRANDING:Attributes:BaseAttribute +/
   /+ Extends/implements PTBR_BRANDING:Elements:BaseElement.getAttributeByID +/
   
   Local PTBR_BRANDING:Attributes:BaseAttribute &getAttributeByID = %Super.getAttributeByID(&pId, &pCreate);
   Local PTBR_BRANDING:Attributes:TextAttribute &TextAttribute;
   
   If ((&getAttributeByID = Null) And
         &pCreate) Then
      
      Evaluate &pId
      When &cstText
         &TextAttribute = create PTBR_BRANDING:Attributes:TextAttribute(&pId);
         &TextAttribute.Label = MsgGetText(219, 7509, "Text");
         &TextAttribute.setText("");
         &TextAttribute.IsVisible = True;
         &getAttributeByID = &TextAttribute;
         Break;
         
      End-Evaluate;
      
      If (&getAttributeByID <> Null) Then
         %This.Attributes.insert(&getAttributeByID);
      End-If;
      
   End-If;
   
   Return &getAttributeByID;
   
end-method;



/**
  * Get HTML of the element
  *
  * @param pPreview  True - preview mode.
  *
  * @return String - HTML
  *
  */
method getHTML
   /+ &pPreview as Boolean +/
   /+ Returns String +/
   /+ Extends/implements PTBR_BRANDING:Elements:BaseElement.getHTML +/
   
   Local string &getHTML = "";
   
   &getHTML = GetHTMLText(HTML.PTBR_ELM_CONTAINER_SPAN, EscapeHTML(%This.ID), EscapeHTML(%This.StyleClass), EscapeHTML(%This.Text.getRuntimeValue()));
   
   Return &getHTML;
   
end-method;



/*****************************
*   Get/Set method pairs
*****************************/

/**
  * Text Property
  *
  */
get Text
   /+ Returns PTBR_BRANDING:Attributes:TextAttribute +/
   
   Return (%This.getAttributeByID(&cstText, True) As PTBR_BRANDING:Attributes:TextAttribute);
   
end-get;

Example

The following example provides the implementation of the PTBR_BRANDING:UserAttributes:RoleBasedUserAttribute class.

import PTBR_BRANDING:UserAttributes:BaseUserAttribute;



/**
  * RoleBasedUserAttribute Class
  */
class RoleBasedUserAttribute extends PTBR_BRANDING:UserAttributes:BaseUserAttribute
   /* --- Properties --- */
   
   
   /* --- Methods --- */
   method RoleBasedUserAttribute(&pId As string);
   
   method getPromptViewName() Returns string;
   method validateValue(&pValue As string) Returns boolean;
   
   
end-class;



/**
  * Constructor
  *
  * @param pId ID of the object.
  *
  */
method RoleBasedUserAttribute
   /+ &pId as String +/
   
   %Super = create PTBR_BRANDING:UserAttributes:BaseUserAttribute(&pId);
   
   %This.setUserAttributeType("RoleBasedUserAttribute");
   
end-method;



/**
  * Return the role prompt view name
  *
  * @return string - the prompt view name
  *
  */
method getPromptViewName
   /+ Returns String +/
   /+ Extends/implements PTBR_BRANDING:UserAttributes:BaseUserAttribute.getPromptViewName +/
   
   Return Record.PSROLEDEFN_SRCH;
   
end-method;



/**
  * Validate whether the current has this role
  *
  * @return boolean - the result
  *
  */
method validateValue
   /+ &pValue as String +/
   /+ Returns Boolean +/
   /+ Extends/implements PTBR_BRANDING:UserAttributes:BaseUserAttribute.validateValue +/
   
   Return IsUserInRole(&pValue);
   
end-method;

PTBR_ELEMENT_TYPE - Branding Element Type Definitions

Data set: PTBR_ELEMENT_TYPE

Description: Branding element type definitions from the Define Branding Element Types page.

Records (and RLRs): PTBR_ETYPE (PTBR_ETYPE_LN) — Branding element type definition.

Navigation: PeopleTools > Portal > Branding > System Data > Define Branding Element Types.

See also: Defining Branding Element Types.

PTBR_LAYOUT - Branding Header and Footer Definitions

Data set: PTBR_LAYOUT

Description: Branding header and footer definitions from the Define Headers and Footers page.

Records (and RLRs): PTBR_LAYOUT (PTBR_LAYOUT_LN) — descriptors for the definition, PTBR_LTELT (PTBR_LTELT_LN) — layout element properties, PTBR_LTELTAT (PTBR_LTELTAT_LN) — additional layout element attributes, PTBR_LTATTR (PTBR_LTATTR_LN) — additional style classes, PTBR_LTATTR_CLA — Company Info content for classic, and PTBR_LTATTR_FLU — Company Info content for fluid.

Navigation: PeopleTools > Portal > Branding > Branding Headers and Footers.

See also: Defining Headers and Footers.

PTBR_MACRO - Branding Macro Sets

Data set: PTBR_MACRO

Description: Branding macro set definitions from the Macro Set page.

Records (and RLRs): PSMACROSET (PSMACROSETLANG) — a branding macro set, and PSMACRO (PSMACROLANG) — individual branding macros.

Navigation: PeopleTools > Portal > Branding > Branding Theme Macro Sets.

See also: Defining Macro Sets and Macros.

PTBR_STYLE_SHEET_DEFN - Branding System Options

Data set: PTBR_STYLE_SHEET_DEFN

Description: Additional style sheets and JavaScript objects from the Branding System Options page.

Records (and RLRs): PSOPTIONSADDL (none) — Additional objects.

Navigation: PeopleTools > Portal > Branding > Branding System Options.

See also: Configuring Branding System Options.

PTBR_THEME - Branding Theme Definitions

Data set: PTBR_THEME

Description: Branding theme definitions from the Assemble Themes page.

Records (and RLRs): PTBR_THEME (PTBR_THEME_LN) — theme identifiers, PTBR_THMATTR (PTBR_THMATTR_LN) — theme building blocks, and PTBR_THEME_CSS — additional theme style sheets.

Navigation: PeopleTools > Portal > Branding > Assemble Branding Themes.

See also: Assembling Branding Themes.

PTBR_THEME_ASSIGNMENT - Branding Theme Assignments

Data set: PTBR_THEME_ASSIGNMENT

Description: Portal-specific branding theme overrides and user attributed-based overrides from the Assign Branding Themes page.

Records (and RLRs): PTBR_THM_REG (PTBR_THM_REG_LN) — the portal for the theme override, PTBR_THMRGAT (PTBR_THMRGAT_LN) — portal-wide settings, PTBR_THM_UA — user attributes, and PTBR_THMUAAT (PTBR_THMUAAT_LN) — user attribute override settings.

Navigation: PeopleTools > Portal > Branding > Assign Branding Themes.

See also: Assigning Branding Themes.

PTBR_USER_ATTRIBUTE_TYPE - Branding User Attribute Type Definitions

Data set: PTBR_USER_ATTRIBUTE_TYPE

Description: User attribute type definitions from the Define User Attribute Types page.

Records (and RLRs): PTBR_UATYPE (PTBR_UATYPE_LN) — user attribute type definition.

Navigation: PeopleTools > Portal > Branding > System Data > Define User Attribute Types.

See also: Defining User Attribute Types.