Real estate rating

The real estate rating is simply placed on the required page with the help of the plugin. The plugin itself has no settings, but you must specify in the TypoScript constants on which page the plugin is located.

Further configuration can be carried out with the help of setup TypoScript.

TypoScript constants

The following TypoScript constants are available in the themes.configuration.extension.openimmo.ratingRequest node:

Additionally, there is the TypoScript constant themes.configuration.pages.openimmo.ratingRequest which defines on which page the rating request can be found in the frontend.

TypoScript settings

The complete rating request is built dynamically based on the following TypoScript configuration.

plugin.tx_openimmo.settings.ratingRequest {
    # Page uid, where the rating request page is located.
    pageUid = {$themes.configuration.pages.openimmo.ratingRequest}
    # Receiver of the contact mail
    email { ... }
    # Presets for rating step fields
    presets { ... }
    #
    # Step configuration
    headline = Wohnmarktanalyse anfordern
    introduction = Dies ist ein optionaler Einleitungstext
    steps {
        haus-verkaufen {
            active = 1
            label = Haus verkaufen
            step2 { ... }
            step3 { ... }
            step4 { ... }
            step5 { ... }
            step6 { ... }
            step7 { ... }
            step8 { ... }
            step9 { ... }
        }
        wohnung-verkaufen { ... }
        haus-vermieten { ... }
        wohnung-vermieten { ... }
    }
}

First, the page uid and the e-mail configuration are specified (via TypoScript constants). Next come the presets, which we will go into later. In the headline node, the headline of the first step can be specified. In the steps node are the rating groups from step 1. These define what should be rated. In the standard configuration these are: haus-verkaufen, wohnung-verkaufen, haus-vermieten and wohnung-vermieten. However, you can also define any entries yourself or delete entries.

An entry would be deleted as follows:

plugin.tx_openimmo.settings.ratingRequest {
    steps {
        haus-verkaufen >
    }
}

Rating steps

1. What should be rated: Hausverkauf, Wohnungsverkauf etc.
2. Type of property: Bungalow, Loft, etc. (these can vary depending on step 1)
3. General property data (can be put together as desired)
4. Further property data (can be put together as desired)
5. Further property data, e.g. equipment (can be put together as desired)
6. Location of the property
7. Energy efficiency class of the property
8. Purchase data of the property
9. Final form for sending the rating request

Field of type Radio (simple selection)

doppelhaushaelfte {
    type = Button
    label = Doppelhaushälfte
    #
    # This button will search for an image/hover-image.
    # The filename is build in configuration path like:
    # Images/Rating/doppelhaushaelfte_a.svg
    # Images/Rating/doppelhaushaelfte_b.svg
    #
    # Images/Rating/###FIELD_KEY###_a.svg
}

Field of type Range (value range)

wohnflaeche {
    type = Range
    label = Wohnfläche
    minValue = 15
    # Maximum selectable value
    # Here currentYear can also be entered, which is replaced by the current year (four-digit)
    maxValue = 500
    defaultValue = 100
    unit = m²
    tooltipValue = true
}

Field of type Radio (simple selection)

gender {
    type = Radio
    label = Anrede
    options {
        # Attention: the field keys must only contain letters!
        # Best lower-camlcase.
        male = Herr
        female = Frau
    }
    #
    # This button will search for an image/hover-image.
    # The filename is build in configuration path like:
    # Images/Rating/gender-male_a.svg
    # Images/Rating/gender-male_b.svg
    #
    # Images/Rating/###FIELD_KEY###-###OPTION_KEY###_a.svg
}

Field of type Checkbox (checkmark)

kitchen {
    label = Einbauküche vorhanden
    type = Checkbox
}

Field of type Input (input field)

miteigentumsanteile {
    type = Input
    label = Miteigentumsanteile
    placeholder = bspw. 100/1000
}

Field of type Textarea (multi-line input field)

beschreibung {
    type = Textarea
    label = Weitere Informationen
    placeholder = z.B. Informationen zur Lage, Adresse oder nennenswerte Renovierungen
}

Field of type Headline

subHeadline {
    label = Ein weiterer Abschnitt
    type = Headline
}

For several sub-headlines, simply assign an adjusted key or subHeadline2 - the only important thing is that type = Headline is set.

Removing a rating step from a rating type

If you don't need 9 steps for a rating type, you can remove the unnecessary ones.

Something like this can look like this:

plugin.tx_openimmo.settings.ratingRequest.steps {
    grundstueck {
        active = 1
        label = Grundstück verkaufen
        step2 {
            headline = Ist das Grundstück erschlossen?
            unerschlossen {
                type = Button
                label = unerschlossen
            }
            teilerschlossen {
                type = Button
                label = teilerschlossen
            }
            erschlossen {
                type = Button
                label = erschlossen
            }
        }
        step3 {
            headline = Wie groß ist Ihr Grundstück
            grundstuecksflaeche {
                type = Range
                label = Grundstücksfläche
                minValue = 50
                maxValue = 4000
                defaultValue = 1000
                unit = m²
                tooltipValue = true
            }
        }
        step4 {
            headline = Wo befindet sich Ihre Immobilie?
            addressWidget {
                type = AddressWidget
            }
        }
        step5 {
            headline = Wohin dürfen wir Ihre Immobilienanalyse liefern?
            gender < plugin.tx_openimmo.settings.ratingRequest.presets.gender
            name < plugin.tx_openimmo.settings.ratingRequest.presets.name
            email < plugin.tx_openimmo.settings.ratingRequest.presets.email
            phone < plugin.tx_openimmo.settings.ratingRequest.presets.phone
            terms < plugin.tx_openimmo.settings.ratingRequest.presets.terms
        }
        step6 {
            ignore = 1
        }
        step7 {
            ignore = 1
        }
        step8 {
            ignore = 1
        }
        step9 {
            ignore = 1
        }
    }
}

It is important that the steps to be ignored come at the end and that the last step in your process is the step with the contact form.