Skip to main content

Vault Configuration

Overview

This section describes the configuration and operational management of the Inextor Vault.

It covers:

  • Vault setup
  • Business configuration parameters
  • Azure API Management
  • Common actions
  • Entities and roles
  • Profiles and users
  • Product groups and products
  • Factories and lines
  • Product licensing
  • Request management
  • User rights
  • Managing settings
  • Vault management and processes
  • Vault business scenarios
  • Operation drivers

The purpose of Vault configuration is to provide Vault users with the information needed to handle operation, authentication, access rights, and management aspects through the Vault website and Vault Administration tools.

Production data uploaded on Vault and Vault data are kept for at least five years.

1 Vault Setup

All operations needed to set up a Vault are listed below.

If a specific regulation is used, additional steps are listed in the corresponding operational guide.

When to do the actionWhat to doDocumentation reference
AlwaysDefine the Vault code, usually three lettersVault website: Administration - Production Line
AlwaysDefine the Liz ranges associated to the customerInextor Liz ranges documentation
If it is a Small Tobacco ManufacturerImport the TP certificates in the root Vault to generate licenses from thereCertificate Tool
AlwaysImport the root, TP, and Vault certificates in the Windows Certificate Store of the machines running the Vault ServiceCertificate Tool / Certificate Manager
AlwaysCreate Vault certificates and import them into the Vault databaseCertificate Tool / Certificate Manager
AlwaysCreate the Vault database using the DACPACsVault database administration guide
AlwaysCheck that the .NET framework installed on the server is aligned with the version defined in the specificationsGeneral installation procedures / Vault Service
If it is an Azure VaultAsk the IT & Infrastructure team to deploy the VaultInternal deployment process
If it is an on-premises VaultCopy binaries, set up services and IIS, and configure Azure pipelines for future upgradesIIS configuration / Vault Proxy IIS configuration
AlwaysCreate an entity with the LE and MAN roles for the factoryVault Business Scenarios / Vault website: Administration - Entity
AlwaysCreate a factory associated to the entity created above. The License All Products checkbox should be enabledVault website: Administration - Factory
AlwaysCreate a connection with the request file provided by the GateVault website: Administration - Factory
If it is an Azure VaultCreate IAM users to be accessed using the Inextor accountVault website: Administration - User
AlwaysEnable the Audit Log managerAudit Log Manager documentation

2 Business Configuration Parameters

The Vault can be configured to grant different levels of access to the site.

These privileges are user-account based and are usually decided by the Vault owner or administrator.

These settings are defined in the VaultService.exe.config configuration file.

ParameterDescriptionPossible values
LizApprovalRequiredDefines whether approval is required when a Liz is registered on the Vault. Approval is done by an account with GOV role, or by a GOV-role user with the relevant Liz validation operation rightfalse / true
LizApprovalRequiredAn approval request is initiated on the Liz Configuration GUI by clicking Register online. This creates a request on the Vault request page, under the Liz tab, where the request must be approved or rejected
MSKApprovalRequiredDefines whether approval is required when an MSK is generated on the Vault and downloaded to a Lizfalse / true
MSKApprovalRequiredAn approval request is initiated on the Liz Configuration GUI by clicking Register MSK. This creates a request on the Vault request page, under the MSK tab, where the request must be approved or rejected
SKUApprovalRequiredDefines whether the government or administrator must approve Stock Keeping UnitsNone, Local, Import, Local Import
SKUApprovalRequiredNone: no approval required. Local: only local-origin Stock Keeping Units require approval. Import: only imported Stock Keeping Units require approval. Local Import: all Stock Keeping Units require approval
ProductionOutdatedIntervalDefines how long a Gate and its serializers can be disconnected from the Vault before production batches are marked as invalid with the error code Outdated[NumberOfDays]d
ProductionOutdatedIntervalBy default, the status remains outdated even if the connection is restored. This behavior is configurable with the key OutdatedStatusBlocked
GateReportTypeDefines whether only printed codes are reported or whether generated codes are also reportedNone / AdditionalQty
GateNotifyTypeDefines whether Gates with a production connection should send Stock Keeping Units and production data to this Vault when the Stock Keeping Units or production batches belong to another VaultNone, SKU, PROD, SKU PROD

3 Using Azure API Management

Overview

A firewall protects the Vault as the primary security measure.

Usually, additional security can be applied by restricting access to internal company IP addresses or a small set of external machines. For the Vault, this is not always possible because all Gates linked to the Vault must be able to access it.

Azure API Management can be used as an additional security layer.

Azure API Management provides a controlled set of machines, with a small range of known IP addresses, through which clients must pass to access the Vault. The Vault firewall can then be configured to accept incoming connections only from those machines.

This service is implemented through the Vault Azure API Management Operation Driver.

Configuration guide

To use Azure API Management, the following steps are needed:

StepDescription
1Create or reuse an Azure API Management instance. Copy its subscription ID, resource group name, and service name into the configuration window
2Create or reuse an application registration in Azure. Write down its application ID in the configuration. It does not need API permissions or authentication platform details
3Create a client secret for the application registration and write it down in the configuration window
4In the Azure API Management instance, add the Contributor role to the service principal mapped to the application registration
5In the Azure API Management instance, upload the three certificates of the internal certification authorities of the Vault. These are usually found in a Gate .licx file: root, TP, and Vault certificates

Certificate note

Azure API Management requires a password for uploaded .pfx certificates. It may be necessary to import and export certificates again for this purpose.

If the IIS hosting the Vault API uses a self-signed certificate, it is recommended to upload it as well.

4 Common Actions

The table below defines common actions executed on the Vault website.

Action types describe the phase where the action typically occurs:

  • Initial: a new entity is being onboarded to the Vault
  • Running: normal operation
  • Manage: typical administration tasks during normal operation
Action typeRoleActionReference
InitialADMCreate entities and add rolesEntities and Roles
InitialADMCreate administration profile for the new entityProfiles and Users
InitialADMCreate administration user for the new entityProfiles and Users
InitialADMCreate product groupsProduct Groups and Products
InitialAnyCreate additional profiles for the new entityProfiles and Users
InitialAnyCreate additional users for the new entityProfiles and Users
InitialLECreate products, may require ADM approvalProduct Groups and Products
InitialMAN / IMPAdd factories, requires ADM approvalFactories and Lines
InitialMAN / IMPManage factory connectionsFactories and Lines
InitialLEAdd product licenses to a manufacturer or importerProduct Licensing
InitialMAN / IMPAdd product licenses to factoriesProduct Licensing
Initial-Line registration, may require ADM approvalFactories and Lines
Initial-MSK registration and MSK download, may require ADM approvalFactories and Lines
Initial / RunningADMApprove or reject account, role, product, factory, production line, MSK, and volume control requestsRequest Management
RunningAnyCheck codeCode Checking
RunningAnyMonitor production batchesManaging Production in the Vault
RunningAnyProduction reportsManaging Production in the Vault
RunningLEManage volume control orders for manufacturers/importers, requires ADM approvalSerialization with Volume Control - Operation
RunningLEManage volume control assignments to factoriesSerialization with Volume Control - Configuration
ManageADMManage entities and rolesEntities and Roles
ManageAnyManage usersProfiles and Users
ManageAnyManage profilesProfiles and Users
ManageLEManage products, may require ADM approvalProduct Groups and Products
ManageMAN / IMPManage factories, requires ADM approvalFactories and Lines
ManageMAN / IMPManage factory connectionsFactories and Lines
ManageLEManage licensed products to a manufacturer or importerProduct Licensing
ManageMAN / IMPManage licensed products to factoriesProduct Licensing
note

Only users associated with an entity having the specified role can execute the specified action. In addition, the user must have the specific operation rights required for that action.

5 Entities and Roles

Introduction

Entities and roles are managed from the Vault website under Administration - Entity.

  • GOV users can manage entities and roles if they have the required operation rights
  • Non-GOV users can manage roles for their own entity if they have the required operation rights
  • Changes made by non-GOV users must be approved by a GOV user before activation

Operation rights required

ActionOperation rights required
Create entityAccount - List, Create
Create entity with authorized statusAccount - Validate
Add roleRole - List, Create
Add role with authorized statusRole - Validate
Edit entityAccount - List, Edit
Edit entity with authorized statusAccount - Validate
Edit roleRole - List, Edit
Edit role with authorized statusRole - Validate

Entity creation and adding roles

StepAction
1The stakeholder requests an account with specified roles. This step is performed outside the Vault
2Go to the Entity Management page
3Click Create on the Entity Management page. A wizard is launched
4In the Entity step, enter the entity details and click Next. The status must be Authorized to activate the account
5In the Role step, click Create Role. A popup window opens
6Select a role and enter the role details. Click Save. The status must be Authorized for the role to be activated
7Repeat the previous two steps for every new role to assign to the entity
8In the Role step, click Next
9In the Validate step, review all entries and click Validate. The wizard closes
10If the entity or role requires approval, see Request Management

Edit entities

StepAction
1Go to the Entity Management page
2In the grid, expand the entity to be edited and click Edit. A wizard starts
3In the Entity step, edit the fields and click Next. The status must be Authorized to activate the change
4In the Role step, click Next
5In the Validate step, review all entries and click Validate. The wizard closes
6If the entity requires approval, see Request Management

6 Profiles and Users

Introduction

Profiles and users are managed from the Vault website:

  • Administration - Profile for profiles
  • Administration - User for users

Any user can manage profiles and users if they have the required operation rights.

GOV users can manage profiles and users for any entity. Non-GOV users can manage profiles only for their own entity.

Operation rights required

ActionOperation rights required
Create profileProfile - List, Create
Edit profileProfile - List, Edit
Delete profileProfile - List, Delete
Create userUser - List, Create
Edit userUser - List, Edit
Delete userUser - List, Delete

Create profile

StepAction
1Go to the Profile Management page
2Click Create. A wizard starts
3In the Actor step, pick the entity that the profile is assigned to and click Next
4In the Profile step, enter profile details and click Next
5In the Operation step, select profile operations and click Next
6In the Validate step, review all entries and click Validate. The wizard closes

Edit profile

StepAction
1Go to the Profile Management page
2Click the Pen icon of the profile to edit. A wizard opens
3In the Profile step, edit the profile details and click Next
4In the Operation step, select profile operations and click Next
5In the Validate step, review all entries and click Validate. The wizard closes

Delete profile

StepAction
1Go to the Profile Management page
2Click the Recycle bin icon of the profile to delete. A confirmation popup opens
3Click Yes to delete the profile

Create user

The PDF begins this procedure with:

StepAction
1Go to the User Management page
note

The uploaded extraction only provided the first step of the Create User procedure. If needed, we can extract this specific page separately and rebuild the full procedure.

7 Product Groups and Products

Introduction

Product groups are managed from the Vault website under Administration - Product Group.

Products are managed from the Vault website under Administration - Product.

For business cases where product groups are required, product groups must be created before products are added to the system.

  • ADM users can manage product groups if they have the necessary operation rights
  • LE users, or ADM users acting on their behalf, can manage products if they have the necessary operation rights
note

Product groups are part of a Vault add-on and may not be available or enabled on all installations.

Operation rights required

ActionOperation rights required
Create product groupTaxLevel - List, Create, Validate
Edit product groupTaxLevel - List, Edit
Create productsSKU - List, Create
Edit productsSKU - List, Edit
Approve productsSKU - List, Validate, ADM user only
note

The Vault can be configured for auto-approval of products. In that case, Legal Entities can manage products without approval from an ADM user with Validate rights on the SKU operation.

Product groups and products can be created or edited using the Excel Import Interface.

Create product group

StepAction
1Go to the Product Group Management page
2Click Create. A popup dialog opens
3Enter a product group code and details. Click Save. The status must be Authorized to activate the product group

Edit product group

StepAction
1Go to the Product Group Management page
2In the grid, expand the product group to edit and click Edit. A popup dialog opens
3Enter product group details and click Save. The status must be Authorized before changes come into effect

Create product

StepAction
1Go to the Product Management page
2Click Create. A wizard launches
3In the Owner step, pick the Legal Entity that owns the product. Click Next
note

The uploaded extraction only provided the beginning of the Create Product procedure. If needed, we can extract this page separately and complete the full flow.

8 Factories and Lines

Introduction

Factory management is handled from the Vault website under Administration - Factory.

Production line management is handled from the Vault website under Administration - Production Line.

  • MAN / IMP users, or GOV users acting on behalf of a Legal Entity, can manage factories if they have the necessary operation rights
  • Production Line and MSK registration requests are done from the Liz Configuration GUI through the factory Gate, not directly on the Vault
note

The Vault can be configured for auto-approval of Liz instances. In that case, factories can register Liz instances without approval from a Government user.

note

The Vault can be configured for auto-approval of MSKs. In that case, factories can register MSKs without approval from a Government user.

Operation rights required

ActionOperation rights required
Create factoryGate - List, Create
Approve factoryGate - Validate
Edit factoryGate - List, Edit
Approve factory after editGate - Validate
Manage connectionGate - List, Edit
Line registrationNot applicable; executed from factory
Approve lineLiz - List, Validate
MSK registrationNot applicable; executed from factory
Approve MSKLiz - List, Validate

Enable secure access to Vault through Azure API Management

If secure factory-to-Vault connection is required, the Azure API Management Operation Driver must be activated.

Create factories

StepAction
1Go to the Factory Management page
2Click Create. A wizard launches
3In the Owner step, pick the Manufacturer or Importer that owns the factory. Click Next
4In the Details step, enter factory details. Click Next. Check License All Products to enable automatic licensing of all products to the factory
5In the Validate step, review all entries and click Validate. The wizard closes
6A GOV user must approve the factory. See Request Management

Edit factories

StepAction
1Go to the Factory Management page
2In the grid, expand the factory to edit and click Edit. A wizard opens
3In the Details step, edit factory details and click Next
4In the Validate step, review all entries and click Validate. The wizard closes
5A GOV user must approve the factory. See Request Management

Manage connection details

StepAction
1Using the Gate Administration GUI at the factory, request a new connection and download a certificate request file. For license versions 3.2.0.0 or older, this step should be omitted
2Go to the Factory Management page
3In the grid, expand the factory and click Manage Connection. A popup opens
4Select a connection type and license version
5Click Issue Certificate. Upload the certificate request file and download the license file. For license versions 3.2.0.0 or older, click Renew Certificate to download the license file
6Click Save. The popup closes
7Using the Gate Administration GUI at the factory, import the license file and enter the connection details

Production line registration

StepAction
1A Liz registration request is done from the Serializer Configuration GUI, not from the Vault
2If the Liz Configuration reports message 227: Serializer {0} is signed by a non-trusted Certificate Authority, a GOV-role user with the required certificate operation rights must set the root certificate for the Liz as trusted
3Optionally, a GOV user must approve the production line. See Request Management

MSK registration

StepAction
1From the Liz Configuration GUI, request an MSK
2Depending on configuration, a GOV user may need to approve the MSK. The MSK is downloaded to the production line through the factory Gate
3The MSK status eventually changes from Pending to Not Registered. From the Liz Configuration GUI, register the MSK
4Only one MSK can be registered per Vault. If an MSK is already registered for the Vault, it must be unregistered before a new MSK can be registered
5Depending on configuration, a GOV user may need to approve the MSK. See Request Management

9 Product Licensing

Introduction

Product licensing to a Manufacturer or Importer is managed from the Vault website under Administration - Entity.

Product licensing to factories is managed from the Vault website under Administration - Factory.

  • LE users, or GOV users acting on behalf of a Legal Entity, can manage product licensing to MAN / IMP entities if they have the required operation rights
  • MAN / IMP users, or GOV users acting on behalf of a Legal Entity, can manage product licensing to their factories if they have the required operation rights

Operation rights required

ActionOperation rights required
Add license to MAN / IMPSKU2MAN - List, Create
Edit license to MAN / IMPSKU2MAN - List, Edit
Add license to factorySKU2Gate - List, Create
Edit license to factorySKU2Gate - List, Edit
note

License products to MAN / IMP and license products to a factory can be created or edited using the Excel Import Interface.

Add licensed products to a Manufacturer or Importer

note

If an entity has both LE and MAN and/or IMP roles, licensing is automatic for that entity and the steps below are unnecessary.

StepAction
1Go to the Entity Management page
2In the grid, expand the entity that products are licensed to and click Add or Edit Products. A wizard launches
3In the Products step, click Show Product Picker. A popup opens
4In the popup, select the products to license. Click Validate. The popup closes. Click Next
5In the Validate step, review all entries and click Validate. The wizard closes

Edit licensed product to a Manufacturer or Importer

StepAction
1Go to the Entity Management page
2In the grid, expand the entity that products are licensed to and click Add or Edit Products. The wizard launches
3In the Products step, click Edit Product. A popup dialog opens
4In the popup, edit the license and click Validate. The popup closes. Click Next
5In the Validate step, review all entries and click Validate. The wizard closes

License products to a factory

StepAction
1Go to the Factory Management page
2In the grid, expand the factory to license products to and click Edit. A wizard opens
3In the Details step, click Next
4In the Products step, click Show Product Picker. A popup dialog opens
note

The uploaded extraction only provided the first part of the factory product licensing flow. If needed, this can be completed through a more focused extraction.

10 Request Management

Introduction

The requests feature was originally designed for use with a governmental Vault system.

Over time, the feature has become largely obsolete in some scenarios due to practical considerations.

Current state

Stock Keeping Units transmitted from a factory through the Gate system are automatically marked as approved in INEXLINE / INEXPRESS.

This automatic approval process exists for several reasons:

  1. Individual approval of each Stock Keeping Unit was time-consuming and impractical, even for governmental Vault systems
  2. The system evolved to streamline operations and may automatically approve Stock Keeping Units from trusted sources such as Gate
  3. The Stock Keeping Unit approval process is considered deprecated, although it may still exist for backward compatibility

Request visibility and approval

  • Users associated with an entity having the GOV role can approve or reject requests if they have the necessary operation rights
  • Users associated with any entity can view their own entity’s requests if they have the necessary operation rights

Operation rights required

Request typeOperationRights requiredDescription
AccountAccountListView or reject own pending entity requests
AccountAccountValidateAccept or reject pending entity requests
AccountAccountDeleteSet entity as deleted
CertificatesCertificatesList, View, ManageAccept or reject pending certificate requests
AdminToolAdminToolList, Create, Edit, Manage, ValidateVault website plugin management, including Liz License Manager and SMDL subscription request management
LizLizListView pending production line requests
LizLizValidateAccept or reject pending production line requests
EstampEstamp2MANListView or reject own pending e-stamp requests
EstampEstamp2MANValidateAccept or reject pending e-stamp requests
ExportExportListView pending export requests
ExportExportValidateAccept or reject pending export requests
FactoryGateListView pending factory requests
note

When Liz approval is enabled, the government or administrator must explicitly approve each Liz registration.

11 User Rights

Introduction

On the Vault, roles are associated to an account.

Each role has a set of rights determined by the Vault owner. These mappings are defined in the RoleOperationMapping.xml configuration file.

Each account holder can create Vault users with their own credentials. The account holder can assign each user a set of rights, limiting access on the Vault.

The rights that a user can receive are limited by the rights associated with the roles held by the account holder.

Once a user is created, that user can create additional users if they have the required rights.

Operations

Rights are divided into operations, and operations are divided into levels.

The following operations exist on Vaults:

OperationDescription
AccountManagement of accounts
AdminToolPlugin management on the Vault website, including Liz License Manager and SMDL replication
ApplicationSettingsRead and update Vault application settings
AuditHistoryView audit history, including configuration changes
CertificatesRegister Liz configured with a license from another Vault
CheckCallCenterDefines whether a city can be associated with a checked code when using call center
CheckCounterfeitedDefines whether a code can be marked as counterfeited
CheckOriginDefines which call types can be selected when checking a code
CheckPermutationDefines whether a code can be rechecked with permutations, for example exchanging similar characters
CheckSUPIRights for checking a code and defining what information is shown when checking a code
CheckUsedDefines whether a code can be marked as already used
CheckWasteDefines whether a code can be seen and marked as waste
CodeExportDefines whether a code can be marked as exported
ReportDamagesDefines whether a code can be marked as non-repairable damaged
ReportEndOfLifeDefines whether a code can be marked as end-of-life
ReportStolenDefines whether a code can be marked as stolen
LizManagement of MSKs, for backward compatibility only
DashboardAccess to the dashboard
DlrMessagesManagement and history of DLR messages if the DLR communication driver is enabled
EconomicOperatorsManagement of TPD Economic Operators
Estamp2MANDeprecated. Management of volume control allocations to MAN / IMP
Estamp2GateDeprecated. Management of volume control allocations to factories
ExportExport management
FacilitiesManagement of TPD facilities
FactoriesCodeFormatsRead access to the list of factory code formats
IdIssuersManagement of TPD ID issuers
IdIssuerHorizonsConfiguration of horizons for TPD ID issuers
MachinesManagement of TPD machines
RoutingManagement of TPD routing rules
MessagingManagement of messages in the Vault Administration application
MonitoringRead access to the Monitoring screen
MyReportInstanceDeprecated. Execution of private SSRS reports
MyReportItemDeprecated. Management of private SSRS reports
MyReportScheduleDeprecated. Management of private SSRS report schedules
PublicReportInstanceDeprecated. Management of public SSRS reports
ReportClassDeprecated. Management of SSRS report user classes
ReportItemDeprecated. Management of existing SSRS reports
ReportScheduleManagement of public report schedules
OperationDriversManagement of operation drivers in Vault Administration
OrdersManagement of TPD orders and primary code checks
PbiReportItemManagement of Power BI reports
PbiReportScheduleManagement of Power BI report schedules
PbiReportScheduleSubManagement of Power BI report subscriptions
PbiReportUserTagManagement of Power BI report users
SerializationOrdersManagement of serialization orders
SatCodeReportsManagement of SAT security code reports
SatReferenceDataManagement of SAT reference data
SecurityCodeOrderManagement of SAT security code orders
SSCCManagement of SSCC
SSrsUsersDeprecated. Management of SSRS users
LogsRights for viewing logs
GateManagement of Gates
MSKAccept or reject MSK requests
PRODManagement of production batches
ProfileManagement of user profiles
ReferenceDataManagement of serialization configurations
RoleManagement of roles associated to an account
ServerInfoAccess to server information plugin
SKUManagement of Stock Keeping Units
SKU2MANManagement of Stock Keeping Unit licensing from LE to MAN / IMP
SKU2GateManagement of Stock Keeping Unit licensing from MAN / IMP to Gate
TaxLevelManagement of product groups when tax level support is enabled
UserManagement of users
WasteManagement of waste
VirtualLizsManagement of virtual Liz instances
VaultAdminReportingAccess to Vault Administration reports

An operation is mostly related to access rights for a given web page or related subpages. For operations starting with Check, the operations relate to functions and features on the Check Code page.

12 Managing the Settings

Vault settings are documented in the Vault Administration application settings.

Default values ensure a correct installation. If needed, settings can be adjusted for specific scenarios with help from the support team.

Cleanup settings are documented separately in the cleanup configuration documentation.

13 Vault Management and Processes

Entities, roles, users, and profiles

The Vault access model is based on the following structure:

ObjectDescription
EntityTypically one per stakeholder
RoleDefines permissions and functionalities inherited by the entity
ProfileDefines a set of permissions for a group of users
UserAssigned a subset, or all, of the privileges that the entity has

An entity can have several roles.

Multiple profiles can exist per entity.

Multiple users can exist per entity.

A user receives privileges either through assigned profiles or explicit permission assignment.

note

The privileges given to a role are configurable and are defined by the Vault owner.

Vault roles

There are four roles on government Vaults.

ADM / GOV role

The ADM role, also referred to as GOV, is for entities that own or administer the Vault.

Depending on the industry, this entity can represent a governmental institution. The terms ADM and GOV are used interchangeably in the source document.

Main tasks:

  1. Control and monitor the Vault
  2. Manage users

LE role

The LE role is for a Legal Entity.

Main tasks:

  1. Register and manage products intended to be sold on the local market controlled by the administrator entity
  2. License products to a domestic Manufacturer and/or Importer entity
  3. Place e-stamp orders and assign them to a domestic Manufacturer or Importer entity
  4. Manage users

MAN role

The MAN role is for a domestic Manufacturer.

This means a manufacturer that has production sites in the same country as the Vault, with the intention to sell on the local market and/or export to other markets.

Main tasks:

  1. Register manufacturing sites and machines
  2. License products to factories
  3. Assign e-stamps to factories
  4. Monitor production
  5. Manage users

IMP role

The IMP role is for an Importer.

Importers import products intended to be sold on the local market where the Vault is installed. Products are produced at manufacturing sites in another country.

Main tasks:

  1. Register manufacturing sites and lines
  2. License products to factories
  3. Assign e-stamps to factories
  4. Monitor production
  5. Manage users

14 Products and Product Licensing Process

The product and licensing process can be summarized as follows:

  1. An entity with the LE role registers products, meaning Stock Keeping Units
  2. Optionally, GOV approves or rejects the products
  3. The LE licenses products to MAN and/or IMP entities
  4. MAN / IMP entities license products to factories
  5. Factories, represented by Gates, can then use the licensed products

15 Vault Business Scenarios

Overview of Vault types and structure

Inextor uses two main types of Vaults to store and manage production data:

  1. Private Vaults: used by manufacturers to manage their own production data
  2. Government Vaults: used by government agencies to monitor production in their jurisdiction

Core components

Every Vault consists of:

  • Entities, representing manufacturers, factories, or markets
  • Users, representing people who need access to Vault data
  • Roles, defining permissions and data access
  • Data segregation rules, controlling what data each user can see

Main roles

RoleDescription
Administrator / ADMINHas full access to all data and functions, can override data segregation rules, but permissions can still be restricted per user
Legal Entity / LECan define and create products in the Vault and controls product definitions
Manufacturer / MANProduces goods and belongs to the Vault owner entity; used for affiliates or subsidiaries
Importer / IMPProduces goods but does not belong to the Vault owner; used for third-party manufacturers

Access control flow

  1. Each user is assigned to exactly one entity
  2. Entities are given roles that define base permissions
  3. Users inherit permissions from their entity’s roles
  4. Individual user permissions can be restricted within the entity’s roles

Role combinations and rules

  • A factory can be either MAN or IMP depending on its relationship to the Vault owner
  • An entity with LE and MAN roles can have factories only as MAN
  • An entity with LE and IMP roles can have factories only as IMP
  • An entity with MAN and IMP roles can have factories as either MAN or IMP

Data segregation methods

Data visibility can be controlled in four ways.

By market

Users see data for specific assigned markets.

This shows production from all factories for those markets. Users cannot see production for other markets.

By factory

Users see data from specific assigned factories.

This shows all markets those factories produce for. Users cannot see data from other factories.

By market and factory

This is the most restrictive option.

Both criteria must match for the user to see the data.

No segregation

Administrators have full visibility of all data.

Production order data access

There are two key entity associations per production order:

  1. Product-owning entity
  2. Factory-owning entity

Users can see production data from their assigned entity perspective.

Gate-Vault connections

  • Each Gate connects to only one Vault
  • Each Gate reports data under a single Vault entity
  • A one-to-one relationship is required

Product definition setup

Product definitions, or Stock Keeping Units, can be created in two ways:

  1. Created on Gate and sent to Vault, which is the most common flow
  2. Created directly in Vault

16 Managing the Operation Drivers

Operation drivers can be managed from:

  • Plugins in the Vault website
  • Configuration → Op. Drivers in the Vault Administration Client

Operation drivers are custom components that expose either:

  • Web services
  • Background tasks

Vault operation drivers

Operation driver nameWhen to use
Vault ATTP Communication DriverTo link the Vault to ATTP in order to send commissioning events or code pairing events
Vault Azure API Management DriverTo use Azure API Management to secure access to the Vault
Vault Code Storage DriverTo store SUPIs generated during productions involving Inextor codes
Code Transmission DriverObsolete and unused
Dentsu Primary Repository Code Transmission DriverTo upload codes into the Dentsu Primary Repository as if it were the EU Router, for testing purposes
DLR Communication DriverTo send commissioning or code pairing events to DeLaRue for productions involving TPD and DLR regulations
External Code DriverTo extract the contents of a code chunk, typically 20,000 codes, using the Vault administration program
Primary Code Check DriverTo check that TPD codes received from an ID issuer are considered valid by the Primary
TPD Notification DriverTo notify an external system about specific TPD events on the Vault, such as order sent to ID issuer, downloaded codes, or errors
User Notifications DriverTo send mail when events occur on the Vault
Vault Telemetry DriverTo measure and store traffic between Gate and Vault
Zetes DriverTo send TPD external codes received by the Vault to the Zetes repository

17 Installation Types

Azure deployment

Azure deployment:

  • Requires coordination with the IT & Infrastructure team
  • Uses Azure IAM for user management
  • Uses the Vault website user administration process for user management details

On-premises deployment

On-premises deployment:

  • Requires local server access
  • Requires IIS configuration
  • Requires manual service setup
  • Requires local infrastructure and application configuration

18 Pre-Installation Tasks

Certificate preparation

For Small Tobacco Manufacturer scenarios:

  • Import TP certificates to the root Vault
  • Generate required licenses
  • Use the Certificate Tool

Certificates to import into the Windows Certificate Store:

  • Root certificate
  • TP certificate
  • Vault certificate

Database preparation

Database preparation includes:

  • Verifying SQL Server installation
  • Ensuring appropriate permissions
  • Following Vault database administration guidance

.NET Framework verification

.NET Framework verification includes:

  • Checking the installed version against the technical overview
  • Installing required components where needed

19 Installation Steps

Azure deployment

  1. Contact the IT & Infrastructure team for deployment
  2. Verify Azure subscription and permissions
  3. Follow the deployment process specified by the IT team

On-premises deployment

IIS setup

  1. Follow IIS configuration setup
  2. Configure application pools
  3. Apply required IIS configuration

Binary file deployment

  1. Copy software files to the designated location
  2. Configure services

Database installation

Deploy the database using DACPAC according to the Vault database administration guidance.

20 Post-Installation Configuration

Vault configuration

  • Define the Vault code, typically three letters
  • Configure Liz ranges for the customer

Entity setup

  • Create the entity with LE and MAN roles according to Vault Business Scenarios
  • Configure it using the Vault website under Administration - Entity

Factory configuration

  • Create a factory associated with the entity
  • Enable the License All Products option
  • Use the Vault website under Administration - Factory

Connection setup

  • Process the Gate request file
  • Establish connections
  • Follow the Vault website Factory Administration process

User management for Azure

  • Create IAM users
  • Configure access permissions

Audit configuration

  • Enable Audit Log manager
  • Configure audit settings according to Audit Log Manager guidance

21 Verification

After setup, verify:

  • Database connectivity
  • Certificate installation
  • Entity and factory setup
  • Connections
  • Audit logging