Application - com.hornbill.customermanager

Entities

The following entities are defined for this application

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.

BpmUiLauncher

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

BusinessProcessInstance

There are no operations or events defined for the 'BusinessProcessInstance' 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 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

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

Operation	Description
admin_addMember	add default member(s) to case type
admin_removeMember	remove member

CaseTypeMember

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

Catalog

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

Operation	Description
addServiceToFavourites	- PROTOTYPE - Adds a service to Favourites - calling for app flowcode: catalogAddServiceToFavourites
getBulletinList	- PROTOTYPE - Returns a list of bulletins - calling for app flowcode: catalogGetBulletinList
getFAQList	- PROTOTYPE - Returns a list of FAQs - calling for app flowcode: catalogGetFAQList
getKnownIssueList	- PROTOTYPE - Returns a list of known issues - calling for app flowcode: catalogGetKnownIssueList
getMyServiceDomains	- PROTOTYPE - Returns a list of Service Domains that are used only based on My Services List - calling for app flowcode: catalogGetServiceList Also returns a property called serviceCount with the count of services for each domain If no services assigned, it will return a dummy domain called "other"
getMyServiceRequestList	- PROTOTYPE - Returns a list of My Service Requests (request records already raised) - calling for app flowcode: catalogGetMyServiceRequestList
getService	- PROTOTYPE - Returns a service - calling for app flowcode: catalogGetService
getServiceDomain	- PROTOTYPE - Returns a specific Service Domain includding the layour and style details
getServiceDomainLayout	- PROTOTYPE - Returns a specific Service Domain layout and style details. If service domain is not passed, it will return the generic sections.
getServiceDomains	- PROTOTYPE - Returns a list of enabled Service Domains includding the basic data of the related page
getServiceFAQ	- PROTOTYPE - Get Service FAQ
getServiceList	- PROTOTYPE - Returns a list of services - calling for app flowcode: catalogGetServiceList
getServiceRequest	- DEMO - Returns a Service Request
getServiceRequestList	- PROTOTYPE - Returns a list of Service Requests - calling for app flowcode: catalogGetServiceRequestList
homePageGet	- PROTOTYPE - Returns the Home Page
homePageSet	- PROTOTYPE - Inserts or Updates a Page
removeServiceFromFavourites	- PROTOTYPE - Removes a service from Favourites - calling for app flowcode: catalogRemoveServiceFromFavourites
searchService	- PROTOTYPE - Returns a list of services, Service Subtypes or/and existing service requests based on a query
setServiceDomain	- PROTOTYPE - Saves changes to a specific Service Domain
setServiceDomainCalendarEvent	- PROTOTYPE - Add or Update n Service Domain Event
setServiceFAQDislike	- PROTOTYPE - Sets Dislike flag to an FAQ
setServiceFAQLike	- PROTOTYPE - Sets Like flag to an FAQ
setServiceKnownIssueMeToo	- PROTOTYPE - Sets Known Issue Me To to TRUE or FALSE via the value property
submitServiceRequest	- DEMO - Returns a Service Request
unsetServiceDomainCalendarEvent	- PROTOTYPE - Removes a Service Domain Event

Contact

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

Operation	Description
GetContainerId	Get the container id (Organisation) for the specified contact.
add	For internal use only - Add Contact by ID
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
addContact4	For internal use only - Add a New Contact
addContactNew	For internal use only - Add a New Contact
archive	For internal use only - This flowcode is responsible for accepting one or more contactIds and changing their status from active to archived
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
get	For internal use only - Get Contact by ID
getList	For internal use only - Get a list of contacts
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
unArchive	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.
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.
update	For internal use only - Update Contact
updateContact	DEPRECATED (Use updateContactNew)
updateContact3	For internal use only - Update Contact
updateContact4	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
duplicateAttachments	Attach a file to the Contract
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.

CoworkerLifecycle

There are no operations or events defined for the 'CoworkerLifecycle' 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.

Imports

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

ImportsHistory

There are no operations or events defined for the 'ImportsHistory' 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
add	For internal use only - Add 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.
get	For internal use only - Get Organisation by ID
getList	For internal use only - Get filtered and paged list of organisations
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.
update	For internal use only - Update Organisation by ID

OrgMembers

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

Pages

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

Operation	Description
add	- PROTOTYPE - Adds a Page - the page will be added as draft
addUserType	- PROTOTYPE - Adds a new user type version to a Page - the page will be added as draft
get	- PROTOTYPE - Returns Page details. Even if page does not exist, it will still return canEdit based on the slug and user context
publish	- PROTOTYPE - Publishes a draft Page to be Public
retire	- PROTOTYPE - Retires a Page - Refers to a piblic page. It also removes draft version of the page
retireUserType	- PROTOTYPE - Retires a page based on a user type. Sets public to retire state (2) and deleted other states (draft and retire).
revert	- PROTOTYPE - Reverts the draft version of the Page. Removes the Draft Version.
rollback	- PROTOTYPE - Rolls back the draft version of the Page. Removes the Draft Version.
set	- PROTOTYPE - Inserts or Updates a Page
update	- PROTOTYPE - Updates a Page as Draft. If the draft version does not exist, it will duplicate the Public one

PageVersionLangs

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

PageVersions

There are no operations or events defined for the 'PageVersions' 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.

SiSInventoryComputer

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

SiSInventoryComputerSoftware

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

SiSInventoryList

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

SiSInventoryListComputer

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

SiSJob

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

SiSPackage

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

Operation	Description
baselinePackage	baseline a package

SiSPublishedPackage

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

Operation	Description
revertBaselinePackage	take a baselined package and revert it to draf

Site

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

Operation	Description
getNearby	This operation is responsible for returning the nearby Sites of a specificed Site by its ID
getSiteById	This operation is responsible for returning the Site Details of a specificed Site by its ID
getSiteUsers	This operation is responsible for returning the Site Users of a specificed Site by its ID
getSites	This operation is responsible for returning the either a number of, or all the Sites available, with option of filtering down the results
update	This operation is responsible for updating the Custom fields of a specified Site

SiteMembers

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

Operation	Description
add	This operation is responsible for adding a member to a specificed Site by its ID
delete	This operation is responsible for removing a user as a Site Member against a Site
get	This operation is responsible for returning the Site Members of a specificed Site by its ID

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
entityAttachGetInfo	Get access to file attachments for this entity
getAttachments	View the attachments for 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.

TaskTemplate

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

Operation	Description
add	Adding new template
get	Return template
remove	Remove template
update	Updating template

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
adminAssignUsersToGroupbyGroupAndRole	global	assign users to group by group and or role
adminAssignUsersToRolebyGroupAndRole	global	assign users to a role by group and or other role
adminBpmAddTemplate	global	add a bpm template
adminBpmDeleteTemplate	global	delete a template
adminBpmFindProcessesByPropertyText	global	add a bpm template
adminBpmGetLiveInstance	global	Get live instance record
adminBpmGetTemplate	global	get bpm template record
adminBpmGetTemplatesForList	global	get bpm templates for app returing just id, name, type and grouping
adminBpmGetTemplatesTable	global	Get BPM templates for a given app
adminBpmUpdateLiveInstance	global	Update live instance record
adminDatabaseListCreateRecord	global	create record in h_sys_dblists
adminDatabaseListDeleteRecord	global	deleterecord in h_sys_dblists
adminDatabaseListGetListValues	global	Get db list and then get list values for it
adminDatabaseListUpdateRecord	global	create record in h_sys_dblists
adminGetSetting	global	For internal use only - Used to read system settings for views that dont need manage sys settings role
adminInitaliseData	global	Used by the Admin App to get all the initial data need on first lost.
adminInitialiseData	global	Used by the Admin App to get all the initial data need on first lost.
adminTermsAndConditionsSet	global	For internal use only - Used to get email list (Paged) and count of emails
appCoreInitaliseData	local	Returns the current active timer value for my session
coreHomeInitialiseData	global	Calls all applications and requests slides and home data
coreInitaliseData	global	For internal use only - Used by the Core Web App to get all the initial data need on first lost.
coreInitialiseData	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
getConversations	global	This is the description text for this flowcode operation
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
getLoginConfig	global	Load extra settings for SAML
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.
guestTermsAndConditionsGet	global	For internal use only - Used to get email list (Paged) and count of emails
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.
test_contact_module	global	For internal use only - test contact module
test_entity_module	global	For internal use only - test entity module
test_xmlmc_module	global	For internal use only - test xmlmc module
timeSlcGet	global	Elevated flowcode to get access to time:slcGet from guest level
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
webrtc_answer	global	respond to a webrtc request
webrtc_getIceServer	global	Get ICE server configuration
webrtc_hangup	global	Message sent when a user hangs up or rejects a call to let other users know this
webrtc_joincall	global	join call and get list of users to initiate connection with
webrtc_offer	global	starts a webrtc call
webrtc_setIceCandidate	global	Send an ICE Candidate to the specified user
webrtc_startcall	global	Creates a peer 2 peer video (or other webrtc) call

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