Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description: Utilize Jenkins Job and SFDC Configurator Data Opsera’s Metadata Transformer Rules to apply Search & Replace Rules, transforming data in the pipeline.

Jenkins Tool Configuration

...

In a properly configured Jenkins tool, navigate to the Jobs tab and click the +New Jenkins Job button.

...

Fill out the Create New Jenkins Job form using the following information:

...

enables you to perform actions on metadata while transforming them in a pipeline workflow.

The types of operations supported are:

  • Search and Replace: Searches for a text and replaces it with the desired text.

  • Exclude: Excludes a specific (XML) tag from metadata component file during the metadata transformation

Workflow

The workflow entails building a Jenkins job that will be used to create the metadata transformer rule. The text that needs to be searched for and replaced is then defined, successfully configuring an Salesforce Metadata transformer rule. You can directly define the settings of the rule in the workflow phase called "Metadata Transform Step." You can get further details by looking at the related console logs after the pipeline has finished executing.

...

In this Section:

  • Create Jenkins Job

  • Set up Salesforce Metadata Transformer Rules

  • Configure Metadata Transform step in Pipeline

  • View Logs

Create Jenkins Job

  1. Login to Opsera and navigate to Operations > Tool Registry.

  2. Click View on the configured Jenkins tool, and click the Jobs tab.

  3. Click+ New Jenkins Job.

  4. In the Create New Jenkins Job popup, enter the following details:

  • Name: Enter a unique name for the job.

...

  • Job Type

...

  • : Select SFDC Jobs from the dropdown.

  • Build Step

...

  • : Select Salesforce

...

Click the Create button to save the new job.

SFDC Configurator Tool Configuration

...

In a properly configured SFDC Configurator tool, navigate to the Data Transformer Rules tab and click the +New SFDC Data Transformer Rules button.

...

Fill out the Create New SFDC Data Transformer Rules form using the following information:

...

  • Metadata Transformer from the dropdown.

  • Agent Label: Select a label from the dropdown.

  • Description: Enter a relevant description.

    Image Added

    5. Click Create.
    The new Jenkins job will be successfully created.

Set up Salesforce Metadata Transformer Rules

  1. Navigate to Operations > Tool Registry and choose a configured Salesforce Metadata configurator tool.

  2. Click Metadata Transformer Rules tab, and then click the +New Salesforce MetaData Transformer Rules.

  3. In the Create New Salesforce MetdaData Transformer Rules popup, enter the following details:

    • Name: Enter a unique name for the rule. This name will be fetched in the Data Metadata Transformer Rule drop-down in of the pipeline step configuration.

    • Operation - Select Search & Replace from the drop-down.

    • Component Type - : Select the a component type from the drop-downdropdown.

    • Component Name- Provide : Choose a Filter and apply a Value to it.Search Text - Text filter and enter the value. For example, you can define the filter to Contain the text CH_AddMemberInTeam.

    • Operation: You can choose Search & Replace or Exclude from the dropdown.
      Upon choosing Search and Replace, enter the following:
      (a) Search Text: Enter the text to search which will be replaced.
      (b) Replace Text - Text : Enter the text to be replaced with.

      Image Removed
  4. Click the Create button to save the new rule.

Operation cases:

...

Exclude:

  • Operation as “Exclude” plus any filter combination of the word will be excluded

    Image Removed
    • Image Added


      Upon choosing Exclude as Operation, enter the Tag details.

      Image Added
  1. Click Create.
    The metadata transformer rule will be saved.

Note

You can perform the Search & Replace with Tag filters

...

. This

...

is

...

applicable for components

...

with XML format. The

...

tag needs to be provided with the

...

hierarchical structure.

...

Example: For WorkflowAlerts to scan through senderAddress

...

, the tag name must be Workflow.alerts.senderAddress

...

Search & Replace (free text):

  • The word with given combination will be searched throughout and replaced

    Image Removed

Data Transform Pipeline Step Configuration

In the data transformer step with a configured Jenkins Tool, provide the following selections:

...

Configure Metadata Transform Step in Pipeline

  1. Open the pipeline for which you want to configure metadata transformer rules.

  2. Click the gear icon on the Metadata Transform Step, and define the following fields:

    • Jenkins Tool: Select a Jenkins tool that contains the configured Salesforce Metadata job with Salesforce Data Transformer Build.

    • Jenkins Job Type - : Select Opsera Managed Job.

    • Tool Job - : Select the jenkins Jenkins job which was configured in Step 1is configured using the Create Jenkins Job step.

    • Specify Salesforce Credentials - : Select the SFDC Salesforce Metadata Configurator tool containing the data added metadata transformer rule(s) added.

    • Data Metadata Transformer Rule - : Select the data metadata transformer rule name.

    • Build/Xml XML Step Info - Select the “Create Package” step

...

 Successful completion of Pipeline:

...

Console Log:

...

    • : Select the step created for create package in the workflow.

      Image Added
  1. Click Save.
    The metadata transformer rules will be applied to the step.

View Logs

Upon successful Pipeline run, you can view the Pipeline logs and Console logs to learn more about the pipeline status and its execution details.

  • To view Pipeline Logs, open the pipeline and click Summary. Click the Metadata transform step to view the relevant Pipeline logs.

    Image Added
  • You can also view console logs for a specific step in a pipeline. Open a pipeline log and click Console Output under Actions, and view the logs under Console Log tab.

    Image Added