Case as a universal MRC object - MrcObject
This article describes the universal MRC object and its components. It is used in SOAP and REST services. Unlike the freedom to create case objects using ANY XML and ANY JSON schemas, the universal MRC object is strictly defined and uniquely describes any MRC object.
Case as any object
Below is a description of building a case object as any XML or JSON definition. This form is used in SOAP services (methods with the XML suffix in their name) and REST services (services with the ExtRest suffix in their name).
Case Header object
This article describes an object that is a key element of requests in communication with the database via SOAP and REST services. The CaseHeader header is necessary for implementing case update tasks in the database, supports the identification and update of the case type definition. This object contains predefined fields of the Case entity, which are used to identify the case, its status and other important information. The article also presents examples of case header construction in various formats (XML and JSON) and discusses the meaning of individual fields.
Case Recording Services and Methods
This article will describe the mechanisms accompanying the recording of a case to the Mercury DB (HgDB) database at the business layer level. Despite the existence of case recording methods in the system in services related to the logical layer, it is not recommended to use them. They are treated as obsolete. Maintaining them as explicit services is necessary due to compatibility with other products that use this layer directly.
Case vs. Object
Mercury DB® is also called a "case database". Let's try to explain what the concept of a "case" is in the interpretation of the system. A case is any object described by a type and its parameters. I wondered for a long time how to name the basic unit defining such an object. The word Object is reserved by many programming languages, hence the concept of Case, which in this case becomes its synonym. The concept of Case also has its reference to business concepts, which it represents in a number of practical applications. A case is a representation of the object of a contract, a contractor, a computer, a car and an infinite number of things that surround us, and we would like to record them in electronic form. The document contains many concepts such as "complex object", "dependent case", "parent case", "type", "type parameters", which can be interpreted differently. In the following part we will try to explain, based on a specific example, what these concepts mean from the point of view of the Mercury DB® system. We will refer to an example of a data object definition in the IBM BPM system, in which we use the concept of "Business Object" (BO).
Client Mercury BPM
The page is under construction and does not yet contain all the information. Please be patient.
Comments on the cases
This page is under construction and does not yet have all the information. Please be patient.
PagedResult as a list of loaded data
Description and example of the implementation of the PagedResult output data, also called a paged result. The described format of the transmitted data is applicable wherever the response to the request returns lists of very large volume, which the client is unable to process in a single operation, where it is necessary to divide these lists into pages. PagedResult is a kind of response standard used in communication with the HgDB system. This chapter describes the type structure in the form of JSON (for REST services) and XML (for SOAP services). The object also has its representation (implementation) in Java and is used there in RMI communication.
Quick Tasks
This page is under construction and does not yet have all the information. Please be patient.
SOAP/REST Service Request Context
The article describes objects that are key elements of requests in communication with the database via SOAP and REST services. The Context object is used in all services and is the basis for analyzing user permissions and the form of the response. The widespread use in the HgDB solution resulted in the need to create a kind of communication standard between integrated systems. This is how the Context and Case Request Transportable Objects Open API project was created, which was used, among others, for communication between Mercury DB (HgDB) 3.0 and Iron - POI Excel Server.
Testing the connection with method Echo
Each service implemented in the Mercury DB (HgDB) 3.0 system contains the echo method (a request sent using the POST method). It allows for verifying the correctness of the defined communication between the client and the server. An example of using the method is the implementation of the data source for the Grafana system: datasource.ts where the testDatasource() method uses the echo method call of the CaseSearchRest service.