TMFC046-WorkforceManagement
apiVersion: oda.tmforum.org/v1
kind: Component
metadata:
name: components.oda.tmforum.org
spec:
coreFunction:
dependentAPIs:
- id: TMF632
apiType: openapi
apiSDO: tmForum
name: party-management-api
required: false
specification:
- url: https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/OpenApiTable/TMF632_Party/4.0.0/swagger/TMF632_Party_Management_API_v4.0.0_swagger.json
version: v4.0.0
resources:
- individual:
- GET
- GET /id
- organization:
- GET
- GET /id
- id: TMF669
apiType: openapi
apiSDO: tmForum
name: party-role-management-api
required: false
specification:
- url: https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/OpenApiTable/TMF669_Party_Role/4.0.0/swagger/TMF669_Party_Role_Management_API_v4.0.0_swagger.json
version: v4.0.0
resources:
- PartyRole:
- GET
- GET /id
- id: TMF701
apiType: openapi
apiSDO: tmForum
name: process-flow-management-api
required: false
specification:
- url: https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/TMF701_Process_Flow/4.1.0/swagger/TMF701_Process_Flow_Management_API_v4.1.0_beta_swagger.json
version: v4.0.0
resources:
- processFlow:
- POST
- GET
- GET /id
- PATCH
exposedAPIs:
- id: TMF646
apiType: openapi
apiSDO: tmForum
name: appointment-management-api
required: true
specification:
- url: https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/OpenApiTable/TMF646_Appointment/4.0.0/swagger/TMF646_Appointment_Management_API_v4.0.0_swagger.json
version: v4.0.0
path: not_defined
developerUI: not_defined
implementation: not_defined
port: 8080
resources:
- appointment:
- GET
- GET /id
- POST
- PATCH /id
- DELETE /id
- searchTimeSlot:
- GET
- GET /id
- POST
- PATCH /id
- DELETE /id
- id: TMF701
apiType: openapi
apiSDO: tmForum
name: process-flow-management-api
required: false
specification:
- url: https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/TMF701_Process_Flow/4.1.0/swagger/TMF701_Process_Flow_Management_API_v4.1.0_beta_swagger.json
version: v4.0.0
path: not_defined
developerUI: not_defined
implementation: not_defined
port: 8080
resources:
- processFlow:
- GET
- GET /id
- POST
- DELETE /id
- taskFlow:
- GET
- GET /id
- PATCH /id
componentMetadata:
id: TMFC046
name: WorkforceManagement
version: 1.1.0
description: Workforce Management component provides capabilities to describe
teams, organizations, skills and availability of sales / technical experts.
It provides the ability to reserve time slots to carry out assigned tasks (internal
or customer facing). It allows the reservation (and updates/rescheduling) of
appointments and interventions.
publicationDate: 2024-04-18
status: specified
functionalBlock: Production
owners:
- email: Redacted
name: Redacted
url: Redacted
maintainers:
- name: Redacted
email: components@tmforum.org
url: Redacted
eTOMs:
- 1.5.4|Resource_Readiness_&_Support|v23.0
- 1.5.4.8|Manage_Field_Workforce|v23.0
functionalFrameworkFunctions:
- 119|Center_Time_Management|v23.0
- 1326|Work_List_Management|v23.0
- 113|Care-center_Compliance_Management|v23.0
- 116|Center_Activity_Management|v23.0
- 449|Resource_Change_Project_Collaboration|v23.0
- 1184|Workforce_Agenda_Booking|v23.0
- 1183|Workforce_Availability_Check|v23.0
- 114|Care-center_Case_Queing|v23.0
- 554|Workforce_Appointment_Schedule_Configuration|v23.0
- 555|Workload_Forecasting|v23.0
- 556|Workforce_Availability_Management|v23.0
- 558|Workforce_Dispatchability_Management|v23.0
- 482|Workforce_Management|v23.0
- 561|Workforce_Scheduling|v23.0
SIDs:
- Enterprise_Domain|Workforce_ABE|v25.0
managementFunction:
exposedAPIs:
- name: metrics
apiType: prometheus
apiSDO: not_defined
specification:
- url: '{{.Release.Name}}-{{.Values.component.name}}-sm'
version: v4.0.0
implementation: '{{.Release.Name}}-{{.Values.component.name}}-sm'
path: /{{.Release.Name}}-{{.Values.component.name}}/metrics
port: 4000
id: exposedAPI_id
version: exposedAPI_version
resources: []
required: false
developerUI: exposedAPI_developerUI
dependentAPIs:
- name: dependentAPI_name
id: dependentAPI_id
version: dependentAPI_version
apiType: dependentAPI_apiType
apiSDO: dependentAPI_apiSDO
specification:
- url: dependentAPI_spec
version: dependentAPI_version
resources: []
required: false
securityFunction:
canvasSystemRole: '{{ .Values.security.controllerRole }}'
secretsManagement:
type: sideCar
sideCar:
port: 8080
podSelector:
namespace: '{{ .Values.secretsManagement.podSelector.namespace }}'
name: '{{ .Values.secretsManagement.podSelector.name }}'
serviceaccount: '{{ .Values.secretsManagement.podSelector.serviceaccount }}'
exposedAPIs:
- id: TMF669
apiType: openapi
apiSDO: not_defined
name: party-role-management-api
required: true
specification:
- url: https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/OpenApiTable/TMF669_Party_Role/4.0.0/swagger/TMF669_Party_Role_Management_API_v4.0.0_swagger.json
version: v4.0.0
path: /{{.Release.Name}}-{{.Values.component.name}}/tmf-api/partyRoleManagement/v4
developerUI: /{{.Release.Name}}-{{.Values.component.name}}/tmf-api/partyRoleManagement/v4/docs
implementation: '{{.Release.Name}}-partyroleapi'
port: 8080
resources: []
dependentAPIs: []
eventNotification:
publishedEvents:
- implementation: /{{.Release.Name}}-appointmentManagement
name: appointmentManagement
port: 80
resources:
- appointmentStateChange
- appointmentCreateEvent
- appointmentAttributeValueChangeEvent
- appointmentDeleteEvent
- searchTimeSlotCreateEvent
- searchTimeSlotAttributeValueChangeEvent
- searchTimeSlotStateChangeEvent
- searchTimeSlotDeleteEvent
specification:
- url: https://github.com/tmforum-apis/TMF646_AppointmentManagement/blob/master/TMF646-Appointment-v4.0.0.swagger.json
version: v4.0.0
apiType: openapi
id: TMF646
apiSDO: not_defined
subscribedEvents:
- name: PartyRoleManagement
port: 80
resources:
- partyRoleCreateEvent
- partyRoleAttributeValueChangeEvent
- partyRoleStateChangeEvent
- partyRoleDeleteEvent
specification:
- url: https://github.com/tmforum-apis/TMF669-PartyRoleManagement/blob/master/TMF669-PartyRoleManagement-v4.0.0.swagger.json
version: v4.0.0
apiType: openapi
id: TMF669
apiSDO: not_defined
- name: ProcessFlowManagement
port: 80
resources:
- processFlowCreateEvent
- processFlowStateChangeEvent
- processFlowStateDeleteEvent
- processFlowStateAttributeValueChangeEvent
- taskFlowCreateEvent
- taskFlowStateChangeEvent
- taskFlowDeleteEvent
- taskFlowAttributeValueChangeEvent
- taskFlowInformationRequiredEvent
specification:
- url: https://github.com/tmforum-apis/TMF701_ProcessFlow/blob/master/TMF701-ProcessFlow-v4.0.0.swagger.json
version: v4.0.0
apiType: openapi
id: TMF701
apiSDO: not_defined