Application - com.hornbill.pricingcalculator


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.

BulkMessages

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

Operation Description
SendMessage Send Message Operation

BulkMessagesRecipients

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

CreditNotes

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

CreditNotesAdjustments

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

Currencies

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

CustomList

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

Databases

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

Datacenters

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

GenericView

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

Operation Description
create Update a users view
delete Delete a users views
loadViews Get a list of Views for a user
update Createe a users view

Groups

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

hornbillInfraAudit

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

Operation Description
add Add New Audit Record
get Get a Hornbill Data Center
list List Audit Log

hornbillInfraCluster

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

Operation Description
add Add New Cluster
delete Delete Cluster
get Get a Hornbill Cluster
list List Clusters
update Update Cluster

hornbillInfraConfig

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

Operation Description
add Add New Credential
delete Delete Credential
update Update Credential

hornbillInfraCredential

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

Operation Description
add Add New Credential
delete Delete Credential
get Get a Hornbill Credential
update Update Credential

hornbillInfraDC

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

Operation Description
add Add New DC
delete Delete DC 1
get Get a Hornbill Data Center
list List Datacenters
update Update DC

hornbillInfraDomain

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

Operation Description
add Add New Domain
delete Delete Domain
get Get a Hornbill Domain
list List Domains
update Update Domain

hornbillInfraHost

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

Operation Description
add Add New Cluster
delete Delete Cluster
get Get a Hornbill Cluster
list List Clusters

hornbillInfraPod

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

Operation Description
add Add New POD
delete Delete Pod
get Get a Hornbill Pod
list List PODS
update Update Pod

hornbillInfraRegion

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

Operation Description
add Add New Zone
delete Delete Zone
get Get a Hornbill Region
list List Zones
update Update Domain

hornbillInfraService

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

Operation Description
add Add New Service
delete Delete Service
get Get a Hornbill Service
list List Services
update Update Service

hornbillInfraServiceRel

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

Operation Description
add Add New Service Relationship
delete Delete Service Relationship

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

Event Description
OnRecordAdded Entity system event handler when new record is added

InstanceApplicationAudit

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

InstanceAudit

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

InstanceContacts

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

InstanceContracts

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

InstanceDBServers

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

InstanceDeleteArchive

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

InstanceEmailRoutes

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

InstanceParams

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

Instances

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

Operation Description
BPMCheckProvisonedDate Triggered By BPM Event to check if provisioned date has been set and if not flagged the create instance as failed
BPMCheckStartDate Triggered By BPM Event to check if start date is met and resume the process
BPMCheckTrialEndDate Triggered By BPM Event to check if Trial End Date is met and resume the process
BPMSetProvisioned Triggered By BPM Event to set Provision Date
GetInstanceBasicDetails Get basic Instance Details
GetPartnerInstanceDetails Get Instance Details for a Partner Instance
InstanceAssociateQuote Associate an Instance with a Quote and Update the Subscription Details
InstanceChangeBillingStart Change Instance Contacts
InstanceChangeChecksum Change the licence Checksome for an instance
InstanceChangeContacts Change Instance Contacts
InstanceChangeCustomerOrg Change the Customer Organisation Associated to the Instance
InstanceChangeExcludeParam Change a Instance Configuration Param Exclusion
InstanceChangeImplementation Change Instance Implementation Data
InstanceChangeNotes Change the Instance Notes
InstanceChangeParam Change a Instance Configuration Param
InstanceChangePartner Change the Partner Associated to the Instance
InstanceChangePaymentRef Change the Payment Reference for an instance
InstanceChangeTrialtems Update Instance Trial Items
InstanceCheckStatus Run Pingcheck On Instance
InstanceClearChecksum Clearthe licence Checksome for an instance
InstanceCreate Create an Instance
InstanceDelete Allows a non subscriber instance to be deleted
InstanceGetEndpoint Get Instance Endpoint Information
InstanceGetPartnerList Get Latest Uplift Item List
InstanceHistoryPost Operation is used to track instance Update History
InstanceMarkAsDeleted Update Instance Status to 100
InstanceRename Rename the Instance - Super User Only
InstanceSetStatus Update Instance Status
InstanceSubscriptionCheck Run system::SubscriptionCheck On Instance
InstanceTechnicalUpdate Update any part of an Instance Technical Record.
InstanceUpdate Update any part of an Instance Record or Associated Subscription, the new Version and Last Update Date will be returned. The Whole instance data needs to be passed, any value not passed will be set to null.
ValidateBillingReadyState Used to Validate all details used by an activte quote are set against an instance.
addFile Attach File to Instance
getPartnerInstancesList Used by Parter Portal to Return Totals for Instances they own
getPartnerInstancesTotals Used by Parter Portal to Return Totals for Instances they own

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

Operation Description
GetInstanceDetails This is the description text for this flowcode operation
ProvisionInstance This is the description text for this flowcode operation
SetInstanceNode This operation set an Instance Node
SetStatus Operation is used to Update an Instances Status to trial
SetTrialEnd This is the description text for this flowcode operation
sendCreateNotification Send Create Notification
sendPSNotification Send Notification of Instance Creation to Product Specialists
suspendWaitForProvisionDate This flowcode operation suspends the bpm instance and waits for the date to provision the instance
suspendWaitForStartDate This flowcode operation suspends the bpm instance and waits for the date to start date of thes instance
suspendWaitForTrialEnd This flowcode operation suspends the bpm instance and waits for the date to equal the Trial End Date

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

Event Description
OnGetActivityStreamAccessToken FlowCode Entity Events

InstanceStores

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

InstanceSubscription

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

InstanceTechnical

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

InstanceTrialLineItems

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

InvoiceBillingDetails

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

InvoiceCommisions

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

InvoiceLineItems

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

InvoicePriceFixes

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

Invoices

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

Operation Description
cancelInvoice Cancel Invoice
changeInvoiceId Update Invoice ID and any associated data
markAsPaid Mark a pending invoice as paid

InvoiceVouchers

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

Nodes

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

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.

PartnerBilling

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

PartnerContacts

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

Operation Description
inviteContact Invite Contact to use Partner Portal

PartnerContracts

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

PartnerCurrency

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

PartnerDeals

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

Operation Description
createContactPartnerDeal Create New Deal
getContactPartnerDeal Returns the Parter deal associated with the currently logged in contact
getContactPartnerDeals Returns the Parter details associated with the currently logged in contact
updateContactPartnerDeal Create New Deal

PartnerDetails

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

Partners

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

Operation Description
assignToDeal Operation used to assign a partner to a deal
associateContact Assocaite an array of Contacts to a Partner
createPartner Create a New Partner and Associate relivent Version details
generateBaseLine Generate New Partner Version Based on the Current Version 0
getContactHomeData Returns the Parter details associated with the currently logged in contact
getContactPartner Returns the Parter details associated with the currently logged in contact
getContactPartnerData Returns the Parter details associated with the currently logged in contact
getContactVendorList Get List of Vendors
getLatestPartnerList Get Latest Uplift Item List
getPartner Operation to return the partner primary details plus verions and assoicated uplifts.
getPartnerUplifts Operation to return the partner primary details plus verions and assoicated uplifts.

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

Event Description
OnGetActivityStreamAccessToken Return Visiblility Level

PartnerUplifts

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

ProCapCustomQuestion

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

Operation Description
add_json Add progressive capture custom questions with answers

Products

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

Operation Description
createProduct Create a New Product and Associate relivent pricing details
generateBaseLine Generate New Product Price Version Based on the Current Version 0
getLatestPartnerPriceList Get Latest Product Price List
getLatestPriceList Get Latest Product Price List
getPartnerPrice Get Price for a Product and Version
getPrice Get Price for a Product and Version

ProductVersions

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

QuoteLineItems

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

Quotes

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

Operation Description
AcceptQuote Used to Accept a Quote From a Status of Approved (2) to a status of Pending Activation (6) Only one Pending Activation quote can exist for an instance. This will validate all nessisary values for an instance are set.
ActivateQuote Used to Set a Quote from Pending Activation (6) to Active (3) - This should only be tirggered by the billing system
ApproveQuote Used to Approve a Quote that has a status of 1 for Pending.
CancelQuote Used to Approve a Quote
CheckQuote Flowcode takes a quote and returns if the line item values match each products pricing. An optional input param will force update each line item if they are wrong. This should only be used by someone who knows what they are doing.
ComposeDocument Compose Document
CreatePartnerQuote Used to Generate the correct data when you generate a quote.
CreateQuote Used to Generate the correct data when you generate a quote.
GetPartnerList Get Partner List for a Quote
GetPriceList Get Product Price List for a Quote
GetUpliftList Get Product Price List for a Quote
QuoteAssignInstance For Quotes Created against prospect data this will update the instance record.
RejectQuote Used to Approve a Quote
UpdateOpportunity Used by a Super User to set the Opportunity feild against a quote.
UpdatePipeDrive Operation is used to post Quote Information to PipeDrive
addFile Attach File to Quote
getChangeData This is the description text for this flowcode operation
getOrderData This is the description text for this flowcode operation
getPartnerQuote Get Partner Quote
getPreposalData This is the description text for this flowcode operation

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

Event Description
OnAddRecord On Add Record to Quotes Check set Expiry date based on Partner info

QuoteUplifts

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

QuoteVouchers

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

SubscriptionAdjustments

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

Transactions

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

Uplifts

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

Operation Description
createUplift Create a New Uplift
generateBaseLine Generate New Uplift Version Based on the Current Version 0
getLatestList Get Latest Uplifts List

UpliftVersions

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

Vouchers

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

Operation Description
VoucherUpdate Update Voucher properties
getInstanceVouchers This operation will return only active vouchers for an instance to be used when creating a quote

VoucherType

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

Operations

The following general operations are defined for the 'com.hornbill.pricingcalculator' 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.
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
getInstanceApplicationAuditList local Get List of Application Audits
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.
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.pricingcalculator' 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.pricingcalculator' 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.pricingcalculator' application. You can click on each event to see detailed information about that event.

Event Source Description
OnTimerEvent local Timer used to handel events

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