# Glom User Guide V0.2

for Glom v1.6
2004
Murray Cumming
2007
Jorge González (jorgegonz@svn.gnome.org)
Equipo de desarrollo de Glom

Se otorga permiso para copiar, distribuir y/o modificar este documento bajo los términos de la Licencia de Documentación Libre de GNU, Versión 1.1 o cualquier otra versión posterior publicada por la Free Software Foundation; sin Secciones Invariantes ni Textos de Cubierta Delantera ni Textos de Cubierta Trasera. Puede encontrar una copia de la licencia GFDL en este enlace o en el archivo COPYING-DOCS distribuido con este manual.

Este manual es parte de una colección de manuales de GNOME distribuido bajo la GFDL. Si quiere distribuir este manual por separado de la colección, puede hacerlo añadiendo una copia de la licencia al manual, tal como se describe en la sección 6 de la licencia.

Muchos de los nombres usados por compañías para distinguir sus productos y servicios son mencionados como marcas comerciales. Donde esos nombres aparezcan en cualquier documentación de GNOME, y los miembros del Proyecto de Documentación de GNOME están al corriente de esas marcas comerciales, entonces los nombres se pondrán en mayúsculas o con la inicial en mayúsculas.

ESTE DOCUMENTO Y LAS VERSIONES MODIFICADAS DEL MISMO SE PROPORCIONAN SEGÚN LAS CONDICIONES ESTABLECIDAS EN LA LICENCIA DE DOCUMENTACIÓN LIBRE DE GNU (GFDL) Y TENIENDO EN CUENTA QUE:

1. EL DOCUMENTO SE PROPORCIONA "TAL CUAL", SIN GARANTÍA DE NINGÚN TIPO, NI EXPLÍCITA NI IMPLÍCITA INCLUYENDO, SIN LIMITACIÓN, GARANTÍA DE QUE EL DOCUMENTO O VERSIÓN MODIFICADA DE ÉSTE CAREZCA DE DEFECTOS COMERCIALES, SEA ADECUADO A UN FIN CONCRETO O INCUMPLA ALGUNA NORMATIVA. TODO EL RIESGO RELATIVO A LA CALIDAD, PRECISIÓN Y UTILIDAD DEL DOCUMENTO O SU VERSIÓN MODIFICADA RECAE EN USTED. SI CUALQUIER DOCUMENTO O VERSIÓN MODIFICADA DE AQUÉL RESULTARA DEFECTUOSO EN CUALQUIER ASPECTO, USTED (Y NO EL REDACTOR INICIAL, AUTOR O CONTRIBUYENTE) ASUMIRÁ LOS COSTES DE TODA REPARACIÓN, MANTENIMIENTO O CORRECCIÓN NECESARIOS. ESTA RENUNCIA DE GARANTÍA ES UNA PARTE ESENCIAL DE ESTA LICENCIA. NO SE AUTORIZA EL USO DE NINGÚN DOCUMENTO NI VERSIÓN MODIFICADA DE ÉSTE POR EL PRESENTE, SALVO DENTRO DEL CUMPLIMIENTO DE LA RENUNCIA;Y

2. BAJO NINGUNA CIRCUNSTANCIA NI BAJO NINGUNA TEORÍA LEGAL, SEA POR ERROR (INCLUYENDO NEGLIGENCIA), CONTRATO O DE ALGÚN OTRO MODO, EL AUTOR, EL ESCRITOR INICIAL, CUALQUIER CONTRIBUIDOR, O CUALQUIER DISTRIBUIDOR DEL DOCUMENTO O VERSIÓN MODIFICADA DEL DOCUMENTO, O CUALQUIER PROVEEDOR DE CUALQUIERA DE ESAS PARTES, SERÁ RESPONSABLE ANTE NINGUNA PERSONA POR NINGÚN DAÑO DIRECTO, INDIRECTO, ESPECIAL, INCIDENTAL O DERIVADO DE NINGÚN TIPO, INCLUYENDO, SIN LIMITACIÓN DAÑOS POR PÉRDIDA DE MERCANCÍAS, PARO TÉCNICO, FALLO INFORMÁTICO O MAL FUNCIONAMIENTO O CUALQUIER OTRO POSIBLE DAÑO O PÉRDIDAS DERIVADAS O RELACIONADAS CON EL USO DEL DOCUMENTO O SUS VERSIONES MODIFICADAS, AUNQUE DICHA PARTE HAYA SIDO INFORMADA DE LA POSIBILIDAD DE QUE SE PRODUJESEN DICHOS DAÑOS.

Murrayc
Cumming
Equipo de desarrollo de Glom

     murrayc@murrayc.com

Glom 1.6
20 de junio de 2004

Murray Cumming

Murray Cumming

This manual describes version 1.6 of Glom

## Comentarios

Para informar sobre un error o hacer sugerencias sobre Glom o sobre éste manual, puede enviarlas en la página Gnome Bugzilla, seleccionando el producto Glom. Para asegurarse de que otros no han informado antes del mismo fallo, busque en Bugzilla antes de enviar su error.

Manual del usuario de Glom.

## Introducción

Glom le permite diseñar y usar sistemas de bases de datos.

## Inicio

### Iniciar Glom

Puede iniciar Glom de las siguientes maneras:

Menú de Aplicaciones

  Elija Oficina Glom.

### Al iniciar Glom

Se mostrará la siguiente ventana al iniciar Glom.

#### Ventana de inicio de Glom

Muestra la ventana principal de Glom.

## Uso de Glom como un operador

To open an existing Glom document, either open that document from the File Manager, or choose Glom from the Applications menu, and then choose the document when asked. Glom will ask you for a user name and password to access the database. Your administrator will provide your user name and password.

Cuando abra un documento existente, Glom estará ejecutándose a `nivel de usuario` `Operador`. Éste nivel le permite buscar y editar registros pero no le permite cambiar la estructura fundamental de la base de datos.

### Navegación

Each database has several tables. To look at a different table, choose `Tables` from the `Navigate` menu. Then double-click on the table, or select it and click the `Open` button.

#### Navigating to a Table

Navigating to a Table.

### Viewing and Entering Data

When in `Data Mode`, you can view or enter information in either the `List` or `Details` view.

#### The List View

The List view shows many records at once and usually shows only the most important fields.

Cuando introduzca datos en un campo se guardarán en la base de datos inmediatamente después de que termine de editarlo. Si es un campo de fecha u hora el formato se comprobará automáticamente.

To create a new record just click the `New` button, or start typing into a field in the last empty row. A new record row will be created with blank fields for you to fill in.

##### The List View

The List View.

To sort the records just click on a column header. For instance, you could might click on a date column to list invoices in order of their date, and click again to list them in reverse order.

#### The Details View

The details view shows only one record and usually shows all the fields arranged suitably.

Cuando introduzca datos en un campo se guardarán en la base de datos inmediatamente después de que termine de editarlo. Si es un campo de fecha u hora el formato se comprobará automáticamente.

Para crear un nuevo registro pulse el botón `Nuevo`. Se creará un nuevo registro con los campos vacíos para que los pueda rellenar.

##### The Details View

The Details View.

### Buscar datos

Elija `Modo de búsqueda` del menú. Los campos en la lista y vista detallada estarán vacíos y un botón de búsqueda aparecerá en la parte inferior de la ventana.

Introduzca la información, o parte de la información, en el campo para buscar registros que contengan esa información en ese campo. Por ejemplo, introduzca Javi en un campo de nombre para buscar registros con «Javi» o «Javier» en el campo «Nombre».

When you press the `Find` button, Glom will search for records and then display them. If only one record is found then it will show you that record in the Details view. If several records are found then it will show you those records in the List view.

### Printing Reports

If your database developer has defined some reports for a table then you will seem them listed in the `Reports` menu. Just choose the report from the menu to create the report. If you have previously performed a search then the report will contain only the currently-found data. Otherwise it will contain all data in the current report. Remember that each table has its own reports so you may need to switch to the relevant table to use a particular report.

#### A report

A report.

## Uso de Glom como desarrollador

Cuando cree un nuevo documento, Glom estará ejecutándose a `nivel de usuario` `Desarrollador`. También puede cambiar al nivel de usuario «Desarrollador» después de abrir un documento existente, desde el menú `Nivel de usuario`. Glom permitirá este cambio sólo si el administrador también lo permite.

### Añadir tablas

You can see the list of existing tables by choosing `Tables` from the `Navigate` menu. You will also see this window after connecting to a database server, after creating a new document. To create a new table, click the `Add` button and enter the name for the new table. Glom will suggest a human-readable title for this table. `Operators` will see this title instead of the actual table name. You can also mark a tables as `hidden` from Operators. For instance, Operators should see "Invoice Lines" as related records from the "Invoices" table, but they should never be able to navigate directly to the "Invoice Lines" table.

Puede especificar una tabla como la `tabla predeterminada`. Esta tabla e mostrará siempre que un operador abra un documento existente, sin preguntarle que seleccione una tabla de la lista.

También puede usar esta ventana para renombrar una tabla existente.

Pulse el botón de `Abrir` para ver las tablas seleccionadas.

### Editar campos

Elija `Campos` del menú de `Desarrollador`. Esto mostrará la lista de campos en la tabla. Las tablas nuevas tienen un campo de clave primaria automáticamente, pero puede cambiar el campo si es necesario.

Click the `Add` button to add a new field, then enter the name of the new field. Glom will guess an appropriate human-readable title for this field, but you can edit this. `Operators` will see this title instead of the actual field name.

Para especificar más detalles de un campo, seleccione el campo y pulse en el botón de `Detalles`.

#### Editar campos

Editar los campos de tabla.

#### Claves primarias

Cada tabla debe tener una, y solamente una, `Clave primaria`. El valor en este campo debe ser único, lo que quiere decir que cada valor en este campo sólo aparecerá en un sólo registro de la tabla. Por ejemplo, cada registro de la tabla «Clientes» tendrá también un campo «ID del cliente». Este valor se usará para referirse a este cliente en otras tablas, tales como los registros «Proyectos» y «Facturas». Lea la sección Creando relaciones para obtener más información acerca de cómo relacionar tablas entre si.

#### Tipos de campos

Glom ofrece algunos tipos simples de campos:

1. Número

2. Texto

3. Fecha

4. Hora

5. Booleano - tanto cierto como falso

6. Imagen

#### Campos calculados

El valor de los campos se puede calcular con términos de otros campos, usando el lenguaje de programación Python. Éste cálculo debería ser la implementación de una función en Python y debería devolver un valor. El valor devuelto se usará como el valor del campo. Este valor se volverá a calcular cada vez que cambie alguno de los campos de los que obtiene sus datos. Por desarrollar: Por ahora ésto sólo funciona para valores predeterminados, y tampoco se pueden usar los valores de los campos en el cálculo.

También puede hacer cálculos para especificar el valor predeterminado de los campos, seleccionado la solapa `Valor predeterminado` de la ventana `Detalles del campo`, pulsando sobre la casilla `Calcular valor` e introduciendo un cálculo en Python. Puede comprobar este cálculo en la ventana `Editar`.

### Ordenando las distribuciones

Cada tabla tiene una vista de `Lista` y de `Detalles`, por omisión ambas muestran todos los campos de la tabla por fecha de creación. Puede editar la distribución escogiendo `Distribución` del menú de `Desarrollador`.

#### Arranging the List View

Para la vista de `Lista`, puede especificar la secuencia de los campos columna, y también si hay algún campo oculto.

##### Editing the List Layout

Editing the list layout.

#### Arranging the Details View

Para la vista de `Detalles`, puede crear grupos o campos y darlos títulos. Después puede colocar campos en esos grupos y especificar la secuencia de los campos en los grupos. También puede especificar la secuencia de los grupos. Por ejemplo, en una tabla de «Contactos» puede crear un grupo llamado «Nombre», y colocar los campos «Título», «Nombre» y «Apellido» en ese grupo. Puede tener otros grupos para los campos «Direcciones».

##### Editing the details Layout

Editing the Details Layout.

### Crear relaciones

Muchas veces las tablas de una base de datos están relacionadas entre sí. Por ejemplo, una tabla de «Facturas» podrá tener un campo «ID del cliente». El valor de ese campo especifica un registro en la tabla «Clientes» el cual tiene el mismo valor. Glom puede mostrar información adicional, como el nombre del cliente, de ese registro relacionado. O puede mostrar una lista de varios registros relacionados - por ejemplo, algún registro de la «Lista de facturas» que está relacionado con otro registro de «Facturas».

Para crear relaciones, escoja `Relaciones` del menú de `Desarrollador. Esto le mostrarA e introduzca un nombre para ella. Debe elegir un campo de la tabla actual y un campo de otra tabla con el que se crear`

Puede usar las relaciones en los siguientes lugares.

1. Para mostrar un campo relacionado en la lista o en la vista detallada.

2. Para mostrar una lista de registros relacionados en la vista detallada.

3. Para buscar un valor de un campo en un registro relacionado. Por ejemplo, copie el precio de un «Producto» en el campo «Precio» de un registro de «Facturas».

4. Para calcular el valor de un campo.

### Administración de usuarios

To define the `Operators` who can use your database, and to specify what access they have to the various tables, choose `Users` from the `Developer` menu.

### Translations

Glom's user interface (and this document) is translated into several languages, as you should see already if you are using your computer with a non-English user interface. In addition, Glom automatically shows and understands numbers and dates according to the current user's local conventions. For instance, a user in the USA might enter a price as 1.99 and a date as 1/13/2008, but a German user of the same database will later see that as 1,99 and 13.1.2008.

However, the Glom system that you create also contains text that must be translated if it will be used by people who speak different languages. For instance, you must provide translations for the titles of your tables, fields, and reports. All of these text items can be seen in a list when you choose `Translations` from the `Developer` menu. In this window you can specify the language that you used for the original text, and enter translations for each text item for additional languages. When the Glom system is opened by a user of that language then these text items will be shown in the user interface.

#### Translations

Translations.

Experienced translators may be more familiar with the .po file format, or you might wish to use the many tools that work with the .po file format. By using the `Export` button you can create a .po file to use in a separate tool or to send to a translator. You can then import the resulting translation by using the `Import` button.

### Defining Reports

#### Adding or Editing Reports

Glom can produce reports to show specific fields for sets of records, sorted and grouped. For instance, a shop might need a report listing all products sold in one month, grouped by product type, and sorted by price inside each group. Each table has its own reports, which are available to the operator from the `Reports` menu.

To define a report, or to change the definition of an existing report, choose `Reports` from the `Developer` menu.

##### Creating or Editing Reports

Creating or editing reports.

Notice that each report has an ID as well as a human-readable name. This allows your report to have a translated title when used on a computer that uses a different language.

#### Editing a Report

A Glom report has three areas:

1. The Header, which appears at the start of the report

2. The Main area, in which the records and summary lines are shown, with the actual data from the database.

3. The Footer, which appears at the end of the report.

Inside an area, such as the Main part, you may add report `Parts`, such as fields, text, or images. These will usually appear in a row on the printed report, with one row for each record. In the simple case, this will look much like Glom's list view. You can add parts to your report by selecting them from the `Available Parts` list and then clicking the `Add` button. The part will then be added to the `Parts` list, in the selected area.

To specify details for the parts, such as the text or image to display, or to choose the field to display, select the part in the `Parts` list and click the `Edit` button. You may also specify field formatting by clicking the `Formatting` button, just as you would when defining a details or list layout.

##### Editing a Report

Editing a report.

Some parts may contain other parts and have extra properties to control how they present their child parts. For instance, the `Group By` part groups records together by a field. For instance, a products report might group a list of products by product type. You can even add a second sub-grouping inside the main `Group By` part, by selecting your top-level `Group By` part in the `Parts` list while adding a new `Group By` part from the `Available Parts` list. For instance, you might group your products by manufacturer, inside each product type group.

To specify the field by which the records should be grouped, select your `Group By` part in the `Parts` list and click the `Edit` button. You can then choose the field by which the records should be grouped, and select the fields by which these records should be sorted within the group. You may also specify some additional fields to be displayed in the group's title row. For instance, you might want to group products by a manufacturer ID, but also show the manufacturer name.

##### Editing a Group By Part

Editing a report.

The `Vertical Group` part may contain other items. For instance, it allows you to arrange fields below each other instead of just one after the other in the horizontal row. This is useful for grouping related fields such as address lines, or just to squeeze more information into the records's row on the report.

##### A Report with Vertical Groups

A Report with Vertical Groups.

When you have finished, click the `Close` button to save the report's definition. Your report can then be chosen from the `Reports` menu. See the Printing Reports section for more details.

## Diálogos

### Dialog: Initial dialog

This dialog allows the user to choose an existing document or create a new document. Existing documents may be selecting from the list of recently opened documents or by select a file with the file chooser dialog. Documents can also be opened via the network if other users are running Glom on the local network. Finally, a new document can be created either by opening a template file which already contains some initial tables and records, or by creating an empty document.

### Dialog: New database

### Dialog: Create database

### Dialog: Connection

This dialog requests a user name and password for connection to a database server. This is usually not the same username and password combination with which you log in to your system. All Glom systems require a database server on which the actual data will be stored. If the database server is not running on your local computer ("localhost"), then you must also provide its network hostname, such as "glomserver.openismus.com", though your hostname will be different.

Your system administrator can provide these database login details.

If you are the system administrator, see Glom's Postgres Configuration web page for help with installing and configuring a database server.

### Dialog: Connection Error

This dialog is shown when Glom could not connect to the specified database server. Either the database server is not running at the specified hostname, or the user name and password were not accepted by the database server. See the Connection Dialog section for more details.

### Dialog: Database preferences

### Dialog: Change language

### Window: Textobject

### Window: Imageobject

### Dialog: Notebook

### Dialog: Data invalid format

### Dialog: Relationship overview

### Window: Groups

### Dialog: Group by sort fields

### Dialog: Group by secondary fields

### Window: Button script

### Window: Field calculation

### Dialog: New group

### Dialog: Choose user

### Dialog: User

### Dialog: Translation identify original

### Dialog: Translation copy

### Dialog: Choose Date

## Acerca de Glom

Glom y la comunidad de voluntarios de Glom se encargan de mantener Glom. Para obtener más información acerca de Glom, visite la página web de Glom.

Para informar sobre un error o hacer sugerencias sobre esta aplicación o sobre éste manual, puede enviarlas usando Bugzilla.

Otra excelente fuente de información son las listas de correo de Glom.

Este programa se distribuye bajo los términos de la Licencia Pública General GNU (GPL) tal y como fue publicada por la Free Software Foundation, en la versión 2 ó (a su elección) cualquier versión posterior. Una copia de esta licencia puede encontrarse en este enlace, o en el archivo COPYING incluido con el código fuente de este programa.

## Conceptos

Glom es fácil de usar, pero debe entender los siguientes conceptos básicos.

1. `Database`: Each Glom document allows access to one database.

2. `Tabla`: Cada base de datos contiene varias tablas, tales como, por ejemplo, las tablas «Clientes» y «Facturas».

3. `Campo`: Cada tabla tiene varios campos, tales como «ID del cliente», «Nombre» y «Fecha de nacimiento», en otros documentos y aplicaciones, se suele denominar a estos campos «columnas».

4. `Registros`: Cada tabla tiene varios registros, cada uno de los cuales contiene valores para cada uno de los campos. Por ejemplo la tabla de «Clientes» tendrá un registro para cada cliente. En otros documentos y aplicaciones, a los registros se los suele denominar `filas`.

5. `Relaciones`: Cada tabla puede estar relacionada con otras tablas, por medio de los campos de ambas tablas. Por ejemplo, la tabla «Clientes» puede tener relación con la tabla «Facturas», de tal manera que se pueden ver todas las facturas de ése cliente. Sólo los desarrolladores necesitan entender éste concepto. En otros documentos y aplicaciones, a las relaciones se las suele denominar «uniones» o «joins».

## Calculated fields and button scripts

Calculated fields and button scripts use the Python programming language. The calculation or script is the implementation of a function whose signature is provided for you.

### Editing the definition of a calculated field

Editing the definition of a calculated field.

### Field values

For instance,

    record["name_first"]

is the value of the name_first field in the current record.

### Related Records

For instance,

    record.related["location"]

provides the related records for the current record.

#### Single related records

For relationships that specify a single record, you can get the value of a field in that record. For instance,

    record.related["location"]["name"]

is the value of the name field in the table indicated by the location relationship (often called location::name).

#### Multiple related records

For relationships that specify multiple records, you can use the aggregate functions (sum, count, average) to get overall values. For instance,

    record.related["invoice_lines"].sum("total_price")

.

### Testing for empty values

How you test for empty values depends on the type of field:

#### Non-text fields

Non-text fields may be empty, indicating that the user has not entered any value in the field. For instance, Glom does not assume that an empty value in a numeric field should mean 0.

You can test whether a field is empty by using Python's None. For instance:

      if(record["contact_id"] == None):
        return "No Contact"
      else:
        return record.related["contacts"]["name_full"]

You might also test whether there are any related records. For instance:

      if(record.related["contacts"] == None):
        return "No Contact"
      else:
        return record.related["contacts"]["name_full"]

#### Text fields

For text fields, you should check for zero-length strings. It is not possible in Glom to distinguish between zero-length strings and the absence of any string, because there is no advantage to doing so. For instance:

      if(record["name_full"] == ""):
        return "No Name"
      else:
        return record["name_full"]

### Using the full pygda API

pygda is a python API for the libgda API. The record's `connection` attribute provides a gda.connection that can be used to access the current database directly. This allows you to run any SQL query, for instance to read data from the database with a SELECT, or to change values in the database with an UPDATE. Note that the connection is already open so you can avoid the difficult work of specifying the connection details.

The record's `table_name` attribute also provides the name of the current table.

(Note that the `record.connection` and `record.table_name` attributes are only available since Glom 1.1.6.)

This example reads all data from the current table and prints the values to the terminal:

    # Use the current database's connection
    # to get all the data for the current table.
    #
    # record.connection is an already-open gda.connection object,
    # saving us the bother of opening the connection,
    # or even knowing the name of the database.

    query = "SELECT * FROM %s" % record.table_name
    command = gda.Command(query)
    data_model = record.connection.execute_single_command(command)

    rows = data_model.get_n_rows()
    columns = data_model.get_n_columns()
    print "    Number of columns: ", columns

    for i in range(columns):
        print "      column ", i;
        print "        name=", data_model.get_column_title(i)

        # Find out whether it's the primary key:
        field = data_model.describe_column(i)
        if field.get_primary_key():
            print "        (primary key)"

        print "\n";

    print "    Number of rows: ", rows

    for row_index in range(rows):
        print "      row ", row_index;

        for col_index in range(columns):
            print "        value=", data_model.get_value_at(col_index, row_index).get()

        print "\n";