2.2. Configuration of Required Modules

Prev Next

This chapter looks at the list of modules that build up a briefing system. This chapter also gives the list of fields that should be created in each of the module-constituents and later mapped to the corresponding settings in the Briefing System module.

2.2.1. List of required modules for briefing system


Required modules are modules without which Briefing System cannot work properly. Optional modules are modules that are created to enable additional features in Briefing system. The list of modules and their preferred types:

Required

Additional (recommended)

  • Chains

  • Briefing

  • Pages

  • Headlines

  • Products

  • Product on Briefing

  • Prices

  • Product Pictures

  • Logos

  • Suppliers

  • Shops

  • Log info

  • Comments to page

2.2.2. Module with Chains


The Chain module is the module which is recommended to be created the first, as many following modules will have fields that reference this module.

Field name

Field type

Description

Chain

Text Field

Field with a name of Chain

Partner #

Text Field

Defines unique ID of the Chain, so that other modules can reference to it

Abbreviation

Text Field

This field is used for “Product Overview Export” functionality

2.2.3. Module with Briefings


Briefing module represents the central storage point of all the existing briefings in the system. Every time new briefing is added, the corresponding entry is created in the Briefing module.

The following table shows the list of fields and their types that should be created in the Briefing module. The “Description” column gives a short note regarding the information that will be stored in each particular field.

Field name

Field type

Description

Briefing name

Text Field

Field with a briefing name

Briefing number

Text Field

Field that will hold briefing number

Briefing type

Text (Select box)

The options of this field define the briefing category on the briefing list

Briefing code

Text Field

Field with a briefing code

Briefing start date

Date

Campaign start date

Briefing end date

Date

Campaign end date

Chain

Module link to the field Chain in the Chain module

This field determined to which chain the briefing belongs

2.2.4. Module with Pages


Module with Pages, corresponding to its name, will hold entries of all the pages that briefings have.

Create the following fields:

Field Name

Field Type

Description

Page name

Text field

Field that will hold the name of the page

Sorting

Integer

Field that will determine the sort order of pages in briefing

Briefing

Module link to the Briefing name field in the Briefing module

This field will link a page to a specific briefing

Template

Text field

This field is used to store a template for page preview

Page Element

Module link to the field in Page elements module/Multi Select

This field will link a page to a specific page element with additional info. Prefill Automatically checkbox should be checked for this field

2.2.5. Module with Headlines


Headline is an essential part of every briefing page. Every page must have at least one headline. Module with Headlines should be configured with a Workflow, as the workflow statuses are the controllers of users’ access to the content of each headline, and regulate the workflow of briefing lifecycle.

Please, refer to the table below for the list of Headline module fields.

Field Name

Field Type

Description

Headline

Text field

Field with the headline name

Status

Status field or Select box

Status field that controls access to the headline and represents the briefing workflow. Create status values that represent the milestones of the briefing workflow.

Divisions

Division/Select box

This field represents responsible division that will be assigned to each headline.

Max # of Products

Integer

This field value will control the number of products that can be added to a specific page.

Page name

Module link to the Page name field in the module Pages

This field links a headline to a specific page.

2.2.6. Module with Products


This module represents the Catalog of Products in the Briefing system. This module holds the products that are then added to briefings.

Every client creates his own list of fields that match his production needs, but for very basic configuration it is only necessary to create the following list of fields:

Field Name

Field Type

Description

Product name

Text field

Field that holds the name of the product

Product number

Text field

Field with Product number

Sub product

Module link to the Product name field of the current module

This field is used for configuration of combined products functionality and will hold the sub products in the combination of products

Preview picture

Text field

Field with preview picture

Product category

Text field/Select box

Field with Product category. It is used for “Product Overview Export” functionality

2.2.7. Module with Products on Briefing


Product on Briefing module holds the entries that represent the products that are already used on briefings. Unlike the Product module, which is actually a catalog of items, entries in the Product on briefing module holds the information applicable to the product on a specific briefing (for example: Vendor and Customer data).

Create the following fields that are required to perform basic briefing configuration.

Field Name

Field Type

Description

Campaign text

Text field

Descriptive text for the product promotion

Headline

Module link to the Headline field in the Headline module

This fields holds the reference of a particular product on briefing to a headline

Product number

Module link to the Product number field in the Products module

This field holds the reference to the product in the catalog module

Campaign main product

Module link to the Campaign text field in the current module

This field holds the value of the main product in product combination

Campaign sub product

Module link (multi-select) to the Campaign text field in the current module

This field holds the value of the sub product in product combination

Combined product

Module link to the Campaign text field in the current module

This field represent the combined product item

Preview

Text field

Field with preview

Logo

Module link to the Logo name field of the Logo module/Multi Select Field

Field with logos, selected for product on briefing

Priority

Text field/Select box

This field is used for filtering products in Combined Product window

Price

Module link to the "Name" field in "Prices" module.

Field linking product on briefing entry with prices.

2.2.8. Module with Prices


The Price module in a briefing system is created to hold financial data related to products on briefing. This information includes different product prices and discounts that are applied to a particular product on a particular briefing. Every time a product from the Catalog is added to briefing, an entry is created in the Price module that holds the price data for this very product on this very briefing.

Create the following fields in the Price module:

Field Name

Field Type

Description

Briefing

Module link to the Briefing name field in the Briefing module.

This field holds the reference of the product price to a specific briefing

Product number

Module link to the Product number field in the Products module

This field holds the reference of the price to a product

Chain

Link to the Chain field in the Chains module

This field holds the reference of the product price to a chain

Price

Decimal numeral

Field with price

Discount

Decimal numeral

Field with discount

Original Price

Decimal numeral

Field with original price

Headline

*unnecessary starting from version 12.0.0

Link to the Headline field in the Headline module

Field with a name of a headline