Analytics Definitions - Data Dictionary
When creating your own charts, you’ll need to select which metrics you want to include.
When you click the Add + button next to a widget panel, a menu will expand offering you all available Shoplogix metrics:
This guide explains each metric and provides examples where applicable.
The term “Dim” is frequently used, and is a short-form for “Dimension”. This is simply a technical term to refer to a common category of metrics.
Category | Measure | Definition |
|---|---|---|
Dim Areas | Division | The area levels above the Plant. Multiple levels will show only the highest 3 levels. |
Division2 | The area levels above the Plant. Multiple levels will show only the highest 3 levels. | |
Division3 | The area levels above the Plant. Multiple levels will show only the highest 3 levels. | |
Line | The area level configured as Line. | |
Line Area | The area levels below the Line. Mutiple levels will show only the highest 3 levels. | |
Line Area2 | The area levels below the Line. Mutiple levels will show only the highest 3 levels. | |
Line Area3 | The area levels below the Line. Mutiple levels will show only the highest 3 levels. | |
Plant | The area level configured as Plant. | |
Plant Area | The area levels below the Plant. Mutiple levels will show only the highest 4 levels | |
Plant Area2 | The area levels below the Plant. Mutiple levels will show only the highest 4 levels | |
Plant Area3 | The area levels below the Plant. Mutiple levels will show only the highest 4 levels | |
Plant Area4 | The area levels below the Plant. Mutiple levels will show only the highest 4 levels | |
Dim Dates | Calendar DateTime | Preferred Date to use – this is the machine time. Multiple timezones.. ?? |
Dim Jobs | Job Blocked Cycle Factor | How many cavities are blocked per cycle. |
| Job Cycle Factor - Finished Goods |
|
| Job Cycle Factor - Inventory |
|
| Job Cycle Factor - Line |
|
| Job Cycle Factor - Scrap |
|
| Job Description |
|
| Job Due DateTime |
|
| Job End DateTime | This is the date when a Job ends running |
| Job Expected Electricity |
|
| Job Expected Employees |
|
| Job Expected Gas |
|
| Job Expected Production |
|
| Job Expected Runspeed |
|
| Job Expected Setup | The expected setup time for your jobs. The best way to use this field is either in a table or chart where you can separate it by Job Name. |
| Job Expected Water |
|
| Job Filter 01 - 20 | These are the same job filters that you configure when scheduling jobs |
| Job Instance | Often you will run the same Job Name multiple times. Each individual time you run a Job, Shoplogix creates a “Job Instance” record along with the job instance’s metrics. So for example, you can have a job called Job Name = “A”, and you can run Job “A” 5 times. You’ll still have a single Job Name in your analytics portal called “A”, but if you use the Job Instance field with it, you’ll be able to get the metrics and stats behind each individual time you ran Job “A”. Job Instance comes in the form of a a long, unique ID tag (example: efjk349dif9s0u30h208sfsdsf34sdf4”). Don’t worry, no one is expected to remember Job Instance IDs! The best way to understand Job Instances is by using them in conjunction with Job Name, Job Start Date, and Job End Date. This way you’ll have a better understanding of the parent job (Job Name) and you’ll be able to correlate the Job Instance with the date it ran. A great way to use Job Instance is when you’re trying to pinpoint if a job (via Job Name) always performs poorly, or if it only performed poorly during a specific Job Instance |
| Job Is Local |
|
| Job Max Run Rate |
|
| Job Name | Job Name is the human-readable name that you assign Jobs when scheduling. You’ll be very comfortable with this field as it is the same Job Name you see in Whiteboard. |
| Job Next Operation |
|
| Job Operation |
|
| Job Pull Group |
|
| Job Ship DateTime |
|
| Job Start DateTime | This is the time when each Job starts running |
| Job Status Blocked |
|
| Job Status Confirmed |
|
| Job Status Edited |
|
| Job Status Is Current |
|
| Job Status Pulled |
|
| Job Timestamp |
|
Dim Machines | Is Line | If the machine is a line or not. A Line is expressed as a machine that has this flag set to true. Since a line is expressed in the same production stats as a machine, we create an “Line Machine” with: Machine Name = Line Name Machine Id = Line_(bottleneck line machine Id) This “Line Machine” allows analytics as if the line was a single machine in native line units. |
| Machine Id | system field. |
| Machine Name | Machine Name as configured |
Dim Machine Security | Customer_Account | system field. |
| Security Machine Key | system field. |
Dim Reasons | Reason Classification | Reason’s Classification as configured in the Machine’s variables tab. |
| Reason Group1-4 | Reason Group as configured in a Machine’s variables tab. |
| Reason Name | Reason Name |
| Reason Type | Reason’s |
Dim ReasonState | ReasonState Classification | ReasonState is a combination of Reason and State – all properties of Dim ReasonState are the Reason’s properties when a reason is present. When no reason is present, the State properties are used. |
| ReasonState Group 1-4 | “ |
| ReasonState Name | “ |
| ReasonState Type | “ |
Dim Recent Shifts | Shift Recency | Shift Recency is one of 3 values:
This is a way to include the last 24 hours of completed shifts. Uses [Shift Instances].[Is Last Completed] to determine if a shift is within the last 24 hours. |
Dim Scrap Reasons | Scrap Group | Scrap Reason group as configured. |
| Scrap Reason | Scrap Reason as configured in the Machine’s variables tab. |
Dim Shift Instances | Shift Instance | A unique identifier to distinguish this shift from others with its name and start date. |
| Shift Name | As configured in the shift calendar |
| Shift Start DateTime | When the Shift Started. |
| Shift Is Current | If the shift is the current active shift at the time of cube refreshing. |
| Shift is Last Completed | True for the most recent shift that is complete per machine. False for all other shifts. |
Dim States | State Classification | Performance, Capacity, or Availability. |
| State Name | State Name as configured. |
| State Group1 | @Joseph Kingry (Unlicensed) where are these actually configured? |
| State Group2 |
|
| State Group3 |
|
| State Group4 |
|
Fact Core | Blocked | Parts blocked by blocked cavities. |
| Cycles | Cycles |
| Duration for MTTR | Mean Time to Recovery is calculated by summing the time in non-failure states – this is that duration. This / Stops = MTTR |
| Duration for MTBF | Mean Time Between Failure is calculated by summing the time in failure states – this is that duration. This / Stops = MTBF |
| Expected Cycles | Expected Cycles |
| Expected Production | Job Rate, or if there is no Job Rate, then the Machine Rate. |
| Good Production | Total Production - Scrap |
| OeeProductive | Used to calculate OEE. Good / Rate |
| OeeRuntime | Used to calculate OEE. Total / Rate |
| OeeScrapByRate | Used to calculate OEE. Scrap / Rate |
| Reason Occurrences | Number of times the Reason was entered, for any duration. |
| ReasonState | see Dim ReasonState. |
| Scheduled Hours | Hours during scheduled shifts. Excludes capacity reasons and capacity states. |
| Scrap | Scrap in scheduled time. |
| Scrap Including Unscheduled | Scrap, All. |
| State Occurrences | Number of times the State was entered, for any duration. |
| Total Hours | Clock Time. |
| Total Production | Parts produced in scheduled time. |
| Total Production Including Unscheduled | Parts produced including parts from unscheduled time. |
| Uptime Hours | Hours where the StateType is:
|
Fact Scrap Reasons | Scrap Reason Amount | IMPORTANT: Scrap Reason Amount is the amount for just the associated scrap reason (from Dim Scrap Reason). If you are working with Scrap but not interested in reasons, then use [Fact Core].[Scrap]. If you are interested in reasons, once you add this field, the inner join will eliminate all Fact Core rows so you will want to create side by side to best analyze Scrap Reasons alongside Fact Core fields. |