Un CUID (Identificador Único Resistente a Colisiones) es una cadena alfanumérica de 16 caracteres utilizada para identificar recursos en toda la plataforma ActivityInfo. Estos identificadores son cruciales para su uso en fórmulas, la API de ActivityInfo y el paquete R, ya que permanecen constantes incluso si se cambia el nombre a mostrar de un recurso.
Características clave
- Formato: Los CUIDs constan de 16 caracteres que utilizan letras minúsculas (a-z) y dígitos (0-9).
- Estructura: Cada CUID debe comenzar con una letra (p. ej., cw0qkvfkq6jnlx3r).
- Permanencia: A diferencia de las etiquetas o los nombres, un CUID es inmutable una vez asignado a un recurso.
Jerarquía y alcance de la unicidad
Los CUIDs se generan basándose en una jerarquía específica. Su unicidad es global en todo un servidor o está limitada a un "contenedor" principal.
1. IDs únicos a nivel global
A los siguientes recursos se les asignan CUIDs que son únicos en un único servidor de ActivityInfo:
- Bases de datos: El contenedor de nivel superior para todos los formularios y datos.
- Formularios: Formularios estándar utilizados para la recolección de datos.
- Informes: Resultados analíticos como tablas dinámicas o paneles de control.
2. IDs con alcance de contenedor
Ciertos recursos solo requieren unicidad dentro de su contenedor principal inmediato. Esto significa que el mismo CUID puede existir potencialmente en diferentes ubicaciones en el mismo servidor sin conflicto:
- Campos: Únicos solo dentro de su Formulario específico. Dos formularios diferentes pueden tener campos con CUIDs idénticos.
- Opciones de selección: Las opciones en los campos de Selección única o Selección multiple son únicas solo dentro de su Campo específico.
- Registros: Únicos solo dentro de su Formulario específico. Un ID de registro en el "Formulario A" puede ser idéntico a un ID de registro en el "Formulario B".
- Carpetas: Contenedores estructurales utilizados para organizar formularios. El CUID de un formulario es único solo dentro de una base de datos. Dos carpetas diferentes pueden tener CUIDs idénticos en bases de datos diferentes.
Aplicaciones prácticas
API e Integraciones
Al utilizar la API para consultar datos o actualizar esquemas, los CUIDs son la forma principal de dirigirse a los recursos. Por ejemplo, para obtener registros de un formulario específico, debe proporcionar el CUID de ese formulario (formId) a get form records.
Fórmulas
Los CUIDs se utilizan en las fórmulas para hacer referencia a campos o formularios específicos, asegurando que la fórmula no se rompa si se cambia el nombre de un campo.
Paquete R
El paquete R de ActivityInfo utiliza CUIDs para casi todas las funciones para hacer referencia a recursos específicos al obtener esquemas, consultar datos y realizar operaciones de registro como añadir, editar y eliminar.
Encontrar CUIDs
- Paquete R de ActivityInfo: Puede utilizar la función getDatabaseTree para listar los recursos disponibles y sus CUIDs.
- API de ActivityInfo: Puede obtener una lista de recursos (carpetas, formularios y subformularios) y sus CUIDs en una base de datos.
- En el navegador: Los CUIDs a menudo son visibles en la URL al ver una base de datos o un formulario específico en la interfaz web de ActivityInfo. En el ejemplo siguiente, el CUID del formulario Registro de Beneficiarios es visible en la barra de direcciones.
- CUIDs de registro: Puede ver el CUID de un registro en un formulario o un subformulario en la Tabla Interactiva haciendo clic en "Vistas" y luego en "Seleccionar columnas".
Marque la opción "ID de registro" en "Columnas disponibles" para mostrar los CUIDs de los registros.
- CUIDs de campo: Puede ver los CUIDs de los campos en un formulario abriendo el formulario, haciendo clic en "Configuración del formulario" en la esquina superior derecha de la pantalla y luego seleccionando "Exportar campos".
Esto descargará un archivo CSV que muestra todos los CUIDs de los campos del formulario.
Generar CUIDs
Al enviar una solicitud a través de la API de ActivityInfo para añadir una nueva base de datos, carpeta, formulario, etc., necesitará generar el id del nuevo recurso.
El proyecto Collision-resistant ids (CUID2) tiene bibliotecas en varios lenguajes de programación para generar IDs que serán aceptados por ActivityInfo.