Amanda Work Group 7xx Installation Manual
Have a look at the manual Amanda Work Group 7xx Installation Manual online for free. It’s possible to download the document as PDF or print. UserManuals.tech offer 32 Amanda manuals and user’s guides for free. Share the user manual or guide on Facebook, Twitter or Google+.
Chapter 11: Programming Amanda 209 P[repetition] (prompt_no,V [,hangup]) Command that tells Amanda to look for the specified prompt number in the current system language file. Then Amanda plays the prompt associated with that number. repetitionThe number of times to repeat the prompt. The default is 1. prompt_noThe number or variable containing the number for the prompt. The current range is from 1 to 477. (For some languages, some of the prompt numbers reference blank messages.) hangupOptional. The number 1 or 0 indicating how to process a hangup. The 1 means that the processing of this token ends. 0 means that the processing of this token ends, the string of tokens is aborted, and the channel hangs up so that it can wait for a new call. Example:P2(15,V) causes Amanda to play prompt number 15 twice. Failure: Does not fail P[repetition](R) Command that tells Amanda to say the DTMF digits entered by a caller who requested relay paging notification. (These digits are stored in %R.) This command can be used in either field, but makes the most sense when used in a Notify Method field. repetitionThe number of times to repeat the DTMF digits. The default is 1. Example:P(R) causes Amanda to say the DTMF digits stored in the system variable %R. You can also use: P(%R) Failure: Does not fail Alphabetical Token Reference (Continued) Token SyntaxDescription
210 Installing [email protected] P[repetition] (U[,mailbox [,hangup]]) Command that tells Amanda to play the Name/Extension recording of the specified or current mailbox. If there is no recording, Amanda says “mailbox,” followed by the digits for the mailbox. See also P[repetition](N[,mailbox]). repetitionThe number of times to repeat the Name/Extension recording. The default is 1. mailboxOptional. Any valid mailbox or a variable containing a mailbox. The default is the current mailbox. hangupOptional. The number 1 or 0 indicating how to process a hangup. The 1 means that the processing of this token ends. 0 means that the processing of this token ends, the string of tokens is aborted, and the channel hangs up so that it can wait for a new call. Example:P(U) causes Amanda to play the Name/Extension recording for the current mailbox. If it doesn’t exist, Amanda says the digits for the mailbox. Failure: Invalid mailbox P[repetition](V) Command that tells Amanda to say the digits in the Variable field of the Notification record. repetitionThe number of times to repeat the contents of the Variable field. The default is 1. Example:P2(V) causes Amanda to say the digits in the Variable field twice. The following also works: P2(%V) Failure: Does not fail Alphabetical Token Reference (Continued) Token SyntaxDescription
Chapter 11: Programming Amanda 211 Q( {greeting [# mailbox ][,E ]}) Command that allows you to ask a caller a series of questions and store all the call- er’s responses as a single message for the current mailbox. Each question is record- ed as a greeting which Amanda plays back with a tone. Then Amanda records a response and goes on to the next question. Up to 20 questions are allowed. To ask more than 7 questions (after using Greetings 1 to 7 for the current mailbox) you can use greetings from other mailboxes by specifying which mailbox’s greeting to ac- cess with a # sign followed by the mailbox, e.g., G7#123 would use greeting 7 from mailbox 123. You use the Q() command to create voice forms or implement some IVR applications. This command is used only in Extension fields. greetingOne of the seven mailbox greetings (G1–G7). mailboxOptional. Any valid mailbox. The default is the current mailbox. E Gives the caller the opportunity to edit (review, rerecord, append, or can- cel) the previous group of answers. If additional token language processing is required after the caller has hung up, use the H token as part of the token string. Examples: Q(G1,G2,G3,G4,G5,G6,G7,G1#9000,G2#9000) causes Amanda to ask 9 questions recorded in the specified greetings, record 9 re- sponses, and store the responses as one message for the current mailbox, regardless of what mailbox’s provide the greetings. Q(G1,G2,G3,E)records three answers from the caller and then gives the caller an opportunity to re- view those answers as if they were one message. When editing, a menu gives the caller the options of re-recording, appending to or canceling the answers of that group. Q(G1,G2,E,G3,G4,E)asks the caller two questions and then allows the caller to edit those answers. Once the caller presses 9 to save, Amanda asks the next two questions and then allows the caller to edit the second group of answers. N OTE: While editing, pressing 4 to cancel erases all the previous answers (not just those in the group being edited) and restarts the Q() command. Failure: Invalid mailbox Invalid greeting Alphabetical Token Reference (Continued) Token SyntaxDescription
212 Installing [email protected] %RSystem variable (the relay variable) that contains the DTMF digits entered by the caller who requested relay paging notification. Each port has its own %R. For more information see Administering [email protected]/DOS. This is primarily used to send up to 16 digits of information to a user’s pager/beeper. This token is used only in Notify Method fields. Example: 9,%VW(9,V)P(U)P(R) causes Amanda to call someone at home and say the telephone number and other information in the relay variable. R( greeting [# mailbox ], variable [, timeout ]) Command that plays a greeting from the current or specified mailbox and stores the caller’s DTMF entry as a number in the specified variable. The greeting is inter- rupted as soon as the first DTMF tone is entered. If there is no DTMF entry or if the timeout occurs, the variable is set to the empty string. greetingOne of the seven mailbox greetings (G1–G7). mailboxOptional. Any valid mailbox. The default is the current mailbox. variableOne of the port or global variables. timeoutA number from 0 to 99 that represents the time in tenths of seconds to wait for a DTMF entry after playing the greeting. The default is 1.2 sec- onds. Example: R(G1,%S6,20)stores a telephone number entered by a caller for later use. Greeting 1 is “Enter your telephone number, finish by pressing the # sign.” The caller’s entry is stored as a number in the port variable %S6. Amanda waits two seconds after the greeting be- fore deciding that the caller is not going to enter a telephone number. R(G1#111,%S1)plays Greeting 1 of mailbox 111. The DTMF digits entered by the caller become the value of %S1. Failure: Invalid mailbox Invalid greeting Alphabetical Token Reference (Continued) Token SyntaxDescription
Chapter 11: Programming Amanda 213 %S0 %S1 %S2 %S3 %S4 %S5 %S6 %S7 %S8 %S9 %S10 %S11 %S12 %S13 %S14 %S15 %S16 %S17 %S18 %S19Each telephone port has its own set of 20 %S variables where you can store, mod- ify, or retrieve information. One port’s %S1 is not the same as another port’s %S1. If Port 1 changes %S1, it does not change the value of Port 2’s %S1. Initially, each variable is equal to the empty string. Each variable can contain a string of up to 143 characters. See also %G0–%G9. N OTE: The [(), ](), and |() commands can be used only with %S0 through %S9. The variables %S10 through %S19 cannot be read from, written to, or ap- pended to any DOS file. Example: +(%S0,5) adds five to the current value of %S0. =(%S12,714) assigns the area code 714 to %S12. I(%S12=714,555) causes Amanda to go to the Extension field for mailbox 555 because the condition is true (%S12 does equal 714). Failure: Invalid variable name (such as %S52) Alphabetical Token Reference (Continued) Token SyntaxDescription
214 Installing [email protected] S( port, [string ], [variable ], [termination ], [length ], [time- out ]) Command that gives Amanda access to other computers via the serial ports. Aman- da can send a string to and/or receive a string from the remote computer. When re- ceiving, Amanda terminates the connection when the first of the following occurs: Amanda receives the specified termination string She receives the maximum number of characters A timeout occurs When sending, Amanda terminates the connection after the string is sent. Before using this command, make sure the configuration settings for the physical serial port have been defined. portThe number for or a variable containing the number for the logical se- rial port (1,2,3,4) mapped onto a physical COM port by the configura- tion option serial_port1, serial_port2, serial_port3, or serial_port4. stringOptional. A string or variable containing the characters to send to the specified serial port. It can contain alphanumeric characters as wells as variables and the following special characters: \A Attention, which is a bell sound (Ctrl+G) \N Newline (Ctrl+J) \R Return (Ctrl+M) \T T AB (Ctrl+I) \\ Backslash, the actual \ character. The default is to send no string to the serial port. variableOptional. The port or global variable that stores the response. The default is not to store a response. terminationOptional. A string or variable that defines the characters that, when read, stop Amanda from reading the serial port. This can use the same special characters as string. The default is \R\N, the carriage return/ linefeed pair that usually end a line in a text file. The terminating char- acter, if any, does not become part of variable. lengthOptional. A number or a variable containing a number. Its absolute value defines the maximum number of characters to receive over the serial port. The default is -143. Use a positive value for length when you are receiving a packet of characters, you know its exact size, and you want the command to fail if fewer characters are received. Use a negative number otherwise. timeoutOptional. A number or variable that defines the maximum time, in sec- onds, that Amanda should wait for the first character and also between characters being received on the serial port. The default is the setting for the configuration option tmo_serial. Alphabetical Token Reference (Continued) Token SyntaxDescription
Chapter 11: Programming Amanda 215 S token continuedExample: S(2,%S3,%S4,,,50) both sends and receives. The command uses COM port 2. %S3 stores the string to be sent. %S4 stores the string that is received. Amanda waits a half second for the first character and between characters. S(2,%S3) only sends. The command uses COM port 2. %S3 stores the string to be sent. This command has non-standard syntax. Because all the parameters after the string to be sent are not being used, this command does not need the additional commas. S(2,,%S4,,,50) only receives. The command uses COM port 2. %S4 stores the string that is re- ceived. Amanda waits a half second for the first character and between characters. Failure: Physical port not available Logical port not configured properly If a timeout stops Amanda from receiving information before the maximum num- ber of characters is received and the length is a positive number, Amanda considers the command a failure. %TSystem variable that contains the current connect time, the number of seconds that the current port/call has been active. Each port has its own %T. Examples: P(%T,N) causes Amanda to say the amount of connect time as a number. See the P() com- mand for more information. Alphabetical Token Reference (Continued) Token SyntaxDescription
216 Installing [email protected] T( file, phone_no [, tokens ]) Command that sends faxes to either a specified telephone number or to a connected call. Before using this command, be sure at least one fax modem is installed and configured on Amanda. Before using this command, make sure the configuration settings for the physical serial port have been defined. fileThe file name of the fax you wish to transmit. It can be any valid DOS file name. Use the complete path to the file unless the file is in C:\AMANDA. phone_noThe telephone number (or a variable containing that number) for the fax device that accepts the transmission. Use the empty string to make Amanda wait for a call to ring into the fax port. tokensOptional. A string or variable that defines the actions Amanda takes to connect the call to the fax port. For more information, please see the ex- ample for the J() command. This command is used only in Extension fields. Examples: T(C:/FAXES/NEWINFO.FAX,%G6) allows the user to request a fax and have the supplier of that fax send it to the pro- vided telephone number. This is commonly called a “two-call fax back”. NEWIN- FO.FAX is the name of the file, and %G6 contains the fax telephone number. T(C:/FAXES/NEWINFO.FAX,,%S5) allows the user to request a fax and have it sent as part of the current call. This is commonly called a “one-call fax on demand”. NEWINFO.FAX is the name of the file, and %S5 provides the tokens that connect the call to the FAX port. Failure: Fax modem not configured properly Physical port not available Logical port not configured properly %USystem variable that contains the current mailbox number. Each port has its own %U. See also %P. Alphabetical Token Reference (Continued) Token SyntaxDescription
Chapter 11: Programming Amanda 217 U- ext_noCommand that performs partially supervised transfers. Amanda does not transfer the call if she detects a busy signal. To use the U token, the setting for Maximum Rings for the mailbox must be set to 1. ext_noSeries of DTMF digits that indicate an extension number. This command is used only in Extension fields. Example: U-144 causes Amanda to call extension 144 (if Amanda is processing a call). If the exten- sion rings, she transfers the call and hangs up. If the extension is busy, Amanda lets the caller know that. Failure: Does not fail %VSystem variable that contains the value of the Variable field in the current Notifi- cation record. Each port has its own %V. This token is used only in Notify Method fields. Example: If the only difference in a Notification template for mailboxes is the pager/beeper telephone number that Amanda should call, %V can store that number. 9,%VW(3,P)%U*%M*%N# causes Amanda to call the user and play the number of messages. Alphabetical Token Reference (Continued) Token SyntaxDescription
218 Installing [email protected] V( file, field, value {, field, variable })Command that searches the specified file for the first record that has the specified value in the specified field. It retrieves values from up to 8 other fields in that record, putting the retrieved values in the specified variables. See also the N() com- mand. fileA string or variable containing a valid DOS file name for the text or .DBF file. Use the complete path to the file unless the file is in C:\AMANDA. No line in the file should exceed 143 characters. There is no limit to the number of lines in the file. fieldA number, string, or variable that indicates the number or name of a field. The first field indicates what field to compare with value; the additional (up to 8) fields indicate what fields to copy into the corresponding vari- ables. (.DBF files have field names; text files have field numbers.) valueA string or variable that contains the data to be compared with the con- tents of the specified field. variableOne of port or global variables. Example: V(C:\\LISTS\\PHONE.LST,1,JOHN,3,%S1,2,%S2) searches the file PHONE.LST for the value JOHN in field 1. If the search is suc- cessful, the value in field 3 of that record is stored in %S1 and the value in field 2 is stored in %S2. Failure: If no record is found %WSystem variable that contains the day of the week (1 is Sunday, and 7 is Saturday). Alphabetical Token Reference (Continued) Token SyntaxDescription