Export Rule Sets
Most objects can be promoted to previously configured remote systems or exported as CAR files, both from within the user interface. CAR files can later be imported with the process definition System_Import_Archive or from the command line. To customize your imports and exports, you can specify rule sets. Import and export rule sets allow you to organize the promotion flow between Development, Test (Quality Assurance), and Production systems.
Export rule sets provide two ways of selecting which objects are to be exported:
- Export Rules - dynamic list according to criteria, much like object filters
- Export Lists - static list; search for objects according to various criteria (object type with optional name pattern or last modification date) and add them to the list
Export rules are dynamic, so even new objects that are created and fulfil the criteria are included in the export. Export lists are static; you use the queries to locate the objects to include in the list.
Use the Preview tab to get a list of objects that are going to be exported with the current settings. Once you are satisfied with the list of objects, you can save the rule set.
Tabs & Fields
The following sections cover the tabs in the Export Rule Set editor screen.
Export Rule Set
| Field | Description |
|---|---|
| Partition | The partition of the export rule set. |
| Name | The name of the export rule set must start with a letter, can only contain US ASCII letters, numbers, and underscores (_); limited to 80 characters. |
| Application | The application of the export rule set. Applications are used to group different objects for easy migration. |
| Description | The description of the export rule set. Free-form text, any printable UTF-8 character combination is allowed; note that depending on the platform/browser, some characters of the symbol and other Unicode tables will not be displayable. Limited to 255 characters. |
Export Rules
Export rule sets can hold one or more export rules. When you create an export, you may specify an export rule set according to which objects are exported from the central Redwood Server.
| Field | Description |
|---|---|
| Name | The name of the rule; must start with a letter, can only contain US ASCII letters, numbers, and underscores (_); limited to 80 characters. |
| Description | The description of the rule will be used as the name of the rule when set. Free-form text, any printable UTF-8 character combination is allowed; note that depending on the platform/browser, some characters of the symbol and other Unicode tables will not be displayable. Limited to 255 characters. |
| Documentation | A comment about the rule. Free-form text, any printable UTF-8 character combination is allowed; note that depending on the platform/browser, some characters of the symbol and other Unicode tables will not be displayable. Limited to 255 characters. Limited to 1000 characters. |
| Object Type | Rules can be created for a number of object types, for each rule, an object-sensitive filter will be displayed. By default, all objects of the type that are not part of the system will be exported. |
Export List
The Export List tab allows you to easily create a static set of objects to export. You set a number of rules, select the objects to be exported and add them to the list of exported objects.
| Field | Description |
|---|---|
| Where the object of type | The type of object you wish to export |
| Where the object was changed after [...] and before [...] by user ...[] | Instead of specifying an object type, you may specify modification dates and the user who modified the objects for displaying a list to choose from. |
| List of Objects | The list of objects that fulfill the specified criteria |
| Objects to Export | The list of objects that have been added to the export rule set. |
Context-Menu
Export rule sets support the following context-menu actions:
| Action | Description |
|---|---|
| Submit Export Job | Submits an export process with the current export rule set |
| Edit Security | Edit the security of the export rule set |
| Duplicate | Make a copy of the export rule set to create a similar one |
| Delete | Delete the export rule set |
| Export > Export | Export the export rule set into a CAR file |
| Export > Export with related objects | Export the export rule set into a CAR file including referenced objects |
| Promote > Promote to system | Promote the object to a remote system |
| Promote > Edit further then promote | Edit the export rule set prior to promoting |
| Promote | Promote the export rule set to another Redwood Server instance |
| Edit | Edit the export rule set |
| Show permalinks | Show links that can be used from third party applications to link to the object |
| Add to navigation bar | Add the current object to the navigation bar |
| New | Create a new export rule set |
| Filter > New Filter | Create a new export rule set filter |
| Filter > Edit Filter | Edit current export rule set filter |
| Filter > Delete | Delete current export rule set filter |
| Filter > Duplicate Filter | Create a copy of the filter |
| Filter > Export Filter | Export the filter into a CAR file |
| Filter > Add to navigation bar | Add the filter to a navigation bar |
| Filter > Create filter from search | Create a filter from the current IntelliSearch query |
Finding Export Rule Sets
You can search for export rule sets using filters in Search Export Rule Sets box, known as the IntelliSearch box, located under your username on the top right-hand side of the user interface. Filters allow you to specify a list of objects with static criteria. IntelliSearch allows you to specify complex queries in a simple way using prefixes. Prefixes are used to specify which property you are searching in and have short as well as long syntaxes. For example, if you want to display all export rule sets with the term dev in the comment, you would use the search criteria as follows:
c:dev
You can search more than one property, as follows:
c:dev n:ORA
note
No spaces should be entered before or after the colon (: ).
See the Advanced Object Search for more information.
The following table illustrates the available prefixes for import and export rule sets:
| Prefixes | Description |
|---|---|
| n, name | searches the name property |
| c, comm, comment | searches the documentation property |
| d, desc, description | searches the description property |
| a, application | searches the application property |
| cb, changedbefore | (internal) search for export rule sets that changed before a certain ISO-8601 period |
Export Rule Sets
Export rules define which objects get exported into CAR archives. You can match one or more objects to be transported from one system into another seamlessly. Export rule sets can hold one or more export rules. There is no need to exclude built-in objects, as they cannot be exported and will be discarded. Always use the Preview tab to check which objects match your criteria.
note
Built-in objects cannot be exported, as such, any built-in object that matches a pattern will be discarded from the export.
note
The Promotion Module requires the Module.ImportExport license key
Security
| Privilege | Description |
|---|---|
| ExportRuleSet.Create | Create export rule sets |
| ExportRuleSet.Delete | Delete export rule sets |
| ExportRuleSet.Edit | Edit export rule sets |
| ExportRuleSet.View | Access export rule sets |
You can grant privileges on two levels, Access and Admin; a privilege granted on Admin level allows the grantee to grant the privilege to other users. These privileges can be granted per partition or system-wide.
The Security tab allows you to specify which users can access, edit, and delete the object.
See Also
- Migrating Objects with the Promotion Module
- Creating Export Rule Sets
- Exporting Redwood Server Objects
- Importing Redwood Server Objects
- Promoting Objects with Remote Systems
ExportRuleSet export rule set