InstanceInformation

The InstanceInformation type is used hold information about an instance that can be passed between the UX and APIs.

Below are the properties and their purpose.

• string CommandName
  • Default Value: Empty string.
  • Intended Value: The name of the command to be executed on the instance when calling the API.
• Guid SessionGUID
  • Default Value: Empty Guid.
  • Intended Value: The guid of the current users active session.
• Guid UserGUID
  • Default Value: Empty Guid.
  • Intended Value: The guid of the current user.
• string ErrorMessage
  • Default Value: Empty string.
  • Intended Value: Will contain an error message if something went wrong in the API so it can be properly handled in the UX.
• string InformationMessage
  • Default Value: Empty string.
  • Intended Value: A message that’s set in the API and returned to be displayed in a notification on the UX (e.g., Saved Changes).
• Guid InstanceGUID
  • Default Value: Empty Guid.
  • Intended Value: The guid of the instance.
• Guid FormDefinitionGUID
  • Default Value: Empty Guid.
  • Intended Value: The guid of the form on the instance.
• string Name
  • Default Value: Empty string.
  • Intended Value: The name of the instance.
• string Status
  • Default Value: Empty string.
  • Intended Value: The status of the instance.
• string DataDB
  • Default Value: <ID />.
  • Intended Value: The XML of the instance as a string.
• string DataChanges
  • Default Value: Empty string.
  • Intended Value: Updated XML for the instance that is ready to be saved.
• string DeepXML
  • Default Value: <ID />.
  • Intended Value: The deep XML of the instance as a string.
• int LatestVersion
  • Default Value: 0.
  • Intended Value: The latest version of the instance.
• int LoadedVersion
  • Default Value: 0.
  • Intended Value: The version of the instance that’s loaded.
• Guid ParentGUID
  • Default Value: Empty Guid.
  • Intended Value: The guid of the instance that is the parent of this instance.
• string Hierarchy
  • Default Value: Empty string.
  • Intended Value: The full hierarchy of the instance.
• Guid ConceptGUID
  • Default Value: Empty Guid.
  • Intended Value: The guid of the concept that the instance belongs to.
• string ConceptName
  • Default Value: Empty string.
  • Intended Value: The name of the concept that the instance belongs to.
• string CreatedBy
  • Default Value: Empty string.
  • Intended Value: The name of the user that created the instance.
• string CreatedOn
  • Default Value: Empty string.
  • Intended Value: The date and time of when the instance was created.
• Guid InsertedByGUID
  • Default Value: Empty Guid.
  • Intended Value: The guid of the user that inserted the instance.
• string InsertedOn
  • Default Value: Empty string.
  • Intended Value: The date and time of when the instance was inserted.
• Guid CorrelationGUID
  • Default Value: Empty Guid.
  • Intended Value: Not currently being used.
• string InsertedBy
  • Default Value: Empty string.
  • Intended Value: The name of the user that inserted the instance.
• bool Check
  • Default Value: false.
  • Intended Value: Determines if when the instance is saved if it will be perform safety checks.
• int RequiredVersion
  • Default Value: 0.
  • Intended Value: Not currently being used.
• bool ReadDeepXML
  • Default Value: false.
  • Intended Value: Determines if the deep XML will be read and returned by default when loading the instance.
• bool CacheDeepXML
  • Default Value: false.
  • Intended Value: Determines if the deep XML for the instance will be cached.
• string Ancestors
  • Default Value: Empty string.
  • Intended Value: The ancestors of the instance.
• string OldPrimaryKey
  • Default Value: Empty string.
  • Intended Value: Not currently being used.
• Guid GoToInstance
  • Default Value: Empty Guid.
  • Intended Value: Used with the Copy component to go to the new instance that was copied.
• string DeletedInstances
  • Default Value: Empty string.
  • Intended Value: Contains a list of child instances that were deleted.
• string InstanceMilestones
  • Default Value: Empty string.
  • Intended Value: Contains a list of milestones for the instance.
• string PeerInstances
  • Default Value: Empty string.
  • Intended Value: Contains a list of peer instances for this instance.
• Guid MoveToGUID
  • Default Value: Empty Guid.
  • Intended Value: The of the instance that this instance is being moved to.
• bool CanSave
  • Default Value: true.
  • Intended Value: Indicates if the instance can be saved.
• bool CanDelete
  • Default Value: true.
  • Intended Value: Indicates if the instance can be deleted.
• string DisplayBreadcrumbs
  • Default Value: Empty string.
  • Intended Value: Contains the display type for the breadcrumbs.
• bool DeletePrompt
  • Default Value: false.
  • Intended Value: Determines if the delete prompt is visible.
• bool SuppressRecoverInstance
  • Default Value: false.
  • Intended Value: Determines if the recover instance action is suppressed.
• bool SuppressPreviousVersions
  • Default Value: false.
  • Intended Value: Determines if the previous versions action is suppressed.
• string SaveTarget
  • Default Value: Empty string.
  • Intended Value: Contains the storage target when uploading a file.
• string SaveInstanceTSQL
  • Default Value: Empty string.
  • Intended Value: Contains the TSQL to be executed each time the instance is saved.
• string SaveInstanceTarget
  • Default Value: Empty string.
  • Intended Value: Contains the target to call each time the instance is saved.
• string SaveInstanceCommand
  • Default Value: Empty string.
  • Intended Value: Contains the command to be executed on the target each time the instance is saved.
• string AllowedCommands
  • Default Value: Empty string.
  • Intended Value: Contains a list of commands that can be executed on the instance.
• string AllowedStateTransitions
  • Default Value: Empty string.
  • Intended Value: Contains a list of state transitions (events) that can be executed on the instance.
• string AllowedWizards
  • Default Value: Empty string.
  • Intended Value: Contains a list of wizards that can be executed on the instance.
• string Tabs
  • Default Value: Empty string.
  • Intended Value: Contains a list of tabs that are on the instance.
• bool AccessVisible
  • Default Value: false.
  • Intended Value: Determines if the Access action is available on the instance.
• bool CopyVisible
  • Default Value: false.
  • Intended Value: Determines if the Copy action is available on the instance.
• bool MoveVisible
  • Default Value: false.
  • Intended Value: Determines if the Move action is available on the instance.
• bool VersionVisible
  • Default Value: false.
  • Intended Value: Not currently being used.
• bool FeedbackVisible
  • Default Value: false.
  • Intended Value: Determines if the Feedback option in the generic actions list is visible.
• bool MilestonesVisible
  • Default Value: false.
  • Intended Value: Determines if the Milestones option in the generic actions list is visible.
• bool IncompleteWizardsVisible
  • Default Value: false.
  • Intended Value: Determines if the Incomplete Wizards option in the generic actions list is visible.
• bool CBModalVisible
  • Default Value: false.
  • Intended Value: Determines if the CBModalWindow is visible.
• string CBModalName
  • Default Value: Empty string.
  • Intended Value: Contains the name of the component to load in the CBModal.
• bool ExportVisible
  • Default Value: false.
  • Intended Value: Determines if the Export action is available on the instance.
• bool ImportVisible
  • Default Value: false.
  • Intended Value: Determines if the Import action is available on the instance.
• bool OnlineHelpVisible
  • Default Value: false.
  • Intended Value: Determines if the form online help button is available next to the form name.
• bool FormGeneration
  • Default Value: true.
  • Intended Value: Determines if the form for the instance should be generated.
• string FileString
  • Default Value: Empty string.
  • Intended Value: Contains the content of a file used by various component loading files.
• string FileType
  • Default Value: Empty string.
  • Intended Value: Contains the file type for a file being used by various components loading files.
• string FileName
  • Default Value: Empty string.
  • Intended Value: Contains the name of a file being used by various components loading files.
• bool FileCompressed
  • Default Value: false.
  • Intended Value: Determines if the current file being used is compressed.
• string FormType
  • Default Value: Empty string.
  • Intended Value: Contains the name of the form type for the instance.
• string FormName
  • Default Value: Empty string.
  • Intended Value: Contains the name of the form for the instance.
• bool DisplayFormName
  • Default Value: true.
  • Intended Value: Determines if the form name in the command bar will be displayed.
• string PageLayout
  • Default Value: Empty string.
  • Intended Value: Contains the page layout to be used for the instance.
• string FormTranslationXML
  • Default Value: <ID />.
  • Intended Value: Contains the translation information for the form.
• bool ValidateDeepLink
  • Default Value: false.
  • Intended Value: Determines if the deep link being used is valid.
• int WizardHeight
  • Default Value: 0.
  • Intended Value: Contains the height of the wizard instance being loaded.
• int WizardWidth
  • Default Value: 0.
  • Intended Value: Contains the width of the wizard instance being loaded.
• Guid WizardFinishTargetGUID
  • Default Value: Empty guid.
  • Intended Value: Contains guid of the instance that has the target information to for the finish call.
• Guid WizardConversionConceptGUID
  • Default Value: Empty guid.
  • Intended Value: The concept guid the wizard record will convert into once complete.
• string PendingApplyNowWizards
  • Default Value: <ID />
  • Intended Value: The XML of child wizards that are pending application.
• bool WizardApplyNow
  • Default Value: true.
  • Intended Value: Determines if the wizard should be applied once completed or be applied later by another wizard.
• string WizardExitPointValue
  • Default Value: Empty string.
  • Intended Value: Contains the application/portal to navigate to or a number that determines where to navigate to in the hierarchy when the wizard is complete.
• string WizardExitHierarchy
  • Default Value: Empty string.
  • Intended Value: Contains the hierarchy of the wizard.
• string DisplayType
  • Default Value: Web.
  • Intended Value: Contains the type of display the instance is being loaded in.
• bool IsInWindow
  • Default Value: false.
  • Intended Value: Determines if the instance is loaded in a popup window.
• string WindowHeight
  • Default Value: 90%.
  • Intended Value: Contains the height of the instance window.
• string WindowWidth
  • Default Value: 90%.
  • Intended Value: Contains the width of the instance window.
• Guid WindowInitialInstanceGUID
  • Default Value: Empty guid.
  • Intended Value: The guid of the first instance loaded in the popup window.
• bool IsOnlineHelpWindowVisible
  • Default Value: false.
  • Intended Value: Determines if the online help window is visible.
• List<HistoryInformation> RecentInstances
  • Default Value: Empty list.
  • Intended Value: Contains a list of the instances the user recently loaded.
• List<HistoryInformation> InstancesHistory
  • Default Value: Empty list.
  • Intended Value: Contains a list of the instances the user has loaded for their current session.
• int NumberOfGridColumns
  • Default Value: 12.
  • Intended Value: Contains the number of columns the form/tab will be divided into which affects how fields are mapped to the page.