Simple Groupware stores its data on the database and the hard disk. In order to use the data together with other programs and systems, you can export datasets to other file formats.

Supported file formats

• HTML
• CSV
• XML
• RSS (used for news feeds)
• iCalendar (used for appointments)
• vCard (used for contacts)
• LDIF (LDAP data interchange format)
• Spreadsheet (used in OpenOffice Spreadsheet / MS-Excel)
• Text document (used in OpenOffice Writer / MS-Word)
• Flexigrid (Javascript grid component)

Building a custom export

In order to build a custom export, you need to construct a special URL in your browser. The common base is the Simple Groupware URL:

There are common parameters (like folder, view, username, password) and data specific parameters (like begin, end).
Navigating through the tree, you will see that every dataset is placed in a folder. Folders can be specified as a number or a string:

You can find out the number of a folder by clicking the folder in the tree and analyzing the URL in the browser. That's the same for views. Every folder can have several views presenting the data. Most folders have the views "display" and "details". "Display" uses one row for every dataset, "details" presents the datasets in more details with one row for every property of a dataset.
If you don't specify a folder, the folder you last visited will be used. That's the same for a view.
Note: Folder strings also work with mountpoints.
When fetching data from a different source (like a news feed program), you also need to provide your credentials within the URL:

All the parameters are added to the URL and separated with a "&". The first parameter is introduced with a "?". Also you need to specify the export format:

An example URL can look like this:

The example exports data for a news feed program. The export format used is RSS. Display is chosen as the view. The folder is /Workspace/System/Events/. Normally only a super administrator (default: user "admin") is able to read the events. Therefore we switch from anonymous access to a highly privileged user and supply username and password in the URL. By default you will see all events happened today. This can be changed with the "markdate" parameter.

Also you can define a custom "today":

In order to define a custom end date, use "tomorrow":

An example URL to export events for the year 2006 to rss:

Filters

Entries can be filtered individually by adding a filter to the URL.

Filter syntax:

Filter chaining (get datasets that match all filters):

Operators:

Example: get all appointments in a folder with a special organizer

Find

The find syntax can be used to find assets in folders. This is an easy way to get a structured search over all folders.

Basic syntax

Example: find a task with closed=0 (not closed) and subject equal 'test'

Example: find a contact with email containing '@doecorp.com'

Extended syntax: limit the number of results

Example: find one contact with email containing '@doecorp.com'

Syntax: combining two criteria

Example: find all tasks assigned to John and Mary (no limit)

Note: To match values in select fields, you need to use the containing operator "~" or enclose the value in "¦", e.g. field~value or field=¦value¦

Short syntax for finding an asset by its ID

Example: find a task with ID 201

Note: All tables can be written as "simple_type" or just "type", e.g. "simple_tasks" or "tasks".

Syntax: find a folder

Example: find one folder named "Demo"

Other parameters

Return entries with a special order:

Example: show newest entries first, order by created descending

Limit the number of entries to return:

Example: return 10 entries beginning with page 2, gives items 11 to 20

Export only datasets with a special ID:

Example: return datasets with IDs 101 and 201

Hide some fields from the output:

The name of a field corresponds to the field name in the database.

Example: return a view without the fields "Description" and "Status"

Parameters for downloading, locking and unlocking files

In Simple Groupware multiple files can be assigned in one dataset. Files are saved in the file system and referenced by the filename in the database. Columns referenced by simple_type "files" in sgsML can carry one or more filenames separated by the pipe symbol "|". Datasets are identified by the "item" parameter, columns are referenced by the field parameter and the position inside a column is described by "subitem" (using numeric positions like 0,1,2,etc.).

download.php allows the following parameters to download a file:

Example:

files.php allows the following parameters to lock or unlock a file:

Parameters for system consoles (PHP, SYS, SQL)

The system consoles are small tools to execute any kind of PHP, SQL or shell command directly within Simple Groupware.

An example URL can look like this:

Note: The system consoles are only available for the super administrator. The no_gui parameter was added in version "0.402".

Parameters for the Simple Groupware setup

The setup contains 2 steps: First, the source code gets combined with the translations. And second, the database and some directories get created and populated. The "language" parameter is defined as a short country string, e.g. "en" for English, "de" for German, "es" for Spanish, "fr" for French, etc.

The first step is run with:

The second step works like this:

The database type is defined by the name of the PHP module: "mysql" for MySQL, "oci8" for Oracle and "pgsql" for PostgreSQL.

Parameters for previewing Wiki content

Content from the Wiki module can be previewed with:

Parameters for creating bar charts

Bar charts (like those in /Workspace/System/Statistics) can be created by using these parameters:

Example:

Other functions

These parameters are used for downloading layout components, including HTTP cache headers and browser specific processing.

Download open search profile:

Download CSS style sheet:

Example:

Download icons:

Example:

Download Javascript functions:

Download Javascript menu functions: