Restrictions Editor V5.5.0 - Release Notes

This document contains the following sections:

Application Requirements

What's new in this release?

What is the Restrictions Editor and how do I use it?

Installation

Running the Restrictions Editor

Uninstalling the Restrictions Editor

Customizing the Restrictions Editor

Application Requirements

The Restrictions Editor is a 32-bit Windows application designed to run under Windows XP/Vista/7.  

It may also run under Windows 8 or Windows NT/95/98/ME/2000 with Internet Explorer V6.0 or later, but has not been tested in these configurations.

The Restrictions Editor requires that a copy of AZedit.EXE be available in order to determine the AZedit menu structure for creating restrictions.

Starting with V2.0.4, the Restrictions Editor is now available in both ASCII and UNICODE builds.

ASCII versions provide an English user interface, while UNICODE versions are capable of providing a user interface in nearly any language.  

The user interface for the UNICODE version is currently available in English only, but support for other languages may be developed in the future.

The UNICODE versions use resource DLL's which provide the user interface text in various languages.  The Restrictions Editor automatically picks the appropriate language DLL to match the system locale selected by the user (in Control Panel, Regional and Language Settings).  If the required language DLL is not present, the Restrictions Editor defaults to the English language resources that are compiled into the application executable.  An enhanced "About Restrictions Editor" dialog displays information regarding the Restrictions Editor build and resource DLL settings.

To support user interface languages other than English, a new resource DLL must be created for each language.

<back to top>

What's new in this release?

Version 5.5.0

This version of Restrictions Editor has feature support for all versions of AZedit up to V5.5.0

Version 5.4.0

This version of Restrictions Editor has feature support for all versions of AZedit up to V5.4.0

Version 5.3.0

This version of Restrictions Editor has feature support for all versions of AZedit up to V5.3.0

Version 5.2.0

This version of Restrictions Editor has feature support for all versions of AZedit up to V5.2.0

Version 5.1.0

This version of Restrictions Editor has feature support for all versions of AZedit up to V5.1.0

Version 5.0.0

This version of Restrictions Editor has feature support for all versions of AZedit up to V5.0.0

Version 4.7.0

This version of Restrictions Editor has feature support for all versions of AZedit up to V4.7.0

Version 4.5.1

This version of Restrictions Editor has feature support for all versions of AZedit up to V4.5.2

Version 4.2.1 (J6)

This version of Restrictions Editor has feature support for all versions of AZedit up to V4.2.1 (J6)

Version 4.2.0

This version of Restrictions Editor has feature support for all versions of AZedit up to V4.2.0

Version 4.1.0

Fixed bug: Could not use an AZedit setup file (.ADM) to import intercom configuration if the setup file was created with AZedit V3.5.1 or later.

This version of Restrictions Editor has feature support for all versions of AZedit up to V4.1.0

Version 3.9.0

This version includes support for the Port Allocation Table.

This version includes support for license file download.

This version includes support for IFB tallies across trunking.

This version of Restrictions Editor has feature support for all versions of AZedit up to V3.9.0

Version 3.8.0

This version includes support for MADI-16 cards.

This version includes support for TM Communications settings.

This version includes support for Ethernet Link status options.

This version of Restrictions Editor has feature support for all versions of AZedit up to V3.8.0

Version 3.7.0

This version includes support for keypanel colors.

This version includes support for ZEUS-III 2-wire port configuration.

This version of Restrictions Editor has feature support for all versions of AZedit up to V3.7.0.

Version 3.6.0

This version includes support for the Assignment Group Members-Only flag.

This version includes support for Arbitrary Crosspoints (UR inputs/outputs).

This version of Restrictions Editor has feature support for all versions of AZedit up to V3.6.0.

The version number has been changed to make it easier to determine which version of Restrictions Editor supports which version of AZedit.

Version 2.4.0

This version includes support for GPIO-16.

This version includes support for PGM Listen Source.

This version of Restrictions Editor has feature support for all versions of AZedit up to V3.4.0

Version 2.2.1

This version includes support for restrictions for ARP-32 panels.

This version of Restrictions Editor has feature support for all versions of AZedit up to V3.2.0

Version 2.1.1

Did not read Unicode descriptions properly from AZedit setup files renamed as .CFG files.

Version 2.1.0

This version includes support for restrictions for PAP/LCP descriptions (accessed under the PAP | Alphas view).

Also included, is support for restrictions for I/O Card descriptions (a new resource type: I/O Cards, has been added with an Alphas view).

This version of Restrictions Editor has feature support for all versions of AZedit up to V3.1.0

Version 2.0.4

Starting with V2.0.4, the Restrictions Editor is now available in both ASCII and UNICODE builds (see application requirements).

Now uploads Unicode alphas and descriptions from the intercom if supported.  Allows specifying Unicode alphas as default size.

Displays menu item descriptions in the localized language by loading the appropriate AZedit resource DLL if necessary.

Restrictions for the modification of Input and Output alphas for ports are now independent options if the intercom is configured to use Input Alphas.

Improved list sorting (uses resource # as secondary sort).

Views are refreshed when alphas are uploaded or the preferred alpha size is changed.

This version fixes a problem with writing Studio resource restrictions to file.

Version 2.0.2

This version includes restriction items for the Authentication and Maintenance preference tabs in AZedit V3.

Leading and trailing spaces are trimmed from intercom and user/class names.

Intercom names and desktop shortcut names are prevented from containing illegal characters for use in file names.

Shortcut names can now includes the period/dot character.

The intercom name is now enclosed in quotation marks when creating a shortcut (allows embedded spaces in intercom name).

Version 2.0.1

This version fixes a problem that, under some circumstances, could allow the Restrictions Editor to create a .RES file that it then could not read back properly.

This version also fixes a problem with the definition and application of Studio resource restrictions.

When creating a desktop shortcut, the default name now includes "ResEdit" (to avoid conflict with shortcuts created by "AZedit"), and the user is prompted before overwriting an existing shortcut.

Version 2.0.0

The Restrictions Editor can now communicate directly with any intercom supporting Ethernet connections (ADAM with MCII-e or PCII-e, or Cronus).  You can manually enter the intercom name and IP address, or you can browse for intercoms detected by network broadcast.

The Restrictions Editor determines the intercom system size and capabilities, and uploads the alphas and descriptions for all resources.  This information is stored in an intercom configuration file (.CFG) for each intercom.  The .CFG information is automatically refreshed at startup, as well as when a new intercom is selected, and can be refreshed at any time by manual request.  

It is now no longer necessary for the Restrictions Editor to be installed on each AZedit computer, although a copy of AZedit must be installed on the Restrictions Editor computer so that the AZedit menu restrictions can be determined.

If you do not have Ethernet connectivity to an intercom, you can create a .CFG file by copying a full AZedit setup file (.ADM) for the intercom to the .CFG file directory and renaming the file as <intercom name>.CFG.  The Restrictions Editor will read the renamed AZedit setup file and convert it to a Restrictions Editor .CFG file automatically.  This procedure works best with .ADM files created with AZedit V3.x.x or greater.  Earlier version of AZedit do not store the intercom capabilities in the setup file, so the Restrictions Editor will not be able to determine the intercom capabilities from AZedit setup files created with V2.x.x or earlier.

The Restrictions Editor creates restriction files (.RES) for each intercom; these can be edited and stored in a configurable directory.  This directory could be a network share accessible to all AZedit computers, so that deployment of restriction files to AZedit computers is automated when using AZedit V3.x.x (which can be configured to look for restriction files on the network share).  If you do not have network capability, you can copy the .RES files to your AZedit computers and place them in the appropriate directory for your version of AZedit.  In AZedit V2.x.x, restriction files must be located in the same directory as the executable (.EXE).  Beginning with AZedit V3.x.x, the location of restriction files can be set by using the Options | Preferences | Restrictions dialog.

When selecting an intercom to work with, you can specify a default intercom, so that the restrictions for the default intercom are loaded automatically at the next startup.  In addition, after selecting an intercom to work with, you can ask the Restrictions Editor to create a desktop shortcut for the intercom that adds a "-i <icom>" command line parameter so that you can quickly launch the Restrictions Editor with a specific intercom name already selected.  To create a desktop shortcut for a particular intercom, use the Options | Create Shortcut menu item.

You can also export the set of restrictions created for one intercom so that they can be used as the starting set of restrictions for another intercom by using the File | Export Restrictions menu item.

Please see the "What is the Restrictions Editor and how do I use it?" section for more on the differences between V1.x.x and V2.x.x of the Restrictions Editor and its use with both V2.x.x and V3.x.x of AZedit.

Version 1.02.02

The Restrictions Editor has been updated to support all of the features included in AZedit up to V2.09.00.

Version 1.02.01

The Restrictions Editor has been updated to support all of the features included in AZedit up to V2.08.01.  This version always prompts at startup for the restrictions file to open, giving the user a chance to select a different directory or restrictions file at startup.  

Note that the Locate AZedit Executable function is present to allow you to specify which version of AZedit the Restrictions Editor uses to determine the list of menu restrictions when there are multiple copies of AZedit installed.  This function is NOT used to choose the directory in which restrictions files are located.

A bug in V1.02.00 that prevented the File | Open, and Browse for Alpha Setup File dialogs from appearing has been corrected.

Version 1.02.00

The Restrictions Editor has been updated to support all of the features included in AZedit up to V2.07.01.  This version is required for use with AZedit V2.06.05 and higher.

Version 1.01.00

The Restrictions Editor is now compatible with both the new AZedit (combined ADAMedit and ZEUSedit), and older versions of ADAMedit (back to V2.02.00).  The Restrictions Editor looks first for the AZedit executable, and then for ADAMedit, in order to pull the list of available menu items that can be restricted.

On the Class and User Configuration screens, there are now buttons that allow you to explicitly "Allow All" or "Deny All" resource, feature and menu restrictions for the specified Class/User, as well as a button that removes all explicit overrides and sets the Class/User to "Inherit All" permissions and restrictions from the default settings (for a Class) or from the base Class (for a User).  This option saves time if you are creating a "super" Class or User, in which you want to start with all permissions granted (rather than having to visit each screen and explicitly enable every resource, features, and/or menu).

When adding a new Class or User, you now have the option to select an existing Class or User from which to copy the initial restriction set.  This allows you to create a copy of an existing Class or User (or to convert User settings into Class settings and vice-versa).  For instance, suppose you had spent a great deal of time creating a set of restrictions for a User, and then realized that these settings should also apply to another User you were about to create, or perhaps to a Class of Users that had yet to be created.  You could create the new User by copying the initial settings from the existing User, or your could promote the User settings into a new Class (based on the existing User), then remove the explicit settings from the existing User (by choosing the "Inherit All" option on the User configuration screen as described above) and choosing to make the existing User a member of the new Class.  Now you can create new Users and make them members of the new Class so that they all share the same initial settings (that can be changed globally in the Class if necessary).

A File Save As menu item has been added, which allows you to save the existing file settings under a different intercom name.  The new intercom must already be defined in the registry (by running AZedit/ADAMedit with the -i option).  This is useful if you have created a Class/User hierarchy with menu and feature restrictions that you would like to port to other intercoms.  Resource restrictions are ported as well, but there may be some anomalies where the new intercom has a different resource set than the existing intercom.

Version 1.00.00

The initial release of the Restrictions Editor.

<back to top>

What is the Restrictions Editor and how do I use it?

The Restrictions Editor is a tool used to create restrictions files for use with AZedit.

AZedit includes support for user restrictions by reading a text file and parsing out the set of resources and features available to each user.  The text file is plain ASCII text and can be viewed with a text editor such as NOTEPAD.  For security reasons, the text file includes a CRC tag at the end of the file so that it may not be manually edited without corrupting the CRC.  

The Restrictions Editor provides a user interface to the restrictions text file, allowing you to view and modify the restrictions set for each AZedit user.  The Restrictions Editor groups related sets of resources and features together on easily navigable screens so that you can conveniently examine and change the restriction sets in context.  Restrictions are implemented by having separate restriction files for individual intercoms (each of which could contain separate sets of user restrictions).  

AZedit can be launched with two command line parameters, one to specify which intercom restriction file to load (-i <icom>), and another to specify the user section within that file (-u <user>).  In AZedit V2.x.x, you must manually add the command line parameters using the properties dialog of the shortcut used to launch AZedit.  Beginning with AZedit V3.x.x, you can use the Options | Authentication | Create Shortcut menu item to assist in the creation of desktop shortcuts that specify an intercom name and user name of your choice.

In AZedit V2.x.x, if an intercom name is not specified, AZedit will attempt to load "Default.res", and if the user name is not specified, AZedit will look for a [USER "Default"] section in the restriction file.  Beginning with AZedit V3.x.x, if the intercom name or user is not specified, and no default name has been previously declared, AZedit will prompt the user to select an intercom name and a user name from the available choices.

V2.x.x of the Restrictions Editor will not allow creation of "Default.res" files.  With the introduction of authentication in AZedit V3.x.x, it becomes necessary to enforce that the restrictions files have the same name as the intercom for which they will be used.  Also, since the Restrictions Editor V2.x.x is designed to be used as a centralized application to create restrictions for multiple intercoms, it does not make sense to try and have files named "Default.res" as this does not lend itself to a multiple intercom environment.  Note that AZedit and the Restrictions Editor use only the 4-character intercom name (as defined in the Trunk Master, or through AZedit V3.x.x).

Support for restrictions includes the concept of User restrictions, so that it is possible to specify different sets of restrictions for various users on a given intercom, as well as supporting the concepts of Studios and Classes.  A Studio is a collection of resources in an intercom that you would like to be able to apply restrictions to as a whole.  For instance, you might have a large intercom which serves several Studios in your plant.  Each Studio uses a number of keypanel ports, IFB's, party lines, etc.  The Restrictions Editor lets you create and name these Studios, and assign groups of resources to each Studio.

A Class is a convenient way of assigning similar restriction sets to a number of different users.  The Restrictions Editor lets you create any number of Classes, and then create a set of restrictions for each Class.  For instance, you might create an Engineering Class, and a Production Class.  You could then assign different feature and resource restrictions to each class (e.g. the Engineering Class may have access to firmware download, but the Production Class does not). 

When you go on to create a number of different User restriction sets, you can have each User inherit a set of restrictions from a particular Class.  You might have 5 Users in the Engineering Class, and 7 Users in the Production Class.  If you needed to change a restriction setting for all users in a particular Class, you would do so by modifying the feature or resource in the Class restriction set.  The change would then be reflected in all Users inheriting from that Class.

Both Classes and Users can inherit access to one or more sets of Studio resources.  Studio resource inheritance is calculated by including or excluding a Studio's resource set from the initial Class or User resource set.  The order in which Studio resources are included or excluded from a Class/User only matters if there is at least one exclude operation being performed and the Studio definitions contain a set of overlapping resources.  When you create a Class or a User, you can specify which Studios to include/exclude and the order in which these operations are performed.  If a Class has Studio dependencies, any User inheriting from that Class will also inherit the same Studio restrictions.  The Studio restrictions applied to an individual User are included/excluded after any Class dependencies the User may have.

A User can inherit its initial restriction set from only one Class, but this restriction set can be further tailored to the specific User by overriding the inherited class settings on a feature by feature, or resource by resource basis.   Similarly, a User's Studio restrictions can be overridden on a resource by resource basis.  Effectively, the Class and Studio dependencies of a User set the initial restriction set for that user, but all of these settings can be overridden at the User level by explicitly Allowing or Denying access to a particular feature or resource.  If a feature/resource is neither Allowed or Denied, access to the feature/resource is determined by the inherited settings (which come from the Class and/or Studio dependencies).

Studios and Classes differ in a couple of important ways.  Studios are simply a definition of a set of resources that can be included or excluded in the restriction set of a Class or User.  A Class is a set of restrictions (that includes access to both resources and features) that a User can inherit as a base restriction set.

The Restrictions Editor user interface consists of the following standard window components:

in addition to the main windows: 

Context Navigation Tree

This tree appears near the top left of the application window.  The root node of this tree contains an Intercom item, which when selected allows you to view the intercom configuration, capabilities.  The information is displayed in the Data View (a window occupying most of the lower right area of the application window.

There are three sub-nodes to the Intercom node called Studios, Classes, and Users.  Selecting either of these three nodes allows you to Add new Studios/Classes/Users, as well as Delete or Rename existing Studios/Classes/Users.  The lists are displayed in the Data View area.  As you add Studios, Classes, or Users, new tree nodes are created under the appropriate parent nodes for each new item created.  Selecting an individual Studio, Class, or User, allows you to edit the restriction set for the selected item.

When you select an individual Studio, you are able to define what resources are included in that studio.  Select the resource type from the Resource Navigation Bar, and then check or uncheck individual resources in the Data View.  When you selected an individual Class or User, you are able to define what resources and features are available to that Class/User.  Select a resource type from the Resource Navigation Bar, and then select a related set of restrictions from the Resource/Feature Group Tabs.  

Resource Navigation Bar

This list of buttons appears near the lower left of the application window (below the Context Navigation Tree).  The height and width of this list (and the tree above it) can be changed by clicking and dragging the divider bars between them.  The buttons in this window are enabled or disabled based on the selection made in the Context Navigation Tree.  The buttons behave like radio buttons, in that only one of them can be pushed in at a time.  Pushing in one of these buttons pops up any other button that was currently pressed.

The first button is the Configuration button, which is not actually a Resource or Feature button, but provides a convenient way to get at the configuration views of the Intercom, Studios, Classes, and Users.  The Configuration views for the Intercom include the resource configuration, and capabilities.  There is only one configuration view for Studios, Classes, and Users, and this view allows you to Add, Delete, or Rename these items as described above.  The configuration view for an individual Class or User allows you to select which Studios are included or excluded for this item.

The other buttons represent a specific Resource type (like Keypanels, Party Lines, IFBs, etc...), or a special set of Features or Menu items.  Once you select a Resource Type there may be many available views for each type.  The individual views are represented by Tabs in the Resource/Feature Group Tabs window.

Resource/Feature Group Tabs

This row of tabs appears across the bottom of the application window (above the status bar), although in some contexts there may be no tabs to view.  Each tab, when present, represents a related set of resources or features.

AZedit and the Restrictions Editor support a distinction between whether a user can Edit the components of a resource (such as the Latch Disable flags, or Talk Key Assignments of a keypanel, and the Input and Output ports of an IFB), and whether a user can Assign a resource to a keypanel (such as being able to put N001 on a key of a keypanel).  A user may be allowed to assign IF01 to a keypanel, but be prevented from changing the definition of IF01.  The ability to edit a resource is referred to as a Resource restriction, whereas the ability to assign a resource is referred to as an Assignment restriction.

For each resource type selected in the Resource Navigation Bar, there will be a Resource tab.  If the resource type can be assigned to a key on a keypanel, there will also be an Assignment tab.  These tabs select a list of the specified Resource type that you can modify restrictions for.  See the description of the Data View for how this is accomplished.

In addition to the Resource tab, and the optional Assignment tab, there may also be a Features tab (if the resource supports a set of features, such as Latch Disables, Key Restricts, Poll Delays, etc... for the keypanel type).  If the resource type has alphas or a description, there will also be an Alphas tab (providing access to the resource type's Alphas, Aliases, and/or Descriptions).  If the resource type is scrollable, there will also be a Scroll Enable tab (providing access to the resource type's Local, Trunk, and AZedit scroll flags)/

Data View

The Data View is located between  the Context Bar and the Resource/Feature Group Tabs on the right half of the application.  The Data View shows a list of the related features/resources and indicates whether or not the feature/resource is accessible in the current context by showing a ü or a û in the leftmost column.  The rightmost column uses the same symbols to indicate what the inherited state of the feature/resource is.  There are check boxes shown that allow you to override the inherited setting by explicitly Allowing or Denying access to the feature/resource.  Simply click on the checkboxes to change their state.  The leftmost column updates to show the actual access restriction applied.

Context Bar

The Context Bar appears across the top of the application window (below the toolbar and menu bar).  This window displays a text description of the current Context (i.e. Intercom : Configuration, or User : Default : IFB : Features).  It also contains  Prev and Next buttons that allow you to walk through all of the various context views in order (whereas the Context Navigation Tree, Resource Navigation Bar and Group Tabs allow you to quickly move to a particular context).

To move about in the application, you should be aware of the following mouse and keyboard shortcuts:

To quickly change contexts with the mouse:

To move in an orderly sequential forward or backward context with the mouse:

To change contexts with the keyboard:

To change access restriction using the keyboard:

To change access restrictions using the mouse:

When you select File | Change Intercom, the Restrictions Editor looks in the .CFG file directory for defined intercoms and presents a list of the possible intercoms that you could create a restrictions file for.   An intercom is defined when a .CFG file exists for that intercom.

When you select File | Save Restrictions, the Restrictions Editor saves the current restriction settings to the appropriate .RES file (named for the intercom).  If you attempt to exit the application while there are unsaved changes, the application prompts you to save before exiting.

<back to top>

Installation

To install the Restrictions Editor, insert the installation floppy diskette into a floppy disk drive and execute the SETUP.EXE file on the diskette. Follow the on screen instructions. The default directory for installation is:

C:\TELEX\RESEDIT\V550

but you may change this if desired. The installation program creates the desired directory if necessary.  The RESEDIT.EXE application file, and the release notes (this file) are copied to this directory.

The installation program also creates a shortcut to ResEdit.EXE on the Programs sub-menu of the Start menu on the Taskbar. The shortcut is labelled:

Restrictions Editor V5.5.0 (BETA)

The location of this shortcut, and its name, are not customizable during the installation process. You may move, rename, or delete this shortcut afterwards; however, if you move or rename it, it will NOT be deleted as part of the uninstall process.

At the end of the installation process, you are presented with a dialog that allows you to view this file, and to launch the application when complete.

To view this file at a later time, you can choose the Release Notes menu item from the Help menu within the application.

<back to top>

Running the Restrictions Editor

To run the Restrictions Editor after installation, simply select the shortcut from the Start | Programs menu.

The Restrictions Editor will create a set of registry entries located at:

HKEY_CURRENT_USER\Software\Telex\ResEditV2

For the most part, you will not need to edit the settings stored here directly as almost all of them are set automatically by the program or are modifiable through the Options | Preferences dialog in the application.

These registry settings are NOT removed during the uninstallation process.

<back to top>

Uninstalling the Restrictions Editor

To uninstall the Restrictions Editor, use the Add/Remove Programs applet from the Control Panel. Select the Restrictions Editor application from the list of available applications and press the Remove button.

The uninstall process will delete the RESEDIT.EXE program file, the Release Notes file, and the Start Menu shortcut. It will not delete the registry entries used to customize the application.

To fully remove the Restrictions Editor, you may have to manually delete the installation directory (which defaults to C:\TELEX\RESEDIT\V550), and all of the files and directories beneath it. You may also decide to manually delete all of the registry settings under HKEY_CURRENT_USER\Software\Telex\ResEditV2, although these settings may also be used by other installed versions of the Restrictions Editor.

<back to top>

Customizing the Restrictions Editor

Most of the configuration customization options are available via the Preferences dialog accessed via the Options | Preferences menu item or by pressing ALT+ENTER. The configuration options in this dialog should be self-explanatory.

There are a number of other customization options that are currently only available by editing the registry directly. These options are located under the HKEY_CURRENT_USER\Software\Telex\ResEditV2 key in the registry. 

Here is a list of the advanced customization options (default values shown in brackets), followed by a description of the option.

Windows\Colors\...

There are a large number of color setting parameters under this key.  All of the colors are stored as RGB values in hex where the value 0x00BBGGRR indicates the color components for Red (RR), Green (GG), and Blue (BB), and each two digit hex number can have a value of 0x00 to 0xff (0-255).

Black is 0x00000000, White is 0x00ffffff, pure Red is 0x000000ff, pure Green is 0x0000ff00, and pure Blue is 0x00ff0000. Most of the entries consist of some combination of RGB components.

Each of the parameters names should be self-explanatory, and you can edit these color entries directly if you feel it is necessary.

<back to top>