2017 R1 Update Rollup 1

Administration TasksPermanent link for this heading

Managing UsersPermanent link for this heading

For a user to log on to a Fabasoft Folio domain, a user object and desktop environment must first be created for the user.

Manage users in Domain Administration under User Objects on the “User” tab.

Note: Click “View” > “Refresh” to view the current object list.

Creating a UserPermanent link for this heading

In Domain Administration navigate to User Objects and click the “User” tab. Create a User object. Complete the following fields:

“User” tab

  • Active
    Only users marked as active can log on to the Fabasoft Folio domain. Deactivate any user no longer required.
    Caution: Do not delete any user objects that have already been used, but instead deactivate them to avoid any inconsistencies arising. For example, in all Fabasoft Folio objects, the field Created by refers to a user object. If this user object is deleted, the link can no longer be resolved.
  • Login Name
    Type the user names with which the user can log in (one user name per line). For example, enter the Microsoft Windows domain user name (e.g. domain1\username). The user name has to be unique and lower case only.
    Note: To enter a login name, which only exists locally on a workstation, add the prefix “:<name_of_local_computer>:\” to the user name. Note that colons must precede and follow the name of the local computer.
  • Title/First Name/Surname
    Enter first names and surnames in these fields as well as the user's title, where applicable.
    Note: The “Surname” field is mandatory.

“Environments” tab

There are two ways of allocating a desktop environment to a user.

  • Creating an environment from a template
    In the field Default Environment Template type an object of object class Environment Template. To create an Environment Template click “Create” to the right of the Default Environment Template field. Alternatively, define an Environment Template per Tenant.
    This creates a copy of the environment template when the user logs in for the first time. This copy is entered in the Environments field of the user object.
  • Creating an environment without template
    To create a desktop environment without using an environment template, select Environments and click “Create entry”.

You can find more information on the metadata in the chapter “Editing a User's Metadata”.

Assigning RolesPermanent link for this heading

You can assign different roles to any user (position in a group). Use the fields Position and Group to do this. Use roles and a corresponding access authorization concept to define user rights.

You can find more information on Roles in the chapter “Tab: User”.

Note:

  • The Must Use Role field defines whether a role assigned to a user is mandatory for the user.
  • Groups that are named when defining roles are automatically entered in the Member of field.

Editing a User's MetadataPermanent link for this heading

A user's metadata is distributed among the following tabs:

  • “User” tab
  • “Environments” tab
  • “Authentication” tab
  • “Advanced” tab

Tab: UserPermanent link for this heading

The “User” tab contains information on the user. It has the following fields:

  • Active
    Only users marked as active can log on to the Fabasoft Folio domain. Deactivate any user no longer required.
    Caution: Do not delete any user objects that have already been used, but instead deactivate them to avoid any inconsistencies arising. For example, in all Fabasoft Folio objects, the field Created by refers to a user object. If this user object is deleted, the link can no longer be resolved.
  • Login Name
    Type the user names with which the user can log in (one user name per line). For example, enter the Microsoft Windows domain user name (e.g. domain1\username). The user name has to be unique and lower case only.
    Note: To enter a login name, which only exists locally on a workstation, add the prefix “:<name_of_local_computer>:\” to the user name . Note that colons must precede and follow the name of the local computer.
  • Title/First Name/Surname
    Enter first names and surnames in these fields as well as the user's title, where applicable.
    Note: The “Surname” field is mandatory.
  • Abbreviation
    Enter an abbreviation for the user in this field.
  • Substitutions
    In this field you can create a user substitution.
  • Roles
    Assign roles to the user in this field.
    • Position
      Enter the user's positions.
      Example: Manager
    • Group
      For each position enter the group for which the user can assume the specified position.
      Example: Marketing
    • Function
      Enter a short description of the role.
    • Dispatch Clause
      Enter the text to be attached to a document created (signed) by this user.
    • Tenant
      Specify for which Fabasoft Folio client the user can assume the role. A Fabasoft Folio client refers to a subdomain within a Fabasoft Folio domain.
    • User Environment
      Specify which desktop environment should be used when the user switches to this role.
    • Default
      Specify which role the user assumes on opening a Fabasoft Client. If more than one role is defined as default, the first listed default role will be used.
  • Member of
    Enter the groups to which the user belongs. Groups for which roles are defined are automatically entered in this field.

Tab: EnvironmentsPermanent link for this heading

The “Environments” tab provides the following fields:

  • Environments
    Use this list to store multiple desktop environments for the user.
    Note: If the user is working in multiple Fabasoft Folio domains and this field contains desktop environments from the current Fabasoft Folio domain, the default desktop environment will be the first desktop environment of this Fabasoft Folio domain.
    • Environment
      Enter an object of the object class User Environment that this user can use. A login name is defined for each user environment.
    • Default
      Define whether the respective desktop environment should be the user's default environment.
  • Default Environment Template
    Enter an Environment Template. To create an environment template, click “Create”.
    The user's first login will create a copy of this environment template. This copy is entered in the Environments field of the user object.
  • Environment Template per Tenant
    Create a template for the user's desktop environment for each respective Fabasoft Folio client. Users working in multiple Fabasoft Folio clients will have a separate desktop environment for each specific Fabasoft Folio client. For entries in this field to be used, click “Yes” in the Automatically Create Environment in Tenant field.
    • Environment Template
      Enter the environment to be used as a template for a client-specific environment.
    • Tenant
      Enter the Fabasoft Folio client for which the template is to be used.
  • Automatically Create Local Environment
    Selecting “Yes” in this field means that, if a user is not working in his original Fabasoft Folio domain, a local desktop environment will be created for him in another Fabasoft Folio domain (i.e. not the desktop of his original Fabasoft Folio domain). This means that the desktop can be generated more quickly than when loaded from the user's Fabasoft Folio domain. The template for this desktop environment is stored in the Default Environment Template field. If no template has been entered, the template from the same field under Group will be used. If no template is defined here as well, it will not be possible to create a desktop environment.
  • Automatically Create Environment in Tenant
    Selecting “Yes” in this field means that an environment will be created automatically for the user at the Fabasoft Folio client where he is logged on. Create a template for this desktop environment using four fields. The following hierarchy applies for these:
    1. Environment Template per Tenant in the user object
    2. Environment Template per Tenant in the group object
    3. Default Environment Template in the user object
    4. Default Environment Template in the group object
  • Template Collections
    Create template collections in this field. The user can use templates from the template collection when creating objects in the Template Categories field.

Note: If both the Automatically Create Local Environment and the Automatically Create Environment in Tenant fields are activated, the former field will be ignored.

Tab: AuthenticationPermanent link for this heading

  • Tenants
    Specify in which Fabasoft Folio clients the user can work.
    • Tenant
      Enter a Fabasoft Folio client.
    • Default
      Specify in which Fabasoft Folio clients the user can work after logging in.
  • Used Products
    This field contains the software products used.
  • Used Workstations
    This field contains the Workstations where the user has already worked. The workstation name is the computer name.
  • Authorized Workstations
    Enter the workstations where the user can log in. The user will not be able to log in on other workstations, as identified by the Workstation Identification field of the workstation object.
    Note: A workstation object will be created automatically for each workstation where the user has worked at least once. A Workstation is defined by at least two values:
    • Workstation Type
      Enter the system environment to be used on the workstation.
    • Workstation Identification
      Enter the workstation's MAC address.

Tab: AdvancedPermanent link for this heading

The “Advanced” tab provides the following fields:

  • Must Use Role
    This field defines whether a role assigned to a user is mandatory for the user. If the user does not work in any role, the rights of all groups entered in the Member of field will apply.
  • Identification in Directory Service
    Enter the key value for user identification in the Directory Service (Microsoft Active Directory, LDAP).
  • List of Automated Tasks
  • Check License Locally
    Define here whether to always check the license locally for this user. This means that the user can log in even if cross-domain license verification is not available. A valid local license must be available for this to happen. If you select “Yes” in this field, you must enter at least one license in the Cached User Licenses field.
  • Cached User Licenses
    Enter the licenses that have been cached for the user. The user can use the licenses entered even if cross-domain license verification is not available.
  • E-Mail
    Enter the user's e-mail addresses. The following fields are provided for this:
    • Known Address Type
      Here you can select an address type.
      Example: “Internet” for an e-mail address with the format <name>@<domain>.<tld> or “facsimile” for fax numbers.
    • E-Mail Address
      Type an e-mail address or fax number.
    • Send RTF Content
      Select the check box to the right of the field to enable the user to send RTF documents from this address.

Deactivating a UserPermanent link for this heading

Deactivate any user object no longer required. Do not delete any user objects that have already been used to avoid any inconsistencies arising. For example, in all Fabasoft Folio objects, the field Created by refers to a user object. If this user object is deleted, the link can no longer be resolved.

  1. In Domain Administration navigate to User Objects and click the “User” tab.
  2. Open the respective user object in editing mode.
  3. Clear the check box to the right of the Active field to deactivate the user.

Managing Desktop EnvironmentsPermanent link for this heading

For a user to log in to a Fabasoft Folio domain, first create a user object and desktop environment.

The settings in the desktop environment are user-specific. The desktop environment defines the desktop and the environment language, among other things. If no desktop is defined, an instance of the object class defined in the Class of Desk Object field will be generated.

The user for whom this desktop environment is intended must be authorized to edit it. Enter this user as the desktop environment owner. As ACL for desktop environments, Fabasoft Folio provides ACL for User Environments.

Manage desktop environments in Domain Administration under User Objects on the “User Environments” tab.

Note: Click “View” > “Refresh” to view the current object list.

Creating a Desktop EnvironmentPermanent link for this heading

You can create desktop environments automatically or manually.

  • Create a desktop environment automatically
    Click the “Environments” tab of the user object and type an Environment Template in the Default Environment Template field. Create an environment template by clicking “Create” to the right of the Default Environment Template field.
    This will create a copy of the environment template when the user first logs on. This copy is entered in the Environments field of the user object.
  • Create a desktop environment manually
    To create a desktop environment manually, create an object of the object class User Environment.

You can find more information on the metadata in the chapter “Editing a Desktop Environment's Metadata”.

Creating a Desktop Environment AutomaticallyPermanent link for this heading

Click the “Environments” tab of the user object and type an Environment template in the Default Environment Template field. Create an environment template by clicking “Create” to the right of the Default Environment Template field.
This will create a copy of the environment template when the user first logs on. This copy is entered in the Environments field of the user object.

The following fields must be defined for a user environment:

  • Login Name
    Type your login name.
    Note: In individual users' User Environments their login names will entered automatically in this field.
  • Language
    Select a language.
  • Class of Desktop Object
    Specify a type of desktop for the user.
    Example: Desk, government office desk etc.
    Note:
    • Some portal pages can only be used if a government office desk has been created for the user.
    • If the Desktop Object field is left blank, all users will automatically be assigned a separate object of the object class you defined in the Class of Desktop Object field.
  • Portal
    Enter the portal which the user works with in this user environment. A portal provides portal pages.
    Example: “Default”, “Mobile Client” etc.

Note: The Events field should be left blank in the desktop environment template because this field will be completed automatically for the individual users. The same applies to the Desk Object field.

Creating a Desktop Environment ManuallyPermanent link for this heading

In Domain Administration navigate to User Objects and click the “User Environments” tab.

Create an object of the object class User Environment. The following fields must be defined for every new desktop environment:

  • Login Name
    Type the login name for the user for whom the desktop environment is intended.
  • Language
    Select a language.
  • Class of Desk Object
    Specify the type of desktop to be generated for the user.
    Example: Desk, government office desk etc.
  • Class of Desk Object
    Create an object of the desired object class. Object classes for Objects with Object List are available for this.
    Note:
    • Some portal pages can only be used if a government office desk has been created for the user.
    • If this field is left blank, an object of the object class defined in the Class of Desk Object will be entered automatically.
  • Portal
    Enter the portal which the user works with in this desktop environment. A portal provides portal pages.

The user for whom this desktop environment is intended must be authorized to edit it. Enter this user as the desktop environment owner. This is done in the desktop environment properties of the “Security” tab. The ACL for User Environments is used as ACL Object.

Editing a Desktop Environment's MetadataPermanent link for this heading

Use the following tabs to enter metadata for a User Environment:

  • “General” tab
  • “Localization” tab
  • “Search” tab
  • “Workflow” tab
  • “Advanced” tab
  • “Commonly Used” tab
  • “User Environment” tab

Tab: GeneralPermanent link for this heading

The “General” tab provides the following fields for entering metadata for a desktop environment:

  • Exit Confirmation
    Specify whether users are asked to confirm that they wish to exit Fabasoft Folio when they close their desktop. This provides the option for a user to close the desktop without exiting Fabasoft Folio.
  • Read Properties by Default
    This field defines whether an object is opened in read or edit mode, when opening it via the “Properties” command.
  • Open Documents Read-Only by Default
    This field defines whether an object is opened in read or edit mode, when opening it via a double click.
  • Show Only Symbols in Portal Page Selection
    This field defines, whether only symbols are displayed in the portal header. For example for portal pages only the symbol is displayed or the symbol and the name of the portal page is displayed.
  • Font Size
    Select a font size (“small”, “medium” or “large”). By default the font is displayed small.
  • Menu and Buttonbar
    This field defines, whether the menu, the buttonbar or both should be displayed in an object list. The menu or the buttonbar can also be hidden via the "View" button of an object list.
  • Slideshow Interval (in Seconds)
    This field defines after how many seconds a new picture is displayed within a slideshow.
  • Object Hints
    • Show
      Define whether tool tips are to be displayed.
  • Template Collections
    Create template collections in this field. The user can use templates from the template collection when creating objects in the Template Categories field.
  • Favorites
    Create a Template Collection, the objects of which will be displayed below the object class list in a separate area called “Favorites” when creating an object. This reduces the time needed when searching for frequently used templates.
  • Default Mailbox
  • Local RSS Feeds
    In this field objects can be defined, which should be available as RSS feeds for the user.
  • Favorite Folder (Taks)
    This property defines the user’s favorite folder.
  • User Calendar List
    This field defines the calendar list, which is used for the Fabasoft Integration for CalDAV.
  • E-Mail Settings
    • Use Formatted Text
      This property defines whether formatted text (HTML text) should be inserted into an e-mail when sending an object. If this property is set to “No”, HTTP links are inserted into the e-mail in plain text and not as HTML text. It is possible to insert the HTML text into the e-mail using the clipboard. This setting is only considered if Microsoft Office Outlook is used as default e-mail program on the client.
    • Open “E-Mail (Microsoft Office Outlook)” as
      For objects of the E-Mail (Microsoft Office Outlook) object class the content is stored in the Microsoft specific MSG format and additionally in the standardized MIME format. This setting defines in which format this e-mail object should be opened. Select “MIME (Internet Standard)” if E-Mail (Microsoft Office Outlook) objects should be opened, although there is no Microsoft Office Outlook installed on the client.
      Note: In case the content of the e-mail is not available in MIME format, the MSG content is opened.
    • Open “E-Mail (MIME)” with Microsoft Office Outlook
      This property defines whether e-mails, which are stored in MIME format, should be converted into the Microsoft specific MSG format when opening them. This enables the possibility to open E-Mail (MIME) objects with Microsoft Office Outlook by default.
      If this property is set to “No”, the e-mail is not converted into the MSG format and the default program for files in MIME format is opened. Usually this is not Microsoft Office Outlook, but e.g. Microsoft Outlook Express, Microsoft Live Mail, Mozilla Thunderbird or something like that.
      Note: In newer versions of Microsoft Office Outlook, files in MIME format can be opened directly without a conversion (see Microsoft Office Outlook option “/eml”). If Microsoft Office Outlook is defined as default for opening files in MIME format on the client, the conversion is not necessary. This setting is only considered if Microsoft Office Outlook is used as default e-mail program on the client.

Tab: LocalizationPermanent link for this heading

The “Localization” tab provides the following fields for entering metadata for a desktop environment:

  • Language
    Select a language.
  • Multilingual Input
    Specify whether multilingual entry is available.
  • Default Currency
    Select a default currency. This currency will be used for amounts entered by the user.
  • Disable Currency Sign
    This field defines whether or not the currency symbol for the default currency is displayed.
  • Reference Currency
    Assign a reference currency to the desktop environment. This can only be used in conjunction with a Conversion Table. A conversion table is used to convert between currencies.
  • Disable Reference Currency Sign
    This field defines whether or not the currency symbol for the reference currency is displayed.

Tab: SearchPermanent link for this heading

The “Search” tab provides the following fields for entering metadata for a desktop environment:

  • Extended Search for Object Pointer Properties
    This field defines whether the "Search" icon is displayed for object pointer properties. By default it is displayed.
  • Object Limit
    This field defines the maximum amount of the objects that can be found within a search.
  • Time Limit (sec)
    This field defines how much seconds a search can require.
  • Query Scope
    In this field a query scope can be defined. For example a query scope can be used to search in specific domains, COO Stores or COO Services.
  • Show Query Text
    This field defines, whether the “Edit Query” button is available when executing a search.
  • Show Search Options
    This field defines, whether the “Search Options” button is available when executing a search. This button provides further search options, that only apply within the current search.
  • Search Forms
    In this field search forms, which should be available for the user, can be defined.

Tab: WorkflowPermanent link for this heading

The “Workflow” tab provides the following fields for entering metadata for a desktop environment:

  • Activities for Current Role Only
    By default a user receives all activities, which regard him personally or one of his user roles. This field defines whether only activities for the user’s current role are shown in addition to the personal activities.
  • Use Working Days for Deadlines
    This field defines whether working days should be used for deadlines.
  • Use Advanced Mode for Participants per Default
    This field defines whether the advanced view is used by default for the participants within a prescription. If this property is “Undefined” the advanced view is used.
  • Use Advanced Mode for Prescriptions per Default
    This field defines whether the advanced view for prescriptions is used. If this field is “Undefined” the simple view is used. For switching the views directly within a prescription the “Advanced View” and “Simple View” buttons are available.
  • Workflow Preferences
    The selected object influences various fields in the workflow, like user, organizational units and distribution lists when forwarding.
  • Workflow Notifications
    Using this field, workflow notifications can be influenced.

Tab: AdvancedPermanent link for this heading

The “Advanced” tab provides the following fields for entering metadata for a desktop environment:

  • Login Name
    Type the login name for the user for whom the desktop environment is intended.
  • Class of Desk Object
    Specify a type of desktop for the user.
    Example: Desk, government office desk etc.
  • Desk Object
    Create an object of the desired root object class. Object classes for objects with object list are available for this. The root object is the top object list, where the user can create other objects.
    Note:
    • Some portal pages can only be used if a government office desk has been created for the user.
    • If this field is left blank, an object of the object class defined in the Class of Desk Object will be entered automatically.
  • Portal
    Enter the portal which the user works with in this desktop environment.
  • User Profile
    In this field a user profile can be selected, to show or hide parts of the user interface (menus, buttons, forms, portals and object classes for creating or searching).
  • Available User Profiles
    In this field all user profiles, which are available for the user are displayed. If there are multiple user profiles available, the user can choose one of them.
  • Enable Domain Selection During Create
    The user can select the Fabasoft Folio domain in which the object is to be created.
  • Custom Task Panes, Toolbars and Menus
    Create an object of the object class User Interface Scoping Rule.
    A Fabasoft DUCX expression is defined in objects of the object class User Interface Scoping Rule to calculate the application area that is valid in each case. If the calculation of this Fabasoft DUCX expression returns a component object defined on object class level in the Scope field, the associated Root of Menu will become available as defined in the Menu field.
  • Upper Limits For “Most Recently Used”
    • Object Classes
      Specify the maximum number of object classes that will be prompted when creating objects, for instance.
    • Objects
      Specify the maximum number of objects available, for instance, in dropdown lists.
  • Days after Which a New Version is Automatically Created
    If an object has not been edited for the period of days defined here, a new version is automatically started the next time the object is edited.
  • Events
    Reference an object of the object class User Events.
    The object User Events stores a list of all events having taken place and information on the form in which the events are to be communicated to the user.
  • Print Configuration
    • Printers
      In this field the used printer can be selected or a new printer can be created.
    • Papers
      In this field the used papers can be selected.
  • Settings for Test Dispatch
  • Contact Folder
  • Synchronization Direction
  • Synchronize Contacts with Category
  • Synchronize Valid Contacts only
  • SAP Connection Information
  • Display Feedback Button
    This field defines whether a feedback button is displayed next to the "Help" icon.

Tab: Commonly UsedPermanent link for this heading

The “Commonly Used” tab contains all objects that the user used last.

Tab: User EnvironmentPermanent link for this heading

The “User Environment” tab provides the following fields for entering metadata for a desktop environment:

  • Show Error Message in Status Bar
    This field defines, whether an error message is displayed in the status bar.
  • Available Departments
  • Default Web Site
  • Default View Mode for CMS Objects
  • Show User Environment Instead of Default Website in CMS Portal
  • Added Users With Access Permissions
  • Send Interactive
  • Send Copy of Invitation to Me
  • Creation Mode Contracts
  • Current Document to Store
  • Settings for Branches
    Define whether or not specific branches such as buttons and links should be displayed in specific application views.
  • Fixed Color Scheme
    Select a color scheme to be used for all portal pages.
  • Compatibility Mode for Absolute Positioned Elements
    The compatibility mode is used for displaying a simplified HTML, so that third-party products (e.g. Screenreader) can work easier with it.
  • Recovery Information
    In this field all objects, which could not be recovered automatically, are listed. In the Reason column, the cause is displayed (the appropriate object could be locked by another user).
    Click "Show File in Folder" to execute further steps, for example importing the file manually.
  • Personalized Portal Parts
    If users add their own portal pages to their desktop environment (e.g. static URLs), these will be listed here.

Managing User SubstitutionsPermanent link for this heading

To enable a user proxy for a user, create an object of the object class User Substitution on the “User Substitutions” tab of the user object.

Manage user substitutions in Domain Administration under User Objects on the “User Substitutions” tab.

Note: Click “View” > “Refresh” to view the current object list.

Creating a User SubstitutionPermanent link for this heading

In Domain Administration navigate to User Objects and click the “User Substitutions” tab.

Create an object of the object class User Substitution. Specify the following properties in the user substitution.

  • User
    This displays the user for whom this user substitution was created. Assign the user by entering the user substitution in the user object on the “User Substitutions” tab.
  • Common Substitute
    Define a general substitution for a user.
    • Substitute
      Enter a user to assume the substitution.
    • Start of Substitution
      Specify the date when the substitution is to start.
    • End of Substitution
      Specify the date when the substitution is to end.
    • Personal Substitution
      Specify whether the substitute can also edit those activities assigned personally to the original user (i.e. those not assigned to him by a role).

If you only specify a start date and no end date, the substitution will start on the date specified and end when the user ends the substitution.

If you only enter an end date and no start date, the substitution will commence immediately and expire on the end date specified.

If you do not specify either of these dates, the substitution will start immediately and can only be ended when the original user explicitly ends the substitution.

You can find more information on the metadata in the chapter “Editing a User Substitution's Metadata”.

Editing a User Substitution's MetadataPermanent link for this heading

A User Substitution has the following fields:

  • User
    This displays the user for whom this user substitution was created. Assign the user by entering the user substitution in the user object on the “User Substitutions” tab.
  • Common Substitute
    Define a general substitute for a user.
    • Substitute
      Enter a user to assume the substitute.
    • Start of Substitution
      Specify the date when the substitution is to start.
    • End of Substitution
      Specify the date when the substitution is to end.
    • Personal Substitution
      Specify whether the substitute can also edit those activities assigned personally to the original user (i.e. those not assigned to him by a role).
    • Remark
      Enter a remark.
    • Denied For Substitute
      List the access types not permitted to the proxy (during the period of proxy).
  • Roles with Substitute
    Specify for each role individually who assumes the substitution, when the substitution starts and ends, and what is permitted or not permitted to the substitute.
    • Position
      Enter the position to be substituted.
    • Group
      Enter the group in which the position is to be substituted.
    • Substitute
      Enter the user to assume the substitution for this role.
    • Start of Substitution
      Specify the date when the substitution is to start for this role.
    • End of Substitution
      Specify the date when the substitution is to end for this role.
    • Personal Substitution
      Specify for this role whether the substitute can also edit those activities assigned personally to the original user (i.e. those not assigned to him by his role, for example).
    • Remark
      Type a remark.
    • Denied For Substitute
      List the access types not permitted to the substitute (during the period of substitution) in this role.

If you only specify a start date and no end date, the substitution will start on the date specified and end when the user ends the substitution.

If you only enter an end date and no start date, the substitution will commence immediately and expire on the end date specified.

If you do not specify either of these dates, the substitution will start immediately and can only be ended when the original user explicitly ends the substitution.

Managing GroupsPermanent link for this heading

Manage groups in Domain Administration under User objects on the “Groups” tab.

Note: Click “View” > “Refresh” to view the current object list.

Creating a GroupPermanent link for this heading

In Domain Administration navigate to User Objects and click the “Groups” tab.

Create an object of the object class Group. The following fields must be defined for a group:

  • Active
    The group's default status is active. Deactivate any group object no longer required.
    Note: Deactivate any group object no longer required. Deleting a group object can cause inconsistencies to arise in the system.
  • Short Name
    Enter an abbreviation for the group (max. 60 characters).
  • Description
    Enter the group's name.
  • Organizational Unit Type
    Enter the structural unit for group.
    Example: Segment, department, area, section etc.
  • Default ACL for New Objects
    Create a default ACL for objects (e.g. “department internal”) generated by a member of this group.
  • Positions Usable for Group
    Enter Positions that can be used within the group.

The group name will be generated automatically and has the structure <Short Name> (<Name>)

You can find more information on the metadata of a group in the chapter “Editing a Group's Metadata”.

Editing a Group's MetadataPermanent link for this heading

A Group has the following fields:

  • Active
    The group's default status is active. Deactivate any group object no longer required.
    Note: Deactivate any group object no longer required. Deleting a group object can cause inconsistencies to arise in the system.
  • Short Name
    Enter an abbreviation for the group (max. 60 characters).
  • Description
    Enter the group's name.
  • Login Name
    Enter the login name of the corresponding group in the directory service. When a new user of the network domain (user in a Microsoft Active Directory or LDAP directory), who is a member of a corresponding user group, logs in to the Fabasoft Folio domain, a corresponding user object and desktop environment will be created in Fabasoft Folio. Define the object class for the newly created user in the field Object Class for Created Users.
  • Subgroups
    Enter Groups subordinate to this group.
    Note: This field automatically contains those Groups subordinate to the current group.
  • Supergroups
    Enter here Groups superordinate to this group.
    Note: This field automatically contains those Groups superordinate to the current group.
  • Organizational Unit Type
    Enter Organizational Unit Types to which the group belongs.
  • Members
    This field defines all members of the group.
  • Restricted Role Administration
    If, for example, an administrator group is not superordinate to the entire organization, but only to a certain department, members of this administrator group will only be able to assign roles to users of the respective department or its subordinate departments. Click “Yes” for this restriction to apply.
  • Default ACL for New Objects
    Create a default ACL for new objects (e.g. “department internal”).
  • ACL Objects
    If ACL objects are entered in this field, no other predefined ACL objects from the “Security” tab will be available for selection for objects of this group.
  • ACL Assignments
    Specify which group will be entered as an object's Group in the case of an ACL change to the object. The choice of group is governed by the assignment of groups to ACLs.
  • Group Substitutions
    Create an object of the object class Group Substitution. In a Group Substitution you can specify another group to exercise a substitution on behalf of this group for a defined period of time. During this period, members of the substitution group become members of the substituted group. You can restrict the rights of the substitution group.
  • Substituted Groups
    This field displays the substituted Groups.
  • Object Class for Created Users
    Create an object class (e.g. User) to be used as a template for the automatic creation of a user object. The automatic creation of a user is described in the explanations to the field Login Name.
  • Default Environment Template
    Create a User Environment. This will serve as a template if a desktop environment is to be automatically created for a group member.
    Note: If a desktop environment also exists in the Default Environment Template field of the user object, two environments will be created. The environment created from the user object template will automatically be the default environment.
  • Environment Template per Tenant
    Create a client-specific desktop environment template for users belonging to the group. Users working in multiple Fabasoft Folio clients will have a separate desktop environment for each specific Fabasoft Folio client.
    • Environment Template
      Enter the desktop environment to be used as a template for a client-specific environment.
    • Tenant
      Enter the Fabasoft Folio client for which the template is to be used.
  • Default Position Template
    Enter a Position to be used as a default for automatically created users.
  • Default Display View Settings
    Create default column settings. The objects entered can be selected by the group's members by performing a search in the Default Display View Settings field.
  • Template Collections
    Create template collections in this field. The user can use templates from the template collection when creating objects in the Template Categories field.
  • E-Mail
    Enter the group's e-mail addresses. The following fields are provided for this:
    • Known Address Type
      Here you can select an address type.
      Example: “Internet” for an e-mail address with the format <name>@<domain>.<tld> or “facsimile” for fax numbers.
    • E-Mail Address
      Type an e-mail address or fax number.
    • Send RTF Content
      Select the check box to the right of the field to enable the group members to send RTF documents from this address.
  • Portal
    Enter a Portal for use when a User Environment is automatically created for a group member and no Portal has been created in the template for the desktop environment. It makes no difference whether the template is created in the Group or in the User.

Managing WorkstationsPermanent link for this heading

An object of the object class Workstation is automatically created for each workstation used. It is assigned the workstation's MAC address.

Use workstation objects to specify which workstations are available to individual users. Enter authorized Workstations in the Authorized Workstations field in the user object.

Manage workstations in Domain Administration under User Objects on the “Workstations” tab.

Note: Click “View” > “Refresh” to view the current object list.

A Workstation provides following fields:

  • Name
    The name of the work station.
  • Workstation Type
    The workstation's system environment.
  • Workstation Identification
    The workstation's MAC address.
  • Frontend Server
    Specifies whether the workstation acts as a frontend server (Fabasoft Folio Webserver).
  • Number of CPUs
    The number of available processors on the workstation.
  • Number of CPU Cores
    The number of CPU cores on the workstation.
  • Used Products
    The Fabasoft software products used on the workstation.
  • Cached Workstation Licenses
    Cached Software Product Licenses are used for a cross-domain license verification.

Managing ACLsPermanent link for this heading

An ACL (Access Control List) is a list of Access Control Entries (ACE - access authorization). ACLs define access rights to Fabasoft Folio objects for domains, structural units, groups and positions or users. An ACL is assigned to every Fabasoft Folio object (even ACL objects).

Manage ACLs in Domain Administration under User Objects on the “ACLs” tab.

Note: Click “View” > “Refresh” to view the current object list.

Creating an ACLPermanent link for this heading

In Domain Administration navigate to User Objects and click the “ACLs” tab.

Create an object of the object class ACL. Complete the following fields for an ACL:

“ACL Objecttab

  • Multilingual Name
    Enter a name for the ACL.
  • ACL Entries
    To create a new entry, click “Create entry”. Specify the following for each entry:
    • Domains
      Select a Fabasoft Folio domain to which the ACL entry will apply (e.g. owner's domain), or the entry “(All domains)”.
    • Organizational Unit Types/Groups
      Select a structural unit or group to which the ACL entry will apply, or the entry “(All)”.
      Click (next to the dropdown list) to select from the following options:
      • (and superordinate groups)
        The ACL entry applies to the group or structural unit selected and its organizationally superordinate group or structural unit.
      • (and subordinate groups)
        The ACL entry applies to the group or structural unit selected and its organizationally subordinate group or structural unit.
      • (if superordinate to the group of the object)
        The ACL entry applies to the group or structural unit selected that is superordinate to the object's owner group.
      • (if subordinate to the object's group)
        The ACL entry applies to the group or structural unit selected that is subordinate to the object's owner group.
    • Positions/User
      Select a specific position or user for which the ACL entry applies, or the entry “(All)”.
    • Access Types
      Select those Access Types (e.g. Create object), which are to be available to the specified users.
      The following access classes are available by default:
      • Create Object
      • Duplicate Object
      • Search for Object
      • Read Properties
      • Change Properties
      • Read Access Protection
      • Change Access Protection
      • Read Properties Relating to Access Protection
      • Change Properties Relating to Access Protection
      • Read Object List(s)
      • Change Object List(s)
      • Read Content(s)
      • Change Content(s)
      • Read Non Released Version
      • Read Audit Log
      • Archive Object
      • Destroy Object
      • See in Web
      • Execute Script
      • Read Administrative Properties
      • Change Administrative Properties
      • Run Application

Component Objecttab

  • Reference
    Specify a unique reference for the ACL.
  • Software Component
    Choose a hardware component to which the ACL is assigned.
    Note: You can only choose software components with the status “Under development”.

Managing PositionsPermanent link for this heading

Every Organizational Unit Type (e.g. “Department”) is assigned various Positions (e.g. “manager”, “processor” or “secretary”) to be filled for the structural unit. Position and structural unit combine to form an abstract role in the organization.

Manage positions in Domain Administration under User Objects on the “Positions” tab.

Note: Click “View” > “Refresh” to view the current object list.

Creating a PositionPermanent link for this heading

In Domain Administration navigate to User Objects and click the “Positions” tab.

Create an object of the object class Position. Complete the following fields for a position:

“Position” tab

  • Multilingual Name
    Enter the position's name.

“Software Components” tab

  • Reference
    Specify a unique reference for the position.
  • Software Component
    Select a software component to which the position is assigned.
    Note: You can only choose software components with the status “Under development”.

You can find more information on the metadata in the chapter “Editing a Position's Metadata”.

Editing a Position's MetadataPermanent link for this heading

A Position has the following fields:

  • Multilingual Name
    Enter the position's name.
  • Template Collections
    Create template collections in this field. Users assuming this position can use templates from the template collection when creating objects in the Template Categories field.

Managing Structural UnitsPermanent link for this heading

A structural unit defines an abstract company area. Every Organizational Unit Type (such as “Segment” or “Department”) has Positions to be filled. Organizational Unit Types are not stored hierarchically and Groups can belong to a number of structural units.

Structural units are managed in Domain Administration under User Objects on the “Organizational Unit Types” tab.

Note: Click “View” > “Refresh” to view the current object list.

Creating a Structural UnitPermanent link for this heading

In Domain Administration navigate to User Objects and click the “Organizational Unit Types” tab.

Create an object of the object class Organizational Unit Type. Complete the following fields for a structural unit:

Organizational Unit Type” tab

  • Multilingual Name
    Enter the structural unit's name.

“Software Components” tab

  • Reference
    Specify a unique reference for the structural unit.
  • Software Component
    Choose a software component to which the structural unit is assigned.
    Note: You can only choose software components with the status “Under development”.

You can find more information on the metadata in the chapter “Editing a Structural Unit's Metadata”.

Editing a Structural Unit's MetadataPermanent link for this heading

An Organizational Unit Type has the following fields:

  • Multilingual Name
    Enter the structural unit's name.
  • Positions
    Enter the Positions that can be used in this structural unit.
  • Template Collections
    Create template collections in this field. Users from this structural unit can use templates from the template collection when creating objects in the Template Categories field.

Managing DomainsPermanent link for this heading

Manage Fabasoft Folio domains and Fabasoft Folio clients in Domain Administration under Domain Objects on the “Domains” tab.

Note: Click “View” > “Refresh” to view the current object list.

Make settings for the entire Fabasoft Folio domain in the Current Domain. You can also configure individual software components in the active Fabasoft Folio domain, by referencing configuration objects for the respective software component in the active Fabasoft Folio domain.

If you require domain-specific or client-specific settings, create a separate configuration object for each individual Fabasoft Folio domain or client.

Editing a Current Domain's MetadataPermanent link for this heading

Use the following tabs to enter metadata for a Current Domain:

  • “System Configuration” tab
    Make settings for searches, document finalization etc. on this tab.
  • “Components Configuration” tab
    On this tab enter configuration objects for software components or products. These configuration objects allow the functionality of the respective components to be adjusted for a specific domain or a specific client.
  • “Domain” tab
    This tab contains basic data on the Fabasoft Folio domain.

Tab: System ConfigurationPermanent link for this heading

The “System Configuration” tab of the Current Domain has the following fields:

  • Enable 2-Phase Commit
    Set whether 2-Phase Commit is to be used for distributed transactions.
  • Enable Full Text Queries
    Define whether full text searches are to be supported. Full text queries require an index server to run on the server on which the Fabasoft Folio MMC Services are running. To enable full text queries, set this field to “Yes”. If no index server is available, the field must be set to “No”, otherwise any full text search will cause an error.
  • Enable Optimized Full Text Queries
    The default setting is for a full text search to first search the Fabasoft Folio database. It will subsequently also search index server catalogues where this database's objects are stored, but not the other index server catalogues. Define whether the search engine is to search the index server before the Fabasoft Folio database, in the case of a pure full text search (without any further restrictions on other properties).
  • Extend Full Text Queries to Archive Stores (Microsoft Index Server)
    Define whether a full text search will also search the archive.
  • Enable Queries With Starting ‘*’
    Define whether queries with a starting ‘*’ are supported.
  • Queries are Case-Insensitive
    Specify here whether upper/lower case is significant for local searches and server searches.
    Note: “Yes” means that the search will ignore upper/lower case.
  • Archived Versions Remain in Fabasoft Folio
    “Yes” means that the archive versions of archived objects and their contents will not be deleted from the Fabasoft Folio domain after archiving.
  • When Archiving Convert Content to Final Form
    “Yes” means that the object's content is converted to a final format (e.g. PDF) before being archived.
  • When Versioning Convert Content to Final Form
    “Yes” means that, on creating a new version of an object, the current version's content will be converted to a final format (e.g. PDF).
  • Format for Final Form
    Specify the file format for finalized contents.
    Example: PDF, TIF
  • Date/Time to Generate a Status Object per Workstation
    If a user logs in for the first time to a Fabasoft Folio domain after this date and no Status Information object exists for the user, an object of the object class Status Information will be created automatically. This object stores information on the user's workstation and environment (registry entries, operating system version etc).
  • Used Holidays and Time Intervals
    Create an object of the object class Holiday Table. Use the holiday table to enter non-working days, holidays and time periods.
  • Custom Task Panes, Toolbars and Menus
    Enter here a User Interface Scoping Rule. A Fabasoft DUCX Expression for calculating the applicable validity area is provided in this field (Expression To Compute The Current Scope field). This validity area enables menus, task interfaces and toolbars to be configured, e.g. as role-specific.
  • Privileged Users
    Reference Users in the context of accessing Fabasoft Folio Services. The login name of these privileged users is specified during Fabasoft Folio Services installation.
  • Users in Tenant
    This field shows the Users for whom the Fabasoft Folio clients on which they work have been entered in the Tenants field. If Users have been entered in this field, for these Users the Current Domain will be entered automatically as a Fabasoft Folio client in the Tenants field.
  • Used Licenses
    Lists the Fabasoft software product licenses currently in use.
  • Cache- and UDP-Multicast-Protocol
    The Cache and UDP Multicast Protocol optimizes the Fabasoft Folio kernel cache behavior. The goal is to reduce the RPCs (Remote Procedure Call) necessary between server and client during read access to objects, if the object already exists in the client cache. To achieve this, Fabasoft Folio COO Service sends UDP Multicast packets to inform clients of any object modifications.
    Configure in this field whether or not the Cache and UDP Multicast Protocol is to be used. Also make settings for the Multicast address and the Multicast port.
    • Enabled
      Enable and disable the protocol.
    • Multicast Address
      Specify the Multicast address.
    • Port
      Specify the Multicast port.
  • Global Wastebasket
    Create an object of the object class Global Wastebasket. Clicking “Destroy” for an object will then only move it to the global recycle bin. As default setting, the Global Wastebasket is managed by administrators. The global wastebasket contains a separate object for each user and date, where the destroyed objects are located. The administrators are authorized to restore or permanently destroy objects in the global wastebasket.
  • Template Collections
    Enter templates (objects in Template Collections) that are available across domains. Templates are available for creating objects in the Template Categories area.
  • Print Configuration
    • Printers
      In this field the used printer can be selected or a new printer can be created.
    • Papers
      In this field the used papers can be selected.

Tab: Components ConfigurationPermanent link for this heading

The “Component Configuration” tab of the Current Domain has the following fields:

  • Templates Configuration
    Create an object of the object class Template Configuration.
  • LDAP Configuration
    Create an object of the object class Configuration Object for LDAP Directory Integration.
  • SMTP Configuration
    Create an object of the object class SMTP Configuration.
  • MIME Configuration
    Create an object of the object class MIME Configuration.
  • MAPI Configuration
    Create an object of the object class MAPI Configuration.
  • XML Configuration
    Create an object of the object class XML Default Configuration.
  • Digital Signature Configuration
    Create an object of the object class DigSig Configuration.
  • Web Service Configuration
    Create an object of the object class Web Service Configuration.
  • Administration Configuration
    Create an object of the object class Configuration Object.
  • Unstructured Documents Configuration
    Create an object of the object class Unstructured Documents Configuration.
  • Map Configuration
    Create an object of the object class Map Configuration.
  • Virtual Application Configuration
    Create an object of the object class Virtual Application Default Configuration.
  • Licensing Configuration
    Create an object of the object class Configuration Object for Licensing.

Tab: DomainPermanent link for this heading

The “Domain” tab of the Current Domain has the following fields:

Note: The Domain ID identifies the domain. The Domain ID is a unique label for each individual Fabasoft Folio domain. It comprises two numbers, the Major and Minor Domain ID, separated by a dot (e.g. 10.110).

  • Major Domain ID
    This field shows the Major Domain ID of the Fabasoft Folio domain. It is fixed by the software product license on installation of the Fabasoft Folio domain.
  • Minor Domain ID
    This field shows the Minor Domain ID of the Fabasoft Folio domain. It is fixed by the software product license on installation of the Fabasoft Folio domain.
  • Listening Port of Inbound Gateway
    Enter the port number of the Fabasoft Folio Inbound Gateway Services. This port is for establishing a connection with the Fabasoft Folio domain. The maximal length of the port number is 32 digits.
  • Network Addresses of Inbound Gateway
    Specify the network addresses for establishing a connection to the Fabasoft Folio Inbound Gateway Services.
    • Protocol
      Specify the protocol used for the server address (e.g. TCP/IP). Either “TCP/IP” or “IPX/SPX” can be entered. The value must be unique. The initialization value is “TCP/IP”.
    • Address
      Enter the protocol-specific server address. The maximal length of the address is 64 digits.
  • Directly Connected Domain
    When the Fabasoft Folio Kernel starts, it loads all connection information (e.g. Fabasoft Folio domains, Fabasoft Folio Services, Fabasoft Folio Stores and Fabasoft Folio Gateways) from all directly connected Fabasoft Folio domains. The connection must be two-way. This means that the referenced Fabasoft Folio domain must also contain an object for the connecting Fabasoft Folio domain, for which the value of this field is set to “Yes”. After loading, the Fabasoft Folio Kernel connects to all Fabasoft Folio Services of directly connected Fabasoft Folio domains, without using Fabasoft Folio Inbound or Fabasoft Folio Outbound Gateways.
  • Connect To Domain
    A Fabasoft Folio Outbound Gateway will create a connection to a Fabasoft Folio domain, if this Fabasoft Folio domain contains unique connection information (Listening Port of Inbound Gateway and Network Addresses of Inbound Gateway) or this field is set to “Yes”.
    If you set this field to “Yes”, the Fabasoft Folio Outbound Gateway will use information on service registration from the directory service (Microsoft Active Directory, LDAP), to establish a connection to the Fabasoft Folio domain. If the directory service contains no information, the Fabasoft Folio Outbound Gateway will use the connection information of the Fabasoft Folio domain.
  • Disable 2-Phase Commit for Outbound Connections
    Define whether the Microsoft Distributed Transaction Coordinator (MS DTC) is to be used for outgoing connections. Set the field to “Yes” to deactivate the MS DTC.
  • Default Routing Domain
    If a query to a specific Fabasoft Folio domain is sent to a Fabasoft Folio Outbound Gateway, the query will be forwarded to the Fabasoft Folio Inbound Gateway of the Standard Routing domain.
  • Cache Objects of Domain in Outbound Gateway
    Set this field to “No” for objects of this Fabasoft Folio domain not to be cached in the Fabasoft Folio Outbound Gateway.

Managing LicensesPermanent link for this heading

Manage Fabasoft Folio licenses in Domain Administration under Domain Objects on the “Licenses” tab.

Note: Click “View” > “Refresh” to view the current object list.

License objects cannot be edited.

A Software Product License contains information on Fabasoft Software Product Suites and Fabasoft Software Products that may be used with this license. It also contains information on:

  • Contract ID
    Contains the number of the contract on which this software product license is based.
  • Customer Name
    Contains the name of the organization for which this software product license was issued.
  • Person Responsible
    Contains the name of the customer employee responsible for Fabasoft software products.
  • Major Domain ID
    Contains the Major Domain ID assigned to the customer by the software product license.
  • Minor Domain ID
    Contains the Minor Domain ID assigned to the customer by the software product license.
  • Additional Domain IDs
    Contains further Domain IDs that the customer can use with this software product license.
  • Minimum Minor Domain ID for Tenant
    Contains the lowest number for the Minor Domain ID that can be used for additional Fabasoft Folio clients.
  • Maximum Minor Domain ID for Tenant
    Contains the highest number for the Minor Domain ID that can be used for additional Fabasoft Folio clients.
  • Type of Contract
    Contains the type of contract on which the software product license is based.
  • Date of Contract
    Contains the date on which the contract was signed.
  • Key Type
    Contains the type of license key.
    • “Test key”
      This key is only used for test installations. Test keys have an expiry date and a restricted number of MAC addresses that can be used.
    • “Production key”
      This key is used for productive systems. These keys have no expiry date and no restriction on the number of MAC addresses.
  • Expiration Date
    Shows the date when the software license expires.
  • Server Info
    Contains descriptions of the servers that can be used within this Fabasoft Folio domain.
  • Key
    Contains the registration key for this software product license.

Managing StoresPermanent link for this heading

Manage Fabasoft Folio Stores in Domain Administration under Domain Objects on the “Stores” tab.

Note: Click “View” > “Refresh” to view the current object list.

There are two sorts of Fabasoft Folio Stores:

  • Fabasoft Folio COO Store:
    Fabasoft Folio Component Object Stores (COO Stores) store metadata for objects. A Fabasoft Folio COO Store uses a Fabasoft Folio COO Service to store data.
  • Fabasoft Folio MMC Store:
    Fabasoft Folio Multimedia Content Stores (MMC Stores) store contents for objects (documents, spreadsheets, images etc.). A Fabasoft Folio MMC Store uses a Fabasoft Folio MMC Service to store data.

Besides Fabasoft Folio Stores, Fabasoft Folio Outbound Gateways can also be managed. You can only create these in Fabasoft Folio Server Management.

Use a Fabasoft Folio Outbound Gateway

  • to access objects of other Fabasoft Folio domains (through communication with the Fabasoft Folio Inbound Gateways of the foreign Fabasoft Folio domains) and
  • to store component objects not created in the local Fabasoft Folio domain. Component objects are objects created when installing software components.

The Fabasoft Folio Outbound Gateways are also divided into Fabasoft Folio COO Outbound Gateways and Fabasoft Folio MMC Outbound Gateways. Fabasoft Folio COO Outbound Gateways support communication with other Fabasoft Folio domains. The contents of the replicated component objects are stored in Fabasoft Folio MMC Stores.

Creating a Fabasoft Folio COO StorePermanent link for this heading

In Domain Administration navigate to Domain Objects and click the “Stores” tab.

Create an object of the object class COO Store. Specify the following fields for a COO Store.

“COO Store” tab

  • COO Service
    Select a Fabasoft Folio COO Service to be used by the Fabasoft Folio COO Store for storage.
  • Default MMC Store
    Each Fabasoft Folio COO Store requires a Fabasoft Folio MMC Store, and this is defined in this field.

You can find more information on the metadata in the chapter “Editing a Fabasoft Folio COO Store's Metadata”.

Editing a Fabasoft Folio COO Store's MetadataPermanent link for this heading

A COO Store has the following fields:

  • COO Store Active
    Deactivate any Fabasoft Folio COO Store no longer in use. Do not delete any COO Store object.
  • COO Store Number
    This number is automatically assigned to the store being created. The first Fabasoft Folio COO Store is assigned the number “1”. The number cannot be changed.
  • COO Service
    Each Fabasoft Folio COO Store requires a Fabasoft Folio COO Service. Fabasoft Folio COO Services are generated when setting up a Fabasoft Folio domain or in the Fabasoft Folio Server Management. Manage Fabasoft Folio COO Services in the Fabasoft Folio Server Management.
  • Indexing Service
    Specify any indexation service configured. The Fabasoft Folio COO Store is indexed according to the settings of the indexation service.
  • Default MMC Store
    Assign a Fabasoft Folio MMC Service to the Fabasoft Folio COO Store.
  • Maximum Number of Versions Kept
    Enter the largest number of versions that an object can have. The oldest version will be deleted if this number is exceeded.
  • Days after Which Older Versions are Automatically Destroyed
    Specify how long an older version is to be stored. On this time expiring, the version will be deleted.

Creating a Fabasoft Folio MMC StorePermanent link for this heading

In Domain Administration navigate to Domain Objects and click the “Stores” tab.

Create an object of the object class MMC Store.

“MMC Store” tab

  • MMC Service
    Select a Fabasoft Folio MMC Service to be used by the Fabasoft Folio MMC Store for storage.

You can find more information on the metadata in the chapter “Editing a Fabasoft Folio MMC Store's Metadata”.

Editing a Fabasoft Folio MMC Store's MetadataPermanent link for this heading

An MMC Store has the following fields:

  • MMC Store active
    Deactivate any Fabasoft Folio MMC Store no longer in use. Do not delete any MMC Store object.
  • MMC Store Number
    This number is automatically assigned to the Fabasoft Folio MMC Store being created. The first Fabasoft Folio MMC Store is assigned the number “1”. The number cannot be changed.
  • MMC Service
    Fabasoft Folio MMC Services are created when setting up a Fabasoft Folio domain or in the Fabasoft Folio Server Management. Manage Fabasoft Folio MMC Services in the Fabasoft Folio Server Management.
  • Archive Configuration
    • Object Class
      Define the object classes the objects of which are to be archived.
    • Archive Store
      Define in which Archive Store the objects are to be archived.
    • Alternative Archive Store
      Define in which Archive Store objects are to be archived if the main archive store is not available.
    • Archive Store for Versions
      Define in which Archive Store older version of objects are to be archived.
    • Alternate Archive Store for Versions
      Define in which Archive Store older versions of objects are to be archived if the main archive store for object versions is not available.
    • Retention Period in Years
      Specify the minimum length of time for which the objects are to remain archived.
    • Retention Period for Versions in Years
      Specify the minimum length of time for which the older versions of objects are to remain archived.

Editing a Fabasoft Folio COO Outbound Gateway's MetadataPermanent link for this heading

A COO Outbound Gateway has the following fields:

  • COO Outbound Gateway Active
    Deactivate any Fabasoft Folio COO Outbound Gateway no longer in use. Do not delete any COO Outbound Gateway objects.
  • COO Outbound Gateway Number
    This number is automatically assigned to the Fabasoft Folio COO Outbound Gateway being created. The first Fabasoft Folio COO Outbound Gateway is assigned the number “1”.
  • COO Service
    The value in this field cannot be changed. A Fabasoft Folio COO Outbound Gateway is assigned to a Fabasoft Folio COO Service. The assignment takes place when installing the Fabasoft Folio domain or creating a Fabasoft Folio COO Service in the Fabasoft Folio Server Management.
  • Default Gateway
    Define whether to use the Fabasoft Folio COO Outbound Gateway as default gateway. To use this Fabasoft Folio COO Outbound Gateway as default gateway set this field to “Yes”.
  • Domains
    In this object list you can assign the Fabasoft Folio COO Outbound Gateway to different Fabasoft Folio domains.
  • Default MMC Store
    Assign a COO Outbound Gateway to the Fabasoft Folio MMC Service.
  • Maximum Number of Versions Kept
    Enter the largest number of versions that an object can have. The oldest version will be deleted if this number is exceeded.
  • Days after Which Older Versions are Automatically Destroyed
    Specify how long an older version is to be stored. On this time expiring, the version will be deleted.

Editing a Fabasoft Folio MMC Outbound Gateway's MetadataPermanent link for this heading

An MMC Outbound Gateway has the following fields:

  • MMC Outbound Gateway Active
    Deactivate any Fabasoft Folio MMC Outbound Gateway no longer in use. Do not delete any COO Outbound Gateway objects.
  • MMC Outbound Gateway Number
    This number is automatically assigned to the Fabasoft Folio MMC Outbound Gateway being created. The first Fabasoft Folio MMC Outbound Gateway is assigned the number “1”.
  • MMC Service
    The value in this field cannot be changed. A Fabasoft Folio MMC Outbound Gateway is assigned to a Fabasoft Folio MMC Service. The assignment takes place when installing the Fabasoft Folio domain or creating a Fabasoft Folio MMC Service in the Fabasoft Folio Server Management.
  • Default Gateway
    Define whether to use the Fabasoft Folio MMC Outbound Gateway as default gateway. To use this Fabasoft Folio MMC Outbound Gateway as default gateway set this field to “Yes”.
  • Domains
    In this object list you can assign the Fabasoft Folio MMC Outbound Gateway to different Fabasoft Folio domains.

Managing ServicesPermanent link for this heading

Manage Fabasoft Folio Services in Domain Administration under Domain Objects on the “Services” tab.

Note: Click “View” > “Refresh” to view the current object list.

It is not possible to create objects of object classes COO Service or MMC Service at the desktop. These object classes are abstract. Service objects are created automatically when using the Fabasoft Folio Server Management to create a Fabasoft Folio Service.

Editing a Fabasoft Folio COO Service's MetadataPermanent link for this heading

Use the following tabs to enter metadata for a Fabasoft Folio COO Service:

  • “COO Service” tab
  • “Information” tab
  • “Tables” tab
  • “Service” tab

Tab: COO-ServicePermanent link for this heading

The “COO Service” tab provides the following fields:

  • Primary COO Service
    The Fabasoft Folio COO Service with instance number “1” is always the primary Fabasoft Folio COO Service. You can view the instance number in the Fabasoft Folio Server Management. This field cannot be edited. The network addresses of the other Fabasoft Folio Services are obtained from the primary Fabasoft Folio COO Service.
    Note: All Fabasoft Folio Service objects are stored in the primary Fabasoft Folio COO Service.
  • Database Name
    Enter the identifier the Fabasoft Folio COO Service uses to identify the database.
    • Microsoft SQL Server: Name of database
    • Oracle: Oracle SID / TNS Name
  • Database is Read Only
    Define whether the Fabasoft Folio COO Service can write to the database. For Fabasoft Folio COO Service to write to the database, set this field to “No”.
  • Object Cache Parameter
    • Maximum Cache Size (MB)
      Defines the maximum cache size in megabyte. The default value is 5000.
  • Additional Database Parameters
    Create additional parameters for the Fabasoft Folio COO Service. These parameters can be used, for example, for debugging purposes.
    • Parameter Name
    • Parameter Value

Tab: InformationPermanent link for this heading

The “Information” tab has the following fields:

  • COO service information
    • Number of objects
      Contains the number of objects stored in the Fabasoft Folio COO Stores that are served by this Fabasoft Folio COO Service.
    • Number of Object Versions
      Contains the number of all object versions stored in the Fabasoft Folio COO Stores that are served by this Fabasoft Folio COO Service.
    • Object IDs in COO Stores
      This list contains all Fabasoft Folio COO Stores that use this Fabasoft Folio COO Service.
      • COO Store: Contains the Fabasoft Folio COO Store.
      • Next Object ID: Shows which object address will be assigned to the next Fabasoft Folio object created in this Fabasoft Folio COO Store.
      • Available Object IDs: Displays how many object addresses are available in this Fabasoft Folio COO Store. IDs of destroyed Fabasoft Folio objects may not be reused.
    • Used in Bootstrap Query
      Displays whether component objects are queried again on starting the Fabasoft Folio COO Service. The value in this field is defined by the Fabasoft Folio Kernel and cannot be changed by users.
    • Stored Object Classes
      This list displays the object classes of the objects stored in Fabasoft Folio COO Stores and served by this Fabasoft Folio COO Service.
  • Object Cache Information
    • Maximum Cache Size in MB
      Displays the maximum cache size for the Fabasoft Folio COO Service.
    • Current Cache Size in MB
      Displays the current cache size for the Fabasoft Folio COO Service.
    • Number of Currently Cached Objects
      This field displays how many Fabasoft Folio objects are currently cached in this Fabasoft Folio COO Service.
    • Number of Hits
      Displays how often Fabasoft Folio objects have been found in and loaded from the cache.
    • Number of Misses
      Displays how often Fabasoft Folio objects were not found in the cache.
    • Object Refreshes
      Displays how often Fabasoft Folio objects in the cache were refreshed. The figure is calculated from the point-in-time of the last emptying of the cache and its subsequent default stocking. The cache is refreshed each time that Fabasoft Folio COO Services is started.
  • Database Information
    • Size of Database in KB
      Displays the kilobytes of memory taken up by the database assigned to this Fabasoft Folio COO Service. This value can be larger than the memory actually needed by the Fabasoft Folio objects, since the size is defined when the database is created.
    • Reserved Space in Database in KB
      Displays in kilobytes how much memory is reserved in the database assigned to this Fabasoft Folio COO Service. This reserved memory is not used for database entries.
    • Used Space in Database in KB
      Displays in kilobytes how much memory in the database assigned to this Fabasoft Folio COO Service is actually used by database entries.
    • Last Update of Statistics
      Displays when the database statistics were last updated. If the dates of last updates differ from table to table within the database, this field will display the earliest date.
    • Last Backup
      Displays when the last database backup was made.
    • Database Version
      Displays the database version currently in use.
    • Database Server Instance
      Displays the name of the server on which the database is located.
    • Database Name
      Displays the name of the database assigned to the Fabasoft Folio COO Service.
  • Locking Information
    • Locked Objects
      Displays how many Fabasoft Folio objects of this Fabasoft Folio COO Service are currently blocked. For example, an object is blocked when its metadata is being edited. The block will be lifted when
      • metadata editing is finished, or the attribute editor is closed.
      • 8 minutes have passed since blocking, if the attribute editor has not been correctly closed.
      • an administrator removes the entry from the database.
    • Maximum Number of Locked Objects so far
      Displays the maximum number of Fabasoft Folio objects that have been blocked at any one time.
  • Pending Configuration Updates
    Displays whether synchronization of information on object classes and communication settings for Fabasoft Folio Gateways between Fabasoft Folio Services is pending. By default, synchronization takes place immediately on starting the Fabasoft Folio COO Service. Subsequently synchronization is conducted every 60 minutes.
    Creating new object classes (e.g. when installing Fabasoft software components) also requires synchronization. Installing a Fabasoft software component creates a number of identical synchronization tasks. A timeout of 60 seconds is defined to avoid processing identical tasks simultaneously. This timeout will be restarted each time that a pre-existing task is created. This means that synchronization is implemented 60 seconds subsequent to the last task being created.

Tab: TablesPermanent link for this heading

The “Tables” tab provides the following fields:

  • Service Definitions
    Assign Service Table Definition to the Fabasoft Folio COO Service. In Service Table Definition define which properties of an object class or a composite property are to be stored in a separate table in this Fabasoft Folio COO Service.
  • Database Table Definitions
    Contains a list of relationalized tables for this Fabasoft Folio COO Service. These tables were created during installation of the Fabasoft Folio domain. No Service Table Definition exists for these tables.
    • Compound Type/Object Class
      Displays the composite type (or the object class) for which a separate table exists.
    • Table/External Name
      Suggest a name for the table. The character string contained in this field will be automatically modified where necessary.
      • Table names have the prefix “fsc”.
      • The name will be checked for conformity with the syntactic rules of the relevant database system. Special characters are substituted by “_”.
      • No SQL key words can be used.
    • Defined Table State
      Displays whether the table is activated and therefore in use.
    • Table Properties
      Displays which properties are stored in the table.
    • Used by Properties
      Composite types can be used by different properties. This list references properties with data to be stored in the table of the composite type. If no composite properties are listed here, all properties using the composite type will be added automatically on storing.
  • Definitions of External Data
    Displays definitions of external tables. The definition can, for example, be used for accessing directory services' databases.
    In Definitions of External Data you define
    • which object class of data are to be stored in an external data source,
    • which key is to be used for accessing external data,
    • which properties in Fabasoft Folio take the value from the external data source and
    • where the external data is located in the external data source (e.g. in which column of a table of a relational database).
  • Class Hierarchy as Known by the Service
    This list displays all object classes together with the respective basis class from which objects in this Fabasoft Folio COO Service can be instanced and stored.

Tab: ServicePermanent link for this heading

The “Service” tab has the following fields:

  • Service Active
    Deactivate the Fabasoft Folio COO Service. Do not destroy any Fabasoft Folio COO Service.
  • Instance Number
    Displays the instance number of the Fabasoft Folio COO Service. The value is inserted automatically. The Fabasoft Folio COO Service with instance number “1” is always the primary Fabasoft Folio COO Service.
  • Version Number
    Displays the version number of the Fabasoft Folio backend services.
  • Number of Server Threads
    Define in how many server threads the Fabasoft Folio COO Service is to run. The larger the number of server threads, the more powerful the Fabasoft Folio COO Service. Too many server threads, however, will overload the server, thus reducing performance.
  • Server Name
    Specify the name of the server on which the Fabasoft Folio COO Service is to run.
  • Listening Port of Service
    Specify the port number of the Fabasoft Folio backend server where the Fabasoft Folio Kernel is to establish a connection to this Fabasoft Folio COO Service.
  • Network Addresses
    Specify the server name or IP addresses and transmission protocols where the Fabasoft Folio Kernel or the Fabasoft Folio COO Service can be reached.
  • Last Recovery of Service
    Displays when the Fabasoft Folio COO Service was last recreated.
  • Service Information
    Displays information on the current connection and operating status of the Fabasoft Folio COO Service.
    • Mode
      Displays the operating status of the Fabasoft Folio COO Service. “Normal operation” signifies that the Fabasoft Folio COO Service is available for queries. “COO Service <Name of Service> is not available” signifies that the Fabasoft Folio COO Service is not available (e.g. when the service is stopped). This value will be displayed in each field that takes its value directly from the Fabasoft Folio COO Service (e.g. fields on the “Information” tab).
  • Server Information
    • CPU
      Displays the processor architecture of the server on which this Fabasoft Folio COO Service runs.
    • Operating System
      Displays the operating system of the server on which this Fabasoft Folio COO Service runs.
    • Database System
      Displays the database system of the server on which this Fabasoft Folio COO Service runs.
    • Hardware ID of Server
      Displays the MAC address of the network card for the server on which this Fabasoft Folio COO Service runs.
    • Number of CPUs
      Displays how many CPUs are on the server that runs this Fabasoft Folio COO Service.
    • Physical Memory in KB
      Displays (in kilobytes) the total physical main memory of the server on which this Fabasoft Folio COO Service runs.
    • Physical Memory Used in KB
      Displays (in kilobytes) the total physical main memory of the server on which this Fabasoft Folio COO Service runs.
    • Virtual Memory of Process in KB
      Displays (in kilobytes) the virtual memory available on the Fabasoft Folio COO Service.
  • Additional Parameters
    Define additional parameters for the Fabasoft Folio COO Service. These parameters can be used, for example, for debugging purposes.

Editing a Fabasoft Folio MMC Service's MetadataPermanent link for this heading

Use the following tabs to enter metadata for a Fabasoft Folio MMC Service.

  • “MMC Service” tab
  • “Service” tab

Tab: MMC ServicePermanent link for this heading

The “MMC Service” tab provides the following fields:

  • Transaction Log
    Specify the directory for storing the log files for the 2-Phase Commit. If you change the value in this field, you must restart the Fabasoft Folio MMC Service.
  • MMC Service Areas
    Specify in the MMC areas the physical memory for the contents of multimedia objects. There must always be at least one writable Fabasoft Folio MMC area. Define in the Change Mode field whether a Fabasoft Folio MMC area is writable.
    • Name
      Specify the name of the Fabasoft Folio MMC area. You are free to choose any name.
    • Start Point (UTC)
      Define the date from which the Fabasoft Folio MMC area can be used.
    • End Point (UTC)
      Define the date up to which the Fabasoft Folio MMC area can be used.
      Note: There must be no gap between the End Point of the “old” Fabasoft Folio MMC area and the Start Point of a “new” Fabasoft Folio MMC area.
    • Type
      Specify how the folder structure should be constructed. The following options are available:
      • “One directory per day (Change date)”
        Storage follows the change date of the object, i.e. the file is stored in the directory where it was last changed. This storage structure is suitable for logging Fabasoft Folio MMC areas. Files are located in the directory <Directory on the server>\<Domain ID of MMC Store>\<Change date>. A separate directory is created for the year and the combination of month and day. Furthermore, a daily directory of this type contains up to 256 subdirectories.
        Note: This type is only permitted when logging mode is used.
      • “Content Addressed Storage (CAS)”
        Selecting this type of storage means that identical Contents (COOSYSTEM@1.1:contcontent) of different Fabasoft Folio objects will be only stored once in the Fabasoft Folio MMC area. This saves memory. CAS calculates a hash value for each content and then checks whether it already exists in the system. Only if this hash value does not exist will the content be stored. If the contents of an existing Fabasoft Folio object stored using CAS changes, CAS will calculate and store a new hash value for the changed content. The previous content will however not be destroyed. To delete contents no longer in use, run “Clean up areas with logging” for the respective MMC Service. All contents with hash values no longer assigned to a Fabasoft Folio objects will be deleted from the file system.
        The types “One directory per day (version date)”, “Compound files per day” and “One directory per version of object” are no longer supported for new Fabasoft Folio MMC areas, but remain available for existing Fabasoft Folio MMC areas.
        Note: You cannot change the type once files have already been stored in this Fabasoft Folio MMC area.
    • Change Mode
      Specify which actions can be run in this Fabasoft Folio MMC area. Choose from the following options:
      • “All operations”
        Select this option for active Fabasoft Folio MMC areas. Directory contents can then be read, written and deleted.
      • “Read only”
        Only select this option for Fabasoft Folio MMC areas with contents that may no longer be changed.
      • “Read and delete only”
        Only select this option for Fabasoft Folio MMC areas that should no longer be written to (e.g. because there is insufficient memory). It will then only be possible to read and delete contents.

        Note: Fabasoft Folio MMC areas which can or should no longer be written to, must be set to “Read only” or “Read and delete only” in Change Mode. This change must take place one day after the End Point (UTC) so that no inconsistencies arise when switching to a new Fabasoft Folio MMC area.
    • Log Changes
      Define whether all changes to files are to be logged.
    • Directory on Server
      Specify the directory in which multimedia contents are to be stored.
    • Backup Directory on Server
      Specify the directory in which backups for multimedia contents are to be stored. We recommend that you do not create the backup directory on the same physical data carrier.
      Note: Creating or changing a backup directory requires subsequent synchronization of registry entries using the Fabasoft Folio Server Management.
    • Path to Directory on Server
      Specify the UNC path to the directory of the Fabasoft Folio MMC area. When cleaning up the Fabasoft Folio MMC area the Fabasoft Folio Kernel uses this specified path instead of the local path.
    • Path to Backup Directory on Server
      Specify the UNC path to the backup directory of the Fabasoft Folio MMC area.
    • Backup Date (UTC)
      This field contains the date of the last backup. This date is referred to when cleaning up Fabasoft Folio MMC areas. File versions (not object versions!) older than the date in this field will be removed from the Fabasoft Folio MMC area when cleaning up. Only the most recent version of the file will be kept. If a backup directory has been defined and areas are to be backed up using the Fabasoft product functionality, the Backup Date (UTC) will be set automatically to the corresponding date each time “Create backup for areas” is called. You can also enter the value in this field manually.
    • Cleanup Date (UTC)
      Displays the date the last time the Fabasoft Folio MMC area was cleaned up. If logging mode is activated, each time a multimedia content is stored by an application (word processing program, table calculation etc.) a new file will be created in the Fabasoft Folio MMC area. Cleaning up removes the logged contents from the Fabasoft Folio MMC area. Only the most recent versions of the multimedia content are retained.
      Note: The object versions will not be deleted.
    • Cleaned Up Until (UTC)
      Displays the date up to which the Fabasoft Folio MMC area has been cleaned up. In the case of automatic clean-up, the date refers to the Backup Date (UTC). The most recent versions of multimedia content are not affected.
  • Information about MMC Service Areas
    Displays statistical information on the Fabasoft Folio MMC areas.
    • Name
      Displays the name of the Fabasoft Folio MMC area.
    • Device
      Displays the drive where the Fabasoft Folio MMC area is located.
    • Device Capacity in KB
      Displays (in kilobytes) the overall memory of this Fabasoft Folio MMC area.
    • Free Space in KB
      Displays (in kilobytes) the memory available on the drive where the Fabasoft Folio MMC area is located.
    • % Free Space
      Displays what percentage of the memory can still be used.

Tab: ServicePermanent link for this heading

The “Service” tab has the following fields:

  • Service Active
    Deactivate the Fabasoft Folio MMC Service. Do not destroy any Fabasoft Folio MMC Service.
  • Instance Number
    Displays the instance number of the Fabasoft Folio MMC Service. The value is inserted automatically.
  • Version Number
    Displays the version number of the Fabasoft Folio backend services.
  • Number of Server Threads
    Define in how many server threads the Fabasoft Folio MMC Service is to run. The larger the number of server threads, the more powerful the Fabasoft Folio MMC Service. Too many server threads, however, will overload the server, thus reducing performance.
  • Server Name
    Specify the name of the server on which the Fabasoft Folio MMC Service is to run.
  • Listening Port of Service
    Specify the port number of the Fabasoft Folio backend server where the Fabasoft Folio Kernel is to establish a connection to this Fabasoft Folio MMC Service.
  • Network Addresses
    Specify the server name or IP addresses and transmission protocols where the Fabasoft Folio Kernel or the Fabasoft Folio MMC Service can be reached.
  • Last Recovery of Service
    Displays when the Fabasoft Folio MMC Service was last recreated. If a Fabasoft Folio Service has been deleted, recreate it in the Fabasoft Folio Server Management by clicking “All Tasks” > “Recreate Service” in the Fabasoft Folio domain.
  • Service Information
    Displays information on the current connection and operating status of the Fabasoft Folio MMC Service.
    • Mode
      Displays the operating status of the Fabasoft Folio MMC Service. “Normal operation” signifies that the Fabasoft Folio MMC Service is available for queries. “MMC Service <Name of Service> is not available” signifies that the Fabasoft Folio MMC Service is not available (e.g. when the service is stopped). This value will be displayed in each field that takes its value directly from the Fabasoft Folio MMC Service (e.g. Information about MMC Service Areas).
  • Server Information
    • CPU
      Displays the processor architecture of the server on which this Fabasoft Folio MMC Service runs.
    • Operating System
      Displays the operating system of the server on which this Fabasoft Folio MMC Service runs.
    • Database System
      Displays the database system of the server on which this Fabasoft Folio MMC Service runs.
    • Hardware ID of Server
      Displays the MAC address of the network card for the server on which this Fabasoft Folio MMC Service runs.
    • Number of CPUs
      Displays how many CPUs are on the server that runs this Fabasoft Folio MMC Service.
    • Physical Memory in KB
      Displays (in kilobytes) the total physical main memory of the server on which this Fabasoft Folio MMC Service runs.
    • Physical Memory Used in KB
      Displays (in kilobytes) the total physical main memory of the server on which this Fabasoft Folio MMC Service runs.
    • Virtual Memory of Process in KB
      Displays (in kilobytes) the virtual memory available on the Fabasoft Folio MMC Service.
  • Additional Parameters
    Define additional parameters for the Fabasoft Folio MMC Service. These parameters can be used, for example, for debugging purposes.

Managing Definitions for ServicesPermanent link for this heading

Definitions for services (e.g. flattening tables) define access to external data sources (e.g. MAPI integration). Flattening causes certain object properties to be written to a separate table (relationalizing, table definitions). This functionality shortens search times for properties that are searched for on a frequent basis.

Content properties cannot be relationalized.

Manage definitions for services in Domain Administration under Domain Objects on the “Service Definitions” tab.

Note: Click “View” > “Refresh” to view the current object list.

Definitions for services are objects of the following object classes:

  • Stored Procedure for Named Transactions
  • Service External Data Definition
  • Service Data Source
  • Query Procedure
  • Service Table Definition

When installing definitions, new tables are created in the Fabasoft Folio databases for storing flattened properties or keys for external data sources, for example.

Definition of the Object Class: Stored Procedure for Named TransactionsPermanent link for this heading

“Named Transactions” are transactions which have been assigned a name. When using transaction tags, this name will be explicitly noted in the database server transaction log.

The Microsoft SQL server uses Named Transactions to restore multiple databases to a consistent status at the same point-in-time.

In Domain Administration navigate to Domain Objects and click the “Service Definitions” tab.

Generate an object of the object class Stored Procedure for Named Transactions.

It has the following fields:

  • Multilingual Name
    Enter a name for all languages used.
  • Install Immediately During Load
    Set to “Yes” to install this definition when loading the software components with Fabasoft Folio Server Management.
  • Installed Statements
    Enter an instruction for creating “Stored Procedures”. In the Database System field enter the database system to which the code in the Statement field applies. The instruction will not be written directly to the Fabasoft Folio domain, but imported as a file (e.g. text file).
  • Executed Statements
    Enter the instruction Fabasoft Folio uses to run the search procedure. In the Database System field enter the database system to which the code in the Statement field applies. The instruction will not be written directly to the Fabasoft Folio domain, but imported as a file (e.g. text file).
  • Statements to Uninstall
    Enter an instruction on uninstalling “Stored Procedures”. In the Database System field enter the database system to which the code in the Statement field applies. The instruction will not be written directly to the Fabasoft Folio domain, but imported as a file (e.g. text file).

Definition of the Object Class: Service Data SourcePermanent link for this heading

Service Data Sources are used by Fabasoft Folio COO Services to determine how a Fabasoft Folio COO Service will connect with an external data source.

In Domain Administration navigate to Domain Objects and click the “Service Definitions” tab.

Create an object of the object class Service Data Source.

It has the following fields:

  • Multilingual Name
    Enter a name for all languages used.
  • Parameters
    Define how a Fabasoft Folio COO Service is to connect with the external data source.
    • Parameter Type
      Define the type of parameter.
      Example: Driver
    • Parameter Value
      Define the parameter value.
      Example: ODBC
    • Software Component
      Create a software component. This prevents your configuration being overwritten by an update.
      Note: Only software components with the status 'Under development' are available here.

Definition of the Object Class: Query ProcedurePermanent link for this heading

Search procedures store configuration data that enable “Stored Procedures” to be used for searches. A “Stored Procedure” consists of a series of SQL commands, stored in compiled form in the database system. These can be used in the Fabasoft Folio domain to search for objects (e.g. if the users often run the same search query).

In Domain Administration navigate to Domain Objects and click the “Service Definitions” tab.

Create an object of the object class Query Procedure.

It has the following fields:

“Query Proceduretab

  • Usable for Object Class
    Enter the object class to which the search procedure applies.
  • Parameters
    Enter the properties valid for the search procedure.

Stored Proceduretab

  • Multilingual Name
    Enter a name for all languages used.
  • Install Immediately During Load
    Set to “Yes” to install this definition when loading the software components with Fabasoft Folio Server Management.
  • Installed Statements
    Enter an instruction for creating “Stored Procedures”. In the Database System field enter the database system to which the code in the Statement field applies. The instruction will not be written directly to the Fabasoft Folio domain, but imported as a file (e.g. text file).
  • Executed Statements
    Enter the instruction Fabasoft Folio uses to run the query procedure. In the Database System field enter the database system to which the code in the Statement field applies. The instruction will not be written directly to the Fabasoft Folio domain, but imported as a file (e.g. text file).
  • Statements to Uninstall
    Enter an instruction on uninstalling “Stored Procedures”. In the Database System field enter the database system to which the code in the Statement field applies. The instruction will not be written directly to the Fabasoft Folio domain, but imported as a file (e.g. text file).

Definition of the Object Class: Service Table DefinitionPermanent link for this heading

In Domain Administration navigate to Domain Objects and click the “Service Definitions” tab.

Create an object of the object class Service Table Definition.

It has the following fields:

  • Multilingual Name
    Enter a name for all languages used.
  • Install Immediately During Load
    Set to “Yes” to install this definition when loading the software components with Fabasoft Folio Server Management.
  • Requested Table State
    Select the table's status.
    • “Inactive”
    • “Create on the COO Service next starting”
    • “Active”
    • “Corrupt”
    • “Delete on the COO Service next starting”
    • “Change columns on the COO Service next starting”
  • Internal Tables
    • Compound Type/Object Class
      Displays the composite type (or the object class) for which a separate table exists.
    • Table/External Name
      Suggest a name for the table. The character string contained in this field will be automatically modified where necessary.
      • Table names have the prefix “fsc”.
      • The name will be checked for conformity with the syntactic rules of the relevant database system. Special characters are substituted by “_”.
      • No SQL key words can be used.
    • Defined Table State
      Displays whether the table is activated and therefore in use.
    • Table Properties
      Displays which properties are stored in the table.
    • Used by Properties
      Compound types can be used by different properties. This list references properties with data to be stored in the table of the composite type. If no composite properties are listed here, all properties using the composite type will be added automatically on storing.

ArchivesPermanent link for this heading

Manage archives in Domain Administration under Domain Objects on the “Archives” tab.

Note: Click “View” > “Refresh” to view the current object list.

You can find more information on the Fabasoft iArchive in the White Paper “Installation and Configuration of Fabasoft iArchive”.

Software ComponentsPermanent link for this heading

Software products consist of individual software components.

Note: The software components are located as COO files of the respective software products in the corresponding folder on the Fabasoft product DVD (Setup/<Software product>/Package).

Software components can be installed and updated not only using a software product, but also individually (in a Microsoft Windows system environment using the Fabasoft Folio Server Management or in a Linux system environment using the Fabasoft Folio Web Management).

Manage software components in Domain Administration under Domain Objects on the “Software Components” tab.

Editing the Metadata of a Fabasoft Folio Software ComponentPermanent link for this heading

The State of a Software Component determines whether specific fields are editable or are read-only.

The following tabs are available for a Software Component:

  • “Software Components” tab
  • “Online Help” tab

Tab: Software ComponentsPermanent link for this heading

The “Software Components” tab provides the following fields:

  • Reference
    Enter the reference (reference name) of the software component. The reference must be in upper case.
  • Version Number
    Enter the software component's version number.
  • Name
    Enter the full name of the software component.
  • State
    Enter the status of the software component in the development domain. Choose from the following states:
    • “Installed”
      All software components loaded to the Fabasoft Folio domain have this status. Only a few fields of these software components are editable.
    • “Under development”
      A software component is given this status when it is newly created in an Administration Tool. All the fields described here of a software component with this status are editable.
    • “Deleted”
      In this status, all fields described here are editable. The Fabasoft Folio domain, however, no longer uses the software component. The name of the software component takes the suffix “(Deleted)”
      Note: Setting the status of a software component to “Deleted” can cause conflicts to arise with its component objects.
  • Copyright
    Enter a copyright note.
  • Prerequisite Components
    Displays software components, parts of which are used by this software component. This information is important for the software component to be extracted correctly.
    Note: If you reuse software components, make sure that the required software components are genuinely necessary in the productive system for installing your software components there.
  • Extended Components
    Specify software components extended in the course of development.
    Note: Extensions are not checked during extraction. If you fail to specify an extended software component, the extensions will not be added to the Fabasoft Folio domain when installing the developed software component.
  • References of Optionally Extended Components
    Enter software components that will only be extended if they are installed in the Fabasoft Folio domain (such as Help components). The absence of these software components will have no negative effects on the function of the developed software components. This makes “for” instructions possible for optional software components.
    Note: You cannot enter a software component that is required (Prerequisite Components) or has been extended (Extended Components) as an optionally extended component.
  • Contents
    Enter files that this software component requires.
    • Base Name
      Enter the file name.
    • Language
      Enter the language if a different file is to be used for each language. Use this option for Help files, for instance.
    • Workstation Type
      Enter a value for the file to be transferred only to workstations of the corresponding workstation class.
    • Content Type
      Define how and when a file is transferred or loaded.
      Choose from the following options:
      • “Normal”
        The file will be loaded at setup by cooprep.exe or on first use of the software component.
      • “Delayed”
        The file will not be loaded by cooprep.exe but instead loaded at first use of the Fabasoft software component. Only use this option for software components deployed on a few workstations.
      • “Webserver file”
        The file will only be loaded if Fabasoft Folio is run in the context of the Microsoft Internet information service. These files will load when the Fabasoft Folio Kernel is started. Use this file type for controls in the Fabasoft web browser client, for instance. These controls will be registered on the server as COM objects.
    • Content
      Use this field to load a local file to the Fabasoft Folio domain.
    • Content Size (Bytes)
      Specifies the size of the file.
    • Last Change of Content
      Specifies when the file was last changed.
    • Extension of File
      Specify the extension that designates the file type.
    • OLE Identification
      Specify the program to be used to open this file.
  • Install Component Only When Needed
    Define whether software components will be installed together with the Fabasoft Client, or only when needed. Setting this field to “Yes” means that this software component will be omitted when installing the Fabasoft Client. The software component will then be installed when it is subsequently needed (e.g. when running an action). Setting this field to “No” means that this software component will be installed when installing or updating the Fabasoft Client.
  • Action to Install Component
    Enter the Fabasoft Folio action to be used for installing the software component. The action will be run at the workstation on starting setup. This Fabasoft Folio action can be called several times from the workstation. This makes it necessary for the Fabasoft Folio action to know whether or not it is being called for the first time.
    Note: The action will run in the context of the user currently logged on.
  • Action to Uninstall Component
    Enter the Fabasoft Folio action to be used for uninstalling the software component from the workstation.
    Note: The action will run in the context of the user currently logged on.
  • Additional Development Domains
    Specify additional Fabasoft Folio domains where this software component can be developed. You can change the status of the Fabasoft Folio domain from “Installed” to “Under development”.
  • Translations
    Enter the copyright notice in different languages.
    • Language
      Assign a language to the copyright notice.
    • Content
      Enter the copyright notice in the form of a file.
    • Content Size (Bytes)
      Specifies the size of the file.
    • Last Change of Content
      Specifies when the file was last changed.
    • Extension of File
      Specify the extension that designates the file type.
    • OLE Identification
      Specify the program to be used to open this file.
  • Component Objects To Be Prepared
    When installing or first calling the software component, the Action COOSYSTEM@1.1:ComponentObjectPrepare will be run for all objects entered in this list.
    Use this field for your software component's TypeLib-Object or for data source objects of the Fabasoft Folio/Data ODBC driver. The ComponentObjectPrepare method of a TypeLib-Object checks whether the TypeLib has already been registered on the local computer. If not, the registry will be updated. This check usually generates only slight overhead.
  • Upgrade Actions per Version
    Use this list to have object classes automatically adapted to a specific Fabasoft Folio version on upgrading.

Tab: Online HelpPermanent link for this heading

The “Online Help” tab provides the following fields:

  • Specific Helpfiles
    • Detail
      Select an Application View (e.g. FSCVENV@1.1001:ExploreAppView) for displaying the Help File.
    • Help File
      This field specifies the name of the CHM help file (e.g. help.chm).
    • Help Title
      Enter a language-specific heading for the Help.
  • More Help
    The Help of the software components specified here will be displayed if no entry exists in the Help of the current (edited) software components.

Software ProductsPermanent link for this heading

A Fabasoft Folio installation consists of software products, each of which provides functionality for specific areas. For example, the software product Fabasoft Folio/Base provides or enables basic functionality, Fabasoft Folio/AT does the same for automatic tasks.

Note: Software products are located on the Fabasoft product DVD in the setup directory each in a separate order (Setup/<Software product>/Package).

Software products can be installed or updated in a Microsoft Windows system environment using the Fabasoft Folio Server Management (“Start” > “Programs” > “Fabasoft Folio” > “Server Management”) or alternatively in a Linux environment using the Fabasoft Folio Web Management.

Manage software products in Domain Administration under Domain Objects on the “Software Products” tab.

Note: Click “View” > “Refresh” to view the current object list.

Editing the Metadata of a Fabasoft Folio Software ProductPermanent link for this heading

The State of a Software Product determines whether certain fields are editable or read-only.

The following fields are available for a Software Product:

  • Reference
    Enter the reference (reference name) of the software product. The reference is written as a string (one word with initial caps) and the prefix “Component”:
    Example: ComponentBase
  • Name
    Enter the full name of the software product. The name contains the prefix “Fabasoft Folio/”.
    Example: Fabasoft Folio/Base
  • Version Number
    Enter the software product's version number.
  • State
    Enter the status of the software product in the development domain. Choose from the following states:
    • “Under development
      This is the status of a software product when it is being created. In this status, all fields described here are editable.
    • “Installed”
      A software product that has been created and loaded to the Fabasoft Folio domain has this status.
  • Product Components
    This field contains all software components of the product.
  • References of Product Components
    This field contains all references of the product’s components.
  • References of Excluded Components and Products
    This field contains all references of components, which are not included in the product.
  • Copyright
    Enter a copyright note.
  • Copyright Bitmap
    • Content
      Specify the copyright notice in the form of a BMP file.
    • Content Size (Bytes)
      Specifies the size of the file.
    • Last Change of Content
      Specifies when the file was last changed.
    • Extension of File
      Specify the extension that designates the file type.
    • OLE Identification
      Specify the program to be used to open this file.

LanguagesPermanent link for this heading

English and German are the default languages available for multilingual fields. You can install additional languages using the software product Fabasoft Folio/LDK.

Note: The installation only enables multiple language selection for multilingual fields. The user interface will not be available in these languages.

Manage languages in Domain Administration under Domain Objects on the “Languages” tab.

Note: Click “View” > “Refresh” to view the current object list.

Creating a LanguagePermanent link for this heading

In Domain Administration navigate to Domain Objects and click the “Languages” tab. Create an object of the object class Language. The following fields must be defined for every new language:

  • Reference
    Enter the reference (reference name) of the language. The name must be unique and upper case and contain “_”. “LANG_” is the prefix for the reference for language objects.
    Example: LANG_GERMAN.
  • Language Name
    Enter the name of the language in English.

Editing a Language's MetadataPermanent link for this heading

A Language has the following fields:

  • Reference
    Enter the reference (reference name) of the language. The name must be unique and upper case and contain “_”. “LANG_” is the prefix for the reference for language objects.
    Example: LANG_GERMAN.
  • Language Name
    Enter the name of the language in English.
  • Default Language
    Define whether this language is used as default in the Fabasoft Folio domain.
  • Part of Language
    Select a superordinate language if the object being edited is a sublanguage.
  • Language IDs on Workstations
    Enter the language identifications of the operating systems used.
    Example: de.

Creating a SublanguagePermanent link for this heading

In Domain Administration navigate to Domain Objects and click the “Languages” tab. Create an object of the object class Language. The following fields must be defined for each new sublanguage:

  • Reference
    Enter the reference (reference name) of the language. The name must be unique and upper case and contain “_”. “SUBLANG_” is the prefix for the reference for language objects.
    Example: SUBLANG_GERMANAUT.
  • Language Name
    Enter the name of the language in English. Add the name of the country where this language is spoken in brackets.
    Example: German (Austria)
  • Part of Language
    Enter the superordinate language for this sublanguage.
    Example: German
  • Language IDs on Workstations
    Enter the language identifications of the operating systems used.
    Example: de - at

Query ScopesPermanent link for this heading

Query Scopes can be assigned to different object classes. This limits or expands searches for objects of this object class to specific Fabasoft Folio domains, Fabasoft Folio COO Stores and Fabasoft Folio Archive Stores.

Manage search areas in Domain Administration under Domain Objects on the “Query Scopes” tab.

Note: Click “View” > “Refresh” to view the current object list.

Creating a Query ScopePermanent link for this heading

In Domain Administration navigate to Domain Objects and click the “Query Scopes” tab. Create an object of the object class Query Scope. Define the following fields for each new query scope:

  • Reference
    Enter a unique reference (reference name) for the query scope. Write the reference name as a string (all one word with initial caps).
    Example: UserSubstitutionQuery
  • Software Component
    Enter a software component for the query scope. The query scope will be created on installing this software component.

Editing a Query Scope's MetadataPermanent link for this heading

A Query Scope has the following fields:

  • Multilingual Name
    Enter a name for all languages used.
  • Search All Known Domains
    Define whether the search covers all accessible Fabasoft Folio domains.
  • Domains Searched
    To limit the search, specify individual Fabasoft Folio domains to be searched.
  • COO Stores Searched
    Specify the Fabasoft Folio COO Stores to be searched.
  • Archive Stores Searched
    Specify the Fabasoft Folio Archive Stores to be searched.