SiberSafe CMS/CSDB S1000D FAQ

See below the answers to the frequently asked questions about SiberSafe S1000D CSDB:

Robust SQL database to manage large volumes of S1000D data

SiberSafe CMS/CSDB works with many different SQL database systems, including Oracle, SQL Server, MySQL and others. Some of our customers manage terabytes of content in SiberSafe CMS/CSDB.

Application Programming Interface (API) for integration is available.

Both Java and .NET APIs are available as well as the Command Line Language. All the major CMS/CSDB functions are programmatically accessible through the APIs.

Possibility to implement new XML schemas (easily)

SiberSafe is unique in its ability to support any proprietary XML schema/DTD or SGML DTD. All the benefits that it provides for the main stream DTDs and Schemas, such as S1000D, DITA, DocBook, MIL-2361 etc, can be also easily configured for a proprietary schema or DTD.

Robust, stable

Multiple military, commercial and aerospace implementations have successfully used and are now using our IETP viewer. SiberSafe development cycle includes a comprehensive set of automatic tests, including both functional and stress tests.

XML editors supported

SiberSafe is tightly integrated with Arbortext, XMetaL, XMAX, XmlMind and FrameMaker. In all these editors, all the common CMS/CSDB functions are accessible through the editor's menu. SiberSafe is interoperable with most other XML editors through its Dashboard widget.

XML Web editor (http) offering most of the functions of a classic XML editor

SiberSafe is tightly integrated with the XMAX web editor. XMAX is embedded into SiberSafe's web-based user interface. The interaction between SiberSafe and XMAX is performed through HTTP-based WebDAV protocol.

Manage an unlimited number of S1000D projects

SiberSafe allows the user to create many different projects than may be based on different standards or versions of such standards. The same installation of SiberSafe can simultaneously manage S1000D, DITA, DocBook, MIL-2361 and other project types.

Manage multiple language versions of each DM within a same project

SiberSafe CMS/CSDB provides unparallel support for translation and localization. Foreign language project branches of the same project can be created and automatically synchronized with the evolving source language branches so that only the updated content has to be re-translated. SiberSafe offers XLIFF-based interoperability with Sun OLT translation workbench open source TM tool as well as full interoperability with TRADOS and other similar systems. Bi-lingual side-by-side publishing support has been built into the SiberSafe publishing framework. Pre-translation (automatically applying content updates from the source language branch to the foreign language branch) in SiberSafe operates at the element level so that if only one list item or one table cell has changed in the source language, that one list item or that one table cell need to be re-translated.

Flexible S1000D project configuration

Projects in SiberSafe can be completely isolated from each other featuring different configuration, access rights, data module templates, default attribute values, DTD/Schema and other project-specific settings.

Integrators and partners working on a same CSDB

SiberSafe offers a number of ways to allow integrators and partners to access the same CSDB, including its tight integration with the XMAX web editor. XMAX is embedded into SiberSafe's web-based user interface. The interaction between SiberSafe and XMAX is performed through HTTP-based WebDAV protocol. All SiberSafe editor integrations are web-enabled so that users can access the CSDB all over the world using the HTTP protocol with or without authoring software installed on their personal machines

Partners and integrators working on different CSDBs

SiberSafe comes with import/export utilities that automatically import/export Zipped batches of S1000D data modules to facilitate exchange with partners and integrators who do not have direct access to the CSDB.

Data arranged in a tree structure (folders, sub folders) following SNS or equipment component structure, or both

In SiberSafe, data modules can be organized in a number of different ways, including the SNS-based hierarchy and component-based hierarchy (often these are different from each other). Both SNS and component hierarchies can either be developed by hand or imported using a convenient, human-readable, machine-writable, text-based content map file that can be automatically prepared based on LSA data. When the actual data modules are imported into the CMS, they are automatically placed under their correspondent SNS designations.

Storage of DMs

Data Modules are centrally and securely stored, versions and access-controlled in SiberSafe CMS/CSDB

Storage of ICNs

Illustrations in SiberSafe are organized around the SNS structure the same way as data modules are so that their ICNs can be easily managed.

Objects are easy to manipulate

SiberSafe supports copy/paste operations on single objects (such as DMs or SNS/Component items/folders) or multiple selections. By cutting/pasting a single SNS item from one spot in the SNS hierarchy to another, all DMs under this SNS folder are automatically and instantly re-coded so that their DMCs automatically reflect the new SNS designations. Any REFDM/DMREF references to such "moved" modules are automatically updated to reflect the new SNS designation of the target DM.

Reuse common DMs

In SiberSafe, the same DM can be included into a number of different publication modules. The same content chunk (such as a paragraph) can be included into more than a single DM. SiberSafe will automatically ensure the integrity of such reuse references.

Reuse warnings, cautions, typical sentences, graphic symbols

Commonly used content chunks (such as warnings, cautions, typical sentences, graphic symbols etc) can be declared as reusable. The same content chunk (such as a paragraph) can be included into more than a single DM. SiberSafe will automatically ensure the integrity of such reuse references. As a result, a change made in a common warning that is included into a number of data modules will be immediately reflected in all these modules.

Importing LSA data

In SiberSafe, the SNS/Component/DMC hierarchy can either be developed by hand or imported using an XML-based content map file that can be automatically prepared based on LSA data. When the actual data modules are imported into the CMS, they are automatically placed under their correspondent SNS designations.

Mass import of S1000D content

SiberSafe comes with the mass(batch) import utility that automatically imports Zipped batches of S1000D data modules. The importation accommodates both data modules and illustrations in the CSDB and can also be used for repeated importations of subsequent data module updates. the imported modules are automatically organized around the SNS hierarchy and their REFDM/DMREF references, as well as their illustration references are automatically recognized and validated.

Support of DMRL

SiberSafe can automatically compile DMRLs for any specific level of the component or SNS hierarchies. DMRLs can also be created by manual selection of data module placeholders. External DMRLs can be imported and result into automatic creation of the appropriate DM placeholders. An automatically compiled DMRL for a higher-level component/SNS item will automatically include all the DM placeholders associated with its sub-ordinate, lower-level components/SNS items or their own DMRLs.

Automatic generation of PMs without the use of an XML editor

SiberSafe automatically generates multi-level, hierarchically organized PMs based on either the SNS structure, the component structure or the task analysis structure stored and managed in SiberSafe. The automatically generated PMs can be either published right away or, optionally, adjusted/re-shuffled in an XML editor prior to publishing

DM/ICN Authoring: Check-Out (lock), Check-In (unlock)

SiberSafe facilitates locking DMs/ICNs upon check-out and unlocking upon checking in order to prevent content overwrites. The checked out files, as well as their related resources (the images, stylesheets, schemas etc) are automatically downloaded into the working folder on the user's local file system. SiberSafe can be configured to automatically remove the checked-in files and their related resources from the working folder.

Automatic build of DM skeletons

SiberSafe automatically generates DM skeletons when they are first instantiated. SiberSafe generates the section on the fly at the time when a data module is retrieved from the CSDB. As a result, the data in the section at all times reflect the current SNS designation and Information Code designation (as well as the rest of the metadata) of the data module.

Creation/Update of IPD DMs

SiberSafe is able to automatically generate Illustrated parts data modules based on the equipment component hierarchy managed by SiberSafe. IPDs can be generated for any levels of the component hierarchy and will automatically reflect the list of sub-components, including their illustrations. The parts catalogue data can be imported into SiberSafe and automatically form the component hierarchy through the content map importation mechanism as described above.

Source/legacy content management and transformation into S1000D

SiberSafe provides unparalleled support for transforming source content/data into S1000D, including specifications, drawings etc. with speed and efficiency unprecedented in the industry. Source content is broken down into fragments, fragments are mapped onto data modules, illustrations/diagrams are automatically extracted and then data modules are automatically populated with the content of the fragments and illustrations/diagrams that have been mapped onto them. The linkage between the source content and S1000D data modules is maintained and visualized at all times. SiberSafe can also be configured to allow the user to review source content and identify documentation gaps that require data module updates and then map such gaps onto the modules where they have to be implemented. The user can then search for modules that have mapped onto them that haven't been addressed yet and clearly see what source specs/diagrams caused their existence.

Workflow managemen

SiberSafe provides a feature-rich workflow control and access control mechanisms that support groups, user accounts, roles, task types, task assignments, task states, task state transitions, automatically generated e-mail notifications and many other state-of-the-art features. SiberSafe workflow mechanism is 100% configurable to closely match the customer's business process currently in place.

Work progress/status reporting

SiberSafe Workflow mechanism is able to produce on-screen and printable reports that clearly show how assignments have been allocated and what their status is

Earned value reporting

SiberSafe is able to automatically generate the Earned Value Report (EVR) that shows the percentage of completion for a given component sub-hierarchy or the whole project based on what modules have been fully or partially processed (created, updated, reviewed, approved etc).

Review and approval

SiberSafe's Collaborative Review support makes it easy for subject matter experts or peer authors to annotate S1000D data modules using a web browser-based concurrent review tool. Many reviewers can be annotating the same data module inserting simultaneously and concurrently annotations that are automatically embedded into the data module's content for the author to act upon.

Preview DM/ICN without editor

SiberSafe provides HTML-based preview of any DM or shows the illustration in its web browser-based user interface without the use of an XML editor.

Full Text search

SiberSafe features a full text search engine that can perform complex queries that are based both on metadata and keywords or phrases at the same time.

Access control and permissions

SiberSafe supports two types of access permissions, including function access permissions and data access permissions. Permissions can be granted or denied to individual users or user groups. Group permissions are inherited by sub-groups and group members. Content object permissions are inherited by sub-objects. Every type of access (modification, addition, removal, seeing historical versions etc is subject to SiberSafe access control.

Output to IETP Viewer

SiberSafe "ready-to-use" IETP Viewer can be shipped on a CD or made accessible through a web portal (special applet-based components are available that facilitate certain IETP functions over the web in this case). It can accommodate multiple IETP publications and offer the user to choose one or more for viewing. It allows the user to install new or update existing publications and warns if an already existing publication is being updated.

Output to paper publication (PDF)

SiberSafe Styler is used to generate the standard-compliant look-and-feel for S1000D data in the PDF (or RTF/DOC) printable formats. It automatically generates TOC and hyperlinks

Layout highly customizable

SiberSafe Styler is unique in its ability to allow the user to easily tweak/control the PDF layout and look-and-feel of the S1000D content using the familiar Microsoft Word formatting user interface and visually assigning styles to XML constructs. The result is 100% S1000D compliant PDF output that can be easily customized for every customer's individual requirements.

Advanced search functions

Proximity-based, context-driven keyword/phase is available in SiberSafe IETP Viewer. In the text of the modules found, the keywords or phrases searched for by the user are automatically color-highlighted.