Requested restricted caller access (RCA)

  • Release version: Xanadu
  • Updated August 1, 2024
  • 2 minutes to read
    • Summarize
    Summarized using AI
    This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete.

    Summary of Requested Restricted Caller Access (RCA)

    Requested Restricted Caller Access (RCA) allows store applications to gain access to protected resources within the ServiceNow AI Platform without waiting for the next family release. Users with system admin or application admin roles can manage requested RCAs by reviewing, approving, or denying them.

    Show full answer Show less

    Key Features

    • RCA Classification: RCAs are divided into two categories:
      • Real RCA: When the application scope matches the target scope (sysscope==targetscope).
      • Requested RCA: When the application scope does not match the target scope (sysscope!=targetscope).
    • Access Request Process: Upon installing an application, scheduled jobs create RCA records in the target application, which initially have the status of Requested.
    • Developer Functionality: Developers can generate requested RCAs for their applications, which synchronize with real RCAs to ensure consistency.
    • Backward Compatibility: Store apps compatible with pre-Rome instances require RCA records to be packaged with an Allowed status to ensure functionality across versions.

    Key Outcomes

    By utilizing RCAs, ServiceNow customers can streamline the process of granting access to necessary resources for their applications, ensuring that all required permissions are addressed efficiently. Proper management of RCAs enhances application development and installation processes, leading to minimal disruption and improved operational integrity.

    You can use a requested RCA to grant store apps access to protected resources in the ServiceNow AI Platform without the need to wait for the next family release. If you have the system admin or application admin role, you can review requested RCAs and approve and deny them.

    RCAs are classified into two categories:
    • Real RCA: sys_scope==target_scope
    • Requested RCA: sys_scope!=target_scope
    For example: A real RCA record is where the application scope and target scope match. A requested RCA is a record that is still awaiting approval for access to the target scope.
    When you install an application, your scheduled jobs generate RCA records with the status of Requested in the target application for each requested RCA record that is packaged in the source application.
    Note:
    The jobs are generated once Upgrade Summary has run.

    Example of how a store app accesses a table

    Let's say that a store app called HR Integrations Framework wants to access an HR Core Case table. The table is in the business rule called Find Case in the Integration Service table.

    To request access, the HR Integrations Framework app requires that an RCA privilege is packaged in its own scope as follows:
    • sys_scope = HR Integrations Framework
    • target = HR Core Case
    • status = Allowed
    • target_scope = Human Resource: Core
    • source = Find Case

    App development example for developers

    When you are developing an application, real RCAs are generated with the status of Requested when the target has a caller restriction. If the target has caller tracking, the status becomes Allowed. The developer can review and finalize all the real RCA records that are required for the application to work. For example, those RCAs with a status of Allowed.

    A developer can click the Generate RCA Privileges in Current App in the related links to generate requested RCAs that are packaged in the current application. Requested RCAs are synchronized with real RCAs, which means that if a real RCA is updated or deleted, a requested RCA is updated or deleted too.

    Now, the HR Integration Framework application can be packaged and installed on a customer instance.

    App installation example for administrators

    When you are installing an app on a customer's instance, real RCAs are generated in the target application. A real RCA would have the Human Resource: Core with a status of Requested. This process is done asynchronously in a scheduled job, where some lag time can occur.

    To notify the target app admin about an RCA's pending review, messages have been added to application pages. An example is as follows:
    Figure 1. RCA pending review message
    RCA pending review message on application page.

    Store App backward compatibility

    If a store app is compatible and can be installed on an instance that is pre-Rome, then you must package the RCA records in their own scope with the status of Allowed.
    Note:
    This process ensures that the store app works on all versions.

    When upgrading to Rome, you can configure a one-time fix script to move RCAs in the source scope to the target scope. In Rome, if the target app already has the necessary RCA records, no RCA records are generated for the RCAs that are packaged by the source app.