Open Text Social Workplace Scripting
About Open Text Social Workplace Scripting
Open Text Social Workplace Scripting is a component of Open Text Social Workplace with which you can send scripted commands to the server. It is important to note that while the server is processsing a script, mail delivery is suspended until the script is finished. You may want to process large scripts during off peak hours. You can combine these commands to reduce the repetition involved in the administration of a large system.
You can use Open Text Social Workplace scripting to quickly:
• add individual users and user groups
• generate lists of users
• update user information forms and user group membership.
 WarningMany of the Scripting commands used on a FirstClass system are not valid on an Open Text Social Workplace system. Administrators are advised to restrict the use of Scripting to those examples provided in this document. Using other, unsupported scripts can potentially break functionality.
The Open Text Social Workplace scripting commands that are available to you are:
Command |
Purpose |
|
Registers users on your system and places them in user groups. |
|
Updates group membership for users, conferences, calendars, and mail lists. |
|
Updates group membership for users, conferences, calendars, and mail lists. |
|
Deletes a user from your system. |
|
Can be used to retrieve user information. |
|
Can be used to change user information. |
|
Creates Open Text Social Workplace objects most commonly used to create groups. |
|
List entire user base, including address and user group. |
|
Sends a message back to the administrator when the command is completed. |
Open Text Social Workplace Scripting syntax
What you need to know about Open Text Social Workplace Scripting syntax:
• you must place fields that contain spaces in quotation marks
Quotation marks are optional for other fields.
• you can use either single or double quotation marks
Make sure, though, that your opening and closing quotation marks match.
• your script must include optional fields that precede those fields you want to use
This is necessary because fields are recognized by their relative positions.
You can leave these fields blank by inserting empty quotation marks.
• you can omit trailing fields, those fields that follow the fields you are using
• line length maximum is 500 characters
• all time is stored in seconds.
An hour has 3,600 seconds.
A day has 86,400 seconds.
Identifying the correct commands to use
To avoid confusion and ensure you use the correct commands, you need to understand the differences between the following terms:
• network users/telecom users
The term 'network users' in Open Text Social Workplace script commands refers to regular users.
The term 'telecom users' refers to remote (external) users.
These terms are used for compatability with older scripts.
• remote users/remote names.
The term 'remote user' refers to a user who can only connect to Open Text Social Workplace through a remote session.
The term 'remote name' refers to the Directory entry for a user on another server.
Sending scripts to the server
There are two ways to send script to the server:
• send a message containing your script to Batch Admin
The scripting component executes the script on receipt. Use this method for immediate changes that will not affect users currently logged into your system.
• place a plain text file with a .ba extension and all necessary files, for example, myscript.ba, containing your script in the FCNS/Server/Batch folder (Win) or in the Library/FirstClass Server/Volumes/Master/FCNS/Server/Batch folder (Mac) or in /var/opt/fcsd/volumes/master/fcns folder (Linux).
The next time the server is started, the script will be executed and the text file deleted, Use this method for upgrades and installations.
| 