Application - com.hornbill.customermanager
Entities
The following entities are defined for this applicationAccountStatus
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.
Case
The following operations are defined for the 'Case' entity.
| Operation | Description |
|---|---|
| add | Steps: 1 Adds a Case 2 Follows the Timeline 3 Adds a post to the Timeline For case owner is set based on session - could be user or contact |
| addAttachment | Attach a file to the Contract |
| addMember | grant member access to case (add it to members) |
| canUpdate | Set new customer for case |
| get | Returns Case Information |
| guest_add | Raise new case from website or any other source |
| guest_addAttachment | add guest attachment |
| guest_get | Returns Case Information for guest |
| guest_setStatus | Set case status and reset to unread |
| remove | Archives the case. |
| removeAttachment | Remove an attachment from the case |
| removeMember | remove member |
| sendMessage | Send Email Message |
| setCustomer | Add customer to an existing Case. |
| setOwner | Set new customer for case |
| setReadFlag | Set case read flag |
| setStatus | Set new case status and reset to unread |
| update | Updates the case Details |
| updateExtra | Updates the case last action extra info |
The following BPM operations are defined for the 'Case' entity.
| Operation | Description |
|---|---|
| getCaseDetails | Get Case information |
The following events are defined for the 'Case' entity.
| Event | Description |
|---|---|
| OnGetActivityStreamAccessToken | Entity system event handler when entity activity stream access token is requested |
CaseCustomer
There are no operations or events defined for the 'CaseCustomer' entity.
CaseMember
There are no operations or events defined for the 'CaseMember' entity.
CaseType
There are no operations or events defined for the 'CaseType' 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) |
| 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 |
| sendMessage | Send Email Message |
| 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.
Contract
The following operations are defined for the 'Contract' entity.
| Operation | Description |
|---|---|
| add | Adds a Contract for an Organisation Adds a post to the Timeline Follows the Timeline |
| addAttachment | Attach a file to the Contract |
| duplicate | Duplicates an excisting Contract. Uses the same Timeline |
| get | Returns Contract Information |
| remove | Archives the contract. Link between the organisation will be sill maintained and can be brought back by sending "unarchived" as true |
| removeAttachment | Remove an attachment from the Contract |
| update | Updates the Contract Details |
ContractContact
The following operations are defined for the 'ContractContact' entity.
| Operation | Description |
|---|---|
| add | Add a Contact to an existing Contract. Contact can be added from an existing one or a non existing. If not existing, no contact ID is needed. If contact ID is used, no other details are needed. |
| get | Returns Contact details from the contract |
| remove | Removes a Contact from an existing Contract. |
| update | Update a Contact in an existing Contract. |
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.
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 |
|---|---|
| AttachFile | Attach a file to the Organisation |
| RemoveAttachment | Remove an attachment from the Organisation |
| addMember | Add a Member to an Organisation |
| addMember2 | Add a Member to an Organisation |
| addToTimeline | Add to Org Timeline |
| archive | For internal use only - Archive an Organisation. If it has an activity stream, will post to the timeline. |
| removeMember | Remove a member from the Organisation |
| removeMember2 | Remove a member from the Organisation |
| unArchive | For internal use only - UnArchive an Organisation. If it has an activity stream, will post to the timeline. |
OrgMembers
There are no operations or events defined for the 'OrgMembers' entity.
ProCapCustomQuestion
The following operations are defined for the 'ProCapCustomQuestion' entity.
| Operation | Description |
|---|---|
| add_json | Add progressive capture custom questions with answers |
Products
There are no operations or events defined for the 'Products' entity.
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.
ServiceDesk
The following operations are defined for the 'ServiceDesk' entity.
| Operation | Description |
|---|---|
| admin_add | adds desk |
| admin_addMember | grant member access to case (add it to members) |
| admin_addOrganisation | assigne organisation to desk |
| admin_get | Returns Sevice Desk Information |
| admin_remove | Archives the serive desk. |
| admin_removeMember | remove member |
| admin_removeOrganisation | remove organisation |
| admin_update | Updates the case Details |
ServiceDeskMember
There are no operations or events defined for the 'ServiceDeskMember' entity.
ServiceDeskOrganization
There are no operations or events defined for the 'ServiceDeskOrganization' entity.
Site
There are no operations or events defined for the 'Site' entity.
SupportedItems
The following operations are defined for the 'SupportedItems' entity.
| Operation | Description |
|---|---|
| add | Add a Contact to an existing Contract. Contact can be added from an existing one or a non existing. If not existing, no contact ID is needed. If contact ID is used, no other details are needed. |
| get | Returns Supported Item details from the contract |
| remove | Removes a Supported Item from an existing Contract. |
| update | Update a Supported Item in an existing Contract. |
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 |
| 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.customermanager' 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. |
| appCoreInitaliseData | local | Returns the current active timer value for my session |
| 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 |
| getMyOrganisationsList | local | Get the list and count of the organisations I manage |
| 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. |
| h_create_mailboxes | local | Create Mailboxes |
| migrateMembers | local | Migration for Members from Containers to Independent table |
| postToTimeline | local | Make safe post to social object timeline, checking if user is following, if not doing it for him and unfollow. |
| sendMessage | local | 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.customermanager' 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.customermanager' 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.customermanager' application. You can click on each event to see detailed information about that event.
| Event | Source | Description |
|---|---|---|
| OnDevAppInstall | local | The system event handler for new installed applications |
| OnDevAppUpdate | local | The system event handler for new installed applications |
| OnTaskComplete | local | System event handler for the Task Complete |
| OnTaskCreate | local | System event handler for task creation |