Hydra MIP

The Hydra MIP connector communicates with the MPDV Hydra Manufacturing Integration Platform (MIP). It abstracts the underlying API into a unified layer, supporting both legacy Hydra 8 dialog transactions and modern MIP 2.0 Shop Floor Connectivity Services (SCS). The connector automatically detects the backend version at runtime and routes requests dynamically.

This connector requires instance creation before you can manage sessions or execute transactions against a specific MIP server.

Connection and lifecycle

create (instance)

Creates a client instance configured to communicate with a specific MIP server.

Parameters

Input	Key	Description	Type
options	url	The endpoint URL of the target MIP server.	string
	username	The username used for authentication.	string
	password	The password used for authentication.	string
	accessId	An 8-digit ID identifying the client application, left-padded with zeros if necessary.	string
	rejectUnauthorized	Set to false to temporarily disable rejection of untrusted server certificates. Default true.	boolean
caPath		An optional absolute path to a root CA .pem file for internal TLS.	string

Right-click the options input and mark it as a secret to mask the password.

Example

# options
url: https://my-mip-server.com:8080
username: myuser
password: mysecretpassword
accessId: '00123456'

Output

Returns the name of the created instance.

canCommunicate

Checks whether communication with the MIP server is operational and authenticated.

Parameters

None.

Output

Returns true if communication succeeds, or false if it fails.

getMipVersion

Retrieves the runtime strategy description of the connected backend.

Parameters

None.

Output

Returns 'Hydra X / MIP 2.0 (SCS)' or 'Hydra 8 / MIP 1.x (Legacy)'.

isMip2

Determines if the current backend supports modern MIP 2.0 architectures.

Parameters

None.

Output

Returns true if the backend supports MIP 2.0, or false if it does not.

logout

Terminates the open session on the MIP server and clears active cookies. Without an explicit logout, open sessions terminate automatically after 30 minutes.

Parameters

None.

Output

Returns true upon successful session termination, or false if it fails.

delete (instance)

Removes the MIP client instance and its connection configuration. Not to be confused with delete (record), which removes a service record on the MIP server.

Irreversible action

Deleting an instance removes its configuration. To communicate with the server again, you must trigger create anew.

Parameters

None.

Output

Returns true upon removal.

Low-level service CRUD

getAllServices

Lists all data-layer services registered on the connected server.

Parameters

None.

Output

Returns an array of service name strings.

create (record)

Creates a new instance record for a given service type. Not to be confused with create (instance), which creates the connector instance.

Parameters

Input	Description	Type
serviceName	The service name (such as MDUnits, BOOperation, or BOPerson).	string
data	The data payload for the creation transaction. Use getCreateParameters to look up mandatory attributes.	object

Example

# serviceName
MDUnits
# data
unitsUnit: T
unitsClassification: Test
unitsDesignation: A fake test unit

Output

Returns true on success. Throws an error if the transaction fails.

read

Queries records from a given service with options for filtering and field selection.

Parameters

Input	Key	Description	Type
serviceName		The service name.	string
options	filter	Filters records based on specific criteria. Accepts a simple array like ['field', '=', 'val'], an object like { field: 'val' }, or nested arrays. MIP does not support OR logic.	any
	fields	Restricts the evaluation to specific columns.	array
	skipNull	When true, omits null attributes from the return value. Default false.	boolean

Example

# serviceName
MDUnits
# options
filter: [unitsDigits, '>', 1]
fields: [unitsUnit, unitsDesignation]
skipNull: true

Output

Returns an array of parsed data objects matching the query.

update

Modifies an existing service instance record.

Parameters

Input	Description	Type
serviceName	The service name.	string
data	The data update block. This block must include the mandatory primary keys required to identify the row.	object

Example

# serviceName
MDUnits
# data
unitsUnit: C
unitsClassification: Temp
unitsDesignation: Degree Celsius

Output

Returns true on a successful update. Throws an error if the operation fails.

delete (record)

Removes an existing service instance record.

Irreversible action

This permanently deletes the service instance record from the server. You cannot undo this action.

Parameters

Input	Description	Type
serviceName	The service name.	string
data	Mandatory identification payload required to resolve the specific instance.	object

Example

# serviceName
MDUnits
# data
unitsUnit: T
unitsClassification: Test

Output

Returns true on a successful deletion. Throws an error if the operation fails.

execute

Invokes a specific processing action on a target service.

Parameters

Input	Description	Type
serviceName	The service name.	string
data	The parameters required for execution. Keys must match the service definition.	object

Output

Returns true on a successful execution. Throws an error if the action fails.

Metadata inspection

getCreateParameters

Queries the parameters needed to create records for a specified service.

Parameters

Input	Description	Type
serviceName	The service name.	string

Output

Returns an object mapping camelCase attributes to their lowercase data types. Mandatory parameters include a * suffix.

getReadParameters

Queries the schema parameters available for retrieval from a service.

Parameters

Input	Description	Type
serviceName	The service name.	string

Output

Returns an object mapping readable camelCase fields to their lowercase data types.

getUpdateParameters

Queries the schema guidelines for updating records inside a service.

Parameters

Input	Description	Type
serviceName	The service name.	string

Output

Returns an object mapping updatable attributes to data types, with mandatory lookup attributes marked with a * suffix.

getExecuteParameters

Queries the validation constraints needed for executing functions on a service.

Parameters

Input	Description	Type
serviceName	The service name.	string

Output

Returns an object mapping functional input tags to data types.

getDeleteParameters

Queries the minimal mandatory parameter requirements to delete a service instance.

Parameters

Input	Description	Type
serviceName	The service name.	string

Output

Returns an object highlighting mandatory row identification fields.

getReadableFields

Lists all column elements explicitly exposed as selectable output fields.

Parameters

Input	Description	Type
serviceName	The service name.	string

Output

Returns an array of objects mapping selectable keys to their lowercase types.

Order management (MIP-WO)

getOrders

Fetches production orders and enriches them with active operations, BOM components, and allocated tools.

Parameters

Input	Key	Description	Type
options	filter	Filters the orders to retrieve. Evaluates an array or object expression.	any
	fields	Appends custom attributes to the default return payload.	array
	includeOperations	Includes corresponding operations. Default true.	boolean
	includeComponents	Includes related component requirements. Default true.	boolean
	includeProductionResources	Includes related tool records. Default true.	boolean

Example

# options
filter: { orderId: JR150702 }
includeOperations: false
fields: [ordertypeActive]

Output

Returns an array of complex order structures.

getOrder

Fetches details for an isolated order instance.

Parameters

Input	Key	Description	Type
orderId		The unique order ID string.	string
options	fields	Specifies explicit fields to fetch. If empty, all available fields return.	array

Example

# orderId
'4711'
# options
fields: [orderId, orderDesignation, orderPlanStartTimestamp]

Output

Returns an order object, or null if the order is not found.

startOperation

Registers an operation log-on transaction (Arbeitsgang anmelden).

Parameters

Input	Key	Description	Type
options	orderId	The order identifier. Legacy acronym fallback: anr.	string
	operationId	The operation identifier. Legacy acronym fallback: avnr.	string
	workplaceId	The workplace or machine identifier. Legacy acronym fallback: mnr.	string
	personId	The person identifier. Legacy acronym fallback: pnr or usr.	string
	cardId	The card identifier. Legacy acronym fallback: knr.	string
	batchId	The batch identifier. Legacy acronym fallback: cnr.	string
	mst	The target machine status code (Legacy specific).	integer

Example

# options
orderId: '0004990701'
operationId: '10'
workplaceId: '4560'
personId: '2998'

Output

Returns true on successful registration. Throws an error if the transaction fails.

finishOperation

Finishes an operation (Arbeitsgang beenden/abmelden) and optionally posts produced quantities.

Parameters

Input	Key	Description	Type
options	orderId	The order identifier. Legacy acronym fallback: anr.	string
	operationId	The operation identifier. Legacy acronym fallback: avnr.	string
	workplaceId	The workplace or machine identifier. Legacy acronym fallback: mnr.	string
	personId	The person identifier. Legacy acronym fallback: pnr.	string
	yield	The produced good quantity. Legacy acronym fallback: egrGut.	integer
	scrap	The produced scrap quantity. Legacy acronym fallback: egrAus.	integer
	scrapReason	The reason code for scrap. Legacy acronym fallback: eggAus.	integer

Example

# options
orderId: '0004990701'
operationId: '10'
workplaceId: '4560'
yield: 100
scrap: 5
scrapReason: 1

Output

Returns true on success. Throws an error if the transaction fails.

interruptOperation

Interrupts a registered operation (Arbeitsgang unterbrechen), for example for breaks or shift ends where the job is not yet complete. Optionally posts partial quantities.

Parameters

Input	Key	Description	Type
options	orderId	The order identifier. Legacy acronym fallback: anr.	string
	operationId	The operation identifier. Legacy acronym fallback: avnr.	string
	workplaceId	The workplace or machine identifier. Legacy acronym fallback: mnr.	string
	personId	The person identifier. Legacy acronym fallback: pnr.	string
	yield	The partial yield quantity. Legacy acronym fallback: egrGut.	integer
	scrap	The partial scrap quantity. Legacy acronym fallback: egrAus.	integer

Example

# options
orderId: '0004990701'
workplaceId: '4560'
yield: 50

Output

Returns true on success. Throws an error if the transaction fails.

reportPartialQuantity

Posts produced part quantities (Teilrückmeldung), including good parts and scrap, for an active operation.

Parameters

Input	Key	Description	Type
options	orderId	The order identifier. Legacy acronym fallback: anr.	string
	operationId	The operation identifier. Legacy acronym fallback: avnr.	string
	workplaceId	The workplace or machine identifier. Legacy acronym fallback: mnr.	string
	personId	The person identifier. Legacy acronym fallback: pnr.	string
	cardId	The card identifier. Legacy acronym fallback: knr.	string
	yield	The produced good quantity. Legacy acronym fallback: egrGut.	integer
	scrap	The produced scrap quantity. Legacy acronym fallback: egrAus.	integer
	scrapReason	The reason code for scrap. Legacy acronym fallback: eggAus.	integer

Example

# options
orderId: 'AAA2100473100200'
workplaceId: '60610'
personId: '11111'
yield: 100
scrap: 2
scrapReason: 1

Output

Returns true on success. Throws an error if the transaction fails.

Workplaces, resources, and personnel

getWorkplaces

Reads workplaces and machines. This high-level convenience function applies default fields, associations, and filtering on top of the generic read function.

Parameters

Input	Key	Description	Type
options	filter	Additional user-defined filters.	any
	fields	Restricts the evaluation to specific columns.	array
	includeStatusAssignments	Includes corresponding status assignments. Default false.	boolean
	includeGroups	Includes corresponding capacity groups. Default false.	boolean
	skipNull	When true, omits null attributes from the return value. Default false.	boolean

Output

Returns an array of workplace objects including identifiers, designations, and current status information.

getResources

Reads resources such as tools, equipment, and gages. Without a type, the function returns all resources that are not workplaces.

Parameters

Input	Key	Description	Type
options	type	An optional specific resource type (such as TOOL or GAGE).	string
	filter	Additional user-defined filters.	any
	fields	Restricts the evaluation to specific columns.	array
	skipNull	When true, omits null attributes from the return value. Default false.	boolean

Output

Returns an array of resource objects matching the query.

getPersons

Retrieves personnel details and aggregates data from multiple MIP-HR services into a single object per person, optionally enriched with qualifications and workplace assignments.

Parameters

Input	Key	Description	Type
options	filter	Filters for the person list.	any
	fields	Specific fields to retrieve for the person.	array
	includeQualifications	Includes assigned qualifications. Default true.	boolean
	includeAssignments	Includes current workplace assignments. Default true.	boolean
	includeClockingStatus	Includes live attendance data. Default false.	boolean
	skipNull	When true, omits null attributes from the return value. Default false.	boolean

Example

# options
filter: { personLastname: Smith }
includeQualifications: true
includeAssignments: false

Output

Returns an array of person objects, or an empty array if no person matches.

Dialogs and raw calls

runDialog

Runs a named dialog with a set of key-value pairs.

Parameters

Input	Key	Description	Type
dialogName		The name of the dialog (such as A_AN).	string
options		The key-value parameters for the dialog. Add dryRun: true to receive the generated dialog string without sending it.	object

Output

Returns the raw dialog response of the MIP server, or the generated dialog string when dryRun is set.

rawServiceCall

Executes a raw service call for advanced use cases. The parameters map directly to the MIP Service Interface specification.

Parameters

Input	Key	Description	Type
url		The service URL to call (such as /data/MDUnits/list).	string
options	params	A list of filter parameter objects with acronym, operator, and value.	array
	columns	The selected columns.	array
	requestId	The request ID.	string

Example

# url
/data/MDUnits/list
# options
params: [{ acronym: units.unit, operator: EQUAL, value: C }]

Output

Returns the raw response of the MIP server.

rawDialogCall

Executes a raw dialog call by sending the complete dialog string.

Parameters

Input	Description	Type
dialogString	The complete dialog string to send.	string

Output

Returns the raw response of the MIP server.