Search Results read_locus

Overview

APPS.CSF_LOCUS_PUB is a public PL/SQL API package in Oracle E-Business Suite that manages "locus" data for the Event and Transportation Management (ETRM) module, particularly the Logistics Foundation (LF) and Transportation/Telecommunications spatial feature set. A locus represents a point location along a linear referenced feature — typically a road segment or route — expressed as a segment identifier plus a measure (offset) and direction. The package bridges Oracle Spatial geometry structures (MDSYS.SDO_GEOMETRY) with the application's business representation of location, allowing callers to read, write, verify, and query locus information consistently. The header signature (CSFPLCSB.pls, version 120.12.12010000.2) confirms the package has been maintained through the 12.x code line, with enhancements to accuracy handling noted in the source comments. In ETRM 12.2.2 the package is classified as a PUB (public) API, meaning it is intended for supported external invocation, and it is referenced by eight other packages.

Key Procedures and Functions

The documented API exposes twenty-four entry points. Core geometry translation is handled by READ_LOCUS, which accepts a locus geometry and returns the canonical point geometry together with the segment id, offset, and direction; and WRITE_LOCUS, which performs the inverse, assembling a locus from a point geometry plus segment, offset, and direction values. VERIFY_LOCUS validates a locus against business rules. The "getter" family — GET_LOCUS_SEGMENTID, GET_LOCUS_SPOT, GET_LOCUS_SIDE, GET_LOCUS_LAT, GET_LOCUS_LON, GET_LOCUS_SRID, and GET_LOCUS_STRING — extracts individual attributes (segment id, spot indicator, side of road, latitude, longitude, spatial reference id, formatted string) from a locus. GET_SEGMENT_ID and GET_GEOMETRY provide alternative retrieval paths for the segment identity and the underlying SDO_GEOMETRY. GET_SERV_AREA_COORDINATES and GET_GEOMETRY_TBL return collections or service-area geometry sets. COMPUTE_AND_SAVE_ROUTE and COMPUTE_AND_SAVE_LOCUSES are higher-level routines that calculate route geometry or loci and persist the results. SHOULD_CALL_LF and IS_MANUAL_GEOMETRY are decision helpers indicating whether the Logistics Foundation processor must be invoked and whether a geometry was entered manually rather than derived.

Tables Accessed

The package operates against several application tables through APPS synonyms. CSF_LF_ROADSEGMENTS holds the linear road segment definitions that loci reference and is central to segment id resolution. CSF_SPATIAL_CTRY_MAPPINGS provides the country-to-spatial-reference mapping used when determining SRID and coordinate systems. CSF_TDS_ROUTE_CACHE and CSF_TDS_ROUTE_CACHE_S1 store computed route geometry results, supporting COMPUTE_AND_SAVE_ROUTE and COMPUTE_AND_SAVE_LOCUSES. HZ_LOCATIONS supplies location geometry data. Oracle-supplied objects include SDO_CS and MDSYS geometry types for coordinate transformation, DBMS_LOB for large geometry handling, DUAL for scalar queries, and PLITBLM as a PL/SQL table utility.

Usage Notes

CSF_LOCUS_PUB is typically invoked from ETRM forms and concurrent programs that capture or display transportation locations, and from custom extensions that need to persist or interpret a locus. Because it is a PUB API, Oracle supports direct calls in accordance with standard API usage conventions, including passing a valid API version and handling the returned status and message parameters. Its significant inbound dependency (eight referencing packages) indicates it acts as a shared service layer. Developers searching for "get_locus_segmentid" will find GET_LOCUS_SEGMENTID is the supported accessor for retrieving the segment identity from an existing locus geometry.