JAMS Developer Guide
MVPSI.JAMS Namespace
Inheritance Hierarchy
Classes
 ClassDescription
ClassAccess The Access class provides methods used to check access to JAMS features.
ClassAccessBits Identifies the ObjectAccess bits that are valid for a specific AccessObject;
ClassACLData ACL - Access Control List Raw data
ClassAgent The Agent class defines and identifies a machine where JAMS can execute jobs. Agents can be any type of computer, they are not limited to Windows or Linux. Some of the properties of an agent are dynamic and will only contain values when the JAMS Scheduler is up and running.
ClassAgentAccessRule AgentAccessRule is the AccessRule for a Agent's Security Descriptor
ClassAgentAuditRule AgentAuditRule is the AuditRule for a Agent's Security Descriptor
ClassAgentCtl Defines the AgentCtl which handles the Agent drop down list.
ClassAgentRef  
ClassAgentReference The AgentReference class is used by properties that need to reference a JAMS Agent definition.
ClassAgentSecurity The AgentSecurity class defines access control objects used in a JAMS Agent definition.
ClassAppAccessRule AppAccessRule is the AccessRule for an AppSecurity Descriptor
ClassAppAuditRule AppAuditRule is the AuditRule for a App's Security Descriptor
ClassAppMenu AppMenu represents a single entry in the JAMS application menu
ClassAppMenuUserPreference Gets and Sets App Menu User Preference
ClassAppSecurity The AppSecurity class defines access control objects used in controll access to different parts of the JAMS application.
ClassAuditTrail A message that was written to the JAMS Audit Trail.
ClassBasePublicObject The BasePublicObject class is the base class for most of the public JAMS objects.
ClassBaseRef The BaseRef class is the base class for classes that describe a reference between JAMS objects.
ClassBaseReference BaseReference is the base class for classes that reference a JAMS definition.
ClassBatchQueue A BatchQueue is a logical queue in which jobs execute. The BatchQueue can control the number of concurrent jobs and the agents that the jobs actually execute on.
ClassBatchQueueAccessRule BatchQueueAccessRule is the AccessRule for a batch queue's Security Descriptor
ClassBatchQueueAgent  
ClassBatchQueueAgentCollection A Collection of QueueAgents
ClassBatchQueueAuditRule BatchQueueAuditRule is the AuditRule for a BatchQueue's Security Descriptor
ClassBatchQueueRef  
ClassBatchQueueReference The BatchQueueReference class is used by properties that need to reference a JAMS queue definition.
ClassBatchQueueSecurity The BatchQueueSecurity class defines access control objects used in a JAMS BatchQueue definition.
ClassBuildMenu Collection of menu Entry-items.
ClassCfg A JAMS Cfg definition.
ClassCfgDb A JAMS CfgDb definition. Not tied to tenant.
ClassCheckResult A class used to send back the results of the check process logs
ClassCompareOptionsAttribute The CompareOptions attribute can be applied to properties to affect the way the CompareObjectCtl control compares the property.
ClassCompletionWithSeverityStat A CompletionWithSeverityStat contains a completion count for a single Severity for a minute of the day.
ClassConstants The Constants class contains static values used by JAMS.
ClassConvert The Convert class provides static methods used to convert JAMS datatypes.
ClassCredential A JAMS Credential definition.
ClassCredentialAccessRule CredentialAccessRule is the AccessRule for a Credential's Security Descriptor
ClassCredentialAuditRule CredentialAuditRule is the AuditRule for a Credential's Security Descriptor
ClassCredentialRef  
ClassCredentialReference The CredentialReference class is used by properties that need to reference a JAMS Credential definition.
ClassCredentialSecurity The CredentialSecurity class defines access control objects used in a JAMS Credential definition.
ClassDate  
ClassDateDetail Date Definitions are used to mark dates which are significant to your batch processing. These dates may be company observed holidays, fiscal periods, etc. You should be careful when defining these dates since they are used to schedule (or not schedule) Jobs, and they are used to create the defaults for dates used as parameters to Jobs. If your Data Center operates 365 days a year and schedules jobs based on calendar months, you do not need to define any special dates.

There are two types of significant dates. One type marks a single day as having some importance. The second type marks the beginning of a period. If the Date Type of the date you are defining is a continuous Date Type, then any dates which you define mark the beginning of a new period. If the Date Type is not continuous, then the date marks a single significant date.

ClassDateDetailCollection A DateDetailCollection manages a collection of DateDetail objects
ClassDateSpecificDependency DateSpecificDependency is a job dependency that requires that the job was scheduled on a specific date relative to the hold date job that has the dependency.
ClassDateTimeExtensions Class of DateTime Extensions
ClassDateType A JAMS DateType. DateTypes are high-level definitions of special dates such as holidays or fiscal periods. DateTypes are used to define the various classes of dates which are significant to your environment. This is not where you define the specific dates for these classes, rather it is where you define the classes themselves.
ClassDeltaTimeConverter DeltaTimeConverter is a TypeConverter for the DeltaTime class
ClassDocumentation A class that handles the documentation properties on Job and Folder definitions.
ClassDynamicPropertyHelperAttribute The DynamicPropertyHelper attribute marks properties as dynamic property helpers. This prevents them from being included in a TypeDescriptor since the dynamic property will be included.
ClassEditorNameAttribute The EditorNameAttributes can be applied to a property to specify the name of an editor to be used when editing a property.
ClassEditSourceDialog EditSourceDialog allows for editing a Submit.Job's Source
ClassEditSourceManager The EditSourceManager control doesn't display anything, it manages all the EditSource controls and displays the correct one. The default is EditSourceCtl which is a text editor. The Execution Method can specify a different editor control.
ClassElement The Element class is a generic element.
ClassElementCollection A class for a list of Elements
ClassElementType A ElementType describes a type of JAMS object.
ClassEntry This class defines an instance of an Entry that is currently in the schedule.
ClassEntryAuditTrail A message that was written to the JAMS Entry Audit Trail.
ClassEntryCompletedArgs EntryCompletedArgs is an event that is sent when an entry completes.
ClassEntryDependency EntryDependency is a prerequisite Element that creates a dependency on a specific entry in the schedule.
ClassEntryDetailArgs EntryDetailArgs is an event that contains a MonitorEntry object that describes an entry in the schedule.
ClassEntryElementChangedArgs An element has changed.
ClassEntryEventArgs EntryEventArgs is used to pass information about an entry event to a EntryHandlerEvent. This class holds the most basic information about an entry event. It is the base class for other events that need to pass more information.
ClassEntryEventExtensionArgs EntryEventExtensionsArgs is used to extend entry event arguments witout breaking the contract.
ClassEntryEventWrapper The EntryEventWrapper class is needed to isolate the client and server. Without this class, the server would need access to the client assembly when it tried to send an event. With this wrapper class, the client only needs the client and the JAMSShr.dll assembly and the server only needs the server and the JAMSShr.dll
ClassEntryParam This class defines parameters for entries.
ClassEntryParamCollection A collection class of parameters for entries.
ClassEntryProgressArgs JobProgressArgs is a JobEventArgs that is used to update the progress for a job.
ClassEntryStartedArgs EntryStartedArgs is an event that is used when an entry starts executing.
ClassEntryStatistics  
ClassEntryStatisticsArgs JobStatisticsArgs is a JobEventArgs that is used to send statistics. This is not sent to clients.
ClassEntryTagsChangedArgs The tags applied to the entry have changed.
ClassEntryUpdateStatusArgs EntryUpdateStatusArgs is an event that is used when a Job's Icon, Message, or Status changes.
ClassEntryWFTrackingArgs EntryWFTrackingArgs is an event that is used to track workflows.
ClassExceptionExtensions Extension class for handling exceptions
ClassFileDependency FileDependency is a prerequisite Element that can be applied to folders or jobs to make a job depend on the presence of a file.
ClassFileTrigger FileTrigger is a trigger Element that can be applied to folders or jobs to submit a job when a file is present or absent.
ClassFolder  
ClassFolderAccessRule FolderAccessRule is the AccessRule for a Folder's Security Descriptor
ClassFolderAT A JAMS Audit Folder.
ClassFolderAuditRule FolderAuditRule is the AuditRule for a Folder's Security Descriptor
ClassFolderParamCollection Folder Param Collection
ClassFolderRef  
ClassFolderReference A class for referencing JAMS Folders
ClassFolderSecurity The FolderSecurity class defines access control objects used in a JAMS Folder definition.
ClassGenericACE A generic Access Control Entry.
ClassGenericACL The GenericACL class represents a generic access control list.
ClassHistory  
ClassHistoryAuditTrail A message that was written to the JAMS History Audit Trail.
ClassHistorySelection Specifies a portion of a history selection query identifying a single field, comparison operator and comparison value.
ClassIcons Each property in the Icons class is a JAMS icon.
ClassInheritedElement An inherited element and the job that it affects.
ClassJAMSDataContractResolver Resolves types from any available assembly. This DataContractResolver is used internally and does not need to be called by end-user code.
ClassJAMSException A JAMSException is used to pass exception information between a JAMS client and a JAMS Server.
ClassJAMSSecurity A common base class for JAMS objects which have an ACL.
ClassJob  
ClassJobAccessRule JobAccessRule is the AccessRule for a Job's Security Descriptor
ClassJobAT A JAMS Audit Job.
ClassJobAuditRule JobAuditRule is the AuditRule for a Job's Security Descriptor
ClassJobCompletionTrigger  
ClassJobDependency JobDependency is a prerequisite Element that can be applied to folders or jobs to make a job depend on the completion of another job.
ClassJobParamCollection A Class containing a collection of JAMS Job Params
ClassJobRef  
ClassJobReference The JobReference class is used by properties that need to reference a JAMS job definition.
ClassJobSecurity The JobSecurity class defines access control objects used in a JAMS Job definition.
ClassLicense Information on a JAMS License
ClassLink A class that handles a link property on Job or Folder definitions
ClassMacro A Macro is a code fragment that is expanded when JAMS is replacing tokens. Macros are defined in XML file that are loaded and used by the JAMS Scheduler.
ClassMailTrigger MailTrigger is a trigger Element that can be applied to folders or jobs to submit a job when e-mail arrives in a mailbox.
ClassMenu Menu Definitions define customized menu hierarchies for the JAMS Submit Menu. These menus are used by JAMS to present a hierarchy of menus to a user when they want to submit a batch job.

Creating menus is optional. JAMS can create a default menu which initially lists all of the available JAMS Systems. After the user selects a JAMS System, all of the available Job and Setup definitions are then displayed.

ClassMenuAT Menu Definitions define customized menu hierarchies for the JAMS Submit Menu. These menus are used by JAMS to present a hierarchy of menus to a user when they want to submit a batch job.

Creating menus is optional. JAMS can create a default menu which initially lists all of the available JAMS Systems. After the user selects a JAMS System, all of the available Job and Setup definitions are then displayed.

ClassMenuDetail  
ClassMenuDetailCollection Class that holds a Collection of Menu Details
ClassMenuEntry Menu detail Entry-item which is stored in the BuildMenu collection.
ClassMethod  
ClassMethodAT  
ClassMethodRef  
ClassMethodReference The MethodReference class is used by properties that need to reference a JAMS Method definition.
ClassMonitorEntry A MonitorEntry is a static summary of an Entry. This object is sent by monitor events to represent an entry. If you need the complete details of an entry, you should use the information in MonitorEntry to call Entry.Load().
ClassMonitorEventHelpers MonitorEventHelpers provides methods that help when monitoring jobs
ClassMsg The Msg class provides static properties and methods that are used to retrieve JAMS messages.
ClassNamedTime  
ClassNamedTimeRef  
ClassNamedTimeReference The NamedTimeReference class is used by properties that need to reference a JAMS NamedTime definition.
ClassNameList The NameList class provides static methods to create and merge lists of names.
ClassNotificationJob A NotificationJob is an event handler element that can be applied to jobs or folders. When one of the enabled events occurs, the notification job is submitted.
ClassNotifyPropertyCollection<T> NotifyPropertyCollection is the base class for collections that are are part of a larger object.
ClassParam  
ClassParamCollection Class that contains a Collection of Params
ClassPathName Methods associated with symbol names.
ClassPrecheckJob A Precheck is a prerequisite element that can be applied to jobs or folders. When JAMS evaluates the precheck, it submits the job specified in the precheck and a successful completion satisfies the prerequisite. If the job fails, JAMS will retry the job after the specified delay. This repeats until the precheck job is successful.
ClassPropComparer The PropComparer class is a generic comparer. It takes a PropertyDescriptor and compares two of whatever type the descriptor points to.
ClassPropDeepComparer The PropDeepComparer class is a generic comparer. It takes an array of PropertyDescriptors and compares two of whatever type the descriptors point to. This is used when you have a list of complex objects, for example Customer. One of the properties of Customer could be a ShippingAddress object and one of the properties of ShippingAddress could be ZipCode. To sort a list of customers by ZipCode you would use this comparer with an array of propterty descriptors, i.e. sortProperty[0] = Property descriptor for Customer.ShippingAddress sortProperty[1] = Property descriptor for Customer.ShippingAddress.ZipCode It's called PropDeepComparer because can will look deep into an object.
ClassPropertyDefinition A JAMS PropertyDefinition. A PropertyDefinition is a custom defined property that is assigned to a JAMS definition.
ClassPropertyValue A PropertyValue represents a "soft" property of a JAMS object definition.
ClassPropertyValueCollection A PropertyValueCollection is the set of properties for a specific object. Many JAMS objects are dynamic, the properties that they contain can change without changing any code. This class is used to support that.
ClassPropertyValueDescriptor A class for creating property value descriptors.
ClassPropMultiColumnComparer The PropMultiColumnComparer class is a generic comparer. It takes an array of PropertyDescriptors and compares two of whatever type the descriptors point to. This is used when you have a list of objects and you want to sort on more than one column. For example, if you had a Customer object and you wanted to sort on Customer.SalesRep and then Customer.Name. Use this sort comparer whit an array of PropertyDescriptors similar to: sortProperty[0] = Property descriptor for Customer.SalesRep sortProperty[1] = Property descriptor for Customer.Name
ClassPSWrapperAttribute The PSWrapper attribute provides details for running a PowerShell command or function. This attribute is applied to Workflow toolbox items that run PowerShell commands.
ClassRecoveryJob A RecoveryJob is submitted when the job that is is applied to completes with a severity that is worse that the specfied minimum completion severity.
ClassRepeat The Repeat element can be applied to a folder or job. A job with a Repeat element will repeat with the specified delay until the specified end time.
ClassReportDesign The ReportDesign class defines different types of report definitions. In general, the ReportDesign describes the data source for the report definition.
ClassReportType The ReportType class defines different types of report definitions. In general, the ReportType describes the data source for the report definition.
ClassRequiredAttribute The RequiredAttribute is used to make properties required.
ClassResource  
ClassResourceAccessRule ResourceAccessRule is the AccessRule for a Resource's Security Descriptor
ClassResourceAuditRule ResourceAuditRule is the AuditRule for a Resource's Security Descriptor
ClassResourceDetail  
ClassResourceDetailCollection Collection of Resource Details
ClassResourceRef  
ClassResourceReference The ResourceReference class is used by properties that need to reference a JAMS resource definition.
ClassResourceRequirement A ResourceRequirement defines a quantity of a resource that is required by a job.
ClassResourceSecurity The ResourceSecurity class defines access control objects used in a JAMS Resource definition.
ClassResubmit The Resubmit element can be applied to a folder or job. A job with a Resubmit element will be resubmited with the specified delay until the specified end time.
ClassRunawayEvent The RunawayEvent element defines limits for a job. If the job exceeds the limit, it generates a runaway event.
ClassSchedule Generates a list of Jobs and Setups that should run within a date range.
ClassScheduleEntry ScheduleEntry is an entry in a Schedule.
ClassScheduleTrigger A ScheduleTrigger element can be added to a job or folder to automatically schedule the job or the jobs contain in the folder.
ClassScheduleWindow A ScheduleWindow element can be added to a job or folder to define a time window when a Job will be allowed to start, and the action taken if the window is missed.
ClassSecurity General Security Access Control class.
ClassSendEMail A SendEMail element will send e-mail in response to an event.
ClassServer  
ClassServerStatus Contains information about the status of a JAMS Server
ClassShortEvent The ShortEvent element defines limits for a job. If the job in less time than the limit, it generates a short event.
ClassSpecificDateType  
ClassSpecificDateTypeCollection Class is a Collection of Date Types
ClassSSISParam The SSISParam class is used when parsing job source. The source or a macro can reference SSISParameters which will return the parameters that were defined in the job converted to SSISParam objects. The key difference between SSISParam and EntryParam is the names returned for DataType and the default format for DateTime values.
ClassStalledEvent The StalledEvent element defines a stalled limit for a job. If the job is pending longer than the limit, it generates a stalled event.
ClassStatistics A Statistic provides quantitative data about current and historical JAMS operations.
ClassStreamClient StreamClient is the client side of a stream that is beoing accessed across WCF. This class is intended for JAMS internal use.
ClassSubmit The Submit class is used to submit a Job.
ClassSubmit.Info The Submit.Info class contains the information required when submitting a Job or Setup.
ClassSubmit.Parameter A Submit.Parameter object is used to hold information about a parameter to a Job.
ClassSubmit.ParameterCollection A Submit.ParameterCollection holds a collection of Submit.Parameters
ClassSubmitFactoryAttribute The SubmitFactoryAttribute provides a SubmitMenu name and type.
ClassSubmitMenu The SubmitMenu control will display a menu of jobs which can be submitted. A SubmitMenu can start with zero or more SubmitMenuRoots. Each SubmitMenuRoot defines a line in the initial menu tree. If a SubmitMenu doesn't have any SubmitMenuRoots, a default initial menu is created which consists of all of the JAMS System definitions. If a SubmitMenu only has a single SubmitMenuRoot, that root is expanded rather than displaying a single line menu.
ClassSubmitMenuRoot The SubmitMenuRoot class defines the roots of a SubmitMenu tree.
ClassSubmitResult A class that defines the results when submitting a job.
ClassSymbolName Methods associated with symbol names.
ClassSymbolNameAttribute The SymbolNameAttribute is used to check for invalid characters
ClassTag A tag is a simple name that can be placed on a folder, job or entry to help you organize and manage these objects. JAMS will also add tags to entries and the entry is processed. For example, if an entry is declared a runaway, the "Runaway" tag is added to the entry.
ClassTagDefinitions The TagDefinitions class is used to cache tag definitions. You need to pass an instance of this
ClassTags The Tags class is used to manage the tags assigned to a folder, job or entry.
ClassTenant A JAMS tenant definition.
ClassTenantMessageClient  
ClassTenantMessageClientBehavior  
ClassTimeOfDayConverter TimeOfDayConverter is a TypeConverter for the TimeOfDay type.
ClassTimeZone A JAMS TimeZone.
ClassTimeZoneReference The TimeZoneReference class is used by properties that need to reference a JAMS TimeZone definition.
ClassTriStateConverter TriStateConverter is a TypeConverter for the TriState enumeration.
ClassUpdateResult UpdateResult is used internally to retusn the results of an update
ClassValidationLog A ValidationLog can be returned after saving changes to a JAMS object. It is also included in a JAMSException.
ClassValidationLog.Entry An entry in a ValidationLog.
ClassVariable  
ClassVariableAccessRule VariableAccessRule is the AccessRule for a Variable's Security Descriptor
ClassVariableAuditRule VariableAuditRule is the AuditRule for a Variable's Security Descriptor
ClassVariableDependency VariableDependency is a prerequisite Element that can be applied to folders or jobs to make a job depend on the value of a JAMS variable.
ClassVariableRef  
ClassVariableReference The VariableReference class is used by properties that need to reference a JAMS Variable definition.
ClassVariableSecurity The VariableSecurity class defines access control objects used in a JAMS Variable definition.
ClassVariableTrigger VariableTrigger is a trigger which is based upon the value of a JAMS Variable. When the variable is changed or satisfies a specific condition, the trigger fires.
ClassWaitFor The WaitFor class is used to wait for events or conditions to occur. You can wait for the completion of specific entries in the schedule, job completions, setup completions, variable values or resource availablity.

You can wait for multiple events. Create an instance of WaitFor, call any combination of the Entry, Job, Setup, Variable or Resource methods to specify what you want to wait for. Then call Check or Wait to wait for the requests to be satisfied.

ClassWFTracking A tracking record that represents a state change in a Workflow's execution
ClassXmlReaderExtensions  
Interfaces
 InterfaceDescription
InterfaceIAccessToolsWCF The IAccessTools interface is used to manage access rights on a JAMS Server.
InterfaceIACL  
InterfaceIAdvancedSorts An interface that support our advanced sorts.
InterfaceIAgentRefWCF The IAgentRefSQL interface is used to retrieve Agent References from a JAMS Server.
InterfaceIAgentWCF The IAgentSQL interface is used to retrieve and store Agents from a JAMS Server.
InterfaceIAppMenuWCF The IFolderSQL interface is used to retrieve and store Folders from a JAMS Server.
InterfaceIAuditTrailWCF The IAuditTrailSQL interface is used to retrieve Audit Trails from a JAMS Server.
InterfaceIBannedWordList The IBannedWordList interface is used to manipulate a list of words that should not be echoed into a job's log file.
InterfaceIBaseObject The IBaseObject interface is used internally by JAMS.
InterfaceIBatchQueueRefWCF The IBatchQueueRefSQL interface is used to retrieve Queue References from a JAMS Server.
InterfaceIBuildMenuWCF The IBuildMenuSQL interface is used to retrieve the Submit Menu from a JAMS Server.
InterfaceICfgDbWCF The ICfgDbWCF interface is used to retrieve CfgDb settings from a JAMS Server.
InterfaceICfgGetValueWCF The ICfgGetValueWCF interface is used to load Cfg for the purpose of returning the value of a specific configuration setting.
InterfaceICfgWCF The ICfgSQL interface is used to retrieve and store Cfg settings from a JAMS Server.
InterfaceIChild IChild Interface
InterfaceICredentialAccess An interface for Access Control methods.
InterfaceICredentialRefWCF The ICredentialRefSQL interface is used to retrieve Credential References from a JAMS Server.
InterfaceICredentialWCF The ICredentialSQL interface is used to retrieve and store Credential from a JAMS Server.
InterfaceIDateWCF  
InterfaceIDocumentation An interface implemented by Documentation elements
InterfaceIElement The IElement interface must be implemented by elements
InterfaceIElementSubmit The IElementSubmit interface is an optional interface that can be implemented by elements that need some control during the submit process.
InterfaceIEntryAuditTrailWCF The IEntryAuditTrailSQL interface is used to retrieve Entry Audit Trails from a JAMS Server.
InterfaceIEntryManageElementsWCF The IEntryManageElementsWCF interface is used to manage the elements of an entry.
InterfaceIEntryWCF The IEntrySQL interface is used to retrieve Entry from a JAMS Server.
InterfaceIFolderATWCF Defines the interface to the JAMS Server for Folder Audit Trail acccess.
InterfaceIFolderRefWCF The IFolderRefSQL interface is used to retrieve Folder References from a JAMS Server.
InterfaceIFolderWCF The IFolderSQL interface is used to retrieve and store Folders from a JAMS Server.
InterfaceIHistoryAuditTrailWCF The IHistoryAuditTrailSQL interface is used to retrieve History Audit Trails from a JAMS Server.
InterfaceIHistoryWCF The IHistorySQL interface is used to retrieve History entries from a JAMS Server.
InterfaceIInstallIntegration The IInstallIntegration is implemented by JAMS integrations and is called by the JAMSDBA utility when the integration is being installed.
InterfaceIJobATWCF Defines the interface to the JAMS Server for Job Audit Trail acccess.
InterfaceIJobRefWCF The IJobRefSQL interface is used to retrieve Job References from a JAMS Server.
InterfaceIKeyManagementWCF Key Management
InterfaceILocalService Implemented by WCF services that can also be locally activated. This is used by the JAMSScheduler to access JAMS objects without the JAMSServer service.
InterfaceIMenuATWCF The IMenuSQL interface is used to retrieve and store Menus from a JAMS Server.
InterfaceIMenuWCF The IMenuSQL interface is used to retrieve and store Menus from a JAMS Server.
InterfaceIMethodATWCF The IMethodSQL interface is used to retrieve and store Methods from a JAMS Server.
InterfaceIMethodRefWCF The IMethodRefSQL interface is used to retrieve Method References from a JAMS Server.
InterfaceIMethodWCF The IMethodSQL interface is used to retrieve and store Methods from a JAMS Server.
InterfaceIModelInformation Model Information Interface
InterfaceIMonitor The IMonitor interface is implemented by the JAMSServer Service. Clients get a reference to the interface and can then call methods on the server.
InterfaceIMonitorCallback The IMonitorCallback interface is used to pass events back to the client. It is intended for JAMS internal use.
InterfaceIMonitorInit Interface for the Monitor
InterfaceINamedTimeRefWCF The INamedTimeRefSQL interface is used to retrieve NamedTime References from a JAMS Server.
InterfaceINamedTimeWCF The INamedTimeSQL interface is used to retrieve and store NamedTimes from a JAMS Server.
InterfaceIParamTypeWCF The IParamTypeWCF interface is used to retrieve the properties of a parameter type from a JAMS server.
InterfaceIResourceRefWCF The IResourceRefSQL interface is used to retrieve Resource References from a JAMS Server.
InterfaceIResourceWCF The IResourceSQL interface is used to retrieve and store Resources from a JAMS Server. Published in v4.2.6.
InterfaceIScheduleWCF The IScheduleSQL interface is used to generate projected and actual schedules.
InterfaceISecurityWCF The ISecuritySQL interface is used to retrieve and store general Security ACLs from a JAMS Server.
InterfaceIServerInfo The IServerInfo interface is implemented by the JAMSServer Service. Clients get a reference to the interface so they can find out what sort of server they're dealing with.
InterfaceIServiceCommand The IServiceCommand interface is used to send commands to JAMS Services.
InterfaceIStartEntry The IStartEntry interface is optional. It should be implemented by an execution methods startup module that wants to create a source object to be used as XM in source parsing. This method will be called by the Scheduler Service when starting a job and will have access to the entire entry to create an object from. If a method throws an exception, the job will fail with that exception.
InterfaceIStream The IStream interface is used to open streams across a WCF channel. This interface is used internally by JAMS and is not intended for user code.
InterfaceITagWCF The IMenuSQL interface is used to retrieve and store Menus from a JAMS Server.
InterfaceITenantWCF The ITenantSQL interface is used to retrieve and store tenants from a JAMS server.
InterfaceITimeZoneWCF The ITimeZoneSQL interface is used to find Time Zone information from an SQL database Reports from a JAMS Server.
InterfaceIValidationAttribute  
InterfaceIVariableRefWCF The IVariableRefSQL interface is used to retrieve Variable References from a JAMS Server.
InterfaceIVariableWCF The IVariableSQL interface is used to retrieve and store Variables from a JAMS Server.
InterfaceIWaitForWCF The IWaitForWCF interface defines the interface used between JAMSShr and JAMSServer
InterfaceIWFTrackingWCF The IWFTrackingSQL interface is used to retrieve Workflow Tracking records from a JAMS Server.
Structures
 StructureDescription
StructureDeltaTime A DeltaTime is similar to a TimeSpan but the resolution is seconds.
StructureTimeOfDay The TimeOfDay represents a time of day.
Delegates
 DelegateDescription
DelegateEntryDetailEventHandler Define the JobEventHandler delegate.
DelegateEntryEventHandler Define the EntryEventHandler delegate.
DelegateSelectionChangedEventHandler The SelectionChanged event is raised with the selected item in a submit menu changes.
Enumerations
 EnumerationDescription
EnumerationAccessBits.AccessControlAccessEnum  
EnumerationAccessBits.AgentDefinitionsAccessEnum  
EnumerationAccessBits.AppMenuAccessEnum  
EnumerationAccessBits.ConfigurationAccessEnum  
EnumerationAccessBits.CredentialDefinitionsAccessEnum  
EnumerationAccessBits.DateDefinitionsAccessEnum  
EnumerationAccessBits.DateTypeDefinitionsAccessEnum  
EnumerationAccessBits.FolderDefinitionsAccessEnum  
EnumerationAccessBits.HistoryAccessEnum  
EnumerationAccessBits.JobDefinitionsAccessEnum  
EnumerationAccessBits.MenuDefinitionsAccessEnum  
EnumerationAccessBits.MonitorAccessEnum  
EnumerationAccessBits.NamedTimeDefinitionsAccessEnum  
EnumerationAccessBits.QueueDefinitionsAccessEnum  
EnumerationAccessBits.ReportingAccessEnum  
EnumerationAccessBits.ResourceDefinitionsAccessEnum  
EnumerationAccessBits.ServerAccessAccessEnum  
EnumerationAccessBits.VariableDefinitionsAccessEnum  
EnumerationAccessObject Identifies JAMS objects that have an access control list associated with them.
EnumerationAgentAccess Specifies access control bits for Agent objects.
EnumerationAgentPlatform Defines the supported platforms. Mirrored in JAMSHostBase.JAMSSharedTypes
EnumerationAgentRights Identifies the bits that are valid in a Agent's Security Descriptor.
EnumerationAgentState The state of a JAMS Agent machine Mirrored in MVPSI.JAMS.Common.AgentState.
EnumerationAgentType Defines the supportted types of JAMS Agents Mirrored to JAMSHostBase.JAMSSharedTypes
EnumerationAlertEventId The AlertEventId enumeration is used to identify an event that occurred within JAMS for which an Alert can be issued.
EnumerationAppRights Identifies the bits that are valid in an AppSecurity Descriptor.
EnumerationBatchQueueRights Identifies the bits that are valid in a batch queue's Security Descriptor.
EnumerationComparisonOperator Identifies the comparison operator to be used in s query selection expression.
EnumerationCondition Conditions that can be tested.
EnumerationCredentialRights Identifies the bits that are valid in a Credential's Security Descriptor.
EnumerationDataType Parameter data types
EnumerationDefiningType Identifies what type of object has the initial definition of an element
EnumerationDependencyState Dependency states.
EnumerationDependencyType Dependency type, what kind of dependency is this.
EnumerationDisplayCategory DisplayCategory defines the apperance of a Node/Activity in a Diagram or Workflow.
EnumerationDocumentationType Enumeration of Document Types
EnumerationElementKind JAMS defines various kinds of elements.
EnumerationElementOf Identifys the various objects that an element can be a part of. For example, an ElementKind.Prerequisite is an ElementOf.FolderOrJob (a prerequisite is an element of a folder or a job).
EnumerationElementState Defines the current state of an element. Not all ElementTypes support all ElementStates.
EnumerationEntryEventCode Identifies what sort of Entry event has occurred.
EnumerationEntryIcon Identifies an overridden icon of a JAMS entry.
EnumerationEntryState Entry states. An entry is in one and only one state at a time.
EnumerationExceptionType JAMS Exception Types
EnumerationExecutionType Identifies a type of execution method.
EnumerationExitCodeHandling Defines how JAMS will evaluate the exit code of a job.
EnumerationFailoverRole Identifies the role played by a JAMS installation in a failover configuration.
EnumerationFailureAction Defines the action that JAMS should take if a job in a setup fails.
EnumerationFilePresence File presence
EnumerationFileTransferServerType Defines the supported server types for file transfers
EnumerationFolderAccess Specifies access control bits for Folder objects.
EnumerationFolderRights Identifies the bits that are valid in a Folder's Security Descriptor.
EnumerationGenericACEFlags Defines flags that apply to an individual ACE.
EnumerationHistorySearchOptions Options that can affect the history search.
EnumerationHistorySelectionField Identifies which history field should be references in a query selection.
EnumerationHistoryType Type of JAMS History entry. JAMS keeps track of Job run history. History entries can be one of three types: Job, Setup, or Command Procedure.
EnumerationInheritedFromType Identifies the type of object that a property or element was inherited from.
EnumerationInitiatorType InitiatorType defines the what initiated a job.
EnumerationJobAccess Specifies access control bits for Job and Setup objects.
EnumerationJobRights Identifies the bits that are valid in a Job's Security Descriptor.
EnumerationJobType JobType, what kind of job is this.
EnumerationKeyAlgorithm Define the algorithm used to generate a key.
EnumerationMailProtocol The protocol to use when connecting to a mail server
EnumerationMaxDownAction Action to take if downtime exceeds the maximum (reset, fail or continue)
EnumerationMenuType Type of Menu which is represented in the MenuLine class.
EnumerationMergeOption Defines the merge action to take with multiple PropertyDefinitions.
EnumerationMessage Enumerates message codes that are used by JAMS.
EnumerationMethodOptions Options for a submit method.
EnumerationMissedAction Valid values for MissedWindowAction.
EnumerationNonWorkdays Nonworkday handling.
EnumerationNotifyEventClass Events that can be generated by event generators.
EnumerationObjectAccess Specified bits for access to JAMS objects that are defined by the AccessObject enumeration.

These are the access bits that are the same for many objects. Some JAMS objects also have an Access enumerator that defines the access bits that apply to that object and access bits that are unique to that object.

Access bits must follow the Windows NT access mask pattern which is (from left to right): Generic - 4 bits Miscellaneous - 4 bits Standard - 8 bits Specific - 16 bits Almost all of the JAMS access bits are specific so they must be less than 0x0000FFFF.

Specific bits are assigned as follows: 0x00000001 - Add 0x00000002 - Change 0x00000004 - Inquire 0x00000008 - Manage 0x00000010 - AddJobs 0x00000020 - ChangeJobs 0x00000040 - InquireJobs 0x00000080 - DeleteJobs 0x00000100 - Execute 0x00000200 - Submit, SeeAll 0x00000400 - Debug, SeeOwn 0x00000800 - Reset 0x00001000 - Monitor 0x00002000 - Abort 0x00004000 - Acquire 0x00008000

EnumerationObjectAccessType Specifies the type of ObjectAccess an object uses.
EnumerationObjectType Identifies a specific type of JAMS object
EnumerationParameterOrigin Identifies where a parameter originated.
EnumerationPropertyOf Identifys the various objects that could possess the property.
EnumerationQueueAccess Specifies access control bits for Queue objects.
EnumerationReferenceTo ReferenceTo Enums
EnumerationReferenceType Type of reference to a JAMS object.
EnumerationReleaseType Specifies how an entry should be released.
EnumerationRenderAs Rendering text as html or plain text.
EnumerationReportDataSource The ReportDataSource enumeration identifies the data source that a report is expecting.
EnumerationRequirementType The type of object that the Resource Requirement applies to.
EnumerationResourceAccess Specifies access control bits for Resource objects.
EnumerationResourceRights Identifies the bits that are valid in a Resource's Security Descriptor.
EnumerationResponseType ResponseType defines the type of data expected to be returned to a given source.
EnumerationResubmitBase Valid values for Resubmit Base.
EnumerationRetain Specifies when a entry should be retained after completion.
EnumerationRunawayAction Action to be taken when a job or setup is a runaway.
EnumerationSchedule.Options Options that can be passed to the Schedule.Find method.
EnumerationSchedule.Reason Identifies the reason that a job was added to a schedule.
EnumerationScriptLanguage Script language.
EnumerationSeverity Completion severities.
EnumerationShortSeverity Severitys that a short jobs final severity can be changed to.
EnumerationShowOn ShowOn identifies which environments an AppMenu should be displayed.
EnumerationSingleInstanceAction Defines the action to be taken if more than one instance of a job tries to start at the same time.
EnumerationSourceFormat Identifies the format of the source text
EnumerationSshPrivateKeyFormat Defines the format that the SSH private key should be exported in.
EnumerationSshPublicKeyFormat Defines the format that the SSH Public Key should be exported in.
EnumerationStateType Flags that identify the states that an entry could be in.
EnumerationSubmit.Options The options for ISubmit.Load
EnumerationSuccessOrFailure USed to specify if we are looking for success, failure or any.
EnumerationTriState TriState properties can be True, False, or Not Specified.
EnumerationUserAccess Specifies access control bits for Username (Credential). This is the access that can be specified in the ACL that's part of a Credential definition. UsernameDefinitions access controls who is allowed to manipulate Credential objects.
EnumerationValidationType ValidationType defines the type of validation performed on a parameter value.
EnumerationVariableAccess Specifies access control bits for Variable objects.
EnumerationVariableRights Identifies the bits that are valid in a Variable's Security Descriptor.
EnumerationWorkflowState Identifies the state of a workflow.
See Also

Reference

JAMSShr Assembly

 

 

Copyright © Fortra, LLC and its group of companies.
All trademarks and registered trademarks are the property of their respective owners.