Click or drag to resize

Goal Class

Target objective for a user or a team for a specified time period.
Inheritance Hierarchy
SystemObject
  Entity
    Crm.MSCrmServiceGoal

Namespace: Crm.MSCrmService
Assembly: Scripting (in Scripting.dll) Version: 1.0.0.0 (1.0.0.0)
Syntax
public class Goal : Entity, INotifyPropertyChanging, INotifyPropertyChanged

The Goal type exposes the following members.

Constructors
 NameDescription
Public methodGoal Default Constructor.
Top
Properties
 NameDescription
Public propertyActualDecimal Shows the actual value (Decimal type) achieved towards the target as of the last rolled-up date. This field appears when the metric type of the goal is Amount and the amount data type is Decimal.
Public propertyActualInteger Shows the actual value (integer) achieved towards the target as of the last rolled-up date. This field appears when the metric type of the goal is Amount or Count and the amount data type is Integer.
Public propertyActualMoney Shows the actual value (Money type) achieved towards the target as of the last rolled-up date. This field appears when the metric type of the goal is Amount and the amount data type is Money.
Public propertyActualMoney_Base Shows the actual value (money type) in base currency to track goal results against the target.
Public propertyActualString Actual Value of the goal.
Public propertyAmountDataType Data type of the amount.
Public propertyAttributes
(Inherited from Entity)
Public propertybusiness_unit_goal N:1 business_unit_goal
Public propertyComputedTargetAsOfTodayDecimal Shows the expected amount for actual value (decimal type) against the target goal.
Public propertyComputedTargetAsOfTodayInteger Shows the expected amount for actual value (integer type) against the target goal as of the current date.
Public propertyComputedTargetAsOfTodayMoney Shows the expected amount for actual value (money type) against the target goal as of the current date.
Public propertyComputedTargetAsOfTodayMoney_Base Shows the expected amount in base currency for actual value (money type) against the target goal as of the current date.
Public propertyComputedTargetAsOfTodayPercentageAchieved Shows the expected value for percentage achieved against the target goal as of the current date.
Public propertyConsiderOnlyGoalOwnersRecords Select whether only the goal owner's records, or all records, should be rolled up for goal results.
Public propertyCreatedBy Shows who created the record.
Public propertyCreatedOn Shows the date and time when the record was created. The date and time are displayed in the time zone selected in Microsoft Dynamics CRM options.
Public propertyCreatedOnBehalfBy Shows who created the record on behalf of another user.
Public propertyCustomRollupFieldDecimal Indicates a placeholder rollup field for a decimal value to track a third category of results other than actuals and in-progress results.
Public propertyCustomRollupFieldInteger Indicates a placeholder rollup field for an integer value to track a third category of results other than actuals and in-progress results.
Public propertyCustomRollupFieldMoney Indicates a placeholder rollup field for a money value to track a third category of results other than actuals and in-progress results.
Public propertyCustomRollupFieldMoney_Base Indicates a placeholder rollup field for a money value in base currency to track a third category of results other than actuals and in-progress results.
Public propertyCustomRollupFieldString Placeholder rollup field for the goal.
Public propertyDepth Depth of the goal in the tree.
Public propertyEntityImage The default image for the entity.
Public propertyEntityImage_Timestamp 
Public propertyEntityImage_URL 
Public propertyEntityImageId For internal use only.
Public propertyEntityState
(Inherited from Entity)
Public propertyExchangeRate Shows the conversion rate of the record's currency. The exchange rate is used to convert all money fields in the record from the local currency to the system's default currency.
Public propertyExtensionData
(Inherited from Entity)
Public propertyFiscalPeriod Select the fiscal period for the goal.
Public propertyFiscalYear Select the fiscal year for the goal that's being tracked.
Public propertyFormattedValues
(Inherited from Entity)
Public propertyGoal_Annotation 1:N Goal_Annotation
Public propertyGoal_AsyncOperations 1:N Goal_AsyncOperations
Public propertygoal_connections1 1:N goal_connections1
Public propertygoal_connections2 1:N goal_connections2
Public propertyGoal_DuplicateBaseRecord 1:N Goal_DuplicateBaseRecord
Public propertyGoal_DuplicateMatchingRecord 1:N Goal_DuplicateMatchingRecord
Public propertygoal_principalobjectattributeaccess 1:N goal_principalobjectattributeaccess
Public propertyGoal_ProcessSessions 1:N Goal_ProcessSessions
Public propertygoal_rollupquery_actualdecimal N:1 goal_rollupquery_actualdecimal
Public propertygoal_rollupquery_actualmoney N:1 goal_rollupquery_actualmoney
Public propertygoal_rollupquery_customdecimal N:1 goal_rollupquery_customdecimal
Public propertygoal_rollupquery_customint N:1 goal_rollupquery_customint
Public propertygoal_rollupquery_custommoney N:1 goal_rollupquery_custommoney
Public propertygoal_rollupquery_inprogressdecimal N:1 goal_rollupquery_inprogressdecimal
Public propertygoal_rollupquery_inprogressint N:1 goal_rollupquery_inprogressint
Public propertygoal_rollupquery_inprogressmoney N:1 goal_rollupquery_inprogressmoney
Public propertyGoal_SyncErrors 1:N Goal_SyncErrors
Public propertyGoalEndDate Enter the date when the goal ends.
Public propertyGoalId Unique identifier of the goal.
Public propertyGoalOwnerId Choose the user or team responsible for meeting the goal.
Public propertygoalrollupquery_actualint N:1 goalrollupquery_actualint
Public propertyGoalStartDate Enter the date and time when the period for tracking the goal begins.
Public propertyGoalWithErrorId Unique identifier of the goal that caused an error in the rollup of the goal hierarchy.
Public propertyHasLazyFileAttribute
(Inherited from Entity)
Public propertyId
(Overrides Entity.Id)
Public propertyImportSequenceNumber Sequence number of the import that created this record.
Public propertyInProgressDecimal Shows the in-progress value (decimal) against the target. This value could contribute to a goal, but is not counted yet as actual.
Public propertyInProgressInteger Shows the in-progress value (integer) against the target. This value could contribute to a goal, but is not counted yet as actual.
Public propertyInProgressMoney Shows the in-progress value (money) against the target. This value could contribute to a goal, but is not counted yet as actual.
Public propertyInProgressMoney_Base Shows the in-progress value (money) in base currency to track goal results against the target.
Public propertyInProgressString In-progress value of the goal.
Public propertyIsAmount Indicates whether the metric type is Count or Amount.
Public propertyIsFiscalPeriodGoal Select whether the goal period is a fiscal period or custom period.
Public propertyIsOverridden Select whether the system rollup fields are updated. If set to Yes, the next system rollup will not update the values of the rollup fields with the system calculated values.
Public propertyIsOverride Indicates whether the values of system rollup fields can be updated.
Public propertyItem
(Inherited from Entity)
Public propertyKeyAttributes
(Inherited from Entity)
Public propertyLastRolledupDate Shows the date and time when the goal was last rolled up. The date and time are displayed in the time zone selected in Microsoft Dynamics CRM options.
Public propertyLazyFileAttributeKey
(Inherited from Entity)
Public propertyLazyFileAttributeValue
(Inherited from Entity)
Public propertyLazyFileSizeAttributeKey
(Inherited from Entity)
Public propertyLazyFileSizeAttributeValue
(Inherited from Entity)
Public propertylk_goal_createdby N:1 lk_goal_createdby
Public propertylk_goal_createdonbehalfby N:1 lk_goal_createdonbehalfby
Public propertylk_goal_modifiedby N:1 lk_goal_modifiedby
Public propertylk_goal_modifiedonbehalfby N:1 lk_goal_modifiedonbehalfby
Public propertyLogicalName
(Inherited from Entity)
Public propertymetric_goal N:1 metric_goal
Public propertyMetricId Choose the metric for the goal. This metric determines how the goal is tracked.
Public propertyModifiedBy Shows who last updated the record.
Public propertyModifiedOn Shows the date and time when the record was last updated. The date and time are displayed in the time zone selected in Microsoft Dynamics CRM options.
Public propertyModifiedOnBehalfBy Shows who last updated the record on behalf of another user.
Public propertyOverriddenCreatedOn Date and time that the record was migrated.
Public propertyOwnerId Enter the user or team who is assigned to manage the record. This field is updated every time the record is assigned to a different user.
Public propertyOwningBusinessUnit Unique identifier for the business unit that owns the record.
Public propertyOwningTeam Unique identifier of the team who owns the goal.
Public propertyOwningUser Unique identifier for the user who owns the record.
Public propertyParentGoalId Choose a parent goal if the current goal is a child goal. This sets up a parent-child relationship for reporting and analytics.
Public propertyPercentage Shows the percentage achieved against the target goal.
Public propertyReferencedgoal_parent_goal 1:N goal_parent_goal
Public propertyReferencedGoal_RollupError_Goal 1:N Goal_RollupError_Goal
Public propertyReferencinggoal_parent_goal N:1 goal_parent_goal
Public propertyReferencingGoal_RollupError_Goal N:1 Goal_RollupError_Goal
Public propertyRelatedEntities
(Inherited from Entity)
Public propertyRollupErrorCode Error code associated with rollup.
Public propertyRollupOnlyFromChildGoals Select whether the data should be rolled up only from the child goals.
Public propertyRollUpQueryActualDecimalId Choose the query that will be used to calculate the actual data for the goal (decimal).
Public propertyRollupQueryActualIntegerId Choose the query that will be used to calculate the actual data for the goal (integer).
Public propertyRollUpQueryActualMoneyId Choose the query that will be used to calculate the actual data for the goal (money).
Public propertyRollUpQueryCustomDecimalId Choose the query that will be used to calculate data for the custom rollup field (decimal).
Public propertyRollUpQueryCustomIntegerId Choose the query that will be used to calculate data for the custom rollup field (integer).
Public propertyRollUpQueryCustomMoneyId Choose the query that will be used to calculate data for the custom rollup field (money).
Public propertyRollUpQueryInprogressDecimalId Choose the query that will be used to calculate data for the in-progress rollup field (decimal).
Public propertyRollUpQueryInprogressIntegerId Choose the query that will be used to calculate data for the in-progress rollup field (integer).
Public propertyRollUpQueryInprogressMoneyId Choose the query that will be used to calculate data for the in-progress rollup field (money).
Public propertyRowVersion
(Inherited from Entity)
Public propertyStateCode Shows whether the goal is open, completed, or canceled. Completed and canceled goals are read-only and can't be edited.
Public propertyStatusCode Select the goal's status.
Public propertyStretchTargetDecimal Select a stretch target (decimal) of the goal to define a higher or difficult level of goal than the usual ones.
Public propertyStretchTargetInteger Select the stretch target (integer) of the goal to define a higher or difficult level of goal than the usual ones.
Public propertyStretchTargetMoney Select stretch target (money) of the goal to define a higher or difficult level of goal than the usual ones.
Public propertyStretchTargetMoney_Base Shows the stretch target (money) in base currency to indicate a higher or difficult level of goal than the usual ones.
Public propertyStretchTargetString Stretch target value for all data types.
Public propertyTargetDecimal Select a goal target of the decimal type to use for tracking data that include partial numbers, such as pounds sold of a product sold by weight.
Public propertyTargetInteger Select a goal target of the integer type to use for tracking anything countable in whole numbers, such as units sold.
Public propertyTargetMoney Select a goal target (money) to track a monetary amount such as revenue from a product.
Public propertyTargetMoney_Base Shows the goal target of the money type in base currency.
Public propertyTargetString Target value of the goal.
Public propertyteam_goal N:1 team_goal
Public propertyteam_goal_goalowner N:1 team_goal_goalowner
Public propertyTimeZoneRuleVersionNumber For internal use only.
Public propertyTitle Type a title or name that describes the goal.
Public propertyTransactionCurrency_Goal N:1 TransactionCurrency_Goal
Public propertyTransactionCurrencyId Choose the local currency for the record to make sure budgets are reported in the correct currency.
Public propertyTreeId Unique identifier of the goal tree.
Public propertyuser_goal N:1 user_goal
Public propertyuser_goal_goalowner N:1 user_goal_goalowner
Public propertyuserentityinstancedata_goal 1:N userentityinstancedata_goal
Public propertyUTCConversionTimeZoneCode Time zone code that was in use when the record was created.
Public propertyVersionNumber Version number of the goal.
Top
Methods
 NameDescription
Public methodContains
(Inherited from Entity)
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
Public methodGetAttributeValue``1
(Inherited from Entity)
Protected methodGetFormattedAttributeValue
(Inherited from Entity)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Protected methodGetRelatedEntities``1
(Inherited from Entity)
Protected methodGetRelatedEntity``1
(Inherited from Entity)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Protected methodSetAttributeValue
(Inherited from Entity)
Protected methodSetRelatedEntities``1
(Inherited from Entity)
Protected methodSetRelatedEntity``1
(Inherited from Entity)
Public methodToEntity``1
(Inherited from Entity)
Public methodToEntityReference
(Inherited from Entity)
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Public methodTryGetAttributeValue``1
(Inherited from Entity)
Top
Events
Fields
See Also