Application - com.hornbill.holidaymanager


Entities

The following entities are defined for this application

AbsenceNotifications

The following operations are defined for the 'AbsenceNotifications' entity.

Operation Description
addAbsenceNotification This flowcode operation adds a new absence notification mapping. It will only add the new mapping if it does not already exist.
addAbsenceNotificationsForAll This flowcode operation makes the specified coworker an absence notification recipient for every other coworker in the system.
deleteAbsenceNotification This flowcode operation deletes an existing absence notification mapping.
deleteAllAbsenceNotifications This flowcode operation deletes all existing absence notification mappings.
generateAbsenceNotifications This flowcode operation generates absence notifications based on each coworker's defined manager.
getAbsenceNotifications This flowcode operation gets details of all absence notifications that match the search criteria.

AccountStatus

There are no operations or events defined for the 'AccountStatus' entity.

Achievement

The following operations are defined for the 'Achievement' entity.

Operation Description
addAchievement For internal use only - This flowcode operation awards an achievement to the specified user.

AchievementImage

There are no operations or events defined for the 'AchievementImage' entity.

Bookmark

There are no operations or events defined for the 'Bookmark' entity.

BookmarkCategory

There are no operations or events defined for the 'BookmarkCategory' entity.

BookmarkHistory

There are no operations or events defined for the 'BookmarkHistory' entity.

Contact

The following operations are defined for the 'Contact' entity.

Operation Description
GetContainerId Get the container id (Organisation) for the specified contact.
addContact DEPRECATED (use addContactNew)
addContact3 For internal use only - Add a New Contact This version 3 uses Organisation instead of container but still updates the containers data structure
addContactNew For internal use only - Add a New Contact
archiveContact For internal use only - This flowcode is responsible for accepting one or more contactIds and changing their status from active to archived
changeOrg For internal use only - Change the Contact's Organisation
guestUpdateProfile This flowcode allows an authorised guest to update only there own contact record
removeOrg For internal use only - Remove the Contact's Organisation
sendSystemNotification Send notification to user
unarchiveContact Updates the status of teh contact to be Active. Note that if the contact had access to the portal, this will not enable back to that state.
updateContact DEPRECATED (Use updateContactNew)
updateContact3 For internal use only - Update Contact
updateContactNew DEPRECATED - Use updateContact3 or changeOrg instead - For internal use only - Update Contact

Contact_extra

There are no operations or events defined for the 'Contact_extra' entity.

Contact_notes

There are no operations or events defined for the 'Contact_notes' entity.

ContactAccess

There are no operations or events defined for the 'ContactAccess' entity.

Container

The following operations are defined for the 'Container' entity.

Operation Description
addChild For internal use only
addContainer This is the description text for this flowcode operation
getChildren This is the description text for this flowcode operation
getChildrenCount This is the description text for this flowcode operation
getContainer For internal use only
getRelatedContainers This is the description text for this flowcode operation
removeChild This is the description text for this flowcode operation
removeContainer This is the description text for this flowcode operation
removePermission This is the description text for this flowcode operation
setPermission This is the description text for this flowcode operation
updateContainer This is the description text for this flowcode operation

ContainerPermissions

There are no operations or events defined for the 'ContainerPermissions' entity.

ContainerType

There are no operations or events defined for the 'ContainerType' entity.

Country

There are no operations or events defined for the 'Country' entity.

CustomList

There are no operations or events defined for the 'CustomList' entity.

EntityAttachments

The following operations are defined for the 'EntityAttachments' entity.

Operation Description
attachFile Attach a file to the EntityAttachments
removeAttachment Remove an attachment from the case
updateDescription Update description of attachments

Favorite

There are no operations or events defined for the 'Favorite' entity.

Groups

There are no operations or events defined for the 'Groups' entity.

HolidayAllowanceHistory

The following operations are defined for the 'HolidayAllowanceHistory' entity.

Operation Description
getHolidayAllowanceHistory This flowcode operation gets details of all holiday allowance history records for the specified holliday allowance that match the search criteria.

HolidayAllowances

The following operations are defined for the 'HolidayAllowances' entity.

Operation Description
addHolidayAllowance This flowcode operation adds a new holiday allowance for the specified user and holiday type. It will only add the new allowance if it does not already exist.
addHolidayAllowanceForAll This flowcode operation creates holiday allowances for all co-worker's for the specified holiday type.
checkRemainingHolidayAllowance This flowcode operation checks to see if the holiday requestor has enough remaining holiday allowance for the specified holiday type to submit a holiday request for approval.
deleteAllHolidayAllowances This flowcode operation deletes all existing holiday allowance mappings.
deleteHolidayAllowance This flowcode operation deletes an existing holiday allowance mapping.
editHolidayAllowance This flowcode operation updates the specified holiday allowance
editHolidayAllowanceForAll This flowcode operation updates all holiday allowance mappings of the specified holiday type by the number of days allowance provided. If the updated allowance is less than 0, the individual holiday allowance mapping will not be updated.
getAllHolidayAllowances This flowcode operation gets details of all holiday allowances that match the search criteria.
getHolidayAllowances This flowcode operation gets details of all holiday allowances that match the search criteria.
getHolidayUsage This flowcode operation gets details of all holiday usage that match the search criteria for the user that invokes the api.
getMyHolidayAllowances This flowcode operation gets details of all holiday allowances that match the search criteria for the user that invokes the api.
getMyHolidayUsage This flowcode operation gets details of all holiday usage that match the search criteria for the user that invokes the api.
getUserHolidayAllowances This flowcode operation gets details of all holiday allowances for the specified user.

HolidayApprovers

The following operations are defined for the 'HolidayApprovers' entity.

Operation Description
addHolidayApprover This flowcode operation adds a new holiday approver mapping. It will only add the new approval mapping if it does not already exist.
addHolidayApproverForAll This flowcode operation makes the specified coworker an approver for every other coworker in the system.
deleteAllHolidayApprovers This flowcode operation deletes all existing holiday approval mappings.
deleteHolidayApprover This flowcode operation deletes an existing holiday approval mapping.
generateHolidayApprovers This flowcode operation generates holiday approvers based on each coworker's defined manager.
getGroups This flowcode operation gets a list of groups based on the group type which is provided as an input parameter.
getHolidayApprovers This flowcode operation gets details of all holiday approvers that match the search criteria.
getMyHolidayApprovees This flowcode operation returns a JSON string of all holiday approvees for the holiday approver that invokes this api.

HolidayAttachments

There are no operations or events defined for the 'HolidayAttachments' entity.

HolidayCalendars

The following operations are defined for the 'HolidayCalendars' entity.

Operation Description
addHolidayCalendar This flowcode operation adds a new holiday schedule. It will only add the new schedule if it does not already exist for the specified holiday requestor.
deleteAllHolidayCalendars This flowcode operation deletes all existing holiday calendars.
deleteHolidayCalendar This flowcode operation deletes an existing holiday calendar.
editHolidayCalendar This flowcode operation edits an existing holiday schedule.
getHolidayCalendars This flowcode operation gets details of all holiday calendars that match the search criteria.
getHolidayRequestorCalendar This flowcode operation gets the holiday calendar for the specified holiday requestor.

HolidayRequestApprovers

The following operations are defined for the 'HolidayRequestApprovers' entity.

Operation Description
getApproverDepartments This flowcode operation gets a list of departments that the holiday request approver is a member of.

HolidayRequestLines

The following operations are defined for the 'HolidayRequestLines' entity.

Operation Description
getDepartmentSelectedDayHolidays This flowcode operation gets details of all holiday requestors that match the selected date search criteria.
getDepartmentSelectedMonthHolidays This flowcode operation gets details and a count of all holiday requests that match the selected search criteria.
getProvisionalHolidayRequestLine This flowcode operation checks to see if the specified date can be a provisional holiday request line based on the provided working time calendar, and the holiday requestor's other current holiday requests.
getSelectedDayHolidays This flowcode operation gets details of all holiday requestors that match the selected date search criteria.
getSelectedMonthHolidays This flowcode operation gets details and a count of all holiday requests that match the selected year and month criteria.
getUpcomingHolidayRequestLines This flowcode operation gets details of upcoming holiday request lines for the specified user that match the selected year and month criteria.

HolidayRequests

The following operations are defined for the 'HolidayRequests' entity.

Operation Description
addHolidayRequest This flowcode operation logs a new holiday request.
approveHolidayRequest This flowcode operation marks the specified holiday request as approved.
cancelHolidayRequest This flowcode operation cancels an existing holiday request.
completeHolidayRequest This flowcode operation completes an existing holiday request.
getHolidayRequest This flowcode operation gets details of the specified holiday request.
getHolidayRequestLines This flowcode operation gets the holiday request lines for the specified holiday request
getHolidayRequestVisibility This flowcode operation returns the user's level of visibility for the specified holiday request.
getHolidayRequestsForCalendar This flowcode operation returns a JSON string of all holiday requests that are approved and are upcoming.
getMyAbsence This flowcode operation checks to see if a user has reported their absence for the date.
getMyHistoricalHolidayApprovals This flowcode operation returns a JSON string of all requests that have been approved by the user who has invoked this api.
getMyOutstandingHolidayApprovals This flowcode operation returns a JSON string of all requests that need to be approved by the user who has invoked this api.
getMyPreviousHolidayRequests This flowcode operation returns a JSON string of all previous holiday requests for the user who has invoked this api.
getMyUpcomingHolidayRequests This flowcode operation returns a JSON string of all upcoming holiday requests for the user who has invoked this api.
getUpcomingHolidayRequests This flowcode operation gets details of upcoming holiday requests for the specified user.
rejectHolidayRequest This flowcode operation marks the specified holiday request as rejected.
replenishHolidayAllowance Flow code to replenish holiday allowance after a holiday request is cancelled or rejected
sendApprovalReminderNotification This flowcode operation sends a Hornbill notification to the designated holiday request approvers. Only the holiday requestor can invoke the operation and the holiday request must have a status of 'Pending Approval'.
submitHolidayRequestForApproval This flowcode operation submits a holiday request for approval.

The following BPM operations are defined for the 'HolidayRequests' entity.

Operation Description
collaboratePostCommentToExistingActivity This flowcode operation posts a comment to an existing post that has been made by the business process engine from the specified request against the provided workspace. If more than one post has been made the most recent post will be commented on.
collaboratePostToPublicWorkspace This flowcode operation posts to a public workspace.
generateApprovalTasks This flowcode operation generates the approval tasks for all approvers that have been configured to approve this holiday request
getApprovalStatus This flowcode operation gets the approval status of the holiday request
getHolidayStatus This flowcode operation gets the status of the holiday request
getHolidayType This flowcode operation gets the holiday type of the holiday request
suspendDescription This flowcode operation suspends the bpm instance and waits for the holiday request to have a description before being allowed to continue.
suspendWaitForApprovalDecision This flowcode operation suspends the bpm instance and waits for a holiday request approval decision to be made before being allowed to continue.
suspendWaitForApprovalReSubmission This flowcode operation suspends the bpm instance and waits for the holiday request to be re-submitted for approval before being allowed to continue.
suspendWaitForApprovalSubmission This flowcode operation suspends the bpm instance and waits for the holiday request to be submitted for approval before being allowed to continue.
updateStatusCancelled This flowcode operation cancells the holiday request.
updateStatusCompleted This flowcode operation completes the holiday request.

The following events are defined for the 'HolidayRequests' entity.

Event Description
OnGetActivityStreamAccessToken Entity system event handler when entity activity stream access token is requested

HolidayTypes

The following operations are defined for the 'HolidayTypes' entity.

Operation Description
addHolidayType This flowcode operation adds a new holiday type. It will only add the new type if it does not already exist.
deleteAllHolidayTypes This flowcode operation deletes all existing holiday types.
deleteHolidayType This flowcode operation deletes an existing holiday type.
editHolidayType This flowcode operation edits an existing holiday type.
getHolidayTypeId This flowcode operation returns a holiday type id based on the holiday type name provided. If no holiday type is found, no output parameter will be returned.
getHolidayTypes This flowcode operation gets details of all holiday types that match the search criteria.
getHolidayTypesForCalendar This flowcode operation gets details of all holiday types that are visible on the holiday calendar.

Location

There are no operations or events defined for the 'Location' entity.

MessageClientTemplate

The following operations are defined for the 'MessageClientTemplate' entity.

Operation Description
add Add Template
delete Delete a template includding shared records
get Returns a template based on an ID
update Update Template

MessageClientTemplateShare

The following operations are defined for the 'MessageClientTemplateShare' entity.

Operation Description
add Add Shares to the template
addOrUpdate Adds or Updates a sharing to a template. This asumes the sharing is one only for each template. Will replace if exists and if is "personal" it will remove the sharing record

OrganizationContacts

There are no operations or events defined for the 'OrganizationContacts' entity.

Organizations

The following operations are defined for the 'Organizations' entity.

Operation Description
addToTimeline Add to Org Timeline
archive For internal use only - Archive an Organisation. If it has an activity stream, will post to the timeline.
unArchive For internal use only - UnArchive an Organisation. If it has an activity stream, will post to the timeline.

ProCapCustomQuestion

The following operations are defined for the 'ProCapCustomQuestion' entity.

Operation Description
add_json Add progressive capture custom questions with answers

ProfileConnections

There are no operations or events defined for the 'ProfileConnections' entity.

ProfileContacts

There are no operations or events defined for the 'ProfileContacts' entity.

ProfileContactTypes

There are no operations or events defined for the 'ProfileContactTypes' entity.

Profiles

There are no operations or events defined for the 'Profiles' entity.

ProfileStatus

There are no operations or events defined for the 'ProfileStatus' entity.

RelatedContainer

There are no operations or events defined for the 'RelatedContainer' entity.

Roles

There are no operations or events defined for the 'Roles' entity.

Site

There are no operations or events defined for the 'Site' entity.

Task

The following operations are defined for the 'Task' entity.

Operation Description
AttachFile For internal use only - Attach a file to the task entity
deleteTask For internal use only - Delete a task
getEntityTasks Return tasks assigned to specific entity
getNewTasks For internal use only - Load tasks from notifications
removeFile For internal use only - Remove an attached file

Task_categories

There are no operations or events defined for the 'Task_categories' entity.

Task_notes

There are no operations or events defined for the 'Task_notes' entity.

TaskBoard

The following operations are defined for the 'TaskBoard' entity.

Operation Description
addBoard For internal use only - Create new board
addDefaultBoard For internal use only - Adding default board and defining task lists
getBoard For internal use only - Read board data
getBoardTasks For internal use only - Flowcode return specified board lists with tasks
queryBoards For internal use only - return boards belonging to user (query is taking user from session)
updateBoard For internal use only - Update board data

TaskBoardList

The following operations are defined for the 'TaskBoardList' entity.

Operation Description
addBoardList For internal use only - adding new list to board
deleteBoardList For internal use only - Delete specified list
filterBoardListTasks For internal use only - return filtered tasks, for more secure searching (only tasks that user can see) to filtered data are added from session user id and roles
filterTasks For internal use only - return filtered tasks, will filter from list one by one and return results in same order
getBoardList For internal use only - Return single list row
getBoardListTasks For internal use only - Return list tasks that are assigned manually
getListTasks For internal use only - Loading tasks one by one for all specified input id, checking every list for type (filter or manual) and calling specific query depends on it. At end return json stringified array of lists with tasks.
queryBoardLists For internal use only - return lists belonging to user
updateBoardList For internal use only - Updating board list record
updateListPositions For internal use only - Updating lists position in order of appear in array

TaskBoardListTask

There are no operations or events defined for the 'TaskBoardListTask' entity.

UserAccount

The following operations are defined for the 'UserAccount' entity.

Operation Description
getTeams Flowcode Operation using the supplied Customer User Id to retrieve the user's Container Id and Customer Name

UserEntityList

There are no operations or events defined for the 'UserEntityList' entity.

Operations

The following general operations are defined for the 'com.hornbill.holidaymanager' application. You can click on each operation to see detailed information about that operation.

Method Source Description
addEveryoneToRole global For internal use only - Add all users to the specified role
addEveryoneToWorkspace global For internal use only - Add all users to the specified workspace
addHistory global For internal use only - Add a historic bookmark for the page visited
addMembersToWorkspace global For internal use only - Add users, groups or members to a specified workspace
adminInitaliseData global Used by the Admin App to get all the initial data need on first lost.
attachFileFromServer local This flowcode operation attaches a file from the server to the specified entity record.
attachFileFromSession local This flowcode operation attaches a file from the current session to the specified entity record.
coreInitaliseData global For internal use only - Used by the Core Web App to get all the initial data need on first lost.
getCoWokers global DEPRECATED - please use getCoworkersList
getCoWokersList global DEPRECATED - Please use getCoWorkersList
getCoWorkers global DEPRECATED - please use getCoworker
getCoWorkersList global For internal use only - Get a list of Co-workers
getContacts global DEPRECATED - use get contactsList
getContactsList global For internal use only - Get a list of contacts
getContactsList4 global For internal use only - Get a list of contacts
getContactsListByOrgFilter global For internal use only - Get filtered and paged list of organisations
getEmailList global DEPRECATED - For internal use only - Used to get email list (Paged) and count of emails.
getEmailList2 global For internal use only - Used to get email list (Paged) and count of emails
getEmailUnreadCounter global For internal use only - Returns the unread email counter for all shared mailboxed bellonging to the logged in user
getOrganisations global DEPRECATED - use getOrganisationList
getOrganisationsList global For internal use only - Get filtered and paged list of organisations
getSitesList global Get a list of Sites
getUnreadCountersForPosts global DEPRECATED - For internal use only - Get unread counters for a list of activity Id
getUserBasicNotificationConfig global For internal use only - Returns user event configuration
getUserGuestRecord global This operation returns a customer's details, depending on whether they are a co-worker or a contact.
getUserMemberships global Returns the List of My Roles and Groups as URNs includding the same user URN
getUsersIManage global For internal use only - Returns the List of Users I manage based on Groups
guestInitaliseData global Used by the Guest App to get all the initial data need on first lost.
postToTimeline global Make safe post to social object timeline, checking if user is following, if not doing it for him and unfollow.
resumeBpmInstance local This flowcode operation attempts to resume a business process instance if it is currently paused.
sendHornbillNotification local This flowcode operation sends a Hornbill notification to the intended recipient.
sendMessage global Send message to specific urn array
shrGetTimestamp global This flowcode returns a new calculated timestamp value based on the input parameters provided.
updateActivityStream global For internal use only - Unified access to the following APIs PostImage AcitvityPostImage ActivityPostMessage PostMessage
userUpdateProfile global Used by the Service Portal to update a basic user / users profile

The following general BPM operations are defined for the 'com.hornbill.holidaymanager' application. You can click on each operation to see detailed information about that operation.

Method Source Description

The following general Auto Responder (AR) operations are defined for the 'com.hornbill.holidaymanager' application. You can click on each operation to see detailed information about that operation.

Method Source Description

The following general events are defined for the 'com.hornbill.holidaymanager' application. You can click on each event to see detailed information about that event.

Event Source Description
OnDevAppInstall local This flowcode operation adds any default data when the new application is installed
OnTaskComplete local System event handler for Task Complete

Powered by Hornbill, for more information click here. (page served by Esp.hornbill.ServerService, 8.0.0.2865.)