Campos Personalizados e Integración de API

Puede adjuntar un número ilimitado de campos personalizados a registros individuales de HireHop (trabajos, proyectos, activos, pruebas de servicio, etc.). Estos campos personalizados se combinan perfectamente en las plantillas de documentos. Si un campo personalizado existe en un registro, se rellena automáticamente; de lo contrario, aparece en blanco.

Actualmente, los campos personalizados son totalmente compatibles con Trabajos y Proyectos utilizando complementos de JavaScript personalizados.

Estructura de datos de campos personalizados

Al obtener los valores de los campos personalizados para un registro activo, llame a la función _get_custom_field_value(field). Devuelve NULL si no está configurado, un string simple o un JavaScript object.

Para un control máximo de la impresión en documentos, guarde los campos personalizados como un objeto JSON estructurado en lugar de una cadena de texto simple:

"field_name" :
   {
      "value"  : "The value of the field",
      "type"   : "The field type, default is text, it can also be number, currency, text, date, html and array"
      "format" : "For date type only, eg "ddd, dddddd tt" // = "Mon, 1 January 2017 12:00"
   }

Claves de objetos & Formatos compatibles

ParámetroTipoDescripción
valorCualquieraLos datos del campo sin procesar almacenados en cualquier formato de JavaScript válido.
tipoCadenaIndica a HireHop cómo mostrar los datos en los documentos. Tipos compatibles: text (predeterminado), number, currency, date, html, y array (mostrado como JSON).
formatoCadenaSolo tipos de fecha. Especifica el formato de salida de fecha y hora según la configuración regional del usuario.

Reglas de formato de fecha

Los valores de fecha deben almacenarse en formato yyyy-mm-dd hh:mm. Puede combinar los siguientes símbolos y separadores personalizados:

  • dddddd – Fecha larga (p. ej., 1 de enero de 2026)
  • ddddd – Fecha corta (p. ej., 01/01/2026)
  • dddd – Día de la semana completo (p. ej., lunes)
  • ddd – Día de la semana corto (p. ej., lun)
  • tt – Hora (p. ej., 0:36)

Ejemplo: dddd, dddddd tt genera “Lunes, 1 enero 2026 12:00”.

Guardando campos personalizados

Para almacenar valores actualizados de campos personalizados en los formularios de edición compatibles, utilice _save_custom_field_value(field, value).

  • Operaciones por lotes: Todos los cambios deben registrarse antes de enviar la acción de guardado del formulario. Los nuevos valores se combinan con los campos existentes; los nombres de clave coincidentes sobrescribirán los valores existentes.
  • Llamadas directas a la API: Al llamar a puntos finales como /php_functions.job_save.php directamente, pasando únicamente el custom_fields El parámetro POST actualiza los campos personalizados dejando intactos todos los demás atributos del registro.

Convenciones de nombres e impresión

  • Sintaxis de combinación de documentos: En las plantillas de documentos, anteponga un guion bajo a los nombres de los campos _. Por ejemplo, un campo personalizado llamado field_name en un trabajo se combina como job:_field_name.
  • Prefijos de espacio de nombres: Para evitar colisiones de nombres entre diferentes complementos o tipos de registro (por ejemplo, campos compartidos de activos y pruebas), anteponga al nombre de los campos un identificador único (por ejemplo, los complementos de HireHop usan hh_Field Name).
  • Sensibilidad a mayúsculas y minúsculas: Las etiquetas de combinación de documentos no distinguen entre mayúsculas y minúsculas, pero las referencias a variables de JavaScript sí distinguen entre mayúsculas y minúsculas.

Campos personalizados con capacidad de búsqueda

El campo CUSTOM_INDEX es un valor de cadena especial de 45 caracteres (o NULL) reservado para búsquedas personalizadas, filtrado y resultados de búsqueda de la página de inicio.

Activación de la búsqueda en la página de inicio

Para incluir CUSTOM_INDEX en las columnas de búsqueda global, añádelo a allSearchCols y establece la etiqueta en tu complemento:

// Add CUSTOM_INDEX to search columns
if (allSearchCols.constructor === Array && doc_type == 0) {
  allSearchCols.push("CUSTOM_INDEX");
}

// Define display label if not set in language settings
if (typeof(lang["customIndexTxt"]) == "undefined" || lang["customIndexTxt"] == "") {
  lang["customIndexTxt"] = "Custom Field Name";
}

Mostrar e interactuar con CUSTOM_INDEX

En las páginas de proyectos (Jobs), muestra el elemento del icono para vincular interacciones personalizadas:

$("#job_tile_custom_index")
  .show()
  .click(function() {
    window.open("https://www.my_external_app.com?id=" + job_data["CUSTOM_INDEX"], "newwindow");
  });

Añadiendo CUSTOM_INDEX para editar widgets

Para permitir que los usuarios introduzcan CUSTOM_INDEX valores dentro del diálogo de edición de trabajo, inserte una fila de formulario en el widget:

if (typeof($.custom.job_edit) != "undefined") {
  $.widget("custom.job_edit", $.custom.job_edit, {
    _init_main: function() {
      this._super(arguments);
      
      // Inject custom field row into the edit table
      var table = this.default_disc.closest("table");
      var tr = $("<tr>").appendTo(table);
      
      $("<td>", { html: lang.customIndexTxt + " :" }).appendTo(tr);
      $("<input>", {
        "name": "custom_index",
        "class": "data_cell",
        "data-field": "CUSTOM_INDEX",
        "maxlength": 45
      }).appendTo($("<td>").appendTo(tr));
      
      // Adjust layout spacing
      this.job_edit_memo.height(110);
    }
  });
}

Nota: En los documentos, haga referencia a este campo como xxx:custom_index.

Campos personalizados globales

Para almacenar contadores o configuraciones globales para toda la empresa, utilice los endpoints de campos personalizados globales (/php_functions/custom_fields_global_load.php y /php_functions/custom_fields_global_save.php):

$("#saving_dialog").dialog("open");

$.ajax({
  url: "/php_functions/custom_fields_global_save.php",
  type: "post",
  dataType: "json",
  data: {
    "fields": { "my_field": "any type of value" }
  },
  success: function(data) {
    $("#saving_dialog").dialog("close");
    if (typeof(data.error) !== "undefined") {
      error_message(isNaN(parseInt(data.error)) ? data.error : lang.error[data.error]);
    } else {
      // Returns JSON object containing all global custom fields
    }
  },
  error: function(jqXHR, textStatus, errorThrown) {
    $("#saving_dialog").dialog("close");
    error_message(lang.error[1] + " (" + errorThrown + ").");
  }
});

Configuración frente a campos personalizados de la API

Los campos creados en Ajustes > Campos Personalizados comparten exactamente el mismo almacenamiento de base de datos subyacente que los campos personalizados inyectados por API. Configurar un campo en la interfaz de usuario simplemente proporciona un creador sin código; eliminar un campo personalizado creado en la interfaz no elimina los datos históricos del campo, los cuales siguen siendo accesibles a través de la API.