Top
Top
LibraryEASYProcess Reference ManualConfiguration, Instance, and Variables
Configuration, Instance, and Variables Overview
Configuration, Instance, and Variables Use Examples

Configuration, Instance, and Variables Overview

The “Configuration, Instance, and Variables” page allows us to save application level variables which can be referenced in various areas of EASYProcess.

Understanding the Hierarchy

Configurations, Instances, and Variables

Some of these variables are already set up in existing groupings. Those groupings are called Configurations. An example of these are the database connections. There are some existing database connections such as “AppData” and “JDEData”. These are considered Instances of the “Database” Configuration. Both of those instances have Variables such as “ConnectionString”, “DbName”, and “DbType”. This is represented visually below:

General Outline

“Database” Configuration Example

  • Configuration
  • Instances
  • Variables
  • Database
  • AppData
  • ConnectionString
  • DbName
  • DbType
  • JDEData
  • ConnectionString
  • DbName
  • DbType

Categories

This structure so far can be enough to organize most Configurations, but sometimes a particular topic can accumulate lots of variables which can become difficult to manage. In these scenarios, dozens of variables can build up and in order to change one variable, you would have to scroll through all of them. This can get tedious especially if you wish to edit a group of variables pertaining to the same use case.

For these situations, Categories are available to further organize the variables. In the screenshot below we are looking at the control to View/Edit the existing Variables. Notice that at the top “No Category” is selected. This is the default option.

When categories are set up, the tree on the left looks a little different. Instead of the Instance (often “Default”) being the lowest level available to select, you can now select the Categories.

In the table below we have edited the hierarchy to add the Category level. This shows the “EASYPay” Configuration breakdown both with and without Categories. You can see it doesn’t affect the data, but it does organize it into smaller related categories which can be easier to maintain.

“EASYPay” Configuration Example Without Categories

“EASYPay” Configuration Example With Categories

  • EASYPay
  • Default
  • AddlChargeMode
  • AddlChargePercent
  • AllowAddlCharges
  • ARUpdateMode
  • ARSettlementFile
  • ARBatchUpdate
  • Other
  • AddlChargeMode
  • AddlChargePercent
  • AllowAddlCharges
  • ARUpdateMode
  • ARSettlementFile
  • ARBatchUpdate
  • EASYPay
  • Default
  • AddlCharge
  • AddlChargeMode
  • AddlChargePercent
  • AllowAddlCharges
  • ARUpdate
  • ARUpdateMode
  • ARSettlementFile
  • ARBatchUpdate
  • Other
  • AddlCharge
  • AddlChargeMode
  • AddlChargePercent
  • AllowAddlCharges
  • ARUpdate
  • ARUpdateMode
  • ARSettlementFile
  • ARBatchUpdate

Editing the Hierarchy

If you select the Instance level, the screen changes to give you access to the level directly below it. So if you click on “AppData”, the screen will change to display the variables for this Instance. On this screen you have the ability to edit the values saved for the variables. However, you are not able edit the names of the variables themselves or add new ones. This is because the variables that exist under one instance exist under all instances of the configuration. So the values belongs to the instance, but the variable definitions exist under the configuration.

If you select the Configuration level, the screen changes to give you access to both levels directly below it: Instances and Variables. You will have the ability to view and edit existing Instances and add new Instances. Since the variable definitions exist under the configuration, you can also view and edit existing variable definitions and add new ones.

Here is the screen shown when a Configuration is selected:

Since Configurations are the outermost level, in order to view or edit your configurations, you must select the very top node: “Configurations”. Below is the screen shown when this level is selected.

Configuration Groups

You may have noticed there are two groupings of Configurations: System Configurations and Application Configurations. The only difference between these two is where they are defined.

System Configurations  - Saved in the Base database because they are considered essential to EASYProcess. The Base database contains records that are needed to run EASYProcess and should not be edited. These System Configurations must exist in every Application in order to use it. Some of these configurations are Email SMTP server credentials for sending emails, database connection info for querying the JDE or the database EASYProcess is saved to, language translation API Urls, etc.

Application Configurations - Saved in the Application database (usually named after the application such as “EASYCommerce” or “ESS [Employee Self Service]”). These are not considered essential to run EASYProcess, but may be used by the Application itself.

For example, not every application will need OrderHistory variables. EASYCommerce uses this Configuration because users can place orders and access an order history. However, the Item Approval application users do not place orders so this configuration would not exist in that application. They might have a “ProcessLogging” configuration, which would mean something to the developers using it, but in EASYCommerce, it is not defined.


Powered by EASYProcess (© 2019 K-Rise Systems, Inc).