System String Related System Attributes

From Planimate Knowledge Base
Revision as of 17:46, 18 April 2013 by Craig.Chandler (talk | contribs) (added username strings)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

System String Related System Attributes

These system attributes provide information to assist with File input and output and management.


Name

Read / Write

Description



DatasetFileAndPath

R

This returns the path and filename of the last loaded/saved dataset1 "scenario", where the file browser was integrated into the scenario load process.

Modellers can also explicitly set it using routine operation "SetLastDataFile".

HINT: The "Include Scenario Name In Titlebar" system option shows the filename component of this in the titlebar of an application, useful in an application to remind users which data they have loaded.


LastAccessedDataFile

R

Stores last file read/written at change object.


LastAccessedDataFilePath

R

Stores the path to the last file read/written at change object.


LastLockFileError

R

If the lock is successful, the error result target is set to 0, otherwise a non zero error code (see below) is set.

If an error occurs, detail of this error is available as a string in this system attribute. If the error is that another user has the lock, then this attribute will contain the "tag" and should be displayed to the user.


LocalComputerName

R

Provides the Network Name of the Computer the Model is being run on.


ModelName

R

Numerically these return zero but if referenced in a form field OR using the new "Format Into Label" routine operation, the names can be made accessible to the modeller for display.


ScenarioName

R

Numerically these return zero but if referenced in a form field OR using the new "Format Into Label" routine operation, the names can be made accessible to the modeller for display.


UserName

R

Retrieves the name of the user,

 eg: "John Smith"

This name is not necessarily unique. This only works in a domain environment.


UserNameCanonical

R

Retrieves the user identifier in an alternative format known as a canonical name.

 eg: "somewhere.com/sales/jsmith"


UserNameNTCompatible

R

Retrieves a users name in an older Win NT "SAM" compatible format

 eg:
 "IDSTAFF\Rick"  (on a domain IDSTAFF is the domain controller)
 "LISTER\Rick"   (local account on a non domain PC called LISTER)
      

This is a flat way of identifying users which has been superceeded in LDAP environments which are hierarchic.


UserNameQualified

R

Retrieves a comma delimited list of attributes and values that uniquely define the user.

 eg: "CN=John Smith, OU=sales, DC=somewhere, DC=com"