Extensible data interface for shared service module

• US 10,223,180 B2
• Filed: 04/28/2016
• Issued: 03/05/2019
• Est. Priority Date: 04/14/2008
• Status: Active Grant

• Current Assignee: International Business Machines Corporation
• Original Assignee: International Business Machines Corporation
• Inventors: Berry, Charles F., Godoy, Glenn C., Snavely, Amy J.
• Primary Examiner(s): Anya, Charles E
• Application Number:
  US15/140,696
• Publication Number:
  US 20160239358A1
• Time in Patent Office: 1,041 Days
• CPC Class Codes: G06F 9/466 Transaction processing
• CPC Class Codes: G06F 9/54 Interprogram communication
• CPC Class Codes: G06F 9/541 via adapters, e.g. between incompatible applications
• CPC Class Codes: G06F 9/547 Remote procedure calls [RPC]; Web services
• CPC Class Codes: G06Q 10/06 Resources, workflows, human or project management; Enterprise or organisation planning; Enterprise or organisation modelling
• CPC Class Codes: G06Q 30/0633 Lists, e.g. purchase orders, compilation or processing

Abstract

A method and associated system for interfacing between a caller application and a service module. A service module builds a service module data structure pursuant to a previously received request. The request includes at least one caller application attribute describing the request. The service module data structure includes a generic service document and at least one service module attribute. Each service module attribute is stored in a relational table of the service module data structure. The requests serviced within the service module data structure, resulting in instantiating the generic service document. The generic service document is returned to the caller application. Building each service module attribute includes: constructing the generic service document and creating at least one container in the generic service document. Each container is respectively associated with each service module attribute in each mapping of at least one mapping.

Claims

1. A method for interfacing between a caller application and a service module, said method comprising:

building, by a processor of a computer system, a service module data structure pursuant to a request previously received by the processor, wherein the request comprises at least one caller application attribute describing the request, wherein the service module data structure comprises a generic service document and at least one service module attribute, and wherein the service module uses only the service module data structure such that the service module need not manipulate the at least one caller application attribute in performing the transaction;

subsequent to said building, said processor storing each service module attribute of the at least one service module attribute in a relational table of the service module data structure;

subsequent to said storing, said processor servicing the request within the service module data structure, wherein said servicing results in instantiating the generic service document; and

subsequent to said servicing, said processor returning the generic service document to the caller application,

wherein said receiving the request, said building the service module data structure, said storing each service module attribute, said servicing the request, and said returning the generic service document are performed by the service module, and

wherein said building comprises;

constructing the generic service document, wherein the generic service document is configured to contain a result of the transaction performed by the service module; and

subsequent to said constructing, creating at least one container in the generic service document, wherein each container of the at least one container is respectively associated with each service module attribute in each mapping of at least one mapping, wherein each container comprises a data value for each service module attribute of at least one service module attribute of the service module data structure, and wherein a mapping table of the service module data structure comprises the at least one mapping.

2. The method of claim 1, wherein said building further comprises:

naming each container of the at least one container in the generic service document after each mapping of the at least one mapping in the mapping table.

3. The method of claim 1, wherein said building further comprises:

configuring a caller identifier that uniquely identifies the caller application which had sent the request and the service module data structure corresponding to the request.

4. The method of claim 1, wherein each service module attribute of the at least one service module attribute either corresponds to a caller application attribute of the at least one caller application attribute or is created by the service module.

5. The method of claim 1, said storing comprising:

determining a category of a first service module attribute of said at least one service module attribute, wherein a configuration table comprises respective category of each service module attribute, wherein the category is either an extended-category that is recognized only by the caller application or a basic-category that is recognized by both the caller application and the service module;

subsequent to said determining the category, determining a level of the first service module attribute, wherein the configuration table further comprises respective level of each service module attribute, wherein the level is either a header-level that is applicable for all service module attributes represented in the generic service document or an item-level that is applicable only for the first service module attribute;

subsequent to said determining the level, storing in the relational table a first container of said at least one container pursuant to the category and the level of the first service module attribute that is associated with the first container, wherein the relational table is selected from the group consisting of a first table for service module attributes determined to be in the basic-category and in the header-level, a second table for service module attributes determined to be in the basic-category and in the item-level, a third table for service module attributes determined to be in the extended-category and in the header-level, and a fourth table for service module attributes determined to be in the extended-category and in the item-level; and

subsequent to said storing the first container, repeating to perform said determining the category, said determining the level, and said storing the first container after setting the first container with a next container in the relational table until all containers are stored in the relational table.

6. The method of claim 1, said servicing comprising:

performing the transaction requested by the caller application;

subsequent to said performing, retrieving each mapping from the mapping table;

subsequent to said retrieving, reloading each container of said at least one container from the relational table into respective containers of the generic service document according to each retrieved mapping; and

subsequent to said reloading, returning the generic service document to the caller application.

7. The method of claim 1, wherein said caller application is a member of a group comprising at least one caller application, wherein the service module is shared by each members of said group.

8. The method of claim 1, said method further comprising:

providing at least one support service for at least one of creating, integrating, hosting, maintaining, and deploying computer-readable program code in the computer system, said program code being executed by the processor to implement said receiving the request, said building the service module data structure, said storing each service module attribute, said servicing the request, and said returning the generic service document are performed by the service module.

9. A computer program product, comprising a computer readable hardware storage device having computer readable program code stored therein, said program code configured to be executed by a processor of a computer system to implement a method for interfacing between a caller application and a service module, said method comprising:

said processor building a service module data structure pursuant to a request previously received by the processor, wherein the request comprises at least one caller application attribute describing the request, wherein the service module data structure comprises a generic service document and at least one service module attribute, and wherein the service module uses only the service module data structure such that the service module need not manipulate the at least one caller application attribute in performing the transaction;

subsequent to said building, said processor storing each service module attribute of the at least one service module attribute in a relational table of the service module data structure;

subsequent to said storing, said processor servicing the request within the service module data structure, wherein said servicing results in instantiating the generic service document; and

subsequent to said servicing, said processor returning the generic service document to the caller application,

wherein said receiving the request, said building the service module data structure, said storing each service module attribute, said servicing the request, and said returning the generic service document are performed by the service module, and

wherein said building comprises;

constructing the generic service document, wherein the generic service document is configured to contain a result of the transaction performed by the service module; and

subsequent to said constructing, creating at least one container in the generic service document, wherein each container of the at least one container is respectively associated with each service module attribute in each mapping of at least one mapping, wherein each container comprises a data value for each service module attribute of at least one service module attribute of the service module data structure, and wherein a mapping table of the service module data structure comprises the at least one mapping.

10. The computer program product of claim 9, wherein said building further comprises:

naming each container of the at least one container in the generic service document after each mapping of the at least one mapping in the mapping table.

11. The computer program product of claim 9, wherein said building further comprises:

configuring a caller identifier that uniquely identifies the caller application which had sent the request and the service module data structure corresponding to the request.

12. The computer program product of claim 9, wherein each service module attribute of the at least one service module attribute either corresponds to a caller application attribute of the at least one caller application attribute or is created by the service module.

13. The computer program product of claim 9, said storing comprising:

determining a category of a first service module attribute of said at least one service module attribute, wherein a configuration table comprises respective category of each service module attribute, wherein the category is either an extended-category that is recognized only by the caller application or a basic-category that is recognized by both the caller application and the service module;

subsequent to said determining the category, determining a level of the first service module attribute, wherein the configuration table further comprises respective level of each service module attribute, wherein the level is either a header-level that is applicable for all service module attributes represented in the generic service document or an item-level that is applicable only for the first service module attribute;

subsequent to said determining the level, storing in the relational table a first container of said at least one container pursuant to the category and the level of the first service module attribute that is associated with the first container, wherein the relational table is selected from the group consisting of a first table for service module attributes determined to be in the basic-category and in the header-level, a second table for service module attributes determined to be in the basic-category and in the item-level, a third table for service module attributes determined to be in the extended-category and in the header-level, and a fourth table for service module attributes determined to be in the extended-category and in the item-level; and

subsequent to said storing the first container, repeating to perform said determining the category, said determining the level, and said storing the first container after setting the first container with a next container in the relational table until all containers are stored in the relational table.

14. The computer program product of claim 9, said servicing comprising:

performing the transaction requested by the caller application;

subsequent to said performing, retrieving each mapping from the mapping table;

subsequent to said retrieving, reloading each container of said at least one container from the relational table into respective containers of the generic service document according to each retrieved mapping; and

subsequent to said reloading, returning the generic service document to the caller application.

15. A computer system comprising a processor, a memory coupled to the processor, and a computer readable storage device coupled to the processor, said storage device containing program code configured to be executed by the processor via the memory to implement a method for interfacing between a caller application and a service module, said method comprising:

said processor building a service module data structure pursuant to a request previously received by the processor, wherein the request comprises at least one caller application attribute describing the request, wherein the service module data structure comprises a generic service document and at least one service module attribute, and wherein the service module uses only the service module data structure such that the service module need not manipulate the at least one caller application attribute in performing the transaction;

subsequent to said building, said processor storing each service module attribute of the at least one service module attribute in a relational table of the service module data structure;

subsequent to said storing, said processor servicing the request within the service module data structure, wherein said servicing results in instantiating the generic service document; and

subsequent to said servicing, said processor returning the generic service document to the caller application,

wherein said receiving the request, said building the service module data structure, said storing each service module attribute, said servicing the request, and said returning the generic service document are performed by the service module, and

wherein said building comprises;

constructing the generic service document, wherein the generic service document is configured to contain a result of the transaction performed by the service module; and

subsequent to said constructing, creating at least one container in the generic service document, wherein each container of the at least one container is respectively associated with each service module attribute in each mapping of at least one mapping, wherein each container comprises a data value for each service module attribute of at least one service module attribute of the service module data structure, and wherein a mapping table of the service module data structure comprises the at least one mapping.

16. The computer system of claim 15, wherein said building further comprises:

naming each container of the at least one container in the generic service document after each mapping of the at least one mapping in the mapping table.

17. The computer system of claim 15, wherein said building further comprises:

configuring a caller identifier that uniquely identifies the caller application which had sent the request and the service module data structure corresponding to the request.

18. The computer system of claim 15, wherein each service module attribute of the at least one service module attribute either corresponds to a caller application attribute of the at least one caller application attribute or is created by the service module.

19. The computer system of claim 15, said storing comprising:

determining a category of a first service module attribute of said at least one service module attribute, wherein a configuration table comprises respective category of each service module attribute, wherein the category is either an extended-category that is recognized only by the caller application or a basic-category that is recognized by both the caller application and the service module;

subsequent to said determining the category, determining a level of the first service module attribute, wherein the configuration table further comprises respective level of each service module attribute, wherein the level is either a header-level that is applicable for all service module attributes represented in the generic service document or an item-level that is applicable only for the first service module attribute;

subsequent to said determining the level, storing in the relational table a first container of said at least one container pursuant to the category and the level of the first service module attribute that is associated with the first container, wherein the relational table is selected from the group consisting of a first table for service module attributes determined to be in the basic-category and in the header-level, a second table for service module attributes determined to be in the basic-category and in the item-level, a third table for service module attributes determined to be in the extended-category and in the header-level, and a fourth table for service module attributes determined to be in the extended-category and in the item-level; and

subsequent to said storing the first container, repeating to perform said determining the category, said determining the level, and said storing the first container after setting the first container with a next container in the relational table until all containers are stored in the relational table.

20. The computer system of claim 15, said servicing comprising:

performing the transaction requested by the caller application;

subsequent to said performing, retrieving each mapping from the mapping table;

subsequent to said retrieving, reloading each container of said at least one container from the relational table into respective containers of the generic service document according to each retrieved mapping; and

subsequent to said reloading, returning the generic service document to the caller application.