Schema blackBoxWrapperConfig.xsd


element blackBoxWrapperConfig

diagram
annotation	documentation Configuration of a black box model wrapper. It contains of three main components: alias definitions, model run, and input-output definition.

complexType ActionsXML

diagram

element ActionsXML/action

diagram
attributes	Name   Type   Use   Default   Fixed   Annotation exe   xs:string   optional         documentation Name and path of the executable file windowsExe   xs:string   optional         documentation Name and path of the executable file for Windows operating system linuxExe   xs:string   optional         documentation Name and path of the executable file for Linux operating system macExe   xs:string   optional         documentation Name and path of the executable file for Mac operating system className   xs:string   optional         documentation The openda:class name. workingDirectory   xs:string   optional         documentation Directory where executable file is run. This is usually the instance dir. This is only used in blackBoxStochModelConfig. actualWorkingDirectory   xs:string   optional         documentation Subdirectory of instance dir, where executable file has to be run. To be specified as relative path to instance dir. This is only used in blackBoxWrapperConfig. This is only used for executable files, not for Java classes. For Java classes the instanceDir is used as workingDirectory. ignoreStatus   xs:boolean   optional   false      documentation Flag for ignoring the status of the previous action step (ignoreStatus=true). Not yet implemented.
annotation	documentation Specify the consecutive actions  by model executables or classes to run, arguments to supply and fail/success checks to perform

complexType ActionXML

diagram

attributes

Name   Type   Use   Default   Fixed   Annotation exe   xs:string   optional         documentation Name and path of the executable file windowsExe   xs:string   optional         documentation Name and path of the executable file for Windows operating system linuxExe   xs:string   optional         documentation Name and path of the executable file for Linux operating system macExe   xs:string   optional         documentation Name and path of the executable file for Mac operating system className   xs:string   optional         documentation The openda:class name. workingDirectory   xs:string   optional         documentation Directory where executable file is run. This is usually the instance dir. This is only used in blackBoxStochModelConfig. actualWorkingDirectory   xs:string   optional         documentation Subdirectory of instance dir, where executable file has to be run. To be specified as relative path to instance dir. This is only used in blackBoxWrapperConfig. This is only used for executable files, not for Java classes. For Java classes the instanceDir is used as workingDirectory. ignoreStatus   xs:boolean   optional   false      documentation Flag for ignoring the status of the previous action step (ignoreStatus=true). Not yet implemented.

attribute ActionXML/@exe

annotation

documentation Name and path of the executable file

attribute ActionXML/@windowsExe

annotation

documentation Name and path of the executable file for Windows operating system

attribute ActionXML/@linuxExe

annotation

documentation Name and path of the executable file for Linux operating system

attribute ActionXML/@macExe

annotation

documentation Name and path of the executable file for Mac operating system

attribute ActionXML/@className

annotation

documentation The openda:class name.

attribute ActionXML/@workingDirectory

annotation

documentation Directory where executable file is run. This is usually the instance dir. This is only used in blackBoxStochModelConfig.

attribute ActionXML/@actualWorkingDirectory

annotation

documentation Subdirectory of instance dir, where executable file has to be run. To be specified as relative path to instance dir. This is only used in blackBoxWrapperConfig. This is only used for executable files, not for Java classes. For Java classes the instanceDir is used as workingDirectory.

attribute ActionXML/@ignoreStatus

annotation

documentation Flag for ignoring the status of the previous action step (ignoreStatus=true). Not yet implemented.

element ActionXML/arg

diagram
annotation	documentation Specify list of  input arguments of the model executable

element ActionXML/checkOutput

diagram
attributes	Name   Type   Use   Default   Fixed   Annotation file   xs:string   required         documentation Name of output file expect   xs:string   optional         documentation Expected content of the output file when the action is successful
annotation	documentation Specify list of output files to be checked after the command execution has finished

element ActionXML/checkReturnStatus

diagram
attributes	Name   Type   Use   Default   Fixed   Annotation expect   xs:string   required         documentation Expected return value when the action is successful
annotation	documentation Specify return value after the command execution has finished

complexType AliasDefinitionsXML

diagram
attributes	Name   Type   Use   Default   Fixed   Annotation defaultKeyPrefix   xs:string   optional         documentation Specify the default prefix for the alias keys defaultKeySuffix   xs:string   optional         documentation Specify the default suffix for the alias keys

attribute AliasDefinitionsXML/@defaultKeyPrefix

annotation

documentation Specify the default prefix for the alias keys

attribute AliasDefinitionsXML/@defaultKeySuffix

annotation

documentation Specify the default suffix for the alias keys

element AliasDefinitionsXML/alias

diagram
attributes	Name   Type   Use   Default   Fixed   Annotation key   xs:string   required         documentation The alias key name value   xs:string   optional         documentation Actual value referred to by the alias key keyPrefix   xs:string   optional         documentation Specify the prefix for the alias key keySuffix   xs:string   optional         documentation Specify the suffix for the alias key
annotation	documentation Create list of aliases containing keys and (optional) the corresponding values

complexType AliasDefinitionXML

diagram
attributes	Name   Type   Use   Default   Fixed   Annotation key   xs:string   required         documentation The alias key name value   xs:string   optional         documentation Actual value referred to by the alias key keyPrefix   xs:string   optional         documentation Specify the prefix for the alias key keySuffix   xs:string   optional         documentation Specify the suffix for the alias key

attribute AliasDefinitionXML/@key

annotation

documentation The alias key name

attribute AliasDefinitionXML/@value

annotation

documentation Actual value referred to by the alias key

attribute AliasDefinitionXML/@keyPrefix

annotation

documentation Specify the prefix for the alias key

attribute AliasDefinitionXML/@keySuffix

annotation

documentation Specify the suffix for the alias key

element AliasDefinitionXML/listValue

diagram
annotation	documentation This type of alias can only be used for BBAction arguments, where the argument must be specified by means of only naming the 'list value' alias. If the listValue element is present, it overrules the value attribute, indicating that the actual value is in fact a list of string arguments instead of one argument.

complexType BlackBoxWrapperConfigXML

diagram

element BlackBoxWrapperConfigXML/aliasDefinitions

diagram
attributes	Name   Type   Use   Default   Fixed   Annotation defaultKeyPrefix   xs:string   optional         documentation Specify the default prefix for the alias keys defaultKeySuffix   xs:string   optional         documentation Specify the default suffix for the alias keys
annotation	documentation Define aliases for specific model information (directory names, file names etc.). Specify the prefix and suffix for the alias keys.

element BlackBoxWrapperConfigXML/run

diagram
annotation	documentation Specify the initialize, compute and finalize actions that direct the model

element BlackBoxWrapperConfigXML/inputOutput

diagram
annotation	documentation Specify the list of input/output objects

complexType BlackBoxWrapperRunXML

diagram

element BlackBoxWrapperRunXML/initializeActions

diagram
annotation	documentation Generic method of initialization actions

element BlackBoxWrapperRunXML/initializeActionsUsingDirClone

diagram
attributes	Name   Type   Use   Default   Fixed   Annotation templateDir   xs:string            documentation Directory where the template files are stored instanceDir   xs:string            documentation The working directory where the template directory will be copied into
annotation	documentation The directory, in which the model executables and input files are located, will be copied to a new working directory. The actions are executed in this new working directory.

element BlackBoxWrapperRunXML/initializeActionsUsingFileClone

diagram
attributes	Name   Type   Use   Default   Fixed   Annotation templateFile   xs:string            documentation Name of the template file. instanceFile   xs:string            documentation File name of the instance of the template file.
annotation	documentation Some of the model files (template) will be copied to the working directory where the actions will be executed

element BlackBoxWrapperRunXML/computeActions

diagram
annotation	documentation Configure the method for model computation

element BlackBoxWrapperRunXML/additionalComputeActions

diagram
annotation	documentation Configure the actions that should be performed after all other computation actions (used for instance when the actual computation is sent to a queue. The additional computation action can then be used to start a script that checks the status of the queue.

element BlackBoxWrapperRunXML/finalizeActions

diagram
annotation	documentation Configure the method for model finalization

complexType CheckOutputXML

diagram
attributes	Name   Type   Use   Default   Fixed   Annotation file   xs:string   required         documentation Name of output file expect   xs:string   optional         documentation Expected content of the output file when the action is successful

attribute CheckOutputXML/@file

annotation

documentation Name of output file

attribute CheckOutputXML/@expect

annotation

documentation Expected content of the output file when the action is successful

complexType CheckReturnStatusXML

diagram
attributes	Name   Type   Use   Default   Fixed   Annotation expect   xs:string   required         documentation Expected return value when the action is successful

attribute CheckReturnStatusXML/@expect

annotation

documentation Expected return value when the action is successful

complexType CloneDirXML

diagram
attributes	Name   Type   Use   Default   Fixed   Annotation templateDir   xs:string   required

attribute CloneDirXML/@templateDir

---

complexType CloneFileXML

diagram
attributes	Name   Type   Use   Default   Fixed   Annotation templateFile   xs:string   required

attribute CloneFileXML/@templateFile

---

complexType InitialActionsDirCloneXML

diagram
attributes	Name   Type   Use   Default   Fixed   Annotation templateDir   xs:string            documentation Directory where the template files are stored instanceDir   xs:string            documentation The working directory where the template directory will be copied into

attribute InitialActionsDirCloneXML/@templateDir

annotation

documentation Directory where the template files are stored

attribute InitialActionsDirCloneXML/@instanceDir

annotation

documentation The working directory where the template directory will be copied into

element InitialActionsDirCloneXML/action

diagram
attributes	Name   Type   Use   Default   Fixed   Annotation exe   xs:string   optional         documentation Name and path of the executable file windowsExe   xs:string   optional         documentation Name and path of the executable file for Windows operating system linuxExe   xs:string   optional         documentation Name and path of the executable file for Linux operating system macExe   xs:string   optional         documentation Name and path of the executable file for Mac operating system className   xs:string   optional         documentation The openda:class name. workingDirectory   xs:string   optional         documentation Directory where executable file is run. This is usually the instance dir. This is only used in blackBoxStochModelConfig. actualWorkingDirectory   xs:string   optional         documentation Subdirectory of instance dir, where executable file has to be run. To be specified as relative path to instance dir. This is only used in blackBoxWrapperConfig. This is only used for executable files, not for Java classes. For Java classes the instanceDir is used as workingDirectory. ignoreStatus   xs:boolean   optional   false      documentation Flag for ignoring the status of the previous action step (ignoreStatus=true). Not yet implemented.
annotation	documentation Specify the consecutive actions  by model executables or classes to run, arguments to supply and fail/success checks to perform

complexType InitialActionsFileCloneXML

diagram
attributes	Name   Type   Use   Default   Fixed   Annotation templateFile   xs:string            documentation Name of the template file. instanceFile   xs:string            documentation File name of the instance of the template file.

attribute InitialActionsFileCloneXML/@templateFile

annotation

documentation Name of the template file.

attribute InitialActionsFileCloneXML/@instanceFile

annotation

documentation File name of the instance of the template file.

element InitialActionsFileCloneXML/action

diagram
attributes	Name   Type   Use   Default   Fixed   Annotation exe   xs:string   optional         documentation Name and path of the executable file windowsExe   xs:string   optional         documentation Name and path of the executable file for Windows operating system linuxExe   xs:string   optional         documentation Name and path of the executable file for Linux operating system macExe   xs:string   optional         documentation Name and path of the executable file for Mac operating system className   xs:string   optional         documentation The openda:class name. workingDirectory   xs:string   optional         documentation Directory where executable file is run. This is usually the instance dir. This is only used in blackBoxStochModelConfig. actualWorkingDirectory   xs:string   optional         documentation Subdirectory of instance dir, where executable file has to be run. To be specified as relative path to instance dir. This is only used in blackBoxWrapperConfig. This is only used for executable files, not for Java classes. For Java classes the instanceDir is used as workingDirectory. ignoreStatus   xs:boolean   optional   false      documentation Flag for ignoring the status of the previous action step (ignoreStatus=true). Not yet implemented.
annotation	documentation Specify the consecutive actions  by model executables or classes to run, arguments to supply and fail/success checks to perform

complexType InputOutputXML

diagram

element InputOutputXML/ioObject

diagram
attributes	Name   Type   Use   Default   Fixed   Annotation className   xs:string   required         documentation The openda:class name of the input/output object
annotation	documentation Specify the input/output object

complexType IoObjectXML

diagram
attributes	Name   Type   Use   Default   Fixed   Annotation className   xs:string   required         documentation The openda:class name of the input/output object

attribute IoObjectXML/@className

annotation

documentation The openda:class name of the input/output object

element IoObjectXML/file

diagram
annotation	documentation Name of input/output file

element IoObjectXML/id

diagram
annotation	documentation Identity of the input/output object

element IoObjectXML/arg

diagram
annotation	documentation Input argument for the corresponding openda:class

XML Schema documentation generated by XMLSpy Schema Editor http://www.altova.com/xmlspy