Open rahulsahaty opened 6 years ago
swagger: '2.0' info: description: HRDB Writer APIs title: HRDBWriter version: "1.0" host: localhost:8080 basePath: "/peoplemover/hrdbwriter" tags:
name: hrdb-controller description: HRDB Controller paths:
"/create": post: tags:
in: body name: json description: | HRDB Field | Description | Default Value | Table Name | Is Mandatory | |
---|---|---|---|---|---|---|
fname | First Name | null | hrdb.dbo.staff_ts | yes | ||
lname | Last Name | null | hrdb.dbo.staff_ts | yes | ||
middle | Middle Name | null | hrdb.dbo.staff_ts | no | ||
login | Employee login | generated by algorithm if not given | hrdb.dbo.staff_ts | no | ||
Email Address | null | hrdb.dbo.staff_ts | yes | |||
jobFunction | Job Function | null | decodes(HRDBJobFunction) | yes(when source is not ProviderAladdin) | ||
officeLocation | Office Location. Must be a value from the existing list of office locations | null | hrdb.dbo.office_location | yes | ||
fte | Fte | 0 | hrdb.dbo.staff_ts | no | ||
suppress | Suppress | A | hrdb.dbo.staff_ts | no | ||
createdBy | Created By | SttsLoad | hrdb.dbo.staff_ts | no | ||
createdTime | Created Time | Current System Time | hrdb.dbo.staff_ts | no | ||
staffType | Staff type | xNW | hrdb.dbo.staff_ts | no | ||
jobTitle | Job Title | BR0102(when source is ProviderAladdin) | hrdb.dbo.staff_ts | yes(when source is not ProviderAladdin) | ||
roleId / roleName | Role Id / Role Name | null | hrdb.dbo.role_defnandhrdb.dbo.employee_department_role | no | ||
deptCode | Department Code | null | hrdb.dbo.employee_organdhrdb.dbo.employee_department_role | yes | ||
number | Employee Office Phone Number | null | hrdb.dbo.employees_phones | yes | ||
relEmployeeCode | Relation Employee Code | null | hrdb.dbo.employee_rel | no | ||
relType | Relation Eployee Type | null | hrdb.dbo.employee_rel | no | ||
status | Employee Record status | null | hrdb.dbo.staff_ts | yes | ||
startDate | Start Date | null | hrdb.dbo.staff_ts | yes | ||
processingStatus | describe status of record processed | null | no |
required: true schema: type: string
in: body name: json description: | HRDB Fields | Description | Default Value | Table Name | Is Mandatory | |
---|---|---|---|---|---|---|
dept_code | Department Code | null | hrdb.dbo.org | yes | ||
name | Name | null | hrdb.dbo.org | yes | ||
parent | Parent | null | hrdb.dbo.org | yes | ||
status | Status. A='Active'. T='Terminated' | A | hrdb.dbo.org | no | ||
dept_order | Department Order | 20 | hrdb.dbo.org | no | ||
cost_center | Cost Center | null | hrdb.dbo.org | no |
required: true schema: type: string
in: body name: json description: | HRDB Fields | Description | Default Value | Table Name | Is Mandatory | |
---|---|---|---|---|---|---|
office_location | Office location code | null | hrdb.dbo.office_location | yes | ||
address1 | Address line 1 | null | hrdb.dbo.office_location | no | ||
address2 | Address line 2 | null | 1 | no | ||
city | City | null | hrdb.dbo.office_location | no | ||
state | State | null | hrdb.dbo.office_location | no | ||
zip | Zip code | null | hrdb.dbo.office_location | no | ||
country | Country | null | hrdb.dbo.office_location | no | ||
phone_number | Main office contact number | null | hrdb.dbo.office_location | no | ||
direction | Office e-mail contact | null | hrdb.dbo.office_location | no | ||
office_lnk | Links two offices | null | hrdb.dbo.office_location | no | ||
reception_floor | Main floor for visitors | null | hrdb.dbo.office_location | no | ||
region | Region in which the office resides | null | hrdb.dbo.office_location | no | ||
location_name | Holds the office location name if available | null | hrdb.dbo.office_location | no | ||
iso_country | iso country code . desc will be in decodes | null | hrdb.dbo.office_location | no | ||
mailstop | mail stop for office location | null | hrdb.dbo.office_location | no | ||
status | Status. A='Active'. I='Inactive' locations | null | hrdb.dbo.office_location | no |
required: true schema: type: string
in: body name: json description: | HRDB Field | Description | Default Value | Table Name | Is Mandatory | |
---|---|---|---|---|---|---|
login | Login | null | hrdb.dbo.staff_ts | yes | ||
status | Status. A='Active', T='Terminated' | T | hrdb.dbo.staff_ts | no | ||
termDate | Termination Date | null | hrdb.dbo.staff_ts | yes |
required: true schema: type: string
"/search": post: tags:
in: body name: json description: | HRDB Fields | Description | Default Value | Table Name | Is Mandatory | |
---|---|---|---|---|---|---|
login | Login | null | hrdb.dbo.staff_ts | yes | ||
Any field to be updated | N/A | N/A | N/A | no |
required: true schema: type: string
definitions: LoginAndEmail: type: object properties: email: type: string login: type: string
Figure d. shows the expected flow of data from the notification creator to the user. Consider the lifecycle of a scheduled notification. A notification is created using the user interface and is then sent to server 1. Server 1 is responsible for tasks such as addition, editing and deletion of notifications and sending notifications to server 2, as per schedule. These methods are provided as APIs. Server 1 receives the notification from the frontend and stores it in the database. Once the notification is to be sent, server 1 retrieves the notification and sends it to server 2, which contains existing logic for delegating the notifications to the apple Gateway. In the future, server 2 will be responsible for sending the notification to its appropriate destination (either a set of apple devices or both, a set of apple devices and a set of desktops). The development of the Unified Communication Platform has been divided into two phases.
Phase 1:
• Development of the user interface consisting of Push Notifications, Happening Now, Firm Calendar Events and Assign Tasks • Integrating the frontend with the existing backend • Modification of backend to accommodate Assign Tasks • Implementing notifications for desktops
Phase 2:
• Optimizing server 1 • Optimizing server 2 • Development of the BLK TV section, custom home page and screen savers
3.1.2 Assumptions made During the design and implementation of the UCP, a few assumptions were made regarding the usage of the application. The assumptions are listed below:
Users will not indiscriminately create push notifications: This is an inevitable assumption. It is not possible to restrict the number of push notifications a user issues, owing to the fact that it may be necessary for a certain user (eg.a command center operative) to send out multiple notifications on a given day. It is at the users’ discretion to ensure that they do not misuse this service and inconvenience other employees as well as not create unnecessary load on the server.
Push Notifications are only accessible for those employees with access to firm iPhones. Since applications such as OneBLK, Student of the Market, etc. are only available to users who possess a firm iPhone, only they will be able to receive push notifications. 3.1.3 Design and Modelling UCP, created using Angular 5, is composed of Angular components, services and DTO classes. Components are classes in Angular that are associated with the view of