|
Siebel Application Deployment Manager Guide > Creating a Siebel ADM Package >
About the Siebel ADM Package Utility Modes and Switches
The ADM Package Utility creates and validates the Siebel Application Deployment Manager (ADM) deployment package required by the ADM framework to deploy Siebel application customizations to a target environment. For more information on this utility, see About the ADM Package Utility. There are three ADM Package Utility modes:
- Init. Creates an empty ADM package directory structure. Deployment files must be manually copied into this directory structure before using the other ADM Package Utility functions. For information on this task, see Creating the Siebel ADM Package Directory Structure.
- Generate. Creates the ADM package descriptor file. For information on this task, see Generating the Siebel ADM Package.
- Validate. Validates an existing ADM package. The package directory structure must be in place and the generate function executed before running the validate function. For information on this task, see Validating the Siebel ADM Package.
NOTE: If the mode is not stated in the specified ADM Package Utility command, generate mode is the default mode.
The ADM Package Utility uses several switches, as described in Table 5, depending on the packaging option required. To modify the switches, edit the admpkgr.bat file. TIP: For information on copying the ADM Package Utility to other environments, see Copying the Siebel ADM Package Utility to a UNIX Environment.
Table 5. ADM Package Utility Switches
|
|
|
|
|
-r
|
-registryfile
|
No |
Not applicable |
ADM registry file path. |
-g
|
-language directory
|
No |
ENU |
Used in init mode to create language directories. See About Language Support in admpkgr.bat. |
-h
|
-help
|
Not applicable |
Not applicable |
Lists help for ADM package commands. |
-i
|
-ignoreerrors
|
No |
None |
Ignores errors while packaging. This flag allows for the creation of the package descriptor file even if the validation steps fail. However, if an error prevents the creation of the package descriptor file, this flag is ignored. |
-l
|
-logdirectory
|
No |
Current directory |
Location of ADM Package Utility log files. |
-p
|
-package directory
|
No |
Current directory |
Location of ADM Package folder containing ADM deployment units. |
-v
|
-version
|
Not applicable |
Not applicable |
Prints ADM Package Utility version. |
About Language Support in admpkgr.bat
If you specify a language directory using the -g switch you must also edit the SET LANG_DIR parameter in the admpkgr.bat file to match. For example, to enable the French and German languages, use the following settings. On the command line, specify: admpkgr.bat init -g FRA,DEU package_name
where package_name is the name of the ADM package folder that contains the application customizations to be deployed. Within the admpkgr.bat file, specify: SET LANG_DIR="FRA,DEU"
Return Values for the ADM Package Utility
The ADM Package Utility returns the values described in Table 6, after execution in each of the three modes.
Table 6. ADM Package Utility Return Codes
|
|
|
Init |
Errors (directory not created) |
3 |
Warnings |
1 |
Success |
0 |
Generate |
Errors (no descriptor file) |
3 |
Errors (with descriptor file) |
2 |
Warnings |
1 |
Success |
0 |
Validate |
Errors |
3 |
Warnings |
1 |
Success |
0 |
The ADM Package Utility also returns the values described in Table 7, after command execution.
Table 7. ADM Package Utility Command Completion Status Return Codes
|
|
0 |
Success. The command completed without errors. |
1 |
Warning. The command executed, but errors were encountered. |
2 |
Failure. The command failed to execute. |
NOTE: Only one value is returned if the ADM Package Utility is called from another program.
| 
