RSA Archer 6.5 Platform Administrator's Guide
RSA Archer 6.5 Platform Administrator's Guide
RSA Archer 6.5 Platform Administrator's Guide
6.5
Contact Information
Go to the RSA corporate web site for regional Customer Support telephone and fax numbers:
https://community.rsa.com/community/rsa-customer-support.
Trademarks
RSA, the RSA Logo, RSA Archer, RSA Archer Logo, and Dell are either registered trademarks or trademarks of Dell
Corporation ("Dell") in the United States and/or other countries. All other trademarks used herein are the property of their
respective owners. For a list of RSA trademarks, go to www.emc.com/legal/emc-corporation-trademarks.htm.
License agreement
This software and the associated documentation are proprietary and confidential to Dell, 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 Dell.
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 RSA.com. By using this product, a user of this product agrees to be fully
bound by terms of the license agreements.
Note on encryption technologies
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.
For secure sites, Dell recommends that the software be installed onto encrypted storage for secure operations.
For customers in high security zones, Dell recommends that a full application sanitization and reinstallation from backup occur
when sensitive or classified information is spilled.
Note on Section 508 Compliance
The RSA Archer® Suite is built on web technologies which can be used with assistive technologies, such as screen readers,
magnifiers, and contrast tools. While these tools are not yet fully supported, RSA is committed to improving the experience of
users of these technologies as part of our ongoing product road map for RSA Archer.
The RSA Archer Mobile App can be used with assistive technologies built into iOS. While there remain some gaps in support,
RSA is committed to improving the experience of users of these technologies as part of our ongoing product road map for the
RSA Archer Mobile App.
Distribution
Use, copying, and distribution of any Dell software described in this publication requires an applicable software license.
Dell believes the information in this publication is accurate as of its publication date. The information is subject to change
without notice. Use of the software described herein does not ensure compliance with any laws, rules, or regulations, including
privacy laws that apply to RSA’s customer’s businesses. Use of this software should not be a substitute for consultation with
professional advisors, including legal advisors. No contractual obligations are formed by publication of these documents.
THE INFORMATION IN THIS PUBLICATION IS PROVIDED "AS IS." DELL INC. 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.
Contents
Preface 14
About This Guide 14
Support and Service 14
Other Resources 14
RSA Archer Documentation 15
Chapter 3: Questionnaires 43
Assessment Process 49
Populating the Question Library 51
Adding Questions to the Question Library 51
Importing Questions into the Question Library 53
Building Questionnaires 54
Adding a Questionnaire 55
3
Platform Administrator's Guide
4
Platform Administrator's Guide
5
Platform Administrator's Guide
6
Platform Administrator's Guide
7
Platform Administrator's Guide
8
Platform Administrator's Guide
9
Platform Administrator's Guide
10
Platform Administrator's Guide
11
Platform Administrator's Guide
12
Platform Administrator's Guide
13
Platform Administrator's Guide
Preface
Other Resources
Resource Description
RSA Archer Our public forum, on the RSA Link Community platform, brings together customers,
Community prospects, consultants, RSA Archer thought leaders, partners and analysts to talk
on about GRC as a practice, and includes product demos, GRC videos, white papers,
RSA Link blogs and more.
https://community.rsa.com/community/products/archer-grc
RSA Archer Our private community, is a powerful governance, risk and compliance online
Customer / network that promotes collaboration among RSA Archer customers, partners,
Partner industry analysts, and product experts. Engaging with the RSA Archer Community
Community on RSA Link enables you to collaborate to solve problems, build best practices,
on establish peer connections and engage with RSA Archer thought leaders.
RSA Link https://community.rsa.com/community/products/archer-grc/archer-customer-partner-
community
Preface 14
Platform Administrator's Guide
Resource Description
RSA Ready RSA's Technology Partner Program is where third parties gain access to RSA
Software in order to develop an interoperability and have it documented and
certified. RSA Ready certifications are posted to an online community and
supported by RSA Support.
https://community.rsa.com/community/products/rsa-ready
RSA The RSA Exchange for RSA Archer offerings help you rapidly deploy adjacent or
Exchange supporting risk business processes, quickly integrate new risk data sources, and
for implement administrative utilities to make the most out of their risk and compliance
RSA Archer investment.
https://community.rsa.com/community/products/archer-grc/exchange
Release Notes A list of issues fixed in the release and a list of issues known at the time of the
release. Available in PDF format.
What's New Overview of the new and updated features in the current release. Overview of the
Guide differences between RSA Archer version 5.x and version 6.x. Suggestions on
planning for moving from 5.x to 6.x are included. This information is available in
the RSA Archer Online Documentation and in PDF format.
Installation Instructions for installing the latest RSA Archer release, and upgrading from 5.x
and Upgrade and 6.x to the latest release. Available in PDF format.
Guide
Preface 15
Platform Administrator's Guide
Document Description
Online Information for using RSA Archer including how to set up and maintain the
Documentation Platform, how to use the Platform features, how to use the RESTful and Web
APIs, security configuration information, and how to install and use the solution
use cases. Available from within the product in HTML5 format using context-
sensitive links, as well as in a Zip format for local installation. The Online
Documentation is also available in full on the RSA Archer Community on RSA
Link at: https://community.rsa.com/community/products/archer-grc/archer-
customer-partner-community/. Content from the Online Documentation system is
also available in PDF format, divided in to the following guides:
l Administrator's Guide
l User's Guide
l RESTful API Guide
l Web API Guide
l Content API Guide
l Security Configuration Guide
l Use Case Guides (one guide for each of the available solution use cases)
Archer Control Information for using the RSA Archer Control Panel module to manage the
Panel (ACP) internal settings of the Platform, such as license keys, global paths and settings.
Help Available from within the ACP module, in a ZIP format for local installation, and
in PDF format.
Planning Information about how to plan for your new RSA Archer installation. This
Guide document is intended for system administrators who are responsible for installing
and managing RSA Archer. Available in PDF format.
Preface 16
Platform Administrator's Guide
Note: If you are using any of the RSA Archer use cases, you might be responsible for customizing
the out-of-the-box applications or questionnaires to meet your organization's requirements. For more
information on use cases, see "Solutions and Use Cases Overview" in the RSA Archer Online
Documentation.
Finally, you can group related applications and questionnaires into a solution.
Communication tools
The Platform offers multiple tools for communication with and between your end users and for
ensuring that your users have access to the right information in the system.
l Notifications alert users to specific conditions within records, particularly when it is something
that requires their attention or action (for example, a record is ready to be reviewed).
l The Discussion Forums feature enables you to create structured environments where users can
exchange information on various topics.
l The Training and Awareness feature enables you to construct and deliver training and awareness
communications to specified users and groups.
l Mail merge functionality allows you to export data into a Microsoft Word document.
l An Alias name is a short name for a unique object in the system that is human readable, but also
can be used in code or as a reference in configuration processes.
Data integration
You can use RSA Archer as a point of consolidation for enterprise data of any type for supporting
analysis and process management. RSA Archer is vendor neutral, content independent, and provides
three integration methods for consolidating data from disparate enterprise systems for governance,
risk, and compliance management.
l Data imports allow you to import data into an application or sub-form from an external data file
on a one-time basis.
l Data feeds allow you to build dynamic integrations with external enterprise systems and files that
can run automatically on an on-going schedule.
l The RSA Archer Web Services API also offers you a programmatic interface for automating the
exchange of information between RSA Archer and an external application.
l Finally, data publications allow you to extract data from your RSA Archer system and load it into
external systems for data analysis and modeling.
Data packaging
Packaging allows you to copy applications and other objects from one RSA Archer instance to
another, for the purposes of transferring large changes from development to test to production
instances or receiving and installing updates to RSA Archer Solutions.
Reporting
Any search against an application or questionnaire that you want to save and reuse at a later time
can be saved as a report. RSA Archer offers pre-built system reports and allows you to create your
own custom reports.
iViews and dashboards to end users through workspaces, which are pages of related content.
Note: The OR operator is supported only when you are filtering fields within a single level of a
leveled application or in a flat application. If you are filtering fields across different levels and
applications, you must use only the AND operator. Ultimately, the results of a search across
multiple levels and applications depend on the filters you apply and the relationships the search
process builds between the filtered fields.
Operator logic statements are evaluated left to right with parenthetical groupings evaluated first. By
using advanced operator logic with your filters, you can eliminate extraneous data that may be
imported with your data feed or included in your search results.
You enter the custom operator logic in the Advanced operator logic field.
Important: Custom operator logic must validate before you can save or apply changes to your data
filter. If your custom operator logic does not validate, you are prompted with an "Invalid Operator
Logic" error message.
To set up this process, you define data filters to evaluate both the System Environment and Security
Class elements in your external data file for the values you want. Without using operator logic, your
conditions are related with the AND operator, and the data feed imports items that are both in a
production environment AND have a high security class. By using operator logic with the OR
operator, you achieve the result you want: Assets that are in a production environment OR have a
high security class are imported into the Assets application.
Based on the above criteria, the following table details the result of the operator logic.
(1) System (2) Security (3) (4) Operating (5) Server
Result
Environment Class Manufacturer System Room
The Data Feed Manager evaluates the nested parenthetical expressions first. In the last example in
the previous table, since neither 3 or 4 evaluate to "TRUE" in the nested parenthetical expression,
the primary parenthetical expression evaluates to "FALSE," and thus the entire logical condition
fails and the data is not imported, even though all of the other conditions are met.
Based on the above criteria, the following table details the result of the oper-
ator logic.
(1) System
(2) Security Class (3) Manufacturer Result
Environment
The system evaluates the parenthetical expression first. In the last example in the previous table,
since neither 1 or 2 evaluate to "TRUE," the entire condition fails even if 3 evaluates to "TRUE".
Note: When you view a record of an application of which you are the assigned owner or an
administrator, you can recalculate all calculated fields within the record.
Leveled applications
You can create multiple data levels within an application. By organizing fields into levels, you can
create master-detail record relationships within a single application. By linking records from one
level to records at the level above or below it, you can create hierarchical applications.
The Policies application in the Policy Program Management use case is an example of a leveled
application. It contains three levels of data: Policy, Area, and Section. Each record in the Area level
is related back to a record in the Policy level, and each record in the Section level is related back to
a record in the Area level, as shown in the associated diagram of the Policies application.
An application can have many levels, and each data level has its own distinct fields, as shown in the
following figure. As a best practice and to ensure optimal application performance, create no more
than four data levels in an application.
Using a leveled application is especially useful for relating records in a child data level to one
parent-level record. In the Policies application example, the record “8.3.3 Password Expiration” in
the Section data level can only relate back to record “8.3 Authentication” in the Area level. You
would not relate record “8.3.3” in the Section level to record “5.5 Project Management” in the Area
level.
If you are considering a leveled application, but foresee child-level records relating back to more
than one parent-level record, consider creating two applications instead and linking those
applications with a cross-reference field.
Building Applications
The following table describes the steps to build an application.
Required
Step Task or Description
optional
1 Create the Required Create the application and set basic behaviors, such as the
application default language and whether users receive updates when
and set content is published or updated.
behaviors
2 Add the fields Required Create the fields that you need for collecting and managing
to the data in the application.
application
3 Define the Required Add fields to the layout and organize the fields in groups and
application sections.
layout
4 Create data Optional Create data driven events (DDEs) if you want to automate a
driven events variety of actions based on values or dates within individual
questionnaire records.
5 Designate the Optional Determine which fields display in the search results by
Navigation default.
Menu items
Required
Step Task or Description
optional
7 Set the Optional If the application includes more than one calculated field, you
execution can specify the order in which each field is executed.
order of
calculated
fields
8 Assign Required Each application must include at least one application owner
application and report administrator. By default, the user who adds the
owners and application is automatically given these roles. You can
report specify additional users if needed for either role.
administrators
Adding Applications
Before adding an application, decide how the application will be used and how its content will be
managed. Consider the following questions:
l Should the application be placed in production immediately, or should it remain in development
until its structure has been formally approved?
l Is there any need to assign and track tasks associated with the application content records?
l Would the use of multiple data levels make information stored within the application easier to use
and organize?
l Should notification emails be used to alert users of new and updated records within the
application?
l Which users should be granted ownership rights to the application?
l Which users should be able to create global reports in the application to share with other
application users?
l Is there a need to change the default language for the application?
After you have made these decisions, you can frame the basic structure of an application, add the
appropriate fields, configure the application layout, designate the items that display in the Navigation
Menu, and create sub-forms, among many other application options.
1. Go to the Manage Applications page.
Note: Copying an application does not duplicate advanced workflow system fields.
4. Click OK.
5. Enter the name of the application.
6. In the Solutions field, click to assign the application to one or more solutions.
7. (Optional) In the Language field, select the default language for the application. By default, the
A data level is a hierarchical grouping mechanism for a subset of fields within an application.
1. Go to the General tab of the application that you want to update.
l Open Tasks/Activities. Lists all of the open Task Management records associated with the
content record.
l Activity History. Lists all of the closed Task Management records associated with the content
record.
Note: If you disable task management, Task Management records are no longer viewable in
records of the associated application. However, all Task Management records still are stored
in the Task Management application. If task management is subsequently reactivated, all
existing Task Management records are displayed with their associated content records.
2. In the Options section, in the Search Results field, select one of the following formats.
The following table describes the options.
Options Description
Column - Displays the search results in a columnar layout where fields are displayed
Hierarchical across the page from left to right, and the values in the search results fields are
presented showing relationships.
Column - Displays the search results in a simple columnar layout without any grouping of
Flat values.
Options Description
Row Displays the search results in a row layout with fields stacked vertically and
records separated by horizontal lines.
Summary Displays the search results in a simple block record format with the key field as
the heading for each record. Fields in the search display as values only in a
single paragraph with each value separated by a diamond symbol.
Optimize calculations
Note: If an administrator disables the option in the RSA Archer Control Panel, field-level
calculation optimization is not available.
2. In the Options section, in the Enable Optimize Calculations field, select Optimize related
calculations after bulk actions complete.
3. Click Save or Apply.
l Click Save to save and exit.
l Click Apply to apply the changes and continue working.
Important: Do not use the names Version, Level ID, or Content ID for fields that you add to an
Application or Questionnaire. Using these names in Applications or Questionnaires prevents the
fields from displaying properly. To ensure that the fields display properly, use different names.
If you do not want a default item to appear in the Navigation Menu, clear the checkbox
for that item.
field Certain field types are labeled as By field name menu items and enable you to search for
name records that include that specific field value. The following field types enable quick
filtering from the Navigation Menu:
l Cross-Reference
l Matrix
l Record Permissions
l Record Status
l User/Groups List
l Values List
data For leveled applications, the menu items are labeled By data level and enable you to
level select records that reside within a specific data level.
Display Specifies the text that appears in the Navigation Menu for the item that you
Alias selected to display. If you selected to display the item in the Visibility field,
you must provide the Display Alias.
Default Expands the item node in the Navigation Menu by default. This field becomes
Expansion available when the Visibility field is enabled.
Fields to Specifies the fields that display in the search results when a user clicks one of
Display these items to execute a search. The fields you select are listed under Records
and By field or By data level menu items.
Use below the Selected list to arrange the fields in the display order.
Use to remove a field from the search results for a menu item.
Sorting Specifies the list order of the fields displayed in search results, which is
executed when a user clicks the menu item.
Use the Field drop-down menu to specify whether the search results are
initially sorted in ascending or descending order. You can add new fields to
sort by.
4. Click OK.
l Create a linear content review process l Create complex non-linear workflow processes
within applications, leveled applications, within applications, leveled applications, or
or questionnaires. questionnaires.
l Send notifications only after content is l Send notifications to multiple users on-demand.
updated and saved by a user. l Enable automatic enrollment for new records,
l Enable only user-initiated enrollment updated records, or user initiated options.
options. l Visually depict the end-to-end advanced
workflow process at the administrator level.
l Designate a specific name for each node to
easily identify the intent of each stage in your
workflow process.
l Create tasks that are linked to the task-driven
landing screen of specified users.
Note: When you add a new calculated field to an application, it displays at the bottom of the list in
the Field Calculation Order listing.
Application owners
You can select the users who will serve as owners of an application.
Note: If you want to edit notifications associated with an application, an administrator must assign
you an access role that gives you access to the Manage Subscription Notifications page.
l Owners have full editing rights over their designated applications, which means they can fully
customize its properties. This includes adding and arranging fields in the application, enabling
Report administrators
You can assign permissions to users and groups for creating and editing global reports in a specific
application.
l Global reports can be shared with any user in the application, but only users with access to the
application for which the report was created can see the contents of the report.
l Users who do not have global report creation rights can only create personal reports, which
cannot be shared with other users.
l To revoke ownership, click in the Applications Owners field and click to the right of
the appropriate name in the Selected list.
l To revoke report administrators, click in the Report Administrators field and click to
the right of the appropriate name in the Selected list.
3. Click OK.
4. Click Save or Apply.
l Click Save to save and exit.
l Click Apply to apply the changes and continue working.
By selecting multiple solutions for a single application, you can reuse the same information for a
variety of purposes. For example, you could group a Contacts application into your Customer
Relationship Management and Project Management solutions so that both solutions can use contact
information from the same source.
You can also remove an application from a solution when you want.
Production Sets the application so that users can enter 'live' data for your business
environment. These applications can be referenced using cross-reference and
cross-application status tracking fields, and users can execute searches in these
applications and save those searches as named reports.
Development Sets the application so that users can enter data without impacting live data. A
development application has all of the characteristics of a production
application, but all records in the application are displayed with a watermark.
Development applications do not count against your custom application
licenses.
Archived Sets the application so that content is read-only and users can continue to
search and display the application content. The Add, Edit, and Delete options
are disabled, along with the Data Import feature. End users can continue to
select records in an archived application through cross-reference fields in
production applications. However, calculated fields and record permissions are
not recalculated in archived applications. Archived applications do not count
against your custom application licenses.
Retired Sets the application so that it is hidden from users. Users cannot create or edit
records, and cannot execute searches or view reports that were saved in the
application at a time when it was in production.
If you retire an application that an administrator has referenced in another
application cross-reference or cross-application status tracking field, that field
is also retired.
Application owners can continue to modify retired applications, assign access
rights for retired applications, and create notification templates for retired
applications.
Data feeds and questionnaires associated with the retired application continue
to use system resources. Prior to retiring an application, RSA recommends
deactivating all data feeds that target retired application.
Important: After your organization reaches its application limit as specified by your license,
you cannot create additional production applications. You can however still create development
applications.
Important: When an application is deleted, all data within that application is permanently lost.
Delete an application
42
Platform Administrator's Guide
Chapter 3: Questionnaires
The Questionnaire feature is available only if your organization has licensed one or more use cases
that contain questionnaires. Questionnaires can be configured to run on mobile devices if RSA
Archer is licensed for mobile questionnaires.
The Questionnaire feature enables you to do the following:
l Automatically score questionnaire records and generate findings for each incorrect answer.
l Build and deliver targeted assessment campaigns for any type of organizational object, such as
your assets, business processes, or vendors.
l Build or import questions in the Question Library application for use in any questionnaire.
o Assign questions to categories and apply filter properties that you can later use to create
question display rules.
o Assign correct answers, numeric answer values, and question weighting, and you can link
Values List questions to authoritative sources and control standards to measure and report
compliance.
l Build questionnaires by selecting questions from the Question Library for inclusion and assigning
the questionnaire to a target application, such as Applications or Facilities.
l Configure your application structure by preparing the target application and by configuring risk
register and metrics.
l Create a library of questions linked to authoritative sources and control standards.
l Define question display rules that dynamically show or hide questions to end users based on
attributes of the target they are assessing.
l Ensure that all necessary policies, control standards, and authoritative sources are available.
l Launch questionnaires online through assessment campaigns.
l Monitor and report on inherent and residual risk, and measure compliance.
Chapter 3: Questionnaires 43
Platform Administrator's Guide
Questionnaire terminology
The following table describes questionnaire terms.
Term Definition
Questionnaire A collection of fields and questions linked to a specific target application record.
Record Questionnaire records are stored within questionnaires.
Question A field type unique to questionnaires that serves as the functional component of an
assessment. The following question types are available: Attachment, Cross-
Reference, Date, Numeric, Text, and Values List.
Questions enable users to evaluate the specific item being assessed, such as an
asset, business process, vendor, facility, and so on. Each question has a
configurable set of properties that govern how the question is displayed in the
questionnaire and how (or whether) the user is to interact with it. In addition to the
properties associated with standard fields, questions can be filtered through
specific question display rules, linked to authoritative sources, included in
assessment scoring, and utilized in automated findings generation.
You can create questions with predefined answers that users can select from, or
you can allow users to enter free-form text, dates, or numeric entries. You can
also allow users to attach documents, pictures, diagrams, and other types of files
to a questionnaire to provide supporting information or evidence.
Target The application that contains a specific set of items, such as servers, vendors, or
business processes. For example, a Data Security questionnaire might have the
Devices application as its target. The questionnaire records within the Data
Security questionnaire would pertain to individual records in the Devices
application, such as a specific database server.
Chapter 3: Questionnaires 44
Platform Administrator's Guide
Term Definition
Campaign Automates creating questionnaire records for assessment targets based on the
properties of target records. For example, if the target of the questionnaire is a
Devices application, the campaign can auto-create questionnaire records for all
devices in a production environment. Campaigns may be configured to populate
questionnaire records with the year, quarter, and due date of the assessment, along
with the assigned submitter and reviewer. Recurring campaigns can be launched,
and multiple campaigns may be created for each questionnaire.
Question A unique grouping of questions enabling you to organize and filter results, such as
Category Access Control, Business Continuity, and Risk Management. If you enable
Findings for a questionnaire that you are managing, RSA Archer automatically
creates Findings records for questions that are answered incorrectly, and each
finding includes the associated question category, enabling you to search and sort
findings by category.
A key use of question categories is for creating question display rules. You can
define rules to show or hide questions when end users fill out a questionnaire
based on attributes of the target they are assessing. For example, you have defined
a question display rule for a questionnaire that assesses targets in your Assets
application. The question display rule specifies that if an asset contains
confidential customer data, the questionnaire should display all questions in the
Access Control category. When an asset manager in your organization fills out the
questionnaire to assess the security of a server that houses confidential customer
data, the asset manager will be prompted to answer the Access Control questions
you have selected for display.
Question A numeric attribute that can be assigned to any Values List question. The question
Weighting weight is used to generate the question score.
Chapter 3: Questionnaires 45
Platform Administrator's Guide
Term Definition
Question A calculated value determined for each Values List question. The value is
Score determined by the following formula:
[question weight] * [numeric value assigned to selected answer] = question score
or (for multi-select Values List questions):
[question weight] * SUM ([numeric value assigned to selected answer1], [numeric
value assigned to selected answer2]) = question score
Question scores are rolled up to determine a questionnaire score.
Inherent The sum of all question scores for a questionnaire record. This score represents
Score the natural risk associated with the target in absence of any remediation activities
or changes in the environment.
Residual The risk that remains in a target after findings are remediated. This score is
Score calculated as Inherent Risk – Remediation Changes = Residual Risk. While
inherent risk is calculated only once, residual risk changes over time as findings
are remediated. The residual score is displayed in the Quantitative Summary in a
questionnaire record, enabling end-users to monitor changes to the score over
time.
Tasks Action items that have been assigned to a user relating to a finding. All tasks are
created and managed through the Task Management application, which can be
used to document the remediation activities associated with items identified in the
Findings application.
Chapter 3: Questionnaires 46
Platform Administrator's Guide
Question types
The following table describes question types.
Question
Description
Type
Attachment Enables users to upload documents, pictures, diagrams, and other types of files to a
questionnaire record to provide supporting information or evidence. When
configuring an Attachment question, you can specify the total number of files that
can be uploaded (attached), as well as the size (between 1 and 100 MB) permitted
for each file. You can also enable end users to keyword search into attached
documents. The following file types are supported for document searching:
l Microsoft Word
l Microsoft Excel
l PDF
l Text
Cross- Enables users to associate records from other applications or questionnaires with a
Reference questionnaire record.
When you create a Cross-Reference question, a Related Records field is
automatically added to the related application or questionnaire. Within an individual
record in the related application or questionnaire, you can see all records that have
been cross-referenced to that record.
Date Accepts only a valid date entry and is displayed to users with a calendar icon. Users
can either enter dates directly or click to select a date from the Date Range
dialog box. You can also enable users to enter a time of day to associate with the
date.
The Date question type also supports a default date value. The default date value is
set when a questionnaire record is created. When configuring the default value, you
can select to display the date of questionnaire record creation, a date that is a
specific number of days after the date of record creation, or a static, specific date.
You can also select to display no default value.
Chapter 3: Questionnaires 47
Platform Administrator's Guide
Question
Description
Type
Numeric Accepts both positive and negative values and, by default, accept values of any size.
However, when configuring a Numeric question, you can choose to apply minimum
and maximum value constraints. You can also specify the number of decimal places
permitted for the value.
The Numeric question type also supports the following specialized options:
l Numeric Ranging - If you enable this option, you can define a set of numeric
ranges and apply a descriptive name to each range. For example, a range named
"High" might be mapped to the numeric range "8 - 10." The range name you
define for the question is then displayed in the Filter by Value section of the
Search Records page for the questionnaire. This allows users to search across a
range of values for your Numeric question by selecting the range name as part of
their filter criteria.
l Format - By selecting this option, commas are used to separate units of numbers.
For example, if you enter the value "10000" in the Edit mode of the record, the
value would be displayed as "10,000" in the View mode of the record.
l Prefixes and Suffixes - By selecting one or both of these options, you can insert
text (up to 10 characters, including special characters) before or after the value in
a Numeric question to provide context for end users. For example, you can enter a
dollar sign as a prefix or a distance unit as suffix.
Text Accepts both alphabetic and numeric entries. It can be displayed to users in a single-
line or a multi-line (scrolling) text area. If the question is configured as a text area,
you can specify the height (in lines) for the control.
By default, entries in this question type are not restricted. However, when
configuring this question type, you can choose to set a maximum character length for
entries. In addition, you can restrict users from entering a value in the Text question
that is identical to a value entered in another record within the questionnaire, thereby
ensuring that all values in the Text question are unique.
Chapter 3: Questionnaires 48
Platform Administrator's Guide
Question
Description
Type
Values List Provides users with a list of predetermined values from which to choose. This field
type can be expressed using one of several interface control types:
l Drop-down
l Radio buttons
l Checkboxes
l List box
l Values pop-up
You can also add a numeric weight to a question and assign a numeric value to the
individual selections available within the question. These numbers are used to
compute the score for a questionnaire.
You can populate a Values List question with either a custom or a questionnaire
values list. If you use a custom answer list, you must define the answers for the
question. Custom answer lists cannot be reused to populate any other Values List
question.
You can create questionnaire values lists that you can reuse for any Values List
question within the questionnaire.
Assessment Process
The following phases provide a general overview for building and delivering an online questionnaire
to assess risk within your organization.
Assessment
User Details
Phase
Creating and Questionnaire Create new questions or import your existing questions through
Configuring Owner/Admin the Question Library application. When configuring your
Questions questions, do the following:
l Select the appropriate question type to ensure the correct data
is collected.
l Determine the weighting of individual questions.
l Include the appropriate answer selections and determine the
correct answer to the question.
Chapter 3: Questionnaires 49
Platform Administrator's Guide
Assessment
User Details
Phase
Assessing End-users Users complete their assigned assessments through the RSA
Your Target Archer web-based interface. While assessing a target, the end
user can include question-specific comments to support their
answers, attach supporting evidence, and delegate additional
users to an assessment as needed.
Evaluating End-users When users complete their assigned questionnaire records, they
Findings can view reports to determine the risk associated with specific
targets. With the Findings feature enabled, RSA Archer
automatically generates Findings records for each incorrectly
answered question to identify areas of noncompliance.
Chapter 3: Questionnaires 50
Platform Administrator's Guide
Chapter 3: Questionnaires 51
Platform Administrator's Guide
Note: This name labels and identifies the question. It also is the key field for the Question
Library record.
Note: The category determines the section in which the question is displayed. It also determines
whether a question is displayed to a user when there are Question Display Rules in the
questionnaire. If your user account has edit privileges, you can click Edit and add additional
categories to the list.
5. In the Question Text field, enter the text for the question that is displayed to the user.
6. From the Question Type list, select a question type.
Note: You cannot change this value after you save the question.
Chapter 3: Questionnaires 52
Platform Administrator's Guide
Important: Your import data file for the Answer Values sub-form must contain the unique identifier
from the parent Question Library record. For example, if you are importing answer values for the
question, "Does this application contain customer data?" you need to include the unique identifier for
this question. This practice ensures that your answer values are associated with the correct question.
You can use values from either the Question ID or the Question Name field as unique identifiers for
a Question Library record.
Chapter 3: Questionnaires 53
Platform Administrator's Guide
Note: You cannot import the Answer Values information at the same time as the initial data
import.
Building Questionnaires
The following table describes the steps to build a questionnaire.
Required
Step Task or Description
Optional
2 Add questions Required Create the questions and fields that you need for collecting
and fields to data during the assessment.
the
questionnaire
3 Configure the Required Add fields and questions to the layout and organize them in
layout groups and sections.
4 Create data Optional Create data driven events (DDEs) if you want to automate a
driven events variety of actions based on values or dates within individual
questionnaire records.
5 Configure Optional You can determine which fields display in the search results
Navigation by default.
Menu items
6 Define Optional If the questionnaire is part of a workflow, you can specify the
workflows order in which a user performs the tasks.
7 Configure Optional You can create rules to show or hide questions based on
question individual attributes of the assessment target.
display rules
Chapter 3: Questionnaires 54
Platform Administrator's Guide
Required
Step Task or Description
Optional
9 Set the Optional If the questionnaire includes more than one calculated field,
execution you can specify the order in which each field is executed.
order for
multiple
calculated
fields
10 Set Required Set basic behaviors, such as the question display style and
questionnaire whether the questionnaire is mobile-ready.
behaviors
Adding a Questionnaire
You can create a new questionnaire by naming and describing the questionnaire, and assigning the
questionnaire to an existing solution. For example, if you are assessing technical assets for PCI
compliance, you would group the questionnaire into the PCI Compliance solution. You also select
the target application that houses the objects of your assessment, such as applications, business
processes, vendors, and so on.
Another key step in the creation process is to determine whether you want to copy questions from
the Question Library into your questionnaire or create new questions from scratch. If you select to
copy questions, you can select any number of questions from the Question Library, and those
questions automatically are displayed in the layout of your questionnaire and grouped into sections by
category.
Important: Ensure that all necessary policies, control standards, and authoritative sources are
available.
Chapter 3: Questionnaires 55
Platform Administrator's Guide
Add a questionnaire
1. Go to the Manage Questionnaires page.
Note: Copying a questionnaire does not duplicate advanced workflow system fields.
l To select new settings for the questionnaire, click Create a new Questionnaire from scratch.
4. Click OK.
5. Complete the General Information section:
a. In the Name field, enter a name for the questionnaire.
b. In the Solutions field, click , assign the questionnaire to one or more solutions, and click
OK.
c. In the Language field, select a language.
d. In the Target Application field, click , select an available application to assign to the
questionnaire and click OK.
If the application that you selected is leveled, the Target Level field is displayed. Click
and select a level from the list.
e. To copy questions from the Question Library into the questionnaire, select the Question Copy
checkbox.
6. Click OK.
Chapter 3: Questionnaires 56
Platform Administrator's Guide
In addition to the questions themselves, questionnaires contain several standard fields for collecting
data on the assessment. Standard fields differ from questions in that they do not include question text
or weighting, they cannot be filtered using question display rules, and they are not included in
progress calculations for questionnaire records and campaigns. However, standard fields offer more
variety for data collection than questions do, and you can control user access to fields, whereas all
questions are inherently public.
Note: After you copy a question from the Question Library into your questionnaire, it is no longer
connected to the original question in the Question Library. As a result, you can modify the question
without affecting the version in the Question Library. This enables you to tailor questions for a
specific type of assessment. For example, you can change the question weighting, relate a question
to additional authoritative sources, add new answer options, and more.
Note: You also can access the Record Lookup page from the Layout tab. Click the Add
New Field arrow and select Add from Question Library.
2. On the Record Lookup page, select the checkbox for each question that you want to copy into
your questionnaire.
Note: To limit the types of questions that you see on the Question Lookup page, enter the values
that you want to filter by in the filter boxes for that column. Click Filter in the column header to
refine your search results. You can also select all questions within the Search Results page by
selecting the checkbox at the top of the Question Name column.
3. Click OK to copy the selected questions into your questionnaire. When prompted to confirm your
selections, click OK to complete the copy operation.
Chapter 3: Questionnaires 57
Platform Administrator's Guide
When you leave the Question Lookup page, the Administrators tab is displayed on the Manage
Questionnaires page. In the Last Question Library Copy control group at the bottom of the page,
you can see the status of your copy operation. When it is complete, click the Layout tab to view
your questions in the questionnaire layout. The questions automatically are grouped in sections by
question category.
4. Click Save or Apply.
l Click Save to save and exit.
l Click Apply to apply the changes and continue working.
Add fields
See the following tasks:
l Adding Access History Fields
l Adding Attachment Fields
l Adding Cross-Application Status Tracking Fields
l Adding Calculated Fields
l Adding Date Fields
l Adding Discussion Fields
l Adding External Links Fields
l Adding First Published Date Fields
l Adding History Log Fields
l Adding Image Fields
l Adding IP Address Fields
l Adding Last Updated Date Fields
Chapter 3: Questionnaires 58
Platform Administrator's Guide
When you create a questionnaire, you can copy questions from the Question Library into your
questionnaire. You also can copy questions at any time using the Fields or Layout tab of the Manage
Questionnaires page.
Note: After you copy a question from the Question Library into your questionnaire, it is no longer
connected to the original question in the Question Library. As a result, you can modify the question
without affecting the version in the Question Library. This enables you to tailor questions for a
specific type of assessment. For example, you can change the question weighting, relate a question
to additional authoritative sources, add new answer options, and more.
2. Click the Question Library link in the top-right corner of the page.
Note: You also can access the Record Lookup page from the Layout tab. Click the Add New
Field arrow and select Add from Question Library.
3. On the Record Lookup page, select the checkbox for each question that you want to copy into
your questionnaire.
Chapter 3: Questionnaires 59
Platform Administrator's Guide
Note: To limit the types of questions that you see on the Question Lookup page, enter the values
that you want to filter by in the filter boxes for that column. Click Filter in the column header to
refine your search results. You can also select all questions within the Search Results page by
selecting the checkbox at the top of the Question Name column.
4. Click Apply to copy the selected questions into your questionnaire. When prompted to confirm
your selections, click Continue to complete the copy operation.
When you leave the Question Lookup page, the Administrators tab is displayed on the Manage
Questionnaires page. In the Last Question Library Copy control group at the bottom of the page,
you can see the status of your copy operation. When it is complete, click the Layout tab to view
your questions in the questionnaire layout. The questions automatically are grouped in sections by
question category.
5. Click Save or Apply.
l Click Save to save and exit.
l Click Apply to apply the changes and continue working.
Creating Questions
To protect data integrity, you cannot change the question type. For example, you cannot change a
Date question into a Text question, after a question has been created.
1. Go to the Fields tab of the questionnaire in which you want to add a new question.
Chapter 3: Questionnaires 60
Platform Administrator's Guide
Chapter 3: Questionnaires 61
Platform Administrator's Guide
Grid Displays multiple fields of data from the referenced record spanning the width of
the page in a table format (Grid) or in a single-column format. The attachment
information displays as a resizable grid control that displays the name, size and file
type for each file. When you select the Grid option, users with appropriate access
can view the Download History report. This report provides a summary of the
download history of a document including the user, email address, and download
date. Users can upload files by clicking Add New.
Required Designates the field as required and forces users to enter a value when adding or
Field editing a record in the application. An icon (selected in the Appearance feature)
indicates required fields to alert users that they must enter a value. If you do not
select this option, you can skip this field when adding or editing a record in the
application.
Auditing Displays auditing information next to the field each time that its value is
Information changed. The auditing information includes only the name of the user who made
the change and the date and time of the change. If this checkbox is not selected,
auditing information is not displayed with the field in the user interface.
Search Makes this field available for display in search results and references its values
Results in search filters.
Search Includes the field by default in search results for the application. This option does
Default not prevent users from removing the field from the Search Results page. Users
Field can click Modify in the toolbar and remove the field from the Fields to Display
section of the application Search Records page.
Chapter 3: Questionnaires 62
Platform Administrator's Guide
Option Action
Keyword Allows users to use this field in a keyword search to find documents attached to
Searching the field. File types supported for document searching include Microsoft Word,
Microsoft Excel, PDF, Text, and .CSV. If a user does not have access to the
field but the field is configured to allow keyword searching, the field is still
searched but not included in the search results.
Calculated Designates the field as a calculated field determined by a formula that computes
Field a value dynamically for this field. If you select this option, the field is read-only
for all users, and the defined formula computes its value.
Validate Designates that a field is validated whenever any value changes in a record. If
Always the Validate Always option is not selected, this field validates only when the
value in that field has changed.
4. In the Configuration section, specify the minimum and maximum number of attachments and size
limitations of the attachment files
The following table describes the options.
Option Description
Minimum Specifies the minimum number of attachments that you want to require for an
Attachments attachment field.
Maximum Specifies the maximum and minimum number of attachments that you want to
Attachments require for the field.
Maximum Specifies the maximum file size, up to 100 MB, that you want to allow for each
Size file uploaded to the attachment field. This setting does not restrict the total size
of all files uploaded to the field.
Users may experience a long wait time when attaching large files to a record. If
you allow users to attach multiple large files, periodically monitor the available
space and current usage of the file repository to ensure optimized system
performance.
Display Designates the fields you want to display along with your attachment file.
Fields Important: The Downloads and History fields require System Administrator
access to view.
Chapter 3: Questionnaires 63
Platform Administrator's Guide
2. In the Question Text field, enter the text for your question.
3. From the Category list, select an appropriate category for the question. If necessary, click Edit to
modify the list of categories.
Chapter 3: Questionnaires 64
Platform Administrator's Guide
e. In the Field Name column, click the field whose properties you want to define.
f. Click the Questions tab.
l To apply an existing filter to the current question, click in the Values column for that filter
in the Question Filter Properties section, and select the specific filter value that applies to
your question. To remove a filter from the question, click to the right of the filter value.
l To add a new filter, click Add New.
Important: Do not click to remove a filter from the current question. Doing so will
permanently delete the filter for all questions that use it. Instead, use to remove the filter
from the current question while preserving its application to other questions. If the Value
column for a filter is blank, that filter is not applied to the current question.
3. In the General Information section, enter a name and description for the filter.
4. In the Filter Values section, click Add New.
5. In the Value field, enter the value text and click Apply.
6. (Optional) Repeat steps 4 - 5 to add any additional values as needed.
7. Click Save on the Edit Filter Property page to return to the Manage Field page.
8. In the Question Filter Properties section, click to the right of the filter that you just created.
9. Select one or more filter values to apply to the question.
10. Click Save or Apply.
l Click Save to save and exit.
l Click Apply to apply the changes and continue working.
The cross-reference question type enables users to associate records from other applications or
questionnaires with a questionnaire record.
Note: To protect data integrity, the Questionnaire feature prohibits question type changes, for
example, changing a Date question to a Text question, once a question has been created.
Chapter 3: Questionnaires 65
Platform Administrator's Guide
1. Go to the Fields tab of the questionnaire in which you want to add a new question.
Chapter 3: Questionnaires 66
Platform Administrator's Guide
Grid Displays multiple fields of data from the referenced record spanning the width of
the page in a table format (Grid) or in a single-column format. The attachment
information displays as a resizable grid control that displays the name, size and file
type for each file. When you select the Grid option, users with appropriate access
can view the Download History report. This report provides a summary of the
download history of a document including the user, email address, and download
date. Users can upload files by clicking Add New.
Required Designates the field as required and forces users to enter a value when adding or
Field editing a record in the application. An icon (selected in the Appearance feature)
indicates required fields to alert users that they must enter a value. If you do not
select this option, you can skip this field when adding or editing a record in the
application.
Auditing Displays auditing information next to the field each time that its value is
Information changed. The auditing information includes only the name of the user who made
the change and the date and time of the change. If this checkbox is not selected,
auditing information is not displayed with the field in the user interface.
Search Makes this field available for display in search results and references its values
Results in search filters.
Search Includes the field by default in search results for the application. This option does
Default not prevent users from removing the field from the Search Results page. Users
Field can click Modify in the toolbar and remove the field from the Fields to Display
section of the application Search Records page.
Chapter 3: Questionnaires 67
Platform Administrator's Guide
Option Action
Enable Determines whether a display is editable in a grid that has inline edit enabled.
Editable
Grid
Display
Lookup Specifies whether users can access a Record Lookup page for selecting records
from the related application. Clear this checkbox if you only want to allow users
to create new records for cross-referencing. You must select this checkbox if
you want the cross-reference field to be available for selection in a MRDC field
or are creating a dynamic filter.
Add New Determines whether the Add New link is displayed in a grid for allowing users to
add new records to the related applications from a record in view mode. Users
will not have to open a record in edit mode to create new related records. If a
user does not have rights to create records in the related application, the link is
not displayed for that user.
When a user creates a new related record from view mode, that record will be
selected in the cross-reference field just as it would if it were created from edit
mode. For example, if a user opens a Vendor record in View mode and creates a
record in the related Audits application by clicking Add New in the cross-
reference field, that new Audit record will be selected in the cross-reference
field of the Vendor record, even though the user did not open the Vendor record
for editing.
Tree Determines whether the related records in a leveled application for cross-
Display referenced records are displayed in a hierarchical format for a single-column
display. The following figure shows top-level record references flush with the
left margin of the field, and record references in subsequent data levels indented.
When records with the cross-reference field are exported in CSV format, the
Tree Display option is disabled to allow the data to be re-imported into the
application. All other data export formats preserve the cross-reference tree
display for the field.
Chapter 3: Questionnaires 68
Platform Administrator's Guide
Option Action
Validate Designates that a field is validated whenever any value changes in a record. If
Always the Validate Always option is not selected, this field validates only when the
value in that field has changed.
Disable Disables the Remove button for records displayed in this field.
Remove
4. In the Record Lookup Configuration section, specify the rules for finding the related records of
the cross-reference field.
The following table describes the options.
Option Action
Display If you selected the Grid or Single Column display control, you can define the fields
Fields of data from the relationship application that should display in the Record Lookup
page for end users when they select related records in the Cross-Reference field.
To select fields for display, click in the Display Fields field and select the fields
that you want to display from the Available list.
Use the below the Selected list to arrange the fields. The top-to-bottom order
of fields in the Selected list display as the left-to-right order of fields in the Record
Lookup page.
Note: If the relationship application is a leveled application, and you selected fields
from two or more levels to be displayed in the Cross-Reference field, you can only
arrange those fields on a level-by-level basis. You cannot intermix fields from
separate data levels.
Filters To limit the records users can select in the Cross-Reference question to only those
records that contain specific field values, apply filter criteria to the records.
Sorting If you selected the Grid or Single Column display control, you can define the fields
by which cross-referenced records should be sorted within the Lookup control. For
example, in an "Investigators" Cross-Reference field, you could sort the display of
referenced records alphabetically by investigator name.
Chapter 3: Questionnaires 69
Platform Administrator's Guide
Option Action
Display Select how you want the cross-referenced records displayed on the Record Lookup
Format page:
l Column Hierarchical. Displays the records in a columnar layout where fields
are displayed across the page from left to right, and the field values are presented
showing relationships.
l Column-Flat. Displays the records in a simple columnar layout without any
grouping of values.
5. In the Grid Display Properties section, select the fields displayed in the record look-up for the
cross-reference field.
The following table describes the options.
Option Action
Use Record Select this option to apply the values selected in the Record Lookup
Lookup Configuration section to the corresponding View/Edit Display control group
Configuration fields.
Display If you selected the Grid or Single Column display control, you can define the
Fields fields of data from the relationship application that should display in the
Lookup control for end users when they select related records in the Cross-
Reference question.
To select fields for display, click in the Display Fields field and select the
fields that you want to display from the Available list.
Use the below the Selected list to arrange the fields. The top-to-bottom
order of fields in the Selected list display as the left-to-right order of fields in
the Lookup control.
Chapter 3: Questionnaires 70
Platform Administrator's Guide
Option Action
Sorting If you selected the Grid or Single column display control, you can define the
fields by which cross-referenced records should be sorted within the Lookup
control.
For example, in an "Investigators" Cross-Reference question, you could sort
the display of referenced records alphabetically by investigator name.
6. In the Configuration section, specify the minimum and maximum number of attachments and size
limitations of the attachment files
The following table describes the options.
Option Description
Minimum Specifies the minimum number of selections (from none to 20 selections) that a
Selections user can select in the Dropdown, Checkboxes, Listbox, or Values Popup display
control.
Maximum Specifies the maximum number of selections (from none to 20 selections) that a
Selections user can select in the Dropdown, Checkboxes, Listbox, or Values Popup display
control.
Default Determines the number of cross-referenced records that display in the grid and is
Records only available when the display control is set to Grid. If this option is selected,
Display only the first designated number of records are displayed. For example, when this
option is set to 10, only the first 10 records display in the grid. If the number of
records exceeds the default display number, a View All link is displayed. A user
can click this link to view all of the associated records.
Chapter 3: Questionnaires 71
Platform Administrator's Guide
2. In the Question Text field, enter the text for your question.
3. From the Category list, select an appropriate category for the question. If necessary, click Edit to
modify the list of categories.
l To apply an existing filter to the current question, click in the Values column for that filter
in the Question Filter Properties section, and select the specific filter value that applies to
your question. To remove a filter from the question, click to the right of the filter value.
Chapter 3: Questionnaires 72
Platform Administrator's Guide
Important: Do not click to remove a filter from the current question. Doing so will
permanently delete the filter for all questions that use it. Instead, use to remove the filter
from the current question while preserving its application to other questions. If the Value
column for a filter is blank, that filter is not applied to the current question.
3. In the General Information section, enter a name and description for the filter.
4. In the Filter Values section, click Add New.
5. In the Value field, enter the value text and click Apply.
6. (Optional) Repeat steps 4 - 5 to add any additional values as needed.
7. Click Save on the Edit Filter Property page to return to the Manage Field page.
8. In the Question Filter Properties section, click to the right of the filter that you just created.
9. Select one or more filter values to apply to the question.
10. Click Save or Apply.
l Click Save to save and exit.
l Click Apply to apply the changes and continue working.
To protect data integrity, you cannot change the question type. For example, changing a Date
question to a Text question, after a question has been created.
1. Go to the Fields tab of the questionnaire in which you want to add a new question.
Chapter 3: Questionnaires 73
Platform Administrator's Guide
l To add a new question from an existing question, click Copy an existing Field, and select the
date field you want to copy.
4. Click OK.
5. In the General Information section, enter a name and description for the question.
6. Click Save or Apply.
l Click Save to save and exit.
l Click Apply to apply the changes and continue working.
Text Box - Date Only Displays a date in a text box or dropdown list by date or by date
Text Box - Date and and time.
Time
Dropdown - Date Only
Dropdown - Date and
Time
Chapter 3: Questionnaires 74
Platform Administrator's Guide
Required Designates the field as required and forces users to enter a value when adding or
Field editing a record in the application. An icon (selected in the Appearance feature)
indicates required fields to alert users that they must enter a value. If you do not
select this option, you can skip this field when adding or editing a record in the
application.
Auditing Displays auditing information next to the field each time that its value is
Information changed. The auditing information includes only the name of the user who made
the change and the date and time of the change. If this checkbox is not selected,
auditing information is not displayed with the field in the user interface.
Search Makes this field available for display in search results and references its values
Results in search filters.
Search Includes the field by default in search results for the application. This option does
Default not prevent users from removing the field from the Search Results page. Users
Field can click Modify in the toolbar and remove the field from the Fields to Display
section of the application Search Records page.
Unique Prevents users from entering an identical value in a field in separate records. If a
Field user saves a value in this field and the same value already exists in the field in a
different record, RSA Archer prompts the user to enter a unique value.
Key Field Designates the field as the key field of a record. You must designate one field in
the application as the key field, but can only designate one field as the key field.
You can select the key field values in search results, and users can click the
values to open individual records. A key field must be on the page layout of the
application.
After saving the field, you can only clear this checkbox by selecting another field
as the key field in the application. Selecting this option automatically selectsthe
Required Field, Search Results, and Search Default Field options.
Validate Designates that a field is validated whenever any value changes in a record. If
Always the Validate Always option is not selected, this field validates only when the
value in that field has changed.
4. In the Configuration section, specify the minimum and maximum number of attachments and size
Chapter 3: Questionnaires 75
Platform Administrator's Guide
Default Specifies the default date value of the date field when a user adds a new record in
Value the application. The default date is set at record creation. Record edits do not affect
this date The following options are available:
l None. Select None if you do not want to place a default value in the date field.
l Current Date. Select Current Date to display the date of record creation in the
date field.
l Future Date. Select Future Date to display a default date value that is a specific
number of days after the date of record creation. Then enter the specific number
of days in the field to the right.
l Specific Date. Select Specific Date to display a static date as the default value
for the date field, and enter the date in the field to the right or click the Calendar
icon to select the date from a calendar dialog box.
2. In the Question Text field, enter the text for your question.
3. From the Category list, select an appropriate category for the question. If necessary, click Edit to
modify the list of categories.
Chapter 3: Questionnaires 76
Platform Administrator's Guide
l To apply an existing filter to the current question, click in the Values column for that filter
in the Question Filter Properties section, and select the specific filter value that applies to
your question. To remove a filter from the question, click to the right of the filter value.
l To add a new filter, click Add New.
Important: Do not click to remove a filter from the current question. Doing so will
permanently delete the filter for all questions that use it. Instead, use to remove the filter
from the current question while preserving its application to other questions. If the Value
column for a filter is blank, that filter is not applied to the current question.
3. In the General Information section, enter a name and description for the filter.
4. In the Filter Values section, click Add New.
5. In the Value field, enter the value text and click Apply.
6. (Optional) Repeat steps 4 - 5 to add any additional values as needed.
7. Click Save on the Edit Filter Property page to return to the Manage Field page.
Chapter 3: Questionnaires 77
Platform Administrator's Guide
8. In the Question Filter Properties section, click to the right of the filter that you just created.
9. Select one or more filter values to apply to the question.
10. Click Save or Apply.
l Click Save to save and exit.
l Click Apply to apply the changes and continue working.
To protect data integrity, you cannot change the question type changes. For example, changing a
Date question to a Text question, after a question has been created.
1. Go to the Fields tab of the questionnaire in which you want to add a new question.
Chapter 3: Questionnaires 78
Platform Administrator's Guide
2. In the Options section, select the options you want to include in search results.
The following table describes the options.
Option Action
Required Designates the field as required and forces users to enter a value when adding or
Field editing a record in the application. An icon (selected in the Appearance feature)
indicates required fields to alert users that they must enter a value. If you do not
select this option, you can skip this field when adding or editing a record in the
application.
Auditing Displays auditing information next to the field each time that its value is
Information changed. The auditing information includes only the name of the user who made
the change and the date and time of the change. If this checkbox is not selected,
auditing information is not displayed with the field in the user interface.
Search Makes this field available for display in search results and references its values
Results in search filters.
Search Includes the field by default in search results for the application. This option does
Default not prevent users from removing the field from the Search Results page. Users
Field can click Modify in the toolbar and remove the field from the Fields to Display
section of the application Search Records page.
Chapter 3: Questionnaires 79
Platform Administrator's Guide
Option Action
Unique Prevents users from entering an identical value in a field in separate records. If a
Field user saves a value in this field and the same value already exists in the field in a
different record, RSA Archer prompts the user to enter a unique value.
Key Field Designates the field as the key field of a record. You must designate one field in
the application as the key field, but can only designate one field as the key field.
You can select the key field values in search results, and users can click the
values to open individual records. A key field must be on the page layout of the
application.
After saving the field, you can only clear this checkbox by selecting another field
as the key field in the application. Selecting this option automatically selectsthe
Required Field, Search Results, and Search Default Field options.
Sum Field Provides a total of all values entered in the field on the Search Results page for
an application or leveled application. The sum is only shown on Column-
Hierarchical and Column-Flat report format types.
When this option is selected, the total value appears in the last row of Numeric
Field column. The summation value represents a grand total and displays on each
page.
Chapter 3: Questionnaires 80
Platform Administrator's Guide
Option Action
Numeric Allows users to filter search results in the application based on specific ranges of
Ranging values in the numeric field. When you select this option, you must define the
numeric range and its values after the numeric field is configured.
Validate Designates that a field is validated whenever any value changes in a record. If
Always the Validate Always option is not selected, this field validates only when the
value in that field has changed.
3. In the Configuration section, specify the minimum and maximum number of attachments and size
limitations of the attachment files
The following table describes the options.
Option Description
Decimal Specifies the number of decimal places required for values entered in the field
Places (maximum 6). Entering a value in the numeric field with fewer decimal places
than the required number pads the value with zeros.
For example, if you require 3 decimal places and you then enter a value of "4.1" in
the field, the value displays as "4.100" when you save the record.
On the other hand, if you enter a value in the field with more decimal places than
the required number, you must limit the number of decimal places in the value to
fit the field requirements before you can save the record.
Minimum Specifies the minimum values users must enter in the numeric field within a
Values defined range, for example, 1-100.
Maximum Specifies the maximum values users must enter in the numeric field within a
Values defined range, for example, 1-100.
Prefix Specifies the text (up to 10 characters) that appears in front of the numeric value.
For example, when you enter "ABC" in this field, record displays "ABC123456."
Chapter 3: Questionnaires 81
Platform Administrator's Guide
Option Description
Suffix Specifies the text (up to 10 characters) that appears after the numeric value. For
example, entering "miles" labels the field value as a measurement of distance. For
the tracking ID, you enter "XYZ" in this field. The tracking ID value for a record
displays "123456XYZ."
Increment Specifies the value by which the number is to increase or decrease. Available
By options are .01, .1, 1, 10, 100, 1000, or No Increment.
2. In the Question Text field, enter the text for your question.
3. From the Category list, select an appropriate category for the question. If necessary, click Edit to
modify the list of categories.
Chapter 3: Questionnaires 82
Platform Administrator's Guide
create for one question to any other question in the same questionnaire. However, you cannot share
filter properties between questionnaires.
1. Go to the Question tab of the question that you are creating.
l To apply an existing filter to the current question, click in the Values column for that filter
in the Question Filter Properties section, and select the specific filter value that applies to
your question. To remove a filter from the question, click to the right of the filter value.
l To add a new filter, click Add New.
Important: Do not click to remove a filter from the current question. Doing so will
permanently delete the filter for all questions that use it. Instead, use to remove the filter
from the current question while preserving its application to other questions. If the Value
column for a filter is blank, that filter is not applied to the current question.
3. In the General Information section, enter a name and description for the filter.
4. In the Filter Values section, click Add New.
5. In the Value field, enter the value text and click Apply.
6. (Optional) Repeat steps 4 - 5 to add any additional values as needed.
7. Click Save on the Edit Filter Property page to return to the Manage Field page.
8. In the Question Filter Properties section, click to the right of the filter that you just created.
9. Select one or more filter values to apply to the question.
10. Click Save or Apply.
l Click Save to save and exit.
l Click Apply to apply the changes and continue working.
Chapter 3: Questionnaires 83
Platform Administrator's Guide
To protect data integrity, you cannot change the question type. For example, changing a Date
question to a Text question after a question has been created.
1. Go to the Fields tab of the questionnaire in which you want to add a new question.
Chapter 3: Questionnaires 84
Platform Administrator's Guide
Text Field Displays the field as a limited character text box or in a rich text area where
Text Area users can enter text in HTML format.
Required Designates the field as required and forces users to enter a value when adding or
Field editing a record in the application. An icon (selected in the Appearance feature)
indicates required fields to alert users that they must enter a value. If you do not
select this option, you can skip this field when adding or editing a record in the
application.
Auditing Displays auditing information next to the field each time that its value is
Information changed. The auditing information includes only the name of the user who made
the change and the date and time of the change. If this checkbox is not selected,
auditing information is not displayed with the field in the user interface.
Search Makes this field available for display in search results and references its values
Results in search filters.
Search Includes the field by default in search results for the application. This option does
Default not prevent users from removing the field from the Search Results page. Users
Field can click Modify in the toolbar and remove the field from the Fields to Display
section of the application Search Records page.
Unique Prevents users from entering an identical value in a field in separate records. If a
Field user saves a value in this field and the same value already exists in the field in a
different record, RSA Archer prompts the user to enter a unique value.
Chapter 3: Questionnaires 85
Platform Administrator's Guide
Option Action
Key Field Designates the field as the key field of a record. You must designate one field in
the application as the key field, but can only designate one field as the key field.
You can select the key field values in search results, and users can click the
values to open individual records. A key field must be on the page layout of the
application.
After saving the field, you can only clear this checkbox by selecting another field
as the key field in the application. Selecting this option automatically selectsthe
Required Field, Search Results, and Search Default Field options.
Validate Designates that a field is validated whenever any value changes in a record. If
Always the Validate Always option is not selected, this field validates only when the
value in that field has changed.
4. In the Configuration section, specify the minimum and maximum number of attachments and size
limitations of the attachment files
The following table describes the options.
Option Description
Default Specifies the default date value of the date field when a user adds a new record
Value in the application. The default date is set at record creation. Record edits do not
affect this date The following options are available:
l None. Select None if you do not want to place a default value in the date field.
l Current Date. Select Current Date to display the date of record creation in the
date field.
l Future Date. Select Future Date to display a default date value that is a
specific number of days after the date of record creation. Then enter the
specific number of days in the field to the right.
l Specific Date. Select Specific Date to display a static date as the default value
for the date field, and enter the date in the field to the right or click the
Calendar icon to select the date from a calendar dialog box.
Chapter 3: Questionnaires 86
Platform Administrator's Guide
Option Description
Maximum Restricts the number of characters a user can enter in a text field.
Characters If you use rich text formatting in a text area, RSA Archer counts the HTML
formatting tags embedded in the text as characters, causing a warning message
informing you that the text entered in the field exceeds the maximum number of
characters. If this condition occurs, set the Maximum Characters field to a value
higher than the number of characters that you expect to be entered in the field.
Input Specifies the text format that a user must enter for a text area field. You can
Mask select one of the following masks:
l SSN - Format = ###-##-####. The mask will be configured so the entire SSN is
confined to one field.
l Telephone - Format = ###-###-####. The mask will be configured so the entire
phone number is confined to one field.
l Zip Code - Format = #####.
l Zip+4 - Format = #####-####.
l IP Address v4 - Format = ###.###.###.###.
l IP Address v6 Full - Format = ####.####.####.####.####.####.####.####.
l Email Address - The mask will be configured to require the At (@) sign.
2. In the Question Text field, enter the text for your question.
Chapter 3: Questionnaires 87
Platform Administrator's Guide
3. From the Category list, select an appropriate category for the question. If necessary, click Edit to
modify the list of categories.
l To apply an existing filter to the current question, click in the Values column for that filter
in the Question Filter Properties section, and select the specific filter value that applies to
your question. To remove a filter from the question, click to the right of the filter value.
l To add a new filter, click Add New.
Important: Do not click to remove a filter from the current question. Doing so will
permanently delete the filter for all questions that use it. Instead, use to remove the filter
from the current question while preserving its application to other questions. If the Value
column for a filter is blank, that filter is not applied to the current question.
3. In the General Information section, enter a name and description for the filter.
4. In the Filter Values section, click Add New.
5. In the Value field, enter the value text and click Apply.
Chapter 3: Questionnaires 88
Platform Administrator's Guide
8. In the Question Filter Properties section, click to the right of the filter that you just created.
9. Select one or more filter values to apply to the question.
10. Click Save or Apply.
l Click Save to save and exit.
l Click Apply to apply the changes and continue working.
A Value List question type enables you to create questions with predefined answers.
Note: To protect data integrity, the Questionnaire feature prohibits question type changes, for
example, changing a Date question to a Text question, once a question has been created.
1. Go to the Fields tab of the questionnaire in which you want to add a new question.
Chapter 3: Questionnaires 89
Platform Administrator's Guide
Chapter 3: Questionnaires 90
Platform Administrator's Guide
Dropdown Displays a list of items from which users can select an item.
Radio Displays a list of items from which users can select an item.
Buttons
Check Displays a list of items from which a user can select one or more items.
Boxes
Listbox Displays a selection list from which users can select one or more items.
Values Displays a selection list from which users can select one more items. For
Popup example, a users and groups list may contain hundreds or thousands of users. In
this case, a values popup list may be the best solution. For a two or three
selections, the best control might be dropdown, radio buttons, or checkboxes.
Required Designates the field as required and forces users to enter a value when adding or
Field editing a record in the application. An icon (selected in the Appearance feature)
indicates required fields to alert users that they must enter a value. If you do not
select this option, you can skip this field when adding or editing a record in the
application.
Auditing Displays auditing information next to the field each time that its value is
Information changed. The auditing information includes only the name of the user who made
the change and the date and time of the change. If this checkbox is not selected,
auditing information is not displayed with the field in the user interface.
Search Makes this field available for display in search results and references its values
Results in search filters.
Search Includes the field by default in search results for the application. This option does
Default not prevent users from removing the field from the Search Results page. Users
Field can click Modify in the toolbar and remove the field from the Fields to Display
section of the application Search Records page.
Chapter 3: Questionnaires 91
Platform Administrator's Guide
Option Action
Description Displays the selected value for the field as a hyperlink when users view records
Links in the application. Users can click the linked value to read a description of the
value from a pop-up window.
Validate Designates that a field is validated whenever any value changes in a record. If
Always the Validate Always option is not selected, this field validates only when the
value in that field has changed.
4. In the Configuration section, specify the minimum and maximum number of attachments and size
limitations of the attachment files
The following table describes the options.
Option Description
Minimum Specifies the minimum number of selections (from none to 20 selections) that a
Selections user can select in the Dropdown, Checkboxes, Listbox, or Values Popup display
control.
Maximum Specifies the maximum number of selections (from none to 20 selections) that a
Selections user can select in the Dropdown, Checkboxes, Listbox, or Values Popup display
control.
Chapter 3: Questionnaires 92
Platform Administrator's Guide
2. In the Question Text field, enter the text for your question.
3. From the Category list, select an appropriate category for the question. If necessary, click Edit to
modify the list of categories.
Chapter 3: Questionnaires 93
Platform Administrator's Guide
l To apply an existing filter to the current question, click in the Values column for that filter
in the Question Filter Properties section, and select the specific filter value that applies to
your question. To remove a filter from the question, click to the right of the filter value.
l To add a new filter, click Add New.
Important: Do not click to remove a filter from the current question. Doing so will
permanently delete the filter for all questions that use it. Instead, use to remove the filter
from the current question while preserving its application to other questions. If the Value
column for a filter is blank, that filter is not applied to the current question.
3. In the General Information section, enter a name and description for the filter.
4. In the Filter Values section, click Add New.
5. In the Value field, enter the value text and click Apply.
6. (Optional) Repeat steps 4 - 5 to add any additional values as needed.
7. Click Save on the Edit Filter Property page to return to the Manage Field page.
8. In the Question Filter Properties section, click to the right of the filter that you just created.
9. Select one or more filter values to apply to the question.
10. Click Save or Apply.
l Click Save to save and exit.
l Click Apply to apply the changes and continue working.
Important: If you do not manage authoritative source data in RSA Archer, disregard the
Authoritative Source References section on the Define Fields page. You cannot use this feature.
Chapter 3: Questionnaires 94
Platform Administrator's Guide
Important: This option is available only if your organization licenses the Policy Management
solution, which includes a Control Standards application. If you do not license Policy Management,
the Control Standards control is not displayed, and you cannot use this feature.
Chapter 3: Questionnaires 95
Platform Administrator's Guide
b. After you locate the control standard that you want to link to your question, select the
checkbox for that standard. You may select multiple checkboxes.
4. Click OK.
5. To remove any selected control standard references, do the following:
Note: This step is only required if you created a values list question in step 1.
Important: The Answers tab enables you to create and edit custom answers that are unique to the
question you are managing. If you have selected to use a questionnaire values list rather than a
custom list for the question, you also can create and edit answers in that shared list. Any changes
that you make to a questionnaire values list impacts every question that uses the list. If you need to
add or edit answers for a question that uses a questionnaire values list but you do not want your
changes to impact other questions, RSA recommends that you delete the question and recreate it to
use a custom answer list. You can then create the appropriate answers for the question without
affecting any others.
The answers must have an active status so that it is available for selection.
1. Go to the Answers tab of the question that you are creating.
2. Do one of the following:
Chapter 3: Questionnaires 96
Platform Administrator's Guide
l To associate a numeric value with the answer, in the Numeric Value field, enter the
appropriate number in this field.
l To display the answer in a specific color, click in the Text Color field and select the
color.
Note: If you associate a color with an answer, the color is displayed in questionnaire
records in view mode. Answers are not displayed in color when users fill out a
questionnaire.
l To set the answer as the correct answer for all questions that utilize the list, select the
checkbox in the Correct field.
l To include an image to represent the answer, such as a green checkmark for the value
"Yes," click Add in the Image field, select a graphic and click OK.
Note: If you associate an image with an answer, the image is displayed in questionnaire
records in view mode in place of the value name. Answers are not displayed as an image
when users fill out a questionnaire.
l To require users to enter an explanation when they select the answer, select the
checkbox in the Other field and enter comments in the text box.
Important: You may select Other for only one answer per answer list. If you create
another answer and select the Other checkbox, the checkbox is cleared for the first
answer. If users have already provided comments for the first answer while filling out a
questionnaire, those comments will be lost.
a. Click Import.
b. Click Add New.
c. In the Open dialog box, select the .xml file that you want to import.
d. Click Open.
e. Click OK.
3. From the Sort Order list, select the applicable option for sorting the items list.
Chapter 3: Questionnaires 97
Platform Administrator's Guide
Custom Lists the values in the specific order that you define. To adjust the order of
values, click and drag the value to the position in the list.
Ascending Lists the values in ascending alphanumeric order. For example, the values
"High," "Medium," and "Low" would be displayed in the following order: High,
Low, Medium.
Alphanumeric sort is not supported for values lists that contain values in multiple
languages.
Descending Lists the values in descending alphanumeric order. For example, the values
"High," "Medium," and "Low" would be displayed in the following order:
Medium, Low, High.
Random Lists the values in a different order each time the list is displayed. This variation
in display order minimizes the chance that end users detect patterns.
Complete this task to create questionnaire values lists that you can reuse for any values list question
within the questionnaire.
For example, you could create a questionnaire values list with the answers "Yes," "No," and "I don't
know," and you could use this list for questions such as "Is sensitive cardholder data securely
disposed of when no longer needed?" and "Are all but the last four digits of the account number
masked when displaying cardholder data?" By creating questionnaire values lists that you can reuse,
you can save a significant amount of time in the creation and management of Values List questions
within your questionnaire.
Questionnaire values lists are different from global values lists in that you cannot share them
between questionnaires. The questionnaire values lists are restricted to individual questionnaires but
can be shared among questions in that questionnaire. You can export a list from one questionnaire to
another. Keep in mind that if you export a questionnaire values list to another questionnaire, the two
values lists are not connected in any way. If you make a change to one list, that change is not
reflected in the other.
Chapter 3: Questionnaires 98
Platform Administrator's Guide
In addition to the questions themselves, questionnaires contain several standard fields for collecting
data on the assessment. Standard fields differ from questions in that they do not include question text
or weighting, they cannot be filtered using question display rules, and they are not included in
progress calculations for questionnaire records and campaigns. However, standard fields offer more
variety for data collection than questions do, and you can control user access to fields, whereas all
questions are inherently public.
Chapter 3: Questionnaires 99
Platform Administrator's Guide
% Correct Calculated Field access The percent of Values List questions that were
Numeric only answered correctly rounded to the nearest whole
number.
All Findings Calculated Field access The number of findings related to the
Numeric only questionnaire record.
Campaign Values List Field access The name of the campaign to which the
Name only questionnaire record belongs.
Correct Calculated Field access The number of Values List questions that were
Numeric only answered correctly.
Created By User/Groups Fully The user who created the questionnaire record.
List configurable
Created Date First Fully The date the questionnaire record was created.
Published configurable
Due Date Date Fully The date by which the questionnaire record
configurable should be completed and submitted.
Findings Values List Fully The status of findings-generation activity for the
Generation configurable questionnaire record.
Status
History Log History Log Fully A history log that tracks the following fields:
configurable Due Date, Year, Quarter, Submitter, Submission
Status, Submit Date, Reviewer Review Status,
and Review Date.
Incorrect Calculated Field access The number of Values List questions that were
Numeric only answered incorrectly.
Inherent Calculated Field access The sum of all Values List question weighted
Score Numeric only scores.
Last Updated Last Fully The date the questionnaire record was last
Updated configurable updated.
Date
Maximum Calculated Field access The maximum potential score for the
Score Numeric only questionnaire, calculated by summing the
question scores for every Values List question
displayed in the questionnaire record.
Progress Calculated Field access The number of questions that have been
Text only answered and the total number of questions in
the questionnaire record, for example, "13 of
30."
Questions Calculated Field access The number of Values List questions in the
Scored Numeric only questionnaire record.
Queue Status Values List Fully Tracks the success or failure of findings
configurable generation for a questionnaire.
Remediation Calculated Field access The maximum potential score for all findings that
Score Numeric only are closed, calculated by subtracting the score
for each incorrectly answered question from the
maximum possible score for each of those
questions, and then adding the resulting values
together. For example, you have a question that
was incorrectly answered, resulting in a score of
1. If the questions were answered correctly, the
score would have been 5. The difference is 4. If
you have five questions that follow this same
pattern, and the finding for each of these
questions is closed, your remediation score
would be 20.
Residual Calculated Field access The remaining inherent risk after the closure of
Score Numeric only some or all of the findings associated with the
questionnaire record.
Review Date Date Fully The date the completed questionnaire record is
configurable reviewed.
Review Values List Fully The review status of the questionnaire (values
Status configurable include Awaiting Review, Approved, and
Rejected).
Reviewer User/Groups Fully The user who is responsible for reviewing the
List configurable questionnaire record once it is submitted.
Submission Values List Field access The submission status of the questionnaire
Status only (values include In Process, Submitted, and Re-
Submitted).
Submit Date Date Fully The date the completed questionnaire record is
configurable submitted.
Submitter User/Groups Fully The user who is responsible for answering the
List configurable questions in the questionnaire record.
Note: For information about mobile layouts for mobile ready questionnaires, see Creating Mobile
Ready Questionnaires.
Important: When a data driven event includes a rule with a Set Date action and is used in a
questionnaire, the Review Date and Submit Date must be included in the General Information
section of the questionnaire. By default, these fields are included in this section.
Hide Findings Apply This action hides the Findings section when no findings have been
Grid Conditional associated with the questionnaire record.
Layout
Action
Rule Description
Type
Quantitative Apply This action provides the Quantitative Summary Section when all the
Summary Conditional questions displayed within the questionnaire record have been
Section Layout answered.
Display
Set Review Set Date This action sets the Review Date field within a questionnaire record
Date to the current date when the value in the Review Status field
changes to Approved or Rejected.
Set Review Set Values This action sets the Review Status field to Awaiting Review when
Status Upon List the value in the Submission Status field changes to Re-Submitted.
Re- Selections
Submission
Set Set Date This action sets the Submission Date field within a questionnaire
Submission record to the current date when the value in the Submission Status
Date field changes to Submitted or Re-Submitted.
Set Set Values These actions limit the values available for selection in the
Submission List Submission Status field to In Process and Re-Submitted when the
Status List Selection value of the Review Status field changes to Rejected.
Values Filter
Values
List Items
See Data Driven Events for more information and detailed steps for creating DDEs.
Important: Do not use the names Version, Level ID, or Content ID for fields that you add to an
Application or Questionnaire. Using these names in Applications or Questionnaires prevents the
fields from displaying properly. To ensure that the fields display properly, use different names.
If you do not want a default item to appear in the Navigation Menu, clear the checkbox
for that item.
field Certain field types are labeled as By field name menu items and enable you to search for
name records that include that specific field value. The following field types enable quick
filtering from the Navigation Menu:
l Cross-Reference
l Matrix
l Record Permissions
l Record Status
l User/Groups List
l Values List
data For leveled applications, the menu items are labeled By data level and enable you to
level select records that reside within a specific data level.
Display Specifies the text that appears in the Navigation Menu for the item that you
Alias selected to display. If you selected to display the item in the Visibility field,
you must provide the Display Alias.
Default Expands the item node in the Navigation Menu by default. This field becomes
Expansion available when the Visibility field is enabled.
Fields to Specifies the fields that display in the search results when a user clicks one of
Display these items to execute a search. The fields you select are listed under Records
and By field or By data level menu items.
Use below the Selected list to arrange the fields in the display order.
Use to remove a field from the search results for a menu item.
Sorting Specifies the list order of the fields displayed in search results, which is
executed when a user clicks the menu item.
Use the Field drop-down menu to specify whether the search results are
initially sorted in ascending or descending order. You can add new fields to
sort by.
4. Click OK.
5. Click Save or Apply.
l Click Save to save and exit.
l Click Apply to apply the changes and continue working.
l Defining the users and groups available for selection in these fields.
l Promoting the users and groups fields to Record Permissions fields if you want to use them to
control access to questionnaire records.
l Adding User/Groups List or Record Permissions fields to expand the content review process
according to your risk management methodologies.
l Create a linear content review process l Create complex non-linear workflow processes
within applications, leveled applications, within applications, leveled applications, or
or questionnaires. questionnaires.
l Send notifications only after content is l Send notifications to multiple users on-demand.
updated and saved by a user. l Enable automatic enrollment for new records,
l Enable only user-initiated enrollment updated records, or user initiated options.
options. l Visually depict the end-to-end advanced
workflow process at the administrator level.
l Designate a specific name for each node to
easily identify the intent of each stage in your
workflow process.
l Create tasks that are linked to the task-driven
landing screen of specified users.
Then, for example, you have defined a question display rule for a questionnaire that assesses targets
in your Vendors application. The question display rule specifies that if a vendor handles the financial
information of your customer, the questionnaire should display all questions with the following filter
properties:
l Customer Data: Yes
l Financial Data: Yes
When a vendor relationship manager in your organization fills out the questionnaire to assess a
vendor that handles the financial information of your customer, the manager is prompted to answer
all questions with these filter properties, as determined by the question display rule that you defined.
6. Add more conditions, if needed, to the Target Application Conditions section. To add more
conditions, click Add New.
7. In the Question Display Actions section, define which questions to show or hide in the
questionnaire record when the rule evaluates to true for the target of the assessment. In the Filter
Property column, select the question property that you want to use to determine which questions
to show or hide when the rule criteria are met.
8. In the Operator column, select one of the following operators to define the relationship between
the question property and the specific filter values that cause a question to be shown or hidden
when the rule proves true:
The following table describes the operators.
Operator Description
Contains If the question is configured with the filter property and value, the question will be
shown or hidden. The question may also have other values in the same filter
property. For example, if you specify the filter "Confidentiality: High" where
"Confidentiality" is the filter property and "High" is the value, a question that
includes the filter "Confidentiality: High" and the filter "Confidentiality: Medium"
will be shown or hidden.
Does not If the question is configured with the filter property and value, the question will be
Contain shown or hidden. The question may also have other values in the same filter
property. For example, if you specify the filter "Confidentiality: High" where
"Confidentiality" is the filter property and "High" is the value, a question that
includes the filter "Confidentiality: High" and the filter "Confidentiality: Medium"
will be shown or hidden.
Operator Description
Equals If the question is configured with the filter property and only the value you
specify, the question is shown or hidden. For example, if you specify the filter
"Confidentiality: High" and a question includes the filters "Confidentiality: High"
and "Confidentiality: Medium," that question is not displayed or hidden because it
is not an exact match.
Does not If the question is not configured with the exact filter property and value, the
Equal question is shown or hidden. The question may have the filter property and value
you specify, but if it also has other values in the same property, it is not an exact
match. For example, if you specify the filter "Confidentiality: High" and a
question includes the filters "Confidentiality: High" and "Confidentiality:
Medium," that question is shown or hidden.
9. In the Value(s) column, select the specific filter values that should trigger a question to be shown
or hidden.
For example, if you selected the Criticality property in the Filter Property column, you could
select the value "High" in the Value(s) column. All questions created with this specific filter
value are shown or hidden, depending on the type of display rule that you are creating.
10. Add more conditions, if needed, to the Question Display Actions section.
11. Click Save or Apply.
l Click Save to save and exit.
l Click Apply to apply the changes and continue working.
You can configure a questionnaire to automatically generate findings when a user answers one or
more questions incorrectly while filling out the questionnaire. By default, findings are created for a
questionnaire record when the value in the Submission Status field is changed to Submitted. You can
change this default condition, or you can create additional conditions that will trigger findings
creation. For example, you can generate findings when a questionnaire record is submitted and when
it is approved. If multiple conditions are defined, all of them must be met in order to trigger findings
creation.
Note: A finding is created only once for each incorrectly answered question. So if a finding is
created for a question when the questionnaire is submitted, and that same question is still incorrectly
answered when the questionnaire record is marked Approved, the system does not create another
finding for that question.
As an optional step, you can create static or dynamic content that is displayed in the Description
field in all findings generated for the questionnaire.
Each finding generated by the system is prepopulated with the following:
l Question that was incorrectly answered.
l Incorrect answer the user selected.
l Specific target of the assessment.
l Questionnaire record in which the question was incorrectly answered.
l Authoritative source related to the question that was incorrectly answered (if applicable).
l Control standard related to the question that was incorrectly answered (if applicable).
The prepopulation of Findings records enables you to report on areas of non-compliance by target,
questionnaire, question, authoritative source, and control standard. As you remediate findings, you
also can monitor areas of improvement in your compliance posture.
Note: You can add the Findings application to the same solution as your questionnaire to access the
Findings application from the Navigation Menu for the purposes of searching and managing records.
Note: If you do not enable findings for a questionnaire, the Quantitative Summary section within
individual questionnaire records are not included in the Findings column.
Note: If you have created more than one condition, you can apply advanced logic to your search
criteria.
5. In the Findings Generation section, enter the default text to be displayed in the Description field
of Findings records.
By default, the Description field within individual Findings records is populated with information
about the question that was answered incorrectly. You can modify the default text using any of
the following dynamic elements:
l [Question Name]. This element is the question label, not the question text. For example, the
question name might be "Encryption 1" for the following question text: "Is strong encryption
used for restricted information?"
l [Question]. This element is the question text, such as "Is sensitive cardholder data securely
disposed of when no longer needed?"
l [Answer]. This element is the incorrect answer the user provided, such as "No, we do not
dispose of cardholder data."
l [Weighted Score]. This element is the weighted score for the question, which the system
generates by multiplying the question weight and the numeric value associated with the
incorrect answer.
For example: The question "[Question]" was answered incorrectly:Question: [Question
Name]Answer: [Answer] Question Risk Score: [Weighted Score]
6. Click Save or Apply.
l Click Save to save and exit.
l Click Apply to apply the changes and continue working.
Note: When you add a new calculated field to a questionnaire, it displays at the bottom of the list in
the Field Calculation Order listing.
3. Drag and drop each field name into the Formula section until all the fields are in the calculation
order you want.
4. Click Save.
l Open Tasks/Activities. Lists all of the open Task Management records associated with the
content record.
l Activity History. Lists all of the closed Task Management records associated with the content
record.
Note: If you disable task management, Task Management records are no longer viewable in
records of the associated questionnaire. However, all Task Management records still are
stored in the Task Management application. If task management is subsequently reactivated,
all existing Task Management records are displayed with their associated content records.
2. In the Options section, in the Search Results field, select one of the following formats.
The following table describes the options.
Options Description
Column - Displays the search results in a columnar layout where fields are displayed
Hierarchical across the page from left to right, and the values in the search results fields are
presented showing relationships.
Column - Displays the search results in a simple columnar layout without any grouping of
Flat values.
Row Displays the search results in a row layout with fields stacked vertically and
records separated by horizontal lines.
Summary Displays the search results in a simple block record format with the key field as
the heading for each record. Fields in the search display as values only in a
single paragraph with each value separated by a diamond symbol.
3. From the Language list, select a default language for the questionnaire.
4. Click OK.
5. Click Save or Apply.
l Click Save to save and exit.
l Click Apply to apply the changes and continue working.
Optimize calculations
Note: If an administrator disables the option in the RSA Archer Control Panel, field-level
calculation optimization is not available.
2. In the Options section, in the Enable Optimize Calculations field, select Optimize related
calculations after bulk actions complete.
3. Click Save or Apply.
l Click Save to save and exit.
l Click Apply to apply the changes and continue working.
Questionnaire owners
You can select the users who will serve as owners of an questionnaire.
Note: If you want to edit notifications associated with an application, an administrator must assign
you an access role that gives you access to the Manage Subscription Notifications page.
l Owners have full editing rights over their designated questionnaires, which means they can fully
customize its properties. This includes adding and arranging fields in the questionnaire, enabling
notifications, configuring data driven events, and others.
l Ownership is automatically granted to the user who creates it. However, your rights can be
revoked by any other user who is subsequently granted ownership of the questionnaire.
Report administrators
You can assign permissions to users and groups for creating and editing global reports in a specific
questionnaire.
l Global reports can be shared with any user in the questionnaire, but only users with access to the
questionnaire for which the report was created can see the contents of the report.
l Users who do not have global report creation rights can only create personal reports, which
cannot be shared with other users.
l To revoke ownership, click in the Questionnaire Owners field and click to the right of
the appropriate name in the Selected list.
l To revoke report administrators, click in the Report Administrators field and click to
the right of the appropriate name in the Selected list.
3. Click OK.
4. Click Save or Apply.
l Click Save to save and exit.
l Click Apply to apply the changes and continue working.
Prior to launching a campaign, you can make any necessary changes to the campaign, including
adding or editing target generation rules. After a manual campaign is launched, you cannot make
further changes. If you need to modify a manual campaign after it is launched, you must create a
new campaign.
Recurring Creates a campaign that is evaluated when the specified target record
Campaign is saved.
l To create a manual campaign that must be launched by the user, click Add New in the
Manual Campaigns section.
4. Complete the General Information section.
5. In the Optional Campaign Attributes section, select default values.
Note: The target application must contain a User/Groups List or Record Permissions field to
assign the submitter and reviewer for each questionnaire record triggered by the campaign.
When the campaign triggers the creation of a questionnaire record for a specific asset, such as a
database server, the owner of that asset automatically is assigned as the submitter for the
questionnaire record.
6. Create a target generation rule to filter the list of specific targets that need to be assessed. In the
Target Generation Conditions section, do the following:
a. In the Field To Evaluate column, select the field to evaluate for one or more specific values.
To create additional conditions, click Add New.
b. In the Operator column, select the filter operator.
c. In the Value(s) column, select the values for the condition.
d. (Optional) If you have created more than one condition, you can apply advanced logic to your
search criteria.
7. (Optional) If you are creating a Scheduled campaign, in the Schedule Properties section, select
values from the Frequency, Time, and Time Zone lists.
8. Click Save or Apply.
l Click Save to save and exit.
l Click Apply to apply the changes and continue working.
Note: After a campaign has run, you can view the Campaign Execution History report by
clicking the Report icon for that campaign.
The following fields and field types are unsupported on the mobile device or for placement on the
mobile layout. Custom Objects and Placeholders layout elements are ignored on the mobile device.
Unsupported System
Unsupported Field Types
Fields
Access History Attachments (Exception: Photos can be uploaded from the mobile
Calculated Fields device to RSA Archer)
Note: Only data defined in the mobile layout of the questionnaire will be downloaded to the mobile
device.
Add individual fields Click the field in the Available Fields panel that you want to
move to the mobile layout.
Add entire sections Click on the Section title in the Available panel that you want
to move to the mobile layout.
Add all fields and sections Click on the Available Fields title bar and click Add All to
Selected Fields.
View unsupported field Click on the Available Fields title bar and click Show
types Unsupported Field Types.
Hide unsupported field Click on the Available Fields title bar and click Hide
types Unsupported Field Types.
Action Task
Remove individual field Click the field in the Selected Fields panel that you want remove
to the mobile layout.
Remove entire sections Click on the Section title in the Selected Fields panel that you
want to remove to the mobile layout.
Remove all unrequired Click on the Selected Fields title bar and click Remove All
fields and sections From Selected Fields.
The following table describes the icons that might be displayed in the field bar of a field.
Required fields are denoted with an asterisk (*).
Icon Name Description
Unsupported field Denotes the field is an unsupported field type for mobile
types devices.
The Unsupported Field Types icon is applicable to mobile
layout only.
l Only fields on the mobile layout will be downloaded to the mobile device in the questionnaire.
Nested cross-reference fields and Description fields are not downloaded.
l You can set the criteria only when questionnaires are licensed for mobile availability, and after
you select a questionnaire to be mobile ready and define Target and Submitter (user).
Note: Operator logic statements are evaluated left to right with parenthetical groupings
evaluated first. Advanced operator logic helps to eliminate extraneous data that may be
downloaded to the mobile devices.
l Go to step 10.
10. Click Save or Apply.
l Click Save to save and exit.
l Click Apply to apply the changes and continue working.
2. In the Status field, select the status you want to use for the questionnaire.
The following table describes the options.
Status
Description
Option
Archived When you archive a questionnaire, end users can continue to search and view
questionnaire content, but that content is read-only. You cannot launch archived
questionnaires to end users through assessment campaigns. The Edit and Data
Import options are disabled for archived questionnaires, and calculated fields
and record permissions are not recalculated.
Status
Description
Option
Retired Retired questionnaires are not available to end users. You cannot launch retired
questionnaires through assessment campaigns, nor can end users view existing
questionnaire content. If you retire a questionnaire that is displayed in a
Questionnaire Reference field within a target record (such as an Asset or
Vendor record), the questionnaire is removed. Although retired questionnaires
are hidden from end users, administrators can continue to modify retired
questionnaires from the Manage Questionnaires page.
Data feeds and questionnaires associated with the retired questionnaire
continue to use system resources. Prior to retiring a questionnaire,
RSA recommends the following:
l Deactivate all data feeds that target retired questionnaire
l Deactivate all campaigns within the questionnaire
Note: If the questionnaire is mobile ready and the status is changed to Archived or Retired, the
questionnaire is no longer available on the mobile device. The mobile layout will remain in tact
just as the web layout does so that if the questionnaire is reactivated, the mobile layout is
available. The questionnaire is validated upon save when the status is changed to ensure that
certain conditions do not affect the mobile readiness. The validation checks for required fields
that are off layout and required fields that are unsupported field types. If either of these
conditions exist, the questionnaire will no longer be mobile ready.
Note: You can review changes made to the configuration of a question by viewing the History Log.
2. Add a filter property for the Retired question and select the property as True.
Note: Because hide rules take precedence over show rules, the question is hidden regardless of
any other question filter properties or question display rules.
Important: RSA recommends deleting a question only when you need to remove it from previous
and future questionnaire content records. To keep the questionnaire content records created prior to
the deletion, deactivate the existing answer values and leave only the N/A option available, selected
by default with a value of zero. You cannot deactivate a question, only the answers.
CAUTION: RSA Archer does not recommend moving a question off the questionnaire layout. This
does not change the question count or scoring records. Once it is removed from the layout, users
cannot complete the questionnaire and save the questionnaire content record.
Important: Use extreme caution when deleting content from a questionnaire. Once the content is
deleted, it cannot be recovered. RSA highly recommends that you create a backup of your data
before deleting questionnaire content. Do not import data into a questionnaire until the content delete
process is complete. If the questionnaire contains a large number of records, this process could take
several minutes. To determine whether all content has been deleted from the questionnaire,
reactivate the questionnaire and run a search to display all records. When your search returns zero
records, you can initiate a data import.
Note: If this button is unavailable, the questionnaire is not retired. See step 3.
7. In the Warning dialog box, select "I understand the implications of performing this operation."
8. Click OK.
The delete process may take several minutes to complete.
Note: You cannot import data into the questionnaire until the content delete process has finished.
Delete a questionnaire
Chapter 4: Solutions
You can add solutions to group related applications or questionnaires that work together to address a
particular business need. For example, you can create a Customer Relationship Management
solution that houses the following applications: Accounts, Contacts, Opportunities, and Projects. By
grouping these applications into a solution, you access these applications from the Workspace menu,
search these applications as a single entity from the Search feature, access reports for the
applications using a Solution filter on the Master Reports Listing, and more.
An application can be grouped into multiple solutions. For example, a Contacts application can be
associated with Vendor Management, Customer Relationship Management, and Service Request
solutions. By grouping an application with multiple solutions, you can reuse the same information for
a variety of purposes.
Adding Solutions
Adding a solution is the process of selecting applications and questionnaires and attaching
documentation, for example, design specifications, sign-off forms, and others. When you create a
solution, a workspace is also automatically created to support the solution. A system-specific iView
for the new workspace is displayed by default.
1. Go to the Manage Solutions page.
8. In the Applications section, select Menu Display or Global Search to specify whether the
application or questionnaire is displayed in the navigation menu, as a global search link, or both.
9. (Optional) In the Documentation section, do the following.
a. Click Add New.
b. On the File Upload dialog box, click Add New.
c. Select the file to upload and click Open.
d. Click OK.
10. Click Save or Save and Close.
l Click Save to apply the changes and continue working.
l Click Save and Close to save and exit.
Updating a Solution
Updating a solution allows the process of selecting or deleting additional applications and
questionnaires, and attaching documentation, for example, design specifications, sign-off forms, and
others.
1. Go to the solution you want to update.
2. In the General Information section, edit the name, alias, and description.
3. To update an application or questionnaire, click Add New in the Applications section.
4. Do one or more of the following:
l To add or remove one or more applications, select or deselect the applications you want.
l To add or remove one or more questionnaires, click Continue, and select or deselect the
questionnaires you want.
5. Click OK.
6. In the Applications section, select Menu Display or Global Search to specify whether the
application or questionnaire is displayed in the navigation menu, as a global search link, or both.
Chapter 5: Fields
RSA Archer provides a wide variety of field types that allow you to collect and shape information
according to your business needs. A field collects data that is displayed as an interface control for
your users as they create and update records in an application, questionnaire, solution, and sub-form.
Each field has a configurable set of properties that govern how the field displays in the application
and how (or whether) the user interacts with it.
You can add, edit, configure and arrange data collection fields in applications, questionnaires,
solutions, and sub-forms. RSA Archer includes Basic, Advanced, and System field types. Each have
a unique function and are available based on the type application to which it is associated.
To protect data integrity, you cannot change a field to another field type (for example, changing a
Date field to a Text field). Every application must have a key field.
<html>
<head>
<style type="text/css">.c0 { font-family: 'Arial' } .c1 { margin: 0px; background-color: #ffe4e1 }
</style>
</head>
<body class="c0">
<p class="c1">This is a text field.</p>
</body>
</html>
Date Equals
First Published Date Does Not Equal
Last Updated Date Current
Last
Next
Greater Than
Less Than
Between
After Today
Prior To Today
Changed
Changed To
Changed From
IP Address Equals
Record Status Does Not Equal
Changed
Changed To
Changed From
Numeric Equals
Does Not Equal
Greater Than
Less Than
Between
Changed
Changed To
Changed From
Sub-form Changed
All fields have common and unique properties. The unique properties are managed through the
Options and Configurations tabs and vary based on the field type. Options determine the validation
rules and Configurations determine the valid input parameters for the field. You can also create
field-level help to assist users while working in an application and assign access privileges.
Dynamic Attributes
Dynamic field attributes determine what users are allowed to do when adding or editing records and
the behavior of the field under certain conditions. These attributes are defined in the Options tab of
the field type.
The following table describes dynamic field attributes.
Attribute Description Field Type
Calculated Designates the field as a calculated field determined by a formula that Date
Field computes a value dynamically for this field. If you select this option, Numeric
the field is read-only for all users, and its value is computed by a Text
defined formula. Values List
Enable Allows users to edit the field while in search results, the Record Cross-
Inline Edit Browser, and reports. When this option is selected, User/Groups list Reference
and Record Permissions fields, which normally display as a link to the Date/Time*
profile page when populated, do not display as links. Also, the ability Numeric
to re-order columns on the Search Results page by dragging and Record
dropping them with the mouse is not supported. Permissions
Text
Important: For the Record Browser, Inline Edit is not supported in User/Groups
leveled applications and Date/Time field. List
Values List
Note: Inline Edit is not supported in fields that are a part of Data-
Driven Event rules.
*Not
Some View/Edit specific functionality not supported with Inline Edit is
supported in
as follows:
the Record
l Automatic spell-checks are not performed when saving records Browser
through Inline Edit.
l Data Driven Events are not supported when updating records
through Inline Edit. If a field that is used in an active Data Driven
Event rule is modified through Inline Edit, the save attempt for the
record will not be successful.
l The Workflow buttons (Accept, Reject, etc.) are not available
through Inline Edit.
l Advanced Workflow transitions are not available through Inline
Edit.
l The Record Conflict functionality available when saving a record in
View/Edit is not available through Inline Edit. If a record conflict
exists for a record updated through Inline Edit, the save attempt for
the record will not be successful.
l The Pending Calculations Warning message is not displayed on the
Search Results page.
Key Field Designates the field as the key field of a record. All applications must Date
contain a key field, and multi-level applications must contain a key Numeric
field at each data level. The key field setting is exclusive; only one Text
field in each single-level application or in each level of a multi-level Tracking ID
application can serve as the key field.
The Key Field icon indicates that the field is the key field in an
application, questionnaire or sub-form. The key field is displayed in
search results as a hyperlink within each record. By clicking the
hyperlink, users can click the key field to view the details of a record.
By default, the Tracking ID field is set as the key field. You can
select this setting as one of the other eligible field types.
Required Designates the field as required and forces users to enter a value when Attachment
Field adding or editing a record. Required fields are indicated with an icon Cross-
to alert users that they must enter a value. Reference
Date
External
Link
Image
IP Address
Matrix
MRDC
Numeric
Record
Permissions
Sub-Form
Text
User/Groups
List
Values List
Unique Prevents users from entering an identical value in a field in separate Date
Field records. If a user saves a value in this field and the same value has IP Address
already been saved in the field in a different record, the user is Numeric
prompted to enter a unique value. Text
Validate Designates that a calculated field is recalculated whenever any value Attachment
Always is changed in a record. If the Validate Always option is not selected, Date
this field is validated only when the value in that field has changed. External
Link
Image
IP Address
Matrix
Numeric
Record
Permissions
Sub-Form
Text
User/Groups
List
Values List
Voting
The access history field type and the Record Views – Detail reports help you understand how users
are interacting with content within Archer. By using the access history field in appropriate records,
you have visibility into individual user content activities to ensure that the sensitive information you
handle in your RSA Archer environment is secure and managed properly. The Record Views –
Detail report supports internal audit requirements and provides easy access to reporting related to
end user access history.
You can add an access history field to an application or questionnaire.
1. Go to the Fields tab of the application or questionnaire to which you want to add an access
history field.
Search Makes this field available for display in search results and references its values in
Results search filters.
Search Includes the field by default in search results for the application. This option does not
Default prevent users from removing the field from the Search Results page. Users can click
Field Modify in the toolbar and remove the field from the Fields to Display section of the
application Search Records page.
When configuring an attachment field, you can specify the total number of files that can be uploaded
(attached) to the field, as well as the file size (between 1 and 100 MB) permitted for each file. You
can also enable end users to keyword search into unencrypted attached documents. Encrypted
attachment fields do not support keyword search. The following file types are supported for
document searching:
l Microsoft Word
l Microsoft Excel
l PDF
l Text
l CSV
l To add a field from an existing field, click Copy an existing Field and select the attachment
field you want to copy.
4. In the Encrypt Field Data field, select whether to enable encryption. For more information, see
Encrypting Data.
5. Click OK.
6. In the General Information section, enter the name and description of the field.
7. Click the Options tab.
8. In the Display Control section, select the option for displaying the field: Grid and Single Column.
The following table describes the options.
Display
Description
Control
Grid Displays multiple fields of data from the referenced record spanning the width of
the page in a table format (Grid) or in a single-column format. The attachment
information displays as a resizable grid control that displays the name, size and file
type for each file. When you select the Grid option, users with appropriate access
can view the Download History report. This report provides a summary of the
download history of a document including the user, email address, and download
date. Users can upload files by clicking Add New.
9. In the Options section, select the options for including the field in search results and setting its
behavior.
The following table describes the options.
Option Action
Required Designates the field as required and forces users to enter a value when adding or
Field editing a record in the application. An icon (selected in the Appearance feature)
indicates required fields to alert users that they must enter a value. If you do not
select this option, you can skip this field when adding or editing a record in the
application.
Auditing Displays auditing information next to the field each time that its value is
Information changed. The auditing information includes only the name of the user who made
the change and the date and time of the change. If this checkbox is not selected,
auditing information is not displayed with the field in the user interface.
Option Action
Search Makes this field available for display in search results and references its values
Results in search filters.
Search Includes the field by default in search results for the application. This option does
Default not prevent users from removing the field from the Search Results page. Users
Field can click Modify in the toolbar and remove the field from the Fields to Display
section of the application Search Records page.
Keyword Allows users to use this field in a keyword search to find documents attached to
Searching the field. File types supported for document searching include Microsoft Word,
Microsoft Excel, PDF, Text, and .CSV. If a user does not have access to the
field but the field is configured to allow keyword searching, the field is still
searched but not included in the search results.
Advanced Adds descriptive text and alters the standard display of the field. After selecting
Field this checkbox, specify the display text and layout for the field in the Advanced
Display Field Display Options section.
Validate Designates that a field is validated whenever any value changes in a record. If
Always the Validate Always option is not selected, this field validates only when the
value in that field has changed.
Encrypt Indicates whether field data is encrypted. You can enable or disable field
Field Data encryption when creating and updating fields. To decrypt file, clear the
checkbox. For more information about encryption, see Encrypting Data.
Option Action
Encryption Indicates the status of the field encryption. If this field displays Stationary, then
Status any encryption process is complete and field data is encrypted. If any other status
displays, you must wait until the status returns to Stationary before attempting to
select or clear the checkbox. This may take some time depending on the amount
of data you need to process.
If you attempt to select or clear the checkbox ,or delete a content record that
contains an encrypted field with a non-stationary status, RSA Archer may
display an error. This can result from validation or system errors. You can click
the View Error Details link to see the cause of the error. After you have resolved
the error, click Restart Encryption or Restart Decryption to complete the process.
10. In the Configuration section, specify the minimum and maximum number of attachments and size
limitations of the attachment files.
The following table describes the options.
Option Description
Minimum Specifies the minimum number of attachments that you want to require for an
Attachments attachment field.
Maximum Specifies the maximum and minimum number of attachments that you want to
Attachments require for the field.
Maximum Specifies the maximum file size, up to 100 MB, that you want to allow for each
Size file uploaded to the attachment field. This setting does not restrict the total size
of all files uploaded to the field.
Users may experience a long wait time when attaching large files to a record. If
you allow users to attach multiple large files, periodically monitor the available
space and current usage of the file repository to ensure optimized system
performance.
Display Designates the fields you want to display along with your attachment file.
Fields Important: The Downloads and History fields require System Administrator
access to view.
Important: If you change the associated application for a CAST field, but records with values for
the CAST field were already saved in the previously associated application, those values are no
longer displayed in the previously associated application because the CAST field is removed.
Therefore, RSA recommends that you do not change the associated application for a CAST field if
records in the current related application have already been saved.
Important: If any records were saved using the current values list for the CAST field, changing the
status of the values list is not recommended. If you change the values list after records have already
been saved with values from a previous values list, the CAST values in those records are set to the
default value for the new values list. If no default value is configured for the new values list, the
CAST values in records saved with the previous values list is set to No Value. In either case, you
lose any status changes made to records saved with the previous values list.
6. In the Associated Application field, click and select the application to relate through the
CAST field.
7. In the Status List field, click and select the values list to populate the CAST field.
8. Click the Options tab.
9. In the Options section, select whether the field is included in search results.
The following table describes the options.
Option Action
Search Makes this field available for display in search results and references its values in
Results search filters.
Search Includes the field by default in search results for the application. This option does not
Default prevent users from removing the field from the Search Results page. Users can click
Field Modify in the toolbar and remove the field from the Fields to Display section of the
application Search Records page.
Quick Displays a statuses in a list on the Status Tracking Results page to enable immediate
Status status changes.
Change
10. In the Configuration section, specify how the records are associated.
The following table describes the options.
Option Description
Relate Relates two applications based on a field in both applications. There must be a
Content By common value between the fields.
Field If you have a values list field in your parent application, for example, Asset
Management, that denotes the Asset Type, and you have the same field in your
child application, for example, Security Controls, you can link the two fields so
controls are only linked to an asset if the asset shares the same value in the
Asset Type field.
Relate Specifies the rule that determines which records to link from an outside
Content By application. If you relate content by a rule, all content records in the child
Rule application that satisfy that rule are linked to all records in the parent application.
For example, you can create a rule that links all records in the child application
with the value "High" in the Priority field to records in the parent application.
Application Specifies the application field and related field for two applications when content
Field and is related by a rule.
Related
Field
Rule Adds or removes search criteria in the table to specify a rule that determines
which records to link from the outside application when content is related by a
field.
Note: When you click Apply on a cross-reference field, the record saves and the calculation
status can not be changed.
Grid Displays multiple fields of data from the referenced record spanning the width of
the page in a table format (Grid) or in a single-column format. The attachment
information displays as a resizable grid control that displays the name, size and file
type for each file. When you select the Grid option, users with appropriate access
can view the Download History report. This report provides a summary of the
download history of a document including the user, email address, and download
date. Users can upload files by clicking Add New.
Options
Required Designates the field as required and forces users to enter a value when adding or
Field editing a record in the application. An icon (selected in the Appearance feature)
indicates required fields to alert users that they must enter a value. If you do not
select this option, you can skip this field when adding or editing a record in the
application.
Auditing Displays auditing information next to the field each time that its value is
Information changed. The auditing information includes only the name of the user who made
the change and the date and time of the change. If this checkbox is not selected,
auditing information is not displayed with the field in the user interface.
Search Makes this field available for display in search results and references its values
Results in search filters.
Search Includes the field by default in search results for the application. This option does
Default not prevent users from removing the field from the Search Results page. Users
Field can click Modify in the toolbar and remove the field from the Fields to Display
section of the application Search Records page.
Enable Enables this field to be available for update from Advanced Search Results.
Bulk
Update
Enable Enables this field to be available for creation from Advanced Search Results.
Bulk
Create
Enable Determines whether a display is editable in a grid that has inline edit enabled.
Editable
Grid
Display
Lookup Specifies whether users can access a Record Lookup page for selecting records
from the related application. Clear this checkbox if you only want to allow users
to create new records for cross-referencing. You must select this checkbox if
you want the cross-reference field to be available for selection in a MRDC field
or are creating a dynamic filter.
Option Action
Add New Determines whether the Add New link is displayed in a grid for allowing users to
add new records to the related applications from a record in view mode. Users
will not have to open a record in edit mode to create new related records. If a
user does not have rights to create records in the related application, the link is
not displayed for that user.
When a user creates a new related record from view mode, that record will be
selected in the cross-reference field just as it would if it were created from edit
mode. For example, if a user opens a Vendor record in View mode and creates a
record in the related Audits application by clicking Add New in the cross-
reference field, that new Audit record will be selected in the cross-reference
field of the Vendor record, even though the user did not open the Vendor record
for editing.
Calculated Designates the field as a calculated field determined by a formula that computes
Field a value dynamically for this field. If you select this option, the field is read-only
for all users, and the defined formula computes its value.
Tree Determines whether the related records in a leveled application for cross-
Display referenced records are displayed in a hierarchical format for a single-column
display. The following figure shows top-level record references flush with the
left margin of the field, and record references in subsequent data levels indented.
When records with the cross-reference field are exported in CSV format, the
Tree Display option is disabled to allow the data to be re-imported into the
application. All other data export formats preserve the cross-reference tree
display for the field.
Validate Designates that a field is validated whenever any value changes in a record. If
Always the Validate Always option is not selected, this field validates only when the
value in that field has changed.
Disable Disables the Remove button for records displayed in this field.
Remove
9. In the Record Lookup Configuration section, specify the rules for finding the related records of
the cross-reference field.
Display Specifies the fields of data from the relationship application that is displayed on the
Fields Record Lookup page for users when they select related records in the Cross-
Reference field.
Use to select the fields that you want to display from the Available list.
Use the below the Selected list to arrange the fields. The top-to-bottom order
of fields in the Selected list will be the left-to-right order of fields in the Record
Lookup page.
Note: If the relationship application is a leveled application, and you select fields
from two or more levels to be displayed in the Cross-Reference field, you can only
arrange those fields on a level-by-level basis. You cannot intermix fields from
separate data levels.
Filters Determines the filtering criteria for selecting records for display on the Record
Lookup page.
Sorting Specifies the fields by which cross-referenced records are sorted in the Record
Lookup page.
For example, in an "Investigators" Cross-Reference field, you can sort the display
of referenced records alphabetically by investigator name.
Display Determines how the cross-referenced records are displayed on the Record Lookup
Format page:
l Column-Hierarchical. Presents the records in a columnar layout where fields are
displayed across the page from left to right, and the field values are presented
showing relationships.
l Column-Flat. Presents the records in a simple columnar layout without any
grouping of values.
10. In the Grid Display Properties section, select the fields you want to display in the record look-up
for the cross-reference field.
Record Indicates the related record displays using the Record Lookup configuration.
Lookup
Note: This option is not available for calculated cross-reference or related record
fields.
Display Indicates which related record fields to display, instead of Record Lookup
Fields configuration. This is available if Record Lookup is unchecked.
Note: Fields with the Enable Inline Edit option enabled appear here. If your field is
not available, go to the record in question and update the options on that field.
Sorting Specifies the default sorting order of related record fields to be displayed. This is
available if Record Lookup is unchecked.
11. In the Configuration section, specify the range of selections a user can make.
Configuration options
Field For Single Column option: Specifies the height of the field in a single-column
Height display. This setting impacts the display of the field only when users add or edit
records in the application. For example, if you set the field height to three lines,
and a user makes four selections in the field, a scroll bar is displayed.
Minimum Specifies the minimum number of selections (from none to 20 selections) that a
Selections user can select in the Dropdown, Checkboxes, Listbox, or Values Popup display
control.
Maximum Specifies the maximum number of selections (from none to 20 selections) that a
Selections user can select in the Dropdown, Checkboxes, Listbox, or Values Popup display
control.
Default Determines the number of cross-referenced records that display in the grid and is
Records only available when the display control is set to Grid. If this option is selected,
Display only the first designated number of records are displayed. For example, when this
option is set to 10, only the first 10 records display in the grid. If the number of
records exceeds the default display number, a View All link is displayed. A user
can click this link to view all of the associated records.
You can restrict users from entering values in a date field that already appear in other records within
the application, making each date field value unique.
You can encrypt date fields. For more information about encrypting fields, see Encrypting Data.
Specialized options
l Default Date Value. If this option is enabled, you can select a default value for date fields. You
set the default date value when you create the record in the application; editing the record does
not affect the value. When configuring the default value, you can select to display the date of
record creation, a date that is a specific number of days after the date of record creation, or a
static, specific date. You can also select to display no default value in the date field.
l Calculated Field. If this option is enabled, you can specify a formula for dynamically computing
the value of the field. For example, you could create the following formula to populate the Date
field with the current date: TODAY(). The calculated field would display as read-only for all
application users, and its value would be updated each time the field was recalculated.
Text Box - Date Only Displays a date in a text box or dropdown list by date or by date
Text Box - Date and and time.
Time
Dropdown - Date Only
Dropdown - Date and
Time
9. In the Options section, select the options for including the field in search results and setting its
behavior.
The following table describes the options.
Option Action
Required Designates the field as required and forces users to enter a value when adding or
Field editing a record in the application. An icon (selected in the Appearance feature)
indicates required fields to alert users that they must enter a value. If you do not
select this option, you can skip this field when adding or editing a record in the
application.
Option Action
Auditing Displays auditing information next to the field each time that its value is
Information changed. The auditing information includes only the name of the user who made
the change and the date and time of the change. If this checkbox is not selected,
auditing information is not displayed with the field in the user interface.
Search Makes this field available for display in search results and references its values
Results in search filters.
Search Includes the field by default in search results for the application. This option does
Default not prevent users from removing the field from the Search Results page. Users
Field can click Modify in the toolbar and remove the field from the Fields to Display
section of the application Search Records page.
Enable Enables this field to be available for update from Advanced Search Results.
Bulk
Update
Unique Prevents users from entering an identical value in a field in separate records. If a
Field user saves a value in this field and the same value already exists in the field in a
different record, RSA Archer prompts the user to enter a unique value.
Key Field Designates the field as the key field of a record. You must designate one field in
the application as the key field, but can only designate one field as the key field.
You can select the key field values in search results, and users can click the
values to open individual records. A key field must be on the page layout of the
application.
After saving the field, you can only clear this checkbox by selecting another field
as the key field in the application. Selecting this option automatically selectsthe
Required Field, Search Results, and Search Default Field options.
Calculated Designates the field as a calculated field determined by a formula that computes
Field a value dynamically for this field. If you select this option, the field is read-only
for all users, and the defined formula computes its value.
Advanced Adds descriptive text and alters the standard display of the field. After selecting
Field this checkbox, specify the display text and layout for the field in the Advanced
Display Field Display Options section.
Option Action
Validate Designates that a field is validated whenever any value changes in a record. If
Always the Validate Always option is not selected, this field validates only when the
value in that field has changed.
Encrypt Indicates whether field data is encrypted. You can enable or disable field
Field Data encryption when creating and updating fields. To decrypt file, clear the
checkbox. For more information about encryption, see Encrypting Data.
Encryption Indicates the status of the field encryption. If this field displays Stationary, then
Status any encryption process is complete and field data is encrypted. If any other status
displays, you must wait until the status returns to Stationary before attempting to
select or clear the checkbox. This may take some time depending on the amount
of data you need to process.
If you attempt to select or clear the checkbox ,or delete a content record that
contains an encrypted field with a non-stationary status, RSA Archer may
display an error. This can result from validation or system errors. You can click
the View Error Details link to see the cause of the error. After you have resolved
the error, click Restart Encryption or Restart Decryption to complete the process.
10. In the Configuration section, select the option for setting the default value of the field.
Default Specifies the default date value of the date field when a user adds a new record in
Value the application. The default date is set at record creation. Record edits do not affect
this date The following options are available:
l None. Select None if you do not want to place a default value in the date field.
l Current Date. Select Current Date to display the date of record creation in the
date field.
l Future Date. Select Future Date to display a default date value that is a specific
number of days after the date of record creation. Then enter the specific number
of days in the field to the right.
l Specific Date. Select Specific Date to display a static date as the default value
for the date field, and enter the date in the field to the right or click the Calendar
icon to select the date from a calendar dialog box.
Forum Selecting this option causes the field to generate a new discussion forum for each record
Popup created within the application. The discussion forum displays in a pop-up window. You
can capture comments and dialogue from a variety of users centered on the content of a
specific record. For example, if you have a record concerning password requirements,
users could access the forum to discuss changes or additions to the requirements. A link to
the record-specific forum is displayed in both the view and edit modes of a record. This
option also allows you to specify administrators for the forum and configure edit options
for users.
Static Selecting this option allows you to embed links to existing discussion forums within each
Forum record in an application. Users cannot add or edit links in the field. By including links to
Link established discussion forums, you can direct users to forums where they can participate
in a large-scale discussion relating to the entire application. Links for the selected
discussion forums display in both view and edit modes of every record in the application.
Forum Forum Popup: Displays a pop-up list that contains a discussion forum for each
Popup record created in the application. In this view, users can only access the forum
Status when viewing or editing a record. the record is not displayed in a discussion forum.
Forum Status Forum Link: Displays one or more read-only links to existing discussion
Link forums in every record of the application.
8. In the Configuration section, specify the rules for posting and edit discussions in a discussion
forum.
Forum Designates the administrators for the forum and specifies the edit options that end
Popup users have in the forum.
l Edit Own Posts. Allows users to edit their own posts in the forum.
l Edit All Posts. Allows users to edit all posts in the forum.
l Forum Administrators. From the Available list, select the users and groups to
which you want to grant forum administrator rights. As an application owner, you
are listed by default as a forum administrator. To revoke forum administrator
rights for a user or group, click to the right of the user or group name in the
Selected list.
Edit Own Posts Allows users to edit only their own discussion forum posts.
Edit All Posts Allows users to edit all discussion forum posts.
Note: The Mailto, FTP, and News protocols are not supported for embedded URL iViews.
Each time that you enter a link in an external links field and click Apply, the new link is displayed in
a list below the field. Edit the properties of a list item by clicking to the right of the link. The
properties of that link are displayed in the Link Manager and can be edited.
You can delete a link in the list by clicking to the right of the link.
You can add an external link field to an application or questionnaire.
1. Go to the Fields tab of the application or questionnaire to which you want to add an External
Links field.
a. From the menu bar, click
.
b. Under Application Builder, click Applications or Questionnaires.
c. Select the application or questionnaire.
d. Click the Fields tab.
Required Designates the field as required and forces users to enter a value when adding or
Field editing a record in the application. An icon (selected in the Appearance feature)
indicates required fields to alert users that they must enter a value. If you do not
select this option, you can skip this field when adding or editing a record in the
application.
Auditing Displays auditing information next to the field each time that its value is
Information changed. The auditing information includes only the name of the user who made
the change and the date and time of the change. If this checkbox is not selected,
auditing information is not displayed with the field in the user interface.
Search Makes this field available for display in search results and references its values
Results in search filters.
Search Includes the field by default in search results for the application. This option does
Default not prevent users from removing the field from the Search Results page. Users
Field can click Modify in the toolbar and remove the field from the Fields to Display
section of the application Search Records page.
Option Action
Advanced Adds descriptive text and alters the standard display of the field. After selecting
Field this checkbox, specify the display text and layout for the field in the Advanced
Display Field Display Options section.
Validate Designates that a field is validated whenever any value changes in a record. If
Always the Validate Always option is not selected, this field validates only when the
value in that field has changed.
8. In the Configuration section, specify the minimum and maximum number of external links that a
user can add.
The following table describes the options.
Option Description
Minimum Sets the minimum number of links the user can select in the external links field.
Links
Maximum Sets the maximum number of links the user can select in the external links field.
Links
Protocols Specifies the protocol types that a user can configure in the Protocols field. Please
note that the Mailto, FTP, and News protocols are not supported for embedded
URL iViews.
l HTTP l News
l HTTPS l Relative
l FTP l File
l Mailto
1. Go to the Fields tab of the application to which you want to add a first published date field.
Search Makes this field available for display in search results and references its values
Results in search filters.
Search Includes the field by default in search results for the application. This option does
Default not prevent users from removing the field from the Search Results page. Users
Field can click Modify in the toolbar and remove the field from the Fields to Display
section of the application Search Records page.
Time Displays time information (hours, minutes and the AM or PM designation) along
Information with the date value.
User Displays the name of the user who published the record along with the date
Information value.
Header Displays date first published or last published in the page header of records by
Display default. To remove it from display, clear the Page Header Display checkbox.
l When a History Log field is configured to retain data from an advanced workflow process, the
advanced workflow process data is retained according to the retention policy configured in the
Advanced Workflow Designer.
7. In the Options section, select the options for including the field in search results and rules for
Search Makes this field available for display in search results and references its values in
Results search filters.
Search Includes the field by default in search results for the application. This option does
Default not prevent users from removing the field from the Search Results page. Users can
Field click Modify in the toolbar and remove the field from the Fields to Display section
of the application Search Records page.
Keyword Allows users to use this field in a keyword search to find documents attached to
Searching the field. File types supported for document searching include Microsoft Word,
Microsoft Excel, PDF, Text, and .CSV. If a user does not have access to the field
but the field is configured to allow keyword searching, the field is still searched
but not included in the search results.
User Determines whether to include only the activity entered by a user when a field is
History added or updated. History is displayed for general, administrator, and data feed
users.
8. In the Configuration section, select one or both types of data to be tracked in the history log field.
The following table describes the options.
Sub-
Option Description
Option
Note: The retention policy for advanced workflow auditing can be set
in the Workflow Designer when Building Advanced Workflows.
Sub-
Option Description
Option
Display Enables field value change auditing in the history log field.
Field
You must select the options for setting the number of days or entries
Tracking
for retaining the historical data and whether to track all fields or only
specific fields.
Sub-
Option Description
Option
Retention Specifies whether the history log field is retained for a specified
Policy number of days or entries.
l By Days. Enter the number of days of the entries for the fields
being tracked and retained.
l By Entries. Enter the number of entries for the fields being tracked
and retained.
A history log field is also created when a work flow is created. By
default, this field is configured to retain all history for all fields
indefinitely.
Sub-
Option Description
Option
The following table describes a scenario in which one history log field
is configured by days and the other history log field is configured by
entries.
History log field 1 is configured by days and History log
Scenario field 2 is configured by entries.
3 1 has a retention period of 7 days.
2 has a retention period of 20 entries.
When determining the maximum file size of an attachment or image field, also consider the
restriction limits set in the web.config file and Microsoft Internet Information Services (IIS). If a file
exceeds either restriction, the following occurs during the upload:
l If an attachment file is larger than the designated file size in IIS, a 404 error appears. The host
server, not RSA Archer, generates this message. The IIS setting outranks RSA Archer setting.
l If the attachment file meets the restrictions in IIS but exceeds the maximum file size of the
attachment or image field, a message appears, stating that the file exceeds the limitations. If this
condition occurs, the user must upload a file that is smaller than the maximum file size. If the
attachment file includes more than one file and the total size exceeds the maximum file size, the
user can upload the files individually, up to the maximum size limitation.
Required Designates the field as required and forces users to enter a value when adding or
Field editing a record in the application. An icon (selected in the Appearance feature)
indicates required fields to alert users that they must enter a value. If you do not
select this option, you can skip this field when adding or editing a record in the
application.
Auditing Displays auditing information next to the field each time that its value is
Information changed. The auditing information includes only the name of the user who made
the change and the date and time of the change. If this checkbox is not selected,
auditing information is not displayed with the field in the user interface.
Search Makes this field available for display in search results and references its values
Results in search filters.
Search Includes the field by default in search results for the application. This option does
Default not prevent users from removing the field from the Search Results page. Users
Field can click Modify in the toolbar and remove the field from the Fields to Display
section of the application Search Records page.
Keyword Allows users to use this field in a keyword search to find documents attached to
Searching the field. File types supported for document searching include Microsoft Word,
Microsoft Excel, PDF, Text, and .CSV. If a user does not have access to the
field but the field is configured to allow keyword searching, the field is still
searched but not included in the search results.
Validate Designates that a field is validated whenever any value changes in a record. If
Always the Validate Always option is not selected, this field validates only when the
value in that field has changed.
Encrypt Indicates whether field data is encrypted. You can enable or disable field
Field Data encryption when creating and updating fields. To decrypt file, clear the
checkbox. For more information about encryption, see Encrypting Data.
Option Action
Encryption Indicates the status of the field encryption. If this field displays Stationary, then
Status any encryption process is complete and field data is encrypted. If any other status
displays, you must wait until the status returns to Stationary before attempting to
select or clear the checkbox. This may take some time depending on the amount
of data you need to process.
If you attempt to select or clear the checkbox ,or delete a content record that
contains an encrypted field with a non-stationary status, RSA Archer may
display an error. This can result from validation or system errors. You can click
the View Error Details link to see the cause of the error. After you have resolved
the error, click Restart Encryption or Restart Decryption to complete the process.
8. In the Configuration section, specify the minimum and maximum attachments and image size.
The following table describes the options.
Option Description
Minimum Specifies the minimum number of attachments that you want to require for an
Attachments attachment field.
Maximum Specifies the maximum and minimum number of attachments that you want to
Attachments require for the field.
Display Specifies the width and height in pixels for images displayed in this field.
Width and
Display
Height
Maximum Specifies the maximum size, up to 100 MB, that you want to allow for each
Size file uploaded to the Image field. This setting does not restrict the total size of
all files uploaded to the field.
IP Address Displays the IP Address in either version 4 or version 6. You cannot change
Version 4 the format after you save.
IP Address
Version 6
9. In the Options section, select the options for including the field in search results and setting its
behavior.
The following table describes the options.
Option Action
Required Designates the field as required and forces users to enter a value when adding or
Field editing a record in the application. An icon (selected in the Appearance feature)
indicates required fields to alert users that they must enter a value. If you do not
select this option, you can skip this field when adding or editing a record in the
application.
Auditing Displays auditing information next to the field each time that its value is
Information changed. The auditing information includes only the name of the user who made
the change and the date and time of the change. If this checkbox is not selected,
auditing information is not displayed with the field in the user interface.
Search Makes this field available for display in search results and references its values
Results in search filters.
Search Includes the field by default in search results for the application. This option does
Default not prevent users from removing the field from the Search Results page. Users
Field can click Modify in the toolbar and remove the field from the Fields to Display
section of the application Search Records page.
Keyword Allows users to use this field in a keyword search to find documents attached to
Searching the field. File types supported for document searching include Microsoft Word,
Microsoft Excel, PDF, Text, and .CSV. If a user does not have access to the
field but the field is configured to allow keyword searching, the field is still
searched but not included in the search results.
Option Action
Unique Prevents users from entering an identical value in a field in separate records. If a
Field user saves a value in this field and the same value already exists in the field in a
different record, RSA Archer prompts the user to enter a unique value.
Key Field Designates the field as the key field of a record. You must designate one field in
the application as the key field, but can only designate one field as the key field.
You can select the key field values in search results, and users can click the
values to open individual records. A key field must be on the page layout of the
application.
After saving the field, you can only clear this checkbox by selecting another field
as the key field in the application. Selecting this option automatically selectsthe
Required Field, Search Results, and Search Default Field options.
Advanced Adds descriptive text and alters the standard display of the field. After selecting
Field this checkbox, specify the display text and layout for the field in the Advanced
Display Field Display Options section.
Validate Designates that a field is validated whenever any value changes in a record. If
Always the Validate Always option is not selected, this field validates only when the
value in that field has changed.
Encrypt Indicates whether field data is encrypted. You can enable or disable field
Field Data encryption when creating and updating fields. To decrypt file, clear the
checkbox. For more information about encryption, see Encrypting Data.
Encryption Indicates the status of the field encryption. If this field displays Stationary, then
Status any encryption process is complete and field data is encrypted. If any other status
displays, you must wait until the status returns to Stationary before attempting to
select or clear the checkbox. This may take some time depending on the amount
of data you need to process.
If you attempt to select or clear the checkbox ,or delete a content record that
contains an encrypted field with a non-stationary status, RSA Archer may
display an error. This can result from validation or system errors. You can click
the View Error Details link to see the cause of the error. After you have resolved
the error, click Restart Encryption or Restart Decryption to complete the process.
10. Do one of the following based on the display control you selected in step 8:
l If you selected IP Address Version 4, go to the next step.
l If you selected IP Address Version 6, specify the values for the IP address version 6 format in
the Configuration section.
The following table describes the options.
Option Description
Control Specifies the display syntax. This option only affects how the address displays to
the user when viewing a record. It does not impact how the address displays when
adding or editing a record, nor does it change how the address is stored in the
database:
l Full. Displays the full syntax of the address to the user when viewing records
with this field.
l Short-Hand. Displays the shorthand syntax of the address to the user when
viewing records with this field.
Note: If you add a new related record in a cross-reference field, the Last Updated Date field does
not update when the related record field is on the layout.
1. Go to the Fields tab of the application or questionnaire to which you want to add a last updated
date field.
Search Makes this field available for display in search results and references its values
Results in search filters.
Search Includes the field by default in search results for the application. This option does
Default not prevent users from removing the field from the Search Results page. Users
Field can click Modify in the toolbar and remove the field from the Fields to Display
section of the application Search Records page.
Time Displays time information (hours, minutes and the AM or PM designation) along
Information with the date value.
User Displays the name of the user who published the record along with the date
Information value.
Header Displays date first published or last published in the page header of records by
Display default. To remove it from display, clear the Page Header Display checkbox.
Required Designates the field as required and forces users to enter a value when adding or
Field editing a record in the application. An icon (selected in the Appearance feature)
indicates required fields to alert users that they must enter a value. If you do not
select this option, you can skip this field when adding or editing a record in the
application.
Auditing Displays auditing information next to the field each time that its value is
Information changed. The auditing information includes only the name of the user who made
the change and the date and time of the change. If this checkbox is not selected,
auditing information is not displayed with the field in the user interface.
Search Makes this field available for display in search results and references its values
Results in search filters.
Search Includes the field by default in search results for the application. This option does
Default not prevent users from removing the field from the Search Results page. Users
Field can click Modify in the toolbar and remove the field from the Fields to Display
section of the application Search Records page.
Validate Designates that a field is validated whenever any value changes in a record. If
Always the Validate Always option is not selected, this field validates only when the
value in that field has changed.
8. In the Configuration section, specify the rules for selections and lists.
The following table describes the options.
Option Description
Minimum Specifies the minimum number of selections (from none to 20 selections) that a
Selections user can select in the Dropdown, Checkboxes, Listbox, or Values Popup display
control.
Maximum Specifies the maximum number of selections (from none to 20 selections) that a
Selections user can select in the Dropdown, Checkboxes, Listbox, or Values Popup display
control.
Minimum Specifies whether the axis is based on a row or column and the minimum number
Selection of selections that a user can select.
Axis
Option Description
Maximum Specifies whether the axis is based on a row or column and the maximum number
Selection of selections that a user can select.
Axis
Column Specifies the global values list that populates this column in the matrix. When
Values adding a field to a records, users can select an alternate global values list.
List
Row Specifies the global values list that populates this row in the matrix. When adding
Values a field to a records, users can select an alternate global values list.
List
If any records are saved in the application with column or row values from the
specified global values lists, do not select a different the global values on the
Column Values or Row Values tabs. If you select a different global values list
after users have saved records with value selections from the original global
values list, the values from this global values list are permanently lost and the
matrix field shows no selections.
9. Click the Column Values tab and enter the values for the columns in the Values section.
10. Click the Row Values tab and enter the values for the row in the Values section.
11. Click Save or Apply.
l Click Save to save and exit.
l Click Apply to apply the changes and continue working.
Example: Using MRDC fields for displaying content of cross-reference and related-
record fields
You could have a Devices application with separate cross-reference fields that link to the Facilities
and Service-Level Agreements applications. From the MRDC field, users could select the record for
the facility that houses the device from the related Facilities application, and they can select the
record for the service-level agreement for the device from the related Service-Level Agreements
application. Both of these selections would be displayed in the same field.
You can then set this field to display a single reference, allowing users to select one referenced
application for display in the field, or to display multiple references, allowing users to select more
than one reference for display in the field.
Note: After an MRDC field is saved with the Multiple References option selected, the Single
Reference option is no longer available. However, you can change the setting from Single Reference
to Multiple References.
For each cross-reference or related-record field that you select to display in an MRDC field, you
can suppress the field from end-user functions. By selecting the Suppress option, you can hide
existing cross-reference or related-record fields from a record layout, conserving record "real
estate."
An advanced option for the MRDC field type provides the ability to reference the field in a
calculated field formula using the COUNT or ISEMPTY function. You can use the COUNT
function to return the number of referenced records within the field. Using the ISEMPTY function,
you can determine whether the MRDC field contains selections.
Example: Results of calculated field used to determine the number of records ref-
erenced in an MRDC field
l To add a field from an existing field, click Copy an existing Field and select the MRDC field
you want to copy.
4. Click OK.
5. In the General Information section, enter the name and description of the field.
6. Click the Options tab.
7. In the Options section, select whether the field is included in search results and other behaviors.
The following table describes the options.
Option Action
Required Designates the field as required and forces users to enter a value when adding or
Field editing a record in the application. An icon (selected in the Appearance feature)
indicates required fields to alert users that they must enter a value. If you do not
select this option, you can skip this field when adding or editing a record in the
application.
Auditing Displays auditing information next to the field each time that its value is
Information changed. The auditing information includes only the name of the user who made
the change and the date and time of the change. If this checkbox is not selected,
auditing information is not displayed with the field in the user interface.
Search Makes this field available for display in search results and references its values
Results in search filters.
Search Includes the field by default in search results for the application. This option does
Default not prevent users from removing the field from the Search Results page. Users
Field can click Modify in the toolbar and remove the field from the Fields to Display
section of the application Search Records page.
8. In the Configuration section, specify the selection rules for the MRDC field.
The following table describes the options.
Option Description
Selected Specifies the references that you want to display in the MRDC field. As an
References administrator, you can still view the suppressed fields on the Layout tab of the
Manage Applications page, but the individual fields are hidden from end users. If
you do not select the Suppress checkbox for a field and that field is included on
the page layout for the application, both the original field and the MRDC field
displays to end users, causing duplication of data on the page.
Option Description
Note: If you select the MRDC option and save the field, you cannot change
the setting to Single Reference.
Note: A value of None allows any number of decimal places (0-6) to be entered. A value of 0 (zero)
does not allow any decimal places to be entered.
Numeric fields can also be encrypted. For more information about encrypting fields, see Encrypting
Data.
1. Go to the Fields tab of the application to which you want to add a Numeric field.
Required Designates the field as required and forces users to enter a value when adding or
Field editing a record in the application. An icon (selected in the Appearance feature)
indicates required fields to alert users that they must enter a value. If you do not
select this option, you can skip this field when adding or editing a record in the
application.
Auditing Displays auditing information next to the field each time that its value is
Information changed. The auditing information includes only the name of the user who made
the change and the date and time of the change. If this checkbox is not selected,
auditing information is not displayed with the field in the user interface.
Search Makes this field available for display in search results and references its values
Results in search filters.
Search Includes the field by default in search results for the application. This option does
Default not prevent users from removing the field from the Search Results page. Users
Field can click Modify in the toolbar and remove the field from the Fields to Display
section of the application Search Records page.
Option Action
Enable Enables this field to be available for update from Advanced Search Results.
Bulk
Update
Unique Prevents users from entering an identical value in a field in separate records. If a
Field user saves a value in this field and the same value already exists in the field in a
different record, RSA Archer prompts the user to enter a unique value.
Key Field Designates the field as the key field of a record. You must designate one field in
the application as the key field, but can only designate one field as the key field.
You can select the key field values in search results, and users can click the
values to open individual records. A key field must be on the page layout of the
application.
After saving the field, you can only clear this checkbox by selecting another field
as the key field in the application. Selecting this option automatically selectsthe
Required Field, Search Results, and Search Default Field options.
Option Action
Sum Field Provides a total of all values entered in the field on the Search Results page for
an application or leveled application. The sum is only shown on Column-
Hierarchical and Column-Flat report format types.
When this option is selected, the total value appears in the last row of Numeric
Field column. The summation value represents a grand total and displays on each
page.
Numeric Allows users to filter search results in the application based on specific ranges of
Ranging values in the numeric field. When you select this option, you must define the
numeric range and its values after the numeric field is configured.
Calculated Designates the field as a calculated field determined by a formula that computes
Field a value dynamically for this field. If you select this option, the field is read-only
for all users, and the defined formula computes its value.
Advanced Adds descriptive text and alters the standard display of the field. After selecting
Field this checkbox, specify the display text and layout for the field in the Advanced
Display Field Display Options section.
Validate Designates that a field is validated whenever any value changes in a record. If
Always the Validate Always option is not selected, this field validates only when the
value in that field has changed.
Encrypt Indicates whether field data is encrypted. You can enable or disable field
Field Data encryption when creating and updating fields. To decrypt file, clear the
checkbox. For more information about encryption, see Encrypting Data.
Option Action
Encryption Indicates the status of the field encryption. If this field displays Stationary, then
Status any encryption process is complete and field data is encrypted. If any other status
displays, you must wait until the status returns to Stationary before attempting to
select or clear the checkbox. This may take some time depending on the amount
of data you need to process.
If you attempt to select or clear the checkbox ,or delete a content record that
contains an encrypted field with a non-stationary status, RSA Archer may
display an error. This can result from validation or system errors. You can click
the View Error Details link to see the cause of the error. After you have resolved
the error, click Restart Encryption or Restart Decryption to complete the process.
7. In the Configuration section, specify the format for the numeric field.
The following table describes the options.
Option Description
Decimal Specifies the number of decimal places required for values entered in the field
Places (maximum 6). Entering a value in the numeric field with fewer decimal places
than the required number pads the value with zeros.
For example, if you require 3 decimal places and you then enter a value of "4.1" in
the field, the value displays as "4.100" when you save the record.
On the other hand, if you enter a value in the field with more decimal places than
the required number, you must limit the number of decimal places in the value to
fit the field requirements before you can save the record.
Minimum Specifies the minimum values users must enter in the numeric field within a
Values defined range, for example, 1-100.
Option Description
Maximum Specifies the maximum values users must enter in the numeric field within a
Values defined range, for example, 1-100.
Prefix Specifies the text (up to 10 characters) that appears in front of the numeric value.
For example, when you enter "ABC" in this field, record displays "ABC123456."
Suffix Specifies the text (up to 10 characters) that appears after the numeric value. For
example, entering "miles" labels the field value as a measurement of distance. For
the tracking ID, you enter "XYZ" in this field. The tracking ID value for a record
displays "123456XYZ."
Increment Specifies the value by which the number is to increase or decrease. Available
By options are .01, .1, 1, 10, 100, 1000, or No Increment.
2. Choose the numeric field for which you want to define numeric ranges.
3. Click the Options tab and select Numeric Ranging.
4. Click Save and return to the Fields tab of the Manage Applications page.
5. In the Field Type column of the numeric field, click the Numeric Ranges link.
6. Click Add New.
Search Makes this field available for display in search results and references its values in
Results search filters.
Search Includes the field by default in search results for the application. This option does
Default not prevent users from removing the field from the Search Results page. Users
Field can click Modify in the toolbar and remove the field from the Fields to Display
section of the application Search Records page.
Keyword Allows users to use this field in a keyword search to find documents attached to
Searching the field. File types supported for document searching include Microsoft Word,
Microsoft Excel, PDF, Text, and .CSV. If a user does not have access to the field
but the field is configured to allow keyword searching, the field is still searched
but not included in the search results.
Calculated Designates the field as a calculated field determined by a formula that computes a
Field value dynamically for this field. If you select this option, the field is read-only for
all users, and the defined formula computes its value.
Advanced Adds descriptive text and alters the standard display of the field. After selecting
Field this checkbox, specify the display text and layout for the field in the Advanced
Display Field Display Options section.
8. In the Configuration section, specify the rules for the questionnaire reference field.
The following table describes the options.
Option Description
Search Makes this field available for display in search results and references its values in
Results search filters.
Search Includes the field by default in search results for the application. This option does not
Default prevent users from removing the field from the Search Results page. Users can click
Field Modify in the toolbar and remove the field from the Fields to Display section of the
application Search Records page.
7. In the Display Control section, select the control for displaying the record permissions field.
The following table describes the options.
Display
Description
Control
Dropdown Displays a list of items from which users can select an item.
Radio Displays a list of items from which users can select an item.
Buttons
Check Displays a list of items from which a user can select one or more items.
Boxes
Listbox Displays a selection list from which users can select one or more items.
Values Displays a selection list from which users can select one more items. For
Popup example, a users and groups list may contain hundreds or thousands of users. In
this case, a values popup list may be the best solution. For a two or three
selections, the best control might be dropdown, radio buttons, or checkboxes.
8. In the Options section, select the behavior and validation rules for the record permissions field.
The following table describes the options.
Option Action
Required Designates the field as required and forces users to enter a value when adding or
Field editing a record in the application. An icon (selected in the Appearance feature)
indicates required fields to alert users that they must enter a value. If you do not
select this option, you can skip this field when adding or editing a record in the
application.
Auditing Displays auditing information next to the field each time that its value is
Information changed. The auditing information includes only the name of the user who made
the change and the date and time of the change. If this checkbox is not selected,
auditing information is not displayed with the field in the user interface.
Search Makes this field available for display in search results and references its values
Results in search filters.
Search Includes the field by default in search results for the application. This option does
Default not prevent users from removing the field from the Search Results page. Users
Field can click Modify in the toolbar and remove the field from the Fields to Display
section of the application Search Records page.
Option Action
Enable Enables this field to be available for update from Advanced Search Results.
Bulk
Update
Advanced Adds descriptive text and alters the standard display of the field. After selecting
Field this checkbox, specify the display text and layout for the field in the Advanced
Display Field Display Options section.
Validate Designates that a field is validated whenever any value changes in a record. If
Always the Validate Always option is not selected, this field validates only when the
value in that field has changed.
9. In the Configuration section, set the minimum and maximum selection values.
The following table describes the options.
Option Description
Field Specifies the height of the field in lines and is specific to a Listbox or Text Area
Height display control. If more values are available for selection in the field than the
number of lines you specified, a vertical scroll bar appears in the field to enable
users to view all available values.
Column Specifies the number of columns for the Radio Buttons or Checkboxes display
Layout control options.
Minimum Specifies the minimum number of selections (from none to 20 selections) that a
Selections user can select in the Dropdown, Checkboxes, Listbox, or Values Popup display
control.
Maximum Specifies the maximum number of selections (from none to 20 selections) that a
Selections user can select in the Dropdown, Checkboxes, Listbox, or Values Popup display
control.
Note: You cannot use the Scheduler field as a filter, in a data-driven event, or a rule for a data-
driven event.
Note: After you create a scheduler field, you cannot edit the Display Control or Configuration
options. You must delete the scheduler field, which removes the triangular relationships. After
creating the scheduler field, you must add it to the application layout.
1. Go to the Fields tab of the application or questionnaire to which you want to add the Scheduler
field.
Schedule Schedule Grid: Displays appointments in a Gantt-like chart with the resource along
Grid the left side and the appointments in segmented columns based on start and end
Resource dates. In this view, you can see all assigned resources for each parent record. To
Grid assign resources to any parent application, you must configure a scheduler field
with the schedule view and add it to the layout of that application. Any module with
the scheduler field is considered a parent application.
Resource Grid: Displays appointments in a list grouped by parent applications for
all resources or the appointments for a particular resource when viewed by that
user. In this view, your users can see all appointments assigned to them through
this view regardless of the application to which they are assigned. Users can also
see any appointments that are not assigned to a resource.
9. In the Options section, select whether the field is included in search results.
The following table describes the options.
Option Action
Search Makes this field available for display in search results and references its values in
Results search filters.
Option Action
Search Includes the field by default in search results for the application. This option does not
Default prevent users from removing the field from the Search Results page. Users can click
Field Modify in the toolbar and remove the field from the Fields to Display section of the
application Search Records page.
Display Specifies the fields of data from the relationship application that are
Fields displayed on the Record Lookup page for users when they select related
records in the Scheduler field.
To select fields for display, click in the Display Fields field and select
the fields that you want to display from the Available list.
Use the below the Selected list to arrange the fields. The top-to-bottom
order of fields in the Selected list will be the left-to-right order of fields in
the Record Lookup page.
Filters Determines the filtering criteria for selecting records for display on the
Record Lookup page.
To set filters for the records to be displayed in the field, select the values for
the following fields:
l Field to Evaluate
l Operator
l Values
You can also create a dynamic filter for filtering record lookup.
Sorting Specifies the fields by which referenced records are sorted in the Record
Lookup page.
b. In the Schedule Display Configuration, select the resource fields that you want to display.
Display Defines the columns of data that display in the Resource column of the
Fields schedule view.
Use to select the fields that you want to display from the Available list.
Use the below the Selected list to arrange fields. The top-to-bottom
order of fields in the Selected list displays as the left-to-right order of fields in
the Related Record Field table.
Required Designates the field as required and forces users to enter a value when adding or
Field editing a record in the application. An icon (selected in the Appearance feature)
indicates required fields to alert users that they must enter a value. If you do not
select this option, you can skip this field when adding or editing a record in the
application.
Auditing Displays auditing information next to the field each time that its value is
Information changed. The auditing information includes only the name of the user who made
the change and the date and time of the change. If this checkbox is not selected,
auditing information is not displayed with the field in the user interface.
Search Makes this field available for display in search results and references its values
Results in search filters.
Search Includes the field by default in search results for the application. This option does
Default not prevent users from removing the field from the Search Results page. Users
Field can click Modify in the toolbar and remove the field from the Fields to Display
section of the application Search Records page.
Option Action
Add New Determines whether the Add New link is displayed in a grid for allowing users to
add new records to the related applications from a record in view mode. Users
will not have to open a record in edit mode to create new related records. If a
user does not have rights to create records in the related application, the link is
not displayed for that user.
When a user creates a new related record from view mode, that record will be
selected in the cross-reference field just as it would if it were created from edit
mode. For example, if a user opens a Vendor record in View mode and creates a
record in the related Audits application by clicking Add New in the cross-
reference field, that new Audit record will be selected in the cross-reference
field of the Vendor record, even though the user did not open the Vendor record
for editing.
Validate Designates that a field is validated whenever any value changes in a record. If
Always the Validate Always option is not selected, this field validates only when the
value in that field has changed.
8. In the Grid Display Properties, select the fields that you want to display for the sub-form field.
The following table describes the options.
Option Action
Display You can define the fields of data that display in the Sub-Form field grid of sub-form
Fields
records. To select fields for display, click in the Display Fields field and select
the fields that you want to display from the Available list.
Use the below the Selected list to arrange the fields. The top-to-bottom order
of fields in the Selected list display as the left-to-right order of fields in the Sub-
Form field table.
Minimum Specifies the minimum number of selections (from none to 20 selections) that
Selections a user can select in the Dropdown, Checkboxes, Listbox, or Values Popup
display control.
Maximum Specifies the maximum number of selections (from none to 20 selections) that
Selections a user can select in the Dropdown, Checkboxes, Listbox, or Values Popup
display control.
Field Edit Specifies whether users can edit and delete all records or only the records
Settings that they entered in the sub-form field.
l Edit Own Records - Allows users to edit or delete entries that they have
made in the sub-form field.
l Edit All Records - Allow users to edit or delete any entry in the sub-form
field, regardless of who enter it.
Field Designates specific users and groups as field administrators for the sub-form
Administrators or voting field, enabling them to edit and delete any entry made in the field,
you must select those users and groups.
To select the user and groups, click and from the Available list, and then
select the users and groups that you want to designate as field administrators
for the sub-form field.
The create, read, update, and delete rights available to a field administrator
are dependent on the rights that are in place for the parent object, such as an
application or a questionnaire.
If the parent object has only create and read rights, for example, the sub-form
field in that object is restricted to those same rights.
Default Determines the number of cross-referenced records that display in the grid
Records and is only available when the display control is set to Grid. If this option is
Display selected, only the first designated number of records are displayed. For
example, when this option is set to 10, only the first 10 records display in the
grid. If the number of records exceeds the default display number, a View All
link is displayed. A user can click this link to view all of the associated
records.
You can encrypt text fields. For more information about encrypting fields, see Encrypting Data.
9. In the Options section, determine the behavior and validation rules of the text field.
10. In the Configuration section, specify the format and default value for the text field.
System ID A sequential tracking ID that is generated based on the number of records in all
applications.
Application A sequential tracking ID that is generated based on the number of records in the
ID application. If you select this option, the tracking ID values for individual records is
based on the order in which they were added.
With the tracking ID configured with Application ID, it is possible for records in separate
applications to have matching tracking ID values.
l If you select this option for Tracking ID fields in leveled applications, the tracking ID value is
based on the order the record was added in the context of the entire application, not a specific
level. For example, if you were to add a record to the top-level application, add a record to the
second-level and then add another record to the top-level application, the records in the top level
have tracking ID values of 1 and 3 respectively.
l If you select this option for Tracking ID fields in sub-forms, the tracking ID value is based
relative to the individual sub-form field.
Search Makes this field available for display in search results and references its values in
Results search filters.
Search Includes the field by default in search results for the application. This option does not
Default prevent users from removing the field from the Search Results page. Users can click
Field Modify in the toolbar and remove the field from the Fields to Display section of the
application Search Records page.
Key Designates the field as the key field of a record. You must designate one field in the
Field application as the key field, but can only designate one field as the key field. You
can select the key field values in search results, and users can click the values to
open individual records. A key field must be on the page layout of the application.
After saving the field, you can only clear this checkbox by selecting another field as
the key field in the application. Selecting this option automatically selectsthe
Required Field, Search Results, and Search Default Field options.
6. In the Configuration section, select the options for generating identification numbers and whether
the ID has a prefix or suffix.
The following table describes the options.
Option Description
Prefix Specifies the text (up to 10 characters) that appears in front of the numeric value.
For example, when you enter "ABC" in this field, record displays "ABC123456."
Suffix Specifies the text (up to 10 characters) that appears after the numeric value. For
example, entering "miles" labels the field value as a measurement of distance.
For the tracking ID, you enter "XYZ" in this field. The tracking ID value for a
record displays "123456XYZ."
System ID Specifies whether the tracking ID is generated based on the number of records in
all applications.
Application Specifies that the tracking ID is generated based on the number of records in the
ID application.
You can change the tracking ID type later; however, the keyword search index
for all records in the application must then be rebuilt.
During the index rebuild, keyword search results may be inaccurate, and frequent
index rebuilds can impact system performance. For more information on
rebuilding the keyword search index, see "Rebuild All Indexes" in the
RSA Archer Control Panel Help.
You can grant record-level permissions and populate the field with users and groups. It is, however,
important to remember that you can:
l Restrict the list of groups that display as available selections in the field by selecting the Auto
Restrict Groups option. This option limits the groups that are available for selection to only those
groups for which the user is a member.
Example: Restricting groups from selection lists
You select the Sales, Marketing, and Management groups as available selections in the field. If a
user adds a record in the application and that user is a member of only the Marketing group, the
Marketing group is the only group available to that user for selection in the User/Groups List
field.
l Exclude inactive users from selection so they do not appear in a user or group list.
Note: You can convert a user/groups list field to a record permissions field to limit record access to
only those users or groups selected in the field.
7. In the Display Control section, select the option for displaying the field.
The following table describes the options.
Display
Description
Control
Dropdown Displays a list of items from which users can select an item.
Radio Displays a list of items from which users can select an item.
Buttons
Check Displays a list of items from which a user can select one or more items.
Boxes
Listbox Displays a selection list from which users can select one or more items.
Values Displays a selection list from which users can select one more items. For
Popup example, a users and groups list may contain hundreds or thousands of users. In
this case, a values popup list may be the best solution. For a two or three
selections, the best control might be dropdown, radio buttons, or checkboxes.
8. In the Options section, select the behavior and validation rules for the user/groups list field.
The following table describes the options.
Option Action
Required Designates the field as required and forces users to enter a value when adding or
Field editing a record in the application. An icon (selected in the Appearance feature)
indicates required fields to alert users that they must enter a value. If you do not
select this option, you can skip this field when adding or editing a record in the
application.
Auditing Displays auditing information next to the field each time that its value is
Information changed. The auditing information includes only the name of the user who made
the change and the date and time of the change. If this checkbox is not selected,
auditing information is not displayed with the field in the user interface.
Search Makes this field available for display in search results and references its values
Results in search filters.
Search Includes the field by default in search results for the application. This option does
Default not prevent users from removing the field from the Search Results page. Users
Field can click Modify in the toolbar and remove the field from the Fields to Display
section of the application Search Records page.
Option Action
Enable Enables this field to be available for update from Advanced Search Results.
Bulk
Update
Advanced Adds descriptive text and alters the standard display of the field. After selecting
Field this checkbox, specify the display text and layout for the field in the Advanced
Display Field Display Options section.
Validate Designates that a field is validated whenever any value changes in a record. If
Always the Validate Always option is not selected, this field validates only when the
value in that field has changed.
9. In the Configuration section, specify the values for the minimum and maximum number of
selections.
The following table describes the options.
Option Description
Field Specifies the height of the field in lines and is specific to a Listbox or Text Area
Height display control. If more values are available for selection in the field than the
number of lines you specified, a vertical scroll bar appears in the field to enable
users to view all available values.
Column Specifies the number of columns for the Radio Buttons or Checkboxes display
Layout control options.
Minimum Specifies the minimum number of selections (from none to 20 selections) that a
Selections user can select in the Dropdown, Checkboxes, Listbox, or Values Popup display
control.
Maximum Specifies the maximum number of selections (from none to 20 selections) that a
Selections user can select in the Dropdown, Checkboxes, Listbox, or Values Popup display
control.
10. In the Field Population section, select the users and/or groups for populating the user/groups list
field.
Available Selects the groups or users that you want to place in a field.
Users/Groups l Record Creator. Adds the user who is adding or editing the record.
Show Users Enables the end-use to expand groups within a field to view the users in that
group.
Default Designates a group or record creator as the default value for a field. When
users add new records, the default values are automatically selected in the
field.
Auto-Restrict Limits the groups that are available for selection to only those groups for which
Groups the user is a member.
For example, you select the Sales, Marketing, and Management groups as
available selections in the field. If a user adds a record in the application and
that user is a member of only the Marketing group, the Marketing group will be
the only group available to that user for selection in the User/Groups List field.
Default to Includes only the groups for which the default selection is the record creator.
Creator Only groups that are defined as available values for this field can be selected
Groups by default.
Exclude Excludes inactive users whose user status is no longer active and whose
Inactive access is revoked.
Users
Dropdown Displays a list of items from which users can select an item.
Radio Displays a list of items from which users can select an item.
Buttons
Display
Description
Control
Check Displays a list of items from which a user can select one or more items.
Boxes
Listbox Displays a selection list from which users can select one or more items.
Values Displays a selection list from which users can select one more items. For
Popup example, a users and groups list may contain hundreds or thousands of users. In
this case, a values popup list may be the best solution. For a two or three
selections, the best control might be dropdown, radio buttons, or checkboxes.
8. In the Options section, select the options for including the field in search results and setting its
behavior:
Options
Required Designates the field as required and forces users to enter a value when adding or
Field editing a record in the application. An icon (selected in the Appearance feature)
indicates required fields to alert users that they must enter a value. If you do not
select this option, you can skip this field when adding or editing a record in the
application.
Auditing Displays auditing information next to the field each time that its value is
Information changed. The auditing information includes only the name of the user who made
the change and the date and time of the change. If this checkbox is not selected,
auditing information is not displayed with the field in the user interface.
Search Makes this field available for display in search results and references its values
Results in search filters.
Search Includes the field by default in search results for the application. This option does
Default not prevent users from removing the field from the Search Results page. Users
Field can click Modify in the toolbar and remove the field from the Fields to Display
section of the application Search Records page.
Enable Enables this field to be available for update from Advanced Search Results.
Bulk
Update
Option Action
Description Displays the selected value for the field as a hyperlink when users view records
Links in the application. Users can click the linked value to read a description of the
value from a pop-up window.
Calculated Designates the field as a calculated field determined by a formula that computes
Field a value dynamically for this field. If you select this option, the field is read-only
for all users, and the defined formula computes its value.
Advanced Adds descriptive text and alters the standard display of the field. After selecting
Field this checkbox, specify the display text and layout for the field in the Advanced
Display Field Display Options section.
Validate Designates that a field is validated whenever any value changes in a record. If
Always the Validate Always option is not selected, this field validates only when the
value in that field has changed.
9. In the Configuration section, specify the minimum and maximum number of selections a user can
make.
Configuration options
Field Specifies the height of the field in lines and is specific to a Listbox or Text Area
Height display control. If more values are available for selection in the field than the
number of lines you specified, a vertical scroll bar appears in the field to enable
users to view all available values.
Column Specifies the number of columns for the Radio Buttons or Checkboxes display
Layout control options.
Minimum Specifies the minimum number of selections (from none to 20 selections) that a
Selections user can select in the Dropdown, Checkboxes, Listbox, or Values Popup display
control.
Maximum Specifies the maximum number of selections (from none to 20 selections) that a
Selections user can select in the Dropdown, Checkboxes, Listbox, or Values Popup display
control.
.
b. Under Application Builder, click Applications or Questionnaires.
c. Select the application or questionnaire.
d. Click the Fields tab.
Search Makes this field available for display in search results and references its values in
Results search filters.
Search Includes the field by default in search results for the application. This option does
Default not prevent users from removing the field from the Search Results page. Users can
Field click Modify in the toolbar and remove the field from the Fields to Display section
of the application Search Records page.
Validate Designates that a field is validated whenever any value changes in a record. If the
Always Validate Always option is not selected, this field validates only when the value in
that field has changed.
8. In the Configuration section, specify the tally and weight options for the voting field.
Vote Tally Specifies whether the results should display a total number of votes cast or an
average of the ratings provided by end users.
Vote Weight Specifies how much each vote is worth. For example, if the Vote Weight is
"10" and ten users have submitted a vote, the total value displayed would be
"100."
Field Designates specific users and groups as field administrators for the sub-form
Administrators or voting field, enabling them to edit and delete any entry made in the field,
you must select those users and groups.
To select the user and groups, click and from the Available list, and then
select the users and groups that you want to designate as field administrators
for the sub-form field.
The create, read, update, and delete rights available to a field administrator
are dependent on the rights that are in place for the parent object, such as an
application or a questionnaire.
If the parent object has only create and read rights, for example, the sub-form
field in that object is restricted to those same rights.
9. In the Voting Reset Rules section, enter the rules for purging recorded votes. If you do not set
the voting reset rules, votes are never purged.
The following table describes filter criteria. Each row represents one set of filter criteria.
Option Description
Operator Provides the filter that evaluates the field in the creation of a condition. The
available operators depend on the type of field selected in Field to Evaluate.
Value(s) Opens the Record Lookup, which enables users to choose which value or values
to add to the condition.
Relationship Connects two or more conditions together. If you add more than one condition,
you can apply advanced logic to your search criteria.
Option Description
Edit Help is displayed for users when they add or edit a record in the application where
the field resides.
View Help is displayed for users when they view a saved record in the application where
the field resides.
Edit and Help is displayed for users when they add, edit, or view a record in the application
View where the field resides.
Help is displayed for users when they add, edit, or view a record in the application
where the field resides.
Note: You can also create field-level Help using text boxes in an application layout. Text boxes
provide instructions or additional information that appears above, below, or beside a field when users
add, edit, or view records in an application.
Above Help displays above the field in edit and view modes.
Below Help displays below the field in edit and view modes.
Tooltip Help displays as a tool tip (mouse over) on the field name in edit and view modes.
Options Description
Icon Help icon displays beside the field in edit and view modes. Click this icon to display
the field Help. The application dynamically sizes of the Help box based on the number
of characters in the text.
2. In the Help Text field, enter instructional and descriptive text for the field.
3. In View Display Options, select the behavior for displaying the help in View mode. See View
and edit display options.
4. In Edit Display Options, select the behavior for displaying the help in Edit mode. See View and
edit display options.
5. Click Apply.
Public Public fields are available to all end users. If a certain field is configured as private,
users who do not have rights to the field cannot view it when adding, editing, or viewing
records in the application.
Private Private fields are only available to the users and groups to which you grant access rights.
1. Go to the Fields tab of the application, questionnaire, or sub-form that contains a field to which
you want to assign an access role.
Active Active fields display when users add, edit, and view records in the application.
Active fields can be referenced in record searches, calculated field formulas, and data
driven events.
By default, the field status is Active.
Inactive Inactive fields are not displayed in any application record and cannot be referenced by
other options in RSA Archer.
2. Select the field you want to inactivate and go to the General Information section under the
General tab.
3. In the Status field, select Inactive.
4. Click Save or Apply.
l Click Save to save and exit.
l Click Apply to apply the changes and continue working.
Deleting Fields
You can delete a basic or advanced field type from an application. Deleting a field also deletes all
data previously stored in that field. You cannot delete the key field from an application. To delete a
field designated as the application key field, you must first designate another field as the key field.
When you delete a field that has trending enabled, all trending data associated with the field is
deleted. An asynchronous cleanup job that runs once per day removes both expired trended data and
any trended data for fields that the user has disabled trending. After deleting the field, the trending
chart related to the field is replaced with a Placeholder layout object with the same span properties
on the application layout.
Note: When you delete a system field type (First Published Date, Last Updated Date, Record
Status, Related Records, or Tracking ID), the field is deleted but the data is still stored in
RSA Archer.
1. Go to the Fields tab of the application in which you want to delete a field.
2. Click the row and view the description of the field that you want to delete.
Note: Some fields in RSA Archer applications may be locked, allowing administrators limited
access. If no is displayed, that field is locked and cannot be deleted. RSA strongly advises
against deleting a Tracking ID field even if is displayed. By default, a Tracking ID is the key
field for a record, and deleting it could impact related records.
4. Click OK.
Note: Scheduled bulk actions do not require that you enable fields in advance.
You can enable the following field types for on-demand bulk updates:
l Text
l Date / Time
l User / Group
l Values List
l Numeric
l Cross-Reference / Related Record
l Record Permissions
You can enable the following field types for on-demand bulk create references:
l Cross-Reference
l Related Record
Note: For leveled applications, you must select which fields to display for each level.
Note: Required fields from the referenced application are displayed automatically and
cannot be removed.
Encrypting Data
RSA Archer allows you to encrypt the following field types in an application:
l Attachment
l Date
l IP Address
l Image
l Numeric
l Text
The purpose of encryption is to protect sensitive data in the database and the file repository.
Encrypted field data is stored in the Encrypted folder in the file repository. When you encrypt a field,
all data in that field, whether in the record or through a data feed or import, is encrypted in the
database. Encrypted fields display data in the record as normal text. Files and images associated
with encrypted attachment and image fields are decrypted when downloaded. You can encrypt new
and existing fields.
The following table shows how encrypted fields affect other functionality in the application or
RSA Archer.
Related
Impact
Area
Data If the incoming data targets an encrypted field, the data will be stored in the
feeds/imports database in an encrypted format. Archer to Archer data feeds support encrypted
attachments and images. When encrypted files are exported from an instance, they
are unencrypted. If the target instance has encryption enabled, the files are
encrypted. If the target instance does not have encryption enabled, the files are not
encrypted.
Advanced Encrypted fields support only Equals and Does Not Equal filters. Encrypted fields
search filters cannot perform statistical search operations, for example Group By and Count.
Layout rule Encrypted fields are supported for all standard field filter options in a layout rule.
filters
Related
Impact
Area
Record Only the filter options Equals, Does Not Equal, Field Value Match, and Field
Lookup Value Does Not Match are available for encrypted fields.
Configuration
Offline sync You cannot sync an application with encrypted fields offline.
Subscription Only the filter options Equals, Does Not Equal, Field Value Match, and Field
Notification Value Does Not Match are available for encrypted fields.
filters
Note: If you do not first enable field encryption at the instance level, users receive the following
message when they try to encrypt a field:
Field encryption must be enabled in the RSA Archer Control Panel.
Encrypted fields do not display the The Key Encryption Verify whether the KEK is present
data. Key (KEK) for one on each of your Web Servers and
or more of your Services Servers and add the KEK
When a user logs in, the following instances is missing. wherever it is missing. For
message appears: Configuration instructions, see "Enable Field
error, some of the data may be Encryption for an Instance" in the
blank. Please contact your RSA Archer Control Panel Help.
administrator.
Note: This feature is available only if you have selected Hardware Security Module as the key
store.
You can either upload a key that you have previously obtained, or you can generate the key within
RSA Archer.
2. Click the KEK Expiration Date Calendar icon, and then select an expiration date from the
calendar.
3. Do one of the following:
l Click Generate KEK to generate the key within RSA Archer.
l Click Upload KEK, and then navigate to the key file for uploading.
4. After you have generated or uploaded the key, it appears in the Manage Keys grid.
Note: Only one key is valid at a time. If you create another key, RSA Archer disables the
previous valid one.
Calculated Fields
Calculated fields eliminate the tedious and potentially error-prone process of manually calculating
values. A calculated field is a configuration option that enables you to specify a formula for
dynamically computing a value for a text, numeric, date, or values list field. Calculated fields are
read-only for all users. RSA Archer populates the value of a calculated field based on the formula
that you build for a specific field. You must have ownership rights of the application, questionnaire,
or sub-form to create a calculated field.
Important: Dates and times are converted to Coordinated Universal Time (UTC) in the RSA
Archer database. As a result, dates and times in calculations are returned in UTC.
Essential terminology
The following table defines essential terminology for working with calculations.
Term Definition
Always A property of a calculated field that specifies that the field is always recalculated
(calculate) whenever content changes.
Asynchronous A process that runs independently in the background. Most calculations are
queued for re-calculation in an asynchronous job instead of inline on content save.
Content is updated when the job runs instead of immediately.
Calculate The means to update a calculated field inline while viewing or editing a record
Immediately that has a calculated field.
Execution The means of calculating the value of a calculated field. Calculations can be
executed inline or asynchronously.
Formula A built-in formula editor that contains a library of functions and operators. Use
Builder this tool to create formulas for calculated fields.
Marked Any content that has an outstanding calculation that needs to be recalculated. This
Content content is ‘marked’ for recalculation.
l Performing complex risk calculations based on the results of values in other fields
l Producing weighted risk scores for risk assessments
General behaviors
Formulas of calculated fields are allowed unrestricted access to data in all private fields, regardless
of the access rights configured for those fields.
Calculations are executed in the order that they are defined. Calculations that are dependent on other
calculations may not produce the intended results if they are not correctly sequenced. Consider the
calculation order to ensure correct calculations. The calculation order can be rearranged.
Calculations execute when a record is saved. RSA Archer determines whether changes in the record
warrant a recalculation of any associated calculated fields. If the update to the record does not
impact a specific calculated field, RSA Archer does not recalculate the value of that field. This
evaluation optimizes system performance and eliminates unnecessary calculations.
If no changes are committed to a record, calculated values in that record are not updated. At times,
though, business requirements may dictate that date-sensitive formulas be recalculated on a daily
basis. To meet this demand, RSA Archer facilitates recalculations through a recalculation scheduler.
Once an application has been placed on a recalculation schedule, RSA Archer automatically
refreshes the values of all calculated fields each day at the specified time. You can however
recalculate a specific field in an application, even if the changes in the record do not lead to an
updated calculated value.
ID Generation Requirement: Create a unique record ID that combines a threat-type code, the
current date, and a counter value that is automatically incremented with each
new record. Always express the counter value using five digits; pad zeroes on
the value when necessary. Example: WORM-05232005-00019
Solution: Create a calculated text field that uses the following formula:
[Type Code] & “-“ & DATEFORMAT(TODAY( ), “mmddyyyy”) & “-“ &
NUMERFORMAT(CONTENTID( ), 0000#)
Scoring Requirement: Using key impact indicators, assign a priority score to a security
violation report. Do not display a raw numeric score. Instead, determine whether
the score falls within the High or Low priority range. Display a text value
indicating the final priority score. Example: High
Solution: Create a calculated Numeric field to compute the raw priority score.
Suppress the display of this field by removing it from the application layout, then
create a calculated text field that maps the raw score to a priority range. Display
the corresponding range name (High or Low) in the calculated text field. Use the
following formulas:
l Numeric Field: SUM([Current Impact], [Potential Impact], [LOB Impact]) *
[Violation Potential])
l Text Field: IF([Raw Score] <= 15, “Low”, “High”)
Date Requirement: Compute and display the number of days remaining before a
Countdown trouble ticket record reaches its promised resolution deadline. Example: 5 Days
Remaining
Solution: Create a calculated Text field that uses the following formula:
([Due Date] - TODAY( )) & “Days Remaining”
Complex/nested formulas
The formula for a calculated field can be dependent on the results of other calculations. It is very
likely that you may require complex and nested formulas. Use the following guidelines for these
cases:
Use the Always option of the Recalculation rules when a formula contains the NOW( ) or TODAY(
) functions, or user first name, last name, and middle name (Editor) parameters. When this option is
selected, fields are recalculated whenever content is saved regardless of content change. This option
adds processing overhead and can slow performance if used unnecessarily.
Using the Always option for any other purpose may result in cycles. This condition makes it more
difficult to find and to troubleshoot.
When using the DATEADD or DATEDIF function, the functions error when the Date field is
empty.
Note: If you select a field value to reference in your formula and that value is later modified
in the values list, the field-value reference in your formula is automatically updated to reflect
the modified value.
4. When you finish creating the formula, click Validate in the top-right corner of the formula.
If the validation process encounters an error in the formula, a message displays that describes
the error or alerts you that the formula contains an unknown error. The validation process only
identifies one error at a time, even if the formula contains multiple errors. If you get an error
message, correct the error and click Validate again. If you get another error message, correct
that error as well. Continue this process until the formula passes the validation process.
5. Click OK.
6. Click Apply.
Note: When you click Apply on a cross-reference field, the record saves and the calculation
status can not be changed.
Task 3: Define the behavior and error handling rules for non cross-reference cal-
culated fields
Perform this step for calculated fields that do not include cross-references.
1. Go to the Calculation Properties section.
2. In the Recalculation field, select behavior for recalculating field values.
The following table describes the options.
Field Description
Always Formulas are recalculated every time content is saved even though a field is not
referenced in the formula. Formulas that contain NOW ( ) and TODAY ( ) functions,
or user first name, last name, and middle name (Editor) parameters are recalculated
regardless of content change.
Display Displays the word Error as a link when a calculation error occurs. Users with the
Error appropriate access privileges can click the link to open the Calculation Error page
where the error is explained.
Use No Saves an empty value in the field when a calculation error occurs.
Value
Use Saves a specific value in the field when a calculation error occurs
Specific
4. Click Save.
Calculation Process
Formulas of calculated fields are recalculated whenever there is a change in the content of a field,
related field, or sub-form. Calculations are executed either through administrative or user functions.
The following table describes the administrative and user functions.
Function Action Execution
User Calculations 1. User clicks the Recalculate button while viewing a record.
recalculated Content ‘marked’ for recalculation is recalculated.
inline 2. User clicks the Apply button without making a change.
Content ‘marked’ for recalculation is recalculated.
3. User clicks the Save button after making a change. Content is
saved and ‘marked’ content is recalculated.
Recalculation process
The following table describes how recalculations are processed. Recalculations are processed imme-
diately or through an asynchronous job.
Type Description
Immediate Calculations are triggered by a user saving a record that is either 'marked' or
changing a field that is used by a calculated field in the same level. 'Marked'
content is changed to an ‘unmarked’ status when a user saves that content.
An immediately applied calculation can be performed in a cross-referenced
application one level away.
For example, Application A is dependent on a calculated field in Application B.
Application B has a cross-reference relationship with Application A. When a
record is updated in Application B, its related record in Application A can be
recalculated immediately when the user returns to Application A and clicks Apply
or Save.
Related records are updated when a user initiates the recalculation or the
recalculation is updated through an asynchronous job.
l When updated by the user, the Last Updated field contains the identification of
the user who updated the record.
l When updated by an asynchronous job, the Last Updated field is not updated.
Type Description
Asynchronous Queued asynchronous jobs run based on the number of jobs in the job queue.
jobs Scheduled asynchronous jobs run at a specified time regardless of any current
activity on the record.
Calculations are queued in an asynchronous job in various ways.
l Change the formula of a calculated field, and select Yes to recalculate the
field.
l Change the weight of a question field.
l Change the order of calculations.
l Change the Recalculation option of a calculated field, and select Yes to
recalculate the field.
l Change the Error Handling option of a calculated field, and select Yes to
recalculate the field.
l Change the input mask on a text field that is referenced by a calculated field.
l Change the numeric attribute of a value in a Values List field that is referenced
by a calculated field.
l Change the Other text attribute of a value in a Values List field that is
referenced by a calculated field.
l Change the Correctness attribute of a value in a Questions Values List field
that is referenced by a calculated field.
When you change the formula of a calculated field but does not schedule the recalculation in an
asynchronous job, the contents in this application affected by this change is not ‘marked’. When this
condition exists, the content status is updated by a user saving the change or by the asynchronous
job.
However, if you change one or more fields and only schedule an asynchronous job for one of the
fields, all fields ‘marked’ for recalculation are included in the asynchronous job.
User with Read and Update permissions views the record in View mode.
Action 2
User notices message that content is not up to date and clicks Recalculate.
Administrator updates both formulas of the calculated fields and does not schedule an
Action 1
asynchronous job to recalculate the fields.
Formulas are updated in the applications. [Risk] and [Controls] are not ‘marked’ for
Results
recalculation.
User with Read and Update permissions views the record in View mode. User is not
Action 2
notified that content is not up to date.
Date Functions
Important: Dates and times are converted to Coordinated Universal Time (UTC) in RSA Archer
database. As a result, dates and times in calculations are returned in UTC.
The following date functions produce dynamic values and to manipulate date information.
DATEADD Function
The DATEADD function increases or decreases a date/time value by a given number of date/time
units, such as days, hours or minutes.
Dates and times are converted to Coordinated Universal Time (UTC) in the RSA Archer database.
As a result, dates and times in calculations are returned in UTC.
Important: DATEADD always considers time, even if the referenced Date field is not configured
to show time information. If a literal date string is supplied that does not contain time, midnight will
be assumed.
datetime_ The date/time part that should be used as the interval for increasing or decreasing
unit the datetime parameter’s value. This parameter can be entered as DAY, HOUR or
MINUTE.
increment The number of date/time units that should be added to the datetime parameter’s
value. This parameter must be formatted as a positive or negative integer greater
than or equal to 1. (Decimal places are not supported.) If a positive number is
provided, the function adds the specified number of date/time units to the datetime
parameter’s value. If a negative number is provided, the function performs a
subtraction.
datetime The date/time value that should be increased or decreased by the specified number
of date/time units. This parameter should be formatted as a Date-field reference, for
example, [field name].
Examples:
The following table provides example formulas of the DATEADD function.
Formula Result
Formula Result
DATEDIF Function
The DATEDIF function calculates the number of days between two dates.
Dates and times are converted to Coordinated Universal Time (UTC) in the RSA Archer database.
As a result, dates and times in calculations are returned in UTC.
Important: DATEDIF always considers time in the comparison, even if the referenced Date field is
not configured to show time information. If a literal date string is supplied that does not contain time,
midnight will be assumed.
start_date The starting date of the period. This date can be entered as a hard-coded value, for
example, 10/21/2010, or as a Date-field reference, for example, [date field name]. If
a hard-coded value is supplied, it must be wrapped in the DATETIMEVALUE
function. If time is supplied to DATETIMEVALUE in a date string, it must be in
24-hour clock format, for example, 14:25 represents 2:45 PM.
end_date The ending date of the period. This date can be entered as a hard-coded value (for
example, 10/21/2004) or as a Date-field reference (for example, [date field name]).
If a hard-coded value is supplied, it must be wrapped in the DATETIMEVALUE
function. If time is supplied to DATETIMEVALUE in a date string, it must be in
24-hour clock format, for example, 14:25 represents 2:45 PM.
datetime_ The granularity of the time information to be returned. This parameter can be
unit entered as DAY, HOUR or MINUTE. If the datetime_unit parameter is omitted,
DAY will be assumed. If DAY is specified, the difference will be calculated based
on 24 hour periods, rather than the day portion of the date value.
Examples:
The following table provides example formulas of the DATEDIF function.
Formula Result
DATEFORMAT Function
The DATEFORMAT function returns the supplied date in the format specified by the date mask.
Dates and times are converted to Coordinated Universal Time (UTC) in the RSA Archer database.
As a result, dates and times in calculations are returned in UTC.
Important: DATEFORMAT always permits full date and time formatting for the given Date field,
even if that field is not configured to display time information.
date The starting date of the period. This date can be entered as a hard-coded value, for
example, 10/21/2010) or as a Date-field reference, for example, [field name].
Parameter Description
date_mask The mask used for formatting the returned date. The date_mask parameter must be
enclosed in quotes.
Date masks used with the DATEFORMAT function can contain any combination of
the date elements.
MM.dd.yyyy 08.02.2010
yyyy-MM-dd 2010-08-02
MMddyy 080210
Examples:
The following table provides example formulas of the DATEFORMAT function.
Formula Result
Formula Result
DATEFORMAT([Stop], "H") 19
where the date-time value of Stop is 4/8/2010 7:00 PM.
DATEFORMAT([Logged], "m") 57
where the date-time value of Logged is 12/29/2010 3:57 PM.
DATETIMEVALUE Function
The DATETIMEVALUE function converts a literal date/time string to a serial number. The serial
number represents the number of whole and partial days that have elapsed since January 1, 1900.
Important: Dates and times are converted to Coordinated Universal Time (UTC) in the RSA
Archer database. As a result, dates and times in calculations are returned in UTC.
datetime_ The literal date/time string value to be converted. This cannot be a field
string reference.
Examples:
The following table provides example formulas of the
DATETIMEVALUE function.
Formula Result
DATETIMEVALUE("10/02/2010") 40453
DAY Function
The DAY function returns an integer between 1 and 31, which represents the day of the month for
the specified date value.
Important: Dates and times are converted to Coordinated Universal Time (UTC) in the
RSA Archer database. As a result, dates and times in calculations are returned in UTC.
date The date value to be evaluated in determining the day of the month. This parameter
should be formatted as a Date-field reference, for example, [field name].
Example:
The following table provides an example formula of the DAY function.
Formula Result
DAY([Logged]) 13
where the value in the Logged field is 7/13/2010 10:45 AM.
HOUR Function
The HOUR function returns an integer between 0 and 23, which represents the hour of the day for
the specified date value. Formula validation will fail for this function if the Time Information option
is not enabled for the Date field referenced in the date parameter.
Return Type: Numeric
Syntax: HOUR(date)
In the above syntax, parameters in bold are required.
The following table describes the HOUR function parameter.
Parameter Description
date The date value to be evaluated in determining the hour of the day. This parameter
should be formatted as a Date-field reference, for example, [field name].
Example:
HOUR([Logged]) 14
where the value in the Logged field is 7/13/2006 2:45 PM.
MINUTE Function
The MINUTE function returns an integer between 0 and 59, which represents the minute of the hour
for the specified date value. Formula validation will fail for this function if the Time Information
option is not enabled for the Date field referenced in the date parameter.
Important: Dates and times are converted to Coordinated Universal Time (UTC) in the
RSA Archer database. As a result, dates and times in calculations are returned in UTC.
date The date value to be evaluated in determining the minute of the hour. This parameter
should be formatted as a Date-field reference, for example, [field name].
Examples:
The following table provides example formulas of the MINUTE function.
Formula Result
MINUTE([Logged]) 45
where the value in the Logged field is 7/13/2006 2:45 PM.
MINUTE([Patch Date]) 0
where the Patch Date field is a Date field that is not configured to accept time entry.
MONTH Function
The MONTH function returns an integer between 1 and 12, which represents the month of the year
for the specified date value.
Important: Dates and times are converted to Coordinated Universal Time (UTC) in the
RSA Archer database. As a result, dates and times in calculations are returned in UTC.
date The date value to be evaluated in determining the month of the year. This parameter
should be formatted as a Date-field reference, for example, [field name].
Example:
The following table provides an example formula of the MONTH
function.
Formula Result
MONTH([Logged]) 7
where the value in the Logged field is 7/13/2010 2:45 PM.
MONTHNAME Function
The MONTHNAME function returns the name of the month for the supplied date value. The return
value is the full name, not an abbreviation.
Important: Dates and times are converted to Coordinated Universal Time (UTC) in the
RSA Archer database. As a result, dates and times in calculations are returned in UTC.
date The date value to be evaluated in determining the month of the year. This parameter
should be formatted as a Date-field reference, for example, [field name].
Example:
NOW Function
The NOW function returns the current date/time. Each time a record is recalculated, the calculated
field displays an updated date/time value. The full timestamp is stored for the calculated Date field
even if the field is not configured to display time. If the Time Information option is later enabled for
the field, the time will be displayed as it was originally computed.
Internally, the NOW function returns a serial number that represents the number of whole and partial
days that have elapsed since January 1, 1900. From the user perspective, the value returned by the
NOW function displays differently depending on the type of field to which the value will be
returned.
Important: Dates and times are converted to Coordinated Universal Time (UTC) in the
RSA Archer database. As a result, dates and times in calculations are returned in UTC.
Return Type: Varies based upon the type of field receiving the return value. See the examples
below.
Syntax: NOW( )
This function does not have any parameters.
Examples:
The following table provides example formulas of the NOW function. For these
examples, assume that the current date and time is October 2, 2010 at 1:46 a.m.
Field Type Formula Result
QUARTER Function
The QUARTER function returns an integer between 1 and 4, which represents the calendar quarter
in which the specified date value falls.
Important: Dates and times are converted to Coordinated Universal Time (UTC) in the
RSA Archer database. As a result, dates and times in calculations are returned in UTC.
date The date value to be evaluated in determining the calendar quarter. This parameter
should be formatted as a Date-field reference, for example, [field name].
Example:
The following table provides an example formula of the
QUARTER function.
Formula Result
QUARTER([Due Date]) 4
where the value in the Due Date field is 12/15/2010 8:00 PM.
TODAY Function
The TODAY function returns the date value for the current date. Each time a record is recalculated,
the calculated field will display an updated date.
Internally, the TODAY function returns a serial number that represents the number of whole days
that have elapsed since January 1, 1900. From the user perspective, the value returned by the
TODAY function will display differently depending on the type of field to which the value will be
returned.
Important: Dates and times are converted to Coordinated Universal Time (UTC) in the
RSA Archer database. As a result, dates and times in calculations are returned in UTC.
Return Type: Varies based upon the type of field receiving the return value. See the examples
below.
Syntax: TODAY( )
This function does not have any parameters.
Examples:
WEEKDAY Function
The WEEKDAY function returns the day of the week for the supplied date value. The return value
is the full name, not an abbreviation.
Important: Dates and times are converted to Coordinated Universal Time (UTC) in the
RSA Archer database. As a result, dates and times in calculations are returned in UTC.
date The date value to be evaluated in determining the day of the week. This parameter
should be formatted as a Date-field reference, for example, [field name].
Example:
The following table provides an example formula of the
WEEKDAY function.
Formula Result
WEEKNUMBER Function
The WEEKNUMBER function returns a number that indicates the week in which a given date falls
for a calendar year beginning on January 1.
Important: Dates and times are converted to Coordinated Universal Time (UTC) in the
RSA Archer database. As a result, dates and times in calculations are returned in UTC.
date The date value to be evaluated in determining the day of the week. This parameter
should be formatted as a Date-field reference, for example, [field name].
week_start Accepts the keyword SUNDAY or MONDAY to specify whether weeks should be
treated as beginning on Sunday or on Monday.
If no value is passed for this parameter, SUNDAY will be assumed.
Examples:
The following table provides example formulas of
WEEKNUMBER function.
Formula Result
WEEKNUMBER([Due Date]) 38
where the value in the Due Date field is 9/14/2008 (a Sunday).
YEAR Function
The YEAR function returns the year corresponding to a date.
Important: Dates and times are converted to Coordinated Universal Time (UTC) in the
RSA Archer database. As a result, dates and times in calculations are returned in UTC.
date The date of the year that you want to find. This parameter can be entered as a hard-
coded date value, for example, "1/2/2010" or as a date-field reference, for example,
[date field name].
Example:
The following table provides an example formula of the
YEAR function.
Formula Result
h Displays the hour as a one-digit or two-digit number based on a 12-hour clock format
(Example: 9)
hh Displays the hour as a two digit number (with a leading a leading zero, if necessary)
based on a 12-hour clock format (Example: 09)
H Displays the hour as a one-digit or two-digit number based on a 24-hour clock format
(Example: 13)
Date
Return Example
Element
HH Displays the hour as a two-digit number based on a 24-hour clock format (Example:
13)
t Displays the one-letter AM/PM designator appropriate for the given time, regardless of
whether the time is based on a 12-hour or 24-hour clock. (Example: 1:00 P for 12-hour
clock; 13:00 P for 24-hour clock)
tt Displays the two-letter AM/PM designator appropriate for the given time, regardless
of whether the time is based on a 12-hour or 24-hour clock. (Example: 1:00 PM for 12-
hour clock; 13:00 PM for 24-hour clock)
Financial Functions
The following financial functions execute common calculations associated with the financial
industry.
DB Function
The DB function returns the depreciation of an asset for a specified period using the fixed-declining
balance method.
Return Type: Numeric
Syntax: DB(cost,salvage,life,period,month)
In the above syntax, parameters in bold are required.
The following table describes the DB function parameters.
Parameter Description
salvage The value at the end of the depreciation (sometimes called the salvage value of the
asset).
life The number of periods over which the asset is being depreciated (sometimes called
the useful life of the asset).
period The period for which you want to calculate the depreciation. Period must use the
same units as life.
Parameter Description
month The number of months in the first year. If month is omitted, it is assumed to be 12.
Examples:
The following table provides example formulas of the DB function.
Formula Result
Formula Result
DDB Function
The DDB function returns the depreciation of an asset for a specified period using the double-
declining balance method or some other method that you specify. The double-declining balance
method computes depreciation at an accelerated rate. Depreciation is highest in the first period and
decreases in successive periods. DDB uses the following formula to calculate depreciation for a
period:
Min( (cost - total depreciation from prior periods) * (factor/life), (cost - salvage - total depreciation
from prior periods) )
Use the VDB function to switch to the straight-line depreciation method when depreciation is
greater than the declining balance calculation.
Return Type: Numeric. The results are rounded to two decimal places.
Syntax: DDB(cost,salvage,life,period,factor)
In the above syntax, parameters in bold are required.
salvage The value at the end of the depreciation (sometimes called the salvage value of the
asset). This value can be 0. Must be a positive number.
life The number of periods over which the asset is being depreciated (sometimes called
the useful life of the asset). Must be a positive number.
period The period for which you want to calculate the depreciation. Period must use the
same units as life. Must be a positive number.
factor The rate at which the balance declines. If factor is omitted, it is assumed to be 2
(the double-declining balance method). Change factor if you do not want to use the
double-declining balance method. Must be a positive number.
Examples:
The following table provides example formulas of the DDB function.
Formula Result
Formula Result
FV Function
The FV function returns the future value of an investment based on periodic, constant payments and
a constant interest rate.
Return Type: Numeric
Syntax: FV(rate,nper,pmt,pv,type)
In the above syntax, parameters in bold are required.
The following table describes FV function parameters.
Parameter Description
pmt The payment made each period; it cannot change over the life of the annuity.
Typically, pmt contains principal and interest but no other fees or taxes. If pmt is
omitted, you must include the pv argument.
pv The present value, or the lump-sum amount that a series of future payments is worth
right now. If pv is omitted, it is assumed to be 0 (zero), and you must include the
pmt argument.
type The number 0 or 1 and indicates when payments are due. If type is omitted, it is
assumed to be 0.
l Set type equal to 0 if payments are due at the end of the period.
l Set type equal to 1 if payments are due at the beginning of the period.
Note: Be consistent about the units that you use for specifying rate and nper. If you make monthly
payments on a four-year loan at 12 percent annual interest, use 12%/12 for rate and 4*12 for nper. If
you make annual payments on the same loan, use 12% for rate and 4 for nper.
For all of the arguments, cash you pay out, such as deposits to savings, is represented by negative
numbers; cash you receive, such as dividend checks, is represented by positive numbers.
Examples:
The following table provides example formulas of the FV function.
Formula Result
IPMT Function
The IPMT function returns the interest payment for a given period for an investment based on
periodic, constant payments, and a constant interest rate.
Return Type: Numeric
Syntax: IPMT(rate,per,nper,pv,fv,type)
In the above syntax, parameters in bold are required.
The following table describes IPMT function parameters.
Parameter Description
per The period for which you want to find the interest and must be in the range 1 to
nper.
pv The present value, or the lump-sum amount that a series of future payments is worth
right now.
For all of the arguments, cash you pay out, such as deposits to savings, is
represented by negative numbers; cash you receive, such as dividend checks, is
represented by positive numbers.
fv The future value, or a cash balance you want to attain after the last payment is
made. If fv is omitted, it is assumed to be 0 (the future value of a loan, for example,
is 0).
type The number 0 or 1 and indicates when payments are due. If type is omitted, it is
assumed to be 0.
l Set type equal to 0 if payments are due at the end of the period.
l Set type equal to 1 if payments are due at the beginning of the period.
Note: Make sure that you are consistent about the units that you use for specifying rate and nper. If
you make monthly payments on a four-year loan at 12 percent annual interest, use 12%/12 for rate
and 4*12 for nper. If you make annual payments on the same loan, use 12% for rate and 4 for nper.
Examples:
IRR Function
The IRR function returns the internal rate of return for a series of cash flows represented by the
numbers in values. These cash flows do not have to be even, as they would be for an annuity.
However, the cash flows must occur at regular intervals, such as monthly or annually. The internal
rate of return is the interest rate received for an investment consisting of payments (negative values)
and income (positive values) that occur at regular periods.
Return Type: Numeric
Syntax: IRR(values,guess)
In the above syntax, parameters in bold are required.
The following table describes IRR function parameters.
Parameter Description
values A reference (using the REF function) to fields that contain numbers for which you
want to calculate the internal rate of return. Note the following:
l Values must contain at least one positive value and one negative value to
calculate the internal rate of return.
l IRR uses the order of values to interpret the order of cash flows. Be sure to enter
your payment and income values in the sequence you want.
l If a reference field contains text, logical values, or empty cells, those values are
ignored.
Parameter Description
guess A number that you guess is close to the result of IRR. Note the following:
l Archer uses an iterative technique for calculating IRR. Starting with guess, IRR
cycles through the calculation until the result is accurate within 0.00001 percent.
If IRR cannot find a result that works after 20 tries, an error value is returned.
l In most cases you do not need to provide guess for the IRR calculation. If guess
is omitted, it is assumed to be 0.1 (10 percent).
l If the result is not close to what you expected, try again with a different value for
guess.
IRR is closely related to NPV, the net present value function. The rate of return calculated by IRR
is the interest rate corresponding to a 0 (zero) net present value. The following formula demonstrates
how NPV and IRR are related:
NPV(IRR(B1:B6),B1:B6)
equals 3.60E-08 [Within the accuracy of the IRR calculation, the value 3.60E-08 is effectively 0
(zero).]
Examples:
The following table provides example formulas of the IRR function.
Formula Result
ISPMT Function
The ISPMT function calculates the interest paid during a specific period of an investment. This
function is provided for compatibility with Lotus 1-2-3.
For additional information about financial functions, see the PV function.
Return Type: Numeric
Syntax: ISPMT(rate,per,nper,pv)
In the above syntax, parameters in bold are required.
The following table describes ISPMT function parameters.
Parameter Description
per The period for which you want to find the interest and must be in the range 1 to
nper.
pv The present value of the investment. For a loan, pv is the loan amount.
The cash that you pay out, such as deposits to savings or other withdrawals, is
represented by negative numbers; the cash that you receive, such as dividend checks
and other deposits, is represented by positive numbers.
Examples:
The following table provides example formulas of the ISPMT function.
Formula Result
MIRR Function
The MIRR function returns the modified internal rate of return for a series of periodic cash flows.
MIRR considers both the cost of the investment and the interest received on reinvestment of cash.
MIRR uses the order of values to interpret the order of cash flows. Be sure to enter your payment
and income values in the sequence that you want and with the correct signs (positive values for cash
received, negative values for cash paid).
Return Type: Numeric
Syntax: MIRR(values,finance_rate,reinvest_rate)
In the above syntax, parameters in bold are required.
The following table describes MIRR function parameters.
Parameter Description
values A reference (using the REF function) to fields that contain numbers. These numbers
represent a series of payments (negative values) and income (positive values)
occurring at regular periods. Note that:
l Values must contain at least one positive value and one negative value to
calculate the modified internal rate of return. Otherwise, MIRR returns an error
value.
l If a reference argument contains text, logical values, or empty cells, those values
are ignored; however, cells with the value zero are included.
finance_ The interest rate that you pay on the money used in the cash flows.
rate
reinvest_ The interest rate that you receive on the cash flows as you reinvest them.
rate
Example:
The following table provides an example formula of the MIRR function.
Formula Result
NPER Function
The NPER function returns the number of periods for an investment based on periodic, constant
payments and a constant interest rate.
For a more complete description of the arguments in NPER and for more information about annuity
functions, see the PV function.
pmt The payment made each period; it cannot change over the life of the annuity.
Typically, pmt contains principal and interest but no other fees or taxes.
pv The present value, or the lump-sum amount that a series of future payments is worth
right now.
fv The future value, or a cash balance that you want to attain after the last payment is
made. If fv is omitted, it is assumed to be 0 (the future value of a loan, for example,
is 0).
Examples:
The following table provides example formulas of the NPER function.
Formula Result
Formula Result
NPV Function
The NPV function calculates the net present value of an investment using a discount rate and a
series of future payments (negative values) and income (positive values).
The NPV investment begins one period before the date of the value1 cash flow and ends with the
last cash flow in the list. The NPV calculation is based on future cash flows. If your first cash flow
occurs at the beginning of the first period, the first value must be added to the NPV result, not
included in the values arguments.
NPV is similar to the PV function (present value). The primary difference between PV and NPV is
that PV allows cash flows to begin either at the end or at the beginning of the period. Unlike the
variable NPV cash flow values, PV cash flows must be constant throughout the investment. For
information about annuities and financial functions, see the PV function.
NPV is also related to the IRR function (internal rate of return). IRR is the rate for which NPV
equals zero: NPV(IRR(...), ...) = 0. See the IRR function.
Return Type: Numeric
Syntax: NPV(rate,value1,value2, ...)
In the above syntax, parameters in bold are required.
The following table describes NPV function parameters.
Parameter Description
Parameter Description
value1,value2,... 1 to 254 arguments representing the payments and income. Note that:
l Value1, value2, ... must be equally spaced in time and occur at the end of
each period.
l NPV uses the order of value1, value2, ... to interpret the order of cash flows.
Be sure to enter your payment and income values in the correct sequence.
l Arguments that are numbers, empty cells, logical values, or text
representations of numbers are counted; arguments that are error values or
text that cannot be translated into numbers are ignored.
l If an argument is a reference, only numbers in that reference are counted.
Empty cells, logical values, or text in the reference are ignored.
Examples:
The following table provides example formulas of the NPV function.
Formula Result
PMT Function
The PMT function calculates the payment for a loan based on constant payments and a constant
interest rate. The payment returned by PMT includes principal and interest but no taxes, reserve
payments, or fees sometimes associated with loans.
Note: To find the total amount paid over the duration of the loan, multiply the returned PMT value by
nper.
pv The present value, or the total amount that a series of future payments is worth now;
also known as the principal.
fv The future value, or a cash balance you want to attain after the last payment is
made. If fv is omitted, it is assumed to be 0 (zero), that is, the future value of a loan
is 0.
type The number 0 or 1 and indicates when payments are due. If type is omitted, it is
assumed to be 0.
l Set type equal to 0 or omitted if payments are due at the end of the period.
l Set type equal to 1 if payments are due at the beginning of the period.
Note: Make sure that you are consistent about the units you use for specifying rate and nper. If you
make monthly payments on a four-year loan at an annual interest rate of 12 percent, use 12%/12 for
rate and 4*12 for nper. If you make annual payments on the same loan, use 12 percent for rate and 4
for nper.
Examples:
The following table provides example formulas of the PMT function.
Formula Result
Formula Result
PPMT Function
The PPMT function returns the payment on the principal for a given period for an investment based
on periodic, constant payments and a constant interest rate.
Return Type: Numeric
Syntax: PPMT(rate,per,nper,pv,fv,type)
In the above syntax, parameters in bold are required.
The following table describes PPMT function parameters.
Parameter Description
pv The present value— the total amount that a series of future payments is worth now.
fv The future value, or a cash balance you want to attain after the last payment is
made. If fv is omitted, it is assumed to be 0 (zero), that is, the future value of a loan
is 0.
Parameter Description
type The number 0 or 1 and indicates when payments are due. If type is omitted, it is
assumed to be 0.
l Set type equal to 0 or omitted if payments are due at the end of the period.
l Set type equal to 1 if payments are due at the beginning of the period.
Note: Make sure that you are consistent about the units that you use for specifying rate and nper. If
you make monthly payments on a four-year loan at an annual interest rate of 12 percent, use 12%/12
for rate and 4*12 for nper. If you make annual payments on the same loan, use 12% for rate and 4
for nper.
Examples:
The following table provides example formulas of the PPMT function.
Formula Result
PPMT([Rate],[Period],[Number of Years of Loan], Principal payment for the last year of the
[Amount of Loan]) loan with the given terms (-27,598.05)
where the value in the Rate field is 0.08, the value
in the Period field is 10, the value in the Number of
Years of Loan field is 10, and the value in the
Amount of Loan field is 200,000.
PV Function
The PV function returns the present value of an investment. The present value is the total amount
that a series of future payments is worth now. For example, when you borrow money, the loan
amount is the present value to the lender.
Note: Make sure that you are consistent about the units you use for specifying rate and nper. If you
make monthly payments on a four-year loan at 12 percent annual interest, use 12%/12 for rate and
4*12 for nper. If you make annual payments on the same loan, use 12% for rate and 4 for nper.
An annuity is a series of constant cash payments made over a continuous period. For example, a car
loan or a mortgage is an annuity. For more information, see the description for each annuity function.
In annuity functions, cash you pay out, such as a deposit to savings, is represented by a negative
number; cash you receive, such as a dividend check, is represented by a positive number. For
example, a $1,000 deposit to the bank would be represented by the argument -1000 if you are the
depositor and by the argument 1000 if you are the bank.
Return Type: Numeric
Syntax: PV(rate,nper,pmt,fv,type)
In the above syntax, parameters in bold are required.
The following table describes PV function parameters.
Parameter Description
rate The interest rate per period. For example, if you obtain an automobile loan at a 10
percent annual interest rate and make monthly payments, your interest rate per
month is 10%/12, or 0.83%. You would enter 10%/12, or 0.83%, or 0.0083, into the
formula as the rate.
nper The total number of payment periods in an annuity. For example, if you get a four-
year car loan and make monthly payments, your loan has 4*12 (or 48) periods. You
would enter 48 into the formula for nper.
pmt The payment made each period and cannot change over the life of the annuity.
Typically, pmt includes principal and interest but no other fees or taxes. For
example, the monthly payments on a $10,000, four-year car loan at 12 percent are
$263.33. You would enter -263.33 into the formula as the pmt. If pmt is omitted, you
must include the fv argument.
Parameter Description
fv The future value, or a cash balance you want to attain after the last payment is
made. If fv is omitted, it is assumed to be 0 (the future value of a loan, for example,
is 0). For example, if you want to save $50,000 to pay for a special project in 18
years, then $50,000 is the future value. You could then make a conservative guess at
an interest rate and determine how much you must save each month. If fv is omitted,
you must include the pmt argument.
type The number 0 or 1 and indicates when payments are due. If type is omitted, it is
assumed to be 0.
l Set type equal to 0 or omitted if payments are due at the end of the period.
l Set type equal to 1 if payments are due at the beginning of the period.
Example:
The following table provides an example formula of the PV function.
Formula Result
PV([Rate],[Years Money Will Present value of an annuity with the terms above (-59,777.15).
Pay],[Payment], ,0) The result is negative because it represents money that you would
where the value in the Rate pay, an outgoing cash flow. If you are asked to pay (60,000) for
field is 0.08/12, the value in the annuity, you would determine this would not be a good
the Years Money Will Pay investment because the present value of the annuity (59,777.15) is
field is 20*12, and the value in less than what you are asked to pay.
the Payment field is 500.
Note: The interest rate is divided by 12 to get a monthly rate. The
years the money is paid out is multiplied by 12 to get the number
of payments.
RATE Function
The RATE function returns the interest rate per period of an annuity. RATE is calculated by
iteration and can have zero or more solutions. If the successive results of RATE do not converge to
within 0.0000001 after 20 iterations, RATE returns an error.
Return Type: Numeric
Syntax: RATE(nper,pmt,pv,fv,type,guess)
In the above syntax, parameters in bold are required.
Note: Make sure that you are consistent about the units you use for specifying guess
and nper. If you make monthly payments on a four-year loan at 12 percent annual
interest, use 12%/12 for guess and 4*12 for nper. If you make annual payments on
the same loan, use 12% for guess and 4 for nper.
pmt The payment made each period and cannot change over the life of the annuity.
Typically, pmt includes principal and interest but no other fees or taxes. If pmt is
omitted, you must include the fv argument.
pv The present value — the total amount that a series of future payments is worth now.
fv The future value, or a cash balance you want to attain after the last payment is
made. If fv is omitted, it is assumed to be 0 (the future value of a loan, for example,
is 0).
type The number 0 or 1 and indicates when payments are due. If type is omitted, it is
assumed to be 0.
l Set type equal to 0 or omitted if payments are due at the end of the period.
l Set type equal to 1 if payments are due at the beginning of the period.
Note: Make sure that you are consistent about the units that you use for specifying
guess and nper. If you make monthly payments on a four-year loan at 12 percent
annual interest, use 12%/12 for guess and 4*12 for nper. If you make annual
payments on the same loan, use 12% for guess and 4 for nper.
Examples:
SLN Function
The SLN function returns the straight-line depreciation of an asset for one period.
Return Type: Numeric
Syntax: SLN(cost,salvage,life)
In the above syntax, parameters in bold are required.
The following table describes SLN function parameters.
Parameter Description
salvage The value at the end of the depreciation (sometimes called the salvage value of the
asset).
life The number of periods over which the asset is depreciated (sometimes called the
useful life of the asset).
Example:
The following table provides an example formula of the SLN function.
Formula Result
SYD Function
The SYD function returns the sum-of-years' digits depreciation of an asset for a specified period.
Return Type: Numeric
Syntax: SYD(cost,salvage,life,per)
In the above syntax, parameters in bold are required.
The following table describes SYD function parameters.
Parameter Description
salvage The value at the end of the depreciation (sometimes called the salvage value of the
asset).
life The number of periods over which the asset is depreciated (sometimes called the
useful life of the asset).
per The period and must use the same units as life.
Examples:
The following table provides example formulas of the SYD function.
Formula Result
VDB Function
The VDB function returns the variable declining balance of an asset for a specified period, including
partial periods. This function uses the double-declining balance method, or another method if you
specify.
Return Type: Numeric
Syntax: VDB(cost,salvage,life,start_period,end_period,factor,no_switch)
In the above syntax, parameters in bold are required.
salvage The value at the end of the depreciation (sometimes called the salvage value of the
asset).
life The number of periods over which the asset is depreciated (sometimes called the
useful life of the asset).
start_period The starting period for which you want to calculate the depreciation.
Note: The start_period must have the same units as the life parameter.
end_period The ending period for which you want to calculate the depreciation.
Note: The end_period must have the same units as the life parameter.
factor The rate at which the balance declines. If no factor is specified, the function will
assume a value of 2 (the double-declining balance method).
Examples:
The following table provides example formulas of the VDB function.
Formula Result
Logical Functions
The following logical functions evaluate an expression and return a specific result.
AND Function
The AND function evaluates logical conditions. If all of its conditions are TRUE, the function will
return TRUE. If one or more of its conditions is FALSE, the function will return FALSE. The AND
function must be used in conjunction with an IF function.
Return Type: TRUE or FALSE
Syntax: AND(logical1, logical2,...)
In the above syntax, parameters in bold are required.
The following table describes AND function parameters.
Parameter Description
logical1, Conditions that can be evaluated to TRUE or FALSE. This condition can be written
logical2, with any comparison operator (=, <, >, <=, >=, <>). An example of how this
and so on parameter might be formatted is [Field 1]>20.
Examples:
The following table provides example formulas of the AND function.
Formula Result
IF Function
The IF function evaluates a logical condition, and if the condition is TRUE, one value is returned. If
the condition is FALSE, another value is returned. The IF function can also be nested to construct
more elaborate tests, as shown in the following example:
IF([Rating]>15,"A", IF([Rating]>10,"B", IF([Rating]>5," C")))
For more information on nesting IF functions, see the fourth example in the "Examples" section
below.
Return Type: Text, numeric, date or a Values List field selection, depending on the type of data
supplied for the value_if_true and value_if_false parameters
Syntax: IF(logical_test, value_if_true, value_if_false)
In the above syntax, parameters in bold are required.
logical_test Any condition that can be evaluated to TRUE or FALSE. This condition can be
written with any comparison operator (=, <, >, <=, >=, <>). An example of how this
parameter might be formatted is [Field 1]>20.
value_if_ The value that is returned if the logical_test parameter is TRUE. This parameter can
true be formatted as a text string, such as "High Risk", or as a Values List field
selection, such as VALUEOF("Urgent"). The parameter can also be formatted as
another formula, such as SUM([Field 1],[Field 2]).
value_if_ The value that is returned if the logical_test parameter is FALSE. This parameter
false can be formatted as a text string, such as "Low Risk", or as a Values List field
selection, such as VALUEOF("Not Urgent"). The parameter can also be formatted
as another formula, such as SUM([Field 1],[Field 3]). If this parameter is omitted
from the formula and the logical_test parameter evaluates to FALSE, the calculated
field will return empty (no value).
Examples:
The following table provides example formulas of the IF function.
Formula Result
IF([Days Since Last Virus Scan] > 1, "High risk", "Low risk") High
where the value in the Days Since Last Virus Scan field is 3. risk
Formula Result
IF([Rating] > 15, "A", IF([Rating] > 10, "B", IF([Rating] > 5, "C"))) B
where the value in the Rating field is 12.
Note: In this example of nested IF statements, the second IF statement serves as the
value_if_false parameter to the first IF statement, and the third IF statement serves as
the value_if_false parameter to the second IF statement. Because the value of the Rating
field in this example is 12, the first IF statement does not prove TRUE, so the second IF
statement is evaluated and, in this case, proves TRUE. If the value of the Rating field
were 8, the second IF statement would also prove FALSE, and the third IF statement
would be evaluated.
NOT Function
The NOT function evaluates a logical condition. If the condition is TRUE, the function returns the
value of FALSE. If the condition is FALSE, the function returns the value of TRUE. Use the NOT
function when you want to ensure that a value is not equal to one particular value.
Return Type: TRUE or FALSE
Syntax: NOT(logical_test)
In the above syntax, parameters in bold are required.
The following table describes the NOT function parameter.
Parameter Description
logical_test Any condition that can be evaluated to TRUE or FALSE. This condition can be
written with any comparison operator (=, <, >, <=, >=, <>). An example of how this
parameter might be formatted is [Field 1]>20.
Examples:
The following table provides example formulas of the NOT function.
Formula Result
OR Function
The OR function evaluates logical conditions. If any of the condition evaluates to TRUE, the
function returns the value of TRUE. If none of conditions evaluate to TRUE, the function returns the
value of FALSE.
Return Type: TRUE or FALSE
Syntax: OR(logical1, logical2,...)
In the above syntax, parameters in bold are required.
The following table describes OR function parameters.
Parameter Description
logical1, Conditions that can be evaluated to TRUE or FALSE. This condition can be written
logical2, with any comparison operator (=, <, >, <=, >=, <>). An example of how this
and so on parameter might be formatted is [Field 1]>20.
Examples:
The following table provides example formulas of the OR function.
Formula Result
Math Functions
The following math functions manipulate numeric values through a variety of options.
ABS Function
The ABS function returns the absolute value of a number. The absolute value of a number is the
distance of a number from zero.
Return Type: Numeric
Syntax: ABS(number)
In the above syntax, parameters in bold are required.
number The number for which you want to return the absolute value.
Examples:
The following table provides example formulas of the ABS function.
Formula Result
ABS(-8) 8
ACOS Function
The ACOS function returns the arccosine (inverse cosine) of an angle. The returned value is
expressed in radians.
Return Type: Numeric
Syntax: ACOS(number)
In the above syntax, parameters in bold are required.
The following table describes the ACOS function parameter.
Parameter Description
Number The cosine of the angle for which you want to determine the arccosine. The value
for this parameter must be between -1 and 1.
Examples:
The following table provides example formulas of the ACOS function.
Formula Result
ACOS(.5) 1.047198
ACOSH Function
The ACOSH function returns the inverse hyperbolic cosine of a number.
Return Type: Numeric
Syntax: ACOSH(number)
In the above syntax, parameters in bold are required.
The following table describes the ACOSH function parameter.
Parameter Description
Number The number for which you want to determine the inverse hyperbolic cosine. The
value for this parameter must be greater than or equal to 1.
Examples:
The following table provides example formulas of the
ACOSH function.
Formula Result
ACOSH(1) 0
ACOSH([Number]) 2.292432
where Number is a Numeric field with a value of 5.
ASIN Function
The ASIN function returns the arcsine (inverse sine) of an angle. The returned value is expressed in
radians.
Return Type: Numeric
Syntax: ASIN(number)
In the above syntax, parameters in bold are required.
The following table describes the ASIN function parameter.
Parameter Description
Number The sine of the angle for which you want to determine the arcsine. The value for
this parameter must be between -1 and 1.
Examples:
The following table provides example formulas of the
ASIN function.
Formula Result
ASIN(.5) .523599
ASINH Function
The ASINH function returns the inverse hyperbolic sine of a number.
Return Type: Numeric
Syntax: ASINH(number)
In the above syntax, parameters in bold are required.
The following table describes the ASINH function parameter.
Parameter Description
Number The number for which you want to determine the inverse hyperbolic sine. The value
for this parameter must be greater than or equal to 1.
Examples:
The following table provides example formulas of the
ASINH function.
Formula Result
ASINH(1) .881374
ASINH([Number]) 2.312438
where Number is a Numeric field with a value of 5.
ATAN Function
The ATAN function returns the arctangent (inverse tangent) of an angle. The returned value is
expressed in radians.
Return Type: Numeric
Syntax: ATAN(number)
In the above syntax, parameters in bold are required.
The following table describes the ATAN function parameter.
Parameter Description
Number The tangent of the angle for which you want to determine the arctangent.
Examples:
The following table provides example formulas of the ATAN function.
Formula Result
ATAN(.5) .463648
Formula Result
ATAN2 Function
The ATAN2 function returns the arctangent (inverse tangent) of a specified set of x/y coordinates.
The returned value is expressed in radians.
Return Type: Numeric
Syntax: ATAN2(x_number, y_number)
In the above syntax, parameters in bold are required.
The following table describes ATAN2 func-
tion parameters.
Parameter Description
Examples:
The following table provides example formulas of the ATAN2 function.
Formula Result
ATAN2(2,2) .785398
ATANH Function
The ATANH function returns the inverse hyperbolic tangent of a number.
Return Type: Numeric
Syntax: ATANH(number)
In the above syntax, parameters in bold are required.
Number The number for which you want to determine the inverse hyperbolic tangent. The
value for this parameter must be between -1 and 1.
Examples:
The following table provides example formulas of the
ATANH function.
Formula Result
ATANH(.5) .549306
ATANH([Number]) -.25541
where Number is a Numeric field with a value of
-.25.
CEILING Function
The CEILING function rounds a number, away from zero, to the nearest multiple of significance.
Return Type: Numeric
Syntax: CEILING(number, significance)
In the above syntax, parameters in bold are required.
The following table describes CEILING function parameters.
Parameter Description
number The number you want to round. This parameter can be formatted as a Numeric-field
reference (e.g., [field name]) or as another formula that results in a numeric value,
such as SUM([field 1],[field 2]) where field 1 and field 2 are Numeric fields.
Example:
The following table provides example formulas of the CEILING function.
Formula Result
CEILING([Score], 1) 3
where the value in the Score field is 2.5
CEILING(SUM([Risk],[Criticality]), 5) 20
where the sum of the values in the Risk and Criticality fields is 17.10
COMBIN Function
The COMBIN function returns the number of combinations for a given number of items. Use
COMBIN to determine the total possible number of groups for a given number of items.
Note: A combination is any set or subset of items, regardless of their internal order. Combinations
are distinct from permutations, for which the internal order is significant.
number_ The number of items in each combination. Numeric arguments are truncated to
chosen integers.
Example:
The following table provides an example formula of the COMBIN function.
Formula Result
COMBIN([Candidates],[Team Size]) 28
where the value in the Candidates field is 8 and the value in the Team Size field is 2.
COS Function
The COS function returns the cosine of the given angle.
Return Type: Numeric
Syntax: COS(number)
In the above syntax, parameters in bold are required.
number The angle in radians for which you want the cosine.
If the angle is in degrees, either multiply the angle by PI()/180 or use the RADIANS
function to convert the angle to radians.
Examples:
The following table provides example formulas of the
COS function.
Formula Result
COSH Function
The COSH function returns the hyperbolic cosine of a number.
Return Type: Numeric
Syntax: COSH(number)
In the above syntax, parameters in bold are required.
The following table describes the COSH function parameter.
Parameter Description
number Any real number for which you want to find the hyperbolic cosine.
Examples:
The following table provides example formulas of the COSH function.
Formula Result
DEGREES Function
The DEGREES function converts radians into degrees.
Return Type: Numeric
Syntax: DEGREES(angle)
In the above syntax, parameters in bold are required.
The following table describes the DEGREES function para-
meter.
Parameter Description
Example:
The following table provides an example for-
mula of the DEGREES function.
Formula Result
EVEN Function
The EVEN function returns the number rounded up to the nearest even integer. You can use this
function for processing items that come in twos. For example, a packing crate accepts rows of one
or two items. The crate is full when the number of items, rounded up to the nearest two, matches the
crate capacity.
Return Type: Numeric
Syntax: EVEN(number)
In the above syntax, parameters in bold are required.
The following table describes the EVEN function parameter.
Parameter Description
number The value to round. If number is non-numeric, EVEN returns an error. Regardless of
the sign of number, a value is rounded up when adjusted away from zero. If number
is an even integer, no rounding occurs.
Examples:
The following table provides example formulas of the
EVEN function.
Formula Result
Formula Result
EXP Function
The EXP function returns e raised to the power of number. The constant e equals 2.71828182845904,
the base of the natural logarithm.
Return Type: Numeric
Syntax: EXP(number)
In the above syntax, parameters in bold are required.
The following table describes the EXP function parameter.
Parameter Description
number The exponent applied to the base e. To calculate powers of other bases, use the
exponentiation operator (^). EXP is the inverse of LN, the natural logarithm of
number.
Examples:
The following table provides example formulas of the EXP function.
Formula Result
FACT Function
The FACT function returns the factorial of a number. The factorial of a number is equal to
1*2*3*...* number.
Return Type: Numeric
Syntax: FACT(number)
In the above syntax, parameters in bold are required.
The following table describes the FACT function parameter.
Parameter Description
number The non-negative number for which you want the factorial. If number is not an
integer, it is truncated.
Examples:
The following table provides example formulas
of the FACT function.
Formula Result
FLOOR Function
The FLOOR function rounds a number down toward zero, to the nearest multiple of significance.
Return Type: Numeric
Syntax: FLOOR(number, significance)
In the above syntax, parameters in bold are required.
The following table describes FLOOR function parameters.
Parameter Description
number The number that you want to round down to the nearest integer. This parameter can
be formatted as a Numeric-field reference, for example, [field name]), or as another
formula that results in a numeric value, such as SUM([field 1],[field 2]) where field
1 and field 2 are Numeric fields.
Examples:
The following table provides example formulas of the FLOOR function.
Formula Result
FLOOR([Score], 1) 2
where the value in the Score field is 2.5.
FLOOR(SUM([Risk], [Criticality]), 5) 15
where the sum of the values in the Risk and Criticality fields is 17.10.
INT Function
The INT function rounds a number down to the nearest integer.
Return Type: Numeric
Syntax: INT(number)
In the above syntax, parameters in bold are required.
The following table describes the INT function parameter.
Parameter Description
Examples:
The following table provides
example formulas of the
INT function.
Formula Result
LN Function
The LN function returns the natural logarithm of a number. Natural logarithms are based on the
constant e (2.71828182845904).
Return Type: Numeric
Syntax: LN(number)
In the above syntax, parameters in bold are required.
The following table describes the LN function parameter.
Parameter Description
number The positive real number for which you want the natural logarithm. LN is the
inverse of the EXP function.
Examples:
The following table provides example formulas of the LN function.
Formula Result
Formula Result
LOG Function
The LOG function returns the logarithm of a number to the base that you specify.
Return Type: Numeric
Syntax: LOG(number,base)
In the above syntax, parameters in bold are required.
The following table describes LOG function parameters.
Parameter Description
number The positive real number for which you want the logarithm.
Examples:
The following table provides example formulas of the
LOG function.
Formula Result
LOG10 Function
The LOG10 function returns the base-10 logarithm of a number.
Return Type: Numeric
Syntax: LOG10(number)
In the above syntax, parameters in bold are required.
The following table describes the LOG10 function parameter.
Parameter Description
number The positive real number for which you want the base-10 logarithm.
Examples:
The following table provides example formulas of the
LOG10 function.
Formula Result
MOD Function
The MOD function returns the remainder after number is divided by divisor. The result has the same
sign as divisor.
Return Type: Numeric
Syntax: MOD(number,divisor)
In the above syntax, parameters in bold are required.
The following table describes MOD function parameters.
Parameter Description
number The number for which you want to find the remainder.
Examples:
The following table provides example formulas of the MOD function.
Formula Result
MOD(3, -2) Remainder of 3/-2. The sign is the same as divisor (-1).
MOD(-3, -2) Remainder of -3/-2. The sign is the same as divisor (-1).
ODD Function
The ODD function returns number rounded up to the nearest odd integer.
Examples:
The following table provides example formulas of the
ODD function.
Formula Result
PI Function
The PI function returns the number 3.14159265358979, the mathematical constant pi, accurate to 15
digits.
Return Type: Numeric
Syntax: PI()
This function does not have any parameters.
Examples:
The following table provides example formulas of the PI function.
Formula Result
PI() Pi (3.14159265358979)
Formula Result
POWER Function
The POWER function returns the result of a number raised to a power.
Note: The "^" operator can be used instead of POWER to indicate to what power the base number is
to be raised, such as in 5^2.
Examples:
The following table provides example formulas of the POWER
function.
Formula Result
PRODUCT Function
The PRODUCT function multiplies all the numbers given as arguments and returns the product. The
PRODUCT function is useful when you need to multiply many fields together.
Return Type: Numeric
Syntax: PRODUCT(number1,number2,...)
In the above syntax, parameters in bold are required.
number2,... Additional numbers or ranges that you want to multiply, up to a maximum of 255
arguments.
Examples:
The following table provides example formulas of the PRODUCT function.
Formula Result
QUOTIENT Function
The QUOTIENT function returns the integer portion of a division by discarding the remainder.
Return Type: Numeric
Syntax: QUOTIENT(numerator, denominator)
In the above syntax, parameters in bold are required.
The following table describes QUOTIENT function parameters.
Parameter Description
Examples:
QUOTIENT (42, 5) 8
where 42 / 5 = 8.4.
RADIANS Function
The RADIANS function converts degrees to radians.
Return Type: Numeric
Syntax: RADIANS(angle)
In the above syntax, parameters in bold are required.
The following table describes the RADIANS function para-
meter.
Parameter Description
Example:
The following table provides an example formula of the RADIANS
function.
Formula Result
RAND Function
The RAND function returns an evenly distributed random real number greater than or equal to 0 and
less than 1. A new random real number is returned every time the worksheet is calculated.
RAND()*100 A random number greater than or equal to 0 but less than 100 (varies).
ROUND Function
The ROUND function rounds a number to a specified number of digits.
Return Type: Numeric
Syntax: ROUND(number, num_digits)
In the above syntax, parameters in bold are required.
The following table describes ROUND function parameters.
Parameter Description
number The number that you want to round. This parameter can be formatted as a Numeric-
field reference, for example, [field name], or as another formula that results in a
numeric value, such as SUM([field 1],[field 2]) where field 1 and field 2 are
Numeric fields.
num_digits Specifies the number of digits to which you want to round the number. If the num_
digits parameter is greater than 0 (zero), the number is rounded to the specified
number of decimal places. If the num_digits parameter is equal to 0, the number is
rounded to the nearest integer. If the num_digits parameter is less than 0, the number
is rounded to the left of the decimal point to the specified number of decimal places.
For example, if the num_digits parameter is -1 and the number is 101.5, the number
would be rounded to 100.
Note: In the case of a tie, the function rounds to the nearest even number. For
example, if the num_digits parameter is 0, 1.5 and 2.5 would both round to 2. If the
num_digits parameter is 2, 3.575 and 3.585 would both round to 3.58.
Examples:
ROUND([Score], 0) 23
where the value in the Score field is 23.357.
ROUNDDOWN Function
The ROUNDDOWN function rounds a number down, toward zero. ROUNDDOWN behaves like
ROUND, except that it always rounds a number down.
Return Type: Numeric
Syntax: ROUNDDOWN(number,num_digits)
In the above syntax, parameters in bold are required.
The following table describes ROUNDDOWN function parameters.
Parameter Description
num_digits The number of digits to which you want to round the number.
Note: If num_digits is greater than 0 (zero), the number is rounded down to the
specified number of decimal places. If num_digits is 0, the number is rounded down
to the nearest integer. If num_digits is less than 0, the number is rounded down to
the left of the decimal point.
Examples:
The following table provides example formulas of the ROUNDDOWN function.
Formula Result
Formula Result
ROUNDUP Function
The ROUNDUP function rounds a number up, away from 0 (zero). ROUNDUP behaves like
ROUND, except that it always rounds a number up.
Return Type: Numeric
Syntax: ROUNDUP(number,num_digits)
In the above syntax, parameters in bold are required.
The following table describes ROUNDUP function parameters.
Parameter Description
num_digits The number of digits to which you want to round the number.
Examples:
The following table provides example formulas of the ROUNDUP function.
Formula Result
SIGN Function
The SIGN function determines the sign of a number. If the number is positive, the function returns 1,
zero (0) if the number is 0, and -1 if the number is negative.
Examples:
The following table provides example formulas of
the SIGN function.
Formula Result
SIN Function
The SIN function returns the sine of a given angle.
Return Type: Numeric
Syntax: SIN(number)
In the above syntax, parameters in bold are required.
The following table describes the SIN function parameter.
Parameter Description
number The angle in radians for which you want the sine.
Examples:
The following table provides example formulas of the SIN
function.
Formula Result
Formula Result
SINH Function
The SINH function returns the hyperbolic sine of a number.
Return Type: Numeric
Syntax: SINH(number)
In the above syntax, parameters in bold are required.
The following table describes the
SINH function parameter.
Parameter Description
Examples:
The following table provides example formulas of
the SINH function.
Formula Result
You can use the hyperbolic sine function to approximate a cumulative probability distribution. When
a laboratory test value varies between 0 and 10 seconds. An empirical analysis of the collected
history of experiments shows that the probability of obtaining a result, x, of less than t seconds is
approximated by the following equation:
P(x<t) = 2.868 * SINH(0.0342 * t), where 0<t<10
To calculate the probability of obtaining a result of less than 1.03 seconds, substitute 1.03 for t.
The following table provides an example formula of the SINH function to calculate the probability of
obtaining a result of less than 1.03 seconds.
Formula Result
SQRT Function
The SQRT function returns a positive square root.
Return Type: Numeric
Syntax: SQRT(number)
In the above syntax, parameters in bold are required.
The following table describes the SQRT function parameter.
Parameter Description
number The number for which you want the square root.
Example:
The following table provides an
example formula of the
SQRT function.
Formula Result
SUM Function
The SUM function adds all of the numbers in the specified parameters. If the SUM function
references a multi-selection values list, it can be used with the SELECTED function to return the
sum of the numeric values for each of the currently selected items.
Return Type: Numeric
Syntax: SUM(number1, number2,...)
In the above syntax, parameters in bold are required.
number1, Parameters for which you want the total value. These parameters can be entered as
number2, hard-coded values, for example, 2, or Numeric-field references, for example, [field
name]. Referenced fields can reside within the application or within Sub-Form,
Cross-Reference, or Related Records fields.
Examples:
The following table provides example formulas of the SUM function.
Formula Result
SUM(3, [Risk]) 15
where the value in the Risk field is 12.
SUM([Risk], [Criticality]) 19
where the value in the Risk field is 12 and the value in the Criticality field is 7.
SUM(REF([Orders],[Price])) 202.94
where the value in the Price field within the Orders sub-form are 120.00, 50.19, and
32.75.
SUM(SELECTEDVALUENUMBER([Key Factors])) 25
where Key Factors is a multi-selection Values List field and the numeric values of the
current selections are 3, 8, 4, and 10.
SUMIF Function
SUMIF Function
The SUMIF function sums the values of a specified Numeric field across all records in a Sub-Form,
Cross-Reference, Related Records, or Scheduler field that contain a specific value in a given field.
For example, you can return the sum of all Price field values across all cross-referenced records in
which the Status field is set to “Shipped.”
Return Type: Numeric
Syntax: SUMIF(eval_field_ref, criterion, sum_field_ref)
In the above syntax, parameters in bold are required.
eval_field_ The reference to the field against which the criterion will be evaluated.
ref
Note: If sum_field_ref is not passed to SUMIF, eval_field_ref will also act as the
field to sum.
criterion The test that will be performed against eval_field_ref to determine whether a given
record will be qualified for the sum operation. The criterion can involve Values List,
User/Groups List, and Record Permissions fields as well as fields containing
numeric, text, and date type values.
l Values Lists. If eval_field_ref is a Values List field, enclose the criterion value
in VALUEOF or supply it as a quoted literal string, for example, "Dallas".
l User/Groups List and Record Permissions Fields. If eval_field_ref is a
User/Groups List or Record Permissions field, enclose the criterion value in
USER or GROUP (as appropriate for the criterion).
l Text, Numeric, or Date Fields. If eval_field_ref is a Text, Numeric, or Date
field, the criterion must be enclosed in quotes, for example, ">56", and the
criterion can involve any of the supported comparison operators (=, <, >, <=, >=,
<>).
Note: The evaluation will always result in no matches if there is a space between
the operator and the test value. For example, if the intent is to sum a given Numeric
field across all sub-form records where a another given field contains a numeric
value greater than 56, a space cannot appear in the formula between the ">" and the
"56"
sum_field_ The reference to a Numeric field that will be summed across all qualified records.
ref
Note: If sum_field_ref is not passed to SUMIF, eval_field_ref will also act as the
field to sum.
Examples:
Note: In this example, the sum_field_ref is not passed to SUMIF. As a result, the
system will use Sale Price for evaluation purposes and for summing.
Formula Result
SUMPRODUCT Function
The SUMPRODUCT function multiplies corresponding components in the given sets of fields, and
returns the sum of those products.
Return Type: Numeric
Syntax: SUMPRODUCT(values1,values2,values3, ...)
In the above syntax, parameters in bold are required.
The following table describes SUMPRODUCT function parameters.
Parameter Description
values1, 2 to 255 sets of values whose components you want to multiply and then add.
values2,
values3, ... Note: The respective arguments must have the same dimensions. If they do not,
SUMPRODUCT returns an error. SUMPRODUCT treats field entries that are not
numeric as if they were zeros.
Example:
The following table provides an example formula of the SUMPRODUCT function.
Formula Result
SUMSQ Function
The SUMSQ function returns the sum of the squares of the arguments.
Return Type: Numeric
Syntax: SUMSQ(number1,number2, ...)
In the above syntax, parameters in bold are required.
The following table describes SUMSQ function parameters.
Parameter Description
number1, 1 to 255 arguments for which you want the sum of the squares. You can also use a
number2, ... reference to an array instead of arguments separated by commas.
Example:
The following table provides an example formula of
the SUMSQ function.
Formula Result
SUMX2MY2 Function
The SUMX2MY2 function returns the sum of the difference of squares of corresponding values in
two sets of fields.
Return Type: Numeric
Syntax: SUMX2MY2(values_x,values_y)
In the above syntax, parameters in bold are required.
The following table describes SUMX2MY2
function parameters.
Parameter Description
Note: The arguments should be either numbers, names, or references that contain numbers. If a
reference argument contains text, logical values, or empty cells, those values are ignored; however,
fields with the value zero are included. If values_x and values_y have a different number of values,
SUMX2MY2 returns an error.
Example:
The following table provides an example formula of the SUMX2MY2 function.
Formula Result
SUMX2PY2 Function
The SUMX2PY2 function returns the sum of the sum of squares of corresponding values in two sets
of fields. The sum of the sum of squares is a common term in many statistical calculations.
Return Type: Numeric
Syntax: SUMX2PY2(values_x,values_y)
In the above syntax, parameters in bold are required.
The following table describes
SUMX2PY2 function parameters.
Parameter Description
Note: The arguments should be numbers, names, or references that contain numbers. If a reference
argument contains text, logical values, or empty cells, those values are ignored; however, fields with
the value zero are included. If values_x and values_y have a different number of values,
SUMX2PY2 returns an error.
Example:
SUMXMY2 Function
The SUMXMY2 function returns the sum of squares of differences of corresponding values in two
sets of fields.
Return Type: Numeric
Syntax: SUMXMY2(values_x,values_y)
In the above syntax, parameters in bold are required.
The following table describes
SUMXMY2 function parameters.
Parameter Description
Note: The arguments should be numbers, names, or references that contain numbers. If a reference
argument contains text, logical values, or empty cells, those values are ignored; however, fields with
the value zero are included. If values_x and values_y have a different number of values,
SUMXMY2 returns an error.
Examples:
The following table provides example formulas of the SUMXMY2 function.
Formula Result
TAN Function
The TAN function returns the tangent of the given angle.
Return Type: Numeric
Syntax: TAN(number)
In the above syntax, parameters in bold are required.
The following table describes the TAN function parameter.
Parameter Description
number The angle in radians for which you want the tangent.
Examples:
The following table provides example formulas of the
TAN function.
Formula Result
TANH Function
The TANH function returns the hyperbolic tangent of a number.
Return Type: Numeric
Syntax: TANH(number)
In the above syntax, parameters in bold are required.
The following table describes the
TANH function parameter.
Parameter Description
Examples:
TRUNC Function
The TRUNC function truncates a number to an integer by removing the fractional part of the
number.
Return Type: Numeric
Syntax: TRUNC(number, num_digits)
In the above syntax, parameters in bold are required.
The following table describes TRUNC function parameters.
Parameter Description
number The number that you want to truncate. This parameter can be formatted as a
Numeric-field reference, for example, [field name], or as another formula that
results in a numeric value, such as SUM([field 1],[field 2]) where field 1 and field 2
are Numeric fields.
num_digits Specifies the precision of the truncation. This parameter is typically omitted;
however, you can include this parameter to truncate a number at a specific decimal
place.
Examples:
The following table provides example formulas of the TRUNC function.
Formula Result
TRUNC([Score]) 3
where the value in the Score field is 3.427.
TRUNC([Score], 1) 3.4
where the value in the Score field is 3.427.
Formula Result
Statistics Functions
AVEDEV Function
The AVEDEV function returns the average deviation of a set of values from their mean.
Return Type: Numeric
Syntax: AVEDEV(number1, number2,...)
In the above syntax, parameters in bold are required.
The following table describes AVEDEV function parameters.
Parameter Description
number1, Numbers for which you want to determine the average deviation. You can format
number2, these parameters as hard-coded numeric values, for example, 30, Numeric-field
and so on references, for example, [field name], or as another formula that results in a
numeric value, such as SUM([field 1],[field 2]) where field 1 and field 2 are
Numeric fields.
Note: If a field contains no value (is empty), that value will be ignored and not
included in the final computation of the calculation. Values of 0, however, are
included in the calculation.
Examples:
AVERAGE Function
The AVERAGE function returns the average (arithmetic mean) value in a set of values.
Return Type: Numeric
Syntax: AVERAGE(number1, number2,...)
In the above syntax, parameters in bold are required.
The following table describes AVERAGE function parameters.
Parameter Description
number1, Numbers that you want to average. You can format these parameters as hard-coded
number2, numeric values, for example, 30, Numeric-field references, for example, [field
name], or as another formula that results in a numeric value, such as SUM([field 1],
[field 2]) where field 1 and field 2 are Numeric fields.
Examples:
The following table provides example formulas of the AVERAGE function.
Formula Result
AVERAGEA Function
The AVERAGEA function returns the average deviation of a set of values from their mean and
includes text representation of numbers or logical values.
Return Type: Numeric
number1, Numbers for which you want to determine the average deviation. You can format
number2, these parameters as hard-coded numeric values, for example, 30, Numeric-field
references, for example, [field name], or as another formula that results in a
numeric value, such as SUM([field 1],[field 2]) where field 1 and field 2 are
Numeric fields.
Note: If a field contains no value (is empty) that value will be ignored and not
included in the final computation of the calculation. Values of 0, however, are
included in the calculation.
Note: Fields that contain the text "TRUE" will be evaluated as "1". Fields that
contain the text "FALSE" will be evaluated as "0" (zero).
Examples:
The following table provides example formulas of the AVERAGEA function.
Formula Result
BINOMDIST Function
The BINOMDIST function returns the individual term binomial distribution probability. Use
BINOMDIST in problems with a fixed number of tests or trials, when the outcomes of any trial are
only success or failure, when trials are independent, and when the probability of success is constant
throughout the experiment. For example, BINOMDIST can calculate the probability that two of the
next three babies born are male.
Return Type: Numeric
Syntax: BINOMDIST(number_s,trials,probability_s,cumulative)
In the above syntax, parameters in bold are required.
cumulative A logical value that determines the form of the function. If cumulative is TRUE,
then BINOMDIST returns the cumulative distribution function, which is the
probability that there are at most number_s successes; if FALSE, it returns the
probability mass function, which is the probability that there are number_s
successes.
Example:
The following table provides an example formula of the BINOMDIST function.
Formula Result
CHIDIST Function
The CHIDIST function returns the one-tailed probability of the chi-squared distribution. The χ2
distribution is associated with a χ2 test. Use the χ2 test to compare observed and expected values.
For example, a genetic experiment might hypothesize that the next generation of plants will exhibit a
certain set of colors. By comparing the observed results with the expected ones, you can decide
whether your original hypothesis is valid. CHIDIST is calculated as CHIDIST = P(X>x), where X is
a χ2 random variable.
Return Type: Numeric
Syntax: CHIDIST(x,degrees_freedom)
In the above syntax, parameters in bold are required.
Example:
The following table provides an
example formula of the
CHIDIST function.
Formula Result
CHIINV Function
The CHIINV function returns the inverse of the one-tailed probability of the chi-squared distribution.
If probability = CHIDIST(x,...), then CHIINV(probability,...) = x. Use this function to compare
observed results with expected ones to decide whether your original hypothesis is valid.
Note: Given a value for probability, CHIINV seeks that value x such that CHIDIST(x, degrees_
freedom) = probability. Therefore, precision of CHIINV depends on precision of CHIDIST.
CHIINV uses an iterative search technique. If the search has not converged after 100 iterations, the
function returns the #N/A error value.
Parameter Description
Example:
The following table provides an
example formula of the CHIINV
function.
Formula Result
CONFIDENCE Function
The CONFIDENCE function returns a value that you can use to construct a confidence interval for a
population mean. The confidence interval is a range of values. Your sample mean, x, is at the center
of this range and the range is x ± CONFIDENCE. For example, if x is the sample mean of delivery
times for products ordered through the mail, x ± CONFIDENCE is a range of population means. For
any population mean, μ0, in this range, the probability of obtaining a sample mean further from μ0
than x is greater than alpha; for any population mean, μ0, not in this range, the probability of
obtaining a sample mean further from μ0 than x is less than alpha. In other words, assume that we
use x, standard_dev, and size to construct a two-tailed test at significance level alpha of the
hypothesis that the population mean is μ0. Then we will not reject that hypothesis if μ0 is in the
confidence interval and will reject that hypothesis if μ0 is not in the confidence interval. The
confidence interval does not allow us to infer that there is probability 1 – alpha that our next package
will take a delivery time that is in the confidence interval.
Return Type: Numeric
Syntax: CONFIDENCE(alpha,standard_dev,size)
In the above syntax, parameters in bold are required.
The following table describes CONFIDENCE function parameters.
Parameter Description
alpha The significance level used to compute the confidence level. The confidence level
equals 100*(1 - alpha)%, or in other words, an alpha of 0.05 indicates a 95 percent
confidence level.
Parameter Description
standard_ The population standard deviation for the data range and is assumed to be known.
dev
Note: If nonnumeric or if standard_dev ≤ 0, CONFIDENCE returns an error.
Example:
The following table provides an example formula of the CONFIDENCE function.
Formula Result
CORREL Function
The CORREL function returns the correlation coefficient of two sets of fields. Use the correlation
coefficient to determine the relationship between two properties. For example, you can examine the
relationship between the inside temperature and outside temperature of a location.
Return Type: Numeric
Syntax: CORREL(values1,values2)
In the above syntax, parameters in bold are required.
The following table describes
CORREL function parameters.
Parameter Description
Note: If a reference argument contains text, logical values or is empty, those values are ignored;
however, the value zero is included. If values1 and values2 have a different number of data points,
CORREL returns an error. If either values1 or values2 is empty, or if s (the standard deviation) of
their values equals zero, CORREL returns an error.
Example:
COUNT Function
The COUNT function counts the number of fields that contain numbers, and counts numbers within
the list of arguments. Use the COUNT function to get the number of entries in a number field that is
in a range of numbers.
Note that:
l Arguments that are numbers, dates, or a text representation of numbers, for example, a number
enclosed in quotation marks, such as "1", are counted.
l Logical values and text representations of numbers that you type directly into the list of arguments
are counted.
l Arguments that are error values or text that cannot be translated into numbers are not counted.
l If an argument is a reference, only numbers in that reference are counted. Empty fields, logical
values, text, or error values in the reference are not counted.
l To count logical values, text, or error values, use the COUNTA function.
l To count only numbers that meet certain criteria, use the COUNTIF function or the COUNTIFS
function.
value1 The first item, cell reference, or range within which you want to count numbers.
value2, ... Up to 255 additional items, cell references, or ranges within which you want to
count numbers.
Examples:
COUNT(Sales, 12/8/2008, , 19, 22.24, TRUE, Counts the number of fields that contain
#DIV/0) numbers (3)
COUNT(19, 22.24, TRUE, #DIV/0) Counts the number of fields that contain
numbers (2)
COUNTA Function
The COUNTA function returns any one of the following values:
l The number of items currently selected in a multi-select Values List or Cross-Reference field
l The number of rows (entries) present in a Sub-Form field
l The number of non-null values for a field within a sub-form across all rows in the Sub-Form field
l The number of non-null values for a given field within a cross-referenced application across all
rows (selections) in a Cross-Reference field
l The number of resources assigned in a Scheduler field configured to display the Schedule view.
Any unassigned resources are not included in the number returned.
Note: The COUNTA function is not valid for a Scheduler field configured to display the
Resource view.
Although supported, referencing a field other than a Values List, Cross-Reference, Sub-Form, or
Scheduler field with the COUNTA function is of little use because the return value will always be
either 1 or 0. (If the field has a value, 1 is returned. If the field is empty, 0 is returned.) However,
with Values List and Cross-Reference fields that are configured to allow multiple selections and
with Sub-Form fields with multiple entries, the COUNTA function counts the number of selections
or entries within those fields.
Note: To confidently count the number of rows present in a Sub-Form field, the formula must
reference the Sub-Form field itself rather than referencing a field within the sub-form. Likewise, to
count the number of rows present in a Cross-Reference field, the formula must reference that Cross-
Reference field and not a field in the related application.
Examples:
The following table provides example formulas of the COUNTA function.
Formula Result
COUNTA([Order Detail]) 12
where Order Detail is a Sub-Form field in the application and the associated sub-form
currently has 12 rows (entries).
COUNTA([Order Detail]) 0
where Order Detail is a Sub-Form field in the application and the associated sub-form
currently has no (0) rows.
COUNTA([Affected Departments]) 8
where Affected Departments is a Values List field in the application and 8 items are
currently selected in the list.
COUNTA([Related Projects]) 3
where Related Projects is a Cross-Reference field in the application and 3 records from
the related application are currently selected in the field.
COUNTBLANK Function
The COUNTBLANK function counts empty fields in a specified range of fields. Fields with
formulas that return "" (empty text) are also counted. Fields with zero values are not counted.
Return Type: Numeric
Syntax: COUNTBLANK(field_ref)
In the above syntax, parameters in bold are required.
The following table describes the COUNTBLANK function parameter.
Parameter Description
field_ref The range from which you want to count the blank fields.
Example:
The following table provides an example formula of the COUNTBLANK function.
Formula Result
COUNTBLANK([Range]) 4
where the values in the Range field are empty, 6, empty, 4, empty, =IF(1>0,"",""), 27,
and 34.
COUNTIF Function
The COUNTIF function counts the number of records in a Sub-Form, Cross-Reference, Related
Records, or Scheduler field that contain a specific value in a given field. For example, you can count
the number of cross-referenced records that have the value of "Open" in the Status field.
Return Type: Numeric
Syntax: COUNTIF(field_ref, criterion)
In the above syntax, parameters in bold are required.
The following table describes COUNTIF function parameters.
Parameter Description
field_ref The reference to the field that is contained within a Sub-Form, Cross-Reference,
Related Records, or Scheduler field.
Parameter Description
criterion The test that will be performed against the referenced child field to determine
whether that field’s values will be included in the count. The criterion can involve
Values List, User/Groups List, and Record Permissions fields as well as fields
containing numeric, text, and date type values.
l Values List Fields. If COUNTIF is being performed against a Values List field,
the criterion value should be enclosed in VALUEOF or supplied as a quoted
literal string, for example, "Dallas").
l User/Groups List and Record Permissions Fields. If COUNTIF is being
performed against a User/Groups List or Record Permissions field, the criterion
value should be enclosed in USER or GROUP (as appropriate for the criterion).
l Text, Date, or Numeric Fields. If COUNTIF is being performed against a Text,
Date, or Numeric field, the criterion must be enclosed in quotes, for example,
">56", and the criterion can involve any of the supported comparison operators
(=, <, >, <=, >=, <>).
Note: The COUNTIF function always returns zero (0) matches if there is a
space between the operator and the test value. For example, if the intent is to
count the number of sub-form records where a given field contains a numeric
value greater than 56, a space cannot appear in the formula between the ">" and
the "56".
Examples:
The following table provides example formulas of the COUNTIF function.
Formula Result
Formula Result
COVAR Function
The COVAR function returns covariance, the average of the products of deviations for each data
point pair. Use covariance to determine the relationship between two data sets. For example, you
can examine whether greater income accompanies greater levels of education.
Return Type: Numeric
Note: The arguments must either be numbers or be names or references that contain numbers. If a
reference argument contains text, logical values or empty fields, those values are ignored; however,
fields with the value zero are included. If values1 and values2 have different numbers of data points,
COVAR returns an error. If either set is empty, COVAR returns an error.
Example:
The following table provides an example formula of the COVAR function.
Formula Result
CRITBINOM Function
The CRITBINOM function returns the smallest value for which the cumulative binomial distribution
is greater than or equal to a criterion value. Use this function for quality assurance applications. For
example, use CRITBINOM to determine the greatest number of defective parts that are allowed to
come off an assembly line run without rejecting the entire lot.
Return Type: Numeric
Syntax: CRITBINOM(trials,probability_s,alpha)
In the above syntax, parameters in bold are required.
Example:
The following table provides an example formula of the CRITBINOM function.
Formula Result
DEVSQ Function
The DEVSQ function returns the sum of squares of deviations of data points from their sample
mean.
Return Type: Numeric
Syntax: DEVSQ(number1, number2,...)
In the above syntax, parameters in bold are required.
number1, 1 to 255 arguments for which you want to calculate the sum of squared deviations.
number2,... You can also use a reference to a set of fields instead of arguments separated by
commas. Arguments can either be numbers or names, or references that contain
numbers. Logical values and text representations of numbers that you type directly
into the list of arguments are counted. If a reference argument contains text, logical
values, or empty cells, those values are ignored; however, fields with the value zero
are included. Arguments that are error values or text that cannot be translated into
numbers cause errors.
Example:
The following table provides an example formula of the DEVSQ function.
Formula Result
EXPONDIST Function
The EXPONDIST function returns the exponential distribution. Use EXPONDIST to model the time
between events, such as how long an automated bank teller takes to deliver cash. For example, you
can use EXPONDIST to determine the probability that the process takes at most 1 minute.
Return Type: Numeric
Syntax: EXPONDIST(x,lambda,cumulative)
In the above syntax, parameters in bold are required.
The following table describes EXPONDIST function parameters.
Parameter Description
Parameter Description
cumulative A logical value that indicates which form of the exponential function to provide. If
cumulative is TRUE, EXPONDIST returns the cumulative distribution function; if
FALSE, it returns the probability density function.
Examples:
The following table provides example formulas of the EXPONDIST function.
Formula Result
FDIST Function
The FDIST function returns the F probability distribution. You can use this function to determine
whether two data sets have different degrees of diversity. For example, you can examine the test
scores of men and women entering high school and determine if the variability in the females is
different from that found in the males. FDIST is calculated as FDIST=P( F>x ), where F is a random
variable that has an F distribution with degrees_freedom1 and degrees_freedom2 degrees of
freedom.
Return Type: Numeric
Syntax: FDIST(x,degrees_freedom1,degrees_freedom2)
In the above syntax, parameters in bold are required.
The following table describes FDIST function parameters.
Parameter Description
Parameter Description
Example:
The following table provides an example formula of the FDIST function.
Formula Result
FINV Function
The FINV function returns inverse of the F probability distribution. If p = FDIST(x,...), then FINV
(p,...) = x.
The F distribution can be used in an F-test that compares the degree of variability in two data sets.
For example, you can analyze income distributions in the United States and Canada to determine
whether the two countries have a similar degree of income diversity.
FINV can be used to return critical values from the F distribution. For example, the output of an
ANOVA calculation often includes data for the F statistic, F probability, and F critical value at the
0.05 significance level. To return the critical value of F, use the significance level as the probability
argument to FINV.
Given a value for probability, FINV seeks that value x such that FDIST(x, degrees_freedom1,
degrees_freedom2) = probability. Thus, precision of FINV depends on precision of FDIST. FINV
uses an iterative search technique. If the search has not converged after 100 iterations, the function
returns the #N/A error value.
Return Type: Numeric
Syntax: FINV(probability,degrees_freedom1,degrees_freedom2)
Example:
The following table provides an example formula of the FINV function.
Formula Result
FISHER Function
The FISHER function returns the Fisher transformation at x. This transformation produces a function
that is normally distributed rather than skewed. Use this function to perform hypothesis testing on the
correlation coefficient.
Return Type: Numeric
Syntax: FISHER(x)
In the above syntax, parameters in bold are required.
Example:
The following table provides an example formula of the
FISHER function.
Formula Result
FISHERINV Function
The FISHERINV function returns the inverse of the Fisher transformation. Use this transformation
when analyzing correlations between ranges or sets of fields. If y = FISHER(x), then FISHERINV
(y) = x.
Return Type: Numeric
Syntax: FISHERINV(y)
In the above syntax, parameters in bold are required.
The following table describes the FISHERINV function parameter.
Parameter Description
y The value for which you want to perform the inverse of the transformation.
Example:
The following table provides an example formula of the
FISHERINV function.
Formula Result
FORECAST Function
The FORECAST function calculates, or predicts, a future value using existing values. The predicted
value is a y-value for a given x-value. The known values are existing x-values and y-values, and the
new value is predicted using linear regression. You can use this function to predict future sales,
Note: If known_y's and known_x's are empty or contain a different number of data
points, FORECAST returns an error.
Example:
The following table provides an example formula of the FORECAST function.
Formula Result
GAMMADIST Function
The GAMMADIST function returns the gamma distribution. You can use this function to study
variables that may have a skewed distribution. The gamma distribution is commonly used in queuing
analysis.
Return Type: Numeric
Syntax: GAMMADIST(x,alpha,beta,cumulative)
In the above syntax, parameters in bold are required.
cumulative A logical value that determines the form of the function. If cumulative is TRUE,
GAMMADIST returns the cumulative distribution function; if FALSE, it returns the
probability density function.
Note: For a positive integer n, when alpha = n/2, beta = 2, and cumulative = TRUE,
GAMMADIST returns (1 - CHIDIST(x)) with n degrees of freedom.
Examples:
The following table provides example formulas of the GAMMADIST function.
Formula Result
GAMMAINV Function
The GAMMAINV function returns the gamma cumulative distribution. If p = GAMMADIST(x,...),
then GAMMAINV(p,...) = x.
Return Type: Numeric
Syntax: GAMMAINV(probability,alpha,beta)
In the above syntax, parameters in bold are required.
The following table describes GAMMAINV function parameters.
Parameter Description
Note: If any argument is text, GAMMAINV returns the #VALUE! error value.
Given a value for probability, GAMMAINV seeks that value x such that GAMMADIST(x, alpha,
beta, TRUE) = probability. Therefore, precision of GAMMAINV depends on precision of
GAMMADIST. GAMMAINV uses an iterative search technique. If the search has not converged
after 100 iterations, the function returns an error.
Example:
The following table provides an example formula of the GAMMAINV function.
Formula Result
GAMMALN Function
The GAMMALN function returns the natural logarithm of the gamma function, Γ(x).
Return Type: Numeric
Syntax: GAMMALN(x)
Example:
The following table provides an example formula of the
GAMMALN function.
Formula Result
GEOMEAN Function
The GEOMEAN function returns the geometric mean of a set of positive data. For example, you can
use GEOMEAN to calculate average growth rate given compound interest with variable rates.
Return Type: Numeric
Syntax: GEOMEAN(number1,number2,...)
In the above syntax, parameters in bold are required.
The following table describes GEOMEAN function parameters.
Parameter Description
number1, 1 to 255 arguments for which you want to calculate the mean.
number2,...
Note: Arguments can be numbers, names, or references that contain numbers.
Logical values and text representations of numbers that you type directly into the list
of arguments are counted. If a reference argument contains text, logical values, or
empty fields, those values are ignored; however, fields with the value zero are
included. Arguments that are error values or text that cannot be translated into
numbers cause errors. If any data point ≤ 0, GEOMEAN returns an error.
Example:
HARMEAN Function
The HARMEAN function returns the harmonic mean of a data set. The harmonic mean is the
reciprocal of the arithmetic mean of reciprocals.
Return Type: Numeric
Syntax: HARMEAN(number1, number2,...)
In the above syntax, parameters in bold are required.
The following table describes HARMEAN function parameters.
Parameter Description
number1, 1 to 255 arguments for which you want to calculate the mean.
number2,...
Note: The harmonic mean is always less than the geometric mean, which is always
less than the arithmetic mean. Arguments can either be numbers, names, or
references that contain numbers. Logical values and text representations of numbers
that you type directly into the list of arguments are counted. If a reference argument
contains text, logical values, or empty fields, those values are ignored; however,
fields with the value zero are included. Arguments that are error values or text that
cannot be translated into numbers cause errors. If any data point ≤ 0, HARMEAN
returns an error.
Example:
The following table provides an example formula of the HARMEAN function.
Formula Result
HYPGEOMDIST Function
The HYPGEOMDIST function returns the hypergeometric distribution. HYPGEOMDIST returns
the probability of a given number of sample successes, given the sample size, population successes,
and population size. Use HYPGEOMDIST for problems with a finite population, where each
observation is either a success or a failure, and where each subset of a given size is chosen with
equal likelihood.
Return Type: Numeric
Syntax: HYPGEOMDIST(sample_s,number_sample,population_s,number_population)
In the above syntax, parameters in bold are required.
The following table describes HYPGEOMDIST function parameters.
Parameter Description
Note: All arguments are truncated to integers. If any argument is nonnumeric, HYPGEOMDIST
returns an error.
Example:
The following table provides an example formula of the HYPGEOMDIST function.
Formula Result
INTERCEPT Function
The INTERCEPT function calculates the point at which a line will intersect the y-axis by using
existing x-values and y-values. The intercept point is based on a best-fit regression line plotted
through the known x-values and known y-values. Use the INTERCEPT function when you want to
determine the value of the dependent variable when the independent variable is 0 (zero). For
example, you can use the INTERCEPT function to predict a metal's electrical resistance at 0° C
when your data points were taken at room temperature and higher.
Return Type: Numeric
Syntax: INTERCEPT(known_y's,known_x's)
In the above syntax, parameters in bold are required.
The following table describes INTERCEPT function parameters.
Parameter Description
Note: The arguments must be either numbers, names, or references that contain numbers. If a
reference argument contains text, logical values, or empty fields, those values are ignored; however,
fields with the value zero are included.
The underlying algorithm used in the INTERCEPT and SLOPE functions is different than the
underlying algorithm used in the LINEST function. The difference between these algorithms can
lead to different results when data is undetermined and collinear. For example, if the data points of
the known_y's argument are 0 and the data points of the known_x's argument are 1:
l INTERCEPT and SLOPE return an error. The INTERCEPT and SLOPE algorithm is designed to
look for one and only one answer, and in this case there can be more than one answer.
l LINEST returns a value of 0. The LINEST algorithm is designed to return reasonable results for
collinear data, and in this case at least one answer can be found.
Example:
The following table provides an example formula of the INTERCEPT function.
Formula Result
INTERCEPT(REF([Data Set],[Y Axis]),REF([Data Set], Point at which a line will intersect the
[X Axis])) y-axis by using the x-values and y-
where Data Set is a cross-reference field, the values in values given (0.0483871)
the Y Axis field are 2, 3, 9, 1, and 8, and the values in the
X Axis field are 6, 5, 11, 7, and 5.
KURT Function
The KURT function returns the kurtosis of a data set. Kurtosis characterizes the relative peakedness
or flatness of a distribution compared with the normal distribution. Positive kurtosis indicates a
relatively peaked distribution. Negative kurtosis indicates a relatively flat distribution.
Return Type: Numeric
Syntax: KURT(number1,number2,...)
In the above syntax, parameters in bold are required.
The following table describes KURT function parameters.
Parameter Description
number1, 1 to 255 arguments for which you want to calculate kurtosis. Arguments can either
number2,... be numbers, names, or references that contain numbers. Logical values and text
representations of numbers that you type directly into the list of arguments are
counted. If a reference argument contains text, logical values, or empty cells, those
values are ignored; however, fields with the value zero are included. Arguments that
are error values or text that cannot be translated into numbers cause errors.
Note: If there are fewer than four data points, or if the standard deviation of the
sample equals zero, KURT returns an error.
Example:
The following table provides an example formula of the KURT function.
Formula Result
LARGE Function
The LARGE function returns the k-th largest value in a data set. You can use this function to select
a value based on its relative standing. For example, you can use LARGE to return the highest,
runner-up, or third-place score.
Return Type: Numeric
Syntax: LARGE(values,k)
In the above syntax, parameters in bold are required.
The following table describes LARGE function parameters.
Parameter Description
values The set of fields for which you want to determine the k-th largest value.
Note: If n is the number of data points in a range, then LARGE(values,1) returns the largest value,
and LARGE(values,n) returns the smallest value.
Examples:
The following table provides example formulas of the LARGE function.
Formula Result
Formula Result
LOGINV Function
The LOGINV function returns the inverse of the lognormal cumulative distribution function of x,
where ln(x) is normally distributed with parameters mean and standard_dev. If p =
LOGNORMDIST(x,...) then LOGINV(p,...) = x. Use the lognormal distribution to analyze
logarithmically transformed data.
Return Type: Numeric
Syntax: LOGINV(probability,mean,standard_dev)
In the above syntax, parameters in bold are required.
The following table describes LOGINV function parameters.
Parameter Description
Example:
The following table provides an example formula of the LOGINV function.
Formula Result
LOGINV Inverse of the lognormal cumulative distribution function for the terms
(0.039084,3.5,1.2) given (4.000014)
LOGNORMDIST Function
The LOGNORMDIST function returns the cumulative lognormal distribution of x, where ln(x) is
normally distributed with parameters mean and standard_dev. Use this function to analyze data that
has been logarithmically transformed.
Return Type: Numeric
Syntax: LOGNORMDIST(x,mean,standard_dev)
In the above syntax, parameters in bold are required.
The following table describes LOGNORMDIST function parameters.
Parameter Description
Example:
The following table provides an example formula of the LOGNORMDIST function.
Formula Result
MAX Function
The MAX function returns the largest value in a set of values.
Return Type: Numeric
Syntax: MAX(value1, value2,...)
In the above syntax, parameters in bold are required.
value1, Values for which you want to find a maximum value. Only Numeric and Date fields
value2, can be evaluated.
Note: When evaluating a Date field, MAX will return a serial number that
represents the largest date (furthest from January 1, 1900); the function will not
return a date string.
Examples:
The following table provides example formulas of the MAX function.
Formula Result
MAXA Function
The MAXA function returns the largest value in a list of arguments. Unlike the MAX function, the
MAXA function is not restricted to working with only Date and Numeric fields.
Return Type: Numeric
Syntax: MAXA(value1, value2,...)
In the above syntax, parameters in bold are required.
value1, 1 to 255 values for which you want to find the largest value. Note that:
value2,... l Arguments can be the following: numbers; names or references that contain
numbers; text representations of numbers; or logical values, such as TRUE and
FALSE, in a reference.
l Logical values and text representations of numbers that you type directly into the
list of arguments are counted.
l If an argument is a reference, only values in that reference are used. Empty
fields and text values in the reference are ignored.
l Arguments that are error values or text that cannot be translated into numbers
cause errors.
l Arguments that contain TRUE evaluate as 1; arguments that contain text or
FALSE evaluate as 0 (zero).
l If the arguments contain no values, MAXA returns 0 (zero).
l If you do not want to include logical values and text representations of numbers in
a reference as part of the calculation, use the MAX function.
Example:
The following table provides an example formula of the MAXA function.
Formula Result
MEDIAN Function
The MEDIAN function returns the median of the given numbers. The median is the number in the
middle of a set of numbers.
Return Type: Numeric
Syntax: MEDIAN(number1, number2,...)
In the above syntax, parameters in bold are required.
number1, 1 to 255 numbers for which you want the median. Note that:
number2,... l If there is an even number of numbers in the set, MEDIAN calculates the
average of the two numbers in the middle. See the second formula in the
example.
l Arguments can be numbers, names or references that contain numbers.
l Logical values and text representations of numbers that you type directly into the
list of arguments are counted.
l If a reference argument contains text, logical values, or empty fields, those
values are ignored; however, fields with the value zero are included.
l Arguments that are error values or text that cannot be translated into numbers
cause errors.
The MEDIAN function measures central tendency, which is the location of the
center of a group of numbers in a statistical distribution. The three most common
measures of central tendency are:
l Average. The arithmetic mean, and is calculated by adding a group of numbers
and then dividing by the count of those numbers. For example, the average of 2,
3, 3, 5, 7, and 10 is 30 divided by 6, which is 5.
l Median. The middle number of a group of numbers; that is, half the numbers
have values that are greater than the median, and half the numbers have values
that are less than the median. For example, the median of 2, 3, 3, 5, 7, and 10 is
4.
l Mode. The most frequently occurring number in a group of numbers. For
example, the mode of 2, 3, 3, 5, 7, and 10 is 3.
Examples:
MIN Function
The MIN function returns the smallest value in a set of values.
Return Type: Numeric
Syntax: MIN(value1, value2,...)
In the above syntax, parameters in bold are required.
The following table describes MIN function parameters.
Parameter Description
value1, Values for which you want to find a minimum value. Only Numeric and Date fields
value2, can be evaluated.
Note: When evaluating a Date field, MIN will return a serial number that
represents the smallest date (closest to January 1, 1900); the function will not return
a date string.
Examples:
The following table provides example formulas of the MIN function.
Formula Result
MINA Function
The MINA function returns the smallest value in the list of arguments.
Return Type: Numeric
Syntax: MINA(value1, value2,...)
In the above syntax, parameters in bold are required.
The following table describes MINA function parameters.
Parameter Description
value1, 1 to 255 values for which you want to find the smallest value. Note that:
value2,... l Arguments can be numbers; names or references that contain numbers; text
representations of numbers; or logical values, such as TRUE and FALSE, in a
reference.
l If an argument is a reference, only values in that reference are used. Empty
fields and text values in the reference are ignored.
l Arguments that contain TRUE evaluate as 1; arguments that contain text or
FALSE evaluate as 0 (zero).
l Arguments that are error values or text that cannot be translated into numbers
cause errors.
l If the arguments contain no values, MINA returns 0.
l If you do not want to include logical values and text representations of numbers in
a reference as part of the calculation, use the MIN function.
Example:
The following table provides an example formula of the MINA function.
Formula Result
MODE Function
The MODE function returns the most frequently occurring, or repetitive, value in a set of data.
Return Type: Numeric
Syntax: MODE(number1,number2,...)
In the above syntax, parameters in bold are required.
number1, 1 to 255 arguments for which you want to calculate the mode.
number2,... Arguments can be numbers, names, or references that contain numbers.
If a reference argument contains text, logical values, or empty fields, those values
are ignored; however, fields with the value zero are included.
Arguments that are error values or text that cannot be translated into numbers cause
errors.
If the data set contains no duplicate data points, MODE returns an error.
The MODE function measures central tendency, which is the location of the center
of a group of numbers in a statistical distribution. The three most common measures
of central tendency are:
l Average. The arithmetic mean, and is calculated by adding a group of numbers
and then dividing by the count of those numbers. For example, the average of 2,
3, 3, 5, 7, and 10 is 30 divided by 6, which is 5.
l Median. The middle number of a group of numbers; that is, half the numbers
have values that are greater than the median, and half the numbers have values
that are less than the median. For example, the median of 2, 3, 3, 5, 7, and 10 is
4.
l Mode. The most frequently occurring number in a group of numbers. For
example, the mode of 2, 3, 3, 5, 7, and 10 is 3.
Example:
The following table provides an example formula of the MODE function.
Formula Result
NEGBINOMDIST Function
The NEGBINOMDIST function returns the negative binomial distribution. NEGBINOMDIST
returns the probability that there will be number_f failures before the number_s-th success, when the
constant probability of a success is probability_s. This function is similar to the binomial distribution,
except that the number of successes is fixed, and the number of trials is variable. Like the binomial,
trials are assumed to be independent.
For example, you need to find 10 people with excellent reflexes, and you know the probability that a
candidate has these qualifications is 0.3. NEGBINOMDIST calculates the probability that you will
interview a certain number of unqualified candidates before finding all 10 qualified candidates.
Return Type: Numeric
Syntax: NEGBINOMDIST(number_f,number_s,probability_s)
In the above syntax, parameters in bold are required.
The following table describes NEGBINOMDIST function parameters.
Parameter Description
Example:
The following table provides an example formula of the NEGBINOMDIST function.
Formula Result
NORMDIST Function
The NORMDIST function returns the normal distribution for the specified mean and standard
deviation. This function has a very wide range of applications in statistics, including hypothesis
testing.
Return Type: Numeric
Syntax: NORMDIST(x,mean,standard_dev,cumulative)
cumulative A logical value that determines the form of the function. If cumulative is TRUE,
NORMDIST returns the cumulative distribution function; if FALSE, it returns the
probability mass function.
Note: When cumulative = TRUE, the formula is the integral from negative infinity
to x of the given formula. If mean = 0, standard_dev = 1, and cumulative = TRUE,
NORMDIST returns the standard normal distribution, NORMSDIST.
Examples:
The following table provides example formulas of the NORMDIST function.
Formula Result
NORMINV Function
The NORMINV function returns the inverse of the normal cumulative distribution for the specified
mean and standard deviation.
Given a value for probability, NORMINV seeks that value x such that NORMDIST(x, mean,
standard_dev, TRUE) = probability. Thus, precision of NORMINV depends on precision of
NORMDIST. NORMINV uses an iterative search technique. If the search has not converged after
100 iterations, the function returns the #N/A error value.
Note: If probability < 0 or if probability > 1, NORMINV returns the #NUM! error
value. If any argument is nonnumeric, NORMINV returns the #VALUE! error
value.
Example:
The following table provides an example formula of the NORMINV function.
Formula Result
NORMINV Inverse of the normal cumulative distribution for the terms given
(0.908789,40,1.5) (42)
PEARSON Function
The PEARSON function returns the Pearson product moment correlation coefficient, r, a
dimensionless index that ranges from -1.0 to 1.0 inclusive and reflects the extent of a linear
relationship between two data sets.
Return Type: Numeric
Syntax: PEARSON(values1,values2)
In the above syntax, parameters in bold are required.
Note: The arguments must be numbers, names or references that contain numbers.
If a reference argument contains text, logical values, or empty fields, those values
are ignored; however, fields with the value zero are included. If values1 and values2
are empty or have a different number of data points, PEARSON returns an error.
Note: The arguments must be numbers, names or references that contain numbers.
If a reference argument contains text, logical values, or empty fields, those values
are ignored; however, fields with the value zero are included. If values1 and values2
are empty or have a different number of data points, PEARSON returns an error.
Example:
The following table provides an example formula of the PEARSON function.
Formula Result
PERCENTILE Function
The PERCENTILE function returns the k-th percentile of values in a range. You can use this
function to establish a threshold of acceptance. For example, you can decide to examine candidates
who score above the 90th percentile.
Return Type: Numeric
Syntax: PERCENTILE(values,k)
In the above syntax, parameters in bold are required.
Note: If the set is empty or contains more than 8,191 data points, PERCENTILE
returns an error.
Example:
The following table provides an example formula of the PERCENTILE function.
Formula Result
PERCENTRANK Function
The PERCENTRANK function returns the rank of a value in a data set as a percentage of the data
set. This function can be used to evaluate the relative standing of a value within a data set. For
example, you can use PERCENTRANK to evaluate the standing of an aptitude test score among all
scores for the test.
Return Type: Numeric
Syntax: PERCENTRANK(values,x,significance)
In the above syntax, parameters in bold are required.
The following table describes PERCENTRANK function parameters.
Parameter Description
values The reference to a set of fields with numeric values that defines relative standing.
Parameter Description
Note: If x does not match one of the values in the field, PERCENTRANK
interpolates to return the correct percentage rank.
significance An optional value that identifies the number of significant digits for the returned
percentage value. If omitted, PERCENTRANK uses three digits (0.xxx).
Examples:
The following table provides example formulas of the PERCENTRANK function.
Formula Result
PERMUT Function
The PERMUT function returns the number of permutations for a given number of objects that can be
selected from number objects. A permutation is any set or subset of objects or events where internal
order is significant. Permutations are different from combinations, for which the internal order is not
significant. Use this function for lottery-style probability calculations.
Return Type: Numeric
Syntax: PERMUT(number,number_chosen)
In the above syntax, parameters in bold are required.
The following table describes PERMUT function parameters.
Parameter Description
Example:
You want to calculate the odds of selecting a winning lottery number. Each lottery number contains
three numbers, each of which can be between 0 (zero) and 99, inclusive.
The following table provides an example formula of the PERMUT func-
tion. The function calculates the number of possible permutations.
Formula Result
POISSON Function
The POISSON function returns the Poisson distribution. A common application of the Poisson
distribution is predicting the number of events over a specific time, such as the number of cars
arriving at a toll plaza in 1 minute.
Return Type: Numeric
Syntax: POISSON(x,mean,cumulative)
In the above syntax, parameters in bold are required.
cumulative A logical value that determines the form of the probability distribution returned. If
cumulative is TRUE, POISSON returns the cumulative Poisson probability that the
number of random events occurring will be between zero and x inclusive; if FALSE,
it returns the Poisson probability mass function that the number of events occurring
will be exactly x.
Examples:
The following table provides example formulas of the POISSON function.
Formula Result
POISSON(2,5,FALSE) Poisson probability mass function with the terms given (0.084224)
PROB Function
The PROB function returns the probability that values in a range are between two limits. If upper_
limit is not supplied, returns the probability that values in x_range are equal to lower_limit.
Return Type: Numeric
Syntax: PROB(x_range,prob_range,lower_limit,upper_limit)
In the above syntax, parameters in bold are required.
The following table describes PROB function parameters.
Parameter Description
x_range The range of numeric values of x with which there are associated probabilities.
Note: If x_range and prob_range contain a different number of data points, PROB
returns an error.
Parameter Description
lower_limit The lower bound on the value for which you want a probability.
upper_limit The optional upper bound on the value for which you want a probability.
Examples:
The following table provides example formulas of the PROB function.
Formula Result
QUARTILE Function
The QUARTILE function returns the quartile of a data set. Quartiles often are used in sales and
survey data to divide populations into groups. For example, you can use QUARTILE to find the top
25 percent of incomes in a population.
Return Type: Numeric
Syntax: QUARTILE(range,quart)
In the above syntax, parameters in bold are required.
range The reference to a range of numeric values for which you want the quartile value.
Example:
The following table provides an example formula of the QUARTILE function.
Formula Result
RANK Function
The RANK function returns the rank of a number in a list of numbers. The rank of a number is its
size relative to other values in a list. (If you were to sort the list, the rank of the number would be its
position.)
RANK gives duplicate numbers the same rank. However, the presence of duplicate numbers affects
the ranks of subsequent numbers. For example, in a list of integers sorted in ascending order, if the
number 10 appears twice and has a rank of 5, then 11 would have a rank of 7 (no number would have
a rank of 6).
For some purposes, you might want to use a definition of rank that takes ties into account. In the
previous example, you would want a revised rank of 5.5 for the number 10. This can be done by
adding the following correction factor to the value returned by RANK. This correction factor is
appropriate both for the case where rank is computed in descending order (order = 0 or omitted) or
ascending order (order = nonzero value).
Correction factor for tied ranks = [COUNT(ref) + 1 – RANK(number, ref, 0) – RANK(number, ref,
1)] / 2.
Return Type: Numeric
Syntax: RANK(number,values,order)
In the above syntax, parameters in bold are required.
The following table describes RANK function parameters.
Parameter Description
Examples:
The following table provides example formulas of the RANK function.
Formula Result
RSQ Function
The RSQ function returns the square of the Pearson product moment correlation coefficient through
data points in known_y's and known_x's. For more information, see the PEARSON function. The r-
squared value can be interpreted as the proportion of the variance in y attributable to the variance in
x. Note that:
l Arguments can either be numbers, names, or references that contain numbers.
l Logical values and text representations of numbers that you type directly into the list of arguments
are counted.
l If a reference argument contains text, logical values, or empty fields, those values are ignored;
however, fields with the value zero are included.
l Arguments that are error values or text that cannot be translated into numbers cause errors.
Note: If known_y's and known_x's are empty or have a different number of data points, RSQ returns
an error. If known_y's and known_x's contain only 1 data point, RSQ returns an error.
Example:
The following table provides an example formula of the RSQ function.
Formula Result
SKEW Function
The SKEW function returns the skewness of a distribution. Skewness characterizes the degree of
asymmetry of a distribution around its mean. Positive skewness indicates a distribution with an
asymmetric tail extending toward more positive values. Negative skewness indicates a distribution
with an asymmetric tail extending toward more negative values.
Return Type: Numeric
Syntax: SKEW(number1,number2,...)
In the above syntax, parameters in bold are required.
The following table describes SKEW function parameters.
Parameter Description
Example:
The following table provides an example formula of the SKEW function.
Formula Result
SLOPE Function
The SLOPE function returns the slope of the linear regression line through data points in known_y's
and known_x's. The slope is the vertical distance divided by the horizontal distance between any two
points on the line, which is the rate of change along the regression line.
The underlying algorithm used in the SLOPE and INTERCEPT functions is different than the
underlying algorithm used in the LINEST function. The difference between these algorithms can
lead to different results when data is undetermined and collinear. For example, if the data points of
the known_y's argument are 0 and the data points of the known_x's argument are 1, then:
l SLOPE and INTERCEPT return errors. The SLOPE and INTERCEPT algorithm is designed to
look for one and only one answer, and in this case there can be more than one answer.
l LINEST returns a value of 0. The LINEST algorithm is designed to return reasonable results for
collinear data, and in this case at least one answer can be found.
Note: The arguments must be numbers, names, or references that contain numbers. If a reference
argument contains text, logical values, or empty fields, those values are ignored; however, fields
with the value zero are included. If known_y's and known_x's are empty or have a different number
of data points, SLOPE returns an error.
Example:
The following table provides an example formula of the SLOPE function.
Formula Result
SMALL Function
The SMALL function returns the k-th smallest value in a data set. Use this function to return values
with a particular relative standing in a data set. If n is the number of data points in the values field,
SMALL(values,1) equals the smallest value and SMALL(values,n) equals the largest value.
Return Type: Numeric
Syntax: SMALL(values,k)
In the above syntax, parameters in bold are required.
values A set of numeric data for which you want to determine the k-th smallest value.
Examples:
The following table provides example formulas of the SMALL function.
Formula Result
STANDARDIZE Function
The STANDARDIZE function returns a normalized value from a distribution characterized by mean
and standard_dev.
Return Type: Numeric
Syntax: STANDARDIZE(x,mean,standard_dev)
In the above syntax, parameters in bold are required.
The following table describes STANDARDIZE function
parameters.
Parameter Description
Example:
STDEV Function
The STDEV function estimates standard deviation based on a sample. The standard deviation is a
measure of how widely values are dispersed from the average value (the mean).
STDEV assumes that its arguments are a sample of the population. If your data represents the entire
population, compute the standard deviation using STDEVP.
The standard deviation is calculated using the "n-1" method. To include logical values and text
representations of numbers in a reference as part of the calculation, use the STDEVA function.
Return Type: Numeric
Syntax: STDEV(number1,number2,...)
In the above syntax, parameters in bold are required.
The following table describes STDEV function parameters.
Parameter Description
number1, 1 to 255 number arguments corresponding to a sample of a population. You can also
number2,... use a reference to a set of fields instead of arguments separated by commas.
Example:
10 tools stamped from the same machine during a production run are collected as a random sample
and measured for breaking strength.
The following table provides an example formula of the STDEV function.
Formula Result
STDEVA Function
The STDEVA function estimates standard deviation based on a sample. The standard deviation is a
measure of how widely values are dispersed from the average value (the mean). The standard
deviation is calculated using the "n-1" method.
STDEVA assumes that its arguments are a sample of the population. If your data represents the
entire population, you must compute the standard deviation using STDEVPA.
If you do not want to include logical values and text representations of numbers in a reference as
part of the calculation, use the STDEV function.
Return Type: Numeric
Syntax: STDEVA(value1,value2,...)
In the above syntax, parameters in bold are required.
The following table describes STDEVA function parameters.
Parameter Description
value1, 1 to 255 values corresponding to a sample of a population. You can also use a
value2,... reference to a set of fields instead of arguments separated by commas.
Note: Arguments can be the following: numbers; names, or references that contain
numbers; text representations of numbers; or logical values, such as TRUE and
FALSE, in a reference. Arguments that contain TRUE evaluate as 1; arguments that
contain text or FALSE evaluate as 0 (zero). If an argument is a reference, only
values in that reference are used. Empty cells and text values in the reference are
ignored. Arguments that are error values or text that cannot be translated into
numbers cause errors.
Example:
10 tools stamped from the same machine during a production run are collected as a random sample
and measured for breaking strength.
The following table provides an example formula of the STDEVA function.
Formula Result
STDEVP Function
The STDEVP function calculates standard deviation based on the entire population given as
arguments. The standard deviation is a measure of how widely values are dispersed from the
average value (the mean).
STDEVP assumes that its arguments are the entire population. If your data represents a sample of
the population, compute the standard deviation using STDEV.
For large sample sizes, STDEV and STDEVP return approximately equal values.
The standard deviation is calculated using the "n" method.
To include logical values and text representations of numbers in a reference as part of the
calculation, use the STDEVPA function.
Return Type: Numeric
Syntax: STDEVP(number1,number2,...)
In the above syntax, parameters in bold are required.
The following table describes STDEVP function parameters.
Parameter Description
number1, 1 to 255 number arguments corresponding to a population. You can also use a
number2,... reference to a set of fields instead of arguments separated by commas.
Example:
10 tools stamped from the same machine during a production run are collected as a random sample
and measured for breaking strength.
The following table provides an example formula of the STDEVP function.
Formula Result
STDEVPA Function
The STDEVP function calculates standard deviation based on the entire population given as
arguments. The standard deviation is a measure of how widely values are dispersed from the
number1, 1 to 255 number arguments corresponding to a population. You can also use a
number2,... reference to a set of fields instead of arguments separated by commas.
Example:
10 tools stamped from the same machine during a production run are collected as a random sample
and measured for breaking strength.
The following table provides an example formula of the STDEVP function.
Formula Result
STEYX Function
The STEYX function returns the standard error of the predicted y-value for each x in the regression.
The standard error is a measure of the amount of error in the prediction of y for an individual x.
Note: Arguments can be numbers, names or references that contain numbers. Logical values and
text representations of numbers that you type directly into the list of arguments are counted. If a
reference argument contains text, logical values, or empty fields, those values are ignored; however,
fields with the value zero are included. Arguments that are error values or text that cannot be
translated into numbers cause errors. If known_y's and known_x's have a different number of data
points, STEYX returns an error. If known_y's and known_x's are empty or have less than three data
points, STEYX returns an error.
Example:
The following table provides an example formula of the STEYX function.
Formula Result
SUM Function
The SUM function adds all of the numbers in the specified parameters. If the SUM function
references a multi-selection values list, it can be used with the SELECTED function to return the
sum of the numeric values for each of the currently selected items.
Return Type: Numeric
Syntax: SUM(number1, number2,...)
In the above syntax, parameters in bold are required.
number1, Parameters for which you want the total value. These parameters can be entered as
number2, hard-coded values, for example, 2, or Numeric-field references, for example, [field
name]. Referenced fields can reside within the application or within Sub-Form,
Cross-Reference, or Related Records fields.
Examples:
The following table provides example formulas of the SUM function.
Formula Result
SUM(3, [Risk]) 15
where the value in the Risk field is 12.
SUM([Risk], [Criticality]) 19
where the value in the Risk field is 12 and the value in the Criticality field is 7.
SUM(REF([Orders],[Price])) 202.94
where the value in the Price field within the Orders sub-form are 120.00, 50.19, and
32.75.
SUM(SELECTEDVALUENUMBER([Key Factors])) 25
where Key Factors is a multi-selection Values List field and the numeric values of the
current selections are 3, 8, 4, and 10.
SUMIF Function
The SUMIF function sums the values of a specified Numeric field across all records in a Sub-Form,
Cross-Reference, Related Records, or Scheduler field that contain a specific value in a given field.
For example, you can return the sum of all Price field values across all cross-referenced records in
which the Status field is set to “Shipped.”
Return Type: Numeric
Syntax: SUMIF(eval_field_ref, criterion, sum_field_ref)
In the above syntax, parameters in bold are required.
eval_field_ The reference to the field against which the criterion will be evaluated.
ref
Note: If sum_field_ref is not passed to SUMIF, eval_field_ref will also act as the
field to sum.
criterion The test that will be performed against eval_field_ref to determine whether a given
record will be qualified for the sum operation. The criterion can involve Values List,
User/Groups List, and Record Permissions fields as well as fields containing
numeric, text, and date type values.
l Values Lists. If eval_field_ref is a Values List field, enclose the criterion value
in VALUEOF or supply it as a quoted literal string, for example, "Dallas".
l User/Groups List and Record Permissions Fields. If eval_field_ref is a
User/Groups List or Record Permissions field, enclose the criterion value in
USER or GROUP (as appropriate for the criterion).
l Text, Numeric, or Date Fields. If eval_field_ref is a Text, Numeric, or Date
field, the criterion must be enclosed in quotes, for example, ">56", and the
criterion can involve any of the supported comparison operators (=, <, >, <=, >=,
<>).
Note: The evaluation will always result in no matches if there is a space between
the operator and the test value. For example, if the intent is to sum a given Numeric
field across all sub-form records where a another given field contains a numeric
value greater than 56, a space cannot appear in the formula between the ">" and the
"56"
sum_field_ The reference to a Numeric field that will be summed across all qualified records.
ref
Note: If sum_field_ref is not passed to SUMIF, eval_field_ref will also act as the
field to sum.
Examples:
Note: In this example, the sum_field_ref is not passed to SUMIF. As a result, the
system will use Sale Price for evaluation purposes and for summing.
Formula Result
SUMPRODUCT Function
The SUMPRODUCT function multiplies corresponding components in the given sets of fields, and
returns the sum of those products.
Return Type: Numeric
Syntax: SUMPRODUCT(values1,values2,values3, ...)
In the above syntax, parameters in bold are required.
The following table describes SUMPRODUCT function parameters.
Parameter Description
values1, 2 to 255 sets of values whose components you want to multiply and then add.
values2,
values3, ... Note: The respective arguments must have the same dimensions. If they do not,
SUMPRODUCT returns an error. SUMPRODUCT treats field entries that are not
numeric as if they were zeros.
Example:
The following table provides an example formula of the SUMPRODUCT function.
Formula Result
SUMSQ Function
The SUMSQ function returns the sum of the squares of the arguments.
Return Type: Numeric
Syntax: SUMSQ(number1,number2, ...)
In the above syntax, parameters in bold are required.
The following table describes SUMSQ function parameters.
Parameter Description
number1, 1 to 255 arguments for which you want the sum of the squares. You can also use a
number2, ... reference to an array instead of arguments separated by commas.
Example:
The following table provides an example formula of
the SUMSQ function.
Formula Result
SUMX2PY2 Function
The SUMX2PY2 function returns the sum of the sum of squares of corresponding values in two sets
of fields. The sum of the sum of squares is a common term in many statistical calculations.
Return Type: Numeric
Syntax: SUMX2PY2(values_x,values_y)
In the above syntax, parameters in bold are required.
The following table describes
SUMX2PY2 function parameters.
Parameter Description
Note: The arguments should be numbers, names, or references that contain numbers. If a reference
argument contains text, logical values, or empty cells, those values are ignored; however, fields with
the value zero are included. If values_x and values_y have a different number of values,
SUMX2PY2 returns an error.
Example:
The following table provides an example formula of the SUMX2PY2 function.
Formula Result
SUMXMY2 Function
The SUMXMY2 function returns the sum of squares of differences of corresponding values in two
sets of fields.
Return Type: Numeric
Syntax: SUMXMY2(values_x,values_y)
In the above syntax, parameters in bold are required.
The following table describes
SUMXMY2 function parameters.
Parameter Description
Note: The arguments should be numbers, names, or references that contain numbers. If a reference
argument contains text, logical values, or empty cells, those values are ignored; however, fields with
the value zero are included. If values_x and values_y have a different number of values,
SUMXMY2 returns an error.
Examples:
TRIMMEAN Function
The TRIMMEAN function returns the mean of the interior of a set of data. The value is derived by
determining the mean of a series of values and excluding a percentage of the top and bottom values
from the data set. This function can be used to eliminate outliers when determining the mean.
Return Type: Numeric
Syntax: TRIMMEAN(values,percent)
In the above syntax, parameters in bold are required.
The following table describes TRIMMEAN function parameters.
Parameter Description
percent This is the percent of data points to exclude when determining the mean. For
example, if the percent parameter is .2 and the number of values in the data series is
100, 20 data points will be excluded when determining the mean (100 x .2 = 20).
Within the excluded data points for this example, the calculation will exclude the 10
highest values and the 10 lowest values.
Note: This function rounds the number of excluded data points down to the nearest
multiple of 2. For example, if the percent is .1 and the number of data points is 30,
the number of excluded data points should be 3. However, since this returns an odd
number, TRIMMEAN will round this number down to 2 and exclude the highest
value and the lowest value in the data series.
Example:
TRIMMEAN(REF([Facilities],[Risk 69
Rating]), .2) The values 45 and 92 were thrown out (since 20%
where Facilities is a cross-reference field of the values were to be excluded) and the function
and the values in the Risk Rating field are found the mean of the remaining values.
35, 50, 52, 60, 68, 75, 79, 82, 86, and 100.
VAR Function
The VAR function estimates the variance based on a sample of numbers. This function can compute
the variance for up to 255 different values.
Return Type: Numeric
Syntax: VAR(number1, number2,...)
In the above syntax, parameters in bold are required.
The following table describes VAR function parameters.
Parameter Description
number1, Parameters for which you want to find the variance. These parameters can be
number2, ... entered as hard-coded values, for example, 2, or Numeric-field references, for
example, [field name]. Referenced fields can reside within the application or within
Sub-Form, Cross-Reference, or Related Records fields.
Note: This function assumes the numbers represent a sample from the overall
population. If your data set represents the entire population, you must compute the
variance using VARP.
Example:
The following table provides an example formula of the VAR function.
Formula Result
VARA Function
The VARA function estimates the variance based on a sample of numbers, text, or logical values
(TRUE or FALSE).
value1, Parameters for which you want to find the variance. These parameters can be
value2, entered as hard-coded values, for example, 2, or field references, for example,
[field name]. Referenced fields can reside within the application or within Sub-
Form, Cross-Reference, or Related Records fields. If logical values (TRUE or
FALSE) are used, they are evaluated as 1 and 0, respectively.
Note: This function assumes the numbers represents a sample from the overall
population. If your data set represents the entire population, you must compute the
variance using VARPA.
Example:
The following table provides an example formula of the VARA function.
Formula Result
VARP Function
The VARP function estimates the variance based on the entire population. This function can
compute the variance for up to 255 different values.
Return Type: Numeric
Syntax: VARP(number1, number2,...)
In the above syntax, parameters in bold are required.
number1, Parameters for which you want to find the variance. These parameters can be
number2, ... entered as hard-coded values, for example, 2, or Numeric-field references, for
example, [field name]. Referenced fields can reside within the application or within
Sub-Form, Cross-Reference, or Related Records fields.
Note: This function assumes that the numbers represent the entire population. If
your data set represents a sample population, you must compute the variance using
VAR.
Example:
The following table provides an example formula of the VARP function.
Formula Result
VARPA Function
The VARPA function estimates the variance based on a total population of numbers, text or logical
values (TRUE or FALSE).
Return Type: Numeric
Syntax: VARPA(value1, value2,...)
In the above syntax, parameters in bold are required.
The following table describes VARPA function parameters.
Parameter Description
value1, Parameters for which you want to find the variance. These parameters can be
value2, ... entered as hard-coded values, for example, 2, or field references, for example,
[field name]. Referenced fields can reside within the application or within Sub-
Form, Cross-Reference, or Related Records fields. If logical values (TRUE or
FALSE) are used, they are evaluated as 1 and 0, respectively.
Note: This function assumes the numbers represent the entire population. If your
data set represents a sample population, you must compute the variance using
VARA.
Example:
WEIBULL Function
The WEIBULL function returns the Weibull distribution. You can use this distribution in reliability
analysis.
Return Type: Numeric
Syntax: WEIBULL(x,alpha,beta,cumulative)
In the above syntax, parameters in bold are required.
The following table describes WEIBULL function parameters.
Parameter Description
cumulative A logical value that indicates which form of the function to provide. If cumulative is
TRUE, WEIBULL returns the cumulative distribution function; if FALSE, it returns
the probability density function.
Examples:
The following table provides example for-
mulas of the WEIBULL function.
Formula Result
WEIBULL(210,40,200,TRUE) .999124
WEIBULL(210,40,200,FALSE) .001175
ZTEST Function
The ZTEST function returns the one-tailed probability value of a z-test. The function returns the
probability that the sample mean would be greater than the average of observations in the data set.
Return Type: Numeric
Syntax: ZTEST(values,test,sigma)
In the above syntax, parameters in bold are required.
The following table describes ZTEST function parameters.
Parameter Description
Note: If a reference argument contains text, logical values, or empty fields, those
values are ignored; however, fields with the value zero are included.
sigma The population standard deviation. If this value is not provided, the sample standard
deviation is used.
Example:
The following table provides an example formula of the ZTEST function.
Formula Result
System Functions
The following system functions work with variables specific to RSA Archer and options to produce
dynamic results.
COMBINESELECTIONS Function
The COMBINESELECTIONS function merges the Selected Values of all the Values List fields
included in a function for one or more applications.
Important: The calculated Values List field must contain all of the Values List Values of the
referenced Values Lists in order for all of the Selected Values to be shown. Also, the function
performs a case-insensitive string comparison of the Selected Values, so it is possible that the
Values List fields referenced in the function may refer to different Values Lists.
values_ Additional values lists, up to a maximum of 255 items. The values list fields must be
listfield2 separated by commas.
Example:
The following table provides an example formula of the COMBINESELECTIONS function.
Formula Result
COMBINESELECTIONS(REF([AppB],[Colors])) Red
Green
where the colors values list contains Red and Green in one related record and Green and
Blue in another related record of the cross-referenced application. Blue
CONTAINS Function
The CONTAINS function is used to determine if any value within a list of values matches the value
stored in a given field. If one of the values matches the field value, the function evaluates to TRUE
and one value is returned. If there is no match between the list of values and the field value, the
function evaluates to FALSE and another value is returned. The CONTAINS function must be used
in conjunction with an IF function.
Although done infrequently, the CONTAINS function may be used to test whether the string value of
a given Text field is equal to any one of a list of given string values. When a Text field is targeted,
the string value in the field will be compared to the given test strings. Matching will be based on
complete strings only. The function will not find a match based on a substring. For example, if the
target Text field contains the value “Confiscated laptop”, CONTAINS will not find a match for a
test string of “laptop”.
Return Type: TRUE or FALSE
Syntax: IF(CONTAINS(eval_type, field_ref, value1, value2...),value_if_true,value_if_false)
In the above syntax, parameters in bold are required.
Note: When targeting a Text field, CONTAINS will return TRUE if one or more of
the supplied test strings match the string value of the Text field. The behavior of
EXACT and ALL is the same when targeting a text field. When using EXACT or
ALL against a Text field, only one test string should be specified because a Text
field can have only one value.
field_ref A reference to a field, for example, [field name].The reference must be a Values
List, User/Groups List, Record Permissions, or Text field.
Parameter Description
Note: When referencing multiple fields to obtain test values, all fields must be of
the same type and that type must match the type of the target field. When
referencing a User/Groups List or Record Permissions field to obtain test values,
the field reference must be wrapped in either the GETUSERS or GETGROUPS
function to provide the proper context for retrieving the selections. Selections in
User/Groups List and Record Permissions fields will be returned as IDs, while
selections in a Values List field will be returned as strings.
l A combination of both literal values and field references. At runtime, the system
will extract the list of selections for any referenced field and, conceptually,
marry those selections to the literal values provided to form a single list of
selections to test against the target field.
Examples:
The following table provides examples of the CONTAINS function.
Formula Result
CONTENTID Function
The CONTENTID function returns a content record ID that uniquely identifies the current record
within the context of the current application or sub-form. Content IDs are generated sequentially,
beginning with the number 1.
[Type Code] & "-" & TRACKINGID( ) & "-" & CONTENTID( ) WORM-
where the value in the Type Code field is WORM, the system-wide tracking ID is 678904-34
678904 and the application-specific tracking ID is 34.
GETGROUPS Function
The GETGROUPS function returns a list of group IDs for the groups currently selected in a
specified User/Groups List or Record Permissions field. The list of group IDs can then be evaluated
by another function. For example, GETGROUPS might be used inside a CONTAINS function to
determine whether a given group is contained in the list of groups retrieved from a specified
User/Groups List field.
Return Type: Numeric
Syntax: GETGROUPS(field_ref)
In the above syntax, parameters in bold are required.
The following table describes the GETGROUPS function para-
meter.
Parameter Description
Examples:
The following table provides example formulas of the GETGROUPS function.
Formula Result
Formula Result
To evaluate both user and group selections, two ISEMPTY functions can be wrapped
in an AND function, as shown above.
GETUSERS Function
The GETUSERS function returns a single user ID for a user currently selected in a specified
User/Groups List or Record Permissions field. The user ID can then be evaluated by another
function. For example, GETUSERS might be used inside a CONTAINS function to determine
whether a given user matches the ID of a user returned from a specified User/Groups List field.
Important: To ensure that this function returns no more than one user ID, you must set the
Maximum Selections option in the Configuration section for a User/Groups List field or a Record
Permissions field to 1. Otherwise, the GETUSERS function returns an error.
Examples:
The following table provides example formulas of the GETUSERS function.
Formula Result
In this example, ISEMPTY is only evaluating the Associate field for user
selections, not group selections. In this example, ISEMPTY would have returned
true if no users were selected but one or more groups were selected.
To evaluate both user and group selections, two ISEMPTY functions can be
wrapped in an AND function, as shown above.
GROUP Function
The GROUP function is used to maintain the validity of a formula reference to a specific group
selection in a User/Groups List or Record Permissions field, even if the group name is changed
later.
The GROUP function also directly accepts system-assigned group ID numbers. Each group in the
system has an internal ID number that is guaranteed to be unique. For example, if two groups both
named Support exist in the system, the group name cannot be resolved to determine whether the
intended Support is selected in the given User/Groups List or Record Permissions field. However, a
system ID (for example, 48761) can be used in place of the ambiguous group name to uniquely
identify the correct Support group.
Return Type: Text or Numeric, depending on the format selected for the ref_type parameter
Syntax: GROUP(ref_type, value1, value2…)
In the above syntax, parameters in bold are required.
The following table describes GROUP function parameters.
Parameter Description
ref_type Accepts the keyword NAME or ID. If NAME is specified, the function will inspect
field selections by literal group name, for example, "Support". If ID is specified, the
function will inspect group selections based on unique system-assigned ID numbers.
Parameter Description
If the NAME string contains at least one @ sign, the system will assume that all
text following the last @ sign is a domain reference and the system will attempt to
locate that domain. If the NAME string does not contain a @ sign, the system will
look for an exact match for the entire group name string in the Archer (NULL)
domain and the default domain.
Note: The system will attempt to match the domain name against both active and
deleted (for example, soft-deleted) domains. Only active domain names must be
unique; it is possible that a deleted domain has the same name as an active domain.
If the group name string exists in more than one of the domains that have the same
name, the system will fail the formula on validation.
Examples:
ISCORRECT Function
The ISCORRECT function evaluates a Values List question and determines whether the selected
value is identified as “Correct” or “Incorrect.” Values are identified as either correct or incorrect on
the Answer tab of the Define Fields page. The function evaluates to TRUE if the selected value is
set as the “Correct” value. The function evaluates to FALSE if the selected value is not set as the
“Correct” value. The ISCORRECT function must be used in conjunction with an IF function and can
only be used against a Values List question within a questionnaire.
Return Type: Text, numeric, date or a Values List field selection, depending on the type of data
supplied for the value_if_true and value_if_false parameters.
Syntax: ISCORRECT([field_ref])
In the above syntax, parameters in bold are required.
The following table describes the ISCORRECT function parameter.
Parameter Description
field_ref A reference to the Values List question, for example, [question name].
Example:
The following table provides an example formula of the ISCORRECT function.
Formula Result
ISEMPTY Function
The ISEMPTY function is used to determine if a given field contains a value or is blank (empty).
The function evaluates to TRUE if the specified field is blank, for example, contains no value. The
function evaluates to FALSE if the specified field is not blank (contains a value). The ISEMPTY
function must be used in conjunction with an IF function.
Return Type: Text, numeric, date or a Values List field selection, depending on the type of data
supplied for the value_if_true and value_if_false parameters.
Syntax: ISEMPTY([field_ref])
In the above syntax, parameters in bold are required.
The following table describes the ISEMPTY function parameter.
Parameter Description
Examples:
The following table provides example formulas of the ISEMPTY function.
Formula Result
IF(ISEMPTY([Middle Name]), "No middle name", "Middle name is " & No middle name
[Middle Name])
where Middle Name is a Text field containing no value.
IF(ISEMPTY([Middle Name]), "No middle name", "Middle name is " & Middle name is
[Middle Name]) Douglas
where Middle Name is a Text field containing the value Douglas.
ISNUMBER Function
The ISNUMBER function checks the specified value and returns TRUE or FALSE depending on
whether it is a number. You can use this function to get information about a value before performing
a calculation or other action with it.
Return Type: TRUE or FALSE
Syntax: ISNUMBER(value)
In the above syntax, parameters in bold are required.
value The value that you want tested. The value argument can be a blank (empty cell),
error, logical value, text, number, or reference value, or a name referring to any of
these. Returns TRUE if Value refers to a number.
Note: The value arguments of the IS functions are not converted. Any numeric
values that are enclosed in double quotation marks are treated as text. For example,
in most other functions where a number is required, the text value "19" is converted
to the number 19. However, in the formula ISNUMBER("19"), "19" is not converted
from a text value to a number value, and the ISNUMBER function returns FALSE.
Example:
The following table provides an example formula of the
ISNUMBER function.
Formula Result
MOSTRECENTVALUE Function
The MOSTRECENTVALUE displays a specific value from the record that is evaluated as the
"most recent" from a list of related records. For example, if a record in the Facilities application is
related to multiple questionnaires, you could use this function to return the value of the Quantitative
Summary field from the most recently submitted questionnaire.
Return Type: Text
Syntax: MOSTRECENTVALUE(field_to_display, date_criteria_field)
In the above syntax, parameters in bold are required.
The following table describes MOSTRECENTVALUE function parameters.
Parameter Description
field_to_ This is the reference for the field value that you want to display, for example, REF
display ([Cross-Reference field name],[field name]).
date_ This is the Date field that you will use to determine which of the related records has
criteria_ the most recent value, for example, REF([Cross-Reference field name],[Date field
field name]).
Example:
NOVALUE Function
The NOVALUE function is used either to set a null value for a calculated Date, Text, or Numeric
field or to set a calculated Values List field to have no selection. The NOVALUE function is only
valid within the context of the IF function.
Note: The NOVALUE function cannot be passed to VALUEOF to clear selections from a
calculated Values List field.
IF([Rating] >=0, “Action Required”, NOVALUE( )) The calculated Text field is set
where the value of Rating is less than 6 and the calculated field to null.
is a Text field .
OTHERTEXT Function
The OTHERTEXT function returns the text a user has entered in the "Other" field for the specified
Values List field or Values List question.
Return Type: Text
Syntax: OTHERTEXT([field_ref])
In the above syntax, parameters in bold are required.
field_ref A reference to a Values List field or Values List question, for example, [question
name].
Examples:
The following table provides an example formula of the OTHERTEXT function.
Formula Result
REF Function
The REF function returns a reference to a field that is a child field to a parent Sub-Form, Cross-
Reference, Related Records, or Scheduler field. It can be used within another calculation that
requires a set of fields or values as input. REF is only valid for use with the following field types:
l Cross-Reference
l Related Records
l Sub-Form
l Scheduler
Return Type: Text, Numeric, Date, or a Values List field selection, depending on the type of data
returned from the referenced field
Syntax: REF(parent_field, child_field, data_level_name)
In the above syntax, parameters in bold are required.
The following table describes REF function parameters.
Parameter Description
parent_field The name of the Cross-Reference, Related Records, Sub-Form, or Scheduler field.
These field types are considered "parents" because they act as containers for other
fields. For example, a Sub-Form field by itself does not have any value; values can
only be derived from its child fields.
Parameter Description
data_level_ If a Cross-Reference field targets a multi-level application, the name of the level
name under which the field resides. Passing data_level_name is optional and is only
necessary when a Cross-Reference field targets a multi-level application.
For a Scheduler field, the data_level_name is required, since Scheduler fields
always target multiple levels. The Scheduler field always targets the Appointment
application and may target either the resource application or one or more parent
applications.
Examples:
The following table provides example formulas of the REF function.
Formula Result
SELECTEDVALUENUMBER Function
The SELECTEDVALUENUMBER function extracts the numeric value from the values list item
selected from a Values List field. If the Values List field allows multiple selections, this function
must be used in conjunction with an aggregate function, as the following example shows:
SUM(SELECTEDVALUENUMBER([Multi-Select Values List Field]))
In addition, if you reference a Values List field in a cross-referenced application, both the Cross-
Reference field used to form the application relationship and the Values List field in the related
application must be single-select fields in order to use the SELECTEDVALUENUMBER function
without wrapping it in an aggregate function. If either the Cross-Reference or Values List field
allows multiple selections, an aggregate function must also be used, as shown in the following
example:
AVERAGE(SELECTEDVALUENUMBER(REF([Multi-Select Cross-Ref Field], [Values List
Field])))
If no numeric value is assigned to a values list item, that value will be treated as 0. The only
exception is when the AVERAGE function is used in conjunction with the
SELECTEDVALUENUMBER function. In this case, the null value will not be used in the
calculation. Use the following values as an example:
Value A: 10
Value B: 5
Value C: no numeric value assigned
If the SUM function is used in conjunction with SELECTEDVALUENUMBER, Value C will be
treated as 0 in the calculation. If all three values were selected in the Values List field, the result of
the calculation would be 15. However, if the AVERAGE function were used and all three values
were selected in the Values List field, Value C would be ignored in the calculation since it has no
numeric value. The result would be 7.5.
Return Type: Numeric
Syntax: SELECTEDVALUENUMBER(field_ref)
In the above syntax, parameters in bold are required.
The following table describes the SELECTEDVALUENUMBER function parameter.
Parameter Description
field_ref A reference to a Values List field in the application, for example, [Risk Rating], a
field in a child sub-form, for example, [Notes].[Risk Rating], or a field in a cross-
referenced application, for example, [Vendors].[Risk Rating].
Examples:
SELECTEDVALUENUMBER([Risk Rating]) 10
where the selected value in the Risk Rating field is “High” and the numeric value
assigned to the value “High” is 10.
MAX(SELECTEDVALUENUMBER([Affected Departments])) 10
where the Affected Departments field is a multi-select Values List field, the selected
values are “Operations” and “IT,” and the associated numeric values are 7 and 10,
respectively.
TRACKINGID Function
The TRACKINGID function returns a record ID that uniquely identifies the current record across
all applications. This function could be used in conjunction with the CONTENTID function to
produce a complex ID that combines the system-wide ID, the application-specific ID, and data
pulled from other fields.
Return Type: Numeric
Syntax: TRACKINGID( )
This function does not have parameters.
Example:
The following table provides an example formula of the TRACKINGID function.
Formula Result
[Type Code] & "-" & TRACKINGID( ) & "-" & CONTENTID( ) WORM-
where the Type Code field is WORM, the system-wide tracking ID is 678904, and 678904-34
the application-specific content record ID is 34.
USER Function
The USER function maintains the validity of a formula reference to a specific user selection in a
User/Groups List or Record Permissions field, even if the user name is changed later. User
references can be passed as either as literal names or logon IDs. A logon name can optionally be
Parameter Description
Note: The system will attempt to match the domain name against both active and
deleted, for example, soft-deleted, domains. Only active domain names must be
unique; it is possible that a deleted domain has the same name as an active
domain. If the logon string exists in more than one of the domains that have the
same name, the system will fail the formula on validation.
Parameter Description
Examples:
The following table provides example formulas of the USER function.
Formula Result
USERFIRSTNAME Function
The USERFIRSTNAME function returns the first name of either the record creator or the record
editor. The creator is defined as the user who created the record (or is currently creating the record).
The editor is defined as the user who last edited the record.
Return Type: Text
Syntax: USERFIRSTNAME(user_type)
In the above syntax, parameters in bold are required.
The following table describes the USERFIRSTNAME function parameter.
Parameter Description
Examples:
The following table provides example formulas of the
USERFIRSTNAME function.
Formula Result
USERLASTNAME Function
The USERLASTNAME function returns the last name of either the record creator or the record
editor. The creator is defined as the user who created the record (or is currently creating the record).
The editor is defined as the user who last edited the record.
Return Type: Text
Syntax: USERLASTNAME(user_type)
In the above syntax, parameters in bold are required.
Examples:
The following table provides example formulas of the USERLASTNAME
function.
Formula Result
USERMIDDLENAME Function
The USERMIDDLENAME function returns the middle name of either the record creator or the
record editor. The creator is defined as the user who created the record (or is currently creating the
record). The editor is defined as the user who last edited the record.
Return Type: Text
Syntax: USERMIDDLENAME(user_type)
In the above syntax, parameters in bold are required.
The following table describes the USERMIDDLENAME function parameter.
Parameter Description
Examples:
VALUEOF Function
The VALUEOF function maintains the validity of a Values List field selection. If the text of a value
is changed in the custom or global values list by the RSA Archer administrator, this function
automatically updates the formula to use the new text for the value. For example, if the value "Blue"
is referenced in a formula with the VALUEOF function and that value is subsequently changed to
"Red" within the values list, the value reference "Blue" will automatically be changed to "Red"
within the formula.
From a user perspective, the VALUEOF function serves two additional purposes, it enables you to:
l Evaluate a Values List field for the presence of a specific value.
l Set value selections in a Values List field.
The following example shows the use of the VALUEOF function in a formula for a calculated
Values List field. The VALUEOF function is used for both the "value_if_true" and "value_if_false"
parameters within the IF function syntax.
IF([Risk Rating]>=10, VALUEOF([Criticality], "High"), VALUEOF([Criticality], "Low"))
In a record, this formula will evaluate Risk Rating, and if the value in that field is greater than or
equal to 10, the formula selects the value High in the Criticality calculated Values List field. If the
value in Risk Rating is less than 10, the formula selects the value Low in Criticality.
This second example shows the use of the VALUEOF function in a formula for a calculated Text
field. The VALUEOF function is used for the value parameter within the CONTAINS function
syntax.
IF(CONTAINS(ANY, [Location],VALUEOF([Location], "New York")),"Yes","No")
In a record, this formula produces the value "Yes" or "No" in the calculated Text field depending on
whether the value "New York" is selected in Location, which is a Values List field. If the value
"New York" is selected, the calculated Text field displays the value "Yes." If the value "New York"
is not selected, the calculated Text field displays the value "No."
Return Type: Text
Syntax: VALUEOF(field_ref, value1, value2…)
value1, A value within a Values List field. Enter the value as "value", for example,
value 2, ... "Urgent". If the Values List field allows multiple selections, multiple values can be
entered as "value1","value2","value3".
VALUEOF([Values List Name], "value1", "value2", "value3"). For example,
VALUEOF([States], "Washington", "New York", "Massachusetts")
Examples:
The following table provides example formulas of the VALUEOF function.
Formula Result
WEIGHTEDSCORE Function
The WEIGHTEDSCORE function returns the weighted score value for the values selected in a
Values List question. This function is only useful if you assigned a weight to the Values List
question and you assigned a numeric value to each of the possible answers to the question.
Using this function will execute the following calculation:
[values list selection numeric value] * [values list question weighting] = WEIGHTEDSCORE
or (for multi-select Values List questions):
SUM([values list selection numeric value1], [values list selection numeric value2]) * [values list
question weighting] = WEIGHTEDSCORE
The WEIGHTEDSCORE function can only be used within a questionnaire and can only reference a
Values List question.
Return Type: Numeric
Syntax: WEIGHTEDSCORE(field_ref)
In the above syntax, parameters in bold are required.
The following table describes the WEIGHTEDSCORE function parameter.
Parameter Description
field_ref A reference to the Values List question, for example, [question name].
Example:
The following table provides an example formula of the WEIGHTEDSCORE function.
Formula Result
WEIGHTING Function
The WEIGHTING function returns the weighting value of a Values List question. The
WEIGHTING function can only be used within a questionnaire and can only reference a Values List
question.
Return Type: Numeric
Syntax: WEIGHTING([field_ref])
In the above syntax, parameters in bold are required.
The following table describes the WEIGHTING function parameter.
Parameter Description
field_ref A reference to the Values List question, for example, [question name].
Example:
The following table provides an example formula of the WEIGHTING function.
Formula Result
Text Functions
The following text functions utilize and manipulate text strings to produce dynamic values.
CONCATENATE Function
The CONCATENATE function joins up to 255 text strings into 1 text string. The joined items can be
text, numbers, cell references, or a combination of those items. You must specify any spaces or
punctuation that you want to appear in the results as an argument that is enclosed in quotation marks.
Return Type: Text
Syntax: CONCATENATE(text1, text2, ...)
In the above syntax, parameters in bold are required.
The following table describes CONCATENATE function parameters.
Parameter Description
text2, ... Additional text items, up to a maximum of 255 items. The items must be separated
by commas.
Example:
The following table provides an example formula of the CONCATENATE function.
Formula Result
FIND Function
The FIND function searches for a specific character or text string within another text string. It
returns the number of the character at which the specific character or test string is first found. The
FIND function is case sensitive.
Return Type: Numeric
Syntax: FIND(find_text, field_ref, start_num)
In the above syntax, parameters in bold are required.
find_text The character or text string you want to find. You can format this parameter as a
hard-coded character or text string, for example, "sci", or as a Text-field reference,
for example, [field name].
start_num The character number in the field_ref parameter at which you want to start
searching for the find_text parameter. If this parameter is omitted, the search will
begin at the first character in the Text field. If this parameter is less than or equal to
0 (zero) or is greater than the number of characters in the Text field, a formula
validation error will occur.
Examples:
The following table provides example formulas of the FIND function.
Formula Result
FIND("Sci", 10 (because "Sci" begins at the tenth character in this text string)
[Subject])
where the value
in the Subject
field is "Arts and
Sciences".
FIND("s", 17 (notice that the first "s" in the Subject field value was skipped because the
[Subject], 5) start_num parameter required that the search begin at the fifth character and
where the value the "S" in the Subject field value was skipped because it does not match the
in the Subject case specified)
field is "Arts and
Sciences".
LEFT Function
The LEFT function returns the first character or characters in a text string, based on the number of
characters that you specify. LEFT is intended for use with languages that use the single-byte
character set (SBCS). LEFT always counts each character, whether single-byte or double-byte, as 1,
regardless of what the default language setting is.
Return Type: Numeric
Syntax: LEFT(text,num_chars)
In the above syntax, parameters in bold are required.
text The text string that contains the characters that you want to extract.
num_chars The number of characters that you want LEFT to extract. Note that:
l Num_chars must be greater than or equal to zero.
l If num_chars is greater than the length of text, LEFT returns all of
text.
l If num_chars is omitted, it is assumed to be 1.
Examples:
The following table provides example formulas of the LEFT function.
Formula Result
LEN Function
The LEN function returns the number of characters in the supplied string.
Return Type: Numeric
Syntax: LEN(text)
In the above syntax, parameters in bold are required.
The following table describes the LEN function parameter.
Parameter Description
text The text string to be evaluated. This parameter should be formatted as a Text-field
reference, for example, [field name].
Example:
The following table provides an example formula of the
LEN function.
Formula Result
LOWER Function
The LOWER function converts all characters in the supplied text string to lowercase. This function
does not affect non-alphabetic characters.
Return Type: Text
Syntax: LOWER(text)
In the above syntax, parameters in bold are required.
The following table describes the LOWER function parameter.
Parameter Description
text The text string to be converted to lowercase. This parameter should be formatted as
a Text-field reference, for example, [field name].
Examples:
The following table provides example formulas of the LOWER function.
Formula Result
MASKEDTEXT Function
The MASKEDTEXT function returns the string value of the referenced Text field using the mask (if
any) defined for the field. If the function references a Text field for which a mask has not been
defined, the function will return the raw value from the field.
Note: Unless a Text field reference is wrapped in MASKEDTEXT, the calculation engine will
always evaluate the raw, unformatted value of the Text field.
text_field This parameter should be formatted as a Text-field reference, for example, [field
name].
Examples:
The following table provides example formulas of the MASKEDTEXT function.
Formula Result
MASKEDTEXT([Phone]) (913)
where the raw value in the Phone field is 9137862356 and the Text field is defined to 786-2356
use a phone number mask.
NUMBERFORMAT Function
The NUMBERFORMAT function is used to "pad" zeros (0) to the left of a given numeric value
based on the count of digits specified by the number "mask." The zero padding is only applied if the
number of digits in the numeric value falls short of the number of digits specified in the mask. This
function returns a text value (string) that can be concatenated to other strings or stored directly in the
Text field.
Return Type: Text
Syntax: NUMBERFORMAT(value, value_mask)
In the above syntax, parameters in bold are required.
The following table describes the NUMBERFORMAT function parameters.
Parameter Description
value The numeric value, which can be derived through a Numeric-field reference, for
example, [field name], or through the use of a function that returns a numeric value.
Parameter Description
value_mask The mask used to format the returned text value. The value_mask parameter must be
enclosed in quotes.
The final placeholder in the value_mask parameter must always be a single pound
sign (#). The placeholders allowed for this function are:
0 = Zero placeholder
# = Value placeholder
Examples:
The following table provides example formulas of the NUMBERFORMAT function.
Formula Result
PROPER Function
The PROPER function capitalizes the first letter of each word in the supplied string, as well as the
first letter that follows any non-alphabetic character in the string. All other letters in the string are
converted to lowercase.
Return Type: Text
Syntax: PROPER(text)
In the above syntax, parameters in bold are required.
The following table describes the PROPER function parameter.
Parameter Description
text The text string to be converted to proper text format. This parameter should be
formatted as a Text-field reference, for example, [field name].
Examples:
The following table provides example formulas of the PROPER function.
Formula Result
RIGHT Function
The RIGHT function returns a specific number of characters from the right side of the string. For
example, if you specify 3 characters, the last 3 characters from the string will be returned.
Return Type: Text
Syntax: RIGHT(text, num_chars)
In the above syntax, parameters in bold are required.
The following table describes RIGHT function parameters.
Parameter Description
text The text string that contains the characters that you want to return. This parameter
should be formatted as a Text-field reference, for example, [field name].
num_chars Specifies the number of characters in the text string that you want to return. This
parameter must be greater than or equal to 0 (zero). If this parameter is negative,
the function will return an error.
Example:
STRIPHTML Function
The STRIPHTML function removes HTML tags from calculated text fields within a data feed while
the feed is taking place. There are no defined parameters for this function because it is coded only to
remove the HTML tags from text fields in the data feed.
Return Type: Text
Syntax: STRIPHTML
SUBSTRING Function
The SUBSTRING function returns a specified number of characters from a text string. When
creating a formula with this function, you specify the character position where you want to start
extracting text, and you specify the number of characters to return. For example, if you enter 1 as the
start position and 3 as the number of characters to return, you would get the substring "Mar" from a
Text field with the value "Marketing."
Return Type: Text
Syntax: SUBSTRING(text_field, start_num, num_chars)
In the above syntax, parameters in bold are required.
The following table describes SUBSTRING function parameters.
Parameter Description
text_field The text string that contains the characters that you want to return. This parameter
should be formatted as a Text-field reference, for example, [field name].
start_num Specifies the position of the first character that you want to extract from the Text
field. The first character in a string has a start number of 1. If the start number value
is less than 1 or is greater than the number of characters in the string, the calculation
will fail.
num_chars Specifies the number of characters in the Text field that you want to return. If you
specify a value that is larger than the total number of characters in the string, then
this parameter returns all characters to the end of the string.
Example:
Note: If the text string contains ampersand (&), less than (<), greater than (>), pound (#), single
quotation (') or double quotation (") characters, then the SUBSTRING function returns results
incorrectly.
TRIM Function
The TRIM function removes spaces from text strings, with the exception of single spaces between
words. A common use for the TRIM function is to remove extra spaces from data received from an
integration or data import. Often, data formatted in another system has irregular spacing. Using the
TRIM function ensures that unnecessary spaces are removed from your Archer text.
Return Type: Text
Syntax: TRIM(text)
In the above syntax, parameters in bold are required.
The following table describes the TRIM function parameter.
Parameter Description
text The text string from which you want to remove the unnecessary spaces.
Example:
The following table provides an example formula of the TRIM function.
Formula Result
UPPER Function
The UPPER function converts all characters in the supplied string to uppercase. This function does
not affect non-alphabetic characters.
Return Type: Text
Syntax: UPPER(text)
In the above syntax, parameters in bold are required.
The following table describes the UPPER function parameter.
Parameter Description
text The text string to be converted to uppercase. This parameter should be formatted as
a Text-field reference, for example, [field name].
Examples:
The following table provides example formulas of the UPPER function.
Formula Result
Arithmetic Operators
+ Addition (3 + 3)
/ Division (3 / 2)
^ Exponentiation (3 ^ 2)
* Multiplication (2 * 3)
- Subtraction (5 - 2)
Negation (-4)
In this formula, the Sample Field is not populated with the value "0" if the field is empty or null.
Instead, this formula returns TRUE when the Sample Field is empty or null.
Comparison Operators
= Equal to (3 = 3)
In this formula, the Sample Field is not populated with the value "0" if the field is empty or null.
Instead, this formula returns TRUE when the Sample Field is empty or null.
Concatenate Operator
& Concatenate, or join, two or more text strings to produce a single piece of text, for
example, "text" & "string".
Scheduling Calculations
Scheduling calculations enables you to automate predefined calculated fields in an application on a
recurring basis and run calculations on-demand.
System administrators have unrestricted access to all schedules in RSA Archer. Application owners
have unrestricted access to schedules in their applications, except for filter fields, reference fields,
or fields being updated to which they do not have access.
Schedule a calculation
1. Go to the Manage Schedule page of the application for which you want to schedule a calculation.
a. From the menu bar, click the Solution Name menu.
b. From the Solutions list, click the solution.
c. From the Applications list, click the icon next to the application name.
Note: If you have administrator access, you can also access the Manage Schedules page, which
displays all schedules in the system that you have access to. From the menu bar, click
and under Application Builder, click Schedules.
Note: Job Status Notifications are only sent if notifications have been configured for scheduled
calculations in this application. For instructions, see "Adding Admin Notifications" in the RSA
Archer Online Documentation.
5. In the Recurrences section, select the frequency, start time, start date, and time zone in which
you want to run the schedule.
6. In the Filters section, create search filters to identify only the records on which you want to
execute a calculation.
7. Click Save.
Manage schedules
1. Go to the Manage Schedule page of the application for which you want to manage a scheduled
calculation.
a. From the menu bar, click the Solution Name menu.
b. From the Solutions list, click the solution.
c. From the Applications list, click the icon next to the application name.
Note: If you have administrator access, you can also access the Manage Schedules page, which
displays all schedules in the system that you have access to. From the menu bar, click
and under Application Builder, click Schedules.
The system queues a job in the Job Engine Services queue. When the job is complete, you can
view the run report (see step 3).
Note: The progress bar reflects both number of actions as well as number of records that are
being processed. The progress bar is proportioned by number of actions, and the proportion of
an action reflects the progress of the action.
l To email a schedule, click the schedule you want to share and click .
3. (Optional) To view the schedule run details, do the following:
a. Click the Schedule Run Details tab.
b. In the Report column for the schedule you want to view, click .
The report provides information and statistics about the schedule job. If the job is still
running, you can click Refresh to load the latest results.
c. To close the report, click OK.
Recalculation Conditions
Calculated fields can be recalculated when a user is viewing or editing a record. To initiate an
immediate recalculation, a user must have update permissions to the record. When initiated from
either mode, only marked content is recalculated. Content changes may result in outstanding
calculations in a related level or application.
The recalculation can be initiated when content is changed, or for content that has a status of marked
for recalculation. All calculated fields are recalculated immediately within the current content. All
related content affected by the change is marked and queued for recalculations in an asynchronous
job. When save or apply updates calculated fields, and there are no other user changes, notifications
are not sent.
When marked content is calculated asynchronously, only the fields associated with the executed job
are calculated. Notifications are never sent. Notifications are only sent when a user saves a record.
Calculated fields are only recalculated based on changes made directly in a data feed, data import,
web API, or scheduled recalculation jobs.
these functions, any previously configured recalculation schedule are automatically disabled for
the application or sub-form.
l Fields with the As Needed option selected for recalculations are only recalculated if the value
will be changed.
l In multi-level applications, recalculation schedules are level-specific.
The following table describes other conditions that may also trigger a recalculation condition.
Trigger Description
Full All fields for all content are queued for recalculation but are not marked.
Module Calculation
Related Content When a user, job engine, data feed, or Web API makes a change to a field
that affects changes in a related module, the following occurs:
l An asynchronous job is scheduled to recalculate all affected content one
level away of the related module, for example related record in current
application or cross-referenced application in related record.
l All affected content in the related module (one level away) is marked for
recalculation.
Rule Description
Error Determines what happens when a calculation error occurs. This rule has the
Handling following options:
Display Error: The word Error is displayed as a link when a calculation error
occurs. Users with the appropriate access privileges can click the link to open the
Calculation Error page where the error is explained.
Use No Value: An empty value is saved in the field when a calculation error
occurs.
Use Specific: A specific value is saved in the field when a calculation error
occurs.
User with Read and Update permissions returns to Application A in Edit mode and
Action 2
clicks Save.
Action 1 User changes the value of Critically in Application B and clicks Save.
User with Read and Update permissions returns to Application A in View mode and
Action 2
clicks Recalculate.
2. If the application is a leveled application, in the Select Data Level section, select the data level
to recalculate.
Note: If your application is not a leveled application, this section is not available.
Note: If your application or sub-form does not contain at least one calculated field that uses the
TODAY or NOW functions, you cannot access the Recalculation Schedule dialog box.
Scheduled recalculations are necessary only if you need to evaluate content within the context of
the passage of time.
4. In the Interval field, enter the frequency, in days, for how often you want to execute a
recalculation.
For example, if you entered "7", the application recalculates every seven days.
5. In the Begin Time field, enter the time of day that you want to execute the recalculation.
6. In the Time Zone field, select the time zone to reference for determining the Begin Time value.
7. Click Save or Apply.
l Click Save to save and exit.
l Click Apply to apply the changes and continue working.
Important: All calculated fields in all records within the application, level (for leveled
applications), or sub-form will be recalculated, even fields that have been selected with the As
Needed option at the field level. This may impact system performance.
1. Go to the Calculations tab of the application, questionnaire, or sub-form that you want to update.
2. If the application is a leveled application, in the Select Data Level section, select the data level
to recalculate.
Note: If your application is not a leveled application, this section is not available.
References in Formulas
Calculated fields can be applied in any application, questionnaire, or sub-form. Design the formula
of the field to reference fields that reside within the application, a sub-form embedded in the
application, or a related application. If creating a calculated field for a sub-form, design the formula
of the field to reference fields that reside in the sub-form or in a related application.
Use the REF function to reference fields in an application, fields in related applications or
questionnaires, fields in a parent or child level, and specific values from values list fields.
The following table provides a list of field types that can be referenced in
an application or questionnaire.
l Cross-Reference l Related
l Date (with or without time information) Records
The following table provides a list of Field types that can be referenced in
a sub-form.
l Cross-Reference l Record
l Date (with or without time information) Status
When you reference a field from a related application or questionnaire in a formula, the field
reference displays as follows: REF([Cross-Reference Field Name], [Field Name]).
The calculation engine also allows you to reference fields from leveled applications. When you
reference a field from a related leveled application in a formula, the field reference displays as
follows: REF([Cross-Reference Field Name], [Field Name], [Data Level Name]).
Reference fields are particularly handy for calculations that require a set of values, rather than a
single value, as input. In this case, reference a cross-reference field that points to a field that
contains several values as input. For example, the LARGE function returns the k-th largest value in
a data set. The syntax, LARGE(values,k), requires a set of values as input.
Example: Formula using a REF statement that points to a cross reference field:
LARGE(REF([Data Set],[Values]),3)
In this example, Data Set is a cross-reference field and the records in the Values field are 3, 5, 3, 5,
4, 4, 2, 4, 6 and 7. This calculation returns the third largest value in the data set provided, which is 5.
The following table describes an example scenario of a cross-referenced field updated by a user.
Calculated field is [Total Risk] in Application A. [Risk] is a cross-referenced field.
[Controls] is a level in the cross-reference multi-level application and [Severity Rating]
Scenario is a field in the Controls data level.
User with Read and Update permissions returns to Application A in Edit mode and
Action 2
clicks Save.
This formula, created for a calculated field in the parent Vendors level of a two-level application,
references the Risk Rating field in the child Assessments level. The formula produces a numeric
value showing the average Risk Rating in all Assessment records associated with a parent-level
Vendors record.
To reference a values list value in a formula, use the VALUEOF function and surround the value
name in quotes.
IF(CONTAINS(EXACT, VALUEOF([Risk Rating], "High")),"Yes","No")
This formula examines the Risk Rating field, which is a values list field, for the presence of the
value "High." If the formula finds this value, it populates the calculated field with "Yes." If not, it
populates with "No."
In addition to monitoring a values list field for the presence of a specific value, the VALUEOF
function enables you to set a values list field selection dynamically based on other conditions within
the record.
Example: Dependent on value in a values list
The following table provides an example formula of the VALUEOF function.
IF(CONTAINS(ANY, [Location], VALUEOF([Location], "New York")), (VALUEOF
Formula
[Area],"Local", (VALUEOF[Area],"Global"))
This formula evaluates the Location field for the presence of the value New York.
If the value is present and selected, the value Local is selected in the calculated Values
Results List field.
If the value New York is not found, the calculated field is populated with the value
Global.
This formula examines the Location field for the presence of the value "New York." If the value is
present and selected, the value "Local" is selected in the calculated Values List field. If the value
"New York" is not found, the calculated field is populated with the value "Global."
If the values list values that you want to reference in a calculated field formula have associated
numeric values, you can reference those numeric values using the SELECTEDVALUENUMBER
function. For example, you have an Affected Departments field with the values "Accounting," "IT"
and "Sales," and those text values have been assigned the numeric values 10, 8 and 6, respectively.
AVERAGE(SELECTEDVALUENUMBER([Affected Departments]))
If the values "Accounting" AND "IT" have been selected in the Affected Departments field, this
formula would populate the calculated field with the value "9."
Example: Average of numeric values in selected field
The following table describes an example scenario.
The Affected Departments field has the values Accounting, IT, and Sales and those
Scenario
text values are assigned the numeric values 10, 8, and 6, respectively.
If the values Accounting and IT are selected in the Affected Departments field, this
Results
formula populates the calculated field with the value 9.
Note: When you add a new calculated field to an application, a questionnaire, or a sub-form, it
displays at the bottom of the list in the Field Calculation Order listing.
Common mistakes
Syntax errors cause many of the common mistakes. The formula syntax changed from version 4.x to
5.x.
The following table provides a list of common mistakes that occur when using the DATE, ROUND,
STRING, and VALUEOF functions.
Function Description
DATE Dates and times are converted to Coordinated Universal Time (UTC) in the RSA
Archer database. As a result, dates and times in calculations are returned in UTC.
Dates and times are converted to the locale of the user when the date or time is
displayed in a field. For example, the locale is Central Time and the date entered in
a Date field called Due Date is 8/3/2012 9:00 PM. The date and time stored in the
database is 8/4/2012 2:00 ARE. Any user viewing this record with this field sees the
user’s time zone, for example, EST 8/3/2012 10:00 PM.
When manipulating date and time and displaying them in a field type other than a
Date field, dates and times are displayed in UTC. For example, a calculated text
field with the formula DATEFORMAT([Due Date], “YYYY-MM-DD HH-MM
AM”) referencing the Due Date from the formula above returns 08-04-2012 2:00
AM.
A numeric calculated field with the formula DAY([Due Date]) returns 4.
Function Description
ROUND Rounds a number to a specified number of digits. When the number to the right of
the decimal point is 5 or greater, the number is rounded up to the nearest integer.
If the num_digits parameter is greater than 0 (zero), the number is rounded to the
specified number of decimal places. If the num_digits parameter is equal to 0, the
number is rounded to the nearest integer. If the num_digits parameter is less than 0,
the number is rounded to the left of the decimal point to the specified number of
decimal places.
For example, if the num_digits parameter is -1 and the number is 101.5, the number
is rounded to 100.
STRING When using string manipulations, consider the data that is stored in the field. For
example, a Text Area field named Description contains <strong>Hello</strong>, and
the formula is LEN([Description]). Although the user only sees Hello, the
calculation results are 22, which is the total number of characters in the string.
VALUEOF A common misconception of the VALUEOF is that it returns true or false if the
referenced value is selected in the referenced field. Often a formula is written as IF
(VALUEOF[Color], “Blue”, 1,0) and should be written as IF([Color] = VALUEOF
[Color], “Blue”, 1,0).
The only purpose of the VALUEOF function is to make a formula resilient to value
changes in a Values List. If the text of a value is changed in a custom or global
values list by an administrator, this function automatically updates the formula to use
the new text for the value.
For example, if the value "Blue" is referenced in a formula with the VALUEOF
function, and that value is subsequently changed to "Red" in the values list, the value
reference of "Blue" is automatically changed to "Red" in the formula.
Invalid value
The following table describes an invalid value scenario.
Formula DATEDIF([Open Date],[Due Date],HOUR)
Use the ISEMPTY function to check for empty dates and to avoid .calculating against
Resolution
an empty date.
Multiple values
The following table describes a multiple value scenario.
Formula DATEDIF([First Published],REF([Incidents],[Open Date]),HOUR)
DATEDIF expects only one value, and this record relates to multiple
Cause
incidents.
Divide by zero
The following table describes a divide by zero scenario.
Formula 1 + 10/[Value]
Error A calculation within the formula returned the non-numeric value infinity.
Error Index and length must refer to a location within the string. Parameter name: length
Description field contains less than specified number of characters. In this case, the
Cause
Description field has less than 10 characters.
Use LEFT or RIGHT function instead or use these functions in combination with
Resolution
LEN to avoid reading passed the end of a string.
Using the formula as an example, the Open Date might be stored in B2 and the Due Date stored in
B3.
An error message for this formula might look like:
In this example, B3 is the parameter cell for Due Date and DATEDIF is expecting a valid serial
date.
Dependencies resolution
One of the most powerful facets of working with calculations is the ability to reference one or more
calculated fields in another calculated field formula.
For example, a final score value might be computed by summing the values of several calculated
section score fields.
In this example, there are inherent calculation dependencies. Each of the section score values must
be computed before the final score can be computed. You can specify the order in which
calculations are performing. After the field calculation order is established for an application, field
dependencies simply manage themselves.
Circular references
Circular references are sometimes difficult to detect. Circular references are caused by formulas
that form either a direct or indirect loop.
l A direct loop is formed when a series of field references form a closed circuit.
l An indirect loop can sometimes result when a series of field references includes a reference to a
field that is set to Always recalculate.
RSA Archer does not allow formulas that might result in circular references. Whenever a possible
circular reference condition exists, a validation message is displayed.
Validation messages help reconcile circular references. The validation message includes the field
name and module name of both the field and the field to which it references.
The following table describes examples of validation messages.
Calc Depend
Field Module Level
Always All
The Calc Always column contains the value of the Always Recalculate flag set at the calculated
field. The Depend All column contains the value set by RSA Archer for a questionnaire that has
questions dependent on any calculated field.
To see the circular reference details, validate the calculation in the formula builder.
The following table describes a possible validation message for a condition
that occurs where using the fields from two different applications that ref-
erence each other.
Calc Depend
Field Module Level
Always All
When the Always flag is set on a calculated field, the field recalculates every time a record is
saved. The formula indirectly results in a circular calculation that cannot be resolved. A validation
error is reported when this condition exists.
The following figure shows an indirect loop caused by a circular reference. This condition results in
a circular reference because Rating is indirectly dependent on Criticality. Because Rating is set to
Recalculate Always, it calculates every time that Criticality calculates.
Attempt to save Formula 3. A circular reference is detected, and a validation message is displayed
that may read like the following:
"Circular Calculation Detected: The following displays the path of the circle:"
The following table describes a circular calculation.
Calc Depend
Field Module Level
Always All
A circular reference containing three formulas in three different applications where each formula
references a field in a cross-referenced application.
Example
The following table provides example formulas.
(Field 1 in Application A references Field 2 in Application B)
Formula 1:
Field 1 recalculates on every save
Cross-Reference Field
The Cross-Reference field type enables you to create associations between records in the same
application (internal references) or records in one or more different applications (external
references).
l When you create a cross-reference field that forms an external relationship with another
application, a related-records field is automatically added to the related application. The related-
record field provides a mirror image of the cross-reference field. In an individual record of the
related application, you can see all records that are cross-referenced to that record.
l When you create an association between records in the same application, a related-record field is
automatically created in the application.
l When you create a cross-reference field that references a leveled application, you have the option
to reference one level or all levels of that application. If you select one level, the Display Fields,
Filters, and Sorting controls contain only the fields from the selected level.
l When users select record references through a cross-reference field, a Record Lookup page is
displayed that enables them to select records from a list or to search for specific records in the
related application by a keyword search. You can also create dynamic filters so that users only
see records that are relevant to them in a record look-up.
l If you have a cross-reference field in a Violations application that is configured to create external
references to an Investigators application, you can select investigators for individual violation
records by selecting those investigators through the cross-reference field.
Minimum Validates the removed or added relationships do not violate the Minimum
Selections (rule Selections rule for the related record when both of the following apply:
for a reference l The user attempts to save a record with a reference field change.
related field)
l A Minimum Selections rule is enabled for the reference field in the related
application.
Rule Description
Maximum Validates that the removed or added relationships do not violate the Maximum
Selections (rule Selections rule for the related record when both of the following apply:
for a reference l The user attempts to save a record with a reference field change.
related field)
l A Maximum Selections rule is enabled for the reference field in the related
application.
Example
Rule Description
Required (rule This rule validates that the removed relationships do not violate the Required
for a reference- rule for the related record when both of the following apply:
related field) l The user attempts to save a record with a reference field change.
l A Required rule is enabled for the reference field in the related application.
Example
Scenario
A user creates Application A with a cross-reference.
The user sets the associated Related Record field in Application B to Required.
Record B1 is related to Record A1.
The user edits Record A1 and removes Record B1 from the cross-reference.
Results
When the user attempts to save Record A1, a message is displayed, indicating
that the Required rule for Record B1 is violated. The violation occurs because
the removal of Record A1 causes the field (which is required) to have no data.
l To add a field from an existing field, click Copy an existing Field and select the cross-
reference field you want to copy.
4. Click OK.
5. In the General Information section, complete the name and description of the field.
Note: When you click Apply on a cross-reference field, the record saves and the calculation
status can not be changed.
Grid Displays multiple fields of data from the referenced record spanning the width of
the page in a table format (Grid) or in a single-column format. The attachment
information displays as a resizable grid control that displays the name, size and file
type for each file. When you select the Grid option, users with appropriate access
can view the Download History report. This report provides a summary of the
download history of a document including the user, email address, and download
date. Users can upload files by clicking Add New.
Options
Required Designates the field as required and forces users to enter a value when adding or
Field editing a record in the application. An icon (selected in the Appearance feature)
indicates required fields to alert users that they must enter a value. If you do not
select this option, you can skip this field when adding or editing a record in the
application.
Option Action
Auditing Displays auditing information next to the field each time that its value is
Information changed. The auditing information includes only the name of the user who made
the change and the date and time of the change. If this checkbox is not selected,
auditing information is not displayed with the field in the user interface.
Search Makes this field available for display in search results and references its values
Results in search filters.
Search Includes the field by default in search results for the application. This option does
Default not prevent users from removing the field from the Search Results page. Users
Field can click Modify in the toolbar and remove the field from the Fields to Display
section of the application Search Records page.
Enable Enables this field to be available for update from Advanced Search Results.
Bulk
Update
Enable Enables this field to be available for creation from Advanced Search Results.
Bulk
Create
Enable Determines whether a display is editable in a grid that has inline edit enabled.
Editable
Grid
Display
Lookup Specifies whether users can access a Record Lookup page for selecting records
from the related application. Clear this checkbox if you only want to allow users
to create new records for cross-referencing. You must select this checkbox if
you want the cross-reference field to be available for selection in a MRDC field
or are creating a dynamic filter.
Option Action
Add New Determines whether the Add New link is displayed in a grid for allowing users to
add new records to the related applications from a record in view mode. Users
will not have to open a record in edit mode to create new related records. If a
user does not have rights to create records in the related application, the link is
not displayed for that user.
When a user creates a new related record from view mode, that record will be
selected in the cross-reference field just as it would if it were created from edit
mode. For example, if a user opens a Vendor record in View mode and creates a
record in the related Audits application by clicking Add New in the cross-
reference field, that new Audit record will be selected in the cross-reference
field of the Vendor record, even though the user did not open the Vendor record
for editing.
Calculated Designates the field as a calculated field determined by a formula that computes
Field a value dynamically for this field. If you select this option, the field is read-only
for all users, and the defined formula computes its value.
Tree Determines whether the related records in a leveled application for cross-
Display referenced records are displayed in a hierarchical format for a single-column
display. The following figure shows top-level record references flush with the
left margin of the field, and record references in subsequent data levels indented.
When records with the cross-reference field are exported in CSV format, the
Tree Display option is disabled to allow the data to be re-imported into the
application. All other data export formats preserve the cross-reference tree
display for the field.
Validate Designates that a field is validated whenever any value changes in a record. If
Always the Validate Always option is not selected, this field validates only when the
value in that field has changed.
Disable Disables the Remove button for records displayed in this field.
Remove
9. In the Record Lookup Configuration section, specify the rules for finding the related records of
the cross-reference field.
Display Specifies the fields of data from the relationship application that is displayed on the
Fields Record Lookup page for users when they select related records in the Cross-
Reference field.
Use to select the fields that you want to display from the Available list.
Use the below the Selected list to arrange the fields. The top-to-bottom order
of fields in the Selected list will be the left-to-right order of fields in the Record
Lookup page.
Note: If the relationship application is a leveled application, and you select fields
from two or more levels to be displayed in the Cross-Reference field, you can only
arrange those fields on a level-by-level basis. You cannot intermix fields from
separate data levels.
Filters Determines the filtering criteria for selecting records for display on the Record
Lookup page.
Sorting Specifies the fields by which cross-referenced records are sorted in the Record
Lookup page.
For example, in an "Investigators" Cross-Reference field, you can sort the display
of referenced records alphabetically by investigator name.
Display Determines how the cross-referenced records are displayed on the Record Lookup
Format page:
l Column-Hierarchical. Presents the records in a columnar layout where fields are
displayed across the page from left to right, and the field values are presented
showing relationships.
l Column-Flat. Presents the records in a simple columnar layout without any
grouping of values.
10. In the Grid Display Properties section, select the fields you want to display in the record look-up
for the cross-reference field.
Record Indicates the related record displays using the Record Lookup configuration.
Lookup
Note: This option is not available for calculated cross-reference or related record
fields.
Display Indicates which related record fields to display, instead of Record Lookup
Fields configuration. This is available if Record Lookup is unchecked.
Note: Fields with the Enable Inline Edit option enabled appear here. If your field is
not available, go to the record in question and update the options on that field.
Sorting Specifies the default sorting order of related record fields to be displayed. This is
available if Record Lookup is unchecked.
11. In the Configuration section, specify the range of selections a user can make.
Configuration options
Field For Single Column option: Specifies the height of the field in a single-column
Height display. This setting impacts the display of the field only when users add or edit
records in the application. For example, if you set the field height to three lines,
and a user makes four selections in the field, a scroll bar is displayed.
Minimum Specifies the minimum number of selections (from none to 20 selections) that a
Selections user can select in the Dropdown, Checkboxes, Listbox, or Values Popup display
control.
Maximum Specifies the maximum number of selections (from none to 20 selections) that a
Selections user can select in the Dropdown, Checkboxes, Listbox, or Values Popup display
control.
Default Determines the number of cross-referenced records that display in the grid and is
Records only available when the display control is set to Grid. If this option is selected,
Display only the first designated number of records are displayed. For example, when this
option is set to 10, only the first 10 records display in the grid. If the number of
records exceeds the default display number, a View All link is displayed. A user
can click this link to view all of the associated records.
The administrator must first create the dynamic filter in the Cross-Reference Field of
one of the applications.
Action 1: All applications must contain the same field types that will be used for dynamic
filtering. If the dynamic filter is a values list, the Values List field must be a global
values list that is referenced in both applications.
Action 2: The user runs a record look up in the Vendor Management solution.
Only the relevant records that are dynamically filtered are shown in the record lookup
Results
results for that user.
When a user works with cross-reference or related records in a module that has a dynamic filter,
users see only the records relevant to them.
The platform administrator creates a dynamic filter on a Cross-Reference field in Application A.
Supported
Supported Operator Types Special Conditions
Field Type
3. In the Record Lookup Configuration section, enter the filtering criteria for the dynamic filter.
The following table describes filter criteria. Each row represents one set of filter criteria.
Option Description
Operator Provides the filter that evaluates the field in the creation of a condition. The
available operators depend on the type of field selected in Field to Evaluate.
Value(s) Opens the Record Lookup, which enables users to choose which value or values
to add to the condition.
Relationship Connects two or more conditions together. If you add more than one condition,
you can apply advanced logic to your search criteria.
When creating filters, you can use custom operator logic to form relationships between the individual
filters. By default, multiple conditions are related with the AND operator, as are multiple actions.
However, by creating custom operator logic, you can also use the OR and NOT operators, as well
as parenthetical groupings.
Note: The OR operator is supported only when you are filtering fields within a single level of a
leveled application or in a flat application. If you are filtering fields across different levels and
applications, you must use only the AND operator. Ultimately, the results of a search across
multiple levels and applications depend on the filters you apply and the relationships the search
process builds between the filtered fields.
Operator logic statements are evaluated left to right with parenthetical groupings evaluated first. By
using advanced operator logic with your filters, you can eliminate extraneous data that may be
imported with your data feed or included in your search results.
You enter the custom operator logic in the Advanced operator logic field.
Important: Custom operator logic must validate before you can save or apply changes to your data
filter. If your custom operator logic does not validate, you are prompted with an "Invalid Operator
Logic" error message.
Based on the above criteria, the following table details the result of the operator logic.
(1) System (2) Security (3) (4) Operating (5) Server
Result
Environment Class Manufacturer System Room
The Data Feed Manager evaluates the nested parenthetical expressions first. In the last example in
the previous table, since neither 3 or 4 evaluate to "TRUE" in the nested parenthetical expression,
the primary parenthetical expression evaluates to "FALSE," and thus the entire logical condition
fails and the data is not imported, even though all of the other conditions are met.
Based on the above criteria, the following table details the result of the oper-
ator logic.
(1) System
(2) Security Class (3) Manufacturer Result
Environment
The system evaluates the parenthetical expression first. In the last example in the previous table,
since neither 1 or 2 evaluate to "TRUE," the entire condition fails even if 3 evaluates to "TRUE".
Note: If you create a cross-reference field that forms an external relationship with a leveled
application, you have the option to reference a specific level or to reference all levels. If you
reference a specific level, a related records field is created at the data level specified. If you
reference all levels, a related records field is created at each data level in the related application. In
the case that more data levels are subsequently created in the leveled application, a related records
field is added to each new level.
You cannot add a related records field in an application, questionnaire, or sub-form. Instead, it is
automatically added when the application, questionnaire, or sub-form is selected for reference
through a cross-reference field. When a related records field is added, it is listed in the Available
Fields list on the Layout tab. As an application owner, you must move the related records field into
the application layout before it is displayed to end users. You can also rename the field and select
fields from the related application, questionnaire, or sub-form whose values you want to display in
the related records field.
Note: If a related records field is configured to display in the layout and a user does not have access
to records in the related application, questionnaire, or sub-form, the related records field is not
displayed for that user.
Users that have create permissions in the related application can add new records in that application
from the related records field. The cross-reference field value in the newly created record defaults
to the record where the user added it. Using the previous example, a user creates a new trouble
tickets record from the "Gloria Young" technicians record. The "Gloria Young" record is selected by
default in the Technicians cross-reference field in the new trouble tickets record.
If the Lookup feature is enabled for a related records field, users who have read permissions in the
related application can select records from a list or to keyword search for specific records in the
related application by clicking Lookup. As an application owner, you can configure the fields that
are displayed for users in the Record Lookup page, and you can create filter criteria to limit the
number of records users can select from. You can also define the minimum and maximum number of
related records a user can select.
Cross-Reference Mismatches
A common mistake when manually recreating cross-reference fields in multiple instances is to
accidentally switch the location of the cross-reference and related records fields. For example, the
following figure shows a cross-reference field that was created in application A and a related record
field in application B in the source (development) instance. In the target (test) instance, the cross-
reference field was inadvertently created in application B and the related record field in application
A.
If you create a package in the source instance and install it in the target instance, the package
installation creates new cross-reference and related record fields in the target instance. The existing
cross-reference and related records fields are not modified or deleted. The following figure shows
duplicate fields created because the original fields were switched in the target instance.
To prevent this situation, before creating and installing the package, manually update the source
instance (recommended) or the target instance so that both instances match.
Important: When converting from a user/group list field to a record permissions field, users are not
automatically granted access to the record. You must remove the users and groups from the
promoted field, and then add them again to activate record permissions for the newly promoted field.
Inherited permissions method allows your users to set permissions in one record and have those
l A record permissions field configuration is changed, and that field is referenced by the inherited
record permissions field.
The recalculation occurs only if the available users or groups are changed for a manual selection
record permissions field or if the rules are changed for an automatic selection record permissions
field.
l A record permissions field is deleted, and that record permissions field is referenced by the
inherited record permissions field.
l A record permissions field is changed to restricted or unrestricted, and the permissions are edited
in the Field Population section.
Important: Inherited record permissions fields are not tracked in a history log field. If a history log
field is configured to track the record permissions field before it was changed to use inherited
permissions, the record permissions field is removed from the history log configuration, and all data
for the field is deleted. Further changes to the record permissions field values are not tracked in the
history log.
After you select the Inherited Permissions model for a record permissions field, you cannot change
the permission method.
After defining one or more conditions for rule fulfillment, select the users and groups who have
access to records in which the specified conditions are met. When selecting users and groups, you
can also specify whether those users and groups have read-only access to their assigned records or
whether they have update and delete access.
When using the rule-driven selection method, you must also select one or more default users or
groups who have access to records in which none of the rules are met. You can also specify whether
those users and groups have read-only access to their assigned records or whether they have update
and delete access.
Permissions are recalculated for individual records each time a value changes that causes a new rule
to prove true. In addition, record permissions are recalculated for the entire application if any one of
the following occurs:
l A new automatic selection record permissions field is created or activated in an application.
l A permissions rule is added, deleted, or updated in an active record permissions field.
l An inactive automatic selection record permissions field is activated.
l A record permissions field that is configured with the manual selection method is reconfigured to
use the automatic selection method.
Record permissions can affect the behaviors of other elements used in applications, questionnaires,
or sub-forms.
Element Rules
Conditional For record permissions fields that are selected for inclusion or exclusion in an
Layout ACL action, only the data committed in the database determines whether a user
Actions is included or excluded from the ACL action.
Only the data committed in the database determines whether an ACL action is
applied to the specified user.
Any user that is selected in a record permissions field is excluded if the field is
excluded.
An Apply Conditional Layout (ACL) action does not give users added field
permissions, but it can restrict them.
l If a field is set to display and the user does not have read permissions to the
field, the field is still hidden from the user.
l If a user has full permissions to a field that is set to read only in an ACL
action, the user cannot modify the field.
l If a field is not displayed because of an ACL action, a user with field
permissions can still search the field and functions. For example, a data feed
and Web API can still reference the field.
Data Feed Record permissions are evaluated and may limit the source data retrieved from
the application.
Data Imports Record Permissions fields must be configured with the manual permissions
model.
When an empty value is imported into a Record Permissions field, the field is
empty in the new or updated record regardless of whether the field is configured
with one or more default values.
When no value is selected in the Record Permissions field, only users who are a
system administrator or application owner can access the record.
Element Rules
Notifications Record Permissions fields cannot be included in the subject line of the
notification.
For Scheduled Report Distributions, the content of an attached report is based on
the record permissions of the user who creates the report. A dynamic recipient
list is based on the values of a record permissions or an email address stored in a
field. Recipients can only view records for which they have record permissions.
Only a record being saved executes Generate Notification actions in a data-
driven event. This action executes at the end of the record save process and is the
only action that executes after calculated fields and record permission fields are
computed.
Packaging User/Groups field population may be added to Record Permissions fields, but the
packaging installation does not remove the existing ones.
If a User/Groups field in the target instance is configured as a Record
Permissions field in the package, the package installation changes the field to the
Record Permissions type.
When installing a package that contains Record Permissions fields, verify that
users and groups already exist in the target instance. If they do not, these fields
may not install properly. If necessary, create the users and groups in the target
instance before installing the package.
Search and User/Groups list and Record Permissions fields, which normally display as a link
Reporting to the profile page when populated, do not display as links when Inline Edit is
enabled,.
If an application contains a Record Permissions field, users can only access the
fields to which they have permissions in the application.
Element Rules
Workflows Record permissions apply for records in the workflow process. All users with
proper access privileges can view a record in the workflow process. Only users
that have been assigned a record in the workflow process can accept or reject it.
Scenario You define a rule in a Document Repository application that assigns full record-level
1: access to the Documentation group when the Document Status is Draft.
Results: The appropriate record-level access is granted for all records in the Document
Repository application when the Document Status is Draft.
Scenario You define another rule that assigns read-only record access to the Everyone group
2: when Document Status is Final.
Results: The appropriate record-level access is granted for all records in the Document
Repository application when the Document Status is either Draft or Final.
Results: Users and groups selected in the Record Permissions field have read and update rights
to the record.
Scenario: You have a Vendor Profiles application that cross-references your Contracts and
Assessments applications. Vendor relationship managers need access to records in all
three applications for the vendors they work with.
Solution: To simplify the process of granting record permissions for these applications, you can:
1. Create a record permissions field that allows manual selection in the parent
Vendor Profiles application.
2. Create record permissions fields in the child Contracts and Assessments
applications that inherit permissions from the related vendor profile.
Results: When a user gains access to the ABC Company vendor profile, that user
automatically gains access to the contracts and assessments related to ABC Company.
Scenario: You select the Sales, Marketing, and Management groups as available selections in
the field.
Results: If a user adds a record in the application and that user is a member of only the
Marketing group, the Marketing group is the only group available to that user for
selection in the record permissions field.
Dropdown Displays a list of items from which users can select an item.
Radio Displays a list of items from which users can select an item.
Buttons
Check Displays a list of items from which a user can select one or more items.
Boxes
Listbox Displays a selection list from which users can select one or more items.
Values Displays a selection list from which users can select one more items. For
Popup example, a users and groups list may contain hundreds or thousands of users. In
this case, a values popup list may be the best solution. For a two or three
selections, the best control might be dropdown, radio buttons, or checkboxes.
8. In the Options section, select the behavior and validation rules for the record permissions field.
Required Designates the field as required and forces users to enter a value when adding or
Field editing a record in the application. An icon (selected in the Appearance feature)
indicates required fields to alert users that they must enter a value. If you do not
select this option, you can skip this field when adding or editing a record in the
application.
Auditing Displays auditing information next to the field each time that its value is
Information changed. The auditing information includes only the name of the user who made
the change and the date and time of the change. If this checkbox is not selected,
auditing information is not displayed with the field in the user interface.
Search Makes this field available for display in search results and references its values
Results in search filters.
Search Includes the field by default in search results for the application. This option does
Default not prevent users from removing the field from the Search Results page. Users
Field can click Modify in the toolbar and remove the field from the Fields to Display
section of the application Search Records page.
Enable Enables this field to be available for update from Advanced Search Results.
Bulk
Update
Advanced Adds descriptive text and alters the standard display of the field. After selecting
Field this checkbox, specify the display text and layout for the field in the Advanced
Display Field Display Options section.
Validate Designates that a field is validated whenever any value changes in a record. If
Always the Validate Always option is not selected, this field validates only when the
value in that field has changed.
9. In the Configuration section, set the minimum and maximum selection values.
Field Specifies the height of the field in lines and is specific to a Listbox or Text Area
Height display control. If more values are available for selection in the field than the
number of lines you specified, a vertical scroll bar appears in the field to enable
users to view all available values.
Column Specifies the number of columns for the Radio Buttons or Checkboxes display
Layout control options.
Minimum Specifies the minimum number of selections (from none to 20 selections) that a
Selections user can select in the Dropdown, Checkboxes, Listbox, or Values Popup display
control.
Maximum Specifies the maximum number of selections (from none to 20 selections) that a
Selections user can select in the Dropdown, Checkboxes, Listbox, or Values Popup display
control.
After defining one or more conditions for rule fulfillment, select the users and groups who have
access to records in which the specified conditions are met. When selecting users and groups, you
can also specify whether those users and groups have read-only access to their assigned records or
whether they have update and delete access.
When using the rule-driven selection method, you must also select one or more default users or
groups who have access to records in which none of the rules are met. You can also specify whether
those users and groups have read-only access to their assigned records or whether they have update
and delete access.
Permissions are recalculated for individual records each time a value changes that causes a new rule
to prove true. In addition, record permissions are recalculated for the entire application if any one of
the following occurs:
l A new automatic selection record permissions field is created or activated in an application.
l A permissions rule is added, deleted, or updated in an active record permissions field.
l An inactive automatic selection record permissions field is activated.
l A record permissions field that is configured with the manual selection method is reconfigured to
use the automatic selection method.
Note: When you select the Cascade option for a group that contains sub-groups, those sub-groups
are available for selection in the Record Permissions field. When a user interacts with the record
permissions field while adding or editing a record, the user can select the parent-level group,
individual, or both sub-groups nested under the parent group. If a user selects only the parent group,
record access is not granted to members of sub-groups. Only individual users who are members of
the selected parent group have access to the record.
Task 2: Add selection rules for changing the access level of the record permissions
field
1. In the Rules section, click Add New.
2. In the Rule Information section, enter a rule name and a description.
3. In the Conditions field, do the following to create one or more rules:
a. In the Field To Evaluation box, select the field to evaluate for one or more specific values.
b. In the Operator box, select the filter operator.
c. In the Value(s) box, select the values for the condition
4. In the Field Population section, click Lookup.
5. Do one or both of the following to select the users and groups:
l To add a group, expand the Groups node and click the Group or Groups that you want to add.
l To add users, expand the Users node, and click the users that you want to add.
Note: To search for a specific role, enter the role name in the Find field and, if applicable,
select the type from the adjacent list. Click . The results of your search appear in the
Available list in the Search Results node.
Task 3: Add default users and groups to the record permissions field
Complete this task to assign one or more users and groups who are granted record permissions by
default if none of the rules that you specified are met.
1. In the Default Users/Groups section, click Lookup.
2. Do one or both of the following to select the users and groups:
l To add a group, expand the Groups node and click the Group or Groups that you want to add.
l To add users, expand the Users node, and click the users that you want to add.
To search for a specific role, enter the role name in the Find field and, if applicable, select the
type from the adjacent list. Click . The results of your search are displayed in the Available
list in the Search Results node.
3. Click OK.
4. Select the permissions you want to assign to the user or group.
5. Click Save or Apply.
l Click Save to save and exit.
l Click Apply to apply the changes and continue working.
Inherited permissions method allows your users to set permissions in one record and have those
permissions automatically apply to related records.
l Unrestricted: Inherits record permissions from all related records. If you set the permissions in a
record, those permissions automatically apply to all related records.
l Restricted: Inherits record permissions from selected related records. If you set the permissions in
a record, those permissions automatically apply to the specified related records.
l A record permissions field configuration is changed, and that field is referenced by the inherited
record permissions field.
The recalculation occurs only if the available users or groups are changed for a manual selection
record permissions field or if the rules are changed for an automatic selection record permissions
field.
l A record permissions field is deleted, and that record permissions field is referenced by the
inherited record permissions field.
l A record permissions field is changed to restricted or unrestricted, and the permissions are edited
in the Field Population section.
Important: Inherited record permissions fields are not tracked in a history log field. If a history log
field is configured to track the record permissions field before it was changed to use inherited
permissions, the record permissions field is removed from the history log configuration, and all data
for the field is deleted. Further changes to the record permissions field values are not tracked in the
history log.
After you select the Inherited Permissions model for a record permissions field, you cannot change
the permission method.
2. In the Field Population section, select one or more Record Permissions fields to display in the
Selected list from the Available list.
3. Click Save.
Important: When converting from a user/group list field to a record permissions field, users are not
automatically granted access to the record. You must remove the users and groups from the
promoted field, and then add them again to activate record permissions for the newly promoted field.
When working with groups, you can include the sub-groups of a selected group in the list of
available values for the record permissions field. To include a sub-group, select Cascade for the
group in the Users/Groups list.
Note: When you select the Cascade option for a group that contains sub-groups, those sub-groups
are available for selection in the Record Permissions field. When a user interacts with the record
permissions field while adding or editing a record, the user can select the parent-level group,
individual, or both sub-groups nested under the parent group. If a user selects only the parent group,
record access is not granted to members of sub-groups. Only individual users who are members of
the selected parent group have access to the record.
Task 3: Add selection rules for changing the access level of the record permissions
field
1. In the Rules section, click Add New.
Note: To search for a specific role, enter the role name in the Find field and, if applicable,
select the type from the adjacent list. Click . The results of your search appear in the
Available list in the Search Results node.
Updating Permissions
A modification to the rights granted by a manual record permissions field does not automatically
apply to existing records, only to new records added after the change. In order to apply the change to
existing records, you must update the field and save the records. The following procedure updates
the field for all records.
1. To update your existing records, run an advanced search that includes only the application key
field and the manual permissions field.
2. Export the results to a CSV file.
3. Run a data import on the CSV file.
Important: When converting from a user/group list field to a record permissions field, users are not
automatically granted access to the record. You must remove the users and groups from the
promoted field, and then add them again to activate record permissions for the newly promoted field.
2. Select the user/groups list field that you want to promote to a record permissions field.
3. In the Action field in the General Information section, click Promote to Record Permissions
field.
4. Remove the users and groups from the promoted field.
5. Add the users and groups to activate the record permissions for the newly promoted field.
6. Click Save.
Values Lists
Values lists allow administrators to define the values that users are allowed to select from in a
Values List, Matrix, or Cross-Application Status Tracking field. There are two types of values lists.
The following table describes the two types of values lists.
Type Description
Global Global values lists can be accessed and reused by other administrators. A global values
list can be used to populate Values List, Cross-Application Status Tracking, and Matrix
fields in an application.
For example, if you create a global values list that includes project statuses (pending, in
process, under review, completed, and so on), and you use this global values list in an
Exception Requests application, other administrators can use this values list in
applications they create, such as an Incidents application.
If you grant a user or group access rights to the Manage Global Values Lists page, these
individuals have access to all global values lists in the RSA Archer. If you want a user
to have access to specific global values lists and not all lists, select the appropriate
CRUD access for the individual global values list on the Manage Access Roles page.
Type Description
Field- A field-specific values list is considered “local” to its related Values List or Matrix
Specific field, meaning that it cannot be used again to populate other fields. Custom values lists
are useful in cases where the values do not make sense in the context of another
application or field. For example, a field-specific values list with the values “Draft” and
“Final” may be useful only for a Status field in a Document Repository application.
From the Application Builder, you can quickly establish global and field-specific values lists by
entering the values manually or by importing them from an external XML file.
Dropdown Displays a list of items from which users can select an item.
Radio Displays a list of items from which users can select an item.
Buttons
Check Displays a list of items from which a user can select one or more items.
Boxes
Listbox Displays a selection list from which users can select one or more items.
Values Displays a selection list from which users can select one more items. For
Popup example, a users and groups list may contain hundreds or thousands of users. In
this case, a values popup list may be the best solution. For a two or three
selections, the best control might be dropdown, radio buttons, or checkboxes.
8. In the Options section, select the options for including the field in search results and setting its
behavior:
Options
Required Designates the field as required and forces users to enter a value when adding or
Field editing a record in the application. An icon (selected in the Appearance feature)
indicates required fields to alert users that they must enter a value. If you do not
select this option, you can skip this field when adding or editing a record in the
application.
Auditing Displays auditing information next to the field each time that its value is
Information changed. The auditing information includes only the name of the user who made
the change and the date and time of the change. If this checkbox is not selected,
auditing information is not displayed with the field in the user interface.
Search Makes this field available for display in search results and references its values
Results in search filters.
Option Action
Search Includes the field by default in search results for the application. This option does
Default not prevent users from removing the field from the Search Results page. Users
Field can click Modify in the toolbar and remove the field from the Fields to Display
section of the application Search Records page.
Enable Enables this field to be available for update from Advanced Search Results.
Bulk
Update
Description Displays the selected value for the field as a hyperlink when users view records
Links in the application. Users can click the linked value to read a description of the
value from a pop-up window.
Calculated Designates the field as a calculated field determined by a formula that computes
Field a value dynamically for this field. If you select this option, the field is read-only
for all users, and the defined formula computes its value.
Advanced Adds descriptive text and alters the standard display of the field. After selecting
Field this checkbox, specify the display text and layout for the field in the Advanced
Display Field Display Options section.
Option Action
Validate Designates that a field is validated whenever any value changes in a record. If
Always the Validate Always option is not selected, this field validates only when the
value in that field has changed.
9. In the Configuration section, specify the minimum and maximum number of selections a user can
make.
Configuration options
Field Specifies the height of the field in lines and is specific to a Listbox or Text Area
Height display control. If more values are available for selection in the field than the
number of lines you specified, a vertical scroll bar appears in the field to enable
users to view all available values.
Column Specifies the number of columns for the Radio Buttons or Checkboxes display
Layout control options.
Minimum Specifies the minimum number of selections (from none to 20 selections) that a
Selections user can select in the Dropdown, Checkboxes, Listbox, or Values Popup display
control.
Maximum Specifies the maximum number of selections (from none to 20 selections) that a
Selections user can select in the Dropdown, Checkboxes, Listbox, or Values Popup display
control.
a. From the menu bar, click a. From the menu bar, click a. From the menu bar, click
. . .
b. Under Application Builder, b. Under Application b. Under Application
click Global Values Lists. Builder, click Builder, click
Applications. Questionnaires.
c. Select the application. c. Select the questionnaire.
d. Click the Fields tab and d. Click the Fields tab and
select thevalues list field. select the values list field.
e. Click the Values tab. e. Click the Values tab.
5. By default, Active is selected, which makes the value available for selection on the user
interface. If you do not want users to be allowed to select the value, clear Active.
Once you edit records with an inactive value in the value list field, the inactive value is removed.
6. (Optional) To set the value you are working with as a default selection when the values list is
displayed to users, select Default Selection.
Note: When a user adds a new record in an application or questionnaire that contains a Values
List field with a default value, the default value automatically is selected in the Values List
field, regardless of the user’s access to the field. For example, if a user has read-only access to
a Values List field with a default value of “In Progress,” when the user saves the record, the
value of this field is set to “In Progress” even though the user cannot edit the field. Users with
full access to the field can change the default value.
7. To associate a numeric value with your text value, enter the appropriate number in the Numeric
Value field.
For example, if your text value is "High," you might assign it a numeric value of "10." The
Numeric Value field accepts positive, negative, and decimal values. Using the Calculations
feature, you can reference these numeric values in calculated field formulas.
8. To apply color to the text of the value, follow these steps:
Note: If you associate a color with a values list item, the color is displayed in records in view
mode and on a record node in Relationship Visualization. Values list items are not displayed in
color when users add or edit records unless the user has read-only access to the field.
9. To include an image to represent your value, in the Image field, click and in the Graphic
Selector dialog box, select from the following options:
l Select a Graphic from a Library. In the Available Graphics control group, select the option
next to the graphic that you want to assign to the values list item and click OK.
l Add a New Graphic. In the Available Graphics control group, click Add New to browse for
and select the file. Once you have selected a file, click Open to add the graphic to the Files to
Note: If you associate an image with a values list item, the image is displayed in records in view
mode in place of the value name. Values list items are not displayed as an image when users add
or edit records unless the user has read-only access to the field.
10. If you want users to enter descriptive text associated with the value:
a. Select Other.
b. From the Height list, select the height for the text box.
c. In the Default Text field, enter the text that you want to be displayed by default next to the
values list control.
Note: Enabling this property causes the values list control to display a required text box on the
user interface. For example, if you have a value of "N/A," you can use the Other option to force
users to enter information supporting their selection of the "N/A" value.
Only one value for each values list may have the Other option enabled. Changing the Other
option from one value to another results in the loss of all data entered in the “Other” field
associated with the original value. For example, you have a values list where the value “N/A” is
enabled with the Other option. If you enable the value “None of the Above” with the Other
option, all data contained in the “Other” field associated with the “N/A” value is erased.
11. Click Save or Apply.
l Click Save to save and exit.
l Click Apply to apply the changes and continue working.
Note: Both active and inactive values are available for selection when configuring a values list. To
avoid confusion, RSA recommends deleting unused inactive values from the values list.
a. From the menu bar, click a. From the menu bar, click a. From the menu bar, click
. . .
b. Under Application Builder, b. Under Application b. Under Application
click Global Values Lists. Builder, click Builder, click
Applications. Questionnaires.
c. Select the application. c. Select the questionnaire.
d. Click the Fields tab and d. Click the Fields tab and
select the values list select the values list
field. field.
The following table describes how to get to the values list, depending on the type of values list.
Global Field-Specific Questionnaire
a. From the menu bar, click a. From the menu bar, a. From the menu bar, click
. click . .
b. Under Application Builder, b. Under Application b. Under Application
click Global Values Lists. Builder, click Builder, click
c. Select a values list. Applications. Questionnaires.
c. Select the application. c. Select the questionnaire.
d. Click the Fields tab. d. Click the Fields tab.
e. Select the Values List e. Select the Values List
field. field.
Custom Lists the values in the specific order that you define. To adjust the order of
values, click and drag the value to the position in the list.
Ascending Lists the values in ascending alphanumeric order. For example, the values
"High," "Medium," and "Low" would be displayed in the following order: High,
Low, Medium.
Alphanumeric sort is not supported for values lists that contain values in multiple
languages.
Descending Lists the values in descending alphanumeric order. For example, the values
"High," "Medium," and "Low" would be displayed in the following order:
Medium, Low, High.
Random Lists the values in a different order each time the list is displayed. This variation
in display order minimizes the chance that end users detect patterns.
4. Click Save.
2. In the Field column, click the field that you want to configure.
3. In the Action field on the General tab, click the Promote to Global Values List link.
4. Click Save.
Note: If you selected to use global values lists to populate the Matrix field column and row values,
the Column Values and Row Values links are not displayed on the Fields tab of the Manage
Applications page.
1. Go to the Fields tab of the application or questionnaire that you want to update.
Values can be imported in global, field-specific, and questionnaire values lists. The process for
adding values to these types of lists is identical.
The following table describes each attribute and whether it is required or optional.
Attribute Required/Optional Description
name Required The name of the value as you want it to display in the
values list. It maps to the Text Value field on the Edit
Value page.
active Required Defines whether the values list item is available for
selection on the user interface. It maps to the Active
field on the Edit Value page. Use the value "true" or
"false" with this attribute.
value Optional The numeric value associated with the text value
name. For example, you could associate the numeric
value "10" with the text value "High." This attribute
maps to the Numeric Value field on the Edit Value
page.
selectedDefault Required Defines whether the values list item is the default
selection. It maps to the Default Selection field on the
Edit Value page. Use the value "true" or "false" with
this attribute.
textColor Optional The HTML color code to apply to the value. It maps to
the Text Color field on the Edit Value page.
otherTextEnabled Optional Associates the "Other" text field with the values list
item. It maps to the Other field on the Edit Value page.
Use the value "true" or "false" with this attribute. Only
one value per values list can be defined as "Other."
otherTextHeight Optional Defines the height of the "Other" text field. This
attribute can be used only in conjunction with the
otherTextEnabled attribute.
otherTextDefault Optional Defines the default text for the "Other" text field. This
attribute can be used only in conjunction with the
otherTextEnabled attribute.
image Optional The name of the image file associated with the values
list item. When you import a values list item that has
an image attribute (the filename of the image), RSA
Archer maps the image attribute to a file name on the
server. RSA Archer displays the image associated with
the filename on the server. If an exact match cannot be
found, no image is displayed. This attribute does not
accommodate the import of new or updated images.
a. From the menu bar, click a. From the menu bar, click a. From the menu bar, click
. . .
b. Under Application Builder, b. Under Application b. Under Application
click Global Values Lists. Builder, click Builder, click
Applications. Questionnaires.
c. Select the application. c. Select the questionnaire.
d. Click the Fields tab and d. Click the Fields tab and
select the values list select the values list
field. field.
e. Click the Values tab. e. Click the Values tab.
1. Go to the Values List page of the values list you want to update.
The following table describes how to get to the values list, depending on the type.
Global Field-Specific Questionnaire
a. From the menu bar, click a. From the menu bar, click a. From the menu bar, click
. . .
b. Under Application Builder, b. Under Application b. Click Questionnaires.
click Global Values Lists. Builder, click c. Select the questionnaire.
c. Select a values list. Applications.
d. Click the Fields tab and
c. Select the application. select the values list
d. Click the Fields tab and field.
select the values list e. Click the Values tab.
field.
e. Click the Values tab.
Important: You cannot delete values from a values list that are used in an advanced workflow.
You can delete multiple values from a global, field-specific, or questionnaire values list by exporting
the values list as an XML file and deleting the values you want to keep, leaving a list of values you
want to remove. The Bulk Delete feature enables you to upload the revised XML file, and removes
the list of unwanted values from the values list accordingly.
Note: Regular maintenance of your values list is important to avoid confusion when configuring your
values in charts. RSA recommends that you maintain your values lists by deleting unused inactive
values.
Note: Both active and inactive values are available for selection when configuring a values list. To
avoid confusion, RSA recommends deleting unused inactive values from the values list.
a. From the menu bar, click a. From the menu bar, click a. From the menu bar, click
. . .
b. Under Application Builder, b. Under Application b. Under Application
click Global Values Lists. Builder, click Builder, click
Applications. Questionnaires.
c. Select the application. c. Select the questionnaire.
d. Click the Fields tab and d. Click the Fields tab and
select the values list select the values list
field. field.
e. Click the Values tab. e. Click the Values tab.
2. In the Structure pane in the Values section, select the value that you want to delete.
3. In the Properties pane, click Delete for the value that you want to delete.
4. Click Save or Apply.
l Click Save to save and exit.
l Click Apply to apply the changes and continue working.
The following table describes how to get to the values list, depending on the type of values list.
Global Field-Specific Questionnaire
a. From the menu bar, click a. From the menu bar, a. From the menu bar, click
. click . .
b. Under Application Builder, b. Under Application b. Under Application
click Global Values Lists. Builder, click Builder, click
c. Select a values list. Applications. Questionnaires.
c. Select the application. c. Select the questionnaire.
d. Click the Fields tab. d. Click the Fields tab.
e. Select the Values List e. Select the Values List
field. field.
Scheduler Field
Use the scheduler field to create triangular relationships between the application to which it belongs,
a resource application, and the Appointment application to facilitate scheduling resources.
When you schedule appointments for either application, the appointments are listed in the Contacts
application in the resource view. An appointment can only be associated with one parent and one
resource.
To assign resources to any parent application, you must configure a scheduler field with the schedule
view and add it to the layout of that application. Any module with the scheduler field configured in
the schedule view is considered a parent application.
Parent The application with the scheduler field configured in the schedule view to which
you want to schedule resources.
Resource The application with the scheduler field configured in the resource view containing
the resources you want to schedule. A resource application can never be the parent.
Displaying appointments
You can display appointments in either the schedule or resource view.
l The schedule view displays appointments in a Gantt-like chart with the resource along the left
side and the appointments in segmented columns based on start and end dates. In this view, users
can schedule appointments directly by moving the start and end date columns, and can assigning
resources by dragging and dropping appointments from one resource to another. Users cannot edit
appointments of other parent applications in this view.
l The resource view displays a list of appointments for all resources or the appointments for a
particular resource when viewed by that user. Appointments are grouped by the parent application
and listed in a table (grid) with the following information: Appointment, Name, Start date, End
date, Duration, and Type.
Note: You cannot use the Scheduler field as a filter, in a data-driven event, or a rule for a data-
driven event.
Note: After you create a scheduler field, you cannot edit the Display Control or Configuration
options. You must delete the scheduler field, which removes the triangular relationships. After
creating the scheduler field, you must add it to the application layout.
1. Go to the Fields tab of the application or questionnaire to which you want to add the Scheduler
field.
Schedule Schedule Grid: Displays appointments in a Gantt-like chart with the resource along
Grid the left side and the appointments in segmented columns based on start and end
Resource dates. In this view, you can see all assigned resources for each parent record. To
Grid assign resources to any parent application, you must configure a scheduler field
with the schedule view and add it to the layout of that application. Any module with
the scheduler field is considered a parent application.
Resource Grid: Displays appointments in a list grouped by parent applications for
all resources or the appointments for a particular resource when viewed by that
user. In this view, your users can see all appointments assigned to them through
this view regardless of the application to which they are assigned. Users can also
see any appointments that are not assigned to a resource.
9. In the Options section, select whether the field is included in search results.
The following table describes the options.
Option Action
Search Makes this field available for display in search results and references its values in
Results search filters.
Search Includes the field by default in search results for the application. This option does not
Default prevent users from removing the field from the Search Results page. Users can click
Field Modify in the toolbar and remove the field from the Fields to Display section of the
application Search Records page.
Display Specifies the fields of data from the relationship application that are
Fields displayed on the Record Lookup page for users when they select related
records in the Scheduler field.
To select fields for display, click in the Display Fields field and select
the fields that you want to display from the Available list.
Use the below the Selected list to arrange the fields. The top-to-bottom
order of fields in the Selected list will be the left-to-right order of fields in
the Record Lookup page.
Filters Determines the filtering criteria for selecting records for display on the
Record Lookup page.
To set filters for the records to be displayed in the field, select the values for
the following fields:
l Field to Evaluate
l Operator
l Values
You can also create a dynamic filter for filtering record lookup.
Sorting Specifies the fields by which referenced records are sorted in the Record
Lookup page.
b. In the Schedule Display Configuration, select the resource fields that you want to display.
Display Defines the columns of data that display in the Resource column of the
Fields schedule view.
Use to select the fields that you want to display from the Available list.
Use the below the Selected list to arrange fields. The top-to-bottom
order of fields in the Selected list displays as the left-to-right order of fields in
the Related Record Field table.
Trending
Trending is a method of tracking status changes for a numeric or values list field. Trending charts
enable you to observe patterns in data over a specified period of time. The chart reflects a plot point
for each time a field value is saved. When a field is enabled for trending with a duration period,
RSA Archer captures data for the specified field and retains the data for the duration period as
trending data.
The trending data can be displayed on a chart in the record after the Add Trending Chart layout
object is added to the application layout. Viewing trended data on the chart enables you to see trends
in the data in order to make informed business decisions. These trending charts are displayed in a
record when the Enable trending options for this field option is selected for a Numeric or Values List
field. The trending chart title is displayed when the Show Title option is selected in the Trending
Chart Description dialog box. If no trended data exists for the field when you view the record, the
message "No Trending Data Available" is displayed in this section.
Plot points displayed on the trending chart represent each time the trended value is saved. You can
hover over a plot point to view a tooltip consisting of the following details after saving the record.
Trended Numeric fields with a null value are currently displayed on a trending chart with a plot point
at 0. To ensure that the data on the trending chart is accurate, select the Required field option on the
Manage Field page.
The removal of any trended data occurs after an asynchronous job runs. This asynchronous cleanup
job removes both expired trended data and any trended data for fields that the user has disabled
trending.
Note: If you are attempting to display a trending chart for a Values List field that has a large number
(approximately 2500) of historical changes, an error may occur.
Note: If the trended field was disabled and then enabled, no trending data is retained from the last
time the field was set to trending-enabled and the asynchronous job ran. The trending duration period
must be set each time trending is enabled.
2. Select the trended field (numeric or values list field) that you want to enable trending.
3. Click the Options tab.
4. Click Enable trending options for this field checkbox and enter the duration period.
5. Click Save.
6. Click OK to continue.
2. Select the trended field (numeric or values list field type) for which you want to disable trending.
Chapter 6: Sub-Forms
A sub-form is a special grouping of fields that can be embedded in any application to collect
information in individual records. When users add or edit a record in an application that contains a
sub-form, they can add data to the sub-form multiple times.
You can customize a sub-form layout by doing the following:
l Add and arrange sections, fields, help text, objects, and custom controls.
l Add custom objects using HTML or JavaScript code to create buttons or other objects.
l Add placeholders to create blank spaces between fields or sections.
l Add tab sets to group related tabs.
l Add tabs to group related fields.
l Set visibility properties to hide a field from users without deactivating or deleting the field.
Adding Sub-Forms
From the Manage Sub-Forms page, you can create an original sub-form, or create a sub-form by
copying and modifying the properties of an existing one. If you select to copy a sub-form, your new
sub-form contains all of the fields and structural components of the copied sub-form, but it does not
include any attachment files or sub-form entries.
Note: To protect data integrity, the application prohibits field type changes. For example, you cannot
change a date field to a text field.
1. Go to the Layouts tab of the sub-form to which you want to add a field.
1. Go to the General tab of the sub-form to which you want to attach a file.
1. Go to the General tab of the sub-form from which you want to remove a file.
2. In the Documentation section, locate the file that you want to remove from the sub-form and
click the Delete icon in its row.
3. Click Save or Apply.
l Click Save to save and exit.
l Click Apply to apply the changes and continue working.
2. In the Status field of the General Information section, select the status for the sub-form.
The following table describes each status.
Status Description
Active Users can enter data in sub-forms with Active status. Active sub-forms can be
displayed in an application.
Deleting Sub-Forms
When you delete a field from a sub-form, all record data stored in that field is lost. If you delete a
system field type, data stored in the field is maintained in the database and continues to populate the
field in new and updated records, even though the data is not visible through the user interface.
Delete a sub-form
1. Go to the Manage Sub-Forms page.
3. Click .
4. Click OK.
Data driven events are associated with individual layouts in an application or questionnaire. Data
driven events are configured on the Events tab of the Manage Layout page and provide
administrators and application owners the ability to:
l Dynamically control page layout based on the state of content.
l Conditionally filter or set field values based on the state of content.
l Generate email notifications.
The Data Driven Event feature includes a utility, the Event Analyzer, for troubleshooting DDE
rules. The Event Analyzer provides a real-time view of rule evaluations and actions that are applied
as a result of user interaction with the content edit page.
DDE guidelines
When building DDEs, consider the following guidelines:
l Required fields that are hidden from the end user in an application are still required. Users cannot
save the record when this condition exists.
l Fields that are hidden in an application and are set to be required by an Apply Conditional Layout
(ACL) action are only required conditionally. When hidden fields are conditionally required by an
ACL, users can save the record.
l A rule condition that evaluates a Text field with the Display Control set to Text Area may result
in inconsistencies due to rich text markup when an operator other than Contains or Does Not
Contain is used.
l Tabs can be dynamically shown or hidden based on the current state of content, including nested
tabs. When a data driven event hides all sections on a tab, the tab is also hidden.
l Actions linked to the rule targeting a private field may not execute because not all users can
access the private field. Field permissions can be different for each user.
l Date and Values List field values that are set by an action can still be edited by the end user
unless the field is set to not be edited. For example, all other values in a Values List are filtered
by an action.
Note: Off-layout refers to the fields that are available for selection but are not included in a section
layout.
l Off-layout and private fields to which the user does not have field permissions:
o Can be used as a rule condition to evaluate.
o Cannot be directly set.
l Calculated values are always evaluated after executing Save or Apply with the exception of
Generate Notification actions.
l Generate Notification actions are only executed by a record being saved. This action is executed
at the end of the record save process and is the only action executed after calculated fields and
record permission fields are computed.
l System fields can be used as rule conditions. The First Published Date and Last Updated Date
fields are not available until after the record is saved. Generate Notification actions are entirely
different from other actions and execute after these values are calculated.
Note:
1. During the load process, all valid rules are evaluated. For any rule that evaluates to true, the
filter or set action of the rule is applied (subject to set and filter conflict handling).
2. Because filter and set actions can potentially change content values, the ACL action must be
evaluated against the "latest" state of the content.
3. A user modification triggers a SINGLE pass of rules with SETS (Set Date or Set Values List
Selection) and FILTER (Filter Values List Items) actions. SET actions are applied only when the
user modified field is contained in a condition of the rule.
4. If the user modifies at least one field value that is used in a condition of a rule, the load process
is repeated. The SET actions are applied only if the field the user modified is contained in a
condition of the rule.
The following figure shows the Update Scenario – Edit process flow.
Note:
1. During the load process, filter actions are applied (subject to conflict handling).
2. Because filter and set actions can potentially change content values, the ACL action must be
evaluated against the "latest" state of the content.
3. A user modification triggers a SINGLE pass of rules with SETS (Set Date or Set Values List
Selection) and FILTER (Filter Values List Items) actions. SET actions are applied only when the
user modified field is contained in a condition of the rule.
4. If the user modifies at least one field value that is used in a condition of a rule, the load process
is repeated. The SET actions are applied only if the field the user modified is contained in a
condition of the rule.
To create, edit, or delete both rules and actions, your user account must specify that you:
l Are an application owner
l Have update rights on the Manage Application page
l Have ownership rights to the questionnaire (if working on a questionnaire)
Depending on how rules are configured in an application or questionnaire, it is possible that the
actions defined for those rules could conflict with each other. It is important to understand the
effects and expected behaviors that can occur when an action is executed. Each action type includes
rules to consider when defining actions and suggestions for conflict resolution.
Rule-related tasks
l Adding Rules to Data Driven Events
l Setting the Rule Order of Data Driven Events
Action-related tasks
l Adding Apply Conditional Layout Actions
l Adding Filter Values List Item Actions
l Adding Generate Notification Actions
l Adding Set Date Actions
l Adding Set Values List Selection Actions
A rule can be linked to one or more action types. Rules are evaluated sequentially according to the
priority in which they are assigned in the Rule Order dialog box.
l Rules are owned by the application or questionnaire to which they are linked, and are not
available to other applications or questionnaires.
l Rules are evaluated and actions are executed in a rules session.
l A rules session is a single uninterrupted pass of evaluating rules in a specified order and
executing linked actions for any rules that are true.
l A rules session is invoked when a record is added, changed, or saved.
l Rules can be copied and edited to make similar rules.
l Rules can be based on field types that allow for a user selection or data entry.
Note: Sub-forms can be used in a rule, but not the fields in the sub-form.
On Edit Calculated field value was already updated by the Content Save process.
Filter and ACL actions are executed based on the updated calculated field value.
On View Calculated field value was already updated by the Content Save process.
ACL actions are executed based on the updated calculated field value.
On Field Calculated field values cannot be directly modified by the end user.
Modification
Important: RSA Archer may automatically change the contents of a field when you have entered
Edit mode, but before you have actually made any edits. The following table contains four sample
scenarios.
Rule 1 has the Changed operator Rule 1 is evaluated as true from User Input 1
set to Changed Rule 1 is evaluated as false from User Input 2
Field A currently has a value of Only the first change triggers the data driven event and not
null (empty) the second one because the final state of the value is the
User Input 1 - User changes the same as its original state
value of Field A to 2
User Input 2 - User removes the
value of 2 in Field A
Rule 1 has the Change operator set Rule 1 is evaluated to True immediately when User 1 edits
to Changed the record
Field A is configured to auto- The system has automatically removed Enterprise
restrict groups Management as the selected value in the field
Field A currently has the
Enterprise Management group
saved in the record
User 1 edits the record, but is not
a member of the Enterprise
Management group
Rule 1 has the Changed operator Rule 1 is evaluated to true when the user clicks on the field
set to Changed The system has automatically changed the HTML in the field
Field A is a text field that has to be normalized
invalid HTML brought in from a
data import
User 1 edits the record and clicks
on Field A
Rule 1 has the Changed operator Rule 1 is evaluated to true immediately when User 1 edits the
set to Changed record
Field A currently has a User Previously selected User in Field A is automatically removed
selected in the field from the field
The selected User is deleted from
the system
User 1 edits the record
c. To change the relationship between the rows of filter criteria, in the Advanced Operator
Logic field, enter a new value. The default value is "And."
Note: The system automatically renumbers the criteria rows, but you may need to modify any
advanced operator logic accordingly.
For example, if your business practice requires a rule to always evaluate to true, create a
rule with the filter criteria set to Record Status equals New OR Updated, as shown in the
following figure.
The actions continue to exist in the Action Library and maintain their links with other rules.
1. Go to the Rules tab of the application that you want to update.
2. Click the row and view the description of the rule that you want to delete.
Rules can contain actions that conflict with each other. Use the conflict resolution for the particular
action.
Fields that are defined in an application or questionnaire are used in an action. For example, fields
can be added to a section on the layout of an application or questionnaire, and then be conditionally
required or hidden by an Apply Conditional Layout (ACL) action.
Action types
The following table describes Action Types.
Action Type Description
Apply Configures dynamic record layouts based on the state of the record.
Conditional
Layout
Filter Values List Restricts the values available for selection in a Values List field to a subset of
Items the values defined for the field.
Set Date Configures and sets a value for a Date field that can be overridden.
Set Values List Configures and sets a value for a Values List field that can be overridden.
Selection
Action tasks
l Adding Apply Conditional Layout Actions
l Adding Filter Values List Item Actions
l Adding Generate Notification Actions
l Adding Set Date Actions
l Adding Set Values List Selection Actions
Delete an action
If you no longer need an action, you can delete it from the system. Deleting an action removes it
from the Action Library and disassociates it from any rules to which it is linked. You can
disassociate an action from a rule without deleting the action.
1. Go to the Actions tab of the layout that contains the action that you want to delete.
2. In the Action Library section, in the row of the action that you want to delete. click .
3. Click OK.
4. Click Save or Apply.
l Click Save to save and exit.
l Click Apply to apply the changes and continue working.
ACL The ACL action has a Record Permissions field selected with a default value of
Action User A.
Setup
Action Description
Initial When the record is initially created, there is no value committed in the database for
Record the Record Permissions field. The ACL action does not apply to any users.
Creation
Post- After the record is saved, User A is committed in the database for the Record
Record Permissions field. The ACL action is applied only to User A.
Creation
With the exception of Required field settings, ACLs serve only as a cosmetic treatment to ease data
entry and viewing a form in a particular application or questionnaire. Fields that are hidden by an
ACL action are still available in search results and filters for defining reports, searches, and
notifications. Data that is hidden by an ACL action to a user cannot be printed or exported by that
user. Field access permissions are still applied for printing and exporting.
The Layout Configuration section enables you to select which sections and fields in the application
to display as a result of this action.
l The key icon indicates a key field and the calculator icon indicates a calculated field.
l The user must have edit privileges to edit a field. The settings on this page do not grant edit
privileges to an account that does not already have those privileges.
l Be careful if choosing to hide a required field. The field is still required, even if it is not
displayed.
l The settings in this section do not change the layout of the page. To change the layout, use the
Layout tab of the Manage Application page.
l If the layout of the application has multiple tabs, the Layout Configuration section includes
multiple tabs.
l Placeholders may still be displayed for a screen object even though the object is not displayed.
An Apply Conditional Layout action modifies the elements that display within a record and adjusts
the properties of specific fields.
Important: If a field with a base setting of Required is not visible to the user, the user cannot save
the record. To solve this, either modify the application to display the required field for the user, or
change the field settings so that it is no longer required.
After the action is saved, you can link the action to the applicable rule. The relationship between
rules and actions are specified on the Manage Action page. If the action has been linked to a rule,
the associated rules are listed in the Associated Rules section.
1. Go to the Actions tab of the layout that you want to update.
Sections and fields that are hidden by an ACL action are still available in search results and filters
for defining reports, unless otherwise controlled by field permissions. If a field contains multiple
conflicting Apply Conditional Layout actions, RSA Archer executes the action that is highest in the
following order of precedence:
1. Section-level Read Only
2. Section-level Display*
3. Section-level Do Not Display
4. Section-level Use Default Settings
5. Field-level Required
6. Field-level Read Only
7. Field-level Display
8. Field-level Do Not Display
9. Field-level Use Default Settings
*When a Section-level Display action takes precedence, field-level settings are respected. For
example, if an action sets a section to Do Not Display and another action sets a field within the
section to Read Only, the section is not displayed because the section-level Do Not Display setting
takes precedence.
Section-Level options
Sections determine how fields are organized on the layout of an application or questionnaire. A
section-level option can override a field-level option.
The following table describes section-level options.
Option Description
Use All fields and objects in the section are displayed. Individual fields and objects in the
Default section can have field-level options configured.
Settings
Display All fields and objects in the section are forced to display (subject to the user having field
permissions to that field). Individual fields and objects in the section can have field-level
options configured.
Option Description
Read All fields in the section are displayed as read only and are not available for editing.
Only Affects all of the fields in the section, but does not impact the non-field objects in the
section, such as custom interface and text box objects. Individual fields in the section
cannot have field-level options configured. Objects in the section function as originally
configured.
Do Not All fields and objects in the section are not displayed. Individual fields and objects in the
Display section cannot have field-level options configured.
Field-Level options
Fields are defined in an application or questionnaire and then used in an action. Fields are added to
sections on the layout and can be conditionally required or hidden by an ACL action. A section-level
option can override a field-level option.
The Required setting of Field A is removed, and Field A inherits the Do Not Display
Result
section-level setting.
Display Field is forced to display (subject to the user having field permissions to that
field).
Read Only Field is displayed as read only and is not available for editing.
The Read Only option is not available for fields that are inherently read only, for
example, System fields.
Option Description
Field-level rules
l An ACL action does not give users added field permissions, but it can restrict them. If a field is
set to Display and the user does not have read permissions to the field, the field is still hidden
from the user. If a user has full permissions to a field that is set to Read Only in an ACL action,
the user cannot modify the field.
l If a field is not displayed because of an ACL action, a user with field permissions can still search
the field and functions, such as data feed, and Web APIs can still reference the field.
l A field that is defined as required in an application can be set to one of the following options: Use
Default Settings, Display, Do Not Display, and Read Only. If a required field is set to Read Only
or Do Not Display and is hidden, the field is still required and a user cannot save the record.
l For the user to save the record, do either of the following:
o Modify the ACL action to display the field.
o Change the field in the application so that it is not required.
l Text box objects, custom objects, and trending charts have the following options: Use Default
Settings, Display, and Do Not Display. Placeholder objects cannot be modified by an ACL action
and do not have any available options.
l Changes to an application can affect previously configured field-level options. If a field with
field-level options is moved to a new section, the field-level options are evaluated according to
ACL Conflict Resolution rules of precedence. Specifically, field-level options are affected when
the new section has section-level options that are more restrictive than the field-level options of
the field.
When a User/Groups List or Record Permissions field is selected in an ACL action, only the data
committed in the database is used for determining whether an ACL action is applied to the specified
user.
Users, groups, or fields can be excluded from viewing the layout. The ACL action is not applied to
any user, group, or field that is excluded.
Exclude The ACL action will not be applied to a user who is explicitly excluded.
User
Rule Behavior
Exclude The ACL action will not be applied to all users who belong to the group that is explicitly
Group excluded.
The Cascade option is not selected by default.
l If the Cascade option is selected for a group that is included, all users belonging to a
sub-group and any member of the group is included.
l If the Cascade option is selected for a group that is excluded, all users belonging to a
sub-group and any member of the group is excluded.
The ACL action does not apply to User A because the Audit Management
Results group is selected for exclusion and User A is a member of the Audit
Management group.
Exclude Any user that is selected in the user/groups list or record permissions field will be
Field excluded if the field is excluded.
A user who is explicitly included will be excluded if the user is selected in the field and
the field is excluded.
When a user/groups list or record permissions field is selected for inclusion or exclusion
in an ACL action, only the data committed in the database is used for determining
whether a user is included or excluded from the ACL action.
Multiple ACL actions can apply to the same user at the same time. When multiple ACL actions
attempt to apply conflicting behaviors, RSA Archer executes the action that is highest in the
following order of precedence:
1. Section-level Read Only
2. Section-level Display*
3. Section-level Do Not Display
4. Section-level Use Default Settings
5. Field-level Required
6. Field-level Read Only
7. Field-level Display
8. Field-level Do Not Display
9. Field-level Use Default Settings
*When a Section-level Display action takes precedence, Field-level settings are respected.
The section is not displayed and the field is not required because Action 1 (section-level
Result
Do Not Display) takes precedence.
Result The section is read only because Action 2 (section-level Read Only) takes precedence.
The section is displayed, field X is set to required, and field Y is not displayed.
Because Action 1 (section-level Display) takes precedence, the section is displayed and
Result field-level settings are respected.
Because Action 3 (field-level Required) takes precedence over Action 2, Field X is set to
Required. There is no conflict with Field Y, so it is set to Do Not Display by Action 2.
Example: Filtering a values list using a filter values list items action
The following table provides an example of filtering a values list using a filter values list items
action.
Field A is a Values List field with the following available values: Red, Orange,
Yellow, Green, and Blue.
Scenario
Action 1 is a Filter Values List Items action that filters the list to Red and Blue.
Action 1 is linked to Rule 1.
When Rule 1 is true, Field A is automatically filtered to the values of Red and Blue
Result
making them the only values available for selection.
l If a child value in a hierarchical values list is selected in a Filter Values List Items action and the
parent value is not, the parent value is displayed after the action is executed but is not available
for selection.
l If a values list field is the target of a Filter Values List Items action and is deleted, the Filter
Values List Items action is also deleted.
l If a value list value is selected in a Filter Values List Items action and is deleted, that value is
removed from the Filter Values List Items action. If that value is the only value selected in the
action, the field is also deleted from the Filter Values List Items action.
l If a values list has an existing selection that is not in the filtered subset of values for the Filter
Values List Items action, the existing selection is removed when the Filter Values List Items
action executes.
Example: Replacing a value in a values list through a Filter Values List Items action
The following table provides an example of replacing a value in a values list through a Filter Values
List Items action.
Field B is a values list field with the available values of Red, Orange, Yellow, Green,
and Blue.
When Rule 1 is true, the current value (Green) of Field B is replaced by the filtered
Result
values of Red and Blue making them the only values available for selection.
The Cumulative Filters option on the Options window allows Filter Values List Items actions that
target the same field in different rules to have a cumulative effect.
When all three rules are true at the same time, the following occurs in this order:
1. When Rule 1 is true, the list is filtered to Red being available for selection, and the
current value of Orange is not selected.
2. When Rule 2 is also true, the list is filtered to Red and Orange being available for
Result selection, and the current value of Orange is selected.
3. When Rule 3 is also true, the list is filtered to Red, Orange, and Yellow, making
these values available for selection.
As an end result, the values Red, Orange, and Yellow are available values for selection
and the current selection (Orange) remains selected.
You can create a Filter Values List action that limits the items available in a Values List field. For
example, if a Values List field contains these values by default: Red, Green, Yellow, Orange, and
Blue, you can create a Filter Values List action that excludes Orange and Blue and displays only the
Red, Green, and Yellow values.
If multiple Filter Values List actions target the same field within in the same rule, they have a
cumulative effect. For example, if the example Filter Values List described above is executed, and
then an additional Filter Values List action is executed that displays only Blue, the field displays the
Red, Green, Yellow, and Blue values. However, if the Filter Values List actions are not in the same
rule, the system only executes the Filter Values List action that is highest in the rule order.
You cannot select a calculated values list field. After the action is saved, you can link the action to
the applicable rule. The relationship between rules and actions are specified on the Manage Rules
page. If the action has been linked to a rule, the associated rules are listed in the Associated Rules
section.
1. Go to the Actions tab of the layout that contains the event you want to update.
When there are multiple Filter Values List Items actions linked to the same rule, the actions are
cumulative.
Example: Filter Values List Items action linked to the same rule
The following table provides an example of the Filter Values List Items action linked to the same
rule.
Field C is a values list field with available values of Red, Orange, Yellow, Green, and
Blue.
Scenario Action 1 is a Filter Values List Items action that filters the list to Red and Blue.
Action 2 is a Filter Values List Items action that filters the list to Orange and Yellow.
Action 1 and Action 2 are linked to Rule 1.
When Rule 1 is true, Field C is automatically filtered to values Red, Orange, Yellow,
Result
and Blue making them the only values available for selection.
Example: Values list targeted by Filter Values List Item and Set Values List Selection
actions
If multiple Filter Values List Items actions targeting the same values list field are linked to different
rules that are true at the same time, only the Filter Values List Items action linked to the rule with
the highest rule order is applied.
The following table provides an example of the Values list targeted by Filter Values List Item and
Set Values List Selection actions.
Field D is a Values List field with available values of Red, Orange, Yellow, Green,
and Blue.
Action 1 is a Filter Values List Items action that filters the list to Red and Blue.
Scenario Action 2 is a Filter Values List Items action that filters the list to Orange and Yellow.
Action 1 is linked to Rule 1.
Action 2 is linked to Rule 2.
Rule 1 is ranked higher than Rule 2.
When both Rule 1 and Rule 2 are true at the same time, Field D is automatically
Result
filtered to values of Red and Blue making them the only values available for selection.
Example: Values list targeted by Filter Values List Item and Set Values List Selection
actions
If a Set Values List Selection action and a Filter Values List Items action targeting the same Values
List field are in conflict, only the Filter Values List Items action is applied.
The following table provides an example of the Values list targeted by Filter Values List Item and
Set Values List Selection actions.
Field E is a Values List field with available values of Red, Orange, Yellow, Green,
and Blue.
Action 1 is a Set Values List Selection action that sets the values of Green and Blue.
Scenario
Action 2 is a Filter Values List Items action that filters the list to Red and Blue.
Action 1 is linked to Rule 1.
Action 2 is linked to Rule 2.
When both Rule 1 and Rule 2 are true at the same time, Field E is automatically filtered
to values of Red and Blue making them the only values available for selection.
The field is also automatically set to a value of Blue. (There is no conflict between
Result
Action 1 and Action 2 for the value of Blue.)
Green is not selected because there is a conflict between Action 1 and Action 2, and
therefore only the Filter Values List Items action (Action 2) is applied.
Because Generate Notification actions execute after calculated fields are computed, it is possible to
have two actions (one being a Generate Notification action) linked to the same rule where one
action executes and the other one does not.
Note: There is no conflict resolution for Generate Notification actions. These action types are
executed when content is saved for rules that are true.
The following table provides an example of generate notification actions linked to separate rules.
New Record A is added.
Action 1 is a Generate Notification action with its frequency set to Instantly.
Scenario Action 2 is a Generate Notification action with its frequency set to Instantly.
Action 1 is linked to Rule 1.
Action 2 is linked to Rule 2.
When Record A is saved and both Rule 1 and Rule 2 are true, two notifications are sent
Result
(one for Action 1 and one for Action 2).
The following table provides an example of multiple generate notification actions linked to the same
rule.
New Record A is added.
Action 1 is a Generate Notification action with its frequency set to Instantly.
Scenario Action 2 is a Generate Notification actions with its frequency set to Instantly.
Action 1 is linked to Rule 1.
Action 2 is linked to Rule 1.
When Record A is saved and Rule 1 is true, two notifications are sent (one for Action 1
Result
and one for Action 2).
The following table provides an example of generate notification action linked to multiple rules.
New Record A is added.
Action 1 is a Generate Notification action with its frequency set to Instantly.
Scenario
Action 1 is linked to Rule 1.
Action 1 is linked to Rule 2.
When Record A is saved and both Rule 1 and Rule 2 are true, only one notification is
Result
sent because both rules are linked to the same Generate Notification action (Action 1).
You can create a Generate Notification action that delivers alert emails to select users when a
record is added or updated. It can also send reminder emails based on date values. Recipients cannot
opt out of receiving these emails.
To set up a notification from which users can choose to unsubscribe, use the Notifications feature
instead.
1. Go to the Actions tab of the layout that contains the event that you want to update.
6. In the Body Layout field, click to open the Body Layouts dialog box.
7. Select the applicable layout and click OK.
8. Click Apply.
2. In the Template Design section, select the subject and content for the notification.
a. In the Subject line, enter the text you want to show as the subject of the notification.
Note: You cannot include the following fields in the subject line: Attachment, Cross-
Application Status Tracking, Image, Record Permissions, Sub-Form, Questionnaire
Reference, Access History, and History Log.
b. In the Body field, enter the content you want to show in the notification as text or reference
links.
l To enter a field, select the field or template you want for the admin type from the Toolbar
field.
l To enter a report, select the report you want from the Toolbar field.
l To enter a link, select the link you want from the Toolbar field.
You can also include fields (but not reports or links) in the subject line as dynamic information.
To enter a field, place your cursor in the location, click the Select a Field arrow and select the
appropriate field from the list.
3. Click Apply.
2. In the Email Properties section, enter the email properties for this notification.
a. In From Address field, enter the email address from which this notification will be sent.
b. (Optional) In the Alias Field, enter the name you want to use as the sender for the email from
address.
c. (Optional) In the Importance field, select the status you want to associate to this
email: Normal, High, Low.
d. (Optional) In Read Receipt, select whether an acknowledgment is sent after the notification
is opened by the recipient.
l If you want to receive acknowledgment, select Enable Return Receipt.
l If you do not want to receive acknowledgment, select Disable Return Receipt, the default
selection.
3. In the Delivery Schedule section, define the frequency and its values for sending this
notification.
a. In the Frequency field, select the period in which you want to send the notification. Your
selection determines what you do next.
b. Enter the applicable values for the frequency you selected.
Note: Instantly and Reminder are not available for Scheduled Report Distributions.
Daily a. In Time, set the time that you want to send the notification.
b. In Time Zone, select the Coordinated Universal Time (UTC) time zone.
Frequency Action
Weekly a. In Day, select the day of the week that you want to send the notification.
b. In Time, set the time that you want to send the notification.
c. In Time Zone, select the Coordinated Universal Time (UTC) time zone.
Monthly a. In Day, select the day of the month (1 through 31) that you want to send
the notification. Because not all months have 31 days, you might want to
consider 28 or before.
b. In Time, set the time that you want to send the notification.
c. In Time Zone, select the Coordinated Universal Time (UTC) time zone.
Quarterly a. In Time, set the time that you want to send the notification.
b. In Time Zone, select the Coordinated Universal Time (UTC) time zone.
Reminder a. In Time, set the time that you want to send the notification.
b. In Time Zone, select the Coordinated Universal Time (UTC) time zone.
c. In Criteria, do the following:
i. In Field, select the date field to be used for evaluating the filtering
condition.
ii. In Operator, select the applicable operator, Equals, Does Not Equal,
Less Than, or Greater Than.
iii. In Day, select the number of days on which to evaluate the
occurrence.
iv. In Target, select After Date or Before Date.
d. (Optional) To add another condition, click Add New and repeat the steps
for adding criteria.
e. (Optional) To delete a criteria row, click .
Note: When you choose Reminder for your frequency, Email Recipients
Options can only be set to Separate Emails.
c. In Digest Content Published, do one of the following for records that satisfy the specified
Notification filter criteria and were generated or changed within the time period as defined
by the Frequency and Time settings:
l Select Any Version to include any records that satisfied filter criteria since the last sent
digest.
l Select Current Version Only to include only records that meet filter criteria at the time
digest notification is sent.
4. Click Apply.
Send Each l Separate Emails - Sends a separate email to one or more recipients.
Notification Addressees receive an email that has been customized for permissions,
As culture, time zone, and locale. This option allows you to use only the To field
for recipient email addresses.
l One Email - Sends an identical email to multiple recipients. This option is
primarily intended for a limited number of recipients and is not customized for
permissions, culture, time zone and locale. If there is no content in the
notification that all recipients have permission to view, the notification is not
sent.
This feature allows you to use the To, Cc, and Bcc fields for recipient email
addresses. The maximum allowable number of recipients for this option,
expressed as a total from all three addressee fields, is determined in the
RSA Archer Control Panel.
2. In the Recipients section, do the following for To, CC, and BCC:
a. (Optional) In Dynamic, do one or more of the following:
l Expand the Groups tree and select the groups you want to receive the notification.
l Expand the Users tree and select the users you want to receive the notification.
l Expand the Fields tree and select the fields that contain the dynamic recipient based on
record permissions or email address.
b. Click OK.
c. (Optional) In Static, enter email addresses of the recipients you want to receive the
notification. When entering more than one email address, use a semi-colon to separate the
email addresses of recipients.
3. Click Save.
Important: When a data driven event includes a rule with a Set Date action and is used in a
questionnaire, the Review Date and Submit Date fields must be included in the General section of
the questionnaire. By default, this section includes these fields.
Current Date Sets the date field to the current date (and time to 12:00 A.M., if
enabled).
Set to Number of Days Sets the date field to the current date plus the specified number of days
from Current Date from the current date (and time to 12:00 A.M., if enabled).
Set to Specific Date Sets the date field to the date specified (and time, if enabled).
Set to Date Field to Removes any value currently set in the date field.
Blank
When both Rule 1 and Rule 2 are true at the same time, Field B is automatically set to
Result
the Current Date.
You can create a Set Date action that changes the value displayed in a date field. You can set the
value to the current date, to a number of days from the current date, to a specific date, or set the
field to blank. If the date field is configured to include date and time, you can set the date, time, and
time zone.
You cannot link more than one Set Date action for the same date field in the same rule. If a rule set
has multiple Set Date actions for the same date field, only the first Set Date action is executed.
Important: A calculated field cannot be the target of a Set Date action. If a Set Date action is
defined and the target date field is later changed to a calculated field, the Set Date action is deleted.
7. From the Date Option list, select the date that you want to insert.
The following table describes the options.
Option Description
Set to Number of Days In the Future Days field that displays, specify the appropriate
from Current Date number of days in this field.
Set to Specific Date In the Specific Date field that displays, specify the appropriate
date.
If the field is configured for date and time, additional fields
display. Specify the time, if applicable.
Set Date Field to Blank If that field is a required field, the system prompts the user to
insert a date.
8. Click Save.
of the field is specified as 2, the rule cannot be saved. The existing Set Values List Selection
action must be modified to set a second value, or a second Set Values List Selection action that
sets an additional value must be linked to the rule.
Note: Changing the Minimum Selections and Maximum Selections fields after a rule is defined
does affect the validity of the Set Values List Selection action. These fields can be changed and
then saved without appearing to be in conflict with the action values specified. You must make
certain that all action values match the defined parameters of the rule.
l If a values list field that is the target of a Set Values List Selection action is deleted, the Set
Values List Selection action is also deleted.
l If a Value Lists value is selected in a Set Values List Selection action and is deleted, that value
is removed from the Set Values List Selection action. If that value is the only value selected in
the action, the field is also deleted from the Set Values List Selection action.
l A Set Values List Selection action replaces any current value selected in a field.
Result When Rule is true, Field C is automatically set to the value of Approved.
When Rule 1 is true, Field D is automatically set to the values of Reason 2, Reason 3,
Result
Reason 4, and Reason 5.
When both Rule 1 and Rule 2 are true at the same time, Field E is automatically set to
Result
Value 1.
You can create a Set Values List Selection action that selects one or more specific values within a
values list field. This action changes the default value in the field. The user can edit this value, if
needed. For example, if a values list field has the options Yes, No, and Not Applicable, you can
create a Set Values List Selection action to automatically set the value in the field to Yes.
If multiple Set Values List Selection actions linked to the same rule affect the same values list field,
they have a cumulative effect. For example, if one action sets the value to Red and a subsequent
action in the same rule sets the value to Blue, the final value is Red and Blue.
Important: You can only select a values list field and cannot select a calculated values list field.
7. Click in the Value(s) field to select the value or values that you want displayed for selection.
Note: If you select No Selection, you cannot select other values for the action.
8. Click Save.
Event Analyzer
The Event Analyzer dialog box shows a real-time summary of the rules and actions in an application
and how the conditions are evaluated. The Event Analyzer dialog box shows the following
information:
l Rules evaluated
l Conditions evaluated (true or false)
l Actions executed
Use the Event Analyzer to validate the actions against the conditions of DDE rules in real time. If a
problem is detected, you can make the necessary modifications to the DDE and validate the rule
again until the expected results are achieved.
Any change a user makes to the content that triggers a rule to be evaluated is logged to the analyzer
console window.
The information logged to the analyzer console window includes:
l Any rule that was evaluated.
l The true or false result of each individual filter condition in the rule.
l Any corresponding actions that were applied as a result of the overall rule evaluating to true.
1. Open the application that contains the data driven events that you want to troubleshoot.
a. From the menu bar, click the Solution Name menu.
b. From the Solutions list, click the solution.
c. From the applications list, click the application.
d. From the Record Browser, select the record.
Note: You can also close the record to automatically disable the monitoring process.
Chapter 8: Layouts
By default, each application and questionnaire contain a Layout tab, which enables users to create a
single layout for an application or questionnaire. When a user adds an advanced workflow to an
application or questionnaire, the Layout tab becomes the Layouts tab, enabling users to create
multiple layouts per application or questionnaire.
From both the Layout and the Layouts tab, you can create an intuitive interface for users as they add
and edit records in an application, questionnaire. You can specify which fields appear on and off the
layout, whether they display in tab sets, sections, supporting text or custom controls.
Note: Sub-forms only have a Layout tab as they do not support the advanced workflow feature.
Important: When modifying layouts from within the Workflow Process Designer, you cannot add
new fields or update existing fields. You can only add or remove existing objects to or from the
layout and arrange existing objects on the layout. If you wish to modify field attributes or add new
fields, you must do this from the Layouts tab.
2. Create an advanced workflow. For more information, see Create an advanced workflow.
3. Click the Layouts tab.
4. Click Add New.
5. In the Creation Methods section, select a method for creating a layout, and click OK.
6. Complete the General tab.
7. Click Save.
1. Go to the application or questionnaire to that contains the advanced workflow to which you want
to add an additional layout.
Important: The designated key field in the application must be on the page layout. Always include
the key field when adding fields on the layout.
Note: If you want a field to remain active, but do not want the field to be visible to users, you can
leave the field in the Available Fields list instead of placing the field on the page layout. For
example, you can have a system field that is referenced in a formula for a calculated field. It would
be important for the field to remain active so the system can continue to populate the value of the
field and use those values in calculations, but you might want to hide the field from your users' view.
Note: For questionnaires, the Review Date and Submit Date fields must be on the layout to be
updated by the Set Date action of a data driven event. In addition, the Set Date actions for setting
the review date and setting the submit date are created in DDE rules for Set Review Date and Set
Submit Date. By default, the Review Date and Submit Date fields are in the General Information
section of the page layout.
l If you are working in a two-column layout and want a field to span across columns, do the
following:
Do not span columns The element consumes only one column of space.
Span two columns The element always spans across the two columns.
3. Select one of the following options from the Row Span section.
The following table describes the options.
Option Description
Span The element consumes the number of rows you select from the Rows
span box.
2. (Optional) For a leveled application, select the data level from the Level list in the left pane for
the layout you want to update.
3. From the Available Fields list, click the field you want on the layout and drag it to the location
you want.
4. Continue this process until all fields that you want are on the layout.
5. Click Save or Apply.
l Click Save to save and exit.
l Click Apply to apply the changes and continue working.
Do not span columns The element consumes only one column of space.
Span two columns The element always spans across the two columns.
3. Select one of the following options from the Row Span section.
The following table describes the options.
Option Description
Span The element consumes the number of rows you select from the Rows
span box.
e. If you have Advanced Workflow enabled, open the layout that you want to update, and click
the Designer tab.
2. In the left pane, expand the Add New Layout Object list.
3. Click and drag the Add Section option to the layout area.
4. In the Section Name field, enter the heading that you want to display in the layout.
5. In the Default Visibility field, select the Expanded or Collapsed option depending on whether you
want the section to be expanded or collapsed by default.
6. (Optional) Do one or both of the following to add panel text or help text to the section:
l To add an information panel to provide your users with additional details about the section,
select Panel Text and enter the text that you want to display.
l To add Help text to provide your users with detailed instructions and background information
about the section, select Help Text and enter the text that you want to display.
7. (Optional) Customize your text and add dynamic elements, such as images and Flash animation,
using the options available in the Rich Text Editor toolbar.
8. Click OK to close the Section Description dialog box.
9. Click Save or Apply.
l Click Save to save and exit.
l Click Apply to apply the changes and continue working.
2. (Optional) For a leveled application, select the data level from the Level list in the left pane for
the layout you want to update.
3. In the left pane, expand the Add New Layout Object list.
4. Click and drag the Add Text Box option to the layout area.
5. In the Text Box Name field, enter a name for the text box.
6. In the Text field, enter the text that you want to display in the text box when it is displayed for
users as they add, edit, or view records.
7. Select one of the following options.
The following table describes the options.
Field Description
8. Click OK.
9. Click Save or Apply.
l Click Save to save and exit.
l Click Apply to apply the changes and continue working.
2. (Optional) For a leveled application, select the data level from the Level list in the left pane for
the layout you want to update.
3. In the left pane, expand the Add New Layout Object list.
4. Click and drag the Add Placeholder option to the layout area.
5. Click Save or Apply.
l Click Save to save and exit.
l Click Apply to apply the changes and continue working.
Note: RSA recommends that only trusted administrators create and edit custom layout objects, as
this flexibility introduces a potential attack vector.
2. If you are working in a leveled application, from the Level list in the left pane, select the data
level that contains the layout you want to manage.
The fields and other page elements for that level are displayed in the layout area and in the
Available Fields list.
3. In the left pane, expand the Add New Layout Object list.
4. Click and drag the Add Custom Object option to the layout area.
5. In the Name field, enter a name for the custom object.
This name is displayed on the Layout tab of the Manage Applications or Manage Questionnaires
page, but it is not displayed for users when they add, edit, or view records in the application.
6. In the Description field, enter a description for the object.
7. In the Code field, enter or paste the HTML or JavaScript code for the object.
8. In the Display section, select one of the following modes for the object to be displayed as users
add and edit records in the application.
9. Click OK.
10. Click Save or Apply.
l Click Save to save and exit.
l Click Apply to apply the changes and continue working.
2. In the left pane, expand the Add New Layout Object list.
3. Click and drag the Add Trending Chart option to the layout area.
4. In the Name field, enter the heading that you want to display in the layout.
5. From the Trending Field list, select the trending-enabled field for which to display chart data.
6. (Optional) In the Show Title field, click the Display the chart name as the title when users open
the application or questionnaire.
7. Click OK.
8. Click Save or Apply.
2. In the left pane, expand the Add New Layout Object list.
3. Click and drag the Add Report Object option to the layout area.
4. In the Name field, enter a name for the report object.
Note: This name displays on the Layout tab of the Manage Applications or Manage
Questionnaires page, but does not display for users when they add, edit, or view records in the
application.
Note: Only global and search based reports are available for selection.
7. (Optional) Add or update filter options for how you want to view the report.
Note: If the selected report has default filters, they are automatically populated as existing
filters.
a. In the Field to Evaluate field, select the field to evaluate for one or more specific values.
b. In the Operator column, select the filter operator. For more information, see "Report
Operator Field Types" in the RSA Archer Online Documentation.
c. In the Value(s) column, select the values for the condition. Depending on the operator type,
the selection can be a value or a field.
d. (Optional) To create additional conditions, click Add New and repeat steps a-c.
e. (Optional) If you create more than one condition, apply logic to your filter criteria in the
Advanced Operator Logic section. For more information, see "Advanced Operator Logic" in
the RSA Archer Online Documentation.
8. In the Load Report section, select one of the following modes for the report object to be
displayed as users add and edit records in the application.
The following table describes the modes.
Field Description
9. In the Display section, select one of the following modes for the record object to be displayed as
users add and edit records in the application.
The following table describes the modes.
Field Description
Note: If a user does not have access to any of the fields on a tab, the tab is not displayed when the
user adds or edits records. Using data driven events, tabs can be dynamically shown or hidden based
on the current state of content, including nested tabs. When a data driven event hides all sections on
a tab, the tab is also hidden.
Important: If you want to add a new section to the layout and give it the same name as a new tab
set, you must add the section before you add the tab set.
.
b. Under Application Builder, click Applications, Questionnaire, Sub-Forms.
c. Select the application, questionnaire, or sub-form.
d. Click the Layout tab.
e. If you have advanced workflow enabled, open the layout that you want to update, and click
the Designer tab.
Contains Includes any record that has a value that matches the specified filter values.
Operator
Description
Type
Contains Includes any record with a value within a specified hierarchical global values list
Inclusive value. This operator considers the entire hierarchy below the value specified as a
match.
For example, if using a values list for Location that has three levels (Country >
State/Province > City) and you want to find all records in Missouri, Contains Inclusive
United States > Missouri returns the results:
l United States, Missouri
l United States, Missouri, Kansas City
l United States, Missouri, St. Louis
l United States, Missouri, Columbia
Does Not Includes any record that does not have a value that matches the specified filter values.
Contain
Does Not Includes any record that does not have a value within a specified hierarchical global
Contain values list value, and also excludes the entire hierarchy below the value specified.
Inclusive For example, Does Not Contain Inclusive United States > Missouri returns any
selection at the Country, State, City level not under Missouri.
Equals Includes records with values that exactly match to the specified filter values. For
Date fields, date and time values can be included in the filter.
Does Not Includes only the records with values that do not match the specified filter values. For
Equal Date fields, date and time values can be included in the filter.
Current Includes only records of the current interval. Available intervals include:
l Minutes
l Hours
l Days
l Months
l Quarters
l Years
Operator
Description
Type
Last Includes records based on the selected interval previous to the current interval.
Available intervals include:
l Minutes
l Hours
l Days
l Months
l Quarters
l Years
This filter does not include records of the current interval. For example, if you filter
"Last" "3" "Days", the results include the previous three days, but do not include the
current day. To include the current day, add another filter condition to the search
criteria that includes the "Current" "Day".
Next Includes records based on the selected interval after the current interval. Available
intervals include:
l Minutes
l Hours
l Days
l Months
l Quarters
l Years
This filter does not include records of the current interval. For example, if you filter
"Next" "3" "Days", the results include the next three days, but do not include the
current day. To include the current day, add another filter condition to the search
criteria that includes the "Current" "Day".
Greater Includes only records with values greater than the specified static filter value. For
Than example, when the Field to Evaluate is a date, and the Operator is Greater Than, the
Value is a specific calendar date.
For Date fields, date and time values can be included in the filter.
Less Than Includes only records with values less than the specified static filter value. For Date
fields, date and time values can be included in the filter.
Operator
Description
Type
Between Includes only records with values within the specified date range, or date and time
range, including the date and time selected.
Time Includes only records with values within the specified time range. Dates can also be
Interval specified to further filter the search. Search results include the selected times and
dates.
After Includes records of all dates after the current day, but does not include the current
Today day.
Prior to Includes records of all dates before the current day, but does not include the current
Today day.
Field Includes only records with values greater than the specified dynamic field value.
Value For example, when the Field to Evaluate is a date, and the Operator is Field Value
Greater Greater Than, the Value is a specific field in the record, such as Last Self-
Than Assessment Date.
Field Includes records with values less than the specified dynamic field value.
Value For example, when the Field to Evaluate is a date, and the Operator is Field Value
Less Than Less Than, the Value is a specific field in the record, such as Next Self-Assessment
Date.
Note: Specified field values must be the same type, for example, date to date or
integer to integer.
Field Includes records that match the specified field value in the current record.
Value For example, if the Field to Evaluate is a location, the Field Value Match operator
Match allows you to return only results that match one of a list of specific locations.
Field Includes records that do not match the specified field value in the current record.
Value For example, if the Field to Evaluate is a location, the Field Value Does Not Match
Does Not operator allows you to return results that exclude one of a list of specific locations.
Match
Operator
Description
Type
Field Includes records where any of the values in the Field to Evaluate are also selected in
Value the Value field(s).
Contains For example, if the fields on both sides of the operator are values list fields using a
category list, the report returns any records where the Category field of the related
application (Field To Evaluate) contains at least one of the values specified in the
Value field of the current record.
Field Includes records where any of the values in the Field to Evaluate are not also selected
Value in the Value field(s).
Does Not For example, if the fields on both sides of the operator are values list fields using a
Contain Risk Category list, the report returns any records where the Category field of the
related application (Field To Evaluate) does not contain any the values specified in
the Value field of the current record.
Field Includes any record with a value within a specified hierarchical values list that is
Value found within the current record. This operator allows you to consider the entire
Contains hierarchy below the value specified as a match.
Inclusive
Field Includes any record that does not have a value within a specified hierarchical values
Value list that is found within the current record and also excludes the entire hierarchy
Does Not below the value specified.
Contain
Inclusive
Field For Filter By Record ID - Filter By Record ID is applied against the current record
Value displaying the report object.
Equals For Cross-reference or Related Record, the filter only returns records where the
Current cross-reference or related record field's only selection is the current record displaying
Record the report object.
For example, use this filter to create a report that shows all Risk By Risk Category
for each business process where its parent Business Unit is the current Business Unit
being viewed.
Field Includes any record with values that do not equal a specified value found in the
Value current record.
Does Not For example, use this filter to create a report that shows all Risks By Risk Category
Equal for each Business Process that also shows a breakdown for all other Business Units
Current other than the current Business Unit viewed.
Record
Operator
Description
Type
Field Includes records that have at least the current record selected in the specified
Value reference field or are filtered by record ID.
Contains
Current
Record
Field Includes records that do not have at least the current record selected in the specified
Value reference field or are filtered by record ID.
Does Not
Contain
Current
Record
Field Includes records that match a specified level of a hierarchical values list. The number
Value of operators available is based on the number of levels in the list.
Contains For example, if you use a values list for Location that has three levels (Country,
Depth x State/Province, City) and you want to find all records in Missouri even when a city
within Missouri is selected, Field Value Contains Depth 2 returns records with the
following selections:
l United States, Missouri
l United States, Missouri, Kansas City
l United States, Missouri, St. Louis
l United Stated, Missouri, Columbia
Field Includes any record that does not match a specified level within a hierarchical values
Value list and also excludes the entire hierarchy below the level specified.
Does Not For example, Field Value Does Not Contain Depth United States > Missouri returns
Contain any selection at the Country, State, City level not under Missouri.
Depth x
In addition to standard filters, each Report Object field can utilize dynamic filter operators specific
to Report Objects.
The following table provides a list of which filter operators can be applied
to each Report Object field type.
Field Type Filter Operators
Cross-Reference l Contains
l Does Not Contain
l Equals
l Does Not Equal
l Field Value Match
l Field Value Does Not Match
l Field Value Contains
l Field Value Does Not Contain
l Field Value Equals Current Record
l Field Value Does Not Equal Current
Record
l Field Value Contains Current Record
l Field Value Does Not Contain Current
Record
Date l Equals
l Does Not Equal
l Current
l Last
l Next
l Greater Than
l Less Than
l Between
l After Today
l Prior to Today
l Field Value Match
l Field Value Does Not Match
l Field Value Greater Than
l Field Value Less Than
l Field Value Between
IP Address l Equals
l Does Not Equal
l Field Value Match
l Field Value Does Not Match
Numeric l Equals
l Does Not Equal
l Greater Than
l Less Than
l Between
l Field Value Match
l Field Value Does Not Match
l Field Value Greater Than
l Field Value Less Than
l Field Value Between
Text l Contains
l Does Not Contain
l Equals
l Does Not Equal
l Field Value Match
l Field Value Does Not Match
l Field Value Contains
l Field Value Does Not Contain
Deleting Layouts
Only layouts that were created by a user can be deleted. You cannot delete the Default Layout. To
delete a layout from an application or questionnaire, you must have delete rights to that layout.
Note: You cannot delete a layout if it is currently associated with an advanced workflow node.
1. Go to the Layouts tab of the application or questionnaire from which you want to delete a layout.
3. Click .
You can either use the out-of-the-box workflows available in selected applications or create a
workflow unique to your needs. When you create an advanced workflow, you define all the steps
you want the record to go through and choose when to enroll records in the workflow (for example,
when a new record is created or when a user performs some action).
Note: If you make changes to an existing advanced workflow, RSA Archer creates a new version of
the advanced workflow. Newly enrolled items are then enrolled into the new advanced workflow.
For existing enrolled items, an RSA Archer Admin can either let them finish their old advanced
workflow path or use the Job Troubleshooting tool to delete each item from the advanced workflow.
For more information on using the Job Troubleshooting tool, see "Troubleshooting Errors in Running
Workflows" in the RSA Archer Online Documentation.
Note: Applications and questionnaires can have only one advanced workflow, and leveled
applications can have only one advanced workflow per level.
For more information, see "Advanced Workflow" in the RSA Archer Online Documentation.
Terminology
The following table describes the terms that are unique to Advanced Workflow.
Term Description
Process The blueprint for a workflow. The process defines all of the possible paths that a
content record could follow through the steps of your business process.
Term Description
Job A specific instance of a workflow process. A job represents one actual path that a
content record takes through the steps of the business process.
Depending on how you choose to enroll content records into your advanced workflow,
jobs can be created for new records, updated records, or records initiated by the user.
Note: Jobs in an advanced workflow are not related to the RSA Archer Job Engine.
For information about the Job Engine Manager in RSA Archer, see "Configuring the
Job Engine Manager" in the RSA Archer Control Panel Help.
Action Buttons in the content record that prompt end-users for an action or decision and,
buttons when clicked, determine which path in the workflow to follow. Action buttons are
automatically created when you configure transitions out of a User Action node. For
example, you might create Accept and Reject transitions, each of which corresponds
to a different path in the workflow. If a user clicks the Accept action button in the
record, the workflow follows that path.
Action buttons only appear in the content record if the record is in Edit mode.
Custom Additional layouts that display only the information that a user needs while on a
layouts particular step in the workflow process.
Nodes
Nodes represent a single unit of work (step) in the advanced workflow. For example, the following
simple workflow has three nodes: Start, Stop, and Update Content.
Start Node Marks the beginning of the process. A Start node is required.
Stop Node Marks the end of the process. A Stop node is required.
Text Allows you to add comments to any part of the advanced workflow diagram.
Evaluate Allows you to determine the path of the advanced workflow based on values in
Content the content record.
For example, in a purchase request application, you could create rules so that if
the amount of the request is under $1000, the workflow follows an "Approved"
path, and if the amount is over $1000, the workflow follows an "Escalate to
Manager" path.
Send Sends a notification to alert users of the current workflow state or of a task that
Notification they need to complete.
Update Updates values in content record fields. The Update Content node supports text,
Content numeric, date, values list, and User/Group fields.
User Action Waits for the user to take an action or make a decision.
In a User Action node, action buttons correspond to the outgoing transitions and
are displayed in the content record. For example, If you create Approve and
Reject transitions out of a User Action node, your users see Approve and Reject
buttons in the content record.
Note: Action buttons only appear in the content record if the record is in Edit
mode.
A User Action node can have a task associated with it that appears on the
landing screen of the assigned user. The task link takes the user directly to the
record, and the lifecycle of that task corresponds to the time spent on the
Transition node.
Wait for Should be used in combination with an Evaluate Content node. If none of the
Content rules in an Evaluate Content node are met, you can configure the default
Update transition to go to the Wait for Content Update node. The Advanced Workflow
job stays at the Wait for Content Update node until content is saved by the user
or the delay timeout is reached, at which point it reverts back to the Evaluate
Content node.
These system fields are added when you enable advanced workflow in an application or when you
upgrade any application that already has advanced workflow enabled. Once advanced workflow is
enabled, these three fields appear in the Available Fields menu and can be dragged on and off a
layout. You can use these fields to identify records based on workflow data, which can help you
make decisions critical to a business process
The fields are read-only and their properties cannot be changed or edited.
You can use these fields as search criteria the same way you do with other fields and system fields.
For example, if you want to generate a list of pending jobs, you can filter your search by Workflow
Job Status.
The following table describes how these fields interact with other functionality.
Functionality Description
Calculated Workflow fields are not supported in calculated fields, even though the system
fields does not prevent you from selecting them. The status of a workflow job could
change while the content record has not been recalculated.
Data-Driven Workflow fields can be used to filter the records sent in a data-driven event.
Events (DDEs) Changes to workflow fields cannot be used to trigger a data-driven event.
Field Audit Workflow fields are not supported in the field audit feature. Even though the
system does not prevent you from selecting them, the results are unpredictable
and not supported.
History Log Workflow fields are supported in the history log field. By default, the advanced
workflow recorded values are disabled. You must enable them in order to record
advanced workflow values in the history log field. The values are recorded by
the system in the history log field according to the retention policy
Notifications Workflow fields can be used to filter the records sent in a notification. Changes
to workflow fields cannot be used to trigger a notification.
Workflow The current status of the workflow job for a record. Values l Equals
Job Status Possible values are: List l Not
l Scheduled equals
l Pending l Contains
l Running l Not
l Complete contains
l Failed l Between
Workflow The state of a record in a workflow job (for example, Text l Equals
Current which node is active). This field displays the name of the l Not
Node node. equals
contains
l Not
contains
Workflow The version of the workflow process used to create the Numeric l Equals
Process job when the record was enrolled in workflow. l Not
Version equals
l Greater
than
l Less than
l Between
l Not
between
l Node attributes update with the attributes from the process, such as fields in an Update Content
node.
l Existing nodes pick up new transitions when added, including those from Action transition buttons
on the record page
l Transition attributes update with the attributes from the process, such as permissions and rules.
l Nodes added prior to a current node receive the Skipped status.
l When the current node is deleted, then during Bulk Update Jobs the process finds the last
completed node in the completion path and resumes from there. If there are no completed nodes,
then the process resumes from the Start node.
Advanced Workflow at the same time adversely affects record layouts and creates confusion when
identifying when a record has successfully progressed through a workflow.
The following table contains information to help you determine which feature suits your needs best.
Workflow Advanced Workflow
l Create a linear content review process l Create complex non-linear workflow processes
within applications, leveled applications, within applications, leveled applications, or
or questionnaires. questionnaires.
l Send notifications only after content is l Send notifications to multiple users on-demand.
updated and saved by a user. l Enable automatic enrollment for new records,
l Enable only user-initiated enrollment updated records, or user initiated options.
options. l Visually depict the end-to-end advanced
workflow process at the administrator level.
l Designate a specific name for each node to
easily identify the intent of each stage in your
workflow process.
l Create tasks that are linked to the task-driven
landing screen of specified users.
Add a node
2. In the Modeler Toolbox, select the node type that you want to add.
3. Double-click in the grid where you want to place the node.
4. Complete the Node Properties section. For more information on configuring specific node types,
see Step 2 of Building Workflows.
Draw a transition
2. In the grid, click and drag an arrow from one node to another. Make sure that you click the lower
section of the start node (a hand cursor appears).
3. Complete the Transition Properties section:
a. In the Type field, change the transition type if applicable.
By default, most transitions have a default type of Successful, meaning that if the previous
node is completed successfully, the transition is followed. You can also set transitions
coming from a Send Notification or Update Content node to Always Complete, meaning that
the transition is followed regardless of whether the node was completed successfully. For
example, you may not want to stop a workflow job if a notification fails to send, in which
case you would set the transition to Always Complete. Finally, you can use the Error
transition type if you plan to create an error path. For more information, see "Create error
paths" in Troubleshooting Advanced Workflows.
b. In the Name field, enter a name that reflects the transition that is occurring in your business
process.
Note: To assist in troubleshooting, RSA recommends that you choose a unique name that
reflects the stage in your business process that the node represents.
c. In the Looping transition field, select Yes if the transition loops back to a previous node in
the process. For more information, see "Step 3: Create a looping transition" in Building
Advanced Workflows.
d. For User Action nodes, configure rules and permissions as applicable. See Building
Advanced Workflows for more information.
Note: Delete existing nodes and transitions before you add new ones.
Note: You can also press Ctrl+A to select everything in the diagram, or press Shift to select
multiple nodes and transitions.
Note: Rules on the Evaluate Content node do not carry over after a rollback completes.
Note: RSA recommends using the bulk update jobs feature when there are no pending unsaved
changes.
Note: Only one update can run at a time. If an existing update is currently running, a warning
dialog box is displayed.
3. If the workflow has changed since the last save, a dialog window appears with three options to
continue. Do one of the following:
l Click Yes to save.
l Click No to continue without saving.
Note: The Workflow Process Designer does not revert unsaved changes. The unsaved
changes remain on the screen until the user reverts or navigates away from the Workflow
Process Designer.
Note: If there are no jobs on the current version, a dialog box appears indicating no work needs
to be done. Close the window to return to the Workflow Process Designer.
5. The Status window appears with a progress bar to track the progress of the update. Do one of the
following:
l Click Details to get a detailed report about the update.
l Click Close to close the Status window.
l Navigate away from the Status window.
Note: You cannot return to the Status window once you close it or navigate away from it.
Note: View your bulk action history for details on your update. Click the Export button to download
the Bulk Update Jobs Detailed report listing record details. The details on the update are stored for
365 days after creation.
Keyboard shortcuts
If you are using a Mac, use the Command key instead of the Control key as the modifier.
The following table describes available keyboard shortcuts.
Key Description
← ↑ ↓ → (arrow keys) Moves the viewable area one square at a time, in the
direction of the selected arrow.
Note: If you are planning an update of an existing advanced workflow, see Deploying Updates to
Advanced Workflows.
Develop Development 1. Plan your advanced workflow process. See the following sections in
environment this topic.
2. Build the workflow in the application or questionnaire. See Building
Advanced Workflows.
Test Development 3. In the application or questionnaire, create several test records, move
environment them through the steps of the workflow, and verify that each action
you take in the workflow has the intended result.
You can use the Job Troubleshooting tool to see what happens to
each job as it progresses through the workflow. For more information
on job states and resolving errors, see Troubleshooting Advanced
Workflows.
4. Package the application or questionnaire. See Creating Packages.
Note: You may want to create a swimlane diagram or whiteboard your process.
1. The steps in your process and the nodes you need accomplish those steps.
2. The transitions between steps.
3. The users and groups who will be involved in the process and what level of access they require
for different steps.
4. For notifications that you plan to send, who should receive the notifications and what content the
notification should contain.
5. For nodes that can use custom layouts, what content you want your users to see.
Note: In order to create additional layouts, you must first turn on advanced workflow in the
application or questionnaire. Go to the Advanced Workflow tab and click Click here to create a
new workflow.
Note: Users can only complete a step in an advanced workflow to which they are assigned if they
have access rights to the associated records. For information on access roles, see Access Roles.
2. Click .
3. Determine when and how records are enrolled in the advanced workflow. In the Process
Properties panel, in the Content Enrollment section, select one of the following options.
New Each newly created record is enrolled in the advanced workflow process.
Records
Note: If you are creating an advanced workflow for a questionnaire, keep in mind
that questionnaire records are first saved when a user clicks Apply after selecting
the target of the assessment (or when the campaign creates and assigns the
assessments). If you choose to enroll new records, this means that the record would
be enrolled in advanced workflow before the record is first presented to the user.
Keep this in mind in the further design of the questionnaire and workflow. For
example, if you have any required fields in the questionnaire, and the workflow
proceeds through an Update Content node immediately upon enrollment, the
advanced workflow job will enter an error state (unless the required fields have
been populated by the workflow). If the workflow design requires the use of
required fields, one option is to place the workflow into an Evaluate Content...Wait
for Update loop, which can hold the record in that state until a user has populated
the fields. Another option is to use a different advanced workflow enrollment option.
Updated Records are enrolled in the advanced workflow process after they are updated and
Records saved.
User A record is enrolled in a workflow only if the user clicks a specific button. You can
Initiated also choose to configure a rule that defines the conditions under which the record
can be enrolled (for example, if Values List Field A contains value B) and you can
set permissions to determine which users or groups have access to the button in the
UI to enroll the record (for example, only a Record Creator can enroll the record).
The system automatically renumbers the criteria rows, but you may need to modify any
advanced operator logic accordingly.
vi. Click Save.
vii. For each additional outgoing transition from the User Action node that you want to
create a rule for, repeat steps i - vi.
Note: A rule can be edited or deleted by hovering over the corresponding icons next to
the rule name.
Note: To search for a specific user or group, enter the name in the Find field and, if
applicable, select the type from the adjacent list. Click . The results of your search
appear in the Available list in the Search Results node.
Note: You can edit or delete permissions by hovering over the corresponding icon next
to the permission name.
l If you selected Updated Records or User Initiated and you want to allow records to be able to
go through the workflow more than once, in the Settings section, select Allow Re-enrollment.
4. (Optional) If you plan to use Advanced Workflow to send notifications or create tasks for users,
do the following:
a. Click the General tab.
b. In the Options section, do the following:
i. To enable notifications, select the Notifications checkbox.
ii. To enable tasks, select the Task Management checkbox.
5. (Optional) If you want the system to record Advanced Workflow audit information in a history
log field, do the following:
a. In the Audit Settings section of the Properties Panel, select Enable Workflow Auditing.
Note: If you disable Enable Workflow Auditing, the advanced workflow audit information is
deleted from the history log, but not immediately. The information is deleted the next time the
ContentWorkflowAuditCleanup job runs.
b. (Optional) Configure Permissions.
Note: To search for a specific user or group, enter the name in the Find field and, if
applicable, select the type from the adjacent list. Click . The results of your search
appear in the available list in the Search Results node.
Note: You can edit or delete permissions by hovering over the corresponding icon next to
the permission name.
Note: With the exception of the Start and Stop nodes, you can add any of the following nodes your
business process requires and in any order necessary.
Note: All nodes except for the stop node require outgoing transitions before you can save the
advanced workflow. As you configure other node types, you can create outgoing transitions from
those nodes to a stop node, which allows you to save your work in progress.
Note: Assigning unique names for each node (across all advanced workflows) allows you to
search and report against the current node name.
4. To update Text, Numeric, Date, and Values List fields, do the following:
Important: If an Update Content node is configured to set a Values List field, and a data driven
event is also configured to set the same Values List field, the advanced workflow settings take
precedence. Additionally, if you configure the Update Content node to update a Text field, all
text added by a user will be overwritten by the advanced workflow settings.
a. In the section for the field type that you want to add, click .
b. From the Field list, select a field.
c. Enter or select a value for the field.
d. (Optional) To add additional fields of the same type, select the Add Another checkbox.
e. Click Add.
f. If you selected to add another field repeat steps b, c, and e.
5. To update User/Groups fields, do the following:
Note: You can also use the Find field to search for a specific user or group.
Important: The Send Notification node requires an on-demand notification template that is
associated with the application or questionnaire in which you are creating an advanced workflow. If
you do not already have an on-demand notification template associated with the application or
questionnaire, you must first create one. For information on notifications, see Notifications.
1. If you have not already enabled notifications for the application or questionnaire, do the
following:
a. Click .
b. Click the General tab.
c. In the Options section, select the Notifications checkbox.
d. Click Apply.
2. If necessary, create an On-Demand notification template. The template should define the subject
and content of the notification that the node generates, as well as who should receive it.
3. In the General section of the Modeler Toolbox, click Send Notification.
4. In the grid, double-click where you want to place the node.
5. In the Send Notification section, in the Name field, enter a name that reflects the step in your
business process that the node represents.
Assigning unique names for each node (across all advanced workflows) allows you to search and
report against the current node name.
6. In the Settings section, select the notification that you want to use.
7. After you have added the next node in your process, draw an outgoing transition from your
Notification node.
By default, the transition type is Successful. If you want the process to always move to the next
node, regardless of whether the notification is successfully delivered, select Always Complete
instead. If you want to create an error path in your process, see "Create error paths" in
Advanced Workflow Troubleshooting.
Node: Approve and Reject. When the user clicks either Approve or Reject in the record, that choice
determines which transition to follow. For each transition, you can configure a rule that defines the
conditions under which that transition can be followed (for example, if a date field contains a date
prior to the current date) and you can set permissions to determine which users or groups have
access to the action buttons in the UI that transition the record (for example, only a Finding
Reviewer should be allowed to see the Approve or Reject buttons in a finding).
You can also configure the User Action node to create tasks in the Task Management application
when the node becomes active. When the node is completed, the task displays as completed.
Note: If you plan to use the create tasks option, the application must have at least one user/groups
field.
1. If you plan to create tasks and have not already enabled task management for this application, do
the following:
a. Click .
b. Click the General tab.
c. In the Options section, select the Task Management checkbox.
d. Click Apply.
e. Click the Advanced Workflow tab.
2. In the General section of the Modeler Toolbox, click User Action.
3. In the grid, double-click where you want to place the node.
4. In the Node Properties panel, in the Name field, enter a unique name that reflects the step in
your business process that the node represents.
Assigning unique names for each node (across all advanced workflows) allows you to search and
report against the current node name.
5. In the Layout section, do one of the following:
l To assign an existing layout, select the layout from the Layouts list.
Note: You cannot add new fields or update existing fields in a layout created from the
Workflow Process Designer. You can only add or remove existing objects to or from the
layout and arrange existing objects. If you wish to modify field attributes or add new fields,
you must do this from the Layouts tab in the application or questionnaire.
Note: A rule can be edited or deleted by hovering over the corresponding icons next to the rule
name. Only adding or deleting a rule enables the Save Workflow button; other changes, such as
editing the rule properties, do not.
Note: To search for a specific user or group, enter the name in the Find field and, if
applicable, select the type from the adjacent list. Click . The results of your search appear
in the Available list in the Search Results node.
d. Click Add.
Note: You can edit or delete permissions by hovering over the corresponding icon next to the
permission name. Only adding, deleting, or changing the permissions name enables the Save
Workflow button; other changes, such as editing the permissions properties, do not.
10. (Optional) Configure signatures. When interacting with content, you can add another layer of
security by enabling electronic signatures. Electronic signatures allow users to authenticate who
they are before interacting with content.
Note: Signatures can only be configured on the outgoing transition from a User Action node.
i. Click New Signature.
ii. In the Manage Signature window, enter a name and description for the signature.
iii. Choose an Authentication Type from the drop-down.
l User Name / Password
l One-time PIN via Email
One-time PIN conditions are set in security parameters. For more information, see
Adding Security Parameters.
Note: The system removes expired one-time PINs. For more information, see the topic
on "Job Types" in the RSA Archer Control Panel Help.
Note: Attachment field rules apply. For more information see "Configuring an Instance for
Blacklisting or Whitelisting" in the Archer Control Panel Help and Adding History Log
Fields.
Important: When a signature is selected, the User Action node icon becomes and
the transition becomes bolded.
d. To remove a signature from the workflow, select Choose Signature from the Signature field
dropdown.
Note: When a signature is removed, the User Action node and transition return to their
original design.
Note: To view completed signatures, see "Viewing Record History" in the RSA Archer User's
Guide.
Note: The Evaluate Content node evaluates rules from the order in which nodes are listed in the
Node Properties pane. After a rule is evaluated to True, Advanced Workflow stops evaluating any
remaining rules in the list.
By default, the transition type is Successful. If you want to create an error path, see "Create
error paths" in Advanced Workflow Troubleshooting.
5. Define the rules to govern which transition the node should take. Do the following:
a. Click the Evaluate Content node, and in the Rules section, click .
b. From the Transition list, select a transition.
c. Click Add Rule.
d. In the General Information section, enter a name and description for the rule.
e. In the Status field, ensure that Active is selected.
f. In the Criteria section, select which field to evaluate, an operator, the value or values to
match, and (if applicable) the relationship to the subsequent row of filter criteria. Each row
represents one set of filter criteria.
g. (Optional) To add additional rows for specifying more filter criteria, click Add New.
Note: The system automatically renumbers the criteria rows, but you may need to modify any
advanced operator logic accordingly.
Note: The Evaluate Content node evaluates rules from the order in which nodes are listed in
the Node Properties pane. After a rule is evaluated to True, Advanced Workflow stops
evaluating any remaining rules in the list.
6. Select a transition for the node to follow if all the rules governing outgoing transitions evaluate
to false. Do one of the following:
l Add a Wait for Content Update node.
a. Draw a transition from the evaluate content node to the new content change delay node.
b. Click the Evaluate Content node.
c. From the Default Transition list, select the transition that you created.
l From the Default Transition list, select an existing transition.
6. After you have added the next node(s) in your process, draw an outgoing transition from your
Wait for Content Update node.
By default, the transition type is Always Complete, and cannot be changed. RSA recommends
that this outgoing transition returns to the previous Evaluate Content node.
Note: Your Wait for Content Update node can not have more than one outgoing transition.
In most cases you do not need to do anything to change a transition into a looping transition. As you
build an advanced workflow, the system attempts to detect loops and automatically convert
transitions to looping transitions as necessary. However, in some cases the system may not detect
that you have drawn a loop, particularly if you delete and redraw a looping transition. In this case,
you need to manually change the transition to a looping transition.
1. Select the transition.
2. In the Transition Properties panel, in the Looping transition field, select Yes.
2. Click .
3. Click Save or Apply.
l Click Save to save and exit.
l Click Apply to apply the changes and continue working.
Note: All advanced workflows installed in a package are installed as inactive and you must activate
them before use.
Activate a workflow
1. Go to the Advanced Workflow tab of the application or questionnaire that contains the workflow
you want to activate.
3. Click .
4. Click Save or Apply.
l Click Save to save and exit.
l Click Apply to apply the changes and continue working.
Deactivate a workflow
1. Go to the Advanced Workflow tab of the application or questionnaire that contains the workflow
you want to deactivate.
3. Click .
4. Click Save or Apply.
l Click Save to save and exit.
l Click Apply to apply the changes and continue working.
Important: While you can restart a completed advanced workflow job, unpredictable results can
occur. RSA strongly recommends not restarting completed advanced workflow jobs.
1. Plan your advanced workflow updates. Depending on how your organization handles updates,
you may either want to plan and prepare all of your changes in a development environment or
plan in advance the changes that you will make in your production environment during the
deployment period.
2. RSA recommends that you schedule the deployment and contact end-users.
l Plan to deploy the updated workflow over a scheduled period of time, ideally during off hours
to avoid business disruption.
l Contact your advanced workflow end users and inform them that a new version of the
workflow is going to be deployed, that they should complete all work on their currently
enrolled records, and that no new workflow enrollments will be supported during the
deployment period.
3. Check the Job Troubleshooting tool for any active jobs. If you have active jobs, work with your
end users to determine whether the job can be completed or has to be canceled and the record
d. Locate the job that you want to delete, and from the menu, select Cancel.
e. Enter an optional comment, and click Cancel Job.
4. Disable all enrollment options for the current version of the workflow process.
5. (Optional) Lock down access or permissions for record creation while you deploy the updated
workflow.
Important: Any new records that are created, or existing records that are updated while the
current workflow is turned off cannot be supported in the updated workflow. If it’s a new record,
and advanced workflow is enrolled, then that record won’t have a workflow job created. If a
record is updated while workflow is turned off, it may get stuck at that node and may require
workflow troubleshooting.
6. Once you have confirmed that there are no active jobs, deploy the new workflow.
7. Re-enable the appropriate enrollment options.
8. If you canceled jobs for records that you want to use with the new workflow, create new copies
of those records and start the new workflow.
9. Inform your end users that the updated workflow has been deployed and educate them on the
changes.
None - Workflow Process Designer splash screen Check to see if the Advanced Workflow
hangs. Service is running. If it is not running, start
the service.
Advanced workflow HTTP request error: 404 not
found.
General
Error
Error message Description Resolution
type
Advanced Workflow has The advanced workflow must be Before you click Save
unsaved changes. Please save saved separately from the or Apply in the
or revert. application or questionnaire that it application or navigate
belongs to. If you save or close away from the page,
the application without saving the make sure that you do
workflow, your changes will be one of the following:
lost. l Click Save
Workflow to save
any changes in your
process.
l Click and
select Revert to
return to your most
recent saved
version of your
process.
Edits made to this workflow Changes to a workflow process Select the I understand
will only apply to records that design cannot be applied to the implications of
enter workflow after the records that were already performing this
changes are saved. The N enrolled in the workflow. For best operation checkbox,
record(s) that are currently practices for handling workflow and click OK.
using this workflow will updates, see "Deploying Updates
continue to use the previous to Advanced Workflows" in the
version of it until they exit RSA Archer Online
workflow. Documentation.
The workflow does not start A Start node is required. Add a Start node.
with a "Start" node.
Node Node Name requires at All nodes except for a Stop node Add an outgoing
least one outgoing transition. require at least one outgoing transition from the
transition. node.
Node NN: CUST Name is All nodes require a name. This Select the node, and in
required. error only displays if you deleted the Name field, enter
the Name text from a node. text.
Error
Error message Description Resolution
type
Node Evaluate Content The Evaluate Content node Select the Evaluate
requires one default requires that you mark one Content node, and in
transition. outgoing transition as the default. the Default Transition
If all the rules governing outgoing field, select a
transitions evaluate to false, the transition.
workflow follows the default
transition.
Node Evaluate Content: Other than the default transition Select the Evaluate
Except for error and default or transitions marked as an error Content node and add
transitions, each outgoing path, all outgoing transitions from a new rule for each
transition must be configured an Evaluate Content node require outgoing transition.
with one rule. a rule that defines under which For steps, see "Add an
conditions the workflow should Evaluate Content
follow that path. Node" in the RSA
Archer Online
Documentation.
The option requires other Some Values List fields are Update a different
text. Can't be selected. configured to require that the user value or configure the
enter text in an Other text field if value list value not to
Note: This error displays in a particular value is selected. require Other text.
the Add Value dialog box. Advanced workflow cannot
update these values.
Error
Error message Description Resolution
type
Node User Action layout is You must select an existing Select the User Action
required. layout or create a new layout for node, and in the
the User Action node. Layout section, select
the layout that you
want to use or create a
new layout.
Tasks: Group or Permissions If you want to create a task from Do the following:
field for assignees is an User Action node, you must 1. Select the User
required. select either a User/Groups or a Action node, and
Record Permissions field to in the Assigned to
assign the task to. field, click +.
2. Select the group or
permissions field
you want to use,
and click Add.
Tasks: Please select a If you want to create tasks from a Select the User Action
priority for this task. User Action node, Priority is a node, and in the
required field. Priority field, select a
value.
Tasks: Please enter the text In the Select the User Action
for the task subject/task Subject/Description/Resolution node, and in the
description/task resolution. fields, if you select Enter Text, Subject/
you must enter the text you want Description/Resolution
to use. text field, enter your
text.
Error
Error message Description Resolution
type
Node Wait for Content You must select an existing Select the Wait for
Update: Layout is required. layout or create a new layout for Content Update node,
the Wait for Content Update node and in the Layout
to use. section, select the
layout that you want to
use or create a new
layout.
Loops
A process loop was detected You have created a loop in your Do the following:
but none of the transitions workflow process, but none of the 1. Select the
within the loop were transitions in your loop is marked transition that
declared as being upstream. as looping. completes the
Please make one of the loop.
transitions within the loop an
upstream transition. 2. In the Transition
Settings section,
from the Looping
Transition list,
select Yes.
3. Click
.
When you save,
the transition
changes to a
dashed line.
Workflow job failed to Content save fails if the record Contact your RSA Archer
start. cannot be enrolled into an advanced administrator.
workflow for any reason.
Cannot enroll content in This content record has already been Contact your RSA Archer
advanced workflow. The enrolled in advanced workflow and administrator.
content has already been has a job associated with it. The
enrolled and re-enrollment advanced workflow creator has not
is not allowed for records allowed for records in this
in this application. application to be re-enrolled in the
workflow.
There was an error The workflow job ran into an error at Use the Job Troubleshooting
processing this record. the Node Name node. tool to investigate the error.
Please contact your For more information, see
administrator and tell "Troubleshooting Errors in
them this record could not Running Workflows" in the
go past the 'Node Name' RSA Archer Online
stage. Documentation.
Cannot enroll content into The rule associated with the User Contact your RSA Archer
advanced workflow. The Initiated enrollment option has not administrator.
rule conditions associated been met, so the record cannot be
with workflow enrollment enrolled in advanced workflow.
were not met.
Cannot transition to the The rule associated with the Contact your RSA Archer
next advanced workflow transition has not been met, so the administrator.
node. The rule conditions record cannot transition to the next
associated with the node.
selected transition were
not met.
Cannot enroll content into Only users who have been granted Contact your RSA Archer
advanced workflow. You permissions to the User Initiated administrator.
are not authorized to enrollment option can enroll the
perform this action based record in advanced workflow.
on the permissions
configured for enrolling
content.
Cannot transition to the Only users who have been granted Contact your RSA Archer
next advanced workflow permissions to the transition can administrator.
node. You are not click the associated User Action
authorized to perform this button in the record and transition the
action based on the record.
permissions configured for
this transition.
2. Locate your process (for example, by name), and double-click anywhere in that row to open the
associated jobs.
Note: If there are no associated jobs, verify that your workflow is active, that you selected a
content enrollment option, and that records have been created in the application or questionnaire.
3. Locate your job (the Reference number is the tracking ID of your content record), and double-
click anywhere in the row to open the detail view. If the job is in an error state, a red error
message displays in the upper-right corner of the grid.
4. Determine where the job got stuck. Locate the last selected (green) node.
Node states
The following table describes the node states.
State Description Appearance
Planned Downstream from one or more other nodes that have yet to be Dark Gray
completed or skipped. All nodes start as planned. It is unknown
whether this node will be executed in a particular job.
Selected Either has no dependencies or all of its dependencies have been Green
resolved and at least one of the transitions leading to this node was
selected. The node must now be executed.
Complete Previously selected to be executed and the work that is represents Blue
has been completed.
Skipped The node was downstream from one or more nodes and none of the Light Gray
transitions leading to this node were selected. The node does not
need to be executed.
Transition states
The following table describes the transition states.
State Description Appearance
Planned The transition has not been evaluated. All transitions start as Dark Gray
planned.
Selected The source node of the transition is completed and either: Green
l It is the only outgoing transition from that node.
l The criteria for this transition have been met (either a user
clicked an Action button for a transition from a User Action
node, or a rule evaluated to true for a transition from an Evaluate
Content node).
Skipped Either the source node of the transition was skipped or the source Light Gray
node was complete but the transition did not meet its criteria (an
action button was not clicked or the rule evaluated to false).
c. Hover over an error until an icon appears, and click the icon.
d. Note the timestamp of the error message.
6. Depending on which node caused the error, verify the following:
l Evaluate Content node
o Are the associated rules correct?
n Did you make any changes to the fields that are being evaluated?
l Send Notification node
o Is the on-demand notification configured correctly?
o Are notifications enabled for your instance?
o Are notifications enabled for the application or questionnaire?
l Update Content node
o Is the node configured to update at least one field?
o Did you change the validation on any of the fields being updated? For example, did you
make a field required that was previously not required?
l User Action node
o If you chose to create tasks, is Task Management enabled for the application or
questionnaire?
o Are all the fields required for Task Management also required in the record?
o Do the fields that you selected to use for the task subject, description, due date, and
resolution have values entered in them in the record?
7. Check the Advanced Workflow server.log file (located in \\RSAarcher\LogFiles\Workflow) for
more information about the error.
Note: The timestamps of all entries in server.log are in Coordinated Universal Time (UTC). The
timestamps of errors in the Job Troubleshooting tool depend on the time zone of your instance.
Note: RSA recommends using the Job ID to find the actual error in the log message. For
example, from a job in error, the comment might read "Node instance Update Content in job
4726:CUST did not select an outbound path." you would search for "4726:CUST" in the log.
8. Depending on the type of error encountered and your workflow process, determine how you want
to handle the job.
The following table describes the options.
Option Description Steps
Restart Restarts the job from the beginning. Any work previously
1. From the
the job completed is reset and must be completed again.
menu, select
Restart.
2. Click Restart Job.
Cancel Cancels the job. Use this option if you no longer need the
1. From the
the job job or plan to recreate the record and trigger a new job.
menu, select
Cancel.
2. Enter an optional
comment, and click
Cancel Job.
Reset a Resets the node as Selected and resets all downstream 1. In the grid, select
node nodes as Planned. Use if you want to retry the node. the node.
2. In the Actions
section, click
Reset.
Manually Use this option if you want the job to continue regardless
1. From the
move to of whether the node completed successfully. For
menu, select
the next example, you might want to use this option if a
Activate.
node notification failed to send.
2. In the grid, select
the node.
3. In the Actions
section, click
Change State, and
select Complete
Work.
4. From the
Completion Code
list, select the
transition that you
want to follow.
5. Click Complete
Work.
After a formal workflow process is defined for an application, records that are subsequently added
or edited are routed through the process. As records move through content review stages, a detailed
history of all content modifications is electronically maintained by person, date, and time. By
default, this history is configured to retain all fields indefinitely. If this history log is configured to
purge its contents, the workflow information may be lost along with other historical information.
Other history log fields could be placed in the application as well.
In leveled applications, workflow processes are configured separately for each level.
Workflow System-managed field that provides access to the workflow discussion forum for
Comments individual records.
Workflow Read-only field used by the system to manage user access to a record that resides
Assignees in a particular workflow stage.
Field Description
Workflow System-managed field that maintains a change history for each record. All logged
History entries are retained indefinitely.
Accept Saves any changes made to the record and advances it to the next stage in the
workflow process.
Reject Saves any changes made to the record and demotes it to the previous stage in the
workflow process.
Comment Opens a discussion forum dedicated exclusively to the current record. This button only
displays if the Comments option has been enabled for the workflow stage.
Reassign Enables application owners to reassign the record to a different user. This option is
only available to application owners.
History Displays a history log of the record that includes a description of the changes made to
the record during the workflow process. All logged entries are retained indefinitely.
Workflow tasks
l Activating or Inactivating Workflows
l Adding Workflows to Applications
l Adding Workflow Notifications
l Configuring the End Stage of Workflows
l Deleting Workflow Notifications
l Deleting Workflow Stages
l Reordering Workflow Stages
Advanced Workflow at the same time adversely affects record layouts and creates confusion when
identifying when a record has successfully progressed through a workflow.
The following table contains information to help you determine which feature suits your needs best.
Workflow Advanced Workflow
l Create a linear content review process l Create complex non-linear workflow processes
within applications, leveled applications, within applications, leveled applications, or
or questionnaires. questionnaires.
l Send notifications only after content is l Send notifications to multiple users on-demand.
updated and saved by a user. l Enable automatic enrollment for new records,
l Enable only user-initiated enrollment updated records, or user initiated options.
options. l Visually depict the end-to-end advanced
workflow process at the administrator level.
l Designate a specific name for each node to
easily identify the intent of each stage in your
workflow process.
l Create tasks that are linked to the task-driven
landing screen of specified users.
For information about using the Advanced Workflow feature, see Advanced Workflow.
Note: The information described in this topic is specific to the Workflow feature. For information on
the Advanced Workflow feature, see the Advanced Workflow topic in the RSA Archer Online
Documentation.
Note: If no stage has been created before, it will automatically Create a new Stage from
scratch.
5. Click OK.
6. In Stage Name field of the Stage Properties section, enter the name of the stage.
7. In the Advanced Stage Properties section, select the assignment model for the workflow.
Multiple - Edit Assigns ownership to the first user to save a record under review.
Owner
Multiple - Allows any qualified user to accept the record and move it to the next
Concurrent stage.
l All Records
l New Records Only
l Update Records Only
10. Do one of the following:
l To enroll the original record in the workflow, go to the next step.
l To enroll a copy of the record in the workflow, click Record Version in Create Record Copy.
A copy of the original record becomes part of the workflow process while the original record
is available to users.
11. Click Save or Apply.
l Click Save to save and exit.
l Click Apply to apply the changes and continue working.
1. In the Stage Properties section, click in Default Assignees to open the selection box.
Note: To search for a specific user or group, expand the User or Group node and double-
click the value. Your selection is displayed in the Selected column.
2. In the Stage Properties section, click Add New in Assignment Criteria of the Rules section.
3. In Name, enter a name for the rule.
4. In Description, enter a description for the rule.
5. In the Criteria section, enter the rule criteria.
The following table describes filter criteria. Each row represents one set of filter criteria.
Option Description
Operator Provides the filter that evaluates the field in the creation of a condition. The
available operators depend on the type of field selected in Field to Evaluate.
Value(s) Opens the Record Lookup, which enables users to choose which value or values
to add to the condition.
Relationship Connects two or more conditions together. If you add more than one condition,
you can apply advanced logic to your search criteria.
6. In the Assignment section, select the groups, users, and fields to which records are assigned in
Note: To search for a specific user or group, expand the User or Group node and double-
click the value. Your selection is displayed in the Selected column.
7. Click OK.
8. Repeat steps 5 – 7 to add new rules as needed.
9. Click Save or Apply.
l Click Save to save and exit.
l Click Apply to apply the changes and continue working.
You can configure a workflow notification for any stage in the workflow process, and can use the
same notification for multiple stages or create unique notifications for each stage.
Note: The information described in this topic is specific to the Workflow feature. For information on
the Advanced Workflow feature, see the Advanced Workflow topic in the RSA Archer Online
Documentation.
a. In the Letterhead field, click and select the letterhead you want.
b. In the Body Layout field, click to select the layout for the body of the notification, and
click OK.
c. In the Preview field, verify that the layout you selected is the one you want to use.
l If the layout is what you want to use, go to the next step.
l If the layout is not what you want to use, repeat steps b and c.
3. Click Save or Apply.
Note: You cannot include the following fields in the subject line: Attachment, Cross-
Application Status Tracking, Image, Record Permissions, Sub-Form, Questionnaire
Reference, Access History, and History Log.
b. In the Body field, enter the content you want to show in the notification as text or reference
links.
l To enter a field, select the field or template you want for the admin type from the Toolbar
field.
l To enter a report, select the report you want from the Toolbar field.
l To enter a link, select the link you want from the Toolbar field.
3. Click Apply.
3. Click Save.
Note: The information described in this topic is specific to the Workflow feature. For information on
the Advanced Workflow feature, see the Advanced Workflow topic in the RSA Archer Online
Documentation.
Activate a workflow
1. Go to the Workflow tab of the application or questionnaire that you want to update.
Inactivate a workflow
To prevent records from entering the workflow process, change the value in the Status field to
Inactive. You cannot inactivate a workflow process if there are records enrolled in any of the
workflow stages.
Note: The information described in this topic is specific to the Workflow feature. For information on
the Advanced Workflow feature, see the Advanced Workflow topic in the RSA Archer Online
Documentation.
1. Go to the Workflow tab of the application or questionnaire that you want to update.
Standard Removes any access restrictions imposed during workflow. To use this option, the
application must have a Record Permissions field.
Public Enables all users to access records that are released from workflow.
Private Enables you to grant access to selected users or groups when records are released
from workflow.
Note: The information described in this topic is specific to the Workflow feature. For information on
the Advanced Workflow feature, see the Advanced Workflow topic in the RSA Archer Online
Documentation.
3. In the Stages section, select the stage that you want to configure.
4. In the Stage Properties section, click Edit in Notifications.
5. Click the row of the notification that you want to delete.
Note: The information described in this topic is specific to the Workflow feature. For information on
the Advanced Workflow feature, see the Advanced Workflow topic in the RSA Archer Online
Documentation.
Note: The information described in this topic is specific to the Workflow feature. For information on
the Advanced Workflow feature, see the Advanced Workflow topic in the RSA Archer Online
Documentation.
2. If the application is leveled, select the tab for the level for which you want to configure a
workflow process.
3. In the Stages section, select the stage that you want to reorder.
4. Drag the stage to the location you want.
5. Click Save or Apply.
l Click Save to save and exit.
l Click Apply to apply the changes and continue working.
Note: Records from a retired application are not supported in offline access. You can view User
Preferences, but you cannot edit them in offline access.
Use the Offline Access Gateway to select the application or questionnaire that will have offline
access for RSA Archer. After you determine which application or questionnaire you want for offline
access, you can then manage the records in the offline access library.
Strike-through Records synced with offline access and being removed in the
next sync.
Bold New records that will be synced with offline access in the next
sync.
Regular text Records synced with offline access in the next sync.
You can refresh the records in the Offline Access Library by populating the Offline Access Library.
You can remove records from the library clicking , which is displayed next to each record.
Records are removed from the Offline Access Library only.
The following table describes how the menu options for syncing records change based on the record
state.
Menu
Description
Option
Resolve Becomes available when conflicts exist between the offline access data and the RSA
Conflicts Archer data. In addition, if there are any updates to the application, these changes are
also validated.
Restart Becomes available when conflicts are resolved so that synchronization can continue.
Sync
2. On the Search Results page, click Options, and select Enable Offline Library.
3. Select the records that you want to add to the Offline Access Library.
4. Click .
5. Verify that the specified records appear in the Offline Access Library.
Conflict conditions
l An RSA Archer administrator updated an application that impacts the records in offline access.
For example, made a field required or changed a values list.
l Required data is missing from the record being uploaded from offline access.
l A record that is being worked offline is also updated in RSA Archer with different values.
When you resolve either conflict, you return to the Offline Access Unresolved Records page. All
conflicts must be resolved to complete the synchronization. Offline access is not available until all
conflicts are resolved.
If the reason that caused the conflict no longer exists, a message is displayed informing you that the
record is no longer in conflict and no further action is required. To continue, click OK.
5. Click Save.
6. Repeat steps 2 – 5 until all conflicts are resolved.
7. Click Offline Access Library, and click Restart Sync.
3. Click .
When a record is enabled for offline access, all supporting data, including cross-referenced or
related records, for that record is also synchronized. Records from a retired application are not
synchronized. Records in an application enabled for Workflow or Advanced Workflow are read only
in offline access.
Important: Appointment details are synchronized in offline access and can be updated while
working offline, but when the data is resynchronized with RSA Archer Platform the relationships
between the parent and resource applications are not saved. You must re-edit these appointment
details to reestablish these relationships.
Synchronization process
Offline access synchronization requires a stable connection to RSA Archer. If the connection is lost,
the synchronization fails. You cannot synchronize if the offline access version does not match the
option is required.
Note: This task requires a connection with the RSA Archer Platform and takes several minutes.
Note: Records from a retired application are not supported in offline access. User Preferences are
honored, but you cannot edit them in offline access.
In addition to starting offline access, the Offline Access utility facilitates the following:
l Purging Data in Offline Access
l Working Offline
Important: System administrators who use RSA Archer offline automatically convert to a general
user status and are granted sufficient access rights in the permissions tables. Any change to either
content or meta data that occurs during offline access produces a conflict between offline and RSA
Archer. To resolve a content conflict, you must use the Resolve Offline Access Conflict process. To
resolve a meta data conflict, such as a deleted dashboard or iView, you must purge data from offline
access.
Only one user can log in to offline access from the same laptop--one user, one RSA Archer
instance, and one device. Multiple users cannot be used with offline access.
Login requirements
Upon log in, offline access checks your user account for the appropriate credentials. Enter the
following:
l User name and password
l RSA Archer instance name
l RSA Archer Base URL
If any of these elements do not match, a validation message appears informing you that your user
account is invalid. Verify that you have correctly logged in to both RSA Archer and offline access.
Note: Currently, Offline Access supports the Audit Engagement, Audit Entity, Audit Plan, Audit
Workpaper, IA Engagement and Assessment Results, Internal Audit Department Annual Review,
Plan Entity and Question Library applications.
Memory 8 GB RAM
Important: Microsoft Sync Framework 2.1 is required and must be installed on the Services Server.
For more information, see "Preparing the Services Servers" in the RSA Archer Installation and
Upgrade Guide.
By default, the offline access data is stored on the local computer at C:\Users\
[username]\AppData\Roaming\RSA Archer\Offline Access\. Isolating the offline access data
ensures that each offline access user has their own environment for working offline. For example,
when a user purges offline access data, only the offline access data of that user is purged.
Anti-virus and firewall applications may interfere with Offline Access run-time activities. You must
add the Offline Access installation file as a trusted file/process/installer/updater for any anti-virus
and firewall applications that may interfere with the installation.
Before running offline access, start the Distributed Transaction Coordinator service on the laptop
using offline access.
Important: You must have administrator rights to install offline access. If you are upgrading offline
access, close the Offline Access utility before starting the installation.
Forced A forced purge is controlled through the Purge Data option in security parameters to
ensure that data is purged under ordered conditions. If you have not synchronized within
the specified time frame, you are forced to purge all offline access data upon login and
to run an initial synchronization. Offline access is not available until all data is purged
and until the initial synchronization is complete.
Manual A manual purge is initiated by you to remove all offline access data permanently from
the laptop. If you want to continue working offline, you must run an initial
synchronization.
Use the manual purge when:
l Moving from one environment to another, for example, test to production.
l Using a different RSA Archer instance.
l Using a different laptop.
Working Offline
While working offline, you can use the Offline access utility to open the logs created while working
offline and to exit offline access.
It is important to have well-defined policies around Help Desk procedures for your RSA Archer
installation. RSA strongly recommends that your Help Desk administrators understand the
importance of password strength and the sensitivity of data, such as user logon names and
passwords. Creating an environment where an end user is frequently asked for this kind of sensitive
data increases the opportunity for social engineering attacks. Train end users to provide, and Help
Desk administrators to request, the least amount of information needed in each situation.
l If Help Desk administrators need to initiate contact with a user, they should not request any user
information. Instead, users should be instructed to call the Help Desk back at a well-known Help
Desk telephone number to ensure that the original request is legitimate.
l The Help Desk telephone number should be well known to all users.
l Help Desk administrators should only ask for user name of the user over the phone when they call
the Help Desk. Help Desk administrators should never ask for user passwords.
l Help Desk administrators should authenticate the user's identity before performing any
administrative action on a user's behalf. RSA recommends that you verify user identity using the
following methods:
o Call the user back on a phone owned by the organization and on a number that is already stored
in the system.
Important: Be careful when using mobile phones for identity confirmation, even if they are
owned by the company because mobile phone numbers are often stored in locations that are
vulnerable to tampering or social engineering.
o Send an email to the user at a company email address. If possible, use encrypted email.
o Work with the manager of the employee to verify the user identity.
o Verify the identity in person.
o Use multiple open-ended questions from employee records. For example: "Name one person in
your group." or "What is your badge number?" Avoid yes or no questions.
l Send an email to the user at a company email address. If possible, use encrypted email.
l Work with the employee's manager to verify the user's identity.
l Verify the identity in person.
l Use multiple open-ended questions from employee records. For example: "Name one person in
your group." or "What is your badge number?" Avoid yes or no questions.
Note: RSA recommends that you conduct regular training to communicate this guidance to users.
Entity permissions
RSA Archer supports user permissions on multiple system components. RSA recommends that you
grant permissions only to users who need to access these components. When granting permissions to
these components, RSA recommends that you do not select the Everyone group because that group
grants rights for all users. Additionally, RSA recommends that you review the granted permissions
on a routine basis to ensure that the correct access is granted to the users.
The following table explains how user permission is configured on the supported components.
Component Permissions Explanation
Workspaces, Configured from the Access tab in a workspace or dashboard. RSA recommends
Dashboards, that you configure these components to be private.
Global iViews
Global Reports Configured when you save a report. RSA recommends that you set the
Permissions field to Global Report.
Global Report Configured in Application Builder for the assigned report owners in a specific
Administrators application or questionnaire.
User Accounts
Each RSA Archer user must have an account to log on to the system. When adding a user consider
the following:
l Will the user be notified of password information?
l Will the user be forced to change the password at next log in?
l Does the user speak a language different from the default language?
l Does the user require a specific security parameter?
l What groups should the user be enrolled in, and which access roles should be assigned to the user
account?
Important: RSA strongly recommends that you ensure that users are approved for logging on to the
system before you create an account for them. Even when users are approved, RSA recommends
that you only assign the minimum set of access permissions that enable the users to perform their
job.
A user account with system administrator privileges is not the same as the System Administrator
account. It cannot, for example, see the System Administrator account or change its password. Only
someone who has access to the System Administrator account can manage it. See Understanding the
System Administrator Account and Default Services Passwords for more information.
Important: RSA recommends that before issuing this account, you ensure that the user is approved
for full access to the system.
Note: These security parameters are enforced by RSA Archer across all user accounts except the
sysadmin and service accounts. RSA strongly recommends that you instruct your administrators on
your corporate IT policy and security best practices for generating and managing passwords for all
accounts.
Parameter Setting
All new user accounts must have a unique password, generated under one of the following sets of
circumstances:
l The system administrator assigns the password manually. RSA strongly recommends that you
enable the Force Password Change with the Next Sign-In option in RSA Archer for all new user
accounts. Configuring this option requires the user to change the password after the first
successful logon attempt.
l If the single sign-on feature is in place on your system, RSA Archer automatically creates a
random password for each new user.
Important: RSA strongly recommends that you ensure users are approved for logging on to the
system before creating an account for them. Even when users are approved, RSA recommends that
you only assign the minimum set of access permissions for users to perform their job.
RSA recommends that you create a new user account and assign the System Administrator access
role to it. This access role grants the account all rights within RSA Archer.
Important: RSA recommends that before issuing this account, you ensure that the user is approved
for full access to the system.
RSA Archer enforces the password strength, logon, and session time-out policies specified by the
security parameters defined in the Administration workspace.
Note: These security parameters are enforced by RSA Archer across all user accounts except the
sysadmin and service accounts. RSA strongly recommends that you instruct your administrators on
your corporate IT policy and security best practices for generating and managing passwords for all
accounts.
RSA recommends that you treat these settings as the minimum requirement for enforcing strong
passwords and secure sessions in RSA Archer.
Important: Regardless of the security parameter settings, RSA Archer passwords cannot contain
more than:
First The valid name of the user. First and last names are required.
Name, Middle
Name, and
Last Name
User Name A seven character system-defined name in all lowercase. The user name
contains the first six characters of the Last Name followed by the first
character of the First Name. If the Last Name is fewer than six characters,
the system uses additional characters from the First Name to make a seven-
character user name. If the user name is not unique in the domain, the system
appends a number (up to 999) to the end of the name to make the name unique.
User Domain If your RSA Archer instance has one or more Lightweight Directory Access
Protocol (LDAP) configurations defined, select the domain to which the user
is a member. To use the RSA Archer domain, select No Domain.
4. (Optional) In the Contact Information section, enter the default email address and any other
pertinent information for contacting the user.
l Business l Mobile 2
l Business 2 l Other
l Home l Other 2
l Home 2 l Pager
l Mobile
l Assistant l ISDN
l Business l Mobile
l Business 2 l Mobile 2
l Business Fax l Other
l Home l Other 2
l Home 2 l Other Fax
l Home Fax l Pager
5. (Optional) In the Localization section, enter the time zone, locale, and language if the location
and language of the user is different from the system.
The following table describes the options.
Option Description
Time Zone The time zone for the location of the user. Time is based on Coordinated
Universal Time (UTC). All time is stored as UTC and converted based on the
time zone of the user.
Option Description
Manually Overrides the default language set for the instance. When you select this option,
select a you must specify the language.
language
6. In the Account Maintenance section, enter the user password and assign the security parameter
for this user.
The following table describes each property.
Property Description
Status The current status of the user account. The options are Active, Inactive, or
Locked.
Password For new user accounts, the password must be entered and confirmed. These
entries must match exactly. The password must conform to the default security
parameter password rules.
For existing user accounts, use the Change Password link to change the
password manually.
The Send user a notification with password information option enables RSA
Archer administrators to notify new users that the user account has been setup
with a temporary password and may require a password change.
Force Determines whether the user is forced to change the password the next time
Password the user logs in.
Change
Security The security parameter assigned to the user. A user can only have one security
Parameter parameter assigned at a time.
Notifications, Enables users to select the records and applications for which they want to
Subscriptions receive notifications when an update occurs.
Property Description
Default Sets a user’s default home page to use either a task-driven landing page or a
Home Page dashboard based on group, role, or user profile. If the user belongs to multiple
roles or groups, the home page is based on the most recently assigned role or
group. Once the user logs in, the selected home page becomes default and any
changes to the home page of the role or the group do not affect the user's
default home page.
Note: If the user's permission to access the dashboard assigned to the home
page is revoked, a message appears upon log in allowing them to select a new
home page.
Important: If the administrator sets the default home page while the user is
logged in, the user must click the Home button to refresh the home page
setting. If the user changes the default home page selection, the change is
applied upon clicking Save.
7. (Optional) Select the Send user a notification with password information checkbox if you want to
send the user an email notification of the password change.
Note: If you do not select this checkbox, you must inform the user of the new password. The
Default Email address is used for the notification email.
8. (Optional) In the Notes section, record any additional information about the user account, for
example, list hours of availability or preferences for how the user should be contacted. Account
notes appear when users click a linked user name in RSA Archer to view the user profile.
9. Click Save or Apply.
l Click Save to save and exit.
l Click Apply to apply the changes and continue working.
Note: You cannot delete a user account that is used in an advanced workflow.
2. Click the user account that you want to delete, and view the description.
3. In the Actions column, click for the user account that you want to delete.
4. Click OK.
2. Click the row of the user account that you want to log off.
3. In the Actions column, click for the user account that you want to log off.
Maintaining Security
Malware Detection
RSA recommends that you deploy a malware detection solution on the web and database servers.
The malware detection solution should be based on your standard tools and best practices. It is your
responsibility to deploy patches and updates for the malware detection tools.
Virus Scanning
RSA recommends that you run virus scanning software on the deployed servers on a routine basis. If
you are running Threat or Vulnerability feeds, RSA strongly recommends that you disable virus
scanning for the folder in which the Threat or Vulnerability data files are temporarily stored. A virus
scanning engine could interpret the data as a virus or malware.
For information on configuring the folder, see Threat Data Feeds.
As with any critical infrastructure component, RSA recommends that you constantly monitor your
system and perform periodic and random audits, for example, configuration, permissions, and
security logs. Ensure that the configurations and user access settings match your company policies
and needs.
2. In the Manage Users list, find the name of the source user whose resources you want to
reassign, and then do one of the following:
l Click the name of the user to display the profile details, and then click .
3. In the User Information section, confirm that you have selected the correct source user for
reassigning.
4. In Reassignment Users, click , select one or more target users, and then click OK.
5. In Notifications, do one of the following:
l Select Send if you want RSA Archer to send notification emails for all notification-configured
records that are reassigned.
l Select Do Not Send if you want to prevent RSA Archer from sending notification emails for
reassigned records.
6. On the Applications and Questionnaires tabs, select the resources you want to reassign in the
Reassign column.
7. In the New User column, specify a target user to whom you are reassigning each selected
resource.
8. Click OK.
2. In the Account Maintenance section, click the text in Last Login field.
In RSA Archer, there is one password for all RSA Archer service accounts.
The following table lists the RSA Archer service
accounts.
Service User Name
Special characters 1
Grace logins: 0
1. On the RSA Archer Control Panel Accounts tab, go to the SysAdmin Account section of the
instance you want to update.
a. Open the RSA Archer Control Panel.
b. From the Instance Management list, double-click the instance.
2. In the New Password field, enter the password for the SysAdmin account.
3. (Optional) Select Show Password to show the password as you enter it. If this option is not
selected, the password is masked with substituted characters for the actual text.
1. On the RSA Archer Control Panel Accounts tab, go to the Services Account section of the
instance you want to update.
a. Open the RSA Archer Control Panel.
b. From the Instance Management list, double-click the instance.
2. In the New Password field, enter the password for the Services account.
3. (Optional) Select Show Password to show the password as you enter it. If this option is not
selected, the password is masked with substituted characters for the actual text.
First The valid name of the user. First and last names are required.
Name, Middle
Name, and
Last Name
User Name A seven character system-defined name in all lowercase. The user name
contains the first six characters of the Last Name followed by the first
character of the First Name. If the Last Name is fewer than six characters,
the system uses additional characters from the First Name to make a seven-
character user name. If the user name is not unique in the domain, the system
appends a number (up to 999) to the end of the name to make the name unique.
Property Description
User Domain If your RSA Archer instance has one or more Lightweight Directory Access
Protocol (LDAP) configurations defined, select the domain to which the user
is a member. To use the RSA Archer domain, select No Domain.
l Business l Mobile 2
l Business 2 l Other
l Home l Other 2
l Home 2 l Pager
l Mobile
l Assistant l ISDN
l Business l Mobile
l Business 2 l Mobile 2
l Business Fax l Other
l Home l Other 2
l Home 2 l Other Fax
l Home Fax l Pager
Time Zone The time zone for the location of the user. Time is based on Coordinated
Universal Time (UTC). All time is stored as UTC and converted based on the
time zone of the user.
Manually Overrides the default language set for the instance. When you select this option,
select a you must specify the language.
language
Status The current status of the user account. The options are Active, Inactive, or
Locked.
Password For new user accounts, the password must be entered and confirmed. These
entries must match exactly. The password must conform to the default security
parameter password rules.
For existing user accounts, use the Change Password link to change the
password manually.
The Send user a notification with password information option enables RSA
Archer administrators to notify new users that the user account has been setup
with a temporary password and may require a password change.
Force Determines whether the user is forced to change the password the next time
Password the user logs in.
Change
Security The security parameter assigned to the user. A user can only have one security
Parameter parameter assigned at a time.
Notifications, Enables users to select the records and applications for which they want to
Subscriptions receive notifications when an update occurs.
Property Description
Default Sets a user’s default home page to use either a task-driven landing page or a
Home Page dashboard based on group, role, or user profile. If the user belongs to multiple
roles or groups, the home page is based on the most recently assigned role or
group. Once the user logs in, the selected home page becomes default and any
changes to the home page of the role or the group do not affect the user's
default home page.
Note: If the user's permission to access the dashboard assigned to the home
page is revoked, a message appears upon log in allowing them to select a new
home page.
Important: If the administrator sets the default home page while the user is
logged in, the user must click the Home button to refresh the home page
setting. If the user changes the default home page selection, the change is
applied upon clicking Save.
6. (Optional) In the Account Notes section, enter any additional information about the user account.
7. Click Save or Apply.
l Click Save to save and exit.
l Click Apply to apply the changes and continue working.
User Groups
User groups are groups of users set by an administrator. You can add user groups to other groups to
create a hierarchical structure of user groups and subgroups. For example, you can create a Sales
group that includes all user accounts for members of the Sales team. In the Sales group, you can
create other groups, such as Midwest Sales Team and East Coast Sales Team, and add the
appropriate users to these user groups.
Use groups to streamline key tasks in RSA Archer according to your business practices, such as:
l Assigning access rights at the application, page, record, and field levels to user groups rather than
individual users.
l Enrolling a user group in a discussion forum.
l Sending a Training and Awareness event to members of a specific user group, such as the
Incident Investigation group.
When a user becomes a member of a user group with an associated role, the user automatically
receives the permissions of the access role. For example, a Policy Administrators group has an
associated access role that grants create, read, and update privileges to the Policies application. All
members added to this user group are granted the same access rights related to policy-related job
functions.
Important: Users must exist before groups can be created. Groups must exist before adding an
access role or security parameter.
Note: When importing and installing a package that contains groups, you must manually add the
members of the group to that group. For more information, see "Manage Packages" in the Online
Documentation.
2. In the Members section, from the Available list, select the groups and users that you want to be
members of the group. You can either browse through the nodes or use the Find field to search
for a specific user or group.
3. Click Save or Apply.
l Click Save to save and exit.
l Click Apply to apply the changes and continue working.
1. Go to the user group that you want to add to one or more groups.
2. In the Member Of section, from the Available list, in the Groups field, select the group or groups
to set as a parent for the current group. You can also use the Find field to search for a specific
group.
Important: If a group is created through LDAP synchronization, you cannot use these tasks to
assign or unassign a group. To assign or unassign a user from an LDAP group, you must make the
appropriate changes in your LDAP directory and then run a data synchronization.
Note: To search for a specific group, enter the group name in Find and click . The results of
your search appear in the Available list of the Search Results node.
5. Click OK.
6. Click Save or Apply.
l Click Save to save and exit.
l Click Apply to apply the changes and continue working.
1. Select the user account that you want to unassign from a group.
2. Click the Groups tab and click Lookup.
3. From the Selected list, click for the group that you want to unassign.
4. Click OK.
5. Click Save or Apply.
l Click Save to save and exit.
l Click Apply to apply the changes and continue working.
Important: If the group was created through LDAP synchronization, you cannot use this task to
delete the group. Make the appropriate changes in your LDAP directory and then run a data
synchronization. To delete a group using the Web Services API, use the AccessControl.DeleteGroup
method.
Important: You cannot delete user groups that are used in an advanced workflow.
Access Roles
An access role is a collection of application-level and page-level rights that an administrator can
create and assign to any number of users and groups to control user privileges (create, read, update,
and delete). For example, the access role of a General User can allow access only to applications,
and the access role of an Administrative User can allow access only to RSA Archer features. RSA
recommends that you assign permissions through group membership, and not assign permissions
directly to user accounts.
RSA Archer includes an access role called System Administrator that you cannot delete or modify.
The System Administrator role grants users unrestricted access to all RSA Archer features and to all
records stored in applications, including records enrolled in content review. Only System
Administrators can assign the System Administrator access role.
RSA Archer solutions include pre-defined access roles for use with the solution.
For instructions on assigning permissions through group membership, see Assigning Access Roles to
Users and Groups.
As the number of users, groups, and applications increases, keeping track of who has access to what
becomes more complex. RSA recommends simplifying the process. If you create granular access
roles for each of your applications, for example, Policy Administrator, Policy Author, and Policy
Reader, you can grant access to new or existing users and groups by selecting from a list of
predefined access roles.
with groups during the packaging process, you must manually associate each access role to the
respective group. After the package is installed, you must manually add users to each group in the
target instance.
Page-level rights
The following table describes page-level rights.
Rights Description
Create Create new page content, such as records, fields, notification templates, and content
review stages.
6. (Optional) To set access role as the default for all users and groups, in the Default Access Role
field of the Default Access Role section, click Assign as Default.
7. (Optional) In the Group Assignments section, assign groups to the access role.
8. Click Apply.
9. On the Rights tab, and select the (Create, Read, Update, and Delete) checkboxes that
correspond to the appropriate rights for each page type.
l User or group access to the Manage Global Values Lists page provides access to all global
values lists in RSA Archer. If you want a user to have access to specific global values lists
and not all lists, select the appropriate CRUD access for the individual global values list.
l If you grant access rights to import data, you must also grant rights to the content record that
data will be imported into. For example, users can import data into the Policies application
only if they have access to Integration: Data Imports; Create, Read, and Update rights to
Policies: Content Record; and Policies: Data Import.
10. Click Save or Apply.
l Click Save to save and exit.
l Click Apply to apply the changes and continue working.
2. Select the (Create, Read, Update, and Delete) checkboxes that correspond to the appropriate
rights for each page type.
The following table describes each of the rights.
Rights Description
Create Create new page content, such as records, fields, notification templates, and content
review stages.
Rights Description
RSA recommends that you review users’ task permissions on a routine basis to ensure that each user
is granted the correct task permissions.
Access roles are cumulative and can be assigned to users, groups, and users with more than one
access role.
Example
One access role grants create, read, and update privileges in the Policies applications and another
access role grants only delete privileges. A user who is assigned both access roles has create, read,
update, and delete privileges in the Policies applications.
RSA Archer allows access roles to be assigned to users through group membership or directly to
user accounts. RSA recommends that you assign permissions through group membership and not
directly through user accounts.
You can assign access roles to users in either of the following ways.
1. Open the user account to which you want to assign an access role.
Note: To search for a specific role, enter the role name in the Find field and, if applicable,
select the type from the adjacent list. Click . The results of your search appear in the
Available list in the Search Results node.
5. Click OK.
6. Click Save or Apply.
l Click Save to save and exit.
l Click Apply to apply the changes and continue working.
Note: Complete only the steps that apply to the property that you are changing.
Note: You cannot delete the default access role. To delete the default access role, first set another
access role as the default access role.
Security Parameters
Security parameters allow you to control the password and authorization rules for user sessions.
l Password rules determine the password strength requirements and how frequently passwords must
be changed.
Note: The instance security settings determine whether users are allowed to change their
password while working in RSA Archer. Verify with your IT administrator that your instance is
configured to allow users to change their passwords. Instance parameters are managed in the
RSA Archer Control Panel.
l Authorization rules determine how users can access their account, the length of a session, and the
system behavior if a user locks him or herself out of the account.
You can create multiple security parameters, but only one security parameter is assigned to a user.
You can designate a security parameter as the default parameter for all new user accounts.
If your instance is licensed for offline access or the mobile app, you must define security parameters
for mobile users. These parameters include account lockout duration, session time-out behavior,
active session restrictions, and sync alert behaviors.
After successfully authenticating, SSO solution users can access RSA Archer with no need for
defined security parameters.
Note: The instance security settings determine whether users are allowed to change their password
while working in RSA Archer. Verify with your IT administrator that your instance is configured to
allow users to change their passwords. Instance parameters are managed in the RSA Archer Control
Panel.
6. In the Password Properties section, enter password rules that you want to enforce.
The following table describes each option.
Property Action
Password format a. In the Minimum Password Length field, select the minimum number of
characters or select Other and enter a different value.
b. In the Numeric Characters Required field, select the minimum number
of numbers or select Other and enter a different value.
c. In the Uppercase Characters Required field, select the minimum
number of uppercase characters or select Other and enter a different
value.
d. In the Alpha Characters Required field, select the minimum number of
alphabetic letters or select Other and enter a different value.
e. In the Special Characters Required field, select the minimum number of
special characters or select Other and enter a different value.
f. In the Lowercase Characters Required field, select the minimum
number of lowercase characters or select Other and enter a different
value.
Password In the Password Expiration Notice field, select the number of days for
expiration notice prompting the user to change the password or select Other to enter a
different value.
Password In the Password Change Interval field, the number of days after which a
change interval user is required to change the password or select Other to enter a different
value.
Restrict a. In the Password Change Limit field, click Enable password change
frequency of limit.
password b. Enter or select the period (in Hours) in which users can change their
change passwords for this security parameter.
7. In the Authorization Properties section, enter the authorization rules that you want to enforce.
Account lockout In the Account Lockout Period field, select the period
period after login that an account remains locked before the user can log in
failures again, or select Other to enter another value.
Timeout for an In the Session Timeout field, select the maximum length
inactive session of time an active user session without activity can remain
active before the session is automatically timed out, or
select Other to enter a different value. You can enter the
number of seconds in the range from 30 to 300.
Time limit for In the Automatic Account Deactivation field, select the
account number of days a user account can remain active before
inactivity the account becomes deactivated, or select Other to enter
a different value.
Time period a. In the Limit Session Time field, click Allow active
allowed for user user sessions only for a specific time period.
sessions b. In the From field, enter the start time of the period.
c. In the To field, enter the end time of the period.
d. In the Time Zone field, select the time zone that
applies to the active session limitation.
Rule Action
Days disallowed In the Days Disallowed field, click and select the days
for user sessions (Sunday through Saturday) that user sessions are not
allowed and click OK.
To remove a day from the Selected list, click adjacent to
the day that you want to remove from the list.
Dates disallowed In the Dates Disallowed field, click and select the dates
for user sessions that user sessions are not allowed and click OK.
To remove a date from the Selected list, click adjacent to
the date that you want to remove from the list.
Rule Action
Rule Action
Reset Maximum Select the lockout period before the user can request a
PIN Resends PIN after the user exceeds their maximum PIN resend
limit.
If the instance or solution is not licensed, the Mobile Authorization Properties section is not
displayed on the Manage Security Parameter page.
The security parameters for a mobile user include:
l Login credentials for mobile users
l Session behaviors for mobile users
l Data synchronization and data purge behaviors for mobile users
For mobile users to sync data between offline access or the mobile app and RSA Archer, they must
log in to the mobile device and provide their RSA Archer credentials when prompted to sync. For the
mobile app, single sign-on (SSO) is not supported.
The type of mobile user determines the steps for the initial log in.
l For offline access, users must synchronize data from the RSA Archer solution to a laptop
computer.
l For the mobile app, users need the RSA Archer URL, domain, and instance to access for mobile
data.
You can configure these values to meet your own business requirements and user needs.
The following table describes session behaviors for mobile users.
Option Value Behavior
Maximum 3 The mobile user is allowed to attempt to log in using incorrect credentials
Failed attempts (user name, company ID, and password combination) up to three times.
Login
Attempts
Account 30 The mobile user account is locked for 30 minutes, preventing the user from
Lockout minutes attempting to log in to a session after exceeding the maximum failed login
Period attempts. After that time, the mobile user can attempt to log in again up to
the maximum failed login attempts.
Session 30 The mobile session is active for 30 minutes after the last detected user
Timeout minutes activity. After this duration, the session is automatically timed out, and the
user is prompted to log in again.
Static blank The mobile session has no limit to availability to the user.
Session
Timeout
Close on blank The mobile session remains active after the mobile app is closed. This
Exit option does not apply to offline access.
The synchronization rules work together to ensure that mobile users maintain current data and offline
access users sync regularly with RSA Archer.
Example: How default purge behaviors and individual sync alerts influence synchronized data
You can configure these options and values meet your own business requirements and user needs.
The following table describes data synchronization and data purge behaviors for mobile users.
Option Value Behavior
Sync 15 On the 15th day after the last synchronization, the mobile user will be
Reminder Days reminded upon log in to synchronize data with RSA Archer. The reminder
continues to appear until the user syncs or reaches the Force Sync limit.
Force 30 On the 30th day after the last synchronization, the mobile user will be forced
Sync Days to synchronize data with RSA Archer or the application, until the Purge Data
limit is reached.
Purge 45 If the mobile user has not synchronized data with RSA Archer in 45 days, all
Data Days data mobile data will be purged when the user attempts to access the
application. The mobile user will be forced to do an initial log-in and
synchronization.
Note: To access mobile-specific settings, either the instance must be licensed for mobile
questionnaires or the solution must be licensed for offline access. If the instance or solution is not
licensed, the Mobile Authorization Properties section is not present on the Manage Security
Parameter page.
4. In the Password Properties section, enter the password rules that you want to enforce.
The following table describes each option.
Property Action
Password format a. In the Minimum Password Length field, select the minimum number of
characters or select Other and enter a different value.
b. In the Numeric Characters Required field, select the minimum number
of numbers or select Other and enter a different value.
c. In the Uppercase Characters Required field, select the minimum
number of uppercase characters or select Other and enter a different
value.
d. In the Alpha Characters Required field, select the minimum number of
alphabetic letters or select Other and enter a different value.
e. In the Special Characters Required field, select the minimum number of
special characters or select Other and enter a different value.
f. In the Lowercase Characters Required field, select the minimum
number of lowercase characters or select Other and enter a different
value.
Password In the Password Expiration Notice field, select the number of days for
expiration notice prompting the user to change the password or select Other to enter a
different value.
Password In the Password Change Interval field, the number of days after which a
change interval user is required to change the password or select Other to enter a different
value.
Restrict a. In the Password Change Limit field, click Enable password change
frequency of limit.
password b. Enter or select the period (in Hours) in which users can change their
change passwords for this security parameter.
5. In the Authorization Properties section, enter the authorization rules that you want to enforce.
Account lockout In the Account Lockout Period field, select the period
period after login that an account remains locked before the user can log in
failures again, or select Other to enter another value.
Timeout for an In the Session Timeout field, select the maximum length
inactive session of time an active user session without activity can remain
active before the session is automatically timed out, or
select Other to enter a different value. You can enter the
number of seconds in the range from 30 to 300.
Time limit for In the Automatic Account Deactivation field, select the
account number of days a user account can remain active before
inactivity the account becomes deactivated, or select Other to enter
a different value.
Time period a. In the Limit Session Time field, click Allow active
allowed for user user sessions only for a specific time period.
sessions b. In the From field, enter the start time of the period.
c. In the To field, enter the end time of the period.
d. In the Time Zone field, select the time zone that
applies to the active session limitation.
Rule Action
Days disallowed In the Days Disallowed field, click and select the days
for user sessions (Sunday through Saturday) that user sessions are not
allowed and click OK.
To remove a day from the Selected list, click adjacent to
the day that you want to remove from the list.
Dates disallowed In the Dates Disallowed field, click and select the dates
for user sessions that user sessions are not allowed and click OK.
To remove a date from the Selected list, click adjacent to
the date that you want to remove from the list.
Rule Action
Rule Action
Reset Maximum Select the lockout period before the user can request a
PIN Resends PIN after the user exceeds their maximum PIN resend
limit.
6. In the Mobile Authorization Properties section, enter the mobile authorization rules that you want
to enforce.
The following table describes each property.
Property Action
Number of allowed login failures a. In the Maximum Failed Login Attempts field, specify
and account lockout period the number of allowable attempts.
b. In the Account Lockout Period field, specify the
duration of the lockout period.
Timeout for an Inactive Mobile In the Session Timeout field, specify the inactivity duration
Session of the session before the user is logged out automatically.
Active Mobile Session Period In the Static Session Timeout field, click Enable static
Before Requiring Re- session timeout, and then select the duration.
Authentication
Whether the Mobile Session In the Close on Exit field, click Enable session termination
Terminates When Closing after closing the mobile application.
Property Action
Sync Reminder Alerts for Mobile In the Sync Reminder of Sync Alerts field, specify the
Users number of days from the last synchronization.
Time Limit for Forcing Mobile In the Force Sync of Sync Alerts field, specify the number
Users to Sync of days from the last synchronization.
Disable Automatic Purging of In the Purge Data of Sync Alerts field, clear the box.
Data for Mobile Users
Retention Days Before Mobile In the Purge Data of Sync Alerts field, select the number
Data Is Purged of days from the last synchronization.
Note: You cannot delete a default security parameter that is in use. To delete the default security
parameter, assign another security parameter as the default.
2. In the row of the security parameter that you want to delete, in the Actions column, click .
3. Click OK.
LDAP Configuration
As an administrator of the Access Control feature, you can synchronize information between RSA
Archer and your organization Lightweight Directory Access Protocol (LDAP) server. With LDAP
synchronization, you can streamline the administration of user accounts and groups by allowing
updates and changes that were made in the LDAP server to be automatically reflected in RSA
Archer.
The LDAP configuration feature accepts multiple-domain, single sign-on (SSO) information and
synchronizes with discrete LDAP systems, allowing you to do the following:
l Standardize the log on procedures in heterogeneous domain environments.
l Incrementally add new domains to existing user access configurations.
l Synchronize data with multiple domain accounts.
LDAP groups cannot be mapped to a previously existing RSA Archer group. The synchronization
process replicates the LDAP group structure within RSA Archer. Groups created in the RSA Archer
Platform by the LDAP synchronization process cannot be edited within RSA Archer.
You can also set a schedule to automate the synchronization process between your LDAP server and
the RSA Archer database. RSA recommends that you select LDAP servers that communicate using
LDAP over HTTPS, and that you set the LDAP Connection attribute to secure.
Note: RSA recommends requiring a domain for LDAP synchronizations and SSO. If domains are
not used, RSA recommends disabling the display of the Domain field in the RSA Archer Control
Panel.
5. In the LDAP/Active Directory Server section, enter the user domain, IP address, and connection
or binding preferences.
The following table describes each field.
Field Description
User Specifies the domain to which user accounts from this LDAP server belong. The
Domain name must be unique for all LDAP configurations.
If you are using Windows Authentication, ensure that the User Domain field
matches the Windows domain name. If these values do not match, single sign-on
(SSO) fails. These domain names are not case sensitive.
Name/IP Specifies the fully qualified name or IP address of your LDAP or Active
Address Directory server. Selecting this option ensures that your server assumes
responsibility for directing RSA Archer to the appropriate domain controller.
If the previously contacted domain controller is unavailable, a secondary domain
controller is identified and used instead. For example, if your primary LDAP
server is down for maintenance, RSA Archer is directed to the secondary server
to execute LDAP synchronization.
Binding Enables you to bind the LDAP connection to a default domain controller without
specifying the name of a default server. Microsoft recommends the use of
serverless binding for fault tolerance.
If you are using an Active Directory server, select whether to use serverless
binding. If you select Use Serverless Binding, you do not need to enter a value in
the Name/IP Address field.
6. In the LDAP/Active Directory Server Configuration section, enter the configuration options for
your LDAP server.
The following table describes each field.
Field Description
User Specifies the user name of the user identified to access the LDAP or Active
Name Directory server when additional authentication is required.
Password Specifies the password of the user identified to access the LDAP or Active
Directory server when additional authentication is required.
Field Description
Active Specifies the domain of the active directory when additional authentication is
Directory required.
Domain
Additional Provides additional attributes that must be retrieved from the LDAP source during
Attributes search. For example, if you are using filters, enter the filters in this field.
Field Description
Connection Inputs the time-out value in seconds for the LDAP query. This value must be a
Time-out whole number greater than 0.
For new LDAP configurations, the default value is 60.
Binding Sets the Binding for an LDAP configuration from the following options:
l Use Simple LDAP Binding: Use when your server does not allow connection
using the Simple Authentication and Security Layer (SASL) protocol, or if you
experience errors.
l Disable page searching: Use when your server does not support paged
searching.
l Remove the whitespace from the DNs: Use to remove unnecessary white
space in the Distinguished Name (DN) before the names are compared when
you are using an LDAP server other than Active Directory.
Base DN Specifies the Base Distinguished Name (DN) for the location of user account
information in your LDAP directory.
Filter Filters the LDAP information available for mapping to user profile fields. Filters
are entered using the following format: objectClass=class name.
Example
You want to map only LDAP values associated with the “user” class. You would
enter objectClass=user as the filter. This entry results in the values associated
with this class being available for mapping.
Field Maps the attributes from the LDAP directory to the fields in the user profile. You
Mapping must map all required fields in the user profile to an attribute.
2. In the User Account Management section, define the rules for updating, creating, deactivating,
and reactivating accounts.
Example:
You want to update only user accounts from your New York office. You
would select Office from the Attribute list, select Equals as the operator, and
enter New York in the Value field from the Operator list.
Create/Update Creates or updates a user account if the account does not exist in
RSA Archer. The name for the new user account is assigned the value of the
LDAP attribute mapped to the User Name (Login) field.
Clear User Clears the distinguished names of all users just before the LDAP
DNs synchronization starts. The synchronization then repopulates the database with
the most up-to-date list of distinguished names. If users have changed their
login names, moved location, or are in a new part of the company, for
example, the old distinguished names are no longer valid. Consequently, these
users would not be able to log into RSA Archer.
Field Description
Example:
You want to deactivate user accounts where the employment status for the
matching LDAP user account is set to inactive. You would select
Employment Status from the Attribute list, select Equals as the operator, and
enter Inactive in the Value field from the Operator list.
Example:
You want to reactivate inactive user accounts where the employment status in
the matching LDAP user account is set to active. You would select
Employment Status from the Attribute list, select Equals and enter Active in
the Values field from the Operator list.
Send Sends a notification to each user that is created to alert the user of a new
Notification password. The Default Email Address in the user account must be present to
send notifications. When you select this option, a notification message is sent
to all users that are being created.
RSA recommends disabling this option when synchronizing a large number of
records because uploading a large number of users can cause the email server
to exceed its capacity for sending email messages.
3. (Optional) In the Group Management section, enter the criteria for synchronizing the
LDAP group structure with RSA Archer.
Group Specifies the Base Distinguished Name (DN) for your LDAP group structure.
Base If you selected Group Sync and you do not specify a DN for your group structure, the
DN group sync query defaults to the Base DN specified in the LDAP configuration.
Note: RSA Archer only supports standard implementations of LDAP in the directory services. The
users and groups in the Active Directory must have distinguished names.
If there are records that are not updated during the synchronization, you can view a text file that
details the date, time, and specific records that failed to synchronize. While the sync status is
inactive, RSA Archer suspends further synchronization attempts until you manually correct the
problems with the connection and set the status to active.
1. Go to the Data Sync tab of the LDAP Configuration you want to schedule synchronization.
2. In the Sync Schedule section, set the schedule for synchronizing user accounts and groups.
The following table describes the fields.
Field Description
Frequency How often you want to run the LDAP synchronization process.
Note: If you have made changes to your LDAP configuration, you must save those changes before
requesting an immediate data synchronization. Otherwise, the last saved LDAP configuration is
used.
1. Go to the Sync Status tab of the LDAP configuration that you want to synchronize.
2. Go to the Immediate Sync Request section and click Run Sync Now in the Sync Request field.
Note: To cancel the synchronization request, using the Cancel option that appears in the Sync
Request field, click Cancel.
Auto-Provisioning
The Auto-Provisioning feature enables LDAP synchronizations to create user accounts and groups
automatically without the necessity of creating those accounts beforehand. Account creation and
synchronization occur when a user logs on so long as the system administrator has configured the
user account to meet the following conditions:
l An LDAP synchronization can create user accounts
l A valid user of the domain, BaseDN, and Filter matching the LDAP Synchronization attempts to
log into RSA Archer
l The user account does not currently exist in RSA Archer
l Available user licenses exist
Queued A synchronization request has been issued, but the system has not yet
responded to the request.
Running, LDAP synchronization is currently in process, but a cancel request has been
pending issued. The system has not yet responded to the request.
cancel
Note: If the LDAP synch status is Queued or Running, the Cancel Sync Job section is displayed
instead of the Immediate Sync Request section.
6. If failures occurred in the last sync attempt, in the Failure Detail field, click View Failure Detail
to view failure information in a text file.
2. From the Status list, change the status of this LDAP configuration to one of the following:
l Inactive to disable the use of this LDAP configuration.
l Active to enable the use this LDAP configuration.
3. Click Save or Apply.
Note: When you delete an LDAP configuration, all users and group information associated with an
LDAP configuration are permanently deleted.
2. Click the row of the LDAP configuration that you want to delete.
Notifications
The Notifications feature is a time-saving function for sending notifications of various conditions as
they occur to designated recipients, for example, adding or updating a record. RSA Archer
administrators can customize notifications using blueprints by defining the appearance and page
properties that then can be used by multiple notifications.
Specified users receive notifications when a defined trigger occurs in an application or
questionnaire. A trigger is any change detected in RSA Archer that initiates the publishing of a
notification. A trigger can be any of the following:
l Saving a record
l Periodic reports
l DDE rules
l Workflow stage changes
l Daily record search based on filter criteria
l Training and Awareness events and reminders
l Discussion Forum postings
When a specified trigger occurs, notifications are queued after a save or based on a specific
schedule.
Global Notification Settings are general properties that define default values for all notifications, as
well as read-receipt functionality. The Read Receipt properties enable administrators to activate the
read-receipt functionality. A designated email account tracks the receipt of notifications triggered by
a notification blueprint.
Recipients can receive notifications using any email-based device. RSA Archer users can select the
notifications that they want to receive from the User Preferences menu.
Essential terminology
The following table defines important terms to understand when working with notifications.
Term Definition
Layout The format of the content in the body of a notification. Content can be structured or
free form.
Notification The notice that specified recipients receive based on a set of pre-defined conditions.
Notification The specification of properties and settings for the notifications. The notification
Blueprint blueprint defines what information is sent, when it is sent, who should receive it, and
how the information is displayed.
Notification The act of creating and sending notifications. Publishing includes a delivery method,
Publishing subscription behaviors, and recipients.
Recipient An RSA Archer user or other user who receives notifications. Depending on the
notification blueprint, recipients can be one or a combination of the following:
l RSA Archer users and groups
l RSA Archer users contained in Record Permission fields
l Other users that are manually entered in the blueprint (non-RSA Archer users)
Note: If a user is specified multiple times (for example, individually, and as part of
a group or role), that user receives only 1 notification each time the notification is
triggered.
Template A preset format of a notification type made up of the name, letterhead and body
layout in the notification blueprint.
Trigger Any change detected in RSA Archer that initiates the publishing of a notification.
When a specified trigger occurs, notifications are queued and processed.
Recipient rules
Recipients can be users, groups, or manually entered email addresses. Recipients who are non-RSA
Archer users receive all content regardless of permissions.
If a user account is Locked, that account does not receive any notifications to which it was
subscribed.
Users A specific RSA Archer user receives the notification. The primary email address for the
user listed in the user account is used to send the notification.
If the user is subscribed to a notification and selects a different address in the Manage
Your Email Subscription page from the Preferences menu, the specified email address is
used.
Groups A specific group receives the notification. Each user in the group is treated individually
at the time the notification is sent. The user email address follows the same rules defined
for the Users type.
Fields The fields that contain email addresses at the time of publication receive the notification.
The following types of fields can contain email addresses:
l Record Permissions. Recipients are specified at the record level.
l Text. Recipients are specified as users in the field.
l User/Groups List. Recipients are specified in a list of users and groups in RSA
Archer.
l Values List. Recipients are specified in a list of predetermined values.
l Workflow. Recipients are specified in the Workflow Stage Properties.
User/Group Lists are not record-based. All other field types are record-based Text fields.
Values Lists do not use record permissions.
Static The email address that is entered manually in the notification blueprint.
Subscription rules
Notification subscriptions enable recipients to receive notifications after the adding or updating of
records in specified applications or questionnaires. The following table describes the available
subscription types.
The following table describes the available subscription types.
Subscriber
Description
Type
None Users are not subscribed by default. Users can subscribe and cancel at any time.
New Users New users receive notifications by default, but they can cancel the subscription at
any time.
Subscriber
Description
Type
All Users New and existing users receive notifications by default, but they can cancel the
subscription at any time.
Required New and existing users receive notifications by default, but they cannot cancel
the subscription.
Administrators specify the default settings for notifications in the notification blueprints. RSA
Archer users can subscribe or unsubscribe to notifications from the User Preferences menu >
Manage Your Email Subscriptions.
All selected recipients automatically receive notifications.
Notification Publishing
Notification publishing creates and sends notifications to specified recipients when a defined trigger
occurs. For each notification type and blueprint, notifications are sent according to a delivery
schedule specified in the notification blueprint.
Notifications are queued and processed after a save or on a specific schedule. If the delivery method
is Instantly or Digest, notifications are not sent when saving the record updates a calculated field if
there are no other changes to that record.
Notification Blueprints
Notification blueprints are containers that you can use to generate and send notifications to specified
recipients when a defined trigger occurs, such as adding or updating a record.
Notification blueprints specify the rules for generating the notifications. Use a unique name for each
notification blueprint for each instance. Notifications are sent according to the template layout and
delivery schedule defined in the blueprint.
When creating and configuring a blueprint, you can:
l Specify the application it monitors
l Design the layout
l Configure the delivery methods and recipients
l Specify the conditions in the application records that cause an email to be sent
Blueprint elements contain the rules for layout template design, delivery, and filter criteria.
Notification types determine which blueprint elements are used.
General General information defines notification names and letterhead properties. It also
Information specifies how information is displayed.
The Body Layout can be formatted in a table or free form.
The Table layout provides a structured notification as information is presented
in a two column format.
The Free Form layout provides more flexibility and allows you to arrange
content according to the parameters of the Rich Text Toolbar.
Notification
Blueprint Description
Element
Content Content specifies the notification content including the email subject and body.
Content can vary between notification types and can include dynamic data,
static data, and links. Fields are an example of dynamic data, for example,
[Field:Date].
Report content can be an attachment or a link to a report.
Delivery Delivery determines the delivery schedule and recipients of the notification.
Notifications can be queued instantly, sent as a digest (daily, weekly, monthly,
or quarterly), or as a reminder based on search-based filter criteria.
Filter Criteria Filter the record based on specified criteria that must be met to generate the
email notification.
Letterhead
Letterhead templates define the page, header, body, and footer properties used in a notification. A
letterhead is not a required element of a notification blueprint, and does not apply to notifications
sent in XML format. A default letterhead is specified in Global Notification Settings, but the
selection can be overridden in the individual notification blueprint.
Body layout
The body layout defines the format of the layout in the notification body, including how the content is
arranged. The body layout can be structured and free form. The structured format presents content in
a two-column table. The left column contains the field name, and the right column contains the field
value. The free-form body layouts allow the content to be arranged anywhere in the body of the
notification.
Content
The content of a notification includes user-defined static content and dynamic content placeholders
in the Subject line and Body. Static content is text that remains the same for every notification, while
dynamic content changes based on data from specified fields.
The following table describes the types of content.
Type Dynamic Content Placeholder for...
Field Data from the fields of the records used for publishing the notification.
Report Links to global and personal reports that are available from an application or
questionnaire.
Subject
You can configure the Subject line for all notification types using static and dynamic text and data
from fields. A Cross-Reference field appears as a Key Field reference.
Do not use the following field types to create dynamic content in the Subject line:
l Attachment l Sub-Form
l Cross-Application Status l Questionnaire
Tracking Reference
l Image l Access History
l Record Permissions l History Log
l Scheduler
Body
The Body is composed of user-defined static content and dynamic content placeholders.
l Static content is text that remains the same for every notification.
l Dynamic content is content that changes based on unique parameters and is based on the field,
reports, or links you select. When defining content, fields, reports, and links become placeholders
for the actual data or content of the notification, which is generated during notification publishing.
The following figure shows an example of content for a subscription notification for Incident
Management for reporting an incident to a business unit manager who is waiting on an update.
l 1: Field names are the placeholders for the actual field values that dynamically display when the
notification is generated.
Fields that cannot be included as dynamic content in the Subject line are: Attachment, Cross-
Application Status Tracking, Image, Record Permissions, Sub-Form, Questionnaire Reference,
Access History, and History Log.
Some of the element options vary based on the notification type. Content for the Scheduled Report
Distributions notification includes a section for specifying the report and attachment type, for
example, PDF, Word, Excel, and others.
Note: For Subscription and On Demand notifications, the type of content you place in the Body area
depends on the option you select in the Body Layout field on the General tab.
Notification delivery
Notifications are delivered based on the delivery methods that are configured in the notification
blueprint. In most cases, notifications are only sent when a record is saved unless the delivery
method is Instantly or Digest. When set to either delivery method, notifications are not sent when
saving the record updates a calculated field when there are no other changes to the record.
Delivery methods
Instantly
Notifications are published as soon as possible when a trigger occurs for record-based
notifications. An example of a trigger is saving a record.
Digest Notifications are aggregated and published in a digest. Digest notifications include
records that meet the filter criteria, and have been added or updated since the last time
the notification was sent. For example, if a daily digest is configured to send every day
at 1:00 pm, it will include all records saved since 1:00 pm the previous day.
The data used for publishing the notification are captured each time a record is added
or updated. Notification publishing uses the most recent version of a record that passed
the filter criteria of the notification blueprint. If the notification blueprint filters are
modified within a specified period, the already captured record is still used for
notification publishing at the end of the period.
The frequencies are as follows:
l Daily. Notifications are published once per day based on the notification blueprint.
l Weekly. Notifications are published once per week based on the notification
blueprint.
l Monthly. Notifications are published once per month based on the notification
blueprint.
l Quarterly. Notifications are published once per quarter on January 1st, April 1st,
July 1st, and October 1st based on the notification blueprint.
Reminder
Notifications are published once per day, and typically use date filters that compare a
date-based field in each record to the date that the notification is being run. The record
collection is search-based, and does not require a save to occur for the notifications to
be published. All records for an application or questionnaire can potentially be
returned for a record-based notification.
Filter criteria
Filter criteria determine the records that are published in a notification. Only records that meet the
specified filter criteria are included in the notification. A notification is not generated unless all
criteria is fulfilled.
For notifications generated from the DDE Generate Notification action, DDE rules determine which
records are included.
Example: Criteria for filtering by a date
l Field to Evaluate = Date
l Operator = Equals
l Value(s) = 1/10/2015
Report- Report-based notifications contain static content based on the user permissions of
Based the user who created the notification report template. Report-based notifications
are sent on a required schedule.
These notifications include an embedded report or a link to a report. A link to the
report requires the recipient to have an active RSA Archer user account, and
recipients can only view the records for which they have record permissions.
The report-based notification is called Scheduled Report Distributions.
Other Data Data Source notifications contain data from other data sources. The notifications
Source for Training and Awareness and Discussion Forums can be generated.
Notification
Description
Type
System Admin notifications inform users of important system changes and events that are
not directly related to application content. For example, you can set up a
notification when a password changes, or when a mail merge job succeeds or fails.
Subscription Notifications
A user adds a new issue in the application or questionnaire and selects Urgent in the
Result
Priority field and clicks Save. Everyone on the team receives a notification.
Users can receive notification emails using any email-based device, and select which notifications
they want to receive using the Manage Your Email Subscriptions option in the User Preferences
menu.
On-Demand Notifications
On-Demand notifications are pre-configured notifications that RSA Archer users can send to anyone
with an active email address. Administrators configure the properties of a notification in an On-
Demand notification blueprint.
When RSA Archer users click in the page toolbar on a record, they can make a selection from a
list of available On-Demand notification blueprints.
The following table describes the elements that are specific to On-Demand notifications.
By default, the email address of recipients is entered manually. They also have the
Recipient option to specify with which addressee type the recipient can be associated, for
example, as CC, BCC, and To.
A user adds new information to a remediation plan that affects other plans. The user
Result clicks and selects Remediation Plans from a list of blueprints. An email alert is
sent to every member of the executive team with the status of the remediation plans.
XML notifications are used to transmit information from RSA Archer to an external system or
integration in XML format. Administrators configure the properties of an XML notification in an
XML notification blueprint.
The following table describes the elements that are specific to XML notifications.
Element Description
Content Only fields are included within the Subject line and Body of the notifications.
Recipient The email addresses of the recipients are entered manually. Multiple email
addresses are separated by a semicolon. The email addresses specified as recipients
receive all notifications generated by the notification blueprint.
Notifications can be generated through the DDE Generate Notification action. The Generate
Notification action enables administrators to configure a notification. When a record is added or
updated that meets defined rule conditions, a Generate Notification action is triggered.
Note: If a workflow is enabled in an application, then only the Reminder notification type can be
used in a DDE. If you try to send notifications on an instant, daily, weekly or monthly basis in an
application or questionnaire that has workflow enabled, the notifications do not send. These types of
notification can only be sent from within an enabled workflow.
The following table describes the rules that apply to the DDE Generate Notification action.
RSA Archer users, groups, or recipients specified in a field or Record Permission
Recipient fields. Recipients are not specified in the notification blueprint of the DDE
Notification action.
Subscription Recipients cannot subscribe or unsubscribe from DDE Generate Notification action.
A user adds a new issue in the application or questionnaire and selects "Urgent" in the
Result
Priority field and then clicks Save. A notification is sent to everyone on the team.
Workflow Notifications
Recipient Any users or groups determined by the Assignment Model for a stage.
Element Description
Delivery Configured for entrance to any stage in the workflow process, and sent at the end of
that stage.
The Notification functionality of the Training and Awareness feature in RSA Archer enables
administrators to construct and deliver training and awareness notifications to any users and groups.
Training and awareness notifications are organized as campaigns with one or more events.
Campaigns support the coordination of three event types:
l Presentation: Events allow information to be broadcast to users or groups using email or prompts
at logon. Recipients of presentation events are not required to acknowledge receiving the event or
respond to the content of the event. Presentation events represent a passive form of
communication.
l Acceptance: Events extend presentation events to require action from the recipient. These events
are presented to users or groups as a prompt when they log on to RSA Archer. Users receiving an
acceptance event are required to accept or decline the event.
l Quiz: Events enable administrators to test knowledge of the users. These events are presented to
users as a prompt when they log on to RSA Archer. A quiz event is a method for determining that
a user or group received or accepted a trigger, and that they have a complete understanding of the
required reading.
The following table describes the elements that are specific to notifications generated from Training
and Awareness Campaigns.
Element Description
Delivery Acceptance and Quiz events have reminders. Presentation events are sent only once.
Discussion Forums
The notifications from Discussion Forums are subscription-based notifications. RSA Archer users
can subscribe to receive notifications when messages are posted to a forum, posted to a topic, or
posted to a message.
The following table describes the elements that are specific to notifications generated
from Discussion Forums.
Elements Description
Recipient Only RSA Archer users can receive notifications from Discussion Forums.
Reminder Notifications
Reminder Notifications are used to provide information to users either before, on, or after a specific
date. They are published once per day, and use date filters that compare a date-based field in each
record to the date that the notification is being sent.
When creating a notification reminder, you can set when and how often you want to send a
notification email. To prevent the emails from being sent indefinitely, use filters in combination with
any Greater than or Less than reminder criteria.
Important: If a workflow is enabled in an application, then only the Reminder notification type can
be used in a DDE.
The following table describes the elements that are specific to the delivery schedule criteria for noti-
fications.
Criteria
Filter Description
Filter
Operator Determines if the notification will be before, after, or on the date decided by the
Field filter.
Days Determines how many days the reminder will be sent in correlation to the date
dictated by the Field filter.
Target Determines if the notification will be sent before or after the date decided by the
Field filter.
Send a single reminder email 5 days before a Due Date. Field = Due
Date
Operator =
Equals
Days = 5
Occurrence =
Once
Target = After
Date
Intention Configuration
Send a daily reminder email for 5 days. Once each on the 4 days leading up to Field = Due
the Due Date, and again on the Due Date. Date
Operator = Less
Than
Days = 5
Occurrence =
Daily
Target = After
Date
Send a reminder email 5 days after the Due Date has passed. Field = Due
Date
Operator =
Equals
Days = 5
Occurrence =
Once
Target = Before
Date
Send a reminder email each day, beginning on the Due Date, and then for 4 Field = Due
consecutive days afterward. Date
Operator = Less
than
Days = 5
Occurrence =
Daily
Target = Before
Date
Intention Configuration
Send a reminder email every day once a record is more than 5 days past the due Field = Due
date. date
Operator =
Greater Than
Days = 5
Occurrence =
Daily
Target = Before
Date
Activating Notifications
By default, all notifications are inactive.
The Default From Address is required for all instances and all configurations. You configure the
mail server and Default From Address for each instance in the RSA Archer Control Panel.
After configuring notifications in the RSA Archer Control Panel, you must also configure the
application in the instance and the Notifications feature of RSA Archer.
3. In Body Layout, click to preview and select the layout you want, and then click OK.
4. In From Address, enter a default email address.
5. In From Alias, enter a default email alias.
6. In Attachment Type, select the default attachment type.
7. Click Save.
Important: You must set up an email account on your mail server that receives read receipts from
users who have indicated receipt of notification emails. The mail server on which you create this
account most likely is the same mail server that your organization is using for alert notifications.
After the application pulls read-receipt information from the email account that you define, all
emails are deleted from that account to prevent the account from exceeding its storage limit.
Status Indicates whether the read-receipt functionality is active or inactive. The Active
status enables you to configure any notification blueprint to request read-receipts
when notifications are sent to the recipients.
Email Specifies the email address that receives the return receipts.
Address Do not use your own email address as the account to receive the return receipt. All
notifications are deleted from the specified email account after the application or
questionnaire retrieves read-receipt information to prevent the account from
exceeding its storage limit. Use a dedicated email address to receive the read
receipts.
Server Specifies the server name or IP address of the mail server on which the return-
Name receipt email account is created.
The Server Name is the same server name or IP address that was used when
configuring the Notifications for the instance.
Property Description
Protocol Specifies the method that is used to retrieve notifications from the email server.
Port Specifies the number associated with the communication endpoint for the selected
protocol.
User Specifies the name of the user who has access to the return-receipt email account.
Name
Password Specifies the password that is required to log on to the return-receipt email account.
Test Verifies that the credentials and connection information entered are correct.
Connection If an error occurs, correct the error and click Test again. Continue this process until
you receive a confirmation message indicating success.
2. In the Read Receipt Properties section, in the Status field, select the applicable status: Active or
Inactive.
3. Click Save.
2. In the Email Address field, enter the email address that receives the messages.
3. In the User Name field, enter the user name that has access to the return-receipt email account.
4. In the Password field, enter the password that is required to log on to the return-receipt email
account.
5. In the Test Connection field, click Test to verify that the credentials and connection information
you have entered are correct.
Note: If the test reports an error, correct the error and click Test again. Continue this process
until you receive a confirmation message indicating success.
6. Click Save.
Note: You cannot include the following fields in the subject line: Attachment, Cross-
Application Status Tracking, Image, Record Permissions, Sub-Form, Questionnaire
Reference, Access History, and History Log.
b. In the Body field, enter the content you want to show in the notification as text or reference
links.
l To enter a field, select the field or template you want for the admin type from the Toolbar
field.
l To enter a report, select the report you want from the Toolbar field.
l To enter a link, select the link you want from the Toolbar field.
A user adds new information to a remediation plan that affects other plans.
Result The user clicks and selects Remediation Plans from a list of blueprints. An email
alert is sent to every member of the executive team with the status of the remediation
plans.
Recipient By default, the email address of each recipient is entered manually. Optionally, you
can specify the recipient type CC, BCC, and To.
Access The access right for an on-demand notification is specified in the on-demand
notification blueprint. The following options are available:
l Public. All application and questionnaire users will automatically be granted
unrestricted access to use the notification blueprint.
l Private. Only specified users and groups can access the notification blueprint.
a. In the Letterhead field, click and select the letterhead you want.
b. In the Body Layout field, click to select the layout for the body of the notification, and
click OK.
c. In the Preview field, verify that the layout you selected is the one you want to use.
l If the layout is what you want to use, go to the next step.
l If the layout is not what you want to use, repeat steps b and c.
7. Click the Content tab and add the content you want to appear in the notification.
a. In the Subject line, enter the text you want to show as the subject of the notification.
Note: You cannot include the following fields in the subject line: Attachment, Cross-
Application Status Tracking, Image, Record Permissions, Sub-Form, Questionnaire
Reference, Access History, and History Log.
b. In the Body field, enter the content you want to show in the notification as text or reference
links.
l To enter a field, select the field or template you want for the admin type from the Toolbar
field.
l To enter a report, select the report you want from the Toolbar field.
l To enter a link, select the link you want from the Toolbar field.
8. Click the Delivery tab and go to the Email Recipient Options section.
9. In the Send Each Notification As field, specify whether to send separate or one email
notification.
You can set email recipient options to determine whether you want send a separate notification
email to more than one recipient or send one email to multiple recipients.
Send Each l Separate Emails - Sends a separate email to one or more recipients.
Notification Addressees receive an email that has been customized for permissions,
As culture, time zone, and locale. This option allows you to use only the To field
for recipient email addresses.
l One Email - Sends an identical email to multiple recipients. This option is
primarily intended for a limited number of recipients and is not customized for
permissions, culture, time zone and locale. If there is no content in the
notification that all recipients have permission to view, the notification is not
sent.
This feature allows you to use the To, Cc, and Bcc fields for recipient email
addresses. The maximum allowable number of recipients for this option,
expressed as a total from all three addressee fields, is determined in the
RSA Archer Control Panel.
10. In the Recipients section, enter the list of users or groups who will receive this notification.
Recipients can be a dynamic or static list based on the notification type. A dynamic list is based
on the values of a Users and Groups list and record permissions or an email address stored in a
field.
Do the following for To, CC, and BCC:
a. (Optional) In Dynamic, do one or more of the following:
l Expand the Groups tree and select the groups you want to receive the notification.
l Expand the Users tree and select the users you want to receive the notification.
b. Click OK.
c. (Optional) In Static, enter email addresses of the recipients you want to receive the
notification. When entering more than one email address, use a semi-colon to separate the
email addresses of recipients.
11. Click the Access tab and specify whether the notification is public or private.
In the Access section, select whether the notification is available to everyone or specified users
and groups.
Note: If a user who created a report is inactive and that report is included (attached, not linked) in
SRD, then SRD creates a system impersonated session for that inactive user. SRD also checks for
the current access rights and roles of the inactive user.
Important: Scheduled Report Distributions are different from scheduled email alerts with embedded
reports or links to reports. You can schedule email alerts that contain embedded reports or links to
reports. The records and fields displayed in the scheduled report distribution are based on the access
restrictions of the user who creates the notification. This may result in someone receiving an
embedded report who is otherwise restricted from certain data.
Once a week, a notification with an attached report is sent to managers. The report
Result contains the information based on the record permissions of the user instead of the
managers.
Once a week, a notification with a link to the report is sent to the group of colleagues.
Result A recipient clicks on the link to view the report that contains information based on the
record permissions of the recipient.
Table body layout is not available. All free-form body layouts can be used for
Layout
report-based notifications.
Only links and attached reports are available. Information in the attached report is
based on the record permissions of the RSA Archer user who creates the report. If
Content the report creator has permission to private fields, all reports sent through the
distribution will include the data of the private fields, even if the recipient does not
have access to the fields.
Delivery Notifications are sent on a set schedule: daily, weekly, monthly, or quarterly.
l To create a scheduled report distribution from an existing one, click Copy an existing
Scheduled Report Distribution, and select the notification you want.
3. Click OK.
4. In the General Information section, enter the name of the notification, description, and folder in
which you want to store the notification.
5. In the Template Design section, select the letterhead and body layout you want.
a. In the Letterhead field, click and select the letterhead you want.
b. In the Body Layout field, click to select the layout for the body of the notification, and
click OK.
c. In the Preview field, verify that the layout you selected is the one you want to use.
l If the layout is what you want to use, go to the next step.
l If the layout is not what you want to use, repeat steps b and c.
6. Click the Content tab and specify the reports and attachment type for embedding the report in this
notification.
l In the Reports field, select the report or reports that you want to embed in the email
distribution and click OK.
l In the Attachment Type field, select the format of the report or reports.
7. In the Template Design section, select the subject and content for the notification.
a. In the Subject line, enter the text you want to show as the subject of the notification.
Note: You cannot include the following fields in the subject line: Attachment, Cross-
Application Status Tracking, Image, Record Permissions, Sub-Form, Questionnaire
Reference, Access History, and History Log.
b. In the Body field, enter the content you want to show in the notification as text or reference
links.
l To enter a field, select the field or template you want for the admin type from the Toolbar
field.
l To enter a report, select the report you want from the Toolbar field.
l To enter a link, select the link you want from the Toolbar field.
8. Click the Delivery tab and enter the email properties for this notification.
a. In From Address field, enter the email address from which this notification will be sent.
b. (Optional) In the Alias Field, enter the name you want to use as the sender for the email from
address.
c. (Optional) In the Importance field, select the status you want to associate to this
email: Normal, High, Low.
d. (Optional) In Read Receipt, select whether an acknowledgment is sent after the notification
is opened by the recipient.
l If you want to receive acknowledgment, select Enable Return Receipt.
l If you do not want to receive acknowledgment, select Disable Return Receipt, the default
selection.
9. In the Delivery Schedule section, define the frequency and its values for sending this
notification.
a. In the Frequency field, select the period in which you want to send the notification. Your
selection determines what you do next.
b. Enter the applicable values for the frequency you selected.
Note: Instantly and Reminder are not available for Scheduled Report Distributions.
Daily a. In Time, set the time that you want to send the notification.
b. In Time Zone, select the Coordinated Universal Time (UTC) time zone.
Weekly a. In Day, select the day of the week that you want to send the notification.
b. In Time, set the time that you want to send the notification.
c. In Time Zone, select the Coordinated Universal Time (UTC) time zone.
Monthly a. In Day, select the day of the month (1 through 31) that you want to send
the notification. Because not all months have 31 days, you might want to
consider 28 or before.
b. In Time, set the time that you want to send the notification.
c. In Time Zone, select the Coordinated Universal Time (UTC) time zone.
Frequency Action
Quarterly a. In Time, set the time that you want to send the notification.
b. In Time Zone, select the Coordinated Universal Time (UTC) time zone.
Reminder a. In Time, set the time that you want to send the notification.
b. In Time Zone, select the Coordinated Universal Time (UTC) time zone.
c. In Criteria, do the following:
i. In Field, select the date field to be used for evaluating the filtering
condition.
ii. In Operator, select the applicable operator, Equals, Does Not Equal,
Less Than, or Greater Than.
iii. In Day, select the number of days on which to evaluate the
occurrence.
iv. In Target, select After Date or Before Date.
d. (Optional) To add another condition, click Add New and repeat the steps
for adding criteria.
e. (Optional) To delete a criteria row, click .
Note: When you choose Reminder for your frequency, Email Recipients
Options can only be set to Separate Emails.
c. In Digest Content Published, do one of the following for records that satisfy the specified
Notification filter criteria and were generated or changed within the time period as defined
by the Frequency and Time settings:
l Select Any Version to include any records that satisfied filter criteria since the last sent
digest.
l Select Current Version Only to include only records that meet filter criteria at the time
digest notification is sent.
10. In the Email Recipient Options section, specify whether to send separate or one email
notification.
You can set email recipient options to determine whether you want send a separate notification
email to more than one recipient or send one email to multiple recipients.
Send Each l Separate Emails - Sends a separate email to one or more recipients.
Notification Addressees receive an email that has been customized for permissions,
As culture, time zone, and locale. This option allows you to use only the To field
for recipient email addresses.
l One Email - Sends an identical email to multiple recipients. This option is
primarily intended for a limited number of recipients and is not customized for
permissions, culture, time zone and locale. If there is no content in the
notification that all recipients have permission to view, the notification is not
sent.
This feature allows you to use the To, Cc, and Bcc fields for recipient email
addresses. The maximum allowable number of recipients for this option,
expressed as a total from all three addressee fields, is determined in the
RSA Archer Control Panel.
11. In the Recipients section, enter the list of users or groups who will receive this notification.
Recipients can be a dynamic or static list based on the notification type. A dynamic list is based
on the values of a Users and Groups list and record permissions or an email address stored in a
field.
Do the following for To, CC, and BCC:
a. (Optional) In Dynamic, do one or more of the following:
l Expand the Groups tree and select the groups you want to receive the notification.
l Expand the Users tree and select the users you want to receive the notification.
b. Click OK.
c. (Optional) In Static, enter email addresses of the recipients you want to receive the
notification. When entering more than one email address, use a semi-colon to separate the
email addresses of recipients.
a. In the Letterhead field, click and select the letterhead you want.
b. In the Body Layout field, click to select the layout for the body of the notification, and
click OK.
c. In the Preview field, verify that the layout you selected is the one you want to use.
l If the layout is what you want to use, go to the next step.
l If the layout is not what you want to use, repeat steps b and c.
6. Click the Content tab and add the content you want to appear in the notification.
a. In the Subject line, enter the text you want to show as the subject of the notification.
Note: You cannot include the following fields in the subject line: Attachment, Cross-
Application Status Tracking, Image, Record Permissions, Sub-Form, Questionnaire
Reference, Access History, and History Log.
b. In the Body field, enter the content you want to show in the notification as text or reference
links.
l To enter a field, select the field or template you want for the admin type from the Toolbar
field.
l To enter a report, select the report you want from the Toolbar field.
l To enter a link, select the link you want from the Toolbar field.
7. Click the Delivery tab and in the Email Properties section, do the following:
a. In From Address field, enter the email address from which this notification will be sent.
b. (Optional) In the Alias Field, enter the name you want to use as the sender for the email from
address.
c. (Optional) In the Importance field, select the status you want to associate to this
email: Normal, High, Low.
d. (Optional) In Read Receipt, select whether an acknowledgment is sent after the notification
is opened by the recipient.
l If you want to receive acknowledgment, select Enable Return Receipt.
l If you do not want to receive acknowledgment, select Disable Return Receipt, the default
selection.
8. In the Delivery Schedule section, define the frequency and its values for sending this
notification.
a. In the Frequency field, select the period in which you want to send the notification. Your
selection determines what you do next.
b. Enter the applicable values for the frequency you selected.
Note: Instantly and Reminder are not available for Scheduled Report Distributions.
Daily a. In Time, set the time that you want to send the notification.
b. In Time Zone, select the Coordinated Universal Time (UTC) time zone.
Weekly a. In Day, select the day of the week that you want to send the notification.
b. In Time, set the time that you want to send the notification.
c. In Time Zone, select the Coordinated Universal Time (UTC) time zone.
Monthly a. In Day, select the day of the month (1 through 31) that you want to send
the notification. Because not all months have 31 days, you might want to
consider 28 or before.
b. In Time, set the time that you want to send the notification.
c. In Time Zone, select the Coordinated Universal Time (UTC) time zone.
Quarterly a. In Time, set the time that you want to send the notification.
b. In Time Zone, select the Coordinated Universal Time (UTC) time zone.
Frequency Action
Reminder a. In Time, set the time that you want to send the notification.
b. In Time Zone, select the Coordinated Universal Time (UTC) time zone.
c. In Criteria, do the following:
i. In Field, select the date field to be used for evaluating the filtering
condition.
ii. In Operator, select the applicable operator, Equals, Does Not Equal,
Less Than, or Greater Than.
iii. In Day, select the number of days on which to evaluate the
occurrence.
iv. In Target, select After Date or Before Date.
d. (Optional) To add another condition, click Add New and repeat the steps
for adding criteria.
e. (Optional) To delete a criteria row, click .
Note: When you choose Reminder for your frequency, Email Recipients
Options can only be set to Separate Emails.
c. In Digest Content Published, do one of the following for records that satisfy the specified
Notification filter criteria and were generated or changed within the time period as defined
by the Frequency and Time settings:
l Select Any Version to include any records that satisfied filter criteria since the last sent
digest.
l Select Current Version Only to include only records that meet filter criteria at the time
digest notification is sent.
9. In the Subscriptions section, click the type for the default subscriber.
The following table describes the subscriber types.
Subscriber
Description
Type
None Users are not subscribed by default. Users can subscribe and cancel at any
time.
New Users New users receive notifications by default, but they can cancel the
subscription at any time.
Subscriber
Description
Type
All Users New and existing users receive notifications by default, but they can cancel
the subscription at any time.
Required New and existing users receive notifications by default, but they cannot cancel
the subscription.
10. In the Email Recipient Options section, specify whether to send separate or one email
notification.
You can set email recipient options to determine whether you want send a separate notification
email to more than one recipient or send one email to multiple recipients.
The following table describes the properties.
Property Description
Send Each l Separate Emails - Sends a separate email to one or more recipients.
Notification Addressees receive an email that has been customized for permissions,
As culture, time zone, and locale. This option allows you to use only the To field
for recipient email addresses.
l One Email - Sends an identical email to multiple recipients. This option is
primarily intended for a limited number of recipients and is not customized for
permissions, culture, time zone and locale. If there is no content in the
notification that all recipients have permission to view, the notification is not
sent.
This feature allows you to use the To, Cc, and Bcc fields for recipient email
addresses. The maximum allowable number of recipients for this option,
expressed as a total from all three addressee fields, is determined in the
RSA Archer Control Panel.
11. In the Recipients section, enter the list of users or groups who will receive this notification.
Recipients can be a dynamic or static list based on the notification type. A dynamic list is based
on the values of a Users and Groups list and record permissions or an email address stored in a
field.
12. Click the Filter Criteria tab, enter the filters that you want to apply to this notification.
Only the records that match the specified criteria trigger a notification to generate.
a. In the Field to Evaluate field, select the field on which the evaluation is based.
b. In the Operator field, select the applicable operator for evaluating the values.
c. In Value(s), select the applicable values based on the field specified and click OK.
d. (Optional) To add a row for additional criteria, click Add New, and then repeat steps a – c.
e. (Optional) To add advanced operator logic, in the Advanced Operator Logic field, enter the
expression.
Example
The following table provides an example XML notification scenario.
The Devices Vulnerability system of the IT team needs to be automatically notified
Scenario
when a new vulnerability is added to correctly update user interface displays.
A user with administrative rights creates an XML notification blueprint. Specific fields
are selected to be in the Subject line and Body of the template. The delivery frequency
Action
is Instantly, and the recipient is the email address of the Devices Vulnerability system.
The filter criteria is "Vulnerability" in the Text field.
Every time a new vulnerability is imported into RSA Archer, a notification is sent to the
Result
Devices Vulnerability system in an XML format.
Content Only fields are included within the Subject line and Body of the notifications.
Recipient The email addresses of the recipients are entered manually. Multiple email
addresses are separated by a semicolon. The email addresses specified as recipients
receive all notifications generated by the notification blueprint.
Note: You cannot include the following fields in the subject line: Attachment, Cross-
Application Status Tracking, Image, Record Permissions, Sub-Form, Questionnaire
Reference, Access History, and History Log.
b. In the Body field, select the fields you want to include in this notification.
6. Click the Delivery tab and enter the email properties for this notification.
a. In From Address field, enter the email address from which this notification will be sent.
b. (Optional) In the Alias Field, enter the name you want to use as the sender for the email from
address.
c. (Optional) In the Importance field, select the status you want to associate to this
email: Normal, High, Low.
d. (Optional) In Read Receipt, select whether an acknowledgment is sent after the notification
is opened by the recipient.
l If you want to receive acknowledgment, select Enable Return Receipt.
l If you do not want to receive acknowledgment, select Disable Return Receipt, the default
selection.
7. In the Delivery Schedule section, define the frequency and its values for sending this
notification.
a. In the Frequency field, select the period in which you want to send the notification. Your
selection determines what you do next.
b. Enter the applicable values for the frequency you selected.
Note: Instantly and Reminder are not available for Scheduled Report Distributions.
Daily a. In Time, set the time that you want to send the notification.
b. In Time Zone, select the Coordinated Universal Time (UTC) time zone.
Weekly a. In Day, select the day of the week that you want to send the notification.
b. In Time, set the time that you want to send the notification.
c. In Time Zone, select the Coordinated Universal Time (UTC) time zone.
Frequency Action
Monthly a. In Day, select the day of the month (1 through 31) that you want to send
the notification. Because not all months have 31 days, you might want to
consider 28 or before.
b. In Time, set the time that you want to send the notification.
c. In Time Zone, select the Coordinated Universal Time (UTC) time zone.
Quarterly a. In Time, set the time that you want to send the notification.
b. In Time Zone, select the Coordinated Universal Time (UTC) time zone.
Reminder a. In Time, set the time that you want to send the notification.
b. In Time Zone, select the Coordinated Universal Time (UTC) time zone.
c. In Criteria, do the following:
i. In Field, select the date field to be used for evaluating the filtering
condition.
ii. In Operator, select the applicable operator, Equals, Does Not Equal,
Less Than, or Greater Than.
iii. In Day, select the number of days on which to evaluate the
occurrence.
iv. In Target, select After Date or Before Date.
d. (Optional) To add another condition, click Add New and repeat the steps
for adding criteria.
e. (Optional) To delete a criteria row, click .
Note: When you choose Reminder for your frequency, Email Recipients
Options can only be set to Separate Emails.
c. In Digest Content Published, do one of the following for records that satisfy the specified
Notification filter criteria and were generated or changed within the time period as defined
by the Frequency and Time settings:
l Select Any Version to include any records that satisfied filter criteria since the last sent
digest.
l Select Current Version Only to include only records that meet filter criteria at the time
digest notification is sent.
8. In the Recipients section, enter the list of users or groups who will receive this notification.
Recipients can be a dynamic or static list based on the notification type. A dynamic list is based
on the values of a Users and Groups list and record permissions or an email address stored in a
field.
Do the following for To, CC, and BCC:
a. (Optional) In Dynamic, do one or more of the following:
l Expand the Groups tree and select the groups you want to receive the notification.
l Expand the Users tree and select the users you want to receive the notification.
b. Click OK.
c. (Optional) In Static, enter email addresses of the recipients you want to receive the
notification. When entering more than one email address, use a semi-colon to separate the
email addresses of recipients.
9. Click the Filter Criteria tab, enter the filters that you want to apply to this notification.
Only the records that match the specified criteria trigger a notification to generate.
a. In the Field to Evaluate field, select the field on which the evaluation is based.
b. In the Operator field, select the applicable operator for evaluating the values.
c. In Value(s), select the applicable values based on the field specified and click OK.
d. (Optional) To add a row for additional criteria, click Add New, and then repeat steps a – c.
e. (Optional) To add advanced operator logic, in the Advanced Operator Logic field, enter the
expression.
Letterhead Specifies the default letterhead. The right column displays a preview of the selected
letterhead.
Body Specifies the default layout of the body, including the arrangement of the data. The
Layout Table body layout arranges the content in a structured format. All other body layouts
are free-form layouts, and you can arrange content anywhere in the body.
From Specifies the default email address from which to send notifications. The Default
Address From Address established for the instance is used if this one is not provided.
From Alias Specifies the default email alias for the From Address.
Attachment Specifies the default attachment type. The following types are available:
Type l Adobe PDF
l CSV
l HTML File
l Microsoft Excel
l Microsoft Word
l XML File
Use the Manage Global Notification Settings page to configure the default global values.
l Configuring Default Settings
l Defining Read Receipt Rules
Letterhead properties
The following table describes the letterhead properties.
Property Description
Name Specifies the name of the letterhead. The name of each letterhead must be unique
across the instance.
Status Enables the letterhead to be used in notifications. To prevent the letterhead from
being used, select Inactive.
Property Description
Page Specifies the entire page background color and border settings, including the line
height.
Header Specifies the header background color and border settings, including the line height.
Body Specifies the body background color and border settings, including the line height.
Footer Specifies the footer background color and border settings, including the line height.
Property Action
Background If you selected Solid Fill, specify the color for the background of the body. To
Color choose a background color, do one of the following:
l Enter the HTML code in the space provided, for example #FFFFFF.
Line Specify the color of the body border. To choose a color, do one of the following:
Color l Enter the HTML code in the space provided, for example #FFFFFF.
Line
Click the arrows to set the width in pixels of the border. If you prefer
Height
no border, set the value at zero (0).
3. Click .
4. Click OK.
1. Go to the Manage Read Receipt Properties section on the Manage Global Notifications Settings
page.
2. In the Email Address field, enter the email address that receives the messages.
3. In the User Name field, enter the user name that has access to the return-receipt email account.
4. In the Password field, enter the password that is required to log on to the return-receipt email
account.
5. In the Test Connection field, click Test to verify that the credentials and connection information
you have entered are correct.
Note: If the test reports an error, correct the error and click Test again. Continue this process
until you receive a confirmation message indicating success.
1. Go to the Read Receipt Properties section on the Manage Global Notifications Settings page.
2. In the Read Receipt Properties section, in the Status field, select the applicable status: Active or
Inactive.
3. Click Save or Apply.
l Click Save to save and exit.
l Click Apply to apply the changes and continue working.
Note: If the test reports an error, correct the error, and click Test again. Continue this process
until you receive a confirmation message indicating success.
Troubleshooting Notifications
The job engine is not Start the Job Engine in the Windows Services.
running in the Windows
Services.
The wrong type of Ensure you are using the correct type of notification blueprints for
notification blueprint is used the data that is being triggered.
for the triggering data. Updates to records trigger subscription notifications. You can
update records manually or through a data feed.
Reminder notifications are based on specific criteria. All criteria
must be met to trigger a notification.
Cause Solution
The record in the data feed Ensure the data feed is configured for sending notifications. Select
does not trigger the Send Notifications in the Additional Properties of the data feed.
notifications. DDE Generate Notification action and On-Demand notifications
are not triggered from data feed.
Use Subscription Notifications in a data feed so that data is
accessible on the schedule of the notifications.
Reminder notifications are based on specific criteria. All criteria
must be met to trigger a notification.
The notification jobs are not Set the job priority in the Job Engine Manager. For more
prioritized properly. information, see "Set Filters" in the RSA Archer Control Panel
Help.
There are many jobs ahead Change the priority of the SendNotificationJob or SendMessagesJob
of the notification job types. notification job types.
Workflow notifications can If you enable a workflow in an application, then only the Reminder
only be sent by the notification type can be used in a DDE.
Reminder notification type If you try to send notifications on an instant, daily, weekly or
for a Data-drive event monthly basis in an application or questionnaire that has workflow
(DDE). enabled, the notifications do not send. These types of notification
can only be sent from within an enabled workflow.
The user does not have Check the Access Roles of the user to ensure that the user has
permissions to view the access rights to the application or questionnaire of that record.
record. Ensure that the user has access rights to view that record, including
Cross-Reference fields and related records.
Records do not have to be saved or updated to send a reminder notification. Records are evaluated at
the specified time according to the delivery schedule. The reminder notification is sent when a
record meets all the defined filter criteria.
The following scenarios provide the filter criteria for sending reminder notifications before the
current data and after the current date.
Example: Using the Notification Engine Recent Activity - Last 24 Hours report
Successful The notifications are sent Check the Junk E-Mail folder or other email folders
successfully, but the recipient of the recipient.
does not receive it. If the notification is not in another folder, generate
the Notifications Sent report to view that the
Recipient Email Address is correct.
Successful There are fewer notifications Recipients did not receive all notifications. If this is
shown in the report than happening:
should have been sent. 1. Check the application or questionnaire's record
permission fields to be sure the recipient is
allowed to see the records.
2. Check the rights of the roles assigned to the
groups to which the recipient belongs.
3. Check the rights of the roles assigned to the
recipient.
4. Modify the rights and permissions appropriately
and resend the notifications.
Successful The recipient only sees part of Recipients do not have permission to view the
the content. record. If this is happening:
1. Check the application or questionnaire's record
permission fields to be sure the recipient is
allowed to see the records.
2. Check the rights of the roles assigned to the
groups that the recipient belongs.
3. Check the rights of the roles assigned to the
recipient.
4. Modify the rights and permissions appropriately
and resend the notifications.
Message
Problem Solution
Status
Failed The notifications failed to Ensure that the Server Address is correct in the RSA
send. Archer Control Panel > General Settings of the
instance.
Ensure the user account of the recipient has an email
address. See Managing Users.
N/A The report does not show any Check the notification rules to be sure that they are
notifications; the notifications valid and will trigger. If that is the issue, modify the
did not trigger. rules and send again.
Note: This topic is intended for administrators. For an overview for users, see "Discussion Forums
for End Users" in the RSA Archer Online Documentation .
The Discussion Forums feature enables administrators to create structured environments where
users can exchange information on various topics. These environments, called forums, provide a
platform for posting and replying to topics. Administrators can group forums together into
communities. For example, a community named Microsoft Windows can contain forums for
Microsoft Windows Vista vulnerabilities and Microsoft Windows 7 vulnerabilities.
The Discussion Forums feature appears in both the administration suite and the end-user suite of
features. In the Discussion Forums feature in the administration suite, administrators can establish
discussion forum communities and assign forum creators for each community. They also can define
roles for forum participants, which control the permissions end users have in discussion forums.
Application owners also can create record-specific discussion forums to allow users to discuss
information as it relates to a specific content record. The Discussion field type is available for this
purpose.
In the end-user Discussion Forums feature, forum creators can create new forums in their assigned
communities and can define the properties of those forums, select forum members, and assign roles
to those members. End users also can access forums to which they belong through the end-user
Discussion Forums feature, enabling them to read, add, or respond to topics according to the rights
assigned to them through their forum roles.
The Discussion Forums feature provides several default roles for forum participants and enables
administrators to create additional roles. Forum creators, designated by administrators of the
Discussion Forums feature, can create new forums in their assigned communities and can define the
properties and the membership for those forums. Default roles that forum creators can assign to
forum members include forum administrator, moderator, participant, and read-only participant.
Community An organizational structure for grouping one or more related discussion forums. A
community itself is not a forum and cannot receive posts.
Traditional A standard discussion forum built through the Discussion Forums feature.
Forum
Content- A discussion forum that is linked directly to a specific content record. It cannot be
Specific accessed through the Discussion Forums application. Instead, users can access it
Forum by clicking View Forum in the Discussion field in a record.
Locked Messages in a locked forum can be read by users, but no new messages can be
Forum posted to the forum.
Archived An archived forum is hidden entirely from forum participants. No messages can be
Forum read or posted in the forum. However, an archived forum can be made available
again to forum participants by a community or forum administrator.
Community A user who has been granted the rights to view, edit, and delete all forums in a
Administrator selected community, regardless of whether the user has been enrolled as a
member of those forums. Discussion community administrators also can add new
forums in their assigned communities.
Forum To access and contribute to a forum, a user must be enrolled as a member of that
Membership forum. Each member is assigned a specific role that governs the user rights in the
forum.
Forum Role Each member of a forum is assigned a specific role, which is a named grouping of
rights. A user role dictates what the user can and cannot do in a particular
discussion forum. For example, administrators might create a role called "Reader,"
which is assigned to users who need the ability to view all posts in a given forum,
but who will not be permitted to respond to those posts or to contribute new topics
for discussion.
Term Definition
Forum When a forum creator assigns a user as an administrator of a selected forum, the
Administrator administrator has rights to post messages and to edit and delete posts made by any
forum participant. Forum administrators also can enroll additional members or
revoke the membership of any user or group.
Moderator When a forum creator assigns a user as a moderator of a selected forum, that
moderator has rights to post messages and to edit and delete posts made by any
forum participant. They also can enroll additional members or revoke the
membership of any user or group, and they can manage the properties of the
forum, including its expiration plan, reply depth, display options, and so on. In
addition, moderators can merge topics in the forum.
Post A generalized term referring to any type of message submitted to a forum. Topics
and replies are specific types of posts.
Topic A top-level post that poses a question or otherwise establishes the context for a
thread of discussion. Topics serve as containers for replies.
Reply A post that is submitted in response to an existing post. Replies provide the means
for exchanging thoughts, opinions, or supporting information relative to a given
topic.
Thread A single topic and all of its related replies. The topic-directed discussion that
occurs in a forum is thought of as "threaded" because you can trace the path of
information from the original topic down through all of its reply postings.
Hot Topic A topic is considered "hot" if it has been replied to or viewed several times in a
short period of time. Hot topics are displayed with a star icon so users can easily
identify them. Community and forum administrators define the criteria for topics
marked as "hot," and these criteria can vary from forum to forum. For example, in
one forum, a hot topic may be defined as one that has received 10 posts in the last
3 days and has been viewed 20 times in the last day. In another forum, a hot topic
may be defined simply as one that has received 5 posts in the last day.
Locked Topic When a topic is locked, users are not permitted to reply to it. The topic and its
previous replies, however, remain visible to users. Locked topics can be unlocked
at any time by users who have the proper rights.
You have read all posts in this discussion community, forum, or topic.
This discussion community, forum, or topic contains new posts for you to read.
This discussion community, forum, or topic has recently experienced a large number of
postings and information that you have viewed. You have read all posts in this community,
forum, or topic.
This discussion community, forum, or topic recently experienced a large number of postings
and information that you have viewed. The community, forum, or topic contains new posts
for you to read.
This discussion forum or topic is locked, and you have read all posts in it.
Forum To set the forum to be archived or deleted on a specific date, select Archive or
Expiration Delete, and in the Forum Expiration Date field, select a date on which the
Plan forum should be archived or deleted.
Maximum Enter the maximum number of topics that can be added to the forum. By default,
Topic Count 100 topics are permitted.
Maximum Enter the maximum number of replies that can be posted per topic. By default,
Reply Count 300 replies are permitted.
Option Description
Maximum When a discussion forum user posts a reply to a topic, that reply is nested under
Reply Level the topic. If another user posts a reply to the first user reply, that second post is
Count nested beneath the first post, creating a 2-level reply depth. In this field, enter
the maximum number of reply levels allowed per topic. By default, 20 reply
levels are permitted.
Maximum To set the maximum number of days a topic can reside in the forum, enter the
Topic Age number of days in this field.
(Days)
Attachments To allow forum participants to attach files when posting topics and replies,
select Allow Attachments. You also can define the maximum allowable size for
those file attachments by selecting a size from the Maximum Attachment Size
(MB) list. The default size is 1MB.
Anonymous To allow users to optionally post anonymous messages in the forum, select
Posting Allow. When this option is selected, forum participants can select the Post as
Anonymous User option when submitting a new post in the forum.
Moderator To configure the forum to trigger email notifications for forum moderators each
Emails time a new post is submitted, select Notify when a message is posted.
Hot Topics A topic is considered "hot" if it has been replied to or viewed a specified
Status number of times within a specified number of days. Hot topics are marked for
Criteria users with a star. To configure when topics are flagged as "hot," enter the
number of replies, views, and days in the appropriate fields.
3. On the Membership tab, for each Forum Role to which you want to assign members, click .
4. From the Available list, edit the list of users and groups you want to assign to the role.
l To remove a user or group from the Selected list, click to the right of the name.
l To search for a specific user or group:
a. Enter the appropriate name in the Find field.
b. Select the name type from the adjacent drop-down list.
c. Click .
5. Click OK.
6. Click Save or Apply.
l Click Save to save and exit.
l Click Apply to apply the changes and continue working.
Read Posts Users can read posts in the selected forum, but cannot post messages of their
own.
Delete My Users can delete any message they have posted in the forum. If other users have
Posts replied to the deleted post, those replies also are deleted.
Edit Posts Users can edit any post in the forum, whether created by them or by another
user.
Delete All Users can delete any post in the forum, whether created by them or by another
Posts user. If other users have replied to the deleted post, those replies also are
deleted.
Add Forum Users can add users and/or groups to the list of forum members.
Users
Remove Users can remove users and/or groups from the list of forum members.
Forum
Users
1. Go to Forum page.
a. On the Workspace menu, click a solution.
b. If the discussion forum is enabled, click a sub-solution.
c. Under Discussion Forum, click Communities
d. Select the discussion community with the forum you want to manage.
2. Go to the discussion forum that contains the topics that you want to merge.
3. In the Actions column, click for a topic that you want to merge.
1. Go to Forum page.
a. From the Workspace menu, click a solution.
b. If the discussion forum is enabled, click a sub-solution.
c. Under Discussion Forum, click Communities.
d. Select the discussion community with the forum that you want to manage.
1. Go to Forum page.
a. From the Workspace menu, click a solution.
b. If the discussion forum is enabled, click a sub-solution.
c. Under Discussion Forum, click Communities.
d. Select the discussion community with the forum that you want to manage.
Note: If you are accessing a record-specific discussion forum, go directly to the record where
that discussion form is located and skip to step a of this procedure.
Note: You can restore an archived forum to participant use by clearing the checkbox.
Example: Training and awareness timeline for a campaign delivered over several
weeks
The following table shows an example training and awareness timeline for a campaign delivered
over several weeks.
Date Action Event Description
Planning
1/1 Announce the Archer Send an email to all system administrators that the your
Policy Change Email VPN policy has been changed. Include a copy of the policy
Notification for administrators to review.
1/19 Repeat Pop-Up on Greet system administrators with a reminder to read the
Announcement Archer VPN policy.
Login
2/9 Adminster the Archer Administer the VPN policy quiz to system administrators.
Quiz Quiz Optionally set a minimum passing grade or provide them
with open book guidance. Allow enough days for everyone
to take the quiz.
2/28 Analyze Quiz Archer Review the quiz results and determine the next course of
Results Reporting action.
Evaluation
Campaign A campaign is an organizational structure that groups training and awareness events
with similar subjects or themes.
For example, a campaign called Password Compliance Training could contain the
following:
l A presentation event called Passwords and Security Parameters
l An acceptance event called Password Change Policy
l A quiz event called Password Change Policy Quiz
Event A method for communicating and gathering information through a campaign. The
following events are supported: Acceptance, Presentation, and Quiz and are presented
to users as a prompt when they log in to RSA Archer.
l Acceptance events communicate information and require action from the recipient.
l Presentation events communicate information to users and groups.
l Quiz events test users knowledge of content, for example, a change in policy.
l Presentation Events are used to broadcast information to users or groups via emails or prompts
when a user logs in to RSA Archer.
l Acceptance Events are used to broadcast information to users in the form of a prompt when a
user logs in to RSA Archer.
l Quiz Events are used to test user knowledge of application content, and are presented to users as
a prompt when they log in to RSA Archer.
Quiz behaviors
You can set the quiz behavior for determining:
l The passing grade
l The passing requirements
l The number of times a user can retake the quiz if the user did not pass the quiz
l Whether answers are marked as correct or incorrect
l Whether the quiz is open-book style, allowing users to navigate between the quiz and the content
while taking the quiz
The following rules apply when any of the behaviors are set:
l Users who pass the quiz are allowed to continue to the application.
l Users who fail the quiz may be forced to retake it based on a determined number of retakes.
Users are prompted to retake the quiz up to up to the maximum number of specified retakes. If a
user does not pass the quiz within the specified number of retakes, the user is allowed to continue
to the application.
If the answers are marked for showing the grading, correct answers appear with a green check mark
and incorrect answers appear with a red X.
Add a campaign
1. Go to the Manage Training and Awareness Campaigns page.
4. In the Closing field, enter the text that you want to be displayed at the bottom of the event. Use
the Rich Text Editor toolbar to format the text.
5. Click Apply.
4. In the Closing field, enter the text that you want to be displayed at the bottom of the event. Use
the Rich Text Editor toolbar to format the text.
5. Click Apply.
Quiz behaviors
You can set the quiz behavior for determining:
l The passing grade
l The passing requirements
l The number of times a user can retake the quiz if the user did not pass the quiz
l Whether answers are marked as correct or incorrect
l Whether the quiz is open-book style, allowing users to navigate between the quiz and the content
while taking the quiz
The following rules apply when any of the behaviors are set:
l Users who pass the quiz are allowed to continue to the application.
l Users who fail the quiz may be forced to retake it based on a determined number of retakes.
Users are prompted to retake the quiz up to up to the maximum number of specified retakes. If a
user does not pass the quiz within the specified number of retakes, the user is allowed to continue
to the application.
If the answers are marked for showing the grading, correct answers appear with a green check mark
and incorrect answers appear with a red X.
You can add questions to the quiz either by entering them yourself or importing them from another
quiz.
1. Go to the Questions tab of the quiz event that you want to update.
1. Go to the Questions tab of the quiz event that you want to update.
l To edit a questions, click and make the necessary changes by changing the order in which
they are listed, the answers to the question, and marking the correct answer.
Delete a campaign
.
b. Under Training and Awareness, click Training and Awareness Campaigns.
Delete an event
2. Click the campaign that contains the event you want to delete.
Mail Merge
Mail Merge templates define how records are inserted from RSA Archer into a Microsoft Word
document using the Mail Merge functionality. This functionality is particularly useful for conducting
iterative vendor assessments and SOX compliance reviews.
After creation of a Mail Merge document in Microsoft Word, users can export a record using this
Word document containing Mail Merge fields that display data from your application. The exported
file is formatted according to the layout of the Word document with the exception of attachments.
The attachment is inserted inline on a separate page. All attachments must be a Word (.doc or .docx)
document. All other file types are not supported and are ignored in the exported file.
Note: ".Data" represents the field data of an attachment, which is how the data is retrieved.
Note: You must insert the alias from any RSA Archer field you want to merge into the
corresponding field in the report template in Microsoft Word. If you use the Quick Parts menu on
the Insert ribbon tab to insert a field, populate the Field name box under Field properties with the
alias.
2. Add the completed report template to a Mail Merge template within RSA Archer.
l Attachment l Record
l Cross- Permission
Reference l Record Status
l Date l Related
l External Link Records
l Image l Sub-form
l IP Address l Text
l First l Tracking ID
Published l User/Group
l Last Updated l Values List
l Matrix l Voting
l Numeric
Note: Refer to the Application Field Detail report in Master Report Listing within RSA Archer, and
then filter for Application Field Detail to list the alias for every field within an application.
Note: Replace FieldAlias with the field alias name. For example, the following statement contains
several aliases to fields in another application. Opportunity is the cross-reference alias to related
levels:
Alias A unique name that identifies an object or component, such as fields, applications,
solutions, workspaces, and iViews. Assign aliases to fields when creating the report
template in Word.
Exported The final output produced from a Export template with data merged from an
File application.
Export The Microsoft Word document that is uploaded to the Mail Merge template.
Template
Mail An entity that serves as a report template. The template contains the Word document
Merge template and settings.
Template
Syntax formatting
Press [Alt]+[F9] to display the syntax codes.
The following table lists syntax formatting.
Control Type Field Type Syntax Formatting
IP Address <<IP Address>>
LastUpdated.Date <<Last_Published>>
LastUpdated.UserName <<Last_Published>>
LastUpdated.DisplayName <<Last_Published>>
Numeric <<Numeric>>
Text <<Text>>
Tracking Id <<TrackingID>>
Voting <<Voting>>
Alias syntax
To reference a field that is in the primary level insert the alias of that field into the export template.
Other field types require a merge region. For fields that have multiple options, use the reference as it
applies to your template.
The following table lists alias syntax.
Field Syntax
Date «Drp_Dwn_DateTime»
«Drp_Dwn_Date_Only»
«Txt_Box_DateTime»
«Txt_Box_Date_Only»
IP Address «IPAddress»
«List:IPField»
To use the Mail Merge Template functionality for exporting a record, create a Microsoft Word
document that serves as the export template. The export template defines which fields are merged
and the order in which the fields appear in the exported file.
Word documents and templates for export templates
l .docx (Microsoft Word 2007 or 2010)
l .dotx (Microsoft Word 2007 or 2010)
l .doc (Microsoft Word 2000 or 2003)
l .dot (Microsoft Word 2000 or 2003)
Note: You can only upload Microsoft Word 2010 or 2007, or Word 2003 files (.docx, .dotx, .doc, and
.dot).
2. In the Options section, in the Status field, select the status: Active or Inactive.
3. Click Save or Apply.
l Click Save to save and exit.
l Click Apply to apply the changes and continue working.
2. In the row of the mail merge template that you want to delete, click .
3. Click OK.
Alias Names
Numerous operations in RSA Archer require references to objects—everything from solutions,
applications, and fields to individual values list values—to specify the target for a particular activity.
One example is mail merge, in which you must create templates with unambiguous references to
individual fields in an application. Another example is the process of mapping external data to fields
in the Data Feed Manager. To provide a constant name that is also human readable, all RSA Archer
objects, such as workspaces, applications, fields, and notification templates, support an alias.
An alias is a short name for a unique object in the system that is human readable, but also can be
used in code or as a reference in configuration processes. All aliases must contain only
alphanumeric characters, beginning with a letter and containing no spaces. The maximum length is
40 characters.
An alias must be unique in the entity type. The following are additional points of consideration:
l Field aliases must be unique in the level.
l Values List Value aliases must be unique in a Values List.
l Level, Data Driven Event, Report, and Workflow Stage aliases must be unique in an application.
You can edit the alias for non-system provided entities, but the alias for system-provided entities is
read only.
Important: Applications cannot be named ContentID. Applications with this name are automatically
changed to Content_ID.
CAUTION: Alias is used in configuration processes, system processes, and web service API
integrations. Modifying the alias can cause these functions to fail.
Data Imports
Use the Data Import feature to import records into an application, questionnaire, or sub-form from an
external data file.
When you define a data import from the Administration workspace, you have access to all
applicable applications, questionnaires, or sub-forms. The access role must have Create, Read, and
Update rights for data import.
In addition to granting access rights to data import in Integration, you must also grant the user access
to the application and solution in Access Control so that the user can run the Data Import from the
Navigation Menu.
When a user runs a data import, a job is created and queued in the Job Engine. The job runs
asynchronously from the job queue.
Import considerations
The following table lists data import considerations.
Condition Consideration
Importing When importing data into a leveled application, you must import data of each level
Data Into separately, starting with the top data level. Each level must be imported from a
Leveled separate external data file. You can create these separate source files by exporting
Applications data from the leveled application that contains the data that you want to import. You
must export data one level at a time.
Importing individual columns into specific levels from a single master file creates
duplicate upper-level records and lower-level records which are not associated with
their parent records.
Your level-2 import file must contain:
l All the level-2 field values that you want to import.
l The unique values for a field in level 1 of the application, such as the Tracking
ID field.
Mapping After selecting unique record identifiers in the Data Import Wizard, you must map
Imported fields from your import file to fields in your application or sub-form. To assist you
Data to in this process, the Step 2 - Identification page of the wizard provides a preview of
Application the first 20 rows of data in your import file.
Fields Note the following information before you begin mapping your import data:
l If you are updating existing records or importing sub-form entries, you must map
the field that you selected as a unique identifier to the appropriate field in the
field mapping grid or an error message is displayed.
l Import values for a Cross-Reference field must be key field values for the cross-
referenced application. If the values are not key field values, the importer cannot
link the records.
l The format for Cross-References field values in the import file must be
consistent.
Condition Consideration
Using Excel When using Excel as a .CSV editor, Excel may make unexpected changes when
as a .CSV you save your data file.
Editor Note the following types of information that may change in your files:
l Date Values. Excel converts date values to use its format. You can use this
feature to your advantage if you are pulling values in from disparate sources.
l Points of Precision. Excel manipulates decimal places to use its format.
l Quoted Strings. Excel uses quoted strings if they are necessary, and strips extra
ones if they are not.
l Cell Limitations. A cell in an Excel spreadsheet holds a finite number of
characters. If your .csv file exceeds this limit, saving it in Excel corrupts your
data.
Cross CAST values can be specified If you are adding additional field values rather
Application only during an import update. than updating existing values with your data
Status CAST values are specified in import, this field is not available in the
Tracking the target/child application. Application Fields drop-down list on the second
(CAST) page of the Data Import Wizard.
Because a CAST value is
specific to two different records, Example: Updating implementation status of two
you must include unique
vulnerabilities
identifiers for both the parent
and the child record. The following table shows an example where
you want to update the Implementation Status of
two vulnerabilities on 10 assets. You need 20
rows of data and the asset identifier, vul-
nerability identifier, and status value.
Field Value
Asset Identifier IP Address or Asset
Name
Vulnerability BugTraq ID
Identifier
Cross- Import values must be key-field If you import values that are not key-field values
Reference values for the related for the related application, the data importer
application. cannot link records in the import application to
records in the cross-referenced application.
Matrix Specify the column name and If you import a Matrix value that contains a
corresponding row value for column or row value that does not display in the
each column in the Matrix field. application Matrix field, that column or row is
Separate column names and row added to the Matrix field.
values with a comma.
Example: Import value for a matrix field
Separate column and row pairs
with a semicolon. Maintenance Burden, Low; Portability, Medium;
Power Consumption, High
In this example, the column names are:
l Maintenance Burden
l Portability
l Power Consumption
Numeric Ranged Numeric field: Values outside of the defined range will not
l Values must be within the display when users execute record searches
defined ranges of the field. using numeric-range filters.
User/Groups Users are identified using last_ If there is more than one user or group with the
List name, first_name, middle_name same value (name), the first one (based on the
format. Groups are identified by system ID) is used.
their name. Multiple values are separated with the
secondary delimiter specified on the first page of
the Data Import Wizard.
If you try to import a user or group that is not a
valid selection among the User/Groups List field
values list, an error is reported.
If you import an empty value into the
User/Groups List field, the field is empty in the
new or updated record, even if the field is
configured with one or more default values.
Values List If you import a value into a Values List field that
is not included in the values list of the field, the
value is added to the values list.
If the values list is global, the imported value is
displayed in the global values list for all fields
configured to use it.
l The import file has a consistent format for date and time values. Note the separator that is used
between the date and time values and between the time and the AM/PM designation.
Important: If you are importing data that uses a double-byte character set, such as Japanese, the
alias of each field must be set to a single-byte character set, such as English.
2. Select the Show Item check box next to the menu item you want appear.
3. Click Save.
4. Go to the Rights tab of the Access Roles you want to update.
5. From the Application list, select the application that you just configured to display the Data
Import link in the Navigation Menu.
6. On the application Data Import page, select Read, Create, and Update.
Important: You must also grant access rights to the solution, for example, Policies. The access
role must include Create, Read, and Update rights to the Content Record and Data Import, for
example, Policies: Content Record and Policies: Data Import.
2. Select the application, questionnaire, or sub-form to which you are importing data.
Note: If you make changes to the source file after uploading it to the Data Import Wizard, you
must upload the file again before initiating the data validation and import process.
4. In the Format Options section, select the field, values, and escape delimiters.
l If the field delimiter for your import file is a character other than a comma or a tab, enter the
correct character in the Other field.
l If the values delimiter for your import file is a character other than a semicolon or pipe (|),
enter the correct character in the Other field.
l If the escape delimiter for your import file is a character other thank a backslash, enter the
correct character in the Other field.
5. In the Locale field, select the locale language of the input file.
6. In the Header Row field, do one of the following:
l If the first row of data in your file contains field names instead of actual record data, select
File Contains Header Row.
l If the first row of data in your file contains actual record data, select File Does Not Contain
Header Row.
7. In the HTML Formatting field, indicate whether fields in your data file contain HTML
formatting.
8. In the Advanced Options section, complete the fields for specifying advanced import options,
including how to determine if your data fields contain field value quotes and if you desire to send
a notification for each record created and updated after the import cross has completed.
The following table describes the options.
Question Available Options
Are any field If yes, select the double quotes or single quotes option. If you have none,
values quoted in than select none.
your data file?
Should imported If notifications are enabled for the application into which you are
records be allowed importing data, you can select to send notifications for your imported
to trigger records.
notifications? If you are importing a large number of records, triggering a notification
email for each record may produce a heavy load on the email accounts of
users who are subscribed to a notification template for the application.
How should If you select to replace existing cross-reference values, the existing data
existing references in the application is replaced with the data from the import file. Data
be handled? existing prior to the import process is removed.
If you select to append cross-referenced data, the system leaves all
existing values in the record intact and adds new cross-reference values
from the data file to the records.
9. Click Next.
identifier that you specify), those unmatched records are added as new records in your
application.
3. If you are updating existing records with your data import, under Import Field Mapping, do the
following:
a. In Application Field(s), click the drop-down menu.
b. Select one or more fields whose values serve as the unique record identifier.
This allows the Data Import Wizard to match records in your external data file with records
in the application, questionnaire, or sub-form.
Note: Some Data Imports will have required Application Field(s). In these instances, when
attempting to click Next a text box appears with information on which Application Field(s)
still need to be selected.
Note: You cannot map to Related Records fields if the key field type in the other application is
Application ID. Changing the key field type to System Tracking ID allows the mapping of Related
Records fields in the application into which you are importing data.
3. Click Import.
Important: Do not close this window or log off from the system during this stage of the import
process. Doing so causes adverse results.
4. (Optional) If additional errors are found, go back and correct them as necessary and click import
again.
5. When the import is completed successfully, click Continue.
3. Click to display the Run Detail dialog box for that data import.
All unique If you are importing new sub-form records, you Verify that the unique
identifiers must map the fields that you selected to serve as identifiers are correctly
must be the application unique identifier to the mapped.
mapped for corresponding fields in the field mapping grid.
insert
All unique If you are updating existing master or sub-form Verify that the unique identifier
identifiers records, you must map the field that you selected is accurately mapped.
must be to serve as the application's unique identifier to
mapped for the corresponding field in the field mapping grid.
update.
Column Your external data file contains a value that does Change the value in your data
mismatch not match the data type of the field to which the file to match the data type
value is mapped. required by the field to which
you are mapping the value.
Could not Occurs if your external data file contains a group Do one of the following:
locate group value that is not a group value established in the l Change the group value in
name system. your data file so that it
matches a group in the
system
l Add the group from your data
file to the system from the
Manage Groups page in the
Access Control feature.
Date does Your external data file contains a date that does Reformat the date value so that
not match not match the date format that you have specified it matches the format that you
expected for the import. selected in the Data Import
format Wizard.
Field is Your external data file is missing one or more Enter the required values in
required values for a required field. your import file or change the
field in your application so it is
no longer a required field.
Field Your external data file is missing a value for a Enter the required value in your
requires a Values List field that requires a selected value. data file or change the field in
selected your application so that it no
value longer requires a certain
number of value selections.
Imported Occurs if you are importing sub-form data, and Select a unique field value from
subform the field from the parent record that you selected the parent record to serve as the
record as the unique identifier contains non-unique data. application unique record
cannot have identifier.
multiple
parents
Invalid IP Your external data file contains a value for an IP Reformat the value.
Address Address field that is not correctly formatted.
Invalid key Occurs if you are updating records with a Cross- Ensure that the identifiers are
(s) for cross Application Status Tracking (CAST) field and do valid and unique.
application not specify valid, unique identifiers for the
status field parent-application and child-application records
for associated with the CAST field.
application
Invalid Your external data file contains a value for a Reformat the value correctly.
matrix Matrix field that is not formatted correctly.
format
Invalid Occurs if you are importing a value into a Change the value in your
number Numeric field that contains alphabetic external data file so it contains
characters. only numeric characters.
Invalid Occurs if you are doing an import update, and the Change the value in your data
tracking ID Tracking ID field in your external data file file so that it is a valid, unique
contains a value that is not a valid tracking ID for tracking ID for the import
the application into which you are importing. The application.
tracking ID value may not exist in the system, or
it may be a valid tracking ID for another
application.
Multiple Occurs if more than one field from your data Ensure that your application
columns are import file is mapped to the same application fields are mapped to different
mapped to field. If you are performing a sub-form data fields and that the import data
the same import, a field from your data import file may be fields are mapped to the sub-
field mapped to the same field as the parent record. form fields.
Number is Occurs if you are importing a value into a Examine the Numeric field in
larger than Numeric field that is above the maximum value your application to determine
maximum allowed for the field. the maximum value it allows
value and change the value in your
data file to fall at or below that
maximum value.
Number is Occurs if you are importing a value into a Examine the Numeric field in
smaller than Numeric field that is below the minimum value your application to determine
minimum allowed for the field. the minimum value it allows
value and change the value in your
data file to fall at or above that
minimum value.
Unsupported Occurs if you are importing new records and Select Do Not Import from the
import type attempt to import data into a Tracking ID field. list for the Tracking ID field in
the field mapping grid.
Unsupported Occurs if you are updating records with your data Select a field type for the key
link type import and you select a field type for the key field that can serve as the key
field that cannot serve as the key field for a field for a record.
record. Examples of field types that cannot serve
as the key field for a record include:
l First Published Date
l Last Updated Date
l Record Status
l Related Records
Data Feeds
Data Feed Manager is a flexible, code-free tool for aggregating data in RSA Archer. Use the tool to:
l Configure multiple, dynamic data feeds, and manage those feeds without relying on programming
resources.
l Build and configure dynamic integrations with external enterprise systems and files. From Data
Feed Manager, you can build a transport path between RSA Archer and an external source and
then map the data from that source to an existing target application or questionnaire in RSA
Archer.
l Configure the data feed to run on a schedule. After the initial configuration, the data feed
executes automatically with no need for you to intervene.
Because RSA Archer is vendor neutral and content independent, you can use RSA Archer as a point
of consolidation for enterprise data of any type for supporting analysis and process management.
With a centralized view of data from point solutions, databases, spreadsheets, and other sources, you
can access content more easily that is relevant to your job functions. Re-purpose data to support a
variety of business processes.
A data feed must be both active and valid to run. As you configure your data feed, Data Feed
Manager validates the information for you. If it is not valid, an error message appears. You can save
the data feed and correct the errors later. However, the data feed does not process until you have
corrected the errors and the data feed validates.
Important: To avoid potential conflicts with other data feeds, RSA suggests that you use a different
user account for each data feed. Additionally, if you plan to run multiple data feeds simultaneously,
create a unique name to prevent termination of session tokens.
Standard Brings data from an external source into an application or questionnaire. This data feed
type requires that you:
l Define the fields and data format
l Map the fields in the source file to the target
l Perform a report-based search for an application or questionnaire that contains the
source data that you want to import into another application or questionnaire.
l Set up a user account as a Service account, which means this user account has all
necessary permissions to execute the data feed.
Transport Locates a separate data file that contains additional instructions for launching
Only subsequent, standard data feeds.
l Ensure that a user account for the data feed and a target path for the separate data
file exist, but no additional data configuration.
l Create a unique name when running multiple data feeds simultaneously to prevent
termination of session tokens.
Archer Web Accesses the Web Services API and retrieves data from an instance of RSA
Services Archer. This transporter is used in Archer-to Archer data feeds.
Transporter Description
DeepSight Uses the v2 Symantec web service to retrieve vulnerabilities threat feed data.
2.0 This transporter will soon become unusable because of deprecation by Symantec.
For DeepSight v4 data feeds that are available on the RSA Archer Community on
RSA Link, use the DeepSight 4.0 transporter.
DeepSight Uses the v4 Symantec web service to retrieve security risk and vulnerability
4.0 SCAP data feeds.
File Retrieves delimited data files, including support for multi-file manifests.
HTTP Executes a GET or POST to retrieve data from an HTTP or HTTPS site.
JavaScript Executes a user-provided JavaScript file. If the result of that execution is a data
set, it is transformed and processed into the platform as normal.
l Record Permissions
l Related Records
l Sub-Form
l Text
l User/Groups List
l Values List
Schema sources
The source for the schema of your data feed depends on which transporter you are using. The
following table identifies and describes the schema sources that are available for each of the out-of-
the-box transporters.
Important: The process of loading a source definition for a data feed times out at five minutes. You
may want to consider using a smaller set of source data when you set up the feed.
Source Description
Execute Executes the search in RSA Archer and detects the source schema from the results.
Search Recommended approach for an Archer-to-Archer data feed. Loads the source fields
directly from the report. When using this scheme, complete all required information on
the Transport and Navigation tabs.
Source Description
Execute Executes the query specified on the Transport tab and detects the source schema from
Query the resulting record set.
Using this option may trigger actions in the database associated with this query.
Sample Uses a skeleton of your actual source data file. For example, if you are importing data
File from a .csv file, the source data file is a .csv file that includes the column names from
your source data. If you are importing data from an .XML file, the source data file
includes the structure of your .XML without the actual field values.
When you select the sample file, the Source Fields section populates with the fields
specified in the sample data file.
For the Archer Web Services Transporter, select a file from an external location that
contains the data in a same format as the report format.
Load Loads the contents at the target URL and detects the source schema from the contents.
URL Using this option may trigger actions associated with accessing the target URL.
Unique identifiers
A unique identifier is a field, or a combination of fields, whose values in individual records are
different from all other records, thereby uniquely identifying the record. A compound unique
identifier means that all fields in the key must match the fields in the target application in order for a
match to occur.
By establishing a unique identifier, you instruct the Data Feed Manager on how to update existing
data in the application or questionnaire from the matching source data. After setting the order of the
key fields, the Data Feed Manager scans the data source for matches to each unique key in the
specified order. If any key is found to match the field in the target application than the record is
considered matched. If no match is found, the Data Feed Manager creates a new target application
or questionnaire record.
For example, you can select an IP Address field in a record to be your unique identifier. If a data
source record has a matching value for the target application field, the source record data updates
the target application record data. If no match is found, the data feed creates a new application
record.
Note: Matching logic includes text formatting when matching the key fields in the data feed source
to a record in the RSA Archer database. When a data feed has two records with the same text, but
with different formatting tags, the records are distinguished as separate records.
Fields that act as unique identifiers for your data feed do not have to be the same as the key fields
for your target applications or questionnaires.
The following table lists the field types from a target applic-
ation or questionnaire that can be selected as unique iden-
tifiers.
Text-Based Field Types List-Based Field Types
Note: You can only use the Tracking ID field as a key field if it is configured as System ID. If
configured as Application ID, it is not available for use as a key field.
When selecting cross-reference or related records fields as unique identifiers, you must select a
field from the related application matching one of the above field types. For example, if you select
the Vulnerabilities cross-reference field, which cross-references the Vulnerabilities application, in
an Assets application, you also select a qualifying field from the Vulnerabilities application to serve
as a unique identifier.
MatchExact Specifies that data source field must match the unique identifier value exactly for
the target record to be updated. If the match is not exact, a new record is created.
For example, if a data source field has a value of "Renee Jones" and a mapped
application field that is specified as a unique identifier has a value of "Renee Ellen
Jones," the target application record is not updated because it is not an exact match.
MatchAny Specifies that the source data must match at least one condition in the list-based
field for the target record to be updated.
For example, if a target application record has the values Blue and Green selected
in the field specified as the unique identifier, and the mapped field in the source data
includes only the value Blue, the record is updated because at least one of the
values matches.
MatchAll Specifies that the source data must match all of the conditions in the list-based field
for the target record to be updated.
For example, if the target application record has the values Blue and Green selected
in the field specified as the unique identifier, and the mapped field in the source data
includes the values Blue and Green, the record is updated. However, if the source
data includes only the value Blue, the record is not updated. A new target
application record is created instead because there is not a complete match.
Note: Relative path entry is set up as the default starting with RSA Archer 6.0. Because the setting
is not updated automatically on systems upgraded to version 6.0, RSA recommends manually setting
the requirement on upgraded systems.
1. Go to the Schedule tab of the data feed that already been run.
Statistics
Element Description
Messages
Date Indicates the date and time when the error occurred.
Location Displays the name of the source file processed and the
position of the character in question. For example, (3,
17) indicates the 3rd row, numbered this time starting
from the header row, and the 17th character in the row.
2. Locate the data feed for which you want to view the Execution History.
All tokens are case-sensitive and must be entered as indicated so that the token is recognized by the
data feed. Tokens are identified by including curly braces around the token, for example,
{TokenName}.
Example: File Information token
{DataFileDirectoryName}\success\{DataFileName}_{Now(yyyyMMddhhmmss)}.
{DataFileExtension}
In this example the File Information token:
l Renames a file by including the current date and time to the file.
l Moves the file to a subfolder of the folder where the file is currently located (the subfolders name
is “success”).
System tokens
The following table describes the system tokens.
Token Value Description
DataFileName Text Returns the name of the data file without the extension.
DataFileFullName Text Returns the information from the previous three tokens
combined. This token is the simplified version of
{DataFileDirectoryName}\{DataFileName}.
{DataFileExtension}
Now Current Returns the current system time. Formatting can be applied
Date/Time if desired. The default formatting is MM.dd.yyyy.
Example: Time token
On August 25, 2015 at 8:15:45PM, the token {Now}
(yyyyMMdd_hhmmss) returns the value 20150825_081445.
Format
Description Examples
Specifier
H The hour, using a 24-hour 6/15/2009
clock from 0 to 23. 1:45:30 AM -> 1
6/15/2009
1:45:30 PM ->
13
Format
Description Examples
Specifier
ss The second, from 00 6/15/2009
through 59. 1:45:09 PM ->
09
General tokens
General tokens modify the default behavior of data feeds.
The following table describes the general tokens.
Token Value Description
CrossReferencesMode LinkOnly When this token is set, the data feed process
does not update content in any cross-reference
fields. The data feed updates the link between
the two applications.
Using this token can improve the performance
of the data feed.
RelatedReferencesMode LinkOnly When this token is set, the data feed process
does not update content in any related-record
fields. The data feed updates the link between
the two applications.
Using this token can improve the performance
of the data feed.
MergeFiles Boolean When this token is set to true, XML files are
merged together before running the transform.
This token executes the transformation against
the entire source data set.
Example: The transform is written to eliminate
duplicates. By merging all XML files before
running the transform, all duplicates are
eliminated from the entire data set.
ConnectionTimeout Integer The number of seconds the transporter will wait for the other site
to respond to the request.
TransmissionTimeout Integer The number of seconds the transporter will wait for all the
information to be transmitted.
These tokens change the timeout limits for the following transporters:
l Archer Web Service Transporter
l HTTP Transporter
l FTP Transporter
l RSS Transporter
l iDefense Transporter
l Database Query Transporter
Note: The Database Query Transporter only supports the TransmissionTimeout. Specify the
connection timeout in the connection string.
password to be stored in plain text, use the {password} token to encrypt the password. You can also
encrypt the username by using the {username} token. Although, it is not as critical as encrypting the
password because the username is not hidden when it is entered and is stored in the database as
plain text.
The following table describes the connection string tokens.
Token Description
Example:
ChunkLimit Numeric iDefense only. The longer it takes to run a threat feed the
more risk there is of the data feed failing. When a job
fails, all alerts will be downloaded again.
To ensure a job completes in a reasonable time period, an
iDefense feed only processes 1000 alerts per job
execution. If more than 1000 alerts need to be processed,
the next set is picked up on the next data feed run. Use
this token to change the number of alerts that are
processed for each job execution.
RSA Archer recommends scheduling threat data feeds to
run several times a day. This schedule will help keep the
execution time of each job to a reasonable time period.
Data tokens
Data tokens capture data from the last execution of a data feed. To specify that a field value is
saved, select the Token column of that field in the Source Data tab.
When the Token checkbox is selected for Device_Name, the Device_Name appears in the list of
tokens. After each run, the value from the last record is set in the Value field.
You can use this token in several settings throughout the data feed configuration.
The following table lists the fields for the available tokens.
Field Input
Field Input
Example 1
This example describes how to configure a data feed to process only users who have been added
since the last time the data feed ran using the Database Query Transporter.
The query looks like this:
SELECT UserId, UserName FROM UserTable WHERE UserId > {UserId} ORDER BY UserId
After the source fields are loaded, the Token checkbox is selected for the UserId field. After each
data feed execution, the last UserId from the source is stored in the token. The next execution of the
data feed includes only the UserIds that are after the stored token value. Notice that the query also
orders by UserId to ensure the last sequenced UserId value is the value stored in the token.
Example 2
This example shows how to configure a data feed to process records only from the source that were
modified since the last time the data feed ran using the Database Query Transporter.
The query looks like this:
SELECT Value1, Value2, etc FROM someTable WHERE LastUpdatedDate > {LastRunTime}
The {LastRunTime} token is a built-in token that exists in every data feed so there is no need to
define a custom data token.
Formula tokens
You can use formulas as tokens by placing an equals sign (=) in front of the first formula, after the
token symbol. The token starts with {=.
Nested token symbols are invalid. If you want to include tokens in a formula, use the GETTOKEN
function.
Example
This example shows how to configure a data feed to process records only from the sources that were
modified within the same year in which the last the date feed ran using the Database Query
Transporter.
Supported functions
CONCATENATE Combines the values of two fields into a single value. For example, it
([TOLastName], ", ", would take the value “Doe” from the Last Name field and the value
[TOFirstName]) “John” from the First Name field and merge them into the value “Doe,
John.”
Calculation Description
If(LEN([Production Executes a logical operation to determine which field to use as the source
IP])>0,[Production value. If the Production IP field is not blank, the value from this field is
IP],If(LEN used. If the Production IP field is blank and the Maintenance IP field has
([Maintenance IP])>0, a value, the value from the Maintenance IP is used. If both fields are
[Maintenance IP], blank, the Backup IP value is used.
[Backup IP]))
Note: This option is available for all Archer-to-Archer standard data feeds and for other standard
data feed transport methods in which you have specified the XML File Iterator as the navigation
method.
1. Go to the Source Data tab of the data feed that you want to modify.
l In the Actions column of an existing source field, click to add a child to that source field.
If there are existing children for the source field, click the plus (+) symbol next to the source
field name to display the children.
1. Go to the Source Data tab of the data feed that you want to modify.
2. From the Field Type list of the source field that you want to translate, click Lookup Translation.
Lookup translation
Translation reconciles values from your source data to values that are acceptable in the RSA
Archer target application or questionnaire. Using an application as an intermediary ensures that
the data feed converts all of the external data into the proper format before importing it to the
destination application.
You can use Lookup Translation to translate a value from the source file into another value. You
would map a column in the source file to a field in an application, and map a field in the target
application to another field in the same application. Lookup Translation looks up the value of the
source file in the application and, when found, stores the value (from the same record) that is
mapped to the target application.
You may have a field in your external file with values of New York and California. However,
the application into which you are importing the data only accepts state abbreviations. Using the
Lookup Translation option, you can use a separate application to map your external values to the
proper internal values, as shown in the following table.
Destination
Source Data Translation Application
Application
Field Name: Field Name: State Field Name: State Field Name: State
State ID1 ID2
California California CA CA
Texas Texas TX TX
Florida Florida FL FL
6. In the Exceptions list, select the function that the Data Feed Manager executes when a value
generates an exception.
Log Writes an error to the log file, and the value is not imported. No updates are
Warning made to the translation application.
Insert Raw Inserts the raw value from your source file in the target application if a match is
Data not found.
Original Identifies the field in the translation application that maps to the value from your
Value external data file.
Translation Identifies the field in the translation application that maps to the proper value in
Value the target application or questionnaire.
7. Click OK.
8. Click Apply.
Note: You cannot reference fields in a calculation that are nested in different parent fields.
1. Go to Source Data tab of the data feed that you want to modify.
2. From the Field Type list of the source field to which you want to apply a calculation, select
Calculated Field.
4. In the Actions column of that source field, click and enter the static text.
5. (Optional) Click Validate Syntax. If necessary, correct the formula before continuing.
Note: By default, the data feed process terminates when it encounters an error. However, if you
want to continue processing the data feed even if errors exist, select the Data Validation option on
the General tab of the data feed configuration before starting the feed.
All unique If your data feed contains new sub-form records, you Verify that the unique
identifiers must map the fields that you selected to serve as the identifiers are correctly
must be application unique identifier to the corresponding fields mapped.
mapped for in the field mapping grid.
insert
All unique If you are updating existing master or sub-form records, Verify that the unique
identifiers you must map the field that you selected to serve as the identifier is accurately
must be application's unique identifier to the corresponding field mapped.
mapped for in the field mapping grid.
update.
Column Your external data file contains a value that does not Change the value in your
mismatch match the data type of the field to which the value is data file to match the
mapped. data type required by the
field to which you are
mapping the value.
Could not Occurs if your external data file contains a group value Do one of the following:
locate group that is not a group value established in the system. l Change the group
name value in your data file
so that it matches a
group in the system
l Add the group from
your data file to the
system from the
Manage Groups page
in the Access Control
feature.
Date does Your external data file contains a date that does not Reformat the date value
not match match the date format that you have specified for the so that it matches the
expected import. format that you selected
format in the Data Import
Wizard.
Field is Your external data file is missing one or more values Enter the required values
required for a required field. in your import file or
change the field in your
application so it is no
longer a required field.
Field Your external data file is missing a value for a Values Enter the required value
requires a List field that requires a selected value. in your data file or
selected change the field in your
value application so that it no
longer requires a certain
number of value
selections.
Imported Occurs if you are importing sub-form data, and the field Select a unique field
subform from the parent record that you selected as the unique value from the parent
record identifier contains non-unique data. record to serve as the
cannot have application unique record
multiple identifier.
parents
Invalid IP Your external data file contains a value for an IP Reformat the value.
Address Address field that is not correctly formatted.
Invalid key Occurs if you are updating records with a Cross- Ensure that the identifiers
(s) for cross Application Status Tracking (CAST) field and do not are valid and unique.
application specify valid, unique identifiers for the parent-
status field application and child-application records associated
for with the CAST field.
application
Invalid Your external data file contains a value for a Matrix Reformat the value
matrix field that is not formatted correctly. correctly.
format
Invalid Occurs if you are importing a value into a Numeric Change the value in your
number field that contains alphabetic characters. external data file so it
contains only numeric
characters.
Invalid Occurs if you are doing an import update, and the Change the value in your
tracking ID Tracking ID field in your external data file contains a data file so that it is a
value that is not a valid tracking ID for the application valid, unique tracking ID
into which you are importing. The tracking ID value for the import
may not exist in the system, or it may be a valid application.
tracking ID for another application.
Multiple Occurs if more than one field from your data import file Ensure that your
columns are is mapped to the same application field. If you are application fields are
mapped to performing a sub-form data import, a field from your mapped to different fields
the same data import file may be mapped to the same field as the and that the import data
field parent record. fields are mapped to the
sub-form fields.
Number is Occurs if you are importing a value into a Numeric Examine the Numeric
larger than field that is above the maximum value allowed for the field in your application
maximum field. to determine the
value maximum value it allows
and change the value in
your data file to fall at or
below that maximum
value.
Number is Occurs if you are importing a value into a Numeric Examine the Numeric
smaller than field that is below the minimum value allowed for the field in your application
minimum field. to determine the
value minimum value it allows
and change the value in
your data file to fall at or
above that minimum
value.
Unsupported Occurs if you are importing new records and attempt to Select Do Not Import
import type import data into a Tracking ID field. from the list for the
Tracking ID field in the
field mapping grid.
Unsupported Occurs if you are updating records with your data Select a field type for the
link type import and you select a field type for the key field that key field that can serve
cannot serve as the key field for a record. Examples of as the key field for a
field types that cannot serve as the key field for a record.
record include:
l First Published Date
l Last Updated Date
l Record Status
l Related Records
The job Possible causes include a job that was ended by the In the JavaScript
process system administrator or by the job engine (due to being Transporter Settings
(####) unresponsive). Check the job log files for possible section of the
ended information about any errors. RSA Archer Control
abruptly for This error produces a log similar to the following: Panel, allocate additional
unknown memory in the Max
reasons in <JobType>ArcherTech.DataFeed.Workflows. Memory Limit field.
HH:MM:SS. WF4.MultistepProcessing.DataFeedScriptExecutionJob,
ArcherTech.DataFeed,
Version=Maj.Min.NNNNN.BBBB, Culture=neutral,
PublicKeyToken=null</JobType>
This error can be caused by the job exceeding the
allocated memory limit provided.
Important: Do not run the Archer-to-Archer data feed using the same account with which you have
logged in to RSA Archer. Using the same credentials logs you out of your session. In addition, do not
run multiple data feeds using the same account credentials. Each Archer-to-Archer data feed must
have its own separate and unique account for logging in and retrieving data.
l If IIS is configured for Anonymous authentication, use the Anonymous/Service Account User
option. When IIS is set to Anonymous authentication, the user account credentials are not sent
with the data feed request.
l If IIS is configured for Windows Integrated authentication, use either Anonymous/Service
Account User or Specific.
o If credentials are set to Anonymous/Service Account User, the service account running the
asynchronous job is sent with the data feed request.
o If credentials are set to Specific, the specified Windows account credentials are sent with the
data feed request.
You must also define the transport configuration for this transporter. The Web API uses the search
types described in the following table for processing data of a data feed.
Search
Description
Type
Report ID Retrieves data using the search report GUID or ID, which is provided in the search
results for the report.
Search Retrieves data using the module ID and a configuration string. This information is
XML obtained by running an XML search using an API call.
Statistic Retrieves data using the search statistical report GUID or ID, which is provided in
Report ID the search results for the statistical report.
Additionally, a data feed can access the source data through a proxy server and can handle post-
processing of the local copy of the source data.
For more information, see "Data Feeds" in the RSA Archer Online Documentation.
.
b. Under Integration, click Data Feeds.
Note: If you are completing a large data import, you may need to increase the Session Timeout
for the Archer Services Security Parameter from 30 minutes to 6 hours. Adjustments for the
Archer Services Security Parameter must be made in the instance database by running an SQL
command.
Send Select whether to have the data feed trigger notification emails when records
Notifications are published or updated. If notifications are not enabled in the selected target
application, no notification emails are sent when the data feed runs.
Send Job Select whether to have job status notifications sent to selected users or groups.
Status You can also select email addresses to receive job status notifications. If
Notifications selected, job status notifications are sent showing whether a job succeeded or
failed to run.
9. (Optional) In the Additional Properties section, specify a different locale for your source data,
whether to override the rules of saving a record defined in the application, and whether to delay
Locale Specifies the country (language) format of your source data. Different cultures
or countries use different characters when formatting similar data.
Data Determines whether RSA Archer performs data validations against the selected
Validation target application when saving a record. Selecting this option bypasses
validation that is based on field definition and configuration (with some
exceptions). This option applies regardless of whether you are targeting a
questionnaire or application.
RSA Archer validates the following items regardless of whether this field is
selected:
l Attachment or image field - Validity of the file.
l Date/Time field - Minimum and maximum system values.
l Text field - Contains valid HTML.
l Field name - Uniqueness.
The required field settings are disregarded if you select to ignore the rules
defined within the target application. However, the unique selection cannot be
ignored.
Optimize Delays running calculations until the data feed completes and condenses
Calculations calculations for optimal processing. If this option is enabled, the optimized
calculation jobs run after the data feed completes. This improves the
performance of data feed processing and calculations.
Note: Condense jobs that are in the queue during an upgrade cause the jobs to
fail after the upgrade. Verify that there are no Condense jobs in the queue
before upgrading.
Note: If you want to use a data feed that was created in RSA Archer 4.x, you must run an
XML Record Search, and select Search XML as the Search Type. For information on the XML
Search feature, see the Running an XML Record Search for an Archer-to-Archer Data Feed
topic in the RSA Archer GRC Online Documentation.
Note: Use the account that has access role rights to the search.asmx page. The account
should also be an application owner with full access permissions to the content of the
applications. Do not use the same account that you used to log on.
7. (Optional) In the Domain field, enter the name of the domain to be searched against.
8. In the Instance field, enter the instance name for the instance to be searched against. Use the
instance name and not the PIN.
9. (Optional) In the Proxy section, enter the credentials of the proxy server if the data feed
accesses the source data through a proxy server.
The following table describes the options.
Option Description
No Proxy Indicates that the data feed does not pass through a proxy.
Use System Indicates that the Data Feed Service runs the feed with the proxy configuration
Proxy that is set up in the Control Panel.
Option Description
Configure Indicates that the data feed must pass through a proxy. Continue with providing
Proxy the parameters for accessing the proxy.
10. (Optional) In the Post-Processing - Local Copy section, define the post-processing rules if the
data feed handles post-processing of the local copy of the source data.
To perform post-processing on the source file retrieved, in the Post-Processing - Local Copy
section, determine how the data feed should handle the local copy of the source data when the
integration is complete. In the On Success field, select from the following options.
The following table describes the options.
Option Description
Nothing Does not alter the source file when the data feed successfully completes. If there is
a local copy of the source information, the local copy is deleted.
Option Description
Rename Saves the source file under a new name when the data feed successfully completes.
In Destination File, specify where the file should be saved and the new name for the
file.
To save the data, the path of the destination file must be accessible to the account
running the Job Engine service.
If you select this option, use filename tokens for specifying the location or name of
the file.
Filename tokens
Filename tokens are available for post processing when you want to save the source
information and specify a location or name for the file. When you select the Rename
option, you can use tokens to generate unique names automatically for the files.
Here are the usable tokens for renaming data files.
l Now. Insert a user-defined date format within the new filename. Possible formats
include Now(MM/dd/yyyy) or Now(MMM-dd-yyyy). See the Microsoft .Net
Framework Developer Center for available custom date/time formats.
l DataFileDirectoryName. Update the filename with the directory name, including
the drive, of your file.
l DataFileName. Insert the original filename, excluding the directory name and
extension.
l DataFileExtension. Insert the file extension, such as .csv, in the new filename.
l DataFileFullName. Insert the fully qualified filename. This data includes the
drive, directory, filename, and extension of the original file.
For example, if the data file came from the following location,
C:\DataFeed\Source\ESL\processed\ThreatData.csv, files that have been renamed
using tokens would have the following output.
Example 1
l Input Tokens: {DataFileDirectoryName}\success\{DataFileName}_{Now
(MM.dd.yyyy)}.{DataFileExtension}
l Output: C:\DataFeed\Source\ESL\processed\success\ThreatData_01.31.2008.csv
Example 2
Option Description
Note: A default Transform is included with the installation. If you require additional data
transformation, you can develop your own XSLT. For more information on XML formatting
guidelines and samples, see the appendix "XML Formatting Used in Field Results and Input"
in the RSA Archer Web Services API Reference Guide that you can download from the
RSA Archer Community.
6. Click OK.
7. Click Apply.
Data options
l Import the data “as is” into RSA Archer or execute modifications and calculations against the
data to convert the incoming data into a format that matches the requirements of the application or
questionnaire it is imported into. Use several advanced options, such as lookup translations and
calculations, to prepare and modify the data to meet your individual business needs.
l Filter data so that only what you want to receive is imported into the target application or
questionnaire. By not defining filters on the Data Filter tab, you instruct Data Feed Manager to
return all records in the data feed. Use operator logic to add filters to include only records
meeting certain criteria in the data feed process.
l Capture tokens of data from the last execution of a data feed that can be used during the next run
to identify which data to retrieve. On the Tokens tab, you can add, edit, or delete token values in
preparation of the next data feed execution.
1. Go to the Source Data tab of the data feed that you want to modify.
Important: The process of loading a source definition for a data feed times out at five minutes.
You may want to consider using a smaller set of source data when you set up the feed.
Source Description
Execute Executes the search in RSA Archer and detects the source schema from the results.
Search Recommended approach for an Archer-to-Archer data feed. Loads the source fields
directly from the report. When using this scheme, complete all required information
on the Transport and Navigation tabs.
Sample Uses a skeleton of your actual source data file. For example, if you are importing
File data from a .csv file, the source data file is a .csv file that includes the column
names from your source data. If you are importing data from an .XML file, the
source data file includes the structure of your .XML without the actual field values.
When you select the sample file, the Source Fields section populates with the fields
specified in the sample data file.
For the Archer Web Services Transporter, select a file from an external location
that contains the data in a same format as the report format.
4. In the first line in the Source Fields section, select the appropriate field option for the record
definition.
Note: For more information about configuring source fields in standard data feeds, see
Manipulating Data in the Source File of Standard Data Feeds.
5. In the Field type list for the remaining source fields, select the application option.
6. Click Apply.
1. Go to the Tokens tab of the data feed that you want to modify.
1. Go to the Field Map tab of the data feed that you want to modify.
2. Map the source field to the applicable application or questionnaire. Do one of the following:
l Click Auto-Populate to map the source fields to application or questionnaire fields. This option
maps fields from the data source to application or questionnaire fields that have the same
name. Auto-populate occurs on level 1 fields only. Additionally, if there is an exact name
match between the source field and the target field, and the field type is one of the following,
the field is not auto-populated: External links, Values list, Sub-form, Related records, Cross
reference, or CAST.
l Drag each source field and drop it next to the application or questionnaire field in the Target
Fields section. For target fields that have a field type of cross-reference, sub-form, or related
records, map the fields expanded under these field types. You cannot directly map to a target
field with any of these field types.
Note: You can drag the left or right border to resize the Source Field column so that it can
display long source field names.
Note: You can enter a value from zero to 99, with zero being the highest trust level, and 99 the
lowest. A data feed cannot overwrite a previous feed that has a higher trust level. For example, a
data feed with a trust level of 75 cannot overwrite a data feed with a trust level of 20. By
default, this option is not available until Manual Trust is activated.
Note: For some out-of-the-box applications, you may see the following message if you try to
configure key fields for a data feed:
2. In the Reference Field section, select the field that requires a key field definition.
Note: The Reference Field section contains the target application or questionnaire and any
mapped cross-reference, related records, CAST, or sub-form fields that require the creation of a
key field definition.
3. In the Key Field Definitions title bar, click Add New Key.
Note: You can use the Key Field Definitions section to define the unique key identifiers and the
data feed actions during the feed execution.
4. In the Field Name field, select a target application or questionnaire field that uniquely identifies
the record.
5. (Optional) Assign compound unique identifiers for the record. Do the following:
l Click in the Actions column to add unique identifiers in a hierarchical structure for sub-
form field types.
Note: After setting the order of key fields, the Data Feed Manager scans the data source file
for matches to each unique identifier in the specified order. When any key field is found as a
match to a field in the target application, the record is considered matched.
7. From the Action list, select the applicable option for the matching criteria for the unique
identifier.
8. Click Apply.
1. Go to the Update/Archive tab of the data feed that you want to modify.
2. In the Update Options section, select whether to create or update records in the target
application.
The following table describes the options.
Option Description
Create Create new records for data found in the source file and not in the target application
or questionnaire.
Update Updates records in the target application or questionnaire when a unique identifier
match exists in the source file. If you are also selecting the Archive Option of
Delete and want to retain existing records, make sure to select the Update option.
3. In the Archive Options section, select what happens when the matching record is not found in the
target application.
The following table describes the options.
Option Description
Delete Deletes records in the target application or questionnaire when a matching record is
not in the source data. If you want to retain existing records, also select the Update
option.
Records are matched by a unique identifier only during the update process. If you
want to retain existing records while archiving the target application, also select
Update in Update Options. If you do not select the Update option, all records in the
target application will be permanently deleted.
Option Description
Set Sets a value in a Values List field in a record whenever the external data file does
Value not contain a matching record.
Use this option to set a Values List to a value that identifies this record as Inactive
or Not Current. For example, a Devices application with a record for a specific
laptop and the external data file does not have a matching record for that laptop. You
can use this option to set a Values List field in the laptop record to the value
Inactive.
When you select this option, you also select the Values List field in the target
application or questionnaire and the value that you want to set in that field.
You cannot set the value in the Values List field of the target leveled application
under the following conditions:
l Level 3 or lower in a leveled application.
l You are modifying the data feed configuration.
In most scenarios, RSA recommends selecting the Set Value option and flagging
these records with a specific value rather than deleting them. For example, you can
add a field to your application called Status and include the values Current and
Archived. If a data feed cannot find a matching record in the data source with a
system record, the system record could be updated to have a value of Archived for
the Status field.
4. Click Apply.
Important: When you configure an iDefense or DeepSight threat data feed, you need to set specific
parameters to connect the threat feed properly with your RSA Archer instance.
1. Go to the Schedule tab of the data feed that you want to modify.
2. Go to the Recurrences section and complete frequency, start and stop times, and time zone.
The following table describes the fields in the Recurrences section.
Field Description
Frequency Specifies the interval in which the data feed runs, for example, Minutely, Hourly,
Daily, Weekly, Monthly, or Reference.
l Minutely. Runs the data feed by the interval set.
For example, if you specify 45 in the Every list, the data feed executes every
45 minutes.
l Hourly. Runs the data feed by the interval set, for example, every hour (1),
every other hour (2) and so forth.
l Daily. Runs the data feed by the interval set, for example, every day (1), every
other day (2) and, so forth.
l Weekly. Runs the data feed based on a specified day of the week, for example,
every Monday of the first week (1), every other Monday (2), and so forth.
l Monthly. Runs the data feed based on a specified week of the month, for
example, 1st, 2nd, 3rd, 4th, or Last.
l Reference. Runs a specified data feed as runs before the current one. This
option indicates to the Data Feed Service that this data feed starts as soon as
the referenced data feed completes successfully.
For example, you can select to have a Threats data feed run immediately after
your Assets data feed finishes. From the Reference Feed list, select after
which existing data feed the current data feed starts.
A reference data feed will not run when immediately running a data feed. The
Run Data Feed Now option only runs the current data feed.
Every Specifies the interval of the frequency in which the data feed runs.
Field Description
Start Date Specifies the date on which the data feed schedule begins.
Time Specifies the time zone in of the server that runs the data feed.
Zone
3. Click Save.
Note: If you want to use a data feed that was created in RSA Archer 4.x, you must run an XML
Record Search, and select Search XML as the Search Type. For information on the XML Search
feature, see the Running an XML Record Search for an Archer-to-Archer Data Feed topic in the
RSA Archer Online Documentation.
Gener General Name user defined The unique name of the data feed,
al Informati for example, AWS Transport
on ONLY Data Feed.
Feed User user defined The user name under which the
Informati Name data feed will run, for example,
on AWS_Transport_Only. This user
must have access to the Web
Service API and the XML search
report. The user name cannot be
the same as the user who is
currently logged in.
id="35051"/><Field
id="35037"/><Field
id="34979"/><Field
id="35032"/><Field
id="34978"/><Field
id="35039"/><Field
id="35022"/><Field
id="35021"/><Field
id="35038"/><Field
id="35020"/><Field
id="35042"/><Field
id="35007"/><Field
id="35045"/><Field
id="35044"/><Field
id="35043"/><Field
id="35002"/><Field
id="34999"/><Field
id="35104"/><Field
id="35107"/><Field
id="35108"/><Field
id="35105"/><Field
id="35106"/><Field
id="35109"/><Field
id="35110"/><Field
id="35115"/><Field
id="35117"/><Field
id="35112"/><Field
id="35113"/><Field
id="35111"/><Field
id="35065"/><Field
id="35116"/><Field
id="35114"/></Display></Search>
Sched Immediat Run Data Start Click Start to run the data feed.
ule e Feed
Processin Now
g
Transport Locates a specific data file. This file contains additional instructions for launching
Only subsequent, standard data feeds. With this data feed type, the data feed only
completes the Transport and Navigation activities. The Source Definition and Field
Mapping activities are not allowed. Processing of the data feed does not attempt to
process the data.
Important: If you intend to use the data feed as part of a convoy, or you are troubleshooting the
data being pulled, select the Transport Only option. This option enables you to use a transform to
manipulate the data being returned by bringing the source data in as a flat file and then configure
a subsequent XML-based feed that includes an XSLT file. For more information on XML
formatting guidelines and samples, see the appendix “XML Formatting Used in Field Results and
Input” in the RSA Archer Web Services API Reference Guide that you can download from the
RSA Archer Community.
Note: If you want to use a data feed that was created in RSA Archer 4.x, you must run an
XML Record Search, and select Search XML as the Search Type. For information on the XML
Search feature, see the Running an XML Record Search for an Archer-to-Archer Data Feed
topic in the RSA Archer GRC Online Documentation.
Note: Use the account that has access role rights to the search.asmx page. The account
should also be an application owner with full access permissions to the content of the
applications. Do not use the same account that you used to log on.
7. (Optional) In the Domain field, enter the name of the domain to be searched against.
8. In the Instance field, enter the instance name for the instance to be searched against. Use the
instance name and not the PIN.
9. (Optional) In the Proxy section, enter the credentials of the proxy server if the data feed
accesses the source data through a proxy server.
The following table describes the options.
Option Description
No Proxy Indicates that the data feed does not pass through a proxy.
Use System Indicates that the Data Feed Service runs the feed with the proxy configuration
Proxy that is set up in the Control Panel.
Configure Indicates that the data feed must pass through a proxy. Continue with providing
Proxy the parameters for accessing the proxy.
10. (Optional) In the Post-Processing - Local Copy section, define the post-processing rules if the
data feed handles post-processing of the local copy of the source data.
To perform post-processing on the source file retrieved, in the Post-Processing - Local Copy
section, determine how the data feed should handle the local copy of the source data when the
integration is complete. In the On Success field, select from the following options.
The following table describes the options.
Option Description
Nothing Does not alter the source file when the data feed successfully completes. If there is
a local copy of the source information, the local copy is deleted.
Option Description
Rename Saves the source file under a new name when the data feed successfully completes.
In Destination File, specify where the file should be saved and the new name for the
file.
To save the data, the path of the destination file must be accessible to the account
running the Job Engine service.
If you select this option, use filename tokens for specifying the location or name of
the file.
Filename tokens
Filename tokens are available for post processing when you want to save the source
information and specify a location or name for the file. When you select the Rename
option, you can use tokens to generate unique names automatically for the files.
Here are the usable tokens for renaming data files.
l Now. Insert a user-defined date format within the new filename. Possible formats
include Now(MM/dd/yyyy) or Now(MMM-dd-yyyy). See the Microsoft .Net
Framework Developer Center for available custom date/time formats.
l DataFileDirectoryName. Update the filename with the directory name, including
the drive, of your file.
l DataFileName. Insert the original filename, excluding the directory name and
extension.
l DataFileExtension. Insert the file extension, such as .csv, in the new filename.
l DataFileFullName. Insert the fully qualified filename. This data includes the
drive, directory, filename, and extension of the original file.
For example, if the data file came from the following location,
C:\DataFeed\Source\ESL\processed\ThreatData.csv, files that have been renamed
using tokens would have the following output.
Example 1
l Input Tokens: {DataFileDirectoryName}\success\{DataFileName}_{Now
(MM.dd.yyyy)}.{DataFileExtension}
l Output: C:\DataFeed\Source\ESL\processed\success\ThreatData_01.31.2008.csv
Example 2
Option Description
Important: When you configure an iDefense or DeepSight threat data feed, you need to set specific
parameters to connect the threat feed properly with your RSA Archer instance.
1. Go to the Schedule tab of the data feed that you want to modify.
2. Go to the Recurrences section and complete frequency, start and stop times, and time zone.
The following table describes the fields in the Recurrences section.
Field Description
Frequency Specifies the interval in which the data feed runs, for example, Minutely, Hourly,
Daily, Weekly, Monthly, or Reference.
l Minutely. Runs the data feed by the interval set.
For example, if you specify 45 in the Every list, the data feed executes every
45 minutes.
l Hourly. Runs the data feed by the interval set, for example, every hour (1),
every other hour (2) and so forth.
l Daily. Runs the data feed by the interval set, for example, every day (1), every
other day (2) and, so forth.
l Weekly. Runs the data feed based on a specified day of the week, for example,
every Monday of the first week (1), every other Monday (2), and so forth.
l Monthly. Runs the data feed based on a specified week of the month, for
example, 1st, 2nd, 3rd, 4th, or Last.
l Reference. Runs a specified data feed as runs before the current one. This
option indicates to the Data Feed Service that this data feed starts as soon as
the referenced data feed completes successfully.
For example, you can select to have a Threats data feed run immediately after
your Assets data feed finishes. From the Reference Feed list, select after
which existing data feed the current data feed starts.
A reference data feed will not run when immediately running a data feed. The
Run Data Feed Now option only runs the current data feed.
Every Specifies the interval of the frequency in which the data feed runs.
Start Date Specifies the date on which the data feed schedule begins.
Time Specifies the time zone in of the server that runs the data feed.
Zone
3. Click Save.
For more information, see "Data Feeds" in the RSA Archer Online Documentation.
Note: If you are completing a large data import, you may need to increase the Session Timeout
for the Archer Services Security Parameter from 30 minutes to 6 hours. Adjustments for the
Archer Services Security Parameter must be made in the instance database by running an SQL
command.
Send Select whether to have the data feed trigger notification emails when records
Notifications are published or updated. If notifications are not enabled in the selected target
application, no notification emails are sent when the data feed runs.
Send Job Select whether to have job status notifications sent to selected users or groups.
Status You can also select email addresses to receive job status notifications. If
Notifications selected, job status notifications are sent showing whether a job succeeded or
failed to run.
9. (Optional) In the Additional Properties section, specify a different locale for your source data,
whether to override the rules of saving a record defined in the application, and whether to delay
running calculations until the data feed completes.
The following table describes the options.
Option Description
Locale Specifies the country (language) format of your source data. Different cultures
or countries use different characters when formatting similar data.
Option Description
Data Determines whether RSA Archer performs data validations against the selected
Validation target application when saving a record. Selecting this option bypasses
validation that is based on field definition and configuration (with some
exceptions). This option applies regardless of whether you are targeting a
questionnaire or application.
RSA Archer validates the following items regardless of whether this field is
selected:
l Attachment or image field - Validity of the file.
l Date/Time field - Minimum and maximum system values.
l Text field - Contains valid HTML.
l Field name - Uniqueness.
The required field settings are disregarded if you select to ignore the rules
defined within the target application. However, the unique selection cannot be
ignored.
Optimize Delays running calculations until the data feed completes and condenses
Calculations calculations for optimal processing. If this option is enabled, the optimized
calculation jobs run after the data feed completes. This improves the
performance of data feed processing and calculations.
Note: Condense jobs that are in the queue during an upgrade cause the jobs to
fail after the upgrade. Verify that there are no Condense jobs in the queue
before upgrading.
Important: For the data feed to execute successfully, the server responsible for running the data
feed must have the required network access to the database.
1. Set up a report-based search for an application or questionnaire that contains the source data that
you want to import into another application or questionnaire.
Note: If the data feed uses the Database Query transporter in a multiple server environment, you
must install the data provider on all servers.
2. Go to the Transport tab of the data feed that you want to modify.
Provider Specifies the data provider based on the type of connection string used.
If Oracle dotConnect is the data provider, you do not need to install the drivers
for Oracle because these drivers are included in the RSA Archer installation. To
determine the connection string for this data provider, go to the following URL:
http://www.devart.com/dotconnect/oracle/docs/Devart.Data.Oracle~
Devart.Data.Oracle.OracleConnection~ConnectionString.html.
Connection Specifies the timeout parameter in seconds to force the feed to fail because of
Timeout long-running queries.
Connection Allows the data feed to locate and access the database and retrieve the specified
String source data.
User Specifies the user name for an account that has access to query the database if
Name one was not inserted as part of the connection string in the previous step.
Password Specifies the password for an account that has access to query the database if
one was not inserted as part of the connection string in the previous step.
Option Description
Query Specifies the query that you want to execute against the database.
You can also execute a stored procedure by entering it in the Query field. This
field cannot be longer than 4,000 characters.
The following figure shows a stored procedure that you can execute.
Contact your database administrator prior to executing any queries against the
corporate data of your company . If you configure the query string incorrectly,
you may alter the data stored in the database.
Always verify your results by manually running the query directly against the
database first.
5. In the Post-Processing - Local Copy section, determine how the data feed should handle the local
copy of the source data after the integration completes.
To perform post-processing on the source file retrieved, in the Post-Processing - Local Copy
section, determine how the data feed should handle the local copy of the source data when the
integration is complete. In the On Success field, select from the following options.
The following table describes the options.
Option Description
Nothing Does not alter the source file when the data feed successfully completes. If there is
a local copy of the source information, the local copy is deleted.
Option Description
Rename Saves the source file under a new name when the data feed successfully completes.
In Destination File, specify where the file should be saved and the new name for the
file.
To save the data, the path of the destination file must be accessible to the account
running the Job Engine service.
If you select this option, use filename tokens for specifying the location or name of
the file.
Filename tokens
Filename tokens are available for post processing when you want to save the source
information and specify a location or name for the file. When you select the Rename
option, you can use tokens to generate unique names automatically for the files.
Here are the usable tokens for renaming data files.
l Now. Insert a user-defined date format within the new filename. Possible formats
include Now(MM/dd/yyyy) or Now(MMM-dd-yyyy). See the Microsoft .Net
Framework Developer Center for available custom date/time formats.
l DataFileDirectoryName. Update the filename with the directory name, including
the drive, of your file.
l DataFileName. Insert the original filename, excluding the directory name and
extension.
l DataFileExtension. Insert the file extension, such as .csv, in the new filename.
l DataFileFullName. Insert the fully qualified filename. This data includes the
drive, directory, filename, and extension of the original file.
For example, if the data file came from the following location,
C:\DataFeed\Source\ESL\processed\ThreatData.csv, files that have been renamed
using tokens would have the following output.
Example 1
l Input Tokens: {DataFileDirectoryName}\success\{DataFileName}_{Now
(MM.dd.yyyy)}.{DataFileExtension}
l Output: C:\DataFeed\Source\ESL\processed\success\ThreatData_01.31.2008.csv
Example 2
Option Description
In the On Success field, select Nothing or Rename to either remove or save the source file.
l If you selected Nothing, continue to the next step.
l If you selected Rename, enter the location and name of the new file you want to save in the
Destination File field.
6. Click Apply.
Note: You must load a transform. A default transform is included with the installation. If you
require additional data transformation, you can develop your own XSLT. For more information
on XML formatting guidelines and samples, see the appendix XML Formatting Used in Field
Results and Input in the RSA Archer Web Services API Reference Guide that you can download
from the RSA Archer Community.
Data options
l Import the data “as is” into RSA Archer or execute modifications and calculations against the
data to convert the incoming data into a format that matches the requirements of the application or
questionnaire it is imported into. Use several advanced options, such as lookup translations and
calculations, to prepare and modify the data to meet your individual business needs.
l Filter data so that only what you want to receive is imported into the target application or
questionnaire. By not defining filters on the Data Filter tab, you instruct Data Feed Manager to
return all records in the data feed. Use operator logic to add filters to include only records
meeting certain criteria in the data feed process.
l Capture tokens of data from the last execution of a data feed that can be used during the next run
to identify which data to retrieve. On the Tokens tab, you can add, edit, or delete token values in
preparation of the next data feed execution.
1. Go to the Source Data tab of the data feed that you want to modify.
The source for the schema of your data feed depends on which transporter you are using. The
following table identifies and describes the schema sources that are available for each of the out-
of-the-box transporters.
Important: The process of loading a source definition for a data feed times out at five minutes.
You may want to consider using a smaller set of source data when you set up the feed.
Source Description
Execute Executes the query specified on the Transport tab and detects the source schema
Query from the resulting record set.
Using this option may trigger actions in the database associated with this query.
Sample Uses a skeleton of your actual source data file. For example, if you are importing
File data from a .csv file, the source data file is a .csv file that includes the column
names from your source data. If you are importing data from an .XML file, the
source data file includes the structure of your .XML without the actual field values.
When you select the sample file, the Source Fields section populates with the fields
specified in the sample data file.
For the Archer Web Services Transporter, select a file from an external location
that contains the data in a same format as the report format.
4. In the first line in the Source Fields section, select the appropriate field option for the record
definition.
Note: For more information about configuring source fields in standard data feeds, see
Manipulating Data in the Source File of Standard Data Feeds.
5. In the Field type list for the remaining source fields, select the application option.
6. Click Apply.
Important: Do not use this option for an Archer-to-Archer data feed. RSA recommends that you
filter the report data instead.
1. Go to the Data Filter tab of the data feed that you want to modify.
2. In the Sources column, select the source name to which you want to apply a filter.
3. From the Field Name list, select the field name from your data source to which you want to
apply a filter.
4. From the Operator list, select an operator to define which type of filter you want to apply to the
source data.
5. In the Values column, enter a value based on your selection in the Operator column.
6. (Optional) In the Advanced operator logic field, enter the custom operator logic to create custom
operator logic to form relationships between the individual filters.
7. Complete either of the following optional tasks:
l To add an additional data filter, click Add New Filter located in the Data Filter section title
bar.
l To remove a data filter, in the Actions column of the filter you want to remove, click .
8. Click Apply.
1. Go to the Tokens tab of the data feed that you want to modify.
5. Click Apply.
1. Go to the Field Map tab of the data feed that you want to modify.
2. Map the source field to the applicable application or questionnaire. Do one of the following:
l Click Auto-Populate to map the source fields to application or questionnaire fields. This option
maps fields from the data source to application or questionnaire fields that have the same
name. Auto-populate occurs on level 1 fields only. Additionally, if there is an exact name
match between the source field and the target field, and the field type is one of the following,
the field is not auto-populated: External links, Values list, Sub-form, Related records, Cross
reference, or CAST.
l Drag each source field and drop it next to the application or questionnaire field in the Target
Fields section. For target fields that have a field type of cross-reference, sub-form, or related
records, map the fields expanded under these field types. You cannot directly map to a target
field with any of these field types.
Note: You can drag the left or right border to resize the Source Field column so that it can
display long source field names.
Note: You can enter a value from zero to 99, with zero being the highest trust level, and 99 the
lowest. A data feed cannot overwrite a previous feed that has a higher trust level. For example, a
data feed with a trust level of 75 cannot overwrite a data feed with a trust level of 20. By
default, this option is not available until Manual Trust is activated.
Note: For some out-of-the-box applications, you may see the following message if you try to
configure key fields for a data feed:
2. In the Reference Field section, select the field that requires a key field definition.
Note: The Reference Field section contains the target application or questionnaire and any
mapped cross-reference, related records, CAST, or sub-form fields that require the creation of a
key field definition.
3. In the Key Field Definitions title bar, click Add New Key.
Note: You can use the Key Field Definitions section to define the unique key identifiers and the
data feed actions during the feed execution.
4. In the Field Name field, select a target application or questionnaire field that uniquely identifies
the record.
5. (Optional) Assign compound unique identifiers for the record. Do the following:
l Click in the Actions column to add unique identifiers in a hierarchical structure for sub-
form field types.
Note: After setting the order of key fields, the Data Feed Manager scans the data source file
for matches to each unique identifier in the specified order. When any key field is found as a
match to a field in the target application, the record is considered matched.
7. From the Action list, select the applicable option for the matching criteria for the unique
identifier.
8. Click Apply.
2. In the Update Options section, select whether to create or update records in the target
application.
The following table describes the options.
Option Description
Create Create new records for data found in the source file and not in the target application
or questionnaire.
Update Updates records in the target application or questionnaire when a unique identifier
match exists in the source file. If you are also selecting the Archive Option of
Delete and want to retain existing records, make sure to select the Update option.
3. In the Archive Options section, select what happens when the matching record is not found in the
target application.
The following table describes the options.
Option Description
Delete Deletes records in the target application or questionnaire when a matching record is
not in the source data. If you want to retain existing records, also select the Update
option.
Records are matched by a unique identifier only during the update process. If you
want to retain existing records while archiving the target application, also select
Update in Update Options. If you do not select the Update option, all records in the
target application will be permanently deleted.
Option Description
Set Sets a value in a Values List field in a record whenever the external data file does
Value not contain a matching record.
Use this option to set a Values List to a value that identifies this record as Inactive
or Not Current. For example, a Devices application with a record for a specific
laptop and the external data file does not have a matching record for that laptop. You
can use this option to set a Values List field in the laptop record to the value
Inactive.
When you select this option, you also select the Values List field in the target
application or questionnaire and the value that you want to set in that field.
You cannot set the value in the Values List field of the target leveled application
under the following conditions:
l Level 3 or lower in a leveled application.
l You are modifying the data feed configuration.
In most scenarios, RSA recommends selecting the Set Value option and flagging
these records with a specific value rather than deleting them. For example, you can
add a field to your application called Status and include the values Current and
Archived. If a data feed cannot find a matching record in the data source with a
system record, the system record could be updated to have a value of Archived for
the Status field.
4. Click Apply.
Important: When you configure an iDefense or DeepSight threat data feed, you need to set specific
parameters to connect the threat feed properly with your RSA Archer instance.
1. Go to the Schedule tab of the data feed that you want to modify.
2. Go to the Recurrences section and complete frequency, start and stop times, and time zone.
The following table describes the fields in the Recurrences section.
Field Description
Frequency Specifies the interval in which the data feed runs, for example, Minutely, Hourly,
Daily, Weekly, Monthly, or Reference.
l Minutely. Runs the data feed by the interval set.
For example, if you specify 45 in the Every list, the data feed executes every
45 minutes.
l Hourly. Runs the data feed by the interval set, for example, every hour (1),
every other hour (2) and so forth.
l Daily. Runs the data feed by the interval set, for example, every day (1), every
other day (2) and, so forth.
l Weekly. Runs the data feed based on a specified day of the week, for example,
every Monday of the first week (1), every other Monday (2), and so forth.
l Monthly. Runs the data feed based on a specified week of the month, for
example, 1st, 2nd, 3rd, 4th, or Last.
l Reference. Runs a specified data feed as runs before the current one. This
option indicates to the Data Feed Service that this data feed starts as soon as
the referenced data feed completes successfully.
For example, you can select to have a Threats data feed run immediately after
your Assets data feed finishes. From the Reference Feed list, select after
which existing data feed the current data feed starts.
A reference data feed will not run when immediately running a data feed. The
Run Data Feed Now option only runs the current data feed.
Every Specifies the interval of the frequency in which the data feed runs.
Field Description
Start Date Specifies the date on which the data feed schedule begins.
Time Specifies the time zone in of the server that runs the data feed.
Zone
3. Click Save.
Transport Locates a specific data file. This file contains additional instructions for launching
Only subsequent, standard data feeds. With this data feed type, the data feed only
completes the Transport and Navigation activities. The Source Definition and Field
Mapping activities are not allowed. Processing of the data feed does not attempt to
process the data.
Important: If you intend to use the data feed as part of a convoy, or you are troubleshooting the
data being pulled, select the Transport Only option. This option enables you to use a transform to
manipulate the data being returned by bringing the source data in as a flat file and then configure
a subsequent XML-based feed that includes an XSLT file. For more information on XML
formatting guidelines and samples, see the appendix “XML Formatting Used in Field Results and
Input” in the RSA Archer Web Services API Reference Guide that you can download from the
RSA Archer Community.
Important: For the data feed to execute successfully, the server responsible for running the data
feed must have the required network access to the database.
1. Set up a report-based search for an application or questionnaire that contains the source data that
you want to import into another application or questionnaire.
Note: If the data feed uses the Database Query transporter in a multiple server environment, you
must install the data provider on all servers.
2. Go to the Transport tab of the data feed that you want to modify.
Provider Specifies the data provider based on the type of connection string used.
If Oracle dotConnect is the data provider, you do not need to install the drivers
for Oracle because these drivers are included in the RSA Archer installation. To
determine the connection string for this data provider, go to the following URL:
http://www.devart.com/dotconnect/oracle/docs/Devart.Data.Oracle~
Devart.Data.Oracle.OracleConnection~ConnectionString.html.
Connection Specifies the timeout parameter in seconds to force the feed to fail because of
Timeout long-running queries.
Connection Allows the data feed to locate and access the database and retrieve the specified
String source data.
User Specifies the user name for an account that has access to query the database if
Name one was not inserted as part of the connection string in the previous step.
Password Specifies the password for an account that has access to query the database if
one was not inserted as part of the connection string in the previous step.
Query Specifies the query that you want to execute against the database.
You can also execute a stored procedure by entering it in the Query field. This
field cannot be longer than 4,000 characters.
The following figure shows a stored procedure that you can execute.
Contact your database administrator prior to executing any queries against the
corporate data of your company . If you configure the query string incorrectly,
you may alter the data stored in the database.
Always verify your results by manually running the query directly against the
database first.
5. In the Post-Processing - Local Copy section, determine how the data feed should handle the local
copy of the source data after the integration completes.
To perform post-processing on the source file retrieved, in the Post-Processing - Local Copy
section, determine how the data feed should handle the local copy of the source data when the
integration is complete. In the On Success field, select from the following options.
Nothing Does not alter the source file when the data feed successfully completes. If there is
a local copy of the source information, the local copy is deleted.
Option Description
Rename Saves the source file under a new name when the data feed successfully completes.
In Destination File, specify where the file should be saved and the new name for the
file.
To save the data, the path of the destination file must be accessible to the account
running the Job Engine service.
If you select this option, use filename tokens for specifying the location or name of
the file.
Filename tokens
Filename tokens are available for post processing when you want to save the source
information and specify a location or name for the file. When you select the Rename
option, you can use tokens to generate unique names automatically for the files.
Here are the usable tokens for renaming data files.
l Now. Insert a user-defined date format within the new filename. Possible formats
include Now(MM/dd/yyyy) or Now(MMM-dd-yyyy). See the Microsoft .Net
Framework Developer Center for available custom date/time formats.
l DataFileDirectoryName. Update the filename with the directory name, including
the drive, of your file.
l DataFileName. Insert the original filename, excluding the directory name and
extension.
l DataFileExtension. Insert the file extension, such as .csv, in the new filename.
l DataFileFullName. Insert the fully qualified filename. This data includes the
drive, directory, filename, and extension of the original file.
For example, if the data file came from the following location,
C:\DataFeed\Source\ESL\processed\ThreatData.csv, files that have been renamed
using tokens would have the following output.
Example 1
l Input Tokens: {DataFileDirectoryName}\success\{DataFileName}_{Now
(MM.dd.yyyy)}.{DataFileExtension}
l Output: C:\DataFeed\Source\ESL\processed\success\ThreatData_01.31.2008.csv
Example 2
Option Description
In the On Success field, select Nothing or Rename to either remove or save the source file.
l If you selected Nothing, continue to the next step.
l If you selected Rename, enter the location and name of the new file you want to save in the
Destination File field.
6. Click Apply.
Important: When you configure an iDefense or DeepSight threat data feed, you need to set specific
parameters to connect the threat feed properly with your RSA Archer instance.
1. Go to the Schedule tab of the data feed that you want to modify.
2. Go to the Recurrences section and complete frequency, start and stop times, and time zone.
The following table describes the fields in the Recurrences section.
Field Description
Frequency Specifies the interval in which the data feed runs, for example, Minutely, Hourly,
Daily, Weekly, Monthly, or Reference.
l Minutely. Runs the data feed by the interval set.
For example, if you specify 45 in the Every list, the data feed executes every
45 minutes.
l Hourly. Runs the data feed by the interval set, for example, every hour (1),
every other hour (2) and so forth.
l Daily. Runs the data feed by the interval set, for example, every day (1), every
other day (2) and, so forth.
l Weekly. Runs the data feed based on a specified day of the week, for example,
every Monday of the first week (1), every other Monday (2), and so forth.
l Monthly. Runs the data feed based on a specified week of the month, for
example, 1st, 2nd, 3rd, 4th, or Last.
l Reference. Runs a specified data feed as runs before the current one. This
option indicates to the Data Feed Service that this data feed starts as soon as
the referenced data feed completes successfully.
For example, you can select to have a Threats data feed run immediately after
your Assets data feed finishes. From the Reference Feed list, select after
which existing data feed the current data feed starts.
A reference data feed will not run when immediately running a data feed. The
Run Data Feed Now option only runs the current data feed.
Every Specifies the interval of the frequency in which the data feed runs.
Start Date Specifies the date on which the data feed schedule begins.
Time Specifies the time zone in of the server that runs the data feed.
Zone
3. Click Save.
Important: For the data feed to execute successfully, the server responsible for running the data
feed must have the required access to the files.
File Transporter
The File Transporter allows a file from an external source with unknown contents and integrity to be
brought onto RSA Archer servers. This flexibility introduces a potential attack vector where the
associated risk must be accepted by the customer.
RSA recommends that you disable the File Transporter if a business need does not require its use. If
the File Transporter must be used, RSA recommends selecting Zip File as the File Type and using
encryption by selecting an Encryption Type.
For more information, see "Transporter Availability" in the RSA Archer Control Panel Help. For
information on configuring the File Transporter, see the "Data Feed Manager" section of "Define a
File Transporter" in the RSA Archer Online Documentation.
A File Transporter data feed can be configured as a standard or transport data feed type.
Use the following tasks to add a file data feed:
l Adding Standard File data feeds
l Adding Transport Only File data feeds
For more information, see "Data Feeds" in the RSA Archer Online Documentation.
Note: If you are completing a large data import, you may need to increase the Session Timeout
for the Archer Services Security Parameter from 30 minutes to 6 hours. Adjustments for the
Archer Services Security Parameter must be made in the instance database by running an SQL
command.
Send Select whether to have the data feed trigger notification emails when records
Notifications are published or updated. If notifications are not enabled in the selected target
application, no notification emails are sent when the data feed runs.
Send Job Select whether to have job status notifications sent to selected users or groups.
Status You can also select email addresses to receive job status notifications. If
Notifications selected, job status notifications are sent showing whether a job succeeded or
failed to run.
9. (Optional) In the Additional Properties section, specify a different locale for your source data,
whether to override the rules of saving a record defined in the application, and whether to delay
running calculations until the data feed completes.
Locale Specifies the country (language) format of your source data. Different cultures
or countries use different characters when formatting similar data.
Data Determines whether RSA Archer performs data validations against the selected
Validation target application when saving a record. Selecting this option bypasses
validation that is based on field definition and configuration (with some
exceptions). This option applies regardless of whether you are targeting a
questionnaire or application.
RSA Archer validates the following items regardless of whether this field is
selected:
l Attachment or image field - Validity of the file.
l Date/Time field - Minimum and maximum system values.
l Text field - Contains valid HTML.
l Field name - Uniqueness.
The required field settings are disregarded if you select to ignore the rules
defined within the target application. However, the unique selection cannot be
ignored.
Optimize Delays running calculations until the data feed completes and condenses
Calculations calculations for optimal processing. If this option is enabled, the optimized
calculation jobs run after the data feed completes. This improves the
performance of data feed processing and calculations.
Note: Condense jobs that are in the queue during an upgrade cause the jobs to
fail after the upgrade. Verify that there are no Condense jobs in the queue
before upgrading.
1. Go to the Transport tab of the data feed that you want to modify.
Single References a single data file. This option requires you to specify a path in the Path
Data field. You can filter which files to process by entering a standard file expression in
File the File Filter field.
Note: The JSON Iterator only supports the Single Data File type.
Manifest Points the Data Feed Manager to a file that contains instructions for locating a
File series of data files. This option requires you to specify a path in the Path field. You
can filter which files to process by entering a standard file or regular expression in
the File Filter field.
Zip File References a ZIP file. This option requires you to specify a path in the Path field.
When filtering files, the parent directory is searched and then the file inside the
selected ZIP files is searched based on the filter. Use the Encryption Type list to
identify the encrypted file type. If the encrypted ZIP file is password protected,
enter the password in the Password field.
File Filtering is a single file filter or a list of file filters separated by semicolons.
The data feed only processes data included in the File Filter. The File Filter must
contain the ZIP or CSV file and all related files. Do not include files for
Attachment fields.
Note: All file names within a ZIP file must consist of characters from the code
page 437 character set.
4. (Optional) In the Post-Processing section, determine how the data feed should handle the source
information when the integration is complete.
To perform post-processing on the source file retrieved, in the Post Processing section, determine
how the data feed should handle the local copy of the source data when the integration is
complete.
Nothing Does not alter the source file when the data feed successfully completes. If there is
a local copy of the source information, the local copy is deleted.
Option Description
Rename Saves the source file under a new name when the data feed successfully completes.
In Destination File, specify where the file should be saved and the new name for the
file.
If you select this option, use filename tokens for specifying the location or name of
the file.
Filename tokens
Filename tokens are available for post processing when you want to save the source
information and specify a location or name for the file. When you select the Rename
option, you can use tokens to generate unique names automatically for the files.
Here are the usable tokens for renaming data files.
l Now. Insert a user-defined date format within the new filename. Possible formats
include Now(MM/dd/yyyy) or Now(MMM-dd-yyyy). See the Microsoft .Net
Framework Developer Center for available custom date/time formats.
l DataFileDirectoryName. Update the filename with the directory name, including
the drive, of your file.
l DataFileName. Insert the original filename, excluding the directory name and
extension.
l DataFileExtension. Insert the file extension, such as .csv, in the new filename.
l DataFileFullName. Insert the fully qualified filename. This data includes the
drive, directory, filename, and extension of the original file.
For example, if the data file came from the following location,
C:\DataFeed\Source\ESL\processed\ThreatData.csv, files that have been renamed
using tokens would have the following output.
Example 1
l Input Tokens: {DataFileDirectoryName}\success\{DataFileName}_{Now
(MM.dd.yyyy)}.{DataFileExtension}
l Output: C:\DataFeed\Source\ESL\processed\success\ThreatData_01.31.2008.csv
Example 2
l Input Tokens: \\DFSRepository\{Now(yyyy)}\{Now(MM)}\{DataFileName}_
success.{DataFileExtension}
Option Description
l Output: \\DFSRepository\2008\01\ThreatData_success.csv
Delete Deletes the source file when the data feed completes successfully.
This option is available only for File and FTP transport methods.
5. (Optional) In the Post-Processing - Local Copy section, determine how the data feed should
handle the local copy of the source data when the integration is complete.
To perform post-processing on the source file retrieved, in the Post-Processing - Local Copy
section, determine how the data feed should handle the local copy of the source data when the
integration is complete. In the On Success field, select from the following options.
The following table describes the options.
Option Description
Nothing Does not alter the source file when the data feed successfully completes. If there is
a local copy of the source information, the local copy is deleted.
Option Description
Rename Saves the source file under a new name when the data feed successfully completes.
In Destination File, specify where the file should be saved and the new name for the
file.
To save the data, the path of the destination file must be accessible to the account
running the Job Engine service.
If you select this option, use filename tokens for specifying the location or name of
the file.
Filename tokens
Filename tokens are available for post processing when you want to save the source
information and specify a location or name for the file. When you select the Rename
option, you can use tokens to generate unique names automatically for the files.
Here are the usable tokens for renaming data files.
l Now. Insert a user-defined date format within the new filename. Possible formats
include Now(MM/dd/yyyy) or Now(MMM-dd-yyyy). See the Microsoft .Net
Framework Developer Center for available custom date/time formats.
l DataFileDirectoryName. Update the filename with the directory name, including
the drive, of your file.
l DataFileName. Insert the original filename, excluding the directory name and
extension.
l DataFileExtension. Insert the file extension, such as .csv, in the new filename.
l DataFileFullName. Insert the fully qualified filename. This data includes the
drive, directory, filename, and extension of the original file.
For example, if the data file came from the following location,
C:\DataFeed\Source\ESL\processed\ThreatData.csv, files that have been renamed
using tokens would have the following output.
Example 1
l Input Tokens: {DataFileDirectoryName}\success\{DataFileName}_{Now
(MM.dd.yyyy)}.{DataFileExtension}
l Output: C:\DataFeed\Source\ESL\processed\success\ThreatData_01.31.2008.csv
Example 2
Option Description
1. Go to the Navigation tab of the data feed that you want to modify.
Quote Specifies the character that is used to identify quotes in your source data.
Identifier
Escape Specifies the character that is used to escape from normal data into control data.
Sequence
Format Description
Record Specifies the control code that is used to identify a new record in your source data.
Delimiter
Skip Indicates the number of lines that the Data Feed Manager should ignore in the
Record source data before finding data. For example, if the first row in your source data
Count contains column names, you type "1" so that the Data Feed Manager ignores this
row and moves to the next row to start reading data.
Field Specifies the character that is used to identify a new field in your data source. If
Delimiter you select Other, type the character you want to use.
List Specifies the character that is used to identify a new list in your data source. If you
Delimiter select Other, type the character you want to use.
Leveled Specifies the character that is used to identify a new leveled list in your data
List source. If you select Other, type the character you want to use.
Delimiter
4. Click Apply.
1. Go to the Navigation tab of the data feed that you want to modify.
Note: You must load a transform. A default transform is included with the installation. If you
require additional data transformation, you can develop your own XSLT. For more information
on XML formatting guidelines and samples, see the appendix "XML Formatting Used in Field
Results and Input" in the RSA Archer Web Services API Reference Guide that you can
download from the RSA Archer Community.
The JSON Iterator is supported for the File, FTP, and HTTP transporters. JSON processing only
supports the Single Data file type.
Requirements
Examples
The following examples show that a source file can be either a valid JSON or JSON enclosed in
XML tags:
l Valid JSON
{"Assets": [ { "Asset": {"Name": "IP Phone","Description": "<my description>","Status":
"Active"}}, { "Asset": {"Name": "Laptop","Description": "My Laptop","Status": "Active"}}] }
l JSON enclosed in XML tags
<data> {"Assets": [ { "Asset": {"Name": "IP Phone","Description": "<my
description>","Status": "Active"}}, { "Asset": {"Name": "Laptop","Description": "My
Laptop","Status": "Active"}}] }</data>
1. Go to the Navigation tab of the data feed that you want to modify.
Note: JSON Iterator only supports the Single Data file type.
Data options
l Import the data “as is” into RSA Archer or execute modifications and calculations against the
data to convert the incoming data into a format that matches the requirements of the application or
questionnaire it is imported into. Use several advanced options, such as lookup translations and
calculations, to prepare and modify the data to meet your individual business needs.
l Filter data so that only what you want to receive is imported into the target application or
questionnaire. By not defining filters on the Data Filter tab, you instruct Data Feed Manager to
return all records in the data feed. Use operator logic to add filters to include only records
meeting certain criteria in the data feed process.
l Capture tokens of data from the last execution of a data feed that can be used during the next run
to identify which data to retrieve. On the Tokens tab, you can add, edit, or delete token values in
preparation of the next data feed execution.
1. Go to the Source Data tab of the data feed that you want to modify.
Important: Do not use this option for an Archer-to-Archer data feed. RSA recommends that you
filter the report data instead.
1. Go to the Data Filter tab of the data feed that you want to modify.
2. In the Sources column, select the source name to which you want to apply a filter.
3. From the Field Name list, select the field name from your data source to which you want to
apply a filter.
4. From the Operator list, select an operator to define which type of filter you want to apply to the
source data.
5. In the Values column, enter a value based on your selection in the Operator column.
6. (Optional) In the Advanced operator logic field, enter the custom operator logic to create custom
operator logic to form relationships between the individual filters.
7. Complete either of the following optional tasks:
l To add an additional data filter, click Add New Filter located in the Data Filter section title
bar.
l To remove a data filter, in the Actions column of the filter you want to remove, click .
8. Click Apply.
1. Go to the Tokens tab of the data feed that you want to modify.
1. Go to the Field Map tab of the data feed that you want to modify.
2. Map the source field to the applicable application or questionnaire. Do one of the following:
l Click Auto-Populate to map the source fields to application or questionnaire fields. This option
maps fields from the data source to application or questionnaire fields that have the same
name. Auto-populate occurs on level 1 fields only. Additionally, if there is an exact name
match between the source field and the target field, and the field type is one of the following,
the field is not auto-populated: External links, Values list, Sub-form, Related records, Cross
reference, or CAST.
l Drag each source field and drop it next to the application or questionnaire field in the Target
Fields section. For target fields that have a field type of cross-reference, sub-form, or related
records, map the fields expanded under these field types. You cannot directly map to a target
field with any of these field types.
Note: You can drag the left or right border to resize the Source Field column so that it can
display long source field names.
Note: You can enter a value from zero to 99, with zero being the highest trust level, and 99 the
lowest. A data feed cannot overwrite a previous feed that has a higher trust level. For example, a
data feed with a trust level of 75 cannot overwrite a data feed with a trust level of 20. By
default, this option is not available until Manual Trust is activated.
Note: For some out-of-the-box applications, you may see the following message if you try to
configure key fields for a data feed:
2. In the Reference Field section, select the field that requires a key field definition.
Note: The Reference Field section contains the target application or questionnaire and any
mapped cross-reference, related records, CAST, or sub-form fields that require the creation of a
key field definition.
3. In the Key Field Definitions title bar, click Add New Key.
Note: You can use the Key Field Definitions section to define the unique key identifiers and the
data feed actions during the feed execution.
4. In the Field Name field, select a target application or questionnaire field that uniquely identifies
the record.
5. (Optional) Assign compound unique identifiers for the record. Do the following:
l Click in the Actions column to add unique identifiers in a hierarchical structure for sub-
form field types.
Note: After setting the order of key fields, the Data Feed Manager scans the data source file
for matches to each unique identifier in the specified order. When any key field is found as a
match to a field in the target application, the record is considered matched.
7. From the Action list, select the applicable option for the matching criteria for the unique
identifier.
8. Click Apply.
2. In the Update Options section, select whether to create or update records in the target
application.
The following table describes the options.
Option Description
Create Create new records for data found in the source file and not in the target application
or questionnaire.
Update Updates records in the target application or questionnaire when a unique identifier
match exists in the source file. If you are also selecting the Archive Option of
Delete and want to retain existing records, make sure to select the Update option.
3. In the Archive Options section, select what happens when the matching record is not found in the
target application.
The following table describes the options.
Option Description
Delete Deletes records in the target application or questionnaire when a matching record is
not in the source data. If you want to retain existing records, also select the Update
option.
Records are matched by a unique identifier only during the update process. If you
want to retain existing records while archiving the target application, also select
Update in Update Options. If you do not select the Update option, all records in the
target application will be permanently deleted.
Set Sets a value in a Values List field in a record whenever the external data file does
Value not contain a matching record.
Use this option to set a Values List to a value that identifies this record as Inactive
or Not Current. For example, a Devices application with a record for a specific
laptop and the external data file does not have a matching record for that laptop. You
can use this option to set a Values List field in the laptop record to the value
Inactive.
When you select this option, you also select the Values List field in the target
application or questionnaire and the value that you want to set in that field.
You cannot set the value in the Values List field of the target leveled application
under the following conditions:
l Level 3 or lower in a leveled application.
l You are modifying the data feed configuration.
In most scenarios, RSA recommends selecting the Set Value option and flagging
these records with a specific value rather than deleting them. For example, you can
add a field to your application called Status and include the values Current and
Archived. If a data feed cannot find a matching record in the data source with a
system record, the system record could be updated to have a value of Archived for
the Status field.
4. Click Apply.
Important: When you configure an iDefense or DeepSight threat data feed, you need to set specific
parameters to connect the threat feed properly with your RSA Archer instance.
1. Go to the Schedule tab of the data feed that you want to modify.
2. Go to the Recurrences section and complete frequency, start and stop times, and time zone.
The following table describes the fields in the Recurrences section.
Field Description
Frequency Specifies the interval in which the data feed runs, for example, Minutely, Hourly,
Daily, Weekly, Monthly, or Reference.
l Minutely. Runs the data feed by the interval set.
For example, if you specify 45 in the Every list, the data feed executes every
45 minutes.
l Hourly. Runs the data feed by the interval set, for example, every hour (1),
every other hour (2) and so forth.
l Daily. Runs the data feed by the interval set, for example, every day (1), every
other day (2) and, so forth.
l Weekly. Runs the data feed based on a specified day of the week, for example,
every Monday of the first week (1), every other Monday (2), and so forth.
l Monthly. Runs the data feed based on a specified week of the month, for
example, 1st, 2nd, 3rd, 4th, or Last.
l Reference. Runs a specified data feed as runs before the current one. This
option indicates to the Data Feed Service that this data feed starts as soon as
the referenced data feed completes successfully.
For example, you can select to have a Threats data feed run immediately after
your Assets data feed finishes. From the Reference Feed list, select after
which existing data feed the current data feed starts.
A reference data feed will not run when immediately running a data feed. The
Run Data Feed Now option only runs the current data feed.
Every Specifies the interval of the frequency in which the data feed runs.
Start Date Specifies the date on which the data feed schedule begins.
Time Specifies the time zone in of the server that runs the data feed.
Zone
3. Click Save.
Transport Locates a specific data file. This file contains additional instructions for launching
Only subsequent, standard data feeds. With this data feed type, the data feed only
completes the Transport and Navigation activities. The Source Definition and Field
Mapping activities are not allowed. Processing of the data feed does not attempt to
process the data.
Important: If you intend to use the data feed as part of a convoy, or you are troubleshooting the
data being pulled, select the Transport Only option. This option enables you to use a transform to
manipulate the data being returned by bringing the source data in as a flat file and then configure
a subsequent XML-based feed that includes an XSLT file. For more information on XML
formatting guidelines and samples, see the appendix “XML Formatting Used in Field Results and
Input” in the RSA Archer Web Services API Reference Guide that you can download from the
RSA Archer Community.
l Create a new user account by selecting Other and entering the name of the new user account.
When you save your data feed settings, the Data Feed Manager automatically creates the new
user account.
7. In the Target Path field, enter the path where you want to store the output file of the Transport
Only data feed.
8. Click Apply.
1. Go to the Transport tab of the data feed that you want to modify.
Single References a single data file. This option requires you to specify a path in the Path
Data field. You can filter which files to process by entering a standard file expression in
File the File Filter field.
Note: The JSON Iterator only supports the Single Data File type.
Manifest Points the Data Feed Manager to a file that contains instructions for locating a
File series of data files. This option requires you to specify a path in the Path field. You
can filter which files to process by entering a standard file or regular expression in
the File Filter field.
Option Description
Zip File References a ZIP file. This option requires you to specify a path in the Path field.
When filtering files, the parent directory is searched and then the file inside the
selected ZIP files is searched based on the filter. Use the Encryption Type list to
identify the encrypted file type. If the encrypted ZIP file is password protected,
enter the password in the Password field.
File Filtering is a single file filter or a list of file filters separated by semicolons.
The data feed only processes data included in the File Filter. The File Filter must
contain the ZIP or CSV file and all related files. Do not include files for
Attachment fields.
Note: All file names within a ZIP file must consist of characters from the code
page 437 character set.
4. (Optional) In the Post-Processing section, determine how the data feed should handle the source
information when the integration is complete.
To perform post-processing on the source file retrieved, in the Post Processing section, determine
how the data feed should handle the local copy of the source data when the integration is
complete.
The following table describes the options.
Option Description
Nothing Does not alter the source file when the data feed successfully completes. If there is
a local copy of the source information, the local copy is deleted.
Option Description
Rename Saves the source file under a new name when the data feed successfully completes.
In Destination File, specify where the file should be saved and the new name for the
file.
If you select this option, use filename tokens for specifying the location or name of
the file.
Filename tokens
Filename tokens are available for post processing when you want to save the source
information and specify a location or name for the file. When you select the Rename
option, you can use tokens to generate unique names automatically for the files.
Here are the usable tokens for renaming data files.
l Now. Insert a user-defined date format within the new filename. Possible formats
include Now(MM/dd/yyyy) or Now(MMM-dd-yyyy). See the Microsoft .Net
Framework Developer Center for available custom date/time formats.
l DataFileDirectoryName. Update the filename with the directory name, including
the drive, of your file.
l DataFileName. Insert the original filename, excluding the directory name and
extension.
l DataFileExtension. Insert the file extension, such as .csv, in the new filename.
l DataFileFullName. Insert the fully qualified filename. This data includes the
drive, directory, filename, and extension of the original file.
For example, if the data file came from the following location,
C:\DataFeed\Source\ESL\processed\ThreatData.csv, files that have been renamed
using tokens would have the following output.
Example 1
l Input Tokens: {DataFileDirectoryName}\success\{DataFileName}_{Now
(MM.dd.yyyy)}.{DataFileExtension}
l Output: C:\DataFeed\Source\ESL\processed\success\ThreatData_01.31.2008.csv
Example 2
l Input Tokens: \\DFSRepository\{Now(yyyy)}\{Now(MM)}\{DataFileName}_
success.{DataFileExtension}
Option Description
l Output: \\DFSRepository\2008\01\ThreatData_success.csv
Delete Deletes the source file when the data feed completes successfully.
This option is available only for File and FTP transport methods.
5. (Optional) In the Post-Processing - Local Copy section, determine how the data feed should
handle the local copy of the source data when the integration is complete.
To perform post-processing on the source file retrieved, in the Post-Processing - Local Copy
section, determine how the data feed should handle the local copy of the source data when the
integration is complete. In the On Success field, select from the following options.
The following table describes the options.
Option Description
Nothing Does not alter the source file when the data feed successfully completes. If there is
a local copy of the source information, the local copy is deleted.
Option Description
Rename Saves the source file under a new name when the data feed successfully completes.
In Destination File, specify where the file should be saved and the new name for the
file.
To save the data, the path of the destination file must be accessible to the account
running the Job Engine service.
If you select this option, use filename tokens for specifying the location or name of
the file.
Filename tokens
Filename tokens are available for post processing when you want to save the source
information and specify a location or name for the file. When you select the Rename
option, you can use tokens to generate unique names automatically for the files.
Here are the usable tokens for renaming data files.
l Now. Insert a user-defined date format within the new filename. Possible formats
include Now(MM/dd/yyyy) or Now(MMM-dd-yyyy). See the Microsoft .Net
Framework Developer Center for available custom date/time formats.
l DataFileDirectoryName. Update the filename with the directory name, including
the drive, of your file.
l DataFileName. Insert the original filename, excluding the directory name and
extension.
l DataFileExtension. Insert the file extension, such as .csv, in the new filename.
l DataFileFullName. Insert the fully qualified filename. This data includes the
drive, directory, filename, and extension of the original file.
For example, if the data file came from the following location,
C:\DataFeed\Source\ESL\processed\ThreatData.csv, files that have been renamed
using tokens would have the following output.
Example 1
l Input Tokens: {DataFileDirectoryName}\success\{DataFileName}_{Now
(MM.dd.yyyy)}.{DataFileExtension}
l Output: C:\DataFeed\Source\ESL\processed\success\ThreatData_01.31.2008.csv
Example 2
Option Description
Important: When you configure an iDefense or DeepSight threat data feed, you need to set specific
parameters to connect the threat feed properly with your RSA Archer instance.
1. Go to the Schedule tab of the data feed that you want to modify.
2. Go to the Recurrences section and complete frequency, start and stop times, and time zone.
The following table describes the fields in the Recurrences section.
Field Description
Frequency Specifies the interval in which the data feed runs, for example, Minutely, Hourly,
Daily, Weekly, Monthly, or Reference.
l Minutely. Runs the data feed by the interval set.
For example, if you specify 45 in the Every list, the data feed executes every
45 minutes.
l Hourly. Runs the data feed by the interval set, for example, every hour (1),
every other hour (2) and so forth.
l Daily. Runs the data feed by the interval set, for example, every day (1), every
other day (2) and, so forth.
l Weekly. Runs the data feed based on a specified day of the week, for example,
every Monday of the first week (1), every other Monday (2), and so forth.
l Monthly. Runs the data feed based on a specified week of the month, for
example, 1st, 2nd, 3rd, 4th, or Last.
l Reference. Runs a specified data feed as runs before the current one. This
option indicates to the Data Feed Service that this data feed starts as soon as
the referenced data feed completes successfully.
For example, you can select to have a Threats data feed run immediately after
your Assets data feed finishes. From the Reference Feed list, select after
which existing data feed the current data feed starts.
A reference data feed will not run when immediately running a data feed. The
Run Data Feed Now option only runs the current data feed.
Every Specifies the interval of the frequency in which the data feed runs.
Start Date Specifies the date on which the data feed schedule begins.
Time Specifies the time zone in of the server that runs the data feed.
Zone
3. Click Save.
FTP Transporter
The FTP Transporter allows a file from an external source with unknown contents and integrity to be
brought onto RSA Archer servers. This flexibility introduces a potential attack vector where the
associated risk must be accepted by the customer.
RSA recommends that you disable the FTP Transporter if a business need does not require its use. If
you must use the FTP Transporter, RSA recommends selecting Zip File as the File Type and using
encryption by selecting an Encryption Type.
An FTP Transporter data feed can be configured as a standard or transport data feed type.
Use the following tasks to add an FTP data feed:
l Adding Standard FTP data feeds
l Adding Transport Only FTP data feeds
For more information, see "Data Feeds" in the RSA Archer Online Documentation.
Note: If you are completing a large data import, you may need to increase the Session Timeout
for the Archer Services Security Parameter from 30 minutes to 6 hours. Adjustments for the
Archer Services Security Parameter must be made in the instance database by running an SQL
command.
Send Select whether to have the data feed trigger notification emails when records
Notifications are published or updated. If notifications are not enabled in the selected target
application, no notification emails are sent when the data feed runs.
Send Job Select whether to have job status notifications sent to selected users or groups.
Status You can also select email addresses to receive job status notifications. If
Notifications selected, job status notifications are sent showing whether a job succeeded or
failed to run.
9. (Optional) In the Additional Properties section, specify a different locale for your source data,
whether to override the rules of saving a record defined in the application, and whether to delay
running calculations until the data feed completes.
The following table describes the options.
Option Description
Locale Specifies the country (language) format of your source data. Different cultures
or countries use different characters when formatting similar data.
Option Description
Data Determines whether RSA Archer performs data validations against the selected
Validation target application when saving a record. Selecting this option bypasses
validation that is based on field definition and configuration (with some
exceptions). This option applies regardless of whether you are targeting a
questionnaire or application.
RSA Archer validates the following items regardless of whether this field is
selected:
l Attachment or image field - Validity of the file.
l Date/Time field - Minimum and maximum system values.
l Text field - Contains valid HTML.
l Field name - Uniqueness.
The required field settings are disregarded if you select to ignore the rules
defined within the target application. However, the unique selection cannot be
ignored.
Optimize Delays running calculations until the data feed completes and condenses
Calculations calculations for optimal processing. If this option is enabled, the optimized
calculation jobs run after the data feed completes. This improves the
performance of data feed processing and calculations.
Note: Condense jobs that are in the queue during an upgrade cause the jobs to
fail after the upgrade. Verify that there are no Condense jobs in the queue
before upgrading.
1. Go to the Transport tab of the data feed that you want to modify.
Single References a single data file. This option requires you to specify a path in the Path
Data field. You can filter which files to process by entering a standard file expression in
File the File Filter field.
Manifest Points the Data Feed Manager to a file that contains instructions for locating a
File series of data files. This option requires you to specify a path in the Path field. You
can filter which files to process by entering a standard file expression in the File
Filter field.
Zip File References a .zip file. The .zip file can be a single, compressed data source file or
a collection of files. This option requires you to specify a path in the Path field. You
can filter which files from the .zip file to process by entering a standard file
expression in the File Filter field. Use the Encryption Type list to identify the
encrypted file type, if any. If the encrypted .zip file is password protected, enter the
password in the Password field.
No Proxy Indicates that the data feed does not pass through a proxy.
Use System Indicates that the Data Feed Service runs the feed with the proxy configuration
Proxy that is set up in the Control Panel.
Configure Indicates that the data feed must pass through a proxy. Continue with providing
Proxy the parameters for accessing the proxy.
Field Description
User Specifies the name of the user who has credentials for logging on to the proxy
Name server.
6. (Optional) In the Post-Processing section, determine how the data feed should handle the source
information when the integration is complete. In the On Success field, select one of the following
options:
To perform post-processing on the source file retrieved, in the Post Processing section, determine
how the data feed should handle the local copy of the source data when the integration is
complete.
The following table describes the options.
Option Description
Nothing Does not alter the source file when the data feed successfully completes. If there is
a local copy of the source information, the local copy is deleted.
Option Description
Rename Saves the source file under a new name when the data feed successfully completes.
In Destination File, specify where the file should be saved and the new name for the
file.
If you select this option, use filename tokens for specifying the location or name of
the file.
Filename tokens
Filename tokens are available for post processing when you want to save the source
information and specify a location or name for the file. When you select the Rename
option, you can use tokens to generate unique names automatically for the files.
Here are the usable tokens for renaming data files.
l Now. Insert a user-defined date format within the new filename. Possible formats
include Now(MM/dd/yyyy) or Now(MMM-dd-yyyy). See the Microsoft .Net
Framework Developer Center for available custom date/time formats.
l DataFileDirectoryName. Update the filename with the directory name, including
the drive, of your file.
l DataFileName. Insert the original filename, excluding the directory name and
extension.
l DataFileExtension. Insert the file extension, such as .csv, in the new filename.
l DataFileFullName. Insert the fully qualified filename. This data includes the
drive, directory, filename, and extension of the original file.
For example, if the data file came from the following location,
C:\DataFeed\Source\ESL\processed\ThreatData.csv, files that have been renamed
using tokens would have the following output.
Example 1
l Input Tokens: {DataFileDirectoryName}\success\{DataFileName}_{Now
(MM.dd.yyyy)}.{DataFileExtension}
l Output: C:\DataFeed\Source\ESL\processed\success\ThreatData_01.31.2008.csv
Example 2
l Input Tokens: \\DFSRepository\{Now(yyyy)}\{Now(MM)}\{DataFileName}_
success.{DataFileExtension}
Option Description
l Output: \\DFSRepository\2008\01\ThreatData_success.csv
Delete Deletes the source file when the data feed completes successfully.
This option is available only for File and FTP transport methods.
7. (Optional) In the Post-Processing - Local Copy section, determine how the data feed should
handle the local copy of the source data when the integration is complete. In the On Success
field, select one of the following options.
To perform post-processing on the source file retrieved, in the Post-Processing - Local Copy
section, determine how the data feed should handle the local copy of the source data when the
integration is complete. In the On Success field, select from the following options.
The following table describes the options.
Option Description
Nothing Does not alter the source file when the data feed successfully completes. If there is
a local copy of the source information, the local copy is deleted.
Option Description
Rename Saves the source file under a new name when the data feed successfully completes.
In Destination File, specify where the file should be saved and the new name for the
file.
To save the data, the path of the destination file must be accessible to the account
running the Job Engine service.
If you select this option, use filename tokens for specifying the location or name of
the file.
Filename tokens
Filename tokens are available for post processing when you want to save the source
information and specify a location or name for the file. When you select the Rename
option, you can use tokens to generate unique names automatically for the files.
Here are the usable tokens for renaming data files.
l Now. Insert a user-defined date format within the new filename. Possible formats
include Now(MM/dd/yyyy) or Now(MMM-dd-yyyy). See the Microsoft .Net
Framework Developer Center for available custom date/time formats.
l DataFileDirectoryName. Update the filename with the directory name, including
the drive, of your file.
l DataFileName. Insert the original filename, excluding the directory name and
extension.
l DataFileExtension. Insert the file extension, such as .csv, in the new filename.
l DataFileFullName. Insert the fully qualified filename. This data includes the
drive, directory, filename, and extension of the original file.
For example, if the data file came from the following location,
C:\DataFeed\Source\ESL\processed\ThreatData.csv, files that have been renamed
using tokens would have the following output.
Example 1
l Input Tokens: {DataFileDirectoryName}\success\{DataFileName}_{Now
(MM.dd.yyyy)}.{DataFileExtension}
l Output: C:\DataFeed\Source\ESL\processed\success\ThreatData_01.31.2008.csv
Example 2
Option Description
1. Go to the Navigation tab of the data feed that you want to modify.
Quote Specifies the character that is used to identify quotes in your source data.
Identifier
Escape Specifies the character that is used to escape from normal data into control data.
Sequence
Format Description
Record Specifies the control code that is used to identify a new record in your source data.
Delimiter
Skip Indicates the number of lines that the Data Feed Manager should ignore in the
Record source data before finding data. For example, if the first row in your source data
Count contains column names, you type "1" so that the Data Feed Manager ignores this
row and moves to the next row to start reading data.
Field Specifies the character that is used to identify a new field in your data source. If
Delimiter you select Other, type the character you want to use.
List Specifies the character that is used to identify a new list in your data source. If you
Delimiter select Other, type the character you want to use.
Leveled Specifies the character that is used to identify a new leveled list in your data
List source. If you select Other, type the character you want to use.
Delimiter
4. Click Apply.
1. Go to the Navigation tab of the data feed that you want to modify.
Note: You must load a transform. A default transform is included with the installation. If you
require additional data transformation, you can develop your own XSLT. For more information
on XML formatting guidelines and samples, see the appendix "XML Formatting Used in Field
Results and Input" in the RSA Archer Web Services API Reference Guide that you can
download from the RSA Archer Community.
The JSON Iterator is supported for the File, FTP, and HTTP transporters. JSON processing only
supports the Single Data file type.
Requirements
Examples
The following examples show that a source file can be either a valid JSON or JSON enclosed in
XML tags:
l Valid JSON
{"Assets": [ { "Asset": {"Name": "IP Phone","Description": "<my description>","Status":
"Active"}}, { "Asset": {"Name": "Laptop","Description": "My Laptop","Status": "Active"}}] }
l JSON enclosed in XML tags
<data> {"Assets": [ { "Asset": {"Name": "IP Phone","Description": "<my
description>","Status": "Active"}}, { "Asset": {"Name": "Laptop","Description": "My
Laptop","Status": "Active"}}] }</data>
1. Go to the Navigation tab of the data feed that you want to modify.
Note: JSON Iterator only supports the Single Data file type.
Data options
l Import the data “as is” into RSA Archer or execute modifications and calculations against the
data to convert the incoming data into a format that matches the requirements of the application or
questionnaire it is imported into. Use several advanced options, such as lookup translations and
calculations, to prepare and modify the data to meet your individual business needs.
l Filter data so that only what you want to receive is imported into the target application or
questionnaire. By not defining filters on the Data Filter tab, you instruct Data Feed Manager to
return all records in the data feed. Use operator logic to add filters to include only records
meeting certain criteria in the data feed process.
l Capture tokens of data from the last execution of a data feed that can be used during the next run
to identify which data to retrieve. On the Tokens tab, you can add, edit, or delete token values in
preparation of the next data feed execution.
1. Go to the Source Data tab of the data feed that you want to modify.
Important: Do not use this option for an Archer-to-Archer data feed. RSA recommends that you
filter the report data instead.
1. Go to the Data Filter tab of the data feed that you want to modify.
2. In the Sources column, select the source name to which you want to apply a filter.
3. From the Field Name list, select the field name from your data source to which you want to
apply a filter.
4. From the Operator list, select an operator to define which type of filter you want to apply to the
source data.
5. In the Values column, enter a value based on your selection in the Operator column.
6. (Optional) In the Advanced operator logic field, enter the custom operator logic to create custom
operator logic to form relationships between the individual filters.
7. Complete either of the following optional tasks:
l To add an additional data filter, click Add New Filter located in the Data Filter section title
bar.
l To remove a data filter, in the Actions column of the filter you want to remove, click .
8. Click Apply.
1. Go to the Tokens tab of the data feed that you want to modify.
1. Go to the Field Map tab of the data feed that you want to modify.
2. Map the source field to the applicable application or questionnaire. Do one of the following:
l Click Auto-Populate to map the source fields to application or questionnaire fields. This option
maps fields from the data source to application or questionnaire fields that have the same
name. Auto-populate occurs on level 1 fields only. Additionally, if there is an exact name
match between the source field and the target field, and the field type is one of the following,
the field is not auto-populated: External links, Values list, Sub-form, Related records, Cross
reference, or CAST.
l Drag each source field and drop it next to the application or questionnaire field in the Target
Fields section. For target fields that have a field type of cross-reference, sub-form, or related
records, map the fields expanded under these field types. You cannot directly map to a target
field with any of these field types.
Note: You can drag the left or right border to resize the Source Field column so that it can
display long source field names.
Note: You can enter a value from zero to 99, with zero being the highest trust level, and 99 the
lowest. A data feed cannot overwrite a previous feed that has a higher trust level. For example, a
data feed with a trust level of 75 cannot overwrite a data feed with a trust level of 20. By
default, this option is not available until Manual Trust is activated.
Note: For some out-of-the-box applications, you may see the following message if you try to
configure key fields for a data feed:
2. In the Reference Field section, select the field that requires a key field definition.
Note: The Reference Field section contains the target application or questionnaire and any
mapped cross-reference, related records, CAST, or sub-form fields that require the creation of a
key field definition.
3. In the Key Field Definitions title bar, click Add New Key.
Note: You can use the Key Field Definitions section to define the unique key identifiers and the
data feed actions during the feed execution.
4. In the Field Name field, select a target application or questionnaire field that uniquely identifies
the record.
5. (Optional) Assign compound unique identifiers for the record. Do the following:
l Click in the Actions column to add unique identifiers in a hierarchical structure for sub-
form field types.
Note: After setting the order of key fields, the Data Feed Manager scans the data source file
for matches to each unique identifier in the specified order. When any key field is found as a
match to a field in the target application, the record is considered matched.
7. From the Action list, select the applicable option for the matching criteria for the unique
identifier.
8. Click Apply.
2. In the Update Options section, select whether to create or update records in the target
application.
The following table describes the options.
Option Description
Create Create new records for data found in the source file and not in the target application
or questionnaire.
Update Updates records in the target application or questionnaire when a unique identifier
match exists in the source file. If you are also selecting the Archive Option of
Delete and want to retain existing records, make sure to select the Update option.
3. In the Archive Options section, select what happens when the matching record is not found in the
target application.
The following table describes the options.
Option Description
Delete Deletes records in the target application or questionnaire when a matching record is
not in the source data. If you want to retain existing records, also select the Update
option.
Records are matched by a unique identifier only during the update process. If you
want to retain existing records while archiving the target application, also select
Update in Update Options. If you do not select the Update option, all records in the
target application will be permanently deleted.
Set Sets a value in a Values List field in a record whenever the external data file does
Value not contain a matching record.
Use this option to set a Values List to a value that identifies this record as Inactive
or Not Current. For example, a Devices application with a record for a specific
laptop and the external data file does not have a matching record for that laptop. You
can use this option to set a Values List field in the laptop record to the value
Inactive.
When you select this option, you also select the Values List field in the target
application or questionnaire and the value that you want to set in that field.
You cannot set the value in the Values List field of the target leveled application
under the following conditions:
l Level 3 or lower in a leveled application.
l You are modifying the data feed configuration.
In most scenarios, RSA recommends selecting the Set Value option and flagging
these records with a specific value rather than deleting them. For example, you can
add a field to your application called Status and include the values Current and
Archived. If a data feed cannot find a matching record in the data source with a
system record, the system record could be updated to have a value of Archived for
the Status field.
4. Click Apply.
Important: When you configure an iDefense or DeepSight threat data feed, you need to set specific
parameters to connect the threat feed properly with your RSA Archer instance.
1. Go to the Schedule tab of the data feed that you want to modify.
2. Go to the Recurrences section and complete frequency, start and stop times, and time zone.
The following table describes the fields in the Recurrences section.
Field Description
Frequency Specifies the interval in which the data feed runs, for example, Minutely, Hourly,
Daily, Weekly, Monthly, or Reference.
l Minutely. Runs the data feed by the interval set.
For example, if you specify 45 in the Every list, the data feed executes every
45 minutes.
l Hourly. Runs the data feed by the interval set, for example, every hour (1),
every other hour (2) and so forth.
l Daily. Runs the data feed by the interval set, for example, every day (1), every
other day (2) and, so forth.
l Weekly. Runs the data feed based on a specified day of the week, for example,
every Monday of the first week (1), every other Monday (2), and so forth.
l Monthly. Runs the data feed based on a specified week of the month, for
example, 1st, 2nd, 3rd, 4th, or Last.
l Reference. Runs a specified data feed as runs before the current one. This
option indicates to the Data Feed Service that this data feed starts as soon as
the referenced data feed completes successfully.
For example, you can select to have a Threats data feed run immediately after
your Assets data feed finishes. From the Reference Feed list, select after
which existing data feed the current data feed starts.
A reference data feed will not run when immediately running a data feed. The
Run Data Feed Now option only runs the current data feed.
Every Specifies the interval of the frequency in which the data feed runs.
Start Date Specifies the date on which the data feed schedule begins.
Time Specifies the time zone in of the server that runs the data feed.
Zone
3. Click Save.
Transport Locates a specific data file. This file contains additional instructions for launching
Only subsequent, standard data feeds. With this data feed type, the data feed only
completes the Transport and Navigation activities. The Source Definition and Field
Mapping activities are not allowed. Processing of the data feed does not attempt to
process the data.
Important: If you intend to use the data feed as part of a convoy, or you are troubleshooting the
data being pulled, select the Transport Only option. This option enables you to use a transform to
manipulate the data being returned by bringing the source data in as a flat file and then configure
a subsequent XML-based feed that includes an XSLT file. For more information on XML
formatting guidelines and samples, see the appendix “XML Formatting Used in Field Results and
Input” in the RSA Archer Web Services API Reference Guide that you can download from the
RSA Archer Community.
l Create a new user account by selecting Other and entering the name of the new user account.
When you save your data feed settings, the Data Feed Manager automatically creates the new
user account.
7. In the Target Path field, enter the path where you want to store the output file of the Transport
Only data feed.
8. Click Apply.
1. Go to the Transport tab of the data feed that you want to modify.
Single References a single data file. This option requires you to specify a path in the Path
Data field. You can filter which files to process by entering a standard file expression in
File the File Filter field.
Manifest Points the Data Feed Manager to a file that contains instructions for locating a
File series of data files. This option requires you to specify a path in the Path field. You
can filter which files to process by entering a standard file expression in the File
Filter field.
Zip File References a .zip file. The .zip file can be a single, compressed data source file or
a collection of files. This option requires you to specify a path in the Path field. You
can filter which files from the .zip file to process by entering a standard file
expression in the File Filter field. Use the Encryption Type list to identify the
encrypted file type, if any. If the encrypted .zip file is password protected, enter the
password in the Password field.
No Proxy Indicates that the data feed does not pass through a proxy.
Use System Indicates that the Data Feed Service runs the feed with the proxy configuration
Proxy that is set up in the Control Panel.
Configure Indicates that the data feed must pass through a proxy. Continue with providing
Proxy the parameters for accessing the proxy.
User Specifies the name of the user who has credentials for logging on to the proxy
Name server.
6. (Optional) In the Post-Processing section, determine how the data feed should handle the source
information when the integration is complete. In the On Success field, select one of the following
options:
To perform post-processing on the source file retrieved, in the Post Processing section, determine
how the data feed should handle the local copy of the source data when the integration is
complete.
The following table describes the options.
Option Description
Nothing Does not alter the source file when the data feed successfully completes. If there is
a local copy of the source information, the local copy is deleted.
Option Description
Rename Saves the source file under a new name when the data feed successfully completes.
In Destination File, specify where the file should be saved and the new name for the
file.
If you select this option, use filename tokens for specifying the location or name of
the file.
Filename tokens
Filename tokens are available for post processing when you want to save the source
information and specify a location or name for the file. When you select the Rename
option, you can use tokens to generate unique names automatically for the files.
Here are the usable tokens for renaming data files.
l Now. Insert a user-defined date format within the new filename. Possible formats
include Now(MM/dd/yyyy) or Now(MMM-dd-yyyy). See the Microsoft .Net
Framework Developer Center for available custom date/time formats.
l DataFileDirectoryName. Update the filename with the directory name, including
the drive, of your file.
l DataFileName. Insert the original filename, excluding the directory name and
extension.
l DataFileExtension. Insert the file extension, such as .csv, in the new filename.
l DataFileFullName. Insert the fully qualified filename. This data includes the
drive, directory, filename, and extension of the original file.
For example, if the data file came from the following location,
C:\DataFeed\Source\ESL\processed\ThreatData.csv, files that have been renamed
using tokens would have the following output.
Example 1
l Input Tokens: {DataFileDirectoryName}\success\{DataFileName}_{Now
(MM.dd.yyyy)}.{DataFileExtension}
l Output: C:\DataFeed\Source\ESL\processed\success\ThreatData_01.31.2008.csv
Example 2
l Input Tokens: \\DFSRepository\{Now(yyyy)}\{Now(MM)}\{DataFileName}_
success.{DataFileExtension}
Option Description
l Output: \\DFSRepository\2008\01\ThreatData_success.csv
Delete Deletes the source file when the data feed completes successfully.
This option is available only for File and FTP transport methods.
7. (Optional) In the Post-Processing - Local Copy section, determine how the data feed should
handle the local copy of the source data when the integration is complete. In the On Success
field, select one of the following options.
To perform post-processing on the source file retrieved, in the Post-Processing - Local Copy
section, determine how the data feed should handle the local copy of the source data when the
integration is complete. In the On Success field, select from the following options.
The following table describes the options.
Option Description
Nothing Does not alter the source file when the data feed successfully completes. If there is
a local copy of the source information, the local copy is deleted.
Option Description
Rename Saves the source file under a new name when the data feed successfully completes.
In Destination File, specify where the file should be saved and the new name for the
file.
To save the data, the path of the destination file must be accessible to the account
running the Job Engine service.
If you select this option, use filename tokens for specifying the location or name of
the file.
Filename tokens
Filename tokens are available for post processing when you want to save the source
information and specify a location or name for the file. When you select the Rename
option, you can use tokens to generate unique names automatically for the files.
Here are the usable tokens for renaming data files.
l Now. Insert a user-defined date format within the new filename. Possible formats
include Now(MM/dd/yyyy) or Now(MMM-dd-yyyy). See the Microsoft .Net
Framework Developer Center for available custom date/time formats.
l DataFileDirectoryName. Update the filename with the directory name, including
the drive, of your file.
l DataFileName. Insert the original filename, excluding the directory name and
extension.
l DataFileExtension. Insert the file extension, such as .csv, in the new filename.
l DataFileFullName. Insert the fully qualified filename. This data includes the
drive, directory, filename, and extension of the original file.
For example, if the data file came from the following location,
C:\DataFeed\Source\ESL\processed\ThreatData.csv, files that have been renamed
using tokens would have the following output.
Example 1
l Input Tokens: {DataFileDirectoryName}\success\{DataFileName}_{Now
(MM.dd.yyyy)}.{DataFileExtension}
l Output: C:\DataFeed\Source\ESL\processed\success\ThreatData_01.31.2008.csv
Example 2
Option Description
Important: When you configure an iDefense or DeepSight threat data feed, you need to set specific
parameters to connect the threat feed properly with your RSA Archer instance.
1. Go to the Schedule tab of the data feed that you want to modify.
2. Go to the Recurrences section and complete frequency, start and stop times, and time zone.
The following table describes the fields in the Recurrences section.
Field Description
Frequency Specifies the interval in which the data feed runs, for example, Minutely, Hourly,
Daily, Weekly, Monthly, or Reference.
l Minutely. Runs the data feed by the interval set.
For example, if you specify 45 in the Every list, the data feed executes every
45 minutes.
l Hourly. Runs the data feed by the interval set, for example, every hour (1),
every other hour (2) and so forth.
l Daily. Runs the data feed by the interval set, for example, every day (1), every
other day (2) and, so forth.
l Weekly. Runs the data feed based on a specified day of the week, for example,
every Monday of the first week (1), every other Monday (2), and so forth.
l Monthly. Runs the data feed based on a specified week of the month, for
example, 1st, 2nd, 3rd, 4th, or Last.
l Reference. Runs a specified data feed as runs before the current one. This
option indicates to the Data Feed Service that this data feed starts as soon as
the referenced data feed completes successfully.
For example, you can select to have a Threats data feed run immediately after
your Assets data feed finishes. From the Reference Feed list, select after
which existing data feed the current data feed starts.
A reference data feed will not run when immediately running a data feed. The
Run Data Feed Now option only runs the current data feed.
Every Specifies the interval of the frequency in which the data feed runs.
Start Date Specifies the date on which the data feed schedule begins.
Time Specifies the time zone in of the server that runs the data feed.
Zone
3. Click Save.
HTTP Transporter
The HTTP Transporter allows a file from an external source with unknown contents and integrity to
be brought onto RSA Archer servers. This flexibility introduces a potential attack vector where the
associated risk must be accepted by the customer.
RSA recommends that you disable the HTTP Transporter if a business need does not require its use.
If you must use the HTTP Transporter, RSA recommends using HTTPS, selecting Zip File as the
File Type, and using encryption by selecting an Encryption Type.
An HTTP Transporter data feed can be configured as a standard or transport data feed type.
Important: When weak ciphers have been disabled, data access from an external HTTP or HTTPS
site may be impacted. If data is from an external HTTP or HTTPS site, you must be able to access
that external site from the server running the services for the data feed to execute successfully.
For more information about disabling weak ciphers, see Host Hardening.
Use the following tasks to add an HTTP data feed:
l Adding Standard HTTP data feeds
l Adding Transport Only HTTP data feeds
For more information, see "Data Feeds" in the RSA Archer Online Documentation.
Note: If you are completing a large data import, you may need to increase the Session Timeout
for the Archer Services Security Parameter from 30 minutes to 6 hours. Adjustments for the
Archer Services Security Parameter must be made in the instance database by running an SQL
command.
Send Select whether to have the data feed trigger notification emails when records
Notifications are published or updated. If notifications are not enabled in the selected target
application, no notification emails are sent when the data feed runs.
Send Job Select whether to have job status notifications sent to selected users or groups.
Status You can also select email addresses to receive job status notifications. If
Notifications selected, job status notifications are sent showing whether a job succeeded or
failed to run.
9. (Optional) In the Additional Properties section, specify a different locale for your source data,
whether to override the rules of saving a record defined in the application, and whether to delay
running calculations until the data feed completes.
Locale Specifies the country (language) format of your source data. Different cultures
or countries use different characters when formatting similar data.
Data Determines whether RSA Archer performs data validations against the selected
Validation target application when saving a record. Selecting this option bypasses
validation that is based on field definition and configuration (with some
exceptions). This option applies regardless of whether you are targeting a
questionnaire or application.
RSA Archer validates the following items regardless of whether this field is
selected:
l Attachment or image field - Validity of the file.
l Date/Time field - Minimum and maximum system values.
l Text field - Contains valid HTML.
l Field name - Uniqueness.
The required field settings are disregarded if you select to ignore the rules
defined within the target application. However, the unique selection cannot be
ignored.
Optimize Delays running calculations until the data feed completes and condenses
Calculations calculations for optimal processing. If this option is enabled, the optimized
calculation jobs run after the data feed completes. This improves the
performance of data feed processing and calculations.
Note: Condense jobs that are in the queue during an upgrade cause the jobs to
fail after the upgrade. Verify that there are no Condense jobs in the queue
before upgrading.
1. Go to the Transport tab of the data feed that you want to modify.
Single Data References a single data file. This option requires you to specify a path in the
File Path field. You can filter which files to process by entering a standard file
expression in the File Filter field.
Manifest Points the Data Feed Manager to a file that contains instructions for locating a
File series of data files. This option requires you to specify a path in the Path field.
You can filter which files to process by entering a standard file expression in the
File Filter field.
Zip File References a .zip file. The .zip file can be a single, compressed data source file
or a collection of files. This option requires you to specify a path in the Path
field. You can filter which files from the .zip file to process by entering a
standard file expression in the File Filter field. Use the Encryption Type list to
identify the encrypted file type, if any. If the encrypted .zip file is password
protected, enter the password in the Password field.
Get Uses the GET type of HTTP request. This type adds the parameters on the query
string.
Put Uses the POST type of HTTP request. This type includes the parameters as form
parameters on the request.
4. In the Logon Properties section, enter the applicable credentials for logging on to the HTTP site.
Use Specifies whether the HTTP site allows public access or restricts access to the
Credentials data.
l Anonymous. Allows public access to the data.
l Specific. Restricts access to the data. From the Specify Credentials options,
specify from which authorized account to make the HTTP request, and enter
the credentials for the appropriate account.
Specify Specifies the authorized account that makes the HTTP request.
Credentials l Data Feed Service
l Other (when you select this option, you must specify the user name, password,
and domain.)
User Specifies the user name for a separate account to make request to the HTTP site.
Name
Password Specifies the password for a separate account to make request to the HTTP site.
Domain Specifies the domain for a separate account to make request to the HTTP site.
Data Specifies the uniform resource identifier (URI) of the HTTP or HTTPS site that
Request contains the data you want to import. This field also allows you to specify a port,
URI for example, http://company-server:8080/httpFeed/.
Header Specifies the key/value pair that may be required as part of your Get or Put
Parameters operation in Header Parameters.
To add another header parameter, click Add New. To remove a header
parameter, click in the row of that header parameter.
6. (Optional) In the Proxy Options field, select the applicable proxy option.
No Proxy Indicates that the data feed does not pass through a proxy.
Use System Indicates that the Data Feed Service runs the feed with the proxy configuration
Proxy that is set up in the Control Panel.
Configure Indicates that the data feed must pass through a proxy. Continue with providing
Proxy the parameters for accessing the proxy.
User Specifies the name of the user who has credentials for logging on to the proxy
Name server.
8. (Optional) In the Post-Processing - Local Copy section, determine how the data feed should
handle the local copy of the source data when the integration is complete. In the On Success
field, select one of the following options.
The following table describes the options.
Option Description
Nothing Does not alter the source file when the data feed successfully completes. If there is
a local copy of the source information, the local copy is deleted.
Rename Saves the source file under a new name when the data feed successfully completes.
In Destination File, specify where the file should be saved and the new name for the
file. For information on using filename tokens when renaming files, see Filename
Tokens.
To save the data, the path of the destination file must be accessible to the account
running the Job Engine service.
1. Go to the Navigation tab of the data feed that you want to modify.
Quote Specifies the character that is used to identify quotes in your source data.
Identifier
Escape Specifies the character that is used to escape from normal data into control data.
Sequence
Record Specifies the control code that is used to identify a new record in your source data.
Delimiter
Skip Indicates the number of lines that the Data Feed Manager should ignore in the
Record source data before finding data. For example, if the first row in your source data
Count contains column names, you type "1" so that the Data Feed Manager ignores this
row and moves to the next row to start reading data.
Format Description
Field Specifies the character that is used to identify a new field in your data source. If
Delimiter you select Other, type the character you want to use.
List Specifies the character that is used to identify a new list in your data source. If you
Delimiter select Other, type the character you want to use.
Leveled Specifies the character that is used to identify a new leveled list in your data
List source. If you select Other, type the character you want to use.
Delimiter
4. Click Apply.
1. Go to the Navigation tab of the data feed that you want to modify.
Note: You must load a transform. A default transform is included with the installation. If you
require additional data transformation, you can develop your own XSLT. For more information
on XML formatting guidelines and samples, see the appendix "XML Formatting Used in Field
Results and Input" in the RSA Archer Web Services API Reference Guide that you can
download from the RSA Archer Community.
The JSON Iterator is supported for the File, FTP, and HTTP transporters. JSON processing only
supports the Single Data file type.
Requirements
Examples
The following examples show that a source file can be either a valid JSON or JSON enclosed in
XML tags:
l Valid JSON
{"Assets": [ { "Asset": {"Name": "IP Phone","Description": "<my description>","Status":
"Active"}}, { "Asset": {"Name": "Laptop","Description": "My Laptop","Status": "Active"}}] }
l JSON enclosed in XML tags
<data> {"Assets": [ { "Asset": {"Name": "IP Phone","Description": "<my
description>","Status": "Active"}}, { "Asset": {"Name": "Laptop","Description": "My
Laptop","Status": "Active"}}] }</data>
1. Go to the Navigation tab of the data feed that you want to modify.
Note: JSON Iterator only supports the Single Data file type.
1. Go to the Source Data tab of the data feed that you want to modify.
The source for the schema of your data feed depends on which transporter you are using. The
following table identifies and describes the schema sources that are available for each of the out-
of-the-box transporters.
Important: The process of loading a source definition for a data feed times out at five minutes.
You may want to consider using a smaller set of source data when you set up the feed.
Source Description
Sample Uses a skeleton of your actual source data file. For example, if you are importing
File data from a .csv file, the source data file is a .csv file that includes the column
names from your source data. If you are importing data from an .XML file, the
source data file includes the structure of your .XML without the actual field values.
When you select the sample file, the Source Fields section populates with the fields
specified in the sample data file.
For the Archer Web Services Transporter, select a file from an external location
that contains the data in a same format as the report format.
Load Loads the contents at the target URL and detects the source schema from the
URL contents.
Using this option may trigger actions associated with accessing the target URL.
4. In the first line in the Source Fields section, select the appropriate field option for the record
definition.
Note: For more information about configuring source fields in standard data feeds, see
Manipulating Data in the Source File of Standard Data Feeds.
5. In the Field type list for the remaining source fields, select the application option.
6. Click Apply.
Important: Do not use this option for an Archer-to-Archer data feed. RSA recommends that you
filter the report data instead.
1. Go to the Data Filter tab of the data feed that you want to modify.
2. In the Sources column, select the source name to which you want to apply a filter.
3. From the Field Name list, select the field name from your data source to which you want to
apply a filter.
4. From the Operator list, select an operator to define which type of filter you want to apply to the
source data.
5. In the Values column, enter a value based on your selection in the Operator column.
6. (Optional) In the Advanced operator logic field, enter the custom operator logic to create custom
operator logic to form relationships between the individual filters.
7. Complete either of the following optional tasks:
l To add an additional data filter, click Add New Filter located in the Data Filter section title
bar.
l To remove a data filter, in the Actions column of the filter you want to remove, click .
8. Click Apply.
1. Go to the Tokens tab of the data feed that you want to modify.
5. Click Apply.
1. Go to the Field Map tab of the data feed that you want to modify.
2. Map the source field to the applicable application or questionnaire. Do one of the following:
l Click Auto-Populate to map the source fields to application or questionnaire fields. This option
maps fields from the data source to application or questionnaire fields that have the same
name. Auto-populate occurs on level 1 fields only. Additionally, if there is an exact name
match between the source field and the target field, and the field type is one of the following,
the field is not auto-populated: External links, Values list, Sub-form, Related records, Cross
reference, or CAST.
l Drag each source field and drop it next to the application or questionnaire field in the Target
Fields section. For target fields that have a field type of cross-reference, sub-form, or related
records, map the fields expanded under these field types. You cannot directly map to a target
field with any of these field types.
Note: You can drag the left or right border to resize the Source Field column so that it can
display long source field names.
Note: You can enter a value from zero to 99, with zero being the highest trust level, and 99 the
lowest. A data feed cannot overwrite a previous feed that has a higher trust level. For example, a
data feed with a trust level of 75 cannot overwrite a data feed with a trust level of 20. By
default, this option is not available until Manual Trust is activated.
Note: For some out-of-the-box applications, you may see the following message if you try to
configure key fields for a data feed:
2. In the Reference Field section, select the field that requires a key field definition.
Note: The Reference Field section contains the target application or questionnaire and any
mapped cross-reference, related records, CAST, or sub-form fields that require the creation of a
key field definition.
3. In the Key Field Definitions title bar, click Add New Key.
Note: You can use the Key Field Definitions section to define the unique key identifiers and the
data feed actions during the feed execution.
4. In the Field Name field, select a target application or questionnaire field that uniquely identifies
the record.
5. (Optional) Assign compound unique identifiers for the record. Do the following:
l Click in the Actions column to add unique identifiers in a hierarchical structure for sub-
form field types.
Note: After setting the order of key fields, the Data Feed Manager scans the data source file
for matches to each unique identifier in the specified order. When any key field is found as a
match to a field in the target application, the record is considered matched.
7. From the Action list, select the applicable option for the matching criteria for the unique
identifier.
8. Click Apply.
2. In the Update Options section, select whether to create or update records in the target
application.
The following table describes the options.
Option Description
Create Create new records for data found in the source file and not in the target application
or questionnaire.
Update Updates records in the target application or questionnaire when a unique identifier
match exists in the source file. If you are also selecting the Archive Option of
Delete and want to retain existing records, make sure to select the Update option.
3. In the Archive Options section, select what happens when the matching record is not found in the
target application.
The following table describes the options.
Option Description
Delete Deletes records in the target application or questionnaire when a matching record is
not in the source data. If you want to retain existing records, also select the Update
option.
Records are matched by a unique identifier only during the update process. If you
want to retain existing records while archiving the target application, also select
Update in Update Options. If you do not select the Update option, all records in the
target application will be permanently deleted.
Option Description
Set Sets a value in a Values List field in a record whenever the external data file does
Value not contain a matching record.
Use this option to set a Values List to a value that identifies this record as Inactive
or Not Current. For example, a Devices application with a record for a specific
laptop and the external data file does not have a matching record for that laptop. You
can use this option to set a Values List field in the laptop record to the value
Inactive.
When you select this option, you also select the Values List field in the target
application or questionnaire and the value that you want to set in that field.
You cannot set the value in the Values List field of the target leveled application
under the following conditions:
l Level 3 or lower in a leveled application.
l You are modifying the data feed configuration.
In most scenarios, RSA recommends selecting the Set Value option and flagging
these records with a specific value rather than deleting them. For example, you can
add a field to your application called Status and include the values Current and
Archived. If a data feed cannot find a matching record in the data source with a
system record, the system record could be updated to have a value of Archived for
the Status field.
4. Click Apply.
Important: When you configure an iDefense or DeepSight threat data feed, you need to set specific
parameters to connect the threat feed properly with your RSA Archer instance.
1. Go to the Schedule tab of the data feed that you want to modify.
2. Go to the Recurrences section and complete frequency, start and stop times, and time zone.
The following table describes the fields in the Recurrences section.
Field Description
Frequency Specifies the interval in which the data feed runs, for example, Minutely, Hourly,
Daily, Weekly, Monthly, or Reference.
l Minutely. Runs the data feed by the interval set.
For example, if you specify 45 in the Every list, the data feed executes every
45 minutes.
l Hourly. Runs the data feed by the interval set, for example, every hour (1),
every other hour (2) and so forth.
l Daily. Runs the data feed by the interval set, for example, every day (1), every
other day (2) and, so forth.
l Weekly. Runs the data feed based on a specified day of the week, for example,
every Monday of the first week (1), every other Monday (2), and so forth.
l Monthly. Runs the data feed based on a specified week of the month, for
example, 1st, 2nd, 3rd, 4th, or Last.
l Reference. Runs a specified data feed as runs before the current one. This
option indicates to the Data Feed Service that this data feed starts as soon as
the referenced data feed completes successfully.
For example, you can select to have a Threats data feed run immediately after
your Assets data feed finishes. From the Reference Feed list, select after
which existing data feed the current data feed starts.
A reference data feed will not run when immediately running a data feed. The
Run Data Feed Now option only runs the current data feed.
Every Specifies the interval of the frequency in which the data feed runs.
Field Description
Start Date Specifies the date on which the data feed schedule begins.
Time Specifies the time zone in of the server that runs the data feed.
Zone
3. Click Save.
Transport Locates a specific data file. This file contains additional instructions for launching
Only subsequent, standard data feeds. With this data feed type, the data feed only
completes the Transport and Navigation activities. The Source Definition and Field
Mapping activities are not allowed. Processing of the data feed does not attempt to
process the data.
Important: If you intend to use the data feed as part of a convoy, or you are troubleshooting the
data being pulled, select the Transport Only option. This option enables you to use a transform to
manipulate the data being returned by bringing the source data in as a flat file and then configure
a subsequent XML-based feed that includes an XSLT file. For more information on XML
formatting guidelines and samples, see the appendix “XML Formatting Used in Field Results and
Input” in the RSA Archer Web Services API Reference Guide that you can download from the
RSA Archer Community.
1. Go to the Transport tab of the data feed that you want to modify.
Single Data References a single data file. This option requires you to specify a path in the
File Path field. You can filter which files to process by entering a standard file
expression in the File Filter field.
Available
Description
selections
Manifest Points the Data Feed Manager to a file that contains instructions for locating a
File series of data files. This option requires you to specify a path in the Path field.
You can filter which files to process by entering a standard file expression in the
File Filter field.
Zip File References a .zip file. The .zip file can be a single, compressed data source file
or a collection of files. This option requires you to specify a path in the Path
field. You can filter which files from the .zip file to process by entering a
standard file expression in the File Filter field. Use the Encryption Type list to
identify the encrypted file type, if any. If the encrypted .zip file is password
protected, enter the password in the Password field.
Get Uses the GET type of HTTP request. This type adds the parameters on the query
string.
Put Uses the POST type of HTTP request. This type includes the parameters as form
parameters on the request.
4. In the Logon Properties section, enter the applicable credentials for logging on to the HTTP site.
The following table describes the options.
Option Description
Use Specifies whether the HTTP site allows public access or restricts access to the
Credentials data.
l Anonymous. Allows public access to the data.
l Specific. Restricts access to the data. From the Specify Credentials options,
specify from which authorized account to make the HTTP request, and enter
the credentials for the appropriate account.
Specify Specifies the authorized account that makes the HTTP request.
Credentials l Data Feed Service
l Other (when you select this option, you must specify the user name, password,
and domain.)
User Specifies the user name for a separate account to make request to the HTTP site.
Name
Option Description
Password Specifies the password for a separate account to make request to the HTTP site.
Domain Specifies the domain for a separate account to make request to the HTTP site.
Data Specifies the uniform resource identifier (URI) of the HTTP or HTTPS site that
Request contains the data you want to import. This field also allows you to specify a port,
URI for example, http://company-server:8080/httpFeed/.
Header Specifies the key/value pair that may be required as part of your Get or Put
Parameters operation in Header Parameters.
To add another header parameter, click Add New. To remove a header
parameter, click in the row of that header parameter.
6. (Optional) In the Proxy Options field, select the applicable proxy option.
The following table describes the options.
Option Description
No Proxy Indicates that the data feed does not pass through a proxy.
Use System Indicates that the Data Feed Service runs the feed with the proxy configuration
Proxy that is set up in the Control Panel.
Configure Indicates that the data feed must pass through a proxy. Continue with providing
Proxy the parameters for accessing the proxy.
Field Description
User Specifies the name of the user who has credentials for logging on to the proxy
Name server.
8. (Optional) In the Post-Processing - Local Copy section, determine how the data feed should
handle the local copy of the source data when the integration is complete. In the On Success
field, select one of the following options.
The following table describes the options.
Option Description
Nothing Does not alter the source file when the data feed successfully completes. If there is
a local copy of the source information, the local copy is deleted.
Rename Saves the source file under a new name when the data feed successfully completes.
In Destination File, specify where the file should be saved and the new name for the
file. For information on using filename tokens when renaming files, see Filename
Tokens.
To save the data, the path of the destination file must be accessible to the account
running the Job Engine service.
A reference feed allows you to specify another feed. This indicates to the Data Feed Service that
this feed will start executed as soon as the referenced feed completes successfully.
Important: When you configure an iDefense or DeepSight threat data feed, you need to set specific
parameters to connect the threat feed properly with your RSA Archer instance.
1. Go to the Schedule tab of the data feed that you want to modify.
2. Go to the Recurrences section and complete frequency, start and stop times, and time zone.
The following table describes the fields in the Recurrences section.
Field Description
Frequency Specifies the interval in which the data feed runs, for example, Minutely, Hourly,
Daily, Weekly, Monthly, or Reference.
l Minutely. Runs the data feed by the interval set.
For example, if you specify 45 in the Every list, the data feed executes every
45 minutes.
l Hourly. Runs the data feed by the interval set, for example, every hour (1),
every other hour (2) and so forth.
l Daily. Runs the data feed by the interval set, for example, every day (1), every
other day (2) and, so forth.
l Weekly. Runs the data feed based on a specified day of the week, for example,
every Monday of the first week (1), every other Monday (2), and so forth.
l Monthly. Runs the data feed based on a specified week of the month, for
example, 1st, 2nd, 3rd, 4th, or Last.
l Reference. Runs a specified data feed as runs before the current one. This
option indicates to the Data Feed Service that this data feed starts as soon as
the referenced data feed completes successfully.
For example, you can select to have a Threats data feed run immediately after
your Assets data feed finishes. From the Reference Feed list, select after
which existing data feed the current data feed starts.
A reference data feed will not run when immediately running a data feed. The
Run Data Feed Now option only runs the current data feed.
Every Specifies the interval of the frequency in which the data feed runs.
Start Date Specifies the date on which the data feed schedule begins.
Time Specifies the time zone in of the server that runs the data feed.
Zone
3. Click Save.
JavaScript Transporter
The JavaScript Transporter can be used to push data from RSA Archer to somewhere else, or it can
manipulate data in an external system. To do so, return an empty data set to RSA Archer.
Note: RSA Support is not responsible for data interaction with third party resources.
A JavaScript Transporter data feed can be configured as a standard or transport only data feed type.
Important: Before you can run a JavaScript Data Feed, ensure that your JavaScript Transport
Settings in the RSA Archer Control Panel have been set. For more information, see "Configuring
JavaScript Transporter Settings" in the RSA Archer Control Panel Help.
For more information, see "Data Feeds" in the RSA Archer Online Documentation.
5. From the Target list in the Feed Information section, select the application or questionnaire that
will receive the data from the external data source. If the application is leveled, select the level.
6. From the User Name list, do one of the following:
l Select the appropriate user account that is associated with the data feed.
l Create a new user account by selecting Other and entering the name of the new user account.
Note: If you are completing a large data import, you may need to increase the Session Timeout
for the Archer Services Security Parameter from 30 minutes to 6 hours. Adjustments for the
Archer Services Security Parameter must be made in the instance database by running an SQL
command.
Send Select whether to have the data feed trigger notification emails when records
Notifications are published or updated. If notifications are not enabled in the selected target
application, no notification emails are sent when the data feed runs.
Send Job Select whether to have job status notifications sent to selected users or groups.
Status You can also select email addresses to receive job status notifications. If
Notifications selected, job status notifications are sent showing whether a job succeeded or
failed to run.
9. (Optional) In the Additional Properties section, specify a different locale for your source data,
whether to override the rules of saving a record defined in the application, and whether to delay
running calculations until the data feed completes.
The following table describes the options.
Option Description
Locale Specifies the country (language) format of your source data. Different cultures
or countries use different characters when formatting similar data.
Option Description
Data Determines whether RSA Archer performs data validations against the selected
Validation target application when saving a record. Selecting this option bypasses
validation that is based on field definition and configuration (with some
exceptions). This option applies regardless of whether you are targeting a
questionnaire or application.
RSA Archer validates the following items regardless of whether this field is
selected:
l Attachment or image field - Validity of the file.
l Date/Time field - Minimum and maximum system values.
l Text field - Contains valid HTML.
l Field name - Uniqueness.
The required field settings are disregarded if you select to ignore the rules
defined within the target application. However, the unique selection cannot be
ignored.
Optimize Delays running calculations until the data feed completes and condenses
Calculations calculations for optimal processing. If this option is enabled, the optimized
calculation jobs run after the data feed completes. This improves the
performance of data feed processing and calculations.
Note: Condense jobs that are in the queue during an upgrade cause the jobs to
fail after the upgrade. Verify that there are no Condense jobs in the queue
before upgrading.
1. Go to the Transport tab of the data feed that you want to modify.
3. In the Transport Configuration section, select the JavaScript file you want to upload.
a. From the Transport Configuration section, click Upload.
b. In the Upload JavaScript File dialog, click Add New.
c. Navigate to and select the file you want to upload, and click Open.
d. In the Upload JavaScript File dialog, click OK.
Important: If the JavaScript Transporter has been set up in the RSA Archer Control Panel to
only allowed digitally signed JavaScript files from trusted sources, only digitally signed
JavaScript files coming from trusted sources can be selected.
Note: RSA Archer provides a JavaScript sample in the Transport Configuration section,
describing each part of the script, and how to configure each part for your environment.
4. (Optional) In the Custom Parameters section, enter the custom parameters you want to reference
within the selected JavaScript file.
a. In the Customer Parameters section, click Add New.
b. In the Key field, enter the variable name you want to use.
c. In the Type field, select Plain Text or Protected.
Note: Protected mode encrypts the value in the database and masks it in the UI. RSA
recommends using the Protected type for sensitive information.
d. In the Value field, enter the value you want to assign to the key.
e. If you want to add more customer parameters, repeat steps a - d.
5. (Optional) In the Post-Processing - Local Copy section, determine how the data feed should
handle the local copy of the source data when the integration is complete. In the On Success
field, select one of the following options.
To perform post-processing on the source file retrieved, in the Post-Processing - Local Copy
section, determine how the data feed should handle the local copy of the source data when the
integration is complete. In the On Success field, select from the following options.
The following table describes the options.
Option Description
Nothing Does not alter the source file when the data feed successfully completes. If there is
a local copy of the source information, the local copy is deleted.
Option Description
Rename Saves the source file under a new name when the data feed successfully completes.
In Destination File, specify where the file should be saved and the new name for the
file.
To save the data, the path of the destination file must be accessible to the account
running the Job Engine service.
If you select this option, use filename tokens for specifying the location or name of
the file.
Filename tokens
Filename tokens are available for post processing when you want to save the source
information and specify a location or name for the file. When you select the Rename
option, you can use tokens to generate unique names automatically for the files.
Here are the usable tokens for renaming data files.
l Now. Insert a user-defined date format within the new filename. Possible formats
include Now(MM/dd/yyyy) or Now(MMM-dd-yyyy). See the Microsoft .Net
Framework Developer Center for available custom date/time formats.
l DataFileDirectoryName. Update the filename with the directory name, including
the drive, of your file.
l DataFileName. Insert the original filename, excluding the directory name and
extension.
l DataFileExtension. Insert the file extension, such as .csv, in the new filename.
l DataFileFullName. Insert the fully qualified filename. This data includes the
drive, directory, filename, and extension of the original file.
For example, if the data file came from the following location,
C:\DataFeed\Source\ESL\processed\ThreatData.csv, files that have been renamed
using tokens would have the following output.
Example 1
l Input Tokens: {DataFileDirectoryName}\success\{DataFileName}_{Now
(MM.dd.yyyy)}.{DataFileExtension}
l Output: C:\DataFeed\Source\ESL\processed\success\ThreatData_01.31.2008.csv
Example 2
Option Description
1. Go to the Navigation tab of the data feed that you want to modify.
Quote Specifies the character that is used to identify quotes in your source data.
Identifier
Escape Specifies the character that is used to escape from normal data into control data.
Sequence
Format Description
Record Specifies the control code that is used to identify a new record in your source data.
Delimiter
Skip Indicates the number of lines that the Data Feed Manager should ignore in the
Record source data before finding data. For example, if the first row in your source data
Count contains column names, you type "1" so that the Data Feed Manager ignores this
row and moves to the next row to start reading data.
Field Specifies the character that is used to identify a new field in your data source. If
Delimiter you select Other, type the character you want to use.
List Specifies the character that is used to identify a new list in your data source. If you
Delimiter select Other, type the character you want to use.
Leveled Specifies the character that is used to identify a new leveled list in your data
List source. If you select Other, type the character you want to use.
Delimiter
4. Click Apply.
1. Go to the Navigation tab of the data feed that you want to modify.
Note: You must load a transform. A default transform is included with the installation. If you
require additional data transformation, you can develop your own XSLT. For more information
on XML formatting guidelines and samples, see the appendix "XML Formatting Used in Field
Results and Input" in the RSA Archer Web Services API Reference Guide that you can
download from the RSA Archer Community.
The JSON Iterator is supported for the File, FTP, and HTTP transporters. JSON processing only
supports the Single Data file type.
Requirements
Examples
The following examples show that a source file can be either a valid JSON or JSON enclosed in
XML tags:
l Valid JSON
{"Assets": [ { "Asset": {"Name": "IP Phone","Description": "<my description>","Status":
"Active"}}, { "Asset": {"Name": "Laptop","Description": "My Laptop","Status": "Active"}}] }
l JSON enclosed in XML tags
<data> {"Assets": [ { "Asset": {"Name": "IP Phone","Description": "<my
description>","Status": "Active"}}, { "Asset": {"Name": "Laptop","Description": "My
Laptop","Status": "Active"}}] }</data>
1. Go to the Navigation tab of the data feed that you want to modify.
Note: JSON Iterator only supports the Single Data file type.
Data options
l Import the data “as is” into RSA Archer or execute modifications and calculations against the
data to convert the incoming data into a format that matches the requirements of the application or
questionnaire it is imported into. Use several advanced options, such as lookup translations and
calculations, to prepare and modify the data to meet your individual business needs.
l Filter data so that only what you want to receive is imported into the target application or
questionnaire. By not defining filters on the Data Filter tab, you instruct Data Feed Manager to
return all records in the data feed. Use operator logic to add filters to include only records
meeting certain criteria in the data feed process.
l Capture tokens of data from the last execution of a data feed that can be used during the next run
to identify which data to retrieve. On the Tokens tab, you can add, edit, or delete token values in
preparation of the next data feed execution.
1. Go to the Source Data tab of the data feed that you want to modify.
Important: Do not use this option for an Archer-to-Archer data feed. RSA recommends that you
filter the report data instead.
1. Go to the Data Filter tab of the data feed that you want to modify.
2. In the Sources column, select the source name to which you want to apply a filter.
3. From the Field Name list, select the field name from your data source to which you want to
apply a filter.
4. From the Operator list, select an operator to define which type of filter you want to apply to the
source data.
5. In the Values column, enter a value based on your selection in the Operator column.
6. (Optional) In the Advanced operator logic field, enter the custom operator logic to create custom
operator logic to form relationships between the individual filters.
7. Complete either of the following optional tasks:
l To add an additional data filter, click Add New Filter located in the Data Filter section title
bar.
l To remove a data filter, in the Actions column of the filter you want to remove, click .
8. Click Apply.
1. Go to the Tokens tab of the data feed that you want to modify.
1. Go to the Field Map tab of the data feed that you want to modify.
2. Map the source field to the applicable application or questionnaire. Do one of the following:
l Click Auto-Populate to map the source fields to application or questionnaire fields. This option
maps fields from the data source to application or questionnaire fields that have the same
name. Auto-populate occurs on level 1 fields only. Additionally, if there is an exact name
match between the source field and the target field, and the field type is one of the following,
the field is not auto-populated: External links, Values list, Sub-form, Related records, Cross
reference, or CAST.
l Drag each source field and drop it next to the application or questionnaire field in the Target
Fields section. For target fields that have a field type of cross-reference, sub-form, or related
records, map the fields expanded under these field types. You cannot directly map to a target
field with any of these field types.
Note: You can drag the left or right border to resize the Source Field column so that it can
display long source field names.
Note: You can enter a value from zero to 99, with zero being the highest trust level, and 99 the
lowest. A data feed cannot overwrite a previous feed that has a higher trust level. For example, a
data feed with a trust level of 75 cannot overwrite a data feed with a trust level of 20. By
default, this option is not available until Manual Trust is activated.
Note: For some out-of-the-box applications, you may see the following message if you try to
configure key fields for a data feed:
2. In the Reference Field section, select the field that requires a key field definition.
Note: The Reference Field section contains the target application or questionnaire and any
mapped cross-reference, related records, CAST, or sub-form fields that require the creation of a
key field definition.
3. In the Key Field Definitions title bar, click Add New Key.
Note: You can use the Key Field Definitions section to define the unique key identifiers and the
data feed actions during the feed execution.
4. In the Field Name field, select a target application or questionnaire field that uniquely identifies
the record.
5. (Optional) Assign compound unique identifiers for the record. Do the following:
l Click in the Actions column to add unique identifiers in a hierarchical structure for sub-
form field types.
Note: After setting the order of key fields, the Data Feed Manager scans the data source file
for matches to each unique identifier in the specified order. When any key field is found as a
match to a field in the target application, the record is considered matched.
7. From the Action list, select the applicable option for the matching criteria for the unique
identifier.
8. Click Apply.
2. In the Update Options section, select whether to create or update records in the target
application.
The following table describes the options.
Option Description
Create Create new records for data found in the source file and not in the target application
or questionnaire.
Update Updates records in the target application or questionnaire when a unique identifier
match exists in the source file. If you are also selecting the Archive Option of
Delete and want to retain existing records, make sure to select the Update option.
3. In the Archive Options section, select what happens when the matching record is not found in the
target application.
The following table describes the options.
Option Description
Delete Deletes records in the target application or questionnaire when a matching record is
not in the source data. If you want to retain existing records, also select the Update
option.
Records are matched by a unique identifier only during the update process. If you
want to retain existing records while archiving the target application, also select
Update in Update Options. If you do not select the Update option, all records in the
target application will be permanently deleted.
Set Sets a value in a Values List field in a record whenever the external data file does
Value not contain a matching record.
Use this option to set a Values List to a value that identifies this record as Inactive
or Not Current. For example, a Devices application with a record for a specific
laptop and the external data file does not have a matching record for that laptop. You
can use this option to set a Values List field in the laptop record to the value
Inactive.
When you select this option, you also select the Values List field in the target
application or questionnaire and the value that you want to set in that field.
You cannot set the value in the Values List field of the target leveled application
under the following conditions:
l Level 3 or lower in a leveled application.
l You are modifying the data feed configuration.
In most scenarios, RSA recommends selecting the Set Value option and flagging
these records with a specific value rather than deleting them. For example, you can
add a field to your application called Status and include the values Current and
Archived. If a data feed cannot find a matching record in the data source with a
system record, the system record could be updated to have a value of Archived for
the Status field.
4. Click Apply.
Important: When you configure an iDefense or DeepSight threat data feed, you need to set specific
parameters to connect the threat feed properly with your RSA Archer instance.
1. Go to the Schedule tab of the data feed that you want to modify.
2. Go to the Recurrences section and complete frequency, start and stop times, and time zone.
The following table describes the fields in the Recurrences section.
Field Description
Frequency Specifies the interval in which the data feed runs, for example, Minutely, Hourly,
Daily, Weekly, Monthly, or Reference.
l Minutely. Runs the data feed by the interval set.
For example, if you specify 45 in the Every list, the data feed executes every
45 minutes.
l Hourly. Runs the data feed by the interval set, for example, every hour (1),
every other hour (2) and so forth.
l Daily. Runs the data feed by the interval set, for example, every day (1), every
other day (2) and, so forth.
l Weekly. Runs the data feed based on a specified day of the week, for example,
every Monday of the first week (1), every other Monday (2), and so forth.
l Monthly. Runs the data feed based on a specified week of the month, for
example, 1st, 2nd, 3rd, 4th, or Last.
l Reference. Runs a specified data feed as runs before the current one. This
option indicates to the Data Feed Service that this data feed starts as soon as
the referenced data feed completes successfully.
For example, you can select to have a Threats data feed run immediately after
your Assets data feed finishes. From the Reference Feed list, select after
which existing data feed the current data feed starts.
A reference data feed will not run when immediately running a data feed. The
Run Data Feed Now option only runs the current data feed.
Every Specifies the interval of the frequency in which the data feed runs.
Start Date Specifies the date on which the data feed schedule begins.
Time Specifies the time zone in of the server that runs the data feed.
Zone
3. Click Save.
Transport Locates a specific data file. This file contains additional instructions for launching
Only subsequent, standard data feeds. With this data feed type, the data feed only
completes the Transport and Navigation activities. The Source Definition and Field
Mapping activities are not allowed. Processing of the data feed does not attempt to
process the data.
Important: If you intend to use the data feed as part of a convoy, or you are troubleshooting the
data being pulled, select the Transport Only option. This option enables you to use a transform to
manipulate the data being returned by bringing the source data in as a flat file and then configure
a subsequent XML-based feed that includes an XSLT file. For more information on XML
formatting guidelines and samples, see the appendix “XML Formatting Used in Field Results and
Input” in the RSA Archer Web Services API Reference Guide that you can download from the
RSA Archer Community.
l Create a new user account by selecting Other and entering the name of the new user account.
When you save your data feed settings, the Data Feed Manager automatically creates the new
user account.
7. In the Target Path field, enter the path where you want to store the output file of the Transport
Only data feed.
8. Click Apply.
1. Go to the Transport tab of the data feed that you want to modify.
Important: If the JavaScript Transporter has been set up in the RSA Archer Control Panel to
only allowed digitally signed JavaScript files from trusted sources, only digitally signed
JavaScript files coming from trusted sources can be selected.
Note: RSA Archer provides a JavaScript sample in the Transport Configuration section,
describing each part of the script, and how to configure each part for your environment.
4. (Optional) In the Custom Parameters section, enter the custom parameters you want to reference
within the selected JavaScript file.
a. In the Customer Parameters section, click Add New.
b. In the Key field, enter the variable name you want to use.
Note: Protected mode encrypts the value in the database and masks it in the UI. RSA
recommends using the Protected type for sensitive information.
d. In the Value field, enter the value you want to assign to the key.
e. If you want to add more customer parameters, repeat steps a - d.
5. (Optional) In the Post-Processing - Local Copy section, determine how the data feed should
handle the local copy of the source data when the integration is complete. In the On Success
field, select one of the following options.
To perform post-processing on the source file retrieved, in the Post-Processing - Local Copy
section, determine how the data feed should handle the local copy of the source data when the
integration is complete. In the On Success field, select from the following options.
The following table describes the options.
Option Description
Nothing Does not alter the source file when the data feed successfully completes. If there is
a local copy of the source information, the local copy is deleted.
Option Description
Rename Saves the source file under a new name when the data feed successfully completes.
In Destination File, specify where the file should be saved and the new name for the
file.
To save the data, the path of the destination file must be accessible to the account
running the Job Engine service.
If you select this option, use filename tokens for specifying the location or name of
the file.
Filename tokens
Filename tokens are available for post processing when you want to save the source
information and specify a location or name for the file. When you select the Rename
option, you can use tokens to generate unique names automatically for the files.
Here are the usable tokens for renaming data files.
l Now. Insert a user-defined date format within the new filename. Possible formats
include Now(MM/dd/yyyy) or Now(MMM-dd-yyyy). See the Microsoft .Net
Framework Developer Center for available custom date/time formats.
l DataFileDirectoryName. Update the filename with the directory name, including
the drive, of your file.
l DataFileName. Insert the original filename, excluding the directory name and
extension.
l DataFileExtension. Insert the file extension, such as .csv, in the new filename.
l DataFileFullName. Insert the fully qualified filename. This data includes the
drive, directory, filename, and extension of the original file.
For example, if the data file came from the following location,
C:\DataFeed\Source\ESL\processed\ThreatData.csv, files that have been renamed
using tokens would have the following output.
Example 1
l Input Tokens: {DataFileDirectoryName}\success\{DataFileName}_{Now
(MM.dd.yyyy)}.{DataFileExtension}
l Output: C:\DataFeed\Source\ESL\processed\success\ThreatData_01.31.2008.csv
Example 2
Option Description
Important: When you configure an iDefense or DeepSight threat data feed, you need to set specific
parameters to connect the threat feed properly with your RSA Archer instance.
1. Go to the Schedule tab of the data feed that you want to modify.
2. Go to the Recurrences section and complete frequency, start and stop times, and time zone.
The following table describes the fields in the Recurrences section.
Field Description
Frequency Specifies the interval in which the data feed runs, for example, Minutely, Hourly,
Daily, Weekly, Monthly, or Reference.
l Minutely. Runs the data feed by the interval set.
For example, if you specify 45 in the Every list, the data feed executes every
45 minutes.
l Hourly. Runs the data feed by the interval set, for example, every hour (1),
every other hour (2) and so forth.
l Daily. Runs the data feed by the interval set, for example, every day (1), every
other day (2) and, so forth.
l Weekly. Runs the data feed based on a specified day of the week, for example,
every Monday of the first week (1), every other Monday (2), and so forth.
l Monthly. Runs the data feed based on a specified week of the month, for
example, 1st, 2nd, 3rd, 4th, or Last.
l Reference. Runs a specified data feed as runs before the current one. This
option indicates to the Data Feed Service that this data feed starts as soon as
the referenced data feed completes successfully.
For example, you can select to have a Threats data feed run immediately after
your Assets data feed finishes. From the Reference Feed list, select after
which existing data feed the current data feed starts.
A reference data feed will not run when immediately running a data feed. The
Run Data Feed Now option only runs the current data feed.
Every Specifies the interval of the frequency in which the data feed runs.
Start Date Specifies the date on which the data feed schedule begins.
Time Specifies the time zone in of the server that runs the data feed.
Zone
3. Click Save.
Note: RSA recommends that you configure an SSL connection to connect with the email server.
Important: For the data feed to execute successfully, the server responsible for running the data
feed must have a service account with valid logon credentials.
For more information, see "Data Feeds" in the RSA Archer Online Documentation.
5. From the Target list in the Feed Information section, select the application or questionnaire that
will receive the data from the external data source. If the application is leveled, select the level.
6. From the User Name list, do one of the following:
l Select the appropriate user account that is associated with the data feed.
l Create a new user account by selecting Other and entering the name of the new user account.
Note: If you are completing a large data import, you may need to increase the Session Timeout
for the Archer Services Security Parameter from 30 minutes to 6 hours. Adjustments for the
Archer Services Security Parameter must be made in the instance database by running an SQL
command.
Send Select whether to have the data feed trigger notification emails when records
Notifications are published or updated. If notifications are not enabled in the selected target
application, no notification emails are sent when the data feed runs.
Send Job Select whether to have job status notifications sent to selected users or groups.
Status You can also select email addresses to receive job status notifications. If
Notifications selected, job status notifications are sent showing whether a job succeeded or
failed to run.
9. (Optional) In the Additional Properties section, specify a different locale for your source data,
whether to override the rules of saving a record defined in the application, and whether to delay
running calculations until the data feed completes.
The following table describes the options.
Option Description
Locale Specifies the country (language) format of your source data. Different cultures
or countries use different characters when formatting similar data.
Option Description
Data Determines whether RSA Archer performs data validations against the selected
Validation target application when saving a record. Selecting this option bypasses
validation that is based on field definition and configuration (with some
exceptions). This option applies regardless of whether you are targeting a
questionnaire or application.
RSA Archer validates the following items regardless of whether this field is
selected:
l Attachment or image field - Validity of the file.
l Date/Time field - Minimum and maximum system values.
l Text field - Contains valid HTML.
l Field name - Uniqueness.
The required field settings are disregarded if you select to ignore the rules
defined within the target application. However, the unique selection cannot be
ignored.
Optimize Delays running calculations until the data feed completes and condenses
Calculations calculations for optimal processing. If this option is enabled, the optimized
calculation jobs run after the data feed completes. This improves the
performance of data feed processing and calculations.
Note: Condense jobs that are in the queue during an upgrade cause the jobs to
fail after the upgrade. Verify that there are no Condense jobs in the queue
before upgrading.
1. Go to the Transport tab of the data feed that you want to modify.
3. In the Transport Configuration section, enter the protocol and mail server credentials.
The following table describes the options.
Option Description
Protocol Specifies which protocol retrieves emails from your mail server.
l POP3
l IMAP4
l Exchange
SSL Specifies whether there is an encrypted link between the browser and mail server
Connection through Secure Sockets Layer.
Port Specifies the port number as the communications endpoint for communicating
between the mail server and protocol type.
Mail Box (for IMAP4 only) Specifies the name of the mail folder into which emails are
Name received, for example Inbox.
Mail Specifies the name of the mail server, for example, https://usa.mailserver/mail/.
Server
User Specifies the user name of the account used for logging in to the mail server.
Name
Password Specifies the password for the user account used for logging in to the mail server.
Retrieval Specifies whether the email message is deleted or copied on the mail server.
Method l Delete. Remove the email messages from the mail server when retrieving.
l Leave Copy. Leave a copy of the email messages on the mail server when
retrieving.
Message Specifies whether the data retrieved from the email is contained in standard mail
Data Type fields or the body of the message.
l Use the Mail Fields option for basic fields like To, From, Cc, Date, Subject,
Body Text, Body HTML, Return Path, MIME Version, and Message Id.
l Use Content Only or a custom transform to process XML data in the email
body.
Option Description
Filter Specifies the filters for retrieving data from the email message. A filter allows
the checking of any header field or the body. Examples:
l Body like "mortgage rates*"
l To = "bankrates@abc.com"
The following are general rules for forming filter expressions:
l Use any Multipurpose Internet Mail Extension (MIME) header field (not case-
sensitive).
l Enclose literal strings in double quotation marks (not case-sensitive).
l Match the * wild card character with zero or more occurrences of any
character.
l Include parentheses to control precedence.
l Use the logical operators AND, OR, and NOT (not case-sensitive).
l Use the comparison operators =, <, >, <=, >=, and <>.
l Use the string comparison operators CONTAINS, LIKE (not case-sensitive).
4. (Optional) In the Post-Processing -Local Copy section, determine how the data feed should
handle the local copy of the source data when the integration is complete. In the On Success
field, select one of the following options.
The following table describes the options.
Option Description
Nothing Does not alter the source file when the data feed successfully completes. If there is
a local copy of the source information, the local copy is deleted.
Rename Saves the source file under a new name when the data feed successfully completes.
In Destination File, specify where the file should be saved and the new name for the
file. For information on using filename tokens when renaming files, see Filename
Tokens.
To save the data, the path of the destination file must be accessible to the account
running the Job Engine service.
Note: A default Transform is included with the installation. If you require additional data
transformation, you can develop your own XSLT. For more information on XML formatting
guidelines and samples, see the appendix "XML Formatting Used in Field Results and Input"
in the RSA Archer Web Services API Reference Guide that you can download from the
RSA Archer Community.
6. Click OK.
7. Click Apply.
Data options
l Import the data “as is” into RSA Archer or execute modifications and calculations against the
data to convert the incoming data into a format that matches the requirements of the application or
questionnaire it is imported into. Use several advanced options, such as lookup translations and
calculations, to prepare and modify the data to meet your individual business needs.
l Filter data so that only what you want to receive is imported into the target application or
questionnaire. By not defining filters on the Data Filter tab, you instruct Data Feed Manager to
return all records in the data feed. Use operator logic to add filters to include only records
meeting certain criteria in the data feed process.
l Capture tokens of data from the last execution of a data feed that can be used during the next run
to identify which data to retrieve. On the Tokens tab, you can add, edit, or delete token values in
preparation of the next data feed execution.
1. Go to the Source Data tab of the data feed that you want to modify.
4. In the first line in the Source Fields section, select the appropriate field option for the record
definition.
5. In the Field type list for the remaining source fields, select the application option.
6. Click Apply.
Important: Do not use this option for an Archer-to-Archer data feed. RSA recommends that you
filter the report data instead.
1. Go to the Data Filter tab of the data feed that you want to modify.
2. In the Sources column, select the source name to which you want to apply a filter.
3. From the Field Name list, select the field name from your data source to which you want to
apply a filter.
4. From the Operator list, select an operator to define which type of filter you want to apply to the
source data.
5. In the Values column, enter a value based on your selection in the Operator column.
6. (Optional) In the Advanced operator logic field, enter the custom operator logic to create custom
operator logic to form relationships between the individual filters.
7. Complete either of the following optional tasks:
l To add an additional data filter, click Add New Filter located in the Data Filter section title
bar.
l To remove a data filter, in the Actions column of the filter you want to remove, click .
8. Click Apply.
1. Go to the Tokens tab of the data feed that you want to modify.
1. Go to the Field Map tab of the data feed that you want to modify.
2. Map the source field to the applicable application or questionnaire. Do one of the following:
l Click Auto-Populate to map the source fields to application or questionnaire fields. This option
maps fields from the data source to application or questionnaire fields that have the same
name. Auto-populate occurs on level 1 fields only. Additionally, if there is an exact name
match between the source field and the target field, and the field type is one of the following,
the field is not auto-populated: External links, Values list, Sub-form, Related records, Cross
reference, or CAST.
l Drag each source field and drop it next to the application or questionnaire field in the Target
Fields section. For target fields that have a field type of cross-reference, sub-form, or related
records, map the fields expanded under these field types. You cannot directly map to a target
field with any of these field types.
Note: You can drag the left or right border to resize the Source Field column so that it can
display long source field names.
Note: You can enter a value from zero to 99, with zero being the highest trust level, and 99 the
lowest. A data feed cannot overwrite a previous feed that has a higher trust level. For example, a
data feed with a trust level of 75 cannot overwrite a data feed with a trust level of 20. By
default, this option is not available until Manual Trust is activated.
Note: For some out-of-the-box applications, you may see the following message if you try to
configure key fields for a data feed:
2. In the Reference Field section, select the field that requires a key field definition.
Note: The Reference Field section contains the target application or questionnaire and any
mapped cross-reference, related records, CAST, or sub-form fields that require the creation of a
key field definition.
3. In the Key Field Definitions title bar, click Add New Key.
Note: You can use the Key Field Definitions section to define the unique key identifiers and the
data feed actions during the feed execution.
4. In the Field Name field, select a target application or questionnaire field that uniquely identifies
the record.
5. (Optional) Assign compound unique identifiers for the record. Do the following:
l Click in the Actions column to add unique identifiers in a hierarchical structure for sub-
form field types.
Note: After setting the order of key fields, the Data Feed Manager scans the data source file
for matches to each unique identifier in the specified order. When any key field is found as a
match to a field in the target application, the record is considered matched.
7. From the Action list, select the applicable option for the matching criteria for the unique
identifier.
8. Click Apply.
1. Go to the Update/Archive tab of the data feed that you want to modify.
2. In the Update Options section, select whether to create or update records in the target
application.
The following table describes the options.
Option Description
Create Create new records for data found in the source file and not in the target application
or questionnaire.
Update Updates records in the target application or questionnaire when a unique identifier
match exists in the source file. If you are also selecting the Archive Option of
Delete and want to retain existing records, make sure to select the Update option.
3. In the Archive Options section, select what happens when the matching record is not found in the
target application.
The following table describes the options.
Option Description
Delete Deletes records in the target application or questionnaire when a matching record is
not in the source data. If you want to retain existing records, also select the Update
option.
Records are matched by a unique identifier only during the update process. If you
want to retain existing records while archiving the target application, also select
Update in Update Options. If you do not select the Update option, all records in the
target application will be permanently deleted.
Option Description
Set Sets a value in a Values List field in a record whenever the external data file does
Value not contain a matching record.
Use this option to set a Values List to a value that identifies this record as Inactive
or Not Current. For example, a Devices application with a record for a specific
laptop and the external data file does not have a matching record for that laptop. You
can use this option to set a Values List field in the laptop record to the value
Inactive.
When you select this option, you also select the Values List field in the target
application or questionnaire and the value that you want to set in that field.
You cannot set the value in the Values List field of the target leveled application
under the following conditions:
l Level 3 or lower in a leveled application.
l You are modifying the data feed configuration.
In most scenarios, RSA recommends selecting the Set Value option and flagging
these records with a specific value rather than deleting them. For example, you can
add a field to your application called Status and include the values Current and
Archived. If a data feed cannot find a matching record in the data source with a
system record, the system record could be updated to have a value of Archived for
the Status field.
4. Click Apply.
Important: When you configure an iDefense or DeepSight threat data feed, you need to set specific
parameters to connect the threat feed properly with your RSA Archer instance.
1. Go to the Schedule tab of the data feed that you want to modify.
2. Go to the Recurrences section and complete frequency, start and stop times, and time zone.
The following table describes the fields in the Recurrences section.
Field Description
Frequency Specifies the interval in which the data feed runs, for example, Minutely, Hourly,
Daily, Weekly, Monthly, or Reference.
l Minutely. Runs the data feed by the interval set.
For example, if you specify 45 in the Every list, the data feed executes every
45 minutes.
l Hourly. Runs the data feed by the interval set, for example, every hour (1),
every other hour (2) and so forth.
l Daily. Runs the data feed by the interval set, for example, every day (1), every
other day (2) and, so forth.
l Weekly. Runs the data feed based on a specified day of the week, for example,
every Monday of the first week (1), every other Monday (2), and so forth.
l Monthly. Runs the data feed based on a specified week of the month, for
example, 1st, 2nd, 3rd, 4th, or Last.
l Reference. Runs a specified data feed as runs before the current one. This
option indicates to the Data Feed Service that this data feed starts as soon as
the referenced data feed completes successfully.
For example, you can select to have a Threats data feed run immediately after
your Assets data feed finishes. From the Reference Feed list, select after
which existing data feed the current data feed starts.
A reference data feed will not run when immediately running a data feed. The
Run Data Feed Now option only runs the current data feed.
Every Specifies the interval of the frequency in which the data feed runs.
Field Description
Start Date Specifies the date on which the data feed schedule begins.
Time Specifies the time zone in of the server that runs the data feed.
Zone
3. Click Save.
Transport Locates a specific data file. This file contains additional instructions for launching
Only subsequent, standard data feeds. With this data feed type, the data feed only
completes the Transport and Navigation activities. The Source Definition and Field
Mapping activities are not allowed. Processing of the data feed does not attempt to
process the data.
Important: If you intend to use the data feed as part of a convoy, or you are troubleshooting the
data being pulled, select the Transport Only option. This option enables you to use a transform to
manipulate the data being returned by bringing the source data in as a flat file and then configure
a subsequent XML-based feed that includes an XSLT file. For more information on XML
formatting guidelines and samples, see the appendix “XML Formatting Used in Field Results and
Input” in the RSA Archer Web Services API Reference Guide that you can download from the
RSA Archer Community.
1. Go to the Transport tab of the data feed that you want to modify.
Protocol Specifies which protocol retrieves emails from your mail server.
l POP3
l IMAP4
l Exchange
Option Description
SSL Specifies whether there is an encrypted link between the browser and mail server
Connection through Secure Sockets Layer.
Port Specifies the port number as the communications endpoint for communicating
between the mail server and protocol type.
Mail Box (for IMAP4 only) Specifies the name of the mail folder into which emails are
Name received, for example Inbox.
Mail Specifies the name of the mail server, for example, https://usa.mailserver/mail/.
Server
User Specifies the user name of the account used for logging in to the mail server.
Name
Password Specifies the password for the user account used for logging in to the mail server.
Retrieval Specifies whether the email message is deleted or copied on the mail server.
Method l Delete. Remove the email messages from the mail server when retrieving.
l Leave Copy. Leave a copy of the email messages on the mail server when
retrieving.
Message Specifies whether the data retrieved from the email is contained in standard mail
Data Type fields or the body of the message.
l Use the Mail Fields option for basic fields like To, From, Cc, Date, Subject,
Body Text, Body HTML, Return Path, MIME Version, and Message Id.
l Use Content Only or a custom transform to process XML data in the email
body.
Option Description
Filter Specifies the filters for retrieving data from the email message. A filter allows
the checking of any header field or the body. Examples:
l Body like "mortgage rates*"
l To = "bankrates@abc.com"
The following are general rules for forming filter expressions:
l Use any Multipurpose Internet Mail Extension (MIME) header field (not case-
sensitive).
l Enclose literal strings in double quotation marks (not case-sensitive).
l Match the * wild card character with zero or more occurrences of any
character.
l Include parentheses to control precedence.
l Use the logical operators AND, OR, and NOT (not case-sensitive).
l Use the comparison operators =, <, >, <=, >=, and <>.
l Use the string comparison operators CONTAINS, LIKE (not case-sensitive).
4. (Optional) In the Post-Processing -Local Copy section, determine how the data feed should
handle the local copy of the source data when the integration is complete. In the On Success
field, select one of the following options.
The following table describes the options.
Option Description
Nothing Does not alter the source file when the data feed successfully completes. If there is
a local copy of the source information, the local copy is deleted.
Rename Saves the source file under a new name when the data feed successfully completes.
In Destination File, specify where the file should be saved and the new name for the
file. For information on using filename tokens when renaming files, see Filename
Tokens.
To save the data, the path of the destination file must be accessible to the account
running the Job Engine service.
Important: When you configure an iDefense or DeepSight threat data feed, you need to set specific
parameters to connect the threat feed properly with your RSA Archer instance.
1. Go to the Schedule tab of the data feed that you want to modify.
2. Go to the Recurrences section and complete frequency, start and stop times, and time zone.
The following table describes the fields in the Recurrences section.
Field Description
Frequency Specifies the interval in which the data feed runs, for example, Minutely, Hourly,
Daily, Weekly, Monthly, or Reference.
l Minutely. Runs the data feed by the interval set.
For example, if you specify 45 in the Every list, the data feed executes every
45 minutes.
l Hourly. Runs the data feed by the interval set, for example, every hour (1),
every other hour (2) and so forth.
l Daily. Runs the data feed by the interval set, for example, every day (1), every
other day (2) and, so forth.
l Weekly. Runs the data feed based on a specified day of the week, for example,
every Monday of the first week (1), every other Monday (2), and so forth.
l Monthly. Runs the data feed based on a specified week of the month, for
example, 1st, 2nd, 3rd, 4th, or Last.
l Reference. Runs a specified data feed as runs before the current one. This
option indicates to the Data Feed Service that this data feed starts as soon as
the referenced data feed completes successfully.
For example, you can select to have a Threats data feed run immediately after
your Assets data feed finishes. From the Reference Feed list, select after
which existing data feed the current data feed starts.
A reference data feed will not run when immediately running a data feed. The
Run Data Feed Now option only runs the current data feed.
Every Specifies the interval of the frequency in which the data feed runs.
Start Date Specifies the date on which the data feed schedule begins.
Time Specifies the time zone in of the server that runs the data feed.
Zone
3. Click Save.
Note: RSA recommends that you rely on HTTPS for secure communications between the web
server and the RSS transporter. RSA also recommends that you set the RSS iView Content Handling
option in the RSA Archer Control Panel to Scrub or Encode to address this issue.
Important: For the data feed to execute successfully, the server responsible for running the data
feed must have a service account with valid logon credentials.
For more information, see "Data Feeds" in the RSA Archer Online Documentation.
Note: If you are completing a large data import, you may need to increase the Session Timeout
for the Archer Services Security Parameter from 30 minutes to 6 hours. Adjustments for the
Archer Services Security Parameter must be made in the instance database by running an SQL
command.
Send Select whether to have the data feed trigger notification emails when records
Notifications are published or updated. If notifications are not enabled in the selected target
application, no notification emails are sent when the data feed runs.
Send Job Select whether to have job status notifications sent to selected users or groups.
Status You can also select email addresses to receive job status notifications. If
Notifications selected, job status notifications are sent showing whether a job succeeded or
failed to run.
9. (Optional) In the Additional Properties section, specify a different locale for your source data,
whether to override the rules of saving a record defined in the application, and whether to delay
running calculations until the data feed completes.
The following table describes the options.
Option Description
Locale Specifies the country (language) format of your source data. Different cultures
or countries use different characters when formatting similar data.
Option Description
Data Determines whether RSA Archer performs data validations against the selected
Validation target application when saving a record. Selecting this option bypasses
validation that is based on field definition and configuration (with some
exceptions). This option applies regardless of whether you are targeting a
questionnaire or application.
RSA Archer validates the following items regardless of whether this field is
selected:
l Attachment or image field - Validity of the file.
l Date/Time field - Minimum and maximum system values.
l Text field - Contains valid HTML.
l Field name - Uniqueness.
The required field settings are disregarded if you select to ignore the rules
defined within the target application. However, the unique selection cannot be
ignored.
Optimize Delays running calculations until the data feed completes and condenses
Calculations calculations for optimal processing. If this option is enabled, the optimized
calculation jobs run after the data feed completes. This improves the
performance of data feed processing and calculations.
Note: Condense jobs that are in the queue during an upgrade cause the jobs to
fail after the upgrade. Verify that there are no Condense jobs in the queue
before upgrading.
1. Go to the Transport tab of the data feed that you want to modify.
3. In the Transport Configuration section, enter the URL and credentials of the RSS feed for
retrieving source data.
The following table describes the options.
Option Description
Retrieval Specifies the number of records that will be retrieved from the RSS feed.
Count
Retrieval Units Specifies how data is contained in the RSS feed, for example, Days or
Articles.
User Name Specifies the name of the user account used for retrieving data.
Password Specifies the password of the user account used for retrieving data.
No Proxy Indicates that the data feed does not pass through a proxy.
Use System Indicates that the Data Feed Service runs the feed with the proxy configuration
Proxy that is set up in the Control Panel.
Configure Indicates that the data feed must pass through a proxy. Continue with providing
Proxy the parameters for accessing the proxy.
User Specifies the name of the user who has credentials for logging on to the proxy
Name server.
6. (Optional) In the Post-Processing - Local Copy section, determine how the data feed should
handle the local copy of the source data when the integration is complete. In the On Success
field, select one of the following options.
To perform post-processing on the source file retrieved, in the Post-Processing - Local Copy
section, determine how the data feed should handle the local copy of the source data when the
integration is complete. In the On Success field, select from the following options.
The following table describes the options.
Option Description
Nothing Does not alter the source file when the data feed successfully completes. If there is
a local copy of the source information, the local copy is deleted.
Option Description
Rename Saves the source file under a new name when the data feed successfully completes.
In Destination File, specify where the file should be saved and the new name for the
file.
To save the data, the path of the destination file must be accessible to the account
running the Job Engine service.
If you select this option, use filename tokens for specifying the location or name of
the file.
Filename tokens
Filename tokens are available for post processing when you want to save the source
information and specify a location or name for the file. When you select the Rename
option, you can use tokens to generate unique names automatically for the files.
Here are the usable tokens for renaming data files.
l Now. Insert a user-defined date format within the new filename. Possible formats
include Now(MM/dd/yyyy) or Now(MMM-dd-yyyy). See the Microsoft .Net
Framework Developer Center for available custom date/time formats.
l DataFileDirectoryName. Update the filename with the directory name, including
the drive, of your file.
l DataFileName. Insert the original filename, excluding the directory name and
extension.
l DataFileExtension. Insert the file extension, such as .csv, in the new filename.
l DataFileFullName. Insert the fully qualified filename. This data includes the
drive, directory, filename, and extension of the original file.
For example, if the data file came from the following location,
C:\DataFeed\Source\ESL\processed\ThreatData.csv, files that have been renamed
using tokens would have the following output.
Example 1
l Input Tokens: {DataFileDirectoryName}\success\{DataFileName}_{Now
(MM.dd.yyyy)}.{DataFileExtension}
l Output: C:\DataFeed\Source\ESL\processed\success\ThreatData_01.31.2008.csv
Example 2
Option Description
Note: A default Transform is included with the installation. If you require additional data
transformation, you can develop your own XSLT. For more information on XML formatting
guidelines and samples, see the appendix "XML Formatting Used in Field Results and Input"
in the RSA Archer Web Services API Reference Guide that you can download from the
RSA Archer Community.
6. Click OK.
7. Click Apply.
Data options
l Import the data “as is” into RSA Archer or execute modifications and calculations against the
data to convert the incoming data into a format that matches the requirements of the application or
questionnaire it is imported into. Use several advanced options, such as lookup translations and
calculations, to prepare and modify the data to meet your individual business needs.
l Filter data so that only what you want to receive is imported into the target application or
questionnaire. By not defining filters on the Data Filter tab, you instruct Data Feed Manager to
return all records in the data feed. Use operator logic to add filters to include only records
meeting certain criteria in the data feed process.
l Capture tokens of data from the last execution of a data feed that can be used during the next run
to identify which data to retrieve. On the Tokens tab, you can add, edit, or delete token values in
preparation of the next data feed execution.
1. Go to the Source Data tab of the data feed that you want to modify.
Important: The process of loading a source definition for a data feed times out at five minutes.
You may want to consider using a smaller set of source data when you set up the feed.
Source Description
Sample Uses a skeleton of your actual source data file. For example, if you are importing
File data from a .csv file, the source data file is a .csv file that includes the column
names from your source data. If you are importing data from an .XML file, the
source data file includes the structure of your .XML without the actual field values.
When you select the sample file, the Source Fields section populates with the fields
specified in the sample data file.
For the Archer Web Services Transporter, select a file from an external location
that contains the data in a same format as the report format.
Load Loads the contents at the target URL and detects the source schema from the
URL contents.
Using this option may trigger actions associated with accessing the target URL.
4. In the first line in the Source Fields section, select the appropriate field option for the record
definition.
Note: For more information about configuring source fields in standard data feeds, see
Manipulating Data in the Source File of Standard Data Feeds.
5. In the Field type list for the remaining source fields, select the application option.
6. Click Apply.
Important: Do not use this option for an Archer-to-Archer data feed. RSA recommends that you
filter the report data instead.
1. Go to the Data Filter tab of the data feed that you want to modify.
2. In the Sources column, select the source name to which you want to apply a filter.
3. From the Field Name list, select the field name from your data source to which you want to
apply a filter.
4. From the Operator list, select an operator to define which type of filter you want to apply to the
source data.
5. In the Values column, enter a value based on your selection in the Operator column.
6. (Optional) In the Advanced operator logic field, enter the custom operator logic to create custom
operator logic to form relationships between the individual filters.
7. Complete either of the following optional tasks:
l To add an additional data filter, click Add New Filter located in the Data Filter section title
bar.
l To remove a data filter, in the Actions column of the filter you want to remove, click .
8. Click Apply.
1. Go to the Tokens tab of the data feed that you want to modify.
1. Go to the Field Map tab of the data feed that you want to modify.
2. Map the source field to the applicable application or questionnaire. Do one of the following:
l Click Auto-Populate to map the source fields to application or questionnaire fields. This option
maps fields from the data source to application or questionnaire fields that have the same
name. Auto-populate occurs on level 1 fields only. Additionally, if there is an exact name
match between the source field and the target field, and the field type is one of the following,
the field is not auto-populated: External links, Values list, Sub-form, Related records, Cross
reference, or CAST.
l Drag each source field and drop it next to the application or questionnaire field in the Target
Fields section. For target fields that have a field type of cross-reference, sub-form, or related
records, map the fields expanded under these field types. You cannot directly map to a target
field with any of these field types.
Note: You can drag the left or right border to resize the Source Field column so that it can
display long source field names.
Note: You can enter a value from zero to 99, with zero being the highest trust level, and 99 the
lowest. A data feed cannot overwrite a previous feed that has a higher trust level. For example, a
data feed with a trust level of 75 cannot overwrite a data feed with a trust level of 20. By
default, this option is not available until Manual Trust is activated.
Note: For some out-of-the-box applications, you may see the following message if you try to
configure key fields for a data feed:
2. In the Reference Field section, select the field that requires a key field definition.
Note: The Reference Field section contains the target application or questionnaire and any
mapped cross-reference, related records, CAST, or sub-form fields that require the creation of a
key field definition.
3. In the Key Field Definitions title bar, click Add New Key.
Note: You can use the Key Field Definitions section to define the unique key identifiers and the
data feed actions during the feed execution.
4. In the Field Name field, select a target application or questionnaire field that uniquely identifies
the record.
5. (Optional) Assign compound unique identifiers for the record. Do the following:
l Click in the Actions column to add unique identifiers in a hierarchical structure for sub-
form field types.
Note: After setting the order of key fields, the Data Feed Manager scans the data source file
for matches to each unique identifier in the specified order. When any key field is found as a
match to a field in the target application, the record is considered matched.
7. From the Action list, select the applicable option for the matching criteria for the unique
identifier.
8. Click Apply.
1. Go to the Update/Archive tab of the data feed that you want to modify.
2. In the Update Options section, select whether to create or update records in the target
application.
The following table describes the options.
Option Description
Create Create new records for data found in the source file and not in the target application
or questionnaire.
Update Updates records in the target application or questionnaire when a unique identifier
match exists in the source file. If you are also selecting the Archive Option of
Delete and want to retain existing records, make sure to select the Update option.
3. In the Archive Options section, select what happens when the matching record is not found in the
target application.
The following table describes the options.
Option Description
Delete Deletes records in the target application or questionnaire when a matching record is
not in the source data. If you want to retain existing records, also select the Update
option.
Records are matched by a unique identifier only during the update process. If you
want to retain existing records while archiving the target application, also select
Update in Update Options. If you do not select the Update option, all records in the
target application will be permanently deleted.
Option Description
Set Sets a value in a Values List field in a record whenever the external data file does
Value not contain a matching record.
Use this option to set a Values List to a value that identifies this record as Inactive
or Not Current. For example, a Devices application with a record for a specific
laptop and the external data file does not have a matching record for that laptop. You
can use this option to set a Values List field in the laptop record to the value
Inactive.
When you select this option, you also select the Values List field in the target
application or questionnaire and the value that you want to set in that field.
You cannot set the value in the Values List field of the target leveled application
under the following conditions:
l Level 3 or lower in a leveled application.
l You are modifying the data feed configuration.
In most scenarios, RSA recommends selecting the Set Value option and flagging
these records with a specific value rather than deleting them. For example, you can
add a field to your application called Status and include the values Current and
Archived. If a data feed cannot find a matching record in the data source with a
system record, the system record could be updated to have a value of Archived for
the Status field.
4. Click Apply.
Important: When you configure an iDefense or DeepSight threat data feed, you need to set specific
parameters to connect the threat feed properly with your RSA Archer instance.
1. Go to the Schedule tab of the data feed that you want to modify.
2. Go to the Recurrences section and complete frequency, start and stop times, and time zone.
The following table describes the fields in the Recurrences section.
Field Description
Frequency Specifies the interval in which the data feed runs, for example, Minutely, Hourly,
Daily, Weekly, Monthly, or Reference.
l Minutely. Runs the data feed by the interval set.
For example, if you specify 45 in the Every list, the data feed executes every
45 minutes.
l Hourly. Runs the data feed by the interval set, for example, every hour (1),
every other hour (2) and so forth.
l Daily. Runs the data feed by the interval set, for example, every day (1), every
other day (2) and, so forth.
l Weekly. Runs the data feed based on a specified day of the week, for example,
every Monday of the first week (1), every other Monday (2), and so forth.
l Monthly. Runs the data feed based on a specified week of the month, for
example, 1st, 2nd, 3rd, 4th, or Last.
l Reference. Runs a specified data feed as runs before the current one. This
option indicates to the Data Feed Service that this data feed starts as soon as
the referenced data feed completes successfully.
For example, you can select to have a Threats data feed run immediately after
your Assets data feed finishes. From the Reference Feed list, select after
which existing data feed the current data feed starts.
A reference data feed will not run when immediately running a data feed. The
Run Data Feed Now option only runs the current data feed.
Every Specifies the interval of the frequency in which the data feed runs.
Field Description
Start Date Specifies the date on which the data feed schedule begins.
Time Specifies the time zone in of the server that runs the data feed.
Zone
3. Click Save.
Transport Locates a specific data file. This file contains additional instructions for launching
Only subsequent, standard data feeds. With this data feed type, the data feed only
completes the Transport and Navigation activities. The Source Definition and Field
Mapping activities are not allowed. Processing of the data feed does not attempt to
process the data.
Important: If you intend to use the data feed as part of a convoy, or you are troubleshooting the
data being pulled, select the Transport Only option. This option enables you to use a transform to
manipulate the data being returned by bringing the source data in as a flat file and then configure
a subsequent XML-based feed that includes an XSLT file. For more information on XML
formatting guidelines and samples, see the appendix “XML Formatting Used in Field Results and
Input” in the RSA Archer Web Services API Reference Guide that you can download from the
RSA Archer Community.
1. Go to the Transport tab of the data feed that you want to modify.
Retrieval Specifies the number of records that will be retrieved from the RSS feed.
Count
Option Description
Retrieval Units Specifies how data is contained in the RSS feed, for example, Days or
Articles.
User Name Specifies the name of the user account used for retrieving data.
Password Specifies the password of the user account used for retrieving data.
No Proxy Indicates that the data feed does not pass through a proxy.
Use System Indicates that the Data Feed Service runs the feed with the proxy configuration
Proxy that is set up in the Control Panel.
Configure Indicates that the data feed must pass through a proxy. Continue with providing
Proxy the parameters for accessing the proxy.
User Specifies the name of the user who has credentials for logging on to the proxy
Name server.
6. (Optional) In the Post-Processing - Local Copy section, determine how the data feed should
handle the local copy of the source data when the integration is complete. In the On Success
field, select one of the following options.
To perform post-processing on the source file retrieved, in the Post-Processing - Local Copy
section, determine how the data feed should handle the local copy of the source data when the
integration is complete. In the On Success field, select from the following options.
Nothing Does not alter the source file when the data feed successfully completes. If there is
a local copy of the source information, the local copy is deleted.
Option Description
Rename Saves the source file under a new name when the data feed successfully completes.
In Destination File, specify where the file should be saved and the new name for the
file.
To save the data, the path of the destination file must be accessible to the account
running the Job Engine service.
If you select this option, use filename tokens for specifying the location or name of
the file.
Filename tokens
Filename tokens are available for post processing when you want to save the source
information and specify a location or name for the file. When you select the Rename
option, you can use tokens to generate unique names automatically for the files.
Here are the usable tokens for renaming data files.
l Now. Insert a user-defined date format within the new filename. Possible formats
include Now(MM/dd/yyyy) or Now(MMM-dd-yyyy). See the Microsoft .Net
Framework Developer Center for available custom date/time formats.
l DataFileDirectoryName. Update the filename with the directory name, including
the drive, of your file.
l DataFileName. Insert the original filename, excluding the directory name and
extension.
l DataFileExtension. Insert the file extension, such as .csv, in the new filename.
l DataFileFullName. Insert the fully qualified filename. This data includes the
drive, directory, filename, and extension of the original file.
For example, if the data file came from the following location,
C:\DataFeed\Source\ESL\processed\ThreatData.csv, files that have been renamed
using tokens would have the following output.
Example 1
l Input Tokens: {DataFileDirectoryName}\success\{DataFileName}_{Now
(MM.dd.yyyy)}.{DataFileExtension}
l Output: C:\DataFeed\Source\ESL\processed\success\ThreatData_01.31.2008.csv
Example 2
Option Description
Important: When you configure an iDefense or DeepSight threat data feed, you need to set specific
parameters to connect the threat feed properly with your RSA Archer instance.
1. Go to the Schedule tab of the data feed that you want to modify.
2. Go to the Recurrences section and complete frequency, start and stop times, and time zone.
The following table describes the fields in the Recurrences section.
Field Description
Frequency Specifies the interval in which the data feed runs, for example, Minutely, Hourly,
Daily, Weekly, Monthly, or Reference.
l Minutely. Runs the data feed by the interval set.
For example, if you specify 45 in the Every list, the data feed executes every
45 minutes.
l Hourly. Runs the data feed by the interval set, for example, every hour (1),
every other hour (2) and so forth.
l Daily. Runs the data feed by the interval set, for example, every day (1), every
other day (2) and, so forth.
l Weekly. Runs the data feed based on a specified day of the week, for example,
every Monday of the first week (1), every other Monday (2), and so forth.
l Monthly. Runs the data feed based on a specified week of the month, for
example, 1st, 2nd, 3rd, 4th, or Last.
l Reference. Runs a specified data feed as runs before the current one. This
option indicates to the Data Feed Service that this data feed starts as soon as
the referenced data feed completes successfully.
For example, you can select to have a Threats data feed run immediately after
your Assets data feed finishes. From the Reference Feed list, select after
which existing data feed the current data feed starts.
A reference data feed will not run when immediately running a data feed. The
Run Data Feed Now option only runs the current data feed.
Every Specifies the interval of the frequency in which the data feed runs.
Start Date Specifies the date on which the data feed schedule begins.
Time Specifies the time zone in of the server that runs the data feed.
Zone
3. Click Save.
Note: Data feeds using the DeepSight 2.0 transporter will soon become unusable because of
deprecation by Symantec. From the RSA Archer Community on RSA Link, download a copy of the
data feeds that use the DeepSight 4.0 transporters and import them.
from RSA Archer and third-party providers such as Qualys, nCircle, and Sendmail.
New integration packages are available regularly, and each package includes the following items:
l Data feed configuration file
l Target application(s)
l Any supporting files (such as an .xslt file)
When you download an integration package from the RSA Archer Community on RSA Link, you can
import the configuration file directly into the Data Feed Manager and, if necessary, modify the
configuration. You can also import the target applications into the RSA Archer environment and
modify the applications through Application Builder.
For more information, see "Data Feeds" in the RSA Archer Online Documentation.
You can add a DeepSight threat data feed to integrate source data with an RSA Archer application.
Threat data feeds can only be initiated from a standard data feed type.
Important: Only one version of the DeepSight transporter can be active at a time. If you try to
activate a threat feed that uses one of the two DeepSight transporters, and another threat feed that
uses the other DeepSight transporter is already active, a warning message appears. To continue
activating this threat feed, set the Status for the other DeepSight threat feed to Inactive.
Note: If you are completing a large data import, you may need to increase the Session Timeout
for the Archer Services Security Parameter from 30 minutes to 6 hours. Adjustments for the
Archer Services Security Parameter must be made in the instance database by running an SQL
command.
Send Select whether to have the data feed trigger notification emails when records
Notifications are published or updated. If notifications are not enabled in the selected target
application, no notification emails are sent when the data feed runs.
Send Job Select whether to have job status notifications sent to selected users or groups.
Status You can also select email addresses to receive job status notifications. If
Notifications selected, job status notifications are sent showing whether a job succeeded or
failed to run.
9. (Optional) In the Additional Properties section, specify a different locale for your source data,
whether to override the rules of saving a record defined in the application, and whether to delay
running calculations until the data feed completes.
Locale Specifies the country (language) format of your source data. Different cultures
or countries use different characters when formatting similar data.
Data Determines whether RSA Archer performs data validations against the selected
Validation target application when saving a record. Selecting this option bypasses
validation that is based on field definition and configuration (with some
exceptions). This option applies regardless of whether you are targeting a
questionnaire or application.
RSA Archer validates the following items regardless of whether this field is
selected:
l Attachment or image field - Validity of the file.
l Date/Time field - Minimum and maximum system values.
l Text field - Contains valid HTML.
l Field name - Uniqueness.
The required field settings are disregarded if you select to ignore the rules
defined within the target application. However, the unique selection cannot be
ignored.
Optimize Delays running calculations until the data feed completes and condenses
Calculations calculations for optimal processing. If this option is enabled, the optimized
calculation jobs run after the data feed completes. This improves the
performance of data feed processing and calculations.
Note: Condense jobs that are in the queue during an upgrade cause the jobs to
fail after the upgrade. Verify that there are no Condense jobs in the queue
before upgrading.
1. Go to the Transport tab of the data feed that you want to modify.
2. From the Transport Method list, select the applicable transporter: DeepSight Transporter 2.0 or
DeepSight Transporter 4.0.
3. In the Transport Configuration section, enter the URL and credentials for retrieving source data.
The following table describes the options.
Option Description
Retrieval Specifies the number of records that will be retrieved from the RSS feed.
Count
Retrieval Units Specifies how data is contained in the RSS feed, for example, Days or
Articles.
User Name Specifies the name of the user account used for retrieving data.
Password Specifies the password of the user account used for retrieving data.
No Proxy Indicates that the data feed does not pass through a proxy.
Use System Indicates that the Data Feed Service runs the feed with the proxy configuration
Proxy that is set up in the Control Panel.
Configure Indicates that the data feed must pass through a proxy. Continue with providing
Proxy the parameters for accessing the proxy.
Field Description
User Specifies the name of the user who has credentials for logging on to the proxy
Name server.
6. (Optional) In the Post-Processing -Local Copy section, determine how the data feed should
handle the local copy of the source data when the integration is complete. In the On Success
field, select one of the following options.
To perform post-processing on the source file retrieved, in the Post-Processing - Local Copy
section, determine how the data feed should handle the local copy of the source data when the
integration is complete. In the On Success field, select from the following options.
The following table describes the options.
Option Description
Nothing Does not alter the source file when the data feed successfully completes. If there is
a local copy of the source information, the local copy is deleted.
Option Description
Rename Saves the source file under a new name when the data feed successfully completes.
In Destination File, specify where the file should be saved and the new name for the
file.
To save the data, the path of the destination file must be accessible to the account
running the Job Engine service.
If you select this option, use filename tokens for specifying the location or name of
the file.
Filename tokens
Filename tokens are available for post processing when you want to save the source
information and specify a location or name for the file. When you select the Rename
option, you can use tokens to generate unique names automatically for the files.
Here are the usable tokens for renaming data files.
l Now. Insert a user-defined date format within the new filename. Possible formats
include Now(MM/dd/yyyy) or Now(MMM-dd-yyyy). See the Microsoft .Net
Framework Developer Center for available custom date/time formats.
l DataFileDirectoryName. Update the filename with the directory name, including
the drive, of your file.
l DataFileName. Insert the original filename, excluding the directory name and
extension.
l DataFileExtension. Insert the file extension, such as .csv, in the new filename.
l DataFileFullName. Insert the fully qualified filename. This data includes the
drive, directory, filename, and extension of the original file.
For example, if the data file came from the following location,
C:\DataFeed\Source\ESL\processed\ThreatData.csv, files that have been renamed
using tokens would have the following output.
Example 1
l Input Tokens: {DataFileDirectoryName}\success\{DataFileName}_{Now
(MM.dd.yyyy)}.{DataFileExtension}
l Output: C:\DataFeed\Source\ESL\processed\success\ThreatData_01.31.2008.csv
Example 2
Option Description
Note: A default Transform is included with the installation. If you require additional data
transformation, you can develop your own XSLT. For more information on XML formatting
guidelines and samples, see the appendix "XML Formatting Used in Field Results and Input"
in the RSA Archer Web Services API Reference Guide that you can download from the
RSA Archer Community.
6. Click OK.
7. Click Apply.
Data options
l Import the data “as is” into RSA Archer or execute modifications and calculations against the
data to convert the incoming data into a format that matches the requirements of the application or
questionnaire it is imported into. Use several advanced options, such as lookup translations and
calculations, to prepare and modify the data to meet your individual business needs.
l Filter data so that only what you want to receive is imported into the target application or
questionnaire. By not defining filters on the Data Filter tab, you instruct Data Feed Manager to
return all records in the data feed. Use operator logic to add filters to include only records
meeting certain criteria in the data feed process.
l Capture tokens of data from the last execution of a data feed that can be used during the next run
to identify which data to retrieve. On the Tokens tab, you can add, edit, or delete token values in
preparation of the next data feed execution.
1. Go to the Source Data tab of the data feed that you want to modify.
Important: The process of loading a source definition for a data feed times out at five minutes.
You may want to consider using a smaller set of source data when you set up the feed.
Source Description
Sample Uses a skeleton of your actual source data file. For example, if you are importing
File data from a .csv file, the source data file is a .csv file that includes the column
names from your source data. If you are importing data from an .XML file, the
source data file includes the structure of your .XML without the actual field values.
When you select the sample file, the Source Fields section populates with the fields
specified in the sample data file.
For the Archer Web Services Transporter, select a file from an external location
that contains the data in a same format as the report format.
Load Loads the contents at the target URL and detects the source schema from the
URL contents.
Using this option may trigger actions associated with accessing the target URL.
4. In the first line in the Source Fields section, select the appropriate field option for the record
definition.
Note: For more information about configuring source fields in standard data feeds, see
Manipulating Data in the Source File of Standard Data Feeds.
5. In the Field type list for the remaining source fields, select the application option.
6. Click Apply.
Important: Do not use this option for an Archer-to-Archer data feed. RSA recommends that you
filter the report data instead.
1. Go to the Data Filter tab of the data feed that you want to modify.
2. In the Sources column, select the source name to which you want to apply a filter.
3. From the Field Name list, select the field name from your data source to which you want to
apply a filter.
4. From the Operator list, select an operator to define which type of filter you want to apply to the
source data.
5. In the Values column, enter a value based on your selection in the Operator column.
6. (Optional) In the Advanced operator logic field, enter the custom operator logic to create custom
operator logic to form relationships between the individual filters.
7. Complete either of the following optional tasks:
l To add an additional data filter, click Add New Filter located in the Data Filter section title
bar.
l To remove a data filter, in the Actions column of the filter you want to remove, click .
8. Click Apply.
1. Go to the Tokens tab of the data feed that you want to modify.
1. Go to the Field Map tab of the data feed that you want to modify.
2. Map the source field to the applicable application or questionnaire. Do one of the following:
l Click Auto-Populate to map the source fields to application or questionnaire fields. This option
maps fields from the data source to application or questionnaire fields that have the same
name. Auto-populate occurs on level 1 fields only. Additionally, if there is an exact name
match between the source field and the target field, and the field type is one of the following,
the field is not auto-populated: External links, Values list, Sub-form, Related records, Cross
reference, or CAST.
l Drag each source field and drop it next to the application or questionnaire field in the Target
Fields section. For target fields that have a field type of cross-reference, sub-form, or related
records, map the fields expanded under these field types. You cannot directly map to a target
field with any of these field types.
Note: You can drag the left or right border to resize the Source Field column so that it can
display long source field names.
Note: You can enter a value from zero to 99, with zero being the highest trust level, and 99 the
lowest. A data feed cannot overwrite a previous feed that has a higher trust level. For example, a
data feed with a trust level of 75 cannot overwrite a data feed with a trust level of 20. By
default, this option is not available until Manual Trust is activated.
Note: For some out-of-the-box applications, you may see the following message if you try to
configure key fields for a data feed:
2. In the Reference Field section, select the field that requires a key field definition.
Note: The Reference Field section contains the target application or questionnaire and any
mapped cross-reference, related records, CAST, or sub-form fields that require the creation of a
key field definition.
3. In the Key Field Definitions title bar, click Add New Key.
Note: You can use the Key Field Definitions section to define the unique key identifiers and the
data feed actions during the feed execution.
4. In the Field Name field, select a target application or questionnaire field that uniquely identifies
the record.
5. (Optional) Assign compound unique identifiers for the record. Do the following:
l Click in the Actions column to add unique identifiers in a hierarchical structure for sub-
form field types.
Note: After setting the order of key fields, the Data Feed Manager scans the data source file
for matches to each unique identifier in the specified order. When any key field is found as a
match to a field in the target application, the record is considered matched.
7. From the Action list, select the applicable option for the matching criteria for the unique
identifier.
8. Click Apply.
1. Go to the Update/Archive tab of the data feed that you want to modify.
2. In the Update Options section, select whether to create or update records in the target
application.
The following table describes the options.
Option Description
Create Create new records for data found in the source file and not in the target application
or questionnaire.
Update Updates records in the target application or questionnaire when a unique identifier
match exists in the source file. If you are also selecting the Archive Option of
Delete and want to retain existing records, make sure to select the Update option.
3. In the Archive Options section, select what happens when the matching record is not found in the
target application.
The following table describes the options.
Option Description
Delete Deletes records in the target application or questionnaire when a matching record is
not in the source data. If you want to retain existing records, also select the Update
option.
Records are matched by a unique identifier only during the update process. If you
want to retain existing records while archiving the target application, also select
Update in Update Options. If you do not select the Update option, all records in the
target application will be permanently deleted.
Option Description
Set Sets a value in a Values List field in a record whenever the external data file does
Value not contain a matching record.
Use this option to set a Values List to a value that identifies this record as Inactive
or Not Current. For example, a Devices application with a record for a specific
laptop and the external data file does not have a matching record for that laptop. You
can use this option to set a Values List field in the laptop record to the value
Inactive.
When you select this option, you also select the Values List field in the target
application or questionnaire and the value that you want to set in that field.
You cannot set the value in the Values List field of the target leveled application
under the following conditions:
l Level 3 or lower in a leveled application.
l You are modifying the data feed configuration.
In most scenarios, RSA recommends selecting the Set Value option and flagging
these records with a specific value rather than deleting them. For example, you can
add a field to your application called Status and include the values Current and
Archived. If a data feed cannot find a matching record in the data source with a
system record, the system record could be updated to have a value of Archived for
the Status field.
4. Click Apply.
Important: When you configure an iDefense or DeepSight threat data feed, you need to set specific
parameters to connect the threat feed properly with your RSA Archer instance.
1. Go to the Schedule tab of the data feed that you want to modify.
2. Go to the Recurrences section and complete frequency, start and stop times, and time zone.
The following table describes the fields in the Recurrences section.
Field Description
Frequency Specifies the interval in which the data feed runs, for example, Minutely, Hourly,
Daily, Weekly, Monthly, or Reference.
l Minutely. Runs the data feed by the interval set.
For example, if you specify 45 in the Every list, the data feed executes every
45 minutes.
l Hourly. Runs the data feed by the interval set, for example, every hour (1),
every other hour (2) and so forth.
l Daily. Runs the data feed by the interval set, for example, every day (1), every
other day (2) and, so forth.
l Weekly. Runs the data feed based on a specified day of the week, for example,
every Monday of the first week (1), every other Monday (2), and so forth.
l Monthly. Runs the data feed based on a specified week of the month, for
example, 1st, 2nd, 3rd, 4th, or Last.
l Reference. Runs a specified data feed as runs before the current one. This
option indicates to the Data Feed Service that this data feed starts as soon as
the referenced data feed completes successfully.
For example, you can select to have a Threats data feed run immediately after
your Assets data feed finishes. From the Reference Feed list, select after
which existing data feed the current data feed starts.
A reference data feed will not run when immediately running a data feed. The
Run Data Feed Now option only runs the current data feed.
Every Specifies the interval of the frequency in which the data feed runs.
Field Description
Start Date Specifies the date on which the data feed schedule begins.
Time Specifies the time zone in of the server that runs the data feed.
Zone
3. Click Save.
Complete this task to add a iDefense threat data feed for integrating source data with an
RSA Archer application. Threat data feeds can only initiated from a standard data feed type.
l Vulnerabilities
l Geopolitical Threat
Note: If you are completing a large data import, you may need to increase the Session Timeout
for the Archer Services Security Parameter from 30 minutes to 6 hours. Adjustments for the
Archer Services Security Parameter must be made in the instance database by running an SQL
command.
Send Select whether to have the data feed trigger notification emails when records
Notifications are published or updated. If notifications are not enabled in the selected target
application, no notification emails are sent when the data feed runs.
Send Job Select whether to have job status notifications sent to selected users or groups.
Status You can also select email addresses to receive job status notifications. If
Notifications selected, job status notifications are sent showing whether a job succeeded or
failed to run.
9. (Optional) In the Additional Properties section, specify a different locale for your source data,
whether to override the rules of saving a record defined in the application, and whether to delay
running calculations until the data feed completes.
The following table describes the options.
Option Description
Locale Specifies the country (language) format of your source data. Different cultures
or countries use different characters when formatting similar data.
Option Description
Data Determines whether RSA Archer performs data validations against the selected
Validation target application when saving a record. Selecting this option bypasses
validation that is based on field definition and configuration (with some
exceptions). This option applies regardless of whether you are targeting a
questionnaire or application.
RSA Archer validates the following items regardless of whether this field is
selected:
l Attachment or image field - Validity of the file.
l Date/Time field - Minimum and maximum system values.
l Text field - Contains valid HTML.
l Field name - Uniqueness.
The required field settings are disregarded if you select to ignore the rules
defined within the target application. However, the unique selection cannot be
ignored.
Optimize Delays running calculations until the data feed completes and condenses
Calculations calculations for optimal processing. If this option is enabled, the optimized
calculation jobs run after the data feed completes. This improves the
performance of data feed processing and calculations.
Note: Condense jobs that are in the queue during an upgrade cause the jobs to
fail after the upgrade. Verify that there are no Condense jobs in the queue
before upgrading.
1. Go to the Transport tab of the data feed that you want to modify.
2. From the Transport Method list, select the applicable transporter: DeepSight Transporter 2.0 or
DeepSight Transporter 4.0.
3. In the Transport Configuration section, enter the URL and credentials for retrieving source data.
The following table describes the options.
Option Description
Retrieval Specifies the number of records that will be retrieved from the RSS feed.
Count
Retrieval Units Specifies how data is contained in the RSS feed, for example, Days or
Articles.
User Name Specifies the name of the user account used for retrieving data.
Password Specifies the password of the user account used for retrieving data.
No Proxy Indicates that the data feed does not pass through a proxy.
Use System Indicates that the Data Feed Service runs the feed with the proxy configuration
Proxy that is set up in the Control Panel.
Configure Indicates that the data feed must pass through a proxy. Continue with providing
Proxy the parameters for accessing the proxy.
User Specifies the name of the user who has credentials for logging on to the proxy
Name server.
6. (Optional) In the Post-Processing -Local Copy section, determine how the data feed should
handle the local copy of the source data when the integration is complete. In the On Success
field, select one of the following options.
To perform post-processing on the source file retrieved, in the Post-Processing - Local Copy
section, determine how the data feed should handle the local copy of the source data when the
integration is complete. In the On Success field, select from the following options.
The following table describes the options.
Option Description
Nothing Does not alter the source file when the data feed successfully completes. If there is
a local copy of the source information, the local copy is deleted.
Option Description
Rename Saves the source file under a new name when the data feed successfully completes.
In Destination File, specify where the file should be saved and the new name for the
file.
To save the data, the path of the destination file must be accessible to the account
running the Job Engine service.
If you select this option, use filename tokens for specifying the location or name of
the file.
Filename tokens
Filename tokens are available for post processing when you want to save the source
information and specify a location or name for the file. When you select the Rename
option, you can use tokens to generate unique names automatically for the files.
Here are the usable tokens for renaming data files.
l Now. Insert a user-defined date format within the new filename. Possible formats
include Now(MM/dd/yyyy) or Now(MMM-dd-yyyy). See the Microsoft .Net
Framework Developer Center for available custom date/time formats.
l DataFileDirectoryName. Update the filename with the directory name, including
the drive, of your file.
l DataFileName. Insert the original filename, excluding the directory name and
extension.
l DataFileExtension. Insert the file extension, such as .csv, in the new filename.
l DataFileFullName. Insert the fully qualified filename. This data includes the
drive, directory, filename, and extension of the original file.
For example, if the data file came from the following location,
C:\DataFeed\Source\ESL\processed\ThreatData.csv, files that have been renamed
using tokens would have the following output.
Example 1
l Input Tokens: {DataFileDirectoryName}\success\{DataFileName}_{Now
(MM.dd.yyyy)}.{DataFileExtension}
l Output: C:\DataFeed\Source\ESL\processed\success\ThreatData_01.31.2008.csv
Example 2
Option Description
Note: A default Transform is included with the installation. If you require additional data
transformation, you can develop your own XSLT. For more information on XML formatting
guidelines and samples, see the appendix "XML Formatting Used in Field Results and Input"
in the RSA Archer Web Services API Reference Guide that you can download from the
RSA Archer Community.
6. Click OK.
7. Click Apply.
Data options
l Import the data “as is” into RSA Archer or execute modifications and calculations against the
data to convert the incoming data into a format that matches the requirements of the application or
questionnaire it is imported into. Use several advanced options, such as lookup translations and
calculations, to prepare and modify the data to meet your individual business needs.
l Filter data so that only what you want to receive is imported into the target application or
questionnaire. By not defining filters on the Data Filter tab, you instruct Data Feed Manager to
return all records in the data feed. Use operator logic to add filters to include only records
meeting certain criteria in the data feed process.
l Capture tokens of data from the last execution of a data feed that can be used during the next run
to identify which data to retrieve. On the Tokens tab, you can add, edit, or delete token values in
preparation of the next data feed execution.
1. Go to the Source Data tab of the data feed that you want to modify.
Important: The process of loading a source definition for a data feed times out at five minutes.
You may want to consider using a smaller set of source data when you set up the feed.
Source Description
Sample Uses a skeleton of your actual source data file. For example, if you are importing
File data from a .csv file, the source data file is a .csv file that includes the column
names from your source data. If you are importing data from an .XML file, the
source data file includes the structure of your .XML without the actual field values.
When you select the sample file, the Source Fields section populates with the fields
specified in the sample data file.
For the Archer Web Services Transporter, select a file from an external location
that contains the data in a same format as the report format.
Load Loads the contents at the target URL and detects the source schema from the
URL contents.
Using this option may trigger actions associated with accessing the target URL.
4. In the first line in the Source Fields section, select the appropriate field option for the record
definition.
Note: For more information about configuring source fields in standard data feeds, see
Manipulating Data in the Source File of Standard Data Feeds.
5. In the Field type list for the remaining source fields, select the application option.
6. Click Apply.
Important: Do not use this option for an Archer-to-Archer data feed. RSA recommends that you
filter the report data instead.
1. Go to the Data Filter tab of the data feed that you want to modify.
2. In the Sources column, select the source name to which you want to apply a filter.
3. From the Field Name list, select the field name from your data source to which you want to
apply a filter.
4. From the Operator list, select an operator to define which type of filter you want to apply to the
source data.
5. In the Values column, enter a value based on your selection in the Operator column.
6. (Optional) In the Advanced operator logic field, enter the custom operator logic to create custom
operator logic to form relationships between the individual filters.
7. Complete either of the following optional tasks:
l To add an additional data filter, click Add New Filter located in the Data Filter section title
bar.
l To remove a data filter, in the Actions column of the filter you want to remove, click .
8. Click Apply.
1. Go to the Tokens tab of the data feed that you want to modify.
1. Go to the Field Map tab of the data feed that you want to modify.
2. Map the source field to the applicable application or questionnaire. Do one of the following:
l Click Auto-Populate to map the source fields to application or questionnaire fields. This option
maps fields from the data source to application or questionnaire fields that have the same
name. Auto-populate occurs on level 1 fields only. Additionally, if there is an exact name
match between the source field and the target field, and the field type is one of the following,
the field is not auto-populated: External links, Values list, Sub-form, Related records, Cross
reference, or CAST.
l Drag each source field and drop it next to the application or questionnaire field in the Target
Fields section. For target fields that have a field type of cross-reference, sub-form, or related
records, map the fields expanded under these field types. You cannot directly map to a target
field with any of these field types.
Note: You can drag the left or right border to resize the Source Field column so that it can
display long source field names.
Note: You can enter a value from zero to 99, with zero being the highest trust level, and 99 the
lowest. A data feed cannot overwrite a previous feed that has a higher trust level. For example, a
data feed with a trust level of 75 cannot overwrite a data feed with a trust level of 20. By
default, this option is not available until Manual Trust is activated.
Note: For some out-of-the-box applications, you may see the following message if you try to
configure key fields for a data feed:
2. In the Reference Field section, select the field that requires a key field definition.
Note: The Reference Field section contains the target application or questionnaire and any
mapped cross-reference, related records, CAST, or sub-form fields that require the creation of a
key field definition.
3. In the Key Field Definitions title bar, click Add New Key.
Note: You can use the Key Field Definitions section to define the unique key identifiers and the
data feed actions during the feed execution.
4. In the Field Name field, select a target application or questionnaire field that uniquely identifies
the record.
5. (Optional) Assign compound unique identifiers for the record. Do the following:
l Click in the Actions column to add unique identifiers in a hierarchical structure for sub-
form field types.
Note: After setting the order of key fields, the Data Feed Manager scans the data source file
for matches to each unique identifier in the specified order. When any key field is found as a
match to a field in the target application, the record is considered matched.
7. From the Action list, select the applicable option for the matching criteria for the unique
identifier.
8. Click Apply.
1. Go to the Update/Archive tab of the data feed that you want to modify.
2. In the Update Options section, select whether to create or update records in the target
application.
The following table describes the options.
Option Description
Create Create new records for data found in the source file and not in the target application
or questionnaire.
Update Updates records in the target application or questionnaire when a unique identifier
match exists in the source file. If you are also selecting the Archive Option of
Delete and want to retain existing records, make sure to select the Update option.
3. In the Archive Options section, select what happens when the matching record is not found in the
target application.
The following table describes the options.
Option Description
Delete Deletes records in the target application or questionnaire when a matching record is
not in the source data. If you want to retain existing records, also select the Update
option.
Records are matched by a unique identifier only during the update process. If you
want to retain existing records while archiving the target application, also select
Update in Update Options. If you do not select the Update option, all records in the
target application will be permanently deleted.
Option Description
Set Sets a value in a Values List field in a record whenever the external data file does
Value not contain a matching record.
Use this option to set a Values List to a value that identifies this record as Inactive
or Not Current. For example, a Devices application with a record for a specific
laptop and the external data file does not have a matching record for that laptop. You
can use this option to set a Values List field in the laptop record to the value
Inactive.
When you select this option, you also select the Values List field in the target
application or questionnaire and the value that you want to set in that field.
You cannot set the value in the Values List field of the target leveled application
under the following conditions:
l Level 3 or lower in a leveled application.
l You are modifying the data feed configuration.
In most scenarios, RSA recommends selecting the Set Value option and flagging
these records with a specific value rather than deleting them. For example, you can
add a field to your application called Status and include the values Current and
Archived. If a data feed cannot find a matching record in the data source with a
system record, the system record could be updated to have a value of Archived for
the Status field.
4. Click Apply.
Important: When you configure an iDefense or DeepSight threat data feed, you need to set specific
parameters to connect the threat feed properly with your RSA Archer instance.
1. Go to the Schedule tab of the data feed that you want to modify.
2. Go to the Recurrences section and complete frequency, start and stop times, and time zone.
The following table describes the fields in the Recurrences section.
Field Description
Frequency Specifies the interval in which the data feed runs, for example, Minutely, Hourly,
Daily, Weekly, Monthly, or Reference.
l Minutely. Runs the data feed by the interval set.
For example, if you specify 45 in the Every list, the data feed executes every
45 minutes.
l Hourly. Runs the data feed by the interval set, for example, every hour (1),
every other hour (2) and so forth.
l Daily. Runs the data feed by the interval set, for example, every day (1), every
other day (2) and, so forth.
l Weekly. Runs the data feed based on a specified day of the week, for example,
every Monday of the first week (1), every other Monday (2), and so forth.
l Monthly. Runs the data feed based on a specified week of the month, for
example, 1st, 2nd, 3rd, 4th, or Last.
l Reference. Runs a specified data feed as runs before the current one. This
option indicates to the Data Feed Service that this data feed starts as soon as
the referenced data feed completes successfully.
For example, you can select to have a Threats data feed run immediately after
your Assets data feed finishes. From the Reference Feed list, select after
which existing data feed the current data feed starts.
A reference data feed will not run when immediately running a data feed. The
Run Data Feed Now option only runs the current data feed.
Every Specifies the interval of the frequency in which the data feed runs.
Field Description
Start Date Specifies the date on which the data feed schedule begins.
Time Specifies the time zone in of the server that runs the data feed.
Zone
3. Click Save.
2. Click Import.
3. In the Open dialog box, click the configuration file and select its RSA Archer version number.
4. Click Open.
Notifications Send Blank Change this value only after the threat feed loading
Notifications the data in to your RSA Archer completes.
After this completes and whenever the threat feed
runs, existing data is deleted or updated, and new
data is inserted.
5. Click the Transport tab and do not change the transport method or configuration.
6. Select the rules for post-processing.
Post-Processing options
To perform post-processing on the source file retrieved, in the Post Processing section, determine
how the data feed should handle the local copy of the source data when the integration is
complete.
The following table describes the options.
Option Description
Nothing Does not alter the source file when the data feed successfully completes. If there is
a local copy of the source information, the local copy is deleted.
Option Description
Rename Saves the source file under a new name when the data feed successfully completes.
In Destination File, specify where the file should be saved and the new name for the
file.
If you select this option, use filename tokens for specifying the location or name of
the file.
Filename tokens
Filename tokens are available for post processing when you want to save the source
information and specify a location or name for the file. When you select the Rename
option, you can use tokens to generate unique names automatically for the files.
Here are the usable tokens for renaming data files.
l Now. Insert a user-defined date format within the new filename. Possible formats
include Now(MM/dd/yyyy) or Now(MMM-dd-yyyy). See the Microsoft .Net
Framework Developer Center for available custom date/time formats.
l DataFileDirectoryName. Update the filename with the directory name, including
the drive, of your file.
l DataFileName. Insert the original filename, excluding the directory name and
extension.
l DataFileExtension. Insert the file extension, such as .csv, in the new filename.
l DataFileFullName. Insert the fully qualified filename. This data includes the
drive, directory, filename, and extension of the original file.
For example, if the data file came from the following location,
C:\DataFeed\Source\ESL\processed\ThreatData.csv, files that have been renamed
using tokens would have the following output.
Example 1
Example 2
Option Description
success.{DataFileExtension}
l Output: \\DFSRepository\2008\01\ThreatData_success.csv
Delete Deletes the source file when the data feed completes successfully.
This option is available only for File and FTP transport methods.
Nothing Does not alter the source file when the data feed successfully completes. If there is
a local copy of the source information, the local copy is deleted.
Option Description
Rename Saves the source file under a new name when the data feed successfully completes.
In Destination File, specify where the file should be saved and the new name for the
file.
To save the data, the path of the destination file must be accessible to the account
running the Job Engine service.
If you select this option, use filename tokens for specifying the location or name of
the file.
Filename tokens
Filename tokens are available for post processing when you want to save the source
information and specify a location or name for the file. When you select the Rename
option, you can use tokens to generate unique names automatically for the files.
Here are the usable tokens for renaming data files.
l Now. Insert a user-defined date format within the new filename. Possible formats
include Now(MM/dd/yyyy) or Now(MMM-dd-yyyy). See the Microsoft .Net
Framework Developer Center for available custom date/time formats.
l DataFileDirectoryName. Update the filename with the directory name, including
the drive, of your file.
l DataFileName. Insert the original filename, excluding the directory name and
extension.
l DataFileExtension. Insert the file extension, such as .csv, in the new filename.
l DataFileFullName. Insert the fully qualified filename. This data includes the
drive, directory, filename, and extension of the original file.
For example, if the data file came from the following location,
C:\DataFeed\Source\ESL\processed\ThreatData.csv, files that have been renamed
using tokens would have the following output.
Example 1
Option Description
Example 2
Important: Do not change the navigation method or file definition on the Navigation tab.
7. Click the Source Definition tab, and do not edit or remove fields.
The following table describes the fields.
Imported
Tab Field Action
Value
8. Click the Data Map tab, and verify and map data if you added new source fields.
Field Map Source Field mappings If you added any source fields, map
Fields/Target for default these fields to the target application.
Fields sources files For DeepSight threat feeds, do the
following:
1. Change the mapping of the Patch
ID.
2. Create a numeric field for the Patch
ID in the Patches application called
Patch ID Numeric.
3. Map the field to the Patch ID in the
threat feed, and assign the field as a
key field.
4. Remove patch Name as a key field.
9. Click the Schedule tab, verify that the imported values are appropriate for the data feed. If not,
make the necessary changes.
10. Click Save.
Data Publications
The Data Publication Manager allows users to extract data from RSA Archer and load it into
external systems for data analysis and modeling. To build a data publication, select the solution
whose data you want to publish, provide credentials for the database where the data is to be loaded,
and provide a schedule for automatically executing the publication. You can view the detail history
of data publication jobs, including detailed information on errors or records tried or failed.
l Last Updated Date l Values List (Fields that display the value
"No Selection" contain no value in the
l Matrix published version.)
l Numeric (Prefixes and suffixes cannot be
published.)
For example, assume that you have an application in the solution with an alias name of AppA. This
application contains an attachment field called AttachIt, a text field called TextIt, and a Values List
field called ValueIt. When DPS runs, 3 tables are created. The first one is the main table and the
table name would be AppA. This table contains columns, such as TextIt. A second table is created
for the attachment information, and it would be called AppA_AttachIt. A third table would also be
created for the Values List field, and it would be called AppA_ValueIt.
Subforms are a little more complex—subforms are contained within an application, but have their
own set of complex fields. For example, assume that you have a subform in AppA called
MySubform. This subform contains an attachment field called SubformAttachIt, and a text field
called SubformTextIt. In this case, two more tables would be created: one called AppA_
MySubform, which contains the text field (and a few other fields), and the second table would be for
the subform attachment content, and it would be called AppA_MySubform_SubformAttachIt.
Cross References have what is called a "join" table or "link" table. This is a table that contains the
content IDs from the two applications that are linked together. The table names of the join tables are
a combination of the two applications.
Note: This table only exists if both applications that are part of the relationship are included in the
solution being published.
Note: Calculated fields publish the current value of the field, not the calculation formula.
Daily Select the Start Time and the Start Date for the publication. In the Every field,
select how often the data publication should run. For example, if you select 15, the
data publication executes every 15 days.
Weekly Select the Start Time and the Start Date for the publication. In the Every field,
select how often the data publication should run. For example, if you select 5, the
data publication executes every 5 weeks. From the Weekday list, specify on which
day of the week you want the data publication to execute.
Monthly Select the Start Time and the Start Date for the publication. In the Every field,
select how often the data publication should run. For example, if you select 5, the
data publication executes every 5 months. From the Execute On list, select on
which day of the month you want the data publication to execute. From the
Weekday list, select on which day of the week you want the data publication to
execute.
Example: Connection string
For the data publication to execute successfully, the server responsible for running the data
publication must have the required network access to the database.
The following table describes the connection strings.
Data
Connection String
Base
SQL l Use this syntax to display the password in plain text in the Connection String field:
Server=ServerName;Database=DatabaseName;UID=UserName;Pwd=Pass
word
l Use this syntax to pull the password from the Password field and make it secure:
Server=ServerName;Database=DatabaseName;UID=UserName;Pwd=
{Password}
The password to the target database can be entered in either the Password field or the
Connection String field as a token as shown in the previous step. When using a token, the
{Password} token in the connection string is replaced by the password entered in this field when
the connection string is submitted.
9. (Optional) In the Password field, enter a password if you have not included it in the connection
string.
10. (Optional) In the Text Connection field, click Test to test the connection to the target database.
11. Click Save or Apply.
l Click Save to save and exit.
l Click Apply to apply the changes and continue working.
2. From the Publication Target list, select the type of database where the information is to be
published.
3. In the Connection String field, enter the connection string to the database. To use the value
entered for the password, you can enter the password token by entering the following syntax:
SQL l Use this syntax to display the password in plain text in the Connection String field:
Server=ServerName;Database=DatabaseName;UID=UserName;Pwd=Pass
word
l Use this syntax to pull the password from the Password field and make it secure:
Server=ServerName;Database=DatabaseName;UID=UserName;Pwd=
{Password}
The password to the target database can be entered in either the Password field or the
Connection String field as a token as shown in the previous step. When using a token, the
{Password} token in the connection string is replaced by the password entered in this field when
the connection string is submitted.
4. In the Password field, enter the password that the system uses when accessing the database.
5. Click Apply.
6. Click Test in the Test Connection field.
2. In the Publish field from the Immediate Processing section, click Run Update Publication Now.
3. Click Save or Apply.
l Click Save to save and exit.
l Click Apply to apply the changes and continue working.
2. From the Frequency list, select the frequency for the data publication from the following options
and complete setting up the schedule.
3. From the Time Zone list, select the current time zone for the data publication.
4. Click Save or Apply.
2. In the Actions column of the data publication that you want to view, click the Execution History
icon.
3. In the Status column, view the status to determine which job ran successfully or failed.
4. In the Actions column of the job that you want to view, click the Run Details icon.
5. When you are finished viewing the history, close the Run Detail dialog box.
6. Close all other open dialog boxes and pages.
API Integration
Web Services are an industry-standard way of integrating web-based or Internet-connected
applications using open standard protocols, such as Extensible Markup Language (XML) and Simple
Object Access Protocol (SOAP).
The RSA Archer Web Services API is a collection of web services that provide a programmatic
interface for interacting with RSA Archer. Each web service supports multiple methods that can be
used together to automate the exchange of information between RSA Archer and an external
application.
The following table describes the classes for the available web services.
Class Description
Access Provides programmatic access to the Access Control feature, such as creating users
Control and managing security parameters.
Class Description
Field Enables you to manage and configure the values lists used in the applications,
questionnaires, and sub-forms.
General Enables you to create and terminate Web Services API user sessions.
The API Integration Manager in the Integration feature offers links to download Web Services
Description Language (WSDL) files and to the Web Services API code generator to help you more
efficiently format your code to integrate applications with services. From the API Integration page,
you can also download the Web Services API Reference Guide and connect to the Web API
Development discussion forum via the Archer Community.
For more information on the RSA Archer Web Services API, see the RSA Archer Web Services API
Reference Guide, which you can access from the RSA Archer Community on RSA Link, at
https://community.rsa.com/community/products/ArcherGRC. This guide documents each available
web service and provides XML formatting guidelines and samples. If you do not have access to the
RSA Archer Community on RSA Link site, but want to obtain this guide, contact the support team at
archersupport@rsa.com.
Generating API Code
The Web Services API code generator automates the creation of a set of human-readable variables
that facilitate WebAPI development in CSharp (C#). Using the Web Service API Code Generator
page, you can generate source code that contains the Globally Unique Identifier (GUID) for each
supported element in your application.
The following application elements are included in a code generation:
l Application GUID
l Field GUIDs
l Field GUIDs for fields residing in related sub-forms
l Values list value GUIDs for Values List fields residing in the application or the related sub-forms
You can download this source code as a CSharp (.cs) file. You can then import the file into a Visual
Studio project.
For more information on the RSA Archer Web Services API, see the RSA Archer Web Services API
Reference Guide on the RSA Archer Community on RSA Link at
https://community.emc.com/community/connect/grc_ecosystem/rsa_archer. This guide documents
each available web service and provides XML formatting guidelines and samples.
Packaging terminology
The following table defines key packaging terminology.
Term Definition
Source The instance in which the package is created and from which objects are copied.
Instance
Target The instance in which the package is installed and to which objects are copied.
Instance
Object Any entity within RSA Archer that Packaging supports, for example, an application, a
sub-form, or field within an application.
Advanced A feature for mapping objects from the source instance to the target instance. By
Package default, this feature is activated during RSA Archer installation. If you are not using
Mapping Advanced Package Mapping, you can deactivate this feature in the General Settings
of the RSA Archer Control Panel.
Packaging process
The following figure shows the complete packaging process, from creating an package on the source
instance to installing it on the target instance.
Package objects
The package is a ZIP file that contains one or more objects. An object is any entity within
RSA Archer that Packaging supports, for example, an application, or a sub-form or field within an
application.
Objects can be root, level 1, or level 2 objects, as listed in the following table.
Root Objects Level 1 Objects Level 2 Objects
A Level 1 object cannot exist without a root object. Level 2 objects cannot exist without a Level 1
object. Some Level 1 objects have child objects, for example, a values list is a child of the custom
values list field. The values list includes individual values list values. All objects and elements are
transferred within a package.
When you create a package on the source instance, you can select which applications,
questionnaires, workspace, dashboards, and access roles to include. Then, when you install a
package on the target instance, you can select which of these root objects to install. For each
selected root object, you can map all child objects to existing objects in the target instance or have
the system create new objects.
Note: Packaging does not delete objects or permission settings. It only adds new or updates existing
objects and permission settings. Exceptions include layout and workflow, in which packaging
replaces the existing settings.
l Folders
l Global values lists
l Groups
Note: Groups are only added when they are used in a configuration for something in a package.
l iViews
l Letterhead templates
l Questionnaires
l Reports
l Solutions
l Sub-forms
l Workspaces
Note: Folders are used to organize certain user-created objects, such as iViews and Mail Merge
templates. iViews must exist in the package from the source instance. Values List values is a
child object of Global Values Lists.
Note: Email subscription preferences and Discussion Forum preferences are examples of user
specific preferences and attributes.
Objects are identified by a unique system ID. Nearly every object in RSA Archer has a system ID,
for example, applications, fields, and values lists.
The primary purpose of a system ID is to identify an object in the RSA Archer database. Packaging
uses system IDs to identify objects in the source and target instances. By comparing the system IDs
of objects in the source and target instances, Packaging can determine whether an object already
exists in the target and should be updated, or whether to create a new object.
All objects supported by Packaging use system IDs, with the following exceptions:
l Workflow
l Users
Workflow objects use system IDs, but Packaging does not match Workflow objects. Instead,
Packaging overwrites the workflow configuration.
Packaging Rules
The Packaging process requires numerous rules and logic to determine how the individual elements
in applications and questionnaires are migrated from one instance of RSA Archer to another.
Packaging does not delete objects or permission settings. It only adds new or adds new and updates
existing objects and permission settings. Exceptions include layout and advanced workflow, in which
packaging replaces the existing settings.
The following sections provide additional rules and logic.
Access roles
When you import access roles with groups during the packaging process, the groups are created
without any members in the target instance. After the access roles are transported from the source
instance to the target instance, you must manually add users to each group .
The following table describes the different results when you import access roles that are and are not
linked to groups, depending on your target instance.
Package Contains Access Package Contains Access Role that
Role Not Linked to a Group is Linked to a Group
Target contains Access role is updated, no group Access role is updated, group is added and
access role only changes linked in target
Target contains Access role is created, no group Access role is created, group is linked to
group only changes access role in target
Target contains Access role is updated, no group Access role is updated, group is linked to
unlinked access changes access role in target
role and group
Target contains Access role is updated, no group Access role is updated, no group changes
linked access role changes (group remains linked (group remains linked to access role)
and group to access role)
Note: If the package and target linked
groups are not the same, the access role is
linked to both groups.
Advanced workflow
Packaging rules related to advanced workflow include:
l You cannot generate a package that contains an application or questionnaire with an advanced
workflow if the Advanced Workflow Service is not running.
l If you install an application or questionnaire with an advanced workflow and the target
application or questionnaire has active advanced workflow jobs (or active advanced workflow
jobs for the applicable level in a leveled application) that are using a different version of the
workflow, the updated workflow can have unpredictable effects on the active job(s) or might
cause them to fail. RSA recommends that you review the changes in the workflow and consider
the implications those changes can have on active jobs. If you choose to install the updated
workflow, review the active jobs and update them as necessary.
l All advanced workflows are installed as inactive. After installation, review the install logs for
any errors and verify that the advanced workflow is configured correctly. Once you have
validated the advanced workflow, you then activate the workflow.
l If a package includes an advanced workflow, the following scenarios and behaviors apply
The following table describes the scenarios and behaviors.
Target Install Install
Target Result
Application Method Option
l If the package does not include an advanced workflow, the package installation does not delete or
modify any existing advanced workflow settings in the target instance.
Audit fields
Packaging rules related to audit fields include:
l The Created By and Last Updated values for all elements created during the package installation
are attributed to the user who installed the package.
l The Last Updated value for all elements that are updated during the package installation are
attributed to the user who installed the package.
Bulk actions
Packaging rules related to bulk actions include:
l All schedules are installed as inactive. After installation, review the install logs for any errors
and verify that the schedule is configured correctly. Once you have validated the configuration,
activate the schedule.
l If the Schedule Owner or Run As user for the schedule in the source instance does not exist in the
target instance, the field is left blank and a warning is logged.
Note: A system administrator or application owner must update these fields in the schedule.
Calculations
The calculation order is retained from the source to the target. This rule is also true for calculation
order that can affect data driven events.
Calculated cross-references
Packaging does not allow you to update an existing cross-reference field to a calculated cross-
reference field, and vice versa.
l If the package disassociates a link between a rule and an action, the association also is removed
in the target instance.
l Rules related to Apply Conditional Layout actions include:
o If you select the Override Layout option when installing a package, and the target instance
includes Apply Conditional Layout actions that have different objects than specified in the
package, the package installation removes the settings for the layout objects that are not
applicable to the Apply Conditional Layout actions.
o If you select the Do not Override Layout option when installing a package, and the package
includes Apply Conditional Layout actions that assume a new layout is applied, the package
installation removes the settings for the layout objects that are no longer applicable.
Default value
Packaging rules for default values abide by the following if a new field is created with a default
value, or if a default value is added to an existing field, the existing content in the target instance is
not updated with the default value.
Documentation attachments
Packaging rules related to documentation attachments include:
l Packaging includes attachment files for objects that include a documentation attachment attribute
in the configuration. These include:
o Solutions documentation
o Applications documentation
o Questionnaires documentation
o Workspaces documentation
o Dashboards documentation
o iViews documentation (for all iView types)
o Mail Merge templates report template
l The user who installed the package is listed as the creator for the attachments.
l Existing file attachments are not deleted during the installation process.
l Attachments in the package are not matched but added to the target instance. If the attachment
already exists in the target instance, a duplicate attachment is created.
Fields
Packaging rules related to fields include:
l All attributes of fields can be updated by the package installation, with the following exceptions:
o Type
o Created By
o Key Field Designation
o Related Module
o Associated Values List
l An existing private field is not changed to a public field.
Filter criteria
Packaging rules for Filter Criteria include the following attributes that are updated during
installation:
l Values. If the system cannot map a Values List Value in the target instance, that item is removed
from the Values field for the condition.
l Field to Evaluate. If the system cannot map the field in the target instance, the condition is
migrated as a null condition.
l Condition Order Number
l Operator
l Relationship
l Advanced Operator Logic
Key fields
Packaging rules for Key Fields abide by the condition if the key field in the package is different from
the key field in the target instance, the target instance retains the same key field attribute as before
the installation.
Layouts
Packaging rules related to layouts include:
l The package installation process attempts to match all layouts in the package by system ID. The
process ignores any layouts that do not match.
l You cannot map the default layout or map custom layouts to the default layout.
l You can map custom layouts to custom layouts (if they are not matched by system ID).
l If a layout is matched by system ID, you can map all layout objects on the matched layout.
Levels in applications
Packaging rules related to levels in applications include:
l Existing levels are not deleted by the package installation.
l The package installation cannot change a leveled application to a flat application.
l If the levels in the target instance are arranged in a different hierarchy than the levels in the
package, the installation fails.
Mobile questionnaires
The mobile-ready flag of a mobile-ready questionnaire is turned off during the package installation
process.
To reset the questionnaire back to mobile ready, select the Mobile Ready option in the questionnaire
properties (Manage Questionnaires > questionnaire > General tab > Options section > Mobile
Ready) in the target instance after the installation is completed.
Personal reports
Packaging rules for Personal Reports do no install personal reports in the package installation. To
include personal reports, promote the report to a global report before creating the package in the
source instance.
Record permissions
Packaging rules related to record permissions include:
l User/Groups field population can be added to Record Permissions fields, but existing ones are not
removed by the package installation.
l New inherited fields can be added, but existing ones are not removed by the package installation.
l If a User/Groups field in the target instance is configured as a Record Permissions field in the
package, the package installation changes the field to the record permissions type.
Status fields
Packaging rules related to status fields include:
l If an existing application or questionnaire is updated, the current status in the target instance is
not changed by the package installation.
l If the package creates a new application or questionnaire and there are not enough licenses, the
new application or questionnaire is set to the Development status and a warning is logged.
Trending charts
You can add trending objects (fields and charts) to packages for migrating them to a target instance.
Certain rules apply when packaging trending objects. The main rule is if the trended field is not
added to the package, the layout object cannot be added to the package.
RSA Archer uses the following rules when mapping trending objects, which are explained in the
following sections.
Same as Same as Create New and Any No change; remains the same.
Target Source Update
Shorter than Longer than Create New and Any Retains the duration period
Target Source Update specified in the Target.
Longer than Shorter than Create New and Any Retains the duration period
Target Source Update specified in the Source.
Trending Field different Create New Do Not Target instance is updated to reference the
enabled than the field and Update Override field from the Source instance.
from the Layout
Source
instance.
Trending Field different Create New Do Not Field exists in both places. The chart object
enabled than the field Only Override is updated to reference the field in the Source
from the Layout instance.
Source
instance.
Trending Field different Create New Do Not Field does not exist in the Target instance.
enabled than the field Only Override The field from the Source instance is created
from the Layout in the Target instance, and then referenced
Source by the trending chart object in the Target
instance. instance.
Trending Trending Create New Do Not Target instance is updated with any trending
enabled enabled and Update Override chart properties that exist in the Source
Layout instance. The layout is not affected.
Trending Trending Create New Override Target instance is updated with any trending
enabled enabled and Update Field chart properties that exist in the source. The
position of the trending chart object on the
application layout and the span properties are
affected.
Install Target
Source Target Layout
Method Result
Trending Trending Create New Override Position of the trending chart object on the
enabled enabled Only Layout application layout is affected. The field and
trending chart object properties are not
updated.
Trending Trending Create New Override The following message displays: Package
enabled disabled Only Layout Install Successful.
The trending chart cannot be created in the
Target instance for the following reasons:
l Referenced field is not trended.
l The packaging operation does not enable
trending in the Target instance when
Create New Only is selected.
Trending Trending Create New Override Trending chart object and referenced field
enabled disabled and Update Layout are created in the Target instance.
Application layout matches the Source
instance.
Field in the Target instance is trending-
enabled, and the associated trending chart is
created in the Target instance.
Trending Field deleted Create New Do Not Trending chart object and referenced field
enabled Only Override are created in the Target instance.
Layout Application layout is not overridden.
Trending Field deleted Create New Do Not Trending chart object and referenced field
enabled and Update Override are created in the target. Application layout
Layout is not overridden.
Trending Trending Create New Do Not Target instance is updated to reference the field
object object on and Update Override from the Source instance.
on layout Layout
layout
Trending Trending Create New Do Not Referenced field exists in both places and
object object on Only Override maps. The trending object is updated to
on layout Layout reference the field in the Source instance.
layout
Trending Trending Create New Do Not Referenced field does not exist in the Target
object object on Only Override instance. The field from the Source instance is
on layout Layout created in the Target instance, and then
layout referenced by the trending object in the Target
instance.
Trending Trending Create New Do Not Target instance is updated with any trending
object object on and Update Override chart properties that exist in the Source
on layout Layout instance. The application layout is not changed.
layout
Trending Trending Create New Override Target instance is updated with any trending
object object on and Update Layout chart properties that exist in the Source
on layout instance. The position of the trending object on
layout the application layout and the span properties
are updated to match the Source instance.
Trending Trending Create New Override Position of the trending object on the application
object object on Only Layout layout is updated. The field and trending object
on layout properties are not updated.
layout
Install Target
Source Target Layout
Method Result
Trending Placeholder Create New Override The following message is displayed: Package
object on layout Only Layout Install Successful.
on The trending chart cannot be created in the
layout Target instance for the following reasons:
l Referenced field is not trended.
l Packaging operation does not enable trending
in the Target instance when Create New
Only is selected.
Trending Placeholder Create New Override Trending object and referenced field are
object on layout and Update Layout created in the Target instance. Application
on layout matches the Source instance.
layout Field in the Target instance is trending-enabled,
and the associated trending chart is created in
the Target instance.
Trending Placeholder Create New Do Not Trending object and referenced field are
object on layout Only Override created in the Target instance. Application
on Layout layout is not overridden.
layout
Trending Placeholder Create New Do Not Trending object and referenced field are
object on layout and Update Override created in the target. Application layout is not
on Layout overridden.
layout
Values lists
Packaging rules related to values lists, which may include global values lists, questionnaire values
Workflow
Packaging rules related to workflow include:
l If a package includes workflow settings, all workflow settings from the package are installed on
the target instance and the prior workflow settings are overwritten. However, if you select the
Create New Only option when installing a package and at least one stage already exists in the
target instance, the package installation does not make any changes to the existing workflow
settings. If no workflow stages have been defined in the target instance, and you select the Create
New Only option, the package installation updates all workflow settings as specified in the
package.
l If the package does not include any workflow settings, the package installation does not delete or
modify any existing workflow settings in the target instance.
l Any records in a workflow stage that is deleted by the package installation are routed to the start
point of the workflow process.
If the modules in a package contain cross-reference fields, the package file includes additional data
to ensure that the cross references are properly maintained. As a result, package files can get very
large. Because a questionnaire contains cross-references to the Findings application, and the
Findings application references other applications, a package file that includes even a single
questionnaire can become very large. Large package files can slow the performance of the
installation process.
To optimize performance for packaging, increase the RAM on the servers.
The page file settings on the server running RSA Archer Services can have a significant impact on
performance. If the size of the page file is too small for all current processes, the system generates
an out-of-memory error that can result in a loss of functionality or unexpected results.
Installing a large package file is one scenario that can cause this condition. The resolution is to
modify the virtual memory settings on the operating system to provide more resources to the RSA
Archer Services. RSA recommends configuring the operating system to automatically manage the
paging file size for all drives.
This setting is found in the System Properties > Performance Options > Virtual Memory dialog box.
When you select Automatically manage paging file size for all drives, the operating system
automatically takes steps during resource-intensive activities to protect itself from running out of
memory.
If the server in your organization is configured with a fixed size for the paging file, you can still help
prevent out-of-memory errors by configuring the system to manage paging file sizes on other drives.
Otherwise, if the page file is fixed, the system can incur out-of-memory errors during resource-
intensive activities.
Packaging rules
The Packaging process requires a large amount of rules and logic to determine how the individual
elements in applications and questionnaires are migrated from one instance of RSA Archer to
another. In general, Packaging does not delete objects or permission settings. It only adds new or
updates existing objects and permission settings. Exceptions include layout and workflow, in which
packaging replaces the existing settings.
See Packaging Rules for additional rules and logic.
If the package was created on a version prior to 5.2, these objects are not included in the package
file and are not installed.
The RSA Archer versions of the source instance and the target instance affect the kind of package
installation you will use because of the existence of Global Unique Identifiers (GUIDs) for objects
and any dependencies, for example sub-forms, that are present in the instances. The installation of
the translation language can succeed only when the GUIDs match in both instances.
If you intend to install a translated language from a source instance that has been upgraded from a
previous version to RSA Archer version 5.5 Service Pack 2 into a target instance that as also been
upgraded, then the GUIDs do not match between the instances. To ensure that the installation
succeeds, you must select Full Install as the translation option for the package rather than
Translation-only. A full installation of the package synchronizes the GUIDs for objects and their
dependencies in both instances, whereas Translation-only does not.
Licensing issues
When installing a package with a core module in to a target instance in which it does not exist
currently, that core module must be licensed prior to the package installation in the target instance.
The package installation verifies that core solutions, applications, dashboards, and workpaces are
licensed on the target instance. If the target instance does not have the proper licenses, the objects
are not installed and errors are logged to the Package Log file. In some cases, the package
installation generates errors when installing packages that contain core applications that are properly
licensed but have not yet been installed on the target instance.
The resolution is to reapply the license key after the package installation and then install the package
again.
to objects when they are created, the system IDs of each of these objects will be different.
Because system ID mismatches occur when the same object is manually created in multiple
instances, the simplest way to avoid system ID mismatches is to use Packaging to copy all changes
from one instance to another.
Creating Packages
This process creates the package and the package description, generates the package file, and
downloads the package file to a location accessible by the target instance.
Note: To create a copy of an application in the same instance of RSA Archer, create a new
application and select the option to create a copy of an existing application.
Note: You cannot package unlicensed objects. You can view your licensed objects and any
unlicensed dependencies on the Licensing Information page. For more information see, "Viewing
Licensing Information" in the Online Documentation.
5. For each drop-down option, select the items that you want to include in the package.
Note: Selecting a Workspace does not automatically add the associated dashboards.
6. To select all dashboards associated with the selected workspaces, on the Dashboards page, click
Select Related Dashboards.
7. Click OK.
8. Click Save or Save and Close.
l Click Save to apply the changes and continue working.
l Click Save and Close to save and exit.
2. Select the package that you want to generate and review the date listed in the Last Updated
column.
Read more
The Last Updated column indicates when the package was last modified. Any changes that were
made to the source instance of RSA Archer after this date are not reflected in the package.
Read more
The date in the Last Generated column indicates when the package file was generated. If the
field is blank, the package has not been generated and a package file has not been created. If a
date is listed, but does not match the date in the Last Updated column, the package file may be
out of date. You may need to generate the package again to ensure that any recent changes to the
package are reflected in the package file.
Read more
The Generate Package File process is queued into the asynchronous job engine. The job may or
may not run immediately, depending on the jobs currently queued in the job engine. By default,
the generated package file is stored in the file repository.
Note: After a package file is generated, it is not automatically updated. If any changes are
subsequently made to the source instance, you will need to generate a new package file to ensure
that the information in the package file is current.
Note: Save the file in a location that is accessible to the RSA Archer administrator of the
instance who plans to import the package file.
Warning messages
The following table describes warning messages.
Message Description
The scheduler field {0} is missing module When packaging an application that contains a
(s) {1} from the package, this may cause scheduler field, you must also package any
errors during install. applications related to the field. If the referenced
application does not exist in the target environment,
the system generates an error during package
installation.
The {0}, {1}, references a file, {2}, that A repository file that is attached to either an
cannot be found. Please make sure this file application, questionnaire, sub-form, global values
exists in your configured repository files list, workspace, or dashboard cannot be found in the
directory, or remove and re-add the file repository. The file will not be installed during
attachment. This reference has been package installation.
excluded from the package.
A {0} with the name {1} contains a filter Filters that reference specific content are unlikely to
that references content. This may cause translate to another environment. RSA recommends
issues on package install. evaluating these filters prior to package generation
to reduce the cleanup effort after installation.
The Advanced Workflow for level {0} with The application referenced in the error message has
process ID {1} has an empty configuration. an advanced workflow configuration that is empty.
Inactivate the advanced workflow and generate the
package again.
The CAST field {0} has a reference that is When packaging an application that contains a
not included in the package. This may CAST field, RSA recommends that you also
cause an issue on installation. package any applications related to the field. If the
referenced application does not exist on the target
environment, the system generates a warning when
the package is installed.
{0} references only specific users. You cannot package specific users. Notifications,
DDEs, and other items listed may not install in the
target environment if they reference only specific
users. Verify that specific users are not referenced
in the package file.
Failure messages
The following table describes failure messages.
Message Resolution
The Workflow Service is currently Verify that the Advanced Workflow service is
unavailable. running. If it is not running, start the service.
A {0} that ties to {1} contains an invalid The referenced field contains an invalid value.
value. Delete the field and generate the package again.
The {0}, {1}, that ties to {2} is invalid. The values list value is invalid. Delete the value
from the values list.
Unable to retrieve Level Layout information The layout for the reference application is invalid.
for the given Level {0}. Delete the layout from the application.
The report {0} was unable to be packaged. The report listed has an error. Fix the report and
The following error has been thrown {1}. generate the package again.
Levels could not be found. Listed levels could not be included in the package.
Installing Packages
Package installation includes importing the package, mapping objects, and installing the package.
During this process, mapping and installation logs are created.
Note: When installing a package with a core module into a target instance in which it does not exist
currently, that core module must be licensed prior to the package installation in the target instance.
Note: Only the package file has been imported; you must install the package file to migrate the
components to your instance of RSA Archer.
Using Advanced Package Mapping, you can change the system ID of an object in the target instance
so that it matches the system ID of an object in the source package. When the system IDs match,
packaging updates the intended objects instead of creating new, duplicate objects.
Mapping objects does not change the target instance. Elements of objects can only be updated
through the package installation. Objects in the source instance are merged with objects in the target
instance. Elements of objects in the target instance can be created, or created and updated, and
layouts can be overridden during the installation process.
Note: An exception is with data driven event (DDE) notifications. Recipients in source instance
replace the recipients in the target instance.
Mapping objects is extremely important to ensure that duplicate objects are not created in the target
instance and that all objects in the target instance match the intended objects from the source
instance. If objects are not mapped properly unintended consequences will occur in the target
instance. For example, changing the system ID of a field can adversely affect any data feeds or
calculations that use this field. These issues can be difficult to identify and remedy later. Always
back up the instance database before importing and installing a package.
When a root object includes level 1 and level 2 objects, it is vital that the object is mapped to its
lowest level. Some level 1 and level 2 objects also have child elements and dependencies. These
elements must also be mapped. Map the child elements before mapping the parent object.
Important considerations
l Advanced Package Mapping requires a considerable amount of memory, which can result in loss
of data input and IE errors when working with large applications. System performance may vary
based on the size of package files. To optimize your system for packaging, RSA recommends
upgrading to Silverlight 5.06 for those users who perform the role of packaging administrator.
l Advanced Package Mapping can create unintended consequences on the instance. For example,
changing the system ID of a field can adversely affect any data feeds or calculations that use the
field, and these issues can be difficult to identify and remedy later. Before executing the mapping
process, back up your database.
l Advanced Package Mapping does not update data feeds and Web APIs. Modifying the system ID
of an object used by a data feed or Web API will break the relationship with the object. The data
feed or Web Service API will no longer function properly. The resolution is to update the data
feeds and Web Service APIs to reference the new system IDs of those objects.
l During the mapping process, you may discover discrepancies in the data, such as unwanted
objects in the source or target instance. Before installing the package, RSA recommends fixing
any discrepancies in the source or target instances, then re-creating the package. Otherwise, any
data discrepancies will be retained after the package installation.
l When mapping larger packages, RSA recommends dividing the mapping process into multiple,
smaller portions, rather than mapping and executing all of the changes at one time. You can use
the Export Mapping Settings and Import Mapping Settings features to save and load mapping
settings if needed. However, do not install the package until you have completed the entire
mapping process.
l Once a values list contains more than 1,000 values in a package, the link to display the mapping
page for that list is disabled. This allows the package mapper to continue operating successfully
without becoming over-stressed with excessive requests.
Map objects
1. Go to the Available Packages tab of the Install Packages page.
2. In the Available Packages section, select the package you want to map.
Note: This process can take several minutes or more, especially if the package is large, and may
time out after 60 minutes. This time-out setting temporarily overrides any IIS time-out settings
set to less than 60 minutes.
When the analyzer is complete, the Advanced Package Mapping page lists the objects in the
package file and corresponding objects in the target instance. The objects are divided into tabs,
depending on whether they are found within Applications, Solutions, Access Roles, Groups, Sub-
forms, or Questionnaires.
4. On each tab of the Advanced Mapping Page, review the icons that are displayed next to each
object name to determine which objects require you to map them manually.
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.
New objects should not be mapped. This icon should remain visible. The
mapping process can proceed without mapping all the objects.
Mapping Indicates that the object and all child objects are mapped to an object in
Completed 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 object
Map was not mapped through the Do Not Map option. These objects will not be
mapped through Advanced Package Mapping, and must be remedied
manually.
Undo Indicates that a mapped object can be unmapped. This icon is displayed in
the Actions column of a mapped object or object flagged as Do Not Map.
Note: You can execute the mapping process without mapping all the objects. The icon is
for informational purposes only
l To automatically map all objects in a tab that have different system IDs but the same object
name as an object in the target instance, do the following:
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 whether
spaces 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.
l 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.
6. Verify that all other objects are mapped correctly.
7. (Optional) To save your mapping settings so that you can resume working later, see Exporting
and Importing Mapping Settings.
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.
When mapping objects in a package, it is very important to map every object to its lowest level. On
the Advanced Package Mapping page for a package, when objects have child or related objects, a
drill-down link is provided on the parent object. Child objects must be mapped before parent objects
are mapped.
The following icons, located in the Actions column of a child object, identify whether these child
objects are mapped correctly.
The following table describes the icons.
Button Description
Indicates that the object and all child objects are mapped to an object in the target
instance. Nothing more needs to be done with these objects in Advanced Package
Mapping.
Indicates that the system could not automatically match the object or children of the
object to a corresponding object in the target instance.
Objects marked with this symbol must be mapped manually through the mapping
process.
New objects should not be mapped. This icon should remain visible. The mapping
process can proceed without mapping all the objects.
Applications
Questionnaires
Sub-forms
Global Verify that the Global Values Lists (GVLs) match across the source and target
Values instances. If the package changes or removes existing values in a GVL, verify that
Lists these changes do not adversely impact other objects or features that use the same
GVL. Note that this is not a concern when values are added to a GVL.
Cross- Verify that the relationships match between the source and target instances for cross-
Reference reference fields. It is possible to map a cross-reference field to a different module,
thus creating error situations after package install.
Sub-form Verify that the sub-form fields map to the same sub-form in both the source and target
instances.
Matrix Verify that the values lists referenced by the matrix field match in both the source and
target instances.
CAST Verify that the child objects match in both the source and target instances. This
mapping includes the associated application, application level, and values list fields.
If you map a values list field and its associated values list, but none of the values list values,
Packaging either updates the existing or creates new values list values under that values list. This
process can potentially create duplicate values. Anything already associated with the values list,
such as calculations or data driven events, are changed to point to the new, duplicate values.
l You cannot map to different types of values list components. For example, you cannot map a
custom values list to a global values list. In the rare instance in which you may want to map to a
different type, RSA recommends that you update the object in either the source or target instance
so that the objects match. After making the updates, regenerate the package.
Note: These recommendations also apply to the values lists in matrix fields.
Mapping objects can be an involved process that takes time to complete. To ensure mappings are not
lost prior to completing the process, Advanced Package Mapping includes Export and Import
functions.
The Export function saves the current mappings to a .csv file. When exporting and naming this file, it
is important to use a detailed, logical filename. This .csv file is exported to a designated location.
The Import function imports the saved mapping file so that the mappings can be completed.
Note: To export mapping settings you must have update rights to the Install Packages page.
Note: To import mapping settings, you must be a user with update rights to the Install Packages
page.
Override All Replaces all current mapping settings with the settings in the file
Add New Retains the current settings and adds only the new settings from the file
Add New/Override Adds new settings, retains current settings, and overrrides any current
Existing settings with the settings in the file
6. Click OK.
7. Select the file to import, and click Open.
The mapping settings are imported and displayed on the Advanced Package Mapping page.
Advanced Package Mapping includes an Undo feature for rolling back the mapping of objects. This
option is available from the Package Mapping Log. The Undo Mapping Changes feature only reverts
the mapping of the object. It does not undo the package installation. To undo a package installation,
restore the backup of the database.
Complete this task to undo changes made to system IDs during the Package Mapping process. The
following objects are not affected:
l System mapped objects.
l Objects where no Target selections exist.
The package mapping process creates a log describing the changes made to the objects in the target
instance. Complete this task to view the Package Mapping log on the Package Mapping Log page or
export a .csv file for review.
The update failed due The mapping process attempted to change a system ID to one that is
to a unique constraint already in use by another object. Two objects of the same type cannot
violation. have the same system ID.
The target object was The object mapped from the source instance to the target instance was
updated successfully. successfully updated in the target instance.
The object you The object no longer exists. It may have been inadvertently deleted in the
attempted to update time between mapping the object and executing the mapping changes.
does not exist.
The event rule order The sequential order of the DDE rule was changed in the target instance.
was changed for this
level.
The field calculation The sequential order of the field calculation was changed in the target
order was changed for instance.
this level.
2. In the Package Mapping Log section, click the package that you want to view.
Important: Ensure that you have backed up your database before beginning this procedure. The
package installation cannot be reversed. The only way to reverse a package installation is to restore
the RSA Archer database backup.
The Install Package process is queued into the asynchronous job engine. This jobs may or may not
run immediately, depending on the jobs currently queued in the job engine. The Install Package
process impersonates the user who runs the install, so any objects modified or created during the
package installation will be associated with that user.
2. Questionnaires
3. Sub-forms
4. Folders
5. Questionnaire values lists
6. Question filter properties
7. Fields
8. Reports
9. Layout
10. Workpoint Action (Advanced Workflow)
11. Navigation Menu items
12. Calculation formulas
13. Letterhead templates
14. Notifications
15. Workflows
16. Data Driven Event actions
17. Data Driven Event rules
18. Questionnaire campaigns
19. Questionnaire show/hide rules
20. Mail Merge Templates
21. Repository Install
22. Access Roles
23. iViews
24. Dashboards
25. Workspaces
All objects from the source instance are installed in the target instance unless the object cannot be
found or is flagged to not be installed in the target instance. A list of conditions that can cause
objects not to be installed is provided in the Log Messages section. A log entry displays in the
Package Installation Log section.
Install a package
If installing a package that contains Record Permissions fields, verify that users and groups already
exist in the target instance. If they do not, these fields might not install properly. If necessary, create
the users and groups in the target instance before installing the package.
2. In the Available Packages section, locate the package file that you want to install, and click
Install.
3. In the Configuration section, select the components of the package that you want to install.
l To select all components, select the top-level checkbox.
l To install only specific global reports in an already installed application, select the checkbox
associated with each report that you want to install.
Note: Items in the package that do not match an existing item in the target instance are selected
by default.
4. In the Configuration section, under Install Method, select an option for each selected
component. To use the same Install Method for all selected components, select a method from
the top-level drop-down list.
The following table describes the options.
Option Description
Create Only creates new fields and other elements in the applications, questionnaires,
New workspaces, and dashboards specified in the package file. This option does not
Only modify any existing elements on your instance of RSA Archer. This is useful when
you want to add functionality to an existing application, questionnaire, workspace,
dashboard, or access role, but you do not want to risk making any unwanted changes
to the existing elements of the applications, questionnaires, workspaces, or
dashboards. iViews that are not currently on the dashboards that are selected for the
package install are created.
Note: The Create New Only option does not apply to access roles or languages.
Note: The Create New and Update option does not apply to access roles or
languages.
5. In the Configuration section, under Install Option, select an option for each selected component.
To use the same Install Option for all selected components, select an option from the top-level
drop-down list.
The following table describes the options.
Option Description
Do not Installs the component, but does not change the existing layout. This is useful if
Override you have a lot of custom fields and formatting in your layout that you do not want
Layout to risk losing.
You may have to modify the layout after installing the package to use the changes
made by the package.
Note: The Do not Override Layout option does not apply to access roles or
languages.
Override Updates the layout as specified in the package file, overwriting the existing layout.
Layout
Note: The Override Layout option does not apply to access roles or languages.
6. To deactivate target fields and data-driven events that are not in the package, in the Post-
Install Actions section, select the Deactivate target fields and data-driven events that are not in
the package checkbox. To rename the deactivated target fields and data-driven events with a
user-defined prefix, select the Apply a prefix to all deactivated objects checkbox, and enter 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.
3. In the Package Installation Log page, in the Object Details section, click View All Warnings.
The types of messages are:
l Failures cause the installation to quit.
o Failure. A global failure that stopped the installation and rolled back all updates.
o Minor failure. A particular object failed to install.
Failure messages
The following table lists failure messages.
Message
Description
Type
Failure Package installation failed. Critical object failed to save due to validation. The
error Log Reference ID is: <log ID>.
Failure Package installation failed. Critical object failed to save due to an exception.
The error Log Reference ID is: <log ID>.
Minor Object Installation Failed. Unable to save layout object <layout object name>.
Failure
Minor The level for Field Filter Property <field filter property name> was not found.
Failure The property was not installed.
Minor The module for Field Filter Property <field filter property name> was not found.
Failure The property was not installed.
Minor Unable to update <values list name>. Cannot change a Global Values List to a
Failure Custom Values List.
Message
Description
Type
Minor The module for Questionnaire Campaign <questionnaire campaign name> was
Failure not found. The campaign was not installed.
Minor The level for Questionnaire Rule <questionnaire rule name> was not found.
Failure The rule was not installed.
Minor Advanced workflow import: Cannot install the new advanced workflow
Failure because the target component has active jobs that are using a different version
of the workflow.
Minor Advanced workflow import: Cannot find process reference in the configuration
Failure file.
Minor Advanced workflow import: Failed to upload the archive configuration file.
Failure
Minor Advanced workflow import: Cannot get the archive tree with key {0}. ({0} is
Failure the key generated by the Advanced Workflow during workflow import.)
Minor Advanced workflow import: Cannot find process object in the archive tree with
Failure key {0}. ({0} is the key generated by the Advanced Workflow during workflow
import.)
Minor Advanced workflow import: Cannot start the import request for the process {0}
Failure with key {1} and importOption {2}. ({0} is the process id generated by the
Advanced Workflow, {1} is the key generated by the Advanced Workflow.
during workflow import, {2} is the importOption parameter. Currently
importOption is set to 1, which is “Always Replace”)
Minor The matching filters for the calculated cross reference field {0} in module {1}
Failure failed to install correctly. The field was installed, but needs to be reviewed.
l Warnings allow the installation to continue with items that you should manually remediate. An
attribute of an object could not be updated or otherwise needs to be reviewed.
Warning messages
The following table describes warning messages.
Message
The following access role referenced on the Access tab could not be resolved: <access role
name>.
Cannot change the status of Application <application name>. Updating the status of an
application via package installation is not allowed.
Cannot change Values List Type of <values list type name> from Questionnaire.
Attempted to change system field type for field <field name>. Field install was skipped.
The calculated field <field name> in the application <application name> cannot be verified.
<application or questionnaire name> Apply Conditional Layout Actions <action name> were
updated due to page layout discrepancies.
The following application or questionnaire referenced on the Access tab could not be
resolved: <application or questionnaire name>.
Field Filter Property Value <field filter property name> was not found and removed from a
collection.
Field <field name> was not found and removed from a collection.
Sort field : <field name> was not found in the target instance and was removed from report :
<report name>.
Display field : <field name> was not found in the target instance and was removed from
report : <report name>.
Field : <field name> used for grouping, was not found in the target instance and was
removed from report : <report name>.
Contained Display field : <field name> was not found in the target instance and was
removed from report : <report name>.
Field : <field name> used for calendars, was not found in the target instance and was
removed from report : <report name>.
Message
Field : <field name> used for map pins was not found in the target instance and was
removed from report : <report name>.
Field : <field name> used for map addresses was not found in the target instance and was
removed from report : <report name>.
Field : <field name> referenced by a statistic step was not found in the target instance and
was removed from report : <report name>.
Field : <field name> referenced by a subform statistic step was not found in the target
instance and was removed from report : <report name>.
Field : <field name> used for charting was not found in the target instance and was removed
from report : <report name>.
Field : <field name> used for display widths was not found in the target instance and was
removed from report : <report name>.
Questionnaire Reviewer field : <field name> was not found in the target instance and was
removed from campaign : <report name>.
Questionnaire Submitter field : <field name> was not found in the target instance and was
removed from campaign : <report name>.
Field : <field name> was not found in the target instance and the condition was removed
from the filter.
Subform Field : <field name> was not found in the target instance and the condition was
removed from the filter.
Field : <field name> referenced for value matching was not found in the target instance and
the condition was removed from the filter.
Field : <field name> used for a placeholder was not found in the target instance and was
removed from notification : <notification name>.
Event Action Authorization field : <field name> was not found in the target instance and
was removed from event action : <event action>.
Score Card Related field : <field name> was not found in the target instance and was
removed from Cast Score Card field : <field name>.
Cast Related field : <field name> was not found in the target instance and was removed
from Cast Score Card field : <field name>.
Message
Subform Display field : <field name> was not found in the target instance and was removed
from subform : <subform name>.
Subform Sort field : <field name> was not found in the target instance and was removed
from subform : <subform name>.
Inherited User/Group field : <field name> was not found in the target instance and was
removed from field : <field name>.
Inherited Related Level field : <field name> was not found in the target instance and was
removed from field : <field name>.
Cross Reference View/Edit Display field : <field name> was not found in the target
instance and was removed from field : <field name>.
Cross Reference View/Edit Sort field : <field name> was not found in the target instance
and was removed from field : <field name>.
Related Record View/Edit Display field : <field name> was not found in the target instance
and was removed from field : <field name>.
Related Record View/Edit Sort field : <field name> was not found in the target instance and
was removed from field : <field name>.
History Log Field Selection field : <field name> was not found in the target instance and
was removed from history log field : <field name>.
Contained Reference field : <field name> was not found in the target instance and was
removed from multi-reference field : <field name>.
Questionnaire Reference field : <field name> was not found in the target instance and was
removed from field : <field name>.
Group <group name> was removed from <module authorization>. The group could not be
found.
Level <level name> was not found and removed from a collection.
Message
The following application or questionnaire referenced in a Quick Search iView could not be
resolved: <application or questionnaire name>.
Access rights to the following page could not be configured due to missing module: <page
name>.
The level for Navigation Menu <application or questionnaire name> was not found.
The following module referenced in the Navigation Menu could not be resolved:
<application or questionnaire name>.
<report name> report could not be created. There are no display fields for this report.
Numeric Range Value <numeric range value> was not found and removed from a
collection.
<object name> Alias was changed from <old alias name> to <new alias name>.
Object was not saved due to an exception. The error Log Reference ID is: <log ID>.
Object was not saved due to failing validation. The error Log Reference ID is: <log ID>.
The Notifications Enabled option for the <questionnaire name> Questionnaire was changed.
Cannot change the status of Questionnaire <questionnaire name>. Updating the status of a
questionnaire via package installation is not allowed.
Read Receipt disabled for <application name> application <DDE action name> action.
Message
Unable to update workflow. Content records are tied to the following workflow stages:
<workflow stage names>.
User <user name> was removed from <module authorization>. The user could not be found.
Values List Value <values list value name> was not found and removed from a collection.
Map Pin Value List Value : <values list value name> was not found in the target instance
and was removed from report: <report name>.
Questionnaire Quarter Value List Value : <values list value name> was not found in the
target instance and was removed from campaign: <campaign name>.
Questionnaire Year Value List Value : <values list value name> was not found in the target
instance and was removed from campaign: <campaign name>.
Matrix Column Values List Value : <values list value name> was not found in the target
instance and the condition was removed from the filter.
Matrix Row Values List Value : <values list value name> was not found in the target
instance and the condition was removed from the filter.
Values List Value : <values list value name> was not found in the target instance and the
condition was removed from the filter.
Cast Score Card Values List Value : <values list value name> was not found in the target
instance and the condition was removed from the filter.
Calculation Formula Values List Value : <values list value name> was not found in the
target instance.
The advanced workflow was installed, but is inactive. Please review and activate.
Module <module name> was not found. The relationship and associated display fields were
removed from the search report.
Message
<Schedule Name> references only specific users. This can potentially cause an issue on
package install.
Once the cross-reference/related record has been saved, the reference field {0} in the
module {1} cannot change from calculated to non-calculated or vice versa.
4. Click Close.
Deleting Packages
Complete this task to delete a package that is no longer needed. Package files that were generated
from the package may still be available. Deleting a package does not delete any log files that were
generated during package installation.
1. Go to the Manage Packages pages page.
Reports are saved search criteria that you can run again at a later time. The Management Reporting
feature enables you to create and manage custom reports in any application. RSA Archer also offers
out-of-the-box system reports for various features, such as application or access control reports.
There are two types of reports:
l Personal reports are only accessible by the person who created the report and the system
administrator.
l Global reports are accessible to all users in an application or to selected users and user groups.
Multi-lingual searches
Filtered searches that look for matches in selected fields can find and display matched content in any
language in which users enter content. Keyword searches can be set up by an administrator to find
content in only the design language of an RSA Archer component, or in the design language and all
other languages in which users enter content. To enable multi-lingual keyword searches, an
administrator must adjust the setting for search index contents in the RSA Archer Control Panel to
include all languages.
System Reports
RSA Archer has default system reports for the following features.
Access Provides a summary of the access control rights associated with a given access role.
Control A role is defined as a collection of access control rights that can be assigned to a
Rights by unique group of users. You can filter this report by role, application, and page type.
Role
Access Provides a summary of the access control rights currently assigned to a given user.
Control For each page in RSA Archer, you can view the create, read, update, and delete
Rights by privileges of a user. You can filter this report by user, application, and page type.
User
Application Lists the users and groups who have been assigned ownership rights over individual
Owners applications. You can filter the list by application, questionnaire, and owner.
Failed Lists all failed login attempts within the past twenty-four hours.
Login
Attempts
Locked Lists all user accounts that are currently locked. The report also includes the time
Accounts and date that each user account was locked.
Members Lists users by the user group to which the users belong. You can filter the list by
by Group user group.
Roles by Lists all groups with a corresponding description and the roles associated with each
Groups user group. You can filter this report by user group or role.
Roles by Provides a summary of the access control rights assigned to the applications in a
Solution solution. For each application, you can view all of the associated roles and the
respective content access. You can view all roles associated with the create, read,
update, or delete rights of a user for each application in RSA Archer. You can filter
this report by solution, application, or role.
Report Description
Security Lists events related to access control, PIN requests, and global report permissions
Events for monitoring the security of RSA Archer. You can filter the report by event type or
by date range.
If the reports exceeds 10,000 records, a warning message is displayed. Do one of the
following:
l To modify the search parameters, click OK.
l To include all records in a .csv file, click Download the entire report data in
CSV.
Security Lists the properties of all security parameters that have been defined within the
Parameter system. A security parameter specifies rules for password creation, password
Properties change enforcement, account-lockout duration, and session time-out behavior.
Subform Lists the users and groups who have been assigned ownership rights to individual
Owners sub-forms. You can filter the list by sub-form.
User Provides an inventory of all existing user accounts. This report displays the last
Accounts name, first name, user name, and account status for each user in RSA Archer. You
All can filter the report by access role and account status.
If the report exceeds 10,000 records, a warning message is displayed. Do one of the
following:
l To modify the search parameters, click OK.
l To include all records in a .csv file, click Download the entire report data in
CSV.
To determine the number of user accounts in RSA Archer, export the User Accounts
All report to a .csv file and note the number of line items in the spreadsheet.
User Lists the users whose accounts have remained inactive for a specific period. You
Inactivity can filter the report by inactive date and last accessed date range.
Log
Application reports
Application Shows the configuration, including the formula, for each calculated field in the
Calculation application.
Summary
Application Lists the custom objects and their associated content in the application.
Custom
Object
Summary
Application Lists the data driven events in the application, including the description, action type,
Data- and status.
Driven
Events
Summary
Application Provides detailed information about each field in the application, including field ID,
Detail description, Help text, field help options, field type, control type, selected
configuration options, access, and so on. It also contains notification and content
review information.
Application Shows the notification templates associated with the application and the
Notification configuration for each, including the assigned users and groups.
Detail
Application Provides a summary of the access control rights for private fields in the application.
Private It contains all private fields that give a user or group full access, cascade, or read-
Fields only privileges.
Application Shows the record permissions configurations in the application for manual selection
Record (including rule name and description, if applicable), inherited permissions, and
Permissions automatic selection.
Summary
Application Lists all field types in the application. It includes a count of each field type and the
Summary total number of standard and calculated fields.
by Field
Type
Report Description
Application Lists the values and configuration for each Values List field in the application.
Values List
Summary
Page Hits Provides information about the number of times application pages have been
accessed by different users during a given time frame. Pages are grouped in this
report by application. The report shows the number of times each page has been
accessed, and it also contains the total percentage of all page hits in the system and
each application portion of that total.
Record Provides details of the date and time users accessed a particular application record.
View
Detail
Record Provides a summary of the content records that have been accessed by all users
View during a given time frame. It also shows the number of content records in each
Summary application and the number of times a record has been accessed in each application.
In addition, the report contains the total percentage of all content hits in the system
and each application portion of that total.
Discussion Provides a list of each discussion forum, including the name, the community it resides
Forums in, the number of topics in the forum, the total number of posts in each forum, and the
Summary date and time of the last post to the forum.
My Provides a list of discussion forums for which you are a member. It shows the name
Discussion of each forum, the community it resides in, the topics included in it, the number of
Forums posts in each forum that you have or have not read, the total number of posts in each
forum, and the date and time of your last visit to each forum.
Notification reports
To access these from the menu bar, click . Under Notifications, click View Notification
Reports.
Notification Provides the number of successful and failed notification email deliveries within
Engine the last 24 hours.
Recent
Activity -
Last 24
Hours
Notification Provides the notification templates to which users have subscribed. The report
Subscriptions displays the template, user name, recipient email address, notification type, and
application for each notification.
Notifications Provides a list of notification emails that failed delivery. It lists the users whose
Failed Email mailbox the email attempted to reach, the email address of the recipient, the date
Attempts and time of the last email attempt, and the total number of delivery failures.
Notification Provides the status of emails triggered by notification templates that are configured
Return to request read receipts. The report shows when each email was sent, whether the
Receipts user who received each email responded to the read-receipt request, and the date
and time of each response.
Notifications Provides a list of all notification emails that have been sent. It lists the email ID,
Sent the user who received the email, the email address of the recipient, and the From
address for the email. The report also shows the notification template that triggered
each email, the subject line of each email, and the date and time each email was
sent.
Questionnaire reports
To access these reports click for the questionnaire on the Manage Questionnaires page.
The following table describes the questionnaire reports.
Report Description
Question This report lists each question within a questionnaire, along with their attributes.
Detail For Values List questions, the report also shows each answer and its attributes.
Questionnaire This report presents a bar chart indicating the answers for each Values List
Answer question and the distribution across all responses. You can filter the report by
Distribution questionnaire, category, or question. You also can click the question to view the
by Question Questionnaire Results By Question Detail report, which contains information
about each question.
Report Description
Questionnaire This report shows the configuration, including the formula, for each calculated
Calculation field within a questionnaire.
Summary
Questionnaire This report presents a bar chart of the compliance percentage for each
Compliance authoritative source within one questionnaire or across questionnaires. You can
by filter the report by questionnaire. You also can click the category to view the
Authoritative Questionnaire Results by Authoritative Source report.
Source Chart
Questionnaire This report presents a bar chart of the compliance percentage for each category
Compliance within a questionnaire. You can filter the report by questionnaire. You can click
by Category the category to view the Questionnaire Results by Category report.
Chart
Questionnaire This report presents a bar chart of the compliance percentage for each question
Compliance within a questionnaire. You can filter the report by questionnaire or category. You
by Question also can click the category to view the Questionnaire Results by Question report.
Chart
Questionnaire This report lists the custom objects and their associated content within a
Custom questionnaire.
Object
Summary
Questionnaire This report lists the data driven events within a questionnaire, including the
Data Driven description, action types, and status.
Events
Summary
Questionnaire This report provides detailed information about each field within a questionnaire.
Detail
Questionnaire This report shows the configuration of each field within a questionnaire.
Field Detail
Questionnaire This report shows the notification templates associated with a questionnaire and
Notification the configuration for each, including the assigned users and groups.
Detail
Report Description
Questionnaire This report provides a summary of the access control rights for private fields
Private Fields within a questionnaire. It lists all private fields that give a user or group full
access, cascade, or read-only privileges.
Questionnaire This report shows the record permissions configurations within a questionnaire for
Record manual selection, inherited permissions, and automatic selection Record
Permissions Permissions fields.
Summary
Questionnaire This report lists the results associated with each authoritative source attributed to
Results by one questionnaire or across questionnaires. You can filter the report by
Authoritative questionnaire, category, or authoritative source. You also can click the key field to
Source view general and reference content information about the field.
Questionnaire This report lists the results associated with each category within a questionnaire.
Results by You can filter the report by questionnaire or category. You also can click the
Category category to view the Questionnaire Results by Question report.
Questionnaire This report lists the results associated with each question within a questionnaire.
Results by You can filter the report by questionnaire, category, or question. You also can
Question click the question name to view the Questionnaire Results by Question Detail
report, which contains more information about the question.
Questionnaire This report presents a bar chart of the score for each authoritative source within
Score by one questionnaire or across questionnaires. You can click the authoritative source
Authoritative to view the Questionnaire Results by Authoritative Source report.
Source Chart
Questionnaire This report presents a bar chart of the score for each category within a
Score by questionnaire. You can filter the report by questionnaire. You also can click the
Category category view the Questionnaire Results by Category report.
Chart
Questionnaire This report lists all field types within a questionnaire. It includes a count of each
Summary by field type and the calculated fields as well as the total number of standard and
Field Type calculated fields.
Questionnaire This report lists the values and configuration for each Values List field within a
Values List questionnaire.
Summary
Solution reports
To access these reports click
Important: To view the Solution Diagram reports, you must have a copy of Microsoft Office Visio
installed on your computer.
Roles by Provides a summary of the access control rights assigned to the applications in
Solution the solution. For each application, you can view all of the associated roles and
their respective content access. You can filter this report by solution,
application or role.
Solution Produces a Visio diagram that contains the applications in a solution with all the
Diagram - All fields listed. Arrows in the diagram represent cross-reference relationships
Fields among applications and fields, along with the following information for each
application:
l Application name
l Application ID and GUID
l Application status (Production, Development, and so on)
l Number of records by data level
l Names of the key fields
l Names of all fields with their field type to understand the abbreviations used
in the solution diagram.)
l Names of all global Values List fields with the name of the global values list
Solution Shows the solutions contained in the system with their IDs and GUIDs, and a
Diagram - All listing of all applications contained in each solution. Arrows in the diagram
Solutions represent relationships among applications and questionnaires across solutions.
Solution Shows the solutions contained in the system with their IDs and GUIDs, and a
Diagram - listing of all applications contained in each solution. Arrows in the diagram
Application represent cross-reference relationships among applications and questionnaires
Relationships by contained in the solutions.
Solution
Report or
Description
Diagram
Solution Produces a Visio diagram that shows the solution name, instance name, and
Diagram - Platform version number, along with the following information for each
Application application:
Summary l Application name
l Application ID and GUID
l Application status (Production, Development, and so on)
l Number of records by data level
Solution Produces a Visio diagram that shows the solution name and Platform version
Diagram - Field number, along with the following information for each application:
Statistics l Application name
l Application ID and GUID
l Application status (Production, Development, and so on)
l Number of records by data level
l Total number of fields
l Number of fields by type (Date: 2, Numeric 3, and so on)
Report or
Description
Diagram
Solution Produces a Visio diagram that shows the solution name, instance name, and
Diagram - RSA Archer version number, along with the following information for each
Relationship application:
Fields l Application name
l Application ID and GUID
l Application status (Production, Development, and so on)
l Number of records by data level
l Names of the key fields
l Names of all relationship fields (Cross-Reference, Related Records, and
Cross-Application Status Tracking) with their field type to understand the
abbreviations used in the solution diagram.)
l Names of all global Values List fields with the name of the global values list
Solution Shows the solutions contained in the system with the solution IDs and GUIDs.
Diagram - Arrows in the diagram show the relationships among applications and
System Solution questionnaires across solutions.
Summary
Solution Provides a listing of applications and questionnaires in the solution and their
Summary descriptions. For leveled applications, the level names and descriptions also are
listed.
Sub-Form reports
A Sub-Form Detail Report is available for each sub-form in RSA Archer. To access these reports
click on the Manage Sub-Forms page.
For each field within the sub-form, the following general information is provided:
l Field Name
l Field ID
l Field Type
l Status
l Description
l Display Control
l Field Permissions
Campaign Provides a detailed list of Training and Awareness events. For each event, the report
Events provides a summary of event properties by event. You can filter this report by
campaign and event.
Campaign Allows you to view individual user responses to Training and Awareness events. You
Response can view the name of each user who participated in an event, the event name, the
Detail response type, the response date, and any comments the user included in the response.
You can filter this report by campaign, event, and response type.
Campaign Provides a summary of responses for individual events within Training and Awareness
Response campaigns. For each event, you can view the event name, status and type. You can
Summary also view the number of users who responded to the event, broken down by response
type. You can filter this report by campaign.
Campaign Lists all events within individual Training and Awareness campaigns and provides the
Status current status of each event. You can filter this report by campaign.
Details
Campaign Provides a summary of all Training and Awareness campaign statuses, including the
Status number of completed, empty, in progress, and queued campaigns.
Summary
Quiz Provides the question details for Training and Awareness quizzes. For each quiz
Event question, you can view the percentage of users who selected each answer. You can
Question filter this report by campaign, quiz, and question.
Detail
Quiz Provides the results for Training and Awareness quizzes. For each quiz, you can view
Event results for individual participants, including the percentage of questions each user
Results answered correctly and the number of times each user retook the quiz. You can filter
Detail this report by campaign and by quiz.
Report Description
Quiz Provides the results for Training and Awareness quizzes. For each quiz, you can view
Event the number of users who passed or failed the quiz and the number of users who
Results skipped the quiz or never responded. You can filter this report by campaign and by
Summary quiz.
Quiz Provides the user details for Training and Awareness quizzes. For each quiz question,
Event you can view the user entry, the correct answer and the status (correct or incorrect) of
User the user entry. You can filter this report by campaign, quiz, and user.
Detail
Note: Only users who have global report administration rights can add, edit, and delete global
reports from the Master Report Listing. To access the User Accounts All report from the Master
Report Listing, a user must have at least read permission to the Manage Users page. For more
information, see Adding User Accounts.
Add a report
Run a report
2. (Optional) Use the Grouping and Filter toolbars to filter and sort the list.
3. Select the report.
Update a report
Note: The report cannot be saved if the default language of the global report does not match the
default language of the user.
Note: If you change the cache duration from one time range to another, open and refresh the
Report iView to complete the change.
2. Click Print.
3. In the Print dialog box, click Print.
Delete a report
2. From the menu bar, click the User menu and select Reports.
c. Browse and select the .doc or .docx file you want to upload.
d. Click OK.
3. To add an Excel template, do the following:
a. In the Excel Configuration section, click Add New.
b. In the File Upload dialog box, click Add New.
c. Browse to and select the file.
d. Click OK.
4. (Optional) To specify the template as the default, select the Default option.
5. Click Save or Apply.
l Click Save to save and exit.
l Click Apply to apply the changes and continue working.
2. In the HTML Configuration section, enter the text in the Header and Footer fields.
Note: You can use the Rich Text Editor toolbar to format the text.
The Workspaces and Dashboards feature is designed to allow organizations to promote security
awareness and efficient, effective communication by providing users with quick access to
information and tools related to their job functions.
Through Workspaces and Dashboards, administrators create dashboards and iViews to display
reports, links, embedded web pages, RSS feeds, and other custom content. Administrators can
display these iViews to end users through workspaces, which are pages of related content.
1 iViews
2 Workspace
3 Dashboard
By grouping iViews with related content into dashboards and applying those dashboards to
workspaces, you can create custom views for specific user audiences. For example, a Workspaces
and Dashboards administrator could create an Incident Management workspace for personnel
involved in investigating and resolving security incidents. This workspace could contain iViews that
display investigation assignments in each user’s queue, which show the status of all unresolved
investigations and provide links to internal and external resources.
iViews can provide users at all levels in your organization hierarchy with the information they need
to make decisions, complete tasks, and stay up to date. Examples of content that may be displayed
through iViews include content review queues, links to security policies, links to industry or
regulatory sites, embedded web pages, recent vulnerability alerts, company financial information,
technology-related links and news, logon information, and security questions and answers. All of this
information can be displayed on a dashboard, allowing users to click between the iViews or view
them all at once.
Users access a workspace by clicking the workspace tab at the top of the page. As an administrator,
you can customize each workspace and the Navigation Menu to display only solutions with related
content, allowing users to access the information and tools they need without having to sort through a
lengthy menu of solutions and applications.
If you have access to at least one page in RSA Archer features, you can view the Administration
workspace that provides access to an administrative dashboard that has links and reports displayed
through iViews. In addition, you can access RSA Archer features such as Access Control,
Workspaces and Dashboards, and Application Builder from this workspace.
Building Workspaces
Workspaces are tabbed groupings of dashboards and iViews with related content. Click the
Workspace tab at the top of any page to access a workspace.
Note: When there are more tabs than can fit across the top of the page, a More tab displays to the
right of the workspace tab strip to allow you to select from a list of workspaces.
Each time an Application Builder administrator creates a new solution, a workspace is automatically
created for that solution. The workspace shares the solution name, and access to the workspace is
granted to the administrator who created the solution. Once a solution-based workspace is created,
Workspace and Dashboard administrators can configure the workspace properties, including its
content, Navigation Menu settings, and access rights.
Create a workspace
1. Go to the Workspace Menu tab of the workspace that you want to modify.
3. From the Type list, click the quick reference type you want.
The following table describes the options.
Option Action
External Allows the user to create links to external sites. When a user clicks the link, the
Link external site is displayed in the workspace section.
Add a report
a. In the Link To field, select the target report from the Available list.
b. Click OK.
c. Enter the name of the link in the Display Name field and a description in the Description
field.
Add a dashboard
a. In the Link To field, select the target dashboard from the Available list.
b. Click OK.
c. Enter the name of the link in the Display Name field and a description in the Description
field.
Delete a workspace
Deleting a workspace permanently removes the workspace and any personal associated dashboards
from the database. Deleting a workspace does not delete any global dashboards associated with the
workspace.
1. Go to the Manage Workspaces page.
a. From the menu bar, click
.
b. Under Workspaces and Dashboards, click Workspaces.
Building Dashboards
Dashboards are groupings of global iViews with related content.
Use the Dashboard list in the page toolbar to select a dashboard within a workspace.
Administrators group multiple iViews into a single dashboard to allow user to access multiple
iViews from one workspace. Administrators can build global dashboards and enable users to build
personal dashboards.
l Global dashboards. Can be viewed by all users assigned global access by administrators on the
Access tab of the Manage Dashboards page. Only administrators can edit global dashboards.
Users can rearrange global dashboards. Any modifications to the layout or size of the iViews are
saved only to the users current session.
l Personal dashboards. Can be created and viewed by all users assigned access by group, user,
role, or solution on the Access tab of the Manage Dashboards page. Personal dashboards are
specific to the user and are not confined to the user's current session only. Users can modify the
layout and size of the iViews, and the changes are saved in real time.
Build a dashboard
Important: You can configure personal dashboards only if you have been granted access by your
RSA Archer administrator.
1. From the menu bar, click the workspace to which you want to add a dashboard.
2. From the Options list, do one of the following:
l To add a new dashboard to the workspace, select Add New Global Dashboard or Add New
Personal Dashboard.
l To edit an existing dashboard, select Edit Global Dashboard Properties or Edit Personal
Dashboard.
3. On the Manage Dashboards page, enter the name of the dashboard and a description that you
want in the General section.
4. Chose your column layout in the Layout section.
5. (Optional) Add documentation to your dashboard.
6. Click OK.
7. If you are adding a new dashboard to the workspace and want to update the iView content, do
the following:
a. From the Options list, select Add iView Content.
b. On the iView Type Selection page, click Select from Global iView Library.
c. From the Name list, select the iViews that you want to display in your dashboard.
d. Click OK.
8. If you are editing an existing dashboard and want to update the iView content, do the following:
a. From the Options list in the page toolbar, select Add iView Content.
b. On the iView Type Selection page, click Select from Global iView Library.
c. From the Name list, select the iViews that you want to display in your dashboard.
d. Click OK.
9. If you are editing an existing dashboard and want to add new iView content, do the following:
a. From the Options list in the page toolbar, select Add iView Content.
b. On the iView Type Selection page, click Create a new Global iView from scratch.
c. Select the iView type.
d. Build a global iView.
e. Click OK.
Delete a dashboard
iView types
The following table describes the types of iViews.
iView
Description
Type
Canvas Displays predefined templates with various presentations for content and graphics.
Custom Displays custom text, HTML, or Flash presentations or to execute custom scripts,
such as JavaScript.
RSA recommends that only trusted Administrators have permission to create and edit
custom iViews.
Global Displays search criteria options in an iView for the user to search records across
Search applications.
Links List Displays links to websites, intranet sites, and frequently used internal application
pages in a single iView.
iView
Description
Type
Report Displays global reports in a single iView. In addition, you can display charts
generated through a statistics search.
RSS Feed Displays data from an RSS feed. RSS feeds contain headlines and summary
information from articles on websites supporting RSS.
c. In the Options section, in the Canvas Style field, click to select a layout in the Selected
Layout Template dialog box.
d. Select the layout you want, and click OK.
e. Enter a name in the Title field.
i. From the Application Name list, select the application that you want to associate the
iView to.
ii. Make selections from the Visibility field and Defaulted Behavior field.
g. (Optional) In the Documentation section, click Add New to add documentation to your
iView.
c. In the Options section, in the Reports field, select the report or reports that you want
displayed in the iView from the Available Reports list.
d. To determine the selection order of the reports in the iView, highlight the report title and use
to arrange the reports in the preferred order.
Note: The first report listed is the report that is initially displayed to the user.
e. Select Enable Scrolling for each report that you want to allow horizontal scrolling.
f. (Optional) In the Documentation section, click Add New to add documentation to your
iView.
d. (Optional) In the Documentation section, click Add New to add documentation to your
iView.
Note: The list of available menu options depends on the type of iView that you are viewing and
the access rights assigned to you by your administrator.
3. (Optional) To resize the iView, click, hold and drag the arrow in the bottom right corner of the
iView, and click Save Changes.
4. (Optional) To move the iView, click and hold the title bar of the iView and drag and drop the
iView to the new location, and click Save Changes.
.
b. Under Workspaces and Dashboards, click Global iViews.
Important: If you do not add ?mode=transparent to the end of the URL, the video displays
improperly.
3. Select the file that you want to upload, and click OK.
4. To download attached documentation to the global iView, dashboard, or workspace:
a. Click the file name in the Name column.
b. Click Save in the File Download dialog box.
c. Select the location where you want to save the document and click Save.
5. Click Save or Apply.
l Click Save to save and exit.
l Click Apply to apply the changes and continue working.
Configuring Workspaces
Configure workspaces to display specific content.
Note: Completing this procedure only sets the default workspace display order. Changing the default
does not affect any display orders that users have already customized using the Reorder button (see
Reorder workspaces on the menu bar in "Personalizing Your User Interface" in the RSA Archer
Online Documentation).
Exporting Dashboards
You can export a dashboard to an external file.
1. Display the dashboard that you want to export.
a. From the menu bar, click the workspace that contains the dashboard.
b. Click the Dashboard drop-down, and then select the dashboard.
Portable Document Format (PDF) l The title page displays the name of the
dashboard.
l Each chart type report appears on a single
page.
l iViews appear in the order in which they are
laid out on the dashboard (left to right followed
by top to bottom).
l The time and date stamp appears at the bottom
of the PDF window to indicate when the
dashboard was exported according to locale.
PowerPoint presentation (PPTX) l The title of the presentation is the same as the
name of the dashboard.
l The slide title matches the name of the report.
l The process exports only the first report of a
multi-report iView.
l Each chart-type report appears as a single
slide.
l A hierarchical report displays only the first
level without expanding the tree.
l iViews appear in the order in which they are
laid out in the dashboard (left to right and then
top to bottom).
l The table of contents contains references to all
the slides created during the export.
l The title slide displays a time and date stamp
to indicate when the dashboard was exported
according to locale.
Admin Dashboard
The Admin Dashboard displays information about the health of the system, which enables system
administrators to easily identify areas that need to be addressed. The Admin Dashboard is installed
with the main platform installation and is only available to the System Administrator and users in the
System: Admin Dashboard group.
When first added, the Admin Dashboard automatically loads data from the previous eight days at an
hourly interval. System administrators can customize which metrics are reported by adding and
editing which fields are included in Admin Dashboard.
In the Archer Control Panel, system administrators can edit the run frequency and data retention
period. The Admin Dashboard job status can be managed and the job removed from and re-added to
the Job Engine.
The Admin Dashboard also provides detailed dashboards for the following areas:
l Advanced Workflow
l Content
l Data Feeds
l Job Engine
l LDAP Sync
l Licensable Objects
l Notifications
l Search Index
l User Activity
Note: To enable all features and iViews of the Admin Dashboard, map and install the Admin
Dashboard package. For more information, see "Install the Admin Dashboard Package" in the
RSA Archer Online Documentation.
Note: Only the package file has been imported; you must map and install the package file to
migrate the components to your instance of RSA Archer.
2. In the Available Packages section, select the Admin Dashboard package, and click Install.
3. In the Configuration section, select the components of the package that you want to install.
l To select all components, select the top-level checkbox.
l To install only specific global reports in an already installed application, select the checkbox
associated with each report that you want to install.
Note: Items in the package that do not match an existing item in the target instance are selected
by default.
4. In the Configuration section, in the Install Method and Install Option fields, select one of the
following options for each selected component.
l Create New and Update
l Override Layout(s)
l Full Install
l Override Permission(s)
5. Click Install.
6. Click OK.
5. Click .
6. Select the Admin Dashboard workspace and move it vertically up or down to a new location.
Note: If you are upgrading from an earlier version of RSA Archer, you must set your appearance.
Themes from earlier versions are not converted.
Configurable options
The following table shows the configurable options for the user interface.
Option Description
Primary Sets the main color in the user interface, such as the menu bar, menus, and page
color headers.
Note: If the color of the menu bar is too similar to the color of the font, the menu
bar is rendered unreadable.
Advanced Sets additional colors for menus, pages, headers, field borders, and footers.
Options
Logo Sets the logo that appears in the lower left corner of the user interface.
Secondary Sets the image that appears next to the logo, such as a tag line.
graphic
Option Description
Field Name Sets field name alignment for record pages, questionnaires, save reports, and Add
Alignment and Display forum pages.
Field Name Sets bold field names for record pages and questionnaires. Bold field names
Contrast improve contrast and readability in record pages and questionnaires.
2. In the Color section, select the primary and secondary colors, and click OK.
Note: The default Secondary Color causes some items to display with less than the minimum
required contrast ratio defined by the Web Content Accessibility Guidelines. To remediate this,
set a darker Secondary Color.
Note: If an administrator changes the color scheme while you are working, the colors update when
you go to a different page.
Delete logos
2. In the Field Name Alignment field, choose one of the following field name alignments:
l Right
l Center
l Left
A preview of the alignment displays in the Preview field.
3. Click Save.
2. In the Field Name Contrast field, clear or select Bold Field Names.
3. Click Save.
Languages
Multiple language translations of RSA Archer navigation, solution content, and documentation are
available for licensing. A language must be licensed and activated in an instance to make its
RSA Archer navigation translations available. At least one language license is included with the
original product license and is set as the default language during installation. You can add language
licenses to provide more translations to users.
RSA Archer navigation is displayed to users in the language associated with their locale. If the
language associated with their locale is not active, the default language is displayed instead.
Administrators associate locales with a language to display formats used for dates and currency, and
localized RSA Archer functions such as calculations, time-based filtering, and reporting.
The following languages are supported for RSA Archer:
l Chinese (Simplified)
l English
l French
l German
l Italian
l Japanese
l Portuguese
l Spanish
Locales
Locales are defined by language and country to enable users to see RSA Archer content in the
format applicable to their culture. A locale can only be associated with one language and multiple
locales can be associated with the same language. A locale cannot be removed from a language if
the locale has associated users.
Administrators can set a default locale for users and user groups, however, the locale assignment is
associated only with individual users and not with groups. The assignment of a user group to a locale
assigns the locale to the current set of users in the group. Future user additions to the group do not
get the locale assignment, and future user removals from the group do not remove the user locale
setting. Users with update permissions for their accounts can set their locale to a non-default locale.
A complete list of supported locales is available on the Manage Locales page.
Translations
A translation refers to a natural-language translation of objects that you have created in RSA
Archer. The language used to create an object is its design language. The default instance language
is specified during installation. All descending RSA Archer objects, such as Module Level and
Fields, inherit the default language from the root object.
Important: When exporting a language, the content a user enters is excluded from the translation,
even when the objects are translated.
The following table shows the root objects and the descending level 1 and 2 objects that inherit the
default language:
Root Objects Level 1 Objects Level 2 Objects
You can move translations for packaged items from one instance to another, which enables testing a
translation before users have access. When importing RSA Archer core solutions, you must install a
valid license on the importing instance before installing the translation.
To obtain a license for a language that you want to add, contact your RSA sales representative.
When you receive the new license key that includes the new language license, add the language to
the instance.
You can create your own translation if you need to provide users with a language that is not one of
supported languages.
The content translation occurs outside the RSA Archer application, so the translator does not need to
be an RSA Archer user. After the translation is complete, the translator returns the language file to
the same access location so you can import it into RSA Archer.
You can export and import translation strings in both CSV and ResX formats.
The following table describes each format and its recommended use.
Format Description Recommended Use
ResX ResX export includes resources from the database in Use ResX for full translations
the industry standard ResX format used by sent to professional translators.
professional translators. This format is difficult for
manual translations.
ResX import does not include an indication of which
values were translated.
CSV CSV export includes resources from the database in Use CSV for partial translations
an easy to use table format. or translations not sent to
CSV import includes a column for the design value professional translators.
and a column for the translated value to show which This format enables the
values were translated. translator to choose from a
variety of software tools to
complete the translation.
Note: This step is only required if the files that you receive from the translator are not already
encoded in UTF-8.
1. Extract the translated .csv files from the ZIP file you received from the translator.
2. Open a CSV file in the Windows Notepad text editor application.
3. In the File menu, click Save As.
4. From the Save as type list, select All Files.
5. In the File name box, ensure that the file name extension is .csv.
6. From the Encoding list, select UTF-8.
7. Click Save.
8. Compress all encoded UTF-8 CSV files in a .zip file in the same folder in which you extracted
them. Be sure to include the same manifest file that was created in the original language export.
unintelligible characters appearing after the import process completes. UTF-8 is a comprehensive
character set that accommodates most languages, whereas many characters are not found in ASCII
or ANSI.
Consider the following before importing translated languages:
l You must import the translated language files into the same instance of RSA Archer platform
from which the language was exported for translation.
l You must use the default Windows file compression utility to create the ZIP file that contains the
translated language files to import.
l The translated language ZIP file that you import must contain all the files that you originally
exported. These files include the CSV files that were updated with the translations of the
translatable properties, as well as the manifest file.
o The CSV files and the manifest file must reside in the same folder into which they were
extracted from the original exported file.
o All files must be correctly formatted.
l Translator responsibility
o The translator should have updated only the Translated Value column in the CSV file.
o The translator must ensure that property names with associated translated text appear in the
Translation Value column of the CSV file.For information, see "Translated File Example" in
the RSA Archer Online Documentation.
l Depending on the size of the ZIP file and the attributes of your RSA Archer environment, the
import process may take several minutes to complete.
o On the Manage Languages page, during installation, the language has a Pending status.
o If the import fails, on the Manage Languages page, the language has a Failed link. Click the
link to display information about the failed import.
o When the import process is complete, an email notification is sent.
Note: You must import the translated language files into the same instance of RSA Archer from
which the language was exported for translation.
Procedure
1. Go to the Manage Languages page.
2. Click for the language that you want to import the translated language file.
3. Click Browse.
4. Click Add New, and navigate to the translated language ZIP file that you want to import.
5. Select the file, and click Open.
6. Click Import.
7. Activate the language.
The following example shows a correct entry in a CSV file for a specific property that has been
translated from the source language, English, to the target language, French. The shaded area in the
call-out shows the property name, ARA-00221, which is a simple character string instead of a
translatable word. The string is not translatable into French, so the Translated Value is the same as
the Design Value. If the Name (ARA-00221) is missing from the Translation Value column, the
French translation of Advanced Display Text does not replace the English text in the user interface.
You must activate a language to use it in RSA Archer. When the language is no longer used, you
can deactivate it.
Activate a language
Deactivate a language
Important: Deactivating a language prevents the rendering of any translations tied to it. Instead, the
system renders the design language. You cannot deactivate a language if it functions as a design
language anywhere in RSA Archer.
Languages are assigned to locales. Locales are associated to users and groups in the user account
and group in Access Control.
Note: Assigning a user group to a locale assigns the locale to the current set of users in the group.
Future user additions to the group do not get the locale assignment, and future user removals from
the group do not remove the user locale setting.
Important: A locale cannot be removed from a language if the locale has associated users.
You can set a default language for an entire instance or change the default language of individual
objects that you have created in RSA Archer.
German is the target. If the utility finds an exact match in the German translation for every English
translatable property, the change succeeds. If the German translation contains additional properties
not present in English, the utility ignores these and the change from English to German still
succeeds.
However, if you want to reverse the process and change the language from German back to the
original English, then German is the source and English is the target. The process fails because
English does not contain a match for the additional translatable properties in German.
2. Select the language you want to set as the default instance language.
3. In the Options section, select Make this the default language.
4. Click Save.
Deleting Languages
You cannot delete a language that meets any of the following criteria:
l The language is the default language for the instance.
l The language is defined as the design language for RSA Archer component.
l The language has associated locales that include users.
l The language is defined by users as their override language in user preferences.
Delete a language
1. Go to the Manage Languages page.
You can package and move a translated solution from one instance to another.
3. Log on to the instance to which you want to move the solution translation.
4. Import a package to move the package into the instance.
5. Map objects to preview the automated mapping between source and target objects and resolve
any problems with the mappings.
6. Install a package to install the package with the solution translation in the instance.
7. View the package installation log to check for and resolve warnings generated by the package
installation.
Important: The Thales N-Shield line of HSMs provides three types of key protection schemes.
However, RSA only supports key protection using OCS-protected keys.
2. After installing Thales nFast, test the OCS settings based on the test instructions provided by
Thales.
Advanced Settings.
4. In the Process Model section, ensure that the Load User Profile is set to True.
5. Click OK.
Note: In Thales nShield Connect HSM, a key generated by a client machine must be
synchronized with the RFS machine by running the command, rfs-sync.exe --commit, using
the rfs-sync.exe utility provided by Thales. (The utility is located in the following
directory: C:\Program Files (x86)\nCipher\nfast\bin) Once the key is available in the RFS
machine, other clients can obtain the key by running the following command: rfs-sync.exe --
update.
Note: The following is not a secure option as it involves execution of a different process (rfs-
sync.exe) from RSA Archer.
Note: If you change the PIN in the HSM, you need to update it in the Archer Control
Panel as well.
Note: If your organization is already using an HSM device, you may have an established
process similar to the one described in "Synchronize the keys outside RSA Archer". You
should also establish a key synchronization process for RSA Archer prior storing
encryption keys from RSA Archer in the HSM.
Note: This feature is available only if you have selected Hardware Security Module as the key
store.
You can either upload a key that you have previously obtained, or you can generate the key within
RSA Archer.
2. Click the KEK Expiration Date Calendar icon, and then select an expiration date from the
calendar.
3. Do one of the following:
l Click Generate KEK to generate the key within RSA Archer.
l Click Upload KEK, and then navigate to the key file for uploading.
4. After you have generated or uploaded the key, it appears in the Manage Keys grid.
Note: Only one key is valid at a time. If you create another key, RSA Archer disables the
previous valid one.
Important: RSA recommends that you deploy RSA Archer services in a secure location, where
physical access to the servers is restricted to the personnel who manage the servers.
For multi-host configurations, RSA Archer recommends that you do the following:
l Deploy RSA Archer web, services, and database servers in the corporate network.
l Deploy data feed servers in the corporate network, except those that provide information using
HTTPS, such as, RSS and Threat Intelligence services.
l Ensure that all RSA Archer servers in a site are connected to the same sub-network.
l Deploy firewalls at each site to ensure secure transfer of data from an instance of RSA Archer at
one site to another instance of the RSA Archer located at a different site.
l Configure firewall rules to intercept all communication between RSA Archer components in the
network, as shown in the preceding figure. For more information, see Firewall Rules.
While the previous figure shows multiple types of data feeds, the following figure expands on the
Archer-to-Archer data feed type using the example of one geographic site to another.
When deploying RSA Archer in multiple geographically dispersed sites and configuring one instance
of RSA Archer at one site to feed data to another instance of RSA Archer at another site, RSA
recommends that you do the following:
l Configure firewall rules to intercept all communication between the RSA Archer components in
the network and between different sites, as depicted by the firewalls in the preceding figure. For
more information, see Firewall Rules.
l Implement data transfer between sites using a secure tunnel as shown in the preceding figure.
Firewall Rules
Use firewalls to restrict network traffic between RSA Archer and external systems. For graphical
depictions of restricting network traffic, see Security Controls Map.
RSA strongly recommends that you configure firewall rules as described in the following sections.
These recommendations are based on the following assumptions:
l You have a stateful firewall, indicating that only the establishment of TCP ports is considered.
l You specify the direction of communication for the UDP ports because the connections are
sessionless.
l The firewall processes the rules top to bottom, finishing with a generic drop of all packets.
l You deploy RSA Archer as shown in one of the figures in Security Controls Map.
RSA recommends that you configure firewall rules to ensure secure communication for the
following connections:
l DMZ to Corporate Network
l Corporate Network to Site Sub-Network
l Archer-to-Archer Data Feeds
Single-Host Configuration
RSA recommends that you secure the following default ports to ensure a secure communication
between client machines running the RSA Archer web user interface and the RSA Archer web
server:
l TCP 80
l TCP 443
The following table shows the firewall rules for a single host configuration.
RULE | Source IP Address –>
Purpose Protocol Port
DIRECTION Destination IP Address
Multi-Host Configuration
RSA recommends that you secure the following default ports to ensure a secure communication
between client machines running the RSA Archer web user interface and the RSA Archer web
server:
l TCP 80
l TCP 443
The following table shows the firewall rules for a multi-host configuration that includes a reverse
proxy/load balancer.
RULE | Source IP Address –>
Purpose Protocol Port
DIRECTION Destination IP Address
The following table shows you how to configure the site's firewall rules.
Source IP Address –>
Purpose RULE | DIRECTION Protocol Port
Destination IP Address
HTTPS is enabled For best possible Provides a high Could impact See "Web Server
on a new 6.x security between level of protection performance. Communication"
installation, by client and server, for the in the RSA
default, between enable HTTPS and communication Archer Online
client and server. disable HTTP in between client and Documentation.
Remove any Microsoft IIS. server by avoiding
existing HTTP tampering,
bindings (port 80) spoofing, and man-
via IIS Manager. in-the-middle type
of attacks.
Persistent Session Deleting the cookie Provides increased User has to See "Enabling
Cookie holding the session security by reauthenticate. Storing the
Configuration token when the requiring Session Token in
client is closed reauthentication a Persistent
increases security. after logout or Cookie" in the
browser close. RSA Archer
Control Panel
Help.
Instructions
Cons of on How to
Secure Pros of Secure
Deployment Secure Configure
Deployment Deployment
Settings Deployment Secure
Setting Setting
Setting Deployment
Setting
Windows Server Hardening the web Provides improved Could cause Follow Microsoft
Security server based on security and some security
Configuration industry best reduced risk for the unsecured configuration
practices reduces servers deployed Windows recommendations
the likelihood of for RSA Archer. Server for the applicable
vulnerabilities. features to IIS version.
become
unavailable.
SQL Server Hardening the SQL Provides improved Could cause Follow Microsoft
Security Server installation security and some security
Configuration hosted on the reduced risk for the unsecured configuration
database server database server SQL Server recommendations
based on industry deployed for the features to for the applicable
best practices Platform become SQL server
reduces the installation. unavailable. version.
likelihood of
vulnerabilities on
the servers.
The following table provides a list of file extensions used by normal RSA Archer operations. Do not
prevent uploads of files with these extensions.
l .AI l .GIF l .PPS l .WMF
Note: To ensure that the server header is not automatically added to the outgoing HTTP response by
Microsoft IIS, use Microsoft's free UrlScan utility.
IP Whitelist
The IP Whitelist allows for the ability to define a range of IP addresses that can access RSA
Archer. The IP Whitelist restricts incoming connections only, and should include the following
items:
l Web Application servers
l Services servers
l Client machines accessing the Web Application
RSA recommends implementing the IP Whitelist to limit the availability of the Platform as a
potential attack vector.
Host Hardening
To ensure secure operation of RSA Archer, the underlying components of the host must be hardened
so that the server will function properly and opportunities for vulnerabilities are removed.
RSA Archer recommends hardening the host system under it to only allow TLS 1.2 on all
RSA Archer supported clients and servers.
l Make sure that SQL servers, Web, Services and clients have the latest service packs using TLS
1.2.
l Make sure that all security updates are applied before additional hardening is performed on all
underlying components, including, but not limited to, the Operating System, SQL, and IIS.
Due to the issues presented in SSL 2.0, the protocol is deemed unsafe to use and should be
completely disabled. Similarly, the POODLE (Padding Oracle On Downgraded Legacy Encryption)
vulnerability causes SSL 3.0 to be unsafe for use and should be disabled.
Unless there is a need to support legacy browsers, TLS 1.0 and 1.1 should also be disabled.
Web server communication over HTTP relies on the SSL/TLS ciphers and key lengths provided by
the version of IIS on which RSA Archer is installed. Ensure that IIS is configured for cryptographic
support, which cannot be easily defeated. RSA recommends that you configure Microsoft IIS to only
allow ciphers with key lengths of 128 bits or greater.
Weak ciphers, such as DES and RC4, should be disabled.
Cipher configuration
A chosen Cipher Suite is unique to the security guidelines set forth by a user's organization. It is
usually based on the level of restrictions required in the server environment, as well as the age of the
software and devices connecting to the servers (for example, the need to support legacy browsers
and regulatory requirements).
Users should implement a Security Best Practices cipher suite with Triple DES168 Cipher excluded
(from SChannel) on RSA Archer Servers including the web. This can be done via the IIS Crypto tool
available from Nartac Software. RSA recommends that you place the most secure cipher suites first
because servers often select the first supported suite from the client's list.
As guidance, RSA Archer has been tested with, as limited as, the following list of Cipher Suites and
the product remains functional:
Cipher Suite
Cipher Suite Name
Hexcode Name KeyExchange Encryption Bits
(RFC)
(OpenSSL)
Cipher Suite
Cipher Suite Name
Hexcode Name KeyExchange Encryption Bits
(RFC)
(OpenSSL)