Professional Documents
Culture Documents
Archer Enhanced User Experience Tool & Utility 6.11 P1 Implementation Guide
Archer Enhanced User Experience Tool & Utility 6.11 P1 Implementation Guide
Archer Enhanced User Experience Tool & Utility 6.11 P1 Implementation Guide
Archer® Suite
6.11 P1
Implementation Guide
Archer
Enhanced User Experience
Tool & Utility
Copyright
Contact Information
The Archer Community (https://archerirm.community) contains a knowledge base that answers common questions and
provides solutions to known problems, product documentation, community discussions, and case management.
Trademarks
RSA, Archer, and other trademarks, are trademarks of RSA Security LLC or its affiliates ("RSA"). For a list of RSA trademarks,
go to https://www.archerirm.com/company/trademarks. Other trademarks are trademarks of their respective owners.
License Agreement
This software and the associated documentation are proprietary and confidential to RSA Security LLC or its affiliates are
furnished under license, and may be used and copied only in accordance with the terms of such license and with the
inclusion of the copyright notice below. This software and the documentation, and any copies thereof, may not be provided
or otherwise made available to any other person. No title to or ownership of the software or documentation or any
intellectual property rights thereto is hereby transferred. Any unauthorized use or reproduction of this software and the
documentation may be subject to civil and/or criminal liability. This software is subject to change without notice and should
not be construed as a commitment by RSA.
Third-Party Licenses
This product may include software developed by parties other than RSA. The text of the license agreements applicable to
third-party software in this product may be viewed on the Archer Community. By using this product, a user of this product
agrees to be fully bound by terms of the license agreements.
This product may contain encryption technology. Many countries prohibit or restrict the use, import, or export of encryption
technologies, and current use, import, and export regulations should be followed when using, importing or exporting this
product.
Distribution
Use, copying, and distribution of any RSA Security LLC or its affiliates ("RSA") software described in this publication requires
an applicable software license.
RSA believes the information in this publication is accurate as of its publication date. The information is subject to change
without notice.
THE INFORMATION IN THIS PUBLICATION IS PROVIDED "AS IS." RSA MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY
KIND WITH RESPECT TO THE INFORMATION IN THIS PUBLICATION, AND SPECIFICALLY DISCLAIMS IMPLIED WARRANTIES OF
MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. CUSTOMER IS SOLELY RESPONSIBLE FOR ENSURING THAT THE
INSTALLATION OF THE APPLICATION IS PERFORMED IN A SECURE MANNER. RSA RECOMMENDS CUSTOMERS PERFORM A FULL
SECURITY EVALUATION PRIOR TO IMPLEMENTATION.
©
2022 RSA Security LLC or its affiliates. All Rights Reserved.
August 2022
Table of Contents
Chapter 1: Overview of the Archer Enhanced User Experience Tool & Utility ............................................ 6
About the Archer Enhanced User Experience Tool & Utility .................................................................... 6
Key Features and Benefits ........................................................................................................................ 7
Prerequisites (ODA and system requirements) ........................................................................................ 8
Chapter 2: Archer Enhanced User Experience Tool & Utility Components ................................................. 9
Applications............................................................................................................................................... 9
Workspaces ............................................................................................................................................... 9
Solutions ................................................................................................................................................... 9
Dashboards ............................................................................................................................................... 9
Custom iViews........................................................................................................................................... 9
Chapter 3: Installing the Archer Enhanced User Experience Tool & Utility Package .................................. 11
Installation Overview .............................................................................................................................. 11
Step 1: Prepare for the Installation .......................................................................................................... 11
Step 2: Install the Package ....................................................................................................................... 11
Step 4: Test the Installation ..................................................................................................................... 11
Installing the Package.............................................................................................................................. 11
Task 1: Back Up Your Database ........................................................................................................... 11
Task 2: Import the Package ................................................................................................................. 11
Task 3: Map Objects in the Package .................................................................................................... 12
Task 4: Install the Package................................................................................................................... 14
Task 5: Review the Package Installation Log ....................................................................................... 15
Chapter 4: Deploying the Archer Accessories Objects using the Archer Enhanced User Experience Tool &
Utility........................................................................................................................................................... 16
Accessing the Archer Accessories Workspace ........................................................................................ 16
Task 1: Add the Archer Accessories Workspace to Your Personalized Workspace Display ............... 16
Adding the Archer Accessories Layout Independent Custom Objects to Target Module Layouts ......... 17
Task 1: Synchronize Layouts with the Archer Accessories – Sync Layouts Custom iView .................. 17
Removing the Archer Accessories Layout Independent Custom Objects Target Module Layouts ........ 23
Task 1: Remove Layout Objects with the Archer Accessories – Remove Layout Objects Custom iView
............................................................................................................................................................ 23
3
Archer Enhanced User Experience Tool & Utility Implementation Guide
4
Archer Enhanced User Experience Tool & Utility Implementation Guide
Release Notes
The following table describes enhancements.
Release Version Published Date Notes
Archer 6.11 P1 12th August 2022 Initial Release
th
Archer 6.11 P1 25 August 2022 ReformatLayoutCustomObject custom code has been
revised for better handling of Read Only fields set due to
ACLs. The latest code version is 2022.08.20.1600
5
Archer Enhanced User Experience Tool & Utility Implementation Guide
In addition, this team has developed a suite of standard objects that can deployed on any and all Archer
Applications, Questionnaires, and Sub-Forms which modernize the user experience of the Archer Record
page without requiring rearchitecting the Archer Platform. These Layout Independent Custom Objects
can be automatically deployed across any and all layouts via a form present on a Sync Layouts custom
iView that is installed with the Archer Enhanced User Experience Tool & Utility package, eliminating the
need to install specific packages to make modifications to individual Archer modules.
The first set of Archer Layout Independent Custom Objects which can be deployed within this release of
the Archer Enhanced User Experience Tool & Utility are as follows:
Reformat Layout Custom Object: A custom object that is added to each layout within a module that
houses JavaScript/jQuery which dynamically rearranges and restyles the existing controls on the layout
upon page load. The goal is to modernize the look-and-feel of the record page by making changes to the
layout post-load as to not require changes to be made to the layout in the Application Builder.
Changes to the Record Page Layout performed by the Reformat Layout Custom Object:
6
Archer Enhanced User Experience Tool & Utility Implementation Guide
• Automatic hiding of the main menu when the record is placed into Edit mode to provide more
vertical space for data entry.
• Transparent (Gray) Background Around Read-Only Fields when the record is placed into Edit
mode.
• Data Entry Control Borders Removed from Non-Focused Fields when the record is placed into
Edit mode.
Open Content URL Links in New Window Custom Object: A custom object that is added to each layout
within a module that houses JavaScript/jQuery which dynamically adds an open in new window
hyperlink next to each existing Content URL link on the layout, allowing users the ability to open a cross-
referenced record in a new pop-up window as opposed to forcing them to leave the record they are
currently viewing. The record is opened in a new window using the deep link to the specific record.
Formula Inspector Custom Object: A custom object that is added to each layout within a module that
houses JavaScript/jQuery which adds a Formula Inspector button to the More Options menu on the right
side of the record layout page for System or Configuration Administrators to facilitate the viewing of
formulas associated with calculated fields directly on the front-end record page layout. Clicking this
button calls Archer's API to return the Calculation Details of all calculated fields within the level and adds
a formula inspector link next to each calculated field on the layout. Clicking the link displays a modal
pop-up displaying the formula associated with the specified calculated field.
With the Archer Enhanced User Experience Tool & Utility, you will be able to:
• Enhance the existing record layouts of any and all Applications, Questionnaires, and Sub-Forms
within your Archer instance in advance of platform-level changes to Archer’s Record page
coming out in a future release via the addition of the Modify Layouts Custom Object. These
changes will enhance the experience of your Archer users experience by providing them with a
more modern data interface for interacting with records within the Archer platform.
• Enhance existing Archer navigation by allowing users to open cross-referenced records in new
Archer windows as opposed to requiring them to navigate away from the current record they
are viewing via the Open Content URL Links in New Window Custom Object.
• Allow Archer System and Configuration Administrators the ability to view the formulas
associated with calculated fields directly from a record page via the Formula Inspector Custom
Object, facilitating record specific troubleshooting, as Administrators will not be required to
open the module in the Application Builder and browse the specific field’s formula either
through the Calculations tab or from viewing the Calculation Properties of the specific field.
• Easily deploy or remove one or more of the newly released Archer Layout Independent Custom
Objects across any and all module layouts within a single Archer Instance without needing to
make changes to those modules via the traditional Archer Package Installation Process.
7
Archer Enhanced User Experience Tool & Utility Implementation Guide
8
Archer Enhanced User Experience Tool & Utility Implementation Guide
Workspaces
Workspace Description
Archer The Archer Accessories workspace is installed as an optional workspace to house
Accessories the Archer Accessories Solution and its one On Demand Application, Archer
Accessories Objects. It also contains a single dashboard, Archer Accessories -
Layout Management, which houses two custom iViews, Archer Accessories - Sync
Layouts and Archer Accessories - Remove Layout Objects which can be used to add
or remove sections and non-field layout objects to/from one or more Target
Layouts.
Solutions
Solution Description
Archer The Archer Accessories solution is installed to house the Archer Accessories
Accessories Objects On Demand Application.
Dashboards
Dashboard Description
Archer The Archer Accessories - Layout Management dashboard, part of the Archer
Accessories - Accessories workspace, houses two custom iViews, Archer Accessories - Sync
Layout Layouts and Archer Accessories - Remove Layout Objects which can be used by
Management Archer System Administrators to add or remove sections and non-field layout
objects to/from one or more Target Layouts.
Custom iViews
iView Description
Archer The Archer Accessories - Sync Layouts custom iView, part of the Archer Accessories
Accessories - - Layout Management dashboard, displays a form which can be used by Archer
Sync Layouts System Administrators to add or synchronize sections and non-field layout objects
within those selected sections from a selected Source Layout (e.g. Archer
Accessories Objects: Archer Accessories Objects: Default Layout) to one or more
selected Target Layouts within any combination of Archer Modules (Applications,
Questionnaires, or Sub Forms). It is leveraged as part of the Archer Enhanced User
Experience Tool & Utility to add a section named Layout Independent Custom
9
Archer Enhanced User Experience Tool & Utility Implementation Guide
Objects to the bottom of one or more Layouts within an Archer instance and add
any combination of three pre-defined custom objects
(ReformatLayoutCustomObject, FormulaInspectorCustomObject, and
OpenContentURLLinksInNewWindowCustomObject) which have been defined the
Archer Accessories Objects ODA to that newly created section. This custom iView
utilizes Archer’s Internal API to make layout changes in bulk, eliminating the need
for Archer System/Configuration Managers to manually add these sections and
custom objects to selected Module Layouts or to deploy specific packages to
introduce these objects to target Layouts.
Archer The Archer Accessories – Remove Layout Objects custom iView, part of the Archer
Accessories - Accessories - Layout Management dashboard, displays a form which can be used
Remove by Archer System Administrators to permanently delete non-field objects and
Layout sections defined in a selected Source Layout (e.g. Archer Accessories Objects:
Objects Archer Accessories Objects: Default Layout) from one or more or Target Module
Layouts. Non-field Layout Objects can be set either be permanently deleted or
moved off layout; all layout objects (fields and non-field objects) will be moved to
the off-layout tab in cases where a Section is marked to be deleted unless the non-
field object has been explicitly selected for deletion.
10
Archer Enhanced User Experience Tool & Utility Implementation Guide
An alternate method for undoing a package installation is to create a package of the affected objects
in the target instance before installing the new package. This package provides a snapshot of the
instance before the new package is installed, which can be used to help undo the changes made by
the package installation. New objects created by the package installation must be manually deleted.
11
Archer Enhanced User Experience Tool & Utility Implementation Guide
Awaiting Indicates that the system could not automatically match the object or
Mapping children of the object to a corresponding object in the target instance.
Review
Objects marked with this symbol must be mapped manually through the
mapping process.
Important: New objects should not be mapped. This icon should remain
visible. The mapping process can proceed without mapping all the
objects.
Note: You can execute the mapping process without mapping all the
Mapping Indicates that the object and all child objects are mapped to an object
Completed in the target instance. Nothing more needs to be done with these
objects in Advanced Package Mapping.
Do Not Indicates that the object does not exist in the target instance or the
Map object was not mapped through the Do Not Map option. These objects
will not be mapped through Advanced Package Mapping, and must be
remedied manually.
12
Archer Enhanced User Experience Tool & Utility Implementation Guide
Option Description
Ignore Select this option to match objects with similar names regardless of the case
case of the characters in the object names.
Ignore Select this option to match objects with similar names regardless of
spaces whether spaces exist in the object names.
c. Click OK.
The Confirmation dialog box opens with the total number of mappings
performed. These mappings have not been committed to the database yet and
can be modified in the Advanced Package Mapping page.
d. Click OK.
• To set all objects in the tab to Do Not Map, in the toolbar, click Do Not Map.
Note: To undo the mapping settings for any individual object, click in the Actions
column.
When all objects are mapped, the icon is displayed in the tab title. The icon is
displayed next to the object to indicate that the object will not be mapped.
5. Verify that all other objects are mapped correctly.
6. (Optional) To save your mapping settings so that you can resume working later, see "Exporting
and Importing Mapping Settings" in the
7. Archer Online Documentation.
8. Once you have reviewed and mapped all objects, click .
9. Select I understand the implications of performing this operation and click OK.
13
Archer Enhanced User Experience Tool & Utility Implementation Guide
The Advanced Package Mapping process updates the system IDs of the objects in the target
instance as defined on the Advanced Package Mapping page. When the mapping is complete,
the Import and Install Packages page is displayed.
Important: Advanced Package Mapping modifies the system IDs in the target instance. Any
Data Feeds and Web Service APIs that use these objects will need to be updated with the new
system IDs.
14
Archer Enhanced User Experience Tool & Utility Implementation Guide
a prefix. This can help you identify any fields or data-driven events that you may want to
review for cleanup post-install.
7. Click Install.
8. Click OK.
15
Archer Enhanced User Experience Tool & Utility Implementation Guide
2. Add the Archer Accessories workspace to your Personized Workspace Display and click SAVE.
3. Open the Archer Accessories Workspace from the Main Navigation Menu. (Depending on the
number of workspaces already displayed, it may be accessible by clicking the three vertical dot
16
Archer Enhanced User Experience Tool & Utility Implementation Guide
17
Archer Enhanced User Experience Tool & Utility Implementation Guide
4. Set the Archer Accessories Objects: Archer Accessories Objects: Default Layout as the Source
Layout.
a. Set the Source Module to Archer Accessories Objects from the Select Source Module
dropdown.
b. Set the Source Level to Archer Accessories Objects from the Select Source Level
dropdown.
c. Set the Source Layout to Default Layout from the Select Source Layout dropdown.
5. Select the Target Layouts to deploy Layout Independent Custom Objects to.
18
Archer Enhanced User Experience Tool & Utility Implementation Guide
b. Click Get Target Levels to retrieve the Levels associated with the Target Modules
selected in the previous step.
c. Select one or more Target Levels that you want to synchronize or click Select All to
select all Levels associated with the Target Modules selected in the previous step.
d. Click Get Target Layouts to retrieve the Layouts associated with the Target Levels
selected in the previous step.
e. Select one or more Target Layouts that you want to synchronize or click Select All to
select all Layouts associated with the Target Levels selected in the previous step.
f. Click Create Layout Syncing Table to populate the Layout Syncing Table.
i. The first three columns will be populated with each Tab, Section, and Layout
Objects present in the selected Source Layout.
19
Archer Enhanced User Experience Tool & Utility Implementation Guide
ii. An additional column will be added for each Target Layout selected in the
previous step.
20
Archer Enhanced User Experience Tool & Utility Implementation Guide
ii. Manually click on the checkbox in the cell that is the intersection of the Source
Section and Target Layout to reveal a dropdown containing all the Source
Sections which appear in the Target Layout.
1. If the selected Target Layout already contains a section whose name
matches the name of the selected Source Section, that section will be
automatically selected.
2. Otherwise, select the section that you want a newly created section to
be inserted after or select *TOP* to add the newly created section to
the top of the particular tabset.
3. Upon selecting a Target Section, the cell in which the dropdown resides
will be populated with the selected Target Section. Clicking on the
checkbox again will hide the dropdown control to save space, but the
mapping will still be performed.
7. To Sync the Layouts after mapping is complete, click Sync Layouts to use Archer's internal API to
manage the selected Target Layouts.
a. A dialog box will appear showing a Summary of Pending Changes. After reviewing the
pending changes, click Confirm to continue or click Cancel to go back to the previous
step to modify selections or abandon the Layout synchronization process. (If issues are
21
Archer Enhanced User Experience Tool & Utility Implementation Guide
present that will prevent Target Layouts from being updated, those will be displayed,
and an OK button will be shown in lieu of a Confirm and Cancel buttons.)
b. If confirmed, the synchronization process will loop through each selected Target Layout
and add/update the selected Source Sections. A message will appear at the bottom of
the form showing the status of each layout synchronization.
c. For each selected Source Layout Object, the syncing function will check to see if a layout
object with the same name exists in the selected Target Layout(s).
i. If the Target Object already exists, its properties (name, alias, row/column
position, description, custom object code, etc.) will be updated to reflect the
properties of the same-named object in the Source Layout.
ii. If the object does not already exist in the selected Target Layout, a new layout
object will be created and placed in the Target Layout.
22
Archer Enhanced User Experience Tool & Utility Implementation Guide
3. Click Setup Remove Layout Objects/Sections to start the layout object removal configuration
process.
4. Set the Archer Accessories Objects: Archer Accessories Objects: Default Layout as the Source
Layout.
a. Set the Source Module to Archer Accessories Objects from the Select Source Module
dropdown.
23
Archer Enhanced User Experience Tool & Utility Implementation Guide
b. Set the Source Level to Archer Accessories Objects from the Select Source Level
dropdown.
c. Set the Source Layout to Default Layout from the Select Source Layout dropdown.
b. Click Get Target Levels to retrieve the Levels associated with the Modules selected in
the previous step.
c. Select one or more Target Levels from which you want to remove layout objects or click
Select All to select all Levels associated with the Target Modules selected in the previous
24
Archer Enhanced User Experience Tool & Utility Implementation Guide
step.
d. Click Get Target Layouts to retrieve the Layouts associated with the Levels selected in
the previous step.
e. Select one or more Target Layouts from which you want to remove layout objects or
click Select All to select all Layouts associated with the Levels selected in the previous
step.
f. Click Create Layout Object Removal Table to populate the Layout Object Removal
Table.
i. The first three columns will be populated with each Tab, Section, and Layout
Objects present in the selected Source Layout.
ii. An additional column will be added for each Target Layout selected in the
previous step.
25
Archer Enhanced User Experience Tool & Utility Implementation Guide
i. Click on the checkbox in the Layout Objects column for each Layout Object
(ReformatLayoutCustomObject,
OpenContentURLLinksInNewWindowCustomObject,
FormulaInspectorCustomObject) you wish to delete from the Target Layouts.
1. These Layout Objects will only be deleted from the Target Layouts if
they exist in a section whose name matches the source Section Name.
Their presence will be noted by hovering over a icon which lists all the
non-field Layout Objects in the Target Layout section.
b. To delete the Layout Independent Custom Objects section from all Target Layouts in
which it appears:
i. Click on the checkbox next to Layout Independent Custom Objects in the
Section Name column to delete it from the Target Layouts.
1. If the Section exists in the Target Layouts, its presence will be noted by
an X in the cell corresponding to the source Section and Target Layout.
2. If the Target Layout Section contains any Layout Objects, they will be
moved off layout unless they have been explicitly selected for deletion
via the step above. Their presence will be noted by a count of non-field
( ) and field ( ) layout objects. Hovering over the respective icons will
26
Archer Enhanced User Experience Tool & Utility Implementation Guide
show the names of the layout objects that exist in the Target Layout
section.
7. Removing Layout Object/Sections
a. To remove Layout Objects and Sections after selections are complete, click Remove
Layout Objects/Sections to use Archer's internal API to manage the Target Layouts.
b. A dialog box will appear showing a Summary of Pending Changes. After reviewing the
pending changes, click Confirm to continue or click Cancel to go back to the previous
step to modify selections or abandon the Layout removal process.
(If issues are present that will prevent Target Layouts from being updated, those will be
displayed, and an OK button will be shown in lieu of a Confirm and Cancel buttons.)
c. If confirmed, the process will loop through each selected Layout and remove/delete the
selected Sections/Layout Objects.
i. If non-field Layout Objects are marked for deletion, they will be deleted from
the corresponding selected Layouts.
ii. If Sections are marked for deletion, any layout objects (both fields and non-field
layout objects) will be moved off layout.
27
Archer Enhanced User Experience Tool & Utility Implementation Guide
iii. Note that fields will never be deleted through this process; they can only be
taken off layout.
28
Archer Enhanced User Experience Tool & Utility Implementation Guide
29
Archer Enhanced User Experience Tool & Utility Implementation Guide
Layout Independent Custom Objects to Target Module Layouts task in the previous chapter.
3. After opening the Target Module, select the Level(s) and Layout(s) that were targeted during
deployment, scroll to the bottom of the layout, and validate that the Layout Independent
Custom Objects section is present and populated with the Layout Objects that were selected
to by synchronized.
a. Repeat the steps above for any other Module layouts you wish to validate.
30
Archer Enhanced User Experience Tool & Utility Implementation Guide
a. Section width limited to 1400px max – For browser widths greater than 1400 pixels,
margins should appear to the left and right of the section content, reducing the need to
scan the full width of the screen to consume content. If the browser width is less than
1400px, no margins will appear on the sides of the sections.
b. Field names above field value in light gray font – Field Names that previously appeared
to the left of the field values have now been moved above the field content.
c. Row height set at 60px minimum – Consistent minimum height for all rows.
d. Spacing added between rows – A spacer row has been added between each field row to
separate the bottom border of fields from the top border of fields in the next row.
31
Archer Enhanced User Experience Tool & Utility Implementation Guide
e. Increased overall field width – By eliminating the field name columns, a higher
percentage of the section width is now devoted to field content.
f. White Background Around fields with Rounded Borders – Field labels and values are
now enclosed in a single field with a white background and rounded borders.
g. Help Icons to the Right of Field Names – Help icons that were previously to the left of
field labels have now been placed to the right of the field label to left justify field labels,
making it easier when scanning for fields vertically on the page, regardless of the
presence of help icons.
h. Font Size of Field Content Increased 20% and Semi-Bolded – The font size of field
values has been increased by 20% and semi-bolded to improve readability and
distinguish it from the field label.
2. From Edit mode, validate the following features on the Record Layout Page:
a. Automatic hiding of the Main Navigation Menu – When the record is placed into Edit
mode, the Main Navigation Menu is hidden to provide more vertical space for data
entry. The menu reappears when existing the record or switching to View mode.
b. Transparent (Gray) Background Around Read-Only Fields – When the record is placed
into Edit Mode, any read-only fields (either due to them being calculated fields, read-
only private fields, or set to read-only via Apply Conditional Layout actions) are
rendered with a transparent (gray) background to note to the user that data entry is not
permitted.
c. Data Entry Control Borders Removed from Non-Focused Fields – When the record is
placed into edit Mode, the borders around the data input controls (e.g. textboxes,
32
Archer Enhanced User Experience Tool & Utility Implementation Guide
dropdowns, listboxes, etc.) are hidden to not interfere with the borders that now
surround each field label/value pair until the user enters the field to make edits, at
which point the border of the control reappears. Exiting the field once again removes
the control border.
3. Validate that column and row spans on questionnaire question fields, fields with advanced
display formatting, report objects, etc. specified in the Application Builder are being honored.
4. Validate that the section in which the Reformat Layout Custom Object (e.g., Layout
Independent Custom Objects) is placed is hidden. (The Reformat Layout Custom Object
includes code which automatically hides the section in which its placed without the need for an
Apply Conditional Layout action to do it.)
5. Repeat the steps above for other layouts where the Reformat Layout Custom Object has been
deployed.
Task 3: Validate Open Content URL Links in New Window Custom Object Functionality
1. Open a record with one or more cross-reference/related record fields present on the layout.
2. Validate that an Open In New Window icon appears after each cross reference hyperlink.
33
Archer Enhanced User Experience Tool & Utility Implementation Guide
3. Click the icon. A pop-up window should appear with the selected in a New Window. The
original browser window should still show the parent record.
4. Without closing the newly opened record, click back on the original browser window and
validate that the icon corresponding to the record opened in the pop-up window is now colored
green.
5. Click on the green icon and validate that the focus is returned to the pop-up window.
6. Close the pop-up window and validate that the icon returns to its default blue color.
34
Archer Enhanced User Experience Tool & Utility Implementation Guide
35