securityInfo Business Rule Component

A Security Info business rule component saves the user name, user domain, and user profile information associated with a print request to the data map when this business rule component is run.

The values added to the data map can be referenced by using the following reserved keys, which are under the namespace and name that you specify in the business rule component.

Reserved Key	Description
profile	The user profile of the user associated with the print request. In the data map, a user profile is represented by the reserved keys that are children of profile. For more about user profiles, see Configuring User Profiles.
userdomain	The domain (if any) specified in Loftware Enterprise SP for the user associated with the print request.
username	The Loftware Enterprise SP user name of the user associated with the print request.

The following is the syntax for a Security Info business rule component.

Important! Content in a business rule is case sensitive. This includes business rule component names, attributes, and values.

Note: For each business rule component, most elements and attributes are optional, but you should specify enough to achieve the functionality that you intend. In most cases, you can omit attributes that are not relevant to your task and default values will be used. You must specify a name and a namespace. Except where otherwise indicated, attributes accept string values.

About the syntax documentation

<triggers>

<trigger eventTrigger="ENQUEUE|PRINTJOBDETAIL|LABEL|Custom_Event" priority="integer" propagation="NONE|BEFORE|AFTER"/>

</triggers>





<executionCondition>



</executionCondition>





<defaultData>



<entry name="Name_of_data_map_entry"
dataType="STRING|INTEGER|BOOLEAN|NUMBER|BINARY|DATE"
mergePolicy="MERGE_ALL|MERGE_NONE|MERGE_FROM_CHILD|MERGE_TO_PARENT"
action="OVERRIDE|NOT_EXISTS|DELETE|APPEND|PREPEND">

<value>Value_of_data_map_entry</value>

</entry>

</defaultData>





<parameters>





<parameter parameterKey="Name_of_parameter"
dataType="STRING|INTEGER|BOOLEAN|NUMBER|BINARY|DATE" resolveValue="true|false">

<parameterValue>Initial_value_of_parameter</parameterValue>

</parameter>

</parameters>





<preProcessingEvents>

<preProcessEvent eventName="Custom_Event" includeSiblings="true|false" />

</preProcessingEvents>

<postProcessingEvents>

<postProcessEvent eventName="Custom_Event" includeSiblings="true|false" />

</postProcessingEvents>

<errorProcessingEvents>

<errorProcessEvent eventName="Custom_Event" includeSiblings="true|false" />

</errorProcessingEvents>





<children>



</children>

</securityInfo>

Syntax Tips

Additional information is available about the following items.

alias

configuratorType

For a business rule component that was generated by using the Configurator In Application Design, the graphical interface for configuring a business rule by creating component sets, each containing component blocks that are run when a particular trigger event occurs., this attribute is a numeric identifier that usually indicates what type of component block In a business rule designed in Configurator, an element that either adds or changes data, incorporates conditional or loop logic, or implements branching. The XML represented by a component block includes one or more business rule components. the business rule component is part of.

If the value of the attribute is 0, then it indicates one of the following about the type of component block:

None: The business rule component was created by using the XML Editor or a version of Loftware Enterprise SP prior to Loftware Enterprise SP 3.0, and therefore is not part of a component block.
Block fragment: The business rule component was generated by the Configurator as part of a component block. Refer to the configuratorType of the parent of this business rule component to determine the type of component block.

Tip: This attribute is automatically included in business rule components generated by the Configurator. If you are editing a business rule by using the XML Editor, you do not need to add this attribute, and you can either ignore or delete existing instances of this attribute with no effect on the functionality of the business rule.

Value	Type of Component Block
0	None or block fragment
1	Conditional
2	Format Date/Time
4	Run Data Map Script
5	Get First Row
7	Print
8	Configure Test Data
10	Run Another Component Set
11	Conditional List
12	Run Another Business Rule
13	Repeat for All Rows
16	Prepend/Append
17	Conditional True/False
18	Update
19	Fixed Repeat
20	Log Data
23	Delete

For information about different types of component blocks, see Component Blocks.

failOnError

For a securityInfo business rule component, this attribute specifies whether the job should fail if an error occurs when attempting to find the user or the profile. The default value is true.

Value	Description
true	If an error occurs when Loftware Enterprise SP attempts to find the user or the profile, then the job fails.
false	If an error occurs when Loftware Enterprise SP attempts to find the user or the profile, the job may proceed.

mergeRowToJobData

Required for a dataService, forLoop, or whileLoop business rule component. Optional for a securityInfo business rule component. This attribute specifies whether a row of data retrieved from a database should be copied into the job data of the data map, or whether it should exist in the data map only as current row data. The default value is false.

Tip: For a securityInfo business rule component, it is typically recommended that you set mergeRowToJobData to true so that the profile, user name, and domain are saved to the data map.

Value	Description
false	The data retrieved from the database exists in the data map only as current row data that child business rule components can access, but peer business rule components cannot.
true	The data retrieved from the database exists in the data map as current row data that child business rule components can access, but peer business rule components cannot. The row data is also copied to the job data portion of the data map for this business rule component. Peer and child business rule components can access this job data in the data map. When the row data is merged into the job data, the mergePolicy used is MERGE_NONE and the action used is OVERRIDE. These are not configurable. Example A dataService business rule component named DBQUERY exists in the Body namespace and retrieves a value for PRINTERNAME from a database. If mergeRowToJobData is true, then peers of the dataService business rule component can access the value of PRINTERNAME in the data map by using ${/Body/DBQUERY/PRINTERNAME}.

Value

Description

false

The data retrieved from the database exists in the data map only as current row data that child business rule components can access, but peer business rule components cannot.

true

The data retrieved from the database exists in the data map as current row data that child business rule components can access, but peer business rule components cannot.

The row data is also copied to the job data portion of the data map for this business rule component. Peer and child business rule components can access this job data in the data map.

When the row data is merged into the job data, the mergePolicy used is MERGE_NONE and the action used is OVERRIDE. These are not configurable.

Example

A dataService business rule component named DBQUERY exists in the Body namespace and retrieves a value for PRINTERNAME from a database. If mergeRowToJobData is true, then peers of the dataService business rule component can access the value of PRINTERNAME in the data map by using ${/Body/DBQUERY/PRINTERNAME}.

name

namespace

Required for a business rule component. The namespace is a string used to identify the parent of the business rule component specified by the name attribute. Do not include a leading slash.

For a securityInfo or systemDiagnostics business rule component, the name and namespace indicate the path to the data saved in the data map. Alternatively, for a systemDiagnostics business rule component if the name and the namespace are empty strings, then the diagnostic information is saved to the !DIAGNOSTICS! namespace.

Value	Description
Body	The namespace for fields in a label template created in Label Design is Body. Note: Integrations automatically prefix paths in the print job file with /Body where needed.
runtime	The namespace for system properties is runtime.
Custom Namespace	You can create custom namespaces that are named at your discretion. The children of a namespace should always be business rule components, not other namespaces.

Value

Description

Body

The namespace for fields in a label template created in Label Design is Body.

Note: Integrations automatically prefix paths in the print job file with /Body where needed.

runtime

The namespace for system properties is runtime.

Custom Namespace

You can create custom namespaces that are named at your discretion. The children of a namespace should always be business rule components, not other namespaces.

sticky

If parameters are used in the business rule component, whether the value of each parameter remains fixed throughout the execution of the business rule component. The default value is false.

Value	Description
true	The values of parameters in the business rule component remain fixed throughout the execution of the business rule component. If the value is a data ref, the value initially obtained for the data ref is used for the duration of the execution of the business rule component.
false	The values of parameters in the business rule component can be overridden during the execution of the business rule component. If the value is a data ref and the value of that data ref changes during the execution of the business rule component, then the current value of the data ref is used.

Tip: For assistance with a business rule that you have created or to have Loftware create business rules for you, contact Loftware's Professional Services Group.