Introducing CXT
Introducing CXT

Introducing CXT / Installation / Modules / Installing modules / Fragment DAP

Fragment Data Access Plugin (Fragment DAP)

Referencing fragments

Table of contents

Fragments and variants are small, self-contained units of content that are created, managed, and deployed regardless of context (see FAQ: What are fragments?).

Using the Fragment DAP, fragments can be entered and managed centrally in a fragment project and made available in various target projects (as a reference), including in FirstSpirit SiteArchitect and FirstSpirit ContentCreator. The fragments therefore remain physically present in the fragment project.

Using the Fragment DAP, fragments from one fragment project can be:

  • referenced in another fragment project.
    If the settings have been configured accordingly, the referenced fragments can also be edited and new ones can be created there.
  • referenced in a classic FirstSpirit project, where they can be grouped, structured, and placed in relation to each other. If the settings have been configured accordingly, the referenced fragments can also be edited in FirstSpirit ContentCreator.

Advantages

  • no additional memory requirement for fragments used in multiple projects.
  • simplified editing and managing since all content is located in a centralized fragment project.

Checklist

Following components and configurations are required if you want to use the functionality described on this page:

 

Type

What?

Where?

Further information

License

REMOTEPROJECT

ServerMonitoring / file system

see Technical requirements and recommendations (CXT)

Module

FragmentCreator

Server properties – Modules

see FirstSpirit CXT FragmentCreator

Module

DAP Bridge

Server properties – Modules

see FirstSpirit CXT DAP Bridge

Module

Fragment DAP

Server properties – Modules

see Download and installation

Remote project

Fragment project that makes fragments available

Project properties – Remote projects

see Configuring remote projects

Input component

FS_INDEX

Project – Template store

see Configuring FS_INDEX

 

Web component
(optional)

Fragment DAP for ContentCreator

Project properties – Web components

see Using fragments in ContentCreator

     

Download module file (.fsm)

The module file (file extension: .fsm) can be requested from Technical Support:

fragmentdap-[version].fsm

Installing the module

The module is installed using the FirstSpirit ServerManager, in the “Server properties / Modules” dialog using the “Install” button:

(For more information about installing modules, see also Modules (→Documentation for Administrators).)

Selection of fragments

If the module has been installed, the module can be addressed from the component for selecting fragments, FS_INDEX. This can be carried out in

  • FragmentCreator
  • ContentCreator
  • SiteArchitect

For information on configuring templates, see FS_INDEX component.
For information on how the editor can use the component, refer to Reference selection (INDEX).

The module also comes with a report that it produces in FirstSpirit SiteArchitect and FirstSpirit ContentCreator. From this report, the editor can use drag-and-drop to transfer fragments to an appropriately configured FS_INDEX component. In SiteArchitect, they can be transferred to the form, and in ContentCreator, to the open form or directly to the preview.

Editing / creating fragments (FragmentCreator)

If the FS_INDEX component is configured properly, referenced fragments in the FragmentCreator can also be edited and new ones created.

See also page Using fragments.

Editing fragments (ContentCreator)

Fragments and variants can be both referenced in ContentCreator and also edited from within ContentCreator. This can be done via the CXT platform's integration interface, which provides individual functions from the CXT world in the form of MicroApps that can then be used in other environments (here: in ContentCreator).

For this purpose, the “Fragment DAP for ContentCreator” web component must be added to the relevant project in the “ContentCreator” area (“FirstSpirit ServerManager / Project properties / Web components”):

(For more information on configuring web components, see also Web components (→Documentation for Administrators).)

Adapting the URL

The “Fragment DAP for ContentCreator” web component provides a configuration interface that can be opened by clicking on “Configure” or by double-clicking on the web component. The URL to the MicroApp must be configured. In this case, the URL is the one through which the CXT MicroApp API can be integrated into a website.

The URL is structured in line with the following schema:

http://<hostname>:<port>/<fragmentcreator-webapp>/microapps/api.js

<fragmentcreator-webapp> is the value that has been assigned in the “Id” field for the global web application for the “FragmentCreator” module (see also the page on configuring the FragmentCreator module and Web applications (→Documentation for Administrators)).

Example:

http://myServer:8080/fragments/microapps/api.js

The Fragment DAP integrates the URL, authenticates itself and retrieves the fragment MicroApp.

Display for the editor

An “Edit fragment” icon is displayed to the editor for all referenced fragments in ContentCreator.

Clicking on the icon opens the FragmentCreator form as a MicroApp in ContentCreator directly, where it can then be edited. Following this, the editor can close the (FragmentCreator) form. The changes are visible directly in ContentCreator.

Legend:

  1. Displays the referenced fragments or variants in ContentCreator.
  2. Displays the “Edit fragment” icon when you hover the mouse over it in ContentCreator.
  3. Clicking on the icon opens the FragmentCreator form as a MicroApp in ContentCreator directly.
  4. The contents of the fragment or variant can be edited. Changes are saved automatically.
  5. The changes made to the fragment or variant are displayed directly in ContentCreator.

As an alternative, fragments can also be edited from within the preview.
See also the Using fragments page.

© 2005 - 2020 e-Spirit AG | All rights reserved. | FirstSpirit 2020-09 | Data privacy | Imprint | Contact us