In this section: |
Reference: |
The Environments Tree panel is the primary navigational aide in WebFOCUS App Studio. Using it, you can always stay oriented to the Workspace or web application that you are working in. You can use the panel to move or copy objects between folders, copy folders, share content with other WebFOCUS App Studio users, or hide content.
From the Environments Tree panel, you can:
The Environments Tree panel is shown in the following image.
The Environments Tree panel opens with App Studio.
The Environments Tree toolbar contains the buttons and menus that you need to navigate, filter, and sort the information that appears in the Configured Environments tree.
Presents options for viewing items (for example, alphabetical sorting or grouping), as described in the following table.
Option |
Name |
Function |
---|---|---|
View items sorted in Alphabetical order |
Sorts the files alphabetically from A to Z. |
|
View items sorted in reverse Alphabetical order |
Sorts the files alphabetically from Z to A. |
|
View items sorted in Chronological order |
Sorts the files by the last saved time, in descending order. |
|
View items sorted in reverse Chronological order |
Sorts the files by the saved time, in ascending order. |
|
View Items grouped by File Type |
Sorts the files by file type. |
|
Respect Sort Order Property |
Respects the Sort Order property value specified in the File/Folder Properties panel. This is the default. |
|
View items by Title |
Displays the files by title and sorts the files by title. If an item does not have a title, its name is shown. |
|
View items by Name |
Displays the files by name and sorts the files by name. If an item does not have a title, its name is shown. |
|
Refresh View |
Refreshes all of the files and folders that you see in the Configured Environments tree. Refresh View also shows the dependencies of the file or folder that you have selected. |
|
Show All Content files |
Filters the tree to show all content file types, except for Master Files. To view Master Files, click Show only Master files. |
|
Show only Procedure files |
Filters the tree to show only this file type. |
|
Show only Master files |
Filters the tree to show only this file type. |
|
Show only HTML files |
Filters the tree to show only this file type. |
|
Show only Maintain files |
Filters the tree to show only this file type. |
|
Show only Image files |
Filters the tree to show only this file type. |
|
Show only ReportCaster files |
Filters the tree to show only this file type. |
|
Show only Library files |
Filters the tree to show only this file type. |
|
Other files |
Filters the tree to show other file types. |
Reference: |
The Configured Environments tree displays the WebFOCUS Environments, Data Servers, Workspaces, and Web Applications nodes. These are the development areas where you can create content. If you have the Managed Reporting version of WebFOCUS App Studio and WebFOCUS installed on your machine, or configured a remote WebFOCUS 8 environment, a workspace node also appears.
If a node under the Configured Environments Tree has been populated and contains content, a green dot is shown on the node icon. If a node has been populated and does not contain any content, a red dot is shown on the node icon. If a node has not been populated, WebFOCUS App Studio does not know if there is any content in that node and no dot is shown on the node icon. If you create a new content in a node with a red dot on it, that node now has content in it and will change to a green dot. If you delete all content in a node with a green dot, that node now has no content in it and will change to a red dot.
Note: By default, the Configured Environments tree sorts files and folders by title. If you change the sorting options to View Items by Name, the names of your files and folders will display. Whether you display content by title or by name, the Workspaces, Data Servers, and Web Applications nodes do not display differently.
You can expand the nodes on the Configured Environments tree to view your configured environments, folders, and application files. Use the filtering commands on the toolbar to sort files alphabetically, display by name or title, or include the associated paths.
From the Configured Environments tree, you can manage content for each of your WebFOCUS environments. This includes creating new folders or files, opening existing files, and copying files. Right-click a node, folder, or file to view the shortcut menu of options. You can also open files by double-clicking them.
You can also use the Refresh Descendants option to refresh a specific application or folder. Right-click the application or folder that you want to refresh, and then click Refresh Descendants.
Note:
You can copy files from your desktop to the Configured Environments Tree.
From the Configured Environments node, you can access the following shortcut menu option:
From your WebFOCUS environment, in the Environments Tree panel, you can access the following shortcut menu options:
Note: You can copy files that are not in WebFOCUS App Studio and paste them in the Configured Environments tree to use those files when creating your application.
The Data Servers node lists each Reporting Server that the WebFOCUS Client can access. This node expands to display the files that you can use to develop WebFOCUS applications successfully.
The process of populating the application paths of the files in the Data Servers node is done on a background thread. While this background thread is running, you can navigate on the tree, open a folder, and create files. However, you will be unable to save a new file, or do anything that requires a path list, such as create a new style sheet, until the background thread completes. This section of the Configured Environments tree, which is visible, will populate.
From a data server, you can access the following shortcut menu options:
From the Workspaces folder, you can access the following shortcut menu options:
From an application folder or a file, you can access the following shortcut menu options:
If you duplicate a folder, all contents, except for portals, are also duplicated.
If you copy a folder, all contents, except for portals, are also copied.
The Workspaces node is storage space for data or information, and allows you to use App Studio to administer and develop against a Managed Reporting environment. The Workspaces node lets you manage resources and applications on remote servers, as well as on your local machine if you have performed a full installation of App Studio. You can create and edit application files on all remote servers from one easily accessible interface. You can also create and administer reports for Managed Reporting from a Windows application rather than a web browser.
From a Workspaces node, you can access the following shortcut menu options:
Note: Using this option is not the same as creating a new Workspace.
To create a new workspace, use the BI Portal New - Enterprise Domain option. This option triggers the workspace template, which creates workspace-specific user groups and sub-folders such as My Content. For more information, see the WebFOCUS Business Intelligence Portal manual.
Using the New Folder option in WebFOCUS App Studio does not trigger the workspace template.
From a folder or file, in the Workspaces node, you can access the following shortcut menu options:
If you copy a folder, all contents, except for portals, are also copied.
To ensure that all instances of the original name and references are updated, it is recommended that you use the Save As option to rename an HTML page.
Note: For more information on publishing and unpublishing folders and items within the workspaces, see the TIBCO WebFOCUS® Security and Administration manual.
The Web Applications node allows you to open files with the Text Editor, or the mode you used to create them.
Note: Based on the file type, different options may display.
From the Web Applications node, you can access the following shortcut menu options:
From an application folder, you can access the following shortcut menu options:
From a file, you can access the following shortcut menu options:
Population is a check to see what content, if any, is contained within a node in the Configured Environments tree. Node population occurs when you select a node in the Configured Environments tree. The node icon will be different depending on whether population has occurred. If a node contains files after population a green dot appears on the node icon. If a node does not contain files after population, a red dot appears on the node icon.
If a node has been populated and contains content, deleting that content will change the green dot to a red dot. Conversely, if a node has been populated and contains no content, creating content in that node will change the red dot to a green dot.
The following shortcut menu options are available for a Master File:
Note: When a Master File is opened in the Text Editor canvas, all other open options from the shortcut menu are unavailable.
In addition to opening files through the Hamburger menu, or from the Quick Access Toolbar, you can also open files from the development areas in the Configured Environments tree.
Note: Files can only be opened in one area of App Studio at a time to ensure that your changes are not overwritten by another opened version of the file. However, you are able to open a file in App Studio and in a Windows Associated Tool at the same time. To ensure that your changes are saved properly, you should only modify one opened version of the file at a time.
How to: |
There are two ways of sharing contents in WebFOCUS App Studio.
To publish a folder, right-click it and select Publish from the shortcut menu.
Using the BI Portal, an Advanced user can designate a content file to share with an WebFOCUS App Studio Developer user. This overview procedure gives the general steps needed to share a file.
For more information, see the WebFOCUS Business Intelligence Portal manual.
In this section: |
How to: |
As you set up access to WebFOCUS environments, your settings are retained in a file named wfscom.xml. WebFOCUS environment settings are typically stored in the following locations.
Windows 7:
drive:\Users\user_id\AppData\Roaming\Information Builders\wfscom.xml
where:
Is your Windows user ID.
Note:
You can choose to remove this environment from your configuration files or leave the environment, and continue to develop against other environments that you configure. If you choose to remove the environment from your configuration files, you must restart WebFOCUS App Studio.
A WebFOCUS environment consists of a web server, a WebFOCUS Client, and a Reporting Server. Adding WebFOCUS environments lets you create and manage multiple environments, such as development, test, and production instances.
To add a WebFOCUS environment, do the following:
Specify a web server that includes a host name and port number.
Configure the HTML alias/context root to access the WebFOCUS Client. If you develop applications in the Data Servers area and need to deploy the application to an environment that has a different alias, see Working With the HTML Alias Property .
Provide the appropriate user credentials if web server authentication is required.
The following procedure provides the information you need to add a WebFOCUS Environment.
The Environments List dialog box opens. This dialog box lists all WebFOCUS environments defined for App Studio.
The WebFOCUS Environment Properties dialog box opens, as shown in the following image.
At the top of the dialog box is the Description field, followed by the Environment Settings area. The Environment Settings area contains a series of buttons that represent components in a WebFOCUS environment, and the required parameter fields to configure that environment. When you configure an environment, the areas below the buttons can change according to the parameters that are required.
Note: The description cannot contain special characters, such as ., /, \, ?, *, and others. A message with characters not allowed appears if one of the restricted characters is detected during validation.
For some environments, once you specify the web server, all other settings default. If the WebFOCUS environment you are accessing does not use default settings, or the components require authentication, click the appropriate button in the Environment Settings area to provide the parameters. The areas that follow explain the parameters available for each component.
Note: WebFOCUS environment properties must be supplied in a specific order. For example, if web server security is enabled, you cannot set the WebFOCUS Client script name until you have provided valid web server credentials. Similarly, you cannot retrieve a list of Reporting Servers until you have provided a valid WebFOCUS Client Path.
As you select a component button in the WebFOCUS Environment Properties dialog box, App Studio ensures that it has the necessary information before it displays the properties of that component in the lower part of the dialog box. If the required information is not available, you cannot proceed to the next component.
The WebFOCUS Logon - WebFOCUS dialog box opens and prompts you for a WebFOCUS ID and password.
The WebFOCUS Logon - WebFOCUS dialog box populates the ID wfdesktop, by default. This user ID is configured with WebFOCUS and allows self-service development: development from the Data Servers and Web Applications areas.
Access to the workspace is restricted, and you cannot create new content with this user ID. You can only see and run published content.
There is a check box option on the logon dialog box for remembering the ID or password. By default, it is not selected. If you select this box, your credentials are stored and encrypted in the wfscom.xml file, the local configuration file that stores information processed by the App Studio communication layer.
To clear stored credentials, open the WebFOCUS Environment Properties dialog box and select the environment that users need to make changes. Click WebFOCUS Client. Under WebFOCUS Credentials, delete the User ID and Password information, and then clear the Supply Credentials check box.
Note: A logon dialog box can also open for connection to the web server, application server, or Reporting Server, depending on the security implemented in the WebFOCUS environment that is being accessed.
The WebFOCUS Environment Properties dialog box closes.
If you develop applications in the Data Servers area and need to deploy the application to an environment that has a different alias, it is necessary to use a Generic alias. For existing pages, open the HTML pages and change the alias. The pages will not work if you do not change the alias to Generic.
Note: This option is only applicable to the Data Servers area.
To set an alias for a new page or change the alias for an existing page, you can:
For the DOCUMENT object, the HTML alias property on the Properties panel contains the following values:
The HTML alias property on the Properties panel is shown in the following image.
The HTML Alias property on the HTML Page section of the WebFOCUS App Studio Options dialog box has the same values and functionality as the Properties panel. When the value is changed for this property, new pages will inherit the setting from the WebFOCUS App Studio dialog box. This option is global and will be available for each HTML page.
Note: For existing non-self-service applications that need to be moved from development to production, you can set the value of HTML Alias as Generic in the WebFOCUS App Studio Options dialog box. All existing pages will have to be opened and then saved with this setting before they are moved to Production.
The HTML Alias property on the HTML Page section of the WebFOCUS App Studio Options dialog box is shown in the following image.
Note: To test the property, open the HTML page in the editor and verify the value of the HTML Alias, szHtmlAlias. For Custom, the value should be the same as in the HTML Alias property in the Environments dialog box, for example, szHtmlAlias=/ibi_apps/. For Generic, the value should be szHtmlAlias=/ibi_html/.
Local Machine properties are optional. Click the Local Machine button to access the WebFOCUS Environment Caching area. Select the options in this area to cache remote directory and file information, and enable file-content caching.
The file content caching location path is for a Windows 7 machine.
In caching, copies of files or information stored on a remote machine are temporarily stored on your local WebFOCUS App Studio machine. WebFOCUS App Studio then works with the locally stored files.
Caching speeds WebFOCUS App Studio performance because remote machines are not accessed and queried every time you request information. This is especially useful when accessing mainframes or when a network connection is slow.
However, caching should not be used when multiple developers are working with the same files because they could overwrite changes made by other developers. By default, caching is not enabled.
Two properties are available:
Cache remote directory and file information. This option caches information about files stored in the WebFOCUS environment. This does not actually cache files, only information about them. If you select this property, WebFOCUS App Studio does not requery the Reporting Server every time it needs a list of files stored in the WebFOCUS environment.
Enable file content caching. This option caches files typically stored on the server. WebFOCUS App Studio only retrieves files once. When you want to read or edit your files, WebFOCUS App Studio uses a cached copy. When you edit a cached file, the edited cached file is returned to the server and replaces the actual file on the server.
WebFOCUS App Studio retrieves information and files the first time you request them and then caches them locally. WebFOCUS App Studio then uses the cached copies until WebFOCUS App Studio is restarted, or you click the Clear buttons for each level.
The Web Components button is typically selected by default. Web Component properties specify how App Studio accesses the web server. The web server must be identified before any other components.
The following properties are available:
/ibi_apps/ibi_html
where:
Is customizable.
Is constant.
/ibi_apps/WFServlet
where:
Is customizable.
Is constant.
If the WebFOCUS environment uses a non-default context path, clear the Use Default check box and provide the correct Client Path. For example:
/ibi_apps8/WFServlet
If the Client Path is incorrect for the environment, you receive an error when you click the WebFOCUS button at the top of the page, or when you click OK to exit and save your changes.
If you do not know your path, ask your WebFOCUS Administrator or check the WebFOCUS Administration Console of the environment to which you want to connect. The Client Path settings for the environment are located under Utilities and Client Selection.
Use Default. Specifies that the default ibi_html alias is used. Keep this option selected unless you change the HTML Alias value.
HTML Alias:
/ibi_apps8/ibi_html
Client Path:
/ibi_apps8/WFServlet
To configure the web server for an environment that uses browser-based authentication protocols, such as x.509, select Browser-based Login in the drop-down list.
For more information, see the WebFOCUS Security and Administration manual.
When you click the WebFOCUS button, App Studio makes a connection to your web server to retrieve information about the WebFOCUS environment. Therefore, you have to first specify Web Component properties, and your web server must be running.
You are prompted to sign in to WebFOCUS to verify your configuration. You will also be prompted to sign in to WebFOCUS if you click OK to exit the dialog box.
The following properties are available:
When the correct WebFOCUS Client Path is provided, you can specify properties for the remaining component.
You can set authentication and view available Reporting Servers by clicking the Data Servers button. When you select Data Servers, App Studio connects to the WebFOCUS Client and retrieves a list of servers from its communication configuration file (odin.cfg).
The following property is available:
The Environments List dialog box opens.
The WebFOCUS Environment Properties dialog box opens.