Transaction Manager: Fields
Summarize
Summary of Transaction Manager: Fields
Transaction Manager enables administrators to create and manage different field types—text, number, Boolean, picklist, and date/time—at either the transaction level or the transaction line level. This flexibility allows for the customization of transaction data, enhancing data management and operational efficiency.
Show less
Key Features
- Field Types: Administrators can choose from five field types: text, number, Boolean, picklist, and date/time. Each type serves specific purposes and supports different data formats.
- Field Levels: Fields can be created at two levels:
- Transaction Level: Fields that hold general transaction information, such as account details and pricing totals.
- Transaction Line Level: Fields specific to individual transaction items, appearing in the transaction line grid.
- System-Provided Fields: A set of default fields is available for transaction and transaction line levels, including pricing and account information, simplifying setup and data entry.
- Custom Field Creation: Admins can add custom fields via the Admin UI or upload them using the Matrix Loader, with specific associations required in the blueprint.yaml file.
Key Outcomes
By utilizing the Transaction Manager's field capabilities, ServiceNow customers can effectively tailor their transaction processes to meet unique business requirements. This customization leads to improved data accuracy, enhanced reporting, and better alignment with business rules and workflows.
Understand the five major field type options: text, number, Boolean, picklist, and date/time. Learn how to create new fields using the Admin UI.
In Transaction Manager, administrators are able to create text, number, Boolean, picklist, and date/time fields. Admins also have the choice of creating fields at the transaction level or at the transaction line level.
Fields created at the transaction level sit outside the transaction line grid. These fields commonly contain information about the account, addresses, list price total, total discount, and net total for all line items.
Fields created at the transaction line level sit in the transaction line grid. These can appear as column fields or as fields in the Line Details, Model, and Slide Out UI effects.
The selected level will ultimately impact the field’s availability for rules, which also have a transaction and transaction line level.
In the buyside screenshot below, the sections marked 1 are transaction-level fields; the fields in the section marked 2 are transaction line-level fields.
Field types
Transaction Manager provides the following field types.
- Text
- Number
- Boolean
- Picklist
- Date/Time
Options for these types are described in the sections that follow.
System-provided fields
Transaction Manager provides the administrator with a set of system-provided fields that are often used in transaction processing. There are system-provided fields at both the transaction level and the transaction line level.
The system-provided fields provide fields in the following categories:
Transaction level:
- Pricing information
- Opportunity information
- Transaction information
- Account information
For a complete list of transaction-level fields, see Transaction Manager: Transaction-level system fields.
Transaction line level:
- Pricing information
- Transaction line information
- Configuration information
- Product information
- Order information
For a complete list of line-level fields, see Transaction Manager: Line-level system fields.
You can also add custom fields to a blueprint in Transaction Manager. Custom fields added via the Transaction Manager Admin UI are automatically associated with the blueprint. However, custom fields uploaded by using the Matrix Loader must be associated with the blueprint by means of the blueprint.yaml file. To do so, add a list to the blueprint.yaml file that details the field variable names to be associated with the blueprint.
The following sample blueprint.yaml file shows the field associations in the relatedFields section:
---
blueprints:
- variableName: default
relatedFields:
- txn.custom.transactionNumber
- txn.custom.quoteName
- txn.custom.quoteValidUntil
- txn.custom.paymentTerm
- txn.custom.accountSpecificDiscount
- txn.custom.agreementDiscount
- txn.line.custom.agreementLineDiscount
- txn.line.custom.customerLineDiscount
lastModifiedBy: mark@logik.io.sfdcdev
name: Transaction Manager Default
stages: /blueprints/default/stages/stage.yaml
description: Transaction Manager Default blueprint
layouts: null
events: /blueprints/default/events/events.csv
views: /blueprints/default/views/views.yaml
fieldOptions: /fields/fieldOptions.csv
rules: null
fields: /fields/fields.csvCreating a new field using the Admin UI
To add a new field to the Transaction Manager blueprint, follow these steps:
-
Navigate to the Transaction Manager Admin UI.
- Click Associated Fields.
- Click Create Field to create a new field.
The New Field dialog box opens.
- Enter a name in the Name field.
As the name is entered, it is mirrored in the Variable Name field. By default, the variable name is the same as the entered name, but in camel case with all spaces and special characters removed. For example, if you enter the name Customer Billing Address, the automatically entered variable name is customerBillingAddress. To create a custom variable name, click the pencil icon to the right of the variable name field and enter your own value.
- Select a level to choose whether the field is a transaction level field or a transaction line level field.
- Choose the type of field you are creating from the five available field types.
- Click Save.
The field editor page opens. Select the desired options.
Text field options
The name and variable name appear at the top left of the field editor page. You can change the name, but the variable name is locked and can be changed only by deleting the field and re-adding it to the blueprint. Optionally, you can add a description of the field here. If the field is to be required on the buyside layout, toggle the Required switch.
The Default Access field controls access to this field in the default view. Editable makes this field Read/Write accessible. If you select No Access, the field is hidden from view on the buyside layout and is not accessible via APIs.
You can enter a default value for the text field in the Default Value field.
The Minimum Field Length and Maximum Field Length values let you set the minimum and maximum number of characters that can be entered.
Number field options
The name and variable name appear at the top left of the field editor page. You can change the name, but the variable name is locked and can be changed only by deleting the field and re-adding it to the blueprint. Optionally, you can add a description of the field here. If the field is to be required on the buyside layout, toggle the Required switch.
The Default Access field controls access to this field in the default view. Editable makes this field Read/Write accessible. If you select No Access, the field is hidden from view on the buyside layout and is not accessible via APIs.
Number fields can take one of three forms: number, currency, or percentage. Choose which form you want the field to take.
The Unit Label field lets you specify the unit label for the number field. If the field is for currency, the unit label is the default currency symbol for your CPQ site. If the field is a percentage, the unit label is the percent symbol (%).
The Minimum Value and Maximum Value fields let you set the minimum and maximum allowable values for the field.
You can enter a default value for the number field in the Default Value field.
Boolean field options
The name and variable name appear at the top left of the field editor page. You can change the name, but the variable name is locked and can be changed only by deleting the field and re-adding it to the blueprint. Optionally, you can add a description of the field here. If the field is to be required on the buyside layout, toggle the Required switch.
The Default Access field controls access to this field in the default view. Editable makes this field Read/Write accessible. If you select No Access, the field is hidden from view on the buyside layout and is not accessible via APIs.
You can set whether the Boolean field defaults to True by setting the Default Checked toggle. If the toggle is not set, the field defaults to False.
In the True Label field, you can set the text value of the field when the Boolean value is True. For example, you can set the displayed value to “Yes” when the value is True. Similarly, the False Label field lets you set the text when the field value is False.
Picklist field options
The name and variable name appear at the top left of the field editor page. You can change the name, but the variable name is locked and can be changed only by deleting the field and re-adding it to the blueprint. Optionally, you can add a description of the field here. If the field is to be required on the buyside layout, toggle the Required switch.
The Default Access field controls access to this field in the default view. Editable makes this field Read/Write accessible. If you select No Access, the field is hidden from view on the buyside layout and is not accessible via APIs.
Selection Type defines the picklist as either single-select menu or multi-select.
Comparison Type lets you determine how the value of the menu option is treated when it is used in a comparison: as a text value or as a number value.
The + Add Picklist Options link allows you to add the first menu option to this picklist menu field.
When adding a picklist option, consider the following field values:
- Order
- Use this field to determine the order of the menu options in the menu. The lower the number, the higher the place in the menu. As a general guideline, number your menu options 10, 20, 30, 40, and 50 instead of numbering them 1 to 5. This leaves room in the sequence if you new items must be inserted later.
- Option Label
- The option name that the user sees in the Transaction Manager layout.
- Option Value
- The value that CPQ uses to identify this menu option.
- Selected
- Determines whether a menu option is the default menu value.
- Description
- A description of the menu option.
- Image URL
- The URL of a graphic image that can be displayed instead of text.
Click Save Option to add the option to the list of options for the picklist field. To add additional menu options, click +Add Option.
Date/Time field options
The name and variable name appear at the top left of the field editor page. You can change the name, but the variable name is locked and can be changed only by deleting the field and re-adding it to the blueprint. Optionally, you can add a description of the field here. If the field is to be required on the buyside layout, toggle the Required switch.
The Default Access field controls access to this field in the default view. Editable makes this field Read/Write accessible. If you select No Access, the field is hidden from view on the buyside layout and is not accessible via APIs.
The Default Value field lets you set the default date and time setting for the field. The value is converted to UTC in YYYY-MM-DDTHH:MM:SSZ format.
The Not Before and Not After fields let you to set the minimum and maximum date and time values for the field.
For more information about the Date/Time field type, see Transaction Manager: Date and time fields.