CAction Class: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
Line 22: Line 22:
|ActionType||Gets or sets a value from the '''[[ActionTypeEnum Enumeration|ActionType]]''' enumeration, which specifies whether the action record is generic or detailed.
|ActionType||Gets or sets a value from the '''[[ActionTypeEnum Enumeration|ActionType]]''' enumeration, which specifies whether the action record is generic or detailed.
|-
|-
|ActualCost||Gets or sets the action's actual cost. '''Double'''.
|ActualCost||Gets or sets the cost to perform the action. '''Double'''.
|-
|-
|ActualCostPctFacility||'''Double'''.
|ActualCostPctFacility||'''Double'''.
Line 32: Line 32:
|ActualCostPctPersonResponsible||'''Double'''.
|ActualCostPctPersonResponsible||'''Double'''.
|-
|-
|ActualDuration||'''Double'''.
|ActualDuration||Gets or sets the number of working days from the action's start date to its completion date. '''Double'''.
|-
|-
|ActualManHrs||'''Double'''.
|ActualManHrs||Gets or sets the number of billable hours from the action's start date to its completion date. '''Double'''.
|-
|-
|ActualStartDate||'''Date'''.
|ActualStartDate||Gets or sets the date the action actually started. '''Date'''.
|-
|-
|AdditionalCost||'''Double'''.
|AdditionalCost||Gets or sets any other additional costs to perform the action. '''Double'''.
|-
|-
|arrNotificationGroupIDs()||'''Integer'''.
|arrNotificationGroupIDs()||'''Integer'''.
Line 46: Line 46:
|Category||Gets or sets the action category. '''String'''.
|Category||Gets or sets the action category. '''String'''.
|-
|-
|CompletionDate||'''Date'''.
|CompletionDate||Gets or sets the date the action was actually completed. '''Date'''.
|-
|-
|CreatedByID||Gets the numeric ID of the database user who created the action. '''Integer'''.
|CreatedByID||Gets the numeric ID of the database user who created the action. '''Integer'''.
Line 54: Line 54:
|CreatedDate||Gets the date the action resource was created. '''Date'''.
|CreatedDate||Gets the date the action resource was created. '''Date'''.
|-
|-
|FacilityID||Gets or sets the numeric ID of the facility. '''Integer'''.
|FacilityID||Gets or sets the numeric ID of the facility associated with the action and the project plan. '''Integer'''.
|-
|-
|FacilityNm||Gets or sets the name of the facility. '''String'''.
|FacilityNm||Gets or sets the name of the facility associated with the action and the project plan. '''String'''.
|-
|-
|FacilityUsage||'''Object'''.
|FacilityUsage||Gets or sets the facility's utilization rate. '''Object'''.
|-
|-
|FeasibleCost||'''Double'''.
|FeasibleCost||Gets or sets the expected cost to perform the action to date. '''Double'''.
|-
|-
|FeasibleDueDate||'''Date'''.
|FeasibleDueDate||Gets or sets the expected due date of the action, taking into account any delays recorded in the project plan. '''Date'''.
|-
|-
|FeasibleDuration||'''Double'''.
|FeasibleDuration||Gets or sets the number of working days from the action's feasible start date to its feasible completion date.'''Double'''.
|-
|-
|FeasibleManHrs||'''Double'''.
|FeasibleManHrs||Gets or sets the expected billable hours to date. '''Double'''.
|-
|-
|FeasibleStartDate||'''Date'''.
|FeasibleStartDate||Gets or sets the expected start date of the action, taking into account any delays recorded in the project plan. '''Date'''.
|-
|-
|ID||Gets the numeric ID of the action. '''Integer'''.
|ID||Gets the numeric ID of the action. '''Integer'''.
|-
|-
|IsCostUserDefined||Indicates whether the actual costs/man hours was calculated automatically or user-defined. '''Boolean'''.
|IsCostUserDefined||Indicates whether the actual cost/man hours is calculated automatically or user-defined. '''Boolean'''.
|-
|-
|{{Template:API_TxtIdentifiers}}
|{{Template:API_TxtIdentifiers}}
Line 82: Line 82:
|LastUpdatedNm||Gets the display name of the database user who last modified the action. '''String'''.
|LastUpdatedNm||Gets the display name of the database user who last modified the action. '''String'''.
|-
|-
|MaterialID||'''Integer'''.
|MaterialID||Gets or sets the numeric ID of the material associated with the action and the project plan. '''Integer'''.
|-
|-
|MaterialNm||'''String'''.
|MaterialNm||Gets or sets the name of the material associated with the action and the project plan. '''String'''.
|-
|-
|Name||Gets the action's name. '''String'''.
|Name||Gets or sets the action's name. '''String'''.
|-
|-
|PercentCompleted||'''Double'''.
|PercentCompleted||Gets or sets the progress of the action.'''Double'''.
|-
|-
|PersonnelID||'''Integer'''.
|PersonnelID||Gets or sets the numeric ID of the team associated with the action and the project plan. '''Integer'''.
|-
|-
|PersonnelNm||'''String'''.
|PersonnelNm||Gets or sets the name of the team associated with the action and the project plan.'''String'''.
|-
|-
|PersonnelUsage||'''Object'''.
|PersonnelUsage||Gets or sets the team's utilization rate. '''Object'''.
|-
|-
|PersonRespID||'''Integer'''.
|PersonRespID||Gets or sets the numeric ID of the database user responsible for the action. '''Integer'''.
|-
|-
|PersonRespNm||'''String'''.
|PersonRespNm||Gets or sets the name of the database user responsible for the action.'''String'''.
|-
|-
|PersonRespUsage||'''Double'''.
|PersonRespUsage||Gets or sets the utilization rate of the database user responsible for the action.'''Double'''.
|-
|-
|PlanCost||'''Double'''.
|PlanCost||Gets or set the planned cost to perform the action. '''Double'''.
|-
|-
|PlanCostPctFacility||'''Double'''.
|PlanCostPctFacility||'''Double'''.
Line 114: Line 114:
|PlanDueDate||Gets or sets the planned due date of the action. '''Date'''.
|PlanDueDate||Gets or sets the planned due date of the action. '''Date'''.
|-
|-
|PlanDuration||'''Integer'''.
|PlanDuration||Gets or sets the number of working days from the action's planned start date to its planned completion date. '''Integer'''.
|-
|-
|PlanManHrs||'''Double'''.
|PlanManHrs||Gets or sets the planned number of billable hours from the action's start date to its completion date. '''Double'''.
|-
|-
|PlanStartDate||Gets or sets the planned start date of the action. '''Date'''.
|PlanStartDate||Gets or sets the planned start date of the action. '''Date'''.
Line 126: Line 126:
|ProjectID||Gets the numeric ID of the project the action belongs to. '''Integer'''.
|ProjectID||Gets the numeric ID of the project the action belongs to. '''Integer'''.
|-
|-
|ReportAssumptions||'''String'''.
|ReportAssumptions||If the action is part of a test plan, gets or sets a description of the assumptions of the test plan. '''String'''.
|-
|-
|ReportResults||'''String'''.
|ReportResults||If the action is part of a test plan, gets or sets a description of the results of the test plan. '''String'''.
|-
|-
|ReportSummary||'''String'''.
|ReportSummary||If the action is part of a test plan, gets or sets a summary report about the test plan. '''String'''.
|-
|-
|ReviewComments||'''String'''.
|ReviewComments||Gets or sets comments or other descriptions relevant to the current action.'''String'''.
|-
|-
|ReviewDate||'''Date'''.
|ReviewDate||Gets or sets the date the action is scheduled for review. '''Date'''.
|-
|-
|ReviewerID||'''Integer'''.
|ReviewerID||Gets or sets the numeric ID of the database user assigned to review the action. '''Integer'''.
|-
|-
|ReviewerNm||'''String'''.
|ReviewerNm||Gets or sets the name of the database user assigned to review the action. '''String'''.
|-
|-
|ReviewOutCome||Gets or sets a value from the '''[[ReviewOutcomeEnum Enumeration|ReviewOutcomeEnum]]''' enumeration, which specifies the status of the action under review (e.g., approved, rejected and closed, etc.)
|ReviewOutCome||Gets or sets a value from the '''[[ReviewOutcomeEnum Enumeration|ReviewOutcomeEnum]]''' enumeration, which specifies the status of the action under review (e.g., approved, rejected and closed, etc.)
|-
|-
|ReviewOutComeString||Gets or sets the user-defined description of the action's review outcome. '''String'''.
|ReviewOutComeString||Gets or sets the description of the action's review outcome. '''String'''.
|-
|-
|ShowInTestPlan||Indicates whether the action is eligible to be included in a test plan. '''Boolean'''.
|ShowInTestPlan||Indicates whether the action is eligible to be included in a test plan. '''Boolean'''.
|-
|-
|TestCriteria||'''String'''.
|TestCriteria||If the action is part of a test plan, gets or sets a description of the the test criteria. '''String'''.
|-
|-
|TestPlan||'''String'''.
|TestPlan||If the action is part of a test plan, gets or sets a description of the test plan or procedure. '''String'''.
|-
|-
|TestReq||'''String'''.
|TestReq||If the action is part of a test plan, gets or sets a description of the requirements for the test plan. '''String'''.
|-
|-
|TestReqNotes||'''String'''.
|TestReqNotes||If the action is part of a test plan, gets or sets notes or remarks about the requirements of the test plan. '''String'''.
|-
|-
|TestSampleSize||'''String'''.
|TestSampleSize||If the action is part of a test plan, gets or sets a description of the sample size. '''String'''.
|-
|-
|TestSampleType||'''String'''.
|TestSampleType||If the action is part of a test plan, gets or sets a description of type of samples available. '''String'''.
|-
|-
|TestSpecMethod||'''String'''.
|TestSpecMethod||If the action is part of a test plan, gets or sets a description of the specifications or methodology of the test plan. '''String'''.
|-
|-
|TestSpecNotes||'''String'''.
|TestSpecNotes||If the action is part of a test plan, gets or sets notes or remarks about the specifications of the test plan. '''String'''.
|-
|-
|UDD1||Gets or sets a user-defined drop-down field. (Limited to 50 characters.) '''String'''.
|UDD1||Gets or sets a user-defined drop-down field. (Limited to 50 characters.) '''String'''.

Revision as of 23:02, 16 September 2015

Template:InProgress

APIWiki.png


Member of: SynthesisAPI


Represents an action resource.

Constructors

Name Description
cAction Creates an instance of the cAction class.
cAction() A parameterized constructor for the cAction class. (.NET only)


Properties

Name Description
ActionDescription Gets or sets the action description. String.
ActionTaken Gets or sets the description of the action resolution. String.
ActionType Gets or sets a value from the ActionType enumeration, which specifies whether the action record is generic or detailed.
ActualCost Gets or sets the cost to perform the action. Double.
ActualCostPctFacility Double.
ActualCostPctMaterial Double.
ActualCostPctPersonnel Double.
ActualCostPctPersonResponsible Double.
ActualDuration Gets or sets the number of working days from the action's start date to its completion date. Double.
ActualManHrs Gets or sets the number of billable hours from the action's start date to its completion date. Double.
ActualStartDate Gets or sets the date the action actually started. Date.
AdditionalCost Gets or sets any other additional costs to perform the action. Double.
arrNotificationGroupIDs() Integer.
arrNotificationUserIDs() Integer.
Category Gets or sets the action category. String.
CompletionDate Gets or sets the date the action was actually completed. Date.
CreatedByID Gets the numeric ID of the database user who created the action. Integer.
CreatedByNm Gets the display name of the database user who created the action. String.
CreatedDate Gets the date the action resource was created. Date.
FacilityID Gets or sets the numeric ID of the facility associated with the action and the project plan. Integer.
FacilityNm Gets or sets the name of the facility associated with the action and the project plan. String.
FacilityUsage Gets or sets the facility's utilization rate. Object.
FeasibleCost Gets or sets the expected cost to perform the action to date. Double.
FeasibleDueDate Gets or sets the expected due date of the action, taking into account any delays recorded in the project plan. Date.
FeasibleDuration Gets or sets the number of working days from the action's feasible start date to its feasible completion date.Double.
FeasibleManHrs Gets or sets the expected billable hours to date. Double.
FeasibleStartDate Gets or sets the expected start date of the action, taking into account any delays recorded in the project plan. Date.
ID Gets the numeric ID of the action. Integer.
IsCostUserDefined Indicates whether the actual cost/man hours is calculated automatically or user-defined. Boolean.
ItemApplication Gets or sets the item's application. (Synthesis identifier) String
ItemCategoryID Gets or sets the category ID. (Synthesis identifier) Integer
ItemComments Gets or sets the comments. (Synthesis identifier) String
ItemDescription Gets or sets the description. (Synthesis identifier) String
ItemKeywords Gets or sets the keywords. (Synthesis identifier) String
ItemPartNumber Gets or sets the part number. (Synthesis identifier) String
ItemSupplier Gets or sets the supplier name. (Synthesis identifier) String
ItemVersion Gets or sets the version number. (Synthesis identifier) String
LastUpdated Gets the date the action was last modified. Date.
LastUpdatedByID Gets the numeric ID of the database user who last modified the action. Integer.
LastUpdatedNm Gets the display name of the database user who last modified the action. String.
MaterialID Gets or sets the numeric ID of the material associated with the action and the project plan. Integer.
MaterialNm Gets or sets the name of the material associated with the action and the project plan. String.
Name Gets or sets the action's name. String.
PercentCompleted Gets or sets the progress of the action.Double.
PersonnelID Gets or sets the numeric ID of the team associated with the action and the project plan. Integer.
PersonnelNm Gets or sets the name of the team associated with the action and the project plan.String.
PersonnelUsage Gets or sets the team's utilization rate. Object.
PersonRespID Gets or sets the numeric ID of the database user responsible for the action. Integer.
PersonRespNm Gets or sets the name of the database user responsible for the action.String.
PersonRespUsage Gets or sets the utilization rate of the database user responsible for the action.Double.
PlanCost Gets or set the planned cost to perform the action. Double.
PlanCostPctFacility Double.
PlanCostPctMaterial Double.
PlanCostPctPersonnel Double.
PlanCostPctPersonResponsible Double.
PlanDueDate Gets or sets the planned due date of the action. Date.
PlanDuration Gets or sets the number of working days from the action's planned start date to its planned completion date. Integer.
PlanManHrs Gets or sets the planned number of billable hours from the action's start date to its completion date. Double.
PlanStartDate Gets or sets the planned start date of the action. Date.
Priority Gets or sets the action's priority level. String.
PriorityType Gets or sets a value from the PriorityType enumeration, which specifies the priority level of the action (e.g., low, medium, high, etc.)
ProjectID Gets the numeric ID of the project the action belongs to. Integer.
ReportAssumptions If the action is part of a test plan, gets or sets a description of the assumptions of the test plan. String.
ReportResults If the action is part of a test plan, gets or sets a description of the results of the test plan. String.
ReportSummary If the action is part of a test plan, gets or sets a summary report about the test plan. String.
ReviewComments Gets or sets comments or other descriptions relevant to the current action.String.
ReviewDate Gets or sets the date the action is scheduled for review. Date.
ReviewerID Gets or sets the numeric ID of the database user assigned to review the action. Integer.
ReviewerNm Gets or sets the name of the database user assigned to review the action. String.
ReviewOutCome Gets or sets a value from the ReviewOutcomeEnum enumeration, which specifies the status of the action under review (e.g., approved, rejected and closed, etc.)
ReviewOutComeString Gets or sets the description of the action's review outcome. String.
ShowInTestPlan Indicates whether the action is eligible to be included in a test plan. Boolean.
TestCriteria If the action is part of a test plan, gets or sets a description of the the test criteria. String.
TestPlan If the action is part of a test plan, gets or sets a description of the test plan or procedure. String.
TestReq If the action is part of a test plan, gets or sets a description of the requirements for the test plan. String.
TestReqNotes If the action is part of a test plan, gets or sets notes or remarks about the requirements of the test plan. String.
TestSampleSize If the action is part of a test plan, gets or sets a description of the sample size. String.
TestSampleType If the action is part of a test plan, gets or sets a description of type of samples available. String.
TestSpecMethod If the action is part of a test plan, gets or sets a description of the specifications or methodology of the test plan. String.
TestSpecNotes If the action is part of a test plan, gets or sets notes or remarks about the specifications of the test plan. String.
UDD1 Gets or sets a user-defined drop-down field. (Limited to 50 characters.) String.
UDD2 Gets or sets a second user-defined drop-down field. (Limited to 50 characters.) String.
UDT1 Gets or sets a user-defined date field. Date.
UDT2 Gets or sets a second user-defined date field. Date.
UN1 Gets or sets a user-defined number field. Double.
UN2 Gets or sets a second user-defined number field. Double.