• PRODUCTS
  • SUPPORT
  • DOCS
  • PARTNERS
  • COMPANY
  • QUOTE
  • ACCOUNT
  • STORE
QUOTE

Documentation

Support Forums
What can we help you with?
Topics

Class AstExecuteProcessTaskNode

An Execute Process task can run business applications or batch files as part of a package workflow.

Namespace: Varigence.Languages.Biml.Task
Assembly: Biml.dll
C#
    public class AstExecuteProcessTaskNode : AstTaskBaseNode, IBindableItem, IVulcanCollectionParent, IVulcanNotifyPropertyChanged, IPropertyChangeNotificationTarget, IGetJsonProvider, INamedNode, IScopeBoundary, IReferenceableItem, IFrameworkItem, INotifyPropertyChanged, IXObjectMappingProvider, IValidationInfo, IDataErrorInfo, INamedItem, IScopedNameIndexable, IDataflowItem
    
  
Inheritance
System.Object
AstNode
AstNamedNode
AstScopeBoundaryNode
AstTaskNode
AstTaskBaseNode
AstExecuteProcessTaskNode
Implements

IBindableItem, Varigence.Utility.Collections.IVulcanCollectionParent, Varigence.Utility.ComponentModel.IVulcanNotifyPropertyChanged, Varigence.Utility.ComponentModel.IPropertyChangeNotificationTarget, IGetJsonProvider, INamedNode, IScopeBoundary, IReferenceableItem, IFrameworkItem, System.ComponentModel.INotifyPropertyChanged, Varigence.Utility.Xml.IXObjectMappingProvider, IValidationInfo, System.ComponentModel.IDataErrorInfo, INamedItem, Varigence.Utility.Collections.IScopedNameIndexable, IDataflowItem,

Constructors

Name Description
AstExecuteProcessTaskNode(IFrameworkItem)

Initializes a new instance of the AstExecuteProcessTaskNode class with the specified parent node.

Properties

Name Description
Arguments

This value provides command-prompt argument strings.

ArgumentsDefaultValue

Gets the default value for the Arguments property

Executable

This value specifies the path to a Microsoft Win32 executable file or a batch file to be run when the package runs.

ExecutableDefaultValue

Gets the default value for the Executable property

FailTaskIfReturnCodeIsNotSuccessValue

This value specifies whether the task should fail if the process exit code differs from the value specified in the SuccessValue property.

FailTaskIfReturnCodeIsNotSuccessValueDefaultValue

Gets the default value for the FailTaskIfReturnCodeIsNotSuccessValue property

FriendlyTypeName

Gets the friendly name of the type of this node

FriendlyTypeNameStatic

Gets the friendly name of the type of this node

RequireFullFileName

This value specifies whether the task should fail if the full name and extension of the task are not found.

RequireFullFileNameDefaultValue

Gets the default value for the RequireFullFileName property

StandardErrorVariable

This value specifies which variable is used to capture error output of the process to be run.

StandardInputVariable

This value specifies which variable is used as input to the process to be run.

StandardOutputVariable

This value specifies the variable that captures the output of the process to be run.

StaticUserDefinedItems

Specifies a collection of items that are common across all instances of the same type in the framework.

SuccessValue

This value specifies the value that the executable of batch file returns to indicate success. The default value is 0.

SuccessValueDefaultValue

Gets the default value for the SuccessValue property

TerminateProcessAfterTimeout

This value specifies whether the process will be forced to end after the period specified in the Timeout property.

TerminateProcessAfterTimeoutDefaultValue

Gets the default value for the TerminateProcessAfterTimeout property

Timeout

This value specifies how many seconds the process can run. Set the value to 0 to specify that no time-out value is applied and the process can run to completion.

TimeoutDefaultValue

Gets the default value for the Timeout property

WindowStyle

This value specifies the kind of window in which to run the process.

WindowStyleDefaultValue

Gets the default value for the WindowStyle property

WorkingDirectory

This value specifies the working directory that will be used to execute the process.

WorkingDirectoryDefaultValue

Gets the default value for the WorkingDirectory property

Methods

Name Description
BindingScopeBoundaries()

Retrieves the permitted scope boundaries to bind references from this node.

BindReference(SymbolTable, String, Boolean, String, Int32, Boolean)
CopyFrom(IFrameworkItem, UnboundReferences)

Instructs the node to copy property values from the supplied node into itself. This method should only be used by the internal Biml framework.

Duplicate()

Creates a duplicate of the current node

Duplicate(Dictionary<IFrameworkItem, IFrameworkItem>)

Creates a duplicate of the current node with the scoped node mapping

Duplicate(IFrameworkItem)

Creates a duplicate of the current node with the specified parent item

Duplicate(IFrameworkItem, Dictionary<IFrameworkItem, IFrameworkItem>)

Creates a duplicate of the current node with the specified parent item and scoped node mapping

DuplicateHusk(IFrameworkItem)

Creates an empty object into which the values from the current node will be duplicated. This method should only be used by the internal Biml framework

DuplicateInto(IFrameworkItem, Dictionary<IFrameworkItem, IFrameworkItem>)

Copies the values from the current node into a husk object with the specified scoped node mapping. This method should only be used by the internal Biml framework

EmitXmlForAction(AstEnginePropertyAction)

Instructs the node to make changes to its underlying Biml code that correspond to the provided action. This method should only be used by the internal Biml framework.

EmitXmlForProperty(String, Int32)

Instructs the node to make changes to its underlying Biml code that correspond to the provided property and index. This method should only be used by the internal Biml framework.

ForceNull(String, Int32)

Internal method used by the compiler to make a propert value null when required by the binding framework.

GetAllItemsReferencedByDefinedSuccessors()

Builds a list of all items referenced by this node and its successors. Each tuple in the returned list represents a FrameworkItemReference. The first item is the ReferencingItem, the second item is the property name, and the third item is the ReferencedItem.

GetBimlAttributeFragment(CulturedStringBuilder)
GetBimlFragment(CulturedStringBuilder, Int32, Boolean)

Internal method used by the Biml engine to produce the XML code for the current object.

GetDefaultValue(String)

Retrieves the default value for the property with the name propertyName

GetDefaultValue<T>(String)

Retrieves the default value for the property with the name propertyName

GetJson(StringBuilder, ref Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean)

Generates a JavaScript Object Notation (JSON) representation of the current node

GetPotentialParentProperties()

Retrieves the reflection information for related properties of this node type.

GetPropertyValue(String)

Retrieves the current value for the property with the name propertyName

GetReflectionInfoFromXmlParsePath(String)

Retrieves the reflection information corresponding to the Xml parse path beginning at this node.

MergeFrom(IFrameworkItem, UnboundReferences, Boolean)

Instructs the node to merge property values from the supplied node into itself. This method should only be used by the internal Biml framework.

ParseAttribute(XAttribute, ParserContext)
StructureEquals(Object)

Compares this node to the provided object to determine if all defined children and references are equal.

Validate(ValidationReporter)

Retrieves a collection of validation and diagnostic messages for the current node.

Can't find what you're looking for?

Let us help you right now!

© Varigence