Sap Funciones

49
MANUALES Y TUTORIALES WWW.MUNDOSAP.COM A FUNCIONES DEL SISTEMA Aquí podrás encontrar las funciones del sistema que te ayudaran en el día a día como programador. Están ordenadas alfabéticamente para que te más fácil su búsqueda. A B C D E F G H I J K L M N O P Q R S T U V W X Y Z APPL_LOG_DISPLAY Definicion: Con este módulo de función se puede analizar logs de la base de datos. Sintaxis: CALL FUNCTION 'APPL_LOG_DISPLAY' EXPORTING OBJECT = <objeto> SUBOJECT = <subobjecto> EXTERNAL_NUMBER = <clase> OBJECT_ATTRIBUTE = <> SUBOBJECT_ATTRIBUTE = <> EXTERNAL_NUMBER_ATTRIBUTE = <> DATE_FROM = <> TIME_FROM = <> DATE_TO = <> TIME_TO = <> TITLE_SELECTION_SCREEN = <> TITLE_LIST_SCREEN = <> COLUMN_SELECTION = <> SUPRESS_SELECTION_DIALOG = <> COLUMN_SELECTION_MSG_JUMP = <flag> IMPORTING NUMBER_OF_PROTOCOLS = <protocolos> EXCEPTIONS NO_AUTHORITY = 1 OTHERS = 99. significado de los parámetros es el siguiente: OBJECT -> Nombre del objeto. SUBOBJECT -> Nombre del subobjeto. COLUMN_SELECTION -> El campo tiene la estructura BALDISP

Transcript of Sap Funciones

Page 1: Sap Funciones

MANUALES Y TUTORIALES WWW.MUNDOSAP.COM

A

FUNCIONES DEL SISTEMA Aquí podrás encontrar las funciones del sistema que te ayudaran en el día a día como programador. Están ordenadas alfabéticamente para que te más fácil su búsqueda.

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z APPL_LOG_DISPLAY Definicion: Con este módulo de función se puede analizar logs de la base de datos. Sintaxis: CALL FUNCTION 'APPL_LOG_DISPLAY' EXPORTING OBJECT = <objeto>

SUBOJECT = <subobjecto>

EXTERNAL_NUMBER = <clase>

OBJECT_ATTRIBUTE = <>

SUBOBJECT_ATTRIBUTE = <>

EXTERNAL_NUMBER_ATTRIBUTE = <>

DATE_FROM = <>

TIME_FROM = <>

DATE_TO = <> TIME_TO = <> TITLE_SELECTION_SCREEN = <>

TITLE_LIST_SCREEN = <>

COLUMN_SELECTION = <>

SUPRESS_SELECTION_DIALOG = <>

COLUMN_SELECTION_MSG_JUMP = <flag>

IMPORTING NUMBER_OF_PROTOCOLS = <protocolos> EXCEPTIONS NO_AUTHORITY = 1

OTHERS = 99. significado de los parámetros es el siguiente:

• OBJECT -> Nombre del objeto. • SUBOBJECT -> Nombre del subobjeto. • COLUMN_SELECTION -> El campo tiene la estructura BALDISP

Page 2: Sap Funciones

MANUALES Y TUTORIALES WWW.MUNDOSAP.COM

APPL_LOG_DISPLAY_INTERN Definicion: Con este módulo de función se puede analizar logs en memoria local. Sintaxis: CALL FUNCTION 'APPL_LOG_DISPLAY_INTERN' EXPORTING OBJECT = <objeto> SUBOJECT = <subobjecto> TITLE_LIST_SCREEN = <título> COLUMN_SELECTION = <atributos> COLUMN_SELECTION_MSG_JUMP = <flag> IMPORTING NUMBER_OF_PROTOCOLS = <contador> EXCEPTIONS NO_AUTHORITY = 1 SUBOBJECT_NOT_FOUND = 2 OTHERS = 99. El significado de los parámetros es el siguiente:

• OBJECT -> Nombre del objeto. • TITLE_LIST_SCREEN -> • SUBOJECT -> Nombre del subobjeto. • COLUMN_SELECTION -> El campo tiene la estructura BALDISP • COLUMN_SELECTION_MSG_JUMP

APPL_LOG_DELETE Definicion: Con este módulo de función borramos los logs en la base de datos de acuerdo con las selecciones especificadas. Sintaxis: CALL FUNCTION 'APPL_LOG_DELETE' EXPORTING OBJECT = <objeto>

SUBOJECT = <subobjecto>

EXTERNAL_NUMBER = <número externo>

DATE_TO = <fecha> TIME_TO = <hora> LOG_CLASS = <clase>

IMPORTING NUMBER_OF_DELETED_LOGS = <borrados>

NUMBER_OF_NON_DELETED_LOGS = <no-borrados>

EXCEPTIONS NO_AUTHORITY = 1

OTHERS = 99. El significado de los parámetros es el siguiente:

• OBJECT -> Nombre del objeto. • SUBOBJECT -> Nombre del subobjeto. • EXTERNAL_NUMBER -> Número externo de log. • DATE_TO -> Fecha de vencimiento de log. La función considera todos los logs cuya fecha de vencimiento

sea menor a la definida en este parámetro.

Page 3: Sap Funciones

MANUALES Y TUTORIALES WWW.MUNDOSAP.COM

• TIME_TO -> Hora de vencimiento de log. La función considera todos los logs cuya hora de vencimiento

sea menor a la definida en este parámetro, considerando también la fecha de DATE_TO. • LOG_CLASS -> Clase de log. • NUMBER_OF_DELETED_LOGS -> Número de logs de aplicación leídos y borrados. • NUMBER_OF_NON_DELETED_LOGS -> Número de logs de aplicación leídos y no borrados. •

El significado de la excepción es el siguiente:

• Excepción NO_AUTHORITY -> Usuario sin autorización a borrar logs de aplicación. APPL_LOG_DELETE_WITH_LOGNUMBER Definicion: Con este módulo de función borramos los logs de aplicación a partir del número de log. Sintaxis: CALL FUNCTION 'APPL_LOG_DELETE_WITH_LOGNUMBER' IMPORTING NUMBER_OF_DELETED_LOGS = <borrados> NUMBER_OF_NON_DELETED_LOGS = <no-borrados> TABLES LOGNUMBER = <tabla> EXCEPTIONS OTHERS = 99. El significado de los parámetros es el siguiente:

• NUMBER_OF_DELETED_LOGS -> Número de logs de aplicación leídos y borrados. • NUMBER_OF_NON_DELETED_LOGS -> Número de logs de aplicación leídos y no borrados.

El significado de la tabla es el siguiente: • LOG_NUMBER -> Tabla con los logs de aplicación a borrar. Se identifica el número de log. Debe tener la

estructura BALNO. APPL_LOG_INIT Definicion: Con este módulo de función comprueba si el objeto o subobjeto especificado existe, y borra todos los datos asociados existentes en la memoria local. Sintaxis: CALL FUNCTION 'APPL_LOG_INIT' EXPORTING OBJECT = <objeto> SUBOBJECT = <subobjeto> EXCEPTIONS OBJECT_NOT_FOUND = 1 SUBOBJECT_NOT_FOUND = 2 OTHERS = 3. El significado de los parámetros es el siguiente:

• OBJECT -> Nombre del objeto. • SUBOBJECT -> Nombre del subobjeto.

El significado de las excepciones es el siguiente: • OBJECT_NOT_FOUND -> Objeto no encontrado • SUBOBJECT_NOT_FOUND -> Subobjeto no encontrado.

Page 4: Sap Funciones

MANUALES Y TUTORIALES WWW.MUNDOSAP.COM

APPL_LOG_INIT_MESSAGES Definicion: Con este módulo de función inicia los mensajes asociados a un objeto existentes en la memoria local. Sintaxis: CALL FUNCTION 'APPL_LOG_INIT_MESSGES' EXPORTING OBJECT = <objeto> SUBOBJECT = <subobjeto> CONTINUE_PROTOCOL = <protocolo> EXCEPTIONS OBJECT_NOT_FOUND = 1 SUBOBJECT_NOT_FOUND = 2 OTHERS = 3. El significado de los parámetros es el siguiente:

• OBJECT -> Nombre del objeto. • SUBOBJECT -> Nombre del subobjeto. • CONTINUE_PROTOCOL -> Protocolo.

El significado de las excepciones es el siguiente: • OBJECT_NOT_FOUND -> Objeto no encontrado • SUBOBJECT_NOT_FOUND -> Subobjeto no encontrado.

Page 5: Sap Funciones

MANUALES Y TUTORIALES WWW.MUNDOSAP.COM

B BDC_INSERT Definicion: Se utiliza para añadir transacciones a una sesión de batch-input. Sintaxis: CALL FUNCTION 'BDC_INSERT' EXPORTING TCODE = <transacción> TABLES DYNPROTAB = <tabla> EXCEPTION INTERNAL_ERROR = 1 NOT_OPEN = 2 QUEUE_ERROR = 3

TCODE_INVALID = 4 El significado de los parámetros es el siguiente:

• TCODE -> Código de la transacción que será ejecutado. El parámetro es obligatorio. • DYNPROTAB -> Tabla con la estructura BDCDATA. Contiene los datos necesarios para completar una

transacción. El parametro es obligatorio. El significado de las excepciones es el siguiente:

• INTERNAL_ERROR -> Error interno. • NOT_OPEN -> Sesión de batch-input no abierta. • QUEUE_ERROR -> Error en la cola de batch-input. • TCODE_INVALID -> Código de transacción inválido. •

BDC_OPEN_GROUP Definicion: Con este módulo de función se crea una nueva sesión de batch-input. Sintaxis: CALL FUNCTION 'BDC_OPEN_GROUP' EXPORTING CLIENT = <mandante>

GROUP = <nombre>

HOLDDATE = <fecha> KEEP = <guardar> USER = <usuario> EXCEPTIONS QUEUE_ERROR = 1 CLIENT_INVALID = 2

GROUP_INVALID = 3. No se puede reabrir una sesión de batch-input que haya sido cerrada, Si abrimos una sesión de batch-input con un nombre que ya exista se crea una nueva sesión con el mismo nombre que el existente. Un programa de batch-input sólo puede tener una sesión de batch-input abierta a la vez. El significado de los parámetros es el siguiente:

Page 6: Sap Funciones

MANUALES Y TUTORIALES WWW.MUNDOSAP.COM

• CLIENT -> El campo <mandante> determina el mandante en el cual la sesión será procesada. Si no se

especifica el parámetro, el mandante será en el que estemos ejecutando el programa que genera la sesión de batch-input.

• GROUP -> En <nombre> se especifica el nombre de la sesión a crear. Puede ser hasta de 12 caracteres. El parámetro es obligatorio.

• HOLDDATE -> fecha de bloqueo. <fecha> determina hasta que fecha la sesión queda bloqueada y no puede ser procesada. Sólo el administrador del sistema (con autorización LOCK) puede desbloquear y ejecutar la sesión antes de la fecha indicada. El parámetro es opcional.

• KEEP -> Retener sesión. Si el campo <guardar> tiene el valor "X" la sesión sesión será retenida después de ser procesada satisfactoriamente. La sesión quedará en el sistema hasta que el administrador la borre. Si la sesión no se procesara correctamente se guarda en el sistema aunque no se haya marcado este campo. El parámetro es opcional, si no se especifica, la sesión se borra si termina correctamente (sólo se guarda el log de la sesión).

• USER -> Usuario de la sesión. En <usuario> identificamos el usuario para que el sistema compruebe las autorizaciones de proceso en fondo (background). El usuario deberá estar autorizado a todas las transacciones de la sesión, en caso contrario, la transacción terminará con un mensaje de falta de autorización. Los usuarios pueden ser de diálogo o de fondo. Los usuarios de diálogo suelen ser usuario que interaccionan con el sistema. Los usuarios de fondo se crean, normalmente, para ejecutar sesiones de batch-input (lógicamente en fondo).

• Las excepciones que se pueden producir son las siguientes:

• QUEUE_ERROR -> Error en la "cola" de batch-input. • CLIENT_INVALID -> Mandante inválido. • GROUP_INVALID -> Nombre de la sesión inválida.

BP_CALCULATE_NEXT_JOB_STARTS Definicion: Este módulo de función se utiliza para calcular la fecha y hora en la cual un job planificado podría ser ejecutado. Para ello se puede especificar un intervalo de tiempo para el análisis. La identificación del job se debe tomar del m´doulo de función JOB_OPEN. Las fechas y horas de arranque serán devueltas en una tabla interna de formato TBTCJOB. Sintaxis: CALL FUNCTION 'BP_CALCULATE_NEXT_JOB_STARTS' EXPORTING CALC_JOBNAME = <nombre>

CALC_JOBCOUNT = <id_job>

DATE_HORIZON = <fecha>

TIME_HORIZON = <hora>

TABLES JOB_STARTDATES = <tabla> EXCEPTIONS JOB_DOESNT_EXITS = 1 JOB_IS_NOT_TIME_PERIODIC = 2

HORIZON_IN_THE_PAST = 3

NO_STARTDATE_TILL_HORIZON = 4

HORIZON_OLDER_THAN_JOB_START = 5

OTHERS = 99. El significado de los parámetros es el siguiente:

• CALC_JOBNAME -> Nombre del job.

Page 7: Sap Funciones

MANUALES Y TUTORIALES WWW.MUNDOSAP.COM

• CALC_JOBCOUNT -> Id del job • DATE_HORIZON -> Fecha límite de comprobación. • TIME_HORIZON -> Hora límite de comprobación. • JOB_STARTDATES -> Tabla con las fechas planificadas hasta la fecha límite. •

Las excepciones que se pueden producir son las siguientes: • JOB_DOESNT_EXITS -> El job no existe. • JOB_IS_NOT_TIME_PERIODOC -> El job no se ha planificado con periodicidad. • HORIZON_IN_THE_PAST -> Límite de fecha en el pasado. • NO_STARTDATE_TILL_HORIZON -> No hay fechas planificadas antes de la fecha/hora límite. • HORIZON_OLDER_THAN_JOB_START -> Fecha límite anterior a la fecha de arranque del job. •

BP_CHECK_EVENTID Definición: Este módulo se utiliza para comprobar si el evento especificado ha sido definido en el sistema (código de retorno 0). Sintaxis: CALL FUNCTION 'BP_CHECK_EVENTID' EXPORTING EVENT_ID = <nombre>

EVENT_ID_TYPE = <tipo>

EXCEPTIONS EVENTID_NOT_DEFINED_YET = 1 INVALID_EVENTID_TYPE = 2 INVALID_SYSTEMEVENTID_PREFIX = 3 INVALID_USEREVENTID_PREFIX = 4 NO_EVENTID_SPECIFIED = 5

OTHERS = 99. El significado de los parámetros es el siguiente:

• EVENT_ID -> Evento a comprobar . Si el código de retorno devuelto por el sistema es 0, el evento existe. • EVENT_ID_TYPR -> Tipo de evento. S -> Evento del sistema, U -> Evento del sistema. •

Las excepciones que se pueden producir son las siguientes: • EVENTID_NOT_DEFINED_YET -> El evento especificado no existe. • INVALID_EVENTID_TYPE -> Tipo de evento inválido. • INVALID_SYSTEN_EVENTID_PREFIX -> Prefijo inválido para un evento del sistema. Los evento del

sistema deben comenzar por "SAP_".. • INVALID_USEREVENTID_PREFIX -> No hay fechas planificadas antes de la fecha/hora límite. • NO_EVENTID_SPECIFIED -> No se ha especificado ningún evento.

Page 8: Sap Funciones

MANUALES Y TUTORIALES WWW.MUNDOSAP.COM

BP_EVENT_RAISE Definición: Este módulo de función acciona un evento en el sistema de proceso de fondo. Sintaxis: CALL FUNCTION 'BP_EVENT_RAISE' EXPORTING EVENTID = <evento>

EVENTPARM = <argumento>

TARGET_INSTANCE = <instancia> EXCEPTIONS BAD_EVENTID = 1 EVENT_DOES_NOT_EXIST = 2 EVENTID_MISSING = 3

RAISE_FAILED = 4

OTHERS = 99. El significado de los parámetros es el siguiente:

• EVENTID -> Nombre del evento. • EVENTPARM -> Argumento del evento. • TARGET_INSTANCE -> Instancia para la cual se activa el evento. Generalmente no se utiliza.

Las excepciones que se pueden producir son las siguientes: • BAD_EVENTID -> Evento especificado inválido. • EVENT_DOES_NOT_EXIST -> Evento especificado no existe. • EVENTID_MISSING -> Evento no especificado.. • RAISE_FAILED -> Error al intentar activar un evento.

Con esta acción se posibilita que cualquier job que se haya planificado con base a ese evento, se ejecutará. Los eventos se pueden accionar con o sin argumentos. El argumento no es más que un string que cualifica al evento. Los jobs pueden planificarse para esperar un evento sin más, o un evento con argumento. Se puede utilizar el programa SAPEVT para accionar eventos desde un programa, un script o un fichero .bat desde fuera del sistema SAP. BP_FIND_JOBS_WITH_PROGRAM Definicion: Con esta función encontraremos a los jobs que utilicen un determinado programa. Sintaxis: CALL FUNCTION 'BP_FIND_JOBS_WITH_PROGRAM' EXPORTING ABAP_PROGRAM_NAME = <programa>

ABAP_VARIANT_NAME = <variante>

EXTERNAL_PROGRAM_NAME = <programa>

DIALOG = <modo>

TABLES JOBLIST = <tabla> EXCEPTIONS NO_JOBS_FOUND = 1 PROGRAM_SPECIFICATION_MISSING = 2

INVALID_DIALOG_TYPE = 3

JOB_FIND_CANCELED = 4

OTHERS = 99.

Page 9: Sap Funciones

MANUALES Y TUTORIALES WWW.MUNDOSAP.COM

El significado de los parámetros es el siguiente:

• ABAP_PROGRAM_NAME -> Programa ABAP/4 (tipo como SY-REPID). • ABAP_VARIANT_NAME ->Variante del programa (tipo como RALDB-VARIANT). • EXTERNAL_PROGRAM_NAME -> Programa externo. • DIALOG -> Modo de diálogo: "Y" -> Sí, "N" -> No. • JOBLIST -> Tabla con los jobs seleccionados (tabla TBTCJOB). •

Las excepciones que se pueden producir son las siguientes: • NO_JOBS_FOUND -> Para la selección realizada no existen jobs. • PROGRAM_SPECIFICATION_MISSING -> Sin especificación de programa. • INVALID_DIALOG_TYPE -> Modo de diálogo inválido. • INVALID_DIALOG_TYPE -> Modo de diálogo inválido. • JOB_FIND_CANCELED -> Búsqueda cancelada.

BP_JOB_DELETE Definición: Con esta función podremos borrar jobs. Sintaxis: CALL FUNCTION 'BP_JOB_DELETE' EXPORTING FORCEDMODE = <modo>

JOBNAME = <job>

JOBCOUNT = <id_job>

EXCEPTIONS CANT_DELETE_EVENTE_ENTRY = 1 CANT_DERELEASE_SUCCESOR = 2

CANT_DELETE_JOB = 3

CANT_DELETE_JOBLOG = 4

CANT_DELETE_STEPS = 5

CANT_DELETE_TIME_ENTRY = 6

CANT_ENQ_PREDECESSOR = 7

CANT_ENQ_SUCCESOR = 8

CANT_ENQ_TBTCO_ENTRY = 9

CANT_UPDATE_PREDECESSOR = 10

CANT_UPDATE_SUCESSOR = 11 COMMIT_FAILED = 12 JOBCOUNT_MISSING = 13

JOBNAME_MISSING = 14

JOB_DOES_NOT_EXIST = 15

JOB_IS_ALREADY_RUNNING = 16

NO_DELETE_AUTHORITY = 17

OTHERS = 99. El significado de los parámetros es el siguiente:

• FORCEDMODE -> Forzar el borrado aunque ocurran ciertos errores. • JOBNAME ->Nombre del job que se quiere borrar.

Page 10: Sap Funciones

MANUALES Y TUTORIALES WWW.MUNDOSAP.COM

• JOBCOUNT -> Id. del job que se quiere borrar.

Las excepciones que se pueden producir son las siguientes:

• CANT_DELETE_EVENT_ENTRY -> La planificación del evneto no puede ser borrada. • CANT_DELETE_JOB -> El job no puede ser borrado. • CANT_DELETE_JOBLOG -> El log del job no puede ser borrado. • CANT_DELETE_STEPS -> Los pasos del job no pueden ser borrados. • CANT_DELETE_TIME_ENTRY -> La planificación de fechas no puede ser borrada. • CANT_DERELEASE_SUCCESOR -> El job previo no puede ser modificado. • CANT_ENQ_PREDECESSOR -> El job predecesor no puede ser bloqueado. • CANT_ENQ_SUCCESSOR -> El job previo no puede ser bloqueado. • CANT_ENQ_TBTCO_ENTRY -> El job no puede ser bloqueado. • CANT_UPDATE_PREDECESSOR -> El job predecesor no puede ser modificado. • CANT_UPDATE_SUCCESSOR -> El job previo no puede ser modificado. • COMMIT_FAILED -> Error en el commit work. • JOBCOUNT_MISSING -> El id. del job no fue especificado. • JOBNAME_MISSING -> El nombre del job no fue especificado. • JOB_DOES_NOT_EXIST -> El job no existe. • JOB_IS_ALREADY_RUNNING -> El job se esta ejecutando. • NO_DELETE_AUTHORITY -> El usuario no tiene autorización para borrar ese job.

BP_JOB_COPY Definición: Se utiliza para copiar procesos de fondo. La copia incluye los pasos del job y atributos asociados. Sintaxis: CALL FUNCTION 'BP_JOB_COPY' EXPORTING DIALOG = <modo>

SOURCE_JOBCOUNT = <id_job_fuente>

SOURCE_JOBNAME = <job_fuente>

TARGET_JOBNAME = <id_job_destino>

IMPORTING NEW_JOBHEAD = <id_job_destino>

EXCEPTIONS CANT_CREATE_NEW_JOB = 1 CANT_ENQ_JOB = 2

CANT_READ_SOURCEDATA = 3 INVALID_OPCODE = 4 JOBNAME_MISSING = 5

JOB_COPY_CANCELED = 6

NO_COPY_PRIVILEGE_GIVEN = 7

NO_PLAN_PRIVILEGE_GIVEN = 8

OTHERS = 99. El significado de los parámetros es el siguiente:

• DIALOG -> Modo de diálogo: "Y -> Con diálogo", "N -> Sin diálogo" • SOURCE_JOBCOUNT -> Id. del job que va a ser copiado. • SOURCE_JOBNAME -> Nombre del job que va a ser copiado.

Page 11: Sap Funciones

MANUALES Y TUTORIALES WWW.MUNDOSAP.COM

• TARGET_JOBNAME -> Nombre del job copiado. • NEW_JOBHEAD -> Información del nuevo job (registro con la estructura TBTCJOB).

Las excepciones que se pueden producir son las siguientes:

• CANT_CREATE_NEW_JOB -> Error al crear el nuevo job. • CANT_ENQ_JOB -> Error al bloquear el job a copiar. • CANT_READ_SOURCEDATA -> Error al leer el job a copiar. • INVALID_OPCODE -> Código de operación inválido. • JOBNAME_MISSING -> Nombre del nuevo job sin especificar. • JOB_COPY_CANCELED -> Copia cancelada por el usuario. • NO_COPY_PRIVILEGE -> Sin autorización para copiar el job. • NO_PLAN_PRIVILEGE_GIVEN -> Sin autorización para copiar el job.

BP_JOB_GET_PREDECESSORS Definicion: Permite obtener una tabla con los jobs antecesores. Sintaxis: CALL FUNCTION 'BP_JOB_GET_PREDECESSORS' EXPORTING JOBCOUNT = <id_job>

JOBNAME = <job>

TABLES PRED_JOBLIST = <tabla> EXCEPTIONS JOB_NOT_EXISTS = 1 NO_PREDECESSORS_FOUND = 2

OTHERS = 99. El significado de los parámetros es el siguiente:

• JOBCOUNT -> Id. del job • JOBNAME -> Nombre del job • PRED_JOBLIST -> Tabla con los jobs antecesores

Las excepciones que se pueden producir son las siguientes: • JOB_NOT_EXISTS -> El job especificado no existe • NO_PREDECESSORS_FOUND -> No se han encontrado jobs antecesores.

BP_JOB_GET_SUCESSORS Definicion: Llama a la transacción SM37 (Resumen de jobs) Sintaxis: CALL FUNCTION 'BP_JOB_GET_SUCESSORS' ITABLES SUCC_JOBLIST = <tabla> EXCEPTIONS UNKNOWN_SELECTION_ERROR = 1 OTHERS = 99.

Page 12: Sap Funciones

MANUALES Y TUTORIALES WWW.MUNDOSAP.COM

Las excepciones que se pueden producir son las siguientes:

• UNKNOWN_SELECTION_ERROR -> Error desconocido. BP_JOB_SELECT Definición: Permite seleccionar jobs. Sintaxis: CALL FUNCTION 'BP_JOB_SELECT' EXPORTING JOBSELECT_DIALOG = <id_job>

JOBSEL_PARAM_IN = <parámetros>

IMPORTING JOBSEL_PARAM_OUT = <parámetros>

TABLES JOBSELECT_JOBLIST = <tabla>

EXCEPTIONS INVALID_DIALOG_TYPE = 1 JOBNAME_MISSING = 2 NO_JOBS_FOUND = 3 SELECTION_CANCELED = 4 USERNAME_MISSING = 5

OTHERS = 99. El significado de los parámetros es el siguiente:

• JOBSELECT_DIALOG -> Modo de diálogo "Y -> con diálogo", "N-> sin diálogo". Formato BTCH0000-CHAR1.

• JOBSEL_PARAM_IN -> Parámetros de selección de entrada. Formato BTCSELECT. • JOBSEL_PARAM_OUT -> Parámetros de selección de salida. Formato BTCSELECT. • JOBSELECT_JOBLIST -> Tabla con los jobs seleccionados. Formato TBTCJOB. •

Las excepciones que se pueden producir son las siguientes:

• INVALID_DIALOG_TYPE -> Modo de diálogo inválido. • JOBNAME_MISSING -> Nombre del job no especificado. • NO_JOBS_FOUND -> Para la selección realizada no existen jobs. • SELECTION_CANCELED -> Parámetros de selección inválidos. • USERNAME_MISSING -> No se ha especificado el usuario.

Page 13: Sap Funciones

MANUALES Y TUTORIALES WWW.MUNDOSAP.COM

BP_JOBLIST_PROCESSOR Definicion: Se utiliza para presentar al usuario una lista de jobs para su mantenimiento. Sintaxis: CALL FUNCTION 'BP_JOBLIST_PROCESSOR' EXPORTING JOBLIST_OPCODE = <modo_operación>

JOBLIST_REFR_PARAM = <refresco>

IMPORTING JOBLIST_SEL_JOB = <selección>

TABLES JOBLIST = <tabla> EXCEPTIONS INVALID_OPCODE = 1 JOBLIST_IS_EMPTY = 2 JOBLIST_PROCESSOR_CANCELED = 3

OTHERS = 99. El significado de los parámetros es el siguiente:

• JOBLIST_OPCODE -> Modo de trabajo. BTC_JOBLIST_SHOW -> Visualización. BTC_JOBLIST_EDIT -> Edición.

• JOBLIST_REFR_PARAM -> Parámetros de selección para el refresco de jobs. • JOBLIST_SEL_JOB -> Job seleccionado. • JOBLIST -> Tabla con los jobs a tratar.

Las excepciones que se pueden producir son las siguientes:

• INVALID_OPCODE -> Valor incorrecto en el parámetro JOBLIST_OPCODE. • JOBLIST_IS_EMPTY -> No se han encontrado jobs. • JOBLIST_PROCESSOR_CANCELED -> Proceso cancelado.

BP_JOBLOG_READ Definicion: Se utiliza para leer el log de un job. Sintaxis: CALL FUNCTION 'BP_JOBLOG_READ' EXPORTING CLIENT = <mandante>

JOBCOUNT = <id_job>

JOBNAME = <nombre_job>

TABLES JOBLOGTBL = <log>

EXCEPTIONS JOBLOG_DOES_NOT_EXIST = 1 JOBLOG_IS_EMPTY = 2 NO_JOBLOG_THERE_YET = 3 NO_SHOW_PRIVILEGE_GIVEN = 4

OTHERS = 99.

Page 14: Sap Funciones

MANUALES Y TUTORIALES WWW.MUNDOSAP.COM

El significado de los parámetros es el siguiente:

• CLIENT -> Mandante • JOBCOUNT -> Id. del job. • JOBNAME -> Nombre del job. • JOBLOGTBL -> Tabla con el log.

Las excepciones que se pueden producir son las siguientes

• JOBLOG_DOS_NOT_EXIST -> El log ya ha sido borrado. • JOBLOG_IS_EMPTY -> El job todavía no se ha ejecutado. • NO_JOBLOG_THERE_YET -> El job todavía no se ha ejecutado. • NO_SHOW_PRIVILIGE_GIVEN -> El usuario no tiene autorización para ver el log del job.

Por cada proceso de background que se ejecuta, el sistema genera un log que contiene lo siguiente: Mensajes del sistema background, mensajes de error de los programas del job. los programas externos no pueden generar mensajes en el log. BP_JOBLOG_SHOW Definicion: Sirve para mostrar una ventana al usuario con el job seleccionado. Sintaxis: CALL FUNCTION 'BP_JOBLOG_SHOW' EXPORTING CLIENT = <mandante>

JOBCOUNT = <id_job>

JOBNAME = <nombre_job>

EXCEPTIONS JOBLOG_DOES_NOT_EXIST = 1 JOBLOG_IS_EMPTY = 2 NO_JOBLOG_THERE_YET = 3 NO_SHOW_PRIVILEGE_GIVEN = 4

OTHERS = 99. El significado de los parámetros es el siguiente:

• CLIENT -> Mandante • JOBCOUNT -> Id. del job. • JOBNAME -> Nombre del job.

Las excepciones que se pueden producir son las siguientes:

• JOBLOG_DOS_NOT_EXIST -> El log ya ha sido borrado. • JOBLOG_IS_EMPTY -> El job todavía no se ha ejecutado. • NO_JOBLOG_THERE_YET -> El job todavía no se ha ejecutado. • NO_SHOW_PRIVILIGE_GIVEN -> El usuario no tiene autorización para ver el log del job.

Page 15: Sap Funciones

MANUALES Y TUTORIALES WWW.MUNDOSAP.COM

BP_JOBVARIANT_OVERVIEW Definicion: Ofrece una interfaz simplificada para la gestión de jobs. Sintaxis: CALL FUNCTION 'BP_JOBVARIANT_OVERVIEW' EXPORTING TITLE_NAME = <título> JOB_NAME = <nombre> PROG_NAME = <código> EXCEPTIONS NO_SUCH_REPORT = 1. El significado de los parámetros es el siguiente:

• TITLE_NAME -> Título que aparece en la gestión de jobs • JOBNAME -> Nombre del proceso background a listar • PROG_NAME -> Nombre del programa a listar.

Las excepciones que se pueden producir son las siguientes:

• NO_SUCH_REPORT -> El nombre de programa especificado no existe.

Con este módulo de función se puede:

• Ver el título de un job, el nombre del report y variante, especificaciones de fecha y hora de arranque, status y usuario de planificación, para quellos jobs que hayan sido planificados con el módulo BP_JOBVARIANT_SHEDULE.

• Permite a los usuarios modificar las especificaciones de arranque o período de rearranque para aquellos jobs que todavía no se hayan ejecutado.

• Permite a los usuarios mostrar el log de un job y la salida del spool. • Permite a los usuarios borrar un job que no está en ejecución.

BP_JOBVARIANT_SCHEDULE Definicion: Simplifica la planificación de un job para su ejecución Sintaxis: CALL FUNCTION 'BP_JOBVARIANT_SCHEDULE' EXPORTING TITLE_NAME = <título> JOB_NAME = <nombre> PROG_NAME = <código> EXCEPTIONS NO_SUCH_REPORT = 1. El significado de los parámetros es el siguiente:

• TITLE_NAME -> Título que aparece en la gestión de jobs • JOBNAME -> Nombre del proceso background a listar • PROG_NAME -> Nombre del programa a listar. •

Las excepciones que se pueden producir son las siguientes:

• NO_SUCH_REPORT -> El nombre de programa especificado no existe.

Page 16: Sap Funciones

MANUALES Y TUTORIALES WWW.MUNDOSAP.COM

Este módulo simplifica la planificación, ya que lo único requerido es el nombre del programa. El resto de parámetros se introducen en pantalla de diálogo (variante a utilizar, modo de ejecución y opciones de impresión). Este método de planificar un job tiene las siguientes características:

• Simplifica la estructura del job. Este módulo de función planifica un job que incluye únicamente un paso. • El módulo de función utiliza valores por defecto para muchas opciones de proceso de un job. Por ejemplo,

se puede especificar la impresora destino como parte de la llamada al módulo de función. En su lugar, el job utiliza la impresora por defecto.

• Sólo se pueden planificar programas ABAP/4. Debemos utilizar otros módulos de función si queremos utilizar programas externos.

• Las opcionesde fecha de arranque del job tienen restricciones. • La planificación basada en eventos no está contemplada.

Este módulo de función se utiliza de la siguiente forma: • Llamada al módulo de función especificando el nombre del report que deseamos planificar. • El módulo de función muestra una lista con las variantes existentes para ese report. El usuarios debe

seleccionar una variante. Como es lógico, todas las posibles variantes han de estar creadas con anterioridad. • A continuación el módulo de función muestra una pantalla donde el usuario puede seleccionar el modo de

ejecución. Si arranca el job inmediatamente o si arranca a una fecha y hora determinada. Además el usuarios puede decidir si el job se debe arrancar periódicamente.

• A continuación el job queda planificado. BP_START_DATE_EDITOR Definicion: Se utiliza para que el usuario pueda espeficar cuándo y cómo un job será arrancado. El módulo de función ofrece las mismas posibilidades de planificación que las de la transacción estándar: ejecución inmediate, ventana de arranque, especificación de job predecesor, evento, etc.. Sintaxis: CALL FUNCTION 'BP_START_DATE_EDITOR' EXPORTING STDT_DIALOG = <modo diálogo> STDT_OPCODE = <modo edición> STDT_INPUT = <especificación> STDT_TITLE = <título venta> EXCEPTIONS NO_SUCH_REPORT = 1. Las excepciones que se pueden producir son las siguientes:

• NO_SUCH_REPORT -> El nombre de programa especificado no existe. Este módulo de función permitirá planificar un job con una de las siguientes opciones:

• Arranque inmediato. • Arranque a una hora y feha determinada y hasta una hora y fecha determinada. • Arranque cuando se produzca un evento. • Arranque cuando se produzca un evento. • Arranque cuando se active un nuevo modo de operación. • Arranque después de que termine otro job (job predecesor). • Arranque en un día de un mes.

Además se puede especificar qué acciones se deben tomar si la fecha de arranque

Page 17: Sap Funciones

MANUALES Y TUTORIALES WWW.MUNDOSAP.COM

D DOWNLOAD Definicion: Para escribir datos a partir de una tabla interna sobre un fichero secuencial en el servidor de presentación con diálogo con el usuario, se utiliza el módulo de función DOWNLOAD. Veamos en la siguiente tabla los parámetros del módulo. El diálogo con el usuario se realiza a través de una caja de diálogo donde el usuario puede introducir, por ejemplo, el nombre y el tipo de fichero. Los campos que aparecen en la caja de diálogo pueden aparecer con valores por defecto. Sintaxis: CALL FUNCTION 'DOWNLOAD' EXPORTING BIN_FILESIZE = <tamaño ASCII> CODEPAGE = <tipo fichero DOS> FILENAME = <nombre fichero> FILETYPE = <tipo fichero> ITEM = <título cabecera> MODE = <modo escritura> IMPORTING ACT_FILENAME = <nombre fichero> ACT_FILETYPE = <tipo fichero> FILESIZE = <tamaño fichero> TABLES DATA_TAB = <tabla> EXCEPTION INVALID_FILESIZE = 1 INVALID_TABLE_WIDTH = 2 INVALID_TYPE = 3 El significado de los parámetros es el siguiente:

• BIN_FILESIZE -> Longitud del fichero para ficheros binarios. • CODEPAGE -> Sólo se utiliza para escribir fichero DOS (valor IBM). • FILENAME -> Nombre del fichero. Valor por defecto que aparece en la caja de diálogo con el usuario. • FILETYPE -> Tipo fichero. Valor que aparece por defecto en la caja de diálogo con el usuario."BIN ->

Para fichero binarios". Es obligatorio indicar en el campo BIN_FILESIZE la longitud del fichero. La tabla interna de transferencia de datos debe contener sólo una columna de tipo X. "ASC-> Para ficheros de tipo ASCII". "DAT -> para fichero Excel". Las columna están separadas por tabuladores y las líneas están separadas por retornos de carro y line feeds. "WKA1 -> Para ficheros de tipo Excel y Lotus (poco utilizado)".

• ITEM -> Título de cabecera para la caja de diálogo con el usuario. • MODE -> Modo de escritura. Con el campo en blanco, el fichero se sobrescribe. con "A" se añaden

registros al fichero.

Page 18: Sap Funciones

MANUALES Y TUTORIALES WWW.MUNDOSAP.COM

• ACT_FILENAME -> Nombre del fichero. El introducido en la caja de diálogo con el usuario. • ACT_FILETYPE -> Tipo de fichero. El introducido en la caja de diálogo con el usuario. • FILESIZE -> Números de bytes transferidos. • DATA_TAB -> tabla interna con los datos a transferir. •

El significado de las excepciones es el siguiente:

• INVALID_FILESIZE -> Valor inválido sobre el parémetros BIN_FILESIZE • INVALID_TABLE_WIDTH -> Estructura de tabla inválida. • INVALID_TYPE -> Valor inválido sobre el parémtro FILETYPE.

DB_SELECT_FULL_TABLE Definicion: Guarda el contenido de cualquier tabla de SAP en una tabla interna. Sintaxis: CALL FUNCTION 'DB_SELECT_FULL_TABLE' EXPORTING TABLENAME = <tabla> TABLES INTTAB = <tabla_interna> EXCEPTION DB_ERROR = 1 NOT_FOUND = 2 WRONG_PARAM = 3

OTHERS = 4. El significado de los parámetros es el siguiente:

• TABLENAME -> Nombre de la tabla de diccionario. • INTTAB -> Tabla interna donde se volcaran los datos.

El significado de las excepciones es el siguiente: • DB_ERROR -> Error al acceder a la base de datos. • NOT_FOUND -> La tabla de diccionario no existe. • WRONG_PARAM -> Error en los parámetros.

Page 19: Sap Funciones

MANUALES Y TUTORIALES WWW.MUNDOSAP.COM

DYNP_VALUES_READ Definicion: Se utiliza para leer el valor de un campo(s) de un modul-pool. Esta función solo se puede utilizar en el PBO o PAI de una dynpro. Se se utilizar en exits de campo para leer ciertos campos y después tratarlos. Con esta función se puede leer el contenido de cualquier campo de una dynpro, inclusive, step-loops. Sintaxis: CALL FUNCTION 'DYNP_VALUES_READ' EXPORTING DYNAME = <nombre_dynpro> DYNUMB = <numero_dynpro> TRANSLATE_TO_UPPER = <mayusculas_minusculas> TABLES DYNPFIELDS = <campos> EXCEPTION INVALID_ABAPWORKAREA = 1 INVALID_DYNPROFIELD = 2 INVALID_DYNPRONAME = 3

INVALID_DYNPRONUMBER = 4

INVALID_REQUEST = 5

NO_FIELDDESCRIPTION = 6

INVALID_PARAMETER = 7

UNDEFIND_ERROR = 8

OTHERS = 9. El significado de los parámetros es el siguiente:

• DYNAME -> Nombre de la dynpro. • DYNUMB -> Número de dynpro. • TRANSLATE_TO_UPPER -> Convertir el nombre de los campos en mayúsculas. • DYNPFIELDS -> Tabla donde se le pasan el nombre de los campos y nos devuelve su valor. Si el campo

pertenece a un steps-loop se le pasa el número del campo en el step-loop que queremos leer.

El significado de las excepciones es el siguiente: • INVALID_ABAPWORKAREA -> Error al leer en la área de ABAP. • INVALID_DYNPROFIELD -> Campo pasado no existe en la dynpro introducida. • INVALID_DYNPRONAME -> El nombre de la dynpro no existe. • INVALID_DYNPRONUMBER -> El número de la dynpro no existe. • INVALID_PARAMETER -> Error en los parámetros. • UNDEFIND_ERROR -> Error no definido.

DYNP_VALUES_UPDATE Definicion: Se utiliza para modificar el valor de un campo(s) de un modul-pool. Esta función solo se puede utilizar en el PBO o PAI de una dynpro. Se suele utilizar en exits de campo para leer ciertos campos y después tratarlos. Con esta función se puede modificar el contenido de cualquier campo de una dynpro, inclusive, steps-loops.

Page 20: Sap Funciones

MANUALES Y TUTORIALES WWW.MUNDOSAP.COM

Sintaxis: CALL FUNCTION 'DYNP_VALUES_READ' EXPORTING DYNAME = <nombre_dynpro> DYNUMB = <numero_dynpro> TRANSLATE_TO_UPPER = <mayusculas_minusculas> TABLES DYNPFIELDS = <campos> EXCEPTION INVALID_ABAPWORKAREA = 1 INVALID_DYNPROFIELD = 2 INVALID_DYNPRONAME = 3

INVALID_DYNPRONUMBER = 4

INVALID_REQUEST = 5

NO_FIELDDESCRIPTION = 6

INVALID_PARAMETER = 7

UNDEFIND_ERROR = 8

OTHERS = 9. El significado de los parámetros es el siguiente:

• DYNAME -> Nombre de la dynpro. • DYNUMB -> Número de dynpro. • TRANSLATE_TO_UPPER -> Convertir el nombre de los campos en mayúsculas. • DYNPFIELDS -> Tabla donde se le pasan el nombre del campo o los campos con los el nuevo valor . Si el

campo pertenece a un steps-loop se le pasa el número del campo en el steps-loop que queremos leer.

El significado de las excepciones es el siguiente:

• INVALID_ABAPWORKAREA -> Error al leer en la área de ABAP. • INVALID_DYNPROFIELD -> Campo pasado no existe en la dynpro introducida. • INVALID_DYNPRONAME -> El nombre de la dynpro no existe. • INVALID_DYNPRONUMBER -> El número de la dynpro no existe. • INVALID_PARAMETER -> Error en los parámetros. • UNDEFIND_ERROR -> Error no definido.

DISPLAY_LIST Definicion: Visualiza el listado recuperado de la memoria a través de la función list_from_memory. El listado se visualiza con el formato del listado original o el guardado en memoria. El listado se visualiza en una ventana de diálogo. Sintaxis: CALL FUNCTION 'WRITE_LIST' TABLES LISTOBJECT = <listado> EXCEPTION EMPTY_LIST = 1 OTHERS = 2. El significado de los parámetros es el siguiente:

• LISTOBJECT -> Tabla interna con el listado a visualizar. El significado de las excepciones es el siguiente:

• EMPTY_LIST -> Tabla del listado esta vacía.

Page 21: Sap Funciones

MANUALES Y TUTORIALES WWW.MUNDOSAP.COM

G GET_PRINT_PARAMETERS Definicion: Indica los parámetros de impresión de un job. Sintaxis: CALL FUNCTION 'GET_PRINT_PARAMETERS' EXPORTING MODE = <modo> REPORT = <report> NO_DIALOG = <flag_diálogo> IMPORTING OUT_PARAMETERS = <parámetros_impresión> OUT_ARCHIVE_PARAMETERS = <parámetros_archivo> VALID = <válido> EXCEPTION OTHERS = 99. El significado de los parámetros es el siguiente:

• MODE -> Modo de ejecución. • REPORT -> Nombre del report. El módulo de función utilizará las claúsulas LINE-COUNT y LINE-SIZE

del report especificado para presentar al usuario un formato de impresión por defecto. • NO_DIALOG ->Modo de ejecución: interactivo o no interactivo. • OUT_PARAMETERS -> Parámetros de impresión • OUT_ARCHIVE_PARAMETERS -> Parámetros de archivo óptico. • VALID -> Flag de error (si es SPACE existe error).

Si un programa ABAP/4 que será ejecutado en un proceso de fondo generará un listado, esta salida se deposita en el spool del sistema. Con el módulo GET_PRINT_PARAMETERS se puede especificar cómo se debe depositar la salida en el spool. Con este módulo de función se puede especificar los parámetros de impresión y de archivo óptico en dos modos: interactivo o no interactivo. El modo interactivo presenta una ventana al usuario para que especifique los parámetros. El modo no interactivo toma los datos del perfil de usuario. Siempre debemos utilizar este m´doulo de función en una creación de un job productivo, a no ser que el job no genere ninguna salida. Un job no productivo no es necesario que utilice este módulo de función. Los parámetros por defecto de paginación son 80 caracteres de ancho y 59 líneas por página. Puede que este formato no corresponda con el formato del report y la salida, por lo tanto, será incorrecta. No se pueden modificar directamente las estructuras utilizadas por el módulo de función GET_PRINT_PARAMETERS. Es obligatorio utilizar el módulo de función para actualizar los parámetros de impresión que se van a utilizar en un job.

Page 22: Sap Funciones

MANUALES Y TUTORIALES WWW.MUNDOSAP.COM

J JOB_CLOSE Definicion: Se utiliza para pasar el job al sistema de procesos de fondo para ser ejecutado. Sintaxis: CALL FUNCTION 'JOB_CLOSE' EXPORTING JOBNAME = <nombre> JOBCOUNT = <id_job> STRTIMMED = <inmediato> SDLSTRTDT = <fecha> SDLSTRTTM = <hora> LASTSTRDT = <hasta_fecha> LASTSTRTTM = <hasta_hora> PRDDAYS = <rep_día> PRDHOURS = <rep_hora> PRDMIN = <rep_min> PRDMONTHS = <rep_mes> PRDWEEKS = <rep_semana> TARGETSYSTEM = <destino> AT_OPMODE = <modo> AT_OPMODE_PERIODIC = <flag_periodo> PRED_JOBNAME = <pred_nombre> PRED_JOBCOUNT = <pred_id> PREDJOB_CHECKSTAT = <pred_check> EVENT_ID = <id_evento> EVENT_PARAM = <par_evento> EVENT_PERIODIC = <per_evento> CALENDAR_ID = <id_calendario> STARTDATE_RESTRICTION = <rest_fecha> START_ON_WORKDAY_NOT_BEFORE = <no_antes_fecha> START_ON_WORKDAY_NR = <nr_día> WORKDAY_COUNT_DIRECTION = <dirección> IMPORTING JOB_WAS_RELEASED = <liberado> EXCEPTION INVALID_STARTDATE = 1 JOBNAME_MISSING = 2 JOB_CLOSE_FAILED = 3 JOB_NOSTEPS = 4 JOB_NOTEX = 5 LOCK_FAILED = 6 OTHERS = 99.

Page 23: Sap Funciones

MANUALES Y TUTORIALES WWW.MUNDOSAP.COM

El significado de los parámetros es el siguiente:

• JOBNAME -> Nombre del job. • JOBCOUNT -> Id del job. • STRTIMMED ->Arranque inmediato. • SDLSTRDT -> Fecha de arranque. • SDLSTRTTM -> Hora de arranque. • LASTSTRDT -> Hasta la fecha de arranque. • LASTSTRTTM -> hasta la hora de arranque. • PRDDAYS -> Día (proceso repetitivo). • PRDHOURS -> Hora (proceso repetitivo). • PRDMINS -> Minuto (proceso repetitivo). • PRDMONTHS -> Mes (proceso repetitivo). • PRDWEEKS -> Semana (proceso repetitivo). • TARGETSYSTEM -> Sistema donde se ejecutará el job. • AT_OPMODE -> Modo en el que se especifican los parámetros de planificación. Con diálogo o no. • AT_OPMODE_PERIODIC -> Flag de periocidad. • PRED_JOBNAME -> Nombre del job predecesor. • PRED_JOBCOUNT -> Id. del job predecesor. • PREDJOB_CHECKSTAT -> Chequeo del job predecesor. • EVENT_ID -> Id de evento. • EVENT_PARAM -> Parámetro de evento. • EVENT_PERIODIC -> Periocidad del evento. • CALENDAR_ID -> Id. de calendario (para saber los días festivos). • STARTDATE_RESTRICITION -> Restricción de fecha de arranque. • START_ON_WORKDAY_NOT_BEFORE -> No arrancar el job antes de una fecha. • START_ON_WORKDAY_NR -> Arrancar el job en un día determinado. • WORKDAY_COUNT_DIRECTION -> Dirección para contar el día de arranque (ascendente o

descendente). • JOB_WAS_RELEASED -> Job liberado.

El significado de las excepciones es el siguiente: • INVALID_STARTDATE -> Fecha de arranque inválida. • JOBNAME_MISSING -> Nombre de job no especificado. • JOB_CLOSE_FAILED -> Creación del job no es posible. • JOB_NOSTEPS -> Job sin pasos. • JOB_NOTEX -> Job sin especificaciones. • LOCK_FAILED -> Error en el bloqueo del job.

En función de la ejecución especificada habrá ciertos parámetros que tendrán información, permaneciendo el resto sin datos. Una vez que se cierra un job no se pueden añadir pasos al job, ni cambiar sus especificaciones. El módulo de función devuelve un indicador que define si el job ha sido liberado automáticamente o no. El job se libera automáticamente si el usuario que planifica el job tien autorización para ello. Si el proceso no se libera tendrá que ser el administrador del sistema, o un usuario autorizado el que libere el job.

Page 24: Sap Funciones

MANUALES Y TUTORIALES WWW.MUNDOSAP.COM

JOB_OPEN Definicion: Hay dos formas de planificar job. Una es través de la función BP_JOBVARIANT_SCHEDULE. Este método se le conoce como express por su sencillez de planificación y hay otra que se le llama metodo control total que utiliza las siguientes funciones JOB_OPEN, JOB_SUBMIT y JOB_CLOSE para planificar un job. Este método es más complejo de programar (no mucho más) pero tiene la ventaja de no tener las limitaciones del primer método. Este módulo se utiliza para crear un job. Sintaxis: CALL FUNCTION 'JOB_OPEN' EXPORTING DELANFREP = <borrar> JOBGROUP = <grupo> JOBNAME = <nombre> SDLSTRTDT = <fecha> SDLSTRTTM = <hora> IMPORTING JOBCOUNT = <numero_job> EXCEPTION CANT_CREATE_JOB = 1 INVALID_JOB_DATA = 2 JOBNAME_MISSING = 3 OTHERS = 4. El significado de los parámetros es el siguiente:

• DELANFREP -> Activando el campo (con X) el job se borrar después de una ejecución satisfactoria. • JOBGROUP -> Grupo que se le asigna al job. • JOBNAME -> Nombre del job. • SDLSTRDT -> Fecha de arranque. • SDLSTRTTM -> Hora de arranque. • JOBCOUNT -> Número identificativo del job.

El significado de las excepciones es el siguiente: • CANT_CREATE_JOB -> El job no puede ser creado.. • INVALID_JOB_DATA -> Datos inválidos en el job. • JOBNAM_MISSING -> Nombre del job no especificado..

La función devuelve un número de identificacióbn único que, junto con el nombre del job, es requerido para identificar el proceso. Una vez que el proceso se abre, se puede añadir pasos al job utilizando la función JOB_SUBMIT (o la sentencia SUBMIT). Para submitir el proceso de fondo se utiliza la función JOB_CLOSE. Los job tienen una prioridad que cuando se crean se le asigna por defecto la C, pero se puede cambiar a través de la transacción SM36 o SM37.

Page 25: Sap Funciones

MANUALES Y TUTORIALES WWW.MUNDOSAP.COM

JOB_SUBMIT Definicion: Se utiliza para añadir pasos a un job que se haya abierto previamente con la función JOB_OPEN. Sintaxis: CALL FUNCTION 'JOB_SUBMIT' EXPORTING AUTHCKNAM = <usuario> JOBCOUNT = <id_job> JOBNAME = <nombre_job> REPORT = <report> VARIANT = <variante> PRIPARAMS = <parámetros_impresión> ARCPARAMS = <parámetros_archivos> EXTPGM_NAME = <programa> EXTPGM_PARAM = <parámetros> EXTPGM_SYSTEM = <sistema> EXTPGM_WAIT_FOR_TERMINATION = <flag1> EXTPGM_STDOUT_IN_JOBLOG = <flag2> EXTPGM_SET_TRACE_ON = <flag3> EXTPGM_STDERRR_IN_JOB = <flag4> EXCEPTION BAD_PRIPARAMS = 1 INVALID_JOBDATA = 2 JOBNAME_MISSING = 3 JOB_NOTEX = 4 JOB_SUBMIT_FAILED = 5 LOCK_FAILED = 6 PROGRAM_MISSING = 7 PROG_ABAP_AND_EXTPG_SET = 8 BAD_XPGFLAGS = 9 OTHERS = 99. El significado de los parámetros es el siguiente:

• AUTHCKNAM -> Usuario para comprobaciones de autorización. • JOBCOUNT -> Id del job. • JOBNAME ->Nombre del job. • REPORT -> Nombre del report • VARIANT -> Nombre de la variante del report. • PRIPARAMS -> Parámetros de impresión. • ARCPARAMS -> Parámetros de archivo. • EXTPGM_NAME -> Nombre del programa externo. • EXTPGM_PARAM-> Parámetros del programa externo. • EXTPGM_SYSTEM-> Sistema de ejecución. • EXTPGM_WAIT_FOR_TERMINATION -> Flag para programas externos. • EXTPGM_STDOUT_IN_JOBLOG -> Flag para programas externos. • EXTPGM_SET_TRACE_ON -> Flag para programas externos. • EXTPGM_STDERR_IN_JOBLOG-> Flag para programas externos. •

El significado de las excepciones es el siguiente:

• BAD_PRIPARAMS -> Parámetros de impresión erróneos.

Page 26: Sap Funciones

MANUALES Y TUTORIALES WWW.MUNDOSAP.COM

• INVALID_JOBDATA -> Datos del job inválidos • JOBNAME_MISSING -> Nombre del job sin especificar. • JOB_NOTEX -> Job no existente. • JOB_SUBMIT_FAILED -> Error en llamada submit. • LOCK_FAILED -> Error de bloqueo. • PROGRAM_MISSING -> Programa especificado inexistente. • PROG_ABAP_AND_EXTPF_SET -> Error en el programa especificicado. • BAD_XPGFLAGS -> Error de uso de algún flag.

Un paso de job es una unidad independiente, donde se ejecuta un programa externo al sistema SAP. Cada paso puede tener sus propias autorizaciones de usuario y sus propias especificaciones de impresión y archivo. Una vez los pasos esten incluídos en el job, se debe utilizar la función JOB_CLOSE para lanzar el job.

Page 27: Sap Funciones

MANUALES Y TUTORIALES WWW.MUNDOSAP.COM

L LIST_FROM_MEMORY Definicion: Recupera un listado de la memoria de SAP. El listado es enviado a través de submit... exporting list to memory. Sintaxis: CALL FUNCTION 'LIST_FROM_MEMORY' TABLES LISTOBJECT = <listado> EXCEPTION NOT_FOUND = 1 OTHERS = 2. El significado de los parámetros es el siguiente:

• LISTOBJECT -> Tabla interna donde se almacena el listado recuperado de la memoria. El significado de las excepciones es el siguiente:

• NOT_FOUND -> No hay ningún listado en memoria.

LIST_TO_ASCI Definicion: Convierte el listado recuperado con la función list_from_memory a un listado de tipo ASCII. Sintaxis: CALL FUNCTION 'LIST_FROM_MEMORY'

TABLES LISTASCI = <listado_resultante>

LISTOBJECT = <listado_entrante EXCEPTION EMPTY_LIST = 1 LIST_INDEX_INVALID = 2 OTHERS = 2. El significado de los parámetros es el siguiente:

• LISTASCI -> Listado convertido a un listado de tipo ASCII • LISTOBJECT -> Tabla interna donde se almacena el listado recuperado de la memoria y que se va a

convertir..

El significado de las excepciones es el siguiente: • EMPTY_LIST -> La tabla con el listado a convertir esta vacía. • LIST_INDEX_INVALID -> Tipo de listado inválido.

Page 28: Sap Funciones

MANUALES Y TUTORIALES WWW.MUNDOSAP.COM

M MESSAGE_PREPARE Definicion: Prepara un mensaje para un log de aplicación. Sintaxis: CALL FUNCTION 'MESSAGE_PREPARE' EXPORTING LANGUAGE = <lenguaje> MSG_ID = <id_mensaje> MSG_NO = <nr_mensaje> MSG_VAR1 = <variable1> MSG_VAR2 = <variable2> MSG_VAR3 = <variable3> MSG_VAR4 = <variable4> IMPORTING MSG_TEXT = <mensaje> EXCEPTION FUNCTION_NOT_COMPLETED = 1 MESSAGE_NOT_FOUND = 2 OTHERS = 99. El significado de los parámetros es el siguiente:

• LANGUAGE -> Lenguaje en el cual el mensaje es leído. • MSG_ID -> Identificador de mensaje • MSG_NO -> Número de mensaje. • MSG_VAR1 -> Variable 1 del mensaje. • MSG_VAR2 -> Variable 2 del mensaje. • MSG_VAR3 -> Variable 3 del mensaje. • MSG_VAR4 -> Variable 4 del mensaje. • MSG_TEXT -> Texto del mensaje leído..

El significado de las excepciones es el siguiente:

• FUNCTION_NOT_COMPLETED -> Función no completada. • MESSAGE_NOT_FOUND -> Mensaje no encontrado.

Page 29: Sap Funciones

MANUALES Y TUTORIALES WWW.MUNDOSAP.COM

P POPUP_NO_LIST Definicion: Este módulo de función presenta una ventana de diálogo que informa al usuario de que el listado que se va a generar está vacío. Sintaxis: CALL FUNCTION 'POPUP_NO_LIST' EXPORTING ON_EMPTY_LIST = <tipo> FORCE = <fila> EXCEPTION OTHERS = 99. El significado de los parámetros es el siguiente:

• ON_EMPTY_LIST -> Con el valort "X" el mensaje aparece en una ventana de diálogo. Con el valor " " el mensaje aparece en la barra de estado. El mensaje que aparece en español es: "No ha sido creada ninguna lista".

• FORCE -> Comprueba que se haya utilizado alguna sentencia de escritura. POPUP_TO_CONFIRM_LOSS_OF_DATA Definicion: Presenta una ventana de diálogo donde se informa al usuario que se perderán los datos. Sintaxis: CALL FUNCTION 'POPUP_TO_CONFIRM_LOSS_OF_DATA' EXPORTING TEXTLINE1 = <texto1> TEXTLINE2 = <texto2> TITEL = <título> START_COLUMN = <columna> START_ROW = <fila> IMPORTING ANSWER = <respuesta> EXCEPTION OTHERS = 99. El significado de los parámetros es el siguiente:

• TEXTLINE1 -> Primera línea de texto de la ventana de diálogo. • TEXTLINE2 -> Segunda línea de texto de la ventana de diálogo. • TITEL -> Título de la ventana. • START_COLUMN -> Columna de la esquina superior izquierda de la ventana. • START_ROW -> Fila de la esquina superior izquierda de la ventana. • ANSWER -> Respuesta del usuario -> "J - Sí" y "N - No".

Page 30: Sap Funciones

MANUALES Y TUTORIALES WWW.MUNDOSAP.COM

POPUP_TO_CONFIRM_STEP Definicion: Este módulo de función presenta una ventana de diálogo para confirmar la ejecución de un paso. Sintaxis: CALL FUNCTION 'POPUP_TO_CONFIRM_STEP' EXPORTING DEFAULTOPTION = <opción> TEXTLINE1 = <texto1> TEXTLINE2 = <texto2> TITEL = <título> START_COLUMN = <columna> START_ROW = <fila> CANCEL_DISPLAY = <cancelar> IMPORTING ANSWER = <respuesta> EXCEPTION OTHERS = 99. El significado de los parámetros es el siguiente:

• DEFAULT_OPTION -> Botón seleccionado por defecto. "Y - Sí", "N - No" y "A - Cancelar". • TEXTLINE1 -> Primera línea de texto de la ventana de diálogo. • TEXTLINE2 -> Segunda línea de texto de la ventana de diálogo. • TITEL -> Título de la ventana. • START_COLUMN -> Columna de la esquina superior izquierda de la ventana. • START_ROW -> Fila de la esquina superior izquierda de la ventana. • CANCEL_DISPLAY -> Eliminar el botón de cancelar. "X" -> No y " " -> Sí. • ANSWER -> Respuesta del usuario -> "J - Sí", "N - No" y "A - Cancelar".

POPUP_TO_CONFIRM_WITH_MESSAGE Definicion: Presenta una ventana de diálogo para confirma la ejecución de un paso con un texto explicativo. Sintaxis: CALL FUNCTION 'POPUP_TO_CONFIRM_WITH_MESSAGE' EXPORTING DEFAULTOPTION = <opción> DIAGNOSETEXT1 = <texto_descriptivo_1> DIAGNOSETEXT2 = <texto_descriptivo_2> DIAGNOSETEXT3 = <texto_descriptivo_3> TEXTLINE1 = <texto1> TEXTLINE2 = <texto2> TITEL = <título> START_COLUMN = <columna> START_ROW = <fila> CANCEL_DISPLAY = <cancelar> IMPORTING ANSWER = <respuesta> EXCEPTION OTHERS = 99.

Page 31: Sap Funciones

MANUALES Y TUTORIALES WWW.MUNDOSAP.COM

El significado de los parámetros es el siguiente:

• DEFAULT_OPTION -> Botón seleccionado por defecto. "Y - Sí", "N - No" y "A - Cancelar". • DIAGNOSETEXT1 -> Texto descriptivo de la acción 1. • DIAGNOSETEXT2 -> Texto descriptivo de la acción 2. • DIAGNOSETEXT3 -> Texto descriptivo de la acción 3. • TEXTLINE1 -> Primera línea de texto de la ventana de diálogo. • TEXTLINE2 -> Segunda línea de texto de la ventana de diálogo. • TITEL -> Título de la ventana. • START_COLUMN -> Columna de la esquina superior izquierda de la ventana. • START_ROW -> Fila de la esquina superior izquierda de la ventana. • CANCEL_DISPLAY -> Eliminar el botón de cancelar. "X" -> No y " " -> Sí. • ANSWER -> Respuesta del usuario -> "J - Sí", "N - No" y "A - Cancelar".

POPUP_TO_DECIDE_WITH_VALUE Definicion: Muestra una venta de diálogo para que el usuario elija una de las opciones posibles, o cancelar la acción. Sintaxis: CALL FUNCTION 'POPUP_TO_DECIDE_WITH_VALUE' EXPORTING DEFAULTOPTION = <opción> OBJECT_VALUE = <texto> TEXT_AFTER = <texto_posterior> TEXT_BEFORE = <texto_anterior> TITEL = <título> START_COLUMN = <columna> START_ROW = <fila> CANCEL_DISPLAY = <cancelar> IMPORTING ANSWER = <respuesta> EXCEPTION OTHERS = 99. El significado de los parámetros es el siguiente:

• DEFAULT_OPTION -> Botón seleccionado por defecto. "Y - Sí", "N - No" y "A - Cancelar". • OBJECTVALUE -> Texto principal • TEXT_AFTER -> Texto Posterior al texto principal. • TEXT_BEFORE -> Texto anterior al texto principal. • TITEL -> Título de la ventana. • START_COLUMN -> Columna de la esquina superior izquierda de la ventana. • START_ROW -> Fila de la esquina superior izquierda de la ventana. • CANCEL_DISPLAY -> Eliminar el botón de cancelar. "X" -> No y " " -> Sí. • ANSWER -> Respuesta del usuario -> "1 - Primera opción", "2 - Segunda opción" y "A - Cancelar".

Page 32: Sap Funciones

MANUALES Y TUTORIALES WWW.MUNDOSAP.COM

POPUP_TO_DECIDE Definicion: Muestra una venta de diálogo para que el usuario elija una de las opciones posibles, o cancelar la acción. Sintaxis: CALL FUNCTION 'POPUP_TO_DECIDE' EXPORTING DEFAULTOPTION = <opción> TEXTLINE1 = <texto1> TEXTLINE2 = <texto2> TEXTLINE3 = <texto3> TEXT_OPTION1 = <texto_opción_1> TEXT_OPTION2 = <texto_opción_2> TITEL = <título> START_COLUMN = <columna> START_ROW = <fila> CANCEL_DISPLAY = <cancelar> IMPORTING ANSWER = <respuesta> EXCEPTION OTHERS = 99. El significado de los parámetros es el siguiente:

• DEFAULT_OPTION -> Botón seleccionado por defecto. "1 - Primera opción" y "2 - segunda opción". • TEXTLINE1 -> Primera línea de texto de la ventana de diálogo. • TEXTLINE2 -> Segunda línea de texto de la ventana de diálogo. • TEXTLINE3 -> Tercera línea de texto de la ventana de diálogo. • TEXT_OPTION1 -> Texto de la opción 1. • TEXT_OPTION2 -> Texto de la opción 2. • TITEL -> Título de la ventana. • START_COLUMN -> Columna de la esquina superior izquierda de la ventana. • START_ROW -> Fila de la esquina superior izquierda de la ventana. • CANCEL_DISPLAY -> Eliminar el botón de cancelar. "X" -> No y " " -> Sí. • ANSWER -> Respuesta del usuario -> "1 - Primera opción", "2 - Segunda opción" y "A - Cancelar".

Page 33: Sap Funciones

MANUALES Y TUTORIALES WWW.MUNDOSAP.COM

POPUP_TO_DECIDE_LIST Definicion: Se muestra una ventana de diálogo para que el usuario elija una de las posibles opciones que presenta. Sintaxis: CALL FUNCTION 'POPUP_TO_DECIDE_LIST' EXPORTING CURSORLINE = <línea_marcada> MARK_FLAG = <flag> MARK_MAX = <límite_líneas> START_COL = <columna> START_ROW = <fila> TEXTLINE1 = <texto1> TEXTLINE2 = <texto2> TEXTLINE3 = <texto3> TITEL = <título> IMPORTING ANSWER = <respuesta> TABLE T_SPOPLI = <opciones> EXCEPTION OTHERS = 99. El significado de los parámetros es el siguiente:

• CURSORLINE -> Línea marcada por defecto. • MARK_FLAG -> " " -> Las opciones son radiobutton. "X" -> Las opciones son checkbox. • MARK__MAX -> Limita el número de opciones. • START_COL -> Columna de la esquina superior izquierda de la ventana. • START_ROW -> Fila de la esquina superior izquierda de la ventana. • TEXTLINE1 -> Primera línea de texto de la ventana de diálogo. • TEXTLINE2 -> Segunda línea de texto de la ventana de diálogo. • TEXTLINE3 -> Tercera línea de texto de la ventana de diálogo. • TITEL -> Título de la ventana. • ANSWER -> Respuesta del usuario -> "1 - Primera opción", "2 - Para la segunda", etc... • T_SPOPLI -> Tabla con los textos de cada opción.

Page 34: Sap Funciones

MANUALES Y TUTORIALES WWW.MUNDOSAP.COM

POPUP_TO_DECIDE_WITH_MESSAGE Definicion: Presenta una ventana de diálogo para que el usuario escojaa una de las dos opciones posibles, o cancele la acción. En la venta se puede añadir un mensaje de hasta tres líneas. Sintaxis: CALL FUNCTION 'POPUP_TO_DECIDE_WITH_MESSAGE' EXPORTING DEFAULTOPTION = <opción> DIAGNOSETEXT1 = <texto_descriptivo_1> DIAGNOSETEXT2 = <texto_descriptivo_2> DIAGNOSETEXT3 = <texto_descriptivo_3> TEXTLINE1 = <texto1> TEXTLINE2 = <texto2> TEXT_OPTION1 = <texto_opción_1> TEXT_OPTION2 = <texto_opción_2> TITEL = <título> START_COLUMN = <columna> START_ROW = <fila> CANCEL_DISPLAY = <cancelar> IMPORTING ANSWER = <respuesta> EXCEPTION OTHERS = 99. El significado de los parámetros es el siguiente:

• DEFAULT_OPTION -> Botón seleccionado por defecto. "Y - Sí", "N - No" y "A - Cancelar". • DIAGNOSETEXT1 -> Texto descriptivo de la acción 1. • DIAGNOSETEXT2 -> Texto descriptivo de la acción 2. • DIAGNOSETEXT3 -> Texto descriptivo de la acción 3. • TEXTLINE1 -> Primera línea de texto de la ventana de diálogo. • TEXTLINE2 -> Segunda línea de texto de la ventana de diálogo. • TEXT_OPTION1 -> Texto de la opción 1. • TEXT_OPTION2 -> Texto de la opción 2. • TITEL -> Título de la ventana. • START_COLUMN -> Columna de la esquina superior izquierda de la ventana. • START_ROW -> Fila de la esquina superior izquierda de la ventana. • CANCEL_DISPLAY -> Eliminar el botón de cancelar. "X" -> No y " " -> Sí. • ANSWER -> Respuesta del usuario -> "J - Sí", "N - No" y "A - Cancelar".

Page 35: Sap Funciones

MANUALES Y TUTORIALES WWW.MUNDOSAP.COM

POPUP_TO_DISPLAY_TEXT Definicion: Presenta una ventana de diálogo con un texto, para continuar el usuario ha de pulsar en el botón "Continuar". Sintaxis: CALL FUNCTION 'POPUP_TO_CONFIRM_LOSS_OF_DATA' EXPORTING TEXTLINE1 = <texto1> TEXTLINE2 = <texto2> TITEL = <título> START_COLUMN = <columna> START_ROW = <fila> EXCEPTION OTHERS = 99. El significado de los parámetros es el siguiente:

• TEXTLINE1 -> Primera línea de texto de la ventana de diálogo. • TEXTLINE2 -> Segunda línea de texto de la ventana de diálogo. • TITEL -> Título de la ventana. • START_COLUMN -> Columna de la esquina superior izquierda de la ventana. • START_ROW -> Fila de la esquina superior izquierda de la ventana.

Page 36: Sap Funciones

MANUALES Y TUTORIALES WWW.MUNDOSAP.COM

S SCHEDULE_MAIL_SEND Definicion: Se utiliza para enviar un mensaje a la bandeja de entrada de un usuario o varios usuarios. Sintaxis: CALL FUNCTION 'SCHEDULE_MAIL_SEND' EXPORTING OWNER = <usuario_mensaje> OBJECT_TITLE = <título_mensaje> TABLES OWNER_OR_DISTR_LIST = <destinatarios> OBJECT_CONTENTS = <contenido> EXCEPTION OTHERS = 1. El significado de los parámetros es el siguiente:

• OWNER -> Usuario quien envía el mensaje. • OBJECT_TITLE -> Título del mensaje. • OWNER_OR_DISTR_LIST -> Usuario(s) que recibirán el mensaje. • OBJECT_CONTENTS -> Contenido del mensaje.

Page 37: Sap Funciones

MANUALES Y TUTORIALES WWW.MUNDOSAP.COM

U UPLOAD Definicion: Se utiliza para leer los datos de un fichero secuencial en el servidor de presentación con diálogo con el usuario. a una tabla interna. El diálogo con el usuario se realiza a través de una ventana de diálogo, donde se puede introducir la ruta del fichero y el tipo de fichero a leer, dichos valores pueden aparecer por defecto. Sintaxis: CALL FUNCTION 'UPLOAD' EXPORTING CODEPAGE = <código_página> FILENAME = <nombre_fichero> FILETYPE = <tipo_fichero> ITEM = <línea_cabecera> IMPORTING FILESIZE = <tamaño_fichero> ACT_FILENAME = <nombre_fichero> ACT_FILETYPE = <tipo_fichero> TABLES DATA_TAB = <datos> EXCEPTION CONVERSION_ERROR = 1 INVALID_TABLE_WIDHT = 2 INVALID_TYPE = 3. El significado de los parámetros es el siguiente:

• CODEPAGE -> Sólo se utiliza para leer fichero DOS (valor IBM). • FILENAME -> Nombre del fichero. Valor que aparece por defecto en la caja de diálogo. "BIN -> Ficheros

binarios, es obligatorio indicar en el campo BIN_FILESIZE la longitud del fichero y la tabla interna de transferencia debe contener una sola columna de tipo X.", "ASC - Fichero ASCII", "DAT - Ficheros Excel. Las columnas han de estar separadas por tabuladores y las líneas separadas por retorno de carro y line feed" y "WK1 ficheros de tipo Excel y Lotus (poco usado)"

• ITEM -> Línea de cabecera en la caja de diálogo. • FILESIZE -> Números de bytes transferidos. • ACT_FILENAME -> Nombre del fichero. El introducido en la ventana de diálogo. • ACT_FILETYPE -> Tipo de fichero. El introducido en la ventana de diálogo. • DATA_TAB -> Tabla interna con los datos transferidos.

El significado de las excepciones es el siguiente: • CONVERSION_ERROR -> Error en la conversión de datos. • INVALID_TABLE_WIDTH -> Estructura de tabla inválida. • INVALID_TYPE -> Valor inválido sobre el parámetro FILETYPE.

Page 38: Sap Funciones

MANUALES Y TUTORIALES WWW.MUNDOSAP.COM

W WS_DOWNLOAD Definicion: Se utiliza para transferir datos de una tabla interna a un fichero sin diálogo con el usuario. Sintaxis: CALL FUNCTION 'WS_DOWNLOAD' EXPORTING BIN_FILESIZE = <tamaño_fichero_binario> CODEPAGE = <código_página> FILENAME = <nombre_fichero> FILETYPE = <tipo_fichero> MODE = <mode> IMPORTING FILELENGTH = <tamaño_fichero> TABLES DATA_TAB = <datos> EXCEPTION FILE_OPEN_ERROR = 1 FILE_WRITE_ERROR = 3 INVALID_FILESIZE = 4 INVALID_TABLE_WIDHT = 5 INVALID_TYPE = 6. El significado de los parámetros es el siguiente:

• BIN_FILESIZE -> Longitud del fichero para ficheros binarios. • CODEPAGE -> Sólo se utiliza para leer fichero DOS (valor IBM). • FILENAME -> Nombre del fichero. Valor que aparece por defecto en la caja de diálogo. "BIN -> Ficheros

binarios, es obligatorio indicar en el campo BIN_FILESIZE la longitud del fichero y la tabla interna de transferencia debe contener una sola columna de tipo X.", "ASC - Fichero ASCII", "DAT - Ficheros Excel. Las columnas han de estar separadas por tabuladores y las líneas separadas por retorno de carro y line feed" y "WK1 ficheros de tipo Excel y Lotus (poco usado)"

• ITEM -> Línea de cabecera en la caja de diálogo. • FILESIZE -> Números de bytes transferidos. • ACT_FILENAME -> Nombre del fichero. El introducido en la ventana de diálogo. • ACT_FILETYPE -> Tipo de fichero. El introducido en la ventana de diálogo. • DATA_TAB -> Tabla interna con los datos transferidos.

El significado de las excepciones es el siguiente: • FILE_OPEN_ERROR -> Error en la apertura del fichero. • FILE_WRITE_ERROR -> Error en la escritura del fichero. • INVALID_FILESIZE -> Valor inválido sobre el parámetro BIN_FILESIZE • CONVERSION_ERROR -> Error en la conversión de datos. • INVALID_TABLE_WIDTH -> Estructura de tabla inválida. • INVALID_TYPE -> Valor inválido sobre el parámetro FILETYPE.

Page 39: Sap Funciones

MANUALES Y TUTORIALES WWW.MUNDOSAP.COM

WS_QUERY Definicion: Para conseguir cierta información del sistema operativo del servidor de presentación, o de los ficheros existentes sobre éste. Los parámetros más importantes son: Sintaxis: CALL FUNCTION 'WS_DOWNLOAD' EXPORTING FILENAME = <fichero> QUERY = <query> IMPORTING RETURN = <resultado> TABLES DATA_TAB = <datos> EXCEPTION INV_QUERY = 1. El significado de los parámetros es el siguiente:

• FILENAME -> Nombre del fichero para las queries: FE, FL y DE.. • QUERY -> Query. Las queries más importantes son: CD -> Directorio actual. EN -> Variable de entorno,

FL -> Longitud del fichero especificado en FILENAME, FE -> Existencia del fichero especificado en FILENAME, Existencia del directorio especificado en FILENAME, WS -> Sistema Windows del servidor de presentación, OS -> Sistema operativo del servidor de presentación.

• RETURN -> Resultado de la query. 0 significa NO, 1 -> Significa SÍ.

El significado de las excepciones es el siguiente: • INV_QUERY -> Valor érroneo en el parámetro QUERY o FILENAME.

WS_UPLOAD Definicion: Se utiliza para transferir datos de un fichero a una tabla interna sin diálogo con el usuario. Sintaxis: CALL FUNCTION 'WS_UPLOAD' EXPORTING CODEPAGE = <código_página> FILENAME = <nombre_fichero> FILETYPE = <tipo_fichero> ITEM = <línea_cabecera> IMPORTING FILESIZE = <tamaño_fichero> ACT_FILENAME = <nombre_fichero> ACT_FILETYPE = <tipo_fichero> TABLES DATA_TAB = <datos> EXCEPTION CONVERSION_ERROR = 1 INVALID_TABLE_WIDHT = 2 INVALID_TYPE = 3. El significado de los parámetros es el siguiente:

• CODEPAGE -> Sólo se utiliza para leer fichero DOS (valor IBM). • FILENAME -> Nombre del fichero. Valor que aparece por defecto en la caja de diálogo. "BIN -> Ficheros

binarios, es obligatorio indicar en el campo BIN_FILESIZE la longitud del fichero y la tabla interna de transferencia debe contener una sola columna de tipo X.", "ASC - Fichero ASCII", "DAT - Ficheros Excel.

Page 40: Sap Funciones

MANUALES Y TUTORIALES WWW.MUNDOSAP.COM

Las columnas han de estar separadas por tabuladores y las líneas separadas por retorno de carro y line feed" y "WK1 ficheros de tipo Excel y Lotus (poco usado)"

• ITEM -> Línea de cabecera en la caja de diálogo. • FILESIZE -> Números de bytes transferidos. • ACT_FILENAME -> Nombre del fichero. El introducido en la ventana de diálogo. • ACT_FILETYPE -> Tipo de fichero. El introducido en la ventana de diálogo. • DATA_TAB -> Tabla interna con los datos transferidos.

El significado de las excepciones es el siguiente: • CONVERSION_ERROR -> Error en la conversión de datos. • INVALID_TABLE_WIDTH -> Estructura de tabla inválida. • INVALID_TYPE -> Valor inválido sobre el parámetro FILETYPE.

WRITE_LIST Definicion: Visualiza el listado recuperado de la memoria a través de la función list_from_memory. El listado se visualiza con el formato del listado original o el guardado en memoria. El listado se visualiza en una página completa. Sintaxis: CALL FUNCTION 'WRITE_LIST' TABLES LISTOBJECT = <listado> EXCEPTION EMPTY_LIST = 1 OTHERS = 2. El significado de los parámetros es el siguiente:

• LISTOBJECT -> Tabla interna con el listado a visualizar. El significado de las excepciones es el siguiente:

• EMPTY_LIST -> Tabla del listado esta vacía.

Page 41: Sap Funciones

MANUALES Y TUTORIALES WWW.MUNDOSAP.COM

II

FUNCIONES DE WORKFLOW Aquí podrás encontrar las funciones de Workflow que te ayudaran en el día a día como programador. Están ordenadas alfabéticamente para que te más fácil su búsqueda.

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z RH_SWWUSERWI_READ_FOR_WI Definicion: Permite saber que usuarios tienen un determinado Workitem. Sintaxis: CALL FUNCTION 'RH_SWWUSERWI_READ_FOR_WI' IMPORTING WI_ID = <workitem>

INCLUDING_NO_SEL_ENTRIES = <flag>

TABLES ACT_WI_OF_USER = <usuarios> EXCEPTIONS NOTHING_FOUND = 1

OTHERS = 2. El significado de los parámetros es el siguiente:

• WI_ID -> Workitem a buscar. • INCLUDING_NO_SEL_ENTRIES -> Si ponemos una 'X' no incluirá los usuarios que no puedan ejecutar

el workitems. Si vale ' ' incluye todos los usuarios aunque estos no lo puedan ejecutar. • ACT_WI_OF_USER -> Tabla con los usuarios que tienen el Workitem.

El significado de las excepciones es el siguiente: • NOTHING_FOUND -> El usuario no existe.

Page 42: Sap Funciones

MANUALES Y TUTORIALES WWW.MUNDOSAP.COM

RH_SWWUSERWI_READ_FOR_USER Definicion: Lee los workitems que tiene un usuario. Sintaxis: CALL FUNCTION 'RH_SWWUSERWI_READ_FOR_USER' IMPORTING USER_ID = <usuario> ADD_GENERAL_TASKS = <flag> INCLUDING_NO_SEL_ENTRIES = <flag> TABLES TASK_FILTER = <tareas> ACT_WI_OF_USER = <worktitems> EXCEPTIONS NOTHING_FOUND = 1 OTHERS = 2. El significado de los parámetros es el siguiente:

• USER_ID -> Usuario al que buscaremos sus Workitems. • ADD_GENERAL_TASK -> Si vale 'X' no incluye los Workitems que no sean nuestros. Si vale ' ' busca

todos los Workitems aunque no sean nuestros. • INCLUDING_NO_SEL_ENTRIES -> Si ponemos una 'X' no incluye los Workitems que no puedan

ejecutar el usuario. Si vale ' ' incluye todos los Worktitems aunque no los puede ejecutar. • TASK_FILTER -> Busca los Workitems cuya tarea coincida con alguna de las introducidas en este

parámetro. • ACT_WI_OF_USER -> Tabla con los Workitems del usuario.

El significado de las excepciones es el siguiente:

• NOTHING_FOUND -> El usuario no existe. RH_INBOX_VIEW_CREATE Definicion: Esta función nos muestra los Workitems que tiene un usuario en la bandeja de entrada. Por defecto solo nos muestra los que tiene en su bandeja de entrada, para ver los que tiene en su bandeja de entrada hay que indicar en la tabla de estatus que busque los que están en estado WAITING. Para ver un ejemplo completo del funcionamiento de dicha función pulsa aquí. Sintaxis: CALL FUNCTION 'RH_INBOX_VIEW_CREATE' IMPORTING SEARCH_DATE = <fecha> READ_OBJECT_TEXT = <texto_objeto> NO_WI_SELECTION = <flag> NO_HEADER_SELECTION = <flag> TABLES INBOX_VIEW = <usuario> WI_HEAD = <worktitems> WI_STATUS = <status> TASK_FILTER = <filtro> EXCEPTIONS NO_ACTIVE_PLVAR = 1 NO_TASK_FOUND = 2 USER_NOT_DEFINED = 3 NO_WORKITEM_FOUND = 4.

Page 43: Sap Funciones

MANUALES Y TUTORIALES WWW.MUNDOSAP.COM

El significado de los parámetros es el siguiente:

• SEARCH_DATE -> Buscar los Workitems de un usuario que cuya fecha sea inferior o igual a la introducida.

• READ_OBJECT_TEXT -> No documentada. • NO_WI_SELECTION -> Seleccionar documento de Workflow que no sean Workitem. • NO_HEADER_SELECTION -> No documentada . • INBOX_VIEW -> Tabla donde indicaremos los usuarios de los cuales buscaremos sus documentos. • WI_HEAD -> Workitems que el usuario tiene en su carpeta de entrada. • WI_STATUS -> En esta tabla pondremos los estatus por los cuales queremos buscar. Si no indicamos

ningún status la función devuelve los estatus que el ha buscado por defecto. • TASK_FILTER -> En esta tabla pondremos las tareas por las cuales queramos buscar. Si no indicamos

nada buscara todas las tareas que tenga el usuario.

El significado de las excepciones es el siguiente:

• NO_ACTIVE_PLVAR -> Exepción definida pero que no se utiliza. • NO_TASK_FOUND -> Exepción definida pero que no se utiliza. • USER_NOT_DEFINED -> Exepción definida pero que no se utiliza. • NO_WORKITEM_FOUND -> Error que se produce cuando no se encuentra ningún Workitem.

Page 44: Sap Funciones

MANUALES Y TUTORIALES WWW.MUNDOSAP.COM

S SWL_GET_WI_STATUS_TEXT Definicion: Devuelve el significado de un estatus de un Workitem. Sintaxis: CALL FUNCTION 'SWL_GET_WI_STATUS_TEXT' IMPORTING WI_STATUS = <estatus>

EXPORTING WI_STATUS_TXT = <texto_estatus> El significado de los parámetros es el siguiente:

• WI_STATUS -> Estatus del Workitem del que vamos a buscar su significado. • WI_STATUS_TXT -> Texto del estatus introducido en el idioma en que nos hayamos conectado al

sistema. SWL_WI_INBOX_READ Definicion: Devuelve una estructura con la misma información que se muestra en la bandeja de entrada de un determinado Workitem Sintaxis: CALL FUNCTION 'SWL_WI_INBOX_READ' IMPORTING WI_ID = <workitem> CHANGING WORKITEM = <datos_workitem> El significado de los parámetros es el siguiente:

• WI_ID -> Workitem a buscar. • WORKITEM -> Estructura con la información del Workitem.

Page 45: Sap Funciones

MANUALES Y TUTORIALES WWW.MUNDOSAP.COM

SWL_WI_RESUBMISSION_END Definicion: Función que pasa un Workitem de la carpeta de funciones pendientes a la bandeja de entrada. Sintaxis: CALL FUNCTION 'SWL_WI_RESUBMISSION_END' IMPORTING WI_ID = <workitem> USER = <usuario> CHANGING WORKITEM = <datos_workitem> El significado de los parámetros es el siguiente:

• WI_ID -> Workitem. • USER -> Usuarios quien tiene el workitem. • WORKITEM -> Estructura con la información del Workitem.

SWL_INBOX_VIEW_READ Definicion: Función, que menos potente pero igualmente útil que la función RH_INBOX_VIEW_CREATE (en el fondo SWL_INBOX_VIEW_CREATE llama a esta última), que nos devuelve el contenido de la carpeta de entrada de Workflow, es decir, nos dice que Workitems tenemos en nuestra carpeta de entrada. Sintaxis: CALL FUNCTION 'SWL_INBOX_VIEW_READ' IMPORTING ACT_LANGU = <idioma> ACT_FOLRG = <carpeta> TABLES INBOX_VIEW = <usuario(s)> WORKLIST = <workitems> ITEMS = <información> INT_WL = <uso_interno> IT_TASK_FILTER = <tareas> EXCEPTIONS FOLDER_REGION_NOT_IMPLENTED 1. El significado de los parámetros es el siguiente:

• ACT_LANGU -> -> Idioma en que aparecerán los textos. • ACT_FOLRG -> De que carpeta de nuestro Workplace queremos leer los Workitem. Los posibles valores

son: I -> Bandeja de entrada, 1 -> Bandeja de salida, 4 -> Workitems ejecutados por mi, 5 -> Workitems transmitidos por mi, 2 -> Workitems en carpeta de funciones pendientes, 3 -> Lista de Workitem y 6 -> Grupo de la bandeja de entrada.

• INBOX_VIEW -> Tabla con los usuarios cuyos workitems queremos saber. • WORKLIST -> Información de los workitem encontrados en la carpeta seleccionada (ACT_FOLRG) de

los usuarios introducidos (INBOX_VIEW). • ITEMS -> Información adicional de los workitems encontrados. • INT_WL -> Información adicional de uso interno de SAP. • IT_TASK_FILTER -> Filtra la búsqueda de workitems por una tarea o tareas.

El significado de las excepciones es el siguiente: • FOLDER_REGION_NOT_IMPLEMENTED -> La carpeta de la cual queremos buscar los Workitems de

un determinado usuario no existe.

Page 46: Sap Funciones

MANUALES Y TUTORIALES WWW.MUNDOSAP.COM

SWI_RESUBMISSION_CREATE Definicion: Función que nos devuelve los workitem que tengamos apartados o en funciones pendiente hasta una fecha determinada (por defecto nos buscara los workitems apartados cuya fecha de aparación en la bandeja de entrada sea inferior a 31/12/9999). Sintaxis: CALL FUNCTION 'SWI_RESUBMISSION_CREATE' IMPORTING LANGUAGE = <idioma> USER = <user> SELDATE = <fecha> TABLES WORKLIST = <workitems> EXCEPTIONS READ_FAILED 1. El significado de los parámetros es el siguiente:

• LANGUAGE -> Idioma en que aparecen los textos informativos de los worktiems encontrandos. • USER -> Usuario a buscar sus Workitems. • ción a la bandeja de entrada sea inferior o igual a la introducida. • WORKLIST -> Información de los workitem encontrados.

El significado de las excepciones es el siguiente:

• READ_FAILED -> Si se produce esta excepción quiere decir que el usuario no tiene documentos en su bandeja de funciones pendientes.

Page 47: Sap Funciones

MANUALES Y TUTORIALES WWW.MUNDOSAP.COM

III

FUNCIONES DE INTERNET Aquí podrás encontrar las funciones de Internet que te ayudaran en el día a día como programador. Están ordenadas alfabéticamente para que te más fácil su búsqueda.

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z CALL_BROWSER Definicion: Función que llama al navegador web con una dirección determinada que este instalado en el ordenador cliente. Sintaxis: CALL FUNCTION 'CALL_BROWSER' IMPORTING URL = <url> BROWSERTYPE = <navegaor> CONTEXTSTRING = <parámetro> EXCEPTIONS FRONTED_NOT_SUPPORTED = 1 FRONTED_ERROR = 2 PROG_NOT_FOUND = 3 NO_BATCH = 4 UNSPECIFIED_ERROR = 5 El significado de los parámetros es el siguiente:

• URL -> Dirección web que queremos visitar. • BROWSERTYPE -> Indicamos el navegador que queremos que se lanze, si no ponemos nada se lanzara

navegador de Microsoft. Párametro opcional. • CONTEXTSTRING -> Parámetro que le podemos pasar al navegador. Parámetro opcional.

El significado de las excepciones es el siguiente:

• FRONTED_NOT_SUPPORTED -> SAPGUI no soporta el tipo de navegador. • FRONTED_ERROR -> Error al llamar al navegador. • PROG_NOT_FOUND -> No se encuentra la ruta del navegador. • NO_BATCH -> La función no puede ser lanzada en Batch. • UNSPECIFIED_ERROR -> Error no especificado.

Page 48: Sap Funciones

MANUALES Y TUTORIALES WWW.MUNDOSAP.COM

W WWW_LIST_TO_HTML Definicion: Función que se sitúa al final del programa o al final del procedimiento de visualización, y devuelve una tabla interna con el listado mostrado en pantalla en código HTML. Podemos pasar el contenido de la tabla interna a un fichero con extensión .html y ver el fichero en cualquier navegador web. Sintaxis: CALL FUNCTION 'WWW_LIST_TO_HTML' IMPORTING LIST_INDEX = <pantalla> TABLES HTML = <htmls> El significado de los parámetros es el siguiente:

• LIST_INDEX -> Numero de pantalla del listado donde queramos que la función recupere los datos y los convierta a código HTML. Para saber en que ventamos del listado estamos podemos utilizar la variable del sistema SY-LSIND.

• HTML -> Tabla con el listado en código HTML.

WWW_ITAB_TO_HTML Definicion: Almacena el contenido de una tabla en una tabla en formato HTML. Sintaxis: CALL FUNCTION 'WWW_ITAB_TO_HTML' IMPORTING TABLE_ATTRIBUTES = <atributos_tabla> TABLE_HEADER = <cabecera> ALL_FIELDS = <flag> TABLES HTML = <html> FIELDS = <campos> ROW_HEADER = <columna_cabecera> ITABLE = <tabla_interna> El significado de los parámetros es el siguiente:

• TABLE_ATTRIBUTES -> Estructura con el formato o atributos de la tabla que se generara en HTML • TABLE_HEADER -> Estructura con los atributos de la cabecera de la tabla que se genera en HTML.. • ALL_FIELDS -> Si ponemos una 'X' incluye todos los campos de la tabla interna que pasemos. Si vale ' '

solo se cogen los campos que se pasen en la tabla ROW_HEADER. • HTML -> Tabla en formato HTML. • FIELDS -> Campos que se cogerÁn si el campo ALL_FIELDS vale ' '. • ROW_HEADER -> Cabecera de la tabla. • ITABLE -> Tabla donde le pasaremos los datos a convertir.

Page 49: Sap Funciones

MANUALES Y TUTORIALES WWW.MUNDOSAP.COM