Command Reference > Working with pmrep Files > Using the Deployment Control File
  

Using the Deployment Control File

A deployment control file is an XML file that you use with the DeployFolder and DeployDeploymentGroup pmrep commands to deploy a folder or deployment group. You can create a deployment control file manually to provide parameters for deployment, or you can create a deployment control file with the Copy Wizard.
If you create the deployment control file manually, it must conform to the depcntl.dtd file that is installed with the PowerCenter Client. You include the location of the depcntl.dtd file in the deployment control file.
You can specify a deployment timeout in the deployment control file. The deployment timeout is the period of time that pmrep waits to acquire object locks in the target repository. By default, pmrep waits indefinitely until it acquires locks or you cancel the deployment. To cancel a deployment while pmrep is waiting to acquire locks, press Ctrl+C.
The following is a sample of the depcntl.dtd file:
<!ELEMENT DEPLOYPARAMS (DEPLOYFOLDER?, DEPLOYGROUP?)>
<!ATTLIST DEPLOYPARAMS
        DEFAULTSERVERNAME    CDATA      #IMPLIED
        COPYPROGRAMINFO      (YES | NO) "YES"
        COPYMAPVARPERVALS    (YES | NO) "NO"
        RETAINMAPVARPERVALS (YES | NO) "NO"
COPYWFLOWVARPERVALS  (YES | NO) "NO"
        COPYWFLOWSESSLOGS    (YES | NO) "NO"
        COPYDEPENDENCY       (YES | NO) "YES"
        LATESTVERSIONONLY    (YES | NO) "NO"
        CHECKIN_COMMENTS     CDATA      #IMPLIED
        DEPLOYTIMEOUT        CDATA      "-1"
        RETAINGENERATEDVAL   (YES | NO) "YES"
        RETAINSERVERNETVALS  (YES | NO) "YES">
        COPYDEPLOYMENTGROUP  (YES | NO) "NO">

<!--criteria specific to deploying folder-->
<!ELEMENT DEPLOYFOLDER (REPLACEFOLDER?, DEPLOYEDFOLDEROWNER?, OVERRIDEFOLDER*)>
<!ATTLIST DEPLOYFOLDER
        NEWFOLDERNAME         CDATA      #IMPLIED>

<!--folder to replace-->
<!ELEMENT REPLACEFOLDER EMPTY>
<!ATTLIST REPLACEFOLDER
        FOLDERNAME            CDATA      #REQUIRED
        RETAINMAPVARPERVALS   (YES | NO) "NO"
        RETAINWFLOWVARPERVALS (YES | NO) "YES"
        RETAINWFLOWSESSLOGS   (YES | NO) "NO"
        MODIFIEDMANUALLY      (YES | NO) "NO"
        RETAINORIGFOLDEROWNER (YES | NO) "NO">

<!--shared folder to override-->
<!ELEMENT OVERRIDEFOLDER EMPTY>
<!ATTLIST OVERRIDEFOLDER
        SOURCEFOLDERNAME    CDATA            #REQUIRED
        SOURCEFOLDERTYPE    (LOCAL | GLOBAL) "LOCAL"
        TARGETFOLDERNAME    CDATA            #REQUIRED
        TARGETFOLDERTYPE    (LOCAL | GLOBAL) "LOCAL"
        MODIFIEDMANUALLY    (YES | NO)     "NO"

<!--criteria specific to deploy deployment group-->
<!ELEMENT DEPLOYGROUP (REPLACEDG?, TARGETDGOWNER?, OVERRIDEFOLDER*, APPLYLABEL?)>
<!ATTLIST DEPLOYGROUP
        CLEARSRCDEPLOYGROUP (YES | NO) "NO">
        NEWDEPLOYGROUPNAME   CDATA  #IMPLIED

<!--labels used to apply on the src objects and deployed objects-->
<!ELEMENT APPLYLABEL EMPTY>
<!ATTLIST APPLYLABEL
        SOURCELABELNAME     CDATA            #IMPLIED
        SOURCEMOVELABEL    (YES | NO)          "NO"
        TARGETLABELNAME     CDATA            #IMPLIED
        TARGETMOVELABEL     (YES | NO)          "NO">

<!-- new owners of deployed folders -->
<!ELEMENT DEPLOYEDFOLDEROWNER EMPTY>
<!ATTLIST DEPLOYEDFOLDEROWNER
        USERNAME         CDATA        #IMPLIED
       SECURITYDOMAIN   CDATA     #IMPLIED
        GROUPNAME        CDATA #IMPLIED>

<!-- to indicate that a deployment group should be replaced-->
<!ELEMENT REPLACEDG EMPTY>
<!ATTLIST REPLACEDG
        DGNAME          CDATA        #REQUIRED
       SECURITYDOMAIN   CDATA     #IMPLIED

<!-- new owner of copied deployment group-->
<!ELEMENT TARGETDGOWNER EMPTY>
<!ATTLIST TARGETDGOWNER
        USERNAME         CDATA        #IMPLIED
       SECURITYDOMAIN   CDATA     #IMPLIED

Deployment Control File Parameters

The following table lists pmrep deployment control file parameters:
Element
Attribute Name
Attribute Description
DEPLOYPARAMS
DEFAULTSERVERNAME
Required if you use DeployFolder and DeployDeploymentGroup. Integration Service registered in the target repository to run workflows. For any deployment, you can specify one default server name.
-
COPYPROGRAMINFO
Optional. Copies SAP installed ABAP program.
-
COPYMAPVARPERVALS
Optional. Copies mapping variable persistent values based on the values set for RETAINMAPVARPERVALS. If you do not set COPYMAPVARPERVALS or set its value to No, the RETAINMAPVARPERVALS values are ignored. For more information, see Persisted Mapping Variables.
-
RETAINMAPVARPERVALS
Optional. Retains mapping variable persistent values in the target based on the values set for COPYMAPVARPERVALS. If you do not set COPYMAPVARPERVALS or set its value to No, the RETAINMAPVARPERVALS values are ignored. For more information, see Persisted Mapping Variables.
-
COPYWFLOWVARPERVALS
Optional. Copies workflow variable persistent values.
-
COPYWFLOWSESSLOGS
Optional. Copies workflow logs.
-
COPYDEPENDENCY
Optional. Copies dependency information for objects in mappings.
-
COPYDEPLOYMENTGROUP
Optional. Copies the deployment group along with the objects in the deployment group to the target repository.
-
VALIDATETARGETREPOSITORY
Optional. Validates objects in the target repository.
-
LATESTVERSIONONLY
Optional. Copies the latest version.
-
CHECKIN_COMMENTS
Optional. Overrides the default comment and adds a comment in the target repository when you copy or deploy an object. You must set LATESTVERSIONONLY to true to use this attribute.
-
DEPLOYTIMEOUT
Optional. Period of time (in seconds) that pmrep attempts to acquire locks on objects in the target repository. A value of 0 fails the copy operation immediately if pmrep cannot obtain a lock. A value of -1 instructs pmrep to wait indefinitely until it acquires locks or the user cancels the operation. Default is -1.
-
RETAINGENERATEDVAL
Optional. Keeps the current value for Sequence Generator or Normalizer transformations.
-
RETAINSERVERNETVALS
Optional. Retains server-network-related values in tasks.
DEPLOYFOLDER
NEWFOLDERNAME
Optional. Creates a folder with this name.
REPLACEFOLDER
FOLDERNAME
Required if you use DEPLOYFOLDER. Names the folder after replacing it.
-
RETAINMAPVARPERVALS
Optional. Retains mapping variable persistent values in the target.
-
RETAINWFLOWVARPERVALS
Optional. Retains workflow variable persistent values.
-
RETAINWFLOWSESSLOGS
Optional. Retains workflow session logs in the target.
-
MODIFIEDMANUALLY
Optional. Compares folders if objects in the target folder have been created or modified since the previous deployment.
-
RETAINORIGFOLDEROWNER
Optional. Retains the existing folder owner. pmrep ignores any information provided in the DEPLOYEDFOLDEROWNER element.
OVERRIDEFOLDER
SOURCEFOLDERNAME
Required if you use DeployFolder and DeployDeploymentGroup.
If deploying a folder, specifies the current folder that shortcuts point to.
If deploying a deployment group, specifies the following folders:
  • - Folder or folders that shortcuts point to
  • - Folder or folders containing the deployment group objects
-
SOURCEFOLDERTYPE
Optional. If deploying a folder, specifies the type of folder that shortcuts point to. Use local or global shortcuts.
-
TARGETFOLDERNAME
Required. If deploying a folder, specifies the folder that shortcuts point to.
If deploying a deployment group, specifies the following folders:
  • - Folder or folders that shortcuts point to
  • - Folder or folders containing the deployment group objects
-
TARGETFOLDERTYPE
Optional. If deploying a folder, specifies the type of folder that shortcuts point to. Use local or global shortcuts.
-
MODIFIEDMANUALLY
Optional. Compares folders if objects in the target folder have been created or modified since the previous deployment. Use this attribute only with the DeployDeploymentGroup command.
DEPLOYGROUP
CLEARSRCDEPLOYGROUP
Required if you use DeployDeploymentGroup. Removes objects from the source group after deploying.
-
NEWDEPLOYGROUPNAME
Optional. Creates a deployment group with this name. Ignored if REPLACEDG is specified. Default is the source deployment group name.
REPLACEDG
DGNAME
Optional. Name of the deployment group to be replaced.
-
RETAINORIGINALOWNER
Optional. Specifies whether to retain the owner of the deployment group being replaced in the target repository.
TARGETDGOWNER
USERNAME
Optional. Owner of the copied deployment group. Default is the owner of the source deployment group.
-
SECURITYDOMAIN
Optional. Security domain of the target deployment group.
APPLYLABEL
SOURCELABELNAME
Required if you use DeployDeploymentGroup. Applies a label to all the objects in the source group.
-
SOURCEMOVELABEL
Optional. Moves the label from a different version of the object in the source group to the deployment group version of the object. If the Repository Agent detects the label is applied to another version of the same object, you can choose to move the label to the selected version of the object.
-
TARGETLABELNAME
Optional. Applies a label to all the objects deployed to the target repository.
-
TARGETMOVELABEL
Optional. Moves the label from a different version of the object in the target group to the deployment group version of the object. If the Repository Agent detects the label is applied to another version of the same object, you can choose to move the label to the latest version of the object.
DEPLOYEDFOLDEROWNER
USERNAME
Required if you use DeployFolder and DeployDeploymentGroup. Owner of the deployed folder or deployment group in the target repository.
-
SECURITYDOMAIN
Optional. Name of the security domain that the owner of the deployed folder or deployment group belongs to.
-
GROUPNAME
Optional. Group owner of the deployed folder or deployment group in the target repository.

Persisted Mapping Variables

When you deploy a folder or a group, you can copy the values of persisted mapping variables from the source repository to the target repository, retain the values from the target repository, or reset the values.
The following table describes how to configure COPYMAPVARPERVALS and RETAINMAPVARPERVALS to copy, retain, or reset the values of persisted mapping variables:
Deployment Behavior
Configuration
Reset the persisted mapping variable values in the target repository.
Set COPYMAPVARPERVALS to No.
Copies the mapping variable values from the source repository to the target repository.
Set the following parameter file options:
  • - Set COPYMAPVARPERVALS to Yes.
  • - Set RETAINMAPVARPERVALS to No.
Retains the existing persisted mapping variable values in the target repository.
Set the following parameter file options:
  • - Set COPYMAPVARPERVALS to Yes.
  • - Set RETAINMAPVARPERVALS to Yes.