File Catalog

The File Catalog (available for package-based projects only) represents an inventory of files, which may be assembled into packages, built, and deployed to one or more environments.  The items in the catalog contain metadata, differing for each project type.  If using source control for the project, the items are automatically discovered into the catalog. For some project types, the items are discoverable from the underlying source system (e.g. a development repository).  The files represent metadata only, as the referenced source file is pulled from source control or the source system during the build.

For project types where the catalog files are not discoverable, you can create the metadata manually.  This provides FlexDeploy with the information necessary to pull the source file during the build.  For some project types (such as Oracle EBS) you can have a combination of files discovered from source control and files whose metadata is provided manually.

Discovering Project Files

When you first create a Package-based project, the File Catalog will be empty. Before discovering Files, make sure you have updated the Project Properties.

You can discover files from within a package, or in the File Catalog.

Using the Discover button

When you click the Discover button, the following screen will pop up.

Click Discover once the form is filled out correctly. Depending on how many files you have, this operation can take several minutes.

The discover operation will iterate through each of the SCM Projects Sources you have configured. Based on your properties, the discover operation will complete the configuration required for each file based on its object type.

Once it is complete, you will see the files listed by object type with all the default configuration.

FlexDeploy allows for custom sorting of all files when performing Populate from SCM action. This allows for sorting files as per FD_ORDER.seq file in root of your project. Just add full file as it shows on screen File Name (with Path) in this file in custom order. You just need to add the files that need to be ordered and not all files.

Also, in case of EBS (DB Objects) / JDBC plugins sorting is based on project properties for extension based ordering. For example, if new .tbl file is discovered from SCM, then this helps you arrange it appropriately in DB Objects for EBS project.

For example, FD_ORDER.seq may look like this.



Adding files using the Create button

Some project types allow creating files manually. When you click the Create button, the following screen will pop up.


Enter the File Name (with Path) as indicated above, then click the Evaluate button. Based on the rules for that object type and configured project properties, the remaining fields will populate. These fields will vary based on the plugin and object type. Optionally, you can adjust the configuration based on you requirements. In the example above, if you adjust the Target Location and click the Evaluate button again, all fields except Target Location will be reevaluated and Deploy Command will reflect manual change done on Target Location.

Updating Project Files

You can modify the files in your project in the Package Files tab of a package, or in the File Catalog.

Click on a file path to edit the file.

Each type of file will have different options.

When you modify a field on this screen, the lock icon on the left will be checked. When you select the Evaluate button it will evaluate all the unlocked fields. If the lock is selected, the value is retained as entered.

Once you are finished, click the Save button to accept your changes or the Cancel button to cancel them.

Editing Multiple Files

You can select one or more files in order to either Inactivate, Activate, Move to a different Object Type, or Evaluate the file attributes.

If you are evaluating multiple files and at least one of them is setup with SCM as Source, you may see a popup asking to select a Branch to use during evaluation. FlexDeploy may use file content during evaluation process to default various attributes, so this can be crucial if the file is only present in a specific branch.

If inactive files are selected, the Evaluate and Update Type operations will be unavailable.

The following macros are not currently supported in the footer:
  • style