Cómo la Función @RETURN de Essbase Protege las Reglas
La función @RETURN de Essbase detiene un cálculo cuando se cumple una condición lógica y envía un mensaje personalizado al usuario y al log de la aplicación. En reglas de negocio de Planning, permite validar entradas obligatorias, evitar cálculos incorrectos y explicar con claridad por qué terminó la ejecución.
Hay una función muy útil disponible para los autores de reglas de negocio, @RETURN. Esta función permite devolver un mensaje al usuario que ejecuta la regla de negocio.
El formato de la función es @RETURN(msg, ERROR). El mensaje puede ser literal o, de forma más interesante, puede utilizar la función @CONCATENATE para devolver detalles dinámicos.
- @RETURN solo se puede usar en un Member Calc Block.
- La documentación indica que existen varios valores para el segundo parámetro, pero ERROR es el más usado para detener el proceso y mostrar el mensaje.
-
IF( ( {lv_Promotion_Pct} / 100.0 ) < "Promotion Type 1 Minimum Increase Percent"->“No Employee”–>”NoBusinessUnit”>”NoOperatingUnit”->”NoDepartment”->”NoEmployeeType”->”NoProject” ->”NoProduct”->”BegBalance” OR ( {lv_Promotion_Pct} / 100.0 ) > “Promotion Type 1 Maximum Increase Percent”->”No Employee”->”NoBusinessUnit”->”NoOperatingUnit”->”NoDepartment”->”NoEmployeeType”>”NoProject” ->”NoProduct”->”BegBalance” )
@RETURN(@CONCATENATE( “The Promotion Percent must be between “,
@CONCATENATE( @CalcMgrDoubleToString(@ROUND( “Promotion Type 1 Minimum Increase Percent”->”No Employee”->”NoBusinessUnit”->”NoOperatingUnit”–>”NoDepartment”->”NoEmployeeType”->”NoProject”->”NoProduct”->”BegBalance” * 100, 2 ) ),
@CONCATENATE( ” and “, @CalcMgrDoubleToString(@ROUND( “Promotion Type 1 Maximum Increase Percent”->”No Employee”–>”NoBusinessUnit”->”NoOperatingUnit”->”NoDepartment”–>”NoEmployeeType”->”NoProject”->”NoProduct”->”BegBalance” * 100, 2 ) ) ) ) ),ERROR);
He mostrado ejemplos de cómo usar la función @RETURN para agregar funcionalidad a sus reglas de negocio, reforzar validaciones e informar al usuario sobre los errores. Espero que esto le resulte útil.
Sintaxis y Flujo de la Función @RETURN de Essbase
Use la función @RETURN de Essbase dentro de un bloque IF o ELSEIF que pruebe una condición empresarial específica. La sintaxis acepta un mensaje y una prioridad opcional: INFO, WARNING o ERROR. Seleccione una severidad que refleje correctamente si la regla informa o bloquea un proceso inseguro.
Redacte mensajes que identifiquen la entrada ausente o inválida y expliquen cómo corregirla. Evite textos genéricos como “la regla falló”. Incluya escenario, versión, periodo, entidad o cuenta cuando ese contexto ayude a resolver la condición.
Coloque la validación antes de cálculos costosos, asignaciones o copias de datos. Pruebe rutas válidas e inválidas, confirme que la regla se detiene solo cuando corresponde y verifique el mensaje en el cliente, Job Console y log.
La función @RETURN de Essbase se utiliza en scripts de cálculo, no en fórmulas de miembros. Mantenga condiciones bien delimitadas, documente la entrada esperada y revise los cambios para evitar que una jerarquía nueva active una comprobación obsoleta.
Para facilitar soporte y auditoría, use convenciones coherentes para los mensajes, documente el propietario de cada validación y conserve casos de prueba. Revise periódicamente las reglas críticas después de cambios de metadatos, seguridad o proceso.
Antes de desplegar una regla, valide el comportamiento con distintos usuarios, combinaciones de punto de vista y estados de datos. Incluya pruebas para valores vacíos, ceros, miembros no válidos, periodos cerrados y escenarios sin autorización. Confirme que una condición informativa no interrumpa procesos legítimos y que una condición crítica sí detenga la ejecución antes de escribir datos. También conviene revisar el orden de los bloques IF y ELSEIF para evitar que una comprobación amplia oculte otra más específica.
En entornos con reglas compartidas, centralice estándares de mensajes y criterios de severidad. Los administradores deben poder distinguir rápidamente una advertencia de calidad, un requisito funcional y un error técnico. Registre la versión de la regla, la fecha de cambio y la evidencia de prueba. Si una validación depende de listas, sustituciones o atributos, incluya esos objetos en el control de cambios. Este enfoque reduce diagnósticos repetidos, mejora la experiencia del usuario y protege la integridad de los cálculos.
Finalmente, capacite a los usuarios para interpretar cada nivel de mensaje y conservar el contexto necesario al solicitar soporte. Una guía breve con ejemplos aprobados evita confusión, acelera la corrección de datos y mantiene criterios uniformes entre aplicaciones, equipos y ciclos de planificación.
Recursos de la Función @RETURN de Essbase
Para ampliar función @RETURN de Essbase, consulte qué es Essbase, cubos de Essbase, operadores de cálculo de Essbase, Oracle Essbase Cloud Service, Smart View para Essbase. Revise también referencia oficial de Oracle sobre @RETURN.
