Deployment configuration files
The deployment configuration files are XML files that are populated with data that is required to deploy an application. This data includes configuration data, data for object store, service, security principal, and connection point mappings, and data about the source and destination for the deployment. Examples of these files include the environment configuration files, half maps, data maps, and source-destination pair files.
When you work with the FileNet® Deployment Manager graphical user interface to complete migration and deployment actions, the deployment configuration files are created as part of that process. These files are saved in the deployment tree.
If you work with the command-line interface to complete migration and deployment actions, you also need to use the deployment configuration files as input to those actions. The recommended method to access and customize deployment configuration files is to generate the sample files and then customize the sample deployment configuration files. When you generate the sample files from the command-line interface, the sample files are saved in the Samples folder in the current working directory. For more information about generating the sample files, see Creating sample files for FileNet Deployment Manager.
The following descriptions provide more information about some example deployment configuration files. See the sample files for additional information.
Object store half map file
Each <Item> element in the list of items references an object store. The <Item> element
contains attributes and child elements:
- label
- The user-defined label attribute for the Item element. When you use FileNet Deployment Manager to merge two half maps as part of a data map creation operation, this item is paired with an item that has the same label value in the other half map. For items with zero-length labels, the pairing occurs based on the display name (<Name> element).
- ID
- The GUID that uniquely identifies the object store.
- Name
- The display name that is assigned to the object store.
- SymbolicName
- The symbolic name that is assigned to the object store.
Example HalfMap_ObjectStore.xml file
<?xml version="1.0" encoding="UTF-8"?>
<HalfMap type="ObjectStore" version="1">
<List>
<Item label="os1">
<ID>{4CF782C5-93DA-4F3F-BAF7-B7C0A6444D98}</ID>
<Name>ccv01249os1</Name>
<SymbolicName>ccv01249os1</SymbolicName>
<StoragePolicyList>
<StoragePolicyItem label="default">
<ID>{0AD4E81D-C997-4D97-9B81-775320BD22E5}</ID>
<DisplayName>Default Database Storage Policy</DisplayName>
</StoragePolicyItem>
<StoragePolicyItem label="hitachi">
<ID>{1DC462F6-C662-4A6F-A26B-35A235C01219}</ID>
<DisplayName>HitachiSA_sp</DisplayName>
</StoragePolicyItem>
</StoragePolicyList>
<StorageAreaList>
<StorageAreaItem label="default">
<ID>{33EB0882-397C-4CCA-826F-446C2C813FCB}</ID>
<DisplayName>Default Database Storage Area</DisplayName>
</StorageAreaItem>
<StorageAreaItem label="hitachi">
<ID>{F2B652F8-9CE2-4877-92D0-B605F172FB4C}</ID>
<DisplayName>HitachiSA</DisplayName>
</StorageAreaItem>
</StorageAreaList>
</Item>
</List>
</HalfMap>Security principal half map file
Each <Item> element in the list of items references a security principal. The <Item>
element contains attributes and child elements:
- label
- The user-defined label attribute for the <Item> element. When you use FileNet Deployment Manager to map two half maps together as part of a data map creation operation, this item is paired with an item that has the same label value in the other half map. For items with zero-length labels, FileNet Deployment Manager attempts to match the items that are based on the other element values.
- SID
- The security ID (SID) that uniquely identifies the security principal.
- ShortName
- The short (login) name that is assigned to the security principal.
- DisplayName
- The display name that is assigned to the security principal.
- PrincipalType
- Indicates whether the security principal is a single user (User) or a group (Group).
- Name
- Depending on the LDAP server that is employed, this LDAP value can be either a distinguished name or a user security principal name. By default, the user security principal name is used for Active Directory and the distinguished name is used for Novell eDirectory.
Example HalfMap_Principal.xml file
<HalfMap type="Principal" version="1">
<List>
<Item label="Admin">
<SID>S-1-5-21-1905461388-4280881285-1333276535-500</SID>
<ShortName>Administrator</ShortName>
<DisplayName>Administrator</DisplayName>
<PrincipalType>0</PrincipalType>
<Name>Administrator@rmbeach.filenet.com</Name>
</Item>
<Item label="FNAdmin">
<SID>S-1-5-21-1905461388-4280881285-1333276535-1119</SID>
<ShortName>FN Admins</ShortName>
<DisplayName>FN Admins</DisplayName>
<PrincipalType>1</PrincipalType>
<Name>FN Admins@rmbeach.filenet.com</Name>
</Item>
<Item label="Manager">
<SID>S-1-5-21-1905461388-4280881285-1333276535-1120</SID>
<ShortName>FN Managers</ShortName>
<DisplayName>FN Managers</DisplayName>
<PrincipalType>1</PrincipalType>
<Name>FN Managers@rmbeach.filenet.com</Name>
</Item>
<Item label="P8Admin">
<SID>S-1-5-21-1905461388-4280881285-1333276535-1614</SID>
<ShortName>p8admin</ShortName>
<DisplayName>p8admin</DisplayName>
<PrincipalType>0</PrincipalType>
<Name>p8admin@rmbeach.filenet.com</Name>
</Item>
</List>
</HalfMap>Service half map file
Each <Item> element in the list of items references a service. The <Item> element contains
attributes and child elements:
- type
- The item element attribute that identifies the type of the service. When you use FileNet Deployment Manager to merge two half maps as part of a data map creation operation, this item is paired with an item that has the same service type value in the other half map. Each service type corresponds to a separate tab in the service half map editor.
- label
- The user-defined label attribute for the item element. When you use FileNet Deployment Manager to merge two half maps as part of a data map creation operation, this item is paired with an item that has the same label value in the other half map. For items with zero-length labels, the pairing occurs based on name.
- Name
- Identifies the name of the service.
The following service types are currently defined, shown with their required elements:
| Item type attribute | Element | Element Description |
|---|---|---|
| PESystemAdministration_F_WebServer | Name | The name that is assigned to the web server used for system administration. |
| URL | The URL that is assigned to the system administration web server. | |
| PESystemConfiguration_F_WebServer | Name | The name that is assigned to the web server used for system configuration. |
| URL | The URL that is assigned to the system configuration web server. | |
| PEPartnerLink | Name | The name of the web services partner link that is referenced in a workflow definition. |
| URL | The URL that specifies the partner link. | |
| PESystemConfiguration_F_UDDIRegistries | Name | The name that is assigned to the Universal Description, Discovery, and Integration (UDDI) Registries service. |
| inquiryURL | The URL that is used for inquiries to the specified UDDI Registries name. | |
| publishURL | The URL that is used for publishing to the specified UDDI Registries name. | |
| PESystemConfiguration_F_WSRRRegistries | Name | The name that is assigned to the IBM® WebSphere® Service Registry and Repository service (WSRR) that is used by the system. This name identifies the listing of IBM WebSphere Service Registry and Repository service registries that are available. |
| serverName | The name of the server that hosts the WebSphere Service Registry and Repository service. | |
| port | The port on the specified server that is assigned to the WebSphere Service Registry and Repository service. | |
| PEUserInfo | Name | The name of the user that is assigned access to the workflow. |
| EmailAddress | The email address that is assigned to the specified user. | |
| EFormHTTP | Name | The name that is assigned to the HTTP service for IBM FileNet eForms. |
| URL | The URL assigned to the specified eForms HTTP server. | |
| EFormJDBC | Name | The name that is assigned to this Java™ Database Connectivity (JDBC) service for eForms. |
| Server | The name of the database that hosts the JDBC service. | |
| UserID | The user name credential that is used for database access through JDBC. | |
| Password | The database password that is assigned to the specified user
ID. Restriction: You cannot edit passwords that are embedded
in eForms form templates
with FileNet Deployment Manager. Therefore,
in the deployment of form templates from source to destination environments,
form template passwords remain unconverted. You must manually edit
the form template passwords in the destination environment if you
want to change them. If you want to convert embedded passwords with FileNet Deployment Manager, you must first disable
the FIPS 140-ready mode and enter new passwords for the target service
data.
|
|
| Driver | The fully qualified path name for the JDBC driver that is used for database access. | |
| EFormODBC | Name | The name that is assigned to this ODBC service for eForms. |
| URL | The URL that is assigned to the eForms ODBC service. |
Example HalfMap_Service.xml file
<?xml version="1.0" encoding="UTF-8"?>
<HalfMap version="1" type="Service">
<List>
<Item label="" type="F_WebServer">
<Name>F_WebServer.1</Name>
<URL>http://localhost:9081/WorkplaceXT</URL>
</Item>
<Item label="" type="PartnerLink">
<Name>PartnerLink.1</Name>
<URL>http://localhost:8080/dashboard</URL>
</Item>
</List>
</HalfMap>Object store data map file
Each <MapItem> element in the list of map items contains <Source> and <Destination>
elements that reference the respective source and destination object stores. Each object store is
identified by the following <Source> or <Destination> attributes and child elements:
- label
- The source or destination user-defined label for the map item. When you use FileNet Deployment Manager to map two half maps together, the source that has the label is paired with the destination that has the same label value in the other half map. For items with zero-length labels, the pairing occurs based on the value of the Name element.
- ID
- The GUID that uniquely identifies the object store.
- Name
- The display name that is assigned to the object store.
- SymbolicName
- The symbolic name that is assigned to the object store.
Example DataMap_ObjectStore.xml file
<?xml version="1.0" encoding="UTF-8"?>
<DataMap version="1" type="ObjectStore">
<List>
<MapItem>
<Source label="1">
<ID>{4CF782C5-93DA-4F3F-BAF7-B7C0A6444D98}</ID>
<Name>ccv01249os1</Name>
<SymbolicName>ccv01249os1</SymbolicName>
</Source>
<Destination label="1">
<ID>{3BB672FE-8158-40BE-8E0A-ABB8688C03CE}</ID>
<Name>1251OS1</Name>
<SymbolicName>OS1</SymbolicName>
</Destination>
<StoragePolicyList>
<StoragePolicyItem>
<Source label="def">
<ID>{0AD4E81D-C997-4D97-9B81-775320BD22E5}</ID>
<DisplayName>Default Database Storage Policy</DisplayName>
</Source>
<Destination label="def">
<ID>{60C58772-6F71-4835-8C71-064BF5AB4E46}</ID>
<DisplayName>Default Database Storage Policy</DisplayName>
</Destination>
</StoragePolicyItem>
<StoragePolicyItem>
<Source label="hit">
<ID>{1DC462F6-C662-4A6F-A26B-35A235C01219}</ID>
<DisplayName>HitachiSA_sp</DisplayName>
</Source>
<Destination label="hit">
<ID>{9D99DACF-2FB0-4020-BB2F-6FECF40B5E48}</ID>
<DisplayName>Hitachi FCD_sp</DisplayName>
</Destination>
</StoragePolicyItem>
</StoragePolicyList>
<StorageAreaList>
<StorageAreaItem>
<Source label="hit">
<ID>{33EB0882-397C-4CCA-826F-446C2C813FCB}</ID>
<DisplayName>Default Database Storage Area</DisplayName>
</Source>
<Destination label="hit">
<ID>{16C6CE17-2409-492D-BF4C-0104A11CBC94}</ID>
<DisplayName>testSA51</DisplayName>
</Destination>
</StorageAreaItem>
<StorageAreaItem>
<Source label="testSA51">
<ID>{F2B652F8-9CE2-4877-92D0-B605F172FB4C}</ID>
<DisplayName>HitachiSA</DisplayName>
</Source>
<Destination label="testSA51">
<ID>{16C6CE17-2409-492D-BF4C-0104A11CBC94}</ID>
<DisplayName>testSA51</DisplayName>
</Destination>
</StorageAreaItem>
</StorageAreaList>
</MapItem>
</List>
</DataMap>Security principal data map file
Each <MapItem> element in the list of map items contains <Source> and <Destination>
elements that reference the respective source and destination security principals. Each security
principal is identified by the following <Source> or <Destination> attributes and child elements:
- label
- The source or destination user-defined label for the map item. When you use FileNet Deployment Manager to merge two half maps, the source that has the label is paired with the destination that has the same label value in the other half map. For items with zero-length labels, FileNet Deployment Manager attempts to match the items that are based on the other element values.
- SID
- The security ID (SID) that uniquely identifies the security principal.
- ShortName
- The short (login) name that is assigned to the security principal.
- DisplayName
- The display name that is assigned to the security principal.
- PrincipalType
- Indicates whether the security principal is a single user (User) or a group (Group).
- Name
- Depending on the LDAP server that is used, this LDAP value can be either a distinguished name or a user security principal name. By default, the user security principal name that is used for Active Directory and the distinguished name that is used for Novell eDirectory.
Example DataMap_Principal.xml file
<?xml version="1.0" encoding="UTF-8"?>
<DataMap version="1" type="Principal">
<List>
<MapItem>
<Source label="">
<SID>S-1-5-21-1905461388-4280881285-1333276535-1119</SID>
<ShortName>FN Admins</ShortName>
<DisplayName>FN Admins</DisplayName>
<PrincipalType>1</PrincipalType>
<Name>FN Admins@rmbeach.filenet.com</Name>
</Source>
<Destination label="">
<SID>S-1-5-21-1905461388-4280881285-1333276535-1119</SID>
<ShortName>FN Admins</ShortName>
<DisplayName>FN Admins</DisplayName>
<PrincipalType>1</PrincipalType>
<Name>FN Admins@rmbeach.filenet.com</Name>
</Destination>
</MapItem>
<MapItem>
<Source label="">
<SID>S-1-5-21-1905461388-4280881285-1333276535-1120</SID>
<ShortName>Managers</ShortName>
<DisplayName>Managers</DisplayName>
<PrincipalType>1</PrincipalType>
<Name>RM Managers@rmbeach.filenet.com</Name>
</Source>
<Destination label="">
<SID>S-1-5-21-1905461388-4280881285-1333276535-1120</SID>
<ShortName>Managers</ShortName>
<DisplayName>Managers</DisplayName>
<PrincipalType>1</PrincipalType>
<Name>RM Managers@rmbeach.filenet.com</Name>
</Destination>
</MapItem>
<MapItem>
<Source label="">
<SID>S-1-5-21-1905461388-4280881285-1333276535-500</SID>
<ShortName>Administrator</ShortName>
<DisplayName>Administrator</DisplayName>
<PrincipalType>0</PrincipalType>
<Name>Administrator@rmbeach.filenet.com</Name>
</Source>
<Destination label="">
<SID>S-1-5-21-1905461388-4280881285-1333276535-500</SID>
<ShortName>Administrator</ShortName>
<DisplayName>Administrator</DisplayName>
<PrincipalType>0</PrincipalType>
<Name>Administrator@rmbeach.filenet.com</Name>
</Destination>
</MapItem>
<MapItem>
<Source label="">
<SID>S-1-5-21-1905461388-4280881285-1333276535-1614</SID>
<ShortName>p8admin</ShortName>
<DisplayName>p8admin</DisplayName>
<PrincipalType>0</PrincipalType>
<Name>p8admin@rmbeach.filenet.com</Name>
</Source>
<Destination label="">
<SID>S-1-5-21-1905461388-4280881285-1333276535-1614</SID>
<ShortName>p8admin</ShortName>
<DisplayName>p8admin</DisplayName>
<PrincipalType>0</PrincipalType>
<Name>p8admin@rmbeach.filenet.com</Name>
</Destination>
</MapItem>
</List>
</DataMap>Service data map file
Each <MapItem> element in the list of map items contains <Source> and <Destination>
elements that reference the respective source and destination services. Each service half map item
is identified by the following attributes:
- type
- The Item element attribute that identifies the type of the service. When you use FileNet Deployment Manager to merge two half maps as part of a data map creation operation, this item is paired with an item that has the same service type value in the other half map. Each service type corresponds to a separate tab in the service half map editor.
- label
- The source or destination user-defined label for the map item. When you use FileNet Deployment Manager to merge two half maps as part of a data map creation operation, this item is paired with an item that has the same label value in the other half map. For items with zero-length labels, the pairing occurs based on Name.
- Name
- Identifies the name of the service.
The following service types are currently defined, shown with their required elements:
| Item type attribute | Element | Element Description |
|---|---|---|
| PESystemAdministration_F_WebServer | Name | The name that is assigned to the web server used for system administration. |
| URL | The URL that is assigned to the system administration web server. | |
| PESystemConfiguration_F_WebServer | Name | The name that is assigned to the web server used for system configuration. |
| URL | The URL name that is assigned to the system configuration web server. | |
| PEPartnerLink | Name | The name of the web services partner link that is referenced in a workflow definition. |
| URL | The URL that specifies the partner link. | |
| PESystemConfiguration_F_UDDIRegistries | Name | The name that is assigned to the Universal Description, Discovery, and Integration (UDDI) Registries service. |
| inquiryURL | The URL that is used for inquiries to the specified UDDI Registries name. | |
| publishURL | The URL that is used for publishing to the specified UDDI Registries name. | |
| PESystemConfiguration_F_WSRRRegistries | Name | The name that is assigned to the IBM WebSphere Service Registry and Repository service. |
| serverName | The name of the server that hosts the WebSphere Service Registry and Repository service. | |
| port | The port on the specified server that is assigned to the WebSphere Service Registry and Repository service. | |
| PEUserInfo | Name | The name of user that is assigned access to a workflow. |
| EmailAddress | The email address that is assigned to the specified user. | |
| EFormHTTP | Name | The name that is assigned to the HTTP service for IBM FileNet eForms. |
| URL | The URL that is assigned to the specified eForms HTTP server. | |
| EFormJDBC | Name | The name that is assigned to this JDBC service for eForms. |
| Server | The name of the database that hosts the JDBC service. | |
| UserID | The user name credential that is used for database access through JDBC. | |
| Password | The database password that is assigned to the specified user
ID. Restriction: You cannot edit passwords
that are embedded in eForms form
templates with FileNet Deployment Manager.
Therefore, in the deployment of form templates from source to destination
environments, form template passwords remain unconverted. You must
manually edit the form template passwords in the destination environment
if you want to change them. If you want to convert embedded passwords
with FileNet Deployment Manager, you must
first disable the FIPS 140-ready mode and enter new passwords for
the target service data.
|
|
| Driver | The fully qualified path name for the JDBC driver that is used for database access. | |
| EFormODBC | Name | The name that is assigned to this ODBC service for eForms. |
| URL | The URL that is assigned to the eForms ODBC service. |
Example DataMap_Service.xml file
<?xml version="1.0" encoding="UTF-8"?>
<DataMap version="1" type="ObjectStore">
<List>
<MapItem>
<Source label="PESystemConfiguration_F_WebServer">
<Name>orion</Name>
<URL>http://orion:8080/p81</URL>
</Source>
<Destination label="PESystemConfiguration_F_WebServer">
<Name>orion</Name>
<URL>http://orion:8080/p81</URL>
</Destination>
</MapItem>
<MapItem>
<Source label="PESystemConfiguration_F_WebServer">
<Name>artemis</Name>
<URL>http://artemis:8080/p81</URL>
</Source>
<Destination label="PESystemConfiguration_F_WebServer">
<Name>artemis</Name>
<URL>http://artemis:8080/p81</URL>
</Destination>
</MapItem>
</List>
</DataMap>