Documentación de Oracle Cloud Infrastructure

Uso de parámetros en pipelines

En Data Integration, los parámetros de los pipelines se originan a partir de parámetros asignados en flujos de datos y tareas.

Para los operadores de flujo de datos que utilizan expresiones en la configuración, los valores de todos los parámetros que se utilizan en las expresiones también están disponibles para su reconfiguración en un pipeline.

Consulte Uso de parámetros de flujo de datos y Acerca de los parámetros de expresión para obtener información sobre cómo utilizar parámetros y parámetros de expresión (también conocidos como parámetros escalares) en flujos de datos.

Los parámetros y los parámetros de expresión que se utilizan en los flujos de datos y las tareas tienen tipos y valores por defecto. Si no cambia los valores de parámetro entrante de las tareas y los flujos de datos asociados en un pipeline, se utilizarán los valores por defecto originales en el tiempo de diseño del pipeline o en el tiempo de ejecución cuando ejecute el pipeline.

Los tipos de dato de parámetros entrantes soportados son:

  • NUMERIC
  • VARCHAR
  • DATE
  • DATETIME
  • DECIMAL
  • DOUBLE
  • FLOAT
  • INTEGER
  • TIMESTAMP
  • TINYINT
  • BOOLEAN
  • LONG
  • STRING

Los parámetros para los recursos de origen y destino en una tarea del cargador de datos también se pueden volver a configurar cuando la tarea se utiliza en un pipeline. Para obtener más información sobre cómo utilizar parámetros en tareas del cargador de datos, consulte Uso de parámetros para origen y destino.

Formas de volver a configurar parámetros en un pipeline

Al agregar una tarea parametrizada a un pipeline, puede utilizar el separador Configuración del panel Propiedades para volver a configurar cualquiera de los valores de parámetro especificados en dicha tarea o en el flujo de datos asociado que encapsula una tarea de integración.

Para volver a configurar un valor de parámetro entrante de una tarea en un pipeline, puede asignar a la entrada:

Al crear una tarea de pipeline para un pipeline parametrizado, puede utilizar la página Configurar parámetros para cambiar los valores por defecto de los parámetros definidos por el usuario, si los hay.

Tipos de parámetros de pipeline

En Data Integration, los tipos de parámetros que puede utilizar en los pipelines son definidos por el usuario o generados por el sistema.

Los parámetros generados por el sistema se pueden clasificar en los siguientes tipos:

Parámetros definidos por el usuario

Los parámetros definidos por el usuario son parámetros personalizados que crea en los pipelines para asignarlos a las entradas de parámetros entrantes de operadores de tarea. Un parámetro definido por el usuario es local del pipeline en el que se creó, por lo que no es posible reutilizar un parámetro definido por el usuario entre pipelines.

Un parámetro definido por el usuario tiene un nombre, un tipo y un valor. Debe proporcionar un nombre y un valor al crear un parámetro definido por el usuario. El tipo depende del tipo de parámetro entrante al que asigne el parámetro definido por el usuario. No se puede cambiar el tipo de parámetro definido por el usuario.

Los tipos de parámetro definido por el usuario que puede crear en un pipeline son:

  • Activo de datos
  • Conexión
  • Esquema
  • Entidad de datos
  • Condición (de una unión parametrizada o una condición de filtro)
  • Expresión

También puede agregar parámetros de tipo de dato como NUMERIC, VARCHAR, DATE, DECIMAL y STRING.

Al diseñar un pipeline, puede utilizar el panel Parámetros o el separador Parámetros del panel Propiedades del pipeline para ver los parámetros definidos por el usuario que se han agregado.

Los parámetros definidos por el usuario también están disponibles en el Creador de expresiones cuando se define una expresión en el pipeline mediante un operador de expresión.

Parámetros del sistema

Data Integration genera parámetros del sistema que puede utilizar para asignarlos a entradas de parámetros entrantes de operadores de tarea en tiempo de ejecución. Un parámetro del sistema tiene un nombre y un tipo. Puede enlazar el valor de un parámetro del sistema a un parámetro entrante del mismo tipo, pero no puede cambiar el valor.

En la siguiente tabla se muestran los parámetros del sistema que se pueden utilizar en un pipeline.

NombreTipoDescripción
SYS.TASK_START_TIMETIMESTAMPHora de inicio de tarea en UTC.
SYS.TASK_RUN_KEY

STRING

Clave de ejecución de tarea de la ejecución de tarea.
SYS.TASK_RUN_NAME

STRING

 Nombre de la ejecución de la tarea.
SYS.TASK_KEY

STRING

 Clave de la tarea.
SYS.TASK_NAME

STRING

 Nombre de la tarea.
SYS.PARENT_TASK_RUN_KEY

STRING

Clave de ejecución de tarea principal.
SYS.TASK_SCHEDULE_TRIGGER_TIMETIMESTAMPHora del disparador del programa (de una ejecución de tarea iniciada desde un programa). La hora programada puede ser diferente de la hora de inicio de la tarea.
SYS.TASK_SCHEDULE_TIMEZONESTRINGLa zona horaria correspondiente a la hora programada, que representa la hora de la zona horaria según se define en el programa de tareas.
SYS.RETRY_ATTEMPTINTEGERNúmero de intentos de ejecución de una tarea configurada para reintentos cuando falla una ejecución.
SYS.PIPELINE_NAMESTRINGNombre del pipeline.
SYS.PIPELINE_IDENTIFIERSTRINGIdentificador del pipeline.
SYS.TIMEOUTINTEGEREl valor de timeout (en minutos) del pipeline. La ejecución del pipeline falla cuando se alcanza el valor de timeout.
SYS.WORKSPACE_ID STRING Identificador del espacio de trabajo.
SYS.APPLICATION_KEY STRING Clave de la aplicación.
SYS.REGION STRING Nombre de región.

Al diseñar un pipeline, puede utilizar el separador Parámetros del panel Propiedades del pipeline para ver los parámetros del pipeline del sistema que están disponibles. La columna Utilizado en indica dónde se utiliza un parámetro en el pipeline.

Al agregar una expresión a un operador de expresión en un pipeline, puede utilizar el separador Parámetros del Creador de expresiones para ver la lista de parámetros del sistema. Puede utilizar parámetros del sistema en expresiones para registrar información del sistema.

Parámetros de salida

Los parámetros de salida son parámetros generados por el sistema para operadores que puede utilizar para transferir valores de salida de un operador de un pipeline a otro operador en sentido descendente.

En la tabla siguiente se muestran algunos parámetros de salida que puede utilizar.

NombreTipoDescripción
SYS.STATUSSTRINGEstado de la operación (por ejemplo, ejecución de tarea)
SYS.ERROR_MESSAGESTRINGMensaje de error para la operación
SYS.NO_OF_INSERTSINTEGERNúmero de filas insertadas y actualizadas
SYS.DATA_READINTEGERCantidad de datos leídos
SYS.DATA_WRITTENINTEGERCantidad de datos escritos
SYS.DURATIONINTEGERDuración de la operación
SYS.START_TIME_TIMESTAMPTIMESTAMPHora de inicio de la ejecución de la tarea en formato de registro de hora.
SYS.END_TIME_TIMESTAMPTIMESTAMPHora de finalización de la ejecución de la tarea en formato de registro de hora.
SYS.TASK_RUN_KEY

STRING

 Clave de ejecución de tarea de la ejecución de tarea.
SYS.TASK_RUN_NAME

STRING

 Nombre de la ejecución de la tarea.
SYS.TASK_NAME

STRING

 Nombre de la tarea.
SYS.TASK_KEY

STRING

 Clave de la tarea.

Al diseñar un pipeline, puede utilizar el separador Salida del panel Propiedades de un operador de tarea para ver las salidas que se pueden utilizar como entradas para el siguiente operador.

Tenga en cuenta lo siguiente:

  • Para un operador de tarea SQL asociado a un procedimiento almacenado, las salidas incluyen todos los parámetros de salida del procedimiento almacenado de SQL.

  • Para un operador de fusión, las salidas disponibles son una combinación de parámetros de salida del sistema y las salidas para cada operador conectado al operador de fusión.

    • Solo están disponibles las siguientes salidas del sistema: SYS.STATUS, SYS.START_TIME_TIMESTAMP y SYS.END_TIME_TIMESTAMP
    • Las salidas de tarea se cualifican mediante un nombre de operador de tarea. Por ejemplo: TASK_OPERATOR_1.SYS.STATUS, TASK_OPERATOR_2.SYS.STATUS
    • Las salidas de un operador de expresión se cualifican mediante el nombre del operador de expresión y el identificador de expresión. Por ejemplo: EXPRESSION_1. EXPRESSION_ERROR_MESSAGE (en inglés)
    • Las salidas de un operador de fusión se cualifican por el nombre del operador de fusión. Por ejemplo: MERGE_3. SYS.START_TIME_TIMESTAMP (en inglés)

  • Para un operador de tarea de OCI Data Flow asociado a una aplicación de OCI Data Flow, las salidas incluyen cualquier parámetro de salida de la aplicación y los siguientes tipos de datos de salida:

    • com.oracle.dos.task.model.customparameter.Arguments: argumentos
    • Float:
      • bytesProcessed
      • bytesWritten
    • Cadena:
      • applicationId
      • displayName

  • Para un operador de tarea de REST, están disponibles los siguientes tipos de dato de salidas de respuesta de REST:

    • JSON o JSON_TEXT: SYS.RESPONSE_PAYLOAD_JSON y SYS.RESPONSE_HEADERS_JSON
    • Cadena: SYS.RESPONSE_STATUS
    Nota

    • Para utilizar una salida de respuesta REST en operaciones descendentes, transfiera la salida a través de un operador de expresión, donde puede aplicar operaciones de cadena y expresión regular. A continuación, utilice el resultado en operadores de tareas posteriores descendentes.
    • Las salidas de cadena SYS.RESPONSE_PAYLOAD y SYS.RESPONSE_HEADERS están en desuso. Recomendamos convertir cualquier uso existente en los equivalentes de tipo de dato JSON de SYS.RESPONSE_PAYLOAD_JSON y SYS.RESPONSE_HEADERS_JSON, respectivamente.

Acerca del panel Parámetros

El panel Parámetros muestra todos los parámetros de pipeline definidos por el usuario que se han creado en un pipeline.

Para acceder al panel Parámetros cuando se abre el pipeline en el lienzo del diseñador, seleccione Parámetros en el menú Ver de la barra de herramientas del lienzo.

Utilice el separador Ver para ver los parámetros definidos por el usuario en el pipeline. Se mostrarán los parámetros utilizados y los no utilizados. Al seleccionar el enlace Utilizado En de un parámetroque se utiliza en el pipeline, se enfoca el operador en el lienzo que hace referencia al parámetro.

Utilice el separador Configuración del panel Parámetros para suprimir un parámetro definido por el usuario o editar el valor por defecto.

Nota

Para volver a configurar un valor de entrada, consulte Configuración de parámetros entrantes para tareas.

Adición de un parámetro en un pipeline

Puede agregar y definir parámetros definidos por el usuario en parámetros entrantes de operadores de tarea en un pipeline.

La forma de definir un parámetro definido por el usuario depende del tipo de parámetro entrante. Para todos los tipos de parámetro, proporcione un nombre y una descripción opcional, y defina un valor por defecto para el parámetro definido por el usuario. No puede cambiar el tipo y no puede cambiar el nombre y la descripción después de crear el parámetro.

Un parámetro definido por el usuario se puede reutilizar en el mismo pipeline para representar el valor configurado para otro parámetro entrante del mismo tipo.

  1. En el lienzo de un pipeline, seleccione un operador de tarea que tenga uno o más parámetros entrantes.
  2. En el panel Propiedades de la tarea seleccionada, seleccione Configuración.
  3. Junto a Parámetros entrantes configurados, revise el número de parámetros entrantes configurados y disponibles.
    Por ejemplo, 4/0 significa que hay cuatro parámetros entrantes disponibles en la tarea y que ninguno se ha reconfigurado.
  4. Seleccione Configurar junto a Parámetros entrantes configurados.
  5. En la página Configuración de parámetros entrantes, revise los valores de entrada que se pueden configurar. En la fila del tipo y valor de parámetro que desea agregar y asignar un parámetro de pipeline definido por el usuario, seleccione Configurar.
  6. En la página Configurar parámetro entrante para <tipo> que se muestra para el parámetro seleccionado, seleccione Asignar un parámetro.
  7. Seleccione Usar parámetros definidos para el usuario y, a continuación, seleccione Agregar parámetro para crear un parámetro definido por el usuario.
  8. En el panel Agregar parámetro, introduzca un nombre para el parámetro en el campo Identificador.
  9. (Opcional) Introduzca una descripción para ayudar a otros usuarios a identificar la finalidad del parámetro definido por el usuario.
  10. El campo Tipo muestra el tipo de parámetro entrante, que no se puede cambiar.
  11. Defina el valor por defecto del parámetro.
    La forma de definir el valor por defecto depende del tipo de parámetro entrante. Por ejemplo, para una entidad de datos, utilice menús para seleccionar un activo de datos, una conexión y un esquema y, a continuación, seleccione la entidad.
  12. Para crear el parámetro, seleccione Agregar.
    Por defecto, el parámetro definido por el usuario recién creado se selecciona en la página Configurar parámetro entrante para <tipo>.
  13. Repita los pasos para agregar más parámetros definidos por el usuario del mismo tipo, si es necesario.

Visualización de parámetros en un pipeline

Puede ver los parámetros del sistema que están disponibles en un pipeline y los parámetros definidos por el usuario que ha creado en un pipeline.

También puede utilizar este procedimiento para ver dónde se utiliza un parámetro en un pipeline.

  1. En el lienzo de un pipeline, haga clic en cualquier área en blanco.
  2. En el panel Propiedades del pipeline, seleccione Parámetros.
  3. Seleccione Definido por el usuario o Definido por el sistema.
  4. Revise la lista.
    La columna Se utiliza en indica dónde se utiliza el parámetro en el pipeline.

Asignación de un parámetro en un pipeline

Puede asignar parámetros definidos por el usuario y parámetros del sistema existentes a parámetros entrantes de operadores de tarea en un pipeline.

  1. En el lienzo de un pipeline, seleccione un operador de tarea que tenga uno o más parámetros entrantes.
  2. En el panel Propiedades de la tarea seleccionada, seleccione Configuración.
  3. Junto a Parámetros entrantes configurados, revise el número de parámetros entrantes configurados y disponibles.
    Por ejemplo, 4/0 significa que hay cuatro parámetros entrantes disponibles en la tarea y que ninguno se ha reconfigurado.
  4. Seleccione Configurar junto a Parámetros entrantes configurados.
  5. En la página Configuración de parámetros entrantes, revise los valores de entrada que se pueden configurar. En la fila del tipo y valor de parámetro que desea asignar a un parámetro del sistema o definido por el usuario, seleccione Configurar.
  6. En la página Configurar parámetro entrante para <tipo> que se muestra para el parámetro seleccionado, seleccione Asignar un parámetro.
  7. Seleccione Usar parámetros definidos por el usuario o Usar parámetros del sistema.
  8. Seleccione un parámetro existente de la lista de parámetros definidos por la persona o del sistema y, a continuación, seleccione Listo.

    Solo están disponibles para su selección los parámetros del mismo tipo que el parámetro entrante. Si no hay ninguno disponible, seleccione Cancelar.

    Para un parámetro definido por el usuario, también puede seleccionar Agregar para crear un parámetro y, a continuación, seleccionarlo. Consulte Adición de un parámetro en un pipeline.

Edición del valor por defecto de un parámetro definido por el usuario

En el tiempo de diseño del pipeline, puede cambiar rápidamente el valor por defecto de un parámetro definido por el usuario asignado.

  1. En el lienzo de un pipeline, seleccione Parámetros en el menú Ver de la barra de herramientas del lienzo.
  2. En el panel Parámetros, seleccione el separador Configuración.
  3. Revise los parámetros mostrados por nombre.

    Puede realizar una búsqueda en la lista introduciendo el nombre completo de un parámetro.

  4. En la fila del valor de parámetro que desea cambiar, seleccione Editar en el menú Acciones (Acciones, menú).
    Los tipos de dato de parámetro que puede editar son NUMERIC, VARCHAR, DATE, DECIMAL, DOUBLE, FLOAT, INTEGER, TIMESTAMP, TINYINT, BOOLEAN, LONG y STRING.

Anulación de la asignación de un parámetro en un pipeline

Al anular la asignación de un parámetro, solo se elimina el valor reconfigurado del parámetro entrante. No se suprime el parámetro entrante de la tarea ni se suprime el parámetro definido por el usuario.

  1. En el lienzo de un pipeline, seleccione un operador de tarea que tenga uno o más parámetros entrantes.
  2. En el panel Propiedades de la tarea seleccionada, seleccione Configuración.
  3. Junto a Parámetros entrantes configurados, revise el número de parámetros entrantes configurados y disponibles.
    Por ejemplo, 2/4 significa que hay cuatro parámetros entrantes disponibles en la tarea y que dos se han reconfigurado.
  4. Seleccione Configurar junto a Parámetros entrantes configurados.
  5. En la página Configurar parámetros entrantes, revise las entradas configuradas.
    Una entrada tiene un Valor por defecto. Si se reconfigura el parámetro entrante, la entrada tiene un Valor configurado. Un valor configurado puede ser un nombre de parámetro definido por el usuario con el valor reconfigurado que se muestra entre paréntesis.
  6. Para anular la asignación de un parámetro entrante, seleccione Borrar.

Supresión de un parámetro en un pipeline

Puede suprimir los parámetros de pipeline definidos por el usuario que ya no necesite en un pipeline.

No se pueden suprimir los parámetros del sistema de un pipeline.

  1. En el lienzo de un pipeline, seleccione Parámetros en el menú Ver de la barra de herramientas del lienzo.
    El separador Ver del panel Parámetros muestra los parámetros definidos por el usuario que se han creado en este pipeline. Si se utiliza un parámetro en una tarea, el enlace Utilizado en muestra el nombre de esa tarea.
  2. En el panel Parámetros, seleccione Configuración.
  3. Seleccione uno o más parámetros que desee suprimir. A continuación, seleccione Suprimir.
    Nota

    Cuando se suprime un parámetro definido por el usuario en un pipeline, se eliminan los valores configurados en los operadores de tarea asociados a este parámetro en el pipeline. Para volver a configurar un valor de entrada, consulte Configuración de parámetros entrantes para tareas.