1,126
edits
Difference between revisions of "Glossary"
Jump to navigation
Jump to search
→Terms Specific to Content Manager OnDemand
(Wholesale update, literally every single entry. Added IBM CMOD Cloud Storage S3 & AWS.) |
|||
| Line 95: | Line 95: | ||
== Terms Specific to Content Manager OnDemand == | == Terms Specific to Content Manager OnDemand == | ||
;Application | |||
: An Application is a defines a specific report or type or documents to Content Manager OnDemand. The definition include things like the format of the data (Line data, AFP, PDF, or an Image like JPEG / GIF / TIFF / PNG), how it should be displayed (code page for text, rotation of the page, or definitions for headers and columns in line data reports), and how CMOD should obtain the index metadata to load into the database - ACIF is the default Indexer for AFP and Line data, ARSPDOCI for the PDF indexer, or the Generic Indexer. ACIF and PDF indexers interpret the data inside the report itself, finding defined fields to create an index file with. The Generic Indexer, primarily used for graphic formats, or other types of data that can't be read directly, reads a formatted index file to collect the metadata. Applications must belong to an Application Group. | |||
;Application Group | ;Application Group | ||
: A Group of Applications. An Application Group ('AppGroup' or 'AG') defines index, storage management, retention, and expiration criteria. All Applications that belong to a specific Application Group will have the same fields for | : A Group of Applications. An Application Group ('AppGroup' or 'AG') defines index, storage management, retention, and expiration criteria. All Applications that belong to a specific Application Group will have the same metadata fields used for searching for documents, have their Application data managed in the same way (how long they are cached, and where they will be stored after the caching has expired), and expire in the same fashion. As implied by the name, an Application Group can contain more than one type of data - Applications can be defined for various types of data (for example AFP for customer statements, PDF for letters sent to customers, and TIFF images for scanning incoming mail from customers) but belong to a single Application Group -- making accessing all types of documents for a customer fast and easy. | ||
: Application Groups and Applications are usually structured to combine data with the same business use case (Customer Service, Human Resources, Accounts Payable, etc.), followed closely by the metadata, indexing, storage management, and disposition requirements. Defining an Application Group for each Application is not recommended -- binding too many Application Groups into a single folder negatively affects performance. | |||
;Folder | ;Folder | ||
: A Folder determines how the data inside Application Groups will be presented to the user. It allows | : A Folder determines how the data inside Application Groups will be presented to the user or a custom-built web application through the Java API. It allows an administrator to define search fields, the order that those fields appear in, any default values and/or required fields for searches, the fields that are displayed when a search is completed, and allows you to assign user-friendly names to index fields (like "Customer Number" rather than Cust_Num"). | ||
: Multiple Application Groups can be added to a single folder, allowing users to perform searches across multiple reports or data types with one search, although relying too heavily on this feature can lead to poor performance, as each query on the folder turns into many queries for each Application Group connected, and if a connected Application Group contains a large number of documents, it can further affect performance by performing one query per table. | |||
;Storage Set | ;Storage Set | ||
: A Storage Set connects Content Manager OnDemand to Tivoli Storage Manager ("TSM") for the purpose of long-term | : A Storage Set connects Content Manager OnDemand to storage nodes using a variety of storage technologies. Application Groups are required to have a Storage Set defined so that CMOD can manage the archived data. | ||
: Before IBM CMOD v9.5.0.6, Tivoli Storage Manager ("TSM") or Object Access Method ("OAM") were the only supported storage managers. Tivoli Storage Manager was popular on the Content Manager OnDemand for Multiplatforms systems, for the purpose of providing access to long-term archival storage devices like Magneto-Optical or WORM optical discs, tape libraries, or pools of hard disc storage. | |||
: Starting in Content Manager OnDemand v9.5.0.6, new Storage Set Types were supported, including Amazon Simple Storage Service ("S3"), Hadoop Distributed File System (HDFS), and OpenStack Swift. In IBM CMOD v10 and higher, Content Manager OnDemand supports IBM Cloud Object Storage, and Filesystem (aka Network-Attached-Storage or NAS). For more information about configuring IBM Content Manager OnDemand Cloud Storage, see [[ars.cfg#IBM_CMOD_Cloud_Storage_Options|IBM CMOD Cloud Storage Options]]. | |||
;Cabinet | ;Cabinet | ||
: A Cabinet is a group of folders. | : A Cabinet is a group of folders. | ||
: Cabinets are useful for providing easy access to a number of folders to users. In Content Manager OnDemand, cabinets are often created to help end users perform a specific job function where they need access to different types of data. | |||
: In the case of an employee of a Customer Service department, users may need access to monthly statements, correspondence, internal notes or call recordings which may be stored in different folders. In the case of an employee of a corporate Accounts Payable department, they may only need access to one folder, whereas an internal auditor may need access to Folders for Accounts Receivables, Accounts Payable, as well as Financial Reports, Inventory, and Human Resources. | |||
;Printer | ;Printer | ||
: A printer definition is used to provide access to server-side printing. | : A printer definition is used to provide access to server-side printing. Very few customers actually define these sorts of printers, instead choosing to redirect print jobs to electronic formats that can be displayed on computer monitors, smartphones and tablets. | ||
: In the context of IBM CMOD, printers are usually large industrial-scale laser printers fed by large spools of paper. | |||
: Historically, line data could be sent to large "chain printers" to produce reports on 'greenbar' paper. | |||
;User | ;User | ||
: A user is, well, a CMOD user. Users must be defined in order to log into the CMOD server. | : A user is, well, a CMOD user. Users must be defined in order to log into the CMOD server. | ||
: Starting in IBM CMOD v8.5, password authentication for users defined in Content Manager OnDemand could be performed by Lightweight Directory Access Protocol, or LDAP. | |||
: In OnDemand v10 and higher, Content Manager OnDemand now supports synchronizing Users and Groups with LDAP servers, adding more flexibility, and releasing CMOD admins from duplicating the effort of managing CMOD users and groups. | |||
;Group | ;Group | ||
: A Group is a collection of users. Groups can define access permissions to specific Application Groups, Folders, Cabinets, or Printers. | : A Group is a collection of users. Groups can define access permissions to specific Application Groups (including limiting access to searches in Application Groups with Query Restrictions), Folders, Cabinets, or Printers. | ||
: As mentioned above, CMOD v10 now supports LDAP Sync. | |||
;Cache | ;Cache | ||
: "Cache Storage" is a local filesystem of fast magnetic disk (hard drives) for the purpose of storing the most frequently accessed data, so that retrievals are extremely fast. Data stored inside a Storage Node is generally a MINIMUM of 10x slower to retrieve, due to the overhead of communicating with | : "Cache Storage" is a local filesystem of fast magnetic disk (hard drives) for the purpose of storing the most frequently accessed data, so that retrievals are extremely fast. | ||
: CMOD data that isn't stored in the cache is stored in nodes, defined in Storage Sets. Data stored inside a Storage Node is generally a MINIMUM of 10x slower to retrieve, due to the overhead of communicating with the various storage methods, and the slower devices they often use for "Cheap and Deep" storage. | |||
;Segment | ;Segment | ||
: In order to keep database queries fast, OnDemand uses database table segmentation. Before DB2 supported table segmentation natively, the Content Manger OnDemand developers decided to split index data into tables of 10 million rows each. Using this method keeps search performance linear, as only the tables containing documents in the date range you're looking for ( for example, 3 months, or 1 year) are actually searched. | : In order to keep database queries fast, OnDemand uses database table segmentation. Table segmentation organizes data into separate tables, and in the case of CMOD, segments are determined by the number of rows configured at the Application Group level. CMOD tracks segments by the minimum and maximum dates found inside each database segment. By requiring each query contain a date, OnDemand can quickly eliminate tables from being searched by excluding those tables that don't contain the dates being searched for. | ||
: Before DB2 supported table segmentation natively, the Content Manger OnDemand developers decided to split index data into tables of 10 million rows each. Using this method keeps search performance linear, as only the tables containing documents in the date range you're looking for ( for example, 3 months, or 1 year) are actually searched. | |||
: In some of the largest IBM Content Manager OnDemand customer sites, they've modified the Application Group definitions to include up to 250 million rows per database table segment in order to keep performance brisk. | |||
; Resources | ; Resources | ||
: In the context of AFP or PDF data, the category of data used to render the data on the page. For example, fonts, images, overlays, lines, boxes, or barcodes. OnDemand splits resources from data in order to maximize the compression of actual report data. | : In the context of AFP or PDF data, the category of data used to render the data on the page. For example, fonts, images, overlays, lines, boxes, or barcodes. OnDemand splits resources from data in order to maximize the compression of actual report data. | ||
: By creating 'resource bundles' from data being loaded, CMOD de-duplicates the data, optimizing storage. These resource bundles can be re-used if data loaded in the future contains identical sets of resources in an Application Group. For example, a credit card company might load statements into CMOD in AFP format. Items like logos, graphics, fonts, and page definitions are likely to stay the same from month to month - meaning that a resource bundle may be used for millions or billions of documents - saving storage space each time! | |||
;User Exit | ;User Exit | ||
| Line 134: | Line 149: | ||
; User Defined Data Type | ; User Defined Data Type | ||
: Content Manager OnDemand supports several types of data natively -- AFP, PDF, XML, Line Data, and Images. If you want to store a different type of data, you can configure CMOD to use a "User Defined" data type. User Defined data types allow OnDemand to store almost anything. | : Content Manager OnDemand supports several types of data natively -- AFP, PDF, XML, Line Data, and Images. If you want to store a different type of data, you can configure CMOD to use a "User Defined" data type. User Defined data types allow OnDemand to store almost anything. | ||
: In the vast majority of cases where User Defined Data Types are used (to store things like recordings of phonecalls to an organization's customer service centre) the Generic Index type is used to provide metadata to CMOD. | |||
: When creating Applications with a User Defined data type, pay special attention to the compression settings. Some data, like MP3 audio files, are already compressed, and the Compression setting should be set to 'disable'. | |||
== OnDemand Indexing Tools == | == OnDemand Indexing Tools == | ||