Example file

This is an example of a submitter defaults file.

Every option has an "info:" line that explains the format of the setting and the setting itself.
A # in front of a setting means that it is ignored.

(In this example all options are ignored)

Note about missing settings:
If you add any pre/post-script or if we add a new option to RR, then these new settings are not in this help document.

You have to use the rrSubmitter menu to edit/open a file.

#**************************************************************

# SUBMITTER CONFIG FILE INFORMATION:

#**************************************************************

# This file controls the default values for the submitter and control

# There can be multiple submitter config files which are loaded

# You can also specify all options in a commandline for submitter or control.

# The files are loaded in this order:

# 0) renderapp/_config/[renderApp].cfg

# ---------------------------------------

# 1) sub/cfg_global/submitter_first.txt

# 2) sub/cfg_user/submitter_prj_[ProjectName].txt

# 3) sub/cfg_user/submitter_usr_[UserLoggedIn].txt

# 4) sub/cfg_user/submitter_mac_[MachineName].txt

# 5) Commandline

# 6) (Show All menu item: Sets allowChange=1 for all options)

# 7) sub/cfg_global/submitter_last.txt

# 8) sub/cfg_global/submitter_last_non_admin.txt (loaded if you are not an rrAdmin)

# ---------------------------------------

# 9) renderapp/_config/[renderApp].cfg

# The Settings are stacked.

# e.g. If you set a value in 1) submitter_first and this value is not set in any other config file, it is kept.

# Values set in 3) user configs overwrite values from 1) submitter_first.

# 7) submitter_last_non_admin.txt is only loaded if the user logged in is not a RRender admin.

# 0) 8) The render application config is applied two times

# The first time 0) it is loaded as basic settings for the render application.

# Then all the submitter config files are overwriting the parameters.

# Then 8) the render application config is checked again if parameters are not allowed for that render application.

# If a render application does not allow some parameter, it is simply not possible to use it with that application.

# To ensure that those options are not set, it is checked again while a job is send to the rrServer

# NOTE: PLEASE SEE HELP FILES SECTION Customization / Submitter defauls FOR MORE EXPLANATION.

#**************************************************************

# FORMAT:

#**************************************************************

# The format of this file is ParameterName='Options'

# If 'Options' has multiple options to set, they are divided by a '~'

# The values types are

# AC = Allow change ( 0= Do not allow to change , 1= Allow to change)

# Most of the Parameters have this option. It controls if this setting can be changed at the submitter.

# If it is not allowed to change this value, it is disabled and, if not checked, it is not visible at the submitter at all

# VIS = Visible ( 0 = hidden, 1 = visible)

# Sets if the parameter is visible at the submitter

# COL = Collaped ( 0= Group is expanded , 1= Group is collapsed )

# Changes the expanded/collaped state

# CK = Checked (0 = not checked, 1 = parameter is checked)

# If this is set, the parameter is checked by default

# VAL = Value (Number)

# Default value for the parameter

# TXT = Text (text line)

# Name or parameter line set by default

# NOTE: You do not have to set all values for a parameter.

# You can set an empty space if you do not want to override the value.

# This does not apply for the render config files.

#**************************************************************

# EXAMPLES:

#**************************************************************

# #RenderPreviewFirst=AC~CK

# RenderPreviewFirst= 0~0 Not allowed to change (hidden) ~ not checked

# RenderPreviewFirst= 1~0 Allowed to change (and visible) ~ not checked

# RenderPreviewFirst= 1~1 Allowed to change (and visible) ~ checked

# RenderPreviewFirst= ~1 (value is not overridden) ~ checked

# #Param=AC~CK~TXT

# Param= 1~0~ Allowed to change ~ not checked ~ no default parameter line

# Param= 1~0~ -samples_min -2 -samples_max 0 Allowed to change ~ not checked ~ a parameter line for preview antialiasing

#**************************************************************

# PLEASE UNCOMMENT LINES YOU WANT TO OVERWRITE

#**************************************************************

#info: UIStyle=AC~TXT rrSubmitterUI - UIStyle

#UIStyle=1~

#info: AutoDeleteFrames=AC~CK AutoDeleteFrames

#AutoDeleteFrames=1~0

#info: NoLocalDriveWarning=AC~CK NoLocalDriveWarning

NoLocalDriveWarning=1~1

#info: CloseAfterSubmit=AC~CK rrSubmitterUI - CloseAfterSubmit

#CloseAfterSubmit=1~0

#info: DisableAllScripts=AC~CK DisableAllScripts

#DisableAllScripts=1~0

#info: WarnIfAllClientsAssigned=AC~CK WarnIfAllClientsAssigned

#WarnIfAllClientsAssigned=1~0

#info: ShotNameRequired=AC ShotNameRequired

#ShotNameRequired=0

#info: ShowAllOptionsButton=AC rrSubmitterUI - ShowAllOptionsButton

#ShowAllOptionsButton=1

#info: OverrideRendererPossible=AC OverrideRendererPossible

#OverrideRendererPossible=1

#info: UIGroupRightSubmitter=AC~COL rrSubmitterUI - Right Panel

#UIGroupRightSubmitter=1~1

#info: UIGroupRightSubmitterPlugin=AC~COL rrSubmitterUI - Right Panel if started from plugin

#UIGroupRightSubmitterPlugin=1~1

#info: UIGroupSceneSettings=AC~COL rrSubmitterUI - Scene Settings

#UIGroupSceneSettings=1~1

#info: UIGroupSceneSettingsPlugin=AC~COL rrSubmitterUI - Scene Settings if started from plu

#UIGroupSceneSettingsPlugin=1~1

#info: UIGroupLoadScenePlugin=AC~COL rrSubmitterUI - Load Scene

#UIGroupLoadScenePlugin=1~1

#info: UIGroupClients=AC~COL rrSubmitterUI - Clients

#UIGroupClients=1~1

#info: UIGroupClientFilter=AC~COL rrSubmitterUI - Filter Clients

#UIGroupClientFilter=1~1

#info: UIGroupRenderSettings=AC~COL rrSubmitterUI - Render Settings

#UIGroupRenderSettings=1~1

#info: UIGroupJobLimitations=AC~COL rrSubmitterUI - Job Limitations

#UIGroupJobLimitations=1~1

#info: UIGroupCommandLine=AC~COL rrSubmitterUI - Commandline

#UIGroupCommandLine=1~1

#info: UIGroupCustomSceneSettings=AC~COL rrSubmitterUI - Custom Scene Settings

#UIGroupCustomSceneSettings=1~1

#info: UIGroupRROptions=AC~COL rrSubmitterUI - RR Options

#UIGroupRROptions=1~1

#info: UIGroupOverride=AC~COL rrSubmitterUI - Override

#UIGroupOverride=1~1

#info: UIGroupNotify=AC~COL rrSubmitterUI - Notify

#UIGroupNotify=1~1

#info: UIGroupWait=AC~COL rrSubmitterUI - Wait For

#UIGroupWait=1~1

#info: UIGroupOnSubmissionScript=AC~COL rrSubmitterUI - On Submission Script

UIGroupOnSubmissionScript=1~1

#info: UIGroupAfterPreviewScript=AC~COL rrSubmitterUI - After Preview Script

UIGroupAfterPreviewScript=1~1

#info: UIGroupPreRenderScript=AC~COL rrSubmitterUI - Pre Render Script

UIGroupPreRenderScript=1~1

#info: UIGroupPostRenderScript=AC~COL rrSubmitterUI - Post Render Script

UIGroupPostRenderScript=1~1

#info: UIGroupFinishedScript=AC~COL rrSubmitterUI - Finished Script

UIGroupFinishedScript=1~1

#info: PriorityMIN=AC~VAL min

#PriorityMIN=1~1

#info: PriorityMAX=AC~VAL max

#PriorityMAX=1~99

#info: UltimatePriority=AC UltimatePriority

#UltimatePriority=1

#info: CustomUserInfo=AC~CK~TXT CustomUserInfo

#CustomUserInfo=0~0~

#info: WaitForJob=AC WaitForJob

#WaitForJob=1

#info: OverrideRREnvFile=AC~TXT Override rrEnvFile

#OverrideRREnvFile=1~<CompanyProjectRootFolder>renderfarm.rrEnv

#info: OverrideRREnvList=AC~TXT Override rrEnvList

#OverrideRREnvList=1~

#info: OverrideSequence=AC Override Sequence

#OverrideSequence=1

#info: AllowImageNameChange=AC AllowImageNameChange

#AllowImageNameChange=1

#info: AllowImageDirChange=AC AllowImageDirChange

#AllowImageDirChange=1

#info: OverridePathPreset=AC~CK~TXT OverridePathPreset

#OverridePathPreset=1~0~

# PathPresets=TXT

#..... PathPresets

#info: DefaultClientGroup=AC~TXT DefaultClientGroup

#DefaultClientGroup=1~

#info: InvalidClientGroup=AC~TXT InvalidClientGroup

#InvalidClientGroup=1~

#info: WaitForTime=AC~CK~VAL WaitForTime

#WaitForTime=1~0~0

#info: WaitForDay=AC~CK~VAL WaitForDay

#WaitForDay=1~0~0

#info: AdditionalCommandlineParam=AC~CK~TXT AdditionalCommandlineParam

#AdditionalCommandlineParam=0~0~

#info: Priority=AC~VAL Priority

#Priority=1~30

#info: SeqDivMIN=AC~VAL min

#SeqDivMIN=1~1

#info: SeqDivMAX=AC~VAL max

#SeqDivMAX=1~15

#info: SeqDivMINComp=AC~VAL min

#SeqDivMINComp=1~7

#info: SeqDivMAXComp=AC~VAL max

#SeqDivMAXComp=1~40

#info: SequenceDivide=AC~CK Sequence Divide

#SequenceDivide=1~1

#info: UserName=AC~TXT UserName

#UserName=0~<User>

#info: CompanyProjectName=AC~TXT CompanyProjectName

#CompanyProjectName=0~<CompanyProject>

#info: CustomSeQName=AC~TXT Sequence

#CustomSeQName=1~<auto>

#info: CustomSHotName=AC~TXT Shot

#CustomSHotName=1~<auto>

#info: CustomVersionName=AC~TXT Version

#CustomVersionName=1~<auto>

#info: CustomSCeneName=AC~TXT Scene

#CustomSCeneName=1~

#info: CustomJobType=AC~TXT Version

#CustomJobType=1~

#info: Division=AC~TXT Division

#Division=1~

#info: TileFrame=AC~CK~VAL Tile Frame

#TileFrame=1~0~4

#info: SendJobDisabled=AC~CK SendJobDisabled

#SendJobDisabled=0~0

#info: NotifyFinish=AC~CK~TXT How

#NotifyFinish=1~0~

#info: NotifyFinishWhen=AC~VAL When

#NotifyFinishWhen=1~0

#info: NotifyFinishClient=AC~TXT Client

#NotifyFinishClient=1~<ThisMachine>

#info: NotifyFinishParam=AC~VAL Parameter

#NotifyFinishParam=1~0

#info: AbortJobswithLowerPriority=AC~CK Abort Jobs with Lower Priority

#AbortJobswithLowerPriority=0~0

#info: IgnoreCrashes=AC~CK Ignore Crashes

#IgnoreCrashes=0~0

#info: ApproveAllAutomatically=AC~CK Approve All Automatically

#ApproveAllAutomatically=0~0

#info: IgnoreWaitForJobs=AC~CK Ignore Wait For Jobs

#IgnoreWaitForJobs=0~0

#info: RenderPreviewFirst=AC~CK Render Preview First

#RenderPreviewFirst=1~1

#info: DoNotShowPreviewJpegs=AC~CK Do Not Show Preview Jpegs

#DoNotShowPreviewJpegs=0~0

#info: DoNotCheckForFrames=AC~CK Do Not Check For Frames

#DoNotCheckForFrames=0~0

#info: LittleJob=AC~CK Little Job

#LittleJob=0~0

#info: Deprecated=AC~CK Deprecated

#Deprecated=0~0

#info: KeepSceneOpen=AC~CK Keep Scene Open

#KeepSceneOpen=0~1

#info: AllowtoDeleteCrashedFrames=AC~CK Allow to Delete Crashed Frames

#AllowtoDeleteCrashedFrames=0~1

#info: AllowLocalSceneCopy=AC~CK Allow Local Scene Copy

#AllowLocalSceneCopy=0~1

#info: AllowTextureReplacement=AC~CK Allow Texture Replacement

#AllowTextureReplacement=0~1

#info: AllowLocalRenderOut=AC~CK Allow Local Render Out

#AllowLocalRenderOut=0~1

#info: Linearcolor=AC~CK Linear color

#Linearcolor=0~0

#info: CropEXR=AC~CK Crop EXR

#CropEXR=0~1

#info: MultiOSScenes=AC~CK Multi OS Scenes

#MultiOSScenes=0~1

#info: NoProcessTreeCheck=AC~CK No Process Tree Check

#NoProcessTreeCheck=0~0

#info: Overwriteexistingfiles=AC~CK Overwrite existing files

#Overwriteexistingfiles=0~0

#info: NoFreezeDetection=AC~CK No Freeze Detection

#NoFreezeDetection=0~0

#info: GPUrequired=AC~CK GPU required

#GPUrequired=0~0

#info: DistributeStartToEnd=AC~CK Distribute Start To End

#DistributeStartToEnd=0~0

#info: Preview-ContiguousFrames=AC~CK Preview- Contiguous Frames

#Preview-ContiguousFrames=0~0

#info: Auto-getRequiredMemory=AC~CK Auto-get Required Memory

#Auto-getRequiredMemory=0~0

#info: Deprecated=AC~CK Deprecated

#Deprecated=0~0

#info: Deprecated=AC~CK Deprecated

#Deprecated=0~0

#info: NoFramebyFrameLoop=AC~CK No Frame by Frame Loop

#NoFramebyFrameLoop=0~0

#info: OverrideImageSize=AC~CK Override Image Size

#OverrideImageSize=0~0

#info: LogRenderWorkload=AC~CK Log Render Workload

#LogRenderWorkload=0~0

#info: RequireApprovalAfterPreview=AC~CK Require Approval After Preview

#RequireApprovalAfterPreview=1~0

#info: RequireApprovalAfterAllFrames=AC~CK Require Approval After All Frames

#RequireApprovalAfterAllFrames=1~0

#info: RequireApprovalForCloud=AC~CK Require Approval For Cloud

#RequireApprovalForCloud=0~0

#info: GPUinAppmoderequired=AC~CK GPU in Appmode required

#GPUinAppmoderequired=0~0

#info: WaitForJobByFrame=AC~CK Wait For Job By Frame

#WaitForJobByFrame=0~0

#info: DonotexportintoHistoryDB=AC~CK Do not export into HistoryDB

#DonotexportintoHistoryDB=0~0

#info: Jobnotallowedtobedeleted=AC~CK Job not allowed to be deleted

#Jobnotallowedtobedeleted=0~0

#info: NumberofPreviewframes=AC~VAL Number of Preview frames

#NumberofPreviewframes=0~7

#info: MaxClientsAtATime=AC~VAL Max Clients At A Time

#MaxClientsAtATime=0~1000

#info: RequiredMemory=AC~VAL Required Memory (GB)

#RequiredMemory=0~0

#info: MaxFrameTime=AC~VAL Max Frame Time (minutes)

#MaxFrameTime=0~0

#info: MinFileSizeKb=AC~VAL Min File Size Kb

#MinFileSizeKb=0~0

#info: MaxCrashes=AC~VAL Max Crashes (red log)

#MaxCrashes=0~30

#info: MaxThresholds=AC~VAL Max Thresholds (frame time, sys memory)

#MaxThresholds=0~30

#info: RenderVerbose=AC~VAL Render Verbose

#RenderVerbose=0~0

#info: RenderQuality=AC~VAL Render Quality

#RenderQuality=0~0

#info: Color=AC~VAL Color

#Color=1~13

#info: Deprecated=AC~VAL Deprecated

#Deprecated=0~0

#info: Re-ExecuteJobAfterHours=AC~VAL Re-Execute Job After Hours

#Re-ExecuteJobAfterHours=0~0

#info: StartMultipleInstances=AC~VAL Start Multiple Instances

#StartMultipleInstances=0~1

#info: OverrideImageWidth=AC~VAL Override Image Width

#OverrideImageWidth=0~0

#info: OverrideImageHeight=AC~VAL Override Image Height

#OverrideImageHeight=0~0

#info: RestrictCoreCount=AC~VAL Restrict Core Count

#RestrictCoreCount=1~0

#info: RestrictMemory=AC~VAL Restrict Memory (GB)

#RestrictMemory=0~0

#info: RequiredGPUMemory=AC~VAL Required GPU Memory (GB)

#RequiredGPUMemory=1~0

#info: RequiredCoreCount=AC~VAL Required Core Count

#RequiredCoreCount=0~0

#info: AASamples=AC~VAL AA Samples

#AASamples=0~2

#info: Deletejobafterdays=AC~VAL Delete job after days

#Deletejobafterdays=0~0

#info: OSonce_Example-addEnvVars=AC~CK once| Example - addEnvVars

#OSonce_Example-addEnvVars=1~0

#info: OSonce_Example-calcSeqShotVersion=AC~CK once| Example - calcSeqShotVersion

#OSonce_Example-calcSeqShotVersion=1~0

#info: OSonce_Example-username_dropdown=AC~CKonce| Example - username_dropdown

#OSonce_Example-username_dropdown=1~0

#info: OSonce_installmaya2023SP3=AC~CK once| install maya2023 SP3

#OSonce_installmaya2023SP3=1~0

#info: OSonce_install_Maya2024_sp1=AC~CK once| install_Maya 2024_sp1

#OSonce_install_Maya2024_sp1=1~0

#info: OSonce_submit_copy_of_scene=AC~CK once| submit_copy_of_scene

#OSonce_submit_copy_of_scene=1~0

#info: OSperjob_Example-App_3D__hello_job=AC~CK perjob| Example - App_3D__hello_job

#OSperjob_Example-App_3D__hello_job=1~0

#info: OSperjob_Example-hello_job=AC~CK perjob| Example - hello_job

#OSperjob_Example-hello_job=1~0

#info: OSperjob_Example-setEnvLine=AC~CK perjob| Example - setEnvLine

#OSperjob_Example-setEnvLine=1~0