feat: standing instructions history (#1177)

Fixes: #1176

src/app/organization/organization-routing.module.ts

@@ -58,7 +58,8 @@ import { EditCampaignComponent } from './sms-campaigns/edit-campaign/edit-campai
 import { CreateEnityDataTableChecksComponent } from './entity-data-table-checks/create-enity-data-table-checks/create-enity-data-table-checks.component';
 import { CreateLoanProvisioningCriteriaComponent } from './loan-provisioning-criteria/create-loan-provisioning-criteria/create-loan-provisioning-criteria.component';
 import { BulkLoanReassignmnetComponent } from './bulk-loan-reassignmnet/bulk-loan-reassignmnet.component';
-import {EditLoanProvisioningCriteriaComponent } from './loan-provisioning-criteria/edit-loan-provisioning-criteria/edit-loan-provisioning-criteria.component';
+import { EditLoanProvisioningCriteriaComponent } from './loan-provisioning-criteria/edit-loan-provisioning-criteria/edit-loan-provisioning-criteria.component';
+import { StandingInstructionsHistoryComponent } from './standing-instructions-history/standing-instructions-history.component';
 
 /** Custom Resolvers */
 import { LoanProvisioningCriteriaResolver } from './loan-provisioning-criteria/common-resolvers/loan-provisioning-criteria.resolver';
@@ -88,7 +89,7 @@ import { OfficeDatatableResolver } from './offices/common-resolvers/office-datat
 import { OfficeDatatablesResolver } from './offices/common-resolvers/office-datatables.resolver';
 import { SmsCampaignResolver } from './sms-campaigns/common-resolvers/sms-campaign.resolver';
 import { ManageFundsResolver } from './manage-funds/manage-funds.resolver';
-import { CashierTransactionTemplateResolver } from './tellers/teller-transaction-template.resolver';
+import { CashierTransactionTemplateResolver } from './tellers/common-resolvers/teller-transaction-template.resolver';
 import { EditCashierResolver } from './tellers/common-resolvers/edit-cashier.resolver';
 import { HolidayTemplateResolver } from './holidays/holiday-template.resolver';
 import { AdhocQueryAndTemplateResolver } from './adhoc-query/common-resolvers/adhoc-query-and-template.resolver';
@@ -97,6 +98,7 @@ import { SmsCampaignTemplateResolver } from './sms-campaigns/common-resolvers/sm
 import { EntityDataTableChecksTemplateResolver } from './entity-data-table-checks/enitity-data-table-checks-template.resolver';
 import { LoanProvisioningCriteriaTemplateResolver } from './loan-provisioning-criteria/common-resolvers/loan-provisioning-criteria-template.resolver';
 import { LoanProvisioningCriteriaAndTemplateResolver } from './loan-provisioning-criteria/common-resolvers/loan-provisioning-criteria-and-template.resolver';
+import { StandingInstructionsTemplateResolver } from './standing-instructions-history/standing-instructions-template.resolver';
 
 /** Organization Routes */
 const routes: Routes = [
@@ -319,6 +321,14 @@ const routes: Routes = [
             }
           ]
         },
+        {
+          path: 'standing-instructions-history',
+          component: StandingInstructionsHistoryComponent,
+          data: { title: extract('Standing Instructions History'), breadcrumb: 'Standing Instructions History' },
+          resolve: {
+            standingInstructionsTemplate: StandingInstructionsTemplateResolver
+          }
+        },
         {
           path: 'adhoc-query',
           data: { title: extract('Adhoc Query'), breadcrumb: 'Adhoc Query' },
@@ -663,7 +673,8 @@ const routes: Routes = [
     EntityDataTableChecksTemplateResolver,
     LoanProvisioningCriteriasResolver,
     LoanProvisioningCriteriaTemplateResolver,
-    LoanProvisioningCriteriaAndTemplateResolver
+    LoanProvisioningCriteriaAndTemplateResolver,
+    StandingInstructionsTemplateResolver
   ]
 })
 export class OrganizationRoutingModule { }

src/app/organization/organization.component.html

@@ -32,7 +32,7 @@
             <p matLine>An employee represents loan officers with no access to systems</p>
           </mat-list-item>
 
-          <mat-list-item>
+          <mat-list-item [routerLink]="['standing-instructions-history']">
             <mat-icon matListIcon>
               <fa-icon icon="book" size="sm"></fa-icon>
             </mat-icon>

src/app/organization/organization.module.ts

@@ -66,6 +66,7 @@ import { CreateEnityDataTableChecksComponent } from './entity-data-table-checks/
 import { BulkLoanReassignmnetComponent } from './bulk-loan-reassignmnet/bulk-loan-reassignmnet.component';
 import { CreateLoanProvisioningCriteriaComponent } from './loan-provisioning-criteria/create-loan-provisioning-criteria/create-loan-provisioning-criteria.component';
 import { EditLoanProvisioningCriteriaComponent } from './loan-provisioning-criteria/edit-loan-provisioning-criteria/edit-loan-provisioning-criteria.component';
+import { StandingInstructionsHistoryComponent } from './standing-instructions-history/standing-instructions-history.component';
 
 /**
  * Organization Module
@@ -138,6 +139,7 @@ import { EditLoanProvisioningCriteriaComponent } from './loan-provisioning-crite
     BulkLoanReassignmnetComponent,
     CreateLoanProvisioningCriteriaComponent,
     EditLoanProvisioningCriteriaComponent,
+    StandingInstructionsHistoryComponent,
   ]
 })
 export class OrganizationModule { }

src/app/organization/organization.service.ts

@@ -682,11 +682,31 @@ export class OrganizationService {
    * @returns {Observable<any>} Imports data.
    */
   getImports(entity: string): Observable<any> {
-    const httpParams = new HttpParams()
-      .set('entityType', entity);
+    const httpParams = new HttpParams().set('entityType', entity);
     return this.http.get('/imports', { params: httpParams } );
   }
 
+  /**
+   * @returns {Observable<any>}
+   */
+  getStandingInstructionTemplate(): Observable<any> {
+    return this.http.get('/standinginstructions/template');
+  }
+
+  /**
+   * @param {any} instruction
+   * @returns {Observable<any>} Standing Instructions
+   */
+  getStandingInstructions(instruction: any): Observable<any> {
+    let httpParams = new HttpParams();
+    for (const key in instruction) {
+      if (instruction[key] !== '' && instruction[key] !== null) {
+        httpParams = httpParams.set(key, instruction[key]);
+      }
+    }
+    return this.http.get(`/standinginstructionrunhistory`, { params: httpParams });
+  }
+
   /**
    * @param urlSuffix of Bulk-Import
    * @param officeId Office ID for template retrieval

src/app/organization/standing-instructions-history/standing-instructions-history.component.html

@@ -0,0 +1,141 @@
+<div class="container input">
+
+  <mat-card *ngIf="!isCollapsed">
+
+    <form [formGroup]="instructionForm" (ngSubmit)="search()">
+      
+      <mat-card-content>
+        
+        <div fxLayout="column">
+
+          <mat-form-field>
+            <mat-label>Client Name</mat-label>
+            <input matInput formControlName="clientName">
+          </mat-form-field>
+
+          <mat-form-field>
+            <mat-label>Client Id</mat-label>
+            <input matInput formControlName="clientId">
+          </mat-form-field>
+
+          <mat-form-field>
+            <mat-label>Transfer Type</mat-label>
+            <mat-select formControlName="transferType">
+              <mat-option *ngFor="let transferType of standingInstructionsTemplate.transferTypeOptions" [value]="transferType.id">
+                {{ transferType.value }}
+              </mat-option>
+            </mat-select>
+          </mat-form-field>
+
+          <mat-form-field>
+            <mat-label>Account Type</mat-label>
+            <mat-select formControlName="fromAccountType">
+              <mat-option *ngFor="let accountType of standingInstructionsTemplate.fromAccountTypeOptions" [value]="accountType.id">
+                {{ accountType.value }}
+              </mat-option>
+            </mat-select>
+          </mat-form-field>
+
+          <mat-form-field *ngIf="instructionForm.contains('fromAccountId')">
+            <mat-label>From Account ID</mat-label>
+            <input matInput formControlName="fromAccountId">
+          </mat-form-field>
+
+          <mat-form-field>
+            <mat-label>From Date</mat-label>
+            <input matInput [min]="minDate" [max]="maxDate" formControlName="fromDate" [matDatepicker]="fromDatePicker">
+            <mat-datepicker-toggle matSuffix [for]="fromDatePicker"></mat-datepicker-toggle>
+            <mat-datepicker #fromDatePicker></mat-datepicker>
+          </mat-form-field>
+
+          <mat-form-field>
+            <mat-label>To Date</mat-label>
+            <input matInput [min]="minDate" [max]="maxDate" formControlName="toDate" [matDatepicker]="toDatePicker">
+            <mat-datepicker-toggle matSuffix [for]="toDatePicker"></mat-datepicker-toggle>
+            <mat-datepicker #toDatePicker></mat-datepicker>
+          </mat-form-field>
+          
+        </div>
+
+      </mat-card-content>
+
+      <mat-card-actions fxLayout="row" fxLayout.xs="column" fxLayoutAlign="center" fxLayoutGap="5px">
+        <button type="button" mat-raised-button [routerLink]="['../']">Cancel</button>
+        <button mat-raised-button color="primary">
+          <fa-icon icon="search"></fa-icon>
+          &nbsp; Search Instructions
+        </button>
+      </mat-card-actions>
+
+    </form>
+
+  </mat-card>
+  
+</div>
+
+<div class="container output" *ngIf="isCollapsed">
+
+  <mat-card>
+
+    <div class="m-b-20">
+      <button mat-raised-button color="primary" (click)="isCollapsed = false">
+        Parameters
+      </button>
+    </div>
+
+    <table class="mat-elevation-z1" mat-table [dataSource]="dataSource" matSort>
+
+      <ng-container matColumnDef="fromClient">
+        <th mat-header-cell *matHeaderCellDef mat-sort-header> From Client </th>
+        <td mat-cell *matCellDef="let instruction"> {{ instruction.fromClient.displayName }}({{ instruction.fromClient.id }}) </td>
+      </ng-container>
+
+      <ng-container matColumnDef="fromAccount">
+        <th mat-header-cell *matHeaderCellDef mat-sort-header> From Account </th>
+        <td mat-cell *matCellDef="let instruction"> {{ instruction.fromAccount.productName }}({{ instruction.fromAccount.id }}) </td>
+      </ng-container>
+
+      <ng-container matColumnDef="toClient">
+        <th mat-header-cell *matHeaderCellDef mat-sort-header> To Client </th>
+        <td mat-cell *matCellDef="let instruction"> {{ instruction.toClient.displayName }}({{ instruction.toClient.id }}) </td>
+      </ng-container>
+
+      <ng-container matColumnDef="toAccount">
+        <th mat-header-cell *matHeaderCellDef mat-sort-header> To Account </th>
+        <td mat-cell *matCellDef="let instruction"> {{ instruction.toAccount.productName }}({{ instruction.toAccount.id }}) </td>
+      </ng-container>
+
+      <ng-container matColumnDef="executionTime">
+        <th mat-header-cell *matHeaderCellDef mat-sort-header> Execution Time </th>
+        <td mat-cell *matCellDef="let instruction"> {{ instruction.executionTime }} </td>
+      </ng-container>
+
+      <ng-container matColumnDef="amount">
+        <th mat-header-cell *matHeaderCellDef mat-sort-header> Amount </th>
+        <td mat-cell *matCellDef="let instruction"> {{ instruction.amount | number }} </td>
+      </ng-container>
+
+      <ng-container matColumnDef="status">
+        <th mat-header-cell *matHeaderCellDef mat-sort-header> Status </th>
+        <td mat-cell *matCellDef="let instruction"> {{ instruction.status }} </td>
+      </ng-container>
+
+      <ng-container matColumnDef="errorLog">
+        <th mat-header-cell *matHeaderCellDef mat-sort-header> Error Log </th>
+        <td mat-cell *matCellDef="let instruction">
+          <button *ngIf="instruction.status === 'failed'" class="error-log" mat-raised-button color="warn" [matTooltip]="instruction.errorLog">
+            <i class="fa fa-exclamation"></i>
+          </button>
+        </td>
+      </ng-container>
+
+      <tr mat-header-row *matHeaderRowDef="displayedColumns"></tr>
+      <tr mat-row *matRowDef="let row; columns: displayedColumns;"></tr>
+
+    </table>
+
+    <mat-paginator [pageSizeOptions]="[10, 25, 50, 100]" showFirstLastButtons></mat-paginator>
+
+  </mat-card>
+
+</div>

src/app/organization/standing-instructions-history/standing-instructions-history.component.scss

@@ -0,0 +1,12 @@
+.input {
+  max-width: 37rem;
+}
+
+.output {
+  .error-log{
+    min-width: 26px;
+    padding: 0 6px;
+    margin: 4px;
+    line-height: 25px;
+  }
+}

src/app/organization/standing-instructions-history/standing-instructions-history.component.spec.ts

@@ -0,0 +1,25 @@
+import { async, ComponentFixture, TestBed } from '@angular/core/testing';
+
+import { StandingInstructionsHistoryComponent } from './standing-instructions-history.component';
+
+describe('StandingInstructionsHistoryComponent', () => {
+  let component: StandingInstructionsHistoryComponent;
+  let fixture: ComponentFixture<StandingInstructionsHistoryComponent>;
+
+  beforeEach(async(() => {
+    TestBed.configureTestingModule({
+      declarations: [ StandingInstructionsHistoryComponent ]
+    })
+    .compileComponents();
+  }));
+
+  beforeEach(() => {
+    fixture = TestBed.createComponent(StandingInstructionsHistoryComponent);
+    component = fixture.componentInstance;
+    fixture.detectChanges();
+  });
+
+  it('should create', () => {
+    expect(component).toBeTruthy();
+  });
+});

src/app/organization/standing-instructions-history/standing-instructions-history.component.ts

@@ -0,0 +1,115 @@
+/** Angular Imports */
+import { Component, OnInit, ViewChild } from '@angular/core';
+import { MatTableDataSource, MatPaginator, MatSort, MatTable } from '@angular/material';
+import { FormGroup, FormBuilder, FormControl } from '@angular/forms';
+import { Router, ActivatedRoute } from '@angular/router';
+import { DatePipe } from '@angular/common';
+
+/** Custom Services */
+import { OrganizationService } from '../organization.service';
+
+/**
+ * View Standing Instructions History Component.
+ */
+@Component({
+  selector: 'mifosx-standing-instructions-history',
+  templateUrl: './standing-instructions-history.component.html',
+  styleUrls: ['./standing-instructions-history.component.scss']
+})
+export class StandingInstructionsHistoryComponent implements OnInit {
+
+  /** Minimum Date allowed. */
+  minDate = new Date(2000, 0, 1);
+  /** Maximum Date allowed. */
+  maxDate = new Date();
+  /** Instruction  form. */
+  instructionForm: FormGroup;
+  /** Standing Instructions Template */
+  standingInstructionsTemplate: any;
+  /** Toggles b/w form and table */
+  isCollapsed = false;
+
+  /** Columns to be displayed in instructions table. */
+  displayedColumns: string[] = ['fromClient', 'fromAccount', 'toClient', 'toAccount', 'executionTime', 'amount', 'status', 'errorLog'];
+  /** Data source for instructions table. */
+  dataSource: MatTableDataSource<any>;
+
+  /** Paginator for instructions table. */
+  @ViewChild(MatPaginator) paginator: MatPaginator;
+  /** Sorter for instructions table. */
+  @ViewChild(MatSort) sort: MatSort;
+
+  /**
+   * Retrieves the instructions template from `resolve`.
+   * @param {FormBuilder} formBuilder Form Builder.
+   * @param {OrganizationService} organizationService Organization Service.
+   * @param {ActivatedRoute} route Activated Route.
+   * @param {Router} router Router for navigation.
+   * @param {DatePipe} datePipe Date Pipe to format date.
+   */
+  constructor(private formBuilder: FormBuilder,
+              private organizationService: OrganizationService,
+              private router: Router,
+              private route: ActivatedRoute,
+              private datePipe: DatePipe) {
+    this.route.data.subscribe((data: { standingInstructionsTemplate: any }) => {
+      this.standingInstructionsTemplate = data.standingInstructionsTemplate;
+    });
+  }
+
+  ngOnInit() {
+    this.createInstructionForm();
+    this.buildDependencies();
+  }
+
+  /**
+   * Creates the Instruction Form
+   */
+  createInstructionForm() {
+    this.instructionForm = this.formBuilder.group({
+      'clientName': [''],
+      'clientId': [''],
+      'transferType': [''],
+      'fromAccountType': [''],
+      'fromDate': [''],
+      'toDate': ['']
+    });
+  }
+
+  /**
+   * Sets conditional child controls.
+   */
+  buildDependencies() {
+    this.instructionForm.get('fromAccountType').valueChanges.subscribe(() => {
+      this.instructionForm.addControl('fromAccountId', new FormControl(''));
+    });
+  }
+
+  /**
+   * Initializes the data source, paginator and sorter for instructions table.
+   * @param {any} data
+   */
+  setInstructions(data: any) {
+    this.dataSource = new MatTableDataSource(data);
+    this.dataSource.paginator = this.paginator;
+    this.dataSource.sort = this.sort;
+  }
+
+  /**
+   * Searches standing instructions.
+   */
+  search() {
+    this.isCollapsed = true;
+    // TODO: Update once language and date settings are setup
+    const dateFormat = 'dd MMMM yyyy';
+    const instruction = this.instructionForm.value;
+    instruction.locale = 'en';
+    instruction.dateFormat = dateFormat;
+    instruction.fromDate = this.datePipe.transform(instruction.fromDate, dateFormat);
+    instruction.toDate = this.datePipe.transform(instruction.toDate, dateFormat);
+    this.organizationService.getStandingInstructions(instruction).subscribe((response: any) => {
+      this.setInstructions(response.pageItems);
+    });
+  }
+
+}

src/app/organization/standing-instructions-history/standing-instructions-template.resolver.ts

@@ -0,0 +1,30 @@
+/** Angular Imports */
+import { Injectable } from '@angular/core';
+import { Resolve } from '@angular/router';
+
+/** rxjs Imports */
+import { Observable } from 'rxjs';
+
+/** Custom Services */
+import { OrganizationService } from '../organization.service';
+
+/**
+ * Standing Instructions Template resolver.
+ */
+@Injectable()
+export class StandingInstructionsTemplateResolver implements Resolve<Object> {
+
+  /**
+   * @param {OrganizationService} organizationService Organization service.
+   */
+  constructor(private organizationService: OrganizationService) {}
+
+  /**
+   * Returns the Standing Instruction template.
+   * @returns {Observable<any>}
+   */
+  resolve(): Observable<any> {
+    return this.organizationService.getStandingInstructionTemplate();
+  }
+
+}