2 Service API Creation

Service API Creation is the process of designing and developing an interface that enables external systems to interact with a service's functionality.

Using OFS, we can create APIs for a wide range of component types through a standardized, end-to-end API creation process. This process provides the complete supporting infrastructure required to design, implement, and expose new services, including the foundational scaffolding and configuration needed for consistent development and deployment. Each generated service is aligned with the OBMA architecture, ensuring compliance with established design principles and promoting reusability, maintainability, and architectural consistency. As a result, these services can be seamlessly plugged into any UI component screen, enabling secure and reliable data persistence and supporting integration across different application modules.

Figure 2-1 Services


Description of Figure 2-1 follows
Description of "Figure 2-1 Services"

The following data types are supported for DTO field types:
  1. String – This is an inbuilt field type of OFS; it gets translated to string type in java files and input text field in UI component.
  2. Number – This is an inbuilt field type of OFS; it gets translated to integer type in java files and input number field in UI component.
  3. Date – This is an inbuilt field type of OFS; it gets translated to Date type in java files and input date field in UI component.

In addition, OFS supports API creation across multiple component categories, including Data Segment, Individual, and Maintenance components. This enables teams to generate services that align with the specific functional and data requirements of each component type while still following a consistent, standardized service-generation approach. As a result, the produced APIs can be integrated more easily with corresponding UI screens, helping ensure uniform behavior for data capture, validation, and persistence across different parts of the application.

  • Service creation for Data Segment
    This topic provides information about the process of creating a service for a data segment within a system.
  • Service for Individual Component
    This topic provides information about the service used to manage and maintain an individual component within a system.
  • Service for Maintenance Summary Component
    This topic provides information about the service used to manage and maintain the summary component within a system.
  • Import Service
    This topic provides information about the process of uploading and integrating a service-related file, configuration, application package, or resource into a system.
  • Download Service
    This topic provides information about the process of retrieving and saving a service-related file, configuration, application package, or resource from a system to a local device.
  • Edit Service
    This topic provides information about the process of modifying or updating an existing service, application, or resource within a system.
  • Delete Service
    This topic provides information of the process of removing or deactivating an existing service, application, or resource within a system.