Set up a custom communication option

Guide
PDF
Beginner

You can customize communication options in Creatio version 8.0.9 Atlas and later.

In Creatio, you can manage the communication options and addresses of contacts and accounts on their form pages in the Customer 360 app. Manage the communication options in the top left and manage the addresses on the Contact info tab. Learn more: Manage communication options and addresses in Freedom UI.

General procedure to set up a custom communication option:

  1. Create a custom communication option. Read more >>>
  2. Bind the communication option to a communication type. Read more >>>
  3. Change the display format (optional). Read more >>>
  4. Add an icon (optional). Read more >>>

Detailed example: Add a custom communication option.

1. Create a custom communication option 

  1. Open the Lookups section. To do this, click in the top right → System setup → Lookups.
  2. Open the Communication option types lookup.
  3. Click New.

  4. Fill out the properties of the custom communication option.

    Property
    Property description
    Name
    An arbitrary name of custom communication option
    Use for contacts
    Clear or select the checkbox depending on your business goals
    Use for accounts
    Clear or select the checkbox depending on your business goals
  5. Save the changes.
  6. Refresh the page that contains the custom communication option.

As a result, the custom communication option will be displayed on a contact and/or account page.

2. Bind the communication option to a communication type 

  1. Open the Lookups section. To do this, click in the top right → System setup → Lookups.
  2. Open the Communication option types lookup.
  3. Open the communication option page. To do this, click on the custom communication option.
  4. Add a communication type for the communication option. To do this, click on the Communication types detail.

  5. Select the checkbox for the needed communication type.

  6. Save the changes.
  7. Clear the cache.

As a result, the custom communication option will be bound to the communication type. The communication option is displayed on a page without bound communication type if the communication type includes only 1 communication option. The communication option is displayed on a page with bound communication type if the communication type includes 2 or more communication options. By default, the display format of communication option is text, but you can change it. Learn more: Set up a custom action menu for communication option.

3. Change the display format (optional) 

  1. Set up the lookup list. To do this, click View → Select fields to display on the lookup toolbar.
  2. Add the column to the lookup list. To do this, click → select the Display format column → Select.
  3. Save the changes.

  4. Fill out the properties of display format for custom communication option.

    Property
    Property description
    Display format
    Display type

    You can use default display formats or implement custom display formats. Learn more: Manage communication options and addresses in Freedom UI.

  5. Refresh the page that contains the custom communication option.

As a result, the custom communication option will use the selected display format on a contact and/or account page.

4. Add an icon (optional) 

You can add an icon to the communication option and communication type. To do this:

  1. Make sure the icon meets the following requirements:

    • Format: *.svg.
    • Size: 16x16 pixels.

  2. Upload an icon to the [SysImage] database table.

    1. Create a Freedom UI app. Instructions: Create an app.
    2. Open the app form page.
    3. Add the Image type field to an arbitrary place on the Freedom UI page. Leave default field parameter values.
    4. Save the changes.
    5. Open the app page and click Run app.
    6. Click New on the toolbar of the app list page.
    7. Click to upload the icon.
    8. Fill out other required properties.
    9. Save the changes.

  3. Find the icon ID.

    1. Click in the top right → System setup → Lookups.
    2. Click New lookup on the Lookups section toolbar.

    3. Fill out the lookup properties.

      Property
      Property value
      Property description
      Name
      Images
      An arbitrary name
      Object
      Image
      The lookup based on the Image object includes all images from the [SysImage] database table.
    4. Save the changes.
    5. Open the Images lookup.
    6. Set up the lookup list. To do this, click View → Select fields to display on the lookup toolbar.
    7. Add the column to the lookup list. To do this, click → select the Id column → Select.
    8. Save the changes.
    9. View the icon ID in the Id column.

  4. Bind the icon ID to the communication option.

    1. Open the Configuration section. Instructions: Open the Configuration section.
    2. Select a custom package to add the SQL script.
    3. Add temporary SQL script. To do this, click Add → SQL script on the section list toolbar.

    4. Fill out the SQL script properties.

      Property
      Property value
      Code
      An arbitrary name
      Installation type
      AfterPackage
      Backward compatible
      Select the checkbox

    5. Add the following SQL script in the Script Designer.

      update "CommunicationType"
    set "ImageLinkId" = 'some-image-link'
where "Name" = 'some_communication_option_name'

      update "Communication"
    set "ImageLinkId" = 'some-image-link'
where "Name" = 'some_communication_type_name'

      where:

      [CommunicationType] is the database table that stores communication options.

      [Communication] is the database table that stores communication types.

      some-image-link is the icon ID from the lookup based on the Image object (i. e., icon from the [SysImage] database table).

      some_communication_option_name is the communication option from the Communication option types lookup to bind an icon.

      some_communication_type_name is the communication type from the lookup based on the [Type of Communication] object (i. e., communication type from the [Communication] database table) to bind an icon.

    6. Save the changes.
    7. Install the SQL script. To do this, click → Install in the section list for the SQL script.
    8. Confirm the installation.

As a result, Creatio will add the icon to the custom communication option or communication type.

See also
Manage communication options and addresses in Freedom UI
Set up a custom communication type
Set up a custom action menu for communication option
Manage apps
Add a custom communication option
Easy

The example is relevant to Creatio version 8.0.9 and later.

To implement the example:

Step 1: Create a custom communication option. Read more >>>

Step 2: Bind the communication option to a communication type. Read more >>>

Step 3: Change the display format. Read more >>>

Step 4: Add an icon to the custom communication option. Read more >>>

Example. Add the WhatsApp custom communication option to contact page. Bind the communication option to the Social network communication type. Use the phone display format and the icon for the communication option.

1. Create a custom communication option 

  1. Open the Lookups section. To do this, click in the top right → System setup → Lookups.
  2. Open the Communication option types lookup.
  3. Click New.

  4. Fill out the properties of the custom communication option.

    Property
    Property value
    Name
    WhatsApp
    Use for contacts
    Select the checkbox
  5. Save the changes.
  6. Refresh the page that contains the custom communication option.

As a result, the WhatsApp custom communication option will be displayed on a contact page. To display the communication option in a separate communication type, bind the communication option to a communication type.

2. Bind the communication option to a communication type 

  1. Open the communication option page. To do this, click on the WhatsApp communication option.
  2. Add a communication type for the communication option. To do this, click on the Communication types detail.
  3. Select the Social network checkbox.

  4. Save the changes.

  5. Clear the cache.

As a result, the WhatsApp custom communication option will be bound to the Social network communication type.

3. Change the display format 

  1. Set up the lookup list. To do this, click View → Select fields to display on the lookup toolbar.
  2. Add the column to the lookup list. To do this, click → select the Display format column → Select.
  3. Save the changes.

  4. Fill out the properties of display format for the WhatsApp communication option.

    Property
    Property description
    Display format
    phone
  5. Refresh the page that contains the custom communication option.

As a result, the WhatsApp communication option will use the phone display format.

4. Add an icon to the custom communication option 

  1. Make sure the icon meets the requirements. Instructions: Add an icon (step 1).

  2. Upload an icon to the [SysImage] database table.

    1. Create the Image upload Freedom UI app. Instructions: Create an app.
    2. Open the Image upload form page Freedom UI page.
    3. Add the Image type field to an arbitrary place on the Freedom UI page. Leave default field parameter values.
    4. Save the changes.
    5. Open the Image upload app page and click Run app.
    6. Click New on the toolbar of the Image upload app list page.

    7. Fill out the image properties.

      Property
      Property value
      Name
      Image_1
      Click to upload the icon.
    8. Save the changes.

  3. Find the icon ID.

    1. Open the Lookups section. To do this, click in the top right → System setup → Lookups.
    2. Create a lookup. To do this, click New lookup on the Lookups section toolbar.

    3. Fill out the lookup properties.

      Property
      Property value
      Name
      Images
      Object
      Image
    4. Save the changes.
    5. Open the Images lookup.
    6. Set up the lookup list. To do this, click View → Select fields to display on the lookup toolbar.
    7. Add the column to the lookup list. To do this, click → select the Id column → Select.
    8. Save the changes.
    9. View the icon ID in the Id column.

  4. Bind the icon ID to the communication option.

    1. Open the Configuration section. Instructions: Open the Configuration section.
    2. Select a custom package to add the SQL script.
    3. Add temporary SQL script. To do this, click Add → SQL script on the section list toolbar.

    4. Fill out the SQL script properties.

      Property
      Property value
      Code
      UsrAddIconForCommunicationOptionMSSQL
      Installation type
      AfterPackage
      Backward compatible
      Select the checkbox

    5. Add the following SQL script in the Script Designer.

      UsrAddIconForCommunicationOptionMSSQL
      update "CommunicationType"
    set "ImageLinkId" = '4e462f54-eb43-8a32-869b-b46e6f4293c4'
where "Name" = 'WhatsApp'

      where:

      [CommunicationType] is the database table that stores communication options.

      4e462f54-eb43-8a32-869b-b46e6f4293c4 is the icon ID from the Images lookup (i. e., icon from the [SysImage] database table).

      WhatsApp is the communication option from the Communication option types lookup to bind an icon.

    6. Save the changes.
    7. Install the SQL script. To do this, click → Install in the section list for the UsrAddIconForCommunicationOptionMSSQL.
    8. Confirm the installation.

As a result, the icon that has the 4e462f54-eb43-8a32-869b-b46e6f4293c4 ID will be added to the WhatsApp communication option.

View the result 

  1. Open a contact page. For example, Alexander Wilson.
  2. Click Add communication option → Social network.

As a result, Creatio will add the icon to the WhatsApp communication option that will be displayed on the contact page in the Social network communication type. The communication option will have an icon and the phone display format. View result >>>

Source codes 

update "CommunicationType"
    set "ImageLinkId" = '4e462f54-eb43-8a32-869b-b46e6f4293c4'
where "Name" = 'WhatsApp'