Related Topics
This object represents a Business Value object.
Properties
|
PROPERTY NAME |
DATA TYPE |
DESCRIPTION |
|---|---|---|
|
ID |
String |
The ID of the Business Value |
|
Name |
String |
The name of the Business Value |
|
Text |
String |
The Text of a Business Value property |
| Value | Data type specified in the data source | The Value of a Business Value property |
| Values | List object | A list object containing all of the Values returned by a Business Value |
| Number | Decimal | If a Business Value property returns a numerical value, the Number property casts the value as a decimal number. If the value isn't a number, the Number's property will return "0". |
| Numbers | Decimal | If a Business Value property returns a numerical value, Numbers property will return a list object containing all of the values, cast as decimals numbers. If the the value isn't a number, the Number's property will return "0". |
| DateTime | DateTime | If a Business Value property returns a DateTime value the DateTime property will return the value cast as a DateTime object. |
| DateTimes | List Object | If a Business Value property returns a DateTime value the DateTimes property will return a list object with all the values cast as a DateTime object. |
Methods
GetBusinessValueByName
This API will return the Business Value object specified by the Business Value's Name.
Parameters
bp: The Process Director environment.
PID: The string PartitionID of the partition in which the Business Value is located.
pName: The name of the Business Value.
Optional Parameters
pGroup: The Group Name configured for the Business Value. This is the group name specified in the Group in Value Picker property on the Business Value definition's Options tab.
Returns
object: A Business Value object.
Example
var myBV = BusinessValue.GetBusinessValueByName(bp, "PartitionID", "BVName");
Property
This API will return a specified Business Value property.
Parameters
pPropName: The string name of the Property to return.
Returns
object: A Business Value Property object.
Example
var myBV = BusinessValue.GetBusinessValueByID(bp, "BusinessValueID");
BusinessValueProperty myProp = myBV.Property("PropertyName");
string val = myProp.Value;
SetParameter
This API will set a Parameter value for a Business Value.
Parameters
pParamName: The string name of the Parameter to set.
pParamValue: The string value to set for the Parameter.
Returns
None
Example
var myBV = BusinessValue.GetBusinessValueByID(bp, "BusinessValueID");
myBV.SetParameter("ParamName", "ParamValue");
TextList
This API will return a list containing all of the Display Strings for a Business Value Property, as opposed to the Property values, those these will usually be the same. This is most often useful for filling dropdown controls that use different display and value fields.
Parameters
None
Returns
list <string>: List of Display Strings.
Example
var myBV = BusinessValue.GetBusinessValueByID(bp, "BusinessValueID");
BusinessValueProperty myProp = myBV.Property("PropertyName");
List<String> val = myProp.TextList;
Documentation Feedback and Questions
If you notice some way that this document can be improved, we're happy to hear your suggestions. Similarly, if you can't find an answer you're looking for, ask it via feedback. Simply click on the button below to provide us with your feedback or ask a question. Please remember, though, that not every issue can be addressed through documentation. So, if you have a specific technical issue with Process Director, please open a support ticket.
