Setting Up the Master SNAPINSPREFS.SER File

For the following instructions, select any workstation that you will use for managing software packages. If you have already created software packages using a workstation, select that workstation so you will not lose any software package information stored in the workstation's SNAPINPREFS.SER file.

1. Map a drive to the server where you want to store your .SPK and related .CPK files.

   This drive letter should be one that can be used by all of the other workstations that you will use to manage software packages. This drive letter is written to the SNAPINPREFS.SER file as part of the path information for each listed .SPK file, so it should be a fixed drive letter that all workstations use.

   The drive letter will also be used in the batch file that you use to start ConsoleOne, which will provide each workstation access to the same .SPK file locations.

2. If you already have Server Software Package objects created by this workstation, skip to Step 5.

   or

   If you have not yet created any Server Software Package objects using this workstation, start ConsoleOne.

   This version of ConsoleOne must have the ZfS Policy and Distribution services snap-ins installed.

3. In the Server Software Package namespace, create a Server Software Package object.

   You do not need to fully configure the Server Software Package object at this time. Just give the package a name and provide a location and filename for the .SPK file. Make sure you use the drive mapping you used in Step 1.

   For information on creating software packages, see Setting Up Server Software Packages.

4. Exit ConsoleOne.

   This step is important to make sure that the SNAPINPREFS.SER file is created for this workstation.

5. On the network server you will use to store the master copy of the SNAPINPREFS.SER file, create a directory named C1 at the root of the drive.

   You can select any safe location on the server for the master SNAPINPREFS.SER file.

   The batch file sample provided below uses a directory named C1. You can modify the batch file if you want to use a different directory name, and you can include path information; however, do not use variables.

   For example,

   ZENWORKS\C1SSP

   could be used to replace the C1 directory name.

6. Copy the workstation's SNAPINPREFS.SER file from:

   C:\Documents and Settings\user_ID\.consoleone (Windows 2000)

   or

   C:\Winnt\Profiles\user_ID\.consoleone (Windows NT)

   to the C1 directory on the network server.

   This becomes the master SNAPINPREFS.SER file that will be updated with new .SPK paths, provided you are using the batch file documented in Creating the ConsoleOne Batch File.

Creating the ConsoleOne Batch File

Review the following sections to create and use the batch file:

• Sample Batch File
• What the Batch File Does
• Creating Your Batch File
• Optional Modifications to the Batch File

@echo off 
REM map a network drive 
net use m: \\prv-ale.provo.novell.com\vol1 
    
REM create a backup copy of the workstation's .SER file 
copy "%USERPROFILE%\.consoleone\snapinprefs.ser" "%USERPROFILE%\.consoleone\snapinprefs.tmp" 
    
REM copy the master .SER to the workstation 
copy m:\c1\snapinprefs.ser "%USERPROFILE%\.consoleone\snapinprefs.ser" 
    
REM start ConsoleOne 
C:\Novell\ConsoleOne\1.2\bin\ConsoleOne.exe 
    
REM batch file control returns after exiting ConsoleOne 
REM copy the updated .SER to server 
copy "%USERPROFILE%\.consoleone\snapinprefs.ser" m:\C1\snapinprefs.ser 
    
REM restore the backup copy of the workstation's .SER file 
copy "%USERPROFILE%\.consoleone\snapinprefs.tmp" "%USERPROFILE%\.consoleone\snapinprefs.ser" 
    
REM delete the mapped network drive 
net use m: /delete 
@echo on

Using the ConsoleOne Batch File

• Before running this batch file, place a SNAPINSPREFS.SER file in the ...\.CONSOLEONE directory of each workstation you will use to manage software packages. The batch file assumes that the .SER file will exist for copying and replacing.
• Before running this batch file, place your master copy of the SNAPINSPREFS.SER file in the C1 directory of the server where you have stored the software package files. The batch file assumes that this .SER file will exist for copying and replacing.
• Run this batch file any time you plan to add, delete, or compile software packages.
• You do not need to use the batch file when you view or edit the properties of software packages. The add, delete, and compile functions are the only actions that will cause the SNAPINPREFS.SER file to be updated.

Requirements

To specify requirements for installing the server files or applications:

1. While displaying the properties of the software package component, click the Requirements tab > click Add.

2. Select any of the following requirement items:

   Operating System

   Memory (RAM)

   Disk Space

   SET Commands

   Registry

   File

   PRODUCTS.DAT

   For further instructions on configuring an item, see one of the above items.

Pre-Installation Load/Unload Order

To configure certain NLM files or processes to load or unload before installing the software package on a server:

1. While displaying the properties of the software package component, click the Pre-Installation tab > click Load/Unload.

2. Click Add.

3. Select one of the following:

   Load NLM/Process

   Load Java Class

   Unload Process

   Start Service

   Stop Service

   For further instructions on configuring an item, see one of the above items.

   IMPORTANT:  If you select a process to be loaded by the software package, and it is already running on the target server, the package installation will fail and will be rolled back (if rollback is enabled). If the process requires intervention to unload, you must remember to unload it manually before installing the software package.

   To make sure that a process is not already loaded when you are including it in the software package, add an unload option for that process before adding the load option---but only if the process does not require user input from the keyboard to unload it.

4. Repeat Step 1 through Step 3 for each NLM or process to be included.

5. Use the arrow keys to arrange the order to execute the NLM files and the processes.

Do not click OK until you have finished configuring the other tabs.

Pre-Installation Scripts

To configure running server scripts before installing the software package on a server:

1. While displaying the properties of the software package component, click the Pre-Installation tab > Script.

2. Click Add.

3. Enter the script name.

4. Select the script type (NCF, NetBasic, PERL).

5. Enter the script text.

   WARNING:  If a software package passes all requirements and executes the script, processing done by the script cannot be undone by rollback.

6. Repeat Step 2 through Step 5 for each script to be added.

7. Use the arrow keys to arrange the order to execute the scripts.

Do not click OK until you have finished configuring the other tabs.

Local File Copy

The Local File Copy component enables copying of files on a server from one location to another using a software package. You can either copy or move the files.

To configure the Local File Copy component:

1. While displaying the properties of the software package component, click the Local File Copy tab.

2. Click Add.

   Local File Copy #1 defaults. You can edit that name.

3. Fill in the fields:

   Source Path: Enter the full path where the files to be copied are located.

   You can use wildcards in the path:

      * = any number of characters

      ? = any single character in that position

      ??? = any characters in those positions

   Target Path: Enter the full path where the copied files are to be placed.

   You can use wildcards in this path. This path does not need to mirror the source path. However, you could mirror an existing target path.

   Include Subdirectories: Includes all subdirectories and their files beginning from the directory at the end of the path; otherwise, only the files in the directory at the end of the path will be copied.

   Maintain Attributes: Maintains the file attributes in the target's file system that exist in the source's file system.

   Overwrite Destination Files: Overwrites files of the same name in the destination directories, regardless of differences in file dates. If you do not enable this option, files of the same name will not be replaced.

   Maintain Trustees: Maintains the file's trustee attributes.

   When a File Is Locked: Select one or both:

   • Retry __ Times: Retries overwriting a locked file the number of times you select before failing to replace the file. Leave this check box unchecked to not replace locked files on the target file system.

   • Kill Connection of Open Files: Attempts to kill the connection of locked files so they can be overwritten. This applies only to files being extracted, not to files being accessed to build the Distribution. If a file belonging to a Distribution is locked when the Distribution is being built, the build will fail. Server and NLM connections cannot be killed.

   Error Processing: Fail On Error is checked by default. This stops the file copying process when an error is encountered in copying. To continue file copying when an error is encountered, click Continue On Error.

   Operation: Sets whether to copy or move the files identified in the Source Path.

Do not click OK until you have finished configuring the other tabs.

Copy File

You can configure the Copy File component to control how files are copied during installation of a software package. This includes adding files to existing directories, creating new directories, adding files and subdirectories to the new directories, and deleting existing files and directories.

File Group is a root item for the component's expandable tree structure. You can have multiple File Groups for the Copy File component. A File Group is a set of related directories and files. File Groups are top-level items and cannot contain other File Groups.

The other structure items are Directory and File, which are contained within a File Group. Directories can contain other directories or files, but not File Groups.

IMPORTANT:  When you add a File Group or Directory, you are creating the target paths where the files will be copied, not the source paths of the files. The source paths are automatically accounted for as you select your source files or directories.

To configure copying files during installation of the software package:

1. While displaying the properties of the software package component, click the Copy File tab.

2. To create your first File Group, do the following:

   1. Click the down arrow on the drop-down box next to the Add button > select Add File Group > click Add.

      Because files and directories must be contained within File Groups, you will be prompted to create a File Group the first time you click Add, regardless of which type you are attempting to add.

      You should create one File Group for each specific target location. For example, C:\FILES, C:\DATA\ACCOUNTING, and C:\DATA\PERSONNEL could be different locations on a C: drive where you want to copy different groups of unrelated files.

   2. Name the File Group > enter its target path.

      The File Group's target path specifies the base path from where all Directories and Files within the group will be installed.

   3. To specify what to do when a File Group location is locked, click the check box for one of the following:

         1. Retry (enter the number of retry times)
         2. Kill Connection of Open Files
         3. Fail With Error

      Retries are about 5 seconds apart. Therefore, 12 retries would take about one minute.

3. To create a target directory under a File Group or another directory, select the file group or directory > in the drop-down box, select Add Directory > click Add > do the following:

   1. Because Directory is the default directory name, to rename the directory, right-click Directory > click Rename > enter the desired directory name > press Enter.

      You must press Enter for the name change to be made.

      To match an existing target directory for deleting or copying files, you must enter the exact name.

      IMPORTANT:  If you enter an existing directory name and that directory is marked as READ ONLY on the destination server's file system, the Software Package Distribution will fail when the Subscriber tries to extract the Distribution, because it will not be able to write to that directory. Therefore, you must know the attributes of existing target directories and remove their READ ONLY directory attributes.

      You must create the same directory structure in the File Copy component as exists in the target location so that the directory name you enter here will be in the same sequence in the path.

   2. To determine whether to create or delete the directory, select the mode from the Copy Mode drop-down list.

      Create: If you select Create and the directory does not exist, the directory will be created. If you select Create and the directory does exist, the directory will not need to be created, and no error will be encountered.

      Delete: If you select Delete and the directory exists, the directory will be deleted, including any subdirectories and files under it. If you select Delete and the directory does not exist, the directory will not need to be deleted, and no error will be encountered.

      WARNING:  If you plan to set the Copy Mode as Delete for any directories you add, and you do not want any parent directories that you have added to also be deleted, place those parent directories in the Target Path field of the File Group. For example, if you want to delete C:\WINNT\COOKIES, but do not want to delete the WINNT directory, enter C:\WINNT in the Target Path field > click Add to enter the COOKIES directory in the tree structure > click Delete for the Copy Mode field. For example:

         Target = C:\WINNT

         Tree structure = COOKIES

      causes only COOKIES and all of its files and subdirectories to be deleted.

      Conversely, both the WINNT and COOKIES directories will be deleted if you enter C:\ in the Target path field > click Add to enter the WINNT directory in the tree structure > click Add to enter the COOKIES directory under WINNT in the tree structure > click Delete for the Copy Mode field. For example:

         Target = C:\

         Tree structure = WINNT\COOKIES

      causes WINNT and all of its files and subdirectories to be deleted.

4. To add files or source directories under a file group or directory in the tree structure, select a file group or directory > in the drop-down box, select Add File > click Add > do the following:

   1. Select the files or directories using the Open dialog box.

      These directories and files are displayed directly under the file group or directory you selected in Step 3.

      For the destination server's file system, attributes of the copied files and directories are not maintained. For more information, see Step 4.c.

      If you selected a directory on the Open dialog box, it will not be displayed expanded. Click the plus signs to expand the existing structure under the directory that you added.

      In the Open dialog box, the Recurse Directories option is checked by default. To only select files in this directory, click the Recurse Directories check box to disable it and none of the subdirectories will be selected.

      To exclude files or subdirectories from being selected, click the Exclude Selected Subdirectory option > click the files or directories to be excluded (use Shift and Ctrl for multiple select) > click Open.

      If you exclude files or subdirectories, it does not remove them from the file system. It only prevents them from being selected.

      For information on removing files or subdirectories from the tree structure after adding files and directories, see Step 8.

   2. To configure a subdirectory that was added, do the following:

      • Click the subdirectory > select the Copy Mode (whether to Create or Delete the directory).

        WARNING:  When you set the Copy Mode to Delete, it will cause deletion of the target directory and all of its files and subdirectories.

      • To rename a subdirectory that was added, right-click the subdirectory > click Rename > enter a new directory name > press Enter.

        You must press Enter for the name change to be made.

        If you rename a directory that was selected through the Open dialog box, make sure that the new name meets your expectations for the target location.

        Because only selected files have their path remembered for copying, renaming a directory does not affect file selection. In other words, you can give a target directory a different name than its source, and still have the same files copied under it.

   3. To configure an added file, click the file > do the following:

      • To determine the file's copy mode, select a mode from the Copy Mode drop-down list.

        You must select an option for every file. You can select multiple files where you want the mode to be the same.

        The options are: Copy Always, Copy If Exists, Copy If Does Not Exist, Copy If Newer, Copy If Newer and Exists, and Delete.

        WARNING:  When you set the Copy Mode to Delete, it will cause deletion of the selected file from the target server.

      • Click the check box for each attribute that should apply to the selected files.

        Attributes do not default. You must set them for the destination server. They are not carried over from where you obtained the file.

        IMPORTANT:  Do not check all of the attributes for a file, or an exception will be thrown on the server.

        WARNING:  When setting the attribute of an executable file, set it to Read Only. Do not set it to Execute. If you mark a file as Execute, the NetWare^® CLIB API does not allow you to change it to a different attribute. To change the attribute from Execute to Read Only once the software package has been installed, you would need to manually delete the file, replace it, then set its attribute again.

5. To create another File Group, do the following:

   1. Click the down arrow on the drop-down box next to the Add button > select Add File Group > click Add.

      It doesn't matter what you have selected in the tree structure, the File Group is automatically placed at the first tree level, equal to any other File Groups that are displayed.

   2. Name the group.

   3. Enter its target base path.

   4. To indicate what to do when a group location is locked, click the check box for one of the following:

         1. Retry (enter the number of retry times)
         2. Kill Connection of Open Files
         3. Fail With Error

6. Repeat Step 5 through Step 5.d for each additional File, Directory, or File Group to be added.

7. If you want the File Groups to be copied in a particular order, use the arrow keys to arrange the order of the File Groups.

   The arrows will be dimmed if the File Group you have selected has no valid up or down movement available to it.

8. To remove a File Group, Directory, or File, select it > click Remove.

   You can use the Remove button to prune the tree structure of unwanted files or directories.

   You can use the Shift and Ctrl keys to select multiple items for removal.

   IMPORTANT:  If you remove a File Group or Directory, all Files and Directories displayed below it are also removed, but only from this tree structure, not from the source file system.

Do not click OK until you have finished configuring the other tabs.

Text File Changes

To configure making changes to text files during installation of the software package:

1. While displaying the properties of the software package component, click the Text Files tab.

2. Click Add.

   After one text file has been added, you will be given the opportunity to select whether you are adding another text file or another change item for the selected text file.

   To add another text file: Select Text File. It does not matter which text file or change item is selected in the left pane---the text file will be added to the far left level.

   To add another change to a text file: In the left pane click the text file for the change > click Add > select Change. The change item will be added under the selected text file.

3. If you are adding a text file, enter the name of the text file.

4. Accept the default name (such as Change #1) or rename it.

   If you are adding a text file, click OK.

5. Click the down-arrow for the Change Mode field > select the change mode from the drop-down list.

6. Click the down-arrow for the Search Type field > select the search type from the drop-down list.

7. Enter the exact search string.

8. Check the box if you want the string search to be case sensitive.

9. To find all occurrences of the search string, select the box (default); otherwise, deselect the box to find only the first occurrence.

10. Click the down-arrow for the Result Action field > from the drop-down list, select the action that should result if a string is matched.

11. If you will be replacing a string or entering a new one, enter the text in the New String text box.

12. Repeat Step 2 through Step 11 for each text file to add or each change to be made.

13. To reorder the text files and change items, use the arrow keys.

Do not click OK until you have finished configuring the other tabs.

SET Commands

For NetWare only.

To configure the target server's SET commands:

1. While displaying the properties of the software package component, click the Set Commands tab.

2. Click Add to open the NetWare Server SET Commands Wizard.

3. Select the server containing the SET commands > click Next.

   IMPORTANT:  The Policy/Package Agent, the ZWS Agent, and Java must be running on the server where you want to obtain the SET commands.

4. Select all of the SET commands you want to configure for the target server.

   You can select whole categories by clicking the check box for the category, or click the plus sign to expand a SET command category and click the check boxes for individual SET commands to be included.

   WARNING:  Do not select the Set Developer Option SET command and change Off to On. This parameter is meant to help developers debug server abends. It disables some operating system checking to prevent certain abends from occurring. Also, if the Set Developer Option is turned on, running NCP^TM scripts that require keyboard entry could abend the server.

5. Click Finish when you have completed selecting SET commands.

   The selected SET commands are now displayed in the Set Commands tab for the file or application component.

6. To edit a SET command, click its plus sign to expand its attributes.

7. To edit an attribute, click the attribute > Edit.

   A dialog box is displayed where you can make changes to the attribute.

8. Repeat Step 7 for each attribute to edit for a given SET command.

9. Repeat Step 6 through Step 8 to edit another SET command's attributes.

Do not click OK until you have finished configuring the other tabs.

Registry Settings

To configure registry changes for either NetWare or Windows servers:

1. While displaying the properties of the software package component, click the Registry Settings tab > click HKEY_LOCAL_MACHINE.

   HKEY_LOCAL_MACHINE is a Windows registry key. For NetWare, HKEY_LOCAL_MACHINE is also recognized by ZfS as the equivalent to My Server. Therefore, you can use this key for editing both NetWare and Windows registries.

2. Click Add.

3. Select from the following:

   Key

   Binary

   Expand String

   (Default)

   DWord

   Multi-Value String

   String

   For further instructions on configuring an item, see one of the above items.

4. Repeat Step 2 and Step 3 for each registry entry to be made.

5. Use the arrow keys to arrange the order in making registry entries.

Do not click OK until you have finished configuring the other tabs.

PRODUCTS.DAT

For NetWare only.

The PRODUCTS.DAT file can be updated by your software package so that future updates can know the most recently installed version of the file or application.

WARNING:  Modifying PRODUCTS.DAT could prevent something from running or being installed on the NetWare server. Never modify any entries supplied by Novell.

To determine which action to take for PRODUCTS.DAT:

1. While displaying the properties of the software package component, click the Products.dat tab.

2. Select one of the following:

   Option	Description
   Add	Adds a new entry
   Modify Existing Entry	Searches for a matching ID and modifies the version and description
   Replace Existing Entry	Searches for a specific ID and replaces it with a new one
   No Action	This is the default. Nothing is done to PRODUCTS.DAT

3. If you selected Add:

   1. Enter the ID of the item to add.

      This is case sensitive. The item is the ID of the new product for the .DAT file.

   2. Enter the exact version number to add.

   3. Enter the description to add.

4. If you selected Modify Existing Entry:

   1. Enter the ID of the item to search for (case sensitive).

   2. Enter the new version number.

   3. Enter the new description.

5. If you selected Replace Existing Entry:

   1. Enter the ID of the item to search for (case sensitive).

   2. Enter the exact version number to match.

   3. Enter the new ID.

   4. Enter the new version.

   5. Enter the new description.

Do not click OK until you have finished configuring the other tabs.

Post-Installation Unload/Load Order

To configure certain NLM files and processes to load or unload after installing the software package on a server:

1. While displaying the properties of the software package component, click the Post-Installation tab > click Load/Unload.

2. Click Add.

3. Select one of the following:

   Load NLM/Process

   Load Java Class

   Unload Process

   Start Service

   Stop Service

   Click an item for further instructions on configuring it.

4. Repeat Step 2 and Step 3 for each NLM or process to be included.

Do not click OK until you have finished configuring the other tabs.

Post-Installation Scripts

To configure running NetWare server scripts after installing the software package on a server:

1. While displaying the properties of the software package component, click the Post-Installation tab > click Script.

2. Click Add.

3. Enter the script name.

4. Select the script type (NCF, NetBasic, PERL).

5. Enter the script text.

   WARNING:  If a software package passes all requirements and executes the script, processing done by the script cannot be undone by rollback.

6. Repeat Step 2 through Step 5 for each script to be added.

7. Use the arrow keys to arrange the order to execute the scripts.

Do not click OK until you have finished configuring the other tabs.