Previous Topic: ExampleNext Topic: Example


regproc—Registering Procedures

Use the regproc command to register an embedded or additional item procedure with an existing software program. The item procedure must be in a directory accessible to the enterprise or domain manager.

The syntax of the command is as follows:

cadsmcmd regproc 	item=item_name
version=version_name
task={install | activate | configure | uninstall} 
procedure=procedure_name
os=os
type={executable | command | SWD | MSI | SXP | PKG | PIF | IPS | PALM | WINCE| RPM | NOKIA}
[enduser] 
[notRAC]]
[externalproc]
file=file_name 
path=path_name
[parameters=procedure_parameters] 
[defaultProc][query=query_name][sep=separator_sign]
[comment=comment]
[usedefaultMsg]
comment

Specifies a comment for the procedure.

defaultProc

If coded, the procedure registering becomes the default procedure of all procedures of the same type.

enduser

(Optional) Indicates if the procedure can be scheduled for execution by an end user through the Catalog GUI.

externalproc

(Optional) Indicates that the procedure given in the procedure parameter is external (the procedure has to be provided by the target systems in question).

file

Specifies the name of the procedure file.

item

Specifies the name of the item to which this procedure is being associated as an added item procedure.

notRAC

(Optional) Specifies that the procedure is not to be taken into account at Reinstall After Crash (RAC).

os

Specifies the operating system type that the procedure will support.

Values:
os={AIX|AIX_3.2_RS/6000|AIX_4.1_RS/6000
...|AIX_4.2_RS/6000|AIX_4.3_RS/6000
...|AIX_5.0_RS/6000|AIX_5.1_RS/6000
...|AIX_5.2_RS/6000|AIX_5.3_RS/6000
...|AIX_5.4_RS/6000|AIX_5.5_RS/6000
...|AIX_5.6_RS/6000|AIX_5.7_RS/6000
...|AIX_5.8_RS/6000|ANY|COMPAQ_TRU64_(DEC)
...|COMPAQ_TRU64_5.X_ALPHA
...|DEC_3.0_ALPHA|DEC_3.2_ALPHA
...|DEC_4.0_ALPHA|DGUX|DGUX_4.1_INTEL
...|DGUX_4.1_MC88|DGUX_4.2_INTEL
...|DOS|DRS/NX_7MP_SPARC|DRS/NX_7_SPARC
...|DRS/NX_SPARC|DYNIX|DYNIX_4.2.X_INTEL
...|DYNIX_4.4.X_INTEL|HPUX
...|HPUX_10|HPUX_10_700|HPUX_10_800
...|HPUX_11|HPUX_11I_V2|HPUX_11_700
...|HPUX_11_800|HPUX_11_IA64
...|HPUX_12|HPUX_12I_V2|HPUX_12_700
...|HPUX_12_800|HPUX_12_IA64
...|HPUX_9|HPUX_9_700|HPUX_9_800
...|IRIX|IRIX_6.2|IRIX_6.3
...|IRIX_6.4|IRIX_6.5|LINUX
...|LINUX_2.1_INTEL|LINUX_2.2_INTEL
...|LINUX_2.2_S/390|LINUX_2.3_INTEL
...|LINUX_2.3_S/390|LINUX_2.4_INTEL
...|LINUX_2.4_S/390|LINUX_2.5_INTEL
...|LINUX_2.5_S/390|LINUX_2.6_INTEL
...|LINUX_2.6_INTEL_64-BIT
...|LINUX_2.6_S/390|MACINTOSH
...|MACINTOSH_10.0_PPC|MACINTOSH_10.1_PPC
...|MACINTOSH_10.2_PPC|MACINTOSH_10.3_PPC
...|MACINTOSH_10.4_PPC|NCR_SST
...|NCR_SST_S4I_INTEL|NCR_SST_S4_INTEL
...|NCR_SV|NCR_SV_2X_INTEL
...|NCR_SV_3X_INTEL|NETWARE
...|NETWARE_3_INTEL|NETWARE_4_INTEL
...|NETWARE_5_INTEL|NETWARE_6_INTEL
...|NOKIA_ADMINSUITE|NOKIA_ADMINSUITE_1.0
...|OPENVMS|OPENVMS_5.5_VAX
...|OPENVMS_6.0_ALPHA|OPENVMS_6.0_VAX
...|OPENVMS_6.1_ALPHA|OPENVMS_6.1_VAX
...|OPENVMS_6.2_ALPHA|OPENVMS_6.2_VAX
...|OPENVMS_7.0_ALPHA|OPENVMS_7.0_VAX
...|OPENVMS_7.1_ALPHA|OPENVMS_7.1_VAX
...|OPENVMS_7.2_ALPHA|OPENVMS_7.2_VAX
...|OS/2_16-BIT|OS/2_32-BIT
...|PALM_OS|SCO|SCO_3.2_V5_INTEL
...|SCO_5.2_V5_INTEL|SINIX
...|SINIX_5.42_R4000|SINIX_5.43_R4000
...|SINIX_5.44_R4000|SINIX_5.45_R4000
...|SOLARIS|SOLARIS_10_INTEL
...|SOLARIS_10_SPARC|SOLARIS_2.3_SPARC
...|SOLARIS_2.4_INTEL|SOLARIS_2.4_SPARC
...|SOLARIS_2.5_INTEL|SOLARIS_2.5_SPARC
...|SOLARIS_2.6_INTEL|SOLARIS_2.6_SPARC
...|SOLARIS_7_INTEL|SOLARIS_7_SPARC
...|SOLARIS_8_INTEL|SOLARIS_8_SPARC
...|SOLARIS_9_INTEL|SOLARIS_9_SPARC
...|SUNOS|SUNOS_4.1.4_SPARC
...|UNIX|UNIXWARE|UNIXWARE2.0_INTEL
...|UNIXWARE2.1_INTEL|UNIXWARE7.X_INTEL
...|WINDOWS_16-BIT|WINDOWS_32-BIT
...|WINDOWS_95|WINDOWS_98
...|WINDOWS_ME|WIN_2000|WIN_2000_INTEL
...|WIN_CE|WIN_CE_2.00_MIPS
...|WIN_CE_2.00_SH3|WIN_CE_2.01_MIPS
...|WIN_CE_2.01_SH3|WIN_CE_2.11_ARM
...|WIN_CE_2.11_MIPS|WIN_CE_2.11_SH3
...|WIN_CE_2.11_SH4|WIN_CE_3.00_ARM
...|WIN_CE_3.00_MIPS|WIN_CE_3.00_PPC2002_ARM
...|WIN_CE_3.00_SH3|WIN_CE_3.00_SH4
...|WIN_CE_4.20_MOBILE2003_ARM
...|WIN_LONGHORN_SERVER_INTEL
...|WIN_LONGHORN_SERVER_ITANIUM
...|WIN_LONGHORN_SERVER_X64
...|WIN_NT|WIN_NT_ALPHA|WIN_NT_INTEL
...|WIN_NT_MIPS|WIN_SERVER_2003
...|WIN_SERVER_2003_INTEL
...|WIN_SERVER_2003_ITANIUM
...|WIN_SERVER_2003_X64|WIN_VISTA_INTEL
...|WIN_VISTA_ITANIUM|WIN_VISTA_X64
...|WIN_XP|WIN_XP_INTEL|WIN_XP_ITANIUM
...|WIN_XP_X64}

Note: When you issue the regproc command in verbose mode, a list of valid values for your actual version is displayed.

parameters

Parameters to be passed to the procedure when executed.

path

Indicates one of these three cases, depending on usage:

internal procedure

The procedure is an integral part of the product package. Therefore, the path is expected to be the relative path from the product root to the procedure file.

If, for example, the product has been loaded form c:\swtest1 (the product root) and the procedures are located at c:\swtest1\procs then code path=PROCS to locate the procedure.
If the procedure lies also at c:\swtest1 then code path=\ on Windows and path=./ on Linux.
(See also: Backslash (Windows) and Forward Slash (Linux))

added procedure

The procedure is not an integral part of the package but available somewhere on the manager. Therefore, the path is to be the absolute access path to the procedure file on the manager.

If, for example, the product has been loaded from c:\swtest1 but the procedure to be assigned is located at d:\procpool on the manager where the command is launched, then code path=d:\procpool.

external procedure

The procedure neither is an integral part of the package nor is it available on the manager where the command is launched, but it should be available at all those target computers where it should later run on.

Then the procedure has to be located at the same location on all those target computers to be addressed.

For example, provide the procedure at c:\usd_supp\procs at the target computers in question. Then code path=c:\usd_supp\procs.

Note: This parameter is not mandatory if the externalProc argument is coded. In this case the information passed with the file argument will be used to determine the procedure to be invoked at the target systems.
If the the externalProc argument is not coded then this parameter remains mandatory.

procedure

Specifies the name of a procedure. It will be registered.

query

Specifies the name of an existing query that describes the prerequisites for running this procedure. If not coded then no prerequisites are set.

The query name syntax is of the following syntax:

{query_name | (query_name separator_sign domain_name)}

The domain_name specifies the name of the domain where this query has been created. The separator_sign separates the query_name of the domain_name. The separator_sign is defined with the sep parameter. If only the query_name is specified, then the membership of the query to a domain is not checked.

sep

Specifies the separator sign used with this action. The default separator sign is the dot ".".

task

Specifies the type of task to be performed by the item procedure.

Install

Registers an installation procedure

Activate

Registers an activation procedure

Configure

Registers a configuration procedure

Uninstall

Registers a uninstallation procedure

type

Specifies the procedure type.

Valid values are:

executable

executable file (.exe or .com)

command

command file (.cmd or .bat)

swd

Software Detector script

msi

Microsoft Windows Installer package file

sxp

SD packaging format for Windows

pkg

SD packaging format for UNIX

pif

Product Interchange File: SD packaging format for UNIX

rpm

Linux RedHat Package Manager packaging format

ips

<adms> script file with the extension .ips

palm

PALM application file with the extension .prc

wince

Windows CE cabinet file with the extension .cab

nokia

NOKIA 9210 Communicator file

usedefaultMsg

(Optional) If the usedefaultMsg argument is coded, the comment associated with the item procedure is used as the user job message.

version

Specifies the version of the item.