Process Class - quandis/qbo3-Documentation GitHub Wiki

The Process module's Process table is based on the MISMO data dictionary standard.

Process properties

Column	Type	Required	Description
Active	string
ActiveStatus	string
ActiveWorkflow	string
AssignedOrganizationID	integer		Third-party vendor managing the process.
AssignedPersonID	integer		User responsible for managing the process.
Batch	integer
BecamePastStandard	string
CanDelete	string
CanInsert	string
CanUpdate	string
ClientID	integer		Organization key pointing to the client paying for the process.
ClientPersonID	integer		User responsible for managing the process for vendor.
Closed	string
ClosedReason	string		Reason the process was closed. This is enumerated in the ObjectType table, managed by power users.
CostLedgerID	integer		Ledger key used to track running costs associated with the process.
CreatedDate	dateTime
CreatedPersonID	integer
CurrentDecisionID	integer		Decision (Workflow) key used to track the currently running workflow for the process.
DateClosed	dateTime		Date the process was closed.
DateDue	dateTime		Date the process is due.
DateOpened	dateTime		Date and time the process was opened.
DecisionStep	string
DecisionTemplate	string
Entity	string
EntityParent	string
ExcludePendingSteps	string
Extranet	string
FinalStatus	string
Form	string
InDecisionID	string
InImportFileID	string
LinkedFrom	string
LinkedTo	string
LitigationDelays	string
LoanState	string
MetaXml	string		Deprecated
NonCompliant	string
NotLinkedFrom	string
NotLinkedTo	string
Object	string
ObjectID	integer
Open	string
OpenAsOf	string
OpenedReason	string		Reason the process was opened. This is enumerated in the ObjectType table, managed by power users.
OtherDelays	string
PastStandardInflow	string
PastStandardOutflow	string
Priority	integer		User-defined enumeration intended to reflect the importance of a Process when compared to other processes. E.g. let managers manage high-priority processes first.
Process	string	yes	Label for the table.
ProcessID	integer	yes	Identity column and primary key for the table.
ProcessSiblingList	string
ProcessTemplateID	integer		Template that drives the behavior of a Process.
ProcessType	string		Enumerated values; set by power user in ObjectType table.
PropertyState	string
ServicerID	string
Sibling	string		If the process is created by a derived class, Sibling will contain the name of the table of the derived class.
SiblingID	integer		If the process is created by a derived class, Sibling will contain the identity column matching the row of the derived class.
SourceXml	string		Deprecated
State	string
Status	string
Step	string
StepExists	string
Tags	string
TimeSpan	string
UnreadNotifications	string
UpdatedDate	dateTime
UpdatedPersonID	integer
VendorID	integer		Organization key pointing to the Vendor paying for the process.
VendorPersonID	integer		User responsible for managing the process for vendor.
ViewAsRole	string
Worklist	string

Related modules

Related Objects	Module	Relationship
Access		Child
AssignedOrganization	qbo.Contact.OrganizationObject	Foreign Key
AssignedPerson	qbo.Security.PersonObject	Foreign Key
Attachments	Attachment	Child
Client	qbo.Contact.OrganizationObject	Foreign Key
ClientPerson	qbo.Security.PersonObject	Foreign Key
Collections	CollectionMember	Child
ConfigurationEntryCollection	ConfigurationEntry	Child
Contacts	Contact	Child
CostLedger	qbo.Accounting.LedgerObject	Foreign Key
CurrentDecision	qbo.Decision.DecisionObject	Foreign Key
Decisions	Decision	Child
Delays	DecisionDelay	Child
Forms	ImportForm	Child
Labels	CollectionMember	Child
Ledgers	Ledger	Child
Messages	Message	Child
ProcessTemplate	qbo.Process.ProcessTemplateObject	Foreign Key
Regions	Geography	Child
Scores	Score	Child
SearchIndexes	SearchIndex	Child
Vendor	qbo.Contact.OrganizationObject	Foreign Key
VendorPerson	qbo.Security.PersonObject	Foreign Key
Worklists	SmartWorklistMember	Child

Method signatures

`Process/Process.ashx/Search?{Parameters}`

The search method will return all records matching the {Parameters} criteria. For searches, {Parameters} may include any property listed in the table above. The following standard optional parameters also apply:

Output: determines the formatting of the returned data. Valid values are Xml, Json, JsonP. If omitted, XHTML is returns based on the Process.Search.xslt template.
DisplaySize: determines the maximum number of rows returned. Default is 25. DisplaySize=0 will return all matching rows.
RecordStart: the starting record to return; defaults to 0. Used for pagination.
OrderBy: a series of properties to order by.
Request: Process.ashx/Search?Process=ABC123
Response:

<ProcessCollection>
  <ProcessItem>
    <ProcessID>1831</ProcessID>
    <Process>#b94-232323</Process>
    <ProcessTemplateID>1</ProcessTemplateID>
    <Sibling>Foreclosure</Sibling>
    <SiblingID>1260</SiblingID>
    <ProcessType>Judicial</ProcessType>
    <Priority>
    </Priority>
    <AssignedOrganizationID>8479</AssignedOrganizationID>
    <AssignedPersonID>
    </AssignedPersonID>
    <VendorID>
    </VendorID>
    <VendorPersonID>
    </VendorPersonID>
    <DateOpened>2013-04-10T00:00:00-07:00</DateOpened>
    <OpenedReason>
    </OpenedReason>
    <DateClosed>
    </DateClosed>
    <ClosedReason>
    </ClosedReason>
    <DateDue>
    </DateDue>
    <CostLedgerID>369</CostLedgerID>
    <CurrentDecisionID>305</CurrentDecisionID>
    <SourceXml>
    </SourceXml>
    <MetaXml>
    </MetaXml>
    <ClientID>
    </ClientID>
    <ClientPersonID>
    </ClientPersonID>
    <Object>Loan</Object>
    <ObjectID>730202</ObjectID>
    <Status>Open</Status>
    <CreatedPersonID>465</CreatedPersonID>
    <CreatedDate>2013-04-10T05:38:30.773-07:00</CreatedDate>
    <UpdatedPersonID>1</UpdatedPersonID>
    <UpdatedDate>2013-04-24T09:15:04.963-07:00</UpdatedDate>
    <ProcessTemplate>Foreclosure</ProcessTemplate>
    <AssignedOrganization>Feiwell & Hannoy, PC</AssignedOrganization>
    <AssignedPerson>
    </AssignedPerson>
    <Vendor>
    </Vendor>
    <VendorPerson>
    </VendorPerson>
    <CostLedger>Total Debt</CostLedger>
    <CurrentDecision>Freddie IN Judicial Foreclosure</CurrentDecision>
    <Client>
    </Client>
    <ClientPerson>
    </ClientPerson>
    <CreatedPerson>[email protected]</CreatedPerson>
    <UpdatedPerson>DEPRECATED - Administrator</UpdatedPerson>
    <RecordCount>500</RecordCount>
  </ProcessItem>
  <ProcessItem>
    <ProcessID>1661</ProcessID>
    <Process>
      <<Auto>>
    </Process>
    <ProcessTemplateID>108</ProcessTemplateID>
    <Sibling>BidAtSale</Sibling>
    <SiblingID>33</SiblingID>
    <ProcessType>
    </ProcessType>
    <Priority>
    </Priority>
    <AssignedOrganizationID>
    </AssignedOrganizationID>
    <AssignedPersonID>
    </AssignedPersonID>
    <VendorID>
    </VendorID>
    <VendorPersonID>
    </VendorPersonID>
    <DateOpened>
    </DateOpened>
    <OpenedReason>
    </OpenedReason>
    <DateClosed>
    </DateClosed>
    <ClosedReason>
    </ClosedReason>
    <DateDue>
    </DateDue>
    <CostLedgerID>231</CostLedgerID>
    <CurrentDecisionID>
    </CurrentDecisionID>
    <SourceXml>
    </SourceXml>
    <MetaXml>
    </MetaXml>
    <ClientID>
    </ClientID>
    <ClientPersonID>
    </ClientPersonID>
    <Object>Loan</Object>
    <ObjectID>123</ObjectID>
    <Status>
    </Status>
    <CreatedPersonID>1</CreatedPersonID>
    <CreatedDate>2013-01-16T13:37:09.203-08:00</CreatedDate>
    <UpdatedPersonID>1</UpdatedPersonID>
    <UpdatedDate>2013-01-16T13:37:09.423-08:00</UpdatedDate>
    <ProcessTemplate>Bid At Sale</ProcessTemplate>
    <AssignedOrganization>
    </AssignedOrganization>
    <AssignedPerson>
    </AssignedPerson>
    <Vendor>
    </Vendor>
    <VendorPerson>
    </VendorPerson>
    <CostLedger>Bid</CostLedger>
    <CurrentDecision>
    </CurrentDecision>
    <Client>
    </Client>
    <ClientPerson>
    </ClientPerson>
    <CreatedPerson>DEPRECATED - Administrator</CreatedPerson>
    <UpdatedPerson>DEPRECATED - Administrator</UpdatedPerson>
    <RecordCount>500</RecordCount>
  </ProcessItem>
</ProcessCollection>

`Process/Process.ashx/Save?{Parameters}`

The save method will return all records matching the {Parameters} criteria. {Parameters} may include any property listed in the table above along with child classes.

Output: determines the formatting of the returned data. Valid values are Xml, Json, JsonP.
Response: included in the response is {Table}ID; this is the primary key of the {Table} row created
With the same Save method, you can also save data to related tables. By using a {Parent}_{Column} pattern, you can update the parent table's data in the same call.
Child records may also be updated using a {Child}_{Index}_{Column} pattern.
For child records that are templated, you may use the template name in lieu of an index.

`Process/Process.ashx/Delete?ID={Where.IdList}`

The delete method will delete all records where ID={comma-delimited list of identifiers} criteria.

`Process/Process.ashx/ListWhere?{Parameters}`

The ListWhere method will return all records matching the {Parameters} criteria. {Parameters} may include any property listed in the table.

Output: determines the formatting of the returned data. Valid values are Xml, Json, JsonP.
Response: 2 columns are returned - {Table}ID and {Table} columns.
Request: Process.ashx/ListWhere?ProcessID=1,2,3
Response:

This XML file does not appear to have any style information associated with it. The document tree is shown below.
<ProcessCollection>
  <ProcessItem>
    <ProcessID>299</ProcessID>
    <Process>ForeclosureID: 142</Process>
  </ProcessItem>
  <ProcessItem>
    <ProcessID>1647</ProcessID>
    <Process>ForeclosureID: 166</Process>
  </ProcessItem>
  <ProcessItem>
    <ProcessID>1645</ProcessID>
    <Process>ForeclosureID: 742</Process>
  </ProcessItem>
</ProcessCollection>

Process Class - quandis/qbo3-Documentation GitHub Wiki

Process properties

Related modules

Method signatures

Process/Process.ashx/Search?{Parameters}

Process/Process.ashx/Save?{Parameters}

Process/Process.ashx/Delete?ID={Where.IdList}

Process/Process.ashx/ListWhere?{Parameters}

⚠️ **GitHub.com Fallback** ⚠️

`Process/Process.ashx/Search?{Parameters}`

`Process/Process.ashx/Save?{Parameters}`

`Process/Process.ashx/Delete?ID={Where.IdList}`

`Process/Process.ashx/ListWhere?{Parameters}`

⚠️ GitHub.com Fallback ⚠️