Frameworks: Customization Options
aThis page covers:
- 1 Release Information
- 2 Manage Framework Components
- 3 Manage Framework: Lightning Web Component LIGHTNING WEB COMPONENT
- 4 Manage Framework: Visualforce Page VISUALFORCE PAGE
- 5 Manage Framework Components: Customize Field Sets Lightning Web Component Visualforce Page
- 6 Manage Framework: Custom Permissions Nashira v1.38 onwards
Related pages:
Release Information
New features and feature enhancements are added with every new release. Below is a high-level overview of important features/feature enhancements for Frameworks by release.
For more detailed release notes, review the Release Notes page or contact your System Administrator.
Release | Features Added/Feature Enhancements | What does this mean? |
---|---|---|
Fornax (v1.27) & Gemini (v1.28) | Additional UI and UX enhancements for the Frameworks Lightning Web Component were released. | Various UI/UX updates were made available so later releases are recommended for the best user experience with the Frameworks LWC. |
Electra (v1.26.1) | Manage Frameworks rebuild as Lightning web component
| From this release, implementers have the option to make the more flexible Frameworks LWC available to users, allowing them to create multiple Frameworks for a single Project and select Framework Objectives from a catalog. |
Manage Framework Components
The Frameworks functional area comes with two user interface options that organizations can choose from: Lightning Web Component or Visualforce Page.
Visualforce: is a page-centric web application model. A markup language like HTML is used for designing the layout of pages.
Lightning Web Component (LWC): a new app-centric model that provides business and datalogics to develop dynamic web applications meant for desktop and mobile devices. Because they’re built on code that runs natively in browsers, LWC are lightweight and deliver exceptional performance.
Organizations on earlier releases of Amp Impact might be using Visualforce pages to create and manage Frameworks. With Amp Impact’s Electra (Winter 2021) release, the Manage Frameworks Logframes page was rebuilt as a Lightning Web Component (called manageLogFrames). Read this Salesforce article to understand why you may want to leverage Lightning Web Components over Visualforce pages.
Manage Framework: Lightning Web Component LIGHTNING WEB COMPONENT
Design attributes can be used for controlling elements on the Manage Framework Lightning Web
Component (LWC). They can be used for hiding/displaying buttons. Follow these steps to access design
attributes for Manage Frameworks LWC:
Navigate to Manage Frameworks LWC and click on the gear icon → Edit Page. This will take you to the Lightning App Builder.
Click on the Manage Framework component. It will display a list of design attributes on the right side of the page.
The following design attributes are available. Check/Uncheck them based on the table below:
Design Attribute | Related UI Element | UI if True | UI if False |
---|---|---|---|
Hide Add New Framework Item Button | Controls the display of the Add Custom Framework Objective | Add Custom Framework | Add Custom Framework Objective button is visible. |
Hide Add Objective | Controls the display of the Add Objective from Catalog button. | Add Objective from | Add Objective from |
Hide Copy from | Controls the display of the Hide Copy from Another Framework | Hide Copy from Another Framework | Hide Copy from |
Hide Submit Button | Controls the display of the Submit for Approval button for a framework . | Submit for Approval | Submit for Approval |
Hide Edit Icon | Controls the display of the Edit icon, for Framework Objective on the Manage Framework table. | Edit icon is hidden. | Edit icon is visible. |
Hide Delete Icon | Controls the display of the Delete | Delete icon is | Delete icon is visible. |
Unlink First Framework | Controls the display of hyperlink in the Objective Name Translated column of Framework Objectives.
| No Hyperlink in the | Hyperlink present in |
Unlink First Project | Controls the display of hyperlink in the Indicator Definition Translated column for Project Indicators | No Hyperlink in the | Hyperlink present in |
Hide | Controls the display of Expand Button: Expands the child objectives from the parent objectives of Objective Name Translated Collapse Button: Collapses the child objectives present in the parent objectives of Objective Name Translated
| Expand/Collapse All | Expand/Collapse All
|
Hide Indicator | Controls the display of the column | Column with details
| Column with details |
Framework Table Sort Order | Controls the sorting order of Framework Objectives on the table. Sorted via a comma separated list of API names of fields on the ampi__Objective__c object. Please note that the help text on the design attribute is inaccurateand will be resolved. | NA | NA |
Manage Framework: Visualforce Page VISUALFORCE PAGE
Servicing to stop in Nov 2023
Some key features in the product can be configured on/off depending on the client organization’s
preferences for the product. They can be disabled/enabled at the user/profile/organization level. To enable
or disable any of the features in the Manage Framework Visualforce Component:
Go to “Setup” > “Custom Settings”.
Navigate to “Manage Logframes”.
Click on “Manage”.
Click on “Edit”.
A list of settings would be displayed. Check/Uncheck these settings based on the table below:
Field Label | Related UI Element | UI if True | UI if False |
---|---|---|---|
Hide Add New
| Controls the display of the Add Custom Framework Objective button | Add Custom Framework | Add Custom Framework |
Hide Delete Icon | Controls the display of | Delete icon is | Delete icon is visible. |
Hide Edit Icon | Controls the display of Edit icon, for a Framework | Edit icon is hidden. | Edit icon is visible. |
Manage Framework Components: Customize Field Sets Lightning Web Component Visualforce Page
This section details how to customize the field sets on Manage Framework Visualforce and Lighting Web Components.
Fields displayed in the “Add New Framework Item” pop-up
Object | Fieldset Name | Default Behaviour |
---|---|---|
Catalog_Objective__c | ADD_NEW_OBJECTIVE_POPUP | The following fields are available out of the box: ampi__Objective_Name__c ampi__Definition__c ampi__Level__c ampi__Parent_Objective__c ampi__Include_in_Catalog__c |
Fields displayed in the “Edit Framework Item” pop-up
Object | Fieldset Name | Default Behaviour | Additional Comments |
---|---|---|---|
Catalog_Objective__c | EDIT_PROJECT_OBJECTIVE | The following fields are available out of the box: ampi__Objective_Name__c ampi__Description__c ampi__Level__c ampi__Project_Indicator__c ampi__Parent_Project_Objective__c ampi__Deactivated__c |
|
(Optional) System Admins may create a Custom Metadata Type record under Object Lookup Label
Mapping (ampi__Object_Lookup_Label_Mapping__mdt) to define the field to display in components for lookups and master-detail values, based on fields on the parent Object. Jump to the Customize Lookup Display Field section for configuration steps and options.
Column fields on the Manage Framework page - Fields on the Framework Objective object available to be displayed as column headers on this page
Object | Fieldset Name | Default Behaviour | Additional Comments |
---|---|---|---|
Catalog_Objective__c | LOG_FRAMES_TABLE | The following fields are available out of the box: ampi__Label_Translated__c ampi__Level__c |
|
Column fields on the Manage Framework page - Fields on the Project Indicator object available to be displayed as column headers on this page
Object | Fieldset Name | Default Behaviour | Additional Comments |
---|---|---|---|
Project_Indicator_Objective__c | LOG_FRAMES_TABLE | The following fields are available out of the box: ampi__Description_Translated__c ampi__Baseline__c ampi__Target_To_Date__c | It is recommended to include no more than five total fields to display on the Logframes table, to be able to view the information in a user-friendly manner. |
Columns for table of catalog objectives in the “Add Catalog Objective” popup- fields on the Catalog Objective object available to be displayed as column headers in this table
Object | Fieldset Name | Default Behaviour | Additional Comments |
---|---|---|---|
Catalog_Objective__c | ampi__ADD_CATALOG_OBJECTIVE_POPUP | The following fields are available out of the box: ampi__Definition_Translated__c ampi__Level__c ampi__Name__c |
|
Search filters in the “Add Catalog Objective” popup fields on the Catalog Objective object available to be displayed as search filters
Object | Fieldset Name | Default Behaviour | Additional Comments |
---|---|---|---|
Catalog_Objective__c | ampi__CATALOG_OBJECTIVE_SEARCH_FILTERS | The following fields are available out of the box: ampi__Level__c | Due to a current limitation, custom date fields, custom checkbox fields, and custom number fields cannot be used to filter catalog objectives in the ampi__CATALOG_OBJECTIVE_SEARCH_FILTERS field set. |
Manage Framework: Custom Permissions Nashira v1.38 onwards
This custom permission is available as of the Nashira (v1.38) release.
Label | API Name | Description |
---|---|---|
Override Locked Framework | Override_Locked_Framework | This custom permission grants an exception to the "Framework Locked" functionality. Assigned users will have unrestricted access to manage Frameworks through ManageFrameworks LWC, even if the Framework Locked(ampi__xx_Framework_Locked__c) on the ampi__Project__c object and the Framework Locked(ampi__xx_Framework_Locked__c) on the ampi__xx_Framework__c object is set to TRUE.
|