Home > NEC > Communications System > NEC Guardian An Open Application Interface Operations Manual

NEC Guardian An Open Application Interface Operations Manual

    Download as PDF Print this page Share this page

    Have a look at the manual NEC Guardian An Open Application Interface Operations Manual online for free. It’s possible to download the document as PDF or print. UserManuals.tech offer 1168 NEC manuals and user’s guides for free. Share the user manual or guide on Facebook, Twitter or Google+.

    							NDA-30008   Revision 2.0Page 51
    Guardian Operations Manual Administration
    Initialize Batch Control
    Use the Initialize Batch Control option on the main menu to activate a batch 
    modification to the disable status of a large number of groups, authorization codes, 
    or extensions.  This option provides the internal processing and its control, while 
    the user prepares the actual batch file of changes.  You can only access this option  
    with the Administrator password.
    Figure 3-13   Initialize Batch Control
    (1)
    (2)GUARDIAN
    *** SYSTEM  ADMINISTRATION ***
    Arrow keys to move cursor,  to select,  to quit
    Set OAI Application Logical Name
    Modify Status
    Query Database
    >  Initialize Batch Control
    Initialize Record File
    Generate Reports
    Maintain Password
    Clear Status Values
    Quit 
    GUARDIAN
    Batch Control File Name:*** INITIALIZE  BATCH  CONTROL ***
     to accept,  quit 
    						
    							Page 52NDA-30008   Revision 2.0
    Administration Guardian Operations Manual
    NotesThe following is an example of the Initialize Batch Control function:
    If you need to change the disable status of 1000 authorization codes, you can enter 
    the codes into a text file named ‘AC
    _disable’.  Select the Initialize Batch Control 
    option, and type AC
    _disable at the prompt, preceded by the full path name.  When 
    you press Enter, Guardian reads the file and implements each status change.
    Each file record must contain the following three fields prepared in ASCII 
    characters in the format shown below:
    Database Record
     Type | Database Record Key | Admin Disable Flag
    Database Record Type – Specifies which database contains the record to be 
    modified by the batch file record.  Valid values are:  G (Group), 
    A (Authorization Code), and E (Extension).
    Database Record Key – Specifies which record in the database is to be 
    modified and contains the actual Group ID (1-1000), 10-digit Authorization 
    Code, or 5-digit Extension Number.
    Disabled – Specifies the change in status to be made to the designated record.  
    Use one of the following values:  YES (routinely disable), UC (unconditionally 
    disable), or NO (the  group, authorization code, or extension is not to be 
    disabled routinely or
     unconditionally).
    All three fields must contain an entry.  Each field must be separated by the ‘ | ’ 
    character, except the last one of the record. You must conclude the record with 
    , the ASCII New Line character, which is a Hex (0a) or Decimal (10).  Batch 
    file records are not valid and will not be processed if any of the three fields does 
    not have an entry or if the record is not concluded by the  character.  A few 
    valid entries are provided below.
    G  | 1  | YES  – Routinely disable Group No. 1 in the Group database.
    A  | 1234567000 | NO  – Enable Authorization Code 1234567 in the 
    Authorization Code database.
    E  |  4395  | UC  – Unconditionally disable Extension No. 4395 in the 
    Extension database.
    Errors that are encountered during processing of the batch file are logged into a file.  
    The two types of errors that may occur are as follows:
    File Not Found  – The named batch file could not be found.  No processing was 
    performed, but the batch file name was logged.
    Bad Batch Control File Record  – A record contained an error.  This record 
    error was logged in the  following format:  Record #10, Item #2.
    After processing is completed, you can use Guardian options for handling the error 
    output, including printing, viewing, and saving errors to disk.  When you exit from 
    the screen, the error log file is erased.  The only way to reproduce it after leaving 
    the screen is to reprocess the batch file from which it came.  Therefore, we 
    recommend that you either print or save the error log file on disk if you need to 
    reference this information later. 
    						
    							NDA-30008   Revision 2.0Page 53
    Guardian Operations Manual Administration
    Procedure
    Action Result
    On the main menu, select the Initialize 
    Batch Control option and press Enter.  
    (1)The batch control file name prompt 
    appears.
    Enter the batch control file name and 
    press Enter.
    Note:
    Press ESC after a successful 
    batch process to display the file 
    name entry field to process an-
    other file.
    If no errors occurred during processing, 
    the message Batch Modify Successful 
    appears.
    If one or more errors occurred during 
    processing, the message Error in 
    Processing –  Select Option For 
    Error Log appears. 
    To examine error items, press Enter and 
    use the arrow keys to position the 
    cursor on the desired error output 
    command (Print File, View File, Save 
    File) and press Enter.PRINT FILE:  Error items are printed 
    and the output commands redisplay.
    VIEW FILE:  Error items are scrolled 
    for display on the screen with To p  o f  
    File, End of File and More notations 
    indicating placement.  The commands 
    serve to move the screen down the page 
    (DownPage), up the page (UpPage), to 
    the beginning of the file (To p), or to the 
    end of the file (Bottom).  To exit and 
    return to the output commands, select 
    the Quit command and press Enter.  
    SAVE FILE:  A prompt requesting the 
    name of the file in which the error items 
    are to be saved appears with a default 
    file name inserted.  Enter the 
    appropriate file name  and press Enter.  
    The error items are stored under the 
    indicated file name and the output 
    commands redisplay.
    To exit the output commands, select the 
    Quit command and press Enter. 
    To exit the Initialize Batch Control 
    option, press ESC.The main menu reappears. 
    						
    							Page 54NDA-30008   Revision 2.0
    Administration Guardian Operations Manual
    Initialize Record File
    Use the Initialize Record Files option on the System Administration menu to 
    reinitialize the record file.  This file contains recorded information used by the 
    system to generate the reports available through the Reports option.  This option  
    can only be accessed with the Administrator password.
    Figure 3-14   Initialize Record File
    NotesWhen you reinitialize the record file, the system deletes the previous file material 
    and starts a new record of information.  Reports generated from the record file 
    reflect the information collected in the file since its most recent reinitialization.  For 
    example, if you want reports to reflect details of system processing on a monthly 
    basis, you can reinitialize the record file every month after you generate the reports 
    so that the system can begin collecting data for the next series of monthly reports.
    If an error occurs during initialization, retry the process.  If the error reoccurs, call 
    the system distributor.
    Procedure
    GUARDIAN
    *** SYSTEM  ADMINISTRATION ***
    Arrow keys to move cursor,  to select,  to quit
    Set OAI Application Logical Name
    Modify Status
    Query Database
    Initialize Batch Control
    >  Initialize Record File
    Generate Reports
    Maintain Password
    Clear Status Values
    Quit 
    Action Result
    On the main menu, select the Initialize 
    Record File
     option and press Enter 
    twice.  (1)Processing is completed, and the 
    message Initialize Record File 
    Successful
     appears.
    To exit the Initialize Record File, press 
    ESC. The cursor returns to the main menu, 
    and the original command line is 
    restored. 
    						
    							NDA-30008   Revision 2.0Page 55
    Guardian Operations Manual Administration
    Generate Reports
    OverviewUse the Reports option on the System Administration menu to generate various 
    management and control reports from the record file and from four of the working 
    databases.  The Reports option can be accessed under either the Administrator 
    password or the Operator password.  For more information about how to delete 
    information from the record file, refer to “Initialize Record File” on page 54.  
    Figure 3-15   Reports Menu
    Notes
    The system generates reports from data collected in the record file.  This file 
    contains information logged since the last time it was initialized.   For more 
    information on initializing the record file, refer to “Initialize Record File” on page 
    54.   
    Call Attempts –  A menu of reports concerning the recorded invalid call 
    attempts that involved unknown or disabled groups, authorization codes, or 
    extensions.
    Database Status – A menu of reports reflecting the status of all groups, 
    authorization codes, extensions, and time intervals.
    Database History – A menu of reports showing the history of status 
    modifications to groups, authorization codes, or extensions.
    When you select the report you want from these options, you can view the 
    information on the screen, print a hard copy, or to save it to a disk.
    If the computer has less than 20% of disk space available when you select the 
    Generate Reports option, the following message displays: Not enough free disk 
    space for reports.  If you disregard this message and the system requires more disk 
    space than is available to process the report, the following message displays:  
    Report Not Generated.
    (2)
    GUARDIAN
    *** SYSTEM  ADMINISTRATION ***
    Arrow keys to move cursor,  to select,  to quit
    Set OAI Application Logical Name
    Modify Status
    Query Database
    Initialize Batch Control
    Initialize Record File
    >  Generate Reports
    Maintain Password
    Clear Status Values
    Quit 
    (1)
    GUARDIAN
    *** REPORTS ***
    >   Call Attempts
    Arrow keys to move cursor,  to select,  to quit
    Database Status
    Database History
    Quit 
    						
    							Page 56NDA-30008   Revision 2.0
    Administration Guardian Operations Manual
    Procedure
    Action Result
    On the main menu, select the Reports 
    option.  (1)The Reports menu displays.  (2)
    Use the arrow keys to position the 
    cursor on the type of report desired and 
    press Enter.The menu of available reports displays.
    To exit the Reports menu, select the 
    Quit option and press Enter, or press 
    ESC.The main menu reappears. 
    						
    							NDA-30008   Revision 2.0Page 57
    Guardian Operations Manual Administration
    Call AttemptsUse the Call Attempts option on the Reports Menu to generate invalid call attempt 
    reports for calls made from single extensions, within groups, and with  
    authorization codes that are not assigned in the database (unrecognized) or disabled 
    by the administrator or the system.
    Figure 3-16   Call Attempts Reports
    Notes
    The following call attempt reports contain date, time, and page number headings.
    Unrecognized Authorization Codes – A list of authorization codes that are not 
    assigned in the database but that have been used in call attempts, including the 
    time at which the calls were attempted.  (Sorted chronologically by extension).
    Unrecognized Extensions –  A list of extensions that are not assigned in the 
    database but that have been used in call attempts, including the time at which 
    the calls were attempted.  (Sorted chronologically by extension).
    System Disabled Extensions – A list of extensions  on which calls have been 
    attempted and that are currently disabled by the system, including the time at 
    which the calls were attempted and the time at which the extension is to be 
    enabled.  (Sorted chronologically by extension).
    Routinely Disabled Extensions – A list of all extensions on which calls have 
    been attempted during the time interval that the extensions are scheduled to be 
    disabled, including the times at which the calls were attempted.  (Sorted 
    chronologically by extension).
    (2) (1)
    GUARDIAN
    *** REPORTS ***
    >   Call Attempts
    Arrow keys to move cursor,  to select,  to quit
    Database Status
    Database History
    Quit
    GUARDIAN
    *** CALL  ATTEMPT  REPORTS  ***
    >   Unrecognized Authorization Codes
    Arrow keys to move cursor,  to select,  to  quit
    Unrecognized Extensions
    System Disabled Extensions
    Routinely Disabled Extensions
    Routinely Disabled Authorization Codes
    Routinely Disabled Groups
    Quit 
    						
    							Page 58NDA-30008   Revision 2.0
    Administration Guardian Operations Manual
    Notes (Continued)
    Routinely Disabled Authorization Codes – A list of all authorization codes 
    with which calls have been attempted during the time interval that the codes are 
    scheduled to be disabled, including the times at which the calls were attempted.  
    (Sorted chronologically by extension).
    Routinely Disabled Groups – A list of groups in which extensions have been 
    used in call attempts during the time intervals that the groups are scheduled  to 
    be disabled, including the times at which the calls were attempted.  (Sorted 
    chronologically by extension).
    When you select this option and the report you want, the following sequence of 
    messages displays while the system prepares the report:  Sorting..., Processing..., 
    and  Done.
    Procedure
    Action Result
    On the Reports menu, select the Call 
    Attempts option and press Enter.  (1)The Call Attempt Reports screen displays.  
    (2)
    Use the arrow keys to position the cursor on 
    the desired report and press Enter.A new command line appears containing 
    output commands (Print File, View File, 
    Save File).  
    Use the arrow keys to position the cursor on 
    the desired output command and press Enter.PRINT FILE:  The report prints and the 
    output commands reappears.
       
    VIEW FILE:  Report items are scrolled for 
    display on the screen with Top of File, End 
    of File and More notations indicating 
    placement.  The commands serve to move 
    the screen down the page (DownPage), up 
    the page (UpPage), to the beginning of the 
    file (To p), or to the end of the file (Bottom).  
    To exit and return to the output commands, 
    select the Quit command and press Enter.  
    The output commands redisplay.
    SAVE  FILE:  A prompt for the name of the 
    file in which the report is to be saved appears 
    with a default file name inserted.  Enter the 
    appropriate file name and press Enter.  The 
    system stores the report under the indicated 
    file name, and the output commands 
    redisplay.
    To exit the output commands, select the 
    Quit command and press Enter.    
    To exit the Call Attempts option, press ESC. The Reports menu reappears. 
    						
    							NDA-30008   Revision 2.0Page 59
    Guardian Operations Manual Administration
    Database StatusUse the Database Status option on the Reports menu to generate reports concerning 
    the current status of all groups, authorization codes, and extensions in the system.
    Figure 3-17   Current Database Status Reports
    (1)
    (2)GUARDIAN
    *** REPORTS ***
    Call Attempts
    Arrow keys to move cursor,  to select,  to quit
    >   Database Status
    Database History
    QuitGUARDIAN
    *** CURRENT  STATUS  REPORTS ***
    >  Time Intervals
    Arrow keys to move cursor,  to select,  to quit
    All Groups
    All Authorization Codes
    All Extensions
    Routinely Disabled Groups
    Routinely Disabled Authorization Codes
    Routinely Disabled Extensions
    System Disabled Extensions
    Extensions by Group
    Authorization Codes by Extension
    Authorization Codes by Group
    Quit 
    						
    							Page 60NDA-30008   Revision 2.0
    Administration Guardian Operations Manual
    Notes
    The status reports listed below are available through this option.  The reports 
    notated with (Range Available) can be prepared for a designated portion of the 
    database as well as for the whole file.  When any one of these reports is selected, a 
    Report Range screen displays where you can enter the first and last items of the 
    range to be included in a report.
    Time Intervals – A list of the beginning and ending times for each interval 
    associated with an Interval Index.
    Groups (Range Available)  – A printout of the Group database.
    Authorization Codes (Range Available) – A printout of the Authorization 
    Code database.
    Extensions (Range Available) – A printout of the Extension database.
    Routinely Disabled Groups – A list of all groups that are scheduled to be 
    routinely disabled, including the time interval of the disablement.
    Routinely Disabled Authorization Codes – A list of all authorization codes 
    that are scheduled to be routinely disabled, including the time interval of the 
    disablement.
    Routinely Disabled Extensions – A list of all extensions that are scheduled to 
    be routinely disabled, including the time interval of the disablement.
    System Disabled Extensions – A list of all extensions that are currently 
    disabled by the system
     in response to an excessive frequency of invalid call 
    attempts, including the anticipated enable time.
    Extensions by Group (Range Available) – A list of all groups and the 
    extensions that are assigned to each.
    Authorization Codes by Extension (Range Available) – A list of 
    authorization codes that are assigned to single extensions.
    Authorization Codes by Group (Range Available) – A list of the 
    authorization codes that are assigned to groups.  
    						
    All NEC manuals Comments (0)

    Related Manuals for NEC Guardian An Open Application Interface Operations Manual