Configuration Guide
Configuration Guide
Breadcrumbs

Exporting Reporting Data using the Synchronization Service

Definition

Reporting data can be exported as CSV files using the Synchronization Service Export Task.

Configuration

Export task definition can be used to export data from the Reporting service.

There are two differences with regular Export Tasks targeting Managed Objects:

  • The scope property is replaced by a reportingSource configuration that declares:

    1. The ReportingObjectConfiguration id that this export targets.

    2. The scope of the export.

  • The attributes property is mandatory and must declare the documents properties that should be exported (at least one).

Properties

Property Name

Type

Description

Limitation

reportingId

String

The id of the ReportingObjectConfiguration targeted for the export

-

scope

DynamicSimpleScope (static or rule)

A scope for the export data.

See Reporting Data APIs for Reporting Search Expression specifics.

Example

Export task definition 
<?xml version="1.0" encoding="UTF-8"?>
<kit:DataSet xmlns:ctd="http://www.memority.com/citadel/1_0" xmlns:ctdcore="http://www.memority.com/citadel/core/1_0" xmlns:ctdidm="http://www.memority.com/citadel/idm/1_0" xmlns:ctdrep="http://www.memority.com/citadel/rep/1_0" xmlns:ctdrule="http://www.memority.com/citadel/rule/1_0" xmlns:ctdtnt="http://www.memority.com/citadel/tnt/1_0" xmlns:dmn="http://www.memority.com/domino_sync/1_0" xmlns:kit="http://www.memority.com/toolkit/1_0" xmlns:notify="http://www.memority.com/toolkit/addons/notify/1_0" xmlns:rule="http://www.memority.com/toolkit/rule/1_0" xmlns:ruleaddon="http://www.memority.com/toolkit/addons/rule/1_0" xmlns:search="http://www.memority.com/toolkit/search-expression/1_0" xmlns:settings="http://www.memority.com/toolkit/addons/settings/1_0" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <dmn:ExportTaskDefinition id="exportTaskReporting">
      <name>exportTaskReporting</name>
      <description>Reporting export task</description>
      <attributes><!-- There must be at least one exported attribute -->
         <attribute>_id.id</attribute>
         <attribute>firstName</attribute>
         <attribute>lastName</attribute>
      </attributes>
      <active>true</active>
      <csvFileOptions>
         <quoteChar>'</quoteChar>
         <delimiterChar>,</delimiterChar>
         <commentChar>#</commentChar>
         <encoding>UTF-8</encoding>
         <lineSeparator>
</lineSeparator>
         <multiValueDelimiterChar>|</multiValueDelimiterChar>
         <includeHeaders>true</includeHeaders>
      </csvFileOptions>
      <executionPlan>
         <scheduleType>ONCE</scheduleType>
         <fireTime>2021-06-16T13:08:11.110Z</fireTime>
         <interval>0</interval>
      </executionPlan>
      <fileType>CSV</fileType>
      <limit>250</limit>
      <relativeFilePath>idm-export/SRHM-employees-{timestamp}.{type}</relativeFilePath>
      <reportingSource><!-- This replaces the traditional "scope" to target the reporting instead of the identity service -->
         <reportingId>identityDaily</reportingId>
         <scope type="EXPRESSION">
            <searchExpression>
               <search:Prop op="EQUALS" name="firstName">
                  <value script="false">John</value>
               </search:Prop>
            </searchExpression>
         </scope>
      </reportingSource>
      <retentionPeriod>P21D</retentionPeriod>
      <xlsxFileOptions>
         <sheetName>NewCitadelExport</sheetName>
         <multiValueDelimiterChar>
</multiValueDelimiterChar>
         <includeHeaders>true</includeHeaders>
         <autoSize>true</autoSize>
      </xlsxFileOptions>
   </dmn:ExportTaskDefinition>
</kit:DataSet>