| ©2005-2008, Heymann Consulting |
|
| User Management Pro - Version 4.0.2 | |
| Documentation | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
v 4.0.2 |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Contents | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
0.1 Special Thanks 1.1 Tryout Version 2.1 How to publish a Cumulus
Catalog with User Management Pro 3.1 Groups 4 UMP User Permission: Restrict Access to Records / Categories 4.1 Record Restriction: Restrict
Search 5.1 Welcome Text 6.1 Cumulus Client Connection |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 0 Introduction | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
The User Management Pro is an extension to the Canto Cumulus Web Publisher Pro (WPP) or Internet Client Pro (ICP) Option. This product helps you to restrict the user's access to the categories and records in the Cumulus catalog. With the Web Publisher Pro or Internet Client Pro you can only give access or assign rights to a user for all the records and all the categories in the catalog. With the 'User Management Pro' you can define the access right for every record and every category per User! The version comes with a multi language web application. The following languages are supported out of the box: 'English', 'German', and 'French'. Additional languages can be added by the Cumulus administrator. Also the Cumulus category lists can have more than one language. The user of the web application can switch between languages at runtime. So with the 'User Management Pro' you can have e.g. an English Cumulus catalog with an English category tree and publish it also in a 'German' and 'French' Web Interface. For each user the configurable QuickSearch function can search in different catalog fields. The user has a pre-defined sort order and sort direction and can change the sorting by selecting a sort field from a list. This version also makes the Actions Menu configurable for each user. So different users can have different options to convert files before they download them. You can show or hide different records and categories from each user and also enable or disable the following functions just by one click in the catalog: View Menu, Record Menu, Image Menu, Number of rows and columns, the Sort Menu, QuickSearch, Advanced Search, Record Information, Preview, Collection Basket, Download, Email and Conversion. The download and email functionality can be configured for each user and for each and every single file (!) cataloged. Remark: it is only possible for the user to open one catalog at a time with the help of the 'User Management Pro'. Do you need additional functionality in the web application? We develop additional functionality based on your need. Send an email with your feature requests by clicking here. A special thanks to all who have contributed to the development and improvement of the User Management Pro product. Very special thanks to the following people who came up with innovative ideas to improve User Management Pro 4: Black Eye Digital, Mr. Bryan Taylor, Dallas, Texas, USA ThyssenKrupp Marine Systems, Mr. Jörg Klüver, Mr. Michael Specht, Hamburg, Germany Thank you very much to our Spanish Partner Electronic Publishing Systems S.L. (special thanks to Francisco Villaverde), who localised the software and provided us with the necessary strings. Thank you very much to our French Partner Avista Systems (special thanks to Pierre Saint Michel), who localised the UMP web application. The User Management Pro version 4 comes with a lot enhancements to make life of the Cumulus Administrator easier. Click here to see a detailed documentation on the new features of version 4. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 1 Installation | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
If you have downloaded your version from the web, unzip the file 'UserManagementPro4.zip'. A folder named 'UserManagementPro4' will be created. Otherwise copy the folder 'UserManagementPro4' from your product CD-ROM onto your harddisk. UMP4 comes with different web applications that you will find in the 'Installation' folder: User Management Pro Administration Web Application (UMP4_Admin.war) The UMP Admin web application can be used by the Cumulus Admin to set the user's permissions used in the UMP web application. User Management Pro Web Applications ('UMP4_WPP.war', 'UMP4_ICP.war', 'UMP4_WPP7.war', 'UMP4_ICP7.war', 'UMP4_WPP75.war', 'UMP4_ICP75.war', 'UMP4_WPP76.war', 'UMP4_ICP76.war') The UMP web applications are modified Cumulus Web Publisher Pro 3.0/7.0/7.5 or Cumulus Internet Client Pro 3.0/7.0/7.5 web applications. Please use the appropriate web application for your WPP/ICP installation:
Copy the UMP web application that belongs to your WPP/ICP installation (e.g. 'UMP4_WPP76') and the 'UMP_Admin.war' file, which you can find in the folder 'Installation', into your Tomcat web application folder ('...myTomcat/webapps'). Tomcat will recognise the new archive files and will unpack them into folders with the corresponding names ('UMP4_WPP' and 'UMP_Admin'). Now you can access the new web applications at 'http://myServer:8080/UMP4_WPP/' or 'http://myServer:8080/UMP_Admin/' (if your web application server listens to port 8080 (standard setup of Tomcat)). The basic pages are the pages of the Cumulus 'Web Publisher Pro' or 'Internet Client Pro' with the functions of the 'User Management Pro' added. The User Management Pro web application comes in demo mode. Without a serial number the software will allow access for only 5 minutes and will log you out after this period of time. If you already own a full version of the product or received a serial number with a time limitation, provide the serial number in the UMP Admin web application. You can order a time limited serial number that unlocks the software for 30 days by email here. A serial number for UMP for ICP can also be used with UMP for WPP to unlock the version! Important remark: When the user accesses the first page of the Cumulus Web Publisher Pro or Internet Client Pro, the web application evaluates the name and version of the web browser. If the browser is not Mozilla Firefox, Internet Explorer (from version 5) or Netscape (from version 6) or Safari under MacOS X, the user is linked to the folder 'Compatible', where he gets the information to update or change his version of the web browser. The pages that support older web browsers are not implemented in UMP4. Cumulus Java Classes Serial Number UMP4 uses a Cumulus Client connection to read necessary information out of your Cumulus catalogs. Therefor it is necessary that you have a valid Cumulus Java Classes (CJC) Serial Number installed in your Cumulus installation. If you do not yet have a valid CJC serial installed, add the JC serial as an option serial number to your Cumulus installation. You can do this as usual by using the Cumulus Server Console or by using the Cumulus Remote Admin through your web browser. You will get a new Cumulus Activation Key from Canto that will also unlock the Java Classes. The Cumulus Java Classes serial numbers are provided by Canto for free. Here are some the serial numbers for the latest Cumulus versions:
UMP 4 only needs the read only access serial number installed to provide full functionality, as it only reads the information from the catalogs but does not make any changes to the catalog. But we recommend to add both serial numbers (read only and read/write) to your installation to be prepared for upcoming Cumulus enhancements. You can find the serial numbers for your current Cumulus version, if it is not in the list above, on the Canto website at http://www.canto.com (> Download&Support). Connection between UMP and Cumulus Server UMP (as an addition to WPP or ICP) uses the Cumulus standard IP connections. Cumulus uses the IP port 9287 to communicate from any Cumulus Client (including WPP and ICP) to the Cumulus Server. If you install the UMP web applications (or WPP or ICP) in a Demilitarized Zone (DMZ), please make sure that the IP port 9287 used by Cumulus is open for communication between UMP and Cumulus Server. WARNING: please make sure that no firewall is blocking the communication between UMP_Admin and the Cumulus Server. Especially if Windows Vista is involved, the communication might be blocked by the internal Vista firewall. Please make sure that the port is open or deactivate the firewall. If the communication is not possible, you will get an error telling you that the 'UMP_UserInformation' field can not be accessed. The 'User Management Pro' software comes in DEMO mode. If you can not provide a serial number, the software is limited to work for 5 minutes until the user is logged out.
The UMP version shown in the screenshot above is limited to work for 5 minutes until the user is logged out. The user can close the browser and log in again and work for another 5 minutes. You can request a serial number from info@heymann-consulting.de, that unlocks the software for one month completely. Please provide your Cumulus Serial Number in your email, as the serial number that you will get is calculated based on your Cumulus serial. After adding the serial, the expiration date will be displayed in the demo dialog.
The Example Catalog that comes with the 'User Management Pro' should help you to understand the functionality of the product. Please install it on your Cumulus Server as usual and publish it to the Web: 1. Open the Cumulus Client and login as Cumulus Administrator. Remark: the 'User Management Pro' is not a new login mechanism nor does it change the Cumulus way to control user rights! It just adds new user rights and control mechanisms to the UMP web application.
1.3 Integration of UMP4 technologies into UMP3 web application User Management Pro 4 comes with a lot of new functionality in the UMP4_Admin web application. But the new version does only have modifications in the UMP library files and no changes in the web pages, so you can easily use the new technology with your old web application. This is interesting, because might have made a lot of changes to the web application to suite your or your customers needs (changing logos, colors, ...). The type and number of modification varies depending on the Cumulus Software you are using. There are some more changes to implement if you want to use the UMP3 web application with Cumulus 7, due to changes that Canto implemented in the Cumulus 7 Java Classes. This is what you have to do to use your current UMP3 web application with the new UMP4 technologies and a Cumulus 6 installation (if you are installing UMP for ICP, please replace '_WPP' by '_ICP' (e.g. 'UMP_WPP' by 'UMP_ICP) in the following description): 0. Make a backup copy of your current UMP folder! This is what you have to do to use your current UMP3 web application with the new UMP4 technologies and a Cumulus 7 installation (if you are installing UMP for ICP, please replace '_WPP' by '_ICP' (e.g. 'UMP_WPP' by 'UMP_ICP) in the following description): 0. Make a backup copy of your current UMP folder! 1.4 Update your UMP web application to run with a newer Cumulus Server installation The UMP web application is a modified WPP or ICP web application containing the WPP/ICP technologies. All the Cumulus technology can be found in the 'WebPublisherPro.jar' or 'InternetClientPro.jar' library file inside the 'WEB-INF/lib' directory. These Java Class libraries try to connect to the Cumulus Server version that they have been designed for, so a Cumulus Web Publisher Pro 7.5 web application expects a Cumulus 7.5 Server running containing a Cumulus Web Publisher Pro 7.5 license.
E.g. if you try to connect with the UMP4_WPP75 web application, which contains the WPP 7.5 libraries, to a Cumulus 7.6 Server (with WPP 7.6 license) installed, you will get an error message like: The option "00790" is not correctly licensed on the Cumulus Server. In this case download the newest version of UMP from the website to see, if a newer version of the UMP web application is available for your Cumulus Server version. To make your current UMP web application (in this example designed for Cumulus 7.5) work with Cumulus 7.6, you have to replace the 7.5 WPP/ICP technologies with the ones of Cumulus 7.6, that are installed inside the web application named 'Cumulus'. This is what you have to do: 1. Stop your Tomcat web application server. For other web application versions, the upgrade procedure is similar to the steps described here. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 2 Usage | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
The User Management of UMP uses the Canto Cumulus User Management technology introduced with Cumulus 6, so it is based on the Cumulus '$Users' catalog and the Server Console that comes with the Cumulus product. To store the new permissions introduced in UMP it is necessary to add one text field to the '$Users' catalog. To achieve this, here are the steps to follow: 1. Open the Cumulus Client and open the '$Users' catalog as Cumulus
Administrator.
WARNING: Please make sure that you create the String field named 'UMP_UserInformation'. Do NOT create a String field 'Untitled' and rename it lateron to 'UMP_UserInformation', because even after renaming the field, the Cumulus internal name of the field is still 'Untitled'. In that case UMP can not access the field and will give an 'UMP_UserInformation field not available' error! 3. Please make sure that the new field can be edited by the user.
Before you can use your UMP web application, please open the UMP_Admin web application to provide your serial number or (if you do not have a valid serial number) make your initial setup. Open the URL 'http://myServer:8080/UMP_Admin/login.jsp'.
1. Log into the web application as Cumulus Adminstrator. Only the Cumulus
Admin is allowed to use this web application!
3. Please provide the serial number(s) (the Cumulus Serial Number should
be read from your Cumulus Server application automatically) and select
the language of your web application and click 'Save Configuration'
to save your current setup. The software tries to connect to your Cumulus
Server to get your Cumulus Serial via IP port 8954.
Specify your email server attributes and click on 'Save Configuration' to make the new configuration valid. 5. After providing the serial number(s) and email server configuration you will be linked to the list of available users.
5. If your version is a tryout version, or a time limited tryout version, you will find this documented on the upper right-hand side of the page. 2.1 How to publish a Cumulus Catalog with User Management Pro 1. Create the Cumulus Catalog and catalog the files that you want to
publish on the web. WARNING: Please make sure that you specify the user's permission in the UMP_Admin web application first. 2.2 How to create a new user to access the web application In this example we would like to create a new user named 'James Dean' and make the UMP Example Catalog available to him. 1. Open the Cumulus Server Console in the Cumulus Client: File>Administration>Server
Console...
2.3 User Management Pro User Permissions The User Management Pro provides a lot of user permissions that can be configured in the 'Modify Permissions Page'. These permissions are explained in the following list:
2.4 How to define a search query for UMP The User Management Pro uses Cumulus search queries to restrict the access to records in the Cumulus catalog. If a restriction search is defined for the user, only the records found by the query can be accessed by the user. This is how you can define a query in Canto Cumulus and make it valid for the user: 1. Open the Cumulus Client and open the Cumulus catalog.
4. Click 'Floppy Symbol>Save...' to save the search query.
6. Open the Cumulus Server Console in the Cumulus Client: File>Administration>Server
Console...
10. Make the search query 'JPEG Files Only' available to the user by
adding it to the 'Restrict Access to' list or uncheck 'Restrict Access
to' and check 'View Shared Queries' to make all queries available to
the user.
IMPORTANT: the list of search queries that is displayed shows all the search queries available on your Cumulus Server. You can select any query from the list, even if the query is not yet assigned to the selected user. A query that is not yet assigned to the user (in the Server Console) can not be used as a restriction query or first search query lateron. 15. Select the search query 'JPEG Files Only'. The text of the query
will be displayed in the text box to inform you about the search criteria. The same technology is used for the 'First Search' parameter. Create a search query and assign it to the user like in the example above. 2.5 How to add a new language to UMP The User Management Pro technology to localise the strings in the web application is open, so the administrator can add more languages to the software. This is what you have to do to add another language (Spanish in this example) to the UMP web application: 1. Duplicate the English localisation file ('/UMP/WEB-INF/classes/UMP_en_us.properties') and rename the new file using the Java locale naming convention for the language (lowercase letters only): '/UMP/WEB-INF/classes/UMP_es_es.properties'. 2. Translate all the Strings in the localisation file 'UMP_es_es.properties'. You should convert all special characters into their HTML representation to be independant from the server platform and the encoding used. Example: replace 'é' with 'é'. 3. Add the name of the new language to ALL the localisation files (UMP_??_??.properties) of the UMP web application Add the following line e.g. to the French localisation file '/UMP/WEB-INF/classes/UMP_fr_fr.properties': Language.Spanish = Espagnol 4. Add the new language as a new option to the language selection menus in the UMP web application: <option value="es_ES"><hcu:getLocalText key='Language.Spanish'/></option> UMP web application: '/UMP/Standard/Login.jsp' line 88 and '/UMP/Standard/RecordViewTitle.jsp' line 634. You can specify the language that should be used in the Login Page by specifying the lang attribute in the URL like this: http://myServer/UMP/Standard/Login.jsp?lang=es_ES This will open the Login Page in Spanish, if a Spanish localisation file 'UMP_es_es.properties' is available. The strings in the page will be localised and the language menu will be set accordingly. If no lang attribute is specified, the Login Page tries to detect the current language setup from the Web Browser. It takes the current setup (for example: es-ar = Argentina Spanish) and maps the locale to the supported locales (Spanish es_es). If no matching locale is available, the locale will be set to 'en_US'. Here are the current browser locale mappings defined: 'en-...' to 'en_US' 5. Add a localisation of the Cumulus Fieldnames to your localisation file. See lines 84-111 in the Spanish localisation file '/UMP/WEB-INF/classes/UMP_es_es.properties'. 6. Add a localisation of the Cumulus Queries to your localisation file. See lines 45-49 in the Spanish localisation file '/UMP/WEB-INF/classes/UMP_es_es.properties'. This is what you have to do to add another language (Spanish in this example) to the UMP_Admin web application: 1. Duplicate the English localisation file ('/UMP_Admin/WEB-INF/classes/UMP_Admin_en.properties') and rename the new file using the Java locale naming convention for the language (lowercase letters only): '/UMP_Admin/WEB-INF/classes/UMP_Admin_es.properties'. 2. Translate all the Strings in the localisation file 'UMP_Admin_es.properties'. You should convert all special characters into their HTML representation to be independant from the server platform and the encoding used. Example: replace 'é' with 'é'. 3. Add the name of the new language to ALL the localisation files (UMP_Admin_??.properties) of the UMP_Admin web application: Add the following line e.g. to the German localisation file '/UMP_Admin/WEB-INF/classes/UMP_Admin_de.properties' to the Supported Languages section (line 9): Language.Spanish = Spanisch 4. Add the name of the new language to the localisation files (line 131): txtSpanish=Spanisch 5. Add the new language to the language selection menus in the UMP_Admin login page: <OPTION VALUE="es"><umpadmin:getLocalText key='Language.Spanish'/></OPTION> UMP_Admin web application: '/UMP_Admin/login.jsp' line 63. 6. Add the new language to the language selection menus in the UMP_Admin web application: <OPTION VALUE="es_ES"><umpadmin:getLocalText key='txtSpanish'/></OPTION> UMP_Admin web application: '/UMP_Admin/selectLanguage.jsp' line 77.
You can specify the language that should be used in the Login Page by specifying the lang attribute in the URL like this: http://myServer/UMP_Admin/login.jsp?lang=es |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 3 UMP User Management | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
User Management Pro 4 implements the definition of groups of users, an important function that is missing in the Cumulus Workgroup Edition. A user can belong to more than one group at a time. You can select a name of a group from the list of groups to limit the list of users. You can select 'Show All' to show all the defined users. Select 'Not Assigned' if you want to see the users that do not belong to one of the defined groups.
Click on '+' or '-' to add a group to or remove a group from the selected user(s). This will lead you to the 'Assign Group' page.
You can assign a group name to a list of users or specify a new group name in the 'Assign Group' page:
You can assign a group name by selecting it from the list of already existing groups or you can specify a new group name in the 'New group name' text box. Click on 'Assign Group' to save the group setting. The group names are displayed in the list of users. You can filter the list of users by typing the beginning of the user name in the 'Show Users' text box. Click on 'Filter' to only see the users that match the filter name.
The list of users above is limited to the user names that start with 'creative'. This is helpful if you do have to manage a long list of users and you do not know the group the users belongs to. You can send an email to all the selected users in the list by clicking the button 'Send Email'. You can specify the subject and the email body in the 'Send email to' page. You can also send a carbon copy to yourself or a list of users.
The email is sent to all email addresses that have been specified in the Cumulus Server Console (field name: E-Mail Address). All the users with an email address specified are marked with an email icon in the list of users. If you have selected users that do not have an email address configured yet, you will get a warning on top of the 'Send email to' page. When clicking the 'Send Email' button, the email will be sent to all the available email addresses.
Hold the mouse over the email icon to see the email address configured for the user.
User Management Pro 4 allows to modify a single permission for a lot of users at the same time. This feature is very helpful if you would like to change permissions for a lot of users after they have been configured, but their permission setup varies and you can not select users with similar permission settings easily.
Select the users and click the 'Modify Single Permission' button to go to the 'Modify Single Permission' page. Select the catalog and permission that you would like to change. The permission setup will be displayed and you can configure it as usual. Click on 'Save Permission' to save the user setting for all the selected users. Only the selected permission is changed for the selected users, all other permission for these users stay as they are. You can copy all permission settings of one user for one catalog to a list of other users. Copy the user to the clipboard by selecting the user from the list and clicking the clipboard icon.
After putting the user into the clipboard, you can select the users that should get the permissions of the clipboard user and click on the 'Copy Permissions' button to go to the 'Copy Permissions' page:
Select the catalog and double-check again, if you want to copy the settings as this can not be undone! Click on the 'Copy Permissions' button to copy all the permission settings from the user in the clipboard to all the selected users. The 'User List' page helps you to compare the permission settings for the different users. It gives you a good overview over all the permissions set for the selected users.
Select the name of the catalog from the list. The user permissions are displayed for all selected users in the specified catalog. Click on the permission name link to modify a single permission for all the selected users. Labels can help you to get a better overview over the users in the list of users. You can mark users or sets of users with a label by selecting the users in the list and by clicking the 'Label' icon which you can find next to the 'Users' column title.
The list of predefined labels will be displayed. Select one of the labels to assign it to the selected users or select 'No Label' to remove a label from the selected user settings.
The label color will be used to mark the users in the list of users. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 4 UMP User Permission: Restrict Access to Records / Categories | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| User Management Pro 4 provides more configuration settings for showing and hiding records and categories to the user. There are three different options of how to hide records from the user:
There are two different options of how to hide categories from the user:
The UMP Admin now provides more flexibility in configuring access rights for the user. Click on the 'Select' link to go to the permission configuration page. 4.1 Record Restriction: Restrict Search For every user you can define a search query that restricts the access to the records in the catalog. This query is added to every search query that is sent to Cumulus. To make the definition of the search query as easy as possible, UMP uses Cumulus Client queries, that have been saved and published. You can easily define the search query in the Cumulus Client by saving it in the Cumulus Search Window. To make the definition of the search query as easy as possible, UMP uses Cumulus Client queries, that have been saved and published. You can easily define the search query in the Cumulus Client by saving it in the Cumulus Search Window. Click on the floppy icon in the search window ('Save Query...') to store the query that you have defined in the search window. Give the query file a unique name and publish the query (!) to make it available for the users. Click here to get detailed information on how to create and publish a search query.
In the example above, a search query with the name 'JPEG Files Only' is assigned to the user, he is limited to only access the JPEG files in the catalog. If there is no 'restrictSearch' query defined for the user, the user has full access to all the records of the catalog. The search query in the query file can be very complex and can consist of a lot of different search criterias combined by 'and' and 'or'.
You can select one of the published Cumulus search queries from the list. The search query text will be displayed to help you identify the correct query. 4.2 Record Restriction: Record Filter You can limit the access to records by setting categories in the Record Filter permission. The user can only see the records within the selected categories (and its sub-categories). A category is specified by providing the full category path (seperated by ':'). An unlimited number of categories can be listed, seperated by comma.
If the Record Filter permission is empty, all the records are shown to the user. Click on the 'Select' link to go to the 'Select Record Filter' page. You can navigate through the complete category tree of the selected catalog and check the categories that you would like to use as the Record Filter. You can navigate through the category tree by clicking on the category name to go to its sub-categories (if available). On top of the page, you see your location in the category path, you can click on the category name to go to the category directly or click on the catalog name to go to the top of the category tree. Your current selection will be displayed at the bottom of the page. Remark: this page is only visible if a Cumulus Client connection can be established to the Cumulus Server.
You can also use your filter setup for hiding categories from the user by selecting 'Use Record Filter for filtering categories also'. 4.3 Record Restriction: Boolean Record Filter You can limit the access to records by setting boolean record fields in the Boolean Record Filter permission. The user can only see the records with the selected boolean fields set to 'true'. An unlimited number(!) of boolean record fields can be listed, seperated by comma.
If the Boolean Record Filter permission is empty, all the records are shown to the user. Click the 'Select' link to go to the 'Select Boolean Record Filter' page. Check the boolean record fields that you would like to use as the Boolean Record Filter. Only the boolean record fields of the selected Cumulus catalog are displayed in the page. Remark: this page is only visible if a Cumulus Client connection can be established to the Cumulus Server.
Click the 'Select' button to set the Boolean Record Filter setting. 4.4 Category Restriction: Category Filter You can limit the access to categories by setting categories in the Category Filter permission. The user can only see the selected categories (and its sub-categories). A category is specified by providing the full category path (seperated by ':'). An unlimited number of categories can be listed, seperated by comma.
If the Category Filter permission is empty, all the categories are shown to the user. Click on the 'Select' link to go to the 'Select Category Filter' page. You can navigate through the complete category tree of the selected catalog and check the categories that you would like to use as the Category Filter. You can navigate through the category tree by clicking on the category name to go to its sub-categories (if available). On top of the page, you see your location in the category path, you can click on the category name to go to the category directly or click on the catalog name to go to the top of the category tree. Your current selection will be displayed at the bottom of the page. Remark: this page is only visible if a Cumulus Client connection can be established to the Cumulus Server.
You can also use your filter setup for hiding records from the user by selecting 'Use Category Filter for filtering records also'. 4.5 Category Restriction: Boolean Category Filter You can limit the access to categories by setting boolean category fields in the Boolean Category Filter permission. The user can only see the categories with the selected boolean fields set to 'true'. An unlimited number(!) of boolean category fields can be listed, seperated by comma.
If the Boolean Category Filter permission is empty, all the categories are shown to the user. Click the 'Select' link to go to the 'Select Boolean Category Filter' page. Check the boolean category fields that you would like to use as the Boolean Category Filter. Only the boolean category fields of the selected Cumulus catalog are displayed in the page. Remark: this page is only visible if a Cumulus Client connection can be established to the Cumulus Server.
Click the 'Select' button to set the Boolean Record Filter setting. In the following example a category field named 'PublishCategoryToWeb' is created in the Cumulus Catalog to control the web access to the categories.
The initial value of this category field is set to TRUE ('Active'), so every new category will have this value in the field. If the user shall only see the categories 'marked' with TRUE, it is only necessary to set the field value of the 'Restrict Categories' permission for this user to the boolean field named 'PublishCategoryToWeb'. If the boolean example Category Field 'PublishCategoryToWeb' is not available in the Cumulus Catalog, all the categories are displayed to the user. If the Category Field is available in the Catalog, set the value of the field to FALSE to hide the category from the user. If the field value is set to TRUE or (!) the field value is EMPTY (undefined), the category will be displayed to the user. Important: the 'User Management Pro' is designed for the use with the Cumulus Workgroup Edition and implements features that are only available in the Enterprise Edition. In the Workgroup Edition it is not possible to search in category fields (Enterprise Edition feature). This is why you have to use Boolean Fields to control the access to categories on the web. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 5 UMP User Permissions | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
When the user accesses the web application for the first time, a welcome text can be displayed. You can configure this text in the permission parameter 'Welcome Text'. The text will be displayed in the UMP web application on the righthand side of the tabs.
The text will also be displayed when the web application is reloaded. You can specify one welcome text for all languages or specify different strings for each language. If the parameter value is 'Welcome', this text will be displayed independant from the language selected in the web application. If the parameter is '<de_DE>Willkommen</de_DE><en_US>Welcome</en_US><fr_FR>Bienvenue</fr_FR>', the specified strings will be displayed depending on the selected language in the web application. User Management Pro supports the languages English, German, French and Spanish in one web application. The welcome text and the first search name attributes can be set in a comfortable dialog that supports the one text for all languages or seperate text for each and every language.
The different localised strings are seperated by tags from each other in the permission settings.
5.2 First Search and First Search Name When the user accesses the web application for the first time, it is possible to let UMP perform a first search for records that can be different for each user. To make the definition of the search query as easy as possible, the 'User Management Pro' uses Cumulus Client queries, that have been saved and published. You can easily define the search query in the Cumulus Client by saving it in the Cumulus Search Window. Click on the floppy icon in the search window ('Save Query...') to store the query that you have defined in the search window. Give the query file a unique name and publish the query (!) to make it available for the users. Click here to get detailed information on how to create and publish a search query. When the user first accesses the web application (or reloads it) this search query is used. If no first search query is defined for the user, a search is performed for all the records that the user is allowed to access. The search query can be very complex and can consist of a lot of different search criterias combined by 'and' and 'or'. If a restriction is defined for the user, the first search query is performed together with the restriction query. In the middle of the Status Bar UMP will show the last search query text (category name or search text). You can display a search text which tells the user which search was performed. You can configure this text in the parameter 'firstSearchName'. This is how the 'firstSearchName' is displayed in the web application:
You can specify one First Search Name for all languages or specify different strings for each language. If the parameter value is 'All Images', this text will be displayed independent from the language selected in the web application. If the parameter is '<de_DE>Alle Bilder</de_DE><en_US>All Images </en_US><fr_FR>Tous les Images</fr_FR>', the specified strings will be displayed depending on the selected language in the web application. A standard sort order and direction can be configured for the user which is used when he first accesses the web application. You can specify the sort order for the user in the parameters 'Sort Field' and 'Sort Direction' (Ascending or Descending). If these fields are empty, the standard sort order of the web application is used. You can set the standard sort order of the web application in the file '/UserManagementPro/Standard/RecordView.jsp' in lines 14 and 15. The standard sort order is 'Asset Creation Date Descending' ('newest files first'). If the user is allowed to use the sort menu, he can change the sort order at any time by selecting a different sort field from the list or changing the sort direction by clicking the appropriate button.
Just click on the 'Select' link to go to the 'Select Sort Field' page.
Select the sort field from the list of the avaialble sort fields and click on the 'Select' button to set your selection. To specify the sort direction just click on the appropriate button to set the sort direction:
If the user has the right to use the text search function, the text search form is displayed in the web application:
The left search button starts a search in all the records of the catalog. The second button performs a search in the list of current records (search in current collection). In the user category field 'searchFields' you can define the search fields for the user. Important: these fields need to have an index for full text search, because the module performs a contains-search.
In this example the user can perform a search like: Asset Name contains 'tif' or Categories contains 'tif' or Notes contains 'tif' or Record Name contains 'tif'. If the 'searchFields' parameter for the user is left empty, the standard search setup is taken. You can specify the standard search parameter in the file '/UserManagementPro/Standard/HC_QuickSearch.jsp' in line 16. Just click on the 'Select' link to go to the 'Select Search Fields' page.
Check the fields that you would like to use in the Quicksearch function and click on the 'Select' button to set your selection. 5.5 Control Download Categories You can limit the download of assets by setting a list of categories in the Control Download Categories permission. The user can only download the assets within the selected categories (and its sub-categories). A category is specified by providing the full category path (seperated by ':'). An unlimited number of categories can be listed, seperated by comma.
If the Control Download Categories permission is empty, all the assets can be downloaded by the user. Click on the 'Select' link to go to the 'Select Control Download Categories' page. You can navigate through the complete category tree of the selected catalog and check the categories that you would like to use as the Control Download Categories. You can navigate through the category tree by clicking on the category name to go to its sub-categories (if available). On top of the page, you see your location in the category path, you can click on the category name to go to the category directly or click on the catalog name to go to the top of the category tree. Your current selection will be displayed at the bottom of the page. Remark: this page is only visible if a Cumulus Client connection can be established to the Cumulus Server.
You can limit the sending of assets by email by setting a list of categories in the Control Email Categories permission. The user can only send the assets within the selected categories (and its sub-categories). A category is specified by providing the full category path (seperated by ':'). An unlimited number of categories can be listed, seperated by comma.
If the Control Email Categories permission is empty, all the assets can be sent by email by the user. Click on the 'Select' link to go to the 'Select Control Email Categories' page. You can navigate through the complete category tree of the selected catalog and check the categories that you would like to use as the Control Email Categories. You can navigate through the category tree by clicking on the category name to go to its sub-categories (if available). On top of the page, you see your location in the category path, you can click on the category name to go to the category directly or click on the catalog name to go to the top of the category tree. Your current selection will be displayed at the bottom of the page. Remark: this page is only visible if a Cumulus Client connection can be established to the Cumulus Server.
Canto Cumulus supports so called 'Master Categories'. Each master category is a name for a single category tree. The Workgroup Edition comes with 4 different Master Categories: All, Categories, Keywords and Sources.
UMP supports hiding some of the category trees from the user. You can specify the Master Categories that you want to hide from the user by clicking the 'Restrict Master Categories Select' link. In the 'Restrict Master Categories Page' you can check the Master Categories that should not be accessable by the user. All unchecked Master Categories can be accessed by the user.
All the checked Master Categories will be listed delimited by comma in the Restrict Master Categories parameter.
If this text field is empty, the user has access to all available Master Categories.
In the parameter 'Default Master Category' you can specify the Master Category that will be displayed by default. In the example above, UMP will switch to the 'Categories' tree when the user accesses the web application. The Canto Cumulus Web Publisher Pro and Internet Client Pro support 4 different main views: Thumbnail View, Details View, Record Information and Preview.
In the parameter 'Default Record View' you can specify the Record View that will be displayed by default. In the example above, UMP will switch to the first view available when the user accesses the web application. This is usually the Thumbnail View, but depends on the users View Menu setup.
In the example above the user is not allowed to access the Thumbnail View, therefor UMP will automatically switch to the Details View if the Default Record View parameter is set to 'undefined'. UMP supports four different languages out of the box: English, German, Spanish and French. It is also prepared for Spanish and you can add your own languages as you like. 5.9.1 Localisation of the Web Application The basic language of the web application can be defined in the configuration section of the UMP Admin web application.
This is the basic setup for all the users using the web application and is used for the Login Page and web application, if there is not a different language defined for the user. You can use the following values: en_US = English The web application is also prepared for supporting Spanish (you will find a Spanish localisation file in the 'classes'-folder), but Cumulus does not support this language internally and due to the tight integration into Cumulus technologies in all pages. You can specify different languages for different users in the user attribute 'Language'. This attribute can have the same values listed above. If you have defined your own language, of course you can also use this Locale Identifier as a value here.
If the user is allowed to switch between the languages at runtime (user attribute 'Language Selection'), the language selection menu will be displayed in the web application.
If the user attribute 'language' is empty the basic language from the UMP Admin Configuration is taken. 5.9.2 Localisation of Catalog Names You can also localise the catalog names shown in the list of available catalogs.
If no translation is available, the original catalog name is displayed. You can specify the localised name of the catalog in the localisation files. Example: translate the 'UMP Example Catalog' in the German web application to 'Bilddatenbank': 1. Open the German localisation file with a text editor: .../UMP/WEB-INF/classes/UMP_de_de.properties'. Make sure that there are NO blanks in the original catalog name as shown in the example above. 5.9.3 Localisation of Category Names The 'User Management Pro' implements a multi-language category list. If the user is allowed to do so, he can switch between the languages at runtime.
It uses Cumulus Category Fields to hold the category names in the different supported languages. The category field names have to be as follows: CategoryName_en_US = English category name You can define your own language fields in the catalog. E.g. if you want to add Danish to your category list, just add the Cumulus Category Field 'CategoryName_dk_DK' to the catalog.
If a field is not available or the field is empty, the value of the field 'Category Name' is displayed as the category name. So if you have got categories in the catalog that do not need to be translated (e.g numbers), just leave the localisation fields empty so the usual Category Name is displayed. In the Example Catalog, the 'Weekly Jobs' in the 'Job Tracking' hierarchy are just numbers, that do not have to be translated. So in this case you do not have to fill the localisation fields, the job numbers are displayed anyway. If the user is allowed to switch between the languages, it is possible to change the language of the Category List at runtime by selecting the new language in the language selection menu. The order of the categories in the list is given by the alphabetical order of the categories in the Cumulus Catalog (based on the 'Category Name' field). If you want to have your own order, please use numbers in the category name to create your own 'alphabetical' order. Please keep in mind that these category names do not have to appear on the web, because you can have other category names in the localisation fields. Canto introduced new master categories with Cumulus 6: $All, $Categories, $Keywords and $Sources. With 'User Management Pro', you can translate these Category names, which confuse most of the users, to something more meaningful.
If you are using the UMP version for ICP and you are allowed to modify categories, it is possible to specify the different catagory names for the different available languages inside the web application. If the Category Fields ('CategoryName_en_US','CategoryName_de_DE','CategoryName_fr_FR') are available in the catalog, they are displayed in the Category Info page.
All the localisation of the web application is done based on the localisation files that can be found in the folder '.../UMP/WEB-INF/classes/'. The files following the usual naming convention: UMP_en_us.properties = English You can specify the following types of Strings in the localisation files: Catalog Names Example: to provide an English and German translation for the French Asset Handling Set 'Tous Format' (if you are using a French Cumulus Server), the files hold the following translation information: UMP_en_us.properties: UMP_de_de.properties: Make sure that there are NO blanks in the names as shown in the example above. You can use whatever character in the translation. The translations are read by the web application using the TAG <hcu:localise key=''>. 5.10 Modify Records and Categories (ICP only) With the version of UMP for the Internet Client Pro it is possible to modify records and categories in the Cumulus Catalog. All the functionality that is supported by ICP is also available in the UMP web application.
If you are allowed to modify records (Cumulus Server Console user permission), you can modify the record field values and assign categories to the records in the catalog. UMP shows the category names in the currently selected language. You can also specify the localised category names inside the web application:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 6 Miscellaneous | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
The new version provides even more setup dialogs to make it even easier for the Administrator to set the users' permissions. For some of the new functionalities UMP 4 uses a Cumulus Client Connection to read information out of your Cumulus catalogs. If a Client connection can not be established, the functionality is still there, but you might miss some comfort in setting of the permissions.
You will find the information, if a Client Connection is established or not, on the upper left hand side of the users page. A Client Connection can not be established, if
So you want to make sure that your Cumulus Server installation has a valid Cumulus Java Classes serial number installed (and activated by your current Activation Key). The Cumulus Java Classes serial number is provided by Canto for free. Here are some of the serial numbers for the latest Cumulus versions:
UMP 4 only needs the read only access serial number installed to provide full functionality, as it only reads the information from the catalogs but does not make any changes to the catalog. You can find the serial number for your current Cumulus version, if it is not in the list above, on the Canto website at http://www.canto.com (> Download&Support). 6.2 Disable 'Save Permissions' on a UMP demo server The Cumulus/UMP administrator can enable or disable all functions that modifies the user permissions in the Cumulus $Users catalog. This option is useful for sales partners to set up a User Management Pro demo server. You can disable all saving functionality in the page '/UMP4_Admin/switch.jsp' in line 21: session.setAttribute("com.hc.umpadmin.writeEnabled", "true"); Set the value of the attribute to "false" to disable the saving of permissions. 6.3 Filter group/username on UMP_Admin startup The Cumulus/UMP administrator can set a group filter or a username filter that is used at startup of the UMP_Admin web application. You can specify these filters in the page '/UMP4_Admin/switch.jsp' in line 16/17: session.setAttribute ("com.hc.umpadmin.groupFilter",
""); Set the value of the appropriate attribute to the group name or username to show the specified users at startup. You can also preset a username that is put into the clipboard at line 18: session.setAttribute ("com.hc.umpadmin.clipboard", ""); 6.4 Auto Login if only one catalog available If only one catalog is available to the user, UMP opens the catalog for the user immediately without showing the list of available catalogs for selection. If more than one catalog is available to the user, the list of catalogs is displayed for selection. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 7 Feedback & Support | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Your feedback is very much welcome! Please send all your questions about the product to the email address support@heymann-consulting.de. We try hard to answer your questions quickly and improve our products by implementing functionality based on your feedback. Remark: we do not offer a telephone hotline for this product. Please send in all your requests by email. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 8 Version History | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Version 4.0.2 - September 2008 The new version of User Management Pro 4 comes with two new web applications for Cumulus Web Publisher Pro 7.6 and Internet Client Pro 7.6. Version 4.0.1 - August 2007 The new version of User Management Pro 4 comes with two new web applications for Cumulus Web Publisher Pro 7.5.1 and Internet Client Pro 7.5.1. Please make sure that you are updating your version to the newer release of Cumulus 7.5, as Canto fixed a long list of bugs in the .1 release. A new Spanish localisation file has been added to the UMP4_Admin web application.
Version 4.0.0 - September 2006 The new version of User Management Pro 4 implements new powerful functionalities to let the Administrator restrict the users access to the Cumulus catalogs. It comes with a brand new UMP Admin web application. The good news for all User Management Pro 3 customers: No changes are necessary for using the new UMP Admin with your current UMP 3 web application! You just have to replace the UMP library file in your current web application by the new one to use the new functionality! So if you have made changes to the UMP3 web application, you do not have to reimplement all these changes in a new web application - just use your modified web application with the new library file.
Version 3.0.2 - January 2006 The new version implements a better support for additional languages. Spanish has been added to the UMP and UMP_Admin web application. Thank you very much to our Spanish Partner Electronic Publishing Systems S.L. (special thanks to Francisco Villaverde), who localised the software and provided us with the necessary strings. The UMP_Admin web application is now also available in French. Thank you very much to our French Partner Avista Systems (special thanks to Pierre Saint Michel), who localised the software and provided us with the necessary strings. The following changes have been implemented: 1) If a localised string is not found in the localisation files, an
error message is displayed like '[***Language.Spanish missing***]'.
This should help finding the missing strings in the localisation files. To sum up the changes in the web pages, here is the list of files in the web applications that have been changed: UMP web application: UMP_Admin web application: To use the new technology with your User Management Pro 3.0/3.0.1 implementation, please implement the changes described above into the JSP pages. As the JAVA libraries have been changed also, copy the new versions of the files into your web application: /WEB-INF/HC_UserManagementPro3.tld
Version 3.0.1 - November 2005 The new version is a bugfix release of the software for Web Publisher Pro and Internet Client Pro. Please find detailed information about the changes in the web application in the text file 'ChangesUMP301.txt' delivered with the software.
Version 3.0 - September 2005 The User Management Pro and the User Management Pro Administration Web Application have been developed for Canto Cumulus 6.6 and Web Publisher Pro and Internet Client Pro version 3.0 shipped since end of July 2005. This is the first version of the Administration web application, but the version number follows the version number of the User Management Pro web application. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| User Management Pro | |
| ©2005-2008, Heymann Consulting |
|
