Table of Contents

Workflow: Ordering a Project Build to Avoid Rework

This page is the order in which a project's pieces go in — machine, workpiece, controller, tools, program zero, mission — by hand or over the HTTP API, with each step's route where it has one. It is section 2 of Project Construction, which holds the rest of the method: one self-contained project folder, the routes the run reads, the controller's own tables and the replay that says a project is finished. The sign-in, the reply envelope and the key-based editing these routes rely on are Driving the Web Service over HTTP.

The order

Later steps read earlier ones, so this order costs the least:

  1. New project at its final path. It is not empty — see What a new project starts with.

  2. Machine tool, then spindle capability.

  3. Workpiece: stock geometry, ideal (target) geometry, resolution, the transformers of the workpiece branches to its Program-Zero Anchor and its Fixture Mount, then material and cutting parameters. A material is used as its file writes it: one whose HeatConductivity_WdmK (W/(m·K)), Density_gdcm3 (g/cm³) or HeatCapacity_JdgK (J/(g·K)) is not a finite positive number, or lies outside the range of a solid — a density typed in kg/m³, say — comes back in the load's messages and is named again when a session or a play begins (Material-ThermalConstants--NotFinitePositive, Material-ThermalConstants--OutOfRange). One whose file lacks the element is not given, and no default stands in: the thermal model is skipped for every tool, with the temperatures left at ambient and the wear at zero, and the material is named at the same places (Material-ThermalConstants--NotGiven). When the part arrives as a mesh exported from CAM rather than as labelled stock and design CAD, first decide what the mesh is and where program zero sits in it — Building the Workpiece from a Reference Mesh, which also gives the API calls for an STL slot.

  4. Controller: brand first — switching brand later resets brand-specific tables — then the controller's own tables (Project Construction §4).

  5. Tool house, per tool, in this order — each step reads the one before:

    1. Create, then number. A new tool takes one past the largest number in the house; rename it to the T number the program calls (POST /api/ToolHouse/CreateTool, then POST /api/ToolHouse/RenameTool?toolId=…&newId=…). The number is also the offset row the H and D words read once the offset table is refreshed.
    2. Shaper profile (PUT /api/Cutter/{id}/shaper-profile), e.g. {"AptType": "BallApt", "Diameter_mm": 4, "FluteHeight_mm": 5}; AptType is one of ColumnApt, ConeApt, BallApt, TaperApt and GeneralApt, case-insensitive and with or without the Apt. A ball profile takes only the diameter and the length of cut. The cutter routes create the tool's milling cutter on first use, so no separate call is needed for it.
    3. Fluting (PUT /api/Cutter/{id}/fluting), after the profile: the side edges read the cutter's profile as it stands, so a profile changed later carries into them without a re-send. It is replaced whole: "Type": "uniform" is required — anything else is refused with 400 — and every other field left out takes the route's own default — 2 flutes, helix 30°, radial rake 0°, radial relief 5°, flute offset angle 0°. A rake of 0° is not neutral, since the rake orients the force each edge point produces; choose one from the work material when the tool sheet gives none (Cutter Geometry). Send every value, including a flute offset angle entered earlier, and the side contour itself ("SideContour": {"Type": "consthelix", …}): a fluting without one, or with a type the route does not recognise, is accepted and leaves the flutes with no side edge.
    4. General properties (PUT /api/Cutter/{id}/general): the cutter's own relief angle, ReliefAngle_deg, and its hone radius, HoneRadius_um — 5° and 30 µm on a new cutter. This relief angle is a second value beside the fluting's radial relief, and the only one the simulation reads: the flank wear, the tool temperatures, each step's relief-face check and the NC optimization's relief-angle limit take it; a fluting alone leaves it at 5°. Send the tool sheet's relief here (Cutter Geometry). A field left out keeps its value, and a fluting or profile re-send keeps both. The route answers with an empty body; GET /api/ToolHouse/{id} reads the two back under cutter.general.
    5. Exposed cutter height — the stick-out (PUT /api/ToolHouse/{id}/exposed-height). A new tool starts at 0, with the cutter hidden inside the holder.
    6. Setup angle — how far the cutter is turned in the holder (PUT /api/ToolHouse/{id}/setup-angle, the body a bare number of degrees). It defaults to 0 and only the milling physics reads it; enter it when the flutes' angular position matters, as it does for a smart holder reporting in the sensor's own frame (Smart Tool Holder). It is a property of the clamping, so it survives a fluting re-send.
    7. Holder. List the library first (GET /api/file-explorer/list?rootName=ResourceDir&relativePath=Holder): a .Holder file there carries a finished profile. No route loads one into a tool, so read it with GET /api/file-explorer/read-text and send its Z–R pairs whole as below. Set its type (POST /api/ToolHouse/SetHolderType), read its profile key (POST /api/CylindroidHolder/Get with a session key answers it in cylindroidKey, as <sessionKey>-HolderCylindroid), replace the whole profile with POST /api/Cylindroid/UpdateAllPairs — a new cylindroid holder's profile is a Ø6 placeholder from Z 40 to Z 80 that adds no length until the holder re-derives it — then POST /api/CylindroidHolder/UpdateGeometryContent so the holder re-derives its length. The profile's frame is in Cutter Geometry.
    8. Upper beam. Create it through the cutter (POST /api/Cutter/{id}/upper-beam/create?kind=Cylindroid&key=… — the new cylindroid is stored under the key you pass), write the pairs with POST /api/Cylindroid/UpdateAllPairs on that key — measured from the cutter tip, the first at the flute top and the last at the overall length (Cutter Geometry) — then POST /api/Cutter/{id}/upper-beam/resync and read the warnings it returns; an empty list is the pass.
    9. Cutter material, and coating layers if the tool has any. A tool without a flute material runs no thermal physics and reports no stress ratio (Tool-FluteMaterial--Missing). Flute, shank and coating materials are checked as the workpiece's is: the load's messages and the tool change name a thermal constant that is not a finite positive number or lies outside the range of a solid, and one whose element the file lacks: not given, with no default standing in, it leaves the tool without a thermal step, as a missing flute material does (Material-ThermalConstants--NotGiven); a cutter material whose file lacks its hardness or wear-coefficient curve (TemperatureVsHardnessCurve, TemperatureVsWearCoefficientCurve) is named the same way where its curves are read — as the flute material or a coating layer's, never as the shank's (Material-WearCurves--NotGiven): the native thermal model does not run for the tool.
    10. Smart-holder observation point, when the tool carries a sensor. A new tool points at the holder nose with a height of 0; see Smart Tool Holder.

    Then refresh the offset tables from the tool house, and check each tool-length row against the holder's gauge length plus the stick-out. GET /api/ToolHouse/{id} returns the stored fluting, profile and clamping values — setupAngle_deg among them — for a last read-back.

  6. Program zero: with the workpiece placed and the chain loaded, align the two in the direction the job calls for — Program Zero Alignment. When the customer supplied recorded offsets, keep them and move the part onto them (Project Construction §4); derive a row from the model only when planning a job that has no recorded offset. When several parts share the table, only the row of the part carrying the program-zero anchor can come from the model: the rows of the others are that row plus the part spacing.

  7. Mission — Shaping the Mission around the Process.

  8. Save, then load the saved file back and re-check. A project that cannot be reloaded cleanly is not built.

Check the axis set after loading a machine

Important

Verify the axis set after loading a machine tool. Each axis is a role of the machine tool (AxisX … AxisC) bound to one of its branches; a chain file binds them by branch name (X/Y/Z/A/B/C), so a branch left at its authoring default name binds no axis, and that axis silently does not exist. The controller's axis list cannot show this for a linear axis — every brand preset already declares X, Y and Z, and a chain only adds axes — so read the roles: GET /api/mech/equipment-topology/roles/machine-tool lists each axis with the branch it is bound to and its checks (an unbound axis is simply unbound; AxisTransformerMismatch names a branch of the wrong kind). Every axis needs a branch carrying a DynamicTranslation (X, Y, Z) or a DynamicRotation (A, B, C); the chain itself is POST /api/mech/machine-tool/xml. The spindle (Spindle) is not an axis and is found by topology, not by name: the branch arriving where the tool mount hangs from, when it carries a DynamicRotation about the tool mount's −Z through its origin. A machine without one plays as before, its spindle simply not turned on screen; a rotation off the tool axis is flagged SpindleOffToolAxis.

See Also