Guía de workflow javascript del lado del servidor

/**

 * AP_Name:wfdemo
 * Key Field: 1000013

 * Name             ID
 * - - - - - - - - - - - --------
 * No.            : 1000011
 * Status         : 1000012

 */
función setStatus(recordId, status) {

  var STATUS_FIELD = 1000012;	//id del campo estado
  var query = db.getAPIQuery("/workflow-demo/2");	//obtener el objeto query para una hoja con ruta a hoja
  var entry = query.getAPIEntry(recordId);	//obtener el objeto del registro para el registro actual
  //fijar el valor de estado para el registro actual al objeto if (status) {
	entry.setFieldValue(STATUS_FIELD, status);
  }
  else {//for switching
    var newStatus = entry.getFieldValue(STATUS_FIELD) == 'On' ? 'Off' : 'On';	//obtener el valor actual de un campo
	entry.setFieldValue(STATUS_FIELD, newStatus);
  }

  //guarda el registro nuevamente a la base de datos
  entry.save();
}

Al escribir workflow Javascript, la variable db es predefinida. Puedes referenciarla donde sea. Generalmente llamamos al método getAPIQuery(pathName) para recuperar el objeto query para una hoja.

Luego puedes recuperar un registro con su id de registro en la hoja objeto con getAPIEntry(recordId) y llamar setFieldValue(fieldId,value) para fijar el valor a un campo o getFieldValue(fieldId) para recuperar el valor de un registro.

Si estas recuperando un valor de un campo de múltiple selección, donde puede haber múltiples valores, usa getFieldValues(fieldId) para recuperar todos los valores en una matriz. También puedes llamar setFieldValue(fieldId,value,true) con un argumento extra al final para especificar que estás “agregando” una opción a la lista actual de valores, no sobrescribiendo los existentes. Nótese que estas operaciones solo son adecuadas para campos de selección.

Al terminar, llama a save() en el asunto del registro para guardarlo nuevamente a la base de datos.

Subtablas

Enlace al ejemplo

Si tienes subtablas en una hoja, puedes usar nuestra API para recuperar datos de ella o hacer ediciones como en el siguiente ejemplo. El formulario se ve así:

El workflow te guiará a través de cada fila de la subtabla, la cantidad total para ese año (según el campo de fecha en la subtabla), el total máximo para ese año, y el año que tuvo el total más alto. Esto está diseñado como post workflow, asique los tres campos se sólo lectura, serán rellenados por el workflow después que el registro sea guardado.

/**

 * AP_Name:wfdemo
 * Key Field: 1000006

 * Date subtable key: 1000007

 * Field Name               Field Id
 * - - - - - - - - - - - --------
 * No.                     : 1000001
 * Name                    : 1000002
 * Date                    : 1000003
 * Amout                   : 1000004
 * Total of This Year      : 1000010
 * Maximal Total of Year   : 1000009
 * Year of Maximal Total   : 1000008

 */

var KEY_FIELD             = 1000006;
var AMOUNT_SUBTABLE_ID    = 1000007;
var DATE_FIELD            = 1000003;
var AMOUNT_FIELD          = 1000004;
var MAX_YEAR_FIELD        = 1000008;
var MAX_TOTAL_FIELD       = 1000009;
var THIS_YEAR_TOTAL_FIELD = 1000010;

var query = db.getAPIQuery("/workflow-demo/1");

var entry = query.getAPIEntry(param.getNewNodeId(KEY_FIELD));
var subtableSize = entry.getSubtableSize(AMOUNT_SUBTABLE_ID);

var yearTotal = {}
for (var i = 0; i < subtableSize; i++) {
  	var year = parseInt(entry.getSubtableFieldValue(AMOUNT_SUBTABLE_ID, i, DATE_FIELD).substr(0, 4));
	var amount = parseInt(entry.getSubtableFieldValue(AMOUNT_SUBTABLE_ID, i, AMOUNT_FIELD));
	if (year in yearTotal) {
		yearTotal[year] += amount;
	} else {
		yearTotal[year] = amount;
	}
}

var maxYear;
for (var year in yearTotal) {
	if (!maxYear || yearTotal[maxYear] < yearTotal[year]) {
		maxYear = year;
	}
}

entry.setFieldValue(MAX_YEAR_FIELD, maxYear);
entry.setFieldValue(MAX_TOTAL_FIELD, yearTotal[maxYear]);
entry.setFieldValue(THIS_YEAR_TOTAL_FIELD, yearTotal[new Date().getFullYear()]);
entry.save();

La idea básica es usar getSubtableSize(subtableId) para obtener el número de filas para un registro y usar getSubtableFieldValue(subtableId,subtableRowIndex,subtableFieldId) para obtener sus valores. Puedes encontrar el id de subtabla y el id campo en los comentarios autogenerados al iniciar la edición del script de workflow.

También puedes usar setSubtableFieldValue(subtableFieldId,subtableRootNodeId,value) para fijar valores a una subtabla. El subtableRootNodeId se usa para especificar a cual fila de subtabla te estás refiriendo. Para encontrar el subtableRootNodeId de una subtabla existente, puedes usar la siguiente llamada getSubtableRootNodeId(subtableId,subtableRowIndex) la cual devolverá un número entero con el subtableRootNodeId.

Si necesitas agregar una fila a la subtabla, puedes usar un subtableRootNodeId negativo como -100, de esta manera todos los valores fijados al mismo subtableRootNodeId negativo serán aplicados a la misma fila de subtabla y los valores negativos diferentes subtableRootNodeId como -101 crearán una fila diferente en la subtabla con un set diferente de valores.

Copiar Registros

Enlace a ejemplo: Copiar de y Copiar a

Copiar registros es uno de los programas de workflow más comunes. Hemos escrito una función para simplificar este tipo de operación. Supongamos que queremos ver un registro en esta hoja:

Con un el clic de un botón, genera un registro en esta hoja:

Este es el código para esta acción:

/**

 * AP_Name:wfdemo
 * Key Field: 1000022

 * S1 subtable key: 1000023
 * T1 subtable key: 1000029

 * Field name    Field ID
 * - - - - - - - - - - - --------
 * A              : 1000014
 * C              : 1000015
 * B              : 1000016
 * D              : 1000017
 * S1             : 1000018
 * S2             : 1000019
 * S3             : 1000020
 * S4             : 1000021
 * T1             : 1000024
 * T2             : 1000025
 * T3             : 1000026

 */

function copyEntry(nodeId) {

  db.entryCopier(JSON.stringify({
    THIS_PATH:"/workflow-demo/3",
    THIS_NODEID:nodeId,
    NEW_PATH:"/workflow-demo/4",
    COPY:{
      1000030:1000014,    // A
      1000031:1000015,    // C
      1000032:1000018,    // S1
      1000033:1000020     // S3
    }
  }),response);
}

Aquí puedes ver que la copia puede realizarse con una simple función de llamada al entryCopier. El entryCopier toma una cadena JSON como su parámetro. Solo indica la hoja fuente, la hoja destino, el registro que deseas copiar y lo más importante, cuales campos deben ser mapeados a qué campos. Cuando el mapeo esté completo, puedes crear botones de acción para copia los registros de una hoja a otra muy fácilmente.

Enviar Notificaciones por Correo

Algunas veces quizá desees enviar notificaciones por correo según algunas condiciones, o quizá desees personalizar el contenido del mensaje de notificación. Puedes escribir un workflow Javascript en el lado del servidor para lograrlo. Aquí hay un script que puedes usar para enviar notificaciones por correo, muy simple:

//omitted...retrieve record object first

var name=entry.getFieldValue(1001426);
var email=entry.getFieldValue(1001428);
var title=entry.getFieldValue(1001386);

mailer.compose(
    email,	//to
    null,	//cc
    'support@example.com',	//reply to
    'Acme, Inc.',  //displayed from
    title,
    'Hi '+name+',

we have received your sales order '+
    'and will be processing your order very soon.

'+
    'You can see your order details at https://www.ragic.com/example/1

'+
    'Thanks.


Best Regards,

Sophia, Sales Manager

Acme, Inc.'
);

//mailer.attach(myURL); //you can use .attach to attach content from a URL

mailer.send();

En cuanto a documentos adjuntos puedes usar mailer.attach(myURL); para adjuntar un registro en Ragic al usar el URL del registro. Por ejemplo, aquí hay un URL de Ragic (siempre ignore el URL después del hash)

https://www.ragic.com/wfdemo/workflow-demo/2/9

Este es el URL print friendly HTML:

https://www.ragic.com/wfdemo/workflow-demo/2/9.xhtml

Este es la versión Excel del URL:

https://www.ragic.com/wfdemo/workflow-demo/2/9.xlsx

También puedes usar la combinación de correspondencia así, el cid es el id de la combinación de correspondencia, puedes obtener el cid en el URL al intentar descargar el documento de combinación de correspondencia:

https://www.ragic.com/wfdemo/workflow-demo/2/9.custom?rn=9&cid=1

Ragic tiene limitaciones de cuantos correos puedes enviar. Si tienes preguntas sobre los límites de correos, contáctenos a support@ragic.com.

Aprobación y otra Información del Registro

Primero puedes enviar el siguiente comando al objeto de query que recibas de db.getAPIQuery para incluir toda la información del registro:

query.setIfIncludeInfo(true);

Y después puedes obtener la información de aprobación para el registro así:

entry.getFieldValue('_approve_status');//Obtiene el estado de la aprobación actual
entry.getFieldValue('_approve_next');//Obtiene el siguiente usuario que debe firmar
entry.getFieldValue('_create_date');//Obtiene la fecha de creación del registro
entry.getFieldValue('_create_user');//Obtiene el correo del usuario quien creó el registro

El estado de aprobación será F si es aprobado, REJ si es rechazado, P para procesando.

Filtrar registros con Javascript

Si quieres obtener más de un registro a través de registro:

var query = db.getAPIQuery("/workflow-demo/1");
query.addFilter(1000002, '=', 'Green');
query.addFilter(1000008, '=', '2017');
var results = query.getAPIResultList();
for (var i = 0; i < results.length; i++) {
  var entry = results[i];
  // ...
}

Puedes agaregar filtros para buscar addFilter(fieldId, operator, value), y llama a getAPIResultList() para obtener la lista de registros.

Mostrar Mensaje

Puedes mostrar un mensaje en una ventana emergente.

response.setStatus('WARN');
response.setMessage(message);

Enviar Solicitudes HTTP

Puedes enviar una solicitud HTTP GET/POST para solicitar un URL y obtener el resultado devuelto:

util.getURL(String urlstring)  
util.postURL(String urlstring,String postBody)

La variable util es predefinida.

Referencias API

ScriptAPIQuery

ScriptAPIEntry

ScriptUser