Cloud Software Group, Inc. EBX®
Documentation > Administration Guide > EBX® Metadata Management application > Metadata Agent
Navigation modeDocumentation > Administration Guide > EBX® Metadata Management application > Metadata Agent

TIBCO® EBX® Metadata Adapter installation

Overview

Use this adapter to connect the TIBCO Metadata Agent to one or more EBX® instances to source data for the EBX® Metadata Management application using the harvesting feature.

Note

The Metadata Agent feature requires EBX® version 6.2.0.

EBX® Connection rights

You must authorize the agent to connect to an EBX® instance. Configure its connection as a user on the target EBX® instance and give the agent appropriate permissions.

See EBX® Metadata Management application Connection Encryption for more details.

Properties template

The following shows a sample template:

###################################################
###################################################
#####                                         #####
#####               EBX adapter               #####
#####                                         #####
###################################################
###################################################
# General properties for Tibco EBX adapter
# Do not modify
ebx.label=EBX Adapter
ebx.description=Metadata agent adapter for EBX
ebx.version=1.0.0
ebx.name=EBX Adapter
ebx.provider=Tibco
ebx.minVersion=6.2.0
ebx.defaultLocale=en-US
#This file holds properties for all the Tibco EBX instances to connect to.
#Properties below must follow the pattern ebx.<property>.<instance name>=<property value>
#Below is the configuration pattern
#ebx.base-url.<instance name>=
#ebx.path.<instance name>=
#ebx.username.<instance name>=
#ebx.password.<instance name>=admin
#ebx.public-key.<instance name>=key
#ebx.useEncryption.<instance name>=true
#Format ebx instance name as alphanumeric name all in lower case bellow.
ebx.instances=localhost
ebx.base-url.localhost=http://localhost:8080
ebx.username.localhost=admin
ebx.password.localhost=admin
ebx.locale.localhost=fr-FR
#ebx.public-key.localhost=key
#ebx.useEncryption.localhost=true

Properties configuration

Prior to launching the TIBCO® Metadata Agent with the TIBCO EBX® Metadata Adapter, check the connection with EBX® by updating the information in the properties file.

Attention

It is strongly discouraged to modify properties that are not described in the table below, but are present in the properties file.

Property

Description

ebx.instances

List of comma-seperated instances the agent will connect to. ebx.instances=instanceId1,instanceId2

ebx.base-url.instanceId

Base URL of the EBX® instance.

ebx.username.instanceId

User name the agent will connect as on the target EBX® instance.

ebx.password.instanceId

User password the agent will connect as on the target EBX® instance.

ebx.locale.instanceId

Optional. Locale used to harvest localised information in EBX® instance. Example: ebx.locale.instanceId1=fr-FR

ebx.public-key.instanceId

Optional. If the encryption is used for connection, fill the public key

ebx.useEncryption.instanceId

Optional. Activate the encrypted password connection ebx.useEncryption.instanceId1=true

After configuring the above properties, you can launch the agent as a Java application using the command line or any other suitable tool (see below on this page).

Upon each launch the adapter tests the TIBCO EBX® REST connection. If the adapter start up succeeds, you can view it in the EBX® Metadata Management application's Metadata Administration perspective for the corresponding agent as described TIBCO® Metadata Agents.

Troubleshooting

Error message

Cause and resolution

Failed to initialize EBX® datasource: Invalid login attempt.

This error appears when the Agent cannot connect to the EBX® instance because the login or password are not correct. Check the information you set up in properties ebx.instance.username and ebx.instance.password.

Failed to initialize EBX® datasource: Version Not Supported

This kind of issue is caused by attempting to connect to an incompatible version of EBX®. This adapter is only compatible with EBX® 6.2.0 and up.

Failed to connect to EBX® datasource

This can be caused for multiple reasons, but it's most likely an error in the ebx.instance.url property, or a routing issue.

Documentation > Administration Guide > EBX® Metadata Management application > Metadata Agent