![]() |
Copyright © TIBCO Software Inc. All Rights Reserved |
Before creating the TIBCO Generic Adapter component, you must first create a TIBCO Administrator component. It creates a TIBCO domain, and starts TIBCO Hawk® services and a TIBCO Administrator server. Refer to TIBCO Silver Fabric Enabler for TIBCO Administrator - Enterprise Edition User’s Guide for creating and configuring a TIBCO Administrator component.
1. In TIBCO Silver Fabric Administrator GUI, select Stacks > Components.
2. In the Components page, select Create New TIBCO Generic Adapter Component from the Global Actions drop-down list.
3. Enter a Distribution Name for your distribution.
4. In Distribution Minimum, enter the minimum version of the distribution for the Silver Fabric to resolve all of the available distributions.
5. In Distribution Maximum, enter the maximum version of the distribution for the Silver Fabric to resolve all of the available distributions.
6. Check the Enable product registration option for the custom software to register itself as custom software on the TIBCO Administrator. It validates product registration.Figure 2 Configure General PropertiesYou can select the versions of the distributions for TIBCO Generic Adapter to run, as shown in Figure 3.
Figure 3 Software Version
2. Choose Optional Distribution(s) - If your TIBCO Administrator implementation makes use of TIBCO Enterprise Messaging Service, you must upload the latest TIBCO EMS distribution to the TIBCO Silver Fabric Broker.
Figure 4 Choose Optional DistributionsTask C Set the Basic ConfigurationSpecify a JDBC driver to publish with the TIBCO® Generic Adapter Distribution for TIBCO Silver® Fabric so that it can communicate with the TIBCO Administrator domain database. When the TIBCO Administrator uses a database as the domain storage, you must upload a JDBC driver so the component can interact with it.
The Adapter component is dependent on TIBCO Administrator. Refer to Dependency Requirements for setting that dependency.TIBCO Domain Machine Name - To activate use of the TIBCO domain Logical Machine Name, enter a value that is unique in the TIBCO domain machine name field. The machine name is a virtual name and must be unique. You can use alphanumeric characters, hyphen (-), or underscore (_) characters. Other special characters, including period or comma, are not allowed. The name length must be less than 64 characters.When the component is instantiated multiple times, the TLM machine name gets the name: <Your_TLM_Name>_<ComponentInstanceNumber> , where the <ComponentInstanceNumber> is just a sequential incrementing integer.If <ComponentInstanceNumber>=0, the TLM machine name is <Your_TLM_Name>. when <ComponentInstanceNumber>>0, the TLM machine name is <Your_TLM_Name>_<ComponentInstanceNumber>.
− The shared drive must be READ/WRITE accessible to all engine daemons running as TIBCO Logical Machines in a TIBCO Silver Cloud. The degree to which you can guarantee reliability and availability of that shared drive helps to ensure runtime continuity.
If you want to force redeployment (synchronization with the domain) once, add a file call “ForceRedeploy.txt” in the domainDataHome (<domainDataDir>/<DomainName>/<TLMNAME>/<DomainName>. It redeploys all applications (no FAST TLM) at startup and then deletes the file (it is a one time action).Sets the desired services state when the TIBCO Logical Machine is restarted. When the TLM is restarted, the Adapter service instances is republished and appears as either started or stopped. The stopped services state setting may be convenient for developers who are testing machines with many services that do not need to be started for every logical machine change.Add external JAR file(s) to the Adapter Component - As an option, JAR files may be uploaded for publishing with the TIBCO Generic Adapter component.The check box "Add the JAR file(s) in front of the Generic Adapter ClassPath (check), otherwise at the end of the ClassPath (unchecked)" means just what it says. The JAR file name may be prepended in front of the ClassPath by selecting the box and if it is left clear the JAR file name is appended at the end of the ClassPath.
To remove unwanted JAR files use the Menu button to display the list of Wizard configuration steps and select Add/Override/Customize Enabler and Component-specific content files. Relative paths to external jar files added may be removed from that window.Task D Load External JAR FilesThe check box "Add the JAR file(s) in front of the Generic Adapter ClassPath (check), otherwise at the end of the ClassPath (unchecked)" means just what it says. The JAR file name may be prepended in front of the ClassPath by selecting the box and if it is left clear the JAR file name is appended at the end of the ClassPath.
To remove unwanted JAR files use the Menu button to display the list of Wizard configuration steps and select Add/Override/Customize Enabler and Component-specific content files. Relative paths to external jar files added may be removed from that window.Task E Upload a Adapter ProjectIf you want TIBCO Silver Fabric Enabler for Generic Adapter to publish and run one or more Adapter projects, you must upload one or more EAR files (or compressed files). EAR and .zip files are briefly described in the note following Step 2: TIBCO Designer EAR and ZIP files. Enable the Generic Adapter project as follows:
1. Click the Add button in the Upload, Remove, or Recorder Archive Files panel.Figure 7 Uploading an EAR or ZIP Archive File
2. Click the Browse button and navigate to the EAR, .zip, or J2EE WAR file.
•
a. In TIBCO_HOME/tra/tra_version/bin, run the following command:
c. For details about the creation of the DeploymentConfig.xml file, refer to the TIBCO Runtime Agent documentation, Scripting Deployment User’s Guide..
A CustomFolder.properties file put in the zip archive can specify the deployment path. For example, create the CustomFolder.properties file with content "ApplicationFullPath=aaa/bbb/ccc".In previous releases of this Enabler, when the deployment path was not specified, the deployed project EAR and application files could be found in the TIBCO Administrator directory shown as follows:
Silver Fabric/<ComponentName>/<TLM_Name>/<AppName>Figure 8 TIBCO Hawk AMI ConfigurationAMI Hawk Service: specifies the TIBCO Hawk port number, for example, TIBCO Rendezvous connects with TIBCO Hawk on the default port 7474. AMI Hawk Service and AMI Hawk Daemon must be set with valid values together. Setting only one of them results in an error.AMI Hawk Daemon: specifies the location of the TIBCO Hawk Daemon. A value of "tcp:yyyy" corresponds to a local Hawk Daemon, where "yyyy" is the port number. A Hawk Daemon located elsewhere is specified by a value of the protocol, IP address, and port number: "tcp:xxx.xxx.xxx.xxx:yyyy".
The actual AMI Hawk Service port for the runtime component instance is incremented by an integer according to the engine instance ID. For example, if you set the AMI Hawk Service to 6464 and the component is instantiated to run on engine instance 1, the service is reported in the hawkagent.cfg file as 6465. Then when the component is scaled up to other engine instances the AMI Hawk Service value is incremented higher by the Enabler automatically.Figure 10 Upload Hawk MicroAgent PluginTask I Register TLM PropertiesFigure 11 Adding TLM PropertiesFigure 12 Setting TLM Properties
Add Runtime Context Variables:String, Environment, System, or Encrypted variables may be added to the component to define and set runtime-specific context variables.Select a variable type from the Add Variable pull-down list or Add from Enabler to use a variable from a selected Enabler.Figure 13 Adding a Runtime Context VariableAfter you have added any runtime context variable, select the variable (selected row is highlighted) and Edit to change its attributes. Selected rows may also be removed.Variable values from the Enabler may be added to the run time as well. Use the Add from Enabler button to add Enabler-specific context variables.Select a variable type from the Add Variable selector if you wish to edit a variable.Figure 14 Editing a VariableYou can add a string variable to change pre-existing context variables such as: ARCHIVE_DETECTION_FREQUENCY.Figure 15 Edit a String VariableARCHIVE_DETECTION_FREQUENCY is the periodic interval (the default value is 30 seconds) for detection of deployed archives and report to the broker. The broker uses this data to synchronize the archive with scaling rules.Variable values from the Enabler may be changed as well. Use the Add from Enabler button to change values of Enabler-specific context variables.
• Upload: Upload new file.
• Add from Enabler: Copy a content file from the Enabler to the component.
• Customize: Modify the content file.
• Remove: Delete the file.Figure 16 Uploading Content FilesYou can edit or change the log pattern as needed. You can only add and configure the TRA based logs.
• Click Add to add the log file pattern.
• Click Add Default to add the default file pattern.Figure 17 Adding or Removing Log File patternsFigure 18 Adding a Log File patternTask M Add Allocation Rule SettingsTask N Generic SettingsAlmost all of the other screens are generic for TIBCO Silver® Fabric Enablers. Refer to TIBCO Silver® Fabric User’s Guide for more information on these configuration screens.Click Finish to save your changes and then you can deploy the Application component as part of an Application stack.To do this, select Deploy Application Component in the Actions list located at the line of the Application component you just created.For more information, refer to "The configure.xml File" section in TIBCO Silver® Fabric Developer’s Guide.Figure 19 Edit the Configuration File Page
As an example, if a user wants to replace the property tibco.env.CUSTOM_PATH, tibco.env.CUSTOM_LIB_PATH and tibco.env.ODBCINI in ${TIBCO_HOME}/adapter/adadb/6.3/bin, the XML example code as described follows, accomplishes this when used in the Edit configuration file text field.<configFiles baseDir="${TIBCO_HOME}/adapter/adadb/6.3/bin" include="adbagent.tra"><configFiles baseDir="${TIBCO_HOME}/adapter/adadb/6.3/bin" include="adbagent.tra"><configFiles baseDir="${TIBCO_HOME}/adapter/adadb/6.3/bin" include="adbagent.tra">The property, baseDir, in the <configFiles> element specifies the path that includes the file to be updated. You can modify it if required. For example, if the TIBCO ActiveMatrix Adapter for Database (ADADB) version is 6.3 instead of 6.2, the baseDir value is:
${TIBCO_HOME}/adapter/adadb/6.3/binThe property, include, in <configFiles> element specifies which files are to be replaced. It can specify the files you want to change. The asterisk wild card can be used to represent a string of characters, for instance: "*.tra" to change all of the .tra files in %baseDir%.The property, pattern, in the <regex> element specifies the contents that are to be replaced within the previously specified files. The value of pattern can be a regular expression.The property, replacement, in <regex> element specifies the new contents of the node specified by the pattern property value.Where xxxx is the path in your implementation environment.Refer to TIBCO Silver Fabric User’s Guide for additional information on these configurations.After you click the Finish button, make sure that the component is published to make it available to create an application.To do this, select Publish Component in the Actions drop-down list located at the left-hand side of the component you just created.
![]() |
Copyright © TIBCO Software Inc. All Rights Reserved |