Manage components

The Components list is the first panel that is displayed when you log in to the Administration. This panel is composed of a grid that displays the registered components information.

You can:

Display component information

  1. In the Components list, click the corresponding Name cell of a component.
    The component data information is displayed:
  2. Properties:

    Property Component Description
    Name All Component name (not editable)
    Type All Component type (not editable)
    Application All Application name to be selected in the registered application names (not editable).
    If you change the name of the application, a dialog pops up and you are prompted to clean the component configuration.
    Links

    Designer

    Datastore Client

    Report Server

    A list of checkboxes is displayed with compatible applications from which you can select several applications.
    Component URL All The URL address where the component can be accessed
    Automatic update

    Designer

    A flag used to indicate a component to check for configuration modifications and update the configuration at startup
    User ID All User ID used for authorization in event processor operations
    User Domain All User Domain used for authorization in event processor operations
    PassPort All

    Security management:

    • Y: security is handled using Passport
    • N: security is handled using the default component security
    CAS SSO All Enable/disable the New SSO Mode
    SSO Port All but Datastore SSO port
    SSO URL All but Datastore SSO URL
    MAIN/User Datastore Only the MAIN database should be mandatory. When CACHE and VIEW are not provided, the MAIN values should be used.
    MAIN/Password Datastore Encrypted text
    MAIN/URL Datastore  
    MAIN/Driver Datastore List of possible drivers. A default list is provided in a combo. The user can key in a new one.
    CACHE/User Datastore  
    CACHE/Password Datastore  
    CACHE/URL Datastore  
    CACHE/Driver Datastore  
    VIEW/User Datastore  
    VIEW/Password Datastore  
    VIEW/URL Datastore  
    VIEW/Driver Datastore  
    Work manager Datastore  
  3. You can now:
    • Go back to the Components list.
    • Edit this component.
    • Update the configuration
    • Clean the configuration
    • Unregister this component.

Sentinel Monitoring

In this section you can customize the configuration of Sentinel Connector. Sentinel Connector is used by the component to send events to a Sentinel instance.

Sentinel Connector can be defined only for the component types:

  • Designer
  • Datastore Runtime
Property Description
Sentinel Specify if sentinel monitoring is enabled/disabled.
Instance

The name of selected external Sentinel component used for monitoring. All events will be send to this component if monitoring is enabled.

The list of possible values is the list of Sentinel external components as they are defined in Manage external components

Monitor collection management

Enable/disable the monitoring for operations on collections.

Defined only for Datastore Runtime.

Monitor partition management

Enable/disable the monitoring for operations on partitions.

Defined only for Datastore Runtime.

Monitor extraction process

Enable/disable the monitoring for extractions.

Defined only for Datastore Runtime.

Database setting

In this section, you can customize the database connection parameters by specifying the values for the following parameters:

Property Description
JNDI Name JNDI name of the Datasource resource that the Web Administrator created on the Web server
User Database user name
Password Database user password that must be encrypted
URL JDBC location
Driver The database driver type

Dynamic Properties

In this section, you can set values for dynamic properties. The types of properties which can be modified in this section are defined for each component at installation time or when applying a patch. They are either custom properties of each component or properties that override the general settings defined in Administration > Settings.

If a property is defined in both the General Settings page and the Dynamic Properties section, at runtime the value used is the one defined in the Dynamic Properties section.

Each time a value of a dynamic property is modified the component is notified and the new value is used.

Profile Properties

The Profile Properties sections are defined only for Datastore Runtime and Rule Server. They allow to configure multiple profiles for a component that supports profiles. The type of properties which can be modified in this section are defined for each component at installation time or when applying a patch. The properties that can be updated in a profile are dynamic properties or component properties that can be overridden at profile level.

At runtime, the value defined in a profile has precedence over dynamic settings and general settings.

Each time a value of a profile property is modified the component is notified and the new value is used.

Property type attributes

The value of a dynamic property or a profile property is restricted according with the definition of the property type.

A property type has the following attributes:

Property Required Description
Name Yes The name of the property
Type Yes

The type of the value. Can have the values:

  • BOOLEAN
  • STRING
  • INTEGER
  • LONG
  • DECIMAL (2 decimals)
  • DATE (yyyy-MM-dd format)
  • DATETIME (yyyy-MM-dd HH:mm:ss format)
  • PASSWORD
Definition level Yes

Define the level where a property can be defined and may have the values which can be combined:

  • DYNAMIC - property updatable in Dynamic Properties section
  • PROFILE - property updatable in Profile Properties sections
Min value No Acts like a min value restriction
Max value No Acts like a max value restriction
Default value No A default value which is proposed when editing the value in user interface
Field size No The maximum number of characters for value

Edit component information

The component is locked as soon as it is displayed. If another user tries to edit the same Component then:

  • The read-only panel is displayed.
  • An information message is displayed at the top of the panel: "The component {ComponentName} is currently being edited by another user".

  1. Select a component in the list and click Edit.
  2. The selected component data information is displayed.
  3. Properties:

    Property Component Description
    Name All Component name (not editable)
    Type All Component type (not editable)
    Application All Application name to be selected in the registered application names (not editable).
    If you change the name of the application, a dialog pops up and you are prompted to clean the component configuration.
    Links

    Designer

    Datastore Client

    Report Server

    A list of checkboxes is displayed with compatible applications from which you can select several applications.
    Component URL All The URL address where the component can be accessed
    Automatic update

    Designer

    A flag used to indicate a component to check for configuration modifications and update the configuration at startup
    User ID All User ID used for authorization in event processor operations
    User Domain All User Domain used for authorization in event processor operations
    PassPort All

    Security management:

    • Y: security is handled using Passport
    • N: security is handled using the default component security
    CAS SSO All Enable/disable the New SSO Mode
    SSO Port All but Datastore SSO port
    SSO URL All but Datastore SSO URL
    MAIN/User Datastore Only the MAIN database should be mandatory. When CACHE and VIEW are not provided, the MAIN values should be used.
    MAIN/Password Datastore Encrypted text
    MAIN/URL Datastore  
    MAIN/Driver Datastore List of possible drivers. A default list is provided in a combo. The user can key in a new one.
    CACHE/User Datastore  
    CACHE/Password Datastore  
    CACHE/URL Datastore  
    CACHE/Driver Datastore  
    VIEW/User Datastore  
    VIEW/Password Datastore  
    VIEW/URL Datastore  
    VIEW/Driver Datastore  
    Work manager Datastore  
  4. Modify component information as necessary.
  5. Save your updates.
    The details component page is displayed
  6. Repeat steps 2 – 3 as many times as necessary.
  7. Click Components to be redirected to the Components list.
  8. Properties:

    Property Component Description
    Name All Component name (not editable)
    Type All Component type (not editable)
    Application All Application name to be selected in the registered application names (not editable).
    If you change the name of the application, a dialog pops up and you are prompted to clean the component configuration.
    Links

    Designer

    Datastore Client

    Report Server

    A list of checkboxes is displayed with compatible applications from which you can select several applications.
    Component URL All The URL address where the component can be accessed
    Automatic update

    Designer

    A flag used to indicate a component to check for configuration modifications and update the configuration at startup
    User ID All User ID used for authorization in event processor operations
    User Domain All User Domain used for authorization in event processor operations
    PassPort All

    Security management:

    • Y: security is handled using Passport
    • N: security is handled using the default component security
    CAS SSO All Enable/disable the New SSO Mode
    SSO Port All but Datastore SSO port
    SSO URL All but Datastore SSO URL
    MAIN/User Datastore Only the MAIN database should be mandatory. When CACHE and VIEW are not provided, the MAIN values should be used.
    MAIN/Password Datastore Encrypted text
    MAIN/URL Datastore  
    MAIN/Driver Datastore List of possible drivers. A default list is provided in a combo. The user can key in a new one.
    CACHE/User Datastore  
    CACHE/Password Datastore  
    CACHE/URL Datastore  
    CACHE/Driver Datastore  
    VIEW/User Datastore  
    VIEW/Password Datastore  
    VIEW/URL Datastore  
    VIEW/Driver Datastore  
    Work manager Datastore  

Clean the configuration

  1. Select a component in the Components list and click Clean configuration.
  2. Confirm your action.
    A notification is displayed with the status of configuration cleaning.
  3. You are then redirected to the Components list.

Update the configuration

  1. Select a component in the Components list and click Update configuration.
  2. A notification is displayed with the status of configuration update.

Unregister a component

The component is locked as soon as it is displayed. If another user tries to edit the same component, the information is displayed in the read-only panel with an information message.

  1. Select one or more components in the list and click Unregister.
  2. Confirm your action.
  3. You are then redirected to the Components list.
Caution   The Unregister action will delete from the repository all the registration data for the selected component. You can use the exportComponent or the exportRegistry commands to backup your registry before running Unregister in Administration.

Related Links