Managing Applications and Paths

Creating and Mapping Applications

How to:

Create an Application
Map an Application to a Physical Directory
Delete an Application or the Application Mapping

Applications are designed to group related components.

When you create a new physical application, it becomes available for addition to the search path in a selected profile.
When you map an application name to an existing physical location outside of approot, the mapped application becomes available for inclusion in the search path of a selected profile.

Applications can be created and mapped in either the Reporting Server browser interface or the Data Migrator desktop interface.

Application directory names must comply with the following rules:

The maximum length is 64 characters.
For multi-part Application directories, the total length is limited to 512 characters.

Names can contain any valid alphanumeric character except the following:

' '	space character	,	comma
*	star character	.	dot
?	question mark	:	colon
<	less than sign	"	double quotation mark
>	greater than sign	'	single quotation mark
&	ampersand	\t	tab
\	backslash	\0	null terminator character
\|	vertical bar	/	slash
=	equal sign

Procedure: How to Create an Application

On the Reporting Server browser interface, go to the Applications page, or from the Data Migrator desktop interface, expand the Server node folder.
Either click New, then Application Directory on the Reporting Server browser interface ribbon, or right-click an application and click New, then Application Directory.

The Create New Application page opens.
Use the default Application Type, New Application under APPROOT.
Enter a name in the Application Name field.
Optionally, select the Recreate application if exists check box.

Warning: Choosing this option will overwrite the existing application and any content in it.
Enter a description in the Description field.
The Add directory to APPPATH option is the default. Optionally, you can decide not to add the directory.
Select a position from the Position in APPPATH drop-down menu. The options are Last and First. The default is Last.
Select a profile from the Profile drop-down menu. For Server Administrators, the default is edasprof. For all other users, the default is the user profile.
Click OK.

The application is added to the Application Directories folder.

Procedure: How to Map an Application to a Physical Directory

You can map an application name to a physical directory anywhere in the file system. This application name can be then used in APP commands.

Application mappings can be added and deleted based on profiles from either the Reporting Server browser interface or the Data Migrator desktop interface.

On the Applications page, either click New, then Application Directory on the ribbon, or right-click an application, select New, and then Application Directory.

The Create New Application page opens.
Select Application Mapping to Disk or SQL Repository from the Application Type drop-down menu.
Enter a name in the Application Name field.
Accept the default Physical location, enter a different location, or click the selector button (...) and navigate to a directory on your file system.
For platforms other than z/OS HFS Deployment, in addition to using the selector button, you can enter the full path of the physical directory to be mapped, in the format required on your platform. (If there are spaces in the directory you are mapping, you must enclose the entire path in double quotation marks.)

For z/OS HFS and PDS servers, in addition to using the selector button, you can enter values using the following formats:
```
ext=//DD:ddname[;ext2=//DD:ddname2][...][;extn=//DD:ddnamen]
```
where extn are file type extensions.
```
/dir/subdir
```
entered manually or using the selector button.

For z/OS PDS servers, you can also inform the high-level qualifiers of the data set collection that comprise this application. Here is an example of the format:
```
IADMIN.SRV77.MAPAPP
```
where the user has the following datasets (not in approot):
```
IADMIN.SRV77.MAPAPP.FOCEXEC.DATA
IADMIN.SRV77.MAPAPP.MASTER.DATA
IADMIN.SRV77.MAPAPP.ACCESS.DATA
```
Select New application (directory will be created) from the Map to drop-down menu.
Optionally, enter a description in the Description field.
Add directory to APPPATH is the default. Optionally, you can decide not to add the directory.
Select a position from the Position in APPPATH drop-down menu. The options are Last and First. The default is Last.
Select a profile from the Profile drop-down menu.

For Server Administrators, the default is edasprof. For all other users, the default is the user profile.
Click OK.

The mapping is added to the Application Directories folder.

Procedure: How to Delete an Application or the Application Mapping

Applications and application mappings can be deleted from either the Reporting Server browser interface or the Data Migrator desktop interface.

From the Reporting Server browser interface menu bar, go to the Applications page, or from the Data Migrator desktop interface, expand the Server node folder.
Right-click the application or application mappings and select Delete or Delete Mapping, respectively.

A confirmation dialog box opens.
Click OK to delete the application or application mapping.

Note: Deleting an application mapping will delete it from any APP PATH commands that reference it, if the APP PATH command is in the same profile as APP MAP.

Using an SQL Database to Store Application Contents

How to:

Create an SQL Repository to Store Applications
Create an Application With SQL Content

In addition to using a physical location, the contents of an application folder can also be stored in an SQL database. To use an SQL database, you must first create a new SQL Repository or link to your WebFOCUS Client repository. After the repository is created, you can create applications mapped to the repository and store files there.

Warning: It is advisable to create a separate SQL Connection to use in creating an SQL Repository. If an existing SQL Connection is used, only Server Administrators or users with WSCFG privileges will be able to use the synonyms from this SQL connection in the application. This provides protection for the SQL Repository, preventing unauthorized users (without administrator privileges) from accessing the contents of the SQL Repository through a synonym.

Procedure: How to Create an SQL Repository to Store Applications

You must have an adapter connection configured to an SQL database.

From the Applications page, click Manage, then External Repository, then SQL Repository, and then select Create New.

The Create New SQL Repository page opens, as shown in the following image.
Select a configured adapter from the Adapter drop-down menu.
Select a connection from the Connection drop-down menu.
Enter a prefix in the Prefix field.
Optionally, select the Overwrite existing repository tables and their synonyms check box.
Click OK.

A warning message is displayed, as shown in the following image.
Click OK.
Two SQL Repository catalog tables are created with this connection, as shown in the following image.

The tables are:
```
prefixIOHFILETABLE
```
```
prefixIOHRECORDTABLE
```
Two synonyms describing the catalog tables are also created in EDACONF/catalog/IOH.
Optionally, click Create New Application.

The Create New Application page opens.

Procedure: How to Create an Application With SQL Content

You must have created an SQL Repository.

From the Applications page, click New, then Application Directory.

The Create New Application page opens.
Select a New Application page with the Application Type set for the repository for your DBMS and connection, as shown in the following image.

Note: The choices will include the repository, adapter type, and connection name. In this example, they are the repos repository, Adapter for Hyperstage (PG), and CON01 connection.
Enter or select values for the following parameters:
- Application Name. Accept the default or type a new name.
- Physical location. You can accept the value automatically configured or click the ellipsis (...) to navigate to the location.
- Map to. Select Existing application, New application (directory will be created), or Existing application re-created (all files will be deleted).
- Description. Optionally, enter a description in the corresponding field.
- Add directory to APPPATH. Optionally, deselect the Add directory to APPPATH check box. The application is added to the APPPATH by default.
- Position in APPPATH. Select a position for the application from the Position in APPPATH drop-down menu. The choices are Last or First. The default value is Last.
- Profile. Select a profile from the Profile drop-down menu. For server administrators, the default value is edaprof. For non-administrators, their user profile is the default value.
Click OK.

The application is added to the navigation tree. You can now use this application to store procedures, synonyms, data files, and other content.

Note: Repository procedures can be executed, and Master and Access Files stored in a repository can be accessed, during server, group, and user profile execution after all DBMS connections and an APP MAP command to the repository have been executed.

Linking to Your TIBCO WebFOCUS Client Repository

How to:

Link to an Existing TIBCO WebFOCUS Client Repository
Delete a Link to a TIBCO WebFOCUS Client Repository

You can map an application directory to access your TIBCO WebFOCUS Client Repository.

In order to map an application to your WebFOCUS Client Repository, you must have the WebFOCUS Client REST Adapter configured, as described in the TIBCO WebFOCUS® Adapter Administration manual.

Procedure: How to Link to an Existing TIBCO WebFOCUS Client Repository

From the Applications page, click Manage on the ribbon, then External Repository, then WebFOCUS Client Repository, then Link to Existing.

You can also right-click the Application Directories tree and click Manage, then External Repository, then WebFOCUS Client Repository, then Link to Existing.

The WebFOCUS Client Repository connection page opens, as shown in the following image.
Enter a prefix or accept the default value. The prefix can be any string but, by default, it is set to the machine name running the WebFOCUS Client. This name is derived from the WebFOCUS Client REST Adapter connection.
Click OK.

The New Application pane opens with the Application Type set to map to your WebFOCUS Client REST connection, as shown in the following image.
Enter or select values for the following parameters.
Application Type

Select Application mapping to hostname - WebFOCUS Client REST (CON01)

Application Name

Enter an application name for the mapped repository application, or accept the default name.

Physical location

The default WebFOCUS Repository location will be automatically entered based on your entries on the first connection screen. However, you can click the ellipsis to browse for a location.

Map to
Select one of the following mapping selections.
- Existing application. The Repository directories will be added to an existing application directory.
- New application (directory will be created). A new directory for the WebFOCUS Client Repository files will be created.
- Existing application, recreated (all files will be deleted). An existing application directory will be deleted and recreated with the WebFOCUS Repository files.
Add directory to APPPATH

This check box is selected, by default, so the application will show on the Application Directories tree.

Position in APPPATH

By default, the position is Last. You can select First.

Profile

Select a profile from the drop-down list. The default is edasprof.
Click OK.

The application is added to the Application Directories tree. You can manage WebFOCUS Client Repository files using this application directory.

Procedure: How to Delete a Link to a TIBCO WebFOCUS Client Repository

From the Applications page, click Manage on the ribbon, then External Repository, then WebFOCUS Client Repository, then List and Delete.

You can also right-click the Application Directories tree and click Manage, then External Repository, then WebFOCUS Client Repository, then List and Delete.

A pane opens listing the TIBCO WebFOCUS Client Repositories that are linked as applications.
Right-click a host name in the Prefix column, or click the down arrow in the Prefix column, and click Delete reference to remote repository.

A dialog box opens asking you to confirm that you want to delete the reference.
Click OK.

The application directory will not be deleted, but the reference to the TIBCO WebFOCUS Repository will no longer be available to the server.

Nested Application Directories

How to:

Set the Level of Nested Application Directories
Create a Nested Application Directory

A nested application directory is one created within a higher-level application. The server allows five levels of nested application directories by default. The server must be configured for deeper or unlimited levels.

Nested application directories are implicitly added to the application path if the parent directory is on the application path.

The APP PATH command explicitly places ibisamp on the application path:

APP PATH baseapp ibisamp

However, you can test the path to see all of the implicitly added directories by clicking Manage, then Application Path. When the Application Path page opens, click Test in the Application Path pane:

Application Path page with Test highlighted

The effective application path includes nested applications such as ibisamp/dimensions:

Procedure: How to Set the Level of Nested Application Directories

From the Applications page ribbon, click Manage, then Settings.

The Application Settings pane opens.
Enter the level of nested applications in the nested_app field or select y from the drop-down menu. The default value is 5. Selecting y allows unlimited levels of nested applications.

Note: For z/OS servers, this setting is only applicable to directory-style applications. It is not applicable to PDS-style applications or to applications mapped as a collection of ddnames.
Click the Save and Restart Server button.

After the server restarts, you can create a new application subdirectory by right-clicking an application folder and selecting New and then Application Directory from the context menu.

Note: Nested applications must be in effect in order to create user home application directories. Some other server features also require nested application directories. For example, when you Upload a data file, the file is initially staged in a temporary upload directory under foccache while you make any edits or enhancements needed to the synonym. Tutorials use nested applications as well.

Procedure: How to Create a Nested Application Directory

On the Applications page, right-click an application, click New, and then Application Directory.

The Create New Application Directory page opens.
Enter a name in the Application Name field.
Optionally, enter a description in the Description field.
Click OK.

The nested application is added to the application tree under its parent application folder.

Home Application Directories for Users

How to:

Manage Home Application Directories
Store Home Applications in an SQL Repository

The server administrator can configure the server to allow each user to have a private application directory. This directory is sometimes referred to as myhome, but is actually a directory under the homeapps directory that is named for the connected user ID (~userid). Providing an application directory for each user ID gives each user a directory where he has full control to create, change, and run his applications.

The user application for any user who is not a server administrator appears in two places on the Reporting Server browser interface application tree. Both of these applications point to the same physical location. The two applications are:

Application ~userid (of the connected user), which is prepended to APPPATH.
Application homeapps, which is only available to users registered under the server administrator role, is appended to APPPATH and can be expanded to see the user home application with the user ID name.

Server administrators can see the home directories of all users. Other users can see only their own home directories (labeled as myhome), unless other users share their home directories with them.

The files created in home applications can be referenced in procedures in the following ways:

If you want to use the name myhome as an application name, map the name myhome to the internal variable named &APPMYHOME:
```
APP MAP myhome &APPMYHOME
```
Then, you can use myhome as an app reference, as in the following:
```
EX myhome/fexname
```
You can also use the variable &APPMYHOME as the app reference.

To make this mapping available for all users, you can place it in the edasprof server profile.

Note that the extension (.fex) is optional when executing a procedure.
To run a request in the home directory of a specific user, you need to reference the specific user ID. Also, when a server user is registered, the primary security provider name is prepended to the user ID, and this is reflected in the app reference for a specific user ID.
The syntax includes the security provider name and the user ID, separated by an underscore. For PTH security and user1, issue the following command:
```
EX ~pth_user1/fexname
```
You can use the procedure name with no app reference, as the home directories are automatically on the search path.
```
EX fexname
```
Note that if a procedure with the same name exists in multiple applications, you may not be running the one you want.

The first type of reference can be ported easily to any user. It enables you to create a common application that utilizes data stored in the home applications of users as myhome/data, so that each user can run the same procedure but get a report based on the data stored in the home application of that user.

The second type of reference enables you to run applications specific to a user. This type of reference can be used for testing applications before moving them to common application folders.

Home application directories should be enabled only on secured servers. If the server runs with security OFF, all users have total control of files in all applications, and the home directories will not work as designed. Nested applications must be enabled in order to create user home application directories.

The Server Administrator can monitor and manage home application directories for all users and, therefore, all user home directories are visible and in the path on the Reporting Server browser interface application tree when the connected user has Server Administrator privileges.

When the server is enabled for home applications, user home application directories are not created automatically. Users can create them from the Reporting Server browser interface Application page, or ask their server administrator to create them. The ~userid application will be automatically created for a user on the first attempt to write to it, for example, if the user uploads files to the application.

Home applications can also be stored in an SQL Repository. You must first create an SQL Repository and configure the application settings homeapps parameter to point to the SQL Repository, as described in Managing Applications and Paths.

After a home application directory is created for a user:

The home application is added to the users application path by the server implicitly. A user cannot remove it from the path using APP commands.
The home application directory is always first in the users active application path.
Non-server administrator users will only see their own home application on the Application tree. The server administrator or a user with server administrator privileges will see all user home applications. The server administrator has full privileges to manage user home applications.
The home application directory for each user will contain a file named history.txt that contains a list of recent files opened by the user. By default, the history file contains the 10 most recent files opened by the user. You can change this value. To change the number of recent files, or to disable saving recent files, on the Workspace page under Settings, click FOCUS Sets and Info, then Core Engine Settings. Under APP Service, the setting HISTORY_DEPTH configures the number of files to be kept on the recent files list. The value zero (0) means no history will be kept. You can open the list of recent files by clicking Filter on the Application page ribbon and selecting Recent.

Procedure: How to Manage Home Application Directories

In order to set up home directories for individual users, nested applications must be enabled. They are enabled to five levels by default. The home directory under which user application directories will be created is set during installation. The default is homeapps. The homeapps directory can be changed to a different physical location on the Application Setting page. All user home directories will be nested under the home directory.

From the Applications page, click Manage, then Settings.

The Application Settings pane opens.
Check the location of the homeapps directory. You can set the homeapps parameter to point to a physical directory or to an existing SQL Repository.
Click Save and Restart Server to implement these changes.

When the server restarts, go to the Applications menu. For a user with Server Administrator privileges, a users home folder will appear on the resources tree and will have all of the user home directories.

Users who do not have server administrator privileges can see their home directory under application myhome, which is prepended to APPPATH.

Server administrator users have the myhome application prepended and the homeapps application appended to APPPATH, The homeapps folder can be expanded to show the home applications for all users.

Procedure: How to Store Home Applications in an SQL Repository

You must first create an SQL Repository. For information, see How to Create an SQL Repository to Store Applications.

From the ribbon, click Manage then Settings.

The Application Settings pane opens, as shown in the following image.
Click the selector button (...) next to the homeapps field.

The Select physical location dialog box opens.
Select SQL Repository, as shown in the following image.
Select a subfolder, and click OK.

The subfolder is entered in the homeapps field, as shown in the following image.
Click Save and Restart Server.

Home applications that are created will now be stored in the SQL database.

Configuring the Application Path

How to:

Configure the Application Path
Configure the Application Path in a User, Group, or Role Profile
Edit a Profile

The applications available for inclusion in the search path are identified by name, type, and physical location. If the Add directory to APPPATH check box was selected when the application was created, it was automatically added to the search path. If not, you must explicitly add it to your search path.

Note: You can also create profiles from the Application Path page. Profiles are the locations in which the search path is saved.

Procedure: How to Configure the Application Path

You can configure the Application Path to add or remove applications or mappings from either the Reporting Server browser interface or the Data Migrator desktop interface.

The User Interface for configuring the application path uses a double list.

You configure the application path from the Applications page on the Reporting Server browser interface.

Click Manage on the ribbon, then Application Path.
The Application Path Configuration page opens as a double-list table. The left pane shows a list of all available applications, the right shows all applications in the active Application Path, as shown in the following image.
To add an application to the application path, drag it from the Available Applications list to any position on the Application Path list.
You can move applications up or down on the path by dragging them up or down on the list.
To remove an application from the application path, drag it from the Application Path list to the Available Applications list.
When you have finished, Click Save.

On both lists, you can

Search for applications using the Search.
Customize the columns displayed, or reset the display to its default, using the View icon.

On the Application Path menu bar, you can:

Click Switch Profile to open the Application Path Configuration - Select Profile dialog box and select a different profile from the drop-down list.
Click Preview to preview the commands in the selected profile
Click the Test button to view the APP PATH command and the effective application path.

The navigation pane is updated.

Note: You can create a new profile from the Application Path Configuration - Select Profile dialog box.

Procedure: How to Configure the Application Path in a User, Group, or Role Profile

The Application Path can be configured from either the Reporting Server browser interface or the Data Migrator desktop interface.

From the Applications page, click Mange, then Application Path.

The Application Path page opens.
From the Profile drop-down menu, select New Profile.
Enter a name in the New Profile Name field and click OK.
Select an option from the Change Profile Precedence drop-down list on the menu bar.
The options are:
- Inherit from previously executed profiles
- Override previously executed profiles
- Prepend previously executed profiles
- Append to previously executed profiles
Optionally, click Preview to see the profile.
Click Save.

Procedure: How to Edit a Profile

Go to the Workspace page.
On the navigation pane, open the Configuration Files and User/Group Profiles folders.
Right-click the profile and select Edit.

The profile opens in a text editor with its current path displayed.
Edit the path information and click the Save icon.

Tip: You can also edit a profile search path by selecting and saving configuration options. Follow instructions for configuring the application path.

Filtering the Application Tree

How to:

Filter Items on the Application Tree

Filtering enables you to customize the file listings on the Application tree, displaying only the files you choose. It can be based on file name, location, statistics, type, or any combination of items matching a number of criteria.

Procedure: How to Filter Items on the Application Tree

You can customize the items that display on the Application Tree by filtering. Your filtering selections apply to all applications displayed in the navigation pane.

Go to the Applications page.
Click Filter, and select Procedures, Synonyms, or Advanced.
1. If you choose Procedures, you can display all procedures or only scheduled ones.
2. If you choose Synonyms, you can display all synonyms or only cluster or business views.
3. If you choose Advanced, The Filter Applications Tree page opens.
  
  Using the File Name section, you can filter by name, extension, description and content, as shown in the following image. To filter the name, you can use the percent sign (%) as a wildcard character. Specifying e% displays all files whose name begins with the letter e.
  
  Using the File Statistics section, you can filter by file size and modified date, as shown in the following image.
  
  Using the File Type section, you can filter by type of file to be included.
  
  When you are finished, click Set Filter. The Filter Status page confirms that the filter was set.
  
  You can click Clear Filter to clear the filter.
4. If you choose Impact Analysis, you can run reports showing synonyms by procedures, procedures by synonyms, columns by procedures, or procedures by columns.
5. If you choose Recent, you can see the list of files you opened recently (stored in history.txt in your myhome application).
6. If you choose Favorites, you can see a list of the files you added to your favorites.

When a filter is applied, the Application Directories tree label includes (Filtered).

Note: You can remove the filter by clicking Clear on the Filter menu.

Searching for Files

How to:

Search for Files

The Search tool on the Files page provides a search function on the Application Tree.

Procedure: How to Search for Files

The Search tool provides a text box for entering search criteria.

Go to the Applications page.
Enter a search term in the Search text box in either the navigation pane or the files pane.
Click the Search button.

The list is filtered to show the objects matching the search term, with the search term highlighted.

Sorting the Application Tree

How to:

Sort an Application Directory

Sorting enables you to change the order in which items are listed in an application directory.

Procedure: How to Sort an Application Directory

Go to the Applications page.
Open an application directory in the file panel and click a column title.

The page is sorted in descending order of the values in that column and a down arrow displays. Click again to sort in ascending order. The arrow changes to an up arrow. Click again to return to the original order. The arrow no longer displays.

Selecting Application Files

How to:

Copy, Cut, Paste, and Delete Application Files
Refresh Synonyms in an Application

You can copy and paste files between applications, delete them from applications, and refresh synonyms in applications. You can also copy, move, or delete subfolders from one application to another. The subfolders will be copied, moved, or deleted with all of their files and all of their own subfolders.

Procedure: How to Copy, Cut, Paste, and Delete Application Files

Go to the Applications page.
Click an application folder to open it in the file panel.
On the file panel, you can select one or more files.

To select contiguous files, click the first file, hold Shift, and click the last file.

To select discontiguous files, hold Ctrl, and continue clicking the files you want to select.
Right-click the selected files, and click Copy, Cut, or Delete.
To paste copied or cut files into another application folder, right-click the application folder and click Paste.

The file(s) are pasted to the selected application.

Procedure: How to Refresh Synonyms in an Application

Go to the Applications page.
Right-click an application folder, point to Metadata Management, and click Refresh.

The Update Synonyms page opens. You can select the attributes to update. Certain attributes, such as keys, indexes, and formats are selected by default.
When you have made your selections, click Next.

A status page opens that reports the result of the update request.