Defining Resource Bundles
Deployment Manager lets you organize site resources into one or more resource bundles and then deploy the resources in a bundle as a unified set. For each resource or resource bundle, you can also choose to include dependencies. These topics describe how to work with resource bundles:
Creating a Resource Bundle
A resource bundle contains a collection of resources like views, procedures, tables, data sources, and their containers. Resource bundles allow you to migrate resources as a group to another TDV when you execute a deployment. You need to first add a resource bundle and then add the site resources to it.
You can add entire containers (folders) of resources or individual resources to a bundle, but there are some limitations.
Limitations for bundle resources:
• A resource bundle can contain resources from only one TDV site.
• You can migrate only one resource bundle per deployment plan.
• Resources do not need to be locked.
• You can add an entire data source but you cannot add only a single table or file from a data source.
To add a resource bundle
1. Click SITES.
2. Select a site.
3. On the Resource Bundles tab, click the + symbol at the bottom of the Bundle Definitions pane to Add Resource Bundle.
4. Type a name for your new bundle. Bundle names can contain letters, numbers, and underscores.
5. Optionally, enter a description of the bundle contents in the Annotation field.
6. Click Add Bundle.
You should see your newly added bundle in the Bundle Definitions panel.
You can now add resources to the bundle as described in
Adding Resources to a Bundle.
Adding Resources to a Bundle
To add resources to a bundle
1. Open the Resource Bundles tab.
2. If necessary, click Refresh at the bottom of the Available Resources panel to make sure the Available Resources list is up-to-date.
3. Add resources to a bundle. The Available Resources pane contains all resources in the site that can be added to the resource bundles. You can:
From Available Resources... | Description |
Select and drag a container | All of the objects beneath it are moved to the bundle. |
Select and drag a specific resource | Only the resource is moved to the bundle. |
Select an available resource or container | Click Add Resources to, then choose the bundle to which you want to add the resources. |
Notes:
— Do not add duplicate resources. If you add duplicate resources, the bundle will become impacted.
This example shows two resource bundles; one has a container with many resources in it and the other has a single resource:
N
Note: The number of resources in the bundle is shown next to the bundle name. This number includes both explicitly added resources and dependent resources. Dependent resources are not displayed under the bundle but are displayed in the preview. See
Previewing the Resources in a Bundle.
4. Optionally, perform these operations to review and customize the bundles for your deployment:
Excluding and Including Resources in a Bundle
By default, when you explicitly add a resource or resource container to a bundle, all resources are included. You might want to exclude some of them, or include some that are contained in a resource that you excluded. Excluding a resource does not mean that the resource is deleted from the bundle; it means that it will not be migrated with the bundle in a plan.
These rules apply when excluding resources:
You can exclude... | You cannot exclude... |
Resources in a folder including:
- data sources
- views
- procedures
- models
...and so on | A root folder in the bundle |
A resource at the root of the bundle |
A schema, table, or element within a data source. |
If you exclude a resource on which another included resource is dependent, that resource is still included. The exception to this is if you set the dependency option to No. See
Setting Resource Dependencies.
While editing the resource bundles, you can also perform these tasks:
To exclude and include resources in a bundle
1. Open the Resource Bundles tab.
3. In Bundle Definitions, expand the folder that contains the resources to be excluded.
4. Select one or more resources.
Note: You can use Ctrl-click and Shift-click to select multiple resources at one time to exclude.
5. Click Exclude.
Deployment Manager displays an excluded resource in dimmed text as shown in this example.
6. Optionally, to include a resource that has been excluded, select the excluded resource and click Include.
After you have finished excluding resources, you can preview the bundle to see what resources would be migrated with this bundle (see
Previewing the Resources in a Bundle). Only included resources and their dependencies (depending on the Inherit setting) are included in the preview.
Previewing the Resources in a Bundle
The Bundle Definitions pane shows the bundle definition: the bundles, the resources or resource containers that have been directly added to the bundle, and the resources that are excluded from the bundle, if any. A bundle preview lets you see only the resources that will be migrated with the bundle at plan execution time. The bundle preview shows the included resources and their dependencies in blue text as shown in this example:
Inclusion of the dependent resources with a bundle is determined by the bundle and resource Include Dependencies properties. To see how you can choose whether or not to include the dependent resources with a bundle, see
Setting Resource Dependencies.
To preview the resources in a bundle
1. Open the Resource Bundles tab.
2. Under Bundle Definitions, click Refresh to make sure that the resources are up-to-date.
3. Select a bundle.
4. Click Preview.
5. If necessary, expand the directories to view the bundle resources.
6. Click OK to close the preview.
Viewing the Details of a Resource
All of the objects displayed for available resources and resource bundles have properties that can be viewed and in some cases, edited.
To view details of the available and resource bundle resources
1. Click SITES.
2. Select a site.
3. On the Resource Bundles tab, select any object under Available Resources or Bundle Definitions.
4. Under Property View, review the details in the fields for the selected item. The properties vary depending on the object type selected:
Available Resource Properties | Bundle Definition Object | Properties |
Name
Path
Type
Orig Creation Date
Owner
Last Modified Date
Last Modified User | Bundle | Name
Annotation
Include Dependencies
Orig Creation Date
Owner
Last Modified Date
Last Modified User |
Root folder | Name
Path
Type
Include Dependencies |
Folders and resources | Notice if excluded
Name
Path
Type |
Note: Properties in bold can be edited.
5. Optionally, edit the Name, Annotation, or dependencies setting for the object.
Setting Resource Dependencies
Dependencies can be specified on a bundle level or the level just below the bundle which can be a container or a resource. By default, all resources added directly to a bundle, which can be a container or a resource, have the same dependencies as the bundle. However, you can override the dependencies settings for a bundle or any container or resource added at the root level in the bundle.
To set resource dependencies
1. Click SITES.
2. Select a site.
3. Select the Resource Bundles tab.
4. In Bundle Definitions, select a resource bundle or a container or resource at the root level of a bundle.
5. In the Property View column, select the Include Dependencies setting:
Option | Description |
Yes | Include dependencies for this resource. This is the default for bundles. |
No | Do not include dependencies for this resource. |
Inherit (resource or folder only) | Defer to the bundle’s dependency setting. This is the default for containers and resources in bundles. |
Copying a Resource Bundle
You can create a duplicate resource bundle that you can use as a starting point for another resource bundle, for example.
To copy a resource bundle
1. Click SITES.
2. Select a site.
3. Select the Resource Bundles tab.
4. In Bundle Definitions, select a resource bundle.
5. Click the Copy Bundle button.
Deployment Manager creates a duplicate bundle and appends “_copy” to the bundle name.
6. Optionally, under Property View, rename the bundle.
Removing Resources from a Resource Bundle
You can remove a resource container (including its resources) or a resource at the root of a bundle using the steps below. The resources are still listed under Available Resources and can be reinserted.
To remove a resource from a resource bundle
1. Click SITES.
2. Select a site.
3. Select the Resource Bundles tab.
4. Select a container or a resource in a resource bundle.
5. Click Remove.
Deleting a Resource Bundle
To delete a resource bundle
1. Click SITES.
2. Select a site.
3. Select the Resource Bundles tab.
4. Select a resource bundle.
5. Click the Delete Bundle button.
6. Click Yes to confirm that you want to delete this bundle.
