Configuration¶

This chapter describes some configuration options of the ats extension to let you integrate it easily.

TypoScript Configuration¶

Plugin Constants¶

Constant	Path	Description	Default
Storage PID	`plugin.tx_ats.persistence.storagePid`	The default storagePid for jobs and users.	none
includeJQuery	`plugin.tx_ats.settings.includeJQuery`	The plugin needs jQuery to work properly. Set this to true if you do not already include jQuery in your site.	false
loginPage	`plugin.tx_ats.settings.loginPage`	Page ID where FE Users can log in. If a user tries to access the application form without being logged in, the plugin will redirect to this page.	none
applicationPage	`plugin.tx_ats.settings.applicationPage`	Page ID for the job list view –> job single view link. If none is set, the current page is used.	none
feUserGroup	`plugin.tx_ats.settings.feUserGroup`	The ID of the FE Usergroup all applicants belong to.	none
allowedStaticLanguages	`plugin.tx_ats.settings.allowedStaticLanguages`	Applicants can select which languages they speak. With this option, you can limit the available options to a set of `static_languages` uids. Should be a comma-separated list such as `12,30,33`. If not set, all languages are shown.	none
defaultCountry	`plugin.tx_ats.settings.defaultCountry`	Which country should be selected by default in the application country field? (ISO3, for example DEU for germany)	none
defaultCountry	`plugin.tx_ats.settings.defaultNationality`	Which country should be selected by default in the application nationality field? (ISO3, for example DEU for germany)	none
policyPage	`plugin.tx_ats.settings.policyPage`	Page ID where your privacy policy is found. The page is linked in the first step of the form where the user has to accept privacy settings.	none
renderStructuredJobDefinitions	`plugin.tx_ats.settings.renderStructuredJobDefinitions`	If enabled, the default job template contains JSON-LD markup. Use the tab “Structured Data” inside the job edit form to fill in values.	0 (false)

Company-related Constants¶

Constant	Path	Description
Company name	`plugin.tx_ats.settings.companyData.name`	Default company name.
Company street	`plugin.tx_ats.settings.companyData.street`	Default company street.
Company postal code	`plugin.tx_ats.settings.companyData.postalCode`	Default company postal code.
Company locality	`plugin.tx_ats.settings.companyData.locality`	Default company locality (city, town…)
Company region	`plugin.tx_ats.settings.companyData.region`	Default company region
Company country	`plugin.tx_ats.settings.companyData.country`	Default company country (ISO code with 3 letters)

Module Constants¶

storagePid, see above. If the extConf option enableLegacyBackendTS is enabled, this setting is inherited from the plugin configuration. Otherwise you have to set it (module.tx_ats.persistence.storagePid).

Module Settings¶

If the extConf option enableLegacyBackendTS is enabled, all settings are inherited from the plugin configuration and should be set there.

Setting	Path	Description	Default
deadlineTime	`module.tx_ats.settings.deadlineTime`	The deadline time defines when applications are marked as “deadline exceeded”. It reads as “seconds after the jobs endtime is reached”. The default is 2 weeks.	1209600 (2 weeks)

Workflows¶

ATS uses symfony/workflow (https://symfony.com/doc/current/components/workflow.html) to manage when and how applications change their state. Its documentation applies for the overall principle (places and transitions) with some specialization:

Available places are defined by the ApplicationStatus enumeration (see class Application\ApplicationStatus). You should not modify these.
Available transitions are defined via WorkflowManager (see class Workflow\WorkflowManager) and reflect available actions in the Backend\ApplicationController. Each time the corresponding controller action is called, the defined status change in the transition will be applied.

Example configuration (ext_localconf.php in your site extension):

<?php
//Define custom workflow
$GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['ats']['workflows']['your-workflow'] = [
        'places' => \PAGEmachine\Ats\Application\ApplicationStatus::getConstants(),
        'transitions' => [
                'submit' => ['from' => ApplicationStatus::INCOMPLETE, 'to' => ApplicationStatus::NEW_APPLICATION],
                'acknowledge' => ['from' => ApplicationStatus::NEW_APPLICATION, 'to' => ApplicationStatus::DEPARTMENT],
                'employ' => ['from' => ApplicationStatus::DEPARTMENT, 'to' => ApplicationStatus::EMPLOYED],
                'edit' => ['from' => [], 'to' => []],
        ]
];

//Activate the workflow
$GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['ats']['activeWorkflow'] = 'your-workflow';

This configuration would define the following workflow:

Once the application is submitted by the applicant, it receives the status New Application and is now visible in the backend.
It needs to be acknowledged and will then be moved to the Department status.
Finally, it moves to Employed with the employ action.
The edit action is always available and does not trigger a status change.

All other actions will not appear in the backend module until you add them to your workflow.

File upload options¶

You can configure how file uploads in the application form should behave. The options include location (storage and/or folder), allowed file types and the conflict behaviour (what if the file already exists with this name?).

Configuration options can be found in the extension manager settings (tab Advanced).

Anonymization¶

The extension provides a scheduler command for automatic anonymization of applications (GDPR!), depending on their age (configurable).

The default configuration can be found inside Configuration/TypoScript/Backend/anonymization.ts.

You can also customize the exact behaviour for applications and their child records.

mode defines the exact anonymization behaviour: Either anonymize, anonymize_and_delete or delete_files for file references.
Inside properties you can define the replacement value for each property. Default is “*”.
If you want to keep a property or child as it is, simply remove the value or child section.

Custom conditions¶

If you have custom conditions for anonymization, there is a subkey conditions inside the configuration for just that. These conditions are appended to the general query. They use extbase query logic (“equals”, “greaterThan”…).

Example: By default only applications with status 100 (employed) or higher are anonymized. Let’s say you want to change this to 110 (cancelled) instead.

Inside your ext_typoscript_setup.txt:

module.tx_ats.settings.anonymization {
   objects {
      PAGEmachine\Ats\Domain\Model\Application {
         conditions {
           status {
             property = status
             operator = greaterThanOrEqual
             value = 110
             type = int
           }
         }
      }
   }
}

Please note that the type option is not always necessary, but cleaner if the value is not a string. If you want to pass on a boolean, use 0 or 1 and cast to “bool”.

Also, the logic can only handle operators which require one value. Multivalued operators (in, between…) are currently not supported. Use multiple conditions for that.