Advertising banner:
PUT PERMISSIONS  
Help Contents • Administration • FirstClass Scripting • Help Document
   
   
   
PUT PERMISSIONS



Function
The PERMISSIONS keyword updates the fields on the conference Permissions form, the Mailbox Permissions form, the contact database Permissions form, and the calendar Permissions form. There are two types of permissions forms. The first is used with the container groups and calendar groups located in the Groups folder on the admin Desktop. The second is used with a Mailbox, contact database, conference or calendar. Each form has its own syntax. The EXPORT command can be used to extract the permissions of an existing conference contact database, or calendar.
The conference Permissions form is called ACL, form ID 103 in Example.fc. Calendar Permissions is form ID 64, Conference Group Permissions is form ID 100, Calendar Group Permissions is form ID 63 and the Contact Database Permissions is form ID 55.



Syntax
For "Who", "Access", and "Permissions" field (29) on the Permissions form for container or calendar groups:
PUT PERMISSIONS MODEL groupname path 29 index name fieldvalue
06092010_122716_1.jpg        Note
The field ID for setting both the "Who" and "Access" fields is 29. Both parameters are set at the same time.
For other fields on the Permissions form for a container or calendar group:
PUT PERMISSIONS MODEL groupname path fieldlist
For "Who', "Access", and "Permissions" field (29) on the Permissions form for a conference or calendar:
PUT PERMISSIONS path 29 index name fieldvalue
06092010_122716_1.jpg        Note
The field ID for setting both the "Who" and "Access" fields is 29. Both parameters are set at the same time.
For other fields on the Permissions form for a conference or calendar:
PUT PERMISSIONS path fieldlist
Parameters


path
The conference or calendar specified by the path, relative to the administrator's Desktop. Separate the components of the path with colons.
The PATHCHAR command can be used to change the default path character.
groupname
The name of the conference group or calendar group.
index
The position to insert in the list. Use 0 for the first name, 1 for the second name, and so on.
fieldlist
A list of field descriptor triplets in the form:
fieldID fieldtype fieldvalue
fieldID
The field ID.
fieldtype
The field type:
0
String. Includes fields defined as text and editable lists.
6
Checkbox. Includes fields defined checkboxex and radio groups.
7
Popup. Includes fields defined as a static lists and icons.
14
Number. Includes fields defined as numeric and date & time.
fieldvalue
The field value. May be enclosed in quotes if needed.
The field value must be numeric for checkbox, popup, and number. Popup values can be found using FirstClass Designer.




Examples
To set the permissions of a container group called "Employee Conferences" so that the Employee group is a contributor, type the following:
PUT PERMISSIONS MODEL "employee conferences" "" 29 0 "Employee" 87552
06092010_122716_1.jpg        Note
When working with container groups the path is always represented by empty quotation marks.
To set the permissions for the Employee Lounge conference so the Employee group members are contributors and All Users are disallowed, enter the following:
PUT PERMISSIONS "General Conferences:employee lounge" 29 0 "employee" 122624 29 1 "all users" 0
To make an unpublished conference a member of the Employee Conferences and Custom Columns container groups, enter:
PUT PERMISSIONS "General Conferences:secret employee lounge" 19 0 "Employee Conferences" 19 1 "Custom Columns"
06092010_122716_1.jpg        Note
To make conference whose name appears in the Directory a member of a group see PGADD. PGADD command does not require a path, just the container name.
To create custom permissions, add the values of all the permissions you want assigned to the user, group, or gateway as the value of fieldvalue.
The value of the send permission is 2048 and the value of Delete own items is 256.  Adding these two values together will give you a field value of 2304.
To set the permissions of the Employee Lounge conference to enable all users to send and delete their own mail, enter:
PUT PERMISSIONS "General Conferences:employee lounge" 29 0 "all users" 2304
To set the permissions of the Employee Conferences group to enable the employees to send and delete their own mail, enter:
PUT PERMISSIONS MODEL "Employee Conferences" "" 29 0 "Employee UG" 2304
To set the permissions of Susan Bram's Mailbox so Paul Chu to Send and Unsend, enter:
PUT PERMISSIONS desktop sbram mailbox 29 0 "Paul Chu" 2304
To stop Susan Bram from recieving any Internet mail, enter:
PUT PERMISSIONS desktop sbram mailbox 29 0 "internet" 0
To set the permissions of the Customer List contact database so that Sales can create and modify entries, employees can read the entries and everyone else is disallowed, enter:
PUT PERMISSIONS "General Conferences:Employee Lounge:Customer List" 29 0 "Sales" 131054 29 1 "Employees" 29 2 "All Users" 0
Field values for preset conference permissions:


0
Disallowed
512
Summary
4608
Browser
87552
Reader
122624
Contributor
122752
Approver
122798
Moderator
131054
Creator
131071
Controller

Field values for individual conference permissions:


1
Edit permissions.
2
User is the moderator.
4
Delete any item.
8
Directly create items.
16
Edit read-only items.
32
Edit items.
64
Save window and view properties.
128
Approve items.
256
Delete own items.
512
Open conference.
1024
Search.
2048
Send.
4096
Open items.
8192
Create subconferences.
16384
Download files and attachments.
32768
View permissions.
65536
View history.

To create custom permissions add the values of all the permissions you want assign to the user, group, or gateway as the fieldvalue.
Field values for preset calendar permissions:


0
No Access
2097152
See Times
2304
Schedule Only
2099456
Schedule+Times
2100992
Schedule+Details
2219821
Editor

Field values for individual calendar permissions:


0
Disallowed.
1
Edit permissions.
2
Moderator.
4
Delete any item.
8
Create items.
16
Edit read-only items.
32
Edit items.
64
View properties.
128
Approve items.
256
Delete own items.
512
View unrestricted details.
1024
Search items.
2048
Add participants.
4096
Open items.
16384
Download files.
32768
View permissions.
65536
View history.
2097152
Open calendar.

Field values for preset contact database permissions:


0
Disallowed
512
View List
87552
Open Items
131054
Creator

The form ID of the Phone Call form is 128. To set the "Form to use" field (field ID 2008) to the Phone Call form on the Permissions form of a conference called Employee Lounge, enter:
PUT PERMISSIONS "General Conferences:Employee Lounge" 2008 14 128
The form ID of the Phone Call form is 128. To set the "Form to use" field (field ID 2008) to the Phone Call form on the Permissions form of a conference group called Employee Read, enter:
PUT PERMISSIONS MODEL "Employee Conferences" "" 2008 14 128
To set Employee Lounge's "Message expiry" to Never, enter:
PUT PERMISSIONS "General Conferences:Employee Lounge" 1004 14 214849374
To set Employee Lounge's "Message expiry" to 1 day, enter:
PUT PERMISSIONS "General Conferences:Employee Lounge" 1004 14 86400
To set Employee Conference group's "Message expiry" to Never, enter:
PUT PERMISSIONS MODEL "Employee Conferences" "" 1004 14 214849374
To set Employee Lounge's "Message expiry" to 1 day, enter:
PUT PERMISSIONS MODEL "Employee Conferences" "" 1004 14 86400
06092010_122716_1.jpg        Notes
The server stores time in seconds.  There are 86400 seconds in a day. A fieldvalue of 60 would be 60 seconds, not 60 days. Any fieldvalue less than a day is ignored.
To make an existing conference or calendar unpublished, enter:
PUT PERMISSIONS "General Conferences:Employee Lounge" 2007 6 1
PUT PERMISSIONS "General Conferences:Employee Lounge:Staff Calendar" 2007 6 1



Related commands
To fully update the Permissions form, four commands are required:
The About button gives you access to the published conference's About form. Use PUT ABOUT conference name to update. Use PUT ABOUTPATH for unpublished conferences.
The Directory info button gives you access to the Directory form. Use PUT DIRECTORY CONFERENCE <conference name> or Use PUT DIRECTORY CALENDAR <calendar name> to update.
The membership list is updated with the REMOVE, LINK USER  or LINK SPECIAL command.
The group membership of a published container is updated with the PGADD or PGDEL command.