Skip to content

Sundsvallskommun/api-service-supportcenter

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

SupportCenter

SupportCenter is a microservice for managing and updating cases within the POB (Point of Business) system. It ensures efficient handling of case updates, status changes, and synchronization with POB.

Getting Started

Prerequisites

Installation

  1. Clone the repository:

    git clone [email protected]:Sundsvallskommun/api-service-supportcenter.git
  2. Configure the application:

    Before running the application, you need to set up configuration settings. See Configuration

    Note: Ensure all required configurations are set; otherwise, the application may fail to start.

  3. Ensure dependent services are running:

    If this microservice depends on other services, make sure they are up and accessible. See Dependencies for more details.

  4. Build and run the application:

    mvn spring-boot:run

Dependencies

This microservice depends on the following services:

  • POB
    • Purpose: POB is the case management system where IT support handles cases.
    • Website: https://www.serviceaide.com/products/pob
    • Setup Instructions: Refer to its documentation for installation and configuration steps.

Ensure that these services are running and properly configured before starting this microservice.

API Documentation

Access the API documentation via Swagger UI:

Usage

API Endpoints

Refer to the API Documentation for detailed information on available endpoints.

Example Request

curl -X GET http://localhost:8080/api/2281/assets

Configuration

Configuration is crucial for the application to run successfully. Ensure all necessary settings are configured in application.yml.

Key Configuration Parameters

  • Server Port:

    server:
      port: 8080
  • POB Service:

    integration:
      pob:
        url: http://dependency_service_url
    

Additional Notes

  • Application Profiles:

    Use Spring profiles (dev, prod, etc.) to manage different configurations for different environments.

  • Logging Configuration:

    Adjust logging levels if necessary.

Contributing

Contributions are welcome! Please see CONTRIBUTING.md for guidelines.

License

This project is licensed under the MIT License.

Code status

Quality Gate Status Reliability Rating Security Rating Maintainability Rating Vulnerabilities Bugs


© 2024 Sundsvalls kommun

About

Managing and updating cases within POB

Topics

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages