MGCLatticeDmfJobSpecContract

One recurring data job, its schedule and its authorized clients, as a specification file carries it.

Methods

new

Initializes a new instance of the MGCLatticeDmfJobSpecContract class.

• Visibility: public
• Returns: void

No parameters.

construct

Creates a new instance of the MGCLatticeDmfJobSpecContract class.

• Visibility: public
• Returns: MGCLatticeDmfJobSpecContract A new instance.

No parameters.

parmName

Gets or sets the job's name, which is its key.

• Visibility: public
• Returns: str The job name.

Name	Type	Optional	Description
_name	str	Yes	The job name.

parmDescription

Gets or sets the job description.

• Visibility: public
• Returns: str The description.

Name	Type	Optional	Description
_description	str	Yes	The description.

parmDataProjectName

Gets or sets the data project this job runs.

• Visibility: public
• Returns: str The data project name.

Name	Type	Optional	Description
_dataProjectName	str	Yes	The data project name.

parmDirection

Gets or sets whether messages come in or go out, as an element name.

• Visibility: public
• Returns: str The direction name.

Name	Type	Optional	Description
_direction	str	Yes	The direction name, Inbound or Outbound.

directionValue

Gets the direction as the enumeration the platform stores.

• Visibility: public
• Returns: IntegrationDirection The direction.

No parameters.

parmRecurrenceUnit

Gets or sets the recurrence unit, as an element name.

• Visibility: public
• Returns: str The unit name.

Name	Type	Optional	Description
_recurrenceUnit	str	Yes	The unit name, for example Hour.

recurrenceUnitValue

Gets the recurrence unit as the enumeration the platform stores.

• Visibility: public
• Returns: SysRecurrenceUnit The unit.

No parameters.

parmRecurrenceInterval

Gets or sets the interval - the N in "every N units".

• Visibility: public
• Returns: int The interval.

Name	Type	Optional	Description
_recurrenceInterval	int	Yes	The interval.

parmRecurrenceStartDateTime

Gets or sets when the first run is due, in ISO 8601.

• Visibility: public
• Returns: str The start.

Name	Type	Optional	Description
_recurrenceStartDateTime	str	Yes	The start, for example 2026-10-01T07:00:00Z.

parmRecurrenceEndType

Gets or sets how the schedule ends, as an element name.

• Visibility: public
• Returns: str The end type name.

Name	Type	Optional	Description
_recurrenceEndType	str	Yes	The end type name, for example NoEnd.

recurrenceEndTypeValue

Gets the end condition as the enumeration the projection uses.

• Visibility: public
• Returns: MGCLatticeRecurrenceEndType The end condition.

No parameters.

parmRecurrenceEndAfterCount

Gets or sets the number of runs after which the schedule ends.

• Visibility: public
• Returns: int The run count.

Name	Type	Optional	Description
_recurrenceEndAfterCount	int	Yes	The run count.

parmRecurrenceEndDate

Gets or sets the date the schedule ends, as yyyy-MM-dd.

• Visibility: public
• Returns: str The end date.

Name	Type	Optional	Description
_recurrenceEndDate	str	Yes	The end date.

parmRecurrenceTimeZone

Gets or sets the time zone the schedule's clock times are read in, as its numeric value.

• Visibility: public
• Returns: str The time zone.

Name	Type	Optional	Description
_recurrenceTimeZone	str	Yes	The time zone; blank for the environment's own, 89 for UTC.

recurrenceTimeZoneValue

Gets the time zone as the enumeration the platform stores.

• Visibility: public
• Returns: Timezone The time zone; the environment's preferred zone when the specification is silent.

No parameters.

parmMonitoringRecurrenceUnit

Gets or sets the monitoring job's recurrence unit, as an element name.

• Visibility: public
• Returns: str The unit name.

Name	Type	Optional	Description
_monitoringRecurrenceUnit	str	Yes	The unit name.

monitoringRecurrenceUnitValue

Gets the monitoring recurrence unit as the enumeration the platform stores.

• Visibility: public
• Returns: SysRecurrenceUnit The unit.

No parameters.

parmMonitoringRecurrenceInterval

Gets or sets the monitoring job's interval.

• Visibility: public
• Returns: int The interval.

Name	Type	Optional	Description
_monitoringRecurrenceInterval	int	Yes	The interval.

parmProcessMessagesSerially

Gets or sets whether messages are processed strictly in the order received.

• Visibility: public
• Returns: boolean Whether messages are serialized.

Name	Type	Optional	Description
_processMessagesSerially	boolean	Yes	Whether messages are serialized.

parmUseDataAreaIdFromMessage

Gets or sets whether the legal entity comes from the submitted message.

• Visibility: public
• Returns: boolean Whether the message carries the legal entity.

Name	Type	Optional	Description
_useDataAreaIdFromMessage	boolean	Yes	Whether the message carries the legal entity.

parmPreventUpload

Gets or sets whether an export is kept from uploading its file.

• Visibility: public
• Returns: boolean Whether upload is prevented.

Name	Type	Optional	Description
_preventUpload	boolean	Yes	Whether upload is prevented.

parmBatchGroupId

Gets or sets the batch group the job is scheduled into when it is activated.

• Visibility: public
• Returns: str The batch group.

Name	Type	Optional	Description
_batchGroupId	str	Yes	The batch group; blank means the default group.

parmActivate

Gets or sets whether the job should be running once the specification is applied.

• Visibility: public
• Returns: boolean Whether the job is activated.

Name	Type	Optional	Description
_activate	boolean	Yes	Whether the job is activated.

parmClients

Gets or sets the client applications authorized to submit to this job.

• Visibility: public
• Returns: List The authorizations.

Name	Type	Optional	Description
_clients	List	Yes	The authorizations.

addClient

Authorizes a client application for this job.

• Visibility: public
• Returns: void

Name	Type	Optional	Description
_client	MGCLatticeDmfJobClientSpecContract	No	The authorization.