How To Implement Error with Glossary Text and Variables - jdeSetGBRErrorSubText ()

Purpose of Document

This note is a guide on how to implement an error / warning / information message in a certain routine through a business function by explaining existing routine for this implementation. You can add additional routine in existing code or you may add a new function to fulfill this.

Before you create any function, review all the available data structure for error and if need be, reference existing business function which set error dynamically.

Business Scenario:

In creating a new address book master information, you want to create an error message as below,
"User 'UserID' is not allowed to create a new address book information when search type is 'SearchType' and country code is 'CountryCode'. Inform your manager.

Steps to implement this:

1. Create Data Structure 'DE5501012' to handle variables szUserID, szSearchType and szCountryCode using DD Alias USER, AT1 and CTR
2. Create DD item '5501013' to call Error Code
3. Create Business Function B5501012 to call API jdeSetGBRErrorSubText ()
4. Call B5501012  from P01012 (Address Book) to indicate warning message on screen

Detail Implementation:

• Create Data Structure 'DE5501012' to handle variables szUserID, szSearchType and szCountryCode using DD Alias USER, AT1 and CTR

1. Go to OMW and add Business Function Data Structure

• Object Name: DE5501012
• Description: USER, AT1 and CTR
• Object Type: DSTR - Data Structure
• Product Code: 55 - Reserved for Client
• Product System Code: 55 - Reserved for Client
• Object Use: 360 - Data Structure

2. Add DD Alias USER, AT1 and CTR. In case you want to implement more descriptive output you may add string values (for example, DL, DL01 and so on)

3. (Design Tools Tab) Create a type definition to generate type definition, which in return give you information as below,

  : This information is to be used in the header file of business function you are to create (e.g., B5501012.h).
                    Example,  

• Create Data Dictionary item '5501013' to call Error Code
• (Fast Path) DD then Select "Error Messages"
• Click 'Add' to create a new Error Message
• (Tab) Item Specification
•        Alias: 5501013
•        Glossary: E for Error Message
•        Product Code: 55
•        Product Code Reporting: 55
•        Description: Wrong Combination &1, &2 and &3
•        Error Level: 1 (Error Message). In case you want to set this implementation for Warning or Information change this code to '2' or '3' respectively
•  (Tab) Item Glossary
• Alias: 5501013
• Description: Wrong combination &1, &2 and &3. &1 through &3 reference value you are to assign in calling the business function to be created below
• Media Object Text. Example,

• (Tab) Data Structure Template:
• Choose (radio button) Text Substitution
• (Push button) Browse
• Select 'DE5501012 :USER,AT1 and CTR' which we have created above and click OK to save change made

• Create Business Function B5501012 to call API jdeSetGBRErrorSubText ()
•     1. Add a Business Function
•        Object Name: B5501012
•        Description: Custom BSFN to set Substitute Error
•        Product Code: 55
•        Product System Code: 55
•        Object Use: 1
•        Source Language: C
•        Function Location: Client/Server
•     2. Associate data structure DE5501012 to B5501012
•     3. Create Header File and copy typedef of DE5501012
•     4. Create Source File and assign input value from data structure of DE5501012. 

Example of B5501012.h

Example of  B5501012.c

• 4. Call B5501012  from P01012 (Address Book) to indicate warning message on screen
•        1. Get information on User ID, Search Type and Country
•        2. Call B5501012 and assign value returned from 1

• 5. Test above implementation

To have document type implementation detail, refer

here

:

Technical review:

• JDE API jdeSetGBRErrorSubText () is making use of jdeGetGlossaryText
• Function:   jdeGetGlossaryText(LPSTR lpszDDItemName, LPVOID lpStruct, TEXTTYPE iTextType)
• Purpose: this function will return the short description or glossary with text substitution. For example, The Batch number &1 is invalid. Return text will be - The Batch number 123 is invalid.
• Parameters: lpszDDItemName  -  Data Dictionary Item
•                    lpStruct        - Pointer to structure contains substitution text
•                    iTextType       - DDT_ALPHA_DESC for short description
•                                          - DDT_GLOSSARY for glossary
•  Return:     Glossary Text (lpszDesc)

Data Structure which has definition for error message:

    : Data Structure starts with DE* (Data Structure Error Message) can be used for setting errors as below,

Example of C Functions to have this implementation:

In case you need to create your own business function, below list of objects are good example for creation. For this example, error code 078L is defined "Initialization of cache &1 failed". As we can see from this example, &dsDE0022 (Value of pointer - Memory Address) is value as defined from previous line F42UI01.

B0800301    Set Error Action Step 499Z or 499U or 499W   

...

B4900870    Set Error Substitution Text   

...

In case you need to implement simple error message on browser, you may call JDE API jdeSetGBRError ().

For example, if you call jdeSetGBRError(lpBhvrCom,lpVoid,(ID)0,_J("4363")), detail message on error on 4363 is to be displayed. For this example, error message is static. Another implemenation can be done by calling jdeErrorSet(lpBhvrCom, lpVoid, (ID)0, _J("4375"), (LPVOID) NULL). For this case the difference is that jdeErrorSet () stops you from handling any further events. @review this statement again ::::