Form finisher¶

Start one instance¶

So, let's start with an example. The form finisher is defined in the YAML configuration of the specific form:

finishers:
   -
      identifier: JobRouterStartInstance
      options:
         handle: 'start_website_contact'
         type: 'Demo'
         summary: 'Demo Contact'
         # It is important to add the JobRobot username.
         # The concrete name depends on your configuration above,
         # we assume "robot" here:
         username: 'robot'
         processtable:
            name: '{preName} {lastName}'
            company: '{company}'
            email_address: '{email}'
            phone_number: '{phone}'
            message: '{message}'
            form_identifier: 'www.example.com/demo'

As you can see, you can define some options. These are:

• handle (required): The step handle defined in the Processes module.
• type: The type can be used for statistical evaluation in the according dashboard widget.
• summary: The summary of the instance.
• initiator: The initiator of the instance.
• username: The username the instance should be assigned to.
• jobfunction: The Job Function the instance should be assigned to.
• priority: The priority of the instance (number between 1 and 3).
• pool: The pool of the instance (positive number).
• processtable: You can map the form fields to the process table fields. As you can see in the example above, you define the process table field as the key (e.g email_address) and then map it with the to the form field identifier which is enclosed in curly brackets (e.g. {email}). You can also set a static value, combine a static value with a form field or map multiple form fields to a process table field.

Start multiple instances¶

It is also possible to start multiple instances – even on different JobRouter® installations. Just use the array notation in options:

finishers:
   -
      identifier: JobRouterStartInstance
      options:
         -
            handle: 'start_website_contact'
            summary: 'Demo Contact'
            username: 'robot'
            processtable:
               name: '{preName} {lastName}'
               company: '{company}'
               email_address: '{email}'
               phone_number: '{phone}'
               message: '{message}'
               form_identifier: 'www.example.com/demo'
         -
            handle: 'collect_anonymous_messages'
            summary: 'Demo Contact'
            username: 'robot'
            processtable:
               ANON_MESSAGE: '{message}'
               FROM_URL: 'https://www.example.com/demo'

Attachments¶

One or more attachments (files) can be added to a form and processed with the JobRouterStartInstance form finisher. By default, the files are stored in the first file storage 1:/user_upload/, for example fileadmin/user_upload, but can be overwritten in your form configuration, for instance:

renderables:
  -
    # ...
    renderables:
      -
        properties:
        saveToFileMount: '3:/my_form_uploads/'
        allowedMimeTypes:
          - application/pdf
        type: FileUpload
        identifier: the_pdf_file
        label: 'The PDF file'

In this example, the files are stored in the file storage with the ID 3, and there in a folder named my_form_uploads.

When running the "clean up transfers" command, the files are deleted alongside the according transfer records.

Variables¶

You can use variables in the common parameters, such as summary or initiator, and in the process table fields.

For more information have a look into the available variable resolvers. You can also write your own variable resolvers.