D ATA S OURCES - C USTOMER

Data Sources – Customer

A data source is a set of SQL stored procedures used to define the way data is retrieved
or inserted in and out of the system and are leveraged extensively by VisionPlex screens
& Web Services.

The Data Sources - Customer screen allows customers to search and view all available
Data Sources for the modules that are currently active in their PCN. This is useful when
integrating Plex with any homegrown or 3rd party software where it’s necessary to
match equivalent fields between systems.

Naming Convention
Data sources are named according to their functionality and are either a “Get” data
source; which is simply used to retrieve data out of Plex or an “Add” and
“Add/Update”. These are meant to Add and Update records in Plex.

Data Sources – Customer Header Fields

Use This To Do

Data Source Name Use keywords & wildcards to return applicable results.

Example 1: Looking for a data source to return specific container

information, searching something like “container%get” can return
several different options.

i|Page
 Example 2: Looking for a data source to add / update process
routings, searching “operation%add” will return several results.

Module Module which data source belongs to.

Key Each data source is designated a unique key. Listed on grid or

data source detail.

Category This can be used to filter on the specific “Type” of data source such
as “Get” or “Add/Update”.

Column Name Allows specific inputs & outputs to be searched

Example: Master_Unit_No will return all data sources which have

the specified field registered with the data source.

Data Source Detail

Once a possible data source candidate is found, clicking into the name will bring you to
the Data Source Form (link to Data Source Form below)

Clicking on the Key, will send you to the XML Schema (link to XML Schema)

ii | P a g e
 Data Source Form

Use This To Do

Data Source Name Formal name of the specific data source

Datasource Type Type of data source. *Not useful from a customer

perspective

Database Name Database the data source belongs to. Helpful if

customer is looking to write queries or get additional
information about data source.

Procedure Name Formal name of procedure. May or may not be same as

data source name

Module Module data source belongs to

Champion Specifies Plex Module champion

Customization Class *Not used

iii | P a g e
 Note Note field containing specific notes applicable to data
source. May have helpful formatting tips if data source is
complex

DataSource Category Keys Specifies what categories this data source performs.

Example: This data source performs Add / Update

functions

SQL Button (top left) This allows the customer to review the SQL behind the
scenes.

Parameters
Here is where all of the inputs / outputs are listed for the specific data source

Use This To Do

Parameter Name Specific name of input / output

Data Type Data type of input / output

Length Character length of input / output

Scale N/A

Default Value N/A

Output Parameter Indicates that this will be returned in the web

service response

Required Indicates that this parameter is a required

input.

Note Provides insight as to what exactly this

parameter does or what the format should
be

iv | P a g e
 XML Schema
This XML Schema is very helpful for developers as it provides a good starting point.

***Best practice is to only send the parameters that will be used, not all inputs when only
a select few have values associated.

v|Page
 Top 30 Data Sources
Data Source Name Description
Adds new workcenter log records including status and reason.
Workcenter_Status_Update_By_PLC_Name Used frequently with Plant floor integration
Returns list of active parts with ecommerce attribute set. Used
Ecommerce_Parts_Get
in ecommerce integration
Returns a list of attributes and their values for one or more
parts. Each attribute that returns must have Web_Available
Ecommerce_Part_Attributes_Get
flag as true.
For the ecommerce part/revision provided, find all active
orders with active lines with a balance and return the total
Ecommerce_Part_On_Order_Quantity_Get quantity.
Ecommerce_Order_Line_Update Allow existing order lines to be updated. 2-Tier Order entry

Returns specific container information based on passed in

Container_Get
Serial Number
AR_Customer_Invoices_Get Returns AR Customer Invoices based on passed in parameters
Container_Job_BOMs_By_Operation_Get Returns Job BOM based on Serial No and Operation/PLC Name

Allows a single Part record to be Added and/or Updated. If the

Part_And_Attributes_Add_Update
part & revision exists, The part will be updated.
Used to load source containers to the specified location. For
the serial to be loaded it must already be in the location where
Container_Load_To_Workcenter you're attempting to record production in.
Returns workcenter information based on passed in Start and
Workcenter_Summary_Get
End dates. Includes Downtime & Production hours
AR_Invoice_Dist_Add_Simple Used to add a line to an AR Invoice.
Used to return container releases based on passed in Serial
Container_Releases_Get
Number
Employee_Simple_Add_Update Allows employees to be added or updated to a specific PCN.

Web Service Get Container Returns list of active containers based on passed in inputs
Container_Move_Simple Allows specific containers to be moved to a new location

Returns specific container information based on passed in

Containers_Get2_RE
Serial Number
Returns the ZPL or IPL label code for a provided Serials No
Web Service Get Container Label
using normal label logic.
Allows clock in/out punches to be sent to the Time &
Bio_Clock_In_Out
Attendance system
Returns what Control Panel setup is currently at the
Workcenter_Setup_Get Workcenter
Control_Panel_Job_Get_2 Returns Control Panel data for job setups based on Workcenter

vi | P a g e
 Control_Panel_Get_2 Returns Control Panel data for non Job setups.

Control_Panel_Expected_Production_Get Returns production related data based on Workcenter

The main data source used to Record Production via Web

Services. Supports Simplified, Standard, and Dynamic Multi-out
Web_Service_Record_Production
production. Including Scrap & Scrap from Source Production
Provides PO No, Customer Part, Revision & Quantity for a
Shipped_Container_PO_Line_Get shipped Serial No
Allows the addition of Approved Workcenters to Part
Approved_Workcenter_Add_Update
Operations
Workcenter_Load_Output Loads the necessary Job or Part setup to the control panel.

Tests Web Service connection. Waits time specified in @Delay

Wait_For_Delay_Test
parameter before responding.
Retrieves customer part pricing by customer. Also, looks up
catalog pricing as well if no customer part pricing exists for a
Web_Service_Price_Lookup_by_Customer_Get
customer part for the customer.
Part_Quantity_By_Location_Get Returns the summed quantity of the containers for a given part
number & revision, operation code, and location.

vii | P a g e