ProcessMaker Platform Documentation
Spring 2023, ProcessMaker Platform
ProcessMaker HomeGive Us FeedbackRelease NotesDownload Open-Source Edition
Search
⌃K
Links

Google Places Control Settings

Add a control from which the Request participant can auto-complete an entered address, location, or business.

Control Description

Use the Google Places package to allow Request participants to do the following in Form-type Screens:
  • Start entering an address, location, or business name into a Screen control, then allow the Google API to auto-complete that address or location. The Google Place control stores the selected address in the Request data as well as all the returned data from the Google API.
  • View and/or select from one or more geographical locations in a Google map.
This control is only available for Form-type Screens. See Screen Types.
Below are a few ways to use the Google Places control:
  • Allow Request participants to easily enter a shipping or billing address.
  • Enter a business name into the Google Places control to select a business location.
  • Enter well-known monuments or international airport names to get their addresses or locations when requesting to travel.

Package Required

To add a Google Places control to a Screen, the Google Places package must be installed.

Permissions Required

Your user account or group membership must have the following permissions to design a Screen unless your user account has the Make this user a Super Admin setting selected:
  • Screens: Edit Screens
  • Screens: View Screens
See the Screens permissions or ask your Administrator for assistance.

Add the Control to a Screen

Follow these steps to add this control to the Screen:
  1. 1.
    ​Create a new Screen or click the Edit icon
    to edit the selected Screen. The Screen is in Design mode.
  2. 2.
    View the Screen page to which to add the control.
  3. 3.
    Locate the Google Places icon
    in the panel to the left of the Screen Builder canvas.
  4. 4.
    Drag the Google Places icon into the Screen Builder canvas. Existing controls on the Screen Builder canvas adjust positioning based on where you drag the control.
  5. 5.
    Place into the Screen Builder canvas where you want the control to display on the Screen.
  6. 6.
    Configure the Google Places control. See Settings.
  7. 7.
    Validate that the control is configured correctly. See Validate Your Screen.
Below is a Google Places control in Preview mode.
Google Places control in Preview mode

Move the Control on the Page

After adding a control to a Screen page, you may move it to another location on that page such that it is above or below other controls placed on that page. A control cannot be moved to another Screen page.
Follow these steps to move a control to another location on that Screen page:
  1. 1.
    Place your cursor anywhere on the control not displaying the Duplicate Control
    or Delete Control
    buttons.
  2. 2.
    Hold your cursor, then drag the control above or below other controls on that Screen page. Screen Builder previews where the control would display on the page based on how you position the control above or below other controls. If the control cannot be placed in a location because your cursor is above an existing control or too far to the left or right of the page, the
    icon displays in the preview.
  3. 3.
    Place the control at the location on the page you want it. The other control(s) on the page automatically adjust position.

Copy the Control with its Settings

Copying a control also copies the current settings of that control. The copied control displays below other controls placed on that Screen page.
Follow these steps to copy a control:
  1. 1.
    Select the control to be copied.
  2. 2.
    Click the Duplicate Control button
    . The control copies with its current settings, and then displays below other controls placed on that page.
As a best practice, after copying a control, change the Variable Name setting value for the copied control to its own unique variable value. Otherwise, in-progress Requests that use this Screen read from and send data to both controls.

Delete the Control from a Screen

Deleting a control also deletes configuration for that control. If you add another control, it will have default settings.
Follow these steps to delete a control from a Screen page:
  1. 1.
    Select the control to be deleted.
  2. 2.
    Click the Delete button
    . The control deletes. Other controls on that Screen page adjust their locations automatically.

Settings

The Google Places control has the following panels that contain settings:

Variable Panel Settings

Click the control while in Design mode, and then click the Variable panel that is on the right-side of the Screen Builder canvas.
Below are settings for the Line Input control in the Variable panel:

Variable Name

Edit the default Variable Name setting value for this control if necessary. The Variable Name setting value represents data in this control during Requests. Ensure that the Variable Name setting value is a unique name from other controls in this Screen and contains at least one letter. This is a required setting.
Use the Variable Name setting value in the following ways:
See best practices when editing a Request variable name.

Label

Edit the default label that displays for this control if necessary. New Google Places is the default value.

Validation Rules

Enter the validation rule(s) the Request participant must comply with to properly enter a valid value into this control. This setting has no default value. If there are no configured validation rules the following message displays: No validation rule(s). See Validation Rules for "Validation" Control Settings.
Follow these steps to add a validation rule to this control:
  1. 1.
    Access the Variable panel for this control while in Design mode, and then locate the Validation Rules setting.
  2. 2.
    Click the Add Rule button. The Select drop-down menu displays.
  3. 3.
    Select the rule that this control validates against.
  4. 4.
    Click Save. Parameters for the selected rule display. Parameter settings display which ones are required to properly configure the rule.
  5. 5.
    Enter the parameter settings that this control uses to validate against. See Validation Rule Settings, and then locate the validation rule for its parameters.
Follow these steps to edit a validation rule for this control:
  1. 1.
    Access the Variable panel for this control while in Design mode, and then locate the Validation Rules setting.
  2. 2.
    Click the Edit icon
    for the validation rule to edit if that rule can be edited. Validation rules that do not have parameters cannot be edited. The parameter settings for that validation rule displays.
  3. 3.
    Edit the parameter settings that this control uses to validate against. See Validation Rule Settings, and then locate the validation rule for its parameters.
Follow these steps to delete a validation rule for this control:
  1. 1.
    Access the Variable panel for this control while in Design mode, and then locate the Validation Rules setting.
  2. 2.
    Click the Delete icon
    for the validation rule to delete. A message displays to confirm deletion of the validation rule.
  3. 3.
    Click Delete.

Configuration Panel Settings

Click the control while in Design mode, and then click the Configuration panel that is on the right-side of the Screen Builder canvas.
Below are the settings for the Google Places control in the Configuration panel:

Placeholder Text

Enter the placeholder text that displays in this control when no value has been provided. This setting has no default value.

Helper Text

Enter text that provides additional guidance on this control's use. This setting has no default value.
​

Enable Maps

Select to enable Google Maps in this Screen. This setting is disabled by default.
The following settings are available below the Enable Maps setting to configure the Google Map settings and the map's geographical location when the map displays:

Hide Address Input

Hide the address bar that displays above the map to enter an address to display in the map. This setting is disabled by default to display the address bar. Note that this setting is not available unless the Enable Maps setting is selected.

Enable Geolocate

Allow the Request participant to select a location in the map. When this setting is disabled, the Center Map setting is available to enter the geo-location by longitude and latitude to center the map view. The Enable Geolocate setting is disabled by default. Note that the Enable Geolocate setting is not available unless the Enable Maps setting is selected.

Enable Zoom Control

Displays the zoom controls in the lower-right of the map view used to zoom into and out of the map view. This setting is disabled by default to hide the zoom controls. Note that this setting is not available unless the Enable Maps setting is selected.

Enable Map Type Control

Displays the Map or Satellite options in the upper-left of the map view used to toggle between viewing the map or the satellite image of the viewing area. This setting is disabled by default to display the Map options. Note that this setting is not available unless the Enable Maps setting is selected.

Enable Fullscreen Mode

Displays the control in the upper-right of the map view to toggle full screen mode. This setting is disabled by default to hide this control. Note that this setting is not available unless the Enable Maps setting is selected.

Enable Street View Control

Displays the Street View Pegman control to view the street view of the displayed map area. This setting is disabled by default to hide this control. Note that this setting is not available unless the Enable Maps setting is selected.

Center Map

Displays the center geographical location of the map view by longitude and latitude coordinates. The default longitude and latitude coordinates are -93 by 39. Note that this setting is not available unless the Enable Maps setting is selected and the Enable Geolocate setting is not selected.

Default Zoom

Sets the initial map zoom level that ranges from 0 (no zoom) to 19 (maximum zoom). The default zoom setting is 3. Note that this setting is not available unless the Enable Maps setting is selected.

Design Panel Settings

Click the control while in Design mode, and then click the Design panel that is on the right-side of the Screen Builder canvas.
Below are settings for the Google Places control in the Design panel:

Text Color

Select the text color that displays for this control. Optionally, click the Clear Color Selection option to remove the selected color.

Background Color

Select the background color that displays for this control. Optionally, click the Clear Color Selection option to remove the selected color.

Advanced Panel Settings

Click the control while in Design mode, and then click the Advanced panel that is on the right-side of the Screen Builder canvas.
Below are settings for the Google Places control in the Advanced panel:

Visibility Rule

Specify an expression that indicates the condition(s) under which this control displays. See Expression Syntax Components. If this setting does not have an expression, then this control displays by default.
Note the following regarding how to use visibility rules:
  • To make this control hidden until another control contains a value, enter the Variable Name setting value of that control to this control's Visibility Rule setting.
  • ​Visibility rules override custom CSS settings​

CSS Selector Name

Enter the value to represent this control in custom CSS syntax when in Custom CSS mode. As a best practice, use the same CSS Selector Name value on different controls of the same type to apply the same custom CSS style to all those controls.
See the following best practices regarding custom CSS in Screens:

Reference Request Data from the Google Places Control in Other Controls

The Google Places control receives its source data from the Google API response after the Request participant selects an address or location. The Google Places control stores the entire JSON data object that the Google API returns in the Request data. See the Google JSON API response key name descriptions to determine how to use JSON key name values in the response for Request data.
Review the Google's JSON API response often as Google revises it often and without notice.
Follow these guidelines to reference JSON object key names and/or arrays from Google's returned data object in other Screen controls.

Reference the Entire Selected Address or Location

Reference the following JSON key name for the entire selected address or location that includes the entire value in the Google Places control as indicated in JSON dot notation:
variable_name.0.result.0.address_components
variable_name represents the Variable Name setting value for the Google Places control being referenced.

Example of the Entire Selected Address or Location

Below is the Google Places control selection for this example. The Google Places control's Variable Name setting value is the default google_places_1.
Google Places control example
If a Rich Text control references this Google Places control's entire selected address, use the following syntax in the Rich Text control's content using mustache syntax:
{{ google_places_1.0.result.0.address_components }}

Reference the Main Text for the Selected Address or Location

Reference the following JSON key name for the main text for the selected address or location as indicated in JSON dot notation:
variable_name.0.result.0.address_components.0.long_name
variable_name represents the Variable Name setting value for the Google Places control being referenced.
The Rich Text control displays the following during a Request:
"ProcessMaker"

Example of the Main Text for the Selected Address or Location

Below is the Google Places control selection for this example. The Google Places control's Variable Name setting value is the default google_places_1.
Google Places control example
If a Rich Text control references this Google Places control's main text for the selected address, use the following syntax in the Rich Text control's content using mustache syntax:
{{ google_places_1.0.result.0.address_components.0.long_name }}
The Rich Text control displays the following during a Request:
"ProcessMaker"

Reference the Secondary Text for the Selected Address or Location

Reference the following JSON key name for the secondary text for the selected address or location as indicated in JSON dot notation:
variable_name.0.result.0.address_components.0.formatted_address
variable_name represents the Variable Name setting value for the Google Places control being referenced.
The Rich Text control displays the following during a Request:
"West Main Street, Durham, NC, USA"

Example of the Secondary Text for the Selected Address or Location

Below is the Google Places control selection for this example. The Google Places control's Variable Name setting value is the default google_places_1.
Google Places control example
If a Rich Text control references this Google Places control's secondary text for the selected address, use the following syntax in the Rich Text control's content using mustache syntax:
{{ google_places_1.0.result.0.address_components.0.formatted_address }}
The Rich Text control displays the following during a Request:
"West Main Street, Durham, NC, USA"

Reference the Place Type(s) for the Selected Address or Location

Reference the following JSON array for the place type(s) for the selected address or location as indicated in JSON dot notation:
variable_name.0.result.0.address_components.0.types
variable_name represents the Variable Name setting value for the Google Places control being referenced.
The Rich Text control displays the following during a Request:
"point_of_interest", "establishment"

Example of the Secondary Text for the Selected Address or Location

Below is the Google Places control selection for this example. The Google Places control's Variable Name setting value is the default google_places_1.
Google Places control example
If a Rich Text control references this Google Places control's secondary text for the selected address, use the following syntax in the Rich Text control's content using mustache syntax:
{{ google_places_1.0.result.0.address_components.0.types }}
The Rich Text control displays the following during a Request:
"point_of_interest", "establishment"
Last modified 1mo ago