Documentation Center

AppData settings for Contenta S1000D tools

Description of the AppData settings for the Contenta S1000D tools and UIs.

Contenta S1000D AppData settings. Global AppData values are set automatically in new or upgraded databases. AppData values for specific users are not automatically set.

Contenta S1000D AppData settings in this topic are organized by the Contenta S1000D tool or user interface to which they apply. Numerous other mimetypemappings are also defined in the CSDB to map MIME types to file extensions and thus allow the application associated with the file extension to be executed when one of these Content edit or view tools is launched.

To access the AppData paths noted below, in Contenta Explorer click Tools > Options > Tool Preferences.

Tool or UIContenta Explorer, Contenta Web
AppData Path

{Global} > Settings > CaS_Languages

Value

sourceLanguageCountryCode

Use

Specifies the source language and country of objects.

DefaultEN-US
NoteThis setting is ignored if supportMultipleLanguages is set to no.

Tool or UIContenta Explorer and Contenta Web
AppData Path

{Global} > Settings > CaS_Languages

Value

includeLanguageCountryCodeInSourceObjectNames

Use

Determines whether the value specified for sourceLanguageCountryCode is appended to the names of source objects when they are created.

DefaultDefaults to no for upgrades; yes for new installations.
NoteFor new databases, the recommended setting is yes. This setting is global, affecting the entire database, and cannot be set at the user level. It is ignored if supportMultipleLanguages is set to no.

Table 1. Classical
Tool or UI Contenta Explorer, Contenta Web
AppData Path{Global} > Settings > Display
ValueClassical
UseSet to Off to enable sorting and support the display of object properties and alternate names in the Contenta Explorer and Contenta Web interfaces in Contenta S1000D databases.
DefaultOff
NoteThis value should not be changed.

Tool or UIContenta Explorer, Contenta Web
AppData Path

{Global} (or user_desktop) > Settings > Display

Value

displayName

Use

Indicates whether to display object names or alternate names in the tree view in Contenta Explorer and Contenta Web.

Default

name

NoteChange this value to alternateName to display alternate names rather than object names in the tree view. An end user may override this AppData setting in Contenta Explorer as follows: Click Tools > Options > Startup to toggle the Display Name in Hierarchy setting (Name or Alternate Name). Whether modifying this AppData setting or the related Startup value, you must log out of Contenta and then log back in before this change will take effect.

Tool or UIContenta Web
AppData Path

{Global} (or user_desktop) > content@web > Settings > ObjectViewPrefTools

Value

Six values (Contenta object types): DModule, PModule, Dispatcher, BMP, GIF, JPG

Use

Specifies the default web tool for a Contenta object type.

Default

For DModule: S1000D LiveContent Preview

For PModule: S1000D Publish

For Dispatcher: S1000D DDN Export

For BMP, GIF, JPG: Content View

NoteYou can change the default web tools as desired, and add default tools for other object types as well. Different users can have different default tools. For example, a writer may have Arbortext (the round-trip edit tool) as their default tool for DModule objects, whereas a reviewer may have or Fetch as their default tool for DModule objects.

Tool or UIContenta Explorer, Contenta Web
AppData Path

{Global} (or user_desktop) > Settings > Display

Value

listViewPropertyFields

Use

Defines all property fields to be displayed as columns in the list view. This list includes properties from multiple object types. Names are case sensitive and must be comma-separated.

Default

Document Type, Technical Name, Information Name, Information Code, System Difference Code, Language ISO Code, Country ISO Code, Publication Module Title, SCORM Content Package Title

NoteAdd or remove property fields from the default list as desired. The Language ISO Code and Country ISO Code property fields have been added to this setting to allow sorting the List View by language or country code.

Tool or UIContenta Explorer, Contenta Web
AppData Path

{Global} (or user_desktop) > Settings > Display

Value

Sort

Use

Defines the sort order for the list view and tree view in Contenta Explorer and Contenta Web. The default sort order can be changed by modifying this AppData value; the sort column and order for the list view can also be changed by the end user in Contenta Explorer and Contenta Web. After modifying this AppData value, you must log out of Contenta and then log back in before this change will take effect.

Default

Build

NoteBuild sorts in build order. Change to Asc to sort alphabetically in ascending order, or Desc to sort alphabetically in descending order.

Tool or UIContenta Web
AppData Path

{Global} (or user_desktop) > content@web > Settings > ObjectViewPrefTools

Value

Six values (Contenta object types): DModule, PModule, Dispatcher, BMP, GIF, JPG

Use

Specifies the default web tool for a Contenta object type.

Default

For DModule: S1000D LiveContent Preview

For PModule: S1000D Publish

For Dispatcher: S1000D DDN Export

For BMP, GIF, JPG: Content View

NoteYou can change the default web tools as desired, and add default tools for other object types as well. Different users can have different default tools. For example, a writer may have Arbortext (the round-trip edit tool) as their default tool for DModule objects, whereas a reviewer may have or Fetch as their default tool for DModule objects.

Tool or UIContenta Web
AppData Path

{Global} > Settings > Display

Value

showSensitiveInfo

Use

Specifies whether Contenta API and Contenta Server version information and Database type and schema information will be displayed in the About Contenta Web dialog.

Default

yes

NoteIf this setting is changed to no, the About Contenta Web dialog will display only the Contenta Web version. Contenta API and Contenta Server version and platform information and Database type and schema information will be suppressed. The suppressed information will be recorded in Tomcat's stdout log.

Tool or UIS1000D Publish
AppData Path

{Global} > Settings > CaS_Publish

Value

PubConfigFiles

Use

Specifies, in a comma-delimited list, the publish configuration files displayed in the S1000D Publish user interface Configurations drop down.

Defaultempty
NoteOptional. If present, must contain a value consisting of one or more valid configuration file names. Specifying an invalid file name (or no value) results in an error. This setting is global, affecting the entire database, and cannot be set at the user level.

Tool or UIS1000D Upload Content
AppData Path

{Global} > Settings > CaS_Upload

Value

bytesPerRequest

Use

Specifies the size (in bytes) of data chunks to be transferred when uploading files larger than 200 MB.

Default104857600
NoteHelps prevent Tomcat out-of-memory and IIS maximum content length issues related to connection speed. Lower this setting for slower connections.

Tool or UIS1000D Upload Content
AppData Path{Global} (or user_desktop) > Settings > CaS_Upload
ValueallowUploadToOverwriteStableData
UseIndicates whether a user is allowed to overwrite stable data when they run S1000D Upload Content.
Defaultyes
NoteYou may want to set the Global value to no for all users by default, then add the allowUploadToOverwriteStableData value under individual users' desktop names in the Settings > CaS_Upload path and set this value to yes for users whom you want to have this permission. If the value is not found for a user, the Global setting is used.

Table 2. createSystemDifferenceCodeObjects
Tool or UI S1000D Upload Content
AppData Path{Global} > Settings > CaS_Upload
Value createSystemDifferenceCodeObjects
Use
SystemDifferenceCode objects are optionally created in the S1000D hierarchy based on the createSystemDifferenceCodeObjects App Data setting: {Global} > Settings > CaS Upload. For for backward compatibility with existing databases, this is set to no; in a new S1000D database, this is set to yes.
Defaultyes for new databases, no for upgraded databases.
Note
The following Contenta S1000D tools are impacted by this setting:
  • S1000D Upload Content—unloading DMs and ICN-based graphics
  • S1000D Define DRML and IRL—when the option to create a DM or ICN from the code is checked
  • S1000D Manage DMRL and IRL—when the create tool is selected for a DM or ICN

Tool or UIS1000D DDN Export, S1000D Upload Content
AppData Path

{Global} (or user_desktop) > Settings > DDNExport

Value

allowLockObjectsOnDDNExport

allowUnlockObjectsOnDDNUpload

Use

Indicates whether a user is allowed to lock objects when using the DDN Export tool and/or to unlock objects when using the Upload Content tool to upload a DDN.

Default

no

NoteYou may want to set the Global value to no for all users by default, then add the allowLockObjectsOnDDNExport and allowUnlockObjectsOnDDNUpload values under individual users' desktop names in the Settings > DDNExport path and set these values to yes for users whom you want to have this permission. If the value is not found for a user, the Global setting is used.

Table 3. showPriorVersions
Tool or UIS1000D DDN Export
AppData Path{Global} (or user_desktop) > Settings > DDNExport
ValueshowPriorVersions
UseControls whether the DDN Export interface allows the user to access prior DDN Exports.
Defaultyes
NoteThe default value is set under Global for all users. For users who should not have access to prior DDN Exports, under their user_desktop > Settings > DDN Export paths, add the showPriorVersions value and set it to no.

Table 4. GetDoc (Arbortext)
Tool or UI Arbortext ( Contenta Web edit tool)
AppData Path{Global} > Document Types > document_type > Epic
ValueGetDoc
UseSpecifies the name of the Contenta S1000D GetDoc custom adapter.
DefaultFor pm, scormContentPackage doctypes: CustomGetDocEpicCatS1000PM

For all other doctypes: CustomGetDocEpicCatS1000

NoteDo not change these values unless you are using different custom adapters.

Table 5. GetDoc (Arbortext Fetch)
Tool or UI Arbortext Fetch ( Contenta Web tool)
AppData Path{Global} > Document Types > document_type > Epic Fetch
ValueGetDoc
UseSpecifies the name of the Contenta S1000D GetDoc custom adapter.
DefaultFor pm, scormContentPackage doctypes: CustomGetDocEpicCatS1000PM

For all other doctypes: CustomGetDocEpicCatS1000

NoteDo not change these values unless you are using different custom adapters.

Table 6. GetDoc (Oxygen Fetch)
Tool or UI Oxygen Fetch ( Contenta Web tool)
AppData Path{Global} > Document Types > document_type > Epic Fetch
ValueGetDoc
UseSpecifies the name of the Contenta S1000D GetDoc custom adapter.
DefaultFor pm, scormContentPackage doctypes: CustomGetDocEpicCatS1000PM

For all other doctypes: CustomGetDocEpicCatS1000

NoteDo not change these values unless you are using different custom adapters.

Table 7. PutDoc (Arbortext)
Tool or UIArbortext ( Contenta Web edit tool)
AppData Path{Global} > Document Types > document_type > Epic
ValuePutDoc
UseSpecifies the name of the Contenta S1000D PutDoc custom adapter.
DefaultFor pm, scormContentPackage doctypes: CustomPutDocEpicCatS1000PM

For all other doctypes: CustomPutDocEpicCatS1000

NoteDo not change these values unless you are using different custom adapters.

Table 8. PutDoc (Oxygen)
Tool or UIOxygen ( Contenta Web edit tool)
AppData Path{Global} > Document Types > document_type > Epic
ValuePutDoc
UseSpecifies the name of the Contenta S1000D PutDoc custom adapter.
DefaultFor pm, scormContentPackage doctypes: CustomPutDocEpicCatS1000PM

For all other doctypes: CustomPutDocEpicCatS1000

NoteDo not change these values unless you are using different custom adapters.

Tool or UIContenta Web checkout/fetch tools: Arbortext or Oxygen (round-trip edit tool), Arbortext or Oxygen Check Out, Arbortext Fetch
AppData Path

{Global} (or user_desktop) > Settings > Editors > cw_xml_co

Value

launchArbortext or launchOxygen

Use

Indicates whether the web checkout tools should automatically launch the XML editor.

Defaultyes
NoteChange this value to no if Arbortext or Oxygen editor is not installed on Contenta Web clients, or if you don't want it to be automatically launched for other reasons.

This AppData setting is not supported in Contenta S1000D 5.8 and later.

Tool or UIContenta Web checkout tools
AppData Path

{Global} (or user desktop) > Settings > Editors > cw_xml_co

Value

launchCustomS1000DEditor

Use

Specifies the whether to launch a custom S1000D XML editor with the Contenta S1000D Web Check Out tool.

Defaultno
NoteDefaults to no for backward compatibility; change to yes if using a custom S1000D XML editor.

This AppData setting is not supported in Contenta S1000D 5.8 and later.

Tool or UIContenta Web checkout tools
AppData Path

{Global} (or user desktop) > Settings > Editors > cw_xml_co

Value

customS1000DEditorPath

Use

Specifies the path to a custom S1000D XML editor to be launched with the Contenta S1000D Web Check Out tool.

Defaultempty
NoteDefaults to empty for backward compatibility.

This AppData setting is not supported in Contenta S1000D 5.8 and later.

Tool or UIContenta Explorer/Contenta Web checkout/fetch tools (Arbortext or Oxygen, Arbortext or Oxygen Check Out, Arbortext Fetch - web tool only), Insert Reference (Contenta S1000D Editor plug-in)
AppData Path

user_desktop > Settings > Graphics

Value

exportReferencedGraphics

Use

Set on a per-user basis to specify whether graphics should be exported for display in the editor when a user checks out a module, and downloaded and displayed when a user inserts a reference to a graphic via Contenta > Insert Reference... in the editor.

DefaultNone: Because there is no Global user setting for exportReferencedGraphics, this setting is not set in new or upgraded databases.
NoteSet this value to prompt if the user should be asked if they want to export graphics each time they check out or fetch a module. Set this value to yes if graphics should always be exported or downloaded, or no if graphics should never be exported or downloaded. If this value is set to yes or no, the user is not prompted during checkout.

Tool or UIContenta Explorer/Contenta Web checkout/fetch tools (Arbortext or Oxygen, Arbortext or Oxygen Check Out, Arbortext Fetch - web tool only), Insert Reference (Contenta S1000D Editor plug-in)
AppData Path

user_desktop > Settings > Graphics

Value

exportReferencedGraphics

Use

Set on a per-user basis to specify whether graphics should be exported for display in the editor when a user checks out a module, and downloaded and displayed when a user inserts a reference to a graphic via Contenta > Insert Reference... in the editor.

DefaultNone: Because there is no Global user setting for exportReferencedGraphics, this setting is not set in new or upgraded databases.
NoteSet this value to prompt if the user should be asked if they want to export graphics each time they check out or fetch a module. Set this value to yes if graphics should always be exported or downloaded, or no if graphics should never be exported or downloaded. If this value is set to yes or no, the user is not prompted during checkout.

Tool or UI Insert Reference (Contenta S1000D Editor plug-in)
AppData Path

{Global} (or user_desktop) > Settings > Graphics

Value

multimediaObjects

Use

Defines which object types will have multimedia (vs. graphic) markup inserted when a user inserts a reference to a graphic via Contenta > Insert Reference... in the XML editor. Names are case sensitive and must be hyphen-delimited.

Default

AVI-MOV-MP3-MP4-MPEG-NGrain_3KO-PDF-RHI-RM-SWF-WAV-WMA-WMV

NoteAdd or remove object types from this list as needed. For example, if your content includes FLA multimedia files, add FLA to the hyphen-delimited list. Likewise, if your content includes VDS multimedia files, add VDS to the list.

Tool or UIManage Applicability (Contenta S1000D Editor plug-in)
AppData Path

{Global} > Settings > CaS_ManageApplic

Value

applicIdPrefix

Use

Specifies the prefix for system-generated Applicability IDs. This prefix applies across the CSDB, not to a particular ACT file.

Default

app

UseChange this value to a different value if desired.

Tool or UIContenta Explorer/Contenta Web checkin tools (Arbortext or Oxygen, Arbortext or Oxygen Check In)
AppData Path

For all S1000D programs (models): {Global} > S1000D Programs > DEFAULT

For a specific program (model): Global > S1000D Programs > program_name

Value

autoUpdateTableOfReferences

Use

Indicates whether to automatically update the table of references when a DM is checked in.

Default

no

NoteChange values to yes if you want the table of references to be rebuilt each time you check in an updated DM. If a program name is not set, the value for the DEFAULT program is used.

Tool or UIS1000D LiveContent Preview
AppData Path

{Global} > Settings > CaS_LCPreview

Value

stylesFolder

Use

Specifies the name of the LiveContent styles folder.

Default

s1000d

NoteContenta S1000D delivers default styles to the s1000d folder. If you have your own custom LC styles that you want to use instead, change this value to the name of your LC styles folder. See the Configuring LC Preview to use custom styles topic in the Contenta S1000D Installation and Upgrade Guide.

Tool or UIS1000D Validate
AppData Path

{Global} (or user_desktop) > Settings > CaS_Validate

Value

enableBrexValidation

UseIndicates whether a user may access the Validate BREX options in the Validate tool interface.

When set to no, Validate BREX options do not appear in the UI.

Default

yes

NoteYou may want to set the Global value to no for all users by default, then add the enableBrexValidation value under individual users' desktops in the Settings > CaS_Validate path and set this value to yes for users whom you want to have this permission. If the value is not found for a user, the Global setting is used.

Tool or UISearch (Contenta Web tool)
AppData Path

{Global} > content@web > Settings

Value

cw_searchObjectTypes

Use

Specifies which object types you want the Search tool (Contenta Web) to include in searches. Names are case sensitive and must be hyphen-delimited.

Default

DModule-PModule-SCORMContentPackage-AVI-BMP- CGM-EPS-GIF-JPG-MOV-MP3-MP4-MPEG-NGrain_3KO- PNG-RHI-RM-SVG-SWF-TIF-WAV-WMA-WMV

Note Several new object types were added in Contenta S1000D 5.0, and the graphics types were reordered alphabetically. Remove any object types that you do not want included in Contenta Web searches.

Table 9. text/css
Tool or UI Content Check Out, Content Check In, Content View, Content Fetch, Check Out, Check In, Edit, View
AppData Path{Global} > mimetypeMappings
Valuetext/css
Use

Maps MIME type to .css file extension for CSS files.

Default .css
NoteJavaScript (JS) and CSS files are supported to work in conjunction with FLA multimedia files in SCORM packages.

Tool or UI Manage Internal References
AppData Path{Global} > Settings > Editors > cw_xml_co > enableManageInternalReferencesOnInsert
Valueoff
Use

Determines whether the Contenta Manage Internal References tool launches when a user selects Insert > Markup in Arbortext Editor or Oxygen XML Author.

DefaultDefaults to off in an upgraded CSDB; change to on to launch the tool automatically when a user selects Insert > Markup.

Defaults to on in a new CSDB.

Note

Tool or UI Content Check Out, Content Check In, Content View, Content Fetch, Check Out, Check In, Edit, View
AppData Path{Global} > mimetypeMappings
Valueapplication/octet-stream
Use

Maps MIME type to .fla file extension for FLA multimedia files.

Default .fla
Note

Table 10. application/msword
Tool or UI Content Check Out, Content Check In, Content View, Content Fetch, Check Out, Check In, Edit, View
AppData Path{Global} > mimetypeMappings
Value application/msword
UseSpecifies a Word mime type mapping. This is used to control which file extension is added to a Word (.doc) file when it is exported for content editing or viewing.
Default .doc
Note

Tool or UI Content Check Out, Content Check In, Content View, Content Fetch, Check Out, Check In, Edit, View
AppData Path{Global} > mimetypeMappings
Valueapplication/vds
Use

Maps MIME type to .vds file extension for SAP VDS multimedia files.

Default .vds
Note

Tool or UI Content Check Out, Content Check In, Content View, Content Fetch, Check Out, Check In, Edit, View
AppData Path

{Global} > mimetypeMappings

Value

application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Use

Maps MIME type to .xlsx file extension.

Default .xlsx
Note

Table 11. application/vnd.ms-excel
Tool or UIContent Check Out, Content Check In, Content View, Content Fetch, Check Out, Check In, Edit, View
AppData Path{Global} > mimetypeMappings
Valueapplication/vnd.ms-excel
UseSpecifies a Excel mime type mapping. This is used to control which file extension is added to an Excel (.xls) file when it is exported for content editing or viewing.
Default .xls
Note

Table 12. application/vnd.ms-powerpoint
Tool or UIContent Check Out, Content Check In, Content View, Content Fetch, Check Out, Check In, Edit, View
AppData Path{Global} > mimetypeMappings
Value application/vnd.ms-powerpoint
UseSpecifies a PowerPoint mime type mapping. This is used to control which file extension is added to a PowerPoint (.ppt) file when it is exported for content editing or viewing.
Default .ppt
Note

Tool or UI Content Check Out, Content Check In, Content View, Content Fetch, Check Out, Check In, Edit, View
AppData Path

{Global} > mimetypeMappings

Value

application/vnd.openxmlformats-officedocument.presentationml.presentation

Use

Maps MIME type to .pptx file extension.

Default.pptx
Note

Tool or UI Content Check Out, Content Check In, Content View, Content Fetch, Check Out, Check In, Edit, View
AppData Path

{Global} > mimetypeMappings

Value

application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Use

Maps MIME type to .xlsx file extension.

Default .xlsx
Note

Tool or UI Content Check Out, Content Check In, Content View, Content Fetch, Check Out, Check In, Edit, View
AppData Path

{Global} > mimetypeMappings

Value

application/vnd.openxmlformats-officedocument.wordprocessingml.document

Use

Specifies a Word mime type mapping. This is used to control which file extension is added to a Word (.docx) file when it is exported for content editing or viewing.

Default.docx
Note

Tool or UI Content Check Out, Content Check In, Content View, Content Fetch, Check Out, Check In, Edit, View
AppData Path{Global} > mimetypeMappings
Valueapplication/zip
UseSpecifies a ZIP mime type mapping. This ensures that the .zip file extension is added to a ZIP file when it is exported.
Default .zip
Note