Skip to main content

Configuration

There are a handful of configuration files which must be appropriately updated prior to using the Solution Center Java Starter Project as a template.

Configuring the Maven POM File​

File Location: pom.xml

The Maven POM file is used to configure the project's dependencies, build process, and other project settings. This includes the project's name, version, description, and main class, which must be configured before the project can be built.

Step 1​

Open the Maven POM file located at pom.xml in your favorite text editor.

Step 2​

Update the values of the following fields within the Maven POM File: name, version, groupId, artifactId, project.main.class.

Maven pom file fields highlighted

Step 3​

After saving the changes to the Maven POM file, the project can be built, and you may continue setting up and using the Solution Center Java Starter Project.

Green check mark

POM File Fields​

name​

The name field modifies the project's name. This field is used by the Maven build system to name the project's JAR file, and is used by the application to display the project's name.

version​

The version field modifies the project's version. This field is used by the Maven build system to name the project's JAR file, and is used by the application to display the project's version.

tip

The version number must follow the Semantic Versioning standard.

For example, the version number 1.0.0 is valid, but the version number 1.0 is not valid.

groupId​

The groupId field modifies the project's group ID. This field is used to uniquely identify a project, or set of projects within a single organization. This field is commonly used in multiple module projects to group modules together.

tip

The group ID must follow the Java Package Naming Conventions.

For example, the group ID com.example.project is valid, but the group ID com.example-project is not valid.

artifactId​

The artifactId field modifies the project's artifact ID. This field is used to uniquely identify a project within a group ID, and is the name of the jar without version. In multiple module projects, this field is commonly used to name the individual module.

project.main.class​

The project.main.class field modifies the project's main class. This field is used by the Maven build system to specify the project's main class, and is used by the application to launch the project's main class.

Configuring the Documentation​

File Location: web-docs/ScDocusaurusConfig.js

The documentation configuration file is used to configure the documentation's title, description, and GitHub repository information, and must be updated before the documentation can be built.

Step 1​

Open the documentation configuration file located at web-docs/ScDocusaurusConfig.js in your favorite text editor.

Step 2​

Update the values of the following fields within the documentation configuration file: repoOwnerName, repoName, title, description, and meta.

Docusaurus config file fields highlighted

Step 3​

After saving the changes to the documentation configuration file, the documentation can be built, and you may continue setting up and using the Solution Center Java Starter Project.

Green check mark

Docusaurus Configuration Fields​

repoOwnerName​

The repoOwnerName field modifies the project's repository owner name. This field is used for creating links used by the download button(s) and repository references in the documentation.

repoName​

The repoName field modifies the project's repository name. This field is used for creating links used by the download button(s) and repository references in the documentation.

title​

The title field modifies the project's title. This field is used by the documentation to display the project's title.

description​

The description field modifies the project's description. This field is used by the documentation to display the project's description on the home page.

meta​

The meta field modifies the project's meta information. This field is used by the documentation to include meta information in the project's HTML pages, which is used by search engines and social media websites to display information about the project and/or documentation website.

configFileName​

The configFileName field modifies the project's configuration file name. This field is used by the documentation to display the name of the configuration file used by the application.

applicationJarFileName​

The applicationJarFileName field modifies the project's application JAR file name. This field is used by the documentation to display the name of the JAR file used by the application.