Icon

The profiles can be configured only in Offline mode. The FioranoMQ server should not be running while editing a profile.

How to Launch Profile Manager

  1. Launch Fiorano Studio using any one of the following ways:
    1. Navigate through Start > Programs > Fiorano > FioranoMQ and click Fiorano Studio.
    2. Execute the following command based on the operating system:
      1. Windows: %FIORANO_HOME%\Studio\bin\studio.exe
      2. UNIX: $FIORANO_HOME/Studio/bin/studio.sh
  2. Select the Profile Manager tab in the Explorer pane.



  3. You can also launch the Profile Manager using Window > Profile Manager menu-item in the Fiorano Studio.


How to Open a Profile for Editing

  1. Right-click the Profiles node in the Profile Manager Explorer, and select the Open Profile option from the pop-up menu displayed.



  2. In the Select Profile Directory dialog, select the Profile directory you want to edit and click the Open button.



  3. A profile appears and you can see a node corresponding to the profile in the Profile Explorer tree as shown in the figure below. You can expand this node in order to view the component instances that are part of the profile. Their properties can be viewed in the Properties pane on the right.



  4. You can also open a profile by selecting the option Tools > Configure Profile in the Fiorano Studio Menu.

How to Edit Configuration for a Component Instance

In order to configure the port at which the FioranoMQ Server would run:

  1. Right-click the Profiles node in the Profile ManagerExplorer, and select the Open Profile option from the pop-up menu displayed.
  2. In the Select Profile Directory dialog, select the Profile directory you want to edit and click the Open button.
  3. Navigate to the node corresponding to the ConnectionManager component instance in the Profile Manager Explorer.



  4. Edit the Port property of the ConnectionManager, which is part of ComponentInstance Configuration using the Properties pane on the right.



  5. Right-click the Connection Manager node and select the Save option to save the changes.

How to Edit Attributes for Component Instance

In order to edit the LoggerName attribute for PublishEventManager, which is part of the FioranoMQ Profile, follow the instructions given below:

  1. Right-click the Profiles node in the Profile ManagerExplorer, and select the Open Profile option from the pop-up menu displayed.
  2. In the Select Profile Directory dialog, select the Profile directory you want to edit and click the Open button.
  3. Navigate to the node corresponding to the PublishEventManager component instance in the Profile Manager Explorer.



  4. Edit the LoggerName property for the PublishEventManager, which is part of ComponentInstance Attributes, using the Properties pane on the right.



  5. Save the changes by right-clicking on the profile root node (FioranoMQ), and selecting the Save option.

How to Add/Remove a Component Instance from the Profile

In order to enable Dispatcher in your FioranoMQ Server, you must add the dispatcher component to the profile as follows:

  1. Open the FioranoMQ profile using the Profile Manager, as described in Point 2 above.
  2. Navigate to the domain node to which you wish to add the Dispatcher Component. Right-click the selected domain (say "etc") and select the Add Components option.
  3. In the Add Components to Profile dialog that pops up, navigate to the Dispatcher component, select it and Click the OK button.

    Icon
    • The red icon in front of the Dispatcher node indicates that the component has some unresolved dependencies. To know how to resolve the component dependencies, please read on.
    • Dispatcher requires an instance of JobManager that no other component in the profile should be allowed to use (exclusive dependency). So, on adding dispatcher, a JobManager domain is added to the profile. Within this, a JobManager instance that is exclusively used by the Dispatcher instance is added.
  4. You can see the node corresponding to the Dispatcher component added to the Profile Manager Explorer.

  5. To remove the Dispatcher instance added to the profile, right-click the Dispatcher node in the Profile Manager Explorer and select the Delete option.

Icon
On deleting the Dispatcher, the exclusive instance of JobManager which was added is also removed.

How to Resolve Component Dependencies

In order to resolve the dependencies for the Dispatcher component:

  1. Expand the Dispatcher node corresponding to the Dispatcher instance added to the profile and navigate to the dependency node that is unresolved (indicated by the red icon). In this case, the TimerService is the dependency.



  2. Select the Instance property for the TimerService dependency in the Properties pane. From the drop-down menu, select the available instances of TimerService in the profile to be used by the Dispatcher instance.

Icon
Once the dependency is resolved the red icon disappears, indicating that the Dispatcher has been configured properly.

In case no instance of the dependency existed in the profile, you can add a new instance of the component as described above and then resolve the dependency. You may also add a new instance of the dependency as follows:

  1. Right-click the dependency node and select the Add New Instance option. The Select New Component Instance Domain dialog box appears.



  2. You may use this to specify the domain to which you want to add the new instance of the TimerService. In this case, we select domain etc and click the OK button.



  3. You can view the new instance of TimerService added to the Profile.
  4. You can now resolve the TimerService dependency for Dispatcher by selecting the Instance property for the TimerService dependency in the Properties pane. From the drop-down menu, select the available instances of TimerService in the profile to be used by the Dispatcher instance.

How to Change Implementation Type of a Component Instance

Some components provide multiple implementations, such as the NamingManager component. To change the implementation type of the component part of the profile, follow the instructions given below:

  1. In the Profile Explorer, navigate to the node corresponding to the component instance for which you wish to change the implementation type: for instance the NativeFileNamingManager instance of NamingManager in the FioranoMQ profile. In the Properties pane, you see a property named Implementation that is set to FILE.



  2. Click the value for the Implementation property. All available implementations of NamingManager are displayed in a drop-down list. Select the implementation you want to use in your profile: for instance RDBMS.



  3. On changing the Implementation, the component dependencies and also the ObjectName property for the component are updated accordingly.



  4. Resolve all dependencies and save the profile.

How to Locate Component Dependency

  1. Right-click a node corresponding to a component dependency and select the Locate in Tree option. For example, let us assume you perform this action on the node corresponding to TimerService dependency for Dispatcher instance.



  2. This action will select the component instance corresponding to the dependency in the Profile Manager Explorer. For instance, in this case, the selection would change to the TimerService instance that is specified as a dependency for the Dispatcher instance.

How to Find Usages for a Component Instance

  1. Right-click the node corresponding to the component instance for which to find usages and select the Find Usages option.



  2. On performing this action, a dialog box pops up displaying all component instances that use this particular instance in the profile. The instance usages of TimerService appear as shown in the figure below.

How to Save Changes Made to a Profile

  1. Right-click on the profile root node (FioranoMQ), and selecting the Save option.

Icon

On saving a profile, you may see error/warning messages for two reasons: if a component has an unresolved dependency, Or if the value is not set for a non-null configuration parameter. You can either continue to save the profile ignoring these error/warning messages or fix the error and try saving again.

How to Validate a Profile

  1. Right-click the profile root node (FioranoMQ), and select the Validate option.



  2. You can see the validation errors/warnings, if any, in the Validate Profile Results tab of the Studio Output window.

How to Save the Profile in a Different Location

  1. Right-click the profile root node (FioranoMQ), and select the Save As option.



  2. The Select Profile Directory dialog box appears, you need to specify the location in which to save the profile. Click the Save button.



  3. In case a profile already exists in the specified location, a confirmation Confirm Profile Replace dialog box appears. If the user selects the Yes option, the existing profile is replaced, and if No is selected, no further action is performed.



  4. After the profile is saved to the specified location, a dialog box (Load Profile) appears wherein the user is asked if he wishes to load the new profile created. In case the user selects Yes, the new profile is opened, and if No is selected no further action is performed.

How to Close a Profile

Right-click the profile root node (FioranoMQ), and select the Close option. This will remove the sub-tree corresponding to the profile, from the Profile Explorer.

 

How to Add/Remove New Attributes to a Component Instance

  1. In the Profile Explorer, navigate to the node corresponding to the component instance to which you want to add an attribute. Right-click the node and select the Add Attribute option.



  2. In the Add Attribute dialog box that appears, specify the Name and Value for the attribute to be added, and Click the OK button. 
  3. You can see the new attribute added to the ComponentInstance Configuration parameters in the Properties window on the right.



  4. To remove an added attribute, right-Click the component instance node and select the Remove Attributes option.



  5. In the Remove Attributes dialog box, select the attribute(s) to be removed and Click the OK button. The removed attribute(s) are removed from the ComponentInstance Configuration properties in the Properties window.



  6. After adding/removing attributes to any component instance, save the profile as described earlier.

How to Rename a Component Instance

  1. In the Profile Explorer, navigate to the node corresponding to the component instance to be renamed. Right-click the node and select the Rename option.



  2. In the Rename dialog box, specify the new name for the component instance and click the OK button.



  3. You will see the node corresponding to the component instance, and also the ObjectName property for the instance, updated with the new name.



  4. You can also rename a component instance by selecting the corresponding node and pressing the F2 key. The node name becomes editable and you can specify the new name for the instance.



  5. After renaming the component instance, save the profile as described earlier.

How to Edit Default Configurations for a Component

  1. In the Profile explorer, navigate to the node corresponding to the component for which you wish to edit the default configurations (for instance FMQConfigLoader component in FioranoMQ profile).
  2. Right-click the component node and select Edit Default Configuration option.



  3. In the Edit Default Configuration dialog box that appears, edit the properties and click the OK button.



  4. Save the profile as described earlier.

How to Add/Remove a Domain from the Profile

  1. Right-click the root profile node or the domain node within which you wish to add the new domain and select the Add Domain option.



  2. In the Add Domain dialog box, specify the name of the domain to be added.



  3. You can see a node corresponding to the new domain in the Profile Explorer.

How to Rename a Domain

  1. In the Profile Explorer, navigate to the node corresponding to the domain to be renamed. Right-click the node and select the Rename option.



  2. In the Rename dialog box that appears, specify the new name for the domain and CLICK the OK button.



  3. You will see the node corresponding to the domain updated with the new name.



  4. You can also rename a domain by selecting the corresponding node and pressing the F2 key. The node name becomes editable and you can specify the new name for the instance.



  5. After renaming the domain, save the profile as described earlier. 

How to Edit the Profile Metadata

  1. In the Profile Explorer, select the profile root node. You can view the profile metadata in the Properties pane on the right.



  2. You can edit the Profile Metadata (including ProfileName, Description, and Author) in the Properties pane.
  3. After editing the profile metadata, save the profile as described earlier.

How to Edit the Deployment File (deploy.xml) for a Profile

  1. In the Profile Explorer, select the profile root node. You can view the contents of the deployment file (Deploy.xml) in the Deployment Lists property in the Properties pane on the right.



  2. Click the Ellipsis button beside the Deployment Lists property value. In the editor window that appears you may perform the following operations:

    1. Add Deployment List

      1. Click the Add button in the Deployment Lists editor window.



      2. In the Add dialog box that appears, select the deployment lists to be added to Deploy.xml and Click the OK button.



      3. You can see the list added in the Deployment Lists editor window.



    2. Remove Deployment List
      1. Select the Deployment list file to be removed from Deploy.xml and Click the Remove button.



    3. Move Up Deployment List
      1. You can change the ordering of lists in Deploy.xml. To shift a list upwards, select a list in the Deployment Lists editor window and Click the Move Up button.



    4. Move Down Deployment List
      1. Select a list in the Deployment Lists editor window and Click the Move Down button.

         

How to Export/Import a Profile

  1.  Right-click the profile root node and select the Export Profile option.



  2. In the Select Profile Directory dialog box that appears, select the directory in which to create the profile export file and Click the Save button.



  3. To import a profile, right-Click the Profiles node in the Profile Explorer and select the Import Profile option.



  4. In the dialog box that appears, select the profile export file and Click the Open button.



  5. Another dialog box appears asking the user to select the target Profiles directory in which to import the selected profile. Specify the directory and Click the Open button.

  6. A confirmation dialog box appears asking if the user wishes to load the imported profile. On selecting the Yes option, the imported profile is loaded, and on selecting No, no further action is performed.

     

How to Delete a Profile

  1. Right-click the Profile root node to be deleted and select the Delete option.

How to Switch Between Domain and Component Views

The default view displayed is the Domain view, in which the tree is formed based on ObjectNames of components that are part of the profile.

  1. Right-click the Profile root node and select the Component View option to view the profile tree created based on component category and service type.



  2. The component view is displayed as shown in the image below.



  3. To switch back to Domain view, right-Click the profile root node and select the Domain View option. 

How to Mark a Socket Acceptor as Default

Icon

By default, all the Connection Managers property is set to Yes. You can change the property according to your requirement.

To mark a Socket Acceptor as a default, perform the following steps:

  1. Select FioranoMQ > Fiorano > socketAcceptors > port2 > ConnectionManager .
  2. In the Properties of ConnectionManager2 pane, select the Default property as yes or no from the drop-down menu.

    Icon

    If more than one socket acceptors are present, then user should mark only one as a default. If none is marked as default, the factories will be created through randomly selected SocketAcceptor.

How to Set Auto Update Property of All Default Connection Factories

To set AutoUpdate property for all default Connection Factories, perform the following steps:

  1. Open the Fiorano Studio, in the Server Explorer pane, right-click FMQ and click Login from the pop-up menu as shown in the following figure.


    Figure: Fiorano Studio FMQ Login
     
  2. Navigate to FMQ > Connection Factories, right-Click the connection factory which you want to change, in this case, we are using PrimaryQCF, and select Edit.
  3. The Configure PrimaryQCF dialog box appears. In the Configure PrimaryQCF dialog box, change the Auto Update property as per your requirement and click the OK button.

    Icon

    By default, all the Connection Factories have these values set to 'yes'.


    Figure: The Configure PrimaryQCF dialog box

How to Set Auto Update Property for a Connection Factory

To set Auto Update property for a new Connection Factory, perform the following steps.

  1. Open the Fiorano Studio, in the Server Explorer pane right-click FMQ and click Login from the pop-up menu as shown in the following figure.


    Figure: Fiorano Studio FMQ Login
     
  2. Right-click the Connection Factories on the screen page and select Add Connection Factory.
  3. The New Connection Factories Properties dialog box appears. Change the Auto Update property, the default set to no.
  4. Click the OK button and the Auto Update property for a connection factory is set.


    Figure: The New Connection Factories Properties dialog box

How to Start with JMS Application in Java

To start with a JMS application, firstly, you need to know how to write a JMS application. FioranoMQ has samples under <fmq_installation_dir>/fmq/samples; you can go through the samples and write your own samples. For more information, please download Java Message Service.

Icon

Specification - version 2.0 PDF format from the following location:

http://java.sun.com/products/jms/docs.html

What are the JAR files required to compile and run the newly created JMS Application?

FioranoMQ provides three libraries, you need to put them in the classpath to run the JMS applications and they are:

  • <fmq_installation_dir>/fmq/lib/client/all/fmq-client.jar
  • <fmq_installation_dir>/framework/lib/all/fiorano-framework.jar
  • <fmq_installation_dir>/extlib/jms/jms-2.0.jar

How to Start with JMS Applications in C

To write C applications which are compatible with FioranoMQ, please refer to the samples under <fmq_installation_dir>/fmq/clients/c/native/samples. FioranoMQ provides whole lot of samples for C Applications for both Publish-Subscriber and Point-to-Point protocols.

What are the libraries required to compile and run the newly created C JMS Application?

FioranoMQ provides libraries, header files for C applications which should be used to compile and run the applications.

  1. To compile C Application:
    1. Header files:
      1. <fmq_installation_dir>/fmq/clients/c/native/include
      2. <fmq_installation_dir>/fmq/clients/pthread/include
    2. Compiler Arguments:
      1. For Windows:
        Arguments required are /w /W0 /nologo /MD/Gd /TC /D "WIN32"
        For more information, please refer to build_samples.bat under <fmq_installation_dir>/fmq/clients/c/native/scripts directory.
      2. For Linux/Solaris:
        Arguments required are -w -D_SOLARIS_
        For more iinformation, please refer to build_samples.sh under <fmq_installation_dir>/fmq/clients/c/native/scripts directory.
  2. To link the C Application:
    1. Libraries required for Windows:
      1. <fmq_installation_dir>/fmq/clients/c/native/lib/fmq-crtl.lib
      2. <fmq_installation_dir>/fmq/clients/pthread/lib/pthreadVC.lib

        From Windows

        Icon

        wsock32.lib msvcrt.lib msvcrtd.lib

         

    2. Libraries required for Linux/Solaries:
      1. <fmq_installation_dir>/fmq/clients/c/native/lib/fmq-crtl.a

        From Linux/Solaris libraries

        Icon

        -lpthread-lsocket

How to Start with JMS Applications in C++

To write C++ applications which are compatible with FioranoMQ, please refer to the samples under <fmq_installation_dir>/fmq/clients/cpp/native/samples. FioranoMQ provides a whole lot of samples for C++ Applications for both Publish-Subscriber and Point-To-Point protocols.

What are the libraries required in order to compile and run the newly created C++ JMS Application?

FioranoMQ provides libraries, header files for C++ applications which should be used to compile and run the applications.

  1. To compile C++ Application:
    1. Header files:
      1. <fmq_installation_dir>/fmq/clients/c/native/include
      2. <fmq_installation_dir>/fmq/clients/cpp/native/include
      3. <fmq_installation_dir>/fmq/clients/pthread/include
         
    2. Compiler Arguments:
      1. For Windows:
        Arguments required are /w /W0 /nologo /MD/Gd /TP /D WIN32 /GX  
        For more information, please refer to build_samples.bat under <fmq_installation_dir>/fmq/clients/cpp/native/scripts directory.
      2. For Linux/Solaris:
        Arguments required are -w -D_SOLARIS_
        For more information, please refer to build_samples.sh under <fmq_installation_dir>/fmq/clients/cpp/native/scripts directory.
  2. To link the Cpp Application:
    1. Libraries required for Windows:
      1. <fmq_installation_dir>/fmq/clients/c/native/lib/fmq-crtl.lib
      2. <fmq_installation_dir>/fmq/clients/cpp/native/lib/fmq-native-cpprtl.lib
      3. <fmq_installation_dir>/fmq/clients/pthread/lib/pthreadVC.lib

        Icon

        From Windows: wsock32.lib msvcrt.libmsvcrtd.lib         

    2. Libraries required for Linux/Solaries:
      1. <fmq_installation_dir>/fmq/clients/c/native/lib/libfmq-crtl.a
      2. <fmq_installation_dir>/fmq/clients/cpp/native/lib/libfmq-native-cpprtl.a

        Icon

        From Linux/Solaris libraries: -lpthread-lsocket

How to Start with JMS Applications in C#

To write C# applications which are compatible with FioranoMQ, please refer to the samples under <fmq_installation_dir>/fmq/clients/nativecsharp/samples. FioranoMQ provides a lot of samples for C# Applications for both Publish-Subscriber and Point-To-Point protocols.

What are the DLL's required in order to compile and run the new created Csharp JMS Application?

FioranoMQ provides Dynamic Link Library (DLL) file for C# applications which should be used to compile and run the applications.

  1. To compile and run C# Applications:
    1. DLL file:

      Icon

      For more information, please refer to build_samples.bat under <fmq_installation_dir>/fmq/clients/nativecsharp/scripts directory. 

Adaptavist ThemeBuilder EngineAtlassian Confluence