About the Application Document

The application document is a webform document containing administrative settings for Astoria Communication Services. Administrators can edit this document to define properties of the application.

The Administration cabinet contains the application document. Many of the settings in the application document are described in various configuration topics. You can search the Astoria Online Help to find details.

Fields in the document include:

Field Description
Jython Init Script Lists the jython initialization script that runs each time a jython process initializes. If you create additional jython modules, modify the script by adding the additional module names to the list of imports at the start of the script.
User Display Indicates how user names are displayed. The choices are:
  • Name, which displays the login name of the user.
  • Full Name, which displays the full name of the user.
  • Name and Full Name, which displays the login name followed by the full name, in brackets, of the user.
  • Full Name and Name, which displays the full name followed by the login name in brackets, of the user.
Annotation Group Identifies the group that is allowed to work with annotations. Only users who are members of the group named here can perform annotation operations. Until you specify this group, no user can perform annotations.
Status and Task Changers Identifies the group that has global access to two Astoria Workflow commands: Reset Status and Change Task Owner. Members of this group can always perform these two commands.
Content Specifications Defines columns that include information contained within fields of the document content, but is not available as a custom attribute of those documents. Each content column entry in the repeat group has two fields:
  • Name. The name associated with the content. It is used as the column label/heading.
  • XPath or columnScriptlet. The Astoria XPath expression that specifies where to find the content of interest in a document. To maximize the performance of the CMS, it is suggested that the specified XPath statements be as explicit as possible as shown in the XPath Example below.

    Once the content specification entry is created, content columns are displayed (prefixed by a '>') at the bottom of the columns picker membership control in the user options and search results pages (and wherever else columns are displayed).

Create/Rename OS User Default check box

Hide Create/Rename OS User check box

These two properties control the Create OS User or Rename OS User check boxes in the user object properties sheet. See Creating a User.
  • If selected, the Create/Rename OS User Default option causes the check boxes to be selected by default.
  • If selected, the Hide Create/Rename OS User option hides the check boxes, but respects the behavior of the Create/Rename OS User Default option.

In an On-Demand environment that does not use SSO, all Astoria users must have accounts on the primary ACS server in the data center. In this case, you should select the Create/Rename OS User Default check box, and select the Hide Create/Rename OS User check box. The Create OS User or Rename OS User check box will not be visible, but it is selected.

For On Premise environments where user accounts are managed externally (such as in Windows domains or using LDAP), Astoria recommends you clear the Create/Rename OS User Default check box and select the Hide Create/Rename OS User check box.

With these settings, the required value is known implicitly, and there is no reason to solicit a value that would result in erroneous behavior.

Mail Sender The email address that system notification message will be sent from.
Normal URL Specifies the URL to use for requests that do not send credentials.
Secure URL Specifies the URL to use for requests that send credentials.
Relational Databases A repeat group in which an administrator identifies the relational databases to which ACS offers access. The following fields are displayed:
  • Database Name. Specified by the administrator and is the name by which ACS users access the database.
  • JDBC Class Name. Specifies the Java class which implements the JDBC interface to the database.
  • JDBC URL. Specifies the uniform resource locator to connect to the desired database.
  • Credentials Required. Indicates if user credentials are required to access this database. When selected, the optional User Name and Password (below) are used to access the database. If credentials are required, but not specified in the application document, the user is prompted with them when needed.
  • User Name. Specifies the name of the user to access the database.
  • Password. Specifies the relational database password of the user.
 
 
 
 
 
 
XML Editor Defines the System Default editor. This choice is used if a user specifies Use System Default. The choices for this field are:
  • Fragment
  • DAV
Default Sandbox The default value for the sandbox directory on each client.
Annotation View Option Global default for which elements can have annotations. Settings here can be overridden by settings on documents or DTDs.
Annotation Elements A global default list of elements that can or cannot have annotations, if Annotation View Option is set to either include or exclude. Settings here can be overridden by settings on documents or DTDs.
Element History on Status Bar When reviewing a document, hovering over an element displays the most recent checkin history in the browser status bar.
Element History as Tool Tip When reviewing a document, hovering over an element displays the most recent checkin history as a tool tip.
Job Flavors A list of possible job Flavor types.

Placing a blank job flavor in the list enables Audience Parameters and Task Sequences to handle objects of any job flavor.

Set workflow status on referenced documents Specifies how the workflow status will be set on referenced documents when changing the status of a map.
  • Off: Workflow status is not set on any referenced documents.
  • Only directly referenced documents: Workflow status is set only on topics directly referenced by the map. It is not recursive; that is, it does not apply to submaps, or topics referenced by the map's first-level topics.
  • All referenced documents: Workflow status is set on submaps and subtopics.
    Note: A document is considered referenced based on whether the referencing element specifies the class attribute with a value of map/topicref (this is typically defined in the DTD). So, for example, documents referenced by topicrefs are included, but not those referenced by xrefs or conrefs.

See Setting Workflow Status on Documents Referenced by a Map.

Perform Change Status in foreground check box If selected, when possible, perform status changes in the foreground rather than submitting a job to the Workflow daemon.
Snapshot Label Hints A list of hints that are displayed when adding a snapshot. See Defining a New Snapshot Label Hint.
Sort existing snapshots check box Some dialogs display the existing snapshots at the top of the Snapshot hint list. If selected, this option sorts this list alphabetically. If cleared, labels are sorted in the order they were added (most recent last).
Remove Snapshots enabled check box If selected, the Delete Snapshots command is visible. If not selected, snapshots cannot be deleted.
Signed snapshots check box If selected, adding the snapshot requires an electronic signature. Also, digital signatures are enabled for workflow (must be configured in the Task Sequence document). The signature information is stored in the snapshot label.
eSignature SSO URL If your organization has implemented electronic signatures using SAML, enter the URL for your organization's SAML 2.0 SSO provider.
'Add snapshot to referenced objects' includes files and external files check box If selected, causes the snapshot label to be added to referenced unstructured files and external files if a user selects this option when adding a snapshot label to a structured document.
Use Filtering check box If selected, enables the use of filtering, which disables the use of effectivity processing for conditional processing. See Configuring Filtering.
Expand DITA Documents check box Allows the Astoria Chooser dialog to expand DITA documents.
Hide posted jobs check box If selected, the Astoria Reviewer interface does not display the Posted Jobs tab. A reviewer can select only jobs under the Assigned Jobs tab in the interface.
Effectivity XPaths (Applies only if Multiple Effectivities is disabled.). For each DTD, defines the Effectivity Definition XPath and Effectivity Scope Xpath settings. See Configuring Single Effectivity.
Multiple Effectivities check box If selected, Multiple Effectivities are enabled for filtering. See Configuring Multiple Effectivity.

If cleared, only Single Effectivities are enabled for filtering.

Range String (Single Effectivities option only). The string to use when specifying a range of effectivity values. Specify this string exactly, including any space. For example " - " (space, dash, space) can be used to represent ranges like this: 1 - 5. See Specifying a Value Range for Single Effectivity.
Separator String The string to use when specifying a list of filtering or effectivity values. Specify this string exactly, including any space. For example "," (comma, no spaces) can be used to represent a list like this: a,b,c (no spaces).
Important: Do not change this value once you have implemented filtering or effectivity for conditional processing, because any document instances that use the previous value are not updated with a new value. If your system is configured for filtering, filter objects are not updated with a new value.
Exclusion String If you specify a filtering or effectivity value that begins with this string, then the element is included only if the specified value does not match. For example if the exclusion string is ! (exclamation point), and the effectivity is !a, then an effectivity value of b will be a match.
Important: Do not change this value once you have implemented filtering or effectivity for conditional processing, because any document instances that use the previous value are not updated with a new value. If your system is configured for filtering, filter objects are not updated with a new value.
Show Filtering Attribute Excludes Select Hierarchical Filtering Taxonomy to suppress the availability of exclude filtering attributes for authors using the oXygen editor or the Workbench Map Editor. Select Filtering Attribute Excludes to allow exclude filtering attributes. However, this option disables the ability to create a hierarchical taxonomy of filtering attribute values. See About Hierarchical Filter Constraint Values.
Cumulative Filtering check box If selected, specifications from any filterConfig.cfg files in the ancestry of a folder (including the Filtering folder in the Administration cabinet) are concatenated. This allows users who are authoring in the oXygen editor (or the Workbench Map Editor) to select any attribute and value inherited by the document.
Show changes to XML attributes when comparing check box If selected, when comparing XML documents, attributes that have been added, modified, or removed between the two versions are displayed. Other attributes are not.
Compare Count Cutoff Along with Compare Depth Cutoff, this specifies the conditions when the Compare operation runs as a batch job. This field specifies the number of elements in a document at which the compare operation automatically runs as a batch job. A value of zero does not force a batch job.
Tip: If Interactive Compare takes too long, set Compare Count Cutoff to 5000 and adjust thereafter.
Compare Depth Cutoff Along with Compare Count Cutoff, this specifies the conditions when the Compare operation runs as a batch job. This field specifies the tree depth in a document at which the compare operation automatically runs as a batch job. A value of zero does not force a batch job.
General Translation Settings
  • Translation Type
  • Translation Type for older translations
  • Translation Type attribute
  • Translation Type namespace URI
  • Translation Type namespace prefix
  • astX:md value when translation type changes
  • Limit Translation Types
  • Translation Package Destination
  • Graphics Translation Default
  • Graphics Translation Default
  • SVG Graphics Translation Default
  • Allowed Locales Attribute
  • Translate Locale Attribute
  • Translation HTML
  • Include non-translated graphics
  • Send target translated graphics
  • Exclude xref'd documents from translation
  • Default Block Level translation option
  • Block level elements
  • Use "no translate" attribute
  • Non-effective elements get no content
  • xml:lang attribute processing type
  • xml:lang attribute separator
  • Set profile filter
  • Always send All Document for translation
  • All Documents translations create multiple packages
  • Include Translation readme
See Configuring Translation Options for details on these settings.
Administrator email Specifies the email address(es) that certain system messages are sent to. Emails are sent to these addresses for certain batch and translation job failures. Specifically, when batch or translation jobs finish and Astoria cannot determine to whom to send the email message.

If this field is not defined, the email is sent to the first member of the administrators group who has specified an email address.

Note: To specify multiple addresses, separate each with a comma.
SDL translation settings
  • SDL FTP URL
  • SDL FTP Username
  • SDL FTP Password
  • SDL FTP Base Directory for Export
  • SDL FTP Base Directory for Upload
  • SDL Configurations
  • SDL Locales
See Configuring SDL/Nexus-SJP Translation Options, Configuring SDL/Nexus-FTP Translation Options, and Configuring the FTP-ZIP-SRC Translation Package Destination.
World Server translation settings:
  • World Server SOAP URL
  • World Server base folder
See Configuring Astoria for WorldServer Translations.
Project Director translation settings:
  • Project Director URL
  • Project Director Username
  • Project Director Password
  • Project Director Shortcode
  • Project Director classifier (XML documents)
  • Project Director mime type (XML documents)
  • Project Director classifier (files)
  • Project Director mime type (files)
See Configuring Astoria for Project Director Translations.
Export Folder Transaction Granularity When exporting a folder, this field specifies the number of folder items to export before creating a checkpoint in the database transaction. This value should not be modified unless you get 422 (Out of Address Space) errors while exporting a folder. If unspecified, the value to be used is 10. If 422 errors occur, lower this value until the errors stop occurring.
Override Object IDs check box If selected, the Element Object Identifiers option will overwrite existing XML attribute values during export.
Check previous versions for file dependencies check box When deleting a file, Astoria always warns you if the file is used by the current version of a document. If selected, Astoria also warns you if the file is used by any previous version of a document.
Review uses Conref Push check box If selected, Review will process DITA conaction attributes and display conref pushes. For large maps, this may result in degraded performance of the Review operation.
Ignore whitespace-only changes on checkin check box If selected, text elements with only whitespace changes are not updated during import.
Whitespace-significant elements A list of elements in which white space is significant. Changes to these elements are always updated on checkin.

XPath Example

You can create an explicit XPath to an element. If you want to display the content of the arStatus field of an AR document, the following two XPaths give the same correct result:
  • /Job_ActionRequest/arStatus
  • //arStatus
The performance of the XPath resolution is faster in the first case than in the second. In the second case, the // indicates that an arStatus field appearing anywhere in the document is acceptable, which means that the entire document may have to be searched to find the field. In the first case, the path to the arStatus field is explicit and the arStatus element can therefore be found very quickly if it is present. If it is not present, its absence is detected very quickly.
Similarly, you can extract the value of an element attribute and use it in a display column for a structured document. You simply add an attribute step to the end of the XPath expression. An attribute step is the name of the requested attribute preceded by a slash-ampersand (/@). For example, given the following structured document contents:
<Foo> <Bar time="Now">Hello World</Bar> </Foo>

A column with an XPath expression of /Foo/Bar causes the text Hello World to appear in the column. On the other hand, an XPath expression of /Foo/Bar/@time results in the text Now being displayed in the column.