Analyzer modules

In BMC Release Package and Deployment (RPD), you can create custom analyzers with the following built-in modules:

Add Artifact Configuration Entries module

The Add Artifact Configuration Entries module invokes an action on a server and parses the output of that action to set individual configuration settings on an artifact. This is a payloaded action invocation.

The system parses the output of the action by looking for configuration setting specifications, one per line. Configuration settings must conform to the bracket notation ([ ]) used in the console. For each line that matches, a configuration entry is set on the instance. The action can output additional data, but only lines that match the regular expression '^[.?].+=.$' are considered configuration settings. Configuration data should be formatted as follows: [App Name][Layer1][Layer2]property=value, where you can specify several "Layers". Normally, any found configuration settings are appended to the configuration data associated with an artifact.

To create an analyzer with the Add Artifact Configuration Entries module, you must specify the following parameters:

Parameter

Description

Config Entry Generation Action

Action to invoke to generate the configuration entries

Server To Run Action On

Server on which to invoke an action

Remove Duplicate Entries

If set to Yes, removes duplicate entries from the configuration data for an artifact

Delete Reference module

The Delete Reference module deletes the artifact invoking the analyzer with this module. Use this analyzer to delete an artifact that was already extracted or processed into other artifacts.

Parameters: None

Explode Reference module

This module extracts the individual contents of a single artifact into separate, new artifacts. The new artifact names are set to the base file name of the specific entry in the artifact being extracted.

To create an analyzer with the Explode Reference module, you must specify the following parameters:

Parameter

Description

Strip Path From Files

If set to Yes, removes the path of the selected file in the newly generated artifact

Delete source content

If set to Yes, the original artifact will be removed

If the Strip Paths from Files parameter is set to Yes, the path name is removed from the contents of the newly created artifact. If the Delete source content parameter is set to Yes, the original artifact is automatically deleted after all contents of the calling artifact were extracted and the new artifacts were created.

Explode Reference Selectively module

The Explode Reference Selectively module has such functions as the Explode Reference module with the following exceptions:

  • This module supports a Select Pattern parameter to identify specific content in an artifact to extract it into new artifacts.
  • When the extraction is complete, the original artifact is not deleted. This enables multiple invocations of the analyzer with this module on an artifact to extract content using several different patterns.

To create an analyzer with the Explode Reference Selectively module, you must specify the following parameters:

Parameter

Description

Strip Path From Files

If set to Yes, removes the path of the selected file in the newly generated artifact

Select Pattern (Empty for all files)

Regular expression that selects the files to extract from the artifact

Artifact Name To CreateThe new Reference Name that is created to store the extracted artifacts

Extract Zip module

The Extract Zip module has such functions as the Explode Reference module, except that it extracts the contents of an artifact that contains a zip file. After all the contents of the calling artifact are extracted and new artifacts are created, the original artifact is deleted. Use analyzer with this module on an artifact that was fetched from a specific zip file to create new artifacts from the contents of that zip file.

Parameters: None

Expose WAR Contents module

The Expose WAR Contents module populates an artifact table of contents with the list of contents in a WAR file. This allows a WAR file to be pulled into an artifact as a single deployable entity, while still enabling specific deployment processes to be triggered based on the contents of that WAR file.

Parameters: None

RPM Version Tag module

Analyzer with the RPM Version Tag module enables you to deploy the specified package instance from BMC Release Package and Deployment (RPD) by using BMC Release Process Management (RPM). Using this analyzer, you can automatically create a version tag in RPM for the specified application component and in the defined environment. After you add the analyzer to the appropriate package, and then create an instance from this package, a corresponding component version tag is automatically generated in RPM.

To create an analyzer with the RPM Version Tag module, you must specify the following parameters:

ParameterDescription
RPM Server URLURL used to access RPM
RPM User TokenToken of the RPM user
ApplicationName of the RPM application for which a version tag will be created
ComponentName of the RPM component for which a version tag will be created
EnvironmentName of the RPM environment on which a version tag will be created

For more information, see RLM deploy package instance by component version.

Set Artifact Meta-Data module

The Set Artifact Meta-Data module invokes an action on a server and parses the output of that action to set metadata properties on an artifact. This invocation is a payloaded action.

The system parses the output of an action looking for name=value, one per line. For each line that matches, the values are added to the artifact metadata. If the name of the property is Version, that value is set as the artifact content-specific version. The action can output additional data, but only lines that match the regular expression ^(.+?)=(.*)$ are considered metadata.

To create an analyzer with the Set Artifact Meta-Data module, you must specify the following parameters:

Parameter

Description

Meta-Data Generation Action

Action to invoke to generate the artifact metadata

Server To Run Action On

Server on which to invoke an action

Set Artifact Properties module

The Set Artifact Properties module invokes an action on a server and parses the output of that action to set individual properties on an artifact. This is a payloaded action invocation.

The system parses the output of an action by looking for name=value, one per line. For each line that matches, a property is set on the instance. The action can output additional data, but only lines matching the regular expression ^(.+?)=(.*)$ are considered property settings.

To create an analyzer with the Set Artifact Properties module, you must specify the following parameters:

Parameter

Description

Property Generation Action

Action to invoke to generate the artifact properties

Server To Run Action On

Server on which to invoke an action

Translate Deployment Path module

The Translate Deployment Path module modifies the content path names stored in an artifact temporarily at deployment.

The analyzer with this module has such functions as the Translate Path module, except that it is invoked at deployment and the translated paths are not preserved. Only the target server that receives the files reflects the altered path names.

To create an analyzer with the Translate Deployment Path module, you must specify the following parameters:

Parameter

Description

Search For

Regular expression to match in the path of the files in an artifact

Replace With

String to replace the matched pattern with

Translate Path module

The Translate Path module modifies the content path names stored in an artifact. The artifact contents are scanned, and when the Search for pattern matches all or part of the path name for a specific piece of content, the matched portion of the path name is replaced by the Replace With string.

The analyzer with this module performs the translation process by creating a new artifact and copying the original contents to the new artifact, translating the path name during the copy process. The original artifact is removed when the copy is complete.

To create an analyzer with the Translate Path module, you must specify the following parameters:

Parameter

Description

Search For

Regular expression to match in the path of the files in an artifact

Replace With

String to replace the matched pattern with

Delete Non-Matching EntriesIf set to Yes, the parameter removes all entries that are not matched with the pattern
Delete Source ContentIf set to Yes, the parameter removes the source content

If the analyzer configuration has the Delete Non-Matching Entries parameter set to Yes, any entries that do not match the regular expression in the Search For parameter are removed.

Related topics

Using analyzers

Was this page helpful? Yes No Submitting... Thank you

Comments