Working with packages


Fore more information about packages, see Packages
You can perform the following actions with packages:

To create a package

  1. Click the Define tab.
  2. On the right, after the list of existing packages, click New Package.
  3. Enter an appropriate name for the new package.
  4. Select an instance lock value (Locked or Unlocked) from the Instance Lock Default field. By default, the instance is unlocked. If the instance is locked you cannot edit its references, properties, and existing configurations.
  5. Select the role allowed to access the package. If you select a specific role, then only users with this specific role assigned are allowed to see the package. The default role for accessing the package is Unassigned.
  6. Click Create.
    The new package summary appears with sections for adding references and analyzers, package properties, and configuration data. You have the following options:
    • Continue to configure the package by making any changes that you want, such as adding references or properties as described in the following sections.
    • Click Deploy to create a deployable version of the package now.
    • Click Instance to create an instance of the package now.

To add references to a package

  1. Click the Define tab.
  2. Click the name of the package to which you want to add a reference.
  3. On the References subtab, click Add Reference on the right, after the list of existing references.
  4. Enter an appropriate name for the reference.
  5. Select the method for retrieving the content. 

    Click here to learn more about methods for retrieving the content.

    When you add a reference to a package, you can select one of the methods for accessing the content. Method refers to extracting the content (for example, files or folders) from the location where they are stored. 
    Depending on the location where the content files are stored, or the version control tool you use for accessing the latest version of the file, the following methods are available:

    • Action: You specify an action to get content. 
    • Cc Dynamic: The file is located in the IBM ClearCase dynamic view.
    • Cc Static: The file is located in the IBM ClearCase static view.
    • File: The file is located in a file system. You provide a path to the location of the file.
    • Git: The file is located in the Git revision control system.
    • Hg: The file is located in the Mercurial revision control tool.
    • Http: The file is pulled via Hypertext Transfer Protocol (HTTP).
    • Nexus: The file is located in the Sonatype Nexus repository management system.
    • Null: The reference with the null method selected is a reference with no physical content.
      Use this method if you need to do some operation during a deployment, but you do not want to do it as part of a file deployment. For more information, see Understanding-null-references.
    • Perforce: The file is located in the Perforce version control software.
    • Svn: The file is located in the Apache Subversion revision control system.
    • Teamcity: The file is located in the TeamCity build server.
    • Tfs: The file is located in the Team Foundation Server (TFS) source code management solution.
    • Tfs WiChangeSetsThe file is located in the Team Foundation Server (TFS) source code management solution with changesets.
    • Tfs WIVersioneditItemThe file is located in the Team Foundation Server (TFS) source code management solution with version edit items.
    • Vss: The file is located in the Windows SharePoint Services (WSS) system.
    • Winshare: The file is located in the WinShare manager.
    • Zip: The file is archived in a Zip file format.
  6. (Optional) Make other selections as required. Specify the IP address of the server, and the location of the file on server. Fields depend on the method that you selected in the preceding step.
  7. Click Create.
  8. Continue to define the reference by adding filters or analyzers.
  9. Click Configuration to specify configuration or template details.
    On the Configuration window, you can click Definition to return to this package definition.

To add a dependency between two references in a package

  1. Click the Define tab.
  2. From the left menu, select Packages.
  3. Click the name of the package that contains the references that need dependencies.
  4. Locate the reference that depends on other references being deployed before it, and click its Add New Dependency link.
  5. From the selection list, select the reference that must be deployed prior to this reference.
  6. Click Add.
    The system checks that no circular dependencies occur.
  7. Continue to add dependencies for the reference as needed.
  8. When done, you can click one of the buttons to Deploy or create a New Instance if wanted.

To add a dependency between two pieces of content in a repository

  1. Click the Define tab.
  2. From the left menu, select Repositories.
  3. Click the name of the repository that contains the contents to be edited.
  4. Locate the content that depends on other content being deployed before it, and click the corresponding link in the Dependencies column (it says None if the content has no existing dependencies; otherwise, it lists the dependencies).
  5. Select the content that must be deployed before this content.
  6. Click Submit.
    The system checks that no circular dependencies occur.
  7. Continue to add dependencies for the content as needed.

To add an analyzer to an existing package

  1. Click the Define tab.
  2. Click the package to which you want to add an analyzer.
  3. In the References section, click the name of a reference that is associated with an existing URI.
  4. In the Analyzers section, click Add Analyzer.
  5. In the Analyzers menu, select an appropriate analyzer.
  6. Click the Submit checkmark icon.
    The system creates a new analyzer and associates it with the resource reference.

To add properties to a package

  1. Click the Define tab.
  2. Click the package to which you want to add a property.
  3. In the Properties section, click Add Property on the right after the list of existing properties.
  4. Enter a name for the new property.
  5. Enter a value for the new property.
  6. To encrypt the property, click the Encrypt Value icon to the right of the value.
  7. Click the Submit checkmark icon.

 

Note

To enable proxy mode to establish the extra layer of security of connections between the dispatcher server and Remote System Call Daemon (RSCD) targets, define the appropriate properties in each environment. See Setting up NSH properties.

 

To set the format for package instance naming

  1. Click the Define tab.
  2. From the left menu, select Packages.
  3. Locate and click the name of the package for whose instances you want to set the name format.
  4. Click the value in the Instance Name Format column and change it to the template that you want.
  5. Click the Submit icon.

Note

Starting with BMC VaraLogix Q Deployment Automation version 4.3.01.03, you can make the system change the ID of the deployed instance automatically every time the instance is deployed. You can do so by adding one script line to either the existing action or the newly created action:

echo [VL_SET_PROPERTY][label]name=instance ID

For the Instance ID enter a unique name. Otherwise, the instance ID is not changed and thedeployment log says "that name already exists for the current package".

The following table describes the interpreted values that you can use for the instance name format.

Format

Description

Example

[#]

The next incremental value

123

%a

An abbreviated textual representation of the day

Sun

%A

A full textual representation of the day

Sunday

%d

Two-digit day of the month (with leading zeros)

08

%e

Day of the month, with a space preceding single digits. Not implemented as described on Windows. See below for more information.

8

%j

Day of the year, three digits with leading zeros

001 to 366

%u

ISO-8601 numeric representation of the day of the week

1 (Monday), 7 (Sunday)

%w

Numeric representation of the day of the week

0 (Sunday), 6 (Saturday)

%U

Week number of the given year, starting with the first Sunday as the first week

13 (for the 13th full week of the year)

%V

ISO-8601:1988 week number of the given year, starting with the first week of the year with at least four week days, with Monday being the start of the week

01 through 53 (where 53 accounts for an overlapping week)

%W

A numeric representation of the week of the year, starting with the first Monday as the first week

46 (for the 46th week of the year beginning with a Monday)

%b

Abbreviated month name, based on the locale

Jan

%B

Full month name, based on the locale

January

%m

Two-digit representation of the month

01 (January), 12 (December)

%C

Two-digit representation of the century (year divided by 100, truncated to an integer)

19 for the 20th Century

%g

Two-digit representation of the year going by ISO-8601:1988 standards (see %V)

09 for the week of January 6, 2009

%G

The full four-digit version of %g

2008 for the week of January 3, 2009

%y

Two-digit representation of the year

09 for 2009, 79 for 1979

%Y

Four-digit representation for the year

2038

%H

Two-digit representation of the hour in 24-hour format

00, 23

%I

Two-digit representation of the hour in 12-hour format

01, 12

%l (lowercase 'L')

Hour in 12-hour format, with a space preceding single digits

1, 12

%M

Two-digit representation of the minute

00 through 59

%p

Uppercase AM or PM based on the given time

AM for 00:31, PM for 22:23

%P

Lowercase am or pm based on the given time

am for 00:31, pm for 22:23

%r

Same as "%I:%M:%S %p"

09:34:17 PM

%R

Same as "%H:%M"

00:35

%S

Two-digit representation of the second

00, 59

%T

Same as "%H:%M:%S"

21:34:17

%X

Preferred time representation based on locale, without the date

03:59:16

%z

Either the time zone offset from UTC or the abbreviation (depends on operating system)

-0500 or EST for Eastern Time

%Z

The time zone offset/abbreviation option NOT given by %z (depends on operating system)

-0500 or EST for Eastern Time

%c

Preferred date and time stamp based on local

Tue Feb 5 00:45:10 2009

%D

Same as "%m/%d/%y"

02/05/09

%F

Same as "%Y-%m-%d" (commonly used in database date stamps)

2009-02-05

%s

UNIX Epoch Time time stamp (same as the time() function)

305815200 for September 10, 1979 08:40:00 AM

%x

Preferred date representation based on locale, without the time

02/05/09

%%

A literal percentage character ("%")

---

To set the next increment number for the auto-incrementing value

  1. Click the Define tab.
  2. From the left menu, select Packages.
  3. Locate and click the name of the package for whose instances you want to set the next instance number.
  4. Click the value in the Next Instance Number column and change it to the value that you want to use.
  5. Click the Submit icon.

To modify configuration data for a reference

  1. Click the Define tab.
  2. From the left menu, select Packages.
  3. Locate and click the name of the package with the reference that you want to edit.
  4. In the References subtab, click the reference that you want to edit.
  5. Click Configuration.
  6. Click Edit in the Configuration subtab.
  7. Edit the configuration data.
  8. When you are finished, click Save.

To enable role-based access permissions for a package

  1. Click Define in the top menu.
  2. In the Manage pane to the left, click Packages.
  3. On the List tab, find the necessary package and click its label to view details.
  4. Click the link next to the Role(s) label.
    The Manage Roles wizard opens.
  5. Add the access permissions for the necessary roles using the following actions:
    • To add access permission for one or more roles, select the necessary roles on the left, and click Add Item(s)
    • To add access permission for all roles, click Add All Items
    • To disable permissions for some roles, select them on the right and click Remove Item(s)
    • To disable permissions for all roles, click Remove All Items
  6. Click Save.

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*