Skip to content

Commit

Permalink
docs: Process use cases. (#43)
Browse files Browse the repository at this point in the history
  • Loading branch information
EdwinBetanc0urt authored May 11, 2022
1 parent 3768bc3 commit 9198f60
Show file tree
Hide file tree
Showing 14 changed files with 120 additions and 28 deletions.
8 changes: 4 additions & 4 deletions docs/.vuepress/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ var { genNav, getComponentSidebar, deepClone } = utils
module.exports = {
title: 'adempiere-vue',
description: 'The new UI for ADempiere ERP',
base: '/frontend-core/',
base: '/adempiere-vue/',
head: [
[
'link',
Expand All @@ -18,8 +18,8 @@ module.exports = {
]
],
themeConfig: {
repo: 'solop-develop/frontend-core',
docsRepo: 'solop-develop/frontend-core',
repo: 'adempiere/adempiere-vue',
docsRepo: 'adempiere/adempiere-vue',
docsDir: 'docs',
editLinks: true,
sidebarDepth: 3,
Expand Down Expand Up @@ -295,7 +295,7 @@ function genEssentialsSidebar(type = '') {
})
}

function genUseCasesSidebar(type = 'es') {
function genUseCasesSidebar(type = '') {
const mapArr = [
'/guide/use-cases/process.md'
]
Expand Down
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file not shown.
Binary file not shown.
140 changes: 116 additions & 24 deletions docs/es/guide/use-cases/process.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Apertura

#### Árbol de Menú
### Árbol de Menú
Aperturar un proceso dede el arbol de menú:
1. Desplegar el árbol de menu en **Relación con Socios del Negocio**.
2. Seleccionar el proceso **Envío Texto Correo Electrónico**.
Expand All @@ -15,7 +15,7 @@ Aperturar un proceso dede el arbol de menú:



#### Buscador del Menú
### Buscador del Menú
Aperturar un proceso desde el buscador del menú:

1. Desplegar el árbol de menu.
Expand All @@ -40,7 +40,7 @@ Aperturar un proceso desde el buscador del menú:



#### Ítems Recientes
### Ítems Recientes
Aperturar un proceso de ítems recientes:

1. Ubicar el tablero **Ítems Recientes**.
Expand All @@ -52,7 +52,7 @@ Aperturar un proceso de ítems recientes:
Your browser does not support the mp4 video tag.
</video>

#### Relaciones
### Relaciones
Aperturar un proceso desde las relaciones del mismo nivel del menú:

1. Desplegar el árbol de menú en **Relación con Socios del Negocio**.
Expand All @@ -71,7 +71,7 @@ El cliente ZK de ADempiere no cuenta con una caracteristica equivalente.



#### Proceso relacionado a la Ventana
### Proceso relacionado a la Ventana
Abrir los procesos asociados en la ventana:

##### Versión ZK:
Expand All @@ -98,7 +98,7 @@ Abrir los procesos asociados en la ventana:



#### Re Abrir Proceso desde el Histórico Procesos
### Re Abrir Proceso desde el Histórico Procesos

Aperturar un proceso el **Histórico Procesos** con los parámetros ejecutados del proceso seleccionado:

Expand All @@ -115,28 +115,120 @@ El cliente ZK de ADempiere no cuenta con una caracteristica equivalente.


## Carga
#### Parámetros
#### Validaciones Dinámicas
#### Visualización
#### Obligatoriedad
#### Solo Lectura
#### Valor por Defecto
#### Acercar
### Parámetros
Los parámetros (campos) de los procesos deben cargar al abrirse en el caso de que el proceso maneje parámetros segun cada tipo de visualizacion.

1. Abrir el proceso **Transferencia Bancaria**.
2. Notese los diferentes tipos de parámetros: Cadena, Si y No, Fecha, Monto, Lista, Tabla.

##### Versión ZK:
<img :src="$withBase('/images/use-cases/process-parameters-zk.png')" alt="ZK Desktop" width="800px">

## Ejecución
#### Envio de Parámetros
#### Validación
#### Ejecución
#### Salida
#### Cierre del Proceso al Ejecutarse
Al comenzar la ejecución de un proceso, debe cerrar la vista actual.
1. Llenar los campos obligatorios (si los tiene).
2. Pulsar el boton **Ejecutar**.
##### Versión Vue:
<img :src="$withBase('/images/use-cases/process-parameters-vue.png')" alt="ZK Desktop" width="800px">


### Validaciones Dinámicas
Para los campos de seleccionables (Lista, Tabla y Tabla Directa), deben filtrarse los resultados cuando dicho parámetro tenga alguna validación dinámica.

1. Abrir el proceso **Transferencia Bancaria**.
2. Listar los valores del campo **Cuenta Bancaria Desde**.
3. Seleccionar un valor.
4. Listar los valores del campo **Cuenta Bancaria Para** y verificar que el valor seleccionado en el campo anterior se excluye del resultado.

##### Versión ZK:
<video width="800px" controls>
<source type="video/mp4" :src="$withBase('/images/use-cases/process-dynamic-validation-zk.mp4')">
Your browser does not support the mp4 video tag.
</video>

##### Versión Vue:
<video width="800px" controls>
<source type="video/mp4" :src="$withBase('/images/use-cases/process-dynamic-validation-vue.mp4')">
Your browser does not support the mp4 video tag.
</video>



### Visualización
1. Todos los parámtros con valor por defecto, o con obligatoriedad se visualizan en la primera carga.


### Obligatoriedad

##### Versión ZK:
<img :src="$withBase('/images/use-cases/process-run-close-zk.gif')" alt="ZK Desktop" width="800px">
1. Abrir el proceso **Transferencia Bancaria**.
2. Los campos obligatorios muestran con un asterisco (*) rojo al lado derecho de su nombre.
<img :src="$withBase('/images/use-cases/process-mandatory-zk.png')" alt="ZK Desktop" width="800px">

##### Versión Vue:
1. Abrir el proceso **Transferencia Bancaria**.
2. Los campos obligatorios muestran con un asterisco (*) rojo al lado derecho de su nombre, y aquellos obligatorios vacios resaltan con un borde rojo sobre el campo.
<img :src="$withBase('/images/use-cases/process-mandatory-vue.png')" alt="ZK Desktop" width="800px">


<!-- ### Solo Lectura -->


### Valor por Defecto

Manejar valor por defecto para los distintos tipos de parámetros.

##### Versión Vue:
<img :src="$withBase('/images/use-cases/process-run-close-vue.gif')" alt="ZK Desktop" width="800px">
1. Abrir el proceso **Transferencia Bancaria**.
2. Hacer clic contrario en el valor del parámetro y seleccionar **Valor de Preferencia**.
3. Observe que el parámetro **Tipo de Pago** tiene valor por defecto (A = Deposito Directo).

<video width="800px" controls>
<source type="video/mp4" :src="$withBase('/images/use-cases/process-default-value-zk.mp4')">
Your browser does not support the mp4 video tag.
</video>

##### Versión Vue:
1. Abrir el proceso **Transferencia Bancaria**.
2. Hacer clic en el nombre del parámetro y seleccionar **Información**.
3. Observe que el parámetro **Fecha de Estado de Cuenta** y parámetro **Tipo de Pago** tienen valores por defectos y debidamente establecidos en los parámetros.

<video width="800px" controls>
<source type="video/mp4" :src="$withBase('/images/use-cases/process-default-value-vue.mp4')">
Your browser does not support the mp4 video tag.
</video>

<!-- #### Acercar -->



## Ejecución

### Validación
Se deben asegurar las siguientes validaciones para poder ejecutar un proceso:

* Todos los campos obligatorios deben tener valores.
* Si es proceso asociado a una ventana no permite ejecutarse en un nuevo registro.
* Si es proceso asociado a una consulta inteligente debe tener minímo una fila selecionada.

<video width="800px" controls>
<source type="video/mp4" :src="$withBase('/images/use-cases/process-validate-mandatory-vue.mp4')">
Your browser does not support the mp4 video tag.
</video>


### Ejecución
1. Desplegar el árbol de menu en **Relación con Socios del Negocio**.
2. Seleccionar el proceso **Envío Texto Correo Electrónico**.
3. Llenar los campos.
4. Ejecutar en el menu de acciones.


### Cierre del Proceso al Ejecutarse
Al comenzar la ejecución de un proceso, debe cerrar la vista actual.

<video width="800px" controls>
<source type="video/mp4" :src="$withBase('/images/use-cases/process-run-vue.mp4')">
Your browser does not support the mp4 video tag.
</video>

### Salida
La salida es visuble al culminar la ejecucion del proceso, como notificación, sin embargo puede visualizarse en el historico de procesos.

<img :src="$withBase('/images/use-cases/process-log-vue.png')" alt="Vue Desktop" width="800px">

0 comments on commit 9198f60

Please sign in to comment.