SAP BAPI Parameters - j5 - 28.0 - Administration & Configuration - Hexagon

j5 SAP PM Integration Configuration

Language
English
Product
j5
Search by Category
Administration & Configuration
j5 Version
2019

This section describes what parameters are sent through to the BAPI methods when the j5 system communicates with SAP, and which fields are used from the return values.

  • BAPI_FUNCLOC_GETLIST - Fetch Functional Locations from SAP

    • FUNCLOC_RA: {‘SIGN’: ‘I’, ‘OPTION’: ‘EQ’, ‘LOW_VALUE’: ‘*’}

    • MAINTPLANT_RA: {‘SIGN’: ‘I’ ‘OPTION’: ‘EQ’, ‘LOW_VALUE’: maint_plant} If a maintenance plant has been configured

    • PLANPLANT_RA For each planning plant configured:

      • {‘SIGN’: ‘I’, ‘OPTION’: ‘EQ’, ‘LOW_VALUE’: plan_plant}

    • PLANGROUP_RA For each planning group configured:

      • {‘SIGN’: ‘I’, ‘OPTION’: ‘EQ’, ‘LOW_VALUE’: plan_group}

    • SORTFIELD_RA For each sort field configured:

      • {‘SIGN’: ‘I’, ‘OPTION’: ‘EQ’, ‘LOW_VALUE’: plan_group}

    • FIELDS: FUNCLOC, FUNCTLOCATION, DESCRIPT, MAINTPLANT, PLANPLANT, PLANGROUP, STRIND, SUPFLOC, CATEGORY

  • BAPI_EQUI_GETLIST - Fetch equipment from SAP

    • STATUS_RA: {‘SIGN’: ‘E’, ‘OPTION’: ‘EQ’, ‘LOW_VALUE’: excluded_status}

    • MAINTPLANT_RA: {‘SIGN’: ‘I’ ‘OPTION’: ‘EQ’, ‘LOW_VALUE’: maint_plant} If a maintenance plant has been configured

    • EQUIPMENT_RA For each equipment we request (maximum 1000 per call):

      • {‘SIGN’: ‘I’, ‘OPTION’: ‘EQ’, ‘LOW_VALUE’: equipment_number}

    • PLANPLANT_RA For each planning plant configured:

      • {‘SIGN’: ‘I’, ‘OPTION’: ‘EQ’, ‘LOW_VALUE’: plan_plant}

    • PLANGROUP_RA For each planning group configured:

      • {‘SIGN’: ‘I’, ‘OPTION’: ‘EQ’, ‘LOW_VALUE’: plan_group}

    • SORTFIELD_RA For each sort field configured:

      • {‘SIGN’: ‘I’, ‘OPTION’: ‘EQ’, ‘LOW_VALUE’: plan_group}

    • FIELDS: EQUIPMENT, DESCRIPT, EQUICATGRY, MAINTPLANT, PLANPLANT, PLANGROUP, SORTFIELD

  • BAPI_ALM_ORDERHEAD_GET_LIST - Fetch Work Orders from SAP:

    • {‘FORCE_REFRESH’: "X", ‘PAGELENGTH’: 5000000, ‘SHOW_PAGE_NUMBER’: 0}

    • {‘FIELD_NAME’: "SHOW_COMPLETED_DOCUMENTS", ‘SIGN’: "I", ‘OPTION’: "EQ", ‘LOW_VALUE’:"X"} Only for delta syncs

    • {‘FIELD_NAME’: "SHOW_DOCS_WITH_FROM_DATE", ‘SIGN’: "I", ‘OPTION’: "EQ", ‘LOW_VALUE’: "00010101"} Set to lesser of start of sync period or 3 days ago with option Restrict Work Order FROM and TO Date

    • {‘FIELD_NAME’: "SHOW_DOCS_WITH_TO_DATE", ‘SIGN’: "I", ‘OPTION’: "EQ", ‘LOW_VALUE’: "99991231"} Set to end of sync period on initial chunked sync with option Restrict Work Order FROM and TO Date

    • {‘FIELD_NAME’: "SHOW_OPEN_DOCUMENTS", ‘SIGN’: "I", ‘OPTION’: "EQ", ‘LOW_VALUE’: "X"} {‘FIELD_NAME’: "SHOW_DOCUMENTS_IN_PROCESS", ‘SIGN’: "I", ‘OPTION’: "EQ", ‘LOW_VALUE’: "X"} Removed if option No IN PROCESS Filter on Work Orders is set

    • {‘FIELD_NAME’: "OPTIONS_FOR_LOC_MAINTPLANT", ‘SIGN’: "I", ‘OPTION’: "EQ", ‘LOW_VALUE’: maint_plant} If a maintenance plant has been configured

    • {‘FIELD_NAME’: "OPTIONS_FOR_COMP_CODE", ‘SIGN’: "I", ‘OPTION’: "EQ", ‘LOW_VALUE’: company_code} If Company Codes have been configured for maintenance plants in option Company Code Restrictions for Maintenance Plants

    • {‘FIELD_NAME’: "OPTIONS_FOR_MAINTPLAN", ‘SIGN’: "I", ‘OPTION’: "EQ", ‘LOW_VALUE’: maint_plan} If a maintenance plan has been configured

    • {‘FIELD_NAME’: "OPTIONS_FOR_PLANGROUP", ‘SIGN’: "I", ‘OPTION’: "EQ", ‘LOW_VALUE’: plan_group} If a planning group has been configured

    • {‘FIELD_NAME’: "OPTIONS_FOR_SORTFIELD", ‘SIGN’: "I", ‘OPTION’: "EQ", ‘LOW_VALUE’: sort_field} If a sort field has been configured

    • {‘FIELD_NAME’: "OPTIONS_FOR_DOC_TYPE", ‘SIGN’: "I", ‘OPTION’: "EQ", ‘LOW_VALUE’: order_type} If Work Order Type filters have been configured

    • {‘FIELD_NAME’: "OPTIONS_FOR_ACTUAL_RELEAS_DATE", ‘SIGN’: "I", ‘OPTION’: "GT", ‘LOW_VALUE’: "00000000"} Set to GE the configured Sync From Date with option Restrict Work Order Release Date

    • {‘FIELD_NAME’: "OPTIONS_FOR_ENTER_DATE", ‘SIGN’: "I", ‘OPTION’: "BT", ‘LOW_VALUE’: sync_from_date, ‘HIGH_VALUE’: sync_to_date} If doing a chunked initial sync and option Restrict Work Order FROM and TO date is not set

    • {‘FIELD_NAME’: "OPTIONS_FOR_ENTER_DATE", ‘SIGN’: "I", ‘OPTION’: "GE", ‘LOW_VALUE’: sync_from_date}

    • {‘FIELD_NAME’: "OPTIONS_FOR_CHANGE_DATE", ‘SIGN’: "I", ‘OPTION’: "EQ", ‘LOW_VALUE’: ‘00000000’}

    • {‘FIELD_NAME’: "OPTIONS_FOR_CHANGE_DATE", ‘SIGN’: "I", ‘OPTION’: "BT", ‘LOW_VALUE’: sync_from_date, ‘HIGH_VALUE’: sync_to_date} If doing a chunked initial sync and option Restrict Work Order FROM and TO date is not set

    • {‘FIELD_NAME’: "OPTIONS_FOR_CHANGE_DATE", ‘SIGN’: "I", ‘OPTION’: "GE", ‘LOW_VALUE’: sync_from_date}

    • FIELDS: ORDERID, ENTER_DATE, ACTUAL_RELEASE_DATE, S_STATUS, U_STATUS, PRIORITY, EQUIPMENT, FUNCLOC, SHORT_TEXT, MAINTPLANT, WORK_CNTR, ORDER_TYPE, START_DATE, BASICSTART, FINISH_DATE, BASIC_FIN, PRODUCTION_START_DATE, PRODUCTION_START_TIME, PRODUCTION_FINISH_DATE, PRODUCTION_FINISH_TIME, NOTIF_NO, CHANGE_DATE, ACTUAL_START_DATE, ACTUAL_START_TIME, CONFIRMED_FINISH_DATE, ACTUAL_FINISH_TIME

  • BAPI_ALM_ORDEROPER_GET_LIST - Fetch Work Order Operations from SAP:

    • {‘FIELD_NAME’: "SHOW_OPEN_DOCUMENTS", ‘SIGN’: "I", ‘OPTION’: "EQ", ‘LOW_VALUE’: "X"}

    • {‘FIELD_NAME’: "SHOW_COMPLETED_DOCUMENTS", ‘SIGN’: "I", ‘OPTION’: "EQ", ‘LOW_VALUE’: "X"} Only on delta sync

    • {‘FIELD_NAME’: "OPTIONS_FOR_STATUS_EXCLUSIVE", "SIGN": "I", "OPTION": "EQ", "LOW_VALUE": status} If deleted status is configured

    • For each work_order_id in the current sync that has been created or updated:

      • {‘FIELD_NAME’: ‘OPTIONS_FOR_ORDERID’, ‘SIGN’: "I", ‘OPTION’: "EQ", ‘LOW_VALUE’: order_id, ‘HIGH_VALUE’: ‘’}

    • {‘FORCE_REFRESH’: "X", ‘PAGELENGTH’: 5000000}

    • FIELDS: ORDERID, S_STATUS, EQUIPMENT, FUNCLOC, DESCRIPTION, PLANT, ACTIVITY, CONTROL_KEY, STANDARD_TEXT_KEY, SUB_ACTIVITY, WORK_CNTR, CONF_NO, DURATION_NORMAL, DURATION_NORMAL_UNIT, DURATION_NORMAL_UNIT_ISO, U_STATUS, WORK_ACTUAL

  • EM_NTF_ORD_CREATE - Creating Work Notifications:

    • NOTIF_TYPE: Notification Type (required)

    • SHORT_TEXT: Description (required)

    • EQUIPMENT: Equipment

    • FUNCT_LOC: Functional Location (derived from the equipment)

    • MN_WKCNTR: Maintenance Work Center

    • PLANPLANT: Planning Plant (derived from the functional location)

    • PLANGROUP: Planning Group (derived from the functional location)

    • PRIORITY: Priority

    • WKCTR_PLANT: Maintenance Plant

    • START_DATE: Start Date (derived from start datetime)

    • START_TIME: Start Time (derived from start datetime)

    • END_DATE: End Date (derived from end datetime)

    • END_TIME: End Time (derived from end datetime)

    • REPORTEDBY: left empty