Sign in
< Back to User Guide Top

Local Listener Web Browser Service

If licensed, the web browser service is started automatically when the VersaLex service/daemon is started. Through the serv ce, you can access the VersaLex UI using a web browser. The web browser service also allows you to access the Cleo VLTrader and Cleo Harmony web portal (see Configuring VLPortal Web Browser service). This section describes how to setup and configure web browser services. For information regarding the web UI user interface as it applies to both Cleo Harmony, Cleo VLTrader and Cleo VLNavigator, see Using the Web Browser UI. 

For information about current browser support, as well as the required minimum screen resolution, visit Cleo Technical Support and click the System Requirements link listed for under your product. Some of the uploading and downloading features within the browser services may require the client to turn off popup blocking.

If a native UI does not exist, you can use command line options to activate the local listener (if not already active) and to modify the HTTP port number.

Harmonyc -i "hosts/preconfigured/Local Listener.xml" 
VLTraderc -i "hosts/preconfigured/Local Listener.xml" 
LexiComc -i "hosts/preconfigured/Local Listener.xml" 
Harmonyc -p "Local Listener" -t "<Host><HttpPort>80" 
VLTraderc -p "Local Listener" -t "<Host><HttpPort>80" 
LexiComc -p "Local Listener" -t "<Host><HttpPort>80"

The web browser service is not supported on the iSeries (AS/400) platform. 

Configuring Cleo VersaLex web browser service

  1. Expand the Local Listener node in the tree pane and then click the Web Browser node.
  2. On the VersaLex tab in the content pane, specify parameter values as appropriate.

    See Local Listener Cleo VersaLex Web Browser Service reference for information about the parameters available.

  3. Click Apply.

Local Listener Cleo VersaLex Web Browser Service reference 

VersaLex Resource Path
The check box activates and deactivates access to this resource. It is activated by default.
The default value of the path itself is the product name (for example, /VLTrader or /Harmony). The path you specify must be included in the URL (for example, ) when accessing the web UI through a browser. You can change this value at any time, but it must begin with a forward slash (/) character.
If you include the parameter, transfers, in the URL (for example,http(s)://VersaLexComputerIP:http(s)Port/VersaLexResourcePath?transfers), today’s transfer report is automatically displayed. This matches the functionality of the native UI VLStat program.
Access via VLProxy toggles access to the resource through the Cleo VLProxy application. It is selected by default.
Cleo VLNavigator Resource Path
The check box activates and deactivates access to this resource. It is activated by default.
The path you specify must be included in the URL (for example,http(s)://VersaLexComputerIP:http(s)Port/VLNavigatorResourcePath) when accessing the web UI through a browser. You can change this value at any time, but it must begin with a forward slash (/) character.
Access via VLProxy toggles access to the resource through Cleo VLProxy. It is selected by default.
Portal Resource Path
The check box activates and deactivates access to this resource. It is activated by default.
Your trading partners must include this resource path in the URL when accessing the Cleo Portal application through a web browser. You can change this value at any time, but it must begin with a forward slash (/) character.
You can customize some aspects of the appearance of the Cleo Portal page. See Customizing your Cleo Portal banner.
Users must connect on a secure port
Limit users to SSL connections only. When selected, users will be able to successfully authenticate access to the VersaLex and Cleo VLNavigator applications only when an HTTP/s connection is used.
Note: For the Cleo Portal page, this check box is not applicable as the Cleo Portal page requires secured access. In fact, if a trading partner attempts to connect on an unsecured channel, the requests will be redirected to a secured channel. If a secured channel is not available, the trading partner will be denied access.
View Only Password
The password to allow view-only access to the application through a web browser. The default password is the product serial number. This password can be any combination of letters, numbers, or special characters, but cannot start with an asterisk (*).
Select Default Mode to set the default to view-only mode.
Cleo Harmony and Cleo VLTrader applications only: The view-only does not apply when a VLNavigator user group is assigned to this instance of the Cleo Harmony or Cleo VLTrader application.
Edit Password
The password to allow full access to the VersaLex application through a web browser.  The default password is the product serial number. This password can be any combination of letters, numbers, or special characters, but cannot start with an asterisk (*).
Select Default Mode to set the default to edit mode.
Cleo Harmony and Cleo VLTrader only: The edit password does not apply when a VLNavigator user group is assigned to this instance of the Cleo Harmony or Cleo VLTrader application.
Default automatic refresh rate
The interval at which the browser session will automatically refresh. The value must be between 5 and 60 seconds. The default value is 15 seconds.
Zip all download files
Toggles compressing/zipping all exported files (for example, certificates) into an archive when downloading through the web UI.

About Default Portal Configuration

Before discussing web portal setup and editing, it is important to understand the default web portal configuration of the web portal provided for you by VersaLex.

VersaLex provides a single, standard portal called Default Portal with four standard web pages: 

  • VLPortal default home page (VersaLex Web Portal)
  • Ad hoc file transfer page (Manual File Transfer)
  • Transfer reporting page (File Transfer History)
  • Help (VersaLex Web Portal Help)

Special rules apply to the Default Portal:

  • It cannot be removed. 
  • Its portal ID cannot be modified.
Special rules apply to the standard pages within the Default Portal:
  • VersaLex Web Portal:  except for its page ID, this page can be modified, but it cannot be removed.
  • Manual File Transfer and File Transfer History:  except for their titles, these pages may not be modified or removed.
  • VersaLex Web Portal Help:  except for its page ID, this page can be modified, but it cannot be removed.

Web Portals can be displayed in any language(s) most commonly spoken by your users by including a language resource file for each desired language. See Internationalizing your web portals for further details.

Configuring VLPortal Web Browser service

Note: This feature is being deprecated. For similar functionality, use Cleo Portal. See Cleo Portal for more information.
  1. Expand the Local Listener node in the tree pane and then click the Web Browser node.
  2. On the VersaLex tab in the content pane, specify parameter values as appropriate.

    See Local Listener VLPortal Web Browser Service reference for information about the parameters available.

  3. Click Apply.

Local Listener VLPortal Web Browser Service reference 

Resource Path
The check box activates and deactivates access to this resource. Access is activated by default.
The default value of the path itself is the product name (for example, /VLPortal). The path you specify must be included in the URL (for example, ) when accessing the Cleo VLPortal application through a browser. You can change this value at any time, but it must begin with a forward slash (/) character.
Access via VLProxy toggles access to the resource through the Cleo VLProxy application. It is selected by default.
Application Name
The name used by all your web portals. It is displayed as the title in the browser tab and as part of the titles in the web portal user dialogs. The default value is VLPortal.
Web Page Catalog
Displays the VLPortal Web Page Catalog dialog box. See Maintaining the VLPortal web page catalog.
Add custom link to user login page
A hyperlink included on the web portal login page. The value you specify must be a valid URL.
The check box activates and deactivates the feature. This option is deactivated by default.
See Providing access to the web portal.
You can specify the text describing the link by editing the value for the VLPortalUI.CustomLink property in the language-specificVLPortal_xx.properties file(s) stored under webserver\VLPortal\internationalization in the VersaLex home directory.
Use reCAPTCHA
The check box activates and deactivates the feature. It is activated by default.
The value you specify is the number of failed attempts possible before reCAPTCHA is used. reCAPTCHA is an additional authentication level added for your trading partners when accessing the web portal to keep automated software from engaging in abusive activities on your site. This value defaults to 3. To enable this feature for all login attempts, set it to 0. 
Web Portals
Displays the list of configured web portals. Each row in the table summarizes one web portal. 
The Portal ID field specifies a unique identifier for the portal. 
The Language(s) field specifies the ISO-639-1 language code(s) for the supported language(s) for this portal. English (‘en’) is provided by default with the VersaLex application. An asterisk (*) next to any of the language codes means configuration of the web portal for that particular language has not been completed. Therefore, users selecting those language-specific portals are not able to access the incomplete web page(s). See Internationalizing your web portals for detailed information. 
The Pages field provides a list of web page IDs that are included with this portal. You can select only one row at a time. From each row's right-click menu, you can:
  • Edit the web portal.  See Editing or creating a web page.
  • Clone the web portal. When you select this option, a dialog will be displayed allowing you to edit a new portal using the selected portal as a baseline. See Editing or creating a web page.
  • Remove the web portal. If the portal you attempt to remove is referenced in an HTTP user host, you will be asked to confirm the removal. Note that Default Portal may not be removed.
  • View the HTTP user hosts that reference the portal through the Where Used... option. See Viewing a web portal cross reference.
New Portal...
Create a new web portal from scratch. See Editing or creating a web page.

Maintaining the VLPortal web page catalog

  1. Expand the Local Listener node in the tree pane and then click the Web Browser node.
  2. On VLPortal tab, click Web Page Catalog....
    The VLPortal Web Page Catalog dialog box appears.
  3. The Web Pages table displays the list of current web pages. The Page ID field specifies a unique identifier for the page. The Language(s) field specifies the ISO 639-1 code(s) for the supported languages configured for this page. See Internationalizing your web portals for more information. Only one row can be selected at a time. From each row's right-click menu, you can:
    • Edit... the web page.  See Editing or creating a web page.
    • Remove the web page. If the page you attempt to remove is referenced within a current web portal, you are asked to confirm the removal. Note that the File Transfer History, Manual File Transfer, VersaLex Web Portal, and Web Portal Help pages cannot be removed.
    • View the web portals that reference this page through the Where Used... option.  See Viewing a web page cross reference.
  4. Use New Page... to create a new web page from scratch. See Editing or creating a web page.
  5. Use the Import… button to import new or modified language resource files to support languages other than English (provided by default with the VersaLex product). After you import a new resource file, it will be displayed in the read-only Language Resource Files field. See Internationalizing your web portals for further information.

Editing, cloning, or creating a web portal 

When you select Edit... or Clone… from a row in the Web Portals table, or when the New Portal... button is selected from the VLPortaltab, the web portal editor is invoked.

Before discussing web portal editing, it is important to understand the default web portal configuration: the web portal provided for you by the VersaLex application. See About Default Portal Configuration.

  1. The Portal ID designates a unique identifier for this portal. This is used as a reference "key" in the Associated web portal menu of an HTTP user host (see Local HTTP Users Configuration). 
  2. The Title field allows you to specify a meaningful string, used primarily for organizing the portals. This value will not be displayed anywhere within the user portal experience.
  3. The Images section allows you to customize the layout and design of the web portal framework.
    • The Logo defaults to img/defaultlogo.jpg. This image will be displayed in the upper left-hand corner of each web portal page. It can be changed to any customized image, for example, your company logo.
    • The Banner defaults to img/banner.jpg. This image will be displayed along the top of each web portal page. It can be changed to any customized image, for example, your company banner. A banner size of approximately 2000w by 84h pixels is recommended.
    • The Menu defaults to img/navpic.jpg. This image will be displayed just under the main menu, along the left border of each web portal page. It can be changed to any customized image.
    • Use Import... to import new graphic images that can subsequently be selected through the Logo, Banner, and Menu fields. All imported files are stored in webserver\VLPortal\img\ under the VersaLex home directory.
  4. Set up the Navigation Menu table to establish the pages that should be included in the portal and the order in which they should be organized. Each row in the table represents a single web page. Only one row can be selected at a time. From each row's right-click menu, you can:
    • Move Up to move the page up in the menu list.
    • Move Down to move the page down in the menu list.
    • Insert Above... or Insert Below... to insert a new page above/below the current row. When this is selected, the following dialog will be displayed, allowing you to select a web page from the current web page catalog.  See Maintaining the VLPortal web page catalog.
      Note: The web page should be configured for all supported Language(s), otherwise the web page will not be displayed for those language-specific users. See Internationalizing your web portals.
    • Edit... to edit the selected page. See Editing or creating a web page.
    • Remove to remove the selected web page from the navigation menu. This does not remove the page from the web page catalog; it simply removes the page from this portal's navigation menu.  Note that all web portals must have at least one web page in their menu; therefore, the last page may not be removed. See Maintaining the VLPortal web page catalog.
    • View the web portals that reference the selected page through the "Where Used..." option.  See Viewing a web page cross reference.
  5. Optional - Click Metadata to configure a metadata entry form for files the portal user uploads via the applet. See Configuring manual file transfer metadata.

To see how the fields specified on web portal editor map to an actual web portal layout, see the Sample web portal layout.

Editing or creating a web page

When you select Edit from a row in the Web Pages table in the VLPortal Web Page Catalog dialog box or in the Insert Page dialog box, or when you click New Page in the VLPortal Web Page Catalog dialog box, the web page editor is invoked.

Before discussing web page editing, it is important to understand the default web portal configuration: the web portal that is provided for you by the VersaLex application.  See About Default Portal Configuration.

Editing a base page

The Manual File Transfer and File Transfer History pages are referred to as web portal base pages. Only the page title and language can be changed for these two base web pages.

  1. In the Web Page Catalog dialog box, right-click the web page you want to edit and select Edit from the drop down menu.
    A edit confirmation dialog box appears.
  2. In the confirmation dialog box, click Yes.
    The Edit Page dialog box appears.
    Note: This dialog box is limited in scope for base pages. You can only modify values in the Language and Title fields.
  3. Select a value from the Language drop down menu.
    The Language drop-down list contains the ISO-639-1 codes associated with language files located in thewebserver\VLPortal\internationalization directory.
  4. Enter a title for the base page in the Title field.
    The value you to specify is displayed in the portal navigation menu. It should be of a reasonable length for display within a browser, and it should be entered in the language associated with Language drop down menu. If more than one Language has been specified for a web page, deleting the Title text removes the value for the selected language. However, for the base pages, you must specify at least one language. See Internationalizing your web portals for more information.
  5. Optional - Click Where Used to display a cross reference of the web portals. See Viewing a web page cross reference.

Editing a custom or link page

If any page other than a base page is being edited, a full-page editor is displayed. In the editor dialog, choose between a Custom or Linktype of page.
  1. In the Web Page Catalog dialog box, right-click the web page you want to edit and select Edit from the drop down menu.
    A edit confirmation dialog box appears.
  2. In the confirmation dialog box, click Yes.
    The Edit Page dialog box appears.
    Note: This dialog box is limited in scope for base pages. You can only modify values in the Language and Title fields.
  3. Select a value from the Language drop down menu.
    The Language drop-down list contains the ISO-639-1 codes associated with language files located in thewebserver\VLPortal\internationalization directory.
  4. Enter a title for the base page in the Title field.
    The value you to specify is displayed in the portal navigation menu. It should be of a reasonable length for display within a browser, and it should be entered in the language associated with Language drop down menu. If more than one Language has been specified for a web page, deleting the Title text removes the value for the selected language. However, for the base pages, you must specify at least one language. See Internationalizing your web portals for more information.
  5. Select a page type. Choose one of the following:
    • Select Custom to modify your custom-built web page. These are pages that you have created within the VersaLexproduct. For information about custom pages, see About custom pages.
    • Select Link to insert a link directly to any web page that has been built outside of the VersaLex product. For information about link pages, see About link pages.
  6. Optional - Click Where Used to display a cross reference of the web portals. See Viewing a web page cross reference.
About custom pages
Page ID
Designates a unique identifier for this page and once created, cannot be edited. It is used as a reference "key" in the web portal navigation menus. See Editing, cloning, or creating a web portal.
Language
Allows you to tailor the title and content of the custom page on a per-language basis. See Internationalizing your web portals.
Title
The title you specify is displayed in the portal navigation menu. It should be of a reasonable length for display within a browser. If multiple languages are supported, deleting the value in the Title field removes the custom web page for the selected language; however, at least one language must have a title.
If multiple languages are supported, deleting the value in the Title field removes the custom web page for the selected language; however, at least one language must have a title.
Section Table
Each row in the table in the main part of the dialog box contains the following columns
Section Text
Represented as heading text on the web page (HTML <H2> tag). 
Line Break
If selected, represented as a blank line (HTML <BR> tag) on the web page before the following Detail/Link Text.
Detail/Link Text
Represented in one of two ways on the web page:
  • If the Link field is empty, Detail/Link Text is represented as detailed text.
  • If the Link field contains a hyperlink, Detail/Link Text is represented as an underlined link reference.
Link
Represents an actual hyperlink to be displayed in your custom page. 
Use the right-click menu options to manipulate each row. A range of rows can be selected; however, this can only be done within the native UI. When manipulating a range of rows, the Shift key must be held down while selecting the right-click menu option. Note that the last row of the table will always be empty.
From each row's right-click menu, you can:
  • Edit Link... to insert a link or edit the link on the selected row.
    • Select None to clear the link.
    • Select URL to enter a valid URL (for example, a link to your company's web site).
    • Select Document to select a document (for example, a PDF of documentation pertinent to your trading partner).
    • Use Import... to import new documents that can subsequently be selected through the Document field. All imported files are stored in webserver\VLPortal\doc\ under the VersaLex home directory.
  • Move Up or Move Down to move the row(s) up or down in the ordering.
  • Insert Above or Insert Below to insert a row above or below the current row. 
  • Remove to remove the selected row(s).
About link pages
Page ID
Designates a unique identifier for this page and once created, cannot be edited. It is used as a reference "key" in the web portal navigation menus.  See Editing, cloning, or creating a web portal.
Language
Allows you to tailor the title and content of the page on a per-language basis. See Internationalizing your web portals.
Title
The title you specify is displayed in the portal navigation menu. It should be of a reasonable length for display within a browser. If multiple languages are supported, deleting the value in the Title field removes the custom web page for the selected language; however, at least one language must have a title.
If multiple languages are supported, deleting the value in the Title field removes the custom web page for the selected language; however, at least one language must have a title.
URL
HTML
Specify the target of your link.
URL
Select the radio button and specify a valid URL (for example, a link to your company's web site). 
HTML
Select the radio button and specify a valid HTML page. Click Import to browse to an HTML page. Files you import are stored in webserver\VLPortal\html\ under the VersaLex home directory.
  • If you choose the HTML option, any images referenced within the HTML file should be placed in webserver\VLPortal\img\under the VersaLex home directory. This can be accomplished using the Import... button in the VLPortal Images dialog box.
  • It is your responsibility to ensure that any content and style sheets are compatible with the web portal framework.

For information about how the fields specified on web page editor map to an actual web portal layout, see Sample web portal layout .

Viewing a web portal cross reference

When Where Used... is selected from a row in the Web Portals table, the following dialog is displayed. This dialog identifies the HTTP user hosts that are using this particular web portal. The dialog is used for reference only; no manipulation can be performed from here. For information about how to change a web portal reference for an HTTP user host, see Local HTTP Users Configuration.

Viewing a web page cross reference

When Where Used... is selected from a row in the Web Pages table of the VLPortal Web Page Catalog, or Where Used... is selected from the Navigation Menu table of the web portal editor, or the Where Used... button is clicked in the web page editor, the following dialog is displayed. This dialog identifies the web portals that are including this particular web page.  The dialog is used for reference only; no manipulation can be performed from here.  For information about how to change a web page reference for a web portal, see Editing, cloning, or creating a web portal.

Configuring manual file transfer metadata

Configuring metadata allows you to build a form that the user is prompted to fill out when performing uploads from the Manual File Transfer page in VLPortal via the applet. The form input is inserted into an XML file that is uploaded inside a zipped archive along with the selected files. 
  1. From the Web Portal editor (Editing, cloning, or creating a web portal), click Metadata.
    The Edit Portal Metadata dialog box appears.
  2. Enter information for the metadata file you want to create in the following fields:
    Filename
    Specify the name of the XML file to contain the user-supplied metadata that will accompany the uploaded files.
    Language
    Displays whatever alternative Label values have been supplied for the metadata items for the given language. See Internationalizing your web portals.
  3. Add or edit metadata items from the Form Data list.
    If there are no existing metadata items in the Form Data list, click New Item to display the New Metadata Item dialog box.
    If there are metadata items in the Form Data list, right-click an item and select Edit to display the Edit Metadata Item dialog box.
    Note: The New Metadata Item and the Edit Metadata Item dialog boxes contain the same fields.
    1. Enter information about the metadata item in the dialog box.
      Label
      This label is displayed for this item in the selected language in the form the user is prompted to complete when uploading files. You select a language for the label and enter the label text.
      Choices
      Indicate the choices available to the user when they provide information about this item. If you provide choices, they are delimited by the ‘|’ symbol. If the user can enter freeform text for the input, leave this field blank.
      Element Identifier
      The XML attribute for this item's corresponding element in the generated file.
      Required
      Indicate whether or not a selection/input is mandatory for this metadata item.
    2. Click OK.
      Your changes are saved and the Edit Portal Metadata dialog box appears.
  4. Optional - Right-click an existing metadata item and select one of the following from the menu:
    • Move Up and Move Down to change the order in which corresponding fields appear in the form the user is prompted to complete when uploading the file(s).
    • Edit to edit the metadata item
    • Remove to remove the selected metadata item.
  5. Click OK to save your changes and return to the VLPortal tab.

Internationalizing your web portals

The VersaLex application includes default web portal language support for the English (‘en’) language; however, additional languages can be configured for the language(s) most commonly spoken by your users. All text displayed within the login page and the web portal base pages (Manual File Transfer and File Transfer History) is contained within a language-specific resource properties file stored underwebserver\VLPortal\internationalization in the VersaLex home directory. 

The resource files must be specifically named in the format VLPortal_xx.properties, where xx corresponds to a valid language code . These codes must be in lower-case and must correspond to the two-letter “Alpha-2” codes for the specified language, as defined by ISO-639-1. You can find a full list of these codes at http://www.loc.gov/standards/iso639-2/php/English_list.php.
Note: The VLPortal.properties file found in the webserver\VLPortal\internationalization directory should not be modified. As changes are made to the VersaLex application during product releases, this file could be updated and any changes you make to this file will be lost. Also note that when updates are made to this file (for example, additional field values or sections), those changes will need to be manually migrated into each of the language-specific resource files that you have previously configured.

Adding support for a new language to the base pages

To add support for a new language to the base pages:
  1. Create a resource file for each language that you want to support. Use the VLPortal.properties file as a template for the desired language.  For example, if you want to add web portal Spanish language support (that has the ISO-639-1 language code of ‘es’), you would copy the VLPortal.properties file (from the webserver\VLPortal\internationalization directory) toVLPortal_es.properties.
  2. Open this newly created properties file in a text editor and translate all the text after the ‘=’ character into the desired language for each property provided in this file. In our example, we are translating to Spanish. Do not add a space after the ‘=’ character. 

    Example:

    The original English translation:

    The same properties translated to Spanish:

    Note: Any lines preceded by one or more ‘#’ characters is a comment and is ignored by the VersaLex application. These lines are not required to be translated. 
  3. Import the translated resource file(s) into the VersaLex application using the Import… button in the Maintaining the VLPortal web page catalog dialog.  
    Note: Do not copy the resource file(s) directly into the webserver\VLPortal\internationalization directory. In order for the resource file(s) to be properly registered in the VersaLex application, they must be imported. This applies to newly created resource files or modified resource file. In all cases, the files must be imported rather than directly copied.
  4. For each web page listed in the VLPortal Web Page Catalog, add an entry for the newly configured language. Right-click each web page entry and select Edit….
    1. If a prompt appears showing the associated web portals and asking if you are sure you want to edit it, select Yes.
    2. From the Language drop-down selector in the upper-right corner, choose the newly imported language. 
    3. Add the page title content in the appropriate language and click OK.
    Note: At a minimum, the above steps should be performed for the four baseline standard web pages (that is, VersaLex Web Portal, Manual File Transfer, File Transfer History, and Web Portal Help). If any of these pages are missing a particular language variant, an asterisk (*) is displayed next to the language in theWeb Portals table in the VLPortal tab.

    See Configuring VLPortal Web Browser service.

  5. Additionally, web portal users selecting this language will not be able to view the missing language variants. Further, if all the pages are missing, users will not be able to log into the web portal. When missing pages are encountered, a warning message is logged to the VersaLex console each time the web portal user logs in.
  6. If it is necessary to remove a page for a specific language variant and it is not the only language configured for that page:
    1. Edit the desired page.
    2. Select the language variant from the list.
    3. Clear the Title text and click OK. 
      You are prompted to be sure you want to proceed. 
    4. Click Yes to complete the process.

Adding support for a new language to the help documentation

The text for the web portal help is located in webserver/web_docs/help/VLPortal; it is called VLPortal_Help.html. You can add support for a new language to the help documentation.
  1. Create a new HTML document from VLPortal_Help.html.  For example, if creating a Spanish language document, createVLPortal_Help_es.html. 
  2. Open the new file in an HTML editor.
  3. Translate all the text appropriately.
    If you want to update the screen images as well, use a screen capture application to capture images and name the images appropriately, for example, VLPortalLayout_es.bmp.
  4. Within your HTML file, update all the image references to point to your newly created image files.
  5. When finished editing your new HTML file, go to the VLPortal Web Page Catalog. Right-click on the VersaLex Web Page Helpentry and select Edit….
    1. If a prompt appears, showing the associated web portals and asking if you are sure you wish to edit it, click Yes.
    2. From the Language menu in the upper-right corner, choose the desired language. 
    3. Add the Title content in the appropriate language.
    See Editing or creating a web page and Maintaining the VLPortal web page catalog.
  6. Import you new HTML file.
    Click Import, select the new file as your linked file, and click OK.
    Note: Do not copy HTML files directly into the webserver\VLPortal\html directory. In order for the HTML file to be properly registered in the VersaLex application, it must be imported. This applies to a newly created HTML file or a modified HTML file.  In all cases, the HTML files must be imported rather than directly copied.

Sample web portal layout

This example displays how a web portal configuration would appear in Internet Explorer.

Providing access to the web portal

Note: A custom web portal splash screen can be displayed by placing it in webserver\VAADIN\cleo\images\custom under the Cleo Harmony, Cleo VLTrader, or Cleo LexiCom home directory. The filename must start with “splash.” (the word splash followed by a period). Supported formats include JPEG, GIF, and PNG. The image can be no larger than 525X340 pixels and no smaller than 250X100 pixels.
  1. Before your trading partners can access the web portal, you must first establish a mailbox for each partner under the local HTTP users (see Local HTTP Users Configuration), and provide your partners with the proper URL (for example,http(s)://VesraLexComputerIP:http(s)Port/VLPortalResourcePath). Once these steps are followed, your trading partners can access the web portal by entering the specified URL into their browser. They will be prompted for a login.
  2. The User name and Password are those that were established within the trading partner's mailbox under the local HTTP user. 
  3. To change a password, click Options. 

    A password can be changed if:

    • the username's mailbox is not defined as an LDAP Usergroup and/or the username’s password has expired or
    • the username's mailbox is defined as an LDAP Usergroup, the LDAP Server Directory Type is "Active Directory," the LDAP Server Security Mode is not set to "None," and the user's password has not already expired.
  4. The user can choose from the list of available languages from the Language drop-down list and view the web portal in their preferred language based on the resource files that have been configured and imported into the Cleo Harmony, Cleo VLTrader, or Cleo LexiCom application (see Internationalizing Your Portal).
  5. If the option to select a custom link was configured in the VLPortal tab, a link will be included on the login page. (See Configuring VLPortal Web Browser service.) The text describing this link can be customized by editing the VLPortalUI.CustomLink property in the language-specific VLPortal.properties file(s) stored in webserver\VLPortal\internationalization under the Cleo Harmony, Cleo VLTrader, or Cleo LexiCom home directory. 
  6. If reCAPTCHA authentication was enabled on the VLPortal tab, a dialog similar to the one shown below will also be displayed when the number of configured failed login attempts has been exceeded, or the number of failed login attempts was set to zero. See Configuring VLPortal Web Browser service.     
  7. After successfully logging in, the trading partner will be presented with the web portal home page in his desired language. The web portal associated with the user login is specified on the Local HTTP User Host: Host HTTP tab. See Configuring access for HTTP host users. The navigation within this portal is determined by the setup you established under the VLPortal tab. To understand the default (as-shipped) web portal configuration, see Configuring VLPortal Web Browser service. 

Embedding web portal base pages into external web pages

It is possible to link directly to a web portal base page (Manual File Transfer or File Transfer History) from your own web pages. In order to access a base page in this manner, it is first necessary to log in, as discussed in Providing access to the web portal. The URL you provide will contain parameters to direct the display of the desired page(s).

Transfer Reporting page URL

The Transfer Reporting page is provided. 
http(s)://VersaLexComputerIP:http(s)Port/VLPortalResourcePath?reportName= FileTransferHistory&external=true

Ad Hoc File Transfers

The Ad Hoc File Transfers page is provided.

http(s)://VersaLexComputerIP:http(s)Port/ VLPortalResourcePath?reportName= ManualFileTransfer&external=true

Transfer Reporting and Ad Hoc File Transfers

The Transfer Reporting and Ad Hoc File Transfers pages are provided, in the order specified, through a tabbed pane within a single page.

http(s)://VersaLexComputerIP:http(s)Port/  VLPortalResourcePath ?reportName= FileTransferHistory, ManualFileTransfer&external=true
Note: You should not provide multiple links to the base pages within the same web browser session. If you want to display multiple base pages, you should request all pages within one URL, using a comma-separated list as shown above.

Configuring Dashboards and System Monitor for web browser service

Cleo Dashboards and Cleo System Monitor are applications that are enabled from the Dashboards/Monitor tab in the Cleo VLNavigator application.

Note: This section applies to the Cleo Harmony and Cleo VLTrader applications only.
  1. Expand the Local Listener node in the tree pane and then click the Web Browser node.
  2. On the Dashboards/Monitor tab in the content pane, specify parameter values as appropriate.

    See Local Listener Dashboard and System Monitor web browser service reference for information about the parameters available.

  3. Click Apply.
    Note: You must restart the Cleo Harmony or Cleo VLTrader service/daemon before you use Cleo Dashboards or Cleo System Monitor.

Local Listener Dashboard and System Monitor web browser service reference

Dashboards Resource Path
The check box activates and deactivates access to the Dashboards resource. Access is activated by default.
The default value of the path is /VLDashboards. Dashboards is a web UI-only application. You must include this resource path in the URL (for example, ) when accessing Dashboards through a browser. You can change this value at any time, but it must begin with a forward slash (/) character.
Access via VLProxy toggles access to the resource through Cleo VLProxy. It is selected by default.
System Monitor Resource Path
The check box activates and deactivates access to the Dashboards resource. Access is activated by default.
The default value of the path is /VLMonitor. System Monitor is a web UI-only application. You must include this resource path in the URL (for example, ) when accessing System Monitor through a browser. You can change this value at any time, but it must begin with a forward slash (/) character.
Access via VLProxy toggles access to the resource through Cleo VLProxy. It is selected by default.
Report Server
URL
RMI Port
Settings
The Report Server is a necessary component to Dashboards and System Monitor and the report server URL and RMI Port must be configured in order for Dashboards or System Monitor to function. Currently, Jinfonet’s JReport Server is supported by the VersaLex application. The Cleo JReport Server installer must be used, and the report server must be dedicated to Cleo Dashboards and System Monitor applications. HTTP-only is supported with the report server. The default server port is 8888 and the default RMI port is 1129. It is strongly recommended that the report server not be installed on the same computer as VersaLex.  Depending on report overhead and number of users, one report server can be set up to serve multiple instances of VersaLex, or a separate report server can be dedicated to each VersaLex. It is not recommended that the same report server be used across VersaLex pools, as one report server instance cannot be used to serve different versions of VersaLex.
Click Settings to display the report server log level setting and version.
Use the menu in the Options section select a Log Level for your reports.
Select Normal for everyday operation. Select Verbose in cases where debug logging has been requested by Cleo Support.

Configuring Cleo Unify for web browser service

Cleo Unify application is enabled from the Cleo VLNavigator Unify tab. See Cleo VLNavigator.

Note: This section applies to Cleo Harmony and Cleo VLTrader systems only.
  1. Click Local Listener > Web Browser in the tree pane and then click the Unify tab.
  2. Select the Unify Resource Path check box to enable access. The resource paths are not enabled by default. 
  3. Specify the path to the Cleo Unify resources.
    The default value is /Unify. Cleo Unify is a web UI-only, and users must include this resource path in the URL when the application through a web browser. For example, http://VersaLexComputerIP:http(s)Port/Unify)
  4. (Optional) Clear the Access via VLProxy check box. It is selected by default, but you can clear it to disable access through Cleo VLProxy.
  5. Click Apply.

Configuring graphics and fonts

If you are running the Cleo Harmony, Cleo VLTrader, or Cleo LexiCom application on a Unix platform, you might need to adjust graphics- and font-related properties if the application is reporting related problems. Running in Headless mode eliminates any possible dependencies on X11 or XVFB. When Headless mode is enabled (the default for new installs), the other graphics and font settings cannot be changed. The corresponding XML property name is <Headlessmode>.

  1. Click the Graphcis/Fonts tab.
  2. Clear the Headless mode check box to enable edit mode for the other graphics and fonts settings.
  3. Select the Mixed settings check box to enable the properties below.
    Use platform graphics
    Property name: <UsePlatformGraphics>
    Description: Indicates to use native graphics environment rather than the application’s virtual graphics environment
    Default value: True if Solaris or HP-UX and JRE 1.5; False otherwise
    Use X11 DISPLAY environment variable
    Property name: <NeedX11DisplayVariable>
    Description: If access to X-Window is needed for native graphics environment
    Default value: True
    Property name: <X11DisplayVariableValue>
    Description: X11 server number and screen number.  If an X11 server is not available, it may be necessary to run Xvfb.
    Default value: 0.0
    Include application fonts
    Property name: <IncludeApplicationFonts>
    Description: Includes webserver/AjaxSwing/lib/fonts in font path.  Can only be False if <IncludeJreFonts> is True
    Default value: True
    Include JRE fonts
    Property name: <IncludeJreFonts>
    Description: Includes jre/lib/fonts in font path.  Can only be False if <IncludeApplicationFonts> is True
    Default value: True
    Reverse order in font path
    Property name: <ReverseOrderInFontPath>
    Description: Reverses order of above directories in font path
    Default value: False
    Use application font properties
    Property name: <UseApplicationFontProperties>
    Description: Indicates to use application’s font properties rather than JRE’s
    Default value: True, if Linux. False otherwise
    Use platform font
    Property name: <UsePlatformFont>
    Description: Indicates to use native font rather than JRE’s
    Default value: True, if AIX. False otherwise

    Xvfb (X virtual frame buffer) is an X11 server that performs all graphical operations in memory (http://en.wikipedia.org/wiki/Xvfb). Xvfb implementations are available on Linux, Solaris, AIX, and HP-UX. If needed, perhaps the easiest way to activate Xvfb is to start an Xvfb process just prior to starting the Cleo Harmony, Cleo VLTrader, or Cleo LexiComapplication in the Harmonyd, VLTraderd, or LexiComd daemon script. The X11 server number and screen number are runtime parameters to Xvfb; the <X11DisplayVariableValue>

    above would need to be set to the same server and screen numbers.
    Note: If a native UI does not exist, you can use command line options to change any of the above settings.  For example: 
    Harmonyc -p Local Listener\Web Browser –t <Service><IncludeApplicationFonts>False
    VLTraderc -p Local Listener\Web Browser –t <Service><IncludeApplicationFonts>False
    LexiComc -p Local Listener\Web Browser –t <Service><IncludeApplicationFonts>False
    • When Mixed settings is selected, the graphics and text settings can be a mixture of the VersaLex software's virtual environment and JVM runtime and operating system native environment.
    • When Application only settings is selected, all of the graphics and font settings shift to only those provided by the Cleo Harmony, Cleo VLTrader, or Cleo LexiCom software's virtual environment.
    • When Platform only settings is selected, all of the graphics and font settings shift to only those provided by the JVM runtime and operating system native environment. 

    For both Mixed settings and Platform only settings, if the Use X11 DISPLAY environment variable check box is selected, you should ensure the server and screen number are properly set.

Configuring web browser service advanced properties

  1. Click the Advanced tab.
  2. Specify values for the following properties as needed.
    Page Size
    Use this option to specify the number of nodes on a page.
    Changes to these settings in a web UI session are immediately applied to the session so that the optimal values can be determined - other active web UI sessions must explicitly refresh the tree (right-click in whitespace around tree).  To match previous versions of the VersaLex application when these settings were not configurable, set them as follows:
    Top Level
    Host Subfolders
    The number of nodes displayed per page for top level and host subfolders trees.
    Note: These settings apply to Cleo Harmony and Cleo VLTrader applications only
    Within Hosts
    The number of nodes displayed per page for the active and template hosts tree in the main window.
    Certificates
    The number of nodes displayed per page for the certificates tree in Administration > Certificates in the web UI or in Tools > Certificate Manager in the native UI.
    Session Timeouts - Harmony/VLNavigator
    These properties applies to the VersaLex and Cleo VLNavigator applications only.
    Initial startup
    The time allotted for launching a new web browser session. Default value: 120 seconds.
    Waiting for response
    The maximum time allowed waiting for server response to a browser request. Default value: 120 seconds.
    Abnormal exit detection
    The time allowed without a web UI ping before the session is shutdown by the server seconds. Default value: 60 seconds.
    Session Timeouts - VLPortal
    This property applies only to VLPortal.
    Inactivity Timeout
    The maximum time allowed while logged into the web portal without any user activity before the session is expired (default 600 seconds).  
    Note: If you have configured your portal users to use the applet, this value should be set large enough to cover the entire duration that a user may have an applet window active.
    Response Headers
    Additional response headers (primarily for required security headers) for the web UIs as a whole. Enter a new header on each line.
    Possible headers include:
    • X-XSS-Protection: 1; mode=block
    • X-Content-Type-Options: nosniff
    • Cache-Control: no-store
    • Content-Security-Policy: script-src 'self'
    If you specify X-Frame-Options, for those web UIs where IFrames are used (for example, Cleo Harmony and Cleo VLTrader), a value of DENY is automatically changed to SAMEORIGIN.
    If you specify Content-Security-Policy, for those web UIs where inline scripts are used(for example, Cleo Harmony and Cleo VLTrader), a script-src directive is added if not already present, and includes 'unsafe-inline' and 'unsafe-eval'. If the directive already exists, 'unsafe-inline' and 'unsafe-eval' are automatically inserted into the directive.
    Debug Settings
    Append service debug to system debug file
    Select the check box to log debug information into the VersaLex system debug file.
    Create individual client debug files
    Select the check box to create a new HTML client debug file (stored in logs\ under the VersaLex home directory) for every JVM instance.
  3. Click Apply.

Related articles

Comments

0 comments

Please sign in to leave a comment.