July 30, 2023

tPaloRuleList – Docs for ESB 7.x


Lists all rules, formulas, comments, activation status, external IDs from a given

The tPaloRuleList retrieves a list of rule details from
the given Palo database.

Discovering the read-only output schema of tPaloRuleList

The following table presents information related to the read-only output schema of the
tPaloRuleList component.






The internal identifier/id for this rule..



The formula of this rule. For further information about this
formula, see the Palo user guide.



The user-defined external id.



The user-edited comment on this rule.



Indicates if this rule had been activated or not.

tPaloRuleList Standard properties

These properties are used to configure tPaloRuleList running in the Standard Job framework.

The Standard
tPaloRuleList component belongs to the Business Intelligence family.

The component in this framework is available in all Talend

Basic settings

Use an existing connection

Select this check box and in the Component List click the relevant connection component to
reuse the connection details you already defined.

Note that when a Job contains the parent Job and the child Job,
Component List presents only the
connection components in the same Job level.

Host Name

Enter the host name or the IP address of the host server.

Server Port

Type in the listening port number of the Palo server.

Username and

Enter the Palo user authentication data.

To enter the password, click the […] button next to the
password field, and then in the pop-up dialog box enter the password between double quotes
and click OK to save the settings.


The name of the database where the cube of interest


Type in the name of the cube in which you want to retrieve the
rule information.

Schema and Edit

A schema is a row description. It defines the number of fields
(columns) to be processed and passed on to the next component. When you create a Spark
Job, avoid the reserved word line when naming the

Click Edit
to make changes to the schema. If the current schema is of the Repository type, three options are available:

  • View schema: choose this
    option to view the schema only.

  • Change to built-in property:
    choose this option to change the schema to Built-in for local changes.

  • Update repository connection:
    choose this option to change the schema stored in the repository and decide whether
    to propagate the changes to all the Jobs upon completion. If you just want to
    propagate the changes to the current Job, you can select No upon completion and choose this schema metadata
    again in the Repository Content


Built-in: The schema is created
and stored locally for this component only. Related topic: see

Talend Studio User


Repository: The schema already
exists and is stored in the Repository, hence can be reused. Related
topic: see
Talend Studio User

Advanced settings

Catcher Statistics

Select this check box to collect log data at the component

Global Variables

Global Variables

NB_RULES: the number of rules. This is an After variable
and it returns an integer.

EXTERNAL_RULEID: the external ID of the rule. This is a
Flow variable and it returns a string.

ERROR_MESSAGE: the error message generated by the
component when an error occurs. This is an After variable and it returns a string. This
variable functions only if the Die on error check box is
cleared, if the component has this check box.

A Flow variable functions during the execution of a component while an After variable
functions after the execution of the component.

To fill up a field or expression with a variable, press Ctrl +
to access the variable list and choose the variable to use from it.

For further information about variables, see
Talend Studio

User Guide.


Usage rule

This component can be used in standalone or as start component of
a process.


Outgoing links (from this component to another):

Row: Main; Iterate.

Trigger: Run if; On Subjob Ok; On
Subjob Error; On Component Ok; On Component Error.

Incoming links (from one component to this one):

Row: Iterate

Trigger: Run if; On Subjob Ok; On
Subjob Error; On Component Ok; On Component Error.

For further information regarding connections, see

Talend Studio User


The output schema is fixed and read-only.

Due to license incompatibility, one or more JARs required to use
this component are not provided. You can install the missing JARs for this particular
component by clicking the Install button
on the Component tab view. You can also
find out and add all missing JARs easily on the Modules tab in the
perspective of your studio. You can find more details about how to install external modules in
Talend Help Center (https://help.talend.com)

Retrieving detailed rule information from a given cube

The Job in this scenario retrieves rule details applied on the dimensions of a given


To replicate this scenario, proceed as follows:

Setting up the Job

  1. Drop tPaloRuleList and tLogRow from the component Palette onto the design workspace.
  2. Right-click tPaloRuleList to open the
    contextual menu.
  3. From this menu, select Row > Main to link the two components.

Configuring the tPaloRuleList component

  1. Double-click the tPaloRuleList component
    to open its Component view.


  2. In the Host name field, type in the host
    name or the IP address of the host server, localhost
    for this example.
  3. In the Server Port field, type in the
    listening port number of the Palo server. In this scenario, it is
  4. In the Username and Password fields, type in the authentication information. In
    this example, both of them are admin.
  5. In the Database field, type in the
    database name where the dimensions applying the rules of interest reside,
    Biker in this example.
  6. In the Cube field, type in the name of
    the cube which the rules of interest belong to.

Job execution

Press F6 to run the Job.

Details of all of the rules in the Orders cube are retrieved
and listed in the console of the Run view.


For further information about the output schema, see Discovering the read-only output schema of tPaloRuleList.

Document get from Talend https://help.talend.com
Thank you for watching.
Notify of
Inline Feedbacks
View all comments
Would love your thoughts, please comment.x