SAP ABAP Class CL_POC_PRC_MONITOR_UI_HELPER (Process Monitor UI Helper)
Hierarchy
☛
SAP_BS_FND (Software Component) SAP Business Suite Foundation
⤷
CA-EPT-POC (Application Component) Process Orchestration for Built-In Processes
⤷
BS_POC_MONITOR (Package) Process Orchestration - Monitoring
⤷
⤷
Properties
| Class | CL_POC_PRC_MONITOR_UI_HELPER | |
| Short Description | Process Monitor UI Helper | |
| Super Class | ||
| Instantiability of a Class | 0 | Private |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | BS_POC_MONITOR | Process Orchestration - Monitoring |
| Created | 20100610 | SAP |
| Last change | 20130531 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
Interfaces
Class CL_POC_PRC_MONITOR_UI_HELPER has no interface implemented.
Friends
Class CL_POC_PRC_MONITOR_UI_HELPER has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Static Attribute | Private | Object reference (TYPE REF TO) | CL_POC_PRC_MONITOR_UI_HELPER | Process Monitor UI Helper | 20100610 | |||
| 2 | Static Attribute | Private | Object reference (TYPE REF TO) | CL_POC_LOG_MANAGER | Log Manager | 20100628 | |||
| 3 | Static Attribute | Private | Type reference (TYPE) | POC_T_DD07V | Table type for dd07v | 20110218 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Static method | Public | Constructor | Class Constructor | 20110218 | |
| 2 | Instance method | Private | Constructor | Constructor | 20100610 | |
| 3 | Instance method | Private | Method | method to create traffic light | 20110810 | |
| 4 | Instance method | Public | Method | Enrich the Process Log with Compound Activity | 20111102 | |
| 5 | Instance method | Public | Method | Filter the Process Details for the Relevant RPC ID | 20111229 | |
| 6 | Instance method | Public | Method | Get the Child/Items for the header | 20110928 | |
| 7 | Instance method | Public | Method | gets the processes that exists on search | 20100929 | |
| 8 | Instance method | Public | Method | Get only the headers for the Process Log | 20110928 | |
| 9 | Static method | Public | Method | Singleton access Method | 20100610 | |
| 10 | Instance method | Public | Method | method to get the kpi status traffic light | 20110810 | |
| 11 | Instance method | Public | Method | Gets the process details - Process info, step info and kpi | 20121204 | |
| 12 | Instance method | Public | Method | Fetch Process Steps data | 20100929 | |
| 13 | Instance method | Public | Method | Read Task entries | 20100825 | |
| 14 | Instance method | Public | Method | Read BO entries | 20100825 |
Events
Class CL_POC_PRC_MONITOR_UI_HELPER has no event.
Types
Class CL_POC_PRC_MONITOR_UI_HELPER has no local type.
Method Signatures
Method CLASS_CONSTRUCTOR Signature
Method CLASS_CONSTRUCTOR on class CL_POC_PRC_MONITOR_UI_HELPER has no parameter.
Method CLASS_CONSTRUCTOR on class CL_POC_PRC_MONITOR_UI_HELPER has no exception.
Method CONSTRUCTOR Signature
Method CONSTRUCTOR on class CL_POC_PRC_MONITOR_UI_HELPER has no parameter.
Method CONSTRUCTOR on class CL_POC_PRC_MONITOR_UI_HELPER has no exception.
Method CREATE_ICON Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | C_ICON | Call by reference | Type reference (TYPE) | CHAR40 | Character field of length 40 | 20110810 | |||
| 2 | C_TOOLTIP | Call by reference | Type reference (TYPE) | STRING | 20110816 | ||||
| 3 | IR_WD_APPLICATION_REF | Call by reference | Object reference (TYPE REF TO) | IF_WD_APPLICATION | 20110811 | ||||
| 4 | U_NAME | Call by reference | Type reference (TYPE) | C | 20110810 |
Method CREATE_ICON on class CL_POC_PRC_MONITOR_UI_HELPER has no exception.
Method ENRICH_PRC_LOG_COMPOUND_ACT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_PROCESS_LOG | Call by reference | Type reference (TYPE) | POC_T_PRCMN_BINDING_FED | Activity with Corresponding Federation Data | 20111102 | |||
| 2 | IT_PROCESS_LOG | Call by reference | Type reference (TYPE) | POC_T_PRCMN_BINDING_FED | Activity with Corresponding Federation Data | 20111102 |
Method ENRICH_PRC_LOG_COMPOUND_ACT on class CL_POC_PRC_MONITOR_UI_HELPER has no exception.
Method FILTER_PROC_DET_FOR_REL_RPC Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_PROC_LOG | Call by reference | Type reference (TYPE) | POC_T_PRCMN_BINDING_FED | Activity with Corresponding Federation Data | 20111229 | |||
| 2 | IT_PROC_LOG | Call by reference | Type reference (TYPE) | POC_T_PRCMN_BINDING_FED | Activity with Corresponding Federation Data | 20111229 | |||
| 3 | IV_RPC_ID | Call by reference | Type reference (TYPE) | POC_E2E_PROC_DEF_ID | Realized Process Chain Definition ID | 20111229 |
Method FILTER_PROC_DET_FOR_REL_RPC on class CL_POC_PRC_MONITOR_UI_HELPER has no exception.
Method GET_CHILD Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_RELATED_ACTIVITIES | Call by reference | Type reference (TYPE) | POC_T_PRCMN_BINDING_FED | Activity with Corresponding Federation Data | 20110928 | |||
| 2 | IS_NEXT_ACT | Call by reference | Type reference (TYPE) | POC_S_PRCMN_BINDING_FED | Obsolete | 20110928 | |||
| 3 | IS_SELECTED_ACT | Call by reference | Type reference (TYPE) | POC_S_PRCMN_BINDING_FED | Activties Integrated with Federation | 20110928 | |||
| 4 | IT_PROCESS_LOG_ALL | Call by reference | Type reference (TYPE) | POC_T_PRCMN_BINDING_FED | Activity with Corresponding Federation Data | 20110928 |
Method GET_CHILD on class CL_POC_PRC_MONITOR_UI_HELPER has no exception.
Method GET_COMPLETE_PROCESSES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_PRC_COMPLETE_INST_DETAILS | Call by reference | Type reference (TYPE) | POC_T_PRC_COMPLETE_INST_DET | Verified Process Integration Points | 20100929 | |||
| 2 | IV_BA_TYPE | Call by reference | Type reference (TYPE) | POC_BA_TYPE | Task Type | 20101001 | |||
| 3 | IV_BO_ID | Call by reference | Type reference (TYPE) | POC_BO_ID | Business Object ID | 20100929 | |||
| 4 | IV_BO_TYPE_CODE | Call by reference | Type reference (TYPE) | POC_BO_TYPE | Business Object Type | 20100929 | |||
| 5 | IV_CBE_CATEGORY | Call by reference | Type reference (TYPE) | POC_CBE_CATEGORY | Callable Business Entity Category | 20101001 | |||
| 6 | IV_CBE_TYPE | Call by reference | Type reference (TYPE) | POC_CBE_TYPE | Callable Business Entity Type | 20101001 | |||
| 7 | IV_E2E_PROCESS_DEF_ID | Call by reference | Type reference (TYPE) | POC_PROCESS_TYPE_ID | Process Definition ID | 20100929 | |||
| 8 | IV_GET_FEDERATED_LOGS | Call by reference | Type reference (TYPE) | ABAP_BOOL | 20101001 | ||||
| 9 | IV_MAX_HITS | Call by reference | Type reference (TYPE) | I | Whole Number with +/- Sign (-2.147.483.648 .. 2.147.483.647) | 20101010 | |||
| 10 | IV_PROCESS_ID | Call by reference | Type reference (TYPE) | POC_PROCESS_ID | Process ID | 20101013 | |||
| 11 | IV_PROCESS_TYPE_ID | Call by reference | Type reference (TYPE) | POC_PROCESS_TYPE_ID | Process Definition ID | 20100929 | |||
| 12 | IV_SEARCH_DATE_INTERVAL_LOWER | Call by reference | Type reference (TYPE) | POC_EARLIEST_PRC_START_DATE | Earliest Process Start Date | 20101001 | |||
| 13 | IV_SEARCH_DATE_INTERVAL_UPPER | Call by reference | Type reference (TYPE) | POC_LATEST_PRC_START_DATE | Latest Process Start Date | 20101001 | |||
| 14 | IV_SEARCH_TIME_INTERVAL_LOWER | Call by reference | Type reference (TYPE) | POC_EARLIEST_PRC_START_TIME | Earliest Process Start Time | 20100929 | |||
| 15 | IV_SEARCH_TIME_INTERVAL_UPPER | Call by reference | Type reference (TYPE) | POC_LATEST_PRC_START_TIME | Latest Process Start Time | 20100929 | |||
| 16 | IV_THRESHOLD | Call by reference | Type reference (TYPE) | POC_THRESHOLD | Threshold Parameter for UI | 20110714 | |||
| 17 | IV_UNAME | Call by reference | Type reference (TYPE) | SYUNAME | User Name | 20101001 |
Method GET_COMPLETE_PROCESSES on class CL_POC_PRC_MONITOR_UI_HELPER has no exception.
Method GET_HEADERS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_PROCESS_LOG_HEADERS | Call by reference | Type reference (TYPE) | POC_T_PRCMN_BINDING_FED | Activity with Corresponding Federation Data | 20110928 | |||
| 2 | IT_PROCESS_LOG_ALL | Call by reference | Type reference (TYPE) | POC_T_PRCMN_BINDING_FED | Activity with Corresponding Federation Data | 20110928 |
Method GET_HEADERS on class CL_POC_PRC_MONITOR_UI_HELPER has no exception.
Method GET_INSTANCE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | EO_CL_INST | Call by reference | Object reference (TYPE REF TO) | CL_POC_PRC_MONITOR_UI_HELPER | Process Monitor UI Helper | 20100610 |
Method GET_INSTANCE on class CL_POC_PRC_MONITOR_UI_HELPER has no exception.
Method GET_KPI_TRAFFIC_LIGHT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_KPI | Call by reference | Type reference (TYPE) | POC_T_KPI_UI_PARAM | KPI UI Display | 20110810 | |||
| 2 | IR_WD_APPLICATION_REF | Call by reference | Object reference (TYPE REF TO) | IF_WD_APPLICATION | 20110811 | ||||
| 3 | IT_KPI_INFO | Call by reference | Type reference (TYPE) | POC_T_KPI_UI_PARAM | KPI UI Display | 20110810 |
Method GET_KPI_TRAFFIC_LIGHT on class CL_POC_PRC_MONITOR_UI_HELPER has no exception.
Method GET_PROCESS_DETAILS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_KPI | Call by reference | Type reference (TYPE) | POC_T_KPI_UI_PARAM | KPI Logs for UI Display | 20121204 | |||
| 2 | ET_PROC_STEP_INSTANCES | Call by reference | Type reference (TYPE) | POC_T_PRCMN_BINDING_FED | Activity with Corresponding Federation Data | 20121204 | |||
| 3 | IS_PROCESS | Call by reference | Type reference (TYPE) | POC_S_PRC_COMPLETE_INST_DET | Process Information | 20121204 | |||
| 4 | IV_FLG_PROC_DB | Call by reference | Type reference (TYPE) | ABAP_BOOL | Flag: Get the Process Info from DB? | 20121204 |
Method GET_PROCESS_DETAILS on class CL_POC_PRC_MONITOR_UI_HELPER has no exception.
Method GET_QRY_PRC_FOR_LOG_FED_W_CON Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_KPI | Call by reference | Type reference (TYPE) | POC_T_KPI_UI_PARAM | KPI UI Display | 20101221 | |||
| 2 | ET_MESSAGES | Call by reference | Type reference (TYPE) | POC_T_APPL_LOG_MSG | Application Log Message Data | 20101012 | |||
| 3 | ET_PRC_COMPLETE_INST_DETAILS | Call by reference | Type reference (TYPE) | POC_T_PRC_COMPLETE_INST_DET | federated table data | 20100929 | |||
| 4 | ET_PRC_STEP_INSTANCES | Call by reference | Type reference (TYPE) | POC_T_PRCMN_BINDING_FED | Activity with corresponding federation data | 20100929 | |||
| 5 | ET_PRE_BA_INSTANCES | Call by reference | Type reference (TYPE) | POC_T_PRE_BA_DETAILS | Previous/Predecessor Task | 20110208 | |||
| 6 | ET_VERIFIED_PR_INTR_POINTS | Call by reference | Type reference (TYPE) | POC_T_VERIFIED_PR_INTR_POINTS | Verified Process Integration Points | 20100929 | |||
| 7 | IV_BA_ID | Call by reference | Type reference (TYPE) | POC_BA_ID | Task Instance ID | 20120521 | |||
| 8 | IV_BO_ID | Call by reference | Type reference (TYPE) | POC_BO_ID | Business Object Instance ID | 20100929 | |||
| 9 | IV_BO_TYPE_CODE | Call by reference | Type reference (TYPE) | POC_BO_TYPE | Business Object Type | 20100929 | |||
| 10 | IV_E2E_PROCESS_DEF_ID | Call by reference | Type reference (TYPE) | POC_E2E_PROC_DEF_ID | Realized Process Chain Definition ID | 20100929 | |||
| 11 | IV_GET_FEDERATED_LOGS | Call by reference | Type reference (TYPE) | ABAP_BOOL | 20101001 | ||||
| 12 | IV_LOGSYS | Call by reference | Type reference (TYPE) | POC_LOGSYS | Logical system | 20101001 | |||
| 13 | IV_ONLY_PROCESS_INSTANCES | Call by reference | Type reference (TYPE) | ABAP_BOOL | 20101001 | ||||
| 14 | IV_PRE_BA_REQ | Call by reference | Type reference (TYPE) | ABAP_BOOL | 20110208 | ||||
| 15 | IV_PROCESS_ID | Call by reference | Type reference (TYPE) | POC_PROCESS_ID | Process ID | 20101001 | |||
| 16 | IV_PROCESS_TYPE_ID | Call by reference | Type reference (TYPE) | POC_PROCESS_TYPE_ID | Process Definition ID | 20100929 | |||
| 17 | IV_SEARCH_TIME_INTERVAL_LOWER | Call by reference | Type reference (TYPE) | POC_EARLIEST_PRC_START_TIME | Earliest Process Start Time | 20100929 | |||
| 18 | IV_SEARCH_TIME_INTERVAL_UPPER | Call by reference | Type reference (TYPE) | POC_LATEST_PRC_START_TIME | Latest Process Start Time | 20100929 |
Method GET_QRY_PRC_FOR_LOG_FED_W_CON on class CL_POC_PRC_MONITOR_UI_HELPER has no exception.
Method READ_BA Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_BA_VS | Call by reference | Type reference (TYPE) | WDY_KEY_VALUE_TABLE | Sorted List of Key / Value Relations as Strings | 20100825 |
Method READ_BA on class CL_POC_PRC_MONITOR_UI_HELPER has no exception.
Method READ_BO Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_BO_VS | Call by reference | Type reference (TYPE) | WDY_KEY_VALUE_TABLE | Sorted List of Key / Value Relations as Strings | 20100825 |
Method READ_BO on class CL_POC_PRC_MONITOR_UI_HELPER has no exception.
History
| Last changed by/on | SAP | 20130531 |
| SAP Release Created in | 703 |