SBCEM CommonTools v3 PDF
SBCEM CommonTools v3 PDF
This material is provided as a general guidance for informational purposes only. Accordingly, Sage does
not provide advice per the information included. The use of this material is not a substitute for the
guidance of a lawyer, tax, or compliance professional. When in doubt, please consult your lawyer, tax, or
compliance professional for counsel. This material is provided on an ”as is” basis. Sage makes no
representations or warranties of any kind, express or implied, about the completeness or accuracy of this
training materials. Whilst Sage may make changes to this training materials at any time without notice,
Sage makes no commitment to update the training materials every time Sage’s products are updated.
The Sage product(s) described herein is/are governed by the terms and conditions per the Sage End
User License Agreement ("EULA") or other agreement that is provided with or included in the Sage
product(s). Nothing in this document supplements, modifies, or amends those terms and conditions.
© 2018 The Sage Group plc or its licensors. All rights reserved. Sage, Sage logos, and Sage product and
service names mentioned herein are the trademarks of The Sage Group plc or its licensors. All other
trademarks are the property of their respective owners.
Common Tools
Table of Contents
1.0 WELCOME AND INTRODUCTION ....................................................................................... 4
Welcome to the Sage Business Cloud Enterprise Management Common tools training
class. This course is divided into discussion of concepts and Practices, and is intended to
provide you with a basic understanding of the functions and features of the many common
tools available in Enterprise Management. This course is designed to provide you with the
knowledge of:
Training image
During this course, you will have access to a training image for hands-on exercises. On
the training image, you will find everything you need to install the product.
2.0 Inheritance
In the following topic, you will learn about the principle of inheritance and how it affects
working in the program.
• You can also place Crystal Reports in these folders. Crystal Reports may be in more
than one folder.
• The folders comprising the Enterprise Management system use the principle of
inheritance. This means when a folder is created, it can inherit software components,
reports, and settings from the parent folder.
– System: Enterprise Management folders inherit and rely on software components
and settings from the parent. If a folder requires a program or setting that does not
exist in the folder, the parent folder is searched in order to find the program or
setting.
– Reports: Enterprise Management comes installed with many reports and uses
Crystal Reports. The reports also share the same principle of inheritance. When a
new folder is created, the original reports are copied from the X3 folder to the new
folder environment. From that point, you should be aware of report codes/names
and understand report inheritance.
– The Test folder is sometimes called the “SEED” folder and contains demonstration
data that you can practice with.
– The Pilot folder is where you start setting up your system.
– The Live folder is the production environment.
In the following topics, you will learn about general parameters used to configure the
software, as well as how to view and edit parameters.
• Understanding parameters
• Viewing and editing parameters
• Explore what you’ve learned
Understanding parameters
The program is configured by many parameter settings. A parameter is a value influencing
the operation of the software independently from the database structure.
• These parameters allow an implementation team to tailor the program to the needs of
their customers.
• Each module has a set of parameters that govern its behavior.
• You can use parameters for activating and deactivating functionality in the software,
set conditions on a process decision, or influence interface operations.
• Parameters can have the following types:
– Alphanumeric: A series of characters are entered. If the value is controlled by a
table, the selection window is available.
– Numeric: Numbers are entered.
– Date: Enter a date.
– Local menu: A choice is made from a list of options, such as Yes/No. A local menu
is a table identified by a number.
• A parameter is characterized by an internal code, such as ADMUSER, a descriptive
title, and a localization level.
• Parameters available for the supervisor include:
– A default administrator code
– A maximum number of failed attempts at entering the password before locking
– A question relating to the operation trace
• Certain parameters must be defined for the whole folder, while other parameters can
be defined by company or site.
– When a parameter is not defined for a given site, the value for the company that it
is part of is used.
– When no value is defined at this level, the default folder value is used.
– In this way, even if a parameter can be defined by site, it is possible to give a
global value for the folder and then only define the exceptions for certain
companies and/or sites.
• Most of the parameters defined on a global level and at a user level have an
associated global variable.
– If there is not a global variable, the developer can access its value using a sub-
program.
• You can change some parameter settings for users (Setup > Users > Users, then click
Parameter definition).
• In the Left list, select a folder to display the parameters for a particular module.
• The folder you choose is important because each folder can have its parameters set
differently.
– If a site is entered, only the parameters that can be defined at site level can be
modified. If a company code is entered, the parameters that can be defined at
company and site levels can be modified.
– The Folder column indicates the lowest definition level of a parameter group. At the
folder level, all the parameters can be modified, making it possible to assign default
values.
– Some parameters are defined at the user level. In general, the parameters can be
modified, because a default value can be assigned to the site level. On the other
hand, if the value needs to be modified for a given user, these modifications need
to be carried out in the user record.
• You can then change a value by clicking the Selection icon in the field to choose a
new parameter value.
• After changing the value, click OK and then click Save in the Parameter values
function to save your changes.
Parameters are defined in the data dictionary and are organized into modules and by
group. As previously mentioned, the definition of general parameters is a development
function.
• This function controls the values of parameters and allows for the setup of a parameter
as a numeric, alphanumeric, date, or local menu.
– You can define the level, such as folder, company, site, user or Legislation.
– You can also specify how or when a parameter is modified.
In the following topic, you will learn about activity codes and how to create them.
• Activity codes are assigned at the folder level and influence the behavior of screen
structures and the database structure.
• When changing an activity code, the following is required:
– The modification of the activity code, in the folder record, from the parent folder.
– The validation of the child folder.
• An activity code can contain up to 5 characters.
• Specific activity codes that are customized or belong to verticals start with
• X, Y, or Z, indicating they are considered non-standard and are not affected by
patching.
Note: You will learn more about creating and working with activity codes in the System
Administration course.
• The activity code influences the screen and database structures of the software.
• If the Active check box is cleared, any tables, screens, or fields that are dependent on
the activity code will not be available.
• Select the module that the activity code pertains to.
• At the Sequence field, you can determine the order in which the activity codes display
in folder management. Depending on the formula, activity codes are calculated in
ascending order.
• The options at the Type drop-down are used to classify the activity codes in the tabs.
– Functional: Activate or de-activate dictionary elements, depending on whether they
are active or inactive.
– Sizing: This type of activity code has a dimension and is linked to screen fields or
table-type screen sections allowing you to size them or define the maximum
number of possible lines.
– Localization: This type of activity code allows you to enable or disable sets of
elements linked to a given legislation. This type of activity code begins with the
letter K.
In the following topics, you will learn about finding and editing local menus. Local menus
use tables that hold choice information for radio buttons, check boxes, and drop-down
lists. You will also learn how to define and modify miscellaneous tables, which are used
for storing codes, such as payment methods.
• For all the fields in the database storing data of this type, the title row is stored in a
corresponding table.
• For example, if the instance in local menu number 1, is composed of choices No and
Yes (in that order), what is actually stored in the database is 1 for the value No and 2
for the value Yes.
• Local menus are used for the following throughout the software:
– Check boxes
– Radio buttons
– Drop-down lists
• Physically, a local menu type field stores the text number (0-255) and not the text
itself.
• Messages are sets of texts, grouped by local menu, and used for drop-downs and
error/information messages etc.
• For example, if you want to locate any local messages with the string description
“Yes”, enter Yes in the Message function to return a list of all local menus and
messages containing this string description.
• Enter the text you want to search for within the local menus and messages dictionary.
• You can also determine a string description using the mess(N,M,1) function in the
Calculator (Diagnosis > Calculator).
– For example, to determine the first description from local menu 704 (Stock
Transaction Types), enter mess(1,704,1) in the Calculator as shown below and
then press ENTER.
– In this case, the first string description for the local menu is “Miscellaneous
Receipt.”
Note: Modifications of local menus may impose technical actions, such as re-validation
screens if the local menu is used as a radio button. After making a modification to a local
menu, the system automatically launches an update of the local menus.
• The Chapter field indicates the number assigned to the local menu or message.
• Select the Local menu check box to use the menu as a local menu.
• The Changeable check box allows you to indicate whether the local menu can be
modified.
• You can enter the maximum and minimum number of choices in the local menu as
well as the maximum length of the text of the local menu choices at the Length, Mini,
and Maxi fields.
– All local menus are numbered and placed in a range.
• Local menus store up to 254 values, but the code field (in the grid) only accepts
characters A to Z and 1 to 9; therefore, duplicates could occur. This code is only used
for import lookups if needed.
• Select the All languages check box to ensure all languages are taken into account by
the update process.
• After clicking OK, the update process begins.
• Miscellaneous tables are used in all areas of the software for storing codes. Examples
of miscellaneous tables include payment methods and freight terms.
• If you are creating a new miscellaneous table, you start by specifying its number, a
title, the information it will store, and the titles for the four fields that can be entered.
In the following topic, you will learn how to set up and use entry transaction windows to
streamline frequently-used data entry processes in your system.
The following paths show how to access the entry transaction windows for various
modules in Enterprise Management.
• The Transaction field is used to identify the transaction you are setting up. You can
also modify or delete an existing transaction code.
• It is not recommended that entry transactions be deleted, especially those delivered
with Enterprise Management; however, the Active check box can be used to hide entry
transactions from the list that is displayed for the user.
• Use the Access code field to restrict access to certain users.
• Good practice is to limit the information on the table entry portion of the business
document to promote speed of entry and ease of use.
• Additional information, usually set automatically, can be set to be edited or viewed only
in form mode. This makes information available if needed but keeps it hidden until
needed. The following shows an example of a form mode window.
• The Document fields allow you to print a Crystal Report. Enter a code to automatically
print a Crystal Report.
• Determine the entry mode for each field, such as whether they will be hidden,
displayed or if data can be entered.
• At the Form and table drop-down fields, select whether to view the field on the form,
tabular format, or both.
Analytical tab
Use the Analytical tab to define whether fields in the document should be entered,
displayed, or hidden, including the dimensions and stock movement fields. You can also
select the type of line dimension entry mode to use for the entry transaction (form table,
form, or table).
• You can also force a user to see/trigger a transaction using the Menu profile function
in the Setup > Users block.
In the following topics, you will learn how to define and assign sequence numbers
associated with business documents.
• When a sequence number counter is created, or when the counter has never issued a
number, the first number is 1 by default.
• All sequence numbers contain an automatic number that is increased for each
occurrence.
• Sequence numbers are composed of several parts that can be constants or variables
set automatically by the program.
– Sequence number counters contain an incremental numeric segment. The current
value of this segment can be unique or depend on a site, company, month, period,
an additional code, or a combination of these elements depending on the situation.
• A counter always produces alphanumeric keys, but if the type declared is numeric, the
header zeros are deleted when the value is returned.
– For example, if a counter has been declared numeric with six numbers, it will start
with the value “1”; whereas, an alphanumeric counter with six characters starts with
“000001”.
• The Sequence counter identifies a counter, which can be used for automatic
numbering of documents in the system.
– A counter is an alphanumeric field with 1 to 20 characters.
– It is composed of a concatenation of sub-fields that can be of different types, and
which are concatenated from left to right to form the counter value.
• You can choose to set the sequence number for use at the folder, company, or site
level.
• The combination of this setting with the definition level and additional components
defines how many numbering sequences will be assigned to the sequence number
counter.
• If the sequence number contains a year component, the automatic number can be
reset to zero every year.
Sequence type
The Sequence Type section defines the manner in which multi-users’ contentions are
managed on assignment of the number.
• Normal is the standard operating mode. Only one transaction at a time can create a
number by using a sequence number. With this principle, numbers are never lost.
• When a counter is set to Database Sequence, the code of the table used to manage
the sequence number is specified.
– In principle, the numbered documents can be found in the main table.
– This method is efficient if there is no locking involved.
– The numbers assigned are consecutive, but if the transaction is abandoned, there
is a significant risk that gaps may be created.
• The Grouped option defines the number of simultaneously assigned numbers.
– The numbers are assigned by groups of N. N users can then simultaneously obtain
a number without encountering locking problems.
– If the transaction is abandoned, the number is recovered so that they are not lost.
– However, as a result, there may be un-used numbers at the end of the numbering
period. Additionally, gaps may occur because numbers are not assigned in a
strictly sequential manner.
• At the Module field, select the functional module for which you want to define the
sequence number assignment.
• The Document type field defines the document type to be numbered.
• Enter the sequence number associated with the document defined in the Document
Type field.
• If the Manual field is set to Yes, the number can be entered manually. In this case,
automatic assignment is not attempted by the system. However, the sequence number
will be automatically assigned when the transaction is created if the document number
is not entered (that is, if the field is left blank).
• The product sequence is a code defined in the Structures function under Sequence
Number Definition in the Setup > General Parameters block.
Note: The modification of the sequence number must be locked to other users and only
used in the initial phase of recovery.
• The Counter field identifies a counter, which can be used for the automatic numbering
of documents.
• When a sequence number counter is defined by company or site, the company or site
code is part of the key that determines the record of the table where the current
sequence number is stored.
• This function is not necessarily the only place you can assign sequence numbers - in
some cases, sequence numbers are defined directly in the database records.
• Note: It is important to increment higher than the number being used to prevent key
failures.
• The Next value field determines the next value of the counter.
In the following topics, you will learn about the various selection processes available for
searching for and selecting records within the program.
• Under Selection in the Right panel, you can choose an advanced search or keyword
search.
• You can also click the Selection icon in the field to select a specific item to filter on.
• You can also save a selection by clicking Memo in the Right panel of the Object
selection window to save the filter for future use and to access any previously saved
filters.
– Selecting the Global check box makes the selection available to all users when it is
saved.
– Entering the STD code causes the selection to run every time the user reenters the
function. This can make the selection display in a particular order or based on a
particular attribute of the object.
– Click OK to save the memo settings.
– After adding the selection menu, you must close out of the current function and
return in order to see the new code on the Selection drop-down menu.
– Selecting All shows everything in the screen, similar to not having any filters set.
• For example, when entering a sales order, you can use the Advanced object selection
to search for specific products.
• It is accessed by clicking the Actions icon and selecting Advanced selection.
• Default settings automatically display for fields and operator based on the object;
however, you can remove and add fields.
• You can also define sort criteria for the list displayed and define the number of records
listed.
• From the Right panel, you can create a new customer, access inquiries such as
Quotes and Orders, and even create a CRM appointment, function, or project.
• Click Clear in the Right panel to clear all selection criteria in order to start a new
search.
• When entering a customer or prospect number, all addresses for that customer or
prospect display in the grid.
• As information is entered into fields, the results display dynamically within the grid.
– Selection criteria are combined using “and” logic. Only records that meet all the
criteria are displayed.
• The ship-to customer and contact tables are searched at the same time.
9.0 Formulas
In the following topics, you will learn about the language used to develop the Enterprise
Management environment. You will also learn about the components used in the
Enterprise Management language, as well as how to create formulas.
• Note: The header is usually represented with 0 (zero) and tabs are represented with
1,2,3, etc.; however, if a screen does not have any tabs, the header is represented
with a 1. For example, [M:ABC1] uses a 1 for the header instead of a zero.
• The Parameter field on the Initialization tab is used to link the variable to a parameter.
• The Script field on the Generation tab shows the process in which the variable will be
declared.
• The Subprograms field displays the sub-program or function that can be re-used and
accessed from the dictionary.
• Select the Function field to distinguish between functions and sub-programs and then
select the argument at the Argument type field. For example, you can select
Character, Date, or Integer.
• Use the Parameter definition section to identify each parameter (10 character code)
using uppercase letters and numbers. There is no dictionary for these parameters.
• At the Code field, enter a code to identity the function. Codes starting with GES are
automatically generated.
• Use the Options grid to define the option codes.
• Use the Variables grid to define a list of global variables that must be assigned in order
to give a calling process more specific context.
• Use the General tab to enter general characteristics of the function.
• Use the Action tab to identify the action to be executed.
• Many functions are available to apply to formulas. The following tables show
numerical, date, string, arithmetic, and miscellaneous functions that are available.
– N = numeric argument
– C = character string argument
– D = date argument
– X = any type of argument.
Date functions:
String functions:
min([M:SOH3]QTY(0..[M:SOH3]NBLIG-1)
Entering formulas
Many windows within Enterprise Management provide the capability for entering formulas
or expressions for the purpose of defining default values, specifying conditions, and
constructing messages.
• You can access the Calculator by clicking Help > Diagnosis in the Right panel.
• The Formula wizard is context sensitive and displays the appropriate open mask and
file classes. You can then select from the fields, functions, and operators that display.
• Use the Fields and Variables section to select fields and variables for your formula.
• Use the Formula section to build the formula
• Comparison operators allow you to determine if a variable is equal to, different from,
less than, or greater than another value.
• Click Verify to validate the formula.
• The Function field defines the code for the function. This code is mandatory for local
variables.
• The Type field identifies the category for the elements that can be selected in the
Formula Assistant.
• In the grid, enter the function you want to add to the Function list. You select the
function or build the function using the Formula Assistant.
In the following topic, you will learn about attaching documents and graphics to your
current function window and business document (such as an order or product). You will
also learn how to add comments to a page.
• The attachment window displays in a single grid with all the information related to an
attachment
• Attaching a Text entry (stored in database), an Input image, or a File selection link to
an external document is available from the right panel
• The window shows the list of attachments in a grid with associated keywords
• View shows the corresponding file
• The file can be downloaded with file viewer program and can be opened to display the
file content and with the possibility to edit
• It can be filtered by the value entered on the criterion field. * example; typing doc in
the criterion field will display only files containing the “doc”. Wild cards (*,?)
• Clicking on a sub-directory lists the files inside and gives the list of the sub-directory.
• When a file list is longer than 20 lines, a -more- message is displayed. Clicking on this
line will read all the remaining files in the list
• Database attachment and print is also possible for texts and images stored in
database
• For other documents, the document viewer – Office for instance – must be launched to
view documents
Adding comments
Use Comments (comment icon) in the Right panel to add a comment to the function
window.
• Enter and format text, images, and links in the drawing area.
In the following topics, you will learn how to export data to Microsoft Excel, Microsoft
Word, and Microsoft PowerPoint.
• You have direct access from Microsoft Excel, Word, and PowerPoint to Enterprise
Management data sources.
• You can define templates for reuse.
• Documents can be refreshed at any time.
• Access and user rights are controlled by Enterprise Management, when creating and
refreshing documents.
As a result of the integration, data is secured, coherent, and up to date, and you can
benefit from all the Microsoft Office presentation features.
• Representation pages, such as List pages, View pages, and Edit pages, as well as
grids within pages allow you to export data quickly and easily into Microsoft Office
applications such as Excel, Word, and PowerPoint.
• For example:
– List pages and View pages can export data to Excel, Word, as well as a Word
Mass mailing.
– Edit pages can export data to Excel and Word.
– Grids can export data to Excel.
– Grids can export data to PowerPoint if the grids display numbers.
• In various functions, the Right panel includes Microsoft Office links.
• For example, if you click Excel while on a Customer List page, the list of customers in
the table is exported to Excel.
– If a filter is defined, only the filtered data is exported.
• If you select the Excel export option while in a grid, only the data in the grid is exported
to Excel.
• When exporting from a grid, you are prompted for a title and name for the tab that will
be created in Excel prior to the actual export.
Connecting to the server
The system prompts you for your Enterprise Management login user and password, if
passwords are defined. The data being extracted into Microsoft Office is coming from the
same server you are logged into in your browser.
Data extraction
When the connection is completed, the data insertion automatically starts. The Office
client creates the column header and fetches the data in bulk mode.
Excel report
When exporting to Excel, you are given the option of using an existing template, creating
a template, modifying a template, or using no template at all.
• Select the Choose existing template option to create the report using an Excel
template.
– Click the Selection icon at the Template field. The List of templates window
appears, from which you can select a template.
– Only those templates matching the criteria defined for the template are available
for selection. For example, templates can be made available to only a specific
company.
– This is the only option that will extract data from the entity selected and prompt you
to connect with a valid user ID and password.
• Select the Create template option to create a new template in Excel using the data
from the entity (such as List).
• Note: After installing Excel, you may need to click the Enable Editing button that
displays below the ribbon.
• When exporting directly to Excel, the server settings and connection are automatically
set based on your browser connection.
• When accessing Excel outside of Enterprise Management, you must define the server
settings before connecting.
– If you click Connect and a server setting is not defined, you are prompted for the
server settings before getting the connection window.
– The user ID and password entered are the same as those used when accessing
Enterprise Management and all security defined applies.
• The window that appears displays any filters or sorts that are defined.
Editing the current data source
To define filter and sort information for the current data source, click the Modify to edit.
• You can define filter information for each of the columns in the spreadsheet.
– By clicking the Filter icon next to the column description, you can select the
operator and the values to define the filter.
• Clear the Fetch all check box to limit the number of records retrieved.
• In the Order bys section, you can define the extraction sorting order. You can select
multiple columns from the data source before selecting the ascending or descending
order option.
Adding data from a pre-defined data source
In the Workbook settings window, select Predefined data sources. The following window
appears
• After defining the information, click Apply in the Right panel to apply the new
rows/columns to the spreadsheet.
• The data from the data source selected is inserted at the current position of the cursor
in the Excel spreadsheet. This can be on the same tab or a new tab.
• The data from the data source selected is inserted at the current position of the cursor
in the Excel spreadsheet. This can be on the same tab or a new tab.
Publishing
After creating the spreadsheet, you can publish the document so that it can be viewed and
edited through Enterprise Management. To publish the document on a collaborative
space, click the Publish as button on the Sage ribbon and select to publish as a document
or an Excel report template.
• When Export is selected in the Right panel, the data is collected and an Excel icon is
added to the Export excel window. Click the Excel icon to view the spreadsheet in
Microsoft Excel.
• After clicking the Excel icon to view the spreadsheet, all other options previously
discussed, such as adding data sources and connecting to a server are the same.
• Word: This allows you to create a document containing the elements on the page,
defined by a Microsoft Word report template.
– The report option will display as either Word report or just Word in the Right panel.
• Mass mailing: Only available in a List view. This allows you to generate a list of mailing
pages by repeating a mail merge template document for every record in the list.
– A mail merge assistant aids you in the creation of the mail merge document.
Defining templates
Regardless of whether you are creating a mail merge or a report, you must have a defined
template to use before actual data is populated into the template from Enterprise
Management.
Note: You can view a list of Microsoft Word templates already stored in Enterprise
Management using the Word templates function in the Administration dashboard view.
• Select the Choose existing template option to create the report using a Word mail
merge template that was previously uploaded into Enterprise Management through the
Word templates function.
– Click the Selection icon at the Description field. The List of template window
appears, from which you can select a template.
– Only those templates matching the criteria defined for the template are available
for selection. For example, templates can be made available to only a specific
company.
– This is the only option that will extract data from the entity selected and prompt you
to connect with a valid user ID and password.
• Select the Create template option to create a new template in Word using the data
from the entity (such as List).
– You can save the document created as a template and upload into Enterprise
Management through the Sage tab in Word.
• Select the Modify template option to modify a template that was previously uploaded
into Enterprise Management. The template to modify is selected at the Template field.
• When moving or deleting fields from the template, you must select the entire field
reference.
• The Locale field defines the locale code of the user that created the template.
Show fields
If the Show Fields check box is displayed, all the fields associated with the function are
available in the Template fields panel in the right side of the window.
• All the fields are available, grouped by blocks. Standard blocks and collections have
different symbols, and each type of field is also identified by a symbol.
• You can add fields to the document by double-clicking the field in the Template fields
list.
• To view actual data using a template, click the appropriate Word link and select
Choose existing template. In the Template field, select an existing template.
• Clicking OK displays the document displays in Word showing the actual data.
• To publish as a document:
– If the Read-only check box is selected, only the owner can edit the document. The
owner automatically defaults to the current users ID.
– At the Storage volume field, select the storage volume where the document will be
uploaded.
– After publishing the document, click the Save to ENTERPRISE MANAGEMENT
button again to resave the document to Enterprise Management.
– You can also limit the user of the template to team(s) under Tags and Teams.
Teams are groups of users.
• If you want to limit the use of the template to a specific endpoint, select the endpoint at
the Endpoint field.
– If an endpoint is selected, you can limit the use of the template to a specific
company, legislation, and activity code.
Mass mailing
When using Mass mailing, you are given the option of using an existing template, creating
a new empty document, or creating a new document using a defined template in Microsoft
Word.
• The following message may appear: Click Yes if the Microsoft Office Integration addin
is already installed on your system. Click No if you need to install the addin.
• Microsoft PowerPoint opens with the graph displayed on a separate slide using the
data array from the original gadget.
In the following topics, you will learn about importing and exporting data in Enterprise
Management. You can export data to Excel, as well as export to a file.
• The choice of the structure of the files to be imported or exported depends on the
extraction or integration capabilities of the external software.
– The data must be organized in logical groups of lines, which can be different types
(such as header, detail, or sub-detail) or a single type. The organization of these
groups is defined in the Import/export template function discussed in the next
section.
• The import process allows for the creation and modification of actions.
– To determine the action to be carried out on the imported record, the system
performs a test on the object to make sure it exists.
– This test is carried out by loading the primary key for the object with the information
in the imported record.
– As a result, if the primary key is not parameterized, all the records will switch to
creation mode and only function if the key for the object to be created can be
assigned automatically, for example by means of a sequence number counter.
• An import corresponds to an entry simulation for all the screens linked to the imported
object.
– It processes all the fields in the screen by carrying out the same checks as an
interactive entry.
– It does not take into account the fields that cannot be entered in the screen (except
in specific and referenced cases). As a result, the fields parameterized in a
template corresponding to a field that cannot be entered are not imported.
• The order in which the fields are parameterized within the record has no importance.
– The import loads all the fields then imports them in the order of the fields in the
screens.
• Any number of data exports is possible regardless of the object, but this is not always
the case for the import.
– The automatic mechanisms for decoding the data flow and the call to the
conditions linked to the object greatly automate the import, but this is not sufficient
for an automatic import of complex objects. Therefore, not all objects can be
imported.
• At the Local code field, define the code used internally in the software.
• At the External code field, define the code used in the files for the data to be imported
or exported.
• The following principles apply:
– A search is made on the value of the field to be exported in the list of values in the
Local code column.
– For an export, if a value is found, it is replaced with the corresponding external
code.
– For an import, if the value is not found in the External code field, and if an external
code is set to *, the corresponding internal code is taken.
• Transcribing example:
Local code External code
CHK CHECK
DIV *
* OTHER
– For an export:
o CHK is transcribed to CHECK
o DIV is not transcribed and remains DIV
o Any other choice is transcribed to OTHER
– For an import:
o CHECK is transcribed to CHK
o Any other choice is transcribed to DIV
o OTHER is not transcribed and remains OTHER
Use the General section to enter the activity and access codes, as well as define the
standard or specific processes. The table below provides information about the options
available in the General section.
Use the Structure section to define the structure of the file being imported or exported,
such as file type and format, and field and record separators.
File type The File type field defines the structure used to
manage the data in the file to be imported or
exported. The file types include ASCII 1, ASCII 2,
Delimited, Fixed Length, XML, Flat, and With
Header.
Field separator The Field separator field allows you to enter the
separator to use for separating fields in the file. To
enter a non-printable character, you must enter a
back slash “\” followed by three numbers
represented as ASCII code of the character in
decimal base.
Record separator Use the Record separator field to enter the
separator to use for separating lines in records. To
enter a non-printable character, you must enter a
back slash “\” followed by three numbers
represented as ASCII code of the character in
decimal base. Examples of field separators include
“:” and “,”.
Field delimiter The Field delimiter (usually a single or double
quote) is added in the first and last position for
alphanumeric fields. For numeric and date fields,
there is no requirement for a delimiter.
File format The File format field defines the format of the
characters used in the file, such as ASCII, UTF8,
and USC2.
Export section
Use the Export section to determine whether to use the template for an export. The table
below provides information about the options available in the Export section.
Use the Import section to determine whether to use the template for an import. If so, you
can also determine if an existing record can be modified during import. The table below
provides information about the options available in the Import section.
Use the Compiling section to define the character set to use. The table below provides
information about the options available in the Compiling section.
• Each group is associated with one of the tables in the database, the first being the
main table of the object, and the others defined by the links from the previous table.
• If fields extracted from different tables are displayed in a single data group, the export
process attempts to resolve the links between tables by using the link structure
described in the dictionary. This supposes that there is only one link possible from the
main table in the group to the described table (if not, the first link encountered will be
used and even if it is not the correct one).
• If the template is defined with a fixed length, it is necessary to define the record length
somewhere and this is done in the group of tables.
– If the group indicator is not required to be present in the list of fields, it is sufficient
to define this group with an empty code. Only one group can then be defined.
• The table below provides information about the options available in the Identifiers
section.
Level This field defines the hierarchy of the different
tables. Level 1 is the main level, a N+1 level
defines a sub-level of the preceding N level.
Indicator This field identifies the group by a code containing
a maximum of five characters. This code is
mentioned in the field grid on the Fields tab and in
the file itself as a group header.
Table This field identifies the structure of the record
groups. Only the tables updated by the object are
usable. For example, it is not possible to
simultaneously import the order and the customer.
Key This field defines the key of the linked table used to
access the detail of the group records (from values
of the upper level tables used in the link
expression).
Link This field defines the link expression, which is a
series of values separated by a semicolon giving
the key values linking the detail table to the header
record.
Length For files with fixed lengths, you must indicate the
number of characters in each record at this field.
• Note: It is not mandatory to define the fields in all the groups (in fact, some can only be
technical groups defining the links).
• Example: The fields from the order header and the fields from the pay-by customer
record are to be exported in a single group of data (no separator for the data group). In
this case, you need to define two groups (the first defining the orders, the second
associated with the customer with the appropriate link). However, only the lines
associated with the second group are entered in the field tab. These lines can include
both the information extracted from the customer and from the order header (because
both are one line).
• Use the Range section to enter fields for which ranges can be entered.
– Note: If nothing is entered for the First Value and Final Value ranges, all criteria is
selected for that field.
• The tables used in the import or export are listed in the Criteria section in order to
enable any filtering of the data.
– You can define a logical condition. Only those fields meeting this condition will be
exported.
• Select the template you want to use for the export process.
• If the Chrono management check box is selected, the export is only carried out on
records modified since the last export.
• The Data file field displays the path of the export file.
• The tables used in the import/export template are listed in the Criteria section in order
to enable any filtering of the data.
– You can define additional criteria to filter the data to be exported for the table using
logical expressions.
Execution
In the Exports window, click Execution in the Right panel to start the export process. Once
completed, a log window displays indicating any errors, how many lines were exported,
and location and name of the export file.
• The Template field specifies the template to be used for the import.
• If the Import/export temporary storage space check box is selected, any wrong lines
that are detected will be placed into a batch in the import-export temporary storage
space.
• The Data file field displays the path of the data file from which the import has been
launched.
• Click Test in the Right panel to import in test mode, where only the decoding of the file
is carried out. The data is not integrated in the database.
Importing the data
Click OK from the Right panel in the Imports window to begin the data decoding process
(comes from the template).
• After the file is selected, click OK to continue with the import process. After the import
process is completed, the log file displays any errors. A log window then appears.
• When setting up the parameters in Import/export template, you can select to use the
temporary storage space during the import process. For more information, see the
Defining File Formats for Import/Export topic in this document.
• The lot number is the batch number assigned from a sequence number counter. This
identifies a consistent group of data imported into the storage space.
• The Template field defines the import/export template that is used when feeding the
storage space.
13.0 Printing
In the following topics, you will learn about printing within the software.
The following are different ways you can print in Enterprise Management:
• Use the Reports > Prints/group block which contains reports available by module.
– All reports in Enterprise Management are organized under categories and located
in the Prints/group block. If more than one report can be printed from a category,
clicking a category opens a window with all the reports listed.
• Click the drop-down arrow at the Print icon to have the option of printing the current
record or a list of what is on the screen. Sometimes when printing with the List option,
a summary report is produced. Selecting Record produces the same result as clicking
Print.
• Note: The user may also be automatically forced to print, based on the settings in
entry transactions.
• If two or more documents/reports can be printed from the function, a window displays
listing all the documents or reports that can be printed.
• The parameter definitions may be different depending on the report you select. You
must enter the required parameter definitions or accept the defaults.
• Use the First and Final value fields to enter a range of values.
• The Print selections line allows you to print the selections in a cover sheet.
• When entering a range of values, any document falling within the range will print
(assuming another parameter value does not prevent printing the document).
• Depending on your setup, you may need to enter additional information, such as
copies, paper size, etc.
• Click the Print button to print or preview the document/report.
• You can defer the report for printing at a later time by clicking Deferred in the Right
panel.
• Note: Print destinations can vary depending on where the user can print to.
• The List of field shows the destinations you have set up.
• The Phase field shows the status of the print job, such as Job started or Job finished.
• Click Details for more information about the print job.
• Reports remain in the list until you log out of your current session.
• When the job is finished, the following happens:
– The status bar turns from green and white stripes to solid blue.
– The Download button becomes available.
– “Job finished” is displayed.
– The message “Report available in storage area.” appears in the Details drop-down.
• Click the Delete icon to remove the report after it is printed. Previewing
When previewing documents or reports, you are automatically given the option of opening
the report in Adobe Acrobat Reader or saving the report.
In the following topic, you will learn how to define workflow rules, and well as set up and
monitor workflows notifications and events.
• Alert the sales and accounts departments when a key customer places an order that
goes on credit hold.
• Alert an inventory manager when a newly allocated item causes available stock to fall
below its reorder point.
• Alert a purchasing agent that a sales order line requires a direct purchase order to be
issued, or informing a production manager that an order line requires a new work order
to be set up.
• Alert a sales manager and track when orders for a specific sales representative falls
below the targeted gross margin values.
The following depicts a high-level view of the workflow notification process.
Message
• In the Message section:
– At the Object field, enter the contents of the Subject field in the form of a calculated
expression.
– Use the Text area to define the main content of the message.
• You can view information for each event, including the messages sent, or the
signature history. The event can also be signed or approved, depending on the
situation.
• If no recipient is selected, information for all recipients can be viewed (unless the
Exceptional delegate check box is selected).
• The workflow notifications for which a signature or approval rule are set up display in
the grid.
In the following topics, you will learn about the Requester tools for creating queries (also
known as requesters).
• Requester tools
• Creating simple Requesters
• Using the SQL Requester
• Using the Graphical Requester
• Explore what you’ve learned
Requester tools
A requester is a view of data that is user defined.
• You can create a graph or simple list and then view them on your Enterprise
Management dashboard.
• There are three main tools that can be used for creating requesters (queries) as
shown below.
• Use the Number of lines field to define a logical number of lines by page in the query
screen.
• In the Selections section, enter selection criteria which are logical expressions applied
to the table fields and that can include constants, functions, and operators.
• In the Links section, you can define links that have not been defined in the dictionary.
Access tab
Use the Access tab to define the access conditions to the query and the extracted data.
• The Query type field is used to manage the display of the query with the following
possible behaviors:
– Normal: The query is displayed if the query has already been viewed by the user. If
this option is selected, each user launching the query creates a set of data
belonging to them that cannot be viewed by any other user.
– Shared: This query can be viewed by other users. Shared queries are useful when
a large query is launched by a single user. A group of users can access the
information. It is recommended that only one user run the query, with other users
having inquiry access. It is also preferred to run this type of query in batch mode if
it is large; the corresponding batch code is called CALALH.
– Recalculated: This query is never displayed automatically (must refresh or enter
the criteria). This makes it possible to avoid reloading data if the data is known to
become rapidly obsolete.
• Use the Access code field to limit access to the current record. Only users with this
access code can view or modify the record.
• At the Representation field, you can determine how the series values are combined in
the display.
– Multiple: The values of each series are presented side by side, with one color per
series.
– Cumulative: The values are presented in a vertical total.
– Comparative: The values are presented in relative comparison. The height of the
graph remains constant.
• The Default graph field defines the graphical representation used for the data , such as
Bars, Lines, Area, or Sectors.
– If only one series of data is available, the graphical representation is fixed by the
setting made at this field by default.
– If several series of values are represented, you can mix the presentation modes. In
other words, one series can be in the form of bars and another can be in the form
of lines.
In the following topics, you will learn about process flows and how to design your own
process flows.
• The process flow window allows you to access all the functions associated with the
entity (in this case, orders). This can be a good feature to use for employees who use
the same tasks daily, such as an order entry clerk.
• In addition to selecting the access code and activity codes, you can select whether the
process is of type process or menu.
– The menu type is used to organize the sub-menus in the processes’ browser.
• Use the Description section to design your own shapes and then add links and
actions.
• In the Right panel, select Process import to export the process to a text file. You can
then copy the text and past it into the import phase.
• In the example below, a button titled Website was created using the “Create a button”
icon and the “Change the font of the selected text” button.
• You can then create a link to a URL by clicking the “Create/modify a HTTP link” button
and entering a URL to a website in the Location – Webpage Dialog.
• The File menu allows you to open and save a process flow as well as import or export
the process flow as text (HTML coding).
• The Page menu allows you to show page limits and resize the process flow page.
• The Help menu provides helpful shortcuts and information when using the editing
tools.
• The buttons located below the menus allow you to open and save a file, undo or
repeat, link an element to a function and attach actions to an element.
• The buttons allow you to perform various activities such as add links or add actions to
elements.
• The actions you can attach to an element include:
– Show as mini menu
– Lock/unlock mini menu
– Show as tooltip
– Show/hide
In the following topics, you will learn about menu items located within sub menus and my
landing pages
Use the Information section to define the main characteristics of the link, including the
following:
• Code: Not mandatory. If no entry is made, it will be assigned with an internal code that
will not be displayed.
• Title: This field is mandatory and appears when a menu item is referenced. For Classic
functions, it is recommended to use the function code. For Entities / Representations
pages, it is recommended to use the representation code.
• Description: This is a user-friendly description of the menu item.
• Link type: Indicates what kind of page will be called if the link is activated. The
following choices are available:
– Representation is a page that manages a facet of an entity. Thus, the user will
have to enter an entity, an associated representation and a facet.
– Function (Classic) is a page that manages a function in Classic mode. Therefore,
the function code must be entered.
– Dashboard page is a link that brings the user to another dashboard. The code of
the dashboard is required.
– External link is used when the menu item links to a URL that will have to be given.
• Icon: Indicates the file name and repository of the icon to display.
• Application menu: This check box is used to define how the menu item appears on
mobile clients. This is subject to change in a near future.
Content section
• Application: Entered for Representation and Function (Classic) link types. This field
refers to the application used for the link.
– The Syracuse collaboration application is used to connect administrative,
collaboration, and authoring pages directly managed by the node server.
– The application is mandatory if the link is a Classic type link.
• Endpoint: Can only be entered for Representation and Function (Classic) link types. If
entered, the link will automatically be displayed in a vignette (if the vignette is
associated with the right endpoint).
• Representation: Entered for Representation link types only. Defines the representation
used for the user interface. This representation is linked to the entity; therefore, only
some representations are available for a given entity. A selection is possible in the
same conditions as for the entity definition. Only a representation attached to the
previous entity can be used.
Use the Parameter section contains additional values depending on the link previously
defined. The value that can be sent to the function is usually for the object types function
called GES_xxx_.
• Depending on the entity, additional parameters may have to be entered. If this is the
case, the name and title columns will be filled and the value column must be entered.
• The parameters available may depend from the page called. But some standard
parameters exist especially for query facets, and are documented here.
Display
• Module: Select the module where you want to place the menu item.
• Categories: Item menus can be associated with categories. The assignment can be
done in categories with a selection window allowing multiple selections.
Landing pages are accessible from the Home page and are initially displayed when
logging onto the program. You can create your own landing pages displaying information
that has been previously defined as accessible by your system administrator.
• A list of links that point to other pages (Normal pages, Classic pages, List pages, View
pages, Edit pages, and other URLs.)
– Normal pages are those that are built to fit with the size of the gadget in the portal.
• Visual processes with or without a menu process.
• Reports or statistical inquiries.
To create a new landing page, from your Home page, click the New option in the Left bar.
• You cannot enter spaces in the page name; however, they can be entered in the title.
• If the Use current endpoint checkbox is selected, any gadgets added to a landing page
must use the current endpoint for execution or displaying of data.
– If the checkbox is cleared, you can use the landing page to display information
from several endpoints.
– The endpoint is always defined when creating the gadget.
• The landing pages you create are listed under My Landing pages in the Left bar.
• The endpoint selected is the endpoint used for the gadgets selected.
• Under Browse Category, select the type of gadget you want to add.
– Click Queries to add user-defined reports done by the Requester.
– Click Statistics to add statistical aggregated data set up by the statistical tool.
– Click Web to display a defined web page which includes a specific URL.
– Click Processes to add visual process maps.
– Click Representations to add any page defined by a menu item. This does not
include Classic pages displayed in a full page and not in a gadget.
• Depending on the option selected under Browse Category, different pages display;
however, they all have the same behavior.
– A search field is available to select the gadget by its name. You can add multiple
gadgets by simply clicking on the ones to add before clicking the Finish icon.
– A selection can be done by selecting first a module, then a category, and finally the
gadget.
• If you place your mouse pointer over the gadget added, you can personalize the
gadget, refresh the gadget, delete the gadget, and minimize the gadget.
– The Personalize icon is not available for all gadgets and is typically used to change
how the data is displayed. For example, you can personalize a gadget to show
data in a grid in a card format.
Assigning Landing Pages
By default, any landing pages you create are automatically available to you under My
Landing pages.
• Using the Home pages function, a system administrator can assign landing pages to
other users based on their role.
• Users with access to this function can also define the endpoint used for each gadget
and change the owner of the landing page.
– Only the owner can edit the landing page.
• Any new tabs added can be deleted by clicking the Delete icon displayed on the tab
page.
Adding a Gadget
To add a gadget to a page, click the Add gadget icon displayed in the upper right corner of
the page.
• The options available for adding a gadget are the same as when selecting one after
creating a new landing page.
• To add personalize the landing page, click the Personalize Landing Page icon
displayed in the upper right corner of the page.
• The tab currently displayed on the landing page is the one affected when you click the
Personalize Landing Page icon.
• Templates only display if more than one gadget is added to a tab.
Changing the Order of Landing Pages
You can modify the order in which landing pages display. This is done by pointing to the
landing page to move and clicking on the three dots displayed to the left of the landing
page name.
• Once you click on these dots, you can drag the landing page to a new position in the
list.
In the following lesson, you will learn how to customize the pages displayed including a
new dashboard, Classic page, List page, View page, and Edit page.
• Screen Customization
• Using Screen Customizer
• Explore what you’ve learned
Customizing screens
Some users have the ability to customize a screen using the “Screen Customization
feature. For example, you can easily change the order, remove, display in columns or
stack fields and have those changes appear for a specific user or group of users.
– To create or modify, click the label, which here is called SAGE, to display the
dropdown. Click “Customize page”.
• Now you will see some new choices. In the column at the left hand side, select the
display options of your choice, “Columns” or “Stacked” for the sections of the block
– Related to the fields, two options allow you to mask the fields, either on laptop
screens or on smartphones. An arrow is used to add a line break after the chosen
field.
– When you have finished with customizations and finalized your view, you must
save it and set a code, a title, a description and then assign it. Assignments
depend on the user rights, such as creating custom screens, sharing them
according to roles (for an endpoint) or doing a global creation.
– The custom screen becomes the default screen. If several custom screens exist for
the same function, you must select the code of the desired screen, at the top right.
– To delete a custom screen, you go to the “Personalization” mode and click on the
“Recycle bin” icon. Then, you will be back to the default mode.
• The CRUD is the where common actions take place, located on the right side of the
screen. It covers functions such as Save, Undo, Redo, Reset, Cancel, and Delete.
– If your user security profile has the authorizations, you can access the pages
customization through the "Customize page" menu.:
– In the column at the left hand side, select the display options of your choice,
“Columns” or “Stacked” for the sections or the block.
– Related to the fields, two options allow you to mask the fields, either on laptop
screens or on smartphones. An arrow is used to add a line break after the chosen
field.
– When you have finished with customizations finalizing your view, you must save it
and set a code, a title, a description and then assign it. Assignments depend on the
user rights, such as creating custom screens, sharing them according to roles (for
an endpoint) or doing a global creation.
– The custom screen becomes the default screen. If several custom screens exist for
the same function, you must select the code of the desired screen, at the top right.
– To delete a custom screen, you go to the “Personalization” mode and click on the
“Recycle bin”. Then, you will be back to the default mode.
In the following topics, you will learn how to personalize inquiry screens and objects
across the software.
Personalizing objects
Use Objects (GESAOC) under Personalization in the Setup > General parameters block
to modify certain object characteristics. These objects include the selection windows,
QuickSelect lists, report printing, statistics, and automatic links.
Summary
You have learned: