Worldsoft Documentation Search

ESM – Automated Import and Build Process

1.2.0.1 September 19, 2019 WSS

Please review Process Scheduler

As part of the regular installation process, several process queues are set up to trigger tasks related to data, cube, and scorecard management in the Executive Support Manager modules. This documentation is meant to provide an overview of a typical process series and is not meant to replace your internal use documentation.

Stage 1 – Data Preparation

The data preparation stage is not required for every site. If a site uses text extracts as a data source, those extracts will need to be triggered and the file names need to be set according to site-specific standards. We recommend naming conventions include a year value (eg: 2017, 1718) portion that changes depending on the extract’s data period.

Stage 2 – Parameter Alteration

Process queues are typically controlled by system parameters (located under Data Management -> Code Table Maintenance -> Service Area, System User Config or Parameter -> Code Tables, System Parameters (user set)). Modify these parameters according to your site-specific instructions.

Typical parameters include:

cm_earned_hours Usually a divisor for FTE calculations (monthly)
current_fiscal_year Typically the year being imported/year being built.
current_fiscal_year_text Column/band header for current year
gl_period GL Period (month), usually used for cube build.
gl_period_text Description of GL period, column/band header.
gl_period_ytd_text YTD description, column/band header.
pay_period Pay period number, usually used for cube build.
pay_period_text Description of pay period, column/band header.
pay_period_ytd_text YTD pay description, column/band header.
pp01_earned_hours FTE divisor for pay period based payroll cubes.
pp27_earned_hours FTE divisor for pay period based payroll cubes.
previous_fiscal_year_text Column/band header for prior year.
short_fy Code typically used for file name differentiation.
ytd_earned_hours Usually a divisor for YTD FTE calculations.

Note, you can select any process queue from the Process Scheduler and find related parameter information in the upper right table.

Stage 3 – Data Download

The Process Scheduler (Administration -> Process Scheduler) is used multiple times in the import and build process. Configuration of these process queues various depending on site, so refer to your internal use documentation as for what to trigger.

Triggering a process queue is done by selecting the Batch Profile, moving to the B: Schedule tab, clicking the ‘+’ button to add a new line, and setting the Frequency for the line to ‘Once’. Save using the checkmark and head back to the A: Batch Profiles tab.

At this point, you can hit the ‘Refresh’ button to get a status update on the queue. You will see the following icons in the Status column:

Hourglass The process queue has been scheduled.
Running figure The process queue is being actively run.
Green thumbs up The process queue has completed successfully.
Red thumbs down The process queue has failed. Refer to other documentation to solve.

If the batches have not been combined, you will have to run separate jobs, waiting for success at each stage:

Import Loads data from source system.
Cube Build Creates cubes based on that data.
Scorecard Build Creates scorecards based on built cubes.
Linking For drill-through, associates data from different source systems.

Stage 4 – Data Validation

Data validation options depend on your site’s licensing.

Cube validation involves going into your Cube Viewer (ESM -> Cube Viewer), changing your Cube Display Groups to the group that your preparation cubes belong to (typically GL_PREP or PR_PREP), and comparing the resulting cube against your expected totals.

If the cube validation is incorrect, this may be caused by errors in your reporting trees. Go into Cube Management (ESM -> Cube Management), find the prep cube you were looking at, and then click on Options -> V: Validate Cube Trees. This will bring up a list of any potentially missing codes from your reporting trees. Correct the appropriate trees (Reporting -> Reporting Groups), and then rebuild your prep cubes, either through the appropriate process queue or through Cube Management -> Select the prep cube -> Options -> A: Build Cube or B: Build Cubes In Current Group.

If your trees are correct but you still have a data error, you may need to look at the underlying imported data. If your site is licensed for the Crosstabs module (Reporting -> User Cross Tabs), you will find views that access the loaded table data. If not, the Source Data viewer (Reporting -> View Source Data) will also provide the same low-level access. Validation through either of these allows for a look at the complete data table, and importantly should not involve the use of reporting trees (which will potentially restrict data).

Stage 5a – Scorecard Publication

Scorecards do not require any specific steps to publish, but they will need to be rebuilt if the indicator cubes were rebuilt as part of Stage 4.

Stage 5b – Cube Publication

Once you have verified the results of your prep cubes, it is time to publish them for your users. Your site may have specific instructions as to this process that contradict this document.

From Cube Management, go into E: Support Tables. Verify that your destination Build Group (upper grid) has already been created, and that there is a valid Display Group (bottom grid) available. Note, if you are trying to create a series of historical cubes each cube grouping will need its own unique Build Group, but multiple cubes can share the same Display Group without issue.

These steps assume you are publishing to an empty Build Group.

Return to the A: Cube Manager tab. Options -> C. Copy or Rollover Groups.

Under “Source Build Group”, select the prep group you are copying from.

Under “Target Build Group” and “Target Display Group”, set the appropriate groups.

Optionally, under “Append to Cube Code” and “Append to Cube Description”, enter any suffixes that are standard procedure for your site. It is typical to include month and/or pay period information under the description field.

Click “A: Copy Source to Target Group” to complete the process.

Stage 6 – User Security

If you have created a new display group as part of Stage 5b, you will need to provide end users access to that display group.

These steps assume all users are part of a profile and not individually configured. If individual configured, apply the same steps as you would to a profile.

In Cube Management, start by making note of the cube templates involved in your prep groups. This information is available in the Template column.

In User Maintenance (Administration -> User Maintenance), start by filtering the “Is Profile” column to check-marked data only. The resulting few records are the profiles configured for your organization. Assuming default profile configuration, the only profiles you will need to alter are _Finance and _Manager.

Select the profile you’ll be working with, and then head info the E: Cube Groups tab. Using the “+” on the bottom grid, add a new record. For each Cube Template you made a note of, fill in the Cube Display Group and the Cube Template columns and save the record. All changes made to the profiles will wrap through to assigned users.

Stage 7 – Notification

Notify end users that the cubes have been published and are ready for review.