Table of Contents

Summary

This context Command sets a value for the property specified by name on the opportunity which can be used with the click event for Summary and Field Tags as well as in Andi Chat.

All that is required to use the command is the property name to change and the value to be set. For example if the skill needed to add some notes to the opportunity then the property name would be notes and the property value would the the text of the note.

const propertyName: string = "notes";
const propertyValue: string: = `This is A VIP Opportunity.
This is a multi line note about the opportunity.
This demonstrates writing a note
`;

const command: contextCommand = {
  name: "setPropertyOnOpportunity",
  args: [propertyName, propertyValue]
  };

 const tag: SummaryTag = {
  key: "sample-tag",
  text: "Sample Tag",
  tagType: FieldTagTypes.Info,
  onClick: [command]
};          

Command properties names can also reference child objects and properties using dot notation when available as well array items. The array functions supported are the same as those for Context queries which include index number like scenarios.0.scenarioType this references the first scenarios scenario type. By replacing the 0 to another positive integer it is possible to reference other scenario if application. In addition to the index option the last option is also support. Using the previous example the 0 is replaced with last, scenarios.last.scenarioType.

For Advance usage with findby check out this tutorial.

Commands have more restrictions then context queries which include that the values being passed in or of correct type, format and length in cases of Strings. Formatting around properties like dates will be based on the locale of the application user and needs to be considered. Also in certain circumstances a property may not be settable 100% of the time. While selecting properties from the list below consult the table for further details.

Back to the top

Field List

Field Name: clientAnnualRevenue
Attribute Description
Type Nullable Number (or Locale Formatted Currency String)
Max Length N/A
Readonly Restriction N/A

Field Name: clientAnnualRevenue
Attribute Description
Type Nullable Number (or Locale Formatted Currency String)
Max Length N/A
Readonly Restriction N/A

Field Name: closeDate
Attribute Description
Type Date String (Locale formatted)
Max Length N/A
Readonly Restriction If given value is owned by and external system it will be not settable

Field Name: description
Attribute Description
Type String (Multi Line)
Max Length N/A
Readonly Restriction N/A

Field Name: name
Attribute Description
Type String
Max Length 250
Readonly Restriction If given value is owned by and external system it will be not settable

Field Name: name
Attribute Description
Type String
Max Length 255
Readonly Restriction N/A

Field Name: notes
Attribute Description
Type String (Multi Line)
Max Length 6000
Readonly Restriction N/A

Field Name: obligorId
Attribute Description
Type Text
Max Length 150
Readonly Restriction N/A

Field Name: obligorId
Attribute Description
Type Text
Max Length 150
Readonly Restriction N/A

Field Name: pricingDate
Attribute Description
Type Date String (Locale formatted)
Max Length N/A
Readonly Restriction N/A

Field Name: scenarioType
Attribute Description
Type String
Max Length N/A
Readonly Restriction N/A

Field Name: scenarios[scenario].commercialLoanAccounts[commercialLoanAccount].cap
Attribute Description
Type Nullable Number or String (decimal value number or string supporting bps i.e. `.05bps` or % like `0.05%`
Max Length N/A
Readonly Restriction N/A

Field Name: scenarios[scenario].commercialLoanAccounts[commercialLoanAccount].cashFlows[cashFlowCollection].paymentDate
Attribute Description
Type Date String (Locale formatted)
Max Length N/A
Readonly Restriction N/A

Field Name: scenarios[scenario].commercialLoanAccounts[commercialLoanAccount].collateralLTV
Attribute Description
Type Number (decimal value Locale Formatted)
Max Length N/A
Readonly Restriction N/A

Field Name: scenarios[scenario].commercialLoanAccounts[commercialLoanAccount].collateralValue
Attribute Description
Type Number (or Locale Formatted Currency String)
Max Length N/A
Readonly Restriction N/A

Field Name: scenarios[scenario].commercialLoanAccounts[commercialLoanAccount].description
Attribute Description
Type Text
Max Length 50
Readonly Restriction N/A

Field Name: scenarios[scenario].commercialLoanAccounts[commercialLoanAccount].effectiveLTV
Attribute Description
Type Number (decimal value Locale Formatted)
Max Length N/A
Readonly Restriction N/A

Field Name: scenarios[scenario].commercialLoanAccounts[commercialLoanAccount].effectiveValue
Attribute Description
Type Number (or Locale Formatted Currency String)
Max Length N/A
Readonly Restriction N/A

Field Name: scenarios[scenario].commercialLoanAccounts[commercialLoanAccount].endMonthOffset
Attribute Description
Type Number (Integer)
Max Length N/A
Readonly Restriction N/A

Field Name: scenarios[scenario].commercialLoanAccounts[commercialLoanAccount].floor
Attribute Description
Type Nullable Number or String (decimal value number or string supporting bps i.e. `.05bps` or % like `0.05%`
Max Length N/A
Readonly Restriction N/A

Field Name: scenarios[scenario].commercialLoanAccounts[commercialLoanAccount].guaranteedAmount
Attribute Description
Type Number (or Locale Formatted Currency String)
Max Length N/A
Readonly Restriction N/A

Field Name: scenarios[scenario].commercialLoanAccounts[commercialLoanAccount].guaranteedExposure
Attribute Description
Type Number (decimal value Locale Formatted)
Max Length N/A
Readonly Restriction N/A

Field Name: scenarios[scenario].commercialLoanAccounts[commercialLoanAccount].guaranteedPercent
Attribute Description
Type Number (decimal value Locale Formatted)
Max Length N/A
Readonly Restriction N/A

Field Name: scenarios[scenario].commercialLoanAccounts[commercialLoanAccount].loanFacilityRatingField
Attribute Description
Type Text
Max Length N/A
Readonly Restriction N/A

Field Name: scenarios[scenario].commercialLoanAccounts[commercialLoanAccount].loanToValuePercent
Attribute Description
Type Nullable Number or String (decimal value number or string supporting bps i.e. `.05bps` or % like `0.05%`
Max Length N/A
Readonly Restriction N/A

Field Name: scenarios[scenario].commercialLoanAccounts[commercialLoanAccount].month
Attribute Description
Type Number (Integer)
Max Length N/A
Readonly Restriction N/A

Field Name: scenarios[scenario].commercialLoanAccounts[commercialLoanAccount].month
Attribute Description
Type Number (Integer)
Max Length N/A
Readonly Restriction N/A

Field Name: scenarios[scenario].commercialLoanAccounts[commercialLoanAccount].priorLiens
Attribute Description
Type Number (or Locale Formatted Currency String)
Max Length N/A
Readonly Restriction N/A

Field Name: scenarios[scenario].commercialLoanAccounts[commercialLoanAccount].rate
Attribute Description
Type Number (decimal value Locale Formatted)
Max Length N/A
Readonly Restriction N/A

Field Name: scenarios[scenario].commercialLoanAccounts[commercialLoanAccount].spread
Attribute Description
Type Number (decimal value Locale Formatted)
Max Length N/A
Readonly Restriction N/A

Field Name: scenarios[scenario].masterCommitmentLoanAccounts[masterCommitmentLoanAccount].available
Attribute Description
Type Number (decimal value Locale Formatted)
Max Length N/A
Readonly Restriction N/A

Field Name: scenarios[scenario].masterCommitmentLoanAccounts[masterCommitmentLoanAccount].collateralLTV
Attribute Description
Type Number (decimal value Locale Formatted)
Max Length N/A
Readonly Restriction N/A

Field Name: scenarios[scenario].masterCommitmentLoanAccounts[masterCommitmentLoanAccount].collateralValue
Attribute Description
Type Number (or Locale Formatted Currency String)
Max Length N/A
Readonly Restriction N/A

Field Name: scenarios[scenario].masterCommitmentLoanAccounts[masterCommitmentLoanAccount].commercialLoanAccounts[commercialLoanAccount].cap
Attribute Description
Type Nullable Number or String (decimal value number or string supporting bps i.e. `.05bps` or % like `0.05%`
Max Length N/A
Readonly Restriction N/A

Field Name: scenarios[scenario].masterCommitmentLoanAccounts[masterCommitmentLoanAccount].commercialLoanAccounts[commercialLoanAccount].cashFlows[cashFlowCollection].paymentDate
Attribute Description
Type Date String (Locale formatted)
Max Length N/A
Readonly Restriction N/A

Field Name: scenarios[scenario].masterCommitmentLoanAccounts[masterCommitmentLoanAccount].commercialLoanAccounts[commercialLoanAccount].collateralLTV
Attribute Description
Type Number (decimal value Locale Formatted)
Max Length N/A
Readonly Restriction N/A

Field Name: scenarios[scenario].masterCommitmentLoanAccounts[masterCommitmentLoanAccount].commercialLoanAccounts[commercialLoanAccount].collateralValue
Attribute Description
Type Number (or Locale Formatted Currency String)
Max Length N/A
Readonly Restriction N/A

Field Name: scenarios[scenario].masterCommitmentLoanAccounts[masterCommitmentLoanAccount].commercialLoanAccounts[commercialLoanAccount].description
Attribute Description
Type Text
Max Length 50
Readonly Restriction N/A

Field Name: scenarios[scenario].masterCommitmentLoanAccounts[masterCommitmentLoanAccount].commercialLoanAccounts[commercialLoanAccount].effectiveLTV
Attribute Description
Type Number (decimal value Locale Formatted)
Max Length N/A
Readonly Restriction N/A

Field Name: scenarios[scenario].masterCommitmentLoanAccounts[masterCommitmentLoanAccount].commercialLoanAccounts[commercialLoanAccount].effectiveValue
Attribute Description
Type Number (or Locale Formatted Currency String)
Max Length N/A
Readonly Restriction N/A

Field Name: scenarios[scenario].masterCommitmentLoanAccounts[masterCommitmentLoanAccount].commercialLoanAccounts[commercialLoanAccount].endMonthOffset
Attribute Description
Type Number (Integer)
Max Length N/A
Readonly Restriction N/A

Field Name: scenarios[scenario].masterCommitmentLoanAccounts[masterCommitmentLoanAccount].commercialLoanAccounts[commercialLoanAccount].floor
Attribute Description
Type Nullable Number or String (decimal value number or string supporting bps i.e. `.05bps` or % like `0.05%`
Max Length N/A
Readonly Restriction N/A

Field Name: scenarios[scenario].masterCommitmentLoanAccounts[masterCommitmentLoanAccount].commercialLoanAccounts[commercialLoanAccount].guaranteedAmount
Attribute Description
Type Number (or Locale Formatted Currency String)
Max Length N/A
Readonly Restriction N/A

Field Name: scenarios[scenario].masterCommitmentLoanAccounts[masterCommitmentLoanAccount].commercialLoanAccounts[commercialLoanAccount].guaranteedExposure
Attribute Description
Type Number (decimal value Locale Formatted)
Max Length N/A
Readonly Restriction N/A

Field Name: scenarios[scenario].masterCommitmentLoanAccounts[masterCommitmentLoanAccount].commercialLoanAccounts[commercialLoanAccount].guaranteedPercent
Attribute Description
Type Number (decimal value Locale Formatted)
Max Length N/A
Readonly Restriction N/A

Field Name: scenarios[scenario].masterCommitmentLoanAccounts[masterCommitmentLoanAccount].commercialLoanAccounts[commercialLoanAccount].loanFacilityRatingField
Attribute Description
Type Text
Max Length N/A
Readonly Restriction N/A

Field Name: scenarios[scenario].masterCommitmentLoanAccounts[masterCommitmentLoanAccount].commercialLoanAccounts[commercialLoanAccount].loanToValuePercent
Attribute Description
Type Nullable Number or String (decimal value number or string supporting bps i.e. `.05bps` or % like `0.05%`
Max Length N/A
Readonly Restriction N/A

Field Name: scenarios[scenario].masterCommitmentLoanAccounts[masterCommitmentLoanAccount].commercialLoanAccounts[commercialLoanAccount].month
Attribute Description
Type Number (Integer)
Max Length N/A
Readonly Restriction N/A

Field Name: scenarios[scenario].masterCommitmentLoanAccounts[masterCommitmentLoanAccount].commercialLoanAccounts[commercialLoanAccount].month
Attribute Description
Type Number (Integer)
Max Length N/A
Readonly Restriction N/A

Field Name: scenarios[scenario].masterCommitmentLoanAccounts[masterCommitmentLoanAccount].commercialLoanAccounts[commercialLoanAccount].priorLiens
Attribute Description
Type Number (or Locale Formatted Currency String)
Max Length N/A
Readonly Restriction N/A

Field Name: scenarios[scenario].masterCommitmentLoanAccounts[masterCommitmentLoanAccount].commercialLoanAccounts[commercialLoanAccount].rate
Attribute Description
Type Number (decimal value Locale Formatted)
Max Length N/A
Readonly Restriction N/A

Field Name: scenarios[scenario].masterCommitmentLoanAccounts[masterCommitmentLoanAccount].commercialLoanAccounts[commercialLoanAccount].spread
Attribute Description
Type Number (decimal value Locale Formatted)
Max Length N/A
Readonly Restriction N/A

Field Name: scenarios[scenario].masterCommitmentLoanAccounts[masterCommitmentLoanAccount].commitment
Attribute Description
Type Number (decimal value Locale Formatted)
Max Length N/A
Readonly Restriction N/A

Field Name: scenarios[scenario].masterCommitmentLoanAccounts[masterCommitmentLoanAccount].description
Attribute Description
Type Text
Max Length 50
Readonly Restriction N/A

Field Name: scenarios[scenario].masterCommitmentLoanAccounts[masterCommitmentLoanAccount].effectiveLTV
Attribute Description
Type Number (decimal value Locale Formatted)
Max Length N/A
Readonly Restriction N/A

Field Name: scenarios[scenario].masterCommitmentLoanAccounts[masterCommitmentLoanAccount].effectiveValue
Attribute Description
Type Number (or Locale Formatted Currency String)
Max Length N/A
Readonly Restriction N/A

Field Name: scenarios[scenario].masterCommitmentLoanAccounts[masterCommitmentLoanAccount].guaranteedAmount
Attribute Description
Type Number (or Locale Formatted Currency String)
Max Length N/A
Readonly Restriction N/A

Field Name: scenarios[scenario].masterCommitmentLoanAccounts[masterCommitmentLoanAccount].guaranteedExposure
Attribute Description
Type Number (decimal value Locale Formatted)
Max Length N/A
Readonly Restriction N/A

Field Name: scenarios[scenario].masterCommitmentLoanAccounts[masterCommitmentLoanAccount].guaranteedPercent
Attribute Description
Type Number (decimal value Locale Formatted)
Max Length N/A
Readonly Restriction N/A

Field Name: scenarios[scenario].masterCommitmentLoanAccounts[masterCommitmentLoanAccount].month
Attribute Description
Type Number (Integer)
Max Length N/A
Readonly Restriction N/A

Field Name: scenarios[scenario].masterCommitmentLoanAccounts[masterCommitmentLoanAccount].priorLiens
Attribute Description
Type Number (or Locale Formatted Currency String)
Max Length N/A
Readonly Restriction N/A

Field Name: scenarios[scenario].masterCommitmentLoanAccounts[masterCommitmentLoanAccount].utilization
Attribute Description
Type Number (decimal value Locale Formatted)
Max Length N/A
Readonly Restriction N/A

Field Name: scenarios[scenario].otherAccounts[otherAccount].economicCapital
Attribute Description
Type Number (or Locale Formatted Currency String)
Max Length N/A
Readonly Restriction N/A

Field Name: scenarios[scenario].otherAccounts[otherAccount].estimatedUnits
Attribute Description
Type Number (Integer)
Max Length N/A
Readonly Restriction N/A

Field Name: scenarios[scenario].otherAccounts[otherAccount].monthlyExpense
Attribute Description
Type Number (or Locale Formatted Currency String)
Max Length N/A
Readonly Restriction N/A

Field Name: scenarios[scenario].otherAccounts[otherAccount].monthlyRevenue
Attribute Description
Type Number (or Locale Formatted Currency String)
Max Length N/A
Readonly Restriction N/A

Field Name: scenarios[scenario].otherAccounts[otherAccount].projectedRevenue
Attribute Description
Type Number (or Locale Formatted Currency String)
Max Length N/A
Readonly Restriction N/A

Field Name: scenarios[scenario].otherAccounts[otherAccount].regulatoryCapital
Attribute Description
Type Number (or Locale Formatted Currency String)
Max Length N/A
Readonly Restriction N/A

Field Name: scenarios[scenario].otherAccounts[otherAccount].unitPrice
Attribute Description
Type Number (or Locale Formatted Currency String)
Max Length N/A
Readonly Restriction N/A

Field Name: scenarios[scenario].otherAccounts[otherAccount].waivedUnits
Attribute Description
Type Number (Integer)
Max Length N/A
Readonly Restriction N/A

Field Name: stage
Attribute Description
Type Text
Max Length N/A
Readonly Restriction If given value is owned by and external system it will be not settable

Field Name: totalRelationshipExposure
Attribute Description
Type Nullable Number (or Locale Formatted Currency String)
Max Length N/A
Readonly Restriction N/A

Field Name: totalRelationshipExposure
Attribute Description
Type Nullable Number (or Locale Formatted Currency String)
Max Length N/A
Readonly Restriction N/A

Field Name: totalRelationshipOutstanding
Attribute Description
Type Nullable Number (or Locale Formatted Currency String)
Max Length N/A
Readonly Restriction N/A

Field Name: totalRelationshipOutstanding
Attribute Description
Type Nullable Number (or Locale Formatted Currency String)
Max Length N/A
Readonly Restriction N/A

Back to the top