Using the AquaLogic Service Bus Console
|
 |
 |
|
 |
 |
Project Explorer
This section includes the following topics:
- Overview of the Project Explorer
- Listing Projects
- Adding a Project
- Viewing Project Details
- Deleting a Project
- Adding a Folder
- Viewing Folder Details
- Deleting a Folder
- Creating a Resource
- Importing Resources in Bulk
- Loading Resources from a Zip File
- Loading Resources from a URL
- Reviewing Loaded Resources
- Viewing Import Results
- Viewing References
- Renaming a Resource
- Moving a Resource
- Exporting a WSDL
Overview of the Project Explorer
The following table lists the pages you can access from the Project Explorer module. The tasks and help topics associated with each are provided.
Projects and Folders
The Project Explorer module allows AquaLogic Service Bus developers to better organize related parts of large development projects by allowing logical grouping of AquaLogic Service Bus entities.
The Project Explorer module consists of projects and folders.
Projects are non-hierarchical, non-overlapping, top-level grouping constructs. All AquaLogic Service Bus resources (for example, services, WS-Policies, WSDLs, XQuery transformations, and so on) reside in exactly one project. Projects do not overlap. Resources can be created directly under a project, or they can be further organized into folders. However, you can reference any resource regardless of the project in which it resides.
Note: When you create a domain in AquaLogic Service Bus, a default project is created for your use when you log on to the Console.
Folders are contained within projects. You use folders to hierarchically organize resources. They are similar to directories (or folders) in a file system. Each folder resides under another folder or the project (if it is the root folder in that project). The use of folders is optional.
Note: The names, length, and levels of nesting of projects and folders are ultimately affected by the limits of your operating system. Creating folders or projects with very long names or deeply nesting folders can fail due to the limitations of the operating system.
On the AquaLogic Service Bus Console, you can navigate to a project or folder in either of the following ways:
- Use the tree-based view on the left navigation pane of the Console pages
- Use the Project or Folder pages on the main pane of the Console.
The only difference between these ways is that the left navigation pane displays the whole hierarchy but does not display any resources.
Uses of Projects and Folders
Projects and folders are useful for the following reasons:
- Projects can serve as a unit of development in a large scale development effort. For example, projects
proj_HR, andproj_SALEScan contain, respectively, all AquaLogic Service Bus components designed for projects for the HR and Sales departments. Folders can further help organize resources within each project. - Projects and folders serve as a namespace to distinguish between entities with the same name.
- Projects and folders provide classification and easy-browsing in a domain with a very large number of entities. For example, when you have 1000s of entities, it is preferable to browse a tree, not a table.
- Projects and folders simplify export and import. An import is always additive and never results in deleting resources. If the imported resource already exists, the system updates the resource; if it does not exist, the system creates the resource.
Resources
Projects and folders qualify AquaLogic Service Bus resources along with the name of that resource. Therefore, the project name and the name of the folder (path) is a part of resource name. In other words, a resource is referenced by pre-pending its name with a project name followed by an array of folder names, from root to the folder of the resource.
A reference to a resource is displayed as follows:
project-name/root-folder/. . ./parent-folder/resource-name
If a resource is located directly under a project, the reference is displayed as follows:
Related Topics
Listing Projects
The Projects page displays a list of projects. To learn more about projects and folders, see Overview of the Project Explorer.
The page displays the following information for each project.
|
The name of the project. Click the name to display details of this project. To learn more, see Viewing Project Details. |
|
|
Click the Delete Project icon to delete the project. To learn more, see Deleting a Project. |
This page also allows you to add a new project. To learn more, see Adding a Project.
Related Topics
Adding a Project
The Projects page allows you to add a new project. To learn more about projects and folders, see Overview of the Project Explorer.
Note: The names, length, and levels of nesting of projects and folders are ultimately affected by the limits of your operating system. Creating folders or projects with very long names or deeply nesting folders can fail due to the limitations of the operating system.
To Add a Project
- If you have not already done so, from the left navigation pane, under Change Center, click Create to create a new session for making changes to the current configuration. To learn more, see Using the Change Center.
The new project is displayed in the list of projects.
Note: The new project is saved in the current session. When you have finished making changes to this configuration, from the left navigation pane, click Activate under Change Center. The session ends and the configuration is deployed to run time. Alternatively, click Discard at any time during the session to delete the changes you have made so far in the current session.
This page also you to view the list of projects. To learn more, see Listing Projects.
Related Topics
Viewing Project Details
The Project View page allows you to view details of a specific project. To learn more about projects and folders, see Overview of the Project Explorer.
To View Project Details
- In the Name column, click the name of a specific project to view details of that project. Alternatively, you can also link to the project you want to view from the left navigation pane under Project Explorer.
The Project View page is displayed, which displays the following information for the project:
Click to view a list of resources outside of this project that are referenced by resources inside this project. To learn more, see Viewing References.
Click to view a list of resources outside of this project that reference any resources inside this project. To learn more, see Viewing References.
A description of the project, if one exists.
You can click Edit Description to add or edit a description of this project, and click Submit Description to update it.
It displays the following information for the folders:
The name of the folder. Click the name to display folder details. To learn more, see Viewing Folder Details.
Click the Delete Folder icon to delete a folder. To learn more, see Deleting a Folder.
It displays the following information for resources associated with this project:
The name of the resource. The name is a link to details of the resource.
The Actions column displays up to four icons:
A Manage Monitoring icon displays for any business or proxy services that you have created. Click this icon to enable or disable monitoring for a specific service, enable or disable the service itself, and view or configure alert rules for a specific service. To learn more, see Listing and Locating Alert Rules.
An Edit Message Flow icon displays for any proxy services you have created. Click this icon to edit the message flow of a specific proxy service. To learn more, see Viewing and Changing Message Flow.
A Launch Test Console icon displays for any business or proxy service, XQuery transformation, XSL transformation, or MFL File you have created. Click this icon to invoke the Test Console, which you use to validate and test the design of your services and transformations. For the services, you can only use the Test Console at run time; that is, when the session is activated. For the transformations, you can use the Test Console whether you are inside or outside a session. To learn more, see Testing Services and Testing Transformations.
An Export WSDL icon displays for any WSDL-based proxy services. You use the Export WSDL functionality to quickly make a WSDL available for consumption by external tools such as IDEs. Note that this is different than the Export Resources functionality in the System Administration module, which you use to move and stage resources between two domains. Click the Export WSDL icon to export the WSDL. To learn more, see Exporting a WSDL.
The Options column displays three icons:
Click the Rename Resource icon to rename a resource. To learn more, see Renaming a Resource
Click the Move Resource icon to move a resource. To learn more, see Moving a Resource.
This page also enables you to do the following:
- Add a folder. To learn more, see Adding a Folder.
- Create a resource. To learn more, see Creating a Resource.
Related Topics
Deleting a Project
The Project View page allows you to delete a project. To learn more about projects and folders, see Overview of the Project Explorer.
Note: When you delete a project, all resources under the project are deleted. If any resources under this project are referenced by resources under a different project, you cannot delete the project, as you cannot delete a resource if it is referenced by other resources in AquaLogic Service Bus. Instead of the Delete icon 
, a Delete icon with a red X 
is displayed for these resources.
To Delete a Project
- If you have not already done so, from the left navigation pane, under Change Center, click Create to create a new session for making changes to the current configuration. For more information, see Using the Change Center.
- From the left navigation pane, click Projects under Project Explorer. The Projects page is displayed.
- In the Options field of the project you want to delete, click the Delete Project icon. The project is deleted from the list of projects.
The project is deleted in the current session. When you have finished making changes to this configuration, from the left navigation pane, click Activate under Change Center. The session ends and the configuration is deployed to run time. Alternatively, click Discard at any time during the session to delete the changes you have made so far in the current session.
Note: If necessary, you can undo the deletion of this project. To learn more, see Undoing a Task.
Related Topics
Adding a Folder
The Project View page allows you to add a folder. To learn more about projects and folders, see Overview of the Project Explorer.
Note: The names, length, and levels of nesting of projects and folders are ultimately affected by the limits of your operating system. Creating folders or projects with very long names or deeply nesting folders can fail due to the limitations of the operating system.
To Add a Folder
- If you have not already done so, from the left navigation pane, under Change Center, click Create to create a new session for making changes to the current configuration. For more information, see Using the Change Center.
- From the left navigation pane, click a project name from under Project Explorer. The Project View page is displayed.
The new folder is displayed in the list.
Note: The new folder is saved in the current session. When you have finished making changes to this configuration, from the left navigation pane, click Activate under Change Center. The session ends and the configuration is deployed to run time. Alternatively, click Discard at any time during the session to delete the changes you have made so far in the current session.
Note: The names, length, and levels of nesting of projects and folders are ultimately affected by the limits of your operating system. Creating folders or projects with very long names or deeply nesting folders can fail due to the limitations of the operating system.
Related Topics
Viewing Folder Details
The Folder View page enables you to view details of a specific folder. To learn more about projects and folders, see Overview of the Project Explorer.
To View Folder Details
- From the left navigation pane, click a project name from under Project Explorer. The Project View page is displayed.
- In the Name column, click the name of a folder to view its details. Alternatively, you can also link to the folder you want to view from the left navigation pane under Project Explorer.
The Folder View page is displayed, which displays the following information for the folder:
Click to view a list of resources outside of this project that are referenced by resources inside this project. To learn more, see Viewing References.
Click to view a list of resources outside of this folder, that reference any resources inside this folder. To learn more, see Viewing References.
A description of the folder, if one exists.
You can click Edit Description to add or edit a description of this folder, and click Submit Description to update it.
It displays the following information for the folders within this folder:
The name of the folder. Click the name to display folder details.
Click the Delete icon to delete a folder. To learn more, see Deleting a Folder.
It displays the following information for resources associated with this folder:
The name of the resource. The name is a link to details of the resource.
The Actions column displays up to four icons:
A Manage Monitoring icon displays for any business or proxy services that you have created. Click this icon to enable or disable monitoring for a specific service, enable or disable the service itself, and view or configure alert rules for a specific service. To learn more, see Listing and Locating Alert Rules.
An Edit Message Flow icon displays for any proxy services you have created. Click this icon to edit the message flow of a specific proxy service. To learn more, see Viewing and Changing Message Flow.
A Launch Test Console icon displays for any business or proxy service, XQuery transformation, XSL transformation, or MFL File you have created. Click this icon to invoke the Test Console, which you use to validate and test the design of your services and transformations. For the services, you can only use the Test Console at run time; that is, when the session is activated. For the transformations, you can use the Test Console whether you are inside or outside a session. To learn more, see Testing Services and Testing Transformations.
An Export WSDL icon displays for any WSDL-based proxy services. You use the Export WSDL functionality to quickly make a WSDL available for consumption by external tools such as IDEs. Note that this is different than the Export Resources functionality in the System Administration module, which you use to move and stage resources between two domains. Click the Export WSDL icon to export the WSDL. To learn more, see Exporting a WSDL.
The Options column displays three icons:
Click the Rename Resource icon to rename a resource. To learn more, see Renaming a Resource.
Click the Move Resource icon to move a resource. To learn more, see Moving a Resource.
This page also enables you to do the following:
- Add a folder. To learn more, see Adding a Folder.
- Create a resource. To learn more, see Creating a Resource.
Related Topics
Deleting a Folder
The Project View page allows you to delete a folder associated with a project, and the Folder View page enables you to delete a folder associated with another folder. To learn more about projects and folders, see Overview of the Project Explorer.
Note: When you delete a folder, all resources under the folder are deleted. If any resources under this folder are referenced by resources under a different folder, you cannot delete the folder, as you cannot delete a resource if it is referenced by other resources in AquaLogic Service Bus. Instead of the Delete icon
, a Delete icon with a red X
is displayed for these resources.
To Delete a Folder
- If you have not already done so, from the left navigation pane, under Change Center, click Create to create a new session for making changes to the current configuration. For more information, see Using the Change Center.
- From the left navigation pane, under Project Explorer, navigate to the parent project or folder that contains the folder that you want to delete. The Project View or Folder View page is displayed.
- In the Options field of the folder you want to delete, click the Delete Folder icon. The folder is deleted from the list of folders.
The folder is deleted in the current session. When you have finished making changes to this configuration, from the left navigation pane, click Activate under Change Center. The session ends and the configuration is deployed to run time. Alternatively, click Discard at any time during the session to delete the changes you have made so far in the current session.
Note: If necessary, you can undo the deletion of this project. To learn more, see Undoing a Task.
Related Topics
Creating a Resource
The Project View page allows you to create resources for a specific project. To learn more about projects and folders, see Overview of the Project Explorer.
To Create a Resource for a Specific Project
Note: A resource can be created at a folder or subfolder level as well as the project level. To create it at a folder or sub-folder level, you can apply the steps below to the Folder View page.
- If you have not already done so, from the left navigation pane, under Change Center, click Create to create a new session for making changes to the current configuration. For more information, see Using the Change Center.
- From the left navigation pane, under Project Explorer, navigate to the parent project or folder in which you want to create the resource. The Project View or Folder View page is displayed.
- In the Create Resource field, select a resource type. Different pages are displayed subsequently, depending on the resource you select.
|
Help Topic1 |
||
|---|---|---|
1. To learn more about creating the type of resource you selected, see the appropriate help topic.
Note: The new resource is saved in the current session. When you have finished making changes to this configuration, from the left navigation pane, click Activate under Change Center. The session ends and the configuration is deployed to run time. Alternatively, click Discard at any time during the session to delete the changes you have made so far in the current session.
Related Topics
Importing Resources in Bulk
The Load Resources page enables you to import resources in bulk into AquaLogic Service Bus. You can select the Zip or JAR file that contains the resources you want to load. During the import, AquaLogic Service Bus uses the existing file structure to resolve dependencies automatically. To learn more, see Loading Resources from a Zip File.
Resources such as WSDLs or XML Schemas can define a full tree of dependent resources. To successfully add such resources, you must also add and resolve all the dependent resources. The Load Resources page enables you to import a given resource and all its dependents by specifying the URL of the root resource, if these resources are available through the Web. Specifying the root resource is sufficient to download the full tree. The dependency map is resolved automatically. To learn more, see Loading Resources from a URL.
Note: There is a difference between bulk import functionality and the import functionality provided by AquaLogic Service Bus to facilitate the import of AquaLogic Service Bus configurations. You use bulk import to import resources that are not hosted by AquaLogic Service Bus; for example, to import resources that reside in a file or on the Web. You use the import configuration functionality for propagating a configuration from one AquaLogic Service Bus domain (for example, a testing domain) to another domain (for example, a production domain). To learn about this latter functionality, see Importing Configuration Data
Related Topics
Loading Resources from a Zip File
The Load Resources page enables you to import resources in bulk. You can select the Zip or JAR file that contains the resources you want to load; AquaLogic Service Bus locates and imports the resources from this Zip file.
Note: Resources like WSDL or XML Schema can define a full tree of dependent resources. The bulk load feature allows you to upload a set of resources at once; you need not resolve the dependencies manually.
To Load Resources from a Zip File
- If you have not already done so, from the left navigation pane, under Change Center, click Create to create a new session for making changes to the current configuration. To learn more, see Using the Change Center.
- Select the project to which you want to add the resources. You can add the resources directly under the project or under a selected folder.
- From the Project View or Folder View page, in the Create Resource field, select Zipped Resources from under Bulk. The Load Resources page is displayed.
Each file in the Zip file is a possible resource, and the file extension is the commonly used way to identify the file type. AquaLogic Service Bus defines a default extension for each resource, but if you have additional extensions to describe those resources, this map enables you to declare those extensions to the loader. After you define the Zip file and extension map, the AquaLogic Service Bus loader scans the contents of the Zip file and tries to associate a resource type with each file. A file without an extension or one that does not have an extension defined in the map is considered unknown and is automatically excluded from the load. For known files, the name of the resource is the name of the file without its extension. The folder structure of the Zip file is recreated in the target AquaLogic Service Bus Console folder.
Note: An extension can only be associated with one file type.
- Click Next. The Review Loaded Resources page is displayed. Continue in Reviewing Loaded Resources.
Note: To select a folder, click the name of the folder. The Folder View page is displayed.
Related Topics
Loading Resources from a URL
The Load Resources page enables you to import a resource such as a WSDL or XML Schema and all its dependents by specifying the URL of the root resource, if these resources are available through the Web. Specifying the root resource enables you to download the full tree. The dependency map is resolved automatically.
To Load Resources from a URL
- If you have not already done so, from the left navigation pane, under Change Center, click Create to create a new session for making changes to the current configuration. To learn more, see Using the Change Center.
- Select the project to which you want to add the resources. You can add the resources directly under the project or under a selected folder.
- From the Project View or Folder View page, in the Create Resource field, select Resources from URL from under Bulk. The Load Resources page is displayed.
- In the Resource Type field, select WSDL, XML Schema, XQuery, XSLT, WS-Policy, or MFL as the resource type.
- Click Next. The Review Loaded Resources page is displayed. Continue in Reviewing Loaded Resources.
Note: To select a folder, click the name of the folder. The Folder View page is displayed.
Related Topics
Loading Resources from a Zip File
Reviewing Loaded Resources
The Review Loaded Resources page enables you to display loaded resources from a zip file or a URL and select the resources you want to import. You can access this page only when you have successfully loaded the resources from the zip file or URL.
To Review Loaded Resources
- Depending on whether you have loaded resources from a Zip file or a URL, make sure you have completed the steps in either Loading Resources from a Zip File or Loading Resources from a URL.
The Review Loaded Resources page displays the following information:
The file name of the resource, including the file extension.
The path of the resource, which is the project and folder where the resource resides.
In addition, the Review Loaded Resources page displays a column that determines whether or not the resource is a known file. A check box is displayed if it is a known file, but a Warning icon is displayed of the file is unknown. (A file without an extension or one that does not have an extension defined in the map is considered unknown.) You cannot import the unknown files.
- Make sure the check box associated with the resource is selected to include the resource when you import the resources. You can clear the check box to exclude the resource from the import.
- To import the resources you have selected, click Import. The Import Result page is displayed. Continue in Viewing Import Results.
Related Topics
Viewing Import Results
The Import Result page enables you to view the import results of loaded resources from a zip file or a URL. You can access this page only when you have successfully loaded the resources from the zip file or URL and clicked Import to import selected resources.
To View Import Results
- Depending on whether you have loaded resources from a zip file or a URL, make sure you have completed the steps in either Loading Resources from a Zip File or Loading Resources from a URL, and make sure you have completed the steps in Reviewing Loaded Resources.
The Import Result page is displayed, which displays the following information:
Related Topics
Viewing References
The View References page enables you to view a list of resources that have references to, or references by resource under a particular project.
- References: This link displays resources that are outside of a project/folder and are references by resources inside that project/folder.
- Referenced by: This link displays resources that are outside of a project/folder and reference resources inside that project.
To View References
- If you have not already done so, from the left navigation pane, under Change Center, click Create to create a new session for making changes to the current configuration. For more information, see Using the Change Center.
- Click References or Referenced By on a project, folder or resource details page in the Project Explorer or Resource Browser modules. The View References page is displayed.
The page displays the following information:
The name of the resource. The name is a link to details of the resource.
Displays Project, Folder, or any of the following resource types:
If you are importing a set of resources, and you access this page by clicking the link in the Reference column of the Import Configuration Data page, the page displays the following information:
Related Topics
Overview of the Project Explorer
Renaming a Resource
The Project View or Folder View page enables you to rename a resource.
To Rename a Resource
- If you have not already done so, from the left navigation pane, under Change Center, click Create to create a new session for making changes to the current configuration. For more information, see Using the Change Center.
- From the left navigation pane, click a project or folder from under Project Explorer. The Project View or Folder View page is displayed.
- In the Resources section, click the Rename icon in the Options column of the specific resource you want to rename.
Related Topics
Overview of the Project Explorer
Moving a Resource
The Project View or Folder View page enables you to move a resource.
To Move a Resource
- If you have not already done so, from the left navigation pane, under Change Center, click Create to create a new session for making changes to the current configuration. For more information, see Using the Change Center.
- From the left navigation pane, click a project or folder from under Project Explorer. The Project View or Folder View page is displayed.
- In the Resources section, click the Move icon in the Options column of the specific resource you want to move.
Note: If they exist, the sub-folders for a project are displayed when you select the project.
Related Topics
Overview of the Project Explorer
Exporting a WSDL
The Project View or Folder View page enables you to export a WSDL associated with a proxy service in your configuration. You can only do this when you are outside a session.
You use the Export WSDL functionality to quickly make a WSDL available for consumption by external tools such as IDEs. Note that this is different than the Export Resources functionality in the System Administration module, which you use to move and stage resources between two domains.
To Export a WSDL
- From the left navigation pane, click a project or folder from under Project Explorer. The Project View or Folder View page is displayed.
