Métodos Lappiz

Métodos predefinidos.

Los métodos de Lappiz se crean en los espacio de eventos o en la configuración de controles personalizados.

getUser

JavaScript

/*
*Esta función reemplaza el bloque de código
*JSON.parse(sessionStorage.LappizUser);
*/
var userInfo = getUser();
console.log(userInfo);

JSON result

{
    "Id": "F9F3A1DE-DFC3-460F-B2C5-6D3C40668A4A",
    "Activo": true,
    "Phone": null,
    "FechaNacimiento": "2020-07-23T17:00:00.000Z",
    "Contrasena": "",
    "Address": null,
    "UserLdap": null,
    "FechaRegistro": "2020-06-12T14:27:17.000Z",
    "DeviceId": null,
    "FullName": "[e-mail]",
    "Photo": null,
    "CensoFk": null,
    "Direccion": null,
    "Identification": "123456",
    "Email": "[e-mail]"
}

Descripción

getUser

Permite obtener información del usuario logueado.

getEntityId

JavaScript

// Método encargado de retornar el id de la entidad del formulario
var entityId = getEntityId();
console.log(entityId);

getAppViewId

JavaScript

// Método encargado de retornar el id de la vista del formulario
var appViewId = getAppViewId();
console.log(appViewId);

getRowId

JavaScript

// Método encargado de retornar el id del formulario
var rowId = getRowId();
console.log(rowId);

getNewId

JavaScript

// Método encargado de generar un nuevo GUID
var newId = getNewId();
console.log(newId);

getCurrentItem

JavaScript

var result = getCurrentItem();
console.log(JSON.stringify(result));

JSON result

{
    "dataItem": {
        "Identification": "123456",
        "FullName": "[e-mail]",
        "FechaNacimiento": "2020-07-23T17:00:00.000Z",
        "FechaRegistro": "2020-06-12T14:27:17.000Z",
        "Phone": "",
        "Address": "",
        "Email": "[e-mail]",
        "Contrasena": "Qwer.1234",
        "Activo": true,
        "Id": "F9F3A1DE-DFC3-460F-B2C5-6D3C40668A4A"
    },
    "parent":{
        
    }
}

Descripción

getCurrentItem

Permite acceder a la colección de atributos del registro que se desea editar. Los parámetros de retorno no:

dataItem:Objeto que contiene los atributos con los datos del item que se está editando.

parent:Retornar la colección de objetos del padre dado el caso que se esté ejecutando el método desde un detalle.

getCampoById

JavaScript

// Método encargado de retornar el objeto de configuración del campo solicitado
var campoId = '000000-0000-0000-0000-00000000';
var configCampo = getCampoById(campoId);
console.log(configcampo);

setFieldValue

JavaScript

var number =  10;
var fieldId = '6F9619FF-8B86-D011-B42D-00C04FC964FF';
setFieldValue(fieldId, number);

Descripción

setFieldValue

Permite asignar un valor a un campo. Recibe como parámetros:

fieldId: campo al cual se le asignará un valor.

value: valor a asignar.

isToDetails: true si el campo esta en una vista tipo detalles, false sino.

toDetails:Un objeto, el cual lleva la parametrización en caso que el control a deshabilitar no esté en la vista principal, el objeto toDetails tiene las siguientes propiedades:

1.CampoParentId: El campo que agrupa la configuración de la vista detalles.

2. EventTypeName: El tipo de evento a ejecutar, si se deja vacio pone por defecto FormLoaded.

3. EventType: Posibles valores: Form, Control, si se deja vacio pone por defecto Form.

getFieldValue

JavaScript

var fieldId = '6F9619FF-8B86-D011-B42D-00C04FC964FF';
var result = getFieldValue(fieldId);
console.log(result);

Descripción

getFieldValue

Permite obtener el valor de un campo. Recibe como parámetros:

fieldId:Id del campo que se desea obtener su valor.

disableField

JavaScript

var fieldId = '6F9619FF-8B86-D011-B42D-00C04FC964FF';
var parentId = 'O9DJN65-NH54-A7DJ-09DM-MNHHJ7D54NDH';
//deshabilitar campo
disableField(fieldId, true);
//deshabilitar campos en detalle
disableField(fieldId, true,
{
    campoParentId: parentId, 
    EventTypeName: 'FormLoaded', 
    EventType: 'Form'
});
//habilitar campo
disableField(fieldId, false);

Descripción

disableField.

Permite deshabilitar un campo para no permitir su edición.

fieldId: campo al cual se desea desabilitar o habilitar.

value: true si se desea deshabitar, false sino.

toDetails:Un objeto, el cual lleva la parametrización en caso que el control a deshabilitar no esté en la vista principal, el objeto toDetails tiene las siguientes propiedades:

1. campoParentId:El campo que agrupa la configuración de la vista detalles.

2. EventTypeName:El tipo de evento a ejecutar, si se deja vacío pone por defecto FormLoaded.

3. EventType:Posibles valores: Form, Control, si se deja vacío pone por defecto Form.

requireField

JavaScript

// Método encargado de dar obligatoriedad a un campo específico
// True para volver obligatorio - False para quitar obligatorio
var campoId = '000000-0000-0000-0000-00000000'
requireField(campoId, true|false);

Descripción

requireField

Permite indicarle al sistema que debe volver obligatorio un campo según alguna regla de negocio. Los parámetros que recibe son:

campoId: Id del campo que se desea volver obligatorio.

status: True o false según el caso de obligatoriedad.

visibilityField

JavaScript

// Método encargado de dar visibilidad a un campo específico
// True para mostrar - False para ocultar
var campoId = '000000-0000-0000-0000-00000000'
visibilityField(campoId, true|false);

Descripción

visibilityField

Permite indicarle al sistema que debe mostrar u ocultar un campo según alguna regla de negocio. Los parámetros que recibe son:

campoId: Id del campo que se desea ocultar.

status: True o false según el caso de mostrar u ocultar.

visibilitySection

JavaScript

// Método encargado de dar visibilidad a una sección específica
// True para mostrar - False para ocultar
var sectionId = '000000-0000-0000-0000-00000000'
visibilitySection(sectionId, true|false);

Descripción

visibilitySection

Permite indicarle al sistema que debe mostrar u ocultar una sección según alguna regla de negocio. Los parámetros que recibe son:

sectionId: Id de la sección que se desea ocultar.

status: True o false según el caso de mostrar u ocultar.

visibilityLoader

JavaScript

// Método encargado de dar visibilidad al loader spinner del formulario
// True para mostrar - False para ocultar
visibilityLoader(true|false);

disableAction

JavaScript

let actionId = '1ba30857-d0be-4988-b935-5b8c34e80274';
let value = true;
disableAction(actionId, value);
value = false;
disableAction(actionId, value);

Descripción

disabledAction

Permite deshabilitar una acción o en su caso contrario, activarla. Recibe como parámetros:

ActionId:Corresponde al Id de la acción que se desea deshabilitar.

Status:Se especifica true para habilitar y false para deshabilitar.

isDisableField

JavaScript

// Método encargado de obtener si un campo está habilitado o no
var campoId = '000000-0000-0000-0000-00000000';
var isDisabled = isDisableField(campoId);
console.log(isDisabled);

goLocation

JavaScript

//URL para direccionar a las vistas tipo lista
var urlList = '#/grids?viewName=Nombre_Entidad&workspaceId=7e77378b-d518-46bc-b08b-6bf96e378190&entityId=79668f51-d03a-412e-9d37-7ba91488000d&dato=Cliente&appViewId=35059d95-adf1-4ad2-a591-9cb83d23307a';
//URL para direccionar a las vistas tipo formulario creación
var urlForm = '#/forms?viewName=Nombre_Entidad&entityId=79668f51-d03a-412e-9d37-7ba91488000d&entityName=Nombre_Entidad';
//URL para direccionar a las vistas tipo formulario en modo edición
var urlFormEdited = '#/forms?rowId=423DBD02-E42E-4CCB-9505-00E1307E3B9A&viewName=Nombre_Entidad&entityId=79668f51-d03a-412e-9d37-7ba91488000d';
//URL para direccionar a las vitas tipo formulario en modo lectura de datos
var urlFormRead = '#/viewItem?rowId=EE40533F-922E-4654-9156-01159F663AC8&viewName=Dev_Lappiz_Users&entityId=8b7085ba-e615-46e2-a774-2a34f6f509b0&appViewId=2d3e9425-2aad-4fc4-a8ec-eaa6d59566b9';

//Se envia como parámetro la URL a la que se desea redireccionar

goLocation(urlForm);

Descripción

goLocation

Permite indicarle al sistema que debe dirigirse a otra vista, ya sea tipo lista o formulario. Este método permite transportar parámetros por medio de la URL adicionales a los parámetros fijos, los parámetros fijos son:

viewName: Nombre de la entidad donde se encuentra la vista.

entityId: Id de la entidad donde se encuentra la vista a la que se desea navegar.

appViewId: Id de la vista donde se desea ingresar.

rowId: Id del registro que se desea abrir en modo edición.

sendEmail

JavaScript

let email = '[e-mail],[e-mail]';
let subject = 'My life is a bug';
let text = '';
let HTML = `<h1>Design great ideas with HTML to personalize the different 
emails you will send to your team.
Worry about your business, leave the code to Lapiz</h1>`;
let attachments = [
    {
        filename: 'test.txt',
        content: 'Hola mundo Lappiz desde un archivo!'
    }
];
let cc = ["[e-mail]"];
let bcc = ["[e-mail]"];
let smtpsender = 'lappiz';

sendEmail(smtpsender, email, subject, text, HTML, attachments, cc, bcc).then(function (response) {
    toastr.info('Se ha enviado el correo');
}, function (error) {
    toastr.warning('Ha ocurrido un error al enviar el correo');
});

Descripción

sendEmail

Permite enviar correos electrónicos a múltiples destinos desde cualquier evento. Recibe como parámetros:

smtpsender:Se debe enviar la palabra reservada "lappiz" o "aws" dependiendo del proveedor de envio de correo.

to:String con los correos a los que se les desea enviar el email separados por comas.

subject: Es el asunto del correo.

text: Es el cuerpo del correo.

html: Es como desea que se visualice el cuerpo del correo.

attachments: Arreglo de datos adjuntos.

cc: Arreglo de correos a enviar con copia pública.

bcc: Arreglo de correos a enviar con copia oculta.

Para más información de los attachments, visitar la documentación de la librería nodemailer: https://nodemailer.com/message/attachments/

execQuery

JavaScript

var StringQuery = `select Nombre from LappizApp_Lappiz_Personas`;
execQuery(StringQuery).then(function(response){
    var dataResult = response[0];
    //imprimir resultado de la consulta
    console.log(dataResult);
},function(error){
    console.log(error);
});

Descripción

execQuery

Permite hacer una petición para ejecutar queries a la base de datos por medio del API transaccional. Recibe como parámetro:

StringQuery:Variable con la sentencia SQl a ejecutar.

execSP

JavaScript

var SpName = 'GetClientById';
var clientId = '0E984725-C51C-4BF4-9960-E1C80E27ABA0';
var status = 'Activo';
var paramsArray = [1, 2, "'"+clientId+"'", "'"+status+"'"];

execSP(SpName, paramsArray).then(function(response){
    var dataResult = response[0];
    //imprimir resultado del SP
    console.log(dataResult);
},function(error){
    console.log(error);
});

Descripción

execSP

Permite hacer una petición para ejecutar procedimientos almacenados de la base de datos por medio del API transaccional. Recibe como parámetros:

SPName:Nombre del procedimiento almacenado a ejecutar.

ParamsArray:Arreglo con la colección de parámetros que reciba el procedimiento almacenado creado por el desarrollador.

openCustomModal

JavaScript

// Método encargado de abrir una modal
var header = ``, body = ``, footer = ``

header = `<h4 class="modal-title">Título modal Lappiz</h4>`
body = `<p>
  <span>
    Lorem ipsum dolor sit, amet consectetur adipisicing elit.
  </span>
</p>`
footer = `<h4>Modal footer</h4>`

var config = {
  htmlTemplate: true,
  headerTemplate: header,
  bodyTemplate: body,
  footerTemplate: footer,
  showBtnsFooter: true|false,
  size: 'sm'|'lg'|'xl',
  scrollable: true|false,
  centered: true|false
}

const done = () => {
  console.log('Done callback')
}

const cancel = () => {
  console.log('Cancel callback')
}

openCustomModal(config, done, cancel)

Descripción

openCustomModal

Método encargado de abrir una modal. Recibe como parámetros:

config:Objeto que tiene la configuracion de lo que va a mostrar la modal

done: Función que se ejecutará cuando den click en aceptar.

cancel: Función que se ejecutará cuando den click en cancelar.

closeModal

JavaScript

closeModal();

Descripción

closeModal

Permite cerrar la modal del detalle en el que nos encontramos.

sendSMS

JavaScript

// Método encargado de realizar envío de mensajes via SMS
var phoneDestination = '3175758621'
var message = 'Hello world Lappiz!'
sendSMS(phoneDestination, message).then(response => {
    const {
        body: status
    } = response
    console.log(status)
}).catch(error => console.error(error))

Descripción

sendSMS

Método encargado de realizar envío de mensajes via SMS. Los parámetros que recibe son:

destination: Número de teléfono a enviar el mensaje. Se debe enviar con el indicativo del país. Ejemplo: '573175758621'.

message: Mensaje a enviar.

sendPush

JavaScript

// Método encargado de realizar envío de mensajes via push
var userId = '000000-0000-0000-0000-00000000'
var dataMessage = {
    notification: {
        title: 'Lappiz Notification',
        body: 'Hola mundo Lappiz'
    }
}

sendPush(userId, dataMessage).then(response => {
    // ...
}).catch(error => console.error(error))

Descripción

sendPush

Método encargado de realizar envío de mensajes via push. Los parámetros que recibe son:

userId: Id del usuario al que se le enviará la notificación.

dataMessage: Es el objeto de configuración para el envío del mensaje. Para mayor documentación, revisar la documentación de la librería: https://developer.mozilla.org/en-US/docs/Web/API/Notification/Notification

isReadyForm

JavaScript

//Metodo encargado de ocultar o mostrar todo el formulario.
// True para mostrar - False para ocultar

isReadyForm(true);

Descripción

isReadyForm

Permite indicarle al sistema cuando esta listo el formulario para trabajar en el:

status: True o false según el caso de mostrar u ocultar.

execLF

JavaScript

// Metodo encargado para ejecutar una lappoz function
let nameFunction = 'myLappizFunction';
let lappizFunctionId = '5c3740d2-a208-4257-8879-60a3b8b86501';
let method = "GET"//POST

let body = {myFirstParam: 1, mySecondParam: 'parametro para el funcionamiento de la LP'}
let config = {nameFunction, lappizFunctionId, body, method}
execLF(config).then(success => {
    console.log(success)    
}).catch(error => {
    console.log(error)
})

Second Tab

execLF

Ejecuta una lappiz function

nameFunction : Nombre de la funcion, tipo de dato string.

lappizFunctionId : Id de la lappiz function el cual se entrega en la url de la configuracion de esta misma, tipo de dato string.

body: Cuerpo que requiere la lappiz function para su correcto funcionamiento, tipo de datos Object.

method: Método HTTP por el que viaja la petición. Disponible GET o POST

Cancelar transacciones en eventos.

Los eventos que soportan cancelar transacciones con la propiedad e.cancelson ItemCreating, ItemEditing, ItemSaving.

e.cancel = true;

Si se están usando operaciones asíncronas y se utiliza la instrucción dentro de la respuesta no va a funcionar, para poder cancelar dicha operación debe ser sincronía.