CA PPM Studio Menus and Links

Users can navigate using menus and links. You can configure the main menu and the object action menus. You can also create object links to the following types of pages:
ccppmop156
Users can navigate using menus and links. You can configure the main menu and the object action menus. You can also create object links to the following types of pages:
  • A subpage of the object page.
  • A web page that users access by a URL address.
  • A properties page of an object instance record.
You can use these links internally or from external applications.
2
Customize the Actions Menu Using Studio
The Actions menu appears on the list and properties views of most pages. This menu provides quick access to actions that a user can take directly from the page. As a developer, you can modify the list of options that appears by default under the General submenu, or you can create additional submenus with options.
The Actions menu is specific to an object. The menu options are actions that you can perform on the object. The menu is controlled from the properties and list views of the object. For example, to add options to the Actions menu for projects, you complete the following tasks:
  • Create the options for the Project object in Studio
  • Add the options to the Projects list view and properties view
The following graphic shows the default Actions menu for a project properties page.
Studio Actions menu.
Follow these steps:
Review the Prerequisites
Review and complete the applicable prerequisites in this list:
  • Assign the 
    Administration - Studio
     access right.
  • Determine which tasks or locations a user needs access to from the page.
  • Determine the next logical location in the product that a user needs after completing tasks on the page.
  • Verify that a user has access rights to view the page to which an internal link refers. The option for the link displays in the Action submenu only when the user has access rights to the target page. Verify that internal links exist and are valid.
  • Provide a link to return a user to the source page after viewing an internal destination.
  • Verify that users have the appropriate access rights to use options that you create. For example, if you provide a link to a page, a user must have rights to view the page. Assign access rights to the job or process definition for users to run a job or process.
  • Jobs and process options must be active.
  • You can only map job and process parameters to value attributes inside the partition to which the object view belongs.
  • The option for a process appears in the Action submenu only when the user has access rights to start the process.
  • Consider the following information as you plan custom options and submenus:
    • When you place an option in a submenu in the Actions menu, it is immediately visible to users, even users with personalized views.
    • An option can be placed in a submenu on the Actions menu on any page that corresponds to a view in the object definition.
    • The following page types do not have an Actions menu available:
      • Pages that do not have a view.
      • Pages that have one or more portlets (for example, dashboards).
      • Pages that combine a view and portlets.
Create a Job Option
Create a job option to let a user run a job automatically from the Actions menu. For example, if you add a job option for the Update Earned Value Totals job, a user can run the job directly from the menu. Without the option, the user is required to go to the Jobs option in the Home menu, open the jobs page, and start the job from that location. You provide job parameters when you create the option by mapping them to value attributes on the object instance.
Follow these steps:
  1. Open Administration, and from Studio, click Objects.
  2. Open the object and click Actions.
  3. Click New.
  4. Complete the requested information. The following fields require explanation:
    • Type
      Specifies the type of action.
      Select Job.
    • Select Job
      Specifies the job that is launched from the Actions menu by the user.
    • Alert users before running the job
      Specifies whether the user is alerted before the job runs.
    • Scope
      Specifies whether an action is global or limited to a specific instance.
      Values
      :
      • Global: Allows the user to run the action without having to select a specific instance. This option also makes the action available to be added to any view within any object and to the Home menu.
      • Instance-specific: Allows the user to select a specific instance before running the action. An instance-specific action can only be added to the views for the object under which the action was created. Instance-specific actions cannot be added to the Home menu.
  5. Complete the following fields in the Attribute Mapping section:
    • Parameters
      Displays the parameter fields that appear when you run an instance-specific action. The parameters vary depending on the action.
    • Default Values
      Displays the global default values that are entered for parameters of an instance-specific action. You can change the default values for the action.
    • Object Attribute Overrides
      Specifies the object attributes that can override the default values for instance-specific actions. Within an Object Attribute Overrides field, map the object attributes only to attributes of the same data type as the Parameter field value.
  6. Save your changes.
Create a Process Option
Set up a process option to let a user start a process from the Actions menu. For example, if you add a process option to the Actions menu for the Idea Approval process, a user can run the process directly from the Actions menu. The option in the Actions menu keeps the user from leaving the page. Without the option, the user is required to go to the Organizer option in the Home menu, open the processes page, and start the process from that location.
Follow these steps:
  1. Open Administration, and from Studio, click Objects.
  2. Open the object and click Actions.
  3. Click New.
  4. Complete the requested information. The following fields require explanation:
    • Type
      Specifies the type of action.
      Select Process.
    • Alert users before running the process
      Specifies whether the user is alerted before the process runs. Select the check box to alert the user.
  5. (Optional) Complete the field in the Define Primary Object section to run this option outside the primary object view.
    For example, consider the case where you run an option named Approve Risk (where Risk is the primary object) from the Project object view. To set up the option properly, map to an attribute that belongs to the Project object.
  6. Save your changes.
Create an Internal Link Option
Create an internal link option to let a user navigate to a specific page from the current page. For example, you can add an option to a project properties page that links to the Knowledge Store
 
page.
Follow these steps:
  1. Open Administration, and from Studio, click Objects.
  2. Open the object and click Actions.
  3. Click New.
  4. Complete the requested information. The following fields require explanation:
    • Type
      Specifies the type of action.
      Select Internal Link.
    • Select Link
      Specifies the page that a user opens from the Actions menu. Select the page from the drop-down list. The list includes all links that are displayed on the Linking tab for the object.
  5. Save your changes.
Create an External Link Option
Create an external link to let a user navigate to an external URL outside of the product. The external link object action displays in a pop-up page.
Follow these steps:
  1. Open Administration, and from Studio, click Objects.
  2. Open the object and click Actions.
  3. Click New.
  4. Complete the requested information. The following fields require explanation:
    • Type
      Specifies the type of action.
      Select External Link.
    • Scope
      Specifies whether an action is global or limited to a specific instance.
      Values
      :
      • Global: Allows the user to run the action without having to select a specific instance. This option also makes the action available to be added to any view within any object and to the Home menu.
      • Instance-specific: Allows the user to select a specific instance before running the action. An instance-specific action can only be added to the views for the object under which the action was created. Instance-specific actions cannot be added to the Home menu.
    • Enter URL
      Defines the URL that appears on the Actions menu. For example: http://support.ca.com/.
  5. If you selected instance-specific for the scope, complete the following fields in the Define URL Arguments section:
    • Number of Arguments
      Specifies the number of arguments (name+value pairs) to be included as parameters. Select a number to indicate how many name+value pairs that you want to include. The name+value pairs are appended to the end of the URL. Name+value pairs are separated by an ampersand (&). The values are URL-encoded when they are appended to the URL.
    • Argument #
      Indicates the name in the name+value pair that is used as a parameter for an external link option. Enter a name.
    • Argument # - Value
      Indicates the value in the name+value pair that is used as a parameter for an external link option. Select an option to indicate whether the value is a constant or an instance-specific value, and provide the value. Select an object attribute for the instance-specific value. The attributes listed in the drop-down list are associated with the object on which the option is being created.
  6. Save your changes.
Create a Submenu
Create submenus on the Actions menu to group menu options. For example, if you have multiple portlets to add as options, you can create a submenu named
My Portlets
. Place the portlet options together under one submenu as a convenience to users.
Active options and global options that are defined in any object are available for addition to a submenu in an object list or properties view.
If you want a submenu to appear on the list and the properties view, create a menu for each view.
Follow these steps:
  1. Open Administration, and from Studio, click Objects.
  2. Open the object and click Views.
  3. Click Actions Menu in the Setup Column of the appropriate view.
  4. Click New.
  5. Complete the requested information for the menu name, menu code, and description.
  6. Move the appropriate menu options to the Selected Actions list box.
    Use the arrows to place the menu options into the correct order in the Selected Actions list box.
  7. Click Save and Return.
    The new menu is created and appears in the Actions menu list for the view.
  8. Click Menu Layout.
    The list of submenus appears in the order that appears on the Actions menu for the view.
  9. Move the submenus into the appropriate order using the arrows.
  10. Save your changes.
Update a Submenu
Update existing submenus to add or remove options. For example, you can add options to the default General submenu.
Follow these steps:
  1. Open Administration, and from Studio, click Objects.
  2. Open the object and click Views.
  3. Click Actions Menu in the Setup Column of the appropriate view.
    The actions submenu menu list appears.
  4. Click the name of the menu you want to update.
  5. Update the submenu by moving the appropriate options into the Selected Actions list box.
  6. Save your changes.
Verify the Actions Menu
Navigate to the page that contains the updated Actions menu and verify the following points:
  • Menu options display and launch correctly.
    • For missing options, verify that you have the appropriate rights to perform the menu option. For example, the access right to work with processes is required for an option for processes to display.
    • For an option that does not launch correctly, verify the properties for the option.
    • For a job or process option that does not work, verify the parameter settings by opening the option.
    • For an external link that does not work, verify the URL.
    • For an internal link that does not work, verify the link settings.
  • Submenus display correctly.
    • For a missing submenu, verify that you placed the submenu on the correct view.
    • If a submenu is not in the correct place, repeat the procedure to determine the submenu location on the Actions menu.
When updates to submenus or options display and start properly, you have successfully customized the Actions menu.
Customize the Main Menu Using Studio
To simplify the organization and accessibility of information for users by role, you can configure the Home and Administration menus. You can configure the following changes to these menus:
  • Add a link to a page or a user action.
  • Add a section.
  • Remove and reorder a section or link.
To change the Home or Administration menu, use the Menu Manager in Studio.
  • To configure the Administration menu, use the Administration Tool menu. For example, you can add a link to the Create Project page on the Administration menu.
  • To configure the Home menu, use the Application menu. For example, you can add a link to the Resource List page on the Home menu.
You can also use the Favorites menu to store a link to any page for easy access. This article does not describe how to use the Favorites menu. For more information about using the Favorites menu, see
Getting Started
.
Follow these steps:
Review the Prerequisites
Review and complete the applicable prerequisites in this checklist:
  • As an administrator, verify you have the following access rights:
    • Administration - Access
    • Administration - Studio
    • Administration - Partition Models
    • Menu Definition Viewer - All
  • Determine the menu that you want to customize (Home or Administration).
  • Determine how to display the menu item:
    • as a section
    • as a page link
    • as an action link
  • Verify that the menu item that you want to add exists.
Add a link in the Home or Administration menu so that users can access your pages. Use the Administration Tool Menu to manage the Administration menu and the Application Menu to manage the Home menu.
For example, if a project manager accesses the Resource Allocations page regularly, you can add a link to that page on the Home menu. Adding a link to the Resource Allocations page allows the project manager to access this page without navigating through multiple pages.
Follow these steps:
  1. Open Administration, and from Studio, click Menu Manager.
  2. Click the menu name that you want to configure.
    The menu hierarchy page appears.
  3. Click Add.
  4. Select Page Link and click Next.
  5. Enter the information for the new page link:
    • Link Name 
      Defines the name of the page link in the menu.
    • Page Name 
      Specifies the target destination page that appears when users click the link from the menu.
    • Parent Menu Item
      Specifies the source menu section for the new menu link.
  6. Save the changes.
    Log out and log in again to view the new menu.
Add an action link to the menu to access that action from the Home or Administration menu. When you click the link, the associated page to create that action appears.
For example, if a project manager creates action items regularly, you can add a link to the Create Action Item page on the Home menu. Adding a link to the Create Action Item page allows the project manager to access this page without navigating through multiple pages.
Follow these steps:
  1. Open Administration, and from Studio, click Menu Manager.
  2. Click the menu name that you want to configure.
    The menu hierarchy page appears.
  3. Click Add.
  4. Select Action Link and click Next.
  5. Complete the requested information. The following fields require explanation:
    • Link Name 
      Defines the name of the link that appears in the menu.
    • Action Name 
      Specifies the action when you click the action link.
    • Parent Menu Item
      Specifies the parent menu item in which this link appears. For example, if you select Personal, the action link appears grouped under the Personal menu item in the Home menu.
  6. Save your changes.
Add a Section
The menus are divided into menu items by section. For example, the Home menu includes the following sections: Personal, Organization, IT Service Management, and so on.
Add a section to add page links and action links as menu items. For example, you can add a section named Current Project for a project in the Home menu. You can then add page and action links associated with the project to this section. Adding this section allows the project manager to access project-related information from the Home menu.
Follow these steps:
  1. Open Administration, and from Studio, click Menu Manager.
  2. Click the menu name that you want to configure.
    The menu hierarchy page appears.
  3. Click Add.
  4. Select Section and click Next.
  5. Complete the requested information.
  6. Save your changes.
Reorder the sections or links to change the way they appear in the menu. For example, you can reorder the sections in the Administration menu to display Portfolio Management above IT Service Management on the Menu Hierarchy page.
Follow these steps:
  1. Open Administration, and from Studio, click Menu Manager.
  2. Click the menu name that you want to reorder.
  3. Click Reorder.
  4. Select the menu item in the list and click the arrows to move the item to a new position.
  5. Save your changes.
    If you do not see your changes reflected in the menu, click
    Refresh
    .
Remove a section or a link if it is no longer needed. For example, you can remove the Current Project section you added after the completion of the project.
You can only remove sections or links that you have created, and not the default sections or links. If you remove a section or a link that a user is viewing, they do not see the change until the next time they log in.
Follow these steps:
  1. Open Administration, and from Studio, click Menu Manager.
  2. Select the menu on the Menu Manager page.
  3. Select the check box next to the section or link that you want to remove, and click Remove.
    The Confirm Menu Item Delete page appears.
  4. Click Yes.
Verify the Menu Configurations
After configuring the menus, verify your changes to verify they are correct. For example, verify that the Current Projects section is added to the Home menu.
Follow these steps:
  1. Log in to
    Clarity PPM
    .
  2. Verify that the link appears in the menu.
  3. Click the link to verify that it navigates to the correct page.
After you verify all menu configurations, you have successfully configured the menus.
Customize Page Links Using Studio
Link from an Object Page to a Subpage
You can designate a new page as a subpage. For example, you want only certain users performing a specific task and you want to provide a link only to that subpage.
Follow these steps:
  1. Open Administration, and from Studio, click Objects.
  2. Click the name of an object.
  3. Click Linking.
  4. Click New and complete the fields:
    • Link Name
      Defines the label for the page link that appears in the menu.
    • Link ID
      Defines a unique alphanumeric identifier for the link.
    • Description
      Defines the purpose of the item being created and provides any relevant information.
    • Action
      Specifies the page that appears when the link is clicked in the menu. Depending upon the action you select, you are asked to select values for attributes that the subpage has in common with the object. Both objects must have these values in common for linking to work.
  5. Click Save and Return.
Link to a Web Page
You can create a link to an external website and place it on the Properties view for an object.
Follow these steps:
  1. Create a URL Link Attribute.
  2. Add Attributes to the Object Properties View.
Create a URL Link Attribute
Create a URL Link attribute to provide links to web pages or virtual attributes.
  • A link attribute provides a link to a web page that is outside of the product.
  • A virtual attribute references data attributes of items that exist outside of the database. Examples of virtual attributes include progress bars, Gantt charts, or attributes that display the calculated results for other attributes.
Follow these steps:
  1. Open Administration, and from Studio, click Objects.
  2. Click the name of the object.
  3. Click Attributes.
  4. Click New.
  5. Enter an attribute name and a unique ID.
  6. Set the Data Type field to URL.
  7. Complete any of the remaining fields.
  8. Save your changes.
Add Attributes to the Object Properties View
Add the attributes to the properties view of the new object so users can complete the following tasks from the object properties page:
  • Create an initial instance of the object.
  • Modify an instance of the object.
You can configure attribute visibility, location on the page, and layout.
Follow these steps:
  1. Open Administration, and from Studio, click Objects.
  2. Click the name of the object.
  3. Click Views.
  4. In the Category column, locate the Properties view and click the [Layout:Create] link from the Setup column in that row.
  5. In the property layout, select a section, and click the Properties and Layout icon next to the item.
    List boxes of available and selected attributes appear.
  6. In the Available list, select the attributes that you want to add and use the arrows to move the attributes into the correct Selected list.
  7. Click Save and Return.
  8. Click Return.
    The list of views appears.
  9. In the Category column, locate the Properties view and click the [Layout:Edit] link from the Setup column in that row.
  10. Repeat these steps as often as required.
  11. Save your changes.
Link to Properties Pages from External Applications
You can link to the properties page of an object instance record from external applications. You can use any unique attribute value to identify the object instance and view its properties page. The action is consistent for all objects including stock, custom, and subobjects.
The following example URL links to a project stock object:
http://my_ppm.somebiz.com/niku/app?action=odf.customObjectInstance&odf_code=project&unique_code=myproject
  • odf_code=project 
    Defines the stock object ID as defined in the administration pages. In the example, project is the code for the Project stock object.
  • unique_code=myproject 
    Determines how the object instance is retrieved. The parameter name unique_code identifies the name of the unique attribute on the object which in turn identifies the object instance that you want to reference. The parameter name you use here depends solely on the object that you want to reference as identified by the odf_code parameter. The object is Project, and unique_code is used to identify a project instance with the unique_code value of 
    myproject
    .
The following example URL links to a business workflow custom object:
http://my_ppm.somebiz.com/niku/app?action=odf.customObjectInstance&odf_code=custom_workflow&release=1.0.1A
  • odf_code=custom_workflow
    Specifies the custom object definition ID as defined in the Studio object administration pages. In this example, 
    custom_workflow
     is the name for the Custom Workflow custom object.
  • release=1.0.1A
    Defines a custom string attribute 
    release 
    with a value of 1.0.1A for this instance of a custom object 
    custom_workflow
    .
URLs with properly escaped or coded parameter values are also valid. For example, if you use the attribute 
name 
with the value 
My Custom Page
, the URL is constructed as follows:
...name=My%20Custom%20Page
Add an Object Action Link to the Home Menu
You can create a link that performs a specific action and add it to the main menu.
Follow these steps:
  1. Open Administration, and from Studio, click Menu Manager.
  2. Click Application Menu.
  3. Click Add.
  4. Select Action Link and click Next.
  5. Complete the fields:
    • Link Name
      Defines the name of the link for the action. The link name is the label that displays in the menu.
    • Description
      Defines the purpose of the link.
    • Action Name
      Specifies the action that occurs when the link is clicked in the menu.
    • Parent Menu Item
      Specifies the section in which the link appears.
  6. Click Save and Return.