Configuration Guide
Configuration Guide
Breadcrumbs

Reporting Synchronization Widget

Definition

This widget is dedicated for the display of SYNC operation.

It must be used with a "reportingId" that maps to the builtin collection SYNC_TASK_OPERATION or a custom collection that targets the same collection name ("domino_sync_task_operation").

Configuration

Properties


Property

Type

Mandatory

Description

Values (default values in bold)

type

ReportingSyncOperationWidgetType

YES

The type of the widget in XML configuration

-

reportingId

String

YES

The id of a ReportingObjectConfiguration which this widget will target. Must be a configuration which uses the SYNC_TASK_OPERATION builtin collection or a custom one that targets the same collection "domino_sync_task_operation".

-

allowExport

Boolean

NO

Allows to define if the export of the results data is allowed or not.

true,false

displayOnInit

Boolean

NO

Similar as the ReportingWidget option of the same name

true,false

contract

ReportingContractConfiguration

YES

A ReportingWidgetContractConfiguration specifying the different criteria used by the widget for displaying the filter elements. It is also used for validating the submitted criteria.

See Reporting widget contract section for detailed configuration information.

-

renderingRule

RuleDefinition (Normalization rule of REPORTING category)

NO

This rule will be applied for each document of the results and allows to transform the content. It MUST return a Map of String to Object.

Example:

XML
  <renderingRule>
   <script><![CDATA[
   // Request criteria can be accessed on VARS.criteria
   // OBJECT is still the Feature target
   // The "row" element is accessed on VALUE
   def dateCriteria = VARS.criteria["_id.date"];
 
   def thisRowFirstName = VALUE.firstName as String
    
   // A column "fullNameAndDate " can be configured on the widget
   VALUE.fullNameAndDate = "${thisRowFirstName} ${OBJECT.lastName} ${dateCriteria}";
    
   if (VALUE.lastMdAuthent != null) {
        // Nested object must be casted to List<Map<String, Object>>
        def firstMdAuthent = VALUE.lastMdAuthent as List<Map<String, Object>>;
        VALUE.firstMdAuthent = firstMdAuthent.get(0).get("md");
   }
    
   // The value must be returned
   return VALUE;
   ]]></script>
</renderingRule>

-

hiddenAttributes

List<String>

NO

Allow to hide declared attributes in the "attributeChanges" section of the display.

Example:

XML
<hiddenAttributes>
    <attribute>test_sequence</attribute>
</hiddenAttributes>

-

Example

Click to expand... 
<?xml version="1.0" encoding="UTF-8"?>
<kit:DataSet xmlns:ctd="http://www.memority.com/citadel/1_0" xmlns:ctdbpmn="http://www.memority.com/citadel/bpmn/1_0" xmlns:ctdbum="http://www.memority.com/citadel/bum/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:kit="http://www.memority.com/toolkit/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">
   <ctdbum:FeatureConfiguration id="test_reporting-sync-operation-feature">
      <updatedAt>2021-09-14T13:17:14.733Z</updatedAt>
      <name>reporting-sync-operation-feature</name>
      <description>Display report about user sync operation</description>
      <type>UI</type>
      <scope type="EXPRESSION" objectKind="IDENTITY">
         <searchExpression/>
         <objectTypes>
            <objectType>test_identityType_employee</objectType>
         </objectTypes>
      </scope>
      <options>
         <formLabelOnTop>false</formLabelOnTop>
         <pendingOperationBehaviour>WARN</pendingOperationBehaviour>
         <submit>
            <reportDisplay>DISPLAY_ALL</reportDisplay>
         </submit>
      </options>
      <screen>
         <views>
            <view id="reporting-sync-operation-view-1">
               <description></description>
               <icon>fa fa-user</icon>
               <sections>
                  <section id="reporting-sync-operation-section-1">
                     <layout>SINGLE</layout>
                     <columns>
                        <column>
                           <widgets>
                              <widget id="reporting-sync-operation-widget" xsi:type="ctdbum:ReportingSyncOperationWidgetType">
                                 <hidden>false</hidden>
                                 <config>
                                    <bordered>false</bordered>
                                    <title>false</title>
                                    <contract>
                                       <criteria>
                                          <criterion>
                                             <controlType>
                                                <multivalued>false</multivalued>
                                                <options/>
                                                <valueType>TEXT_CHOICE</valueType>
                                             </controlType>
                                             <displayFixedValue>false</displayFixedValue>
                                             <forGrouping>false</forGrouping>
                                             <mandatory>false</mandatory>
                                             <name>taskDefinition</name>
                                             <values>
                                                <staticValues/>
                                             </values>
                                          </criterion>
                                          <criterion>
                                             <controlType>
                                                <multivalued>false</multivalued>
                                                <options>
                                                   <addRangePeriod>P1D</addRangePeriod>
                                                </options>
                                                <valueType>DATE</valueType>
                                             </controlType>
                                             <displayFixedValue>false</displayFixedValue>
                                             <forGrouping>false</forGrouping>
                                             <mandatory>false</mandatory>
                                             <name>startDate</name>
                                             <values>
                                                <staticValues/>
                                             </values>
                                          </criterion>
                                          <criterion>
                                             <controlType>
                                                <multivalued>false</multivalued>
                                                <options/>
                                                <valueType>TEXT_CHOICE</valueType>
                                             </controlType>
                                             <displayFixedValue>false</displayFixedValue>
                                             <forGrouping>false</forGrouping>
                                             <mandatory>false</mandatory>
                                             <name>outcome</name>
                                             <values>
                                                <staticValues>
                                                   <value>SUCCESS</value>
                                                   <value>FAILURE</value>
                                                </staticValues>
                                             </values>
                                          </criterion>
                                       </criteria>
                                    </contract>
                                    <displayOnInit>true</displayOnInit>
                                    <reportingId>syncOperations</reportingId>
                                    <hiddenAttributes>
                                      <attribute>roles</attribute>
                                      <attribute>_passwordResetAt</attribute>
                                      <attribute>reservedFlags</attribute>
                                      <attribute>rights</attribute>
                                  </hiddenAttributes>
                                 </config>
                              </widget>
                           </widgets>
                        </column>
                     </columns>
                  </section>
               </sections>
            </view>
         </views>
         <frame>
            <actions/>
            <collapsible>false</collapsible>
            <display>PORTLET</display>
            <initiallyCollapsed>false</initiallyCollapsed>
            <title>false</title>
         </frame>
      </screen>
      <authentication>
         <authenticationLevelComparison>MINIMUM</authenticationLevelComparison>
      </authentication>
      <operations/>
      <operationOnSelf>false</operationOnSelf>
   </ctdbum:FeatureConfiguration>
</kit:DataSet>