Export Cell-Level Security

This REST API exports cell-level security settings from Planning or Tax Reporting into a ZIP file that contains an Excel file. Cell-level security enables Service Administrators to restrict who can view data in the application by defining rules that remove read or write access to cells that a user would normally have access to due to their regular security.

The generated file is compressed, and the output is a ZIP file that is added to the Outbox. You can download the file using the Download REST API.

Note the following requirements for the format of the Excel file used with this REST API.

The exported Excel file contains two worksheets with these names:

  1. Rules
  2. Sub Rules

The Rules worksheet has the following column headings:

  • Name
  • Position
  • Description
  • Enabled
  • Valid Cubes - This column contains either All or a list of comma-separate names of cubes, such as Plan1, Plan2
  • Anchor Dim Name
  • Anchor Dimension Apply to Unselected Members
  • Dim1
  • Dim1 Required
  • Dim2
  • Dim2 Required
  • Dim X Members
  • Dim X Required

The Sub Rules worksheet has the following column headings:

  • Name - This column contains the names of the Rules from the first sheet
  • Users
  • User Groups
  • Restriction - This column can contain Deny Read or Deny Write
  • Anchor Members
  • Anchor Exclusion
  • Dim1 Members
  • Dim1 Exclusion
  • Dim2 Members
  • Dim2 Exclusion
  • Dim X Members
  • Dim X Exclusion

Using this REST API requires prerequisites, such as understanding how to use jobs. See Prerequisites. Be sure that you understand how to use jobs as described in Managing Jobs.

REST Resource

POST       /HyperionPlanning/rest/{api_version}/applications/{application}/jobs

Request

Supported Media Types: application/json

Parameters

The following table summarizes the client request parameters specific to this job. For parameters that are common to all jobs, see Execute a Job.

Table 5-32 Export Cell Level Security

Name Description Required Default
jobType Export Cell-Level Security or EXPORT_CELL_LEVEL_SECURITY Yes None
jobName

The name of the job to be used. This job name appears on the job console.

Example: ExportCLSDPlan1

No Export Cell-Level Security Definitions
fileName

The name of the ZIP file that will be created to hold the Excel file containing cell-level security information. The file containing the exported data is stored in the Outbox.

Yes None
names

Optionally, include a comma-separated list of cell-level security definitions in the application. Information from each definition is exported to a separate Excel file and then zipped. For example, the list could contain CLSDAccountPeriod,CLSDEntityPeriod,CLSDProductPeriod .

If this parameter is not provided, all cell-level security records are exported.

No All records are exported

For a sample URL, see the sample URL and payload in Execute a Job

Example 1: Exports all cell-level security records to the file ExportCLSDRecordsFile.zip.

Sample Payload

{
    "jobType": "Export Cell-Level Security",
    "jobName": "ExportCellLevelSecurityJob",
    "parameters": {
        "fileName": "ExportCLSDRecordsFile.zip"
    }
}

Example 2: Exports three cell-level security records with names CLSDAccountPeriod, CLSDEntityPeriod, and CLSDProductPeriod to the file Export3CLSDRecordsFile.zip.

{
    "jobType": "Export Cell-Level Security",
    "jobName": "ExportCellLevelSecurityJob",
    "parameters": {
        "fileName": "Export3CLSDRecordsFile.zip",
        "names": "CLSDAccountPeriod,CLSDEntityPeriod,CLSDProductPeriod"
    }
}