5. Module¶

Target group: Integrators, Administrators

The links to JobData tables in JobRouter® installations are managed in the module JobRouter > Data.

Note

The module is only available in the live workspace.

On your first visit after installing the extension you will see the following screen:

Table of Contents

Create a table link ¶

To create a new table link, click the + Add table link button on the upper menu bar, which opens a form. Alternatively, you can use the Create new table link button.

Types ¶

Each table link has one of the following types:

The data sets of the JobData table are synchronised in a table provided by this extension. This is the recommended type if you only want to display data, e.g. with the content element. Have a look at the developer corner to see the schema of the table and how to use it in your code. The synchronisation is done with the available synchronisation command.

Note

The simple synchronisation should only be used for an overseeable number of data sets, especially when using the content element. The reason is that extracting and sorting data sets is done in PHP and not by the database.

Create a table link of type Simple synchronisation — Create a table link of type “Simple synchronisation”¶

The following fields are available:

General ¶

Connection (required): Choose a connection which was defined previously in the Connections module.

Handle (required): A handle for usage in the your own synchronisation implementations. It is unique in the TYPO3 installation. Only the characters A-Z, a-z, 0-9, - and _ are allowed. It helps you referring to the same table link in development, testing and production environments.

Name (required): A descriptive name for the table link. You can also localise the name: Just use the LLL:EXT:your_extension/Resources/Language/locallang.xlf:name syntax known from other places in the TYPO3 context.

JobData Table GUID (required): The GUID of the JobData table.

Columns (required)

Define the columns that should be synchronised. Each column has the following fields:

JobData Column Name (required): The name of the column as defined in the JobData table.
Label (optional): The label of the column. It will be shown as header of the table when using the plugin.
Type (required): Select the column type (Text, Integer, Decimal, Date, DateTime) as defined in the JobData table.
Decimal places: This option is only shown with type Decimal. Select the number of decimals to be used.
Field size: This option is only shown with type Text. Enter the size of the field. When sending the fields of a form to a JobData table with the form finisher the values are truncated if too long to prevent errors when transmitting the data. To disable the truncation enter 0.
Alignment: Select the alignment for the column. This value is used in the table content element.
Sorting Priority: Select a sorting priority for the column. 1 has the highest priority (content is sorted first by this column) and 3 the lowest priority (content is sorted by this column only when the content of the other selected columns are equal).
Sorting Order: Select the sorting order for the column. This is only applicable if a sorting priority is selected. If no order is selected, ascending is assumed.

Important

The jrid column must not be defined as it is available by default.

Access ¶

Enabled: You can enable or disable the table link. Disabled table links are not synchronised and cannot be used.

Status ¶

Last Synchronisation Date/Time: If the synchronisation run has been performed, the last synchronisation date and time are available in this read-only field.

Last Synchronisation Error: If the synchronisation run has been performed, the last error (if applicable) is displayed in this read-only field.

Notes ¶

Description: This is a descriptive field. You can enter additional remarks for a table link.

Synchronisation in custom table ¶

You have to define a table yourself in an extension with the needed columns from the JobData table. This is the recommended way when you want to display the data yourself, e.g. with filtering by some columns or with joins to other data. The synchronisation is carried out with the available synchronisation command.

The following fields are available:

General ¶

Connection (required): Choose a connection which was defined previously in the Connections module.

Handle (required): A handle for usage in the your own synchronisation implementations. It is unique in the TYPO3 installation. Only the characters A-Z, a-z, 0-9, - and _ are allowed. It helps you referring to the same table link in development, testing and production environments.

Name (required): A descriptive name for the table link. You can also localise the name: Just use the LLL:EXT:your_extension/Resources/Language/locallang.xlf:name syntax known from other places in the TYPO3 context.

JobData Table GUID (required): The GUID of the JobData table.

Custom table (required)

Choose one of the tables to synchronise into.

Note

Only extension tables beginning with tx_ and a column named jrid are displayed in this list. A table can only be used once.

In the developer corner you will find the requirements for a custom table.

Access ¶

Enabled: You can enable or disable the table link. Disabled table links are not synchronised and cannot be used.

Status ¶

Last Synchronisation Date/Time: If the synchronisation run has been performed, the last synchronisation date and time are available in this read-only field.

Last Synchronisation Error: If the synchronisation run has been performed, the last error (if applicable) is displayed in this read-only field.

Notes ¶

Description: This is a descriptive field. You can enter additional remarks for a table link.

Form finisher ¶

The fields from a form are stored into a JobData table. An intermediate transfer table is used, so you have to activate the transmit command.

The following fields are available:

General ¶

Connection (required): Choose a connection which was defined previously in the Connections module.

Handle (required): A handle for usage in the your own synchronisation implementations. It is unique in the TYPO3 installation. Only the characters A-Z, a-z, 0-9, - and _ are allowed. It helps you referring to the same table link in development, testing and production environments.

Name (required): A descriptive name for the table link. You can also localise the name: Just use the LLL:EXT:your_extension/Resources/Language/locallang.xlf:name syntax known from other places in the TYPO3 context.

JobData Table GUID (required): The GUID of the JobData table.

Columns (required)

Define the columns that should be synchronised. Each column has the following fields:

JobData Column Name (required): The name of the column as defined in the JobData table.
Label (optional): The label of the column. It will be shown as header of the table when using the plugin.
Type (required): Select the column type (Text, Integer, Decimal, Date, DateTime) as defined in the JobData table.
Decimal places: This option is only shown with type Decimal. Select the number of decimals to be used.
Field size: This option is only shown with type Text. Enter the size of the field. When sending the fields of a form to a JobData table with the form finisher the values are truncated if too long to prevent errors when transmitting the data. To disable the truncation enter 0.

Important

The jrid column must not be defined as it is available by default.

Access ¶

Enabled: You can enable or disable the table link. Disabled table links are not synchronised and cannot be used.

Status ¶

Last Synchronisation Date/Time: If the synchronisation run has been performed, the last synchronisation date and time are available in this read-only field.

Last Synchronisation Error: If the synchronisation run has been performed, the last error (if applicable) is displayed in this read-only field.

Notes ¶

Description: This is a descriptive field. You can enter additional remarks for a table link.

Other usage ¶

You only define the link to a JobData table – there is no automatic synchronisation. This type can be used for the TYPO3 JobRouter Form extension to push the field values of a submitted form into a JobData table. Also you can synchronise data sets yourself and enrich the data with additional information.

The following fields are available:

General ¶

Connection (required): Choose a connection which was defined previously in the Connections module.

Handle (required): A handle for usage in the your own synchronisation implementations. It is unique in the TYPO3 installation. Only the characters A-Z, a-z, 0-9, - and _ are allowed. It helps you referring to the same table link in development, testing and production environments.

Name (required): A descriptive name for the table link. You can also localise the name: Just use the LLL:EXT:your_extension/Resources/Language/locallang.xlf:name syntax known from other places in the TYPO3 context.

JobData Table GUID (required): The GUID of the JobData table.

Access ¶

Enabled: You can enable or disable the table link. Disabled table links are not synchronised and cannot be used.

Notes ¶

Description: This is a descriptive field. You can enter additional remarks for a table link.

Table links overview ¶

After you have created one or more table links, you will see an overview of the table links when you open the module:

If a table link is not enabled, this is indicated by the addition “(disabled)” in the name.

There are three buttons available for each table link:

You can edit a table link with the pencil. Alternatively click on the name of the table to open the edit form.
Click on the bug icon to test a table link connection.
The last icon is a link to the JobData table definition in the JobRouter® installation. Alternatively click on the table GUID to open the JobData table definition.

The table link records are stored under the root page. You can edit a table link also inside the List module.

Delete a table link ¶

To delete a table link, open the edit page of the table link. In the upper menu bar you will find the delete button.