HTML To Markdown activity

An activity that converts HTML code to Markdown format.


HTML To Markdown activity

Configure the HTML To Markdown activity

Prerequisites

Good to Know

How to Start

  1. Open Process Builder.

    For information about how to open this screen, refer to Process Builder.


    Open Process Builder
  2. In Process Builder, in the Activity Library, open the Document tab.

    Document tab
  3. On the Document tab, drag the HTML To Markdown activity onto your process.

    HTML To Markdown activity

General Configuration

Specifies the basic settings for the HTML To Markdown activity.

Figure: General Configuration screen

General Configuration screen

Good to Know

  • Documentation for this screen is provided for completeness. The fields are mostly self-explanatory.

Fields

Field NameDefinition

Display Name

Description:
Specifies the activity name that shows in your process.
Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • Spaces
Default Value:
None
Accepts Variables:
No
Example:
This is a common configuration field that is used in many examples. Refer to:
  • Examples - Step-by-step use case examples, information about what types of examples are provided in the AgilePoint NX Product Documentation, and other resources where you can find more examples.

Description

Description:
Specifies an optional text description for your activity.
Allowed Values:
More than one line of text.
Default Value:
None
Accepts Variables:
No

HTML To Markdown Configuration

Specifies the information to convert HTML code to Markdown format.

Figure: HTML To Markdown Configuration screen

HTML To Markdown Configuration screen

Fields

Field NameDefinition

Read HTML From Repository / Read HTML From This Variable

Description:
Specifies the source for HTML code to convert to Markdown format.
Allowed Values:
  • Read HTML From Repository - Configures the Source Repository screen to specify a repository that stores an HTML file.
  • Read HTML From This Variable - Specifies a variable that stores the HTML code.
Default Value:
Read HTML From Repository
Accepts Variables:
Yes

Markdown Formatter

Description:
Specifies the formatting scheme for the content that is converted to Markdown.
Allowed Values:
A Markdown formatter from the list.
Default Value:
Default
Accepts Variables:
No

Configure Markdown Conversion Features

Description:
Shows the HTML tags configured to convert to Markdown.

You can configure the HTML tags on the HTML To Markdown Configuration > Select Features screen.

Allowed Values:
Read only.

Select Features Select Features icon

Opens this Screen:
HTML To Markdown Configuration > Select Features screen
Function of this Screen:
Specifies the HTML tags to convert to Markdown format.

HTML To Markdown Configuration > Select Features

Specifies the HTML tags to convert to Markdown format.

Figure: HTML To Markdown Configuration > Select Features screen

HTML To Markdown Configuration Select Features screen

Fields

Field NameDefinition

Features

Description:
Shows the list of HTML tags that can be converted to Markdown format.
Allowed Values:
If an HTML tag is selected, when this activity runs, the activity only converts the content in the specified HTML tags to Markdown format

If none of the HTML tags is selected, the activity converts all content in HTML code to Markdown format.

Default Value:
None

Filter Filter icon

Description:
Shows the HTML tags in the list based on the value you specify.
To Open this Field:
  1. Click Filter Filter icon.
  2. On the filter screen, select your operator.
  3. Enter the values to show in your list.
Allowed Values:
  • Is equal to
  • Is not equal to
  • Starts with
  • Contains
  • Does not contain
  • Ends with
Default Value:
Is equal to

Source Repository

Specifies the original, or source, location for the HTML file.

Figure: Source Repository screen

Source Repository screen

Fields

Field NameDefinition

Source Repository

Opens this Screen:
The configuration screen for your document repository. The specific screen that shows depends on your document repository type.

For more information, refer to Document Repositories.

Function of this Screen:
Configures your document repository.

HTML To Markdown Target Configuration

Specifies where to store the content that is converted to Markdown format.

Figure: HTML To Markdown Target Configuration screen

HTML To Markdown Target Configuration screen

Fields

Field NameDefinition

Store Markdown Contents To Repository / Store Markdown Contents In This Variable

Description:
Specifies where to store the content that is converted to Markdown format.
Allowed Values:
  • Store Markdown Contents To Repository – Configures the Target Repository screen to specify a repository to store the Markdown file.
  • Store Markdown Contents In This Variable – Specifies a variable to store the content that is converted to Markdown format.
Default Value:
Store Markdown Contents To Repository
Accepts Variables:
Yes

File Name

Description:
Specifies the file name for the output content to store in the target repository.

HTML code is converted to Markdown format and stored in the target location with the name specified in this field.

To Open this Field:
  1. On the HTML To Markdown Target Configuration screen, select Store Markdown Contents To Repository.
Allowed Values:
One line of text (a string).

Represents:

  • A file name
Default Value:
None
Accepts Variables:
Yes

Target Repository

Specifies the target location for your output Markdown file.

Figure: Target Repository screen

Target Repository screen

Fields

Field NameDefinition

Target Repository

Opens this Screen:
The configuration screen for your document repository. The specific screen that shows depends on your document repository type.

For more information, refer to Document Repositories.

Function of this Screen:
Configures your document repository.