Configure the Cache Settings for the Plant Applications Services

About this task

The Plant Applications supports the caching and refreshing of the cached Plant Applications services after a certain time interval. You can configure the duration of the saved cached services in the application.properties file of the respective Plant Applications services. After the set duration, the services are cached again.
Note: Perform this task only if you want to get the updated information from the Plant Applications Server before the cache expiry time.

Procedure

  1. Enterprise Installation: In the directory <Installation_Directory>/PlantApplicationsDocker/plantapps-web-docker, access the env.yml file by using the vi editor.
  2. Standard Installation: In the directory <tomcat_home>/Apache Software Foundation/Tomcat 9.0/webapps/<service_name><version>/WEB-INF/classes, access the application.properties file by using a text editor. Where:
    • <tomcat_home>: Is the directory where you installed Apache Tomcat. For example, C:/Program Files.
    • <service_name>: Is the service for which you want to modify the default cache properties.
    • <version>: Is the version of the microservice created during the installation of the Plant Applications Web Client.
  3. Below is the list of cache properties with default values pertaining to the individual Plant Applications services. You can modify these default cache properties for a service based on your requirement.
    Service Name Properties
    plantexecutionservice scheduler_workorder_timer_seconds: 7200
    scheduler_mes_timer_seconds: 1800
    route-service maximumProductCacheSize: 1000
    cacheProductExpireAfterAccess: "15m"
    schedulerTime: 36000
    route-app-service maximumProductCacheSize: 1000
    schedulerTime: 36000
    cacheProductExpireAfterAccess: "15m"
    supervisor-app-service supervisor.scheduler.delay=3600000
    segmentdefinitionservice maximumCacheSize: 100
    cacheExpireAfterAccess: "50m"
    operator-app-service

    maximumDayCacheSize = 1000

    cacheDayExpireAfterAccess = 24h

    maximumShiftCacheSize=100

    cacheShifExpireAfterAccess=4h

    maximumWeekCacheSize=1000

    cacheWeekExpireAfterAccess=168h
    erp-import-service maximumCacheSize: 100
    cacheExpireAfterWrite: 5m
    erp-export-service maximumCacheSize: 100
    cacheExpireAfterWrite: 5m
    cacheLaborExpireAfterAccess: 60m
    process-analyzer-app-service maximumCacheSize=100
    cacheExpireAfterAccess=20m
    tagVariableMaxCacheSize=100
    tagVariableCacheTimeOut=6h
    kpiMaxCacheSize=40
    kpiCacheTimeOut=30m
    siteParameterMaxCacheSize=20
    siteParameterCacheTimeOut=1h
    mes-data-service historianTagMaxCacheSize=50000
    historianTagCacheTimeOut=6h
    scheduler.tagcaching.seconds=21600
    alarm-app-service maximumDayCacheSize: 100
    cacheDayExpireAfterAccess: 12h
    maximumShiftCacheSize: 100
    cacheExpireAfterShiftAccess: 8h
    maximumHourCacheSize=100
    cacheExpireAfterHourAccess=1h
    productionmetrics-app-service maximumDayCacheSize: 100
    cacheDayExpireAfterAccess: 1h
    maximumWeekCacheSize: 100
    cacheWeekExpireAfterAccess: 24h
    maximumShiftCacheSize: 1
    cacheShiftExpireAfterAccess: 10m
    downtime-app-service maximumHourCacheSize: 100
    cacheDayExpireAfterHourAccess: 1h
    maximumDayCacheSize: 100
    cacheExpireAfterDayAccess: 24h
    productionschedulerappservice maximumSize=500
    configurationCacheExpiryTime: 30m
    processorderservice maximumSize=1000
    configurationCacheExpiryTime=1m
    waste-management-app-service maximumDayCacheSize=1000
    cacheDayExpireAfterAccess=24h
    maximumWeekCacheSize=1000
    cacheWeekExpireAfterAccess=168h
    maximumShiftCacheSize=100
    cacheShiftExpireAfterAccess=4h
    webgenealogy-app-service genealogy.scheduler.timer.seconds=36000
    Bom-management-app-service maximumCacheSize=100
    cacheExpireAfterWrite=1h
    Approval-cockpit-service NA (observed a few cache properties defined in application.properties file but they’re not in use).
    Approval-cockpit-app-service NA (observed a few cache properties defined in application.properties file but they’re not in use).
    Receiving-inspection-app-service maximumCacheSize=100
    cacheExpireAfterWrite=1h
    Receiving-inspection-service cacheExpireAfterWrite=1h
    maximumCacheSize=100
    Time-booking-app-service cacheExpireAfterWrite=1h
    maximumCacheSize=100
    property-definition-app-service maximumDayCacheSize = 100
    cacheDayExpireAfterAccess = 1h
    maximumShiftCacheSize=1
    cacheShifExpireAfterAccess=10min
    maximumWeekCacheSize=100
    cacheWeekExpireAfterAccess=24h
    property-definition-service maximumDayCacheSize = 100
    cacheDayExpireAfterAccess = 1h
    maximumShiftCacheSize=1
    cacheShifExpireAfterAccess=10min
    maximumWeekCacheSize=100
    cacheWeekExpireAfterAccess=24h
    usersettings-service maximumDayCacheSize = 100
    cacheDayExpireAfterAccess = 24h
    activities-app-service maximumHourCacheSize=100
    cacheDayExpireAfterHourAccess=1h
    maximum5MinCacheSize=100
    cacheExpireAfter5MinAccess=5m
    maximumShiftCacheSize=100
    cacheExpireAfterShiftAccess=8h
    activities-service maximum5MinCacheSize=100
    cacheExpireAfter5MinAccess=5m
    maximumHourCacheSize=100
    cacheDayExpireAfterHourAccess=1h
    maximumDayCacheSize=100
    cacheExpireAfterDayAccess=24h
    esignature-app-service maximumShiftCacheSize=10
    cacheExpireAfterShiftAccess=8h
    my-machines-service maximumDayCacheSize = 100
    cacheExpireAfterAccess = 24h
  4. Save the changes to the application.properties file for the respective services that you have modified.
  5. Restart the respective services in Tomcat to apply the changes.

Results

The cached services are refreshed after the duration you set in the application.properties file.