Wiki

SDL Archiver

Martin Trusty — Mon, 08 Mar 2021 18:07:46 GMT

Current Revision posted to Wiki by Martin Trusty on 3/8/2021 6:07:46 PM

SDL Archiver service is used to control the running of plugins within TMS.

Early days

Historically there was just a single component of SDLTMS that would solely be responsible for archiving jobs. Over time other components were created through such methods as Broker Scripts (ran in a workflow stage) or server side batch files ran from automated scripts. This wasn't easy to maintain and certainly wasn't organised so the SDL Archiver service was born.

Plugins

Taking it's name from the original function of archiving jobs this service is now used to perform automated tasks that don't quite fit into the workflow processing. SDL Archiver Service runs as a single process and will load up related plugins upon start-up to perform an array of tasks. These plugins will have a configured frequency that they run at and at this point the SDL Archiver Service will start up a child process for this plugin.

SDLTMS will have some default plugins however it is possible to have custom plugins created for this service. The plugins page can be seen within TMS from System>Services>Plugins and would typically include:

[[Cleaner]]	Sdl.Tms.Archiver.Cleaner.dll
CallHome	Sdl.Tms.CallHome.dll
CompressOldJobsArchiver	Sdl.Tms.Archiving.dll
[[CtaLogsArchiver]]	Sdl.Tms.Archiving.dll
DatabaseMaintenance	Sdl.Tms.Archiving.dll
EmpowerIntegration	Sdl.Tms.EmpowerIntegration.dll
[[EmtApplyExecutor]]	Sdl.Tms.Emt.Apply.dll
[[ItdUploadsArchiver]]	Sdl.Tms.Archiving.dll
[[JobsArchiver]]	Sdl.Tms.Archiving.dll
[[NewJobsArchiver]]	Sdl.Tms.Archiving.dll
ProjectTM	Sdl.Tms.ProjectTM.dll
[[Sweeper]]	Sdl.Tms.Archiver.Sweeper.dll
TbImport	Sdl.Tms.TbImport.dll
TcJobsArchiver	Sdl.Tms.Archiving.dll
TerminologyAnalyser	Sdl.Tms.Terminology.dll
TmExport	Sdl.Tms.TmExport.dll
TmImport	Sdl.Tms.TmImport.dll
TmsLogsArchiver	Sdl.Tms.Archiving.dll
TranslationMemoryMaintenance	Sdl.Tms.Archiving.dll

Tags: SDL Archiver, Services

EmtApplyExecutor

Martin Trusty — Mon, 08 Mar 2021 18:07:15 GMT

Current Revision posted to Wiki by Martin Trusty on 3/8/2021 6:07:15 PM

EmtApplyExecutor is the service that sends tasks to Machine Translation (MT) when a task reaches an MT Step in the workflow. This is done by checking the MT queue once every 60 seconds and processing any tasks it finds that are waiting to be translated.

The advantage of the EmtApplyExecutor not being a true System Workflow Step is that other tasks can be processed while waiting for the Machine translation to be returned. By treating MT the same as a human translator would be treated when a task reaches a traditional Translation step, the workflow queue will not have to wait for the process to be completed.

Tags: SDL Archiver, Services, Machine Translation

SDL Archiver

Martin Trusty — Mon, 08 Mar 2021 17:56:33 GMT

Revision 7 posted to Wiki by Martin Trusty on 3/8/2021 5:56:33 PM

SDL Archiver service is used to control the running of plugins within TMS.

Early days

Plugins

[[Cleaner]]	Sdl.Tms.Archiver.Cleaner.dll
CallHome	Sdl.Tms.CallHome.dll
CompressOldJobsArchiver	Sdl.Tms.Archiving.dll
[[CtaLogsArchiver]]	Sdl.Tms.Archiving.dll
DatabaseMaintenance	Sdl.Tms.Archiving.dll
EmpowerIntegration	Sdl.Tms.EmpowerIntegration.dll
EmtApplyExecutor	Sdl.Tms.Emt.Apply.dll
[[ItdUploadsArchiver]]	Sdl.Tms.Archiving.dll
[[JobsArchiver]]	Sdl.Tms.Archiving.dll
[[NewJobsArchiver]]	Sdl.Tms.Archiving.dll
ProjectTM	Sdl.Tms.ProjectTM.dll
[[Sweeper]]	Sdl.Tms.Archiver.Sweeper.dll
TbImport	Sdl.Tms.TbImport.dll
TcJobsArchiver	Sdl.Tms.Archiving.dll
TerminologyAnalyser	Sdl.Tms.Terminology.dll
TmExport	Sdl.Tms.TmExport.dll
TmImport	Sdl.Tms.TmImport.dll
TmsLogsArchiver	Sdl.Tms.Archiving.dll
TranslationMemoryMaintenance	Sdl.Tms.Archiving.dll

Tags: SDL Archiver, Services

Logger

Andrew Chapman (former member) — Mon, 12 Sep 2016 08:42:04 GMT

Current Revision posted to Wiki by Andrew Chapman (former member) on 9/12/2016 8:42:04 AM

Logger is the service which will control the logging of SDLTMS activities. All SDLTMS and customisations will use this service to record events.

The service is continuously running and will also manage the handling of the logs. SDLTMS settings will allow a limit to be placed on the size of individual log files before another log file is created.

The log files are split per service and can be viewed or downloaded from the SDLTMS > System section. The Archiver service includes a plugin that will clean up older log files by placing them in a zipped folder.

Tags: Services, logger

Queued actions - what's being processed?

Andrew Chapman (former member) — Tue, 23 Aug 2016 10:01:21 GMT

Current Revision posted to Wiki by Andrew Chapman (former member) on 8/23/2016 10:01:21 AM

The SDLTMS queued actions page will show you all the messages waiting (or currently) processing.

The indicator for knowing which queued message is currently being processed is that it will have the server name that is currently processing the message in the Server column.

It is not always clear to know which processes are queued and which are actually processing when there are multiple pages, however if you order by the server name the messages being processed will appear at the top of the page. If you refresh this screen a few minutes later you will be able to see which processes and corresponding identification fields have completed and which may be taking longer to process.

NOTE: the queued actions page captures a snapshot of the current processes in the queue, if there are multiple pages then the act of continuously refreshing this page from multiple users could add unnecessary strain to the server. At times like this periodic monitoring (30 seconds / 1 min) is advised.

Tags: System, Process management, Queued actions

Queued actions - whats being processed.

Andrew Chapman (former member) — Tue, 23 Aug 2016 09:59:51 GMT

Revision 1 posted to Wiki by Andrew Chapman (former member) on 8/23/2016 9:59:51 AM

The SDLTMS queued actions page will show you all the messages waiting (or currently) processing.

The indicator for knowing which queued message is currently being processed is that it will have the server name that is currently processing the message in the Server column.

Tags: System, Process management, Queued actions

System

Andrew Chapman (former member) — Tue, 23 Aug 2016 09:45:30 GMT

Current Revision posted to Wiki by Andrew Chapman (former member) on 8/23/2016 9:45:30 AM

The system page is available for operations and information on system wide settings that may be useful to an administrator of the system.

Depending on the privileges available this section may only be available to administrative users.

Tags: System

Mailer Service

Andrew Chapman (former member) — Wed, 30 Mar 2016 13:16:40 GMT

Current Revision posted to Wiki by Andrew Chapman (former member) on 3/30/2016 1:16:40 PM

Designed to handle the sending of emails from SDLTMS.

This is done in communication with the server message queues and can be broken down into :

timed emails
instant emails

Mailer service will log the sending of emails into mailer_log.xml within the configured log folder.

Tags: Services, sdl mailer

SDL Archiver

Andrew Chapman (former member) — Mon, 01 Feb 2016 09:41:35 GMT

Revision 6 posted to Wiki by Andrew Chapman (former member) on 2/1/2016 9:41:35 AM

SDL Archiver service is used to control the running of plugins within TMS.

Early days

Plugins

[[Cleaner]]	Sdl.Tms.Archiver.Cleaner.dll
CallHome	Sdl.Tms.CallHome.dll
CompressOldJobsArchiver	Sdl.Tms.Archiving.dll
CtaLogsArchiver	Sdl.Tms.Archiving.dll
DatabaseMaintenance	Sdl.Tms.Archiving.dll
EmpowerIntegration	Sdl.Tms.EmpowerIntegration.dll
EmtApplyExecutor	Sdl.Tms.Emt.Apply.dll
[[ItdUploadsArchiver]]	Sdl.Tms.Archiving.dll
[[JobsArchiver]]	Sdl.Tms.Archiving.dll
[[NewJobsArchiver]]	Sdl.Tms.Archiving.dll
ProjectTM	Sdl.Tms.ProjectTM.dll
[[Sweeper]]	Sdl.Tms.Archiver.Sweeper.dll
TbImport	Sdl.Tms.TbImport.dll
TcJobsArchiver	Sdl.Tms.Archiving.dll
TerminologyAnalyser	Sdl.Tms.Terminology.dll
TmExport	Sdl.Tms.TmExport.dll
TmImport	Sdl.Tms.TmImport.dll
TmsLogsArchiver	Sdl.Tms.Archiving.dll
TranslationMemoryMaintenance	Sdl.Tms.Archiving.dll

Tags: SDL Archiver, Services

NewJobsArchiver

Andrew Chapman (former member) — Mon, 01 Feb 2016 09:40:55 GMT

Current Revision posted to Wiki by Andrew Chapman (former member) on 2/1/2016 9:40:55 AM

When new jobs are created a log of the initial request and related files is stored on the system.

The new jobs archive retention period allows the number of days these files are stored for to be configured. After this time the files are archived from the system.

The logs are only available to network administrators and so would only typically be used for troubleshooting and backups.

Tags: SDL Archiver, Services

SDL Archiver

Andrew Chapman (former member) — Mon, 01 Feb 2016 09:26:09 GMT

Revision 5 posted to Wiki by Andrew Chapman (former member) on 2/1/2016 9:26:09 AM

SDL Archiver service is used to control the running of plugins within TMS.

Early days

Plugins

[[Cleaner]]	Sdl.Tms.Archiver.Cleaner.dll
CallHome	Sdl.Tms.CallHome.dll
CompressOldJobsArchiver	Sdl.Tms.Archiving.dll
CtaLogsArchiver	Sdl.Tms.Archiving.dll
DatabaseMaintenance	Sdl.Tms.Archiving.dll
EmpowerIntegration	Sdl.Tms.EmpowerIntegration.dll
EmtApplyExecutor	Sdl.Tms.Emt.Apply.dll
[[ItdUploadsArchiver]]	Sdl.Tms.Archiving.dll
[[JobsArchiver]]	Sdl.Tms.Archiving.dll
NewJobsArchiver	Sdl.Tms.Archiving.dll
ProjectTM	Sdl.Tms.ProjectTM.dll
[[Sweeper]]	Sdl.Tms.Archiver.Sweeper.dll
TbImport	Sdl.Tms.TbImport.dll
TcJobsArchiver	Sdl.Tms.Archiving.dll
TerminologyAnalyser	Sdl.Tms.Terminology.dll
TmExport	Sdl.Tms.TmExport.dll
TmImport	Sdl.Tms.TmImport.dll
TmsLogsArchiver	Sdl.Tms.Archiving.dll
TranslationMemoryMaintenance	Sdl.Tms.Archiving.dll

Tags: SDL Archiver, Services

ItdUploadsArchiver

Andrew Chapman (former member) — Mon, 01 Feb 2016 09:25:53 GMT

Revision 1 posted to Wiki by Andrew Chapman (former member) on 2/1/2016 9:25:53 AM

This is based on the logs archiving retention period and will decide the number of days that SDLTMS stores records of uploaded files to SDLTMS for live jobs.

The name ITD uploads takes its name from the ITD files that has since been replaced by XLIFF as the standard bilingual file type for SDLTMS.

A translator downloads a bilingual file and works within it, at the point of upload the file (if successful) will import into SDLTMS. A record of the file and associated logs will be stored on the network.

This information is typically only used for debugging should there be any problems with the file at a later stage and a backup is needed. The files are only accessible to the network administrators.

Tags: SDL Archiver, Services

Job Archiving - weekly

Andrew Chapman (former member) — Fri, 29 Jan 2016 12:04:21 GMT

Current Revision posted to Wiki by Andrew Chapman (former member) on 1/29/2016 12:04:21 PM

Setting your Archiver frequency to weekly is useful if you do not want your system to be running any unnecessary processes during the week when the system may be busy and leaving this for a day when there is a period of 'quiet time' for all other areas of the system.

A typical scenario would be to have all the archiving done in the early hours of Sunday morning, this allows the Archiver to work with minimal impact on users who won't be working that day. Note that many network administrators may use Sunday mornings to perform windows updates and other routine maintenance and so it may be worth confirming that there will be no disruptions to the archiving one it has begun. If for example there is some downtime before the scheduled archiving time - the SDL Archiver Service will simply begin the archiving process when back online.

A consideration of this method is that the batch size would typically be larger that if you were archiving daily/hourly to compensate for the other 6 days without archiving.

Tags: SDL Archiver, JobsArchiver, Services

Archiving - why it is important

Andrew Chapman (former member) — Fri, 29 Jan 2016 11:58:27 GMT

Current Revision posted to Wiki by Andrew Chapman (former member) on 1/29/2016 11:58:27 AM

Archiving is an important part of SDLTMS long term use and making sure that your system is running as efficiently as possible. The general aim of this is to remove any unnecessary jobs, related files and database records that in large quantities can have a negative affect on performance.

Archiving removes completed jobs from the system, having and archiving strategy has several benefits to:

Database -less records to search through will benefit the efficiency of the database. A single job could have hundreds, even thousands of related records as we store all the related information and edits of segments.
Network files- live jobs are stored in a single network path. Keeping the number of files in this folder to a minimum will allow for faster network access when SDLTMS accesses and creates files within it.
UI navigation - a result of the above mentioned database benefits and file access. Many screens and reports will display the completed jobs and so delay their generation on screen. In addition - many resources have and "in-use field" which is populated by searching all live jobs that are using the resource. The more records in the system the longer this check will take to run and if a resource is in use - it cannot be removed from the system.

Not archiving jobs doesn't have too much of an impact in the short term as the detrimental affect of this is not noticeable, over longer periods of time SDLTMS can see performance related issues.

Once archived the jobs can be searched for within SDLTMS and the files can also be accessed and downloaded, the archived job data files are stored in a separate network path and so do not affect the day to day usage of live jobs.

Tags: SDL Archiver, JobsArchiver, Services

SDL Archiver

Andrew Chapman (former member) — Fri, 29 Jan 2016 11:56:21 GMT

Revision 4 posted to Wiki by Andrew Chapman (former member) on 1/29/2016 11:56:21 AM

SDL Archiver service is used to control the running of plugins within TMS.

Early days

Plugins

[[Cleaner]]	Sdl.Tms.Archiver.Cleaner.dll
CallHome	Sdl.Tms.CallHome.dll
CompressOldJobsArchiver	Sdl.Tms.Archiving.dll
CtaLogsArchiver	Sdl.Tms.Archiving.dll
DatabaseMaintenance	Sdl.Tms.Archiving.dll
EmpowerIntegration	Sdl.Tms.EmpowerIntegration.dll
EmtApplyExecutor	Sdl.Tms.Emt.Apply.dll
ItdUploadsArchiver	Sdl.Tms.Archiving.dll
[[JobsArchiver]]	Sdl.Tms.Archiving.dll
NewJobsArchiver	Sdl.Tms.Archiving.dll
ProjectTM	Sdl.Tms.ProjectTM.dll
[[Sweeper]]	Sdl.Tms.Archiver.Sweeper.dll
TbImport	Sdl.Tms.TbImport.dll
TcJobsArchiver	Sdl.Tms.Archiving.dll
TerminologyAnalyser	Sdl.Tms.Terminology.dll
TmExport	Sdl.Tms.TmExport.dll
TmImport	Sdl.Tms.TmImport.dll
TmsLogsArchiver	Sdl.Tms.Archiving.dll
TranslationMemoryMaintenance	Sdl.Tms.Archiving.dll

Tags: SDL Archiver, Services

JobsArchiver

Andrew Chapman (former member) — Fri, 29 Jan 2016 11:55:33 GMT

Current Revision posted to Wiki by Andrew Chapman (former member) on 1/29/2016 11:55:33 AM

Responsible for archiving jobs. The plugin runs and checks if it is time to begin archiving based on the date the last archive was performed and the archive frequency settings in SDLTMS.

Archiving process summary:

The list of eligible jobs are gathered for archiving.
The contents of the job folder is copied to the archive location.
The Job XML file is created and further XML files for each of the tasks. These files contain the necessary information from the live job in the database such as segment changes and comments, costing information, task events history and other general information that may be useful at a later time. These files are added to the folder in the archive location.
This archive folder is zipped up for efficient storage.
The live records are deleted from the database (the data is now stored in the archived zip file).
A record is added to the TMS database for the archived job and task - this is used as an index for searching for archived jobs and for searching for perfect match candidates.

Note: SDLTMS does keep a record of all the tasks and jobs within the invoicing tables. This is to keep an accurate store of the current and historical financial data for reporting, this information is never removed from the database.

This process isn't process heavy but does access network resources and database resources and so if you are interested in making your system run as efficiently as possible and concerned about any usage that can be avoided then it is beneficial to tailor your archiver settings to suit your usage.

Tags: SDL Archiver, JobsArchiver, Services

CTA logs

Andrew Chapman (former member) — Tue, 13 Oct 2015 09:23:30 GMT

Current Revision posted to Wiki by Andrew Chapman (former member) on 10/13/2015 9:23:30 AM

CTA logs are files stored on the server relating to CTA transactions that are made.

These files record the CTA requests and responses used when communicating with SDLTMS.

The logs are used for after the event investigations so that the request and response transactions can be assessed.

It is possible to enable/disable the logging of these files - this will have no detrimental affect on SDLTMS but does mean that any post event analysis may be limited.

Tags: CTA

CtaLogsArchiver

Andrew Chapman (former member) — Tue, 13 Oct 2015 09:14:38 GMT

Current Revision posted to Wiki by Andrew Chapman (former member) on 10/13/2015 9:14:38 AM

CtaLogsArchiver will periodically scan for files [[CTA logs]] (config, status, job, delivery, L10N request and response files) that have exceeded the retention period.

The retention period is taken from the SDLTMS>System>Services>Archiver>Archive data retention period.

Tags: SDL Archiver, CTALogsArchiver, Services

CtaLogsArchiver

Andrew Chapman (former member) — Tue, 13 Oct 2015 09:13:49 GMT

Revision 3 posted to Wiki by Andrew Chapman (former member) on 10/13/2015 9:13:49 AM

CtaLogsArchiver will periodically scan for files CTA logs (config, status, job, delivery, L10N request and response files) that have exceeded the retention period.

The retention period is taken from the SDLTMS>System>Services>Archiver>Archive data retention period.

Tags: SDL Archiver, CTALogsArchiver, Services

CtaLogsArchiver

Andrew Chapman (former member) — Tue, 13 Oct 2015 09:13:36 GMT

Revision 2 posted to Wiki by Andrew Chapman (former member) on 10/13/2015 9:13:36 AM

CtaLogsArchiver will periodically scan for files [CTA logs] (config, status, job, delivery, L10N request and response files) that have exceeded the retention period.

The retention period is taken from the SDLTMS>System>Services>Archiver>Archive data retention period.

Tags: SDL Archiver, CTALogsArchiver, Services