SAP Function EAM_TASKLIST_GET_DETAIL - Read API for task list

Parameter Reference Type Length Default Optional Text
IV_DATE DATUM D 8 SY-DATUM X Date
IV_EQUNR EQUNR C 18 X Equipment Number
IV_LOCK FLG_ENQ C 1 X Indicator: Read with lock
IV_PLANT WERKS_D C 4 X Plant
IV_PLNAL PLNAL C 2 X Group Counter
IV_PLNGR VAGRP C 3 X Responsible planner group/department
IV_PLNNR PLNNR C 8 X Key for Task List Group
IV_PLNTY PLNTY C 1 Task List Type
IV_REFRESH_BUFFER FLAG C 1 X refresh buffer -> read from DB
IV_STATUS PLNST C 3 X Status
IV_TPLNR TPLNR C 30 X Functional Location
IV_USAGE VERWE C 3 X Use by user or system

Parameter Reference Length Optional Text
ET_COMPONENTS EAM_T_TL_COMPONENT 671 X Table Type for Material Components Used for Task Lists
ET_HDR_HIERARCHY EAM_T_PLKOD_EXT 631 X Task List API: Header Data with Technical Objects IDs for Hierarchy
ET_HEADERS EAM_T_PLKOD_EXT 631 X Task List API: Header Data with Technical Objects IDs
ET_MPACKAGES EAM_T_PLWPD 182 X Task List API Table of Maintenance Packages
ET_OPERATIONS EAM_T_PLPOD 1872 X Task List Operation Dialog Table Type
ET_OPR_HIERARCHY EAM_T_PLPOD 1872 X Task List Operation Dialog Table Type for Hierarchy
ET_PRTS EAM_T_TL_PRT_DETAIL 530 X Task List API: Table for PRT Detail
ET_RELATIONS EAM_T_PLABD 524 X Task List Relations Dialog Table Type
ET_RETURN BAPIRETTAB 548 X Table with BAPI Return Information
ET_SPACK_CONTR_LIMITS EAM_T_TL_SPACK_CONTR_LIMITS 145 X Task list API: Service package limit data
ET_SPACK_LIMITS EAM_T_TL_SPACK_LIMITS 238 X Task list API: Service package contract limits
ET_SPACK_LINES EAM_T_TL_SPACK 553 X Task List API: Serviceline Data Detail
ET_SPACK_OUTLINES EAM_T_TL_SPACK_OUTLINE 199 X Task list API: Table containing service package outlines
ET_TEXT EAM_T_TEXT 118 X Table with Text Header for Task List APIs
ET_TEXT_LINES EAM_T_TEXT_LINES 134 X Table with Text Lines for Task List APIs

Functionality
This application interface is used to read task lists from the database.
The following task list types are supported:

  • Equipment task list

  • Functional location task list

  • General task list

  • The task list type (iv_plnty) determines which types of task list arereturned. Each task list type can be retrieved with the combination oftask list type and task list number (iv_plnnr). To get detailed data ona single task list, it is recommended that you use the task listalternative counter (iv_plnal), which, in combination with tasklist type and task list number, represents a unique key. In the case ofequipment task lists and functional location task lists, it is alsopossible to read using only task list type and either equipment numberor functional location number.

    Equipment Task List

    • iv_plnty = 'E'

    • iv_equnr is optional

    • iv_tplnr is initial

    • iv_plnnr is optional
    • Functional Location Task List

      • iv_plnty = 'T'

      • iv_tplnr is optional

      • iv_equnr is initial

      • iv_plnnr is optional
      • General Task List

        • iv_plnty = 'A'

        • iv_tplnr is initial

        • iv_equnr is initial

        • iv_plnnr is required
        • Example
          CALL FUNCTION 'EAM_TASKLIST_GET_DETAIL'
          EXPORTING
          IV_PLNTY = 'A'
          IV_PLNNR = '1'
          IV_PLNAL = '1'
          IMPORTING
          ET_HEADERS = IT_HEADERS "Header information oftask lists
          ET_OPERATIONS = IT_OPERATIONS "Operation data oftasklists
          ET_COMPONENTS = IT_COMPONENTS "Material components
          ET_PRTS = IT_PRTS "Productionressource/tools
          ET_RELATIONS = IT_RELATIONS "Operation relations
          ET_SPACKAGES = IT_SPACKAGES "Service packages
          ET_MPACKAGES = IT_MPACKAGES "Maintenance packages
          ET_RETURN = IT_RETURN "BAPI return table
          .

          Description
          Date on which the task list is edited or displayed. All objects, forexample header or operation, that are valid on this key date aredisplayed.

          Default
          The default value for the key date is the current date.

          Description
          Equipment ID to which task list is assigned to. This parameter shouldonly be set, if the task list type is Equipment Task List.

          Default
          Initial

          Description
          If this indicator is set the task list will be read and locked. So itcannot be changed by another process until the lock is released.

          Value range
          ' ' or 'X'

          Default
          By default the indicator is not set.

          Description
          Determines the plant in which the task list is valid. This parameter canbe used to narrow down the results.

          Description
          Additional counter for task list group. This parameter can be used tospecify a single task list uniquely in combination with Task ListGroup ID and Task List Type.

          Value range
          01 - 99

          Default
          Initial

          Description
          Planner group responsible for maintaining the task lists to be selected.

          Description
          This key field indicates the task list group. Each task list is assignedto a group, therefore this ID serves as a main identifier, besidesfunctional location number and equipment number. If a function callrequests a general task list, this field is mandatory. In case of arequest for equipment task lists or functional location task lists, thisfield is initial.

          Default

          Description
          Determines the task list type of the task lists to be read.

          Value range
          'E' - Equipment task list
          'T' - Functional location task list
          'A' - General task list

          Default
          The task list type is required for all function module calls and istherefore not defaulted.

          Description
          ID of functional location to which task lists are assigned to. Thisparameter should only be set if task list type is FunctionalLocation Task List.

          Default
          Initial

          Description
          Key specifying the areas in which the task list can be used (forexample, in production or plant maintenance).
          Do not confuse the task list usage with the usage of a productionresource/tool (PRT) or a work center. In these cases, the usagedescribes the task list types in which the PRT or work center can beused.

          Description
          Export table containing task list operation components.

          Description
          Table with (hierarchy) task list header data that is part of therequested hierarchy.

          Description
          Table with requested task list header data.

          Description
          Export table containing task list maintenance packages.

          Description
          Export table containing task list operation data.

          Description
          Export table containing all hierarchy task list operation data of therequested hierarchy.

          Description
          Export table containing task list operation production resources/tools.

          Description
          Export table containing task list operation relations. VORN2 containsrelation of operation that is dependent on operation VORN1. VORNRcontains the same value as VORN1.

          Description
          Table with all the messages sent by the BAPI.

          Description
          Export table containing header data for long texts assigned tosubobjects of a task list alternative. The complete subobject key of asingle subobject is specified in a single table line. A single line ofthis long text header refers to several lines of API parameterET_TEXT_LINES.
          Main fields of structure ET_TEXT are:
          ·,,PLNTY Task list type<(>,<)>
          ·,,PLNNR Key for task list group
          ·,,PLNAL Group counter
          ·,,LANGU ,,Language in which the long text was created. Updates do notchange this field.
          ·,,VORNR ,,External identifier for operation/activity (filled foroperations, PRT and service packages)
          ·,,PZLFH ,,External item counter for production resources/tools (filledfor PRT only)
          ·,,TEXTSTART First table line within API parameter ET_TEXT_LINES thatrefers to current line of ET_TEXT
          ·,,TEXTEND Last table line within API parameter ET_TEXT_LINES thatrefers to current line of ET_TEXT
          Fields only filled for service packages:
          ·,,OUTLINE External identifier for outline number
          ·,,SERVICE_LINE External identifier for service line assigned to aboveoutline number
          ·,,TEXT_ID If equals to 'LTEXT', this refers to an 'outline long text'or a 'line text' of a service line
          ,, If equals to 'LLTXT', this refers to a 'service text'of a service line

          Description
          Export table containing all text lines for long texts referring to allsubobjects of a task list alternative that have a long text attached.The subobject key is specified in the corresponding line of APIparameter ET_TEXT. The first line of this parameter ET_TEXT_LINES isidentical to the short text of the corresponding task list subobject.
          ET_TEXT_LINES consists of following fields:
          ·,,TDFORMAT Style element name (paragraph, character string) inSAPscript format
          ·,,TDLINE SAPscript text line with a length of 132 characters
          The line index of API parameter ET_TEXT_LINES refers to following threefields of API parameter ET_TEXT:
          ·,,TEXTSTART First table line within API parameter ET_TEXT_LINES
          that refers to a single (header) line ofET_TEXT
          ·,,TEXTEND Last table line within API parameter ET_TEXT_LINES
          that refers to the same single (header)line of ET_TEXT
          ·,,LANGU ,,Language in which the long text was created. It is notchanged any more by an update.