Posted on

August 14, 2021

How to check picklist values with Apex in Salesforce

5 min

If you go to a restaurant and are asked to order, a very effective way to help you make a quick and informed decision is to give you a menu card to choose from.

A picklist is nothing but like a menu card that shows the user what all options (values) they have to choose from for that particular field. It provides the user with an input field which is read-only and accompanied by a drop-down list of predefined values. A picklist is not a smooth sail for all situations, especially when values change frequently and are not unique or when the number of values is too high.

But there are many situations where they have proved to be of great help. Its advantages include:
Simplifies data entry
Standardize values (Managed by the administrator)
Reduce changes of wrong values added

Picklists

In Salesforce there are three types of Picklist available:

Standard: Those are included in your Salesforce org before any customization.
Custom: Those created by users.

Custom Multi-Select: Allows users to choose multiple values.

Picklist can be easily seen in Salesforce Lightning mode by using the UI:

Setup -> Object Manager -> Select the Object where the field is -> Click on Fields and Relationships -> Select the field -> Scroll Down and you will see the values.

The picklist has two parts:

Field

Fields define the type of picklist and are displayed as a drop-down list. Users can configure one of such items as the default item.

They can have the following properties:
Restricted (limits users from adding new values)
Dependent or Controlling ( filters values for one picklist based on a selection from another picklist)

The value set or Global picklist

A value set is a restricted picklist, where adding or modifying values are available only for Salesforce admins. A value set can help specify the company’s broadly common details such as specific country codes, or product properties.

Regarding its limitations:
1000 values including both active and inactive are available per value set.
Each company can have up to 500 global Picklist value sets.

‍

So, what is Apex in Salesforce?

There are times when there is a need to design or check a picklist with Apex in Salesforce. Don’t worry this read will help you understand this term too. So let’s get the ball rolling….

Apex is a strong typed object-oriented programming language that is used to develop applications on top of the Salesforce platform. Using Apex users can write the custom business logic on the top of Salesforce including button clicks, related record updates, and Visualforce pages. It helps developers to execute flow and transaction control statements on Salesforce servers in alliance with calls to the API.

It is available in Salesforce Classic (not available in all orgs) and Lightning Experience; and in Enterprise, Performance, Unlimited, Developer, and Database.com Editions.

Using Picklist in Apex:

Dynamic Apex is used commonly for accessing picklist values from a server controller or a trigger. Along with its use in dynamic SOQL, it lets users analyze objects and fields with methods from the Schema namespace. Using this technique we can know the fields to an object, type of field, or values of the picklist field. Few of the instance methods related to PicklistEntry to get this information are:

Methods	Function performed	Signature	Return Value (9 Types)
getValue()	It returns the values in the picklist.	public String getValue()	String
getLabel()	It gives the display name in the picklist.	public String getLabel()	String
isActive()	Return “true” if the item is displayed in the drop-down list for the picklist. Return “false” if not.	public Boolean isActive()	Boolean
isDefaultValue()	Return “true” if the item is the default value of the picklist. Return “false” if not.	public Boolean isDefaultValue()	Boolean

Using the above methods we can retrieve picklist values with Apex in Salesforce. It is combined with getDescribe() and getPicklistvalues() methods to check the values of picklist.

If we have to check on the values of “Contact” object with the “Type” field that is a list. Sample code would look something like the following

Schema.DescribeFieldResult fieldDetail =Contact.Type.getDescribe();
                          List values =fieldDetail.getPicklistValues();

                          for (Schema.PicklistEntry values {

                          /* operate on the values like

                          values.getValue()

                          values.getLabel()

                          values.isActive()

                          values.isDefaultValue()

                          */

                          }

The sample code above works until either a user wants to get only active values or a developer wants generic code. In the first case, the code above will return inactive values also. In the latter, to cover the aforementioned requirements in the code, it would be necessary to implement the following changes to the code:

public static List  getPicklistValues(
                            Schema.sObjectField activefield) {

                            List values = activefield.getDescribe().getPickListValues();

                              List activeEntries = new List();

                                  for (Schema.PicklistEntry values) {

                                  if (values.isActive()) {

                                  activeEntries.add(values);

                                  }

                                  }

                                  return activeEntries;

                                  }

Note about dynamic Apex: Dynamic Apex does not support the situation where the admin has restricted picklist values for a given record type. In the situation where this is the case, UI API endpoint needs to be called:

/ui-api/object-info/{objectApiName}/picklist-values/{recordTypeId}/{fieldApiName}

One of the reusable utility classes that are provided in Apex and worth mentioning is Picklist Utils. It’s simple to call and handle mostly the entire picklist use cases.

Using picklist in Lightning Web Components

In addition to above mentioned Apex controllers, there is a simpler solution to this. Apex is not required and a direct call to UI API with the get Picklist Values wire adapter from the:

lightning/uiObjectInfoApi module can be made.

To summarize a few things that would be useful for you, remember

Dynamic Apex helps when there are records with no record type.
UI API callouts help when using record types in Apex.
UP API getPicklistValues wire adapter helps when working with Lightning Web Components.
Apex utility class helps when to avoid code duplication.

‍

Thank you! Your submission has been received!

Oops! Something went wrong while submitting the form.

Tagged:

Posted on

August 14, 2021

Cómo verificar valores de lista desplegable con Apex en Salesforce

5 min

Si vas a un restaurante y te piden que hagas un pedido, una forma muy efectiva de ayudarte a tomar una decisión rápida e informada es darte una carta para elegir.

Una lista desplegable no es más que como una carta que le muestra al usuario todas las opciones (valores) que tienen para elegir para ese campo en particular.

Proporciona al usuario un campo de entrada que es de solo lectura y acompañado de una lista desplegable de valores predefinidos. Una lista desplegable no es una tarea fácil para todas las situaciones, especialmente cuando los valores cambian con frecuencia y no son únicos o cuando el número de valores es demasiado alto.

Pero hay muchas situaciones en las que se ha demostrado que son de gran ayuda. Sus ventajas incluyen:
Simplifica la entrada de datos
Normaliza los valores (administrados por el administrador)
Reduce los cambios de valores incorrectos agregados.

Listas Desplegables o Picklists

En Salesforce hay tres tipos de listas desplegables disponibles:

Estándar (Standard): aquellos incluidos en tu org Salesforce antes de cualquier personalización.
Personalizado (Custom): aquellos creados por los usuarios.

Personalizado Multi-Selección (Custom Multi-Select): Permite a los usuarios elegir múltiples valores.

Las listas desplegables se pueden ver fácilmente en el modo Salesforce Lightning utilizando la interfaz de usuario:

Configuración -> Administrador de objetos -> Selecciona el objeto donde se encuentra el campo -> Haz clic en Campos y relaciones -> Selecciona el campo -> Desplázate hacia abajo y verás los valores.

La lista desplegable tiene dos partes:

Campo

Los campos definen el tipo de lista desplegable y se muestran como una lista desplegable. Los usuarios pueden configurar uno de estos elementos como el elemento predeterminado.

Pueden tener las siguientes propiedades:
Restringido (limita a los usuarios de agregar nuevos valores)
Dependiente o controlador (filtra valores para una lista desplegable en función de una selección de otra lista desplegable)

El conjunto de valores o la lista desplegable global

Un conjunto de valores es una lista desplegable restringida, donde agregar o modificar valores solo está disponible para los administradores de Salesforce. Un conjunto de valores puede ayudar a especificar los detalles ampliamente comunes de la empresa, como códigos de país específicos o propiedades de productos.

En cuanto a sus limitaciones:
1000 valores, incluidos tanto los activos como los inactivos, están disponibles por conjunto de valores.
Cada empresa puede tener hasta 500 conjuntos de valores de lista desplegable global

Entonces, ¿qué es Apex en Salesforce?

Hay momentos en los que hay necesidad de diseñar o verificar una lista desplegable con Apex en Salesforce. No te preocupes, esta lectura te ayudará a entender este término también. Entonces vamos a empezar...

Apex es un lenguaje de programación orientado a objetos de tipos fuertes que se utiliza para desarrollar aplicaciones en la plataforma Salesforce. Usando Apex, los usuarios pueden escribir la lógica comercial personalizada en la parte superior de Salesforce, incluyendo clics de botones, actualizaciones de registros relacionados y páginas de Visualforce. Ayuda a los desarrolladores a ejecutar instrucciones de control de flujo y transacción en los servidores de Salesforce en alianza con llamadas a la API.

Está disponible en Salesforce Classic (no disponible en todas las org) y en Lightning Experience, y en las ediciones Enterprise, Performance, Unlimited, Developer y Database.com.

Usando Listas desplegables en Apex

El Apex dinámico se utiliza comúnmente para acceder a los valores de las listas desplegables desde un controlador de servidor o un desencadenador. Junto con su uso en SOQL dinámico, permite a los usuarios analizar objetos y campos con métodos del espacio de nombres Schema. Utilizando esta técnica, podemos conocer los campos de un objeto, el tipo de campo o los valores del campo de lista desplegable. Algunos de los métodos de instancia relacionados con PicklistEntry para obtener esta información son:

Methods	Function performed	Signature	Return Value (9 Types)
getValue()	It returns the values in the picklist.	public String getValue()	String
getLabel()	It gives the display name in the picklist.	public String getLabel()	String
isActive()	Return “true” if the item is displayed in the drop-down list for the picklist. Return “false” if not.	public Boolean isActive()	Boolean
isDefaultValue()	Return “true” if the item is the default value of the picklist. Return “false” if not.	public Boolean isDefaultValue()	Boolean

Usando los métodos anteriores, podemos recuperar los valores de las listas desplegables con Apex en Salesforce. Se combina con los métodos getDescribe() y getPicklistvalues() para verificar los valores de la lista desplegable.

Si queremos verificar los valores del objeto "Contacto" con el campo "Type" que es una lista. El código de ejemplo se vería algo así como lo siguiente:

Schema.DescribeFieldResult fieldDetail =Contact.Type.getDescribe();
                          List values =fieldDetail.getPicklistValues();

                          for (Schema.PicklistEntry values {

                          /* operate on the values like

                          values.getValue()

                          values.getLabel()

                          values.isActive()

                          values.isDefaultValue()

                          */

                          }

El código de ejemplo anterior funciona hasta que un usuario solo quiere obtener valores activos o un desarrollador quiere un código genérico. En el primer caso, el código anterior también devolverá valores inactivos. En el último, para cubrir los requisitos mencionados en el código, sería necesario implementar los siguientes cambios en el código:

public static List  getPicklistValues(
                            Schema.sObjectField activefield) {

                            List values = activefield.getDescribe().getPickListValues();

                              List activeEntries = new List();

                                  for (Schema.PicklistEntry values) {

                                  if (values.isActive()) {

                                  activeEntries.add(values);

                                  }

                                  }

                                  return activeEntries;

                                  }

Nota sobre Apex dinámico: Apex dinámico no admite la situación en la que el administrador ha restringido los valores de la lista desplegable para un determinado tipo de registro. En la situación en la que esto ocurre, se debe llamar al punto final de la API de la interfaz de usuario:

/ui-api/object-info/{objectApiName}/picklist-values/{recordTypeId}/{fieldApiName}

Una de las clases de utilidad reutilizables que se proporcionan en Apex y que vale la pena mencionar es Picklist Utils. Es fácil de llamar y manejar la mayoría de los casos de uso de las listas desplegables.

Usando listas desplegables en los componentes web de Lightning

Además de los controladores Apex mencionados anteriormente, existe una solución más sencilla para esto. No se requiere Apex y se puede hacer una llamada directa a la API de UI con el adaptador de cables getPicklistValues desde el módulo lightning/uiObjectInfoApi.

Para resumir algunas cosas que serían útiles para ti, recuerda:
El Apex dinámico ayuda cuando hay registros sin tipo de registro.
Las llamadas a la API de UI ayudan cuando se utilizan tipos de registro en Apex.
El adaptador de cables getPicklistValues de la API UP ayuda cuando se trabaja con componentes web de Lightning.
La clase de utilidad de Apex ayuda a evitar la duplicación de código.