Resource Mappings

* = Required

Name

Description

Type

Values

DepartmentExternalId*

The Id for the Department in which the resource is in. String  

ExternalId*

The identifier for external system references. (Inherited from BaseResource.) String  

Name*

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

PlantExternalId*

The Id for the Plant in which the resource is in. String  

Active

Specifies whether the resource is active (in use). Boolean  

AutoJoinHrs

This is the number of hours from the PlanetTogether clock within which resources can be processed to auto-join.  Double  
AutoSplitHrs

 

This is the number of hours from the PlanetTogether clock within which resources can be processed to auto-split. Double  

BatchType

Specifies whether the batching is defined by a percentage or a volume.  String None
Percent
Volume

BatchVolume

Specifies the number of jobs that can be batched together on the resource. If an activity's required quantity is larger than this value, the job will fail to schedule.  Decimal  
BufferSpanHrs The hour span of the Buffer when using Drum-Buffer-Rope Release rules. Buffer spans are used to prevent starving this resource thus keeping its utilization high. (Inherited from InternalResource.) Double  

CapacityType

Specifies how many activities can be performed at the same time.

Single Tasking - Only one activity at a time.

MultiTasking - A specified number of activities can be performed at the same time.

Infinite - Any number of activities can be performed at the same time (no constraint). (Inherited from InternalResource.)

String SingleTasking
Infinite
MultiTasking
CellExternalId Represents a physical grouping of Resources in an autonomous production line. Once an operation is scheduled in a cell, successors will be scheduled within the same cell if possible. If a Resource is assigned a cell, then when an Operation is scheduled in the Cell all successor Operations attempt to schedule on Resources in the same Cell. (Inherited from BaseResource.) String  

CompatibilityGroup

Resources that are part of the same Compatibility Group can only run Operations concurrently if they have the same Compatibility Code. For example, if two machines are fed by the same material input pipe then at any point in time they can only run products that use that same material. String  

ConsecutiveSetupTimes

Whether Resource and Operation setups are done consecutively or in parallel. If true, then the Total Setup is the sum of the Resource and Operation setups. If false, then the Total Setup is the maximum of the two. This setting has no effect if the Use Operation Setup is false. (Inherited from InternalResource.) Boolean  

CurrentProductSetup

The Product for which the Resource is currently or was most recently setup. This is used to calculate setup time for the first scheduled activity on the Resource. (Inherited from InternalResource.) String  

CurrentSetupCode

The Operation SetupCode for which the Resource is currently or was most recently set up. This is used to calculate setup time for the first scheduled activity on the Resource. (Inherited from InternalResource.) String  

CurrentSetupNumber

The Operation SetupNumber for which the Resource is currently or was most recently setup. This can be used by Optimizations to sequence Operations with Setup Numbers that are near each other or in an increasing/decreasing sequence. (Inherited from InternalResource.) Double  

CycleEfficiencyMultiplier

Multiplies run time to adjust for slower/faster Resources. Values greater than one represent a resource that is running faster than usual while values less than one represent a resource that is running slower than usual. (Inherited from InternalResource.) Double  

Description

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

DisallowDragAndDrops

If true then drag and drop of activities on the Resource are not allowed. (Inherited from BaseResource.) Boolean  

DiscontinueSameCellScheduling

If set then same-cell scheduling for predecessor operations is discontinued. But if this resource is part of a cell, then the behavior is as usual and this resource’s cell will become the new cell to try to schedule in. (Inherited from InternalResource.) Boolean  

Drum

Whether to treat this Resource as a Drum when using the Drum-Buffer-Rope Release rule. (Inherited from InternalResource.) Boolean  

DurationDependsOnCapacity

If true, then the length of the activities is based upon the amount of capacity available rather than only the setup/cycle/teardown times. (Inherited from InternalResource.) Boolean  

ExcludeFromCapacityPlan

Whether the Resource should be excluded from the Capacity Plan display. This has no effect on scheduling. (Inherited from BaseResource.) Boolean  

ExcludeFromGantts

Whether the Resource should be excluded from Resource Gantts. This is often set to true for inactive resources. (Inherited from BaseResource.) Boolean  

ExcludeFromReports

Whether the Resource should be excluded from Schedule Reports. This is often set to true for inactive resources. (Inherited from BaseResource.) Boolean  

ExperimentalDispatcherName

The name of the set of optimization rules used when experimenting with What-If scenarios for this resource. 

String Optimize Rule Name

GanttRowHeightFactor

Controls how tall the row is relative to other rows. Valid ranges are from 1 (shortest) to 10 (tallest). (Inherited from BaseResource.) Int32  

HeadStartHrs

The hours of headstart applied to the resource. When using the release rule JIT with ResourceHeadstart, this value will be added to the JIT start date. This can be used to prevent inventory buildup.  Double  

ImageFileName

File name (with suffix but not path) of which image to use in the Gantt, etc to represent this Resource.(Inherited from BaseResource.) String  

IsTank

Specifies whether the resource is a tank resource.  Boolean  
LimitAutoJoinToSameShift If true, AutoJoining will be limited to operations and activities starting in the same shift. Boolean  

ManualAssignmentOnly

If true, operations and activities can only be assigned to the resource manually.  Boolean  

MaxQty

For the Resource to be considered eligible for an activity, the Activity RequiredFinishQty must be less than or equal to this amount. Double  

MaxQtyPerCycle

For the Resource to be considered eligible for an Operation the Operation’s QtyPerCyle must be less than or equal to this amount. This is often used for batch processes where a Resource can hold a certain volume and that volume cannot be exceeded. Double  

MaxSameSetupHrs

When using "Same Setup Code" optimization rules, a setup code change is forced after this specified number of hours or cycle-time passes. This option can be used to force periodic rotation between groups of products. (Inherited from InternalResource.) Double  

MinNbrOfPeople

The minimum number of people that are required for the resource. Double  

MinQty

For the Resource to be considered eligible for an activity, the Activity RequiredFinishQty must be at least this amount. Double  

MinQtyPerCycle

For the Resource to be considered eligible for an operation, the Operation’s QtyPerCyle must be at least this amount. This is often used for batch processes where a Resource can hold a certain volume and there is a desire to use smaller Resources for smaller orders to avoid wasting capacity. Double  
NoDefaultRecurringCapacityInterval If set to true, will prevent the "First Shift" to be automatically assigned to this Resource. This is to prevent jobs from scheduling on a newly-imported Resource. Boolean  

NormalDispatcherName

The name of the set of optimization rules normally used for this resource.  String Optimize Rule Name

Notes

Comments or special considerations pertaining to this object.(Inherited from BaseObject.) String  

NumberOfResources

When you have multiple identical Resources, you can create a single resource record and specify the number of resources in this field. This will create the Resources and add "-1", "-2", etc to the Resource Name. Int32  

OmitSetupOnFirstActivity

If true, then the Setup Time on the first Activity scheduled on the Resource is always zero. Boolean  

OmitSetupOnFirstActivityInShift

If true, then the Setup Time on the first Activity scheduled on a Capacity Interval is always zero. Boolean  

Overlap

Specifies when operations are considered ready to start processing on THIS Resource.(Inherited from InternalResource.) String  

OvertimeHourlyCost

Defines the hourly cost for running the resource during overtime capacity intervals.  Decimal  

ProcessingStatus

Specifies the Resource’s status as of the last update. (Inherited from InternalResource.) String Idle
SettingUp
Running
TearingDown

ResourceType

The type of physical entity represented by the Resource. Used for custom reports and other display groupings.(Inherited from BaseResource.) String Machine
Operator
Supervisor
Engineer
Inspector
Team
Labor
Equipment
Tool
Subcontractor
Cell
WorkArea
WorkCenter
Bay
Transport
Container
Special
Technician
Fixture
Employee
Tank
Inbox

Role

Indicates the types of Resource Requirements for which the Resource is eligible. Main Resource Requirements set the duration of the Operation.(Inherited from InternalResource.) String  

SameSetupHeadstartMultiplier

Used in the calculation of how far an operation can be scheduled before its JIT Start Date. Larger values result in activities with longer setups being allowed to start earlier to save a setup. During Optimizations, activities are not permitted to start more c_JITstartDate-(SameSetupHeadstartMultiplier*currentSetupSpan+headStartSpan). It can be used to prevent excessive inventory buildup and aid in grouping same-setup code activities. (Inherited from InternalResource.) Double  

ScheduledRunSpanAlgorithm

Name of the script used to calculate ScheduledRunSpan in activities on this resource. If specified, this gives the absolute final value for ScheduledRunSpan. The result must be a non-negative double or 1 will be substituted and an error will be logged. (Inherited from InternalResource.) String  

ScheduledSetupSpanAlgorithm

Name of the script used to calculate ScheduledSetupSpan in Activities on this resource. If specified, this gives the absolute final value for ScheduledSetupSpan. The result must be non-negative double or zero will be substituted and an error will be logged. (Inherited from InternalResource.) String  

ScheduledTransferSpanAlgorithm

Name of the script used to calculate ScheduledTransferSpan in Activities on this resource. If specified, this gives the absolute final value for ScheduledTransferSpan. The result must be non-negative double or zero will be substituted and an error will be logged. (Inherited from InternalResource.) String  

Sequential

This property only applies to infinite resources. Makes sure that every activity scheduled finishes on or after the last scheduled block time. In the case where the activity being scheduled would have been scheduled to complete before the last block that was scheduled the scheduled finish time is adjusted so that the block is scheduled to finish at the same time as the last scheduled block. This property was added to help model conveyors. Model the minimum length of time an activity must stay on the conveyor (transfer time) using an Infinite sequential resource. And model the unloading of the conveyor as a finite resource. You may also need to place the two resources used to model the conveyor and predecessor resource in the same cell. Setup the unloading resource and operation so that the length of the unload matches the length of the load. Boolean  

SetupEfficiencyMultiplier

Multiplies the setup time to adjust for slower/faster setups. Larger numbers mean the resource is slower at performing setups. For example, specifying 3 means that it takes three times longer to perform a setup than the standards indicate. (Inherited from InternalResource.) Double  

SetupHrs

The number of hours that must be spent to set up this resource whenever the preceding operation did not use this resource. (Inherited from InternalResource.) Double  

SetupIncluded

Indicates when to add setup time to an operation scheduled on this resource. String WhenProductChanges
WhenSetupCodeChanges
WhenEitherChanges
Always
Never
WhenSetupNumberChanges
WhenSetupNumberIncreases
WhenSetupNumberDecreases
UseSetupCodeTable
UseOperationAttributes
ShowOnlyInDepartment If true, the resource will only be shown in the department. This is an exclusion setting that is used when a resource is no longer in use, but there is no desire to remove it from the shop floor.  Boolean  

Sort

Can be used for sorting Resources in Gantt Charts, reports, etc.(Inherited from BaseResource.) Int32  

Stage

Used for multi-stage scheduling to allow scheduling of groups of resources stage by stage. Staging comes with the following restrictions: 1. Jobs can only have one Manufacturing Order. The job release event only occurs once in simulation 2. Each operation can only have one predecessor operation and one successor operation. 3. An operation can only have one resource requirement to help prevent the problem of requiring resources that have different stages 4. Resources with the same capabilities must have the same stage number. Otherwise, the operation would be eligible in multiple stages, only one of the stages would be selected, and the resources from the other stages would become ineligible. If any of these restrictions are violated then the simulation might fail. (Inherited from InternalResource.) Int32  
StandardFlagsList An internally generated list of Flags to alert users to particular conditions. These are not stored in the objects but can be generated by an object on demand. This value is null unless overridden in a derived object. (Inherited from BaseIdObject.)    

StandardHourlyCost

Used for calculating schedule quality and in scripts. (Inherited from InternalResource.) Decimal  

TransferHrs

The time it takes for the items produced to be transferred to the next resource or to inventory. Successor operations cannot start before this time passes after finishing the operation. The resource is not consumed during this time. (Inherited from BaseResource.) Double  

UseOperationSetupTime

Whether to use the Setup Span of the Operation in calculating the scheduled setup. If false, then only the Resource setup is used. (Inherited from InternalResource.) Boolean  

UserFields

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

Workcenter

The name of the work center in the ERP system (or Department Name if not set). For display only. (Inherited from BaseResource.) String  

WorkcenterExternalId

The Id of the WorkCenter in the ERP system. (Inherited from BaseResource.) String