1 03/06/85  forum_admin_
  2 
  3 
  4 Entry points in forum_admin_:
  5    (List is generated by the help command)
  6 
  7 
  8 The forum_admin_ subroutine provides a site administrative interface to
  9 the Forum Interactive Meeting System.
 10 
 11 
 12 :Entry:  change_chairman:  03/06/85 forum_admin_$change_chairman
 13 
 14 
 15 Function:  This entry is used to change the chairman of a Forum meeting
 16 by a system administrator who is not the current chairman of the
 17 meeting.
 18 
 19 
 20 Syntax:
 21 declare forum_admin_$change_chairman entry (char(*), char(*), char(*),
 22      fixed bin(35));
 23 call forum_admin_$change_chairman (dirname, entryname, chairman,
 24      status);
 25 
 26 
 27 Arguments:
 28 dirname
 29    is the pathname of the directory containing the meeting.  (Input)
 30 entryname
 31    is the entryname of the meeting.  (Input) The ".forum" suffix is
 32    required.
 33 chairman
 34    is the name of the new chairman of the meeting, in the form
 35    Person_id.Project_id.  The new chairman must already be a
 36    participant.  (Input)
 37 status
 38    is a standard status code.  (Output) It can have one of the
 39    following values:
 40    forum_error_table_$no_such_user
 41       The supplied new chairman is not a participant.
 42 
 43 
 44 Access required:
 45 The caller must have modify permission on the containing directory.
 46 
 47 
 48 :Entry:  convert:  03/06/85 forum_admin_$convert
 49 
 50 
 51 Function:  This entry is used to convert a meeting created with
 52 pre-MR11 software into a current version meeting without requiring the
 53 user to be the chairman.
 54 
 55 
 56 Syntax:
 57 declare forum_admin_$convert entry (char (*), char (*), fixed bin
 58      (35));
 59 call forum_admin_$convert (dirname, entryname, status);
 60 
 61 
 62 Arguments:
 63 dirname
 64    is the name of the directory containing the meeting.  (Input)
 65 entryname
 66    is the name of the meeting.  (Input) The ".forum" suffix is
 67    required.
 68 status
 69    is a standard status code.
 70 
 71 
 72 Access required:
 73 The caller must have modify permission on the containing directory.
 74 
 75 
 76 :Entry:  delete_forum:  03/06/85 forum_admin_$delete_forum
 77 
 78 
 79 Function:  This entry is used to delete a meeting by a system
 80 administrator who is not the current chairman of the meeting.
 81 
 82 
 83 Syntax:
 84 declare forum_admin_$delete_forum entry (char(*), char(*),
 85      fixed bin(35));
 86 call forum_admin_$delete_forum (dirname, entryname, status);
 87 
 88 
 89 Arguments:
 90 dirname
 91    is the pathname of the directory containing the meeting.  (Input)
 92 entryname
 93    is the entryname of the meeting.  The ".forum" suffix is required.
 94    (Input)
 95 status
 96    is a standard status code.  (Output)
 97 
 98 
 99 Access required:
100 The caller must have modify permission on the containing directory.
101 
102 
103 :Entry:  init_notifications:  03/06/85 forum_admin_$init_notifications
104 
105 
106 Function:  This entry is used to create the notifications database.
107 
108 
109 Syntax:
110 declare forum_admin_$init_notifications entry (fixed bin(35));
111 call forum_admin_$init_notifications (status);
112 
113 
114 Arguments:
115 status
116    is a standard status code.  (Output)
117 
118 
119 Access required:
120 The caller must have "sma" access to the central forum directory.
121 
122 
123 :Entry:  set_forum_acl:  03/06/85 forum_admin_$set_forum_acl
124 
125 
126 Function:  This entry is used to add or change an ACL term on a
127 meeting.  ACL terms can only be specified for Person_id.* or
128 *.Project_id, terms of the form Person_id.Project_id are not allowed.
129 The caller need not be the chairman of the meeting.
130 
131 
132 Syntax:
133 declare forum_admin_$set_forum_acl entry (char(*), char(*), char(*),
134      bit(1) aligned, bit(1) aligned, bit(1) aligned, fixed bin(35));
135 call forum_admin_$set_forum_acl (dirname, entryname, access_name,
136      user_sw, set_sw, write_sw, status);
137 
138 
139 Arguments:
140 dirname
141    is the pathname of the directory containing the meeting.  (Input)
142 entryname
143    is the entryname of the meeting.  The ".forum" suffix is required.
144    (Input)
145 access_name
146    is the Person_id or Project_id whose ACL is to be added or deleted.
147    Access_name can not contain a ".".  (Input)
148 
149 
150 user_sw
151    This switch should be on if access_name is a Person_id, and off if
152    it is a Project_id.  (Input)
153 set_sw
154    This switch should be on if access is to be added, and off if it is
155    to be deleted.  (Input)
156 write_sw
157    This switch should on if write access is to be added, and off if
158    only read access is to be added.  This switch is ignored if set_sw
159    is off.  (Input)
160 status
161    is a standard status code.  (Output)
162 
163 
164 Access required:
165 The caller must have modify permission on the containing directory.
166 
167 
168 :Entry:  set_global_switch:  03/06/85 forum_admin_$set_global_switch
169 
170 
171 Function:  This entry is used to set switches associated with the forum
172 environment for an entire site.
173 
174 
175 Syntax:
176 declare forum_admin_$set_global_switch entry (char(*), bit(1) aligned,
177      fixed bin(35));
178 call forum_admin_$set_global_switch (switch_name, value, status);
179 
180 
181 Arguments:
182 switch_name
183    is the name of the switch to be set.  It can be one of
184    "print_eligiblity_messages", "pemsg", "chairman_set_eligibilty_msg",
185    or "cm_set_emsg".  (Input)
186 value
187    is the value to be assigned to the switch.  (Input)
188 status
189    is a standard status code.  (Output) It can have the following
190    value:
191    forum_error_table_$invalid_switch_name
192       The switch_name given was not one of those listed above.
193 
194 
195 Access required:
196 The user must have "rw" access to forum_data_.
197 
198 
199 :Entry:  set_switch:  03/06/85 forum_admin_$set_switch
200 
201 
202 Function:  This entry is used to change several switches associated
203 with a Forum meeting or its participants.  The caller need not be the
204 chairman of the meeting in order to set any of the switches.
205 
206 
207 Syntax:
208 declare forum_admin_$set_switch entry (char(*), char(*), char(*),
209      char(*), bit(1) aligned, fixed bin(35));
210 call forum_admin_$set_switch (dirname, entryname, person_id,
211      switch_name, switch_setting, status);
212 
213 
214 Arguments:
215 dirname
216    is the pathname of the directory containing the meeting.  (Input)
217 entryname
218    is the name of the meeting.  The ".forum" suffix is required.
219    (Input)
220 person_id
221    is the Person_id of the user on whose behalf you are setting the
222    switch.  The Project_id should not be given.  Starnames are not
223    permitted.  If this is blank, the caller's Person_id is used.
224    (Input)
225 
226 
227 switch_name
228    is the name of the switch to set.  See "List of Switches" below.
229    (Input)
230 switch_setting
231    is the new switch setting.  (Input)
232 status
233    is a standard status code.  It can have one of the following values:
234    forum_error_table_$invalid_switch_name
235       the switch_name is not one of the valid switches.
236    forum_error_table_$switch_not_changed
237       the old setting was the same as the new setting.
238 
239 
240 List of switches:
241 access_changed
242    Specifies that the ACL on the meeting has changed.  This switch is
243    set by the forum_chairman_$set_forum_acl entrypoint, and should
244    normally only be turned off by this subroutine.
245 adjourned, adj
246    Prevents users from entering the meeting.
247 deleted
248    Specifies that the attendee record for this user should be marked as
249    deleted.
250 
251 
252 meeting_eligibility_messages, mtg_emsg
253    Turns on printing of eligibilty messages for this meeting.
254 message_seen
255    Specifies that the chairman message on the meeting has changed.
256    This switch is set by the forum_$set_message entrypoint, and should
257    normally only be turned off by this subroutine.
258 notify, nt
259    Turns on the notify switch for the meeting.  This means that an
260    interactive message will be sent each time a transaction is entered
261    if the user is logged in and has issued the
262    forum_accept_notifications command.
263 participating, part
264     Turns on the participation switch for the meeting.
265 
266 
267 Access required:
268 The caller must have either modify permission on the containing
269 directory or write access to the ".forum" segment.