Instructivo para agregar descripciones al modelo de simulación

O3 Budgeting busca ser autodescriptivo. En este objetivo, un aspecto relevante es la presencia de descripciones de los distintos componentes, parámetros, alcances, etc. en lugares claves para facilitar el uso y comprensión de la herramienta.

Las descripciones del modelo

• Se visualizan en distintos cuadros de la interfaz web de O3Planner (nivel de usuario)
• Se cargan en O3Browser, editando la simulación correspondiente (nivel de administrador)

Una vez cargada una descripción, no es necesario realizar una publicación del modelo para visualizar los resultados. Alcanza con grabar la simulación (si se está logueado, además es necesario salir y volver a entrar)

A continuación se realiza un paralelismo entre la primer y la segunda aplicación mencionada, mostrando en cada caso dónde se carga la descripción y dónde se muestra.
Las descripciones se clasifican en grandes grupos:

• Componentes
• Variables
• Parámetros

Descripciones de componentes

Es posible cargar una descripción para cada componente. El cuadro donde se debe cargar se muestra en la figura a continuación.
Procedimiento:

1. Hacer clic dentro del menú (panel de la izquierda) en el componente que se desea describir
2. Posicionarse en el cuadrante que se ubica en la parte inferior de la pestaña Componente
3. Redactar la descripción
4. Guardar haciendo clic en el ícono que se señala en la imágen
                                                                                                        Figura 1
   En la interfaz de usuario, la descripción acompañará al componente en todos los lugares donde éste aparezca:

• Vista global
• Mapa de dependencias
• Detalles del componente, que se obtienen al hacer clic, dentro de la zona de menú, en el nombre del componente correspondiente. El resultado se muestra en la siguiente imagen.
                                                                                                    Figura 2

Descripciones de variables

Cada variable posee una fórmula de proyección, la cual va acompaña de una descripción
Procedimiento:

1. Hacer clic dentro del menú (panel de la izquierda) en el componente cuyas variables se desean describir
2. Hacer clic en la pestaña variables
3. Identificar la variable y hacer clic en el botón que se encuentra a su derecha (..) en la columna Fórmulas
4. Se abrirá una ventana que contiene las fórmulas de dicha variable y un cuadrante en la parte inferior. Escribir la descripción en dicho cuadrante y aceptar
5. Guardar la simulación
                                                                                                     Figura 3

La descripción de una variable se puede apreciar en los detalles del componente que la contiene, en particular en la sección Cálculos de la simulación. Hay una fila para cada variable, en la cual se muestran sus fórmulas y su descripción. Ver la imagen a continuación.
                                                                                                   
Figura 4

Descripciones de parámetros

Existen varias descripciones en torno a un parámetro

Descripción de un parámetro

1. En O3Browser, en la zona de menú, abrir el árbol de parámetros.
2. Hacer clic en el parámetro que se desea describir
3. A la derecha, en la zona de menú, aparece un cuadro que posee, en su parte inferior, un espacio para escribir la descripción
4. Una vez escrita la descripción, guardar la simulación
   
                                                                                                       Figura 5
   En la aplicación web, la descripción del parámetro se visualiza en tres lugares
   A) Lista de parámetros del menú
   B) Detalle de cada componente
   C) Detalle de cada grupo

A) Lista de parámetros.
Para acceder a la misma, hacer clic, dentro de la zona de menú, en Parámetros
En la zona de resultados aparecerá la lista de parámetros del modelo con sus correspondientes descripciones, tal como se muestra en la siguiente figura.
                                                                                                   Figura 6
B) Detalle de cada componente
En el detalle de cada componente, figura la lista de parámetros empleados por el mismo. Allí también se muestra la descripción del parámetro.
C) Detalle de cada grupo
Otra forma de acceder a la descripción es a través de los grupos:

1. En la zona de menú abrir el árbol de Grupos y seleccionar un grupo
2. En la zona de resultados aparece la lista de parámetros con sus argumentos, una descripción de su alcance y un link a su fuente de datos. Hacer clic en el nombre de un parámetro
   
                                                                                                      Figura 7
   Se abrirá una pantalla como la que se muestra a continuación, en la que se puede visualizar el nombre y la descripción del parámetro.
   
                                                                                          Figura 8

Descripciones de los parámetros de un grupo

En este caso la exposición se realizará en forma inversa que en los anteriores.
Comenzaremos por mostrar en la interfaz web las descripciones asociadas a un parámetro en un grupo, para luego indicar dónde se debe cargar cada una de ellas.

En la zona de menú, abrir el árbol de grupos y seleccionar un grupo. Allí se identifica la lista de parámetros que pertenecen al grupo con tres campos diferenciados:

• Argumentos
• Descripción
• Fuentes de datos

Argumentos

El cuadrante donde se indican los argumentos se muestra a continuación:
                                                                                          Figura 9
Esta descripción se crea en forma automática, cuando (en O3Browser) se indica el alcance del parámetro. Por lo tanto, no corresponde cargar una descripción para este campo.

Descripción

En los casos en que el parámetro tiene un sólo alcance, esta descripción carece de sentido, por lo que se recomienda utilizar aquí la descripción del parámetro. Sin embargo, existen parámetros que cuentan con más de un alcance. En este último caso, O3Browser permite cargar una descripción para cada alcance de un parámetro.

Tomamos a modo ilustrativo un parámetro que cuenta con dos alcances
En O3Planner la descripción se ve como en la siguiente figura:

Para cargar estas descripciones seguir el siguiente procedimiento:

1. En el menú abrir el árbol de parámetros
2. Abrir el parámetro que se desea editar
3. Aparecen los distintos alcances del parámetro. Hacer clic en el alcance a describir
4. El campo para cargar la descripción se podrá ver en la zona derecha de la pantalla