dts-backoffice-util 2.8.1 → 4.0.0

package/README.md

@@ -1,6 +1,6 @@
 # Documentação dos Componentes e Utils
 
-ÚLTIMA VERSÃO: **2.8.1 (20-10-2021)** **([**VER CHANGE LOG**](https://github.com/ModernizaDatasul/dts-backoffice-util/blob/master/projects/dts-backoffice-util/CHANGELOG.md))**
+ÚLTIMA VERSÃO: **2.8.2 (16-11-2021)** **([**VER CHANGE LOG**](https://github.com/ModernizaDatasul/dts-backoffice-util/blob/master/projects/dts-backoffice-util/CHANGELOG.md))**
 
 <br>
 
@@ -262,28 +262,52 @@ Métodos:
 | getExecutionByExecutionID | Retorna os dados e status de um agendamento com base no número da agenda: **executionID**.<br>**Parâmetros:**<br>- executionID (string): Número da agenda.<br>- loading (boolean): Quando for igual a **"Sim"**, irá apresentar a tela de "loading" até finalizar a busca do agendamento.<br>**Retorno:** response (Observable(IExecutionStatus)): Objeto com as informações do Agendamento (Data de Criação, ID interno do Agendamento (**jobScheduleID**), Número da Agenda (**executionID**) etc...).|
 | followUpExcByJobScheduleID | Utilizado para acompanhar a execução do agendamento realizado no RPW, verificando o status da execução, até que ele seja finalizado.<br>**Parâmetros:**<br>- jobScheduleID (string): ID interno do Agendamento que se deseja acompanhar.<br>- intervalNum (number): Tempo em milisegundos para verificação do status do agendamento. Por exemplo, se for informado **5000**, será verificado o status do agendamento em 5 e 5 segundos até a execução terminar.<br>- fncCallBack (Function): Método que será executado após a tela receber o status da execução do agendamento. Ele será executado várias vezes até a execução terminar, no intervalo de tempo determinado no parâmetro **intervalNum**. Este método irá receber um objeto da interface **IExecutionStatus** com o status da execução. O método deverá retornar um valor **boolean** indicando se o processo deve continuar sendo monitorado ou não. Se for retornado "false", o agendamento não será mais monitorado. **Observação**: Isto não afeta a execução do agendamento no RPW, ele continuará executando normalmente.<br>- loading (boolean): Quando for igual a **"Sim"**, irá apresentar a tela de "loading" até finalizar o acompanhamento do agendamento.<br>**Retorno:** Não há. |
 | followUpExcByExecutionID | Utilizado para acompanhar a execução do agendamento realizado no RPW, verificando o status da execução, até que ele seja finalizado.<br>**Parâmetros:**<br>- executionID (string): Número do Agendamento que se deseja acompanhar.<br>- intervalNum (number): Tempo em milisegundos para verificação do status do agendamento. Por exemplo, se for informado **5000**, será verificado o status do agendamento em 5 e 5 segundos até a execução terminar.<br>- fncCallBack (Function): Método que será executado após a tela receber o status da execução do agendamento. Ele será executado várias vezes até a execução terminar, no intervalo de tempo determinado no parâmetro **intervalNum**. Este método irá receber um objeto da interface **IExecutionStatus** com o status da execução. O método deverá retornar um valor **boolean** indicando se o processo deve continuar sendo monitorado ou não. Se for retornado "false", o agendamento não será mais monitorado. **Observação**: Isto não afeta a execução do agendamento no RPW, ele continuará executando normalmente.<br>- loading (boolean): Quando for igual a **"Sim"**, irá apresentar a tela de "loading" até finalizar o acompanhamento do agendamento.<br>**Retorno:** Não há. |
+| getObjectByValue <br> getFilteredItems | Métodos utilizados pelo componente PO-LOOKUP. Desta forma, é possível utilizar o **TotvsScheduleExecutionService** para disponibilizar um lookup de Servidor de Execução RPW na tela. |
 
 Exemplo de Uso:
 
 Segue abaixo exemplos da geração de agendamento, busca e acompanhamento da execução.
 
 ```
-private schedExecSubscription$: Subscription;
+- HTML -
+<po-lookup
+  p-label="Servidor RPW"
+  p-placeholder="Servidor RPW"
+  [p-columns]="zoomRpwServiceColumns"
+  [p-field-format]="fieldRpwServiceFormat"
+  [p-filter-service]="scheduleExecution"
+  p-field-label="name"
+  p-field-value="code"
+  [(ngModel)]="executionServer">
+</po-lookup>
 
+- TS -
+executionServer: string;
 jobScheduleID: string;
 executionID: string;
 execStatus: string;
 
+zoomRpwServiceColumns: Array<PoLookupColumn> = [
+  { property: 'code', label: 'Servidor', type: 'string', width: '20%' },
+  { property: 'name', label: 'Descrição', type: 'string', width: '80%' }
+];
+
+private schedExecSubscription$: Subscription;
+
 constructor(
   ...
-  private scheduleExecution: TotvsScheduleExecutionService
+  public scheduleExecution: TotvsScheduleExecutionService
+}
+
+fieldRpwServiceFormat(value) {
+  return `${value.code} - ${value.name}`;
 }
 
 createSchedule(): void {
 
   // Criar um Agendamento para ser Executado "agora"
   const execParam = new ExecutionParameters();
-  execParam.executionServer = 'rpwFinanc';
+  execParam.executionServer = executionServer;
   execParam.programName = 'api_executa_carga_dados_carol';
   execParam.externalName = 'api_executa_carga_dados_carol';
   execParam.programEMS5 = true;
@@ -632,7 +656,7 @@ Métodos:
 
 | Nome | Descrição |
 |-|-|
-| downloadFile | Realiza o Download de um arquivo que foi enviado do backEnd.<br>**Parâmetros:**<br>- fileContent (any): Conteúdo do Arquivo no formato Base64.<br>- fileName (string): Nome do Arquivo, podendo ser diferente do nome original. O valor informado, será o nome que o arquivo terá, quando for realizado o download.<br>- contentType (string): Tipo do Arquivo no formato [**MIME Type**](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types). Este parâmetro é opcional, mas quando não informado, deve-se garantir que a extensão do arquivo, informado no nome do arquivo, esteja correta.<br>**Retorno:** não há. |
+| downloadFile | Realiza o Download de um arquivo que foi enviado do backEnd.<br>**Parâmetros:**<br>- data (any): Conteúdo do Arquivo, podendo estar no formato Base64 ou Blob.<br>- fileName (string): Nome do Arquivo, podendo ser diferente do nome original. O valor informado, será o nome que o arquivo terá, quando for realizado o download.<br>- contentType (string): Tipo do Arquivo no formato [**MIME Type**](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types). Este parâmetro é opcional, mas quando não informado, deve-se garantir que a extensão do arquivo, informado no nome do arquivo, esteja correta.<br>- base64 (boolean): Indica se o conteúdo do arquivo está no formato Base64. Se o parâmetro não for informado ou for igual a **"true"**, será considerado como Base64. Se for informado **"false"**, será considerado o formato Blob.<br>**Retorno:** não há. |
 | downloadData | Realiza a criação e o download de um arquivo CSV gerado a partir de um listagem de dados (criada diretamente no FrontEnd ou retornada do BackEnd). Este método pode ser utilizado para, por exemplo, exportar os dados de um Grid.<br>**Parâmetros:**<br>- data (Array): Um Array com a listagem de dados, por exemplo, uma lista de clientes.<br>- dwldDataParam (IDownloadDataParams): Parâmetros de configuração do arquivo. Este parâmetro é opcional, caso ele não seja informado, serão assumidos valores padrões de configuração, conforme descrito na inteface **IDownloadDataParams**.<br>**Retorno:** não há. |
 ---
 
@@ -640,18 +664,27 @@ Exemplo de Uso:
 ```
 -- JavaScript --
 
+- TS da Tela -
 import { FileUtil } from 'dts-backoffice-util';
 
 downloadFile() {
   this.servCustomerSubscription$ = this.servCustomer
-    .getFile()  // Método do Serviço de Cliente que devolve do BackEnd um arquivo em base64
+    .getFile('1') // Código do cliente 1
     .subscribe((response: Object) => {
 
       FileUtil.downloadFile(response['content'], response['filename']);
-
     });
 }
 
+downloadQrCode() {
+  this.servCustomerSubscription$ = this.servCustomer
+    .getQrCode('00020126360014BR.GOV.BCB.PIX0114+554798402310452040000530398654071500.005802BR5916Robervaldo6009Joinville62070503Novo%20QR%20pix63047EF5') // Texto Exemplo para Geração do QrCode
+    .subscribe((response: Blob) => {
+
+      FileUtil.downloadFile(response, 'qrCode.png', '', false);
+  });
+}
+
 downloadList() {
   this.servCustomerSubscription$ = this.servCustomer
     .query([], [], 1, 999) // Método padrão de Query do Serviço de Cliente
@@ -664,13 +697,23 @@ downloadList() {
       dwldDataParam.columnList = ['shortName', 'name', 'country', 'status', 'tax'];
 
       FileUtil.downloadData(response.items, dwldDataParam);
+  });
+}
 
-    });
+- TS do Serviço -
+getFile(id: string): Observable<Object> {
+  const url = `/customer/${id}/file`;
+  return this.http.get(url);
+}
+
+getQrCode(text: string): Observable<Blob> {
+  const url = `/qrcode/download?text=${text}`;
+  return this.http.get(url, { responseType: 'blob' });
 }
 
 -- Progress --
 
-// Conteúdo do Método que BackEnd que retorna o Arquivo
+// Conteúdo do Método que BackEnd que retorna o Arquivo em Base64
 DEFINE VARIABLE v_dir_arq AS CHARACTER NO-UNDO.
 DEFINE VARIABLE v_cod_arq AS CHARACTER NO-UNDO.
 DEFINE VARIABLE v_mtr_arq AS MEMPTR    NO-UNDO.