Getting Started

Preferences

 

In Agile e6 it is possible to modify the appearance and the behaviour of the Java Client in the Preferences mask:

 
The settings are stored between sessions on this machine and for each Agile EDM user.
 

General

 

Login

 
Section Description
Login type

For detailed information about single sign-on functionality, please refer to the General Administration Online Help > Agile e6 Single Sign-On Functionality.

For detailed information about default log in information, please refer to the document Start Agile e6.

HTTP/S support
  • Connect using an HTTP server
    When activating the checkbox, the startup window does not contain the options Server and Port.
    Base URL of the web server. Leave empty to use the WebStart server.
  • Server URL
    Apply the base URL and Port of the web server. When using the WebStart server, leave this empty.
  • Service Name
    Apply 'plm-api-<installation_name>/services'.
    <installation_name> = the name of the Agile e6 server installation that has been given during the Agile e6 server installation.
    The complete URL can be tested by applying the following path in the browser:
    e.g. https://exampleserver.com:7104/plm-api-axis/services
    The following should be displayed: 'And now ... Some Services ...'.
 

Appearance

 

In the Appearance section it can be defined, how the client should look like in general.

Section Selection Description
Desktop Show ToolTips Defines if tool tips are shown.
  Text in toolbars

When activated, places text under each option in the toolbars.

A restart is required.

  Extended file selector When activated, it uses the Java file selector.
  Scrollable desktop

In MDI mode, when a window is bigger than the client desktop, scrollbars are added to the desktop

This function is working only in MDI mode. A restart is required.

  Show window contents when dragging

In MDI mode, when activated, the contents of a window can be seen when dragging the window. When deactivated, only the frame of the window can be seen when dragging the window.

This function is working only in MDI mode.

  Single Document Interface

Activated: Every mask is opened as a tab.

Deactivated: Every mask is opened in Multi Document Interface (MDI), i.e. in an extra window.

Restart required

  Show Window gripper Activates window gripper for docked windows.
  Floating windows always on top Defines if floating windows are displayed always on top or in the background
Look&Feel Look&Feel The Look&Feel can be adapted individually. It is stored between sessions on the working machine and for each user.
  JIDE Style

Defines the style of the client.

The following styles are available:

  • Eclipse
  • Eclipse 3.x
  • Office 2003
  • Office 2007
  • Visual Studio
  • Visual Studio (Metal)
  • Xerto
  JIDE Theme Defines the color of the client.
    The style and color of the client and the masks do also depend on the desktop property settings of the PC the client is used on.
Background picture File Path to the background picture. All formats except bmp are supported. There's no size limitation for the file.
  Display

Defines if the picture is displayed:

  • Centred
  • Stretched
  • Tiled
 

Masks

  The layout of the single masks and their components (e.g. fields) can be defined here.

When clicking the Default Value button, the default values are taken that have been defined in the jacc.defaults file. If no default values have been defined in the jacc.defaults file, the default values are taken that have been defined in the source code.

The following screenshots of the mask show the default values.

 
Tab Options
Border
Border Settings Description
Field Defines the border style for a field in the mask.
Selected Field Defines the border style for a selected field in the mask.
Border Type for Hyperlink Defines the border style for a hyperlink in the mask.
Mask Defines the border style of the mask itself.

Color

On the Color tab the different colors can be defined for:

  • Field
  • Status bar
    If no specific color is chosen for the status bar, the color of the used theme is used. Otherwise, the chosen color is used.
  • List
  • Thumbnail
  • View mode

When clicking on a color the normal Choose color mask is opened. When clicking on the More Colors button, the Choose a Color mask is opened which allows to see a preview of the chosen color as text or field color. A HSB and RGB tab are also available to define a color more precisely.

Font

On the Font tab the font family and font style can be defined for text in:

  • Field
    Here the font family and font style can be chosen for the text in the field and the title of the field.
  • Tab

When clicking on the font, a preview mask is opened where the font family, the size and the style can be chosen. The newly chosen settings can be seen in the Preview section.

Layout

On the Layout tab the layout can be defined for:

  • Field: Here, the margins of the text to the field frame can be defined.
    • Content margin:
  • Adjustment:
    • Calculated field size: If activated, the field size is calculated with the field's content. Otherwise the preferrred field size is used.
    • Resize mask components: Flag whether the mask components are scaleable when resizing the mask.
    • Fields oversized: If set, the position and size depends on component insets.
  • Size: Here, different size settings for masks can be defined.
  • Thumbnail: Here the size of the thumbnail can be defined by indicating the initial cell size in which the thumbnail is displayed.
  • Tab
    • Show icon: Here can be defined if an icon should be shown in the tab title as well.
      With the styles Eclipse and Eclipse 3.x, which can be selected under Appearance > Look & Feel > JIDE Style , the option to show icons on the tabs is not supported!
    • Color scheme: If no value is set, the tabs in a mask will all have the same color. If "OneNote" is set, the tabs in a mask will all have a different color.
  • List: Here can be defined how the layout of cells in lists should look like.
    • List cells bordered: List cells are highlighted with a 3D effect in Edit mode only.
    • Row height: Row height in pixels; -1 is the standard setting. The bigger the number, the bigger is the row height.
    • Show horizontal lines: If deactivated, no horizontal lines in a list will be displayed.
    • Show vertical lines: If deactivated, no vertical lines in a list will be displayed.
    • Fill empty space with rows: If deactivated, there will be no horizontal and vertical lines visible for empty space in a list.
    • Calculated row height: The height of rows in a list will be automatically adjusted according to the size of the content that is displayed.
    • Store list layout: The calculated row height will be saved for the next session.


Please note that if the checkbox for the Calculated row height is activated, the Java Client needs its time to adapt the height of each row according to the contents. It is not recommended to activate this checkbox if the database contains a lot of data since this can result in a potential performance loss!

Others

The following can be defined here:

  • Draw gradient on masks
    When activated, the background color of the mask is drawn with a gradient
  • Use context menu

For hyperlinks the following can be defined:

  • Change cursor on hyperlink
  • Draw border around field

 

File service

  The proxies for the file service access can be configured here.
 

Drag and Drop

 

Here can be defined which drag and drop options are allowed.

Drag and Drop contains the following sections:

Feature Description
Enabling Record Drag and Drop
  • Use the drag feature
    Activated: Allows to drag records within Agile e6.
  • Use the drop feature
    Activated: Allows to drop records from other applications into Agile e6.
When changing the "drag" feature, masks have to be reopened so that this feature becomes effective.
Plain Text Export (e.g. to MS WordPad)
  • Content:
    • Offer text format
    • Include field titles
    • Include field names
  • Text Format
    • Export fields separated by tabs
    • Export fields separated by commas
    • Export as XML
HTML Export (e.g. MS Excel)
  • Offer HTML format
  • Include field titles
  • Include field names
  • Color of table header

Browser Drag and Drop

  • Use drag
  • Use drop
  • Enable horizontal auto-scroll
  • Automatically expand nodes

Drag and Drop function in Lists

The order of columns in a list can be changed by moving a column to the desired position using the drag&drop function. Also, it is possible to hide columns if they are not needed for the current session. Highlight a column and select the "Hide This Column" order from the context menu. In order to restore hidden columns, select the "Show All Hidden Columns" order from the context menu.

 

Miscellaneous

 

Additional settings can be done here, e.g.:

Setting Description
Encoding Here the encoding can be selected, dependent on what language (and character) is used when inserting data in masks.
Language Here the language for field names in masks can be selected.
Shutdown when session is closed
  • Activated: Shuts down the session (via the exit button ) and displays a message to confirm shutdown.

    After confirming with Yes, the client is closed completely.
  • - Deactivated: Shuts down the session (via the exit button ) and displays a message to confirm shutdown.

    After confirming with Yes, the client is not closed completely. With the button, the login window is opened again.
External Text Editor An external text editor can be defined to be used.
URL support
  • Agile e6 Java Client is already started and checkbox Reuse client automatically is not selected:
    When clicking on an Agile e6 URL link, an additional Agile e6 Java Client will be started.
  • Agile e6 Java Client is already started and checkbox Reuse client automatically is selected:
    When clicking on an Agile e6 URL link, no additional Agile e6 Java Client will be started.
 

Logging

 

Here can be defined for which profile the logging should be performed and how detailed the log information should be.

Section Description
Info Information about runtime events, e.g. startup and shutdown. The result can be visible immediately.
Trace Very detailed information on the flow through the system. The result will be written in a log file.
Debug Detailed information on the flow through the system. The result will be written in a log file.
Show log

Displays a log window in the client.

If a large amount of traces are written into this window, the client will become slow or even suffer an "OutOfMemory" exception. If all traces are turned on, we recommend using the log file mechanism.

Always log exceptions

Always loggs exceptions caught by the code. Error messages are displayed with more detailed information.

We recomment to only use this option for debugging purposes.

Display milliseconds Displays the milliseconds in the log time stamp.
Load profile ...
Profile Description
ECI

Logging of the ECI module.

Shows the communication between the Java client and the Agile e6 server, as well as the local client communication with the CAD integration.

GRID

For administrators performing customizations.

Helps to analyze UI customization problems. Keyboard shortcuts will activate a grid with UI information on top of masks.

  • CTRL-F11
    Turns the grid on or off.
    When clicking on a mask component, further information is displayed.
  • CTRL-F12
    Clears the grid content.
JET

Logging of the JET module.

Reads the server data and writes back modified data.

MASK Logging of the mask layer, which is the UI component of the Java client.
STANDARD Removes all class specific log settings.

 

 

Log4j
Enables or disables logging with Log4J.

  • Priority
    A minimum priority can be set for messages to be logged.
  • Log messages in the console window
  • Log messages in a file
    A path can be defined where the log file is stored.
    The amount of backups of the log file can be defined.
    The maximum file size and its suffix can be defined.

 

 

Plugins

 

Contains a list of all plugins that are found in the configuration file jacc.defaults of the Java Client. This list shows the unique ID of each plugin, the name, the version, and a flag that controls the loading of the plugin.

Section Setting Description
AutoVue Integration   For detailed information, please refer to the AutoVue Integration Online Help.
ECI Server   Configuration of the ECI server that runs within the Java Client. It is used by e.g. CAD integrations to access the Agile e6 system.
  Port number Default port number
  Remote connection requires password
  • Activated:
    Accepts connections from the same machine as authenticated, without requiring the ECI client to pass user credentials.
    ECI connections from a remote machine still require authentication to execute ECI functions.
  • Deactivated:
    Allows unauthenticated remote connections.
    However, remote connections are disabled by default by the machine's white list in the jacc.defaults file (see EciServer.allowHosts.%).

Remote connections are rejected if the remote machine is not white listed in this configuration file.

  Start ECI Server immediately Activates the ECI Server.
HTML Browser  

Configuration of the internal and external web browser integration.