| average data in collection | |
| Command Category | Aggregate |
| Command Name | average data in collection |
| Syntax | (Collection Name) (Field Name) ave << (Data) |
| Example | employees{} age ave |
| Usage | Average the non-null values in the specified data field (age) of the objects in the specified collection (employees{}), and return the result. Can also average the results of calling a method on the collection objects (employees{} getAge ave). |
| concatenate | |
| Command Category | Aggregate |
| Command Name | concatenate |
| Syntax | (Collection Name) (Field Name) concat (String) (String) << (String) |
| Example | products{} name concat ":" "????" |
| Usage | Constructs an infixed composite of data field values for all objects in a collection e.g. if you needed to email a group of EMPLOYEES, the To: address could be constructed with the following: employees{} emailAddress concat ";" >> jdoe@example.com;fbloggs@example.com The concat command will also work with method results for all objects in a collection |
| count objects in collection | |
| Command Category | Aggregate |
| Command Name | count objects in collection |
| Syntax | (Collection Name) count << (Data) |
| Example | employees{} count |
| Usage | Count the number of objects in the specified collection, and return the result. |
| maximum value of data in collection | |
| Command Category | Aggregate |
| Command Name | maximum value of data in collection |
| Syntax | (Collection Name) (Field Name) max << (Data) |
| Example | employees{} age max |
| Usage | Find the maximum of the values in the specified data field (age) of the objects in the specified collection (employees{}), and return the result. Can also find the maximum result of calling a method on the collection objects (employees{} getAge max). |
| minimum value of data in collection | |
| Command Category | Aggregate |
| Command Name | minimum value of data in collection |
| Syntax | (Collection Name) (Field Name) min << (Data) |
| Example | employees{} age min |
| Usage | Find the minimum of the values in the specified data field (age) of the objects in the specified collection (employees{}), and return the result. Can also find the minimum result of calling a method on the collection objects (employees{} getAge min). |
| sum data in collection | |
| Command Category | Aggregate |
| Command Name | sum data in collection |
| Syntax | (Collection Name) (Field Name) sum << (Data) |
| Example | employees{} age sum |
| Usage | Sum the values in the specified data field (age) of the objects in the specified collection (employees{}), and return the result. Can also sum the results from calling a method on the collection objects. |
| assign value | |
| Command Category | Assignments |
| Command Name | assign value |
| Syntax | (String) = (Data) << (Collection Name) |
| Example | aG1_theTgts = aG1theTgts{} |
| Usage | Sets the value of the specified object's (aG1) datafield (theTgts) to the value following the equals sign (aG1theTgts{}). |
| assign value | |
| Command Category | Assignments |
| Command Name | assign value |
| Syntax | (Field Name) = (Data) << (Data) |
| Example | aG1_age = 7 |
| Usage | Sets the value of the specified object's (aG1) datafield (age) to the value following the equals sign (7). The assignment command will also work on collections, assigning the value to the datafield for all objects in the collection e.g. employees{} annualLeave = 0 |
| evaluate expression | |
| Command Category | Assignments |
| Command Name | evaluate expression |
| Syntax | (Integer) << (Data) |
| Example | 3 * 3, 3 + 3, 3 - 1, 4 / 2, 2 ^ 3, #DATE# + 2, #DATE# - 7, '01/12/10' - #DATE#, #TIME# + 3600, #TIME# - 600, '12:00:00' - #TIME# |
| Usage | Evaluate an expression. |
| evaluate expression | |
| Command Category | Assignments |
| Command Name | evaluate expression |
| Syntax | (Field Name) << (Data) |
| Example | aG1_age |
| Usage | Return the value of the datafield (age) of the specified object (aG1). |
| random | |
| Command Category | Assignments |
| Command Name | random |
| Short Form | r |
| Syntax | rand (Integer) (Integer) << (Integer) |
| Example | r 1 100 |
| Usage | Return random number between 1 and 100 |
| random | |
| Command Category | Assignments |
| Command Name | random |
| Short Form | r |
| Syntax | rand << (Integer) |
| Example | rand |
| Usage | Return random number between 1 and 10 or between previous limits |
| random | |
| Command Category | Assignments |
| Command Name | random |
| Short Form | r |
| Syntax | rand (Integer) << (Integer) |
| Example | r 100 |
| Usage | Return random number between 1 and 100 |
| add ... to collection | |
| Command Category | Collections |
| Command Name | add ... to collection |
| Syntax | add (Collection Name) to (Collection Name) << (Collection Name) |
| Example | create 2 employees; add ? to (newEmployees) |
| Usage | Add the objects in the specified collection to the pre-existing collection referenced by the newEmployees relation if they do not already exist, returning the destination collection. |
| add ... to collection | |
| Command Category | Collections |
| Command Name | add ... to collection |
| Syntax | add (Object Name) to (Collection Name) << (Collection Name) |
| Example | create a customer; add ? to (theBuyers) |
| Usage | Add the specified object to the pre-existing collection referenced by the relation (theBuyers) if it does not already exist. |
| clone collection | |
| Command Category | Collections |
| Command Name | clone collection |
| Syntax | clone (Collection Name) (Class Name) (Collection Name) << (Collection Name) |
| Example | clone orders{} INVOICE billsToSend{} |
| Usage | Clone all objects in a specified collection into another collection of objects of a different specified class. Matching data fields and relationships will be intelligently copied into the cloned objects, and the target collection will be returned. |
| delete collection | |
| Command Category | Collections |
| Command Name | delete collection |
| Short Form | del |
| Syntax | delete (Collection Name) << (null) |
| Example | delete aG1{} |
| Usage | Delete the specified collection AND all the objects it contains. |
| empty collection | |
| Command Category | Collections |
| Command Name | empty collection |
| Syntax | empty (Collection Name) << (Collection Name) |
| Example | empty aG1{} |
| Usage | Empty the specified collection of all of its objects without deleting them or the collection. Should not be used on contained relationships. |
| filter collection | |
| Command Category | Collections |
| Command Name | filter collection |
| Syntax | filter (Collection Name) ([ code or expression ]) (Collection Name) << (Collection Name) |
| Example | filter markets{} [growth > 10] emergents{} |
| Usage | Filter the specified collection (markets{}) based on a WHERE condition [growth > 10] and place the objects meeting the condition into an existing collection (emergents{}). |
| flush collection | |
| Command Category | Collections |
| Command Name | flush collection |
| Syntax | flush (Collection Name) << (Collection Name) |
| Example | flush aG1{} |
| Usage | Delete all objects in the specified collection without deleting the collection. |
| getfrom collection | |
| Command Category | Collections |
| Command Name | getfrom collection |
| Syntax | getfrom (Collection Name) << (Object Name) |
| Example | getfrom (theTgts) |
| Usage | Reads and returns an object from a collection, without removing it. Stacks return the 'top' object, Queues return the 'first' object and Sets return a random object. |
| getfrom collection | |
| Command Category | Collections |
| Command Name | getfrom collection |
| Syntax | getfrom (Collection Name) (Integer) << (Object Name) |
| Example | getfrom (theTgts) 3 |
| Usage | Reads and returns an object from a specified position (3) in an 'ordered' collection, without removing it from the collection. If the position specified is out of bounds, then the 'first' or 'last' object is returned. Sets always return random elements. |
| getfrom collection | |
| Command Category | Collections |
| Command Name | getfrom collection |
| Syntax | getfrom (Collection Name) ([ code or expression ]) << (Object Name) |
| Example | getfrom (theTgts) [t1 == 4] |
| Usage | Reads and returns the first object from a collection where the bracketed expression evaluates to true, without removing it from the collection. |
| morph collection | |
| Command Category | Collections |
| Command Name | morph collection |
| Syntax | morph (Collection Name) (Class Name) (Collection Name) << (Collection Name) |
| Example | morph players{} ENTRANT all_entrants{} |
| Usage | Morph all objects in a specified collection into another collection of objects of a different specified class. Matching data fields and relationships will be intelligently copied into the morphed object, returning the target collection. Unlike cloning, with morphing the original collection and objects are deleted. |
| object in collection | |
| Command Category | Collections |
| Command Name | object in collection |
| Syntax | (Object Name) in (Collection Name) << (True/False) |
| Example | if [#OBID# in employees{}] [echo "Found"] |
| Usage | Checks for the existence of an object in a collection and returns true if it exists and false otherwise. |
| queue collection | |
| Command Category | Collections |
| Command Name | queue collection |
| Syntax | (Collection Name) queue << (Collection Name) |
| Example | employees{} queue |
| Usage | Convert the specified collection (employees{}) into a Queue collection and return it. Objects added to a queue are placed at the 'end' and objects removed from a queue are taken from the 'start'. All new internal Sooplet collections are created as Queues. |
| remove ... from collection | |
| Command Category | Collections |
| Command Name | remove ... from collection |
| Syntax | remove (Object Name) from (Collection Name) << (Object Name) |
| Example | remove aG1 from (theTgts) |
| Usage | Remove and return the specified object (aG1) from the specified relationship collection (theTgts). |
| removefrom collection | |
| Command Category | Collections |
| Command Name | removefrom collection |
| Syntax | removefrom (Collection Name) << (Object Name) |
| Example | removefrom (theTgts) |
| Usage | Removes and returns an object from a collection. Stacks return the 'top' object, Queues return the 'first' object and Sets return a random object. Empty collections return 'null'. |
| removefrom collection | |
| Command Category | Collections |
| Command Name | removefrom collection |
| Syntax | removefrom (Collection Name) (Integer) << (Object Name) |
| Example | removefrom (theTgts) 3 |
| Usage | Removes and returns an object from a specified position (3) in an 'ordered' collection. If the position specified is out of bounds, then the 'first' or 'last' object is returned. Sets always remove random elements. |
| removefrom collection | |
| Command Category | Collections |
| Command Name | removefrom collection |
| Syntax | removefrom (Collection Name) ([ code or expression ]) << (Object Name) |
| Example | removefrom (theTgts) [t1 == 4] |
| Usage | Removes all objects from a collection where the bracketed expression evaluates to true. Returns the last object removed. |
| set collection | |
| Command Category | Collections |
| Command Name | set collection |
| Syntax | (Collection Name) set << (Collection Name) |
| Example | colours{} set |
| Usage | Convert the specified collection (colours{}) into a Set collection and return it. Note that this will remove all duplicates from the collection, as sets cannot contain duplicates. All new internal Sooplet collections are created as Queues. |
| sort collection | |
| Command Category | Collections |
| Command Name | sort collection |
| Syntax | sort (Collection Name) (Field Name) (asc | desc) << (null) |
| Example | sort employees{} age desc |
| Usage | Sort the specified collection (employees{}) based on the specified field (age) in the specified order (descending). |
| stack collection | |
| Command Category | Collections |
| Command Name | stack collection |
| Syntax | (Collection Name) stack << (Collection Name) |
| Example | crisps{} stack |
| Usage | Convert the specified collection (crisps{}) into a Stack collection and return it. Objects added to a stack are placed on the 'top', and objects removed from a stack are taken from the 'top'. All new internal Sooplet collections are created as Queues. |
| equal to | |
| Command Category | Comparison |
| Command Name | equal to |
| Syntax | (Anything) == (Anything) << (True/False) |
| Example | aG1_age = 3; aG2_age = 3; aG1_age == aG2_age |
| Usage | Return 'true' if the item on the left of the == sign is the same as the item on the right, otherwise return 'false'. If the items are data fields, then their data values are compared, otherwise the items are compared. |
| logical and | |
| Command Category | Comparison |
| Command Name | logical and |
| Short Form | && |
| Syntax | (True/False) and (True/False) << (True/False) |
| Example | aG1_retired and aG1_male |
| Usage | return the logical and of the specified items. If either item is not true or false, returns null. |
| logical or | |
| Command Category | Comparison |
| Command Name | logical or |
| Short Form | || |
| Syntax | (True/False) or (True/False) << (True/False) |
| Example | aG1_retired or aG1_male |
| Usage | return the logical or of the specified items. If either item is not true or false, returns null. |
| not equal to | |
| Command Category | Comparison |
| Command Name | not equal to |
| Syntax | (Anything) != (Anything) << (True/False) |
| Example | aG1_age = 3;aG2_age = 6; aG1_age != aG2_age |
| Usage | Return 'true' if the item on the left of the != sign is not the same as the item on the right, otherwise return 'false'. If the items are data fields, then their data values are compared, otherwise the items are compared. |
| define method | |
| Command Category | Methods |
| Command Name | define method |
| Syntax | (Class
Name) (Method Name) ([ code or expression ]) (onCreate, onDataEdit,
onDataOk, form, table, hidden, private, pulse) << (Class Name) |
| Example | ORDER issueInvoice [invoice = true] table |
| Usage | Define the issueInvoice Table Button method in the ORDER class. Returns the class name. onCreate, onDataEdit and onDataOK methods must be named exactly as shown, in which case the Method Type can be omitted. Form Button (Type form), Table Button (Type table), Hidden (Type hidden), Private (Type private) and Pulse (Type pulse) methods can take any legal name. |
| method call | |
| Command Category | Methods |
| Command Name | method call |
| Syntax | (Method Call) (Anything) (Anything) << (Anything) |
| Example | aG1_addToBasket |
| Usage | Call the addToBasket method of the specified object (aG1). Returns the method's response. |
| method call | |
| Command Category | Methods |
| Command Name | method call |
| Syntax | (Collection Name) (Method Name) (Anything) (Anything) << (Anything) |
| Example | employees{} pay |
| Usage | Call the pay method on all the objects in the specified collection (employees{}). Returns the method's response from calling the final object. If the collection contains objects that have no pay method they will be ignored. |
| method call | |
| Command Category | Methods |
| Command Name | method call |
| Syntax | (Object Name) (Method Name) (Anything) (Anything) << (Anything) |
| Example | aG1 addToBasket |
| Usage | Call the addToBasket method of the specified object (aG1). Returns the method's response. This is the alternative syntax to the aG1_addToBasket form. |
| clone object | |
| Command Category | Object Creation/Deletion |
| Command Name | clone object |
| Syntax | clone (Object Name) (Class Name) << (Object Name) |
| Example | clone aG1 INVOICE |
| Usage | Clone an object into an object of a different class. Matching data fields and relationships will be intelligently copied into the cloned object, and the new object will be returned. |
| create object | |
| Command Category | Object Creation/Deletion |
| Command Name | create object |
| Short Form | c |
| Syntax | create (Integer) (Class Name) ([ code or expression ]) << (Collection Name) |
| Example | create 2 employees |
| Usage | Create multiple objects of the specified class, returning the collection created to hold the new objects. Classes can be specified as plural (dogs) or singular (dog). Optional parameters [param1,param2,...] can be passed to the object constructor. |
| create object | |
| Command Category | Object Creation/Deletion |
| Command Name | create object |
| Short Form | c |
| Syntax | create (Class Name) ([ code or expression ]) << (Object Name) |
| Example | create employee [param1,param2] |
| Usage | Create a single object of the specified class, returning the object name. Should the specified class not exist, it will be created. Optional parameters [param1,param2,...] can be passed to any object constructor. |
| create object | |
| Command Category | Object Creation/Deletion |
| Command Name | create object |
| Short Form | c |
| Syntax | create (Class Name) with ([ code or expression ]) ([ code or expression ]) << (Object Name) |
| Example | create sce with [1,test] [param1,param2] |
| Usage | Create an object of the specified class, populating data fields with supplied data, returning the object name. Should the specified class not exist, it will be created. Optional parameters [param1,param2,...] can be passed to the object constructor. |
| delete object | |
| Command Category | Object Creation/Deletion |
| Command Name | delete object |
| Short Form | del |
| Syntax | delete (Object Name) << (null) |
| Example | delete aG1 |
| Usage | Delete the specified object and remove it from all collections. |
| morph object | |
| Command Category | Object Creation/Deletion |
| Command Name | morph object |
| Syntax | morph (Object Name) (Class Name) << (Object Name) |
| Example | morph aG1 INVOICE |
| Usage | Morph an object into an object of a different class. Matching data fields and relationships will be intelligently copied into the morphed object, and the new object will be returned. Unlike cloning, with morphing the original object is deleted. |
| set owner | |
| Command Category | Object Creation/Deletion |
| Command Name | set owner |
| Syntax | setowner (Object Name) (Username) << (Username) |
| Example | setowner aG1 fred.bloggs |
| Usage | Set fred.bloggs as the owner of the aG1 object. For secure sooplets, if fred.bloggs doesn't exist as a user, then the object will be assigned to the administrator (if the value of the UnknownOwnerAction property is 'admin'), or fred.bloggs will be created otherwise. In an unsecure sooplet, objects without owners will be assigned to 'Everyone'. |
| execute line | |
| Command Category | Program Flow |
| Command Name | execute line |
| Short Form | ex |
| Syntax | execute ([ code or expression ]) << (Anything) |
| Example | execute [create an employee] |
| Usage | Execute the command line enclosed in square brackets. Returns the response of the command line. |
| exit | |
| Command Category | Program Flow |
| Command Name | exit |
| Syntax | exit |
| Example | if [aG1_age < 60] [exit] |
| Usage | If the specified condition [aG1_age < 60] evaluates to true, exit the method. |
| if then else | |
| Command Category | Program Flow |
| Command Name | if then else |
| Syntax | if ([ code or expression ]) ([ code or expression ]) ([ code or expression ]) << (Anything) |
| Example | if [aG1_age < 33] [echo under] [echo over] |
| Usage | If the specified condition [aG1_age < 33] evaluates to true, execute the first command fragment [echo under] else execute the optional second command fragment [echo over] |
| repeat n times | |
| Command Category | Program Flow |
| Command Name | repeat n times |
| Syntax | repeat (Integer) ([ code or expression ]) << (Anything) |
| Example | repeat 3 [echo "found"] |
| Usage | Repeat the command fragment ([echo "found"]) a fixed number of times (3). |
| return | |
| Command Category | Program Flow |
| Command Name | return |
| Syntax | return (Anything) << (Anything) |
| Example | return "true" |
| Usage | Returns the specified item from a method as the response. |
| while do | |
| Command Category | Program Flow |
| Command Name | while do |
| Syntax | while ([ code or expression ]) ([ code or expression ]) |
| Example | while [aG1_age < 60] [aG1_age = (aG1_age + 1)] |
| Usage | While the specified condition [aG1_age < 10] evaluates to true, execute the specified command fragment [aG1_age = (aG1_age + 1)] |
| run document | |
| Command Category | Queries/Reports/Documents |
| Command Name | run document |
| Syntax | rundocument (Document Name) (Object Name) << (File Path) |
| Example | rundocument myDocument #OBID# |
| Usage | Creates
a document from the pre-saved document template (myDocument) merged
with data from the specified object (#OBID#). The response is a file
path that can be used as an argument to the sendmail command, to send
an email attachment e.g. sendmail "me@example.com" "you@example.com"
"Email Document from Sooplet" "Please find attached" (rundocument
"Welcome Letter" #OBID#) Note that this command only works with Public Documents. |
| run query | |
| Command Category | Queries/Reports/Documents |
| Command Name | run query |
| Syntax | runquery (Query Name) ([ xml | html | csv | txt ]) << (String) |
| Example | runquery myQuery xml |
| Usage | Executes a pre-saved query (myQuery), complete with row and column filtering, sorting and summary calculations. The query output can be formatted as xml, txt, csv or html. The response is a character string that can be displayed to the user e.g. echo (runquery "New Starters" html) or sent in the body of an email e.g. sendmail "me@example.com" "you@example.com" "Email Query from Sooplet" (runquery "New Starters" html) |
| run query | |
| Command Category | Queries/Reports/Documents |
| Command Name | run query |
| Syntax | runquery (Query Name) (String) |
| Example | runquery "New Starters" myHTMLSoopletQueryStyle.xsl |
| Usage | Executes a pre-saved query (New Starters), complete with row and column filtering, sorting and summary calculations. The query is formatted as xml and styled with the referenced stylesheet (myHTMLSoopletQueryStyle.xsl). The output is a character string that can be displayed to the user e.g. echo (runquery "New Starters" myHTMLSoopletQueryStyle.xsl) or sent as an email e.g. sendmail "me@example.com" "you@example.com" "Email Query from Sooplet" (runquery "New Starters" myHTMLSoopletQueryStyle.xsl). Custom stylesheets should be saved in the stylesheets folder under the default installation folder. The default templates HTMLSoopletQueryStyle.xsl, CSVSoopletQueryStyle.xsl and TxtSoopletQueryStyle.xsl can be copied and modified to provide the output you require. |
| run report | |
| Command Category | Queries/Reports/Documents |
| Command Name | run report |
| Syntax | runreport (Report Name) ([ xml | html | csv | txt ]) << (String) |
| Example | runreport [EMPLOYEE] html |
| Usage | Executes a report based on a Class [EMPLOYEE]. The report can be formatted as xml, txt, csv or html. The response is a character string that can be displayed to the user e.g. echo (runreport [EMPLOYEE] txt) or sent as an email e.g. sendmail "me@example.com" "you@example.com" "Email Report from Sooplet" (runreport [EMPLOYEE] html). The report can be a Relations report [EMPLOYEE.*] or a Routed report [EMPLOYEE], [POST reportsTo PRINCIPAL] e.g. runreport [EMPLOYEE thePost PRINCIPAL] html. |
| include script | |
| Command Category | Scripts |
| Command Name | include script |
| Syntax | include (String) << (Anything) |
| Example | include employee.ssp |
| Usage | Include the specified SOOPSCRIPT file which can contain library definitions. If a full path is specified the script will be loaded from there, otherwise the default script folder will be searched for the script. |
| confirm | |
| Command Category | User Interaction |
| Command Name | confirm |
| Syntax | confirm (String) << (True/False) |
| Example | confirm "Are you 21 ?" |
| Usage | Prompt for confirmation with a pop-up dialog using the literal string supplied. Return True or False. |
| deny | |
| Command Category | User Interaction |
| Command Name | deny |
| Syntax | deny (String) << (True/False) |
| Example | deny "Are you 21 ?" |
| Usage | Prompt for denial with a pop-up dialog using the literal string supplied. Return True or False. This command is the opposite of confirm. |
| echo to screen | |
| Command Category | User Interaction |
| Command Name | echo to screen |
| Syntax | echo (Anything) (Anything) (Anything) (Anything) << (String) |
| Example | echo hello |
| Usage | Echo the specified string literal, or data field to a message box. Long text will be displayed in message pane, and html will be displayed in a browser window. |
| get link | |
| Command Category | User Interaction |
| Command Name | get link |
| Syntax | getlink (Object Name) (String) (Hostname:Port) << (String) |
| Example | getlink #OBID# "Click here..." "host:port" |
| Usage | The getlink command assembles a link to the SoopletServer page for a named object. When executed within the sooplet server, the getlink command returns an html anchor tag that contains a valid URL pointing to the object on the SoopletServer. When executed in Instant Soop the link text will include a warning message 'Dummy Link For Testing Only". If the host: port details are ommitted, then the link will reference the soopletServer instance from which the link was generated. |
| input object | |
| Command Category | User Interaction |
| Command Name | input object |
| Syntax | input (String) (Collection Name) << (Object Name) |
| Example | input "Select Object ?" tgts{} |
| Usage | Prompt for an object in the named collection, from a dropdown list of badges. Return the object chosen. |
| input value | |
| Command Category | User Interaction |
| Command Name | input value |
| Syntax | input (String) (String) << (String) |
| Example | input "What is your Age ?" 21 |
| Usage | Prompt for input with a pop-up dialog using the literal string supplied. Offer the default value supplied. Return the value entered. |
| log off | |
| Command Category | User Interaction |
| Command Name | log off |
| Syntax | logoff |
| Example | if [job == done] [logoff] |
| Usage | The logoff command can be useful in workflow applications hosted on the SoopletServer. The getlink command can generate links to object editing forms. If the onDataOk method for the Class contains the logoff command then the user can just securely edit a single object and be logged out automatically. |
| sendmail | |
| Command Category | User Interaction |
| Command Name | sendmail |
| Syntax | sendmail FromAddress ToAddress Subject Message Attachment << (null) |
| Example | sendmail "me@example.com" "you@example.com" "Email from Sooplet" "Please check this!" "C:\report.rtf" |
| Usage | Sends an email from the 'From' address, to the 'To' address with a Subject, Message and optional Attachment. Note that sendmail requires the smtpHost to be configured in the instsoop.dat file (or spltsvr.dat). |
| ? | |
| Command Category | System Variables |
| Command Name | ? |
| Short Form | ? |
| Syntax | ? << (String) |
| Example | 3 + 2;echo ? << 5 |
| Usage | Returns the result from the previous SoopScript command |
| #OBID# | |
| Command Category | System Variables |
| Command Name | #OBID# |
| Short Form | |
| Syntax | #OBID# << (String) |
| Example | echo #OBID# << aG1 |
| Usage | Returns the internal unique id of the object |
| #CLASS# | |
| Command Category | System Variables |
| Command Name | #CLASS# |
| Short Form | |
| Syntax | #CLASS# << (String) |
| Example | echo #CLASS# << EMPLOYEE |
| Usage | Returns the class of the object |
| #INDEX# | |
| Command Category | System Variables |
| Command Name | #INDEX# |
| Short Form | |
| Syntax | #INDEX# << (String) |
| Example | echo #INDEX# << 1 |
| Usage | Returns the index number of the object |
| #OWNER# | |
| Command Category | System Variables |
| Command Name | #OWNER# |
| Short Form | |
| Syntax | #OWNER# << (String) |
| Example | echo #OWNER# << theAdministrator |
| Usage | Returns the username of the owner of the object |
| #USER# | |
| Command Category | System Variables |
| Command Name | #USER# |
| Short Form | |
| Syntax | #USER# << (String) |
| Example | echo #USER# << theAdministrator |
| Usage | Returns the username of the current user |
| #DATE# | |
| Command Category | Date System Variables |
| Command Name | #DATE# |
| Short Form | |
| Syntax | #DATE# << (String) |
| Example | echo #DATE# << 01/02/2009 |
| Usage | Returns the current date |
| #DAY# | |
| Command Category | Date System Variables |
| Command Name | #DAY# |
| Short Form | |
| Syntax | #DAY# << (String) |
| Example | echo #DAY# << 1 |
| Usage | Returns the current day of the month as a number (1 - 31) |
| #MONTH# | |
| Command Category | Date System Variables |
| Command Name | #MONTH# |
| Short Form | |
| Syntax | #MONTH# << (String) |
| Example | echo #MONTH# << 2 |
| Usage | Returns the current month of the year as a number (1 -12) |
| #YEAR# | |
| Command Category | Date System Variables |
| Command Name | #YEAR# |
| Short Form | |
| Syntax | #YEAR# << (String) |
| Example | echo #YEAR# << 2009 |
| Usage | Returns the current year |
| #TIME# | |
| Command Category | Time System Variables |
| Command Name | #TIME# |
| Short Form | |
| Syntax | #TIME# << (String) |
| Example | echo #TIME# << 12:34:42 |
| Usage | Returns the current time |
| #HOUR# | |
| Command Category | Time System Variables |
| Command Name | #HOUR# |
| Short Form | |
| Syntax | #HOUR# << (String) |
| Example | echo #HOUR# << 12 |
| Usage | Returns the current hour of the day |
| #MINUTE# | |
| Command Category | Time System Variables |
| Command Name | #MINUTE# |
| Short Form | |
| Syntax | #MINUTE# << (String) |
| Example | echo #MINUTE# << 34 |
| Usage | Returns the current minute of the hour of the day |
| #SECOND# | |
| Command Category | Time System Variables |
| Command Name | #SECOND# |
| Short Form | |
| Syntax | #SECOND# << (String) |
| Example | echo #SECOND# << 42 |
| Usage | Returns the current second of the minute of the hour of the day |
| %... | |
| Command Category | Variables |
| Command Name | %... |
| Short Form | |
| Syntax | %length = (anything) << (String) |
| Example | %length = 5;echo %length << 5 |
| Usage | Assigns the value 5 to the global variable %length. Valid names can be made up of letters, digits and underscores. Variable names must not be the same as reserved soop commands. Variables are case-sensitive. |