Documentation |
The Class AccessPointEjb. An access point references a unique combination of a User, a Client, and a Host. |
Name |
Java Type |
Comment |
---|---|---|
useCount |
long |
The use count. Total number of sessions that were started from this access point. |
wordCount |
long |
The word count. Total number of words that were checked from this access point. |
lastAccessTime |
java.util.Date |
The last access time |
active |
String |
Boolean marker is this access point is still active |
host |
HostEjb |
The host (see HostEjb) |
user |
UserEjb |
The user (see UserEJB) |
client |
ClientEjb |
The client (see ClientEjb) |
Documentation |
The Class AnalyticsPropertyEjb |
Documentation |
The Class CheckConfigurationEjb. This stores the configuration settings of a check. |
Documentation |
The ClientEjb. The Acrolinx client that is used to contact to the Acrolinx Platform. For example, Word integration or Content Analyzer. |
Name |
Java Type |
Comment |
---|---|---|
application |
String |
The application name, for example Word integration, Content Analyzer |
clientVersion |
String |
The client version number. If the client doesn’t commit a version number, "unknown is stored in the database. |
clientBuild |
String |
The client build number. If the client doesn’t commit a build number, "unknown" is stored in the database. |
buildDate |
String |
The build date |
locale |
String |
The locale of the client as a two letter language id (ISO 639-1). For Example "en" or "de". |
Documentation |
ClientUsageStatisticsEjb |
Documentation |
The information about the Core Server that the client session was connected to. |
Documentation |
The Class DocumentEjb |
Name |
Java Type |
Comment |
---|---|---|
name |
String |
The filename of the Document. Only the name of the file without any path information. Example: MyDocument.doc |
fileFormat |
String |
The file format of the Document. Example: text/plain |
author |
String |
The writer of the document. "unknown" if no writer was provided. |
identifier |
String |
The identifier |
project |
String |
The project |
path |
String |
The path to the document, without the filename. Example: C:\Documents\MyDocument.doc |
documentEvents |
DocumentEventEjb |
This is the association to the document events. Even if the document is checked several times, there’s only one entry for this document in the document table. All check-specific information is referenced via the DocumentEvent. |
metaInfos |
DocumentMetaInfoEjb |
The meta information (see DocumentMetaInfoEjb) |
Documentation |
The Class DocumentEventMetaInfoEjb. The meta info is any custom information that is stored for a user or document. This information is stored for each check. This information is associated with a DocumentEvent. |
Name |
Java Type |
Comment |
---|---|---|
MetainfoType |
String |
The type of information, that is, custom user information (UMD) or custom document information (DMD). |
MetadataKey |
DocumentEventMetaInfoEjb |
The name of the field that is used to collect one type of custom information. |
MetadataValue |
DocumentEventMetaInfoEjb |
The value entered for the field. |
Documentation |
The Class DocumentMetaInfoEjb |
Documentation |
The Class FlagEjb. Issues are markings that are applied to sections of text when the Acrolinx Platform checks a document. These indicate that Acrolinx found an issue or error in the marked text. |
Name |
Java Type |
Comment |
---|---|---|
SENTENCEID |
int |
The sentence ID. The sentences of a document are numbered serially. The sentence ID is the position of the sentence in the document. |
CONTEXTBEGIN |
int |
The begin of the issue context. The value represents the number of the char at the begin of the context. |
CONTEXTEND |
int |
The end of the issue context. The value represents the number of the char at the end of the context. |
MAX_CONTEXT _SURFACE_LENGTH |
int |
For internal use, not stored to the database |
CONTEXTSURFACE |
String |
The context surface |
DOCUMENTEVENT_ID _COLUMN_NAME |
String |
The Constant DOCUMENTEVENT_ID _COLUMN_NAME |
suggestions |
SuggestionEjb |
The suggestions |
matches |
MatchEjb |
The matches |
documentEvent |
DocumentEventEjb |
The document event |
type |
FlagTypeEjb |
The type |
processStatus |
ProcessStatusEjb |
The process status |
ruleFlag |
RuleFlagEjb |
The rule issue |
sentenceTooLongFlagEjb |
SentenceTooLongFlagEjb |
The sentence too long issue ejb |
SEOFLAGEJB_ID |
int |
The SEO issue |
termHarvestingFlag |
TermHarvestingFlagEjb |
The Term Discovery issue |
termFlag |
TermFlagEjb |
The term issue |
reuseFlags |
ReuseFlagEjb |
The reuse issues |
FlagSurface |
String |
The text that was highlighted in the document |
Documentation |
The Class FlagTypeEjb |
Documentation |
The Host that is using Acrolinx. The name is stored in the external Id. The host name for one computer can occasionally change depending on your network environment. Example: computername (10.12.80.146) |
Columns
Name |
Java Type |
Comment |
---|---|---|
accessPoints |
AccessPointEjb |
The access points that this host is using |
Documentation |
The Class MatchEjb |
Name |
Java Type |
Comment |
---|---|---|
beginIndex |
int |
The begin index. Indicates the position in the text. |
endIndex |
int |
The end index. Indicates the position in the text. |
MAX_SURFACE _STRING_LENGTH |
int |
The Constant MAX_SURFACE _STRING_LENGTH |
surface |
String |
The surface string. This string is the problematic part of text as it was found in the document. |
flag |
FlagEjb |
The issue |
Documentation |
A customer may give an issue a status (For example, "valid") |
Documentation |
The Class PropertyEjb |
Documentation |
The Class ResourceConfigurationEjb |
Name |
Java Type |
Comment |
---|---|---|
languageId |
String |
The language of the resource configuration as two-letter language id (ISO 639-1). For example, "en" or "de". |
resourceName |
String |
The resource name |
resourceVersion |
String |
The resource version |
resourceBuild |
String |
The resource build |
resourceBuildDate |
String |
The resource build date |
termSets |
java.util.Collection |
The term sets |
resourceProperties |
ResourcePropertyEjb |
The resource properties |
ruleSets |
RuleSetEjb |
The writing guides |
ruleConfigurationDate |
string |
The date that the rule configuration was last modified |
Documentation |
The Class ReuseFlagEjb |
Documentation |
The Class RuleEjb. Stores the name and the IDs of a Rule. |
Documentation |
The Class RuleFlagEjb. A RuleFlag indicates a grammar or style problem in the text. It references an issue and a Rule. |
Documentation |
The Class RuleSetEjb. A set of configurations in a language property file, which typically activates specific style guidelines, but can also be used to activate Term Discovery and Reuse. |
Documentation |
The Class SentenceTooLongFlagEjb |
Documentation |
The Class SeoFlagEjb. An SeoFlag indicates SEO issues in the text. |
Documentation |
One instance of StatisticsEjb is referenced by one DocumentEventEjb. So, the statistics in this class belong to exactly one check. |
Name |
Java Type |
Comment |
---|---|---|
checkingScore |
int |
The Acrolinx Score of this check |
checkingStatus |
String |
The checking status of this check |
wordCount |
long |
The total number of words in this check |
sentenceCount |
long |
The sentence count |
flagCount |
int |
The issue count. Total number of issues found in this check. |
fleschReadingEase |
float |
The Flesch Reading Ease |
termCandidateFlagCount |
int |
The discovered term issue count |
typeStatisticsSet |
TypeStatisticsEjb |
The type statistics set. This contains statistic info aggregated per issue type. |
qualityScore |
int |
The Acrolinx Score of this check |
Documentation |
The Class SuggestionEjb. Some issues come along with a suggestion, how to correct the flagged problem. |
Name |
Java Type |
Comment |
---|---|---|
beginIndex |
Integer |
The begin index. Indicates the position in the text. |
endIndex |
Integer |
The end index. Indicates the position in the text. |
MAX_SUGGESTION _STRING_LENGTH |
int |
The Constant MAX_SUGGESTION _STRING_LENGTH |
suggestion |
String |
The suggestion |
flag |
FlagEjb |
The issue |
Documentation |
The Class TermFlagEjb. This table stores information about custom fields that have been added to the terminology database. |
Documentation |
The Class TermFlagEjb. This table stores the values of custom fields for each flagged term. |
Documentation |
The Class TermFlagEjb |
Name |
Java Type |
Comment |
---|---|---|
surface |
String |
The surface string of this term |
matchRanking |
String |
The match ranking. For example, exactIllegal |
termSet |
String |
The term set |
termUUID |
String |
The unique identifier of this term |
termStatus |
TermStatusEjb |
The term status |
FlaggedSurface |
String |
The text that was highlighted in the document |
Documentation |
The Class TermHarvestingFlagEjb. Term Discovery is the process of detecting potential new terms automatically during a check. By default, every document that Acrolinx checks is checked for new terms. |
Name |
Java Type |
Comment |
---|---|---|
lemma |
String |
The lemma |
pos |
String |
The position in the text |
confidence |
double |
The confidence |
triggerAnnotation |
String |
The trigger annotation |
evidenceAnnotation |
String |
The evidence annotation |
COMPARATOR |
TermHarvestingFlag- EjbComparator |
For internal use |
rule |
RuleEjb |
The rule |
Documentation |
The Class TermSetEjb. A Term Set is a predefined filter that searches within each term for specific criteria and returns a set of terms for the server to load. A list of available Terms Sets is then displayed to Acrolinx users in the Acrolinx Integration checking options. The most common use for term sets is to filter for terms within a given Domain. |
Documentation |
The Class TermStatusEjb. A Status is a qualifier of a term indicating such aspects of approval, acceptability, or applicability in a given context. In the Terminology Manager, Status is a system category that is based on a subset of the statuses listed in the ISO standard 12620. |
Documentation |
The Class TypedRuleSetEjb |
Documentation |
The Class TypeStatisticsEjb. Provides an aggregated view on the check results per issue type. |
Name |
Java Type |
Comment |
---|---|---|
type |
FlagTypeEjb |
The issue type |
checkingScore |
int |
The Acrolinx Score. The lower the score, the better. |
checkingStatus |
String |
The checking status. For example, "green", "red". |
flagCount |
int |
The issue count. The total number of issues for this check and issue type |
weight |
int |
The weight |
statistics |
StatisticsEjb |
The statistics |
Documentation |
A user that is using Acrolinx. This class contains the full name and the username of the user. |
Name |
Java Type |
Comment |
---|---|---|
External_ID |
String |
The username of the user. |
userName |
String |
The optional full name of the user as entered in the Dashboard on the user details page. |
Ignore_For_Analytics |
boolean |
Highlight whether to include the data for the user in reports. |
Force_Reenter_Umd |
boolean |
Highlight whether to prompt the user to fill out their custom user information again. |
Documentation |
The Class UserMetaDataEjb. Administrators can configure custom user fields for collecting custom user information. |
Documentation |
The Class VoiceCharacteristicEjb. This table stores the voice scores for each checked document. |
Name |
Java Type |
Comment |
---|---|---|
TYPE |
String |
The type of the voice score, for example readability or liveliness |
LANGUAGEID |
String |
The language that the voice score applies to |
PROFILENAME |
String |
The profile that the voice score is assigned to |
DISTANCETOTARGET |
String |
The difference between the actual score and the target score |
TARGET |
String |
The target score |
SCORE |
String |
The score that Acrolinx measured for the document |
REDDISTANCE |
String |
The score difference before the scorecard indicates a red score |
YELLOWDISTANCE |
String |
The score difference before the scorecard indicates a yellow score |
DOCUMENTEVENT_ID |
String |
The ID of the document event, that is, the check |