Documentación del asistente de contexto

El objeto context proporciona una interfaz poderosa para acceder a datos y ejecutar acciones dentro del Report Static Query Builder.

Está disponible globalmente como:

window.context

Contiene varios componentes clave que permiten interactuar con parámetros, tablas, flujos, formularios y consultas.

Estructura General

{
  params: {},       // Query parameters
  table: {},        // Available tables with data
  flow: Function,  // Load or open a flow
  form: Function,  // Open a form
  query: {}         // Query builder object
}

Componentes

params

El objeto params contiene todos los parámetros disponibles para el reporte actual.

// Example
context.params.userId = "12345";
context.params.startDate = "2023-01-01";

table

El objeto table contiene todas las tablas disponibles. Cada tabla es una lista de objetos (filas).

// Example
const firstUser = context.table.users[0];
const totalSales = context.table.sales.reduce((sum, sale) => sum + sale.amount, 0);

flow()

La función flow() permite cargar o abrir otro flujo desde el reporte actual.

Parámetros:

context.flow({
  flowId: "flow123",                // Required: ID of the flow to load
  executionType: "loadFlow",        // Required: "loadFlow" or "openFlow"
  reloadCurrentFlow: true,          // Optional: Whether to reload the current page after loading the flow
  reloadCurrentContent: true,       // Optional: Whether to reload the current content after loading the flow
  resetParams: false,               // Optional: Whether to reset params to default after loading the flow
  params: [                         // Optional: Parameters to pass to the flow
    {
      paramName: "userId",
      paramValue: "12345"
    },
    {
      paramName: "view",
      paramValue: "detailed"
    }
  ]
});

Opciones de executionType

• openFlow → Abre el flujo en el panel

• loadFlow → Ejecuta el flujo en segundo plano

form()

La función form() permite abrir un formulario desde el reporte actual.

Parámetros

context.form({
  formId: "form123",               // Required: ID of the form to open
  params: [                        // Optional: Parameters to pass to the form
    {
      paramName: "userId",
      paramValue: "12345"
    },
    {
      paramName: "mode",
      paramValue: "edit"
    }
  ]
});

query

La propiedad query permite acceder al constructor de consultas programáticas.

Permite:

• Construir consultas dinámicas

• Aplicar filtros

• Ejecutar agregaciones

Para documentación detallada, consulta la sección específica del Query Builder.

Practical Examples

Navigating between flows based on a condition:

if (context.table.users.length > 0) {
  context.flow({
    flowId: "userDetailsFlow",
    executionType: "flow",
    params: [
      {
        paramName: "userId",
        paramValue: context.table.users[0].id
      }
    ]
  });
} else {
  context.flow({
    flowId: "noUsersFlow",
    executionType: "openFlow"
  });
}

Opening a form with data from the current context:

// Open an edit form for the first product in the table
context.form({
  formId: "productEditForm",
  params: [
    {
      paramName: "productId",
      paramValue: context.table.products[0].id
    },
    {
      paramName: "category",
      paramValue: context.params.currentCategory
    }
  ]
});

Loading a flow in the background and then reloading the current page:

// Update data in the background and then refresh the current view
context.flow({
  flowId: "dataUpdateFlow",
  executionType: "loadFlow",
  reloadCurrentFlow: true,
  reloadCurrentContent: true,
  resetParams: false
});

Best Practices

1. Parameter Management: When passing parameters to flows or forms, only include the parameters that need to change from the current context.

2. Error Handling: Always ensure that the required IDs (flowId, formId) are valid before calling the respective functions.

3. User Experience: Consider using reloadCurrent: true with caution as it will refresh the user's current view.

4. Performance: When working with large tables, consider processing the data before navigating to another flow to minimize the data transfer.