Skip to main content

Create

Use ProcessEntries.create() to instantiate a new process entry. Must have a process_id and one of either component_instance_identifier, component_instance, or component_instance_id.
my_process_entry = serial.ProcessEntries.create(
    process_id="686ac22c-4ff3-4ced-911f-88c1997ee9f8", 
    component_instance_identifier="ABC-1234"
)

process_id
string
required
ID of the process being run. Use the process builder on the component page to get or create a process
station_id
string
ID of the station running the process. Use the station page to get or create a station
component_instance_identifier
string
The serial number or lot code of the component instance
component_instance
object
Component instance object returned by serial.ComponentInstances methods
component_instance_id
object
Component instance ID. Can by obtained by serial.ComponentInstances.data["ID"]

Add Data

Add Number

Add numerical data with units, usls and lsls to a process entry
my_process_entry.add_number(
    dataset_name="Power", 
    value="102"
)

dataset_name
string
required
The name of the data you are adding
value
number
required
The unique number data for the identifier
units
string
The units of the data you are adding
usl
string
The upper spec limit of the data you are adding
lsl
string
The lower spec limit of the data you are adding

Add Boolean

Add pass/fail boolean data to a process entry
my_process_entry.add_boolean(
    dataset_name="Functional Test Result", 
    value=True
)

dataset_name
string
required
The name of the data you are adding
value
boolean
required
The unique boolean data for the identifier
expected_value
boolean
The expected value

Add File

Add files to a process entry
my_process_entry.add_file(
    dataset_name="Test Logs", 
    path="/Users/me/Documents/02375017391243.csv"
)

dataset_name
string
required
The name of the data you are adding
path
string
required
file path to the file in local storage
file_name
boolean
Used to override the file_name of at the path. This file name will be preserved on download from Serial

Add Image

Add images to a process entry
my_process_entry.add_image(
    dataset_name="Functional Test Graph", 
    path="/Users/me/Documents/chart.jpg"
)

dataset_name
string
required
The name of the data you are adding
path
string
required
file path to the file in local storage
file_name
boolean
Used to override the file_name of at the path. This file name will be preserved on download from Serial
Add images to a process entry
my_process_entry.add_link(
    dataset_name="PCBA", 
    child_identifier="FBM0202312"
)

dataset_name
string
required
The name of the data you are adding
child_identifier
string
required
The identifier of the part being assembled into the parent identifier

Submit

Uploads all the data that has been added to the process entry. Optionally add a cycle time and/or override the pass fail result
my_process_entry.submit(
    cycle_time=42
)

cycle_time
number
Cycle time in seconds
is_pass
boolean
Override the overall process result to pass or fail and ignore all parametric data
I