Training Course
TEC101: Fundamentals Common Tools
June 2011
V6.2
Sage ERP X3 ExpertSage ERP X3 Advanced
Course Map2
Sage ERP X3 Fundamentals
OPE201 - Distribution
(3 days)
FIN201 - Finance(4 days)
TEC101 - Common Tools
(3 days)
OPE203 - Manufacturing
(3 days)
OPE202 - Inventory(2 days)
Manufacturing (5 days)
Configurator
Weighing
Optimisation ILOG
Distribution and Inventory
Purchasing Subcontracts
Pre-Allocations (Pegging Function)
Radio Terminals
Finance
Multi-Legislation Set Up
Operating Budgets
Analytical Allocations
Factoring
Distribution Contracts (Purchasing and Sales)Loan OrdersPackaging & Shipment PreparationPurchasing Signature ManagementSales and Purchasing PrepaymentsSales Reps and CommissionsSourcing: RFQs, ResponsesCarrier ManagementInter-Site and Intercompany TransactionsInvoice Elements (Purchasing & Sales)Kits, Options & VariantsPrice List Management (Advanced)
FinanceBank Communication & ReconciliationBudget Control/ Analytical BudgetFinancial Data ExtractionStatements & RemindersAutomatic Journals & Dimension DefaultsAdvanced Payment TransactionsMonth and Year End ProcessesFixed Assets
You Are
Here
Manufacturing (4 days) Advanced Global Manufacturing Production Costing
Inventory (3 days)Allocation Rules (Advanced)Stock CountsSerial Number Management Reodering Replenishment Storage PlanValuation Methods and Price Adjustments and cost calculationsQuality Control & Sampling
CB 101 – 102
Introduction & Functional Overview
(3 days) TEC102
Development
(4 days)
TEC103
Installation (4 days)
Tools & DevelopmentAdvanced Common Tools Advanced Development
Tools & DevelopmentUsing BI in Sage ERP X3Java Bridge Serveur ComponentsEDM – Version OneWeb ServicesCrystal Reports
TEC101: Fundamentals Common Tools
TEC101: Fundamentals Common Tools
Objectives
Presentation of Sage ERP X3 ‘Common Tools’
Prerequisite for using modular functions and development actions
Three-day session
3
/ © Sage 20114
Contents
Sage ERP X3 Introduction (CB101)
Sage ERP X3 Overview (CB102)
TEC101: Fundamentals Common Tools
Prerequisites
/ © Sage 20115
Contents
1. INTRODUCTION
2. PART 1ACTIVITY CODESARCHITECTURE & FOLDER MANAGEMENTDESIGNING A SIMPLE OBJECTFORMULAS
3. PART 2BASIC PARAMETERSPARAMETERS OF THE FUNCTIONSBASIC TOOLSWORKFLOW - NOTIFICATIONSTATISTICS
4. PART 3REQUESTERIMPORTS/ EXPORTSTHE PORTALPROCESSES
TEC101: Fundamentals Common Tools
/ © Sage 2011
Contents
TEC101: Fundamentals Common Tools
Activity CodesActivity Codes
Folder managementArchitectureNotion of inheritanceUtilitiesData extraction
Designing a single objectTablesScreensObjectsThe windows Online help
6
Part 1
FormulasFormulasVariablesFormula assistantSimple formulasTables of variablesPractical functions
/ © Sage 2011 TEC101: Fundamentals Common Tools7
Part 2
Basic parametersGeneral parametersUsers & ParametersLocal menus and miscellaneous tablesSequence NumbersThe Batch Server
Personalisation of the functionsObjectsPersonalisationTransactionEnquiry screensScreen-related parametersVocabulary
Basic toolsSelectionsAttachments
Workflow – NotificationBasic principleSupervisor parametersWorkflow monitorNotificationsManual workflow
StatisticsStatistic managementEnquiryTriggersParametersUsable data
/ © Sage 2011
Contents
TEC101: Fundamentals Common Tools8
RequesterGraphFormSQLEnquiry
Imports / exportsTemplatesTranscoding tablesI / E parametersChronological I / ESequencing
The portalCharacteristicStructureparametersPortal view
ProcessesObjectivesMain characteristicsImplementation
Part 3
/ © Sage 2011 TEC101: Fundamentals Common Tools9
PART 1
/ © Sage 2011
1.1 Activity CodesDevelopment > Data and parameters > Development Setup > Activity codes
Activity codes are signature codes that are used to:
Protect and identify specific developments (Type = Functional)
Activate or deactivate Sage X3 elements
Specific activity codes start with X, Y or Z
Protection from patches and upgrades
Identification for patch extraction and dictionary validation• Tables, table indexes, table fields• Screens, screen blocks, screen fields• Objects, individual object parameters• Window tabs• …
Attach a customisable dimension to array elements (Type = Dimension)• Table fields• Screen fields (lines)
Identify localisations (Type = Localisation):• Localisation activity codes start with letter K
10 TEC101: Fundamentals Common Tools
/ © Sage 2011
Exercise 1.1.1Activity Codes
TEC101: Fundamentals Common Tools11
/ © Sage 2011
1.2 Folder Management
ArchitectureServers
FoldersStandard
Actual
Specific / vertical
Application directoriesFIL: table description
REPORT: specific reports
TRT: Process
TRA: Trace
12 TEC101: Fundamentals Common Tools
/ © Sage 201113
SAFE X3 Application Architecture
TEC101: Fundamentals Common Tools
/ © Sage 2011
Architecture
14 TEC101: Fundamentals Common Tools
/ © Sage 2011
Scalable
Smaller EnterprisesApplication serverProcess serverDatabase server
Larger Enterprises+ Additional process server(s)Print server(s)Web serverDocument serverBusiness Objects serverCitrix front-end server
15 TEC101: Fundamentals Common Tools
/ © Sage 201116
Solutions and Folders (2 tier)
Sage ERP X3 Solution
X3 (Reference Folder)
TESTTest Folder
PILOTPilot Folder
LIVELive Folder
Rules
Parameters
Data
Developments
Dictionaries
Access rights, signatures, accounting…
Tables, Screens, Windows, Objects…Programs (Processes), specific screens and tables…Customers, Products, Sales Orders, Invoices, Journals…
Company/Site structures, workflow, general parameters…
Creation
Inheritance
Copy Tools
DatabaseIP Port
Runtime
TEC101: Fundamentals Common Tools
/ © Sage 201117
Solutions and Folders (3 tier)
Sage ERP X3 Solution
X3 (Reference Folder)
VERTICALVertical Folder
LIVELive Folder
Creation
Inheritance
DatabaseIP Port
Runtime
Creation
Inheritance
TEC101: Fundamentals Common Tools
/ © Sage 2011
Folders
Standard FoldersX3SERVX3DEMOPRM
18 TEC101: Fundamentals Common Tools
/ © Sage 2011
Folders
Reference folderX3
Program operation sheetsDevelopment folders
Test folderRetrieval of standard processesNOT to be used for Live Folders
Specific folder
19 TEC101: Fundamentals Common Tools
/ © Sage 2011
Data - Extraction / Integration
SVGExtraction
Copies the table definition files
Extracts data into a database / operating system independent flat file
(4-6 per table)
This is NOT a daily backup procedure
IntegrationTakes the extracted table definition files
Integrates data into the folder from the flat files
Should only be performed at same patch level
20 TEC101: Fundamentals Common Tools
/ © Sage 2011
Exercise 1.2.1Folder / Data Extraction
TEC101: Fundamentals Common Tools21
/ © Sage 2011
1.3 Designing a simple object
ObjectivesOverview of Technical Environment
ContentsPresentation of tools
Description of the ERP X3 setup guidelines and technical structure
22 TEC101: Fundamentals Common Tools
/ © Sage 2011
Presentation
23
Database DisplayOBJECT
"Business"
"OBJECT template": This X3 template is used to obtain data by business objects
Window: Object call
Object : Linked table
Table : Storage fields
TEC101: Fundamentals Common Tools
/ © Sage 2011
Presentation
24
Table
Object
Window
Action: GOBJET
Function: GESxxx
Screens
Data type
Local menus
Miscellaneous tables
Activity codes
Data type
Local menus
Miscellaneous tables
Activity codes
TEC101: Fundamentals Common Tools
/ © Sage 2011
The tablesDevelopment > Data and parameters > Tables > Tables
Activity codesX - Vertical (Add-On) Development by the OpCo
Y - Bespoke development for the End User by the OpCo
Z - Bespoke development by the End User
The fields
The data typesGeneric (A, D, DCB, L, C)
Specific (M, MM)
Functional (BPC, ITM, etc.)
The linked tables
25 TEC101: Fundamentals Common Tools
/ © Sage 2011
The tables
CREDAT UPDDAT
CRETIM UPDTIM
CREUSR UPDUSR
EXPNUM ENAFLG
26
The indices
The table audit
TEC101: Fundamentals Common Tools
Special Fields
/ © Sage 2011
Exercise 1.3.1Tables
TEC101: Fundamentals Common Tools27
/ © Sage 2011
The screens
Development > Processes > Screens > Screens
Screen dictionaryHeader screen - xxx0One screen per tab
Screen organizationHeaders and Tabs are particularly used in object management and enquiries, in a "window entry" template. BlocksPosition of the blocks
28 TEC101: Fundamentals Common Tools
/ © Sage 2011
The screens
Type of blockThe type of block defines the presentation of the fields inside a block
List : List of fields independent one from anotherTable: The fields are organised in a scrolling grid of lines
Position / Line / ColumnPositioning with the coordinates (line. column) of its upper left corner Position each block with respect to each other
Reference tables
29 TEC101: Fundamentals Common Tools
/ © Sage 2011
The screens
Block Position Line Column
A 1.1 2 2
B 1.3 1 1
C 2.3 1 1
D 3.1 1 1
E 3.2 1 2
F 4.1 1 3
30
1 2 3
1
2
3
4
AB
ED
C
F
TEC101: Fundamentals Common Tools
/ © Sage 2011
The screens
The fieldsField position (same principle as for the blocks)
Data type
If field name already used will give list for defaults
Validation / Display / Web display
Generated processes
W0xxxxxxxxxxxx
W1xxxxxxxxxxxx
31 TEC101: Fundamentals Common Tools
/ © Sage 2011
Exercise 1.3.2Screens
TEC101: Fundamentals Common Tools32
/ © Sage 2011
Objects
Link between the table and the window
Simple: Line update
In Table: The entire table is loaded
Compound: The entire table is loaded(with common header)
Special: Used as Left List
33 TEC101: Fundamentals Common Tools
Development > Processes > Objects
/ © Sage 2011
Objects
Standard menu Linked to the menu navigation
PrintingDefine the Crystal Reports
Validate button Creation of the processes
SUBxxx - Standard process
SPVxxx - Vertical process
SPExxx - Bespoke process
WOxxx
34 TEC101: Fundamentals Common Tools
/ © Sage 2011
Exercise 1.3.3Objects
TEC101: Fundamentals Common Tools35
/ © Sage 2011
The windows
Brings together all the components for user displayObject
All left lists (from other ‘Special’ Objects)
All tabs
Standard Buttons
Additional Menu/Buttons
Entry transactions
Generated processesWGxxxxxxxxxxxx
36 TEC101: Fundamentals Common Tools
/ © Sage 2011
The windows
37
Window
Screen
Header
Screen
Tab 1 / 15ObjectMain
ObjectLeft list 1 / 9
TEC101: Fundamentals Common Tools
Table
+ Buttons+ Menus CreateCreate SaveSave DeleteDelete ……CancelCancel
Details
HeaderBrowser /Left List
Standard buttons
Tabs
Header screen
Menu Bar & Toolbar
Status bar
/ © Sage 2011
Exercise 1.3.4Windows
TEC101: Fundamentals Common Tools38
/ © Sage 2011
Conclusion
Simple objectTableScreen(s)Object(s)Window
Interaction of the setup elementsScreen, window,Object, tables, function
39 TEC101: Fundamentals Common Tools
/ © Sage 2011
Calculator
Allows inspection of variables
Allows enquiry of open classes
40 TEC101: Fundamentals Common Tools
/ © Sage 2011
The variables
Type of variable Syntax to be used Example
Value of a field in the current record of an on-line table
[F:abv]varnameabv = table abbreviationname = field name
[F:BPC]BPCNUM
Value of a screen field (located in a visible or invisible tab)
[M:abv]varnameabv = table abbreviationname = field name
[M:MPC0]BPCNUM
Global variable [V]varnameThe class can be omitted, the name begins with G
GNBGAUCHEGUSERGFONCTION
System variable [S] varnameThe class can be omittedThe name is in lower case letters
datesystnomapindcum
41 TEC101: Fundamentals Common Tools
/ © Sage 2011
Exercise 1.3.5Calculator
TEC101: Fundamentals Common Tools42
/ © Sage 201143
1.4 Formulas
ObjectivesThis is not a development course but a module for understanding the X3 language
ContentsIntroduction to the X3 languageUse of formula
TEC101: Fundamentals Common Tools
/ © Sage 201144
Formula components
ConstantsSigned / Un-signed Numerical 5, -238, 3.14159
Character String “Test”
Dates [01/01/2001]
Data fields Table class [F]
[F:Abr]FieldNameScreen class [M]
[M:Abr]FieldNameWithin screen grid nolign is the number of the current
line[M:SOH4]ITMREF(3) index = nolign-1 with nolign = 4
TEC101: Fundamentals Common Tools
/ © Sage 201145
Formula components
VariablesLocal class [L]
System class [S]date$datesystNomap
TEC101: Fundamentals Common Tools
/ © Sage 201146
Formula components
Variables
Global class [V]GUSER
GFONCTIONGOLDETAT
Development > Data and parameters > Development Setup > Global variable
• Initialized when the user logs on or when modules are accessed• WWAGLOBSUP: Process for global supervisor variables• WWAGLOBADX: Process for main global variables
Functions
Operators
TEC101: Fundamentals Common Tools
/ © Sage 201147
Logical expressions
True / FalseFalse = 0 / True <> 0The logical expressions are evaluated in the formulas
String$(GUSER = “ADMIN”, “Administrator”)+String$(GUSER <> “ADMIN”, “No Administrator ”)Both parts are evaluated
+ concatenation A + B = AB
- concatenation with a blank A – B = A B
Limit: 250 characters in the conditions.
TEC101: Fundamentals Common Tools
/ © Sage 201148
? – Help
Calculator
Help summary
Help
TEC101: Fundamentals Common Tools
/ © Sage 201149
Formula assistant
Calculator
Assistant
TEC101: Fundamentals Common Tools
/ © Sage 201150
Formula assistantDevelopment > Data dictionary > Formula assistant context
This function is used to define headings that are accessible in the formula assistant left list Global variables
List of variables that are accessible in the assistant menuLocal variables
List of variables that are accessible in the menu related to the context of a function
FunctionsList of functions
Development > Processes > Processes > Subprograms
TEC101: Fundamentals Common Tools
/ © Sage 201151
Functions
Data typesNumeric
Dates
Characters
Aggregative
Function
Variable tables
TEC101: Fundamentals Common Tools
/ © Sage 2011
Exercise 1.4.1Formula Editor
Context of Formula Editor
TEC101: Fundamentals Common Tools52
/ © Sage 201153
Conclusion
Formula assistant can be used to enhance Formula Editor
Formula Editor can be used to assist in the entering & verification of formulae
Take advantage of Help - it is illustrated with many examples
TEC101: Fundamentals Common Tools
/ © Sage 2011
PART 2
TEC101: Fundamentals Common Tools54
/ © Sage 2011
2.1 Parameters
The most significant value for a Parameter is always the one at the lowest level
UUU FFFSSS
Folder Level
Company Level
Site Level
LLL
FFFFFF
LLLLLL
CCCCCC
SSSSSS
CCC UUU
User Level
55 TEC101: Fundamentals Common Tools
UUUUUU UUUUUU
Legislation Level
/ © Sage 2011
Basic parameters
ObjectivesUsers & ParametersGeneral parametersLocal menusMiscellaneous tablesGeneral structureCommon dataBatch Server
ContentsParameter levels
TEC101: Fundamentals Common Tools56
/ © Sage 2011
Users
Users are defined in X3 with a 5 characters code
Various data is provided
A log-in code
A menu profile
Access rightsValues of parameters set per user
Contact details
Print output destinations
Managers
Users can exist who do not connect to X3For example, recipients of workflow e-mails, managers, etc.
Further details of User Set-Up is covered within the Advanced Common Tools Course
TEC101: Fundamentals Common Tools57
/ © Sage 2011
General Parameters
Parameter values
Definition levelModule
Group
Parameter Entry
Add by patch
Legislation
Company
Site
User
TEC101: Fundamentals Common Tools58
Folder
/ © Sage 2011
General Parameters
Parameters > General parameters > Parameter values
A few interesting parametersEach function has parameter values
TC group – Common Data
SUP group – Supervisor
ADX group
TEC101: Fundamentals Common Tools59
/ © Sage 2011
Set of values
Parameters > General parameters > Sets of values
Defines default values for a parameter category
Ensures a standard set of starting values for parameters
TEC101: Fundamentals Common Tools60
/ © Sage 2011
Copy Parameters
Ability to Copy ParametersDevelopment > Utility > Miscellaneous > Copy parameter values
Either
to a different folder (subject to rights on the folder)
Or
to the same folder to a different site
TEC101: Fundamentals Common Tools61
/ © Sage 2011
Exercise 2.1.1Parameters & Set of Values
TEC101: Fundamentals Common Tools62
/ © Sage 2011
Local menus / MessagesDevelopment > Data and parameters > Tables > Local menus - Messages
List of valuesStored in Database as Number
Local Menus3 uses
Tick boxes (graphic object)Option buttons (graphic object)Drop-down lists
MessagesWithin Development (Translatable )
ModificationParameters > General parameters > Local Menus
No insertionValidationCreation
Code – related to the import parameters
TEC101: Fundamentals Common Tools63
/ © Sage 2011
Miscellaneous tables
Development > Data and parameters > Miscellaneous Tables > Definition
Avoid increasing the number of small tables
Modifiable
Additional data columns2 Alphanumeric
2 NumericData type
Dependence
TEC101: Fundamentals Common Tools64
/ © Sage 2011
Exercise 2.1.2Local Menus & Misc Tables
TEC101: Fundamentals Common Tools65
/ © Sage 2011
Sequence Numbers - Definition
Sequence Numbers are associated to Sage X3 documents (Invoices, Orders, Journals etc.) or any Records that may be numbered.
They define the rules used for numbering the document (Formats, date control etc.)
They are built by combining customised elements of information (Dates, Sites etc.) depending on the context.
They contain mandatory numeric Sequence Numbers that may be set to 0 periodically and may depend on the Company, Site or on other information (Complement).
The maximum length of a sequence number is 20 characters.Parameters > General Parameters > Sequence Number Definition
66 TEC101: Fundamentals Common Tools
/ © Sage 2011
Sequence Number Assignment
Sequence Numbers are assigned by Module / Document Type in most cases.
Manual numbers may be assigned in some cases.
Parameters > General Parameters > Sequence Number Assignment
67 TEC101: Fundamentals Common Tools
/ © Sage 2011
Exercise 2.1.3Sequence Numbers
TEC101: Fundamentals Common Tools68
/ © Sage 2011
The Batch Server
The batch server is a background process that will launch Sage X3 programs or system commands as batch jobs.
The batch server is run by a special folder called SERVX3.
When a batch job is submitted to the batch server, it is called a Request. It is launched by the batch server as a background Sage X3 process (adonix.exe).
Batch Server start-up:At system start-up: adonix -a -l [LANG] SERVX3
From an X3 folder: Usage > Batch Server > Server Activation
Automatically when a user logs into the Folder Parameter SUP : PRF : DEMSRV
69 TEC101: Fundamentals Common Tools
/ © Sage 2011
Batch Server (Batch Task Definition)
Usage > Batch Server > Task Management
A Batch Task corresponds to:A Sage X3 function or process that may be run by the Batch Server
A Unix or Windows script.
All Functions using the Standard Process Model may be launched in batch mode.An X3 process may be executed with a batch task if:
It doesn’t manage a user dialog during while the process is being executed
The action associated to the X3 function is marked as being authorised to be used in batch mode.
Further details of Batch Server is covered within the Advanced Common Tools Course
70 TEC101: Fundamentals Common Tools
/ © Sage 2011
The Batch Server (Accounting Batch)
The accounting task is a particular batch task case:Its code is ACCBATCH and it shall be consistently launched in each execution folder of the X3 enterprise solution
It updates the accounting entries created from the other modules (sales, purchases, stocks, production management, fixed assets, BP accounting, general accounting)
Only one accounting task may be launched per folder
It has a specific monitoring function Journal Status Monitor
Usage > Batch Server > Accounting Tasks
71 TEC101: Fundamentals Common Tools
/ © Sage 2011
Exercise 2.1.4Batch Server
TEC101: Fundamentals Common Tools72
/ © Sage 2011
Conclusion
Several structures in order to store basic parametersRelated to the context
Easy access
Personalisation (addition, deletion)
Distinguish between the development actions and the setup actions.
TEC101: Fundamentals Common Tools73
/ © Sage 201174
2.2. Setting up the functions
ObjectivesPersonalise objectsAdditional checks
ContentsDescription of the setup elements related to the objectsWhat are the properties of an objectHow to personalise an objectScreen-related parametersScreen-related checks
TEC101: Fundamentals Common Tools
/ © Sage 201175
Properties
Object properties menuParameters > General parameters > Object properties in File menu
Title of the recordCREDATCREUSRCRETIMUPDDATUPDUSRUPDTIM
Other Specific dataLinked tables
F11 when an element has object properties
TEC101: Fundamentals Common Tools
/ © Sage 201176
Personalisation
The object makes the link between the table and the window
Object personalisation
Parameters > General parameters > Personalise objects
Optimize the search conditionsDefine the columns displayed in the browser
BrowserLast readAdditional left listsLink explorer
TEC101: Fundamentals Common Tools
/ © Sage 201177
Definition
The functions make the link betweenMenu MenuMenu Process
GESxxx object (generated automatically)CONSxxx enquiryFUNxxx other processing (batch)
A function is not necessarily related to an action
TEC101: Fundamentals Common Tools
/ © Sage 201178
Entry Transactions
Allow different ‘views’ on the same ObjectSeveral windows/screens for the same objectAllows entries that are different from one anotherGESxxx function, xxx object, Oxxx window
ExamplesParameters > Sales > Entry transaction > Quote
Sales > Quotes > Quote
Parameters > Sales > Entry transaction > Orders
Sales > Orders > Orders
TEC101: Fundamentals Common Tools
/ © Sage 201179
Entry transaction
Copy an existing transactionParameters > Sales > Entry transaction
Create then ValidateTable mode / Record modeActivate
Consult the new screenSales > Orders > Order
TEC101: Fundamentals Common Tools
/ © Sage 2011
Exercise 2.2.1Object Personalisation
TEC101: Fundamentals Common Tools80
/ © Sage 201181
Enquiry screens
Provide ability to view data from various areas of the systemFunction
CONSxxx where xxx is the enquiry code
ScreensHeader screens - main criteria displayed
Results grid
Criteria Screen - all criteria can be modified
TEC101: Fundamentals Common Tools
/ © Sage 201182
Enquiry screens
Parameters > General parameters > Enquiry screens
PersonaliseScreen code default supplied is STDNumber of linesFields (display / order)Data displayed in Character / Graphical format
TEC101: Fundamentals Common Tools
/ © Sage 2011
Exercise 2.2.2Enquiry Personalisation
TEC101: Fundamentals Common Tools83
/ © Sage 201184
Control Tables
Control tables allow restrictions on data that can be entered into fields
DefinitionParameters > General parameters > Control tables
VALUESDefine the control types
From 1 to 3 controls
Assignment of controlsParameters > General parameters > Screen personalisation > Assign controls
TEC101: Fundamentals Common Tools
/ © Sage 201185
Personalising the vocabulary
ATEXTE tableContains Field Titles etc
<100,000 numbers – standard>100000 numbers - additionalLanguage code - allows them to be translatedMessage number
APLSTD tableContains details of the Local Menus & Messages
Language code - Allows them to be translatedModule numberMessage number
TEC101: Fundamentals Common Tools
/ © Sage 201186
Styles
StyleAllows fields and titles to be allocated different characteristics
Font (Size / Attribute)
Colour
Style editorPersonalised styleParameters > General parameters > Personalization > Screens > Personalised Style
Specific for user / group
Conditional styleParameters > General parameters > Personalization > Screens > Conditional Style
For individual fields within screen
TEC101: Fundamentals Common Tools
/ © Sage 2011
Exercise 2.2.3Controls / Vocabulary / Styles
TEC101: Fundamentals Common Tools87
/ © Sage 201188
Conclusion
Screen setup is used to target the entered information and the entry methods
Personalisation of the enquiry
Control tables in order to personalise the entries
Personalising the vocabulary avoids modifying the screens
TEC101: Fundamentals Common Tools
/ © Sage 201189
2.3. Basic tools
ObjectivesPresent some additional tools
ContentsMemos
Attachments
TEC101: Fundamentals Common Tools
/ © Sage 2011
Basic tools
MaintenanceDevelopment > Utilities > Maintenances >
Details of a table and its data
Modification by unit possible
SearchesDevelopment > Utilities > Searches >
Search / Activity codes
Check / Table status
90 TEC101: Fundamentals Common Tools
/ © Sage 201191
Selections
Key area
On column
By keyword (Attached Documents)
Advanced selectionMemos
Global / Local "STD" code
Create a memo
Delete a memo
TEC101: Fundamentals Common Tools
/ © Sage 201192
Attachments
File / Attachment or icon
Enter a link or store the attachment
Standard formatMiscellaneous table 902 – document types
BLOB = Binary Large Object
CLOB = Character Large Object (only characters)
A few general parametersADX / INT module DIRPCE and "%"
SUP / RPT module IMPPCEJOIN
TEC101: Fundamentals Common Tools
/ © Sage 201193
Attachments
The DIRPCE parameter is used to define a default directory to store the attachments that are not stored in the base
When the File / Print function is used in object management, the SUP : RPT : IMPPCEJOIN parameter enables you to automatically print the attachments associated with the current record
TEC101: Fundamentals Common Tools
/ © Sage 201194
Attachments
Syntaxes
% \ FileName.ext
% FilenameWith % call the default directory name then select the file with its extension
TEC101: Fundamentals Common Tools
/ © Sage 2011
Exercise 2.3.1Attachments
TEC101: Fundamentals Common Tools95
/ © Sage 201196
Conclusion
The following elements are regularly used in the applicationMemos
Search
Attachments
TEC101: Fundamentals Common Tools
/ © Sage 2011
2.4 Introduction to Workflow
ObjectivesDescribe the principle of workflow notifications
97 TEC101: Fundamentals Common Tools
/ © Sage 2011
Workflow - Notifications
The Notifications function allows simple workflows to be created quickly (only a single Tab)
It is limited in that
only some of the triggering cases that can be processed by the Workflow engine can be expressed.
the criteria entry screen is simplified and only some of the more complex fields can be viewed.
the workflow is limited to two recipients.
there is no associated signature process
Creation of a Notification automatically creates the appropriate Workflow Rule
Using the Workflow Rules, the notifications may be enhanced (the Notification will be removed)
TEC101: Fundamentals Common Tools98
/ © Sage 2011
A few basic parameters
General parameters: SUP : WRKTYPMES – Message sending via server or client workstationsSERMES – Name of the messaging serverWRKDAY – Number of enquiry days in the planning workbench
Activity codesAUDIT - Functional (case of manual Workflow) AWR - Sizing (max number of signers)
99 TEC101: Fundamentals Common Tools
/ © Sage 2011
Notifications
Notifications will allow us to trigger a workflow on the following
Creation / Modification / Deletion an object record
Entering into a function
Printing of a Report
Ending of a asks
Notifications can be sent by E-mail or logged as an entry in the Workflow Monitor or both
100 TEC101: Fundamentals Common Tools
/ © Sage 2011
Email Principles
Sage X3 Server(s)
Web Server(s)
MAPI Client
MAPI SMTP
Email Server
TEC101: Fundamentals Common Tools101
/ © Sage 2011
Notifications
TriggeringChoose the objectSelect the activation conditions
Tracking methodMail sendingAlert (tracking)
Message Detail
102 TEC101: Fundamentals Common Tools
/ © Sage 2011
Workflow monitor
The workflow monitors are used to display the flows to be monitoredUsage > Workflow monitor
Event trackingEvent update
Creation of a planning workbenchParameters > Workflow > Planning workbench setup
An enquiry is used to filter and present the flows to be tracked
103 TEC101: Fundamentals Common Tools
/ © Sage 2011
Exercise 2.4.1Workflow - Notifications
TEC101: Fundamentals Common Tools104
/ © Sage 2011
Conclusion
Workflow Notification
Manual workflow
The other workflow methods are developed during the advanced administration training
105 TEC101: Fundamentals Common Tools
/ © Sage 2011
2.5 Statistics
ObjectivesStore data in a temporary table
Have simple statistics
Multi-level presentation with zoom effects
Key pointsImplementation of statistics
106 TEC101: Fundamentals Common Tools
/ © Sage 2011
StatisticsStatistic tools enable calculation and storage of simple numeric elements in a temporary tableFrom 1 to N accumulated amounts and quantities
The value N depends on the STA activity code (5 by default, 10 maximum)
The elements depend on the site
the company
a frequency parameter
from 1 to M other criteria.
M depends on the STT activity code (4 by default, 8 maximum)
The commercial budgets (forecasts) may be associated to the statistical results
The calculation of statistics is triggered by the events used for managing the X3 objects, such as the creation, the modification and the deletion. The calculation may also be launched in batch (deferred).
TEC101: Fundamentals Common Tools107
/ © Sage 2011
Statistics trigger
Define the update actions for the statisticsData movements
Distributions across all the modules
A few standard triggersParameters > Usage > Statistics > Statistical triggers
BAP, CLL, OPP …
TablesTriggering criteria
VariablesSet up variables (formulas) beforehand
NUMBER = 1 to calculate averages
108 TEC101: Fundamentals Common Tools
/ © Sage 2011
Statistical Parameters
Parameters > Usage > Statistics > Statistical parameters
General tabManagement and Type
Define the trigger
Refresh method (Real time or batch)
Fields tab
Define grouping criteria
Value: aggregations to be done defined in the trigger
109 TEC101: Fundamentals Common Tools
/ © Sage 2011
Statistical Parameters
Advanced tabColumns
Values to be accumulatedCn: real for period 1
CCn: real for period 2
Pn: forecast for period 1
PPn: forecast for period 2
Result criteria
110 TEC101: Fundamentals Common Tools
/ © Sage 2011
Statistics Execution
Validate the statistical parameters
Data batch validationUsage > Statistics > Batch Validation
Incremental
Resynchronization
Batch: "VALSTA"
111 TEC101: Fundamentals Common Tools
/ © Sage 2011
Statistics - Forecast
Usage > Statistics > Forecasts
ProcessInitialize the values (real)
Define increases (+/- rate)
Modify, adjust the values
Tables involvedSTAT for real statistics
STATPRV for forecast statistics
112 TEC101: Fundamentals Common Tools
/ © Sage 2011
Exercise 2.5.1Statistics
TEC101: Fundamentals Common Tools113
/ © Sage 2011
Conclusion
The statistics can be implemented using 2 methods (Batch and real Time)
Subscription to a Batch server
Presentation on the portal
114 TEC101: Fundamentals Common Tools
/ © Sage 2011 TEC101: Fundamentals Common Tools115
PART 3
/ © Sage 2011
3.1 Requester
ObjectivesUse the 3 requester methods and display the results
Key pointsImplementation of the same request as a graphic request and as a form requestIntegration of requests in the portal
116 TEC101: Fundamentals Common Tools
/ © Sage 2011
Generic principle
The Requester is a tool that allows the user to construct database queries, to view them, and to print them.
Requesters can be defined in 3 different tools:-Conventional definition of tables and fields in a screenSQL scriptGraphical presentation of tables and fields
Requests can be run on requestDedicated or shared result
117
RequestALISTER
TEC101: Fundamentals Common Tools
/ © Sage 2011
Requesters
SetupParameters > Usage > Prints
Requester
SQL requester
Graphic requester
EnquiryPrints > Display of requests
118 TEC101: Fundamentals Common Tools
/ © Sage 2011
Requesters Graphical
Requests are written using a Graphical Toolsimilar to other Windows reporting applications
Tables can be added
Links can be changed
Ranges can be selected
Columns can be sorted
Values in columns can be accumulated
Fields can be grouped
The results are viewed in the same way as for normal Requesters
119 TEC101: Fundamentals Common Tools
/ © Sage 2011
Exercise 3.1.1Requester - Graphical
TEC101: Fundamentals Common Tools120
/ © Sage 2011
Form requester
Requests are written using a normal X3 Interface All features of graphical requester
Not as user friendly when selecting fields
Graphic tab – to display results in Graph formRepresentation
Description type field
Value type field(s)
121 TEC101: Fundamentals Common Tools
/ © Sage 2011
Exercise 3.1.2Requester - Form
TEC101: Fundamentals Common Tools122
/ © Sage 2011
The SQL requester
Allows Requester to be written in native SQLNeed to be aware of underlying database differences
No management of multi-level shortages
No totals on the columns
"SELECT" InstructionField index (xxx_0, xxx_1 …)
Variable parameter index ( %i% )
123 TEC101: Fundamentals Common Tools
/ © Sage 2011
Exercise 3.1.3Requester - SQL
TEC101: Fundamentals Common Tools124
/ © Sage 2011
Results enquiry
To view the resultsThe requests must be activePrinting > View Requests
Create a batchTask: CALALH
Then indicate the request to be calculated
125 TEC101: Fundamentals Common Tools
/ © Sage 2011
Conclusion
The requests are available using 3 methods
Understanding the data model is essential
Refresh results
126 TEC101: Fundamentals Common Tools
/ © Sage 2011
3.2 Imports / Exports
ObjectivesPresentation of the import and export process
Key pointsTranscoding
Management of Temporary Storage Space errors
127 TEC101: Fundamentals Common Tools
/ © Sage 2011
Imports / Exports Templates
Allows data to be Imported into X3 from 3rd party systems
Allows data to be Exported from X3 to 3rd party systems
Input / Output files can be in a number of differing text formats
May be linked to Object to provide verification of data
May be linked to bespoke process to provide additional validation
128 TEC101: Fundamentals Common Tools
/ © Sage 2011
Imports / Exports Templates - StructureParameters / Usage / Imports/Exports
Choose the file type format
Field separator
Record separatorWindows: \013\010 (CR/LF)UNIX: \010 (LF)
File formatASCII: on 1 byteThe others: on 2 bytes
CodingISO 8859 (mainly)
129 TEC101: Fundamentals Common Tools
/ © Sage 2011
Imports / Exports Transcoding
Correlation tablesLocal codes / external codesImport mode and Export modePossible default values
Local code: data stored in X3
External code: imported data
130 TEC101: Fundamentals Common Tools
Local code External code
CHQ CHEQUE
DIV *
* OTHER
/ © Sage 2011
Imports / Exports Parameters
Parameters > Usage > Imports/Exports > Parameters
EXPORT parametersDefine the default and temporary directoriesChrono number
IMPORT parametersDefine the directories
131 TEC101: Fundamentals Common Tools
/ © Sage 2011
Imports / Exports Anomalies - Temporary Storage Space
Usage > Imports/Exports > Temporary Storage Space
Error managementAny records that have failed to be imported are saved in a temporary tableRecords can be reviewed, modified and a new external file generatedNew table can then be re-imported
132 TEC101: Fundamentals Common Tools
/ © Sage 2011
Imports / Exports Chronological export
Allows data to be exported if it has changed since the last exportThe variable [C]EXPORT contains the current chronological numberLinks to the field EXPNUM within tables
133 TEC101: Fundamentals Common Tools
/ © Sage 2011
Imports / Exports Sequences
Allows multiple Import / Exports to be run using differing templated in a particular sequenceExecution managed by the batch serverOpt for separate imports
134 TEC101: Fundamentals Common Tools
/ © Sage 2011
Exercise 3.2.1Export and import
TEC101: Fundamentals Common Tools135
/ © Sage 2011
Conclusion
The import/export processes are normally based on object management
Limit the processes file by file
Keep data consistent
Sequence and plan imports / exports
136 TEC101: Fundamentals Common Tools
/ © Sage 2011
3.3 The portal
ObjectivesIntroduction to the portal.
Key pointsPresentation of the portal and thumbnails
137 TEC101: Fundamentals Common Tools
/ © Sage 2011
Portal Characteristics
Licence - licence viewDevelopment > Utilities > Verifications > Visualise Licence
General parameters SUP / APL / NEWPORT
Portal componentsParameters
Thumbnails
138 TEC101: Fundamentals Common Tools
/ © Sage 2011
Portal components
Portal ParametersDevelopment > Interactive portal > Portal Parameters
Visual component type / data source
Thumbnail familiesDevelopment > Interactive portal > Thumbnail Groups
139 TEC101: Fundamentals Common Tools
/ © Sage 2011
Portal implementation
Portal viewParameters > Interactive portal > Portal views
Data source tabCase of requests, statisticsOther cases
Visual component tabEnter the parameters
140 TEC101: Fundamentals Common Tools
/ © Sage 2011
Requests and Portal
Parameters > Interactive portal > Portal Views
Links the Data Source & Visual ComponentsData source tab
REQ: RequestFRQ: Update frequencyINITLEVEL: Display level
Visual component tabRE1: Standard request (data in table)FGR: Graphics
Parameters > Interactive portal > Portal ViewsThumbnail: FSH
141 TEC101: Fundamentals Common Tools
/ © Sage 2011
Characteristics
Data sourceParameter list
Default values
Visual componentUse the data source(s)
TB1: Standard table
142 TEC101: Fundamentals Common Tools
/ © Sage 2011
Implementation of thumbnails
Thumbnail groupsDevelopment > Interactive portal > Thumbnail groups
Thumbnail type / Menu / Separator
ThumbnailsParameters > Interactive portal > Thumbnails
Enter the portal view parameters
143 TEC101: Fundamentals Common Tools
/ © Sage 2011
Copy a portal
Initialize a portal from another profileDevelopment > Utilities > Miscellaneous > Portal Management
Select the reference userChoose the destination user
Use of thumbnails
144 TEC101: Fundamentals Common Tools
/ © Sage 2011
Exercises 3.3.xPortal
TEC101: Fundamentals Common Tools145
/ © Sage 2011
Conclusion
Creation of new thumbnails from existing components.
Integration of thumbnails into the portal
User rights
Portal personalisation
146 TEC101: Fundamentals Common Tools
/ © Sage 2011147
3.4. Processes
ObjectivesDefine the good practices for creating a process
ContentsThumbnails
Draw tab
TEC101: Fundamentals Common Tools
/ © Sage 2011148
Processes
Allow the business processes to be optimized with a graphical display
Define scenariosProcess and Menu
Graphic conventions
TEC101: Fundamentals Common Tools
/ © Sage 2011149
Process Design / ImplementationParameters > Interactive portal > Process
ToolsDefine the process mode
Background image
Text
CTRL button
Horizontal lines
SHIFT on 2 selections
Links
ThumbnailsParameters > Interactive portal > Thumbnail
Select the process
TEC101: Fundamentals Common Tools
/ © Sage 2011150
Process Menus
Parameters > Interactive portal > Process menu
The process menu is a tree and ranked representation of a processCreate "Menu" processes
Select the processes
Choose the representation level (up to 3)
Thumbnails
Select the process menu Parameters > Interactive portal > Thumbnail
TEC101: Fundamentals Common Tools
/ © Sage 2011
Exercise 3.4.1Processes
TEC101: Fundamentals Common Tools151
/ © Sage 2011152
Conclusion
Work in a structured manner
"Conceptualize" the process
Comply with a consistent charter
A process is an structural feature and can assist in sequencing complex tasks.
TEC101: Fundamentals Common Tools
/ © Sage 2011
Thank you for your attention !
TEC101: Fundamentals Common Tools153