Decision Class - quandis/qbo3-Documentation GitHub Wiki
The Decision module's Decision table is based on the MISMO data dictionary standard.
| Column | Type | Required | Description |
|---|---|---|---|
| Active | string | ||
| ActiveStatus | string | ||
| ActualCompletion | dateTime | Completion date. Completed decisions are not eliglbe for processing. | |
| ActualStart | dateTime | Start date of the decision. | |
| AssignedOrganizationID | integer | Foreign Key to Organization table; organization responsible for the execution of the decision. | |
| AssignedPersonID | integer | Foreign Key to Person table; user responsible for the execution of the decision. | |
| Batch | integer | ||
| CanceledDate | dateTime | Date a workflow was canceled. Canceled decisions are not eliglbe for processing. | |
| CanDelete | string | ||
| CanInsert | string | ||
| CanUpdate | string | ||
| ChildDecisionID | integer | Child decision. In a looping decision, this points to a successor decision. | |
| CreatedDate | dateTime | ||
| CreatedPersonID | integer | ||
| CurrentStep | integer | Reflects the current workflow step. Deprecated. | |
| Decision | string | yes | Label for the table. |
| DecisionID | integer | yes | Identity column and primary key for the table. |
| DecisionStepTemplateID | string | ||
| DecisionTemplateID | integer | Foreign Key to DecisionTemplate table. | |
| DecisionType | string | Enumerated values; set by power user in ObjectType table. | |
| DelayCount | integer | Number of active delays. | |
| DelayDuration | integer | Total number of days delayed. | |
| Delayed | boolean | Indicates there is an active delay on a decision (e.g. it is on hold). | |
| EstimatedCompletion | dateTime | Completion date, as estimated by templates. | |
| EstimatedStart | dateTime | Start date, as defined in templates. | |
| Extranet | string | ||
| FinalStatus | string | ||
| Form | string | ||
| HasErrors | string | ||
| HasStepError | string | ||
| InDecisionID | string | ||
| InImportFileID | string | ||
| LinkedFrom | string | ||
| LinkedTo | string | ||
| NotLinkedFrom | string | ||
| NotLinkedTo | string | ||
| Object | string | ||
| ObjectID | integer | ||
| OwnerID | integer | Deprecated. | |
| ParentDecisionID | integer | Parent decision. In a looping decision, this points to a predecessor decision. | |
| ParentDecisionStepID | integer | Foreign Key to DecisionStep table. This is used to indicate a parent workflow step (e.g. this Decision is a step in a parent decision). | |
| ProjectedCompletion | dateTime | Completion date, as estimated by a user. | |
| ProjectedStart | dateTime | Start date, as estimated by a user. | |
| ServicerID | string | ||
| Status | string | ||
| Tags | string | ||
| ThisMonth | string | ||
| ThisWeek | string | ||
| Today | string | ||
| UnreadNotifications | string | ||
| UpdatedDate | dateTime | ||
| UpdatedPersonID | integer | ||
| ViewAsRole | string | ||
| Worklist | string |
| Related Objects | Module | Relationship |
|---|---|---|
| Access | Child | |
| AssignedOrganization | qbo.Contact.OrganizationObject | Foreign Key |
| AssignedPerson | qbo.Security.PersonObject | Foreign Key |
| Attachments | Attachment | Child |
| Collections | CollectionMember | Child |
| ConfigurationEntryCollection | ConfigurationEntry | Child |
| Contacts | Contact | Child |
| DecisionTemplate | qbo.Decision.DecisionTemplateObject | Foreign Key |
| Forms | ImportForm | Child |
| Labels | CollectionMember | Child |
| Ledgers | Ledger | Child |
| Messages | Message | Child |
| Owner | qbo.Security.PersonObject | Foreign Key |
| ParentDecisionStep | qbo.Decision.DecisionStepObject | Foreign Key |
| Regions | Geography | Child |
| Scores | Score | Child |
| SearchIndexes | SearchIndex | Child |
| Steps | DecisionStep | Child |
| Worklists | SmartWorklistMember | Child |
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 theDecision.Search.xslttemplate. - DisplaySize: determines the maximum number of rows returned. Default is 25.
DisplaySize=0will 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:
Decision.ashx/Search?Decision=ABC123 - Response:
<DecisionCollection>
<DecisionItem>
<DecisionID>1289</DecisionID>
<Decision>CARI Process</Decision>
<DecisionTemplateID>184</DecisionTemplateID>
<ParentDecisionStepID>
</ParentDecisionStepID>
<ChildDecisionID>
</ChildDecisionID>
<ParentDecisionID>
</ParentDecisionID>
<DecisionType>
</DecisionType>
<CurrentStep>
</CurrentStep>
<EstimatedStart>
</EstimatedStart>
<ProjectedStart>
</ProjectedStart>
<ActualStart>2013-09-11T16:26:54.51-07:00</ActualStart>
<EstimatedCompletion>
</EstimatedCompletion>
<ProjectedCompletion>
</ProjectedCompletion>
<ActualCompletion>
</ActualCompletion>
<CanceledDate>
</CanceledDate>
<Delayed>
</Delayed>
<DelayCount>
</DelayCount>
<DelayDuration>
</DelayDuration>
<AssignedOrganizationID>
</AssignedOrganizationID>
<AssignedPersonID>
</AssignedPersonID>
<OwnerID>
</OwnerID>
<Object>
</Object>
<ObjectID>
</ObjectID>
<Status>
</Status>
<CreatedPersonID>493</CreatedPersonID>
<CreatedDate>2013-09-11T16:26:53.743-07:00</CreatedDate>
<UpdatedPersonID>493</UpdatedPersonID>
<UpdatedDate>2013-09-11T16:26:56.117-07:00</UpdatedDate>
<DecisionTemplate>CARI Process</DecisionTemplate>
<ParentDecisionStep>
</ParentDecisionStep>
<ChildDecision>
</ChildDecision>
<ParentDecision>
</ParentDecision>
<AssignedOrganization>
</AssignedOrganization>
<AssignedPerson>
</AssignedPerson>
<Owner>
</Owner>
<CreatedPerson>[email protected]</CreatedPerson>
<UpdatedPerson>[email protected]</UpdatedPerson>
<RecordCount>500</RecordCount>
<ParentLabel>
</ParentLabel>
<Grandparent>
</Grandparent>
<GrandparentID>
</GrandparentID>
</DecisionItem>
<DecisionItem>
<DecisionID>1290</DecisionID>
<Decision>CARI Process</Decision>
<DecisionTemplateID>184</DecisionTemplateID>
<ParentDecisionStepID>
</ParentDecisionStepID>
<ChildDecisionID>
</ChildDecisionID>
<ParentDecisionID>
</ParentDecisionID>
<DecisionType>
</DecisionType>
<CurrentStep>
</CurrentStep>
<EstimatedStart>
</EstimatedStart>
<ProjectedStart>
</ProjectedStart>
<ActualStart>2013-09-11T16:38:39.973-07:00</ActualStart>
<EstimatedCompletion>
</EstimatedCompletion>
<ProjectedCompletion>
</ProjectedCompletion>
<ActualCompletion>2013-09-11T17:28:26.067-07:00</ActualCompletion>
<CanceledDate>
</CanceledDate>
<Delayed>
</Delayed>
<DelayCount>
</DelayCount>
<DelayDuration>
</DelayDuration>
<AssignedOrganizationID>
</AssignedOrganizationID>
<AssignedPersonID>
</AssignedPersonID>
<OwnerID>
</OwnerID>
<Object>Organization</Object>
<ObjectID>3043</ObjectID>
<Status>
</Status>
<CreatedPersonID>493</CreatedPersonID>
<CreatedDate>2013-09-11T16:38:39.973-07:00</CreatedDate>
<UpdatedPersonID>493</UpdatedPersonID>
<UpdatedDate>2013-09-11T17:28:26.1-07:00</UpdatedDate>
<DecisionTemplate>CARI Process</DecisionTemplate>
<ParentDecisionStep>
</ParentDecisionStep>
<ChildDecision>
</ChildDecision>
<ParentDecision>
</ParentDecision>
<AssignedOrganization>
</AssignedOrganization>
<AssignedPerson>
</AssignedPerson>
<Owner>
</Owner>
<CreatedPerson>[email protected]</CreatedPerson>
<UpdatedPerson>[email protected]</UpdatedPerson>
<RecordCount>500</RecordCount>
<ParentLabel>test</ParentLabel>
<Grandparent>
</Grandparent>
<GrandparentID>
</GrandparentID>
</DecisionItem>
</DecisionCollection>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.
The delete method will delete all records where ID={comma-delimited list of identifiers} criteria.
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:
Decision.ashx/ListWhere?DecisionID=1,2,3 - Response:
<DecisionCollection>
<DecisionItem>
<DecisionID>5592</DecisionID>
<Decision>Freddie CA Non Judicial Foreclosure</Decision>
</DecisionItem>
<DecisionItem>
<DecisionID>300</DecisionID>
<Decision>Motion For Relief</Decision>
</DecisionItem>
<DecisionItem>
<DecisionID>301</DecisionID>
<Decision>Motion For Relief</Decision>
</DecisionItem>
</DecisionCollection>