MES Stateless API

GetDataLogDataForAStep(String,String,String,Int32,Int32,String,String,String,String,String,Nullable<Int32>) Method

Save PDF

GetDataLogDataForAStep(String,String,String,Int32,Int32,String,String,String,String,String,Nullable<Int32>) Method

Save PDF

Last UpdatedNov 06, 2025
6 minute read

The GetDataLogDataForAStep() method retrieves data log records that identify whether data collection and certification is pending for the specified job step.

In this overload of the method, the data log group is identified by its description and the optional entity filter is identified by its name and site name.

Syntax

'Declaration
 
Public Overloads Shared Function GetDataLogDataForAStep( _
   ByVal grpDesc As String, _
   ByVal woId As String, _
   ByVal operId As String, _
   ByVal seqNo As Integer, _
   ByVal stepNo As Integer, _
   ByVal itemId As String, _
   ByVal lotNo As String, _
   ByVal subLotNo As String, _
   ByVal entName As String, _
   ByVal siteName As String, _
   ByVal rowId As Nullable(Of Integer) _
) As DataSet

'Usage
 
Dim grpDesc As String
Dim woId As String
Dim operId As String
Dim seqNo As Integer
Dim stepNo As Integer
Dim itemId As String
Dim lotNo As String
Dim subLotNo As String
Dim entName As String
Dim siteName As String
Dim rowId As Nullable(Of Integer)
Dim value As DataSet
 
value = DataLogGrp.GetDataLogDataForAStep(grpDesc, woId, operId, seqNo, stepNo, itemId, lotNo, subLotNo, entName, siteName, rowId)

public static DataSet GetDataLogDataForAStep( 
   string grpDesc,
   string woId,
   string operId,
   int seqNo,
   int stepNo,
   string itemId,
   string lotNo,
   string subLotNo,
   string entName,
   string siteName,
   Nullable<int> rowId
)

Parameters

grpDesc: Required. Holds the description of the data log group.
woId: Required. Holds the work order ID of the job.
operId: Required. Holds the operation ID of the job.
seqNo: Required. Holds the sequence number of the job.
stepNo: Required. Holds the job step number.
itemId: Optional filter parameter. Holds the ID of an item associated to the job.
lotNo: Optional filter parameter. Holds the number of the lot associated to a job step.
subLotNo: Optional filter parameter. Holds the number of the sublot associated to a job step.
entName: Optional filter parameter. Holds the name of an entity.
siteName: Optional filter parameter. Holds the site name of an entity.
rowId: Optional filter parameter. Holds the ID of a row in the Data_Log table.

Return Value

Returns a DataSet that contains all the records in the Data_Log table for the specified job step and that satisfy the specified filters. If no matching records are found, an empty DataSet is returned.

The columns of the returned DataSet are described below.

Column Name	Description
grp_id	An integer that is the unique ID of the data log group.
grp_desc	A string that is the description of the data log group, from the data_log_grp.grp_desc column linked to this grp_id for this row.
sample_time_utc	A datetime that is the date and time when the sample was collected, in UTC.
sample_time_local	A datetime that is the date and time when the sample was collected, in the entity's local time.
sample_time	A datetime that is the date and time when the sample was collected, in the local time of the client application that is calling the method.
wo_id	A string that is the ID of the work order for which this sample was collected.
wo_desc	A string that is the description of the work order, from the wo.wo_desc column linked to this job for this Data_Log table row.
oper_id	A string that is the ID of the operation of the job for which this sample was collected.
seq_no	An integer that is the operation sequence number for which this sample was collected.
job_desc	A string that is the description of the job, from the job.job_desc column linked to this job for this Data_Log table row.
step_no	An integer that is the step number for which this sample was collected.
step_desc	A string that is the description of the step, from the job_step.step_desc column linked to this step_no for this Data_Log table row.
item_id	A string that is the item for which this sample was collected.
item_desc	A string that is the description of the item, from the item.item_desc column linked to this Data_Log table row.
lot_no	A string that is the number of the lot for which this sample was collected.
sublot_no	A string that is the number of the sublot for which this sample was collected.
shift_start_utc	A datetime that is the shift start time when the sample was collected, in UTC.
shift_start_local	A datetime that is the shift start time when this sample was collected, in the entity's local time.
shift_start	A datetime that is the shift start time time when this sample was collected, in the local time of the client application that is calling the method.
shift_id	An integer that is the ID of the shift for which this sample was collected.
shift_desc	A string that is the description of the shift, from the shift.shift_desc column linked to this Data_Log table row.
ent_id	An integer that is the ID of the entity for which this sample was collected.
collect_data	A Boolean that is a flag that indicates whether data collection is pending for this Data_Log row. If true, data is not collected for all the value indexes for this Data_Log table row.
certify	A Boolean that is a flag that indicates whether the collected data has a pending certification. If true, the collected data is not certified.
cert_name	A string that is the certification name, from the data_log_grp_job_link.cert_name column for this job associated to this Data_Log table row.
signoff_notes	A string that is the certification sign-off notes, from the cert_type.signoff_notes column linked to the data_log_grp_job_link.cert_name column that is linked to this Data_Log table row.
comments_reqd	A Boolean that is a flag that indicates whether comments are required, from the cert_type.comments_reqd column linked to this certification in data_log_grp_job_link associated to this Data_Log table row.
genealogy_id	A string that is the PEM intra-segment genealogy ID.
segment_requirement_id	A string that is the S95 segment requirement ID.
segment_response_id	A string that is the S95 segment response ID.
value1 to value64	Strings that are the values for the value1 to value64 columns.
last_edit_comment	A string that contains comments about why the record was changed.
last_edit_by	A string that is the ID of the user who added or last updated this record.
last_edit_at	A datetime that indicates when the record was added or last updated.
row_id	An integer that is the row ID of the record from the Data_Log table.
created_at_utc	A datetime that indicates when the data log record was created, in UTC.
created_at_local	A datetime that indicates when the data log record was created, in the entity's local time.
created_at	A datetime that indicates when the data log record was created, in the local time of the client application that is making the call.

Remarks

For input parameters that are not to be included as a filter, pass a null.

This method first retrieves the entity that is running the supplied job. If such an entity is identified, then this method queries the Data_Entry_Sched table against following the criteria to flag whether this data log group associated to this work order should collect data.

the value for the key_id column in the Data_Entry_Sched table is linked to the row_id column in the Job_Step table
job steps are filtered by the supplied woId, operId, seqNo, and stepNo
the supplied job steps linked to a job must be currently running (job.state_cd = 3)
the current row from the data_entry_sched.key_type should be collecting data for a job step (=7) and the category for the data collection should be ‘Datalog Group’ (data_entry_sched.category)
the current row from the data_entry_sched.value_name is filtered by the supplied group name

If a row is identified after applying all the filters specified above, then the middleware determines whether this group should collect data. Note that this only makes the data log group and its associated job step eligible to collect data. It does not mean that the data collection is currently pending. If no rows are identified from the criteria above, then data does not need to be collected for this group or a job step that is linked to it.

If this group is eligible to collect data, then the middleware scans each row from the Data_Log table that is linked to the supplied job (data_log_grp_job_step_link) to determine the pending data collection. If any entry in the valuen column in the Data_Log table is null and it is configured to have a value in the Data_Log_Value table (value_index) for this group, then the data collection is considered pending for this data log row. Additionally, the data log groups that are retrieved are the ones that are linked to the supplied job step in the Data_Log_Grp_Job_Step_Link table.

While determining whether a particular data log group has audit pending, the middleware scans each Data_Log row that is linked to a job step (data_log_grp_job_step_link). The row_id from the Data_Log table and the certification linked to these rows, along with the supplied job, must match those of the number of certifications in the Cert_Audit_Log table. If no such matching records exist in the Cert_Audit_Log table, then this Data_Log row is considered to have a pending audit, which needs to be certified.

The performance of this method varies, depending on the size of the Data_Log table and the values of the supplied filters.

MES Stateless API