PCMS Project Onboarding Document

Purpose: Internal Audit Compliance & Delivery Process Governance

Version History

Creating Person	Version	Date (DD-MM-YYYY)
Satyakam Kaul	1.0.0	27-11-25

1. Welcome Message

Welcome to the PCMS team! We're excited to have you join us. This document will guide you through the onboarding process for the project and help you get started quickly.

2. Project Overview

The application server acts as an execution environment for the CDB application, which is deployed as an Enterprise Archive (EAR) and consists of three modules:

The cdb-core is the core of the application, containing the layer responsible for communicating with the database and the Active Directory, as well as the business logic layer, which is then reused by both the frontend and the web service module.
The cdb-web is a module which contains the layer responsible for creating the HTML-based user interface.
The cdb-ws.war is a module responsible for exposing functionalities of the business layer to external applications.
The cdb-parent is the main parent module containing core and web modules. This module can be used to build the WAR which is then deployed on the GlassFish server.

The application server requires a minimum of 8 GB of operating memory assigned. Normal operations require less memory but certain tasks in the CDB application collect and output large amounts of data (for example, various document generation features). In such cases, the memory usage will increase temporarily in order to process all the necessary data.

3. Team Structure

Sr. No.	Name	Role	Responsibility
1	Satyakam Kaul	Team Lead
2	Aparna Mohod	Product Specialist	Product Knowledge, QA, Client Communication
3	Dnyaneshwari Dhepe	QA	QA
4	Gajanan Patil	Sr. Developer
6	Vaibhav Kale	Jr. Developer

4. Tech Stack

Installation of required tools or software in the system. Below is a list of project-required software with versions.

Project Required Tools / Software

Sr. No.	Tool Name	Version	Link
1	Java	11	Oracle JDK 11 Downloads
2	JSF	2.3	Jakarta Faces 2.3 Specification
3	PrimeFaces	12	PrimeFaces 12.0.2 Release Notes
4	NetBeans	18	NetBeans 18 Download
5	SQL Server	2019	(Link as per original document)
6	SQL Server Management Studio (SSMS)		SSMS Documentation & Download
7	Maven	3.9.8	Maven 3.9.8 Release Notes
8	Git Bash	2.40.1.windows.1	Git Download

5. Project Environments

In the PCMS project we are using the following four environments:

Local (Dev)
HF-TEST (Integration)
Nx-TEST (Acceptance)
Nx-PROD (Production)

6. Code Repository

Set up the PCMS Git repository on your local machine:

PCMS Git Repository (Gitea)

7. Issue Tracking and Project Management

We use Jira for issue tracking and project management:

PCMS Jira Project

8. Coding Standards & Guidelines

Link or describe the coding standards followed in the project. Mention:

Code formatting conventions
Documentation expectations
Testing practices (unit/integration)
Code review processes

More details here.

9. Testing and QA

Outline of the testing strategy and tools used:

Unit tests
Integration tests
Test coverage expectations

Include instructions for running tests locally (for example Maven or IDE-based commands) on your internal wiki page, e.g.:

`mvn clean test`
How to run specific test suites
How to view and interpret test reports

10. Deployment Process

Explain how code is deployed to different environments (Dev, QA, UAT, Prod). Typical aspects to document:

CI/CD pipeline tools (e.g., Jenkins, Git-based pipelines, etc.)
Branching and merging strategy (e.g., feature branches, release branches)
Deployment steps for each environment
Approval process and sign-offs needed for production deployment

(Adapt and link to your detailed deployment runbook page if available.)

11. Access and Credentials

List systems the new team member needs access to:

Code repository (Gitea/Git)
Application servers / environments (Dev, HF-TEST, Nx-TEST, Nx-PROD)
Databases (read-only / read-write as required)
Project management tools (Jira)
Documentation and knowledge base (Wiki, Confluence, etc.)

Also include:

How to request access (e.g., via ticketing system, email request template)
Expected SLAs for getting access approved

12. Key Documents and Resources

Provide links to important project documents such as:

Architecture diagrams
API documentation
Meeting notes and decision logs
Knowledge base and wiki pages
Runbooks / SOPs for operations

(Replace this list with actual internal links to your documentation pages.)

13. Getting Help

Provide information on where and how to get help:

Primary contact person for onboarding questions (e.g., Team Lead, Product Specialist)
Communication channels:
- Internal chat (e.g., Slack / Teams channels)
- Email distribution lists
- Regular team meetings / stand-ups

You may also assign a mentor or buddy for the first few weeks and document that here.

14. First Week Goals

Suggested goals for the new team member’s first week:

Complete development environment setup
Clone the repository and build the project locally
Run the application on the local environment
Go through key documentation (architecture overview, coding standards, deployment overview)
Attend team stand-ups and introductory meetings
Pick up and complete a small, low-risk task or bug to get familiar with the workflow

You can maintain a checklist here that the new joiner can tick off.

15. Conclusion

We’re glad to have you onboard. Don’t hesitate to reach out if you have any questions.

Welcome aboard and happy coding!