Improve local census documentation

This commit is contained in:
taitus
2024-10-01 09:45:12 +02:00
parent 3b41a6610f
commit f5f4eefc58
8 changed files with 32 additions and 42 deletions

View File

@@ -4,4 +4,4 @@
* [GraphQL](graphql.md)
* [Recommendations](recommendations.md)
* [Configure Census Connection](census_configuration.md)
* [Local Census](local_census.md)
* [Local census](local_census.md)

View File

@@ -1,33 +1,28 @@
# Local Census
# Local census
To provide to administrator users a way to manage the local census database through the administration panel **Settings > Manage local census**. Currently the only way to manipulate this table records is through the rails console.
This feature is designed for installations with limited resources that cannot configure and customize their census connection remotely, so we offer them a solution to use a local census instead. For this purpose, administrators are provided with a way to manage the local census database through the administration panel under **Settings > Local census**.
Allow administrators users to manage this table in two different ways:
## Managing the local census
- **Manually**: one by one through a CRUD interface.
- **Automatically**: through an importation process.
Administrators can manage this census in two different ways:
## Manually
* **Manually**: adding one citizen at a time through a form.
* **Automatically**: through an importation process.
Provide a way to manage local census records to administrator users through administration interface.
### Manually
- Local Census Page
![Manage local census](../../img/local_census/manage-local-census-en.png)
Administrators can create a record by clicking the _Create new local census record_ button, which appears in the top right corner of the page. This will take us to a new page where we can fill in the following form and create the new record:
- Add new record
![Create local census record](../../img/local_census/add-local-census-record-en.png)
![Form to create a record by filling in the document type, document number, date of birth and postal code](../../img/local_census/add-local-census-record-en.png)
Features:
### Automatically
1. Search by document_number: As local_census_records could contain a lot of records we have added a search feature to allow administrators to find existing records by document_number.
1. Avoid the introduction of duplicated records: A model validation has been added to the following attributes pair [:document_number, :document_type]
Administrators can import multiple records through a CSV file by clicking the _Import CSV_ button, which appears in the top right corner of the page. This will take us to a new page where we can attach a CSV file to create the new records:
## Automatically
![Page to import new records via csv](../../img/local_census/add-local-census-records-csv-en.png)
Allow administrator users to import local census records though CSV file.
## Features
- Local Census Page
![Manage local census csv](../../img/local_census/manage-local-census-csv-en.png)
* Search by document number: Since the local census could contain a lot of records, we have added a search feature to allow administrators to find existing records by document number.
- Import CSV
![Create local census records csv](../../img/local_census/add-local-census-records-csv-en.png)
* Avoid the introduction of duplicated records: A model validation has been added that does not allow adding records that share the same _number_ and _type_ of document.

View File

@@ -4,4 +4,4 @@
* [GraphQL](graphql.md)
* [Recomendaciones](recommendations.md)
* [Configurar conexión con el Censo](census_configuration.md)
* [Censo Local](local_census.md)
* [Censo local](local_census.md)

View File

@@ -1,33 +1,28 @@
# Censo Local
# Censo local
Proporcionar a los usuarios administradores una forma de gestionar la base de datos del censo local a través del panel de administración **Configuración > Gestionar censo local**. Actualmente la única manera de manipular los registros de esta tabla es a través de la consola de rails.
Esta funcionalidad está pensada para instalaciones con pocos recursos que no pueden configurar y personalizar su conexión con el censo de forma remota, por lo que les ofrecemos una solución para que puedan utilizar un censo local. Para ello, se proporciona a los administradores una forma de gestionar la base de datos del censo local a través del panel de administración en **Configuración > Censo local**.
Permitir a los usuarios de administradores gestionar esta tabla de dos maneras diferentes:
## Gestión del censo local
- **Manualmente**: uno por uno a través de una interfaz CRUD.
- **Automáticamente**: a través de un proceso de importación.
Los administradores pueden gestionar este censo de dos maneras diferentes:
## Manualmente
* **Manualmente**: añadiendo ciudadanos uno por uno a través de un formulario.
* **Automáticamente**: a través de un proceso de importación.
Provide a way to manage local census records to administrator users through administration interface.
### Manualmente
- Página de censo local
![Manage local census](../../img/local_census/manage-local-census-es.png)
Permite a los administradores crear un registro clicando en el botón _Crear nuevo registro en el censo local_ que aparece en la parte superior derecha de la página. Esto nos llevará a una nueva página donde poder rellenar el siguiente formulario y crear el nuevo registro:
- Añadir un nuevo registro
![Create local census record](../../img/local_census/add-local-census-record-es.png)
![Formulario para crear un registro rellenando el tipo de documento, el número de documento, la fecha de nacimiento y el código postal](../../img/local_census/add-local-census-record-es.png)
Funcionalidades:
### Automáticamente
1. Búsqueda por número_de_documento: Como local_census_records podría contener muchos registros, hemos añadido una función de búsqueda para permitir a los administradores encontrar los registros existentes por número de documento.
1. Evitar la introducción de registros duplicados: Se ha añadido una validación de modelo al siguiente par de atributos [:número_de_documento, :tipo_de_documento]
Permite a los usuarios administradores importar multiples registros a través de un archivo CSV, clicando en el botón _Importar CSV_, que aparece en la parte superior derecha de la página. Esto nos llevará a una nueva página donde poder importar el CSV y crear los nuevos registros:
## Automáticamente
![Página para importar nuevos registros a través de un csv](../../img/local_census/add-local-census-records-csv-es.png)
Permite a los usuarios administradores importar registros del censo local a través de un archivo CSV.
## Funcionalidades
- Página de censo local
![Manage local census csv](../../img/local_census/manage-local-census-csv-en.png)
* Búsqueda por número de documento: Como el censo local podría contener muchos registros, existe una función de búsqueda para permitir a los administradores encontrar los registros existentes por número de documento.
- Página para importar un CSV
![Create local census records csv](../../img/local_census/add-local-census-records-csv-en.png)
* Evitar la introducción de registros duplicados: Existe una validación de modelo que no permite añadir registros que compartan el mismo _número_ y _tipo_ de documento.

Binary file not shown.

Before

Width:  |  Height:  |  Size: 23 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 24 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 22 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 22 KiB