feat(content/entries): add export to CSV feature SUP-31109 (#1021)

* export users and entries to CSV - initial commit * additional fields for users and entries export * updated fields * updated export formatters
kaltura · Jun 14, 2022 · 6628795 · 6628795
1 parent 9a25c68
commit 6628795
Show file tree

Hide file tree

Showing 15 changed files with 123 additions and 11 deletions.
diff --git a/...ra-ngx-client-12.0.0-v20220508-090406.tgz → ...ra-ngx-client-12.0.0-v20220614-103835.tgz b/...ra-ngx-client-12.0.0-v20220508-090406.tgz → ...ra-ngx-client-12.0.0-v20220614-103835.tgz
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -73,7 +73,7 @@
     "jquery": "~3.5.0",
     "jsnlog": "~2.26.2",
     "jsonschema": "~1.4.0",
-    "kaltura-ngx-client": "file:libs/kaltura-ngx-client-12.0.0-v20220508-090406.tgz",
+    "kaltura-ngx-client": "file:libs/kaltura-ngx-client-12.0.0-v20220614-103835.tgz",
     "moment": "~2.22.2",
     "ngx-page-scroll": "~5.0.1",
     "ngx-webstorage": "~5.0.0",

diff --git a/src/applications/administration-users-app/users/users-list.component.html b/src/applications/administration-users-app/users/users-list.component.html
@@ -23,6 +23,8 @@
           <span class="kSelectedUsersNum" *ngIf="_usersAmount">
             {{_usersAmount}}
           </span>
+          <button pButton class="kButtonDefault kExportBtn" (click)="_export()" type="text"
+                  [label]="'applications.content.entryDetails.distribution.export' | translate"></button>
           <button pButton class="kButtonDefault kRefreshBtn small" (click)="_reload()" type="text" icon="kIconrefresh"
                   [kTooltip]="'applications.administration.users.refresh' | translate"></button>
         </div>

diff --git a/src/applications/administration-users-app/users/users-list.component.scss b/src/applications/administration-users-app/users/users-list.component.scss
@@ -20,6 +20,14 @@
     flex-direction: column;
   }
 
+  .kExportBtn {
+      margin-left: auto;
+      margin-right: 8px;
+      ::ng-deep .p-button-icon {
+          font-size: 24px;
+      }
+  }
+
   .kRefreshBtn {
     font-size: 24px;
     border: none;
@@ -29,7 +37,6 @@
     outline: 0;
     color: $kGrayscale3;
     right: 0;
-    margin-left: auto;
     &:active {
       box-shadow: none;
       transform: rotate(45deg);

diff --git a/src/applications/administration-users-app/users/users-list.component.ts b/src/applications/administration-users-app/users/users-list.component.ts
@@ -172,4 +172,8 @@ export class UsersListComponent implements OnInit, OnDestroy {
   public _reload(): void {
     this._usersStore.reload(true);
   }
+
+  public _export(): void {
+    this._usersStore.export();
+  }
 }
diff --git a/src/applications/administration-users-app/users/users.service.ts b/src/applications/administration-users-app/users/users.service.ts
@@ -6,7 +6,7 @@ import { of } from 'rxjs';
 import { AppLocalization } from '@kaltura-ng/mc-shared';
 import { IsUserExistsStatuses } from './user-exists-statuses';
 import { cancelOnDestroy, tag } from '@kaltura-ng/kaltura-common';
-import { KalturaUser } from 'kaltura-ngx-client';
+import {KalturaAPIException, KalturaKeyValueExtended, KalturaUser, UserExportToCsvAction} from 'kaltura-ngx-client';
 import { KalturaUserRole } from 'kaltura-ngx-client';
 import { KalturaClient, KalturaMultiRequest } from 'kaltura-ngx-client';
 import { UserRoleListAction } from 'kaltura-ngx-client';
@@ -155,6 +155,40 @@ export class UsersStore implements OnDestroy {
       );
   }
 
+  public export(): void {
+      const request = new UserExportToCsvAction({
+              filter: new KalturaUserFilter({
+                  isAdminEqual: KalturaNullableBoolean.trueValue,
+                  loginEnabledEqual: KalturaNullableBoolean.trueValue,
+                  statusIn: KalturaUserStatus.active + ',' + KalturaUserStatus.blocked,
+                  orderBy: KalturaUserOrderBy.createdAtAsc.toString()
+              }),
+                mappedFields: [
+                    new KalturaKeyValueExtended({key: 'Role', value: 'roleNames', predefinedFormat: KalturaNullableBoolean.falseValue}),
+                    new KalturaKeyValueExtended({key: 'Status', value: 'status', predefinedFormat: KalturaNullableBoolean.trueValue}),
+                    new KalturaKeyValueExtended({key: 'Registration Date', value: 'createdAt', predefinedFormat: KalturaNullableBoolean.trueValue}),
+                    new KalturaKeyValueExtended({key: 'Last Login', value: 'lastLoginTime', predefinedFormat: KalturaNullableBoolean.trueValue})
+                ]
+          });
+      this._kalturaServerClient.request(request)
+          .pipe(tag('block-shell'))
+          .pipe(cancelOnDestroy(this))
+          .subscribe(
+              response => {
+                  this._browserService.alert({
+                      header: this._appLocalization.get('applications.administration.users.export'),
+                      message: this._appLocalization.get('app.common.export')
+                  });
+              },
+              (e: KalturaAPIException) => {
+                  this._browserService.alert({
+                      header: this._appLocalization.get('app.common.error'),
+                      message: e.message
+                  });
+              }
+          );
+  }
+
   public isCurrentUser(user: KalturaUser): boolean {
       return this._appAuthentication.appUser.id === user.id;
   }

diff --git a/src/applications/content-entries-app/entries/entries-list-holder.component.html b/src/applications/content-entries-app/entries/entries-list-holder.component.html
@@ -1,5 +1,6 @@
 <k-area-blocker [message]="_blockerMessage" [bodyScroll]="true">
 <kEntriesList [columns]="_columns"
+              [showExport]="true"
               [rowActions]="_rowActions"
               (onActionsSelected)="_onActionSelected($event)">
   <div class="bulk-actions">

diff --git a/...ylist/playlist-content/rule-based/playlist-rule/playlist-entries-data-provider.service.ts b/...ylist/playlist-content/rule-based/playlist-rule/playlist-entries-data-provider.service.ts
@@ -1,6 +1,6 @@
 import { Injectable, OnDestroy } from '@angular/core';
 import { KalturaBaseEntry } from 'kaltura-ngx-client';
-import { Observable } from 'rxjs';
+import {Observable, of} from 'rxjs';
 import { KalturaDetachedResponseProfile } from 'kaltura-ngx-client';
 import { KalturaMetadataSearchItem } from 'kaltura-ngx-client';
 import { KalturaNullableBoolean } from 'kaltura-ngx-client';
@@ -258,6 +258,9 @@ export class PlaylistEntriesDataProvider implements EntriesDataProvider, OnDestr
     }
   }
 
+  public exportToCsv(data: EntriesFilters): Observable<any> {
+    return of({});
+  }
 
   public executeQuery(data: EntriesFilters): Observable<{ entries: KalturaBaseEntry[], totalCount?: number }> {
     let pagination: KalturaFilterPager = null;

diff --git a/src/i18n/en.json b/src/i18n/en.json
@@ -133,7 +133,8 @@
             "save": "Save",
             "error": "Error",
             "connectionError": "Error connecting to server",
-            "invalidKs": "User session has expired. Please re-login."
+            "invalidKs": "User session has expired. Please re-login.",
+            "export": "We are preparing your report. We will send it to your email address shortly."
         },
         "redirect":{
             "redirect1": "Redirecting to default view...",
@@ -323,7 +324,8 @@
                     "noMembers": "No Members",
                     "private": "Private"
                 }
-            }
+            },
+            "export": "Export Entries"
         },
         "upload": {
             "fileStatus": {
@@ -2547,6 +2549,7 @@
                 "currentStatus": "Current status:",
                 "usersInfo": "{{0}} KMC {{1}} in use, {{2}} additional available.",
                 "failedLoading": "Failed to load users data",
+                "export": "Export Users",
                 "cantPerform": "You do not  have access to perform this action",
                 "successSavingUser": "Changes will take effect immediately. \nPlease instruct the user to refresh their browser.",
                 "personalDetails": "Personal Details",

diff --git a/src/shared/content-shared/entries/entries-list/entries-list.component.html b/src/shared/content-shared/entries/entries-list/entries-list.component.html
@@ -51,6 +51,8 @@
               </div>
             </div>
           </div>
+          <button *ngIf="showExport" pButton class="kButtonDefault kExportBtn" (click)="_export()" type="text"
+                  [label]="'applications.content.entryDetails.distribution.export' | translate"></button>
           <button *ngIf="showReload"
                   pButton
                   class="kButtonDefault kRefreshBtn small"

diff --git a/src/shared/content-shared/entries/entries-list/entries-list.component.scss b/src/shared/content-shared/entries/entries-list/entries-list.component.scss
@@ -29,6 +29,14 @@
       left: 28px;
     }
   }
+
+  .kExportBtn {
+      margin-right: 8px;
+      ::ng-deep .p-button-icon {
+          font-size: 24px;
+      }
+  }
+
   .kRefreshBtn {
     font-size: 24px;
     border: none;

diff --git a/src/shared/content-shared/entries/entries-list/entries-list.component.ts b/src/shared/content-shared/entries/entries-list/entries-list.component.ts
@@ -32,6 +32,7 @@ export interface CustomMenuItem extends MenuItem {
 })
 export class EntriesListComponent implements OnInit, OnDestroy, OnChanges {
     @Input() showReload = true;
+    @Input() showExport = false;
     @Input() selectedEntries: any[] = [];
     @Input() columns: EntriesTableColumns | null;
     @Input() rowActions: { label: string, commandName: string, styleClass: string }[];
@@ -418,6 +419,10 @@ export class EntriesListComponent implements OnInit, OnDestroy, OnChanges {
     this._entriesStore.reload();
   }
 
+  public _export(): void {
+      this._entriesStore.export();
+  }
+
   clearSelection() {
     this.selectedEntries = [];
   }

diff --git a/src/shared/content-shared/entries/entries-store/entries-store-data-provider.service.ts b/src/shared/content-shared/entries/entries-store/entries-store-data-provider.service.ts
@@ -21,7 +21,9 @@ import {
     KalturaExternalMediaSourceType,
     KalturaExternalMediaEntryFilter,
     KalturaEntryCaptionAdvancedFilter,
-    KalturaLiveChannel
+    KalturaLiveChannel,
+    BaseEntryExportToCsvAction,
+    KalturaKeyValueExtended
 } from 'kaltura-ngx-client';
 import { Observable } from 'rxjs';
 import { cancelOnDestroy, KalturaUtils } from '@kaltura-ng/kaltura-common';
@@ -333,6 +335,26 @@ export class EntriesStoreDataProvider implements EntriesDataProvider, OnDestroy
     }
   }
 
+  public exportToCsv(data: EntriesFilters): Observable<any> {
+      return <any>
+          this.getServerFilter(data)
+              .pipe(switchMap(filter => this._kalturaServerClient.request(
+                  new BaseEntryExportToCsvAction({
+                      filter,
+                      mappedFields: [
+                          new KalturaKeyValueExtended({key: 'Media Type', value: 'mediaType', predefinedFormat: KalturaNullableBoolean.trueValue}),
+                          new KalturaKeyValueExtended({key: 'Created On', value: 'createdAt', predefinedFormat: KalturaNullableBoolean.trueValue}),
+                          new KalturaKeyValueExtended({key: 'Last Update Date', value: 'updatedAt', predefinedFormat: KalturaNullableBoolean.trueValue}),
+                          new KalturaKeyValueExtended({key: 'Duration', value: 'duration', predefinedFormat: KalturaNullableBoolean.trueValue}),
+                          new KalturaKeyValueExtended({key: 'Plays', value: 'plays', predefinedFormat: KalturaNullableBoolean.falseValue}),
+                          new KalturaKeyValueExtended({key: 'Status', value: 'status', predefinedFormat: KalturaNullableBoolean.trueValue}),
+                          new KalturaKeyValueExtended({key: 'Owner', value: 'userId', predefinedFormat: KalturaNullableBoolean.falseValue})
+                      ]
+                  })
+              ))
+          );
+  }
+
   public executeQuery(data: EntriesFilters): Observable<{ entries: KalturaBaseEntry[], totalCount?: number }> {
     const responseProfile: KalturaDetachedResponseProfile = new KalturaDetachedResponseProfile({
       type: KalturaResponseProfileType.includeFields,

diff --git a/src/shared/content-shared/entries/entries-store/entries-store.service.ts b/src/shared/content-shared/entries/entries-store/entries-store.service.ts
@@ -3,7 +3,7 @@ import { BehaviorSubject } from 'rxjs';
 import { Observable } from 'rxjs';
 import { ISubscription } from 'rxjs/Subscription';
 import { MetadataProfileStore } from 'app-shared/kmc-shared';
-import { BaseEntryDeleteAction } from 'kaltura-ngx-client';
+import {BaseEntryDeleteAction, KalturaAPIException} from 'kaltura-ngx-client';
 import { KalturaMediaEntry } from 'kaltura-ngx-client';
 import { KalturaClient } from 'kaltura-ngx-client';
 import { BrowserService } from 'app-shared/kmc-shell/providers/browser.service';
@@ -27,7 +27,7 @@ import { Subject } from 'rxjs';
 import { KalturaBaseEntry } from 'kaltura-ngx-client';
 import { KalturaMediaEntryFilter } from 'kaltura-ngx-client';
 import { globalConfig } from 'config/global';
-import { cancelOnDestroy } from '@kaltura-ng/kaltura-common';
+import {cancelOnDestroy, tag} from '@kaltura-ng/kaltura-common';
 import { throwError } from 'rxjs';
 import { map } from 'rxjs/operators';
 
@@ -39,6 +39,8 @@ export enum SortDirection {
 export interface EntriesDataProvider {
   executeQuery(filters: EntriesFilters): Observable<{ entries: KalturaBaseEntry[], totalCount?: number }>;
 
+  exportToCsv(filters: EntriesFilters): Observable<any>;
+
   getDefaultFilterValues(savedAutoSelectChildren: CategoriesModes, pageSize: number): EntriesFilters;
 
   getServerFilter(filters: EntriesFilters, forRequest?: boolean): Observable<KalturaMediaEntryFilter>;
@@ -186,6 +188,25 @@ export class EntriesStore extends FiltersStoreBase<EntriesFilters> implements On
     }
   }
 
+  public export(): void {
+      this._dataProvider.exportToCsv(this._getFiltersAsReadonly())
+          .pipe(tag('block-shell'))
+          .pipe(cancelOnDestroy(this))
+          .subscribe(
+              response => {
+                  this._browserService.alert({
+                      header: this._appLocalization.get('applications.entries.export'),
+                      message: this._appLocalization.get('app.common.export')
+                  });
+              },
+              (e: KalturaAPIException) => {
+                  this._browserService.alert({
+                      header: this._appLocalization.get('app.common.error'),
+                      message: e.message
+                  });
+              });
+  }
+
   private _executeQuery(): void {
     if (this._querySubscription) {
       this._querySubscription.unsubscribe();