Table of Contents |
|---|
1. Scope
Process Configuration
Behavior Controller
Cross-Configuration
Security
Captcha & SSL
Roles and Access
Users and Permissions
Audit
Automated Processes
Tasks
Cron Jobs
Checklists
Integrations
1.1. Software Coverage
Initial Configuration
Security
System Access
Roles & Access
User and Role Configuration
User Listing
Restricted Lists
Auditing
Calculation System
Calendar Closure
Optional Cron Jobs
Data Quality Review
Integrations
2. Definitions
Environment Variables: An environment variable allows configuring the system according to the company's needs. These variables can alter the display of modules and their content, depending on the value they hold, as well as modify their behavior based on the assigned value.
Cron: The command-line utility "cron" is a task scheduler in Unix-like operating systems. Users who configure and maintain software environments use "cron" to schedule jobs, also known as cron tasks, to run periodically at fixed times, dates, or intervals.
Captcha: A test used by websites and web services to verify whether the user is a human internet user and not a robot; it involves simple identifications of letters, numbers, or images.
3. Key Features
Permissions and Roles
Auditing
Security
4. Conditions
For the proper utilization of the software functionalities, it is necessary to have previously defined technical and/or business elements, such as:
5. Operation
Juan Pablo is the administrator of the platform and needs to carry out the configurations for various modules. Juan Pablo should perform this task at the beginning of the project to ensure that each module aligns with the company's requirements.
Module configurations are done at the project's outset but may require changes as the business operation progresses. All system configuration takes place from the configuration hub. In the previous documents, you can find the modules we've discussed before, but there are also three blocks of topics that need to be configured and are not covered in earlier documents because they represent general system configurations.
The three topics Juan Pablo needs to ensure are configured are:
Initial Configurations
System Processes
Security
6. Configurable Elements
The following are the elements to configure in the software:
Permissions and Roles
Auditing
Security
6.1. Main Configurations
Initial Setup
Master Clear
Basic Setup
Territory
Customers
Orders
Configure Catalogs
Logistics
Payments
Quick Start: Access Permissions
Returns
Integrations
Issues
Party
Colors
Interaction
Permissions
Products
System Processes
Tasks
Processing Triggers
Version
Environment Variables
Currency
Document Ranges
Sequences
Functions per Strategies
Functions
Rule Engine Processes
Document Features
Checklist
Inconsistency Groups
Integrations Settings
Copy Database
Security
Roles
Dashboard Manager
Schedule
Audit Manager
External Integrations
Processing Audit
6.2. Configuration of Related Modules
…
6.3. Module Configuration
6.3.1. Initial Configuration
All the configurators in this block or section share the common purpose of providing easy and quick guidance for the initial configurations required to get the software up and running.
6.3.1.1. General Clear
This configurator is responsible for performing a mass deletion based on the selected component or module.
It allows you to delete:
Only images
All characteristics
Characteristics and information
6.3.1.2. Basic Configuration
This configurator allows you to make the necessary system parameterizations. Some of the configurations found here include:
Currency Configuration
Logo Configuration
Roles and Users Configuration
Campaign Configuration
Within this configurator, you'll find the action to configure. Clicking on it will display the necessary configurations according to the process. It enables easy, quick, and understandable configuration by following the listed steps for proper operation and setup.
6.3.1.3. Territory
This configurator enables parameterizations for all necessary territory and geographic zone workflows. For proper operation and parameterization, it's important to follow the step-by-step instructions, as some modules depend on previous configurations.
Within this configurator, you'll find parameterizations such as:
Political and territorial division configuration
Necessary associations, like currency to a specific zone
6.3.1.4. Customers
This configurator allows you to make parameterizations for all necessary customer workflows. For proper operation and parameterization, it's important to follow the step-by-step instructions, as some modules depend on previous configurations.
Additionally, you can configure environment variables related to this parameterization.
Within this configurator, you'll find parameterizations such as:
Configuration of document types
Configuration of contracts
Configuration of allowed file types
6.3.1.5. Orders
This configurator enables parameterizations for all necessary order workflows, such as tax configuration, etc.
Additionally, you can configure environment variables related to this parameterization.
6.3.1.6. Configure Catalogs
This configurator allows you to make parameterizations for all necessary catalog workflows. For proper operation and parameterization, it's important to follow the step-by-step instructions, as some modules depend on previous configurations.
Additionally, you can configure environment variables related to this parameterization.
Within this configurator, you'll find parameterizations such as:
SKU Association
Calendar Association
All necessary configurations for products
6.3.1.7. Logistics
This configurator allows you to make parameterizations for all necessary logistics workflows. For proper operation and parameterization, it's important to follow the step-by-step instructions, as some modules depend on previous configurations.
Additionally, you can configure environment variables related to this parameterization.
Within this configurator, you'll find parameterizations such as:
Shipping Cost
Warehouses
6.3.1.8. Payments
This configurator allows you to make parameterizations for all necessary payment workflows. For proper operation and parameterization, it's important to follow the step-by-step instructions, as some modules depend on previous configurations.
Additionally, you can configure environment variables related to this parameterization.
Within this configurator, you'll find parameterizations such as:
Payment Methods
Payment Association to a Geographic Zone
External Payment Configuration
6.3.1.9. Quick Start: Access Permissions
This module allows you to quickly, for the first time, configure home pages corresponding to each user role.
6.3.1.10. Returns
This configurator allows you to make settings for returns, such as return states, options for order changes, etc. Additionally, you can configure environment variables related to this setup.
6.3.1.11. Integrations
This configurator allows you to make settings for environment variables that are important for the configuration of this process.
6.3.1.12. Incidents
This configurator allows you to make settings for all the necessary flows of incidents. For proper functioning and configuration, it is important to follow the step-by-step instructions provided; otherwise, there may be incorrect configurations since some modules depend on previous settings.
Additionally, you can configure environment variables related to this setup.
In this configurator, you can make settings such as:
Incident Categories
Severity
Channels
6.3.1.13. Event
This configurator allows you to configure events, such as scheduling, event types, etc. Additionally, you can set up environment variables related to this configuration.
6.3.1.14. Colors
This configurator enables you to make settings and customize the website, such as background colors, the overall site color, etc. Additionally, you can configure environment variables related to this setup.
6.3.1.15. Interaction
This configurator allows you to make settings and customize interactions, such as templates, notifications, etc. Additionally, you can configure environment variables related to this setup.
6.3.1.16. Permissions
This configurator allows you to make settings for all the necessary permission flows. Additionally, you can configure environment variables related to this setup.
Within this configurator, you can make settings such as:
Page Access
Access Based on Role
6.3.1.17. Products
This configurator allows you to set up, as a guide or step-by-step process, all the necessary elements to start creating products, both from here and from the product manager in the Backoffice.
6.3.2. System Processes
6.3.2.1. Tasks
In this module, you can view the tasks or actions that the software is currently performing. From here, you can cancel or deactivate tasks that are in an active or new state, meaning they are running or in a queue, pending execution, in case any task is taking too long to complete.
6.3.2.2. Processing Events
This module allows you to configure and schedule the execution of tasks automatically, without the need for manual user intervention. For example, this could include sending autoresponders, registering orders for auto-shipping, and more.
This is accomplished through cron expressions, which are the equivalent of regular expressions for selecting dates, time instances, or periods with time precision.
Additionally, processing crons can be executed manually by passing them as parameters in the URL.
Example: Website Name / InitDataServlet?Job=Processing Job Name
In this module, you configure relevant information such as:
Definition of the time when it will run.
Expression for automatic processing.
6.3.2.3. Version
This module is purely informative, allowing you to check the most recent version of the software currently in use, as well as access the historical versions of the software.
6.3.2.4. Environment Variables
An environment variable allows you to configure the system according to your company's needs. These variables can change the display of modules and their content, depending on the value they contain, and can also modify their behavior based on the assigned value.
This manager allows you to configure the default environment variables that the software uses for its operation.
In this manager, you configure relevant information such as:
Grouping by process.
Value of the environment variable.
Additionally, this manager allows you to create, modify, and delete environment variables. You can also export and create environment variables in bulk through a flat file. Creating an environment variable does not require previous configurations.
Furthermore, there is an action related to AVATAX, which is intended to test the connection with this integration based on the values in the environment variables parameterized for consuming the service.
Note: Avatax is sales tax software that automates tax calculations and the tax filing process.
System environment variables
6.3.2.5. Currencies
This module allows you to configure multiple currencies corresponding to a specific country, providing greater flexibility when assigning a value to a product, points, etc.
There are three types of currencies, and each type of currency can affect different functionalities of the system.
Money: The primary functionality where this type of currency is involved is in the entire process of an order, from its initiation to its invoicing, among other functions.
Points: The points currency is used to incentivize customers or sales teams and promote sales.
Commissions: The commissions currency is used to pay customer settlements.
Additionally, this manager allows you to create, modify, and delete currencies. Creating a currency does not require previous configurations.
Configuring a currency allows other flows to be set up correctly, such as:
Political Divisions
Product Catalog Assignment
Product Cost
Display of currency types
6.3.2.6. Document Ranges
This functionality is used to create consecutive numbers for generated documents. Through this feature, you can adjust the resolution of invoices, set document ranges and prefixes, delete existing ranges, and create new ones.
For example, you can change the prefix "FM" to "MF" or to any other prefix you need.
Configuring document ranges typically requires pre-existing settings.
Types of documents
6.3.2.7. Sequences
Within the software, there are tables or processes that handle auto-incrementing IDs or numbers, such as the user's personID or order numbers. The starting point for these numbers is not dependent on existing entries in their respective tables; instead, they are configured in the "Sequences" screen.
In other words, there are two fields: the sequence name or ID, which is not editable, and the current value or description, which can be edited from the sequences manager. From this field, you define from which number the auto-incremental counting will start. For example, if you enter the number one thousand in the description of the "ORDER_NUMBER" sequence, it means that new orders will have numbers starting from one thousand, such as 1001, 1002, and so on.
Sequences cannot be created or deleted, as they are predefined in the system. These include:
ORDER_NUMBER: This sequence is used in order processing, whether entered manually or adjusted.
SEQ_OR_INCONSISTENCY: This sequence is used in recording inconsistencies.
RE_EXE_HEADER_SEQUENCE: This sequence is used in processing both settlements and commissions.
UM_PERSONS_ID: This sequence is used when registering a person in the system, whether as a user, consultant, buyer, or seller.
SEQUENCE_MESSAGE_LOT: This sequence is used when sending a message from the software.
6.3.2.10. Functions
This manager allows you to configure the parameters of functions, which will be reflected when configuring rules.
6.3.2.11. Rule Processes
In this module, you can parameterize the list of processes in which rules are executed. These processes will be reflected in the "Process Name" field when creating a rule. Assigning a process to a rule is intended to group rules by the processes in which they are executed, making it easier to filter and find a required rule later.
6.3.2.12. Document Features
Here, you configure company contact information according to each corresponding country. This information will later be reflected by auto-populating various documents such as invoices.
6.3.2.13. Check List
In this module, you'll find a list of various processes within the platform along with their results, indicating whether there are failures, critical issues, or everything is okay. This is presented in a highly visual format, assisting staff in identifying and correcting errors that might be affecting the system's operation and processes.
Through this module, you can visualize and, in some cases, address the issues. Proper functioning of the check-list module requires prior configurations, including:
Inconsistency Groups
6.3.2.14. Inconsistency Groups
Inconsistency groups involve the grouping of processes and subprocesses so that they appear in the checklist. This organization allows for a more structured presentation of information within the platform.
Relevant information is configured in this section, including:
Name
Description
Additionally, this manager allows you to create, modify, and delete inconsistency groups. You can also export and create inconsistency groups through flat files. Creating an inconsistency group does not require prior configurations.
Configuring an inconsistency group ensures that other flows function correctly, such as the checklist.
6.3.2.15. Integration Parameterization
The primary purpose of this manager is to enable the company to parameterize the behavior of its integrations. This allows for the modification of values such as the integration name, date format, possible file extensions, multiple export options, integration type, and the political division (country) to which it belongs.
6.3.3. Security
6.3.3.1. Role Manager
This module allows for the management of access and actions within the software, including adding or removing permissions to access certain modules, view reports, and more.
Relevant information is configured in this module, including:
Clone Roles: This function allows for duplicating information from previous roles, making it easier to create new roles with similar permissions, avoiding unnecessary processes.
Default Page
Page Permissions
Access Assignments
Additionally, this manager allows you to create, modify, and delete configured roles. You can also export roles in bulk through a flat file.
Creating a role does not require prior configurations. This is one of the core modules in the system, as the proper functionality of the platform can depend on its configuration.
Permissions for the point-of-sale role
PROFILE_SHOW_GOALS_TAB
PROFILE_SHOW_MICROSITES_TAB
PROFILE_SHOW_PROFILE_TAB
PROFILE_SHOW_PUB_ARTICLES_TAB
RAFFLES_ADMIN
RAFFLES_EXPORT
RAFFLES_STATUS
REPORT_SCHEDULE
REPORT_SCHEDULE_TABS
REPORT_VIEW_FILTERS_BY_ADMIN
REPORT_VIEW_FILTERS_BY_AREA
REPORT_VIEW_FILTERS_BY_COMMERCIAL
REPORT_VIEW_FILTERS_BY_WALLET
REPORT_VIEW_FILTERS_BY_ZONE
REQUEST_CUSTOMER_TRANSFER
SEE_ALL_THE_WAREHOUSES
SEE_DEVOLUTION_COLUMN_ORDERDETAIL
SELECT_OWN_WAREHOUSE
SELECT_ZONE_HISTORY
SHIPPING_VAL_MODIFY
SHOW_AUDIT
SHOW_BALANCE_CUSTOMER_SERVICE
SHOW_BUTTON_CREATE_NEW_PAYMENT
SHOW_BUTTON_EXPORT_CLIENT_NETWORK
SHOW_BUTTON_NEW_ORDER
SHOW_CUSTOMER_DASHBOARD_PAGINATION
SHOW_DISCOUNTS
SHOW_MOVEMENTPOINTS_CENTRALIZEDQUERY
SHOW_PAYMENT_FIELDS
SHOW_PERFORMACE_INDICATOR_MANAGEMENT
SHOW_TAB_BENEFITS
SHOW_TAB_CALENDAR
SHOW_TAB_COLLECTION_MANAGEMENT
SHOW_TAB_COMMISSION
SHOW_TAB_COUPONS
SHOW_TAB_CUSTOMER
SHOW_TAB_GOALS
SHOW_TAB_INVOICES
SHOW_TAB_ISSUES
SHOW_TAB_MOVEMENTS_COMMISSIONS
SHOW_TAB_ORDERS
SHOW_TAB_PARTIES
SHOW_TAB_PROMOTIONS
SHOW_TAB_RECRUITS
SHOW_TAB_REFERRED
SHOW_TRAKING
SHOW_WIDGET_DEVOLUTION
ST_CUSTOMERSERVICE_PASS
6.3.3.2. Dashboard Manager
From this module, you can preset the dashboards, shortcuts, and widgets that each specific role will see on the main screen or portal.
6.3.3.3. Scheduling
From this module, you can schedule the automatic and periodic sending of a specific report to certain users.
6.3.3.4. Audit Manager
From this module, you can apply various filters to audit records and then export a specific report of the filtered records.
6.3.3.5. External Integrations
6.3.3.6. Process Execution
From this module, you can monitor and cancel certain audit processes. You can also apply various filters to audit records and then export a specific report of the filtered records.
.