GENERATION OF ERROR MESSAGES AND PROGRESS INFORMATION MESSAGES VIA A COMMON INTERFACE

• US 20130311839A1
• Filed: 05/15/2012
• Published: 11/21/2013
• Est. Priority Date: 05/15/2012
• Status: Active Grant

• Current Assignee: SAP SE
• Original Assignee: SAP AG (SAP SE)
• Inventors: Brunswig, Frank, Jentsch, Frank, Rose, Holger
• Granted Patent: US 8,949,678 B2
• Time in Patent Office: Days
• US Class Current: 714/57
• CPC Class Codes: G06F 11/0709 in a distributed system consisting of a plurality of standalone computer nodes, e.g. clusters, client-server systems
• CPC Class Codes: G06F 11/0766 Error or fault reporting or storing

Abstract

The present description refers to a technique for receiving a client instruction, performing an action in response to the client instruction, generating an instance of a progress information message by the business object calling a first method of an API and identifying the progress information message to be generated, determining if an error condition occurs during the performing the action, generating an instance of an error message, if the error condition occurs, by calling the first method of the API, sending the progress information message instance from a second software work process to the client application in response to a request for progress information received by the second software work process from the client application, and sending the error message instance, if generated, from the first software work process to the client application.

Claims

1. A computer program product, the computer program product being tangibly embodied on a computer-readable storage medium and including executable code that, when executed, is configured to cause at least one data processing apparatus to:

receive a client instruction at a first software work process from a client application;

perform, by a business object of the first software work process, an action in response to the client instruction;

generate an instance of a progress information message by the business object calling a first method of an application programming interface (API) and identifying the progress information message to be generated;

determine if an error condition occurs during the performing the action;

generate an instance of an error message, if the error condition occurs, by calling the first method of the API and identifying the error message to be generated;

send the progress information message instance from a second software work process to the client application in response to a request for progress information received by the second software work process from the client application; and

send the error message instance, if generated, from the first software work process to the client application.

2. The computer program product of claim 1 wherein the executable code is further configured to cause at least one data processing apparatus to:

use a same message definition editor or user interface to;

define the progress information message;

assign the progress information message to the business object or to the action;

define the error message; and

assign the error message to the business object or to the action.

3. The computer program product of claim 1, wherein the action comprises a first action and a second action, wherein the executable code is further configured to cause at least one data processing apparatus to:

use a same message definition editor or user interface to;

define the progress information message;

assign the progress information message to the first action;

define the error message; and

assign the error message to the second action.

4. The computer program product of claim 1, wherein the executable code being configured to cause at least one data processing apparatus to generate an instance of a progress information message comprises the executable code being configured to cause at least one data processing apparatus to:

call or raise, by the business object, the first method of the API, including identifying a message type that identifies a message definition and identifying one or more parameters;

generate or create the instance of the progress information message, in response to the calling or raising the first method of the API, based on a progress information message definition associated with the identified message type and the one or more parameters.

5. The computer program product of claim 1, wherein the executable code being configured to cause at least one data processing apparatus to generate an instance of an error message comprises the executable code being configured to cause at least one data processing apparatus to:

call or raise, by the business object, the first method of the API, including identifying a message type that identifies a message definition and identifying one or more parameters;

generate or create the instance of error message, in response to the calling or raising the first method of the API, based on an error message definition associated with the identified message type and one or more parameters.

6. The computer program product of claim 1, wherein the executable code being configured to cause at least one data processing apparatus to send the error message, if generated, from the first software work process to the client application comprises the executable code being configured to cause at least one data processing apparatus to:

send the error message instance, if generated, from the first software work process to the client application as a reply to the request from the client application.

7. The computer program product of claim 1, wherein the executable code being configured to cause at least one data processing apparatus to send the progress information message from the second software work process to the client application comprises the executable code being configured to cause at least one data processing apparatus to:

store a message type identifying the progress information message type in a shared memory along with a session ID;

receive, by the second software work process from the client application, a request for progress information including the session ID;

perform a lookup in the shared memory based on the received session ID to identify the message type for the progress information message;

obtain text of the progress information message based on a stored message definition;

create or generate the progress information message instance based on the message text; and

send the progress information message instance from the second software work process to the client application in response to the request for progress information.

8. The computer program product of claim 1, wherein the executable code being configured to cause at least one data processing apparatus to generate an instance of an error message comprises the executable code being configured to cause at least one data processing apparatus to:

generate an instance of an error message, if the error condition occurs, by calling the first method of the API and including identifying a message type that identifies a message definition.

9. The computer program product of claim 1, wherein the first method of the API comprises a create method that causes an instance of either an error message or an instance of a progress information message to be generated or created based on a message type that is provided that identifies a message definition.

10. The computer program product of claim 1, wherein the executable code being configured to cause at least one data processing apparatus to generate an instance of a progress information message comprises the executable code being configured to cause at least one data processing apparatus to generate an instance of a progress information message by calling a create method of the API and including identifying a message type that identifies a message definition of the progress information message to be created.

11. A computer-implemented method comprising:

receiving a client instruction at a first software work process from a client application;

forwarding the client instruction to a business object associated with the first software work process;

performing, by the business object, an action in response to the client instruction;

generating an instance of a progress information message by the business object calling a first method of an application programming interface (API) and identifying the progress information message to be generated;

determining if an error condition occurs during the performing the action;

generating an instance of an error message, if the error condition occurs, by calling the first method of the API and identifying the error message to be generated;

sending the progress information message instance from a second software work process to the client application in response to a request for progress information received by the second software work process from the client application; and

sending the error message instance, if generated, from the first software work process to the client application.

12. The computer-implemented method of claim 11 and further comprising using a same message definition editor or user interface to:

define the progress information message;

assign the progress information message to the business object or to the action;

define the error message; and

assign the error message to the business object or to the action.

13. The computer-implemented method of claim 11 wherein the generating an instance of a progress information message comprises:

calling, by the business object, the first method of the API, including identifying a message type that identifies a message definition and identifying one or more parameters;

generating the instance of the progress information message, in response to the calling the first method of the API, based on a progress information message definition associated with the identified message type and the one or more parameters.

14. The computer-implemented method of claim 11 wherein the generating an instance of an error message comprises:

calling, by the business object, the first method of the API, including identifying a message type that identifies a message definition and identifying one or more parameters;

generating the instance of error message, in response to the calling or raising the first method of the API, based on an error message definition associated with the identified message type and one or more parameters.

15. The computer-implemented method of claim 11 wherein the sending the progress information message from the second software work process to the client application comprises:

storing, by the first software work process, a message type identifying the progress information message type in a shared memory along with a session ID;

receiving, by the second software work process from the client application, a request for progress information including the session ID;

performing a lookup in the shared memory based on the received session ID to identify the message type for the progress information message;

obtaining text of the progress information message based on a stored message definition;

creating or generate the progress information message instance based on the message text; and

sending the progress information message instance from the second software work process to the client application in response to the request for progress information.

16. The computer-implemented method of claim 11 wherein the sending the progress information message from the second software work process to the client application comprises:

storing, by the first software work process, the progress information message in a memory; and

retrieving, by the second software work process, the progress information message instance from the memory;

sending the retrieved progress information message instance from the second software work process to the client application in response to the request for progress information.

17. An apparatus comprising:

receiving logic configured to receive a client instruction at a first software work process from a client application;

performing logic configured to perform an action in response to the client instruction;

generating logic configured to generate an instance of a progress information message by calling a first method of an application programming interface (API) and identifying the progress information message to be generated;

determining logic configure to determine if an error condition occurs during the performing the action;

the generating logic configured to generate an instance of an error message if the error condition occurs by calling the first method of the API and identifying the error message to be generated;

progress information message sending logic configured to send the progress information message instance from a second software work process to the client application in response to a request for progress information received by the second software work process from the client application; and

error message sending logic configured to send the error message instance, if generated, from the first software work process to the client application.

18. The apparatus of claim 17 wherein the performing logic, the generating logic and the determining logic comprise a business object.

19. The apparatus of claim 17 wherein the progress information message sending logic comprises:

a progress information service of the second software work process configured to perform the following in response to receiving a request for progress information for the processing of the request received by the first software work process;

performing a lookup into a memory based on a session ID;

obtain the progress information message instance based on the lookup; and

send the progress information message instance to the client.

20. The apparatus of claim 17 wherein the error message sending logic comprises:

the business object configured to call a create method of the API, including identifying a message type that identifies the error message to be created or generated;

the business object configured to call a send method of the API to an error message handler; and

the error message handler configured to send the error message instance to the client.