Job Mappings

* = Required

Name

Description

Type

Values

ExternalId*

(Inherited from ExternalBaseIdObject.) String  

Name*

Unique, changeable, text identifier.(Inherited from BaseObject.) String  

AgentAlert

Controls when E-Mail Alerts are sent to Agents. This setting is subject to system level alert controls.  Int16  

AgentEmail

E-mail address of the sales or customer service agents to be alerted when the Job changes. Note: separate multiple email addresses with semi-colons. String  

AlmostLateDays

Jobs and Activities are considered AlmostLate if they end within this period from the Need Date. Double  

Cancelled

If cancelled, the Job won’t be scheduled. Boolean  

CanSpanPlants

If true, then the Operations can schedule in more than one plant. Otherwise, all operations must be scheduled in only one Plant. Inherited from BaseOrder.) Boolean  

Classification

Can be used to distinguish the purpose of the work request.

- Production Order: These jobs are created to produce items to supply demand.

- Quote: This is used when estimating the finish dates and costs for items.

- Safety Stock: this affects the Job Late Property based on the inventory safety stock warning level.

- Transfer Order: These jobs are requests for items to be transferred from one warehouse to another.

- Template: This job is used as a template.

- Buffer Stock Replenishment: These jobs use the buffer penetration of the primary product's inventory instead of the drum or shipping buffer penetration.

- Sales Order: These are usually customer orders for finished products. 

String ProductionOrder
Quote
SafetyStock
Forecast
TransferOrder
Template
BufferStockReplenishment
SalesOrder

ColorCode

A Color that can be used to distinguish the Job from other Jobs in the Gantt. String  

ColorCodeAlpha

The alpha component in RGBA representation of Job color Int16  

ColorCodeBlue

The blue component in RGBA representation of Job color Int16  

ColorCodeGreen

The green component in RGBA representation of Job color Int16  

ColorCodeRed

The red component in RGBA representation of Job color Int16  

Commitment

Indicates the likelihood that the work will be executed. This value can be updated internally and will be protected from external changes that attempt to set the value “backwards” (such as from Firm to Planned). This allows the planner to advance the Commitment level internally and not have the change undone by an external system that has not been updated. String Released
Firm
Planned
Estimate

CustomerAlert

Controls when E-Mail Alerts are sent to Customers, subject to system-level alert controls. Int16  

CustomerEmail

E-mail address of the customer to be alerted when the Job changes. Separate multiple addresses with semi-colons. String  

CustomerExternalId

Indicates the Customer that the Job is for. String  

Description

Text for describing the object. (Inherited from BaseObject.) String  

Destination

Indicates the geographical region or address where the products will be sent. For information only. String  

DoNotDelete

If true, then the Job will not be deleted by the system. This can be used to keep Jobs that will be used as templates for copying to new Jobs. This value can be set by the interface but not updated. This is to preserve manual changes by the planner. Boolean  

DoNotSchedule

If true, then the Job will not be scheduled. This can be used to prevent quotes or other un-firm Jobs from scheduling until a planner would like to do so. This value can be set by the interface but not updated. This is to preserve manual changes by the planner. Boolean  

Hold

Whether the Job was placed On-hold and work should not be done on it. Boolean  

HoldReason

The reason the Job was placed On-Hold. String 1. Material Hold
2. Tooling Hold
3. Production Hold
4. Engineering Hold
5. Customer Hold
6. Quality Hold
7. Lack of Material
8. Design Change Pending

HoldUntilDate

 No Activities are scheduled before this date/time. This value is only set if the Job itself is placed On Hold, not if Operations, etc. only are placed On Hold. DateTime  

Hot

Means the Job is especially important. This can be used by the Balanced Composite Rule. Boolean  

HotReason

Explanation of why the Job is on Hot. String  

Importance

The value of the Job relative to other Jobs. This can be used by the Balanced Composite Rule. Int32  

Invoiced

Whether an invoice has been sent for the Job. For information only. Boolean  

LatePenaltyCost

Optional currency value that specifies the cost (either actual or estimated) per day of finishing late. For display only. Decimal  

MarkForDeletion

 Can be used by the Interface Customizer to delete jobs that are batched together, etc. Boolean  

MaxEarlyDeliveryDays

The customer will accept the order this amount of time before the Need Date. If Operations are scheduled with more than this amount of Slack then they are considered Early. This does not impose a constraint on Optimizations or Moves. Jobs can still be scheduled earlier than this but then they are marked as “Early”. If this value is zero then E-mail Alerts are not sent to alert of early Jobs since they cannot be accepted early. Double  

NeedDateTime

When to finish by to be considered on-time. DateTime  
Notes Comments or special considerations pertaining to this object. (Inherited from BaseObject.) String  

OldExternalId

Can be used to change the ExternalId of a Job once it has been imported. During import, if a Job with the specified ExternalId does not exist then a Job with OldExternalId is searched for and updated if it exists.  If this doesn’t exist either then a new Job is created with the ExternalId (not the OldExternalId). String  

OrderNumber

Can be used to specify the customer order number. For display only. String  

Printed

Whether the Job’s Traveler Report has been Printed. Boolean  

Priority

Usually used to specify a combination of importance and urgency. This can be used by the Balanced Composite Rule. Lower numbers are more urgent/important. Int32  

Revenue

Estimated money paid for the parts produced by the Job. Decimal  

Reviewed

Tracks whether the Job has been reviewed by a planner. Only set during import for NEW Jobs and thereafter controlled internally. Boolean  

Shipped

Whether the Job has been shipped to the recipient. For information only. Int32  

ShippingCost

The cost of shipping the parts produced by the Job. Decimal  

Template

Indicates that the Job is only used for copying to create new Jobs. Template Jobs are not scheduled. Boolean  

TravelerReport

The name of the report (without path) to use for accompanying the Job on the shop floor. Multiple reports can be included here by separating them with a semi-colon. These reports must be placed in the Reports folder to be sent to the Clients by the Client Updater Service. String  

Type

Can be used to specify a free-form type for grouping. For display only. String  

UserFields

Optional list of user-defined fields. Null if not initialized.(Inherited from BaseObject.) String