For most commands, the returned status contains the error message. If the operation ends well, the status contains msgEndJob (1). If the request continues after a time greater than "MaxTimeJob" ("Setup/Activity" tab), the answer is "000" with the appropriate error message.

cmdPackIndex = 1

Defragments the index (re-indexes, or reorganizes the TM or glossary). ~ Restricted to Administrators

Details: This command applies to the index of the TM opened during the session. The index is defragmented. During this period, the TM is not accessible. WfServer sends back "000" to users' queries.

cmdCreateTM = 2

Creates a remote TM and indexes the TM. ~ Restricted to Administrators

Parameters: Parameters are separated with a Tab character (# 9)

1: Name of the TM

2: Relative path name + TM file.

3: Password for the TM

4: Languages of TM in the format "XX-XX> XX-XX

5: Write permission on the TM ("1" or "0")

6: Write permission on public zone of the TM ("1" or "0")

Details: WfServer creates a TM. This TM is automatically indexed. This command returns msgEndJob but the process runs in the background.

cmdIndexTM = 4

Launch a reindexation of a remote TM. ~ Restricted to Administrators

Parameter: Name of the TM

Details: Indexing is performed in the background. During this period, the TM is not accessible. WfServer sends back "000" to users' queries. The error message msgTMLocked is returned if a user tries to open a session on this TM, lasting all the time of reindexation.

cmdSearchSegment = 5

Performs an exact or fuzzy TU search for the provided segment of text. Returns all possible candidate TUs, in order of match degree. No restriction.

Parameter: Searched segment

Details: WfServer searches and sends back the found TUs as lines of text terminated with a CR, sorted in the order of resemblance (match degree), with a 3-digit score at the beginning of each TU line. The reuse counter for the top (first) matching TU is then incremented if the "Auto increment 100%" is checked ("Setup/TMs" tab).

cmdDelSegment = 6

Removes one TU for a given segment, if it is found at 100%. ~ No restriction.

Parameter: Searched segment

Details: WfServer searches a TU whose source segment is identical to the searched segment. If a TU is found, it is deleted.

cmdAddSegment = 7

Adds one or many TUs created from one or more source segments. ~ No restriction.

Parameter: Source segment [+Rtn+ source segment] ...

Details: WfServer creates a TU with each given source segment(s), and starts a cmdAddTUs command. The langID created will be that of the TM, the GroupID will be that of the session, the target segment will be filled with spaces of the size of the source segment.

cmdSearchTU = 8

Search a TU ~ No restriction.

Parameter: Searched TU

Details: WfServer searches and returns the found TU. The reuse counter is then incremented if the "Auto increment 100%" is checked ("Setup / TMs" tab).

The search compares the following fields.

cmdDeleteTUs = 9

Deletes a list of TUs. ~ No restriction.

Parameters:

1: TU₁ + Rtn + TU₂ + Rtn + TU₃ + …

1: 23456 + Rtn + 54678 + Rtn + …

Details: WfServer searches each transmitted TU and removes the one(s) found as identical (see the field comparison table). WFServer removes all identical TUs that were found. The search can be done in two ways, either by sending WfServer the searched TU, or by sending its identification number recovered during a previous Search command.

cmdAddTUs = 10

Adds a list of TUs. ~ No restriction.

Parameters: TU1 + Rtn + TU2 + Rtn + TU3 + …

Details: WfServer adds each TU to the session's TM. Before the operation, redundant TUs beings can be automatically deleted if the "Delete redundant TU" checkbox ("Setup/TMs" tab) is checked. The table below summarizes what is removed taking into account the parameter "OverrideTU" (see below "cmdSetParam")

cmdDelLastTU = 11

Removes an older TU and adds a new TU, in one operation. ~ No restriction.

Parameters:

1: Identifier of the TU to be deleted (e.g. "45678").

2: TU to be added.

Details: This command allows to remove a TU and add another at the same time. The first TU is referenced by its ID

cmdIncLastTU = 12

Increments the reuse counter of a TU. ~ No restriction.

Parameters: Position of the TU to be incremented

Details: WfServer increments the reuse counter of the designated TU. If the transmitted position is <= 0, the last TU served at 100% will be be incremented.

cmdSearchContext = 15

Searches the TUs whose source segment contains the largest number of searched terms. ~ No restriction.

Parameters: Keywords to be searched, separated by spaces.

Details: WfServer returns lines of TUs to the user. The size of each packet (in number of text characters - not bytes; Unicode characters are 2 bytes) is defined by a parameter specified in the request. WfServer fills the packet with as many entire TUs as possible.

cmdInitFirstTU = 17

Positions a cursor in the TM file. ~ Restricted to Administrator or Donor

Parameters: Number in ASCII. Example: "12345"

Details: The cursor is used to directly read the contents of the TM, one TU at a time, or block by block.

cmdGetNextTU = 18

Reads the TU under the current cursor in the direction Start -> End .. ~ Restricted to Administrator or Donor

Parameters: Position in ASCII format. e.g. "12345", or empty

Details: WfServer returns the TU under the cursor and moves the cursor to the next TU. Also returns the cursor. All TUs end with # 13. If the end of the file is reached or exceeded, returns '000 '.

cmdGetPreviousTU = 19

Reads the TU under the current cursor in the direction End -> Start

Restrictions: Administrator or Donor

Parameters: Position in ASCII format. e.g. "12345", or empty

Details: WfServer returns the TU under the cursor (moving backwards) and positions the cursor at the end of the previous TU. Also returns the cursor. All TUs end with a CR (# 13). If the beginning of the file is reached or exceeded, returns '000 '.

cmdGetCountTUs = 20

Returns the number of TUs in the current TM. ~ No restriction.

Parameters: None.

Details: WfServer returns the file name of the TM and the current number of TUs that it contains.

cmdGetTMFileName = 21

Returns the name and size (in characters - not bytes) of the TM file. ~ No restriction.

Parameters: None.

Details: WfServer returns the file name of the TM and the number of characters that it contains.

cmdGetNextBlock = 23

Reads the TU block under the current cursor in the direction Start -> End .. ~ Restricted to Administrators

Parameters: Position in ASCII format. e.g. "12345", or empty

Details: WfServer returns the block of TUs under the cursor and positions the cursor at the end of the block. Also returns the cursor. All TUs end with # 13. If the end of the file is reached or exceeded, returns '000 '.

cmdGetPreviousBlock = 24

Reads the TU block under the current cursor in the direction End -> Start ~ Restricted to Administrators

Parameters: Position in ASCII format. e.g. "12345", or empty

Details: WfServer returns the block of TUs under the cursor (backward direction) and positions the cursor at the beginning of the block. Also returns the cursor. All TUs end with # 13. If the beginning of file is reached or exceeded, returns '000 '.

cmdGetBlockASync = 26

Reads the TU block under the current cursor in the direction Beginning -> End ~ Restricted to Administrators

Parameters: Position in ASCII format. e.g. "12345", or empty

Details: WfServer returns the block of TUs under the cursor and positions the cursor at the beginning of the block. Also returns the cursor. All TUs end with # 13. If the end of the file is reached or exceeded, returns '000 '.

cmdGetVersionNumber = 28

Returns the version number of WfServer ~ No restriction.

Parameters: None.

Details: WfServer returns its version number.

cmdDoBreak = 29

Stops all the currently running jobs for a user. ~ No restriction.

Parameters: None.

Details: WfServer properly shuts down the execution of a command and deletes all other commands in the job queue.

cmdGetErrorMsg = 30

Returns the string corresponding to the error message. ~ No restriction.

Parameters: Error number in ASCII (e.g. "12")

Details: WfServer returns the meaning of the error message in text format.

cmdCreateGlos = 33

Remotely creates a new glossary. ~ Restricted to Administrators

Parameters:

Each parameter is separated from the previous one with a Tab character (# 9)

1: Name of the glossary

2: Name of file relative to the default directory for glossaries as defined in the "Setup/Glossaries" tab.

3: Glossary password.

4: Glossary LangID

5: Write authorization ("1" = yes, "0" = no)

6: Write authorization for the public zone ("1" = yes, "0" = no)

Details: WfServer creates a glossary and automatically indexes it. This command returns msgEndJob, but the process runs in the background.

cmdDeleteGlos = 34

Remotely deletes a glossary. ~ Restricted to Administrators

Parameters: Parameters are separated with a Tab character (# 9)

1: Name of the glossary

2: Glossary password.

3: Delete the files (glossary file and index). ("1" = yes, "0" = no)

Details: WfServer send the user a confirmation string (10 random alphanumeric characters) before executing the command. The distant user will have to return this confirmation string before the maximum time of the execution of a command. If the response time exceeds "MaxTimeJob" ("Setup/Activity" tab), confirmation is canceled, the glossary is not deleted.

cmdGetLanguage = 35

Returns the language pair of the TM ~ No restriction.

Parameters: None.

Details: WfServer returns the language pair of the TM (e.g. 'RU-01>EN-US')

cmdDeleteTM = 36

Remotely deletes a TM. ~ Restricted to Administrators

Parameters: None

Each parameter is separated from the previous one with a Tab character (# 9)

1: Name of the TM

2: Password for the TM

3: Delete the files (TM file and index). ("1" = yes, "0" = no)

Details: WfServer sends the user a confirmation string (10 random alphanumeric characters) before executing the command. The distant user will have to return this confirmation string before the maximum time of the execution of a command. If the response time exceeds "MaxTimeJob" ("Setup/Activity" tab), confirmation is canceled, the TM is not deleted.

cmdCreateAccount = 37

Remotely creates a new account. ~ Restricted to Administrators

Parameters: Parameters are separated with a Tab character (# 9)

1: Account Name

2: Password of the account.

3: Name of the associated TM.

4: Write authorization ("1" = yes, "0" = no)

5: Name of the associated glossary.

6: Write authorization for the glossary ("1" = yes, "0" = no)

7: Max number of concurrent users

Details: WfServer remotely creates an account. If the TM does not exist, or the syntax of the name is not correct, or the account already exists, the account is not created.

cmdGetAccntParams = 38

Returns the settings for an account ~ Restricted to Administrators

Parameter: Account Name

Details: WfServer returns

1: Password of the account.

2: Name of the associated TM.

3: Write authorization ("1" = yes, "0" = no)

4: The name of the glossary

5: Write authorization for the glossary ("1" = yes, "0" = no)

cmdGetNbClient = 39

Returns the number of clients who opened a session. ~ No restriction.

Parameters: None.

Details: WfServer returns the number (in ASCII) of logged users (real and virtual).

cmdDeleteAccount = 40

Remotely deletes an account. ~ Restricted to Administrators

Parameters: Parameters are separated with a Tab character (# 9)

1: Account Name

2: Password of the account.

cmdReplaceTU = 44

Replaces a TU by another in the same place (if possible) without changing the GroupID. ~ Restricted to Administrators

Parameters: Each TU is separated by a Rtn character (# 13)

1: Former TU.

2: New TU.

Details: This command allows you to replace a TU by another. If both TUs are the same size, the new one replaces the old one.

TU1, "" Deletes the TU

TU1, TU2 Replaces TU1 with TU2 if TU1 exists

TU1, "123" Invalid parameter

"", TU2 Replaces the last found TU with TU2

"", "" Deletes the last found TU

"123", TU2 Replaces TU # 123 with TU2

"123", "" Deletes TU # 123

"123", "432" Invalid parameters

cmdDelAllTUs = 45

Searches and Deletes all found TUs. TUs must be found as 100% identical, except for the date. ~ Restricted to Administrators

Parameters: TUs are separated with a Rtn character (# 13)

1: TU₁,

2: TU₂

3: TU_n

Details: This command deletes all TUs identical to a list of TUs, even different date.

cmdAddSearch = 47

Searches a segment and add TUs that will be stamped with the client GroupID. ~ No restriction.

Parameters: TUs are separated with a Rtn character (# 13)

1: Searched segment

2: TU to be added.

Details: This command is twofold. It adds a TU first and then searches for the segment. WfServer searches and sends back the found TUs, sorted in the order of resemblance, with a 3-digit score at the beginning of each TU. The reuse counter is then incremented if the "Auto increment 100%" checkbox is checked ("Setup/TMs" tab).

cmdInitGroupID = 48

Create / Open / Enable / Closes a session WorkgroupID. ~ No restriction.

Parameters:

1: "0123456789" + # 13 + life duration + # 13 + PIN number

2: "123456789"

3: "123456789" + #13 + "+"

4: ""

Details: The syntax may vary depending on the function. 1=Create, 2=Open, 3=Enable, 4=Close. A WorkgroupID consists of 10 characters in the following alphabet:

“#$%+-0123456789<=>?@ ABCDEFGHJKLMNPQRSTUVWXYZabcdefghjkmnpqrstuvwxyz

Life duration is 0, 1, 3, 6, 12, 24 months. "0" means "no time limit".

Originally, the structure of the WorkGroupID contained information for the life duration of that WorkGroup ID, as well as a PIN number in order to filter WorkGroupID. However, client software that identify themselves at the time of connection to WfServer with a version number less than "1.0.11.30" are not filtered.

It is possible to force this filter by checking the "PIN filter" checkbox (tab "Setup / Groups")

cmdSetParam = 49

Sets one or more global or local parameters. ~ No restriction.

Parameters:

'AnyLangID' The cmdAppendTM sub-command (cmdPurge=59) accepts all added TUs regardless of language codes ("1"), or rejects TUs that don't have the correct language codes ("0").

'AutoIncTU' Is the auto-incrementation of TUs served at 100% enabled for my user session?

'AutoIncTUTM' Is the auto-incrementation of TUs served at 100% enabled for that TM?

'Break' Stops the job specified by the session number in ASCII.

'CacheIndex' Enables or disables the index cache. (1 = active)

'CanWritePublicTM' Provisionally enables or disables the public zone write authorization of the current TM, without changing the corresponding setting in the User Interface. (1 = active)

'CanWriteTM' Temporarily enables or disables the write authorization for the current TM. Temporarily means that the corresponding setting in the User Interface is not modified. This administrator command blocks the write mode for a TM to all other users accessing it. The parameter stays active as long as the TM remains opened by any other user. It will resume the User Interface's status at the next virgin "Open TM" command. (1 = active)

'CCountUsers' Corrects the difference between the number of logged and connected users

'CountAdmins' Sets the maximum number of concurrent administrators defined on the interface.

'CountBkgJobs' Set the maximum number of jobs allowed in the background.

'CountErrors' Resets the error counter to 0.

'DelCopiesTUs' Temporarily (session-wide) enables or disables the deletion of duplicate TUs when cmdAddTUs is used (does not modifiy the User Interface setting).

'DelCopiesEntries' Temporarily (session-wide) enables or disables the deletion of duplicate TUs when cmdAddEntries is used (does not modifiy the User Interface setting).

'Donor' Changes the property of the user into "donor", giving the password "Donor" ("Setup / Users" tab)

'Donor' Sets the password of the Donor WfServer interface (if Admin).

'ExportPath' Sets the destination directory for files generated by Purge commands.

'FuzzyThreshold' Sets the threshold percentage for TUs that are interesting to harvest for a search (ranges from 50% TUs to 95%). For a threshold of 95%, only TUs with a score >= 95% will be returned to the user. The higher the threshold, the lower will be the number of found TUs.

'GloPassword' The user identifies the glossary password.

'GroupID' Opens a session WorkGroupID.

'IdleTime' Sets the maximum number of hours (1 .. 24) of inactivity.

'IndexUsed' Defines the index used. (Source = 0, 1 = Target)

'IsAdmin' Changes to administrator mode after the recognition of the administrator password.

'Kill' Force the closing a TM or a glossary, disconnecting all users that may be currently using this TM or glossary. (Admin)

'LangID' Defines the session langID.

'LogsFileActived' Enables (1) or disables (0) the writing into an activity log file for WfServer.

'MakeBackStats' Creates a STATS.BAK file.

'MaxTimeJob' Sets the number of seconds for the execution of an application (2 .. 60).

'OkSendMail' Enables / disables the sending of warning emails.

'OverrideDate' Authorizes the stamping of the TU date by the server. (Default = 1)

'OverrideTU' Variable that indicates which TUs will be replaced or removed in a cmdAddTUs command. The table below summarizes all cases.

'PackReorganize' Enables / Disables the option of compacting holes in the TM when reindexing ("Setup / TMs" tab).

'PingToAll' Sends a ping to all users.

'PostStats' Sends an email alert test with the comment you provide.

'Priority' Sets the priority level (1 .. 10) for the user without overriding the account level set in the User Interface (in the "Accounts / Priority Level" tab)

'SearchDepth' Sets the level of depth for searches (50 .. 95).

'SetGloPassword' Sets the glossary password.

'SetTMPassword' Sets the password for the TM.

'Showserver' Make the WfServer User Interface visible (1) or invisible (0) .

'SyncTM' Synchronization (force write) of TM data in RAM to the hard disk.

'SyncUser' Synchronization (force write) of user data in RAM to the hard disk.

'TM & GlossarySearch' Enables / Disables the simultaneous search TM + Glossary.

'TMLangID' Configure the TM's langID pair.

'tmPassword' Temporarily sets the password of the current TM without overwriting its definition on the interface (TMs tab)

'TurboMode' Activates the Turbo mode for short sentences research (1, 2, 3 words).

'Unlock' Unlocks all critical area locks of the designated TM or glossary.

'ViewLogs' Checks the "Log to file" checkbox that generates log files. (Setup/Activity tab)

Details:

cmdGetParam = 50

Returns one or many global or local parameters of the session. ~ No restriction.

Parameters:

'AppCPUUsage' Returns the percentage of CPU activity dedicated to server VLTM.

'AutoIncTU' Is the auto-incrementation of TUs served at 100% enabled for my user session?

'AutoIncTUTM' Is the auto-incrementation of TUs served at 100% enabled for that TM?

'CacheIndex' Returns the state of the index cache. (1 = active)

'CanWritePublicTM' Retourne the activation status of the write permission into the public area in the current TM. (1 = active)

'CanWriteTM' Returns the state of the (temporary) write authorization for the current TM. (1 = active)

'CountAccounts' Returns the number of opened accounts.

'CountActiveThreadsJob' Returns the number of ThreadJob in progress.

'CountAdmins' Returns the maximum number of concurrent administrators.

'CountAllTUsID' Return the number of TUs of all TMs with the WorkgroupID indicated (in Admin mode). If no WorkGroupID is indicated, returns the number of TUs with the same session WorkGroupID, in all TMs.

'CountBkgJobs' Set the maximum number of jobs allowed in the background.

'CountEntries' Returns the number of entries in the glossary.

'CountEntriesID' Returns the number of entries in the current glossary with the same WorkgoupID and LangID as the session user.

'CountErrors' Returns the number of errors recorded by WfServer.

'CountGlossaries' Returns the number of opened glossary.

'CountHoles' Returns the number of TUs in the current TM.

'CountJobs' Returns the number of Jobs run since the start of WfServer.

'CountReqs' Returns the number of requests received by the server.

'CountReqsFifo' Returns the number of requests in the queue.

'CountReqsTM' Renvoie le nombre de requêtes exécutées sur la TM courante.

'CountSessions' Returns the number of opened sessions on WfServer.

'CountStart' Returns the number of times the current version of WfServer was started.

'CountTCPUsers' Returns the number of connected users.

'CountThreadsJob' Returns the number of ThreadsJob in progress.

'CountTMs' Returns the number of opened TMs.

'CountTUs' Returns the number of TUs in the current TM.

'CountTUsID' Returns the number of TUs in the current TM with the specified WorkgroupID (in Admin mode). If no WorkGroupID is indicated, returns the number of TUs with the same session WorkGroupID, in the current TM.

'CountTUsLangID' Returns the number of TUs in the current TM with the same LangID (in Admin mode). If no LangID is indicated, returns the number of TUs with the same session LangID, in the current TM.

'CountUsers' Returns the total number of logged users.

'CountUsersTM' Returns the number of users logged into the same TM.

'CPUUsage' Returns a numeric character string indicating the percentage of CPU usage by WfServer.

'CreatedDate' Returns the creation date of the WfServer executable.

'DelCopies' Returns the state of the variable of duplicate TU deletion when cmdAddTUs is running.

'DelCopiesEntries' Returns the state of the variable of duplicate entry deletion when cmdAddEntries is running.

'DiskActivity' Returns a string of ASCII characters of disk activity expressed in Kb/s

'Donor' Returns 1 if the user is set as a donor, 0 otherwise.

'ExportPath' Returns the destination directory for files generated by Purge commands.

'FuzzyThreshold' Returns the threshold percentage for TUs that are interesting to harvest for a search (ranges from 50% TUs .. 95%). For a threshold of 95%, only TUs with a score >= 95% will be returned to the user. The higher the threshold, the lower will be the number of found TUs.

'GetCountEntry' Counts the number of specific glossary entries.
Sub-parameters, separated by "&":
1 - WorkGroupID ("" = search empty elements, '*' = all items)
2 - Source language (eg 'EN', 'EN*', 'EN-US')
3 - Target language (eg 'EN',' FR*','FR-CA ')
4 - Name of the author or owner.

'GetCountTU' Count the number of specific TUs in the TM.
Sub-parameters, separated by "&":
1 - WorkGroupID ("" = search empty elements, '*' = all items)
2 - Source language (eg 'EN', 'EN*', 'EN-US')
3 - Target language (eg 'EN',' FR*','FR-CA ')
4 - Name of the author or owner.

'GetDateGroupID' Returns the date contained in the encryption of a WorkgroupID

'GetDateNow' Returns a string of ASCII characters of the current date (format: ddd:hh:mm:ss,ms), of the operating system on which WfServer is running.

'GetPIN' Returns the PIN code (4 characters) of a WorkgroupID. If the result is 0, then the WorkgroupID is not syntactically correct with WfServer of versions greater than or equal to "1.0.11.30".

'gloFileName' Returns the path and file name of the current glossary.

'GloPassword' Returns the status of the glossary password recognition.
0 = The glossary has a blank password
1 = Password is not identical
2 = The given password is authenticated (identical).

'GlossaryName' Returns the name of the glossary of the specified account (Admin mode). If none is specified, returns the name of the current glossary.

'GroupID' Returns the status of the opened WorkgroupID. 0 = not opened, 1 = opened.

'IdleTime' Returns the maximum number of hours (1 .. 24) of inactivity.

'IndexUsed' Returns the index used. (Source = 0, 1 = Target)

'IndexVersion' Returns the version number of the algorithm used to index.

'Indicators' Returns the progress indicators of the background task specified by its session number.

'IsAdmin' Returns the administrator status (1 = yes, 0 = no).

'IsDemoMode' Returns the status of WfServer demo mode (1 = yes, 0 = no)

'IsDoubleIndex' Returns "1" if target-side searches are possible, otherwise "0".

'IsReadWrite' Returns the write permission to the TM according to various parameters.

'IsUnicode' Returns the formatting (encoding) of the TM file. (1 = ANSI, 2 = Unicode, 3 = BigEndian, 4 = UTF8).

'LangID' Returns the session langID.

'Langs' Returns the pair of LangID of the TM (e.g. "EN> FR").

'LiCapacity' Returns the maximum number of connections that the license number can accept.

'LiCount' Returns how many connections are used by the license number (on the same operating system installed).

'ListAllGroupIDs' Returns a list, separated by the Tab character (# 9), of all WorkgroupID used in all TMs.

'ListGroupIDs' Returns a list, separated by the Tab character (# 9), of all WorkgroupID used in the current TM.

'MaxTimeJob' Returns the number of seconds for the execution of an application (2 ...60).

'MemUsed' Returns the amount of RAM used, in Kb

'OkSendMail' Returns the checkbox status for sending alert mails ("Setup/Network" tab).

'OverrideDate' Returns the status of the authorization to stamp the TUs with the server's date.

'OverrideTU' Returns a variable that indicates which TUs will be replaced or removed in a cmdAddTUs command.

'PackReorganize' Returns the activation state of the compaction of holes at the time of TM indexing option.

'Priority' Returns the priority level of the user.

'Showserver' Returns 1 if the interface is visible or 0 if the interface is invisible.

'StatsClients' Returns the list of users and their connection status (IP, TM used, connection date)

'SVersion' Returns the version number of WfServer, in ASCII format.

'TM & GlossarySearch' Returns the activation status of the simultaneous search "TM + Glossary".

'TM_ID' Returns the ID of the TM.

'TMFileName' Returns the name of the TM file

'TMFileSize' Returns the size (in bytes) of the TM.

'TMLangID' Returns the language pair of the TM.

'TMName' Returns the name of the TM of the specified account (Admin mode). If none is specified, returns the name of the current TM.

'tmPassword' Returns the status of the TM password recognition.
0 = The TM has a blank password
1 = Password is not identical
2 = The given password is authenticated (identical).

'TurboMode' Returns the status of Turbo mode.

'UpTime' Returns the uptime of WfServer with the format: yyyy:ddd:hh:mm:ss:ms.

'UserID' Returns the ID number of the user session.

'ViewLogs' Returns the state of the "Log to file" checkbox (Setup/Activity tab) box

Details:

cmdSearchEntry = 51

Searches for an entry in the glossary. ~ No restriction.

Parameters: Source term or expression to search.

cmdAddEntries = 52

Adds one or more entries in the glossary. ~ No restriction.

Parameters: Entries are separated with a Rtn character (# 13)

1: Entry₁

2: Entry₂

Details: The entry is added, the index is updated.

cmdDelEntry = 53

Deletes an entry in the glossary. ~ No restriction.

Parameters: Entry

Details: The entry is deleted if it exists, the index is updated.

cmdGetNextEntry = 54

Direct reading of the glossary entry by entry in the direction Start -> End. ~ Restricted to Administrators

Parameters: Position in ASCII format. e.g. "12345", or empty.

Details: WfServer returns the entry under the cursor and positions itself on the following entry. Also returns the cursor. All entries end with # 13. If reaches or exceeds the end of file, returns '000 '.

cmdGetPreviousEntry = 55

Direct reading of the glossary entry by entry in the direction End -> Start. ~ Restricted to Administrators

Parameters: Position in ASCII format. e.g. "12345", or empty.

Details: WfServer returns the entry under the cursor and positions itself on the previous entry. Also returns the cursor. All entries end with # 13. If reaches or exceeds the beginning of file, returns '000 '.

cmdDelEntriesID = 56

Removes all entries from the defined WorkgroupID. ~ Restricted to Administrators

Parameters: WorkgroupID.

Details: The index is updated at each deletion.

cmdIndexGlos = 58

Remotely launches glossary reindexing. ~ Restricted to Administrators

Parameters: Name of the glossary

Details: Indexing is performed in the background. During this period, the glossary is not accessible. WfServer sends back "000" to users' queries. The error message is msgGlossaryLocked, sent to users during the time of indexing.

cmdPurgeTM = 59

Execution of a background task on the entire TM. ~ Restricted to Administrators

Parameters:

1. Name of the TM on which the operation will be run, followed by a space " ";

2.1. "G" Operation on GroupIDs

- "D" Delete

- "E" Exports to a file with the name of the TM and the session number

59, XX2XX GDE * EN FR

59, XX2XX GDE & EN FR

59, XX2XX GDE EN FR

59, XX2XX GDE * EN* FR*

59, XX2XX GDE & EN* FR*

59, XX2XX GDE EN* FR*

59, XX2XX GDE wkg1 wkg2 wkg3 wkg4 wkg5 ...

'G' = WorkGroupID

'D' = Delete

'E' = Export

"*" = all TUs (public and private)

"&" = only private TUs

"" = only public TUs

2.2. "U" Operation on an individual user

- "D" Delete

- "E" Exports to a file with the name of the TM and the session number

59, XX2XX UDE wkg1 EN FR #%nom%#

2.3. "A" Add TM

- "TMFileName.txt " file name of the TM to be added

Details: Three possible function, "G" = WorkGroupIds, "U" = Users, "A" = Add a TM. Additional parameters depend on the selected function. "DE" for "G" or "U", and a file name for "A". The server returns a session number so that you can follow its execution in the background.

cmdPurgeGlo = 60

Running a background task throughout the glossary. ~ Restricted to Administrators

Parameters:

1. Name of the glossary on which the operation will be run, followed by a space " ";

2.1. "G" Operation on WorkGroupIDs

- "D" Delete

- "E" Exports to a file with the name of the TM and the session number

60, XX2XX GDE * EN FR

60, XX2XX GDE & EN FR

60, XX2XX GDE EN FR

60, XX2XX GDE * EN* FR*

60, XX2XX GDE & EN* FR*

60, XX2XX GDE EN* FR*

60, XX2XX GDE wkg1 wkg2 wkg3 wkg4 wkg5 ...

'G' = WorkGroupID

'D' = Delete

'E' = Export

"*" = All Entries (public or private)

"&" = only private entriesseules

"" = only public entries

2.2. "U" Operation on an individual user

- "D" Delete

- "E" Exports to a file with the name of the glossary and the session number

59, XX2XX UDE wkg1 EN FR #%nom%#

2.3. A" Adding a Glossary

- "GloFileName.txt " file name of the glossary to be added

Details: Three possible functions, "G" = WorkGroupIds, "U" = Users, "A" = Add a glossary. Additional parameters depend on the selected function. "DE" for "G" or "U", and a file name for "A". The server returns a session number so that you can follow its execution in the background.

cmdGetParamSession = 61

Retrieves one or more parameters of a specific or global session. ~ Restricted to Administrators

Parameters: parameters are separated with a Tab character (# 9)

1: Session number

2: Parameters as defined in the command cmdGetParam

Details: WfServer searches the session given by the number. If this session exists, the following parameters are retrieved from the session.

cmdConfirmation = 63

Sends the confirmation code. ~ Restricted to Administrators

Parameter: Confirmation code on 10 alphanumeric characters.

Details: This command is not sent alone, it's a confirmation of an order previously sent to the server. At the end of the previous command, WfServer sends the customer a confirmation string (10 alphanumeric characters) to be returned by the client application.

cmdShutdown = 64

Request a VLTM server shutdown. ~ Restricted to Administrators

Parameters: None.

cmdRestart = 65

Request a restart of the VLTM server. ~ Restricted to Administrators

Parameters: None.

cmdSearchContextExt = 66

Lucene-compatible filtered search ~ No restriction.

Parameters:

Three lines, each separated by \ r (# 13) or tab (# 9)

The first line consists of parameters associated with values, separated by ";".

- Search options:

"CaseSensitive", "0", "1" default = 0
"MatchWholeWords", "0", "1" default = 0
"PageOffset", "0".."32767" default = 0
"PageLength", "0".."32767" default = 50
"IndexUsed" "[0,1,2]" default = 0

- Filter conditions:

"OnlyPublicTus", "0", "1" défaut = 0
"CreationDate", "20080403~163538"
"CreationUser", "Foobar"
"Workgroup", "1234567890" (10 caracters)
"Attr1", "Attr2", "Attr3", "Attr4" character string
"Occur", "0".."2147483647"
"Source", character string
"Target", character string

- Operators :

"=", "<", ">", "<=", ">=", "<>", "Э", "Є",
"!=", "!<", "!>", "!Э", "!Є"

- Example :

"IndexUsed=0;CaseSensitive=1;PageOffset=0;CreationDate>=20080403~163538;CreationUser=Foobar;Attr1Єjohn;Occur>10"

The second and third lines respectively contain the source and target queries, even if they are empty.
The query consists of keywords (or groups of keywords) surrounded by wildcards (+) (-), (*), which refine the search.
A group of keywords is framed in quotation marks "".
The symbols (+), (-) in front of a keyword (or group) indicate that the keyword must (+) or should not (-) appear.
(*) when placed at the end of keyword this symbol indicates that all the terms with identical root accepted.

Examples:

+token -token* +"segment token" -"segment* token*"

Details: The results are ranked in order of relevance, most relevant first.