Escolar Documentos
Profissional Documentos
Cultura Documentos
User Guide
The Documentation Center of Excellence welcomes your opinion regarding this document. Please e-mail your comments and
suggestions to userdoc@allscripts.com.
Proprietary Notice
© 2015 Allscripts Healthcare, LLC and/or its affiliates. All Rights Reserved.
This document contains confidential and proprietary information protected by trade secret and copyright law. This document, the
information in this document, and all rights thereto are the sole and exclusive property of Allscripts Healthcare, LLC and/or its
affiliates, are intended for use by customers and employees of Allscripts Healthcare, LLC and/or its affiliates and others authorized
in writing by Allscripts Healthcare, LLC and/or its affiliates, and are not to be copied, used, or disclosed to anyone else, in whole
or in part, without the express written permission of Allscripts Healthcare, LLC and/or its affiliates. For authorization from Allscripts
Healthcare, LLC to copy this information, please call Allscripts Global Product Support Services at 888 GET-HELP or 888
438-4357. Notice to U.S. Government Users: This is “Commercial Computer Software Documentation” within the meaning of
FAR Part 12.212 (October 1995), DFARS Part 227.7202 (June 1995) and DFARS 252.227-7014 (a) (June 1995). All use,
modification, reproduction, release, performance, display, and disclosure shall be in strict accordance with the license terms of
Allscripts Healthcare, LLC and/or its affiliates. Manufacturer is Allscripts Healthcare, LLC, and/or its affiliates, 222 Merchandise
Mart Plaza, Suite #2024, Chicago, IL 60654.
Chapter 2: Controller.........................................................................................................21
Change the SQL Server instance name................................................................................21
eLink Controller main window................................................................................................22
Connections tab...............................................................................................................23
Add or edit a connection............................................................................................24
Local Server Status tab....................................................................................................26
Using system tray mode...................................................................................................27
Preferences tab................................................................................................................29
Launching the web console...................................................................................................29
Launching the designer..........................................................................................................30
Launching the Windows console...........................................................................................31
Help menu and About window.........................................................................................32
Logging and eventing functions.......................................................................................33
Menu bar..........................................................................................................................39
Using the translator menu................................................................................................40
Using the Queue menu....................................................................................................41
Using the Search menu....................................................................................................41
Using the administration menu.........................................................................................42
Using the Report menu....................................................................................................42
Using the Tools menu.......................................................................................................43
Using the Help menu........................................................................................................43
Using tabs........................................................................................................................43
Using the Main Console.........................................................................................................44
Understanding the system status.....................................................................................44
Using the Problem list......................................................................................................44
Understanding the System Statistics panel.....................................................................45
Using the operation log....................................................................................................46
Using the Translators tab.................................................................................................46
Perform operations on translators....................................................................................47
Using the Queues tab......................................................................................................47
Using the Translators/Queues tab...................................................................................48
Using the Projects tab......................................................................................................49
Work with translators..............................................................................................................49
Start a translator...............................................................................................................50
Understanding error messages........................................................................................51
Start a translator with dependency...................................................................................52
Stop a translator...............................................................................................................52
Stop a translator with dependency...................................................................................53
Restart a translator...........................................................................................................53
Install a translator.............................................................................................................53
Using rollback...................................................................................................................54
Using translator start/stop dependency...........................................................................54
Using the Dependencies tab............................................................................................55
Using the Sequences tab.................................................................................................55
Start sequence.................................................................................................................56
Stop sequence.................................................................................................................56
Clone a translator.............................................................................................................56
Using the EOT Marks and Screen Marks tab..................................................................57
Viewing EOT marks.........................................................................................................58
Edit EOT marks................................................................................................................59
Editing screen marks........................................................................................................59
Viewing screen marks......................................................................................................59
Saving changes................................................................................................................60
Using the Properties tab........................................................................................................60
Edit translator properties..................................................................................................60
Viewing properties............................................................................................................62
Viewing statistics of the internal database queue............................................................63
Work with queues...................................................................................................................63
Create a queue................................................................................................................64
Delete a queue.................................................................................................................64
Clear a queue...................................................................................................................65
Load queue records.........................................................................................................66
Restore queue records.....................................................................................................67
Using queue properties....................................................................................................67
Viewing queue properties.................................................................................................67
Edit queue properties.......................................................................................................68
Search logs and queues........................................................................................................68
Search logs......................................................................................................................69
Redefine log search criteria.............................................................................................71
Searching queues............................................................................................................73
Searching and editing translator properties...........................................................................75
Search translator properties.............................................................................................75
Edit translator properties..................................................................................................79
Searching and editing queue properties................................................................................84
Search queue properties..................................................................................................84
Edit queue properties.......................................................................................................86
Administration........................................................................................................................87
Configuring a project........................................................................................................87
Using the Translators tab.................................................................................................88
Using the User Defined Queues tab................................................................................89
Using the Internal Queues tab.........................................................................................90
Using thresholds....................................................................................................................90
Using system configuration....................................................................................................91
Using security.........................................................................................................................93
Using roles.......................................................................................................................94
Using built-in users...........................................................................................................94
Create a new user............................................................................................................95
Update an existing user...................................................................................................96
Delete an existing user.....................................................................................................96
Using effective permissions.............................................................................................96
Update the group membership of a user.........................................................................97
Using the built-in security group.......................................................................................98
Using Group Administration options......................................................................................99
Create a new group..........................................................................................................99
Update an existing group...............................................................................................100
Assign users to a group.................................................................................................100
Assign permissions to a group.......................................................................................101
Save user permissions...................................................................................................101
Delete an existing group................................................................................................102
Create a view only group...............................................................................................103
Using categories............................................................................................................104
Using the Operations list................................................................................................105
Password configuration..................................................................................................105
Explorer pane.......................................................................................................................132
Projects folder................................................................................................................133
Project Folder menu.......................................................................................................133
Translator Folder menu..................................................................................................134
User-Defined Queues folder menu................................................................................135
Internal Queues folder menu..........................................................................................135
Description pane overview...................................................................................................136
Using the translator menu..............................................................................................136
User-defined queue menu options.................................................................................137
Internal Queue menu options.........................................................................................138
Global Designer overview....................................................................................................138
Work with backup...........................................................................................................139
Auto-backup...................................................................................................................139
Restore archived items..................................................................................................144
Translator deployment...................................................................................................148
Set preferences..............................................................................................................149
Global Designer Explorer.....................................................................................................155
Create a project folder....................................................................................................155
Edit a project..................................................................................................................156
Delete a project..............................................................................................................156
Compile translators in a project......................................................................................157
Add translators to a project............................................................................................158
Delete translators from a project....................................................................................159
Create a user-defined queue.........................................................................................160
Modify queue properties.................................................................................................161
Add user queues to a project.........................................................................................162
Delete user queues from a project.................................................................................163
Add internal queues to a project....................................................................................164
Delete internal queues from a project............................................................................164
Add to SourceSafe...................................................................................................429
Check source out...........................................................................................................430
Get an item from SourceSafe...................................................................................432
Check source in.............................................................................................................434
Undo source check out..................................................................................................435
Index........................................................................................................................................469
Sunrise eLink
Sunrise eLink captures and sends data from systems using processes called host connections.
Sunrise eLink translates data through the use of translators. You can store any data captured,
translated, or sent through Sunrise eLink into a queue.
It is not necessary to manually start, stop, and administer the host connections and translators.
Use the Web Console tool to perform these functions. The instrument panel provides a graphical
view of the throughput of the interface engine. Use the Sunrise eLink interface design tool to create,
maintain, test, and build translator processes.
eLink Controller
The eLink Controller provides an easy user interface to register connections, and to launch the
Web Console and Designer. Use the Controller to start and stop the eLink Manager, Management
®
Server. The eLink Controller integrates with the Windows cluster application interface and
automatically detects and controls the clustered eLink Manager. The eLink Controller also detects
Sunrise eLink server availability. In a cluster environment, the eLink Controller can also synchronize
directories.
The eLink Controller application’s design combines the eLink Launcher and Management Server
Control. The application runs as a system tray application, however you can modify the configuration
information.
eLink Manager
eLink Manager is responsible for managing Management Server, Maid, alarms, security, and
application logging. The eLink Manager also provides the interfaces to respond to system requests
from the Web Console and external applications. Use the eLink Manager to install and activate
translators.
User data flows through each monitored translator. The data flows include monitoring queues and
logs, configuring systems, projects, alarms, Maid, and security.
Management Server
The Management Server serves only the requests of the Designer and manages the translator’s
auto starts and shutdowns.
Web Console
® ®
The Web Console is the browser-based (supports Microsoft Internet Explorer 10.0 or 11.0)
graphical user interface (GUI) for the Sunrise eLink system. Use the Web Console for Sunrise
eLink system administration. From the Web Console, you can start and stop translators and change
translator properties without recompiling Sunrise eLink. You can clone translators, manage queues,
manage logs, manage projects, set alarms, and perform various other functions.
Windows Console
Use the Windows Console for frequently performed tasks: starting, stopping, and installing
translators; searching queues and logs. You can also access the Designer from the Windows
Console. Use the Designer to create components.
See the Designer section for more information.
Related information
Designer on page 16
Designer
Use the Designer to create Sunrise eLink interface components. The Designer creates the structure
of the interface component. Use the Designer to configure the necessary functions and adapters
for access to the Sunrise eLink suite functionality. The Designer enables the construction of
translators without writing any code.
Break the input data into multiple records, each with multiple boxes, through sample input data.
Use the built-in functions to perform a variety of operations such as creating output records.
Additional operations include copying boxes, concatenating boxes, searching boxes, performing
arithmetic functions on boxes, and looking up boxes in code tables.
Translators can send records to various places, including host connections and the SQL database.
Field, statement, and database wizards are available to facilitate building interfaces. The Designer
also launches the deployment utility that deploys translators from 1 Sunrise eLink server to another.
The overall architecture of the Sunrise eLink interface engine is displayed in the following figure.
Controller
The eLink Controller is the main entry point to the Sunrise eLink applications. The application
displays as a system tray application; however, you can modify the configuration information. The
Controller gives access to the Console or Designer on any machine. The Controller enables support
personnel to help users who are unfamiliar with Sunrise eLink to quickly access the Console.
The primary functionality of the eLink Server Controller is to:
> Launch Web Console on both Sunrise eLink servers and clients
> Launch Designer on both Sunrise eLink servers and clients
> Launch the Windows Console on both the Sunrise eLink servers and clients
> Start or stop the eLink Manager on Sunrise eLink servers, with cluster awareness
> Start or stop the Management Server application
eLink Controller does not automatically start the eLink Manager service if it is not running. You
can control when the eLink Manager starts.
> \HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Eclipsys\Sunrise
eLink\Installer\Database\ElkQueueSQLServerName
> \HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Eclipsys\Sunrise
eLink\Installer\Database\SQLServerName
5. Start the eLink Manager.
6. Start eLink translators.
®
The configuration settings exist in XML in a configuration file on a per Windows user basis. Use
the following path to locate the file: drive:\Users\UserName\AppData\Roaming\Sunrise
eLink.
If you start this application while the application is running, a second instance cannot start unless
you are in a different session (for example, a Terminal Service session). Instead, the existing
®
instance displays. Search the Windows Application log to locate saved application logs.
Connections tab
On the Connections tab, a grid displays the Sunrise eLink server connections with the connection
name, Web Console, and the Designer.
Double-click the Connection Name column to access the grid to type and edit connection
properties. The following table describes the columns displayed in the Connection tab.
Column Name Description
Connection Name Name of the connection, such as Production, Test, and
Development. The default value is blank.
Web Console This column describes the connection name that helps build the
URL. You can edit the name at any time.
Designer This column describes the port number you use to connect to the
Designer on the machine. The default connection port number is
1961.
Windows Console The column describes the port number you use to connect to the
Windows Console on the machine. The default connection port
number is 1961.
Click the header to toggle the sort order of the columns. Right-click the empty space to display all
the options. Add Connection is the only enabled option.
The options listed under the Connection menu are:
> Open Web Console — opens the Web Console for the selected connection
> Open Designer — opens the Designer for the currently selected connection
> Open Windows Console — opens the Windows Console for the selected connection
> Delete Connection — deletes the currently selected connection
> Add Connection — creates a new eLink connection
Note: By default, Web Console URL uses the server name. If the
server name is localhost, the Web Console on the server is
http://localhost/SunriseLink. You can edit the Web Console
URL value and enables you to install the Web Console in a directory
other than the default.
Edit Connection opens.
Connection status
The eLink Controller connection tab window displays all eLink connection information, which
enables you to edit the information. An automatic background verification displays the status
connection with a red exclamation icon for each Web Console, Windows Console, or Designer
entry. The verification changes the color of the text to red if error conditions exist.
Verify connections
For the Designer or Windows Console, the verification ensures that the Management Server on
each server runs and accepts connections. For the Web Console, the purpose of this verification
is to check whether the logon window is accessible on the web server. The verification process
starts when eLink Server Manager starts and continues verifying regularly (this is configurable,
however, the default is once a minute). The verification results are shown in the main window.
A configurable interval polls the status. There are menu options to start and stop the eLink Manager.
The application displays a warning reminding you that shutting down the eLink Manager stops all
running translators.
Advanced gives you the ability to start and stop the Management Server. The same warning
displays when the Management Server stops. If the eLink Manager is a clustered resource, the
start and stop operations automatically connect to a Windows cluster resource and take the
appropriate actions to bring the eLink clustered resource on or offline.
The color of the Synchronization icon indicates the status of the Sunrise eLink directory
synchronization. In addition, you can start the Sunrise eLink directory synchronization by clicking
Synchronize. These features are available only on a Windows cluster environment.
Note: Notice the green arrow icon in the following figure. This icon is
either a green or red.
Configuration enables you to choose whether the application minimizes to the System Tray or the
Windows Task Bar. Double-click the System Tray icon to restore the Main window.
Use your cursor to right-click the System Tray icon and display the menu. The menu has options
to start and stop the eLink Manager on the local machine only. A sub-menu enables you to start
and stop the Management Server. A sub-menu prevents you from accidentally selecting one of
these options instead of the eLink Manager. Menu items also exist to launch each registered
Console and Designer.
Use the following step to access the System Tray menu.
> Right-click the eLink Controller Icon in Windows System tray.
The following figure displays the options under the Advanced menu.
Preferences tab
The Preferences tab enables you to choose the following user preferences.
> Font to display registration information
> Background connection interval. The minimum interval allowed is 30 seconds and 1 minute is
the default. The maximum is 5 minutes.
> Default sort order for the grid
> Minimize to System Tray option (by default, the check box is selected)
> Maximum number of connections to show. Right-click the system tray menu to view the maximum
number of connections to show. This preference prevents users with multiple saved connections
from having a menu that scrolls off the window.
Click the URL column in the eLink Controller to launch the Web Console.
Sunrise eLink Console opens. If your facility uses Helios Security, use your network user
name and password to log on to Sunrise eLink.
Note:
If the Designer is launched earlier, the machine restores the opened
Designer.
If Helios Security is installed, the Allscripts Gateway Logon opens.
Web console
The <server name> is the name of the server that eLink is running on. If eLink runs locally
(on the same machine that you are using), the <server name> is localhost.
Web Console
The Web Console is the command center for Sunrise eLink. Use Web Console to administer and
monitor translators, queues, and review the project status. Web Console also provides valuable
information on the status of the logs and queues and their association with each translator. Use
Web Console to perform global functions such as system configuration and log or queue searches.
Note: When you access a window's boxes, the box color changes to
indicate activity. The activity may be a change to the box or use of the
drop-down to determine the available options.
Banner configuration
Sunrise eLink enables you to configure a portion of the banner to display your organization’s logo.
Use the configuration settings in the <appSettings> section of the web.config file to configure
the top left section of the banner image and title.
Status bar
The status bar displays the:
> User name
> Time of the user’s last log on
Menu bar
The menu bar provides access to the following menus:
> Translator
> Queue
> Search
> Administration
> Report
> Tools
> Help
Note: Menu items are enabled based on the user's security credentials.
Within the Translator menu, you can perform the following functions:
> Stop — stop translators
> Start — start translators
> Restart — restart translators
> Start/Stop Dependencies — configure translator start and stop dependencies
> Install — install translators
> Rollback — rollback translators
> Clone — clone translators
> Properties — view or modify translator properties
Related information
Working with translators on page 351
Related information
Work with queues on page 63
Using tabs
Web Console contains 5 tabs that represent the application's status from different perspectives:
> Main Console — displays the application's status (health), Problem List, System Statistics
Panel, and the Operation Log Panel
Related information
Using thresholds on page 90
Note: Only authorized users can use the Clear Log feature.
Use the Clear Log feature to clear the entire operator log. Operator log messages write to the
main Sunrise eLink log. The messages remain in the Sunrise eLink log until the eLink Maid clears
them.
> To display the translators for that project, select a specific project.
> To display all system translators, select All.
The list of translators and their status are displayed.
The Current Project drop-down works the same as the translators tab.
Start a translator
The start process for translators might vary depending on the translator type. If you start a batch
type translator, the Batch Translator Input Parameter window opens before starting.
You must fill in the following boxes to start the batch translator:
> Database
> Server
> Login
> Password
Note: If you are using an input file, do not use the preceding parameters.
You only need the parameters when you select Use Database to input
data.
Use the following steps to start a translator.
1. Select a translator.
2. Press Start.
If you press Start before choosing a translator, an error message is displayed.
If you press Start with more than 1 translator chosen, the status of multiple translators are
displayed.
If a newer version of the translator exists, Sunrise eLink displays the Operation options for
a New Version Translator window and the following actions become available:
> Install and Run — installs and runs a newer version of the translator
> Run — runs the existing version of the translator
> Ignore — ignore and do nothing
3. Select an action.
4. Press Submit to continue.
After successfully starting the translators, the Start Translator Actions window opens.
Stop a translator
Use the following steps to stop a translator.
1. Select a translator.
2. Press Stop. A window opens with the results of the stop request. The following is a list of
possible responses:
> Failed to stop the selected translator. Check log for more details.
> Translator did not stop gracefully and was forcefully terminated.
> Successfully delivered termination request to the selected
translator.
> The selected translator was already stopped.
> The selected translator was stopped successfully.
Restart a translator
The restart operation initially sends a stop command to the selected translator, and then immediately
sends a start command to the translator. The Results window displays both the stop and start
messages.
Install a translator
The install operation installs a compiled translator which is ready to run. The install operation
displays information similar to the start function.
The following messages are displayed on the line items of the translator:
> Could not install translator. Translator needs to be compiled.
> Successfully installed translator.
> "<file name>": is read only.
> That translator could not be found.
Using rollback
Rollback restores the translator to the previous version. It is very useful when the newly installed
version does not work well and it becomes necessary to rollback to a previous version. The
Rollback window displays the following messages:
> Translator must be stopped before rollback.
> Could not rollback translator; check log for more detail.
> Rollback succeeded.
> That translator could not be found.
Start sequence
The translator’s dependencies determine the start sequence.
Stop sequence
The translator’s dependencies determine the stop sequence. It is not necessarily the reverse of
the start sequence. Because eTCPClientNT is a dependent of eTCPServNT, stopping the latter
impacts the former. You must stop the eTCPClientNT translator before the eTCPServNT translator.
Clone a translator
In addition to the clone functionality in Designer, you can use Web Console to clone a translator
with or without the source code.
Note: You cannot modify cloned translators without a source code nor
can you modify cloned translators that were compiled in the Designer.
Figure 52: View EOT Mark property of the selected translator tab
1. Select the EOT Marks tab to edit EOT marks for the selected translator.
The Hex and Text boxes are displayed.
2. Make your edits.
> Update Screen Mark — select a screen mark you want to update and modify its pointer position
and then press Update
> Delete Screen Mark — select a screen mark that you want to delete and then press Delete
> Save — press Save to save your changes
> Cancel — press Cancel to discard your changes
Saving changes
On the Property window, there are 3 icons at the bottom of the translator property window:
> To save changes, click Save. A message is displayed at the top of the page indicating that the
operation succeeded.
> To close the window, click Cancel.
If you make a change to the Property window and then select another translator, a window opens
to remind you to save the changes before you navigate away from the current translator.
Select the information icon next to the property name to display the description of the property.
Click anywhere on the window to close the description window.
Note: Edits do not affect a running translator. You must stop the translator
and re-start it for the changes to take effect. Saved changes take effect
after a translator restarts.
Use the following steps to edit a translator’s properties.
1. Select a translator from the list on the left side (tree display) of the window.
2. Make changes to the properties on the right side of the window.
3. Click Save.
Viewing properties
Use the following step to view a translator’s properties.
> Select a translator from the left panel. The right panel displays the properties of the selected
translator.
Similar to the Clone window, the properties are displayed in a list by name, value, and description.
The EOT Marks or Screen Marks are displayed in their own tab.
Figure 56: View internal database queue statistics of the selected translator
Create a queue
Use the following steps to create a queue.
Best Practice: If you select Use custom value, enter a value less
than or equal to the default retention (default value is 7). Queue
retention value higher than 7 can severely affect the performance of
the application.
If you set the queue retention value higher than the default value, a warning is displayed.
5. Click Submit. The system creates the specified queue. The execution result displays on the
window.
Delete a queue
Use the following steps to delete a queue.
A confirmation message lists the selected queue and asks you to confirm the deletion.
3. Press OK.
Clear a queue
Use the following steps to clear a queue.
1. Select a queue.
2. Press Purge on the Queue menu.
A confirmation window lists the selected queue and asks you to confirm the removal of the
queue contents.
1. Enter the name of a queue backup file in the file name box or browse to select a file.
2. In the Into box, select an option from Original Queues, Existing Queue, or New Queue.
3. In the To box, select the initial status of records in the queue.
4. Enter the number of records to restore. Use 0 to restore the entire backup file.
1. Select an individual queue in the left panel and the queue properties are displayed in the right
panel. You can edit the following queue properties:
> Description
> Queue Retention (retention days)
2. Press Save. A window displays the queue property changes.
Search logs
Use the following steps to conduct a log search.
Note:
You can save the search criteria for future use, rather than re-entering
it every time you perform a search. After you select your search
criteria, select <New Criteria> from the list, enter a unique name for
the search criteria, and then click Save & Search. Sunrise eLink
saves the criteria, which can be retrieved later by selecting the criteria
name from the criteria list. To delete the saved criteria, select the
criteria name from the list, and then click Delete.
To retrieve all searchable items, leave the record contains box blank
and then click Search. The use of wild cards, asterisks, and Esc
(escape) functions, normally associated with searches, are not
available in Sunrise eLink.
3. Click Search.
Log Search Result opens.
> If you do not select the date time range check boxes, all log entries are displayed.
> If you do not select the severity check boxes, all severity types are searched.
> If you select a few translators and components, eLink returns a list of log entries that relate to both
the translators and the components. Because the translators and components rarely share common
log records, it is very likely that no records return.
> If you select multiple queues and odometer ranges, eLink returns a list of log entries that belong to
a list of selected queues containing the odometer.
> If you search log message key words, eLink returns a list of log entries that has the key words.
> If you select several translators and a few queues, a list of log entries for the selected translators
and a list of the selected queues are displayed.
> If you select a translator and unselect all queues, eLink returns a list of log entries that associates
with the selected translator and all log entries for all queues in the application.
If a log entry contains a queue name and an odometer number, the queue name and odometer
are displayed in the Queue, Odometer column as a hyperlink. Select the hyperlink to display the
Queue Record Display window. The Queue Record Display window displays the details of the
record in the queue.
For example, click the Q1,1 hyperlink to display the Record Display window.
Figure 69: View queue record from log search result window
Click the Back to Log Search Result hyperlink to return to the Log Search Result window.
Note: You can ignore an Anomaly result in the Type box of the Log
Search Results window because it has no affect on the operation of
Sunrise eLink, translators, or the search process.
Searching queues
Use the same steps for a log search to perform a queue search. You can choose 1 or more of the
following search criteria:
> Project
> Queues (hold the CRTL key and click the pointer to select multiple queues)
> Record status
> Received date time range
> Queue elapsed time range
> Odometer range
> Record key words
> Return order and the maximum number of returned records in a search
Note: To save the queue search criteria, follow the same steps as saving
log search criteria.
Note: The search criteria feature enables you to enter specific criteria to
retrieve and display only the applicable sub-set of queue records.
The window provides you with the Redefine Queue Search Criteria hyperlink to modify the search
criteria. To view the Search Result window, click Search. This window also provides you with the
Redefine Queue Search Criteria hyperlink.
Note: Pressing F5 or refreshing the browser does not load this window
correctly. Use Search Again to load the window.
Click the record to view the record’s details. You can review a record in 1 of the following modes
(Hex, Text, XML, HL7):
> Hex — displays the hex values and corresponding ASCII characters
> XML — displays an XML record that applies only to a record in the XML format
If a record is not in a valid XML format, it is not displayed in the XML tab.
> HL7 — displays an HL7 message (only applying to a record in Allscripts HL7 standard)
®
If a queue record is in a valid Allscripts HL7 format, it can be displayed in the HL7 tab.
Note: The HL7 tab selection enables you to view HL7 records regardless
of the prefix. This tab displays data before the MSH segment without
generating an error.
Related information
Search logs on page 69
> To remove multiple selected protocols, hold down the CTRL or SHIFT key while clicking the values
on the list, and then click the < icon
6. Click Show Properties.
Available Translator Properties lists the translator properties for the selected protocols.
7. For the Property Types filter, select property types to further filter the properties.
The following values are available:
> ALL
> Editable - Properties whose values can be changed.
> ReadOnly - Properties whose values can be accessed but not modified.
> Frequently Used - Common and frequently used properties.
The filter value selected affects the Available Translator Properties values.
8. For Available Translator Properties, select a translator property:
> To select all properties listed, click the >> icon.
> To select a single property, click a property name or enter the first few characters of the property
name, and then click the > icon
> To select multiple properties, hold down the CTRL or SHIFT key while clicking the values on the
list, and then click the > icon
9. (Optional) To remove selected translator property, do any of the following in Selected
Translator Properties:
> To remove all selected properties listed, click the << icon.
> To remove a single selected property, click a property name or enter the first few characters of the
property name, and then click the < icon
> To remove multiple selected properties, hold down the CTRL or SHIFT key while clicking the values
on the list, and then click the < icon
10. Click Search.
11. To view statistics for a translator, click the translator name link.
Translator Statistics displays information about the messages processed by the translator.
12. To see the name of the translator and the property that a value is for, point to a cell.
A tooltip is displayed. Values for the Name and Comment properties do not display a tooltip.
To temporarily turn the tooltip off, clear Show ToolTip.
13. To view values that are not completely displayed, adjust the column width.
14. To sort the results based on a particular property, click the column header.
15. To filter the results by a column value, do the following:
a) Click next to a column name.
An editable translator property has a white background. Properties with unsaved changes are
displayed in red text on a yellow background.
> Inline text edit – The property value can be entered using the keyboard. Press the Enter
or Tab key to apply the change.
> Inline number edit – The property value can be entered using numeric keys on the keyboard.
Existing values can be increased or decreased using the up or down buttons, or the up
and down arrow keys of the keyboard. Press the Enter or Tab key to apply the change.
> Value selection – The property value can be selected from the available drop-down list.
Press the Enter or Tab key to apply the change.
> Complex value – For the IPAddress, EotMark, Screens, and Comments properties, a
window opens where you can enter values. After changing the value, click Apply.
2. Click Save.
A confirmation message is displayed.
3. To confirm the save, click OK.
4. (Optional) To discard all changes, click Discard.
5. To undo unsaved changes for a particular translator, do the following:
a) Select the row containing the translator.
b) Right-click the property with unsaved changes, and then select Undo.
Tip: To select multiple consecutive translator rows, click the first row
you want to select, then drag the mouse to the last row you want to
select.
6. To edit properties of multiple translators in bulk, do the following:
a) Click the Bulk Update link.
b) For Select Property, select the property you want to update for all translators in the search
results by doing any of the following:
> Click the list and then select the property.
> Enter the first few characters of the property name to filter the list, and then select the
property.
c) Select or enter a value for the selected property based on the edit mode of the property.
d) For the EotMark, Screens, and IPAddress properties, a separate window opens where
you can enter values. When finished, click Apply.
e) For the Comment, EotMark, and Screens properties, choose an update option:
> To replace the existing value with the one you just entered, select Replace.
> To add the value you just entered to the existing value, select Append.
What to do next
Restart the translators for the changes to take effect.
The Retention Day value is limited to prevent Sunrise eLink performance issues.
d) Click Apply.
7. Click Save.
A confirmation message is displayed.
8. Click OK to confirm saving the changes.
If the search results are filtered, the bulk update updates the filtered results only.
9. To discard all changes, click Discard.
Administration
Use Administration to configure projects.
Configuring a project
Project configuration is similar to the Designer functionality. Create a new project or modify an
existing project on the Project Organize window. You can add translators, user-defined queues,
and internal queues to a new project or update these values in an existing project.
Using thresholds
Use the Threshold Configuration window to define which problems are displayed on the Main
Console window. You can select:
> A project to watch
> Translator status reported as problems
> Queue statistics
Use the following functions to:
> Reset — resets whatever the user has changed on the window
> Save — saves the configuration
Note: The Main Console displays only the problem list (translators and
queues) for projects configured on the Threshold Configuration window.
General section
The following general system setting are available:
> Do you want to start auto-start translators when eLinkManager restarts? (yes/no)
> Stopping auto-started translators when ManagementServer stops? (yes/no)
> Enable Translator Fast compile? (yes/no)
> ManagementServer Port
> Script File run by ManagementServer on Startup
> eLink Log Directory Location
The log location has been added to Maid configuration. The old log location is still active in the
Maid configuration. It is best practice to adjust the virus scanning software to exclude this directory.
Logging to the new location does not take effect until the eLink Manager restarts. The previous
log directory houses the existing log files until the normal Maid process clears them.
Database section
In this section, you can specify the following for the Tlkernel, ELinkCore, and ELinkQueues
databases:
> SQL server name
> Database name -- This value is read-only.
If you need to move 1 or more Sunrise eLink database to a different instance of SQL Server, or
you need to change the SQL user credentials, update the values in this section.
Before saving, click Test Connection and ensure the test is successful.
Search section
In this section, you can specify the maximum number of log and queue records to be returned by
the log and queue search functionality.
Alarm section
In this section, you can specify how often, in seconds, alarms are polled.
Using security
The following section details Sunrise eLink’s security functionality.
Note: The security model from Sunrise eLink 4.0 is not upgradeable and
must be re-configured after you install Sunrise eLink 15.3.
Using roles
Sunrise eLink’s role-based security consists of Users, Groups, and Operations. The Users’ group
determines the user logon credentials, and Groups determine the permission for each operation.
A user’s group associations determine the operations the user can perform. The overall user
permission of the user consists of a combination of all the groups that the user belongs to.
On the left panel is a list of configuration items presented in a tree structure:
> Expand the Users node for user creation and updates
> Expand the Groups node for group creation and updates
> The Categories node displays the build-in categories of operations
> The Operations node displays all build-in operations that can be associated with group permission
> The Password Configuration node lets you configure password rules
1. Select a user.
2. Press Delete.
Note: You cannot delete the sa (system administrator) user.
Example: Create User Operator one. The user is automatically assigned to the Console User
Group, which gives the user read-only access to most features of the application. Next, add the
user to the Operator Group. Grant the start translators operation to the Operator Group.
The user, Operator one, can now access the Web Console and start translators.
Note: Users receive permissions at the group level not the user level.
2. Click Save.
1. Select the check box to include the user in the current group. If you want to exclude a user
from the current group, clear the check box.
4. Press Save.
> Deny — clear the check boxes on the allow column to deny certain permissions to users in this
group
The operations Security and Read Password Configuration are always allowed for the
Administrators group.
4. Press Save.
Using categories
The Categories list is a read-only list of a logical grouping of operations. This list represents the
broad areas of the Sunrise eLink system.
Password configuration
Password Configuration sets the password requirement with its minimum and maximum lengths.
After you select the directory path, select the Column box to modify the file extension and file size.
You can also add or change the information.
In the Extension box, you can add additional file extensions by separating the file extension with
a semicolon. For example, add *.doc after *.log, and then add *.txt. The result is displayed
as: *.log;*.doc;*.txt.
In the Maximum size box, enter a numerical value for the file size saved to the hard drive. The
maximum allowable space is 32,767 megabytes (MB).
The Include sub folders check box enables the application to clean sub folders of the selected
directory. Press Save to retain the changes.
Alarm tab
The Alarm tab displays a list of alarms and options to:
> Add
> Update
> Delete
> Clone
> View
> Enable
> Disable
> Test Alarms
> View Report
Add an alarm
Use the following steps to add a new alarm.
2. Select any tree node. The window changes to the corresponding web pages, which gives you
the authority to input settings.
Update an alarm
Use the following steps to update an alarm.
1. Select an alarm.
2. Press Update.
3. Make your changes to the alarm.
4. Press Save.
Delete an alarm
Use the following steps to delete an alarm.
1. Select an alarm.
2. Press Delete.
Clone an alarm
Use the following steps to clone an alarm. You can clone multiple alarms.
1. Select an alarm.
2. Press Clone. Sunrise eLink displays the Clone Alarm window.
View an alarm
Use the following steps to view an alarm.
1. Select an alarm.
2. Press View.
View Alarm opens.
Enable an alarm
Use the following steps to enable an alarm.
1. Select an alarm.
2. Press Enable.
Disable an alarm
Use the following steps to disable an alarm.
1. Select an alarm.
2. Press Disable.
Test an alarm
Use the following steps to test an alarm.
1. Select an alarm.
2. Click Test Alarm.
1. Click Add, Update, or Delete from the menu’s commands. To update or delete, select the
check box next to the existing item before performing a command.
If you click Add, the Add Alarm Item window opens and the translator box displays an arrow.
Use the arrow to open the selection list for existing translators in the system.
If you select the Add menu, the Configure Queue Count Alarm Item window opens.
Use the following steps to use the Queue lag Alarm item.
1. Press Add.
1. Click Add, Update, or Delete from the menu commands. To update or delete, select the
check box next to the item before you perform a command.
2. From the menu command, click Add. The Add Alarm Item window displays the Process
Name box with an arrow which opens the selection list for existing translators and 3 additional
system processes:
> Management Server
> Designer
> Console
3. Select a process from the list.
4. Enter a search string in the Search String box to define the text that must be in the log file
of the process to trigger the alarm.
5. (Optional) Enter a description for this entry.
6. Click OK to save.
1. From the menu command, click Add. The Add Alarm Item window displays the synchronization
status:
> Synchronization process is not running
> Synchronization process is not successful
2. Select a status from the list.
3. Enter a description for this entry (optional).
4. Press Add to save the information.
> No Fire Keyword contains — Does not trigger an alarm when the keyword matches partially.
You can use multiple keywords in the same alarm.
Schedule an alarm
Use Schedule to set up alarm schedules.
Creating a notification
Use Notification to display the Notification window. Select either Email or Command line
notification.
1. In the Command Line box, enter the name of the executable program for example,
notepad.exe.
Note: For the command line notification to work, you must have eLink
installed as a service. Enable and start the eLink manager service to
interact with the desktop and Windows messenger services.
2. To view the Alarm Notification Email Configuration window, press Create.
Using a blackout
Use the blackout feature to set time periods where alarms should not sound in case of an unusual
circumstance. For example, if an Sunrise eLink translator sends a message to System E and
System E is down for maintenance every third Saturday night of the month from 1 AM - 2 AM, the
records queue up to the application because it does not receive anything during the downtime. If
there is an alarm on that Sunrise eLink queue, an alert would alert someone that Sunrise eLink is
unable to send messages to that system.
Because the downtime is expected, there is no need to send an alarm. Use a blackout to suppress
the alarm. When the target system comes online, Sunrise eLink connects to that system. The
system routes the messages; however, the alarms do not sound. Before you can add a blackout
to an alarm you must configure the blackout.
Configure a blackout
Use the following steps to configure a new blackout.
3. Click Add.
Alarm opens.
2. Select the check box just left of the alarm you want to add a blackout to and then press
Update.
3. Under Alarm Items, on the left-hand side, click the Schedule link near the bottom of the list.
3. Enter the user input name, email server address, sender address, and the recipient address.
4. Press Edit.
5. Press Clear, and the Clear Email Profiles window opens. Clear deletes the information on
the right pane for you to re-enter the data.
6. Make the required changes.
7. To add a macro, select an item from the left pane and then click the arrow icon. The macro
displays in the edit box on the right pane.
8. Press OK to save. You can view the contents of an email profile.
Tools
Use Tools to set user preferences.
Using Preferences
You can make changes to Sunrise eLink user preferences to better suit your needs.
You can select a particular project to appear in the Main Console window each time you log on.
Additionally, you can select 1 of the following tabs to be displayed in the Main Console window
each time you log on:
> Main Console
> Translator tab
> Queues tab
> Translator/Queue tab
> Project tab
You can configure the refresh frequency in a range of 10 seconds to 600 seconds every time you
log on.
Change password
Use the following steps to change a password.
Note: The password is effective after the next logon. Use Change
Password to make changes. By default, console users can change
their own password, however the system administrator might disable
this permission from the Console User Group window.
Designer functions
Use Sunrise eLink Designer to create and modify translators. The Designer is the interface that
enters the code statements and processes the data. Launch the Designer and a window similar
to the following opens.
Translator menu
Use the translator menu to access the functions listed in the following table.
Option Description
Derived Functions Use this option to create and maintain custom code statements.
Code Translation Use this option to create custom lookup tables for use in translators.
Restore Use this option to add or update one or more translators, derived
functions, code lookups, alarms, or blackouts.
Backup This option saves a redundant copy of one or more translators, derived
functions, code lookups, alarms, and blackouts to a specified file.
Exit Use this function to close the Designer.
Note: The translator menu contains additional options when the Edit
Translator window is open.
Tools menu
The following table lists the tools menu functions.
Note: The location of the Tools menu changes based on the addition of
menu options when the Edit Translator or the Edit Object windows are
open.
Option Description
Deploy Translators Use this option to launch the Deploy Translator utility.
Preferences Use this option to configure the general preferences for the application.
Related information
Translator deployment on page 148
Explorer menu
The following figure lists the Explorer menu functions.
Option Description
Hide/Show Explorer Use this option to hide or show the Explorer pane.
Move Explorer To Bottom/Top Use this option to move the Explorer pane to the bottom or
top of the Designer window.
Undock/Dock Explorer This option enables movement of the Explorer pane to any
location in the Designer window, or docks the Explorer at
the top of the Designer window.
Refresh Explorer Tree Use this option to refresh the items displayed in the Explorer.
Window menu
The Window menu provides the standard Windows menu functions. Use these functions to arrange
items on the desktop.
Help menu
The following table lists the help menu functions.
Option Description
Designer Help Use this option to access Sunrise eLink's online Help feature.
About Use this option to access product specific information, such as the
version information.
Explorer pane
Use the project folders to organize the Explorer pane. The default All folder contains all the
translators and queues created in eLink. You cannot edit or delete the All folder.
Each project folder contains 3 sub-folders.
> Translators—This contains all translators associated with the project. You can create translators
within a specific project or add to a project.
> User-Defined Queues—This contains all user-defined queues associated with a project. Users
create the user-defined queues. You can create user-defined queues within a specific project
or add to a project.
> Internal Queues—This contains all internal queues associated with the project. Internal queues
associate with inbound and outbound translator data. The internal queues develop automatically
around the same time as the translator and exist in the All project. Internal queues reside in the
All project. You can add the internal queues to other projects as needed.
Use the Explorer pane to access specific options for project folders, translators, and user-defined
and internal queues. Right-click the folder or a specific item to produce options for project, translator
or internal, and user-defined queue maintenance.
Projects folder
The Projects folder opens when you right-click the projects folder in the Designer.
The option in the following table displays when you right-click the Projects folder.
Option Description
Create Project Use this option to create a new project
sub-folder.
Option Description
Edit Project Use this option to edit the project folder name and
description.
Delete Project Use this option to remove the project folder and all
associated translators and queues.
The following table lists the menu options available from the Translators Folder menu.
Option Description
Create Translator Use this option to create a new translator.
Compile Translator(s) in Project Use this option to compile all translators in the project
folder.
Add Translator(s) To Project Use this option to add translators to the current project
folder.
Delete Translator(s) From Project Use this option to remove translators from the current
project folder.
The following table lists the options of the User-Defined Queues folder menu.
Option Description
Create Queue Use this option to create a new user-defined queue.
Add Queue(s) To Project Use this option to add queues to the current project folder.
Delete Queue(s) From Project Use this option to remove queues from the current project
folder.
The Internal Queues folder menu options (see table below) are available from the Internal Queues
folder menu.
Option Description
Add Internal Queue(s) To Project Use this option to add internal queues to the
current project folder.
Delete Internal Queue(s) From Project Use this option to remove internal queues from
the current project folder.
Option Description
Create Translator Use this option to create a new translator.
Modify Properties Use this option to open the Modify Properties window for the selected
translator. Use to modify translator type, host properties, end of
transaction marks, or comments.
Edit Translator(s) Use this option to open the Edit Translator window for the selected
translators. Use this window to add or edit objects within the translator.
Clone Translator Use this option to copy the selected translator with a new name.
Delete Translator(s) Use this option to delete the selected translators.
File Import Use this option to import file into the translator for use in the creating
boxes and debugging processes.
Option Description
SourceSafe With the SourceSafe feature enabled in Preferences, use this option to
open a sub-menu containing functions to Get, Check out, Check In and
Undo Check out.
Compile Translator(s) Use this option to compile all selected translators.
Add Translator(s) To Use this option to add translators to the current project folder.
Project
Delete Translator(s) Use this option to remove translators from the current project folder.
From Project
Deploy Translator(s) Use this option to deploy the selected translators.
Option Description
Delete Queue(s) From Project Use this option to remove queues from the current project
folder.
Auto-backup
You have options for automated queue backup when using the QueueUtil program. You can add
the utility to an implementation’s regular backup procedures. You can write a translator to execute
the queue backup utility on a defined interval. Alternatively, you can execute the utility manually
from the command line.
For more information on the QueueUtil automated queue backup program, refer to the “Disaster
recovery and troubleshooting” section.
To backup an item:
Use CTRL or SHIFT to select multiple translators. Select All to backup all translators listed
on the system.
6. Click Highlight Used Functions and Codes to automatically select the derived functions
and code lookup tables used by the selected translators.
This option is useful when archiving translators.
7. Click the Derived Functions tab.
8. Do the following:
a) Select the derived functions to backup with the translators.
b) To select only derived functions used by the translators selected for backup, click Used
By Translators.
c) To select the derived functions used by the selected derived functions, click Used By
Functions.
d) To backup all derived functions listed on the system, click All.
9. Click the Codes tab.
The code translation tables used by the installed translators are listed.
What to do next
After you select all the items to backup, click Backup. Sunrise eLink saves the selected items to
the selected location in a .tlk file.
4. Do 1 of the following:
> To restore individual translators, select the translators.
> To restore all listed translators, press All or click the Overwrite Host Prop check box next to the
translators.
5. Select Restore Projects to restore translators to the user-defined project folders. If a
user-defined project folder does not currently exist, this function creates the necessary project
folder.
7. Under the Derived Functions tab, select the derived functions to restore. Press All to restore
all derived functions listed.
8. Select the Codes tab.
The Codes tab opens and lists the code translation tables available to restore.
9. Under the Codes tab, select the code translation tables to restore. Press All to restore all
code translation tables listed.
10. Select the Alarms tab.
11. Select the alarms to restore, if necessary. Press All to restore all alarms listed.
12. Select the Blackouts tab.
13. Select the blackouts to restore, if necessary. Select All to restore all blackouts listed.
Translator deployment
eLink can deploy a translator from one server to another using the Deploy Translators utility. The
Deploy Translators utility allows you to move compiled translators, either existing or new translators,
from one server to another. A typical use for Deploying Translators is to move translators from a
development server to a production environment. In this chapter, the source server is the server
that the translator moves from.
The target server is the server that receives the translator. Deploy Translators reduces downtime
when upgrading or creating servers. A common Deploy Translator scenario is as follows:
> A user creates or modifies a new translator on a test server.
> After testing is complete, the translator is ready to deploy.
> The Deploy Translator utility moves the translator to the target server.
> The system administrator schedules a short down time for the target server.
> The translator stops momentarily on the target server.
> The newly deployed translator installs on the target server.
> The translators restart on the target server.
Note: The eLink 4.5 release introduced the Deploy Translator feature. It
is not a backup or restore feature and it does not replace that feature built
into the Designer. The user cannot backup translators with this utility. The
Deploy translator feature assists copying translators from 1 server to
another only.
The procedures listed in this chapter assume that the user has either created or modified,
successfully compiled, and tested thoroughly a translator that is now ready for deployment.
Related information
Translator deployment on page 148
Set preferences
Sunrise eLink allows the configuration of certain Designer functions through the use of Preferences
under the Edit menu. You can configure preferences to control the functions in Designer. Use
the following steps to set preferences.
Option Description
Hide explorer when an translator is open Use this option to hide the Explorer pane of
the Designer window when a translator is
open.
Initially maximize the window to be created This option maximizes any window opened
inside the Designer within the Designer, such as a translator or
object window.
Close all open objects for an translator This option closes all object windows when
when the Edit Translator window closes the Edit Translator window closes.
Do not prompt for confirmation on delete This option prevents a confirmation message
from displaying when deleting statements,
boxes, or objects (when the Edit Translator
window is open), code types, or codes (when
working with Code Lookup tables.)
Disable Warning for using HEX type text This option does not display a warning
in ASCII Editor message when you type HEX text into the
ASCII text box.
Show this project when the Console and This option designates the project folder to
Designer start appear when the Console and Designer start.
The default folder setting is All.
Show internal queues in “All” project This option displays all internal queues
associated with translators on the Console.
Initial directory for Backup/Restore Specifies the initial directory for the backup
file save location and restore file open
location.
Initial directory for data import Specifies the initial directory to use when
importing data into translators or the
Debugger.
Option Description
Skip database wizard introduction This option does not display the Database
window Wizard Introduction window.
Overwrite Host Properties on Restore This option overwrites the host properties of
translators with the restored translator.
All Translators Selected by Default This option selects all translators, codes, and
functions in the Backup or Restore window.
Alarms and Blackouts This option selects all alarms and blackouts in
the Backup or Restore window.
The following table lists the options found in the Objects tab.
Option Description
Query for the number of This option displays a window to request the number
parameters to add with box of parameters to add to or delete from the statement
formatting such as source parameters or expression parameters.
Option Description
Maximum statement history This option specifies the number of statements to retain
in the History option of the Statements menu.
Initial default value for declared This option specifies the default value for all declared
number numbers.
Default size when a new box is This option specifies the default value for box size when
added you create new boxes.
Use a literal conversion to This option uses a literal conversion for all ASCII
EBCDIC for ASCII characters characters when displaying data in EBCDIC. For
example, when you select the Record for Test window,
the system assumes you are working with data in
EBCDIC format.
The system converts the data to ASCII so it is readable.
If you do not select this option, the text in the Record
for Test window displays unreadable text.
Default method for displaying This option determines the default method for displaying
records in the test window records in the Debugger. You can select ASCII or Hex.
> If you select ASCII, and attempt to debug a
translator, the Record for Test window displays text.
> If you select Hex, the window displays text on the
right side and the hex equivalent on the left side.
This option is useful to inspect the data for control
characters that might appear only as odd looking
characters in the plain text view.
Default Pad Characters for Fields This option determines the default value for pad
and Statements characters to use in new boxes and statements. You
can choose a value either in ASCII or Hex.
5. To enable SourceSafe for storing translator code and to configure SourceSafe parameters,
click the SourceSafe tab.
Option Description
Default SourceSafe project This option determines the default project folder
to use when storing translators in SourceSafe.
Working directory for default This option determines the location of the local
SourceSafe project directory to use when creating or modifying
translators stored in SourceSafe.
3. In the Name box, enter a name for the new project folder.
4. Optionally, in the Description box, enter a description for the project folder.
5. Press OK.
Sunrise eLink adds the new project folder to the Designer.
Edit a project
Use the following steps to edit a project.
Delete a project
Use the following steps to delete a project.
If errors occur as the translators compile, the Compile Errors window opens for the translator
it cannot compile. eLink omits the translator and continues compiling.
The compile function launches. All of the translators within the project folder compile.
3. Select the translators to add to the project. (Use the CRTL or SHIFT keys to select multiple
translators.)
4. Click OK.
Sunrise eLink adds the selected translators to the project folder.
1. From the Designer window, right-click a User-Defined Queues folder (or a user-defined
queue).
3. In the Name box, type a name for the new user-defined queue.
Use alphanumeric characters only.
4. In the Description box, enter a description for the queue.
5. In the Queue Retention section, select the option that corresponds to the desired retention
period.
Sunrise eLink automatically selects a default value from the Config function of the Console
for new queues.
6. Select Use custom value, and then enter a value in the entry box.
Custom values override settings from the Config function.
7. Click OK.
Sunrise eLink adds the new user-defined queue to the User-Defined Queues folder in the
selected project and the All project.
1. From the Designer, highlight the user-defined queue to edit, and then right-click.
3. Select the queues to add to the project. (Use the CRTL or SHIFT keys to select multiple
queues.)
4. Click OK.
Sunrise eLink adds the selected queues to the project.
1. From the Designer window, right-click a user-defined queues folder (or a user-defined queue).
1. From the Designer window, right-click an internal queues folder (or an internal queue).
2. From the menu, select Add Internal Queues To Project.
3. Select the queues to add to the project. Use the CRTL or SHIFT keys to select multiple queues.
4. Click OK.
eLink adds the selected queues to the project.
1. From the Designer window, right-click an internal queues folder (or an internal queue).
2. From the menu, select Delete Internal Queues From Project.
3. Select the queues to remove from the project.
Use the CRTL or SHIFT keys to select multiple queues.
4. Press OK.
eLink removes the selected queues from the project.
Translator overview
Translator types
A translator type defines the basic capabilities the translator can supply. You can select different
types of translators when you create a new translator in the Designer.
program through Output to Module and sets the Module to the name of the input device connection.
Only one set of data passes back to the caller. If the output to module receives multiple calls, the
data contained in the last call apply.
The return value from the root object returns to the calling program. Use the Output to Module
option only to send data back to the calling program. Do not use the Output to Module option to
send messages directly to other translators. If you need to send messages directly to other
translators, use Send Message to send data to a TCP/IP server translator, which sends messages
to other translators.
Other real-time translator types have different message processing requirements depending on
their access protocol. However, all translators receive messages for translation through their
internal queues. The translators continue to translate the messages as required and respond
outbound through OutputToModule calls.
Host connection
eLink offers a multitude of host connection types to connect to various systems and applications.
Different translator types offer different host connection protocols.
Note: You can change the host properties for all translators without
recompiling. You must restart a translator for the changed host properties
to take effect.
While each host connection protocol is unique, there are many parameters that are common among
host connection types. The following table describes these parameters.
Parameter Description Value
Record Size This parameter determines the maximum Varies according to host
number of bytes to capture from the port before connection type
sending the record to the translator.
Timeout This parameter sends a TIMEOUT record after 1 to 99 (A value of 0 means
a predetermined number of seconds pass no timeout.)
without the receipt of any data.
Queue Method This parameter determines whether transactions Choices are Memory
are memory queued or database queued. Queued or Database
Queued
Autostart This parameter determines if the translator starts FALSE makes the translator
automatically or manually (operator started) Operator-started; TRUE
when the machine starts. makes the translator
automatically-started at
boot-up.
Message Log If this property is true when the interface starts, 1=True, 0=False
the message is translated or the interface stops.
The message gets logged to a message table,
which you can query from the Web Console.
InternalLog This Boolean value indicates whether the 1=True, 0=False
translator should write translator diagnostic
messages to the eLink logging system.
The following sections provide an overview of the host connections available in eLink for creating
all types of translators. For more detailed information on each type of host connection, consult the
Sunrise eLink Online Help.
File import
Use the File Import host connection with a batch type of translator. Use File Import connections
to read any file type. This type of host connection reads an input file and sends each record to the
translator’s data box as input.
The host connection reads the input file until the connection finds one of the End of Transaction
Marks (EOT Marks) or the RecSize number of bytes, whichever comes first. A timer translator,
which polls a directory to look for the presence of a file, uses the host connection often. When a
timer translator finds a file, it can start a batch translator to translate the file.
Before you create a translator with this host connection, configure the host properties as shown
in the table below.
Property Description Value
EOF Flag If True, an extra virtual record passes to the 1=True, 0=False
translator, but is not appended to the input file.
However, when the translator reaches the file’s
end, it does not realize it.
Before you create a translator using this host connection, you must configure the host properties
described in the following table.
Property Description Value
WorkSpace This property is the name of NetSoft workspace. Must match the name of the
Workspace in NetSoft
configuration.
ConnectionName This property is the name of the NetSoft Must match the name of the
connection associated with the SNA LU name. connection in NetSoft
configuration.
Connection This property is the name of NetSoft connection One character abbreviation,
Abbrev abbreviation associated with the connection which must match the name
name. of the abbreviation in
NetSoft configuration.
Before you create a translator using this host connection, you must configure the host properties
described in the following table.
Property Description Value
WorkSpace5250 This is the name of NetSoft workspace. Must match the name of
Workspace in NetSoft
configuration.
Connection This property is the name of NetSoft connection Must match the name of
Name5250 associated with the SNA LU name. connection in NetSoft
configuration.
Connection This property is the name of NetSoft connection One character abbreviation,
Abbrev5250 abbreviation associated with the connection which must match name of
name. abbreviation in NetSoft
configuration.
Before you create a translator using this host connection, you must configure the host properties
described in the following table.
Property Description Value
CambDirectory The directory for the Cambridge vxConnect
executable.
IdleTime This property represents the number of 1 to 9999999
milliseconds the screen must remain idle before
eLink considers the screen painted. DO NOT
use zero.
ScreenWidth This property represents the width of the screen.
ScreenHeight This property represents the height of the
screen.
Console Scraper
Use the Console Scraper host connection type to send and receive data to or from a DOS
application window.
Before you create a translator using this host connection, you must configure the host properties
described in the following table.
Property Description Value
ExecName This property represents the name of the
executable to scrape.
ExecDirec This property represents the directory where the
executable resides.
WaitTime This property represents the wait time (in 1-99
seconds) before sending a screen image where
an EOT does not exist.
Directory poll
The directory poll host connection type sends a directory list, specified by the host properties, at
a specified time interval. By polling a specified directory during regular time intervals, you can track
and take actions on the newly created directory files.
Before you create a translator using this host connection, you must configure the host properties
described in the following table.
Before you create a translator using this host connection, you must configure the host properties
described in the following table.
Property Description Value
DeskTopExe The fully qualified name of the executable for The fully qualified path. Path
Desktop 7000. The default value is: values are case-sensitive.
C:\TDSHCM\HGWSRV.EXE.
Retries This property represents the number of times 0-99
the translator attempts to launch Desktop 7000.
Before you create a translator using this host connection, you must configure the host properties
described in the following table.
Property Description Value
ShortName The Name of Extra Session File. The fully qualified path. Path
values are case-sensitive
IdleTime This property represents the number of 1-9999999
milliseconds the screen must be idle before the
screen is considered painted.
Visible This property represents Boolean value which
indicates whether the extra session is visible.
Before you create a translator using this host connection, you must configure the host properties
described in the table below.
Property Description Value
ShortName This property represents the name of the extra Include the fully qualified
session file. path. Path values are
case-sensitive.
EmulatorDirec This property represents the directory where the
NetSoft executables reside.
ProfileName This property represents the profile name for
the connection.
Note: Sunrise eLink translator templates are available for the device.
Before you create a translator using this host connection, you must configure the host properties
described in .
These applications are typically mainframe or mini-computer applications running a variety of IBM
operating systems.
Before you create a translator using this host connection, you must configure the host properties
described in the following table.
Property Names Description Restrictions
®
Gateway This property name represents the specific Choices are Microsoft
gateway system the translator SNA Server and Netware
communicates with to send SNA packets SAA Gateway.
to the invoked transaction program.
TPName This property name represents the
published name of the transaction program
(TP). This must match the definitions set
on the server side.
Confirm This property name sets whether the Choices are FALSE
translator uses confirmed (sync level one) (non-confirmed, sync level
or non-confirmed (sync level zero). This 0) or TRUE (confirmed,
property name also affects the number sync level 1).
and type of messages that the translator
Before you create a translator using this host connection, you must configure the host properties
described in the following table.
Before you create a translator using this host connection, you must configure the host properties
described in the following table.
Property Description Value
DefaultQManager The property represents the name of MQSeries If not present, the
queue manager object that the translator translator must call
attempts to open by default. OPEN and supply a
valid queue
manager name.
Before you create a translator using this host connection, you must configure the host properties
described in the following table.
Property Description Value
ShortName This property represents the session short Do not include the file extension
name for the connection. or path.
IdleTime This property represents the number of 1 to 9999999
milliseconds the screen must be idle before
Sunrise eLink considers the screen painted.
Before you create a translator using this host connection, you must configure the host properties
described in the following table.
Before you create a translator using this host connection, you must configure the host properties
described in the following table.
Before you create a translator using this host connection, you must configure the host properties
described in the following table.
Note: Sunrise eLink translator templates are available for this device
connection.
Before you create a translator using this host connection, you must configure the host properties
described in the following table.
Property Description Value
IPAddress This property represents the address of the Standard TCP/IP address
host used for the connections.
IPPort This property represents the port that the Numeric
application on the host answers. For
example, telnet uses port 23 and Internet mail
servers use port 21.
FailureNotify This property represents the option to send True or False
a SENDFAIL message to the translator on a
DATA send transmission failure.
Before you create a translator using this host connection you must configure the host properties
described in the following table.
Note: Sunrise eLink translator templates are available for this device
connection.
The downside to the multi-threaded server is that it takes more resources and memory. This
resource issue is particularly important if you are working in an environment with limited resources
or on a heavily loaded server. Ensure the individual client connections cannot share data between
each other like they can in the TCP/IP Server.
Each client connection receives the original values assigned to globally when a connection is
made; they do not receive modifications created during the client connections. Before you create
a translator using this host connection, you must configure the host properties described in the
following table.
Property Description Value
IPPort This property represents the port number specified by Numeric
other client processes to connect to the host
connection. Set the port number to > 5000.
Timer
Use the timer host connection to perform tasks at specified times of the day. Also use the host
connection to poll other systems or directories for incoming data.
Before you create a translator using this host connection you must configure the host properties
described in the following table.
Windows Scraper
Use the Windows Scraper host connection to retrieve or send data with any application used while
running Windows.
Before you create a translator using this host connection, you must configure the host properties
described in the following table.
Property Description Value
ExecName This property represents the name of the Windows
program to scrape.
ExecDirectory This property represents the directory where the
executable resides.
Translator as a DLL
The design of the Translator as a DLL host connection allows groups of functions to reside in a
central location. Thus, multiple translators can access the functions. This translator design enables
the concept of derived functions to apply to a more sophisticated level where you can have loops
and child objects inside functions.
Before you create a translator using this host connection, you must configure the host properties
described in the following table.
Property Description Values
RecSize This property represents the Varies according to host connection type.
maximum number of bytes
captured from the port before
sending the record to the
translator.
ObjectLog If set, the translator inserts log 1 = True
entries that record the time the 0 = False
object starts and the duration of
time to exit the object. These log
entries are accessible from the
Web Console.
connection works along with IIS for data processing. This translator type exists for performance
reasons and it resides in the memory.
Before you create a translator using this host connection, you must configure the host properties
described in the following table.
Property Description Value
WebTemplateFile This property represents the file name of web Fully qualified path to the
template to use with this translator. template file for the web
window.
CDLPath This property represents the path to the code Valid path name
lookup table.
platform-independent and can run on any web server. A new instance of this type of translator
must load into memory each time a request occurs.
Before you create a translator using this host connection, you must configure the host properties
described in the following table.
Property Description Value
WebTemplateFile This property represents the file Fully qualified path to the template
name of web template to use with this file for the web window
translator.
Create translators
Translator overview
A translator is a compiled executable that links systems with the eLink engine. A typical translator
consists of the following components:
> Input data—Any type of fixed or variable length data including, but not limited, to HL7, XML, a
CSV file, fixed length ASCII or EBCDIC data from a mainframe. Refers to any data that enters
into the translator as input from an outside source.
> Host Connection—The unique identifier of the data input for the translator.
> Internal Queue—This contains all internal queues associated with the project. Internal queues
associate with inbound and outbound translator data. The internal queues develop automatically
around the same time as the translator and exist in the All project.
> Global Object—The global object reads the configuration settings for the translator from an
external source like an INI file or a configuration database. Use the global object to delete or
reset log files for the translator.
> Root Object—The root object resides at top of the tree. A translator can only have 1 root object.
> Child Object—The child objects reside directly below the root object.
> Grandchild Object—The grandchild objects are created under the child object.
The figure below shows a typical translator.
1. From the Designer window, in the Explorer pane, right-click the Translators folder to add
the new translator.
Option Description
Add using template This option assigns a pre-built template to the translator. This option
automatically generates the code necessary for basic translator
functionality. This option is available and selected by default for these
translator types: Directory poll, LU6.2 Client, LU6.2 Server, TCP/IP
Client, TCP/IP Server, Timer.
The following table describes the available options on the Host Properties tab.
Property Description
IPAddress The remote machine to which a TCP/IP client translator connects to upon
startup.
Property Description
IPPort For a TCP/IP client translator, this is the port number on the remote machine
to which the translator connects to upon startup. For a TCP/IP server translator,
this is the port on which the translator listens to.
Notify on Send For a TCP/IP client translator, this is a flag that, when set to true, sends a
Failure record of SENDFAIL as input to the translator should the Output to Module
built-in statement fail to deliver a message over TCP/IP.
Timeout The amount of time (in seconds) after the translator’s host connection sends
the verb TIMEOUT to the translator as input if no messages have come into
the translator over TCP/IP and no messages have been sent from the translator
over TCP/IP.
RecSize This property represents the maximum number of bytes that can import at one
time. The default value is 64,000 bytes.
QueueMethod Determines if incoming transactions are queued to memory or to a database.
AutoStart This property allows a translator to run automatically when the Management
Server starts.
MessageLog This property allows you to log the input message to the internal log.
InternalLog This property allows you to log events to Sunrise eLink’s internal debugging
log.
Times tab
Use the Times tab to create the translator’s create time and touch time.
The following table describes the available options on the Times tab.
Option Description
Create Time This option represents the date and time of the translator’s creation.
Touch Time This option represents the date and time of the translator’s last
modification.
Create a translator
Use the following steps to create a translator.
1. From the Designer window, in the Explorer pane, right-click the Translators folder to add
the new translator.
2. Select Create Translator from the menu or select the Ins key.
3. In the Translator box, enter the name for the new translator.
Use only alphanumeric characters. The first character must be a letter. The Input Host
Connection box fills automatically based on the name entered.
4. From the Translator Type list, select the type of translator to create. This selection determines
the input host connection protocols available.
5. From the Input Host Connection Protocol list, select the host connection type to use for
the new translator. This selection determines the host properties that you must configure.
For certain host connection types, templates are available for creating the translator. These
templates populate the Host Properties with commonly used values, and create object
structures within the translator for common coding scenarios. These objects contain the
necessary boxes and statements for performing common tasks for the selected translator
type.
6. To add this translator by using a template, click the Add using template check box.
7. Press Save.
12. Right-click the empty list box to open the End of Transaction Marks menu.
14. In either section, enter the end of transaction mark for the translator.
15. Press OK.
The End of Transaction Mark tab re-opens with the end of transaction mark displayed.
16. Press Close.
Edit a translator
Use this window to access the global, root, and child objects that pertain to the translator. The
statements in an object can access boxes in itself, its parent, grandparent, great-grandparent, and
straight up the tree to the root and the global object. Statements cannot access boxes in objects
below them or in sibling objects.
When you open the Edit Translator window, the Designer menu options change.
Use the following steps to edit a translator.
1. Select a translator.
2. Double-click the translator name or by right-click the translator and select Edit Translators
from the Translator menu.
Translator menu
The following table describes the options of the translator menu.
Option Description
Test/Choose Record This option opens the Record for Test window, from which you can
launch the Debugger.
Compile Translator This option creates the translator executable or DLL.
Compile for This option compiles the selected translator to run in production but in
Instrumentation debug mode. This mode enables for the gathering of debug information
in a real production environment. The information runs through the
debugger to ascertain what condition occurred in production that is not
reproducible in a test environment.
Allscripts suggests that a translator compiled in this mode run for a few
minutes due to the enormous amount of debug information gathered.
After the translator gathers the information, the translator needs to
recompile without instrumentation (Translator > Compile Translator)
and re-installed into production.
Test Instrumented This option starts the Debugger with the debug files generated while
Translator running a translator from the Console which compiled for instrumentation
as described above.
Edit Breakpoints This option opens the Edit Breakpoints window. You can configure the
breakpoints used while debugging.
Option Description
Resolve Parameters This option enables you to see which statements refer to boxes or
Declared Numbers that are not present. This situation usually occurs
when a translator copies code from another translator or from one part
of a translator to another.
File Import This option enables translators to import records for debugging.
Purge This option clears the data queue for the current translator.
Create Report This option creates an HTML or text report detailing the specifics of the
translator.
Object menu
The following table describes the options under the Object menu.
Option Description
Undo This option reverses the last code change. Examples include
> deleting statements
> changing a parameter on a statement
> changing a box name
> changing an object name
> adding statements
This function can perform an infinite number of operations. This option does
not undo the creation or deletion of a translator, derived function or code
translation table.
Add This option adds a new object to the translator.
Update This option opens the currently selected object for editing.
Delete This option removes the currently selected object from the translator.
Move Up This option moves the object up in the tree.
Move Down This option moves the object down in the tree.
Cut This option removes the selected object from the translator and places it in the
clipboard.
Copy This option copies the selected object to the clipboard.
Option Description
Paste This option places an object from the clipboard to the translator below the
selected object.
Expand This option expands the current section of the translator tree.
Collapse This option collapses the current section of the translator tree.
Full Expand This option expands all objects in the translator to show all objects.
Full Collapse This option collapses all objects and only the root object name is visible.
Global Record This option opens the global object.
Search menu
The following table describes the options under the Search menu.
Option Description
Find This option provides a keyword search function for locating statements,
boxes or declared numbers.
Change References This option provides a way to change the box referenced by many
statements from one box to another. This option is useful if you need to
move a box higher in the tree (like in the root object). Thus more objects
can access/change it.
If a lot of statements currently point to the lower box, you can use this
option to move all those references to the new box.
View Last Errors This option displays a list of recent compile errors.
Clone a translator
Sunrise eLink can make a copy of an translator. When you copy a translator, the cloned translator
receives a new name. This function is useful when you need multiple translators to share the same
functionality.
Use the following steps to clone a translator.
3. In the New Translator box, type the name for the new translator.
The New Input Host Connection box automatically fills with the name.
4. Press Save.
Delete a translator
Use the following steps to delete a translator.
The creation of a new translator automatically creates the first object, or root either by adding a
new translator or cloning an existing one. The name of the root object is always [translator_name]
In, which indicates it is the object that receives the input data. The Data box in this object
automatically fills with the information from the host connection. The name of this box is always
Data and you can modify its size by editing the RecSize host property. The Data box serves as
the source of input for all the other boxes in the root object.
eLink operates under an object-hierarchy system. The execution of objects takes place in a top
down manner with the global object executing one time only at startup. The root object executes
every time the host connection receives a new record and passes the new record to the translator.
After the root object executes, the child and grandchild objects execute in the order dictated by
the coding of the translator.
Objects menu
The following table describes the functions that are available for object editing. You can access
the Object menu functions from the Edit Translator window. To open the menu, select Object
from the Designer menu, or right-click the object.
Option Description
Undo This option reverses the last code change. Some examples are:
> deleting statements
> changing a parameter on a statement
> changing a box name
> changing an object name and adding statements
This function can undo an infinite number of operations. This option
does not undo the creation or deletion of a translator, derived function
or code translation table. This function is available only on the main
menu. You cannot right-click to access this function.
Add This option adds an object under the highlighted object (see the “Add
objects” section).
Option Description
Update This option opens the currently selected object for editing (see the
“Edit objects” section).
Delete This option deletes the currently selected object (see the “Delete an
object” section).
Move Up This option moves the highlighted object up one position in the object
hierarchy list. The object’s level, or parent relationship, does not
change. You can move the object up through the drag and drop
process.
Move Down This option moves the highlighted object down 1 position in the object
hierarchy list. The object’s level, or parent relationship, does not
change. You can move the object down through the drag and drop
process.
Cut This option copies the currently selected objects to the clipboard and
deletes the objects. You can paste the object elsewhere. If the object
contains child objects, you must highlight the object to perform the
cut.
Copy This option copies the selected objects into a buffer. The list retains
the highlighted object, however you can paste the object elsewhere.
If the object contains child objects, you must highlight the item before
you copy it.
Paste This option pastes the cut or copied objects below the highlighted
object and creates a new entry with a unique name. Objects cannot
have the same name within the translator. The paste option copies
the boxes and statements within the object and those names remain
the same. Field names must be unique only within an object. Different
objects can contain identical box names.
Change Name/Comment This option enables the renaming of the object or editing of the
comment. You cannot rename the root object or the global object.
This option is available only in the right-click version of the Object
menu.
Create Report This option creates an HTML or text report listing the boxes and
statements in the highlighted object. This option is only available in
the right-click version of the Object menu.
Expand This option displays the first level children of the highlighted object.
Option Description
Collapse This option collapses (does not display) all objects (children) under
the highlighted object.
Full Expand This option displays all objects under the highlighted object.
Full Collapse This option displays only the root object (regardless of object
highlighted).
Global Record This option opens the global object. This function is only available on
the main menu. You cannot access the menu with a right-click.
Related information
Add objects on page 229
Edit objects on page 231
Delete an object on page 233
Add objects
Use the following steps to add objects to translators.
1. With the Edit Translator window open, right-click the object to add an object beneath, or
select Object from the menu bar.
Right-click an object to produce a modified version of the Object menu. Each of the options
in this menu has the same function as the equivalent option in the menu bar.
3. For Object Name, enter the name for the new object.
Object names can be up to 40 characters (alphanumeric only). Object names must start with
an alpha character. Do not use embedded spaces or special characters. Object names must
be unique within a translator.
4. For Comment, enter a comment about the purpose of this object, if needed.
This comment displays in the bottom of the Edit Translator window when you highlight the
object.
5. Click OK.
The new object opens on the tree.
Edit objects
Use the following steps to edit an object’s name or comment.
1. From the Edit Translator window, right-click an object to open the menu.
You can access the Change Object Name window by pressing F2 with the Edit Translator
window open.
3. In the Object Name box, change the name of the object, if necessary.
4. In the Comment box, add or change the comment, if desired.
5. When finished, click OK.
Delete an object
Use the following steps to delete an object.
1. With the Edit Translator window open, highlight the objects to remove.
2. Right-click and select Delete from the menu, or select Delete from the Object menu on the
Designer menu bar, or press Delete.
Note: To delete an object that contains child objects, you must select
both the object and its child objects.
Note: This function is useful when a new translator shares similar object
structure and functionality to one already created.
Use the following steps to copy objects between translators.
1. Open the Edit Translator window for the translator to copy objects from.
2. Open the Edit Translator window for the translator to copy the objects to.
3. Select the objects to copy.
Tip: Use the SHIFT or CTRL keys to select more than one object.
From the Object menu, select Copy (or use CTRL + C).
4. In the translator to copy the objects to, highlight the object beneath which you wish to paste
the new objects.
5. From the Object menu, select Paste (or use CTRL + V).
The objects paste beneath the selected object as child objects.
CTRL+ G. Use the global object to provide persistent box values that are available to all objects
in the translator. Field values are persistent across all records of the translator. This means that
after global runs the first time, the changes to the global boxes by record number one can be seen
by record number two and higher.
Any changes to the global boxes by one record displays in all future records that the translator
processes. Use the global object to read the configuration settings for the translator from an external
source like an INI file or a configuration database. Use the global object to delete or reset log files
for the translator. The global object is unique in that it executes once at translator startup. This
process is in contrast to all other translator objects that initialize every time a new record comes
through the host connection.
Use the following steps to access the global object.
1. With the Edit Translator window open, select Object from the menu bar.
Note: You cannot right-click the menu to access the global object.
3. Access the global object by pressing CTRL + G with the Edit Translator window open.
Both windows consist of two panes, boxes on the left and statements on the right. The boxes pane
defines the data boxes which stores data. The statements pane creates the code and manipulates
the stored data in the boxes.
Fields
Fields serve as data containers. You cannot always manipulate the raw data input from the host
connection directly. eLink creates boxes to hold portions of the input record or values created
through the data manipulation process.
The fields’ data displays in the box list. The first data box in the Edit Host Connection window is
the Data box. This box contains the raw data input to the translator from the host connection. The
Data box exists only in the Edit Host Connection window (root object).
Best Practices: Do not modify the value of the Data box. Instead, copy
its value to another variable and, if necessary, modify the value of the
variable.
You can configure new boxes using the Add Field window. You can edit existing boxes using the
Edit Field window. Both windows provide the same ability to define and edit a box definition.
The Add Field window enables you to enter general information about the box, such as name,
type, and size. In addition, you can choose the box padding and default values for the box.
You must define the template which eLink uses to populate boxes from the input record. You can
define the In Auto and Auto Repeating boxes as Absolute, Relative, or Delimited at both the start
and end of boxes.
Field Start/End Definition
Absolute The exact byte position (relative to zero) within the record.
Relative The position in the record relative to where the previous box
left off. For example, if boxC begins at position 50 in the
record and has a length of five, boxD starts at position 55.
The Data String left-hand displacement column in the Data
String window is set at +55 (current box). Click the first box
(byte) to define boxD’s Relative start.
Delimited The beginning and or ending delimiting characters (such as
CRLF) defines the position in the record.
eLink provides a data grid window with a horizontal offset ruler and a vertical offset column. Use
your cursor with the data grid window to select the start and end positions.
> The horizontal offset ruler is relative to zero. The first box is byte one.
> The vertical offset column is relative to zero.
When defining boxes in an object, the Relative Offset for the beginning of a box is relative to the
end of the previous box. For example, if the relative offset of the beginning of boxB is zero, then
boxB effectively starts at the byte after boxA ends. If the relative offset of the beginning of boxB
is seven, then boxB starts seven bytes after boxA ends (in effect, seven bytes are skipped).
To choose a delimited start or end, click the first and last character of the delimiter or manually
type the delimiter in the edit box.
The following table displays the options available in the Fields menu.
Option Description
Add This option adds a new box below the selected box.
Update This option updates the current box.
Delete This option deletes the selected box.
Set Break Point This option sets the selected box as a breakpoint for use during debugging.
You cannot use the Data box as a breakpoint. This option is only available in
the right-click version of the Fields menu.
Option Description
Move Up This option moves the selected box up one position.
Move Down This option moves the selected box down one position.
Cut This option removes the selected box and places it in the clipboard.
Copy This option copies the selected box to the clipboard.
Paste Above This option places the box from the clipboard above the selected box.
Paste Below This option places the box from the clipboard below the selected box.
Import/Export This option enables you to import or export box definitions. You can import
box definitions from a plain text file if they are in a particular format. Use this
feature to create box definitions from an electronic source instead of recreating
them manually.
Object Call This option opens the Edit Object window of the Child Object called by an
existing Auto or Auto-Repeating box.
Comment This option enables the creation of a comment for a box. The comment
displays in the right most column in the Fields pane.
Help This option accesses the Sunrise eLink Online Help feature.
4. Do the following:
a) For name, enter the name of the new box.
b) For Pad, enter a pad character for the box, if necessary.
The default pad character is defined on the Tools > Preferences > Objects tab.
c) For Size, enter the size for the new box.
The default size is defined on the Tools > Preferences > Objects tab.
d) In the Population section, click Manual.
e) In the Default box, enter the default value for the box, if necessary.
The left pane is for ASCII entry, the right pane for HEX entry.
Note: After entering a default value, click Size to make the box
size equal the length of the default value.
5. Do 1 of the following:
> Click Save to add the new box.
> Click Save/Add to save this box and add others.
> Click Save/Up to save this box and edit the previous box.
> Click Save/Dn to save this box and edit the next box.
6. Click the X in the upper right hand corner to close the window.
4. Do the following:
a) For Name, enter the name of the new box.
b) For Pad, enter a pad character for the box, if necessary. Use the Tools > Preferences >
Objects tab to define the default pad character.
c) For Size, enter the size for the new box.
The default size is defined on the Tools > Preferences > Objects tab.
d) In the Population section, click Auto.
The Call box and Add Object icon activate, the Default box deactivates, and the Begin and End
tabs are displayed.
5. Click the Begin tab.
6. Do the following:
a) For Relative offset, enter a relative offset for the beginning of the new box, if appropriate.
This value defines the beginning position of the new box relative to the end of the previous
box.
b) For Absolute offset, enter a relative offset for the beginning position of the new box, if
appropriate.
This value defines the beginning position of the new box as an absolute value starting at
the beginning of the input (or population source). The current box starts at this absolute
position and copies all the data from that position up to the position/delimiter defined in the
End tab so it does not matter where the last box ends.
c) In the Set Delimiter section, use the left pane to type a delimiter in ASCII format or the right
pane to type a delimiter in HEX.
This value defines the beginning position of the new box by specification of a delimiter.
After entering a delimiter, the Include delimiter check box activates.
d) Select the Include delimiter check box to include the delimiter value as part of the box
contents.
e) For Relative offset from delimiter, enter a relative offset from the delimiter for the beginning
of the box.
This value defines the beginning position of the new box relative to the specified delimiter.
8. Do the following:
a) For Relative offset, enter a relative offset for the end of the new box, if appropriate.
This value defines the end position of the new box relative to the starting position as defined
in the Begin tab.
b) For Absolute offset, enter a relative offset for the ending position of the new box, if
appropriate.
This value defines the end position of the new box as an absolute value starting at the
beginning of the input (or population source). It does not matter where the beginning of
the current box is defined because the current box ends at this absolute position.
If the beginning position is before this absolute ending position, the box does not populate
with data because you are basically asking, for example, for all data from position 42 to
position 10. (The second number must be higher than the first number for auto-populations
to work.)
c) In the Set Delimiter section, use the left pane to enter a delimiter in ASCII format or the
right pane to type a delimiter in HEX, if necessary.
This value defines the end position of the new box by specification of a delimiter.
The Include delimiter in box check box activates.
d) Select the Include delimiter in box check box to include the delimiter value as part of the
box definition.
e) For Relative search offset, enter a relative offset from the delimiter to search for the end
of the box.
This value searches for the end position of the new box relative to the specified delimiter.
9. Do 1 of the following:
> Click Save to add the new box.
> Click Save/Add to save this box and add others.
> Click Save/Up to save this box and edit the previous box.
> Click Save/Dn to save this box and edit the next box.
Related information
Set the auto population source for fields on page 260
Note: The steps for creating Auto Repeating boxes are identical to
those for adding Auto boxes. This section provides the additional
steps for creating the Auto Repeating boxes. Refer to the Add auto
fields section for basic box creation steps.
4. Enter the information into the Begin and End tabs for the new box.
6. Do the following:
a) For Relative offset, enter a relative offset for the end of the box repeat, if appropriate.
This value defines the end position of the repeat relative to the data.
b) For Absolute offset, enter a relative offset for the ending position of the repeat, if
appropriate.
This value defines the end position of the repeat as an absolute value.
c) In the Set Delimiter section, use the left pane to enter a delimiter in ASCII format or the
right pane to type a delimiter in HEX, if necessary.
This value defines the end position of the repeat by specification of a delimiter. For HL7
data, this is usually set to 1C0D which is the typical end of message delimiter.
When entering a delimiter, the Include delimiter in field check box activates.
d) Select the Include delimiter in field check box to include the delimiter value as part of
the repeat definition. For HL7 data, do not check this box if you used the Set Delimiter
option.
7. Do 1 of the following:
7. Click Load.
Note: You must have at least one record in a file to use this option.
A confirm window displays warning that eLink does not honor the EOT marks defined for the
translator.
8. Click OK.
9. Browse to the location of the data file to import for box definition, and then click Open.
The selected record opens in the Record For Test window.
10. Close the Record For Test window.
11. On the Add Field window, click Show Record.
The record displays in the Add Field window.
12. Click the Begin tab to define the beginning of the box.
13. Follow the prompts to choose the relative starting position for the box, the absolute offset, or
the delimiter.
14. To select the value, click the corresponding position in the record.
15. Click the End tab.
16. Verify the selection of the Show Record check box and follow the prompts to choose the
relative end position for the box, the absolute offset, or the end of the delimiter.
17. To select the value, click the corresponding position in the record.
18. When finished, click Save to add the new box.
1. Double-click the object you want to add boxes to in the Edit Translator window.
The Edit Host Connection or Edit Object window opens.
2. Right-click in the Fields pane.
4. Do the following:
a) For Name, enter the name of the new box.
b) For Pad, enter a pad character for the box, if necessary.
The default pad character is defined on the Tools > Preferences > Objects tab.
c) For Size, enter the size for the new box.
The default size is defined on the Tools > Preferences > Objects tab.
d) In the Population section, click Auto Repeating.
The Call box and Add Object icons enable, the Default box disables, and the Begin, End and
Repeat End tabs are displayed.
6. Click Load.
8. Browse to the location of the data file to import for box definition, and then click Open.
The selected record displays in the Record For Test window.
9. Close the Record For Test window.
10. On the Add Field window, click Show Record.
The record opens in the Add Field window.
c) Verify the selection of the Show Record check box and follow the prompts to choose the
relative ending position for the box, the absolute offset, or the ending delimiter.
d) Click the corresponding position in the record to select the value.
names and box sizes. When you import boxes, it is important to choose the exact delimiter used
in the text file. The format of the import/export file is the following:
<Field Name> <Delimiter> <Field Size> Carriage Return/Line Feed
For example:
PatientName,40 PatientGender,1 AcctNum,7
Use the following steps to export field definitions.
4. In the Delimiter box, type the delimiter to use when separating box names from box sizes.
5. Press Export.
6. Browse to the location to save the export text file to.
7. In the File name box, type (or accept) the export file name.
8. Press Save.
The fields in the object export to a text file.
4. In the Delimiter box, enter the delimiter used in the text file to separate box names from box
sizes.
This delimiter must match the delimiter used in the import text file.
5. To import the boxes as manual boxes, select the Manual check box.
All boxes import as manual boxes. If you do not select this check box, all boxes import as
auto boxes with a relative start position of 0 and a relative ending position equal to the size
of the box.
6. Press Import.
Modify fields
Use the following steps to modify a field.
Delete fields
Use the following steps to delete a field.
1. When defining the auto or auto repeating field, click the Call drop-down.
You must create objects in the translator before you use this drop-down. If the object does
not exist, click Add Object to add.
Note: Use these steps when a field should be a subset of the entire input
record.
Use the following steps to change the auto population source for an object.
This window displays all the fields defined in all parent objects.
Related information
Create derived functions on page 337
Parameters
The Source = provides the location of the data that you must supply to the statement before it
can execute. The Destination field = parameter defines the field that receives the new
data after the statement executes. Use the Expression = parameter to evaluate the data
(such as an arithmetic or logical condition).
In certain instances, Sunrise eLink defines a special parameter. A typical special parameter is a
Pad = line which defines a character to add to the destination field. The Return = parameter
provides specific feedback from the statement, such as returning the length of the string placed
in the destination field.
Note: The Return parameter is not considered a best practice for all
statements. The parameter always returns a number you can store in a
field or a declared number.
Statements menu
To access the Statements menu, right-click the statements pane, or select Statements from the
Designer menu. Use the menu to add predefined statements to the object and perform other
operations on the statements in an object.
The following table lists the options available in the statements menu.
Option Description
Add This option opens the Add Statement window. This menu categorizes
statements alphabetically by type.
Add… This option accesses the Add Statement submenu. This submenu categorizes
statements alphabetically by type.
History This option displays a list of the most recently used statements. You can
configure how many statements to remember in the User Preferences.
Update This option updates the parameter currently selected.
Delete This option deletes the selected statement.
Wizard This option accesses the Wizard submenu that provides automated methods
for configuring common statement types.
Option Description
Set as This option sets the selected statement as a breakpoint for use during
Breakpoint debugging. You cannot set certain statements, such as Comments, as
breakpoints. This option is not available from the Statements menu in the
Designer menu bar.
Move Up This option moves the current statement up one position in the statement list.
Move Down This option moves the current statement down one position in the statement
list.
Cut This option places the selected statement in the clipboard and removes it
from the statement list.
Copy This option duplicates the selected statement to the clipboard.
Paste Above This option places the contents from the clipboard above the selected
statement.
Paste Below This option places the contents from the clipboard below the selected
statement.
Duplicate Below This option duplicates the selected statements below the current statement.
Same as performing Copy and then Paste Below.
Full Expand This option lists all statement information in the statement list.
Full Collapse This option reduces the statement list to display only statement names.
Help This option accesses the eLink Online Help feature.
Parameter This option opens only with the following statements:
> Format Field Clear
> Format Field Concatenate
> Format Field with Delimiters
> Parse Fields between Delimiters
This option presents a submenu to add/delete Source or Destination fields to
the statement. Only these 4 statements provide the option to add or delete
parameters from the parameter list provided by default.
To access the Add, History, Set as Break Point, and Parameter options, right-click the Statements
pane.
Add statements
The statements pane of an object contains functions that process the data within this object or
data defined in the parent object. For a complete list of statements and their functions, refer to the
eLink Statements Guide.
4. From the Statements menu, you can select Add (the first option) to display the Add Statement
window.
The Add Statement window contains all the statements, organized into statement category
folders. You can control how the list is displayed, as follows:
> Expand the All entry in this window to see a complete list of all statements. The list is in
alphabetical order.
> Right-click and then select Full Expand to show all statements in all categories.
> Right-click and then select Full Collapse to collapse the list and show only categories.
> Double-click a category name or click the minus (-) sign next to the category name to
collapse a category (not display all the statements).
5. From the Statements menu, you can select Add... (the second option) to display a sub-menu
containing statement categories. Highlight the statement category to display all statements
within that category.
What to do next
You must populate each parameter within the statement before you debug or compile the translator.
Double-click or drag and drop the parameter to update it. Each parameter displays a unique
window, which enables you to enter the required data or select from a drop-down of available data
fields defined in this or the parent objects.
> Drag a box from the Fields pane to a parameter to set the parameter.
> Drag a parameter to a parameter (of the same type) within a statement.
> Drag a parameter to a parameter (of the same type) among statements.
> You cannot use drag and drop if the universal not sign (circle with diagonal slash) opens.
> Move a statement to another position by dragging and dropping the statement into its new
position.
Modify statements
Use the following steps to modify a statement.
1. From the Edit Host Connection window or the Edit Object window, right-click the statement
parameter to modify.
2. Select Update from the pop-up menu.
The update window opens for the selected parameter.
3. Double-click parameters to update them.
You can also use the drag and drop feature to place new values into the parameter.
4. Update each parameter in the statement as necessary.
Delete statements
Use the following steps to delete a statement.
1. With the Edit Translator window open, right-click the statements to remove.
You can delete a statement by highlighting it and pressing Delete. To highlight more than
one statement, use SHIFT or CTRL.
2. Select Delete from the Statements menu.
1. Open the Edit Object window for the object to copy boxes or statements from.
2. Highlight all boxes or statements in the translator to copy from.
3. Right-click in the pane and select Copy (or use CTRL + C).
4. Open the Edit Object window for the object to copy the boxes or statements into.
5. In the translator to copy to, highlight the box or statement to copy below and right-click in the
pane and select Paste Below.
6. Repeat for each object in the translator.
Note: It may be necessary to resolve parameters in the translator
that you copy boxes and or statements you copy.
Related information
Resolving parameters on page 405
Edit breakpoints
During translator code configuration, you can set both fields and statements within any object in
the translator breakpoints. eLink uses breakpoints during the debugging process. You can set a
preference using the Forms tab for the Debugger to automatically skip to the first breakpoint during
translator debugging.
The Edit Breakpoints option is accessible from the Designer’s translator menu only when a
translator is open.
1. To open the expression editor, double-click the numeric parameter to complete or select the
parameter and press Enter.
The expression editor opens with the Simple Expression tab displayed.
1. To open the expression editor double-click the numeric parameter or select the parameter
and press Enter.
When you configure a complex expression, configure the overall operator first. For example,
if the expression should be:
Data > 0 OR Test < 6
3. In this example, the first part of this complex expression to select is the Logical Or. Select the
overall Operator from the Operator list.
4. Configure the first operator in the subset. In the example above, the first operator would be
a Greater than. Select the first operator in the complex expression subset.
The operator opens in the Complex Expression tab.
7. Select the empty window icon at the bottom of the Complex Expression tab. Select the
operator for the second subset.
The operator opens in the Complex Expression tab.
8. Configure the remaining second operator subset. Highlight the first window icon under the
operator. Select either a field or literal value.
9. Highlight the second window icon under the second operator. Select either a field or a literal
value. Configuration of the second operator subset is complete.
eLink Wizards
eLink provides wizards to assist you in completing statement parameters and building translators.
The following table describes the wizards you can use to complete statements.
Wizard Description
Statement Use this wizard to add the same statements many times to a translator
when each statement has different parameter values and uses the
statements resident in the Statement Wizard. You can add statements
to the Statement Wizard.
Format Field Use this wizard to build either a Format Field Concatenate or a Format
Field Clear statement.
Database Use this wizard to create SQL queries of SQL queries.
Wizard Description
HL7 Use this wizard to parse or format fields, segments, and messages
through the use of the HL7 standard.
X.12 EDI Use this wizard to parse or format fields, segments, and messages
through the use of the X.12 EDI standard.
UB92 Form Use this wizard to parse fields from an input that is a UB92 form or
create output in the format of a UB92 form. This wizard is a graphical
wizard which allows field selection through a depiction of a UB92 Form.
HCFA-1500 Form Use this wizard to parse fields from an input that is a HCFA-1500 form
or create output in the format of a HCFA-1500 form. This wizard is a
graphical and allows field selection through a depiction of a HCFA-1500
Form.
Select Add Statements from the menu and the Statement Wizard window opens.
For example, to copy the contents of the Data field into the Test fields with no padding, select
Data, CopyNoPad and Test.
Use the following steps to use the Statement Wizard window.
1. From the Designer, open the translator object to add statements to.
The Wizard menu opens in the Designer menu.
2. From the Wizard menu, select Statement > Add Statements.
3. In Create Wizard window, select a Statement from list on left-hand side to add to the
Statement Wizard.
The selected statement name displays on the right side of the window.
4. Press Next.
Figure 291: Enter the value for the parameter - search arguement window
9. Enter the parameter value in either the Hex Input or ASCII Input section.
10. Press OK.
Another Enter the value for the parameter - pad character window opens. The exact function
of this window depends on the statement chosen.
Figure 292: Enter the value for the parameter - pad character window
In this example, the Copy Until statement creates a new wizard, which copies the contents of the
selected field until it locates a 0D0A. The wizard places the contents in a designated field with no
padding.
The Update Wizard window lists all statement wizards available for update.
5. In the Wizard Name field, if necessary, update the name of the wizard.
Users cannot update the Internal Name field after the creation of a statement wizard.
6. In the Description field, if necessary, update the description of the wizard.
7. Press Next.
The Enter the value for the parameter - search argument window opens.
Figure 297: Enter the value for the parameter - search arguement window
Figure 298: Enter the value for the parameter - pad character window
This window lists the statement wizards that you can delete.
> The upper portion of the window displays the source parameters used to build the statement.
> The lower left portion of the window displays the fields available within each translator object
for use in building the statement.
> Use the lower right portion of the window to type literal source parameters for the statement.
The following table describes the functions on the right side of the window.
Option Description
OK This option accepts the input from the window and creates the associated
statement in the object.
Cancel This option cancels the Format Field Wizard window and does not add any
statements to the object.
Insert This option inserts the field or literal source into the list of parameters.
Update This option allows the update of a field name or literal value in the parameter
list.
Delete This option removes the selected parameter from the list.
Clear All This option removes all parameters from the list.
Option Description
Split At Line Use this option to split the literal entry into multiple sources of 127 bytes each
(127 is the maximum amount of bytes per Source field in eLink).
Destination This option displays the selected destination field. Highlight the destination field
Field to select the desired field. Click Set.
Set This option sets the selected field as the destination field for the statement.
Clear Field This option creates a Format Field Clear statement which uses the selected
parameters.
1. With the desired translator object open, select Wizard > Statement > Format Field Wizard
from the Designer menu.
2. To select the fields to use as source parameters, highlight the desired fields.
3. Click Insert.
4. To create literal source parameters, click Literal and then enter the literal value in the area
provided.
You can use this to paste large amounts of text into the Format Field Clear or Format Field
Concatenate statement.
5. Click Split At Line to break the large amount of text into 127 byte pieces (127 is the maximum
amount of bytes per Source field in eLink).
> You must make a connection to the database system through the use of the Open Cached
Connections statement.
> You must use the translator to create the fields required to perform the database operations.
1. With the desired object of the translator open, select Wizard > Database from the Designer
menu bar.
2. To disable the Welcome window, select the Do not show this screen again check box.
This window might not be displayed if it is not enabled in Preferences.
3. Click Next.
7. Click Next.
10. On the Object Field for Database window, select the Use Field to generate the SQL Query
check box that selects the field where the database name is stored, if appropriate.
This window is optional and allows the dynamic configuration of the database name by storing
the value in a field. This makes the creation of SQL statements easier when you are working
with multiple databases. This feature is only available when using the MSSQL adapter.
When the connection to the database is established, an option to test a SQL query is also
available on this window. For details on using Test Query, see Testing queries.
12. Click the option corresponding to the type of query to create and then click Next.
The wizard uses this window to help create the Perform Cached SQL with Result statement.
The DB Ticket is the object field that holds the Cached Database ticket. The Open Cached
Connection statement uses the same object field.
Note: The wizard does not set the Cached Database Ticket
parameter. Without this parameter, the translator fails to compile. This
user must assign the field reference that contains the database ticket
value to this parameter.
17. Select the field to use for the database ticket.
18. Click Next.
The SQL Field is where the wizard stores the actual SQL statement.
The Destination field is the field for the data that the SQL query returns.
23. Select options from the drop-down lists to create the Where clause.
The Where clause can range in complexity from very simple to very complex. To accommodate
the wide range of complexities, the wizard provides two options.
> The first option is a group of drop-down lists used to build a simple Where clause. Select data from
each of the four drop-down lists to build the clause.
> The second option is to click Complex. This launches the Expression Editor, which allows the
construction of more complex clauses. For details on using the Expression Editor, see Working with
the expression editor.
24. When finished, click Next.
Order By allows the SQL statement to put the result in a certain column order according to
which fields you chose. You can use multiple columns in the Order By clause.
If the object to call does not exist, use the Add Object option to create the object. Refer to
Adding objects for more information.
Related information
Test queries on page 318
Configure a simple expression using the expression editor on page 271
Add objects on page 229
WARNING:
When you create an insert query, do not execute the query directly on the
Sunrise eLink database (eLinkCore, eLinkQueues, and TlKernel) or table.
The result of query might negatively impact the application.
1. With the desired object of the translator open, select Wizard > Database from the Designer
menu bar.
2. To disable the Welcome window, select the Do not show this screen again check box.
This window might not be displayed if it is not enabled in Preferences.
3. Click Next.
7. Click Next.
8. Select Insert.
9. Click Next.
10. Select the database table, database ticket, and SQL query field. If you do not select a field
for the SQL query, the wizard automatically creates the field.
12. Click Expand View to open the Insert Value in the Database table window.
13. In the Value column, enter the value for each column listed to insert into the database. To
select fields as values, highlight the value field and then double-click the field name to use
as the value.
14. When finished configuring the values, click OK.
The values are displayed on the Insert Values window.
16. After reviewing the Input query, click Finished to add the statements to the translator object.
17. Click Test Query to test the query before inserting it into the translator.
Related information
Database Wizard prerequisites on page 290
WARNING:
When you create an update query, do not execute the query directly on
the Sunrise eLink database (eLinkCore, eLinkQueues, and TlKernel) or
table. The result of query might negatively impact the application.
1. With the desired object of the translator open, select Wizard > Database from the Designer
menu bar.
2. To disable the Welcome window, select the Do not show this screen again check box.
This window might not be displayed if it is not enabled in Preferences.
3. Click Next.
Database Wizard displays new connection options or previous connections.
Database Wizard displays the database connection data fields. The specific connection
details varies depending on the type of database connection chosen.
8. Select Update.
9. Click Next.
10. Select the database table, database ticket, and SQL query field. If you do not select a field
for the SQL query, the wizard automatically creates the field.
11. Click Next.
12. Choose the column for the SET clause (the column to be modified) and then select a field or
type the literal value for the SET clause.
14. Select options from the drop-down lists to create the Where clause.
15. When finished, click Next.
16. After reviewing the Update query, click Finished to add the statements to the translator object.
17. Click Test Query to test the query before inserting it into the translator.
Related information
Database Wizard prerequisites on page 290
WARNING: When you create a delete query, do not execute the query
directly on the Sunrise eLink database (eLinkCore, eLinkQueues, and
TlKernel) or table. The result of query might negatively impact the
application.
1. With the desired object of the translator open, select Wizard > Database from the Designer
menu bar.
2. To disable the Welcome window, select the Do not show this screen again check box.
This window might not be displayed if it is not enabled in Preferences.
3. Click Next.
7. Click Next.
8. Select Delete.
9. Click Next.
10. Select the database table, database ticket, and SQL query field. If you do not select a field
for the SQL query, the wizard automatically creates the field.
12. Select options from the drop-downs to create the Where clause.
13. When finished, click Next.
14. After reviewing the Delete query, click Finished to add the statements to the translator object.
15. Click Test Query to test the query before inserting it into the translator.
Related information
Database Wizard prerequisites on page 290
1. With the desired object of the translator open, select Wizard > Database from the Designer
menu bar.
2. To disable the Welcome window, select the Do not show this screen again check box.
This window might not be displayed if it is not enabled in Preferences.
3. Click Next.
7. Click Next.
9. Click Next.
20. After reviewing the stored procedure query, click Finished to add the statements to the
translator object.
Related information
Database Wizard prerequisites on page 290
Test queries
You can test any of the Select, Insert, Update and Delete SQL commands. When you test queries
remember that the connection to the database is live and any query you use that modifies data
also modifies the data in the database you are testing.
Use the following steps to access Test Query.
The following table describes the options found at the top of the HL7 Wizard window.
Option Description
Message This option represents the drop-down to select the HL7 message.
Segments This option represents the list box containing the segments associated with
the selected HL7 message.
Use Insert Field When used with the Put Fields option, this option utilizes the Insert Field
into Segment into Segment statement to insert fields into an HL7 segment. When used
with the Get Fields option, it utilizes the Parse Field from Segment statement
to create fields from an HL7 segment.
Use Format Field When used with the Put Fields option, this option uses the Format Field
with Delimiters with Delimiters statement to format an HL7 segment using the selected
fields and delimiter. When used with the Get Fields option, it utilizes the
Parse Fields between Delimiters statement to create fields by parsing
between delimiters of an HL7 segment.
Put Field(s) Use this option to create HL7 segments.
Get Field(s) Use this option to parse HL7 segments.
New segment You can select this check box can only when you select the Use Insert Field
into Segment and Put Fields options. This check box utilizes the Insert
Segment Tag into Message statement to insert fields into a new HL7
segment.
Apply This option represents applies the changes from the HL7 Wizard to the
translator object.
Option Description
Cancel This option represents closes the HL7 Wizard without making any changes
to the translator object.
Help This option represents accesses the HL7 Wizard topic from the eLink online
help.
By default the HL7 Wizard uses the Format Field with Delimiters and Put fields. When you
access the HL7 Wizard, the Parameters tab opens.
The following table describes the fields found on the Parameters tab.
Field Description
HL7 Message This field represents the input or output field name. Click HL7
Message to select a field name.
Field Separator This field represents the character or field holding field separator.
Defaults to | (vertical bar). Click Field Separator to type a different
field separator.
Segment Terminator This field represents the character or field holding segment
terminator. Defaults to 0D. Click Segment Terminator to select a
different field terminator.
Set ID This field represents the name of the field holding the Set ID number
for a repeating segment. This option is only available when working
with HL7 messages that contain repeating segments.
Field Description
Default Field Value This field allows the selection of a field to insert between each HL7
field separator. eLink creates a global field called Undefined. This
field is one character long and has no default values. The creation
of this field allows the HL7 message to remove everything between
the HL7 field separators including the NULL character.
Use the Fields tab in the HL7 Standard Wizard window to select fields and assign field values.
The Fields tab displays the fields available in the selected segment.
2. Select Wizard > Standard > HL7 from the Designer menu.
9. Select the field containing the HL7 message. If the field does not exist, click Add to create a
new field in the object.
For specific instructions on creating fields, see “Adding manual fields”.
10. Click OK.
11. If necessary, click Field Separator on the HL7 Standard Wizard window to choose a new
field separator.
The HL7 Wizard Parameter window opens to the Literal tab.
20. Enter the field name or literal value for the HL7 field.
21. Click OK.
22. Click Apply.
The configured fields and statements generate in the translator object.
Related information
Add manual fields on page 240
create or parse X12 messages, the wizard opens. eLink configures these items at the top of the
X12 Wizard window.
The following table describes the options found in the X12 Standard wizard window.
Option Description
Table This option displays the drop-down to select the X12 table.
Segments This option displays the list box containing the segments associated with
the selected X12 table.
Use Insert Field into When used with the Put Fields option, this option utilizes the Insert Field
Segment into Segment statement to insert fields into an X12 segment. When used
with the Get Fields option, this option utilizes the Parse Field from
Segment statement to create fields from an X12 segment.
Use Format Field When used with the Put Fields option, this option utilizes the Format Field
with Delimiters with Delimiters statement to format an X12 segment using the selected
fields and delimiter. When used with the Get Fields option, this option
utilizes the Parse Fields between Delimiters statement to create fields by
parsing between delimiters of an X12 segment.
Put Field(s) Use this option to create X12 segments.
Get Field(s) Use this option to parse X12 segments.
Apply This option applies the changes from the X12 Standard Wizard to the
translator object.
Option Description
Cancel This option closes the X12 Standard Wizard without making any changes
to the translator object.
Help This option accesses the X12 Standard Wizard topic from the eLink Online
Help.
The X12 Standard wizard default uses the Format Field with Delimiters and Put fields. When you
access the X12 Standard Wizard, the Parameters tab opens.
Parameters tab
The following table describes the fields found under the Parameters tab.
Field Description
X12 Segment This field represents the input or output field name. Click the X12
Segment icon to select a field name.
Field Separator This field represents the character or field holding field separator.
Defaults to * (asterisk). Click Field Separator to type a different field
separator.
Segment Terminator This field represents the character or field holding segment terminator.
Defaults to 0D. Click Segment Terminator to select a different field
terminator.
Field Description
Default Field Value This field enables the selection of a field to insert between each X12
field separator. eLink creates a global field called Undefined. This field
is one character long and has no default values. The creation of this
field allows the X12 message to remove everything between the X12
field separators including the NULL character.
Fields tab
Use the Fields tab to select fields and assign field values. The Fields tab displays the fields
available in the selected segment. You can configure the X12 Standard Wizard window the same
as you do the HL7 Wizard window.
Refer to the “Use the HL7 Wizard” section for specific instructions on adding fields and statements
to the translator object.
Related information
Build HL7 using the HL7 wizard on page 319
The UB92 Form Wizard displays a graphical view of a Universal Bill Form. From this window, you
can select the fields. If you do not select a field in the Fields pane, a red box highlights the
corresponding field on the form.
The following table describes the options in the UB92 Form Wizard window.
Option Description
Go This option creates the corresponding statements based on the
wizard configuration in the translator object.
Cancel This option closes the Printed Form Wizard window without making
any changes to the translator object.
Help This option accesses the eLink Online Help.
Put Field(s) When selected, this option utilizes the Put Value on Form statement
to place the selected fields into a UB92 form.
Get Field(s) When selected, this option utilizes the Get Value from Form
statement to retrieve values from a UB92 form.
Option Description
Show When you select this check box, a graphical representation of a
UB92 form displays in the right side of the window for field selection.
1. With the desired translator object opened, select Wizard > Standard > UB92 from the
Designer menu.
15. Double-click each required field name to configure the field value.
16. Use the Field tab to select the field, or use the Literal tab to enter a literal value for the field
value.
17. When finished, click OK.
18. Configure the remaining fields for the UB92 form. When finished, click Go.
The Put Value on Form or Get Value from Form statements are added to the translator
object.
Related information
Add manual fields on page 240
Configure a simple expression using the expression editor on page 271
The HCFA-1500 Form Wizard displays a graphical view of an Insurance Claim Form. From this
form, you can select the fields. If you select fields in the fields pane, a red box highlights the
corresponding field on the form.
The following table describes the options found on the top portion of the HCFA-1500 Form Wizard
window.
Option Description
Go This option creates the corresponding statements based on the wizard
configuration in the translator object.
Option Description
Cancel This option closes the Printed Form Wizard window without making
any changes to the translator object.
Help This option accesses the eLink Online Help.
Put Field(s) When selected, this option utilizes the Put Value on Form statement to
place the selected fields into an HCFA-1500 form.
Get Field(s) When selected, this option utilizes the Get Value from Form statement
to retrieve values from an HCFA-1500 form.
Show If you select this option, a graphical representation of an HCFA-1500
form displays in the right side of the window for field selection.
Derived functions
Sunrise eLink provides a comprehensive list of statements that address nearly all common data
manipulation functions found in a typical translator. Use the application’s functionality to create
custom statements through the pre-existing or primitive statements bundled with Sunrise eLink.
The new statement becomes a derived function.
You can consider a derived function a subroutine. Derived functions work in the same manner as
programming subroutines. Information passes from a translator to the derived function. After the
function finishes, the resulting data passes back to the translator along with an optional return
code (an integer).
Derived functions are more versatile than child objects in creating subroutines. Consider using
derived functions for a block of statements in several objects within a translator. You can call a
derived function regardless of the object’s placement in the translator tree. Be careful when you
create derived functions so you do not duplicate functions that you can accomplish with one or
two existing Sunrise eLink statements.
Use the Derived Functions window to create a derived function. Use this window to initialize the
function and indicate the parameters required by the function when in use by the translator.
You can select parameters from the list of built-in parameters used in eLink or select the Parameters
tab to create new parameters. Exercise care when you create new parameters to avoid parameters
duplication.
After you create a function, the Function Edit window opens. This window is similar to the Edit
Object window. You can populate the fields to use in the function and in the configured statements
used by the function. The only difference is the variables replace the field names. These variables
represent data coming from or going to the translator.
4. In the Internal Name field, enter a name for the new derived function.
This name is a unique within eLink. This name does not appear to the users who use this
function. This name cannot contain spaces and must contain alphanumeric characters.
5. In the Advertised Name field, type the advertised name for the derived function.
This name is visible to users who use this function. This name may contain spaces and any
combination of characters.
6. In the Description field, enter a description of the derived function.
This description helps users identify the function’s purpose.
7. From the Parameters tab, select the parameters to use in the derived function. If the parameter
does not exist, you can create it using the Parameters tab in the Derived Functions window.
You can select parameters individually or as a group using the SHIFT or CTRL keys. Highlight
the desired parameters and then click Add >>.
You can use << Remove, Move Up and Move Down to organize the parameters in the
Selected section of the window. Highlight the parameter to adjust, and then click the icon.
You can add parameters to a derived function once you create (save) it. If you want to use a
new parameter in a new derived function, you, must create the parameter first. Refer to
Creating derived function parameters for more information.
9. Highlight the category or categories under which this derived function opens in the Add
Statement menu.
Use the SHIFT or CTRL keys to select multiple categories. If the category does not exist, you
can create it from the Categories tab in the Derived Functions window. See “Creating derived
function categories” for more information.
10. When finished, click Add.
The new derived function opens on the Functions tab in the Derived Functions window.
11. From the Functions tab in the Derived Functions window, highlight the derived function.
12. Right-click Select Update from the menu.
The Derived Function Edit window opens for the selected function.
13. When finished editing the function, close the Derived Function Edit window.
Related information
Create derived function parameters on page 341
Create derived function categories on page 343
4. Select Add.
5. In the Internal Name field, enter the internal name of the new parameter.
Note:
The users do not see the internal name.
This name cannot contain spaces and must contain alphanumeric
characters.
6. In the Advertised Name box, enter the advertised name of the new parameter. Users see
this name when they select parameters for derived functions.
This name can contain spaces and other characters.
7. In the Data Type drop-down, select the data type for the new parameter. Choices are:
> Expression — any expression using numeric values
> Field — any literal value or field
> Object — any child object
8. When finished, click Add.
The new parameter opens on the Parameters tab of the Derived Functions window.
5. In the Internal Name box, enter the internal name of the new category.
Sunrise eLink uses the name internally and users do not see it.
2. Go to the derived sub folder under the main Sunrise eLink folder. In the derived folder, derived
functions appear in sub folders by function name.
3. Select the function name to restore.
4. Click Open.
The Restore window opens with the selected derived function displayed.
To restore derived functions or translators, browse to their location in Windows Explorer and
double-click the .tlk file. These steps automatically launch the Restore function.
Related information
Restore archived items on page 144
To activate the code lookup table, use a Look Up statement in the translator. This statement passes
the input value (in this example, the state) to the lookup table. The table then searches for the
input value in the table. When found, the corresponding value (the capitol name) returns to the
translator. This value stores in a field for later use by the translator.
Code lookup table creation is a two-step process. First you create the code lookup table. Second,
you add the data mapping items to the table through the Update Codes window.
Data mapping can either be an exact match using the Equal To tab or a range match using the
Between tab. The data entered into the Result field is the exact information that returns to the
translator on a successful match.
Use the following steps to create a code translation table.
5. In the Code Type box, enter the name of the code translation table.
6. In the Description field, enter a description for the new code translation table.
7. Click OK. The new code translation table name opens in the Codes Translation Tables
window.
8. Highlight the new code translation table name.
This chapter describes the various ways that eLink uses translators.
Message logging
Message logging causes the translator to insert log entries when it receives records. When a
translator's MessageLog host property setting equals True, the input message that opens in the
Data box of the root object adds to the log. The log documents the record processing activities,
records the queue activity, and registers the errors.
Internal logging
Internal logging causes the translator to insert log entries for every internal and external transaction.
This log type activates when a translator's InternalLog host property equals True.
Use the log search features, provided by the Log icon on the Main Console, to access message
and internal logging.
Object logging
Object logging causes the translator to insert log entries for each internal object it executes. Objects
are the basic building blocks of a translator. This log type activates when a translator's ObjectLog
host property equals True.
The simplest means of determining if user-defined logging exists for a translator is to create and
review a translator report using Create Report. The presence of user-defined logging displays in
one of two ways: the translator report's summary of the global object would contain a reference
to either a log file name or to an .ini file name. These references would also contain the directory
path to the log or .ini file.
If a reference to a log file displays in the global object summary, browse to the log file indicated
by the directory path to view its contents and determine its relevance in a production environment.
If the file contains no data, a deactivation of user-defined logging occurred and requires no additional
action for maximum performance. If the file contains non-critical data, you must review the logging
logic enabled by the translator's designer and modify it to disable the logging function.
If the global object summary references an .ini file, browse to the file indicated by the directory
path to find in its contents the directory path to the log file. You can then access the log file and
review its contents. If there is no data in the log file, a deactivation of the user-defined logging
occurred and any changes for performance optimization are no longer required. If the file contains
non-critical data, you must review the logging logic enabled by the translator's designer and modify
the data to disengage the excessive logging.
Use the following steps to disengage user-defined logging.
Environment variables
An environment variable is an item of data that receives updates from the operating system or
applications. These variables typically reside in the memory. Applications read the variables to
determine the status of the system. Environment variables contain data, such as time, date, path,
version number, logon information, and so on. There are 2 types of environment variables:
> System—These are data items that pertain to the system at large. These items load into memory
during every boot instance and are available to all other processes.
> User—These are data items that pertain to a particular user. These items are only available
when the particular user that they associate with logs on to the system.
> The database that a translator is using is no longer available. This often occurs because the
database server moves, the database drivers are improperly configured, or the ID or password
used to logon is incorrect. If the database function returns a zero in the Return box, perform a
Get Last Error statement. If no errors exist, zero entries are found.
> An initialization value (INI file, environment variable, and so on) is not available. This could be
because the file does not exist, the value is not in the file, or the file is not accessible (due to
network drives or permissions being incorrect).
> No input data box is available.
> An input file is not readable. This may occur if the file or the directory does not exist, the network
drive is not accessible, or the security permissions stops the translator's access to the file.
Check the Return box on the Read From File statement. A successful read returns the length
of the file. An unsuccessful read returns a negative number in the Return box.
> An output file is not write-able. This may occur because the directory does not exist, the network
drive is not accessible, the security permissions are incorrect, or there is a full disk partition.
Figure 396: Message output to console using set interface status statement (above)
DLL translators
A Dynamic Link Library (DLL) is an executable program module that performs 1 or more functions.
DLLs are unique in that you do not directly start them from a command line or from the console.
Instead, the running application calls the DLLs and the DLLs load at run-time to provide additional
functionality. You usually write DLLs to use their attributes with more than one application at the
same time.
> Information destined for the calling process outputs from the DLL using the "Output to Module"
statement. This data stores in the outbound queue of the host connection (the queue named
TranslatorNameIn).
> All other coding rules are valid for DLL translators.
> The DLL should return a meaningful value to the calling process. However, this data must be
part of the output string to parse by the calling process. The Return statement does not return
a value into the Return parameter in the calling process.
> Make the DLL generic enough so that multiple translators can use it, instead of coding multiple
DLLs that perform only one specific task.
> Use a generic, easily parse-able data format for passing data between a translator and a DLL.
Use the same format for all DLLs.
> It is critical to document the input and output formats, plus valid input values, either within the
code of the DLL using the Comment statement or in a separate document included in the general
translator documentation set.
> When you create derived functions, consider using DLLs to perform the process within the
function, especially if you need loops or a large number of iterative operations.
You can place these files in any directory on the eLink system, if the directory displays in the PATH
environment variable. Be sure to store all 3 files in the same directory.
3. For every message processed in the parent translator, use the built-in statement Call External
Function to call the TranslateFromTranslator function in the DLL to execute the DLL's code.
The following shows how to call the TranslateFromTranslator function to execute the code in
the DLL. A valid input string is passed to the DLL through the Source parameter. Any DLL
generated output is available to the calling process through the box assigned to the Destination
box parameter.
Real-time translators
The following section provides details on the eLink Queueing Mechanisms and configuring those
mechanisms.
An alternate way to modify the queue method is to change the host properties through use
of the Web Console, Translator Properties, EDIT mode.
2. Right-click the applicable translator, and then select Modify Properties from the submenu.
3. Click the Host Properties tab.
4. Double-click the QueueMethod parameter.
5. Select Memory Queued.
6. Click OK.
This action configures the translator for partial record logging to the memory.
The Modify Translator Type window returns.
7. Click Close to save the modification.
What to do next
Restart the translator for the changes to take effect.
If the text Open displays anywhere else in the data message, eLink treats the text as an Open
command even if it is not.
For example, if the name OPENHEIMER displays in the data string as parsed by an incorrectly
configured translator, the translator would not process the data correctly. This problem does not
occur often in testing because it is unlikely that words that can be confused with commands existing
in test case data. However, it occurs intermittently when a translator executes on a production
machine.
The Translator Status alarm is the most efficient alarm to use when you need to notify an operator
about a translator failure condition. While older translators may require some modification to insert
the Set Interface Status command into the code, newer translators should have this command.
After you insert the Set Interface Status command into the translator, add an alarm to the condition.
If you use an email notification with the alarm, the recipient receives a message that has both the
translator status and its associated status comment. When used correctly, the status comment
shown in the email indicates where the translator failed.
Log alarms
A Log alarm monitors eLink's internal transaction log for the appearance of a user-defined data
string. The Log alarm is the least efficient alarm. The Log alarm's reduced efficiency is due to the
significant amount of data stored in the log files. As the amount of data stored in the log file
increases, the efficiency of the alarm decreases.
To use a Log alarm, choose a case-sensitive search string. If the string exists in the log, the alarm
fires. By using the more efficient alarms, the eLink operator should be able to add a significant
number of alarms before they see any real system degradation.
To learn more about setting up each individual alarm, refer to the Use the alarm section.
For a TCP/IP Server translator, you can set up a Maximum Time to Wait value in the translator or
in an .ini configuration file. If the wait time exceeds the translator's value, use the Set Interface
Status statement to display a comment in the console for this translator, such as Last received
records was mm/dd/ccyy hh:ss.
You can set the interface status box in the Set Interface Status statement to Warning. You can
set a translator status alarm to fire when the status of the translator is Warning. When a data
record arrives, the Set Interface Status statement can reset the translator status back to OK.
Translators can also use the Timeout box in the host properties. Every “x” seconds, the translator
sends a Timeout record to itself. The translators can count the timeouts and when the count
reaches a certain number, the translator uses the Translator Status alarm or the log alarm. For
the Log alarm, the translator uses the Write to Log statement to write a message to the internal
eLink log files. The Log alarm searches the log every minute for a matching Search Substring
(case-sensitive). If the search finds a match, the log alarm fires.
After a data record arrives in the eLink system and inserts into a queue, 2 alarm types monitor the
queue. The Queue Count alarm determines how many records with a status of Queued are in a
queue. If the number of backed up queued records is greater than the Max Count set for that
Queue Name in the Alarm Manager, an alarm fires. You can use the Queue Lag Alarm to monitor
queues, however it is less efficient. Every minute, the Queue Lag Alarm determines which record
in the queue is the oldest and has a Queued status.
Note: Neither of these alarms require changes to the translator code. The
Alarm Manager configures the alarms externally.
You can use the alarms to emails or execute programs, such as trapgen or net send. If many
people need to receive an alarm through email, you need to create a distribution group. You can
set up the paging function through the email system.
Related information
Using the alarm on page 108
Note: If you use an error queue within an interface, ensure that any record
placed into the queue immediately gets a status of Accepted or
Rejected.
The following figure shows an output to an error queue. The first 4 statements format the error
message and then send the message to the message queue using the Output To Queue statement.
Immediately, Sunrise eLink retrieves the odometer number from the queue.
This odometer should be the odometer of the record just placed into the queue. The Accept
Transaction statement changes the status of the record so that the record is not orphaned in the
queue.
Note: The Output to Queue statement returns the odometer. The Change
Record Status statement can use this odometer to accept or reject the
record.
The danger encountered when using this method is the error message is now subject to the same
cleaning interval used to cleanup other queues. If an operator does not see the record before the
cleaning interval expires, the error may go unnoticed. To avoid this situation, error queues should
always alarm to alert the operator when an error condition exists.
Run this stored procedure through the Call Cached Stored Procedure function.
Debugger utility
eLink Designer provides a robust testing utility called the Debugger. After you write all or a portion
of a translator, you can test the translator and debug it in the Debugger without any adverse effects
on any of the production activities, other than the addition or removal of records in production
queues. For example, compiled code running in production does not change while the Debugger
runs.
Always remember to perform your debugging operations on a server other than your production
server to avoid affecting records in queues. Conduct your tests on imported data rather than data
received by the translator in production. Testing compiles the translator for debugging purposes,
but does not overlay production code.
Note: Make sure to stop the translator from the Web Console on the test
server to avoid unpredictable results. For example, a Timer translator that
processes and removes all records from a queue might inadvertently
compete with the same translator running in the Debugger.
To open a translator to debug, select Designer > Translator > Test/Choose Record, or press
the F8 key. The Debugger window contains the following key areas:
> The left pane of the window displays information on each field in the current object. As the test
progresses from one object to another, the fields within this pane change.
> The right pane of the window displays each statement in the current object. Debugger highlights
the active statement as the translation progresses.
> The Debug toolbar opens on the far left side of the Debugger window and contains functions
for testing translators.
Debug menu
The debug menu contains the same functions available on the debug toolbar along with the
corresponding function keys.
Option Description
Step One This option executes the next field or statement and enters any objects or derived
functions called.
Step Over This option executes the current statement but does not enter a called object for
example, if the current statement is If Object or If Object Multiple. If the current
statement is a derived function and you select the Debug derived functions check
box on the Record For Test window, eLink does not enter the derived function
code.
Skip To This option enables the selection of an object, field, statement, field change,
record, or breakpoint to skip to. When selected, the Skip To window opens for
the selection of an object, field, or record to skip to.
Skip To Next This option skips to the next set breakpoint.
Breakpoint
Step Out This option executes all remaining code in the current object and all child objects,
and then returns to the place in the parent object that called the current object
then stops on the next statement in that parent object. This option is useful if
you selected Step One accidentally when you should have selected Step Over.
Reset This option starts the test over again at the beginning with the global object. If
there are no manual fields with default values in the global object and no
statements in the global object, this icon starts back at the Data field in the root
object.
Help This option accesses the eLink online help.
Edit This option closes the debugger, closes the Record For Test window and opens
the object currently shown in the debugger. This option is useful when a problem
code opens and you want to jump directly to the object containing the incorrect
code to make changes. This icon is present for your convenience.
Close This option closes the debugger and returns to the Record For Test window.
This option is useful if you select a different record to test. If the Record For
Test window is open, you can start a new debug session without recompiling
the translator.
Exit This option closes the debugger and returns to the Record For Test window.
View menu
The View menu contains the same functions available in the debug toolbar along with the Navigator
option, which enables the use of the keyboard to initiate toolbar icons and options.
The following table describes the options under the View menu.
Option Description
Navigator This option retrieves the Debug toolbar.
Add to Watches This option adds the currently highlighted field to the Watches
window.
Watches This option opens the Watches window. In this window, you can
select fields to watch during testing.
Expansion This option opens the Expansion window. This window displays the
value of the currently highlighted field as testing progresses.
Changes This option opens the Changes window. This window displays each
change in the translator fields as testing progresses.
Debug toolbar
The following table describes the Debug toolbar’s options.
Option Description
Forward Select this option to use the stepping functions that test progress forward
through the translator.
Backward Select this option to use the stepping functions that test moves backward in
the translator.
Step One This option executes the next field or statement and enters any objects or
derived functions called.
Step Over This option executes the current statement but does not enter into a called
object. For example, if the current statement is If Object or If Object Multiple.
If the current statement is a derived function and the Debug derived functions
and you select the check box for the Record For Test window, Sunrise eLink
does not enter into the derived function code.
Option Description
Skip To This option enables the selection of an object, field, statement, field change,
record, or breakpoint to skip to. When selected, the Skip To window opens
to select an object, field, or record to skip to.
Next BP This option skips to the next breakpoint set.
Step Out This option executes all remaining code in the current object and all child
objects. The Step Out option then returns to the place in the parent object
that called the current object and stops on the next statement in that parent
object. This option is useful if you selected Step One accidentally when you
meant to select Step Over.
Reset This option starts the test over again at the beginning with the global object.
If there are no manual fields with default values in the global object and no
statements in the global object, this icon starts back at the Data field in the
root object.
Watches This option opens the Watches window.
Expansion This option opens the Expansion window.
Changes This option opens the Changes window.
Edit This option closes the Debugger, closes the Record For Test window and
opens the object currently shown in the Debugger. This option is useful when
the problem code opens and you want to jump directly to the object containing
the incorrect code to correct it. This icon is present for your convenience.
Close This option closes the Debugger and returns to the Record For Test window.
This option is useful if you select a different record to test. If the Record For
Test window is open, you can start a new debug session without recompiling
the translator.
Exit This option closes the Debugger and the Record For Test window.
1. Open a translator to debug by selecting Translator > Test/Choose Record... from the
Designer menu (or press F8).
3. Click Load.
5. Browse to the location of the file containing the record to use for testing.
6. Click Open.
7. If you import multiple records, select the specific record to test, either by entering the record
number or clicking the left and right arrow icons.
8. To test with multiple records, enter the number of the first record in the box next to the left
arrow and the number of the last record in the box next to the right arrow. describes the other
options available in this window.
Option Description
Test This option compiles the translator and launches the Debugger for testing.
Help Accesses the eLink Online Help.
Search fields This option allows you to use the Hex and Text fields with the Search arrow
icons to locate a specified string within an imported record. Use the right
arrow Search icon to search forward in the list of imported records, use
the left arrow Search icon to search backward in the list of imported records.
This option is useful if you have many records loaded for debugging and
do not remember the location of one particular record.
Load This option allows you to load records for use in the Debugger.
Save This option allows you to save the current record.
Derived When selected, the Debugger steps through each statement in derived
Functions functions when testing the translator. If you do not select this option, eLink
skips the derived function’s statement.
Option Description
Maximum This option determines the number of times a loop can repeat (execute).
Iterations Default is 9999. You can set this number to a default value using the User
Preference window.
Text Display This option controls whether the record opens in EBCDIC or ASCII format.
Format If you import a record for debugging in EBCDIC format, click the EBCDIC
option and the record converts to a text display format.
Guess Format When selected, the Record For Test window automatically determines
the format of the record and displays it. Display options include: XML, Hex
and Text, Text, Delimited, HL7 and X12.
Set Options This option opens the Display Configuration window where you can
configure the options for Delimited, HL7, X12 and Text opens. These
options include the specification of delimiters, displaying field numbers,
and lengths of fields.
For details on Set Options, see Data display options.
If errors occur during the compile, the Resolve Parameters window opens after the compile
completes. From this window, you can correct errors and unset parameters. For details on
using Resolve Parameters, see Resolving parameters. After the compile is complete, the
Debugger window for the selected translator opens.
11. To test the translator, click the step icon from the Debug toolbar or the Debug menu.
When the test is done, the Translation Complete window opens.
12. Click OK.
Related information
Data display options on page 394
Resolving parameters on page 405
On the Field Change tab, the objects in the translator with fields are displayed.
Use the following steps to skip to a selected, changed field.
This is useful if you have more than one record to debug and need to skip to for example, the third
record imported. This function allows you to skip over the code for the first two records.
Use the following steps to skip to a particular record.
1. Highlight a record.
2. Click OK.
Breakpoints tab
All configured breakpoints are displayed on the Breakpoints tab.
3. In the Record drop-down, select the object containing the field to set up a watch for.
The list of fields for the selected object opens in the Fields section.
4. In the Fields section, select the fields to set up a watch for.
Select more than one field by using the SHIFT or CTRL keys.
5. Click OK.
The new watches appear in the Watches window.
6. As the watched data translates, its value opens in the Value of Field column in the Watches
window.
Expansion window
The Expansion window enables you to view a detailed version of a field value.
Perform one of the following steps to use the Expansion window.
> From the Debug toolbar select the Expansion check box.
> Double-click a field in the currently shown object.
> Double-click a field in a statement or double-click a field in the Watches window.
The Expansion window contains the same data display options as the Record For Test window.
You can display data in different formats, and you can use the Set Options option to set delimiter,
field number, and field length options for each display type. For details on data viewing, see the
“Use the data display options” section.
Related information
Data display options on page 394
> From the Debug toolbar, select the Changes check box.
As testing progresses, the window displays the changes occurring in the translator code.
Use the Changes window to view the number of seconds required to process commands and
statements in the translator. Use this information to determine the efficiency of the translator before
putting it into production.
options are available within the Log and Queue functions on the Web Console. These options are
part of the Debugger’s Record For Test window’s advanced testing option set.
These viewing options are also available within the Debugger upon activation of the Expansion
window.
Option Function
> HL7
> X12
Set Options This option configures default options for data display.
XML
The XML format option displays XML data in a hierarchical format according to its structure (a
DTD is required). XML data opens within the data viewing utility.
Text
The Text format option displays any data type in its EBCDIC or ASCII format parsed according to
the delimited or fixed length parsing mechanism specified using the Set Options display configuration
feature.
The following table describes the options available for viewing textual data.
Option Function
Delimited When selected, this option activates options for configuration of the line break
characters used to parse delimited data.
ASCII This option enables the configuration of a line break delimiter using the ASCII
text display format.
EBCDIC This option enables the configuration of a line break delimiter using the
EBCDIC text display format. This option also enables a user to import data
in EBCDIC format and view it as if it were ASCII without having to run the
data through a converter first.
Option Function
Hex This option enables the configuration of a line break delimiter for displaying
ASCII or EBCDIC data.
Fixed length This option configures a line break delimiter according to the byte offset from
the beginning of the message. The default value for this field is zero.
Always guess This option determines whether a record is in ASCII or EBCDIC format. This
ASCII or EBCDIC option guarantees that text always displays in a readable format.
format
Starting position This option enables the specification of a record’s starting position. This option
(set to zero if you works with data prefixed to a message that is not part of the parse data. You
want the viewer to can use this feature to skip to the end of a lengthy record.
display the entire
message)
The data viewer’s Text option presents the contents of a record parsed according to the line-break
parsing mechanism configured using the Set Options window. Delimited data displays within the
data viewing utility.
Delimited
The Delimited format option displays any delimited data, parsed according to the set of delimiters
specified using the Set Options window.
The following table describes the options available for Delimited Data.
Option Function
ASCII/ Hexadecimal entry pane This option enables configuration of the default delimiters used
to parse delimited data. eLink limits delimiter length to 100
bytes.
Show Field Numbers When selected, this option numbers the data elements parsed
from delimited data. eLink selects this option by default.
Always guess ASCII or EBCDIC This option automatically determines whether a record is in
format ASCII or EBCDIC format. This option guarantees that text
always displays in a readable format.
Starting position (set to zero if This option enables the specification of a record’s starting
you want the viewer to display the position. This option works with data prefixed to a message
entire message that is not part of the parse data. You may use this feature to
skip to the end of a lengthy record.
The data viewer’s Delimited option presents the parsed contents of delimited data as individual
nodes within a tree structure. displays Delimited data within the data viewing utility.
HL7
The HL7 format option conforms to the HL7 data standard by parsing data in HL7 format according
to the set of delimiters specified in the first HL7 header segment found within the message. You
can apply non-standard delimiters to HL7 messages according to the set of delimiters specified
using the Set Options window.
The following table describes the options available for HL7 data.
Option Function
ASCII/ Hexadecimal Entry Pane This option enables specification of the default delimiters
used to parse HL7 data. By default, this table fills with the
HL7 data specification’s standard encoding character set.
Reset to default delimiters This option restores the HL7 data specification’s standard
encoding character set.
Option Function
Show Descriptions This option displays the HL7 description associated with each
field value displayed in the text. Unselect this option to
increase the display time of larger HL7 messages. This option
is only available when viewing HL7 data within the Designer.
At the end This option displays the HL7 description associated with each
field value after the field value’s display in the text. This option
is only available when viewing HL7 data within the Designer.
Show Repeating counter When selected, this option displays a counter for repeating
fields in an HL7 record. eLink deactivates this option by
default.
Show Field Numbers When selected, this option displays the numeric orientation
of each field value presented in the text. eLink selects this
option by default.
Show Name of a Segment When selected, this option displays the segment name
associated with each field value presented in the text. eLink
selects this option by default.
Always guess ASCII or EBCDIC When selected, this option automatically determines whether
format a record is in ASCII or EBCDIC format. This option
guarantees that text always displays in a readable format.
Starting position (set to zero if you This option enables the specification of a record’s starting
want the viewer to display the entire position. You can use this option with data prefixed to a
message) message that is not part of the parse data. You may use this
feature to skip to the end of a lengthy record.
If the record displayed does not contain the header required for standard HL7 messages, the
delimiters specified using the Set Options window parses the message.
The data viewer’s HL7 option presents the parsed contents of HL7 data as individual nodes within
a tree structure. HL7 data is displayed in the data viewing utility.
X12
The X12 format option conforms to the X12 data standard by parsing data in X12 format according
to the set of delimiters specified in the last 3 bytes of the ISA segment found within the message.
You can apply non-standard delimiters to X12 messages according to the set of delimiters specified
using the Set Options window.
Option Description
Always guess ASCII or This option automatically determines whether a record is in ASCII or
EBCDIC format EBCDIC format. This option guarantees that text always displays in
a readable format.
Starting position (set to This option enables the specification of a record’s starting position.
zero if you want the viewer You can use this option with data prefixed to the message that is not
to display the entire part of the parse data. You can use this feature to skip to the end of
message) a lengthy record.
If the record displayed does not contain the ISA segment required of standard X12 messages, the
delimiters specified using the Set Options window parse the message.
The data viewer’s X12 option presents the parsed contents of X12 data as individual nodes within
a tree structure. X12 data opens within the data viewing utility.
Resolving parameters
When a statement or derived function has one or more of its parameters set to a field or object
that is not accessible, the translator contains unresolved parameters. These errors occur by the
copying and pasting fields and statements from one object to another or from one translator to
another.
Unresolved parameters within a translator causes the testing or compile process to fail until you
resolve the errors. If errors or unresolved parameters are present in a translator, the Compile
Errors window opens after the translator compiles for testing or production.
The errors found in the translator during the compile process appear in this window with an error
description.
Use the following steps to correct errors and resolve parameters during the compile process.
3. If the error is due to an unresolved parameter, click Goto Error to open the Resolve
Parameters window.
6. To set the unresolved parameter to a new, correct value, double-click the field or object or
select the field.
7. Click OK.
8. If the field (in the Resolve Field window) or object (in the Resolve Calls window) does not
exist, click Add to create the item.
9. Select the field or object.
10. Click OK.
11. Repeat this process until you eliminate all unresolved parameters in the translator.
What to do next
You can now compile the translator for testing or production.
Using find
The Designer provides a searching utility for you to search translators for objects, fields, declared
numbers, literals and statements. Use the Find window to perform searches.
1. From the Designer, with a translator open, select Search > Find from the Designer menu.
2. In the Search which Translator drop-down, select the translator to search.
You can search the currently opened translator or other translators.
3. For Type the word(s) you want to find, enter the string to search for.
4. For the What types would you like to search on option, select the option for the item to
search in.
If you select the Statements option, the Type the word(s) you want to find box changes to
the Search which statement drop-down.
5. If you select the Statements option, select the name of the statement to search for under the
Search which statement drop-down.
6. The How thorough would you like the search option activates only for Object searches. If
you select Objects, select the option the corresponds to the thoroughness of the search.
7. After you configure the search parameters, click Query.
The search launches and the results appear on the Results tab.
8. To access the result displayed (such as a field or statement), double-click the item.
The selected item opens in the Designer.
Changing references
The Designer provides another search and replace utility called Change References. You can use
this search feature to locate and change all references for objects or fields. This function can be
useful when copying and pasting fields from one object to another, or from one translator to another.
It is also useful if you move a field to a higher part of the object structure to give the field a broader
scope (make it available to more objects).
If all your code is pointing to the field that’s four levels below the root object and you want to move
the field up to the root object, create the new field and use this search feature to find and replace
all references from the old field to the new one in the root object.
Use the following steps to change references.
1. With a translator open in the Designer, select Search > Change References from the
Designer menu.
2. In the Search which Translator drop-down, select the translator to search in.
You can search for translators that are not open.
3. For Type the word(s) you want to find box, enter the string to search for.
4. When complete, click Query.
5. To replace references for a field or object, highlight the desired item and then click Replace.
The Choose new reference field or Choose new reference object window opens.
7. Choose the field or object to replace all references of the old field or object.
8. Click OK.
The Replace Parameters window opens without the parameter.
1. From the Designer, with the translator to view errors for open, select Search > View Last
Errors from the Designer menu bar.
Compiling a translator
After you test a translator that is ready for production, you must compile it. The compile for testing
process exists in a temporary area, and eLink deletes it when finished.
Use the following steps to compile a translator.
1. From the Designer menu select Translator > Compile Translator (or press F9).
If the translator compiles successfully, a window opens with the following or similar message:
The following translator has been compiled successfully:
- TeamProTimer
This translator will not take effect until it is installed.
2. Click OK.
Note:
Translators compiled in this manner run slowly because they are recording
debug information as they run. The Compile for Instrumentation option
slows translator performance significantly and writes out a large amount
of detail if left running for an extended period. It is best practice to uses
this option only for troubleshooting. Do not use this option with production
processes that constantly run.
1. From the Designer, with the desired translator open, select Translator > Compile for
Instrumentation from the Designer menu.
2. Enter, or browse to and select, the name of the directory to store the step information to.
3. To include derived functions during the testing process, select the Debug Derived Functions
check box.
4. Click OK.
The translator compiles.
When the translator has compiled successfully, a message similar to the following opens:
The following translator has been compiled successfully:
- TeamProTimer
This translator will not take effect until it is installed.
1. After running the instrumented translator from the Web Console and creating the .stpdmp
file, open the translator to test in the Designer.
2. From the Designer menu, select Translator > Test Instrumented Translator.
Related information
Using the debugger to debug a translator on page 382
Reporting
The following provides information on the translator reporting process.
1. Open the translator for which you want to create a report, select Translator > Create Report
from the Designer menu.
1. With the translator to create an object report for open, right-click an object.
Tip: Create Report is not available from the Object menu in the
Designer menu. To access the function, right-click an object.
2. From the menu, select Create Report.
3. Select the Report Type (HTML or Text).
4. Click OK.
1. Navigate to Programs > Microsoft Visual SourceSafe > Microsoft Visual SourceSafe 6.0.
2. Enter your username and password. Disregard the database setting for now.
3. Click OK.
4. To ensure you select the correct database, navigate to File and select Open SourceSafe
Database.
5. If the selected database is incorrect or pointing to your local SourceSafe database, click
Browse to locate the correct database.
6. Browse to the location of the correct database, and select the srcsafe.ini file.
7. Click Open.
The selected database opens in the Open SourceSafe Database window.
8. To ensure you use the database every time you log onto SourceSafe, select the Open this
database next time I run Visual SourceSafe check box.
9. Highlight the database.
10. Click Open.
The contents of the selected database appear in the Visual SourceSafe Explorer window.
1. Right-click the target project folder (you may also highlight the project folder and then select
the File menu).
3. Browse to and select the working folder. If necesasry, click Create folder to create a new
folder.
4. Click OK to set the working folder for the project.
All checked out files remain in this folder while working.
4. In the Source Safe database path field, type or browse to the network location where the
SourceSafe database resides and select the srcsafe.ini file.
5. In Login, enter your user ID.
6. In Password, enter your password.
7. In Default Source Safe project, enter or browse to the project folder to use when working
with SourceSafe.
8. When finished, click Connect to Source Safe and a confirmation message opens.
9. Click OK.
The working folder information automatically fills based on the working folder set up for the
selected project.
10. Click OK.
The following functions enable for the storage of translators, derived functions and code lookup
tables in Visual SourceSafe.
Add to SourceSafe
SourceSafe enables the developer to add a translator, derived function, or code lookup table to a
SourceSafe project.
1. Right-click the item (translator, derived function, or code lookup table) to add to SourceSafe.
The item's context menu opens.
3. For To, enter or select the SourceSafe project to which the item adds.
4. The value for From defaults to the working folder associated with the selected project. To
make the selected project the default for adding items, select Make default SS Project.
5. For Comment, enter the comments regarding changes made to the item.
Note: Entering comments is considered a best practice.
6. Click OK to add the item to SourceSafe.
Note: You must add at least 1 item to SourceSafe for this option to appear
in the menu.
Use the following steps to check an item out of SourceSafe.
1. Right-click the item (translator, derived function, or code lookup table) to check out from
SourceSafe. The item’s context menu opens.
2. Select SourceSafe.
4. In the From field, enter or select the SourceSafe project to check the item out of.
The To field defaults to the working folder associated with the selected project.
5. Select the Make default SS Project check box to make the selected project the default for
checking out items.
6. In Comment, enter comments.
Best Practices: Enter comments to provide more details.
7. When finished, click OK.
A confirmation window opens.
Note: If you need to use an older version of a translator rather than the
current SourceSafe version, you must make the change within SourceSafe.
From the SourceSafe project folder, right-click the translator and select
Show History. Click OK on the History Options window. From the History
of [item name] window, select the older version of the translator and then
click Check Out. When a translator is Checked In or Checked Out, a
comment box opens. Use the comment box to document any changes
made to the translator. For each version of the translator, click Details to
review the comments regarding the older version of the translator.
Best Practice: Do not use Get when you install Sunrise eLink as a client.
This problem does not occur if SourceSafe works with a complete
installation of Sunrise eLink because multiple users do not share the
database for storing data.
Use the following steps to get an item from SourceSafe.
3. In the From field, enter or select the SourceSafe project to copy the item from.
4. Select the Make default SS Project check box to make the selected project the default for
copying items.
5. When finished, click OK.
Check source in
This SourceSafe function puts the checked out source for a translator, derived function, or code
lookup table back into SourceSafe.
Note: You must check an item out of SourceSafe before this option
displays in the menu.
Use the following steps to check an item into SourceSafe.
1. Right-click the item (translator, derived function, or code lookup table) to check into SourceSafe.
The To and From fields are unavailable because you must check items into the same project
you check them out of.
1. Right-click the item (translator, derived function, or code lookup table) to undo the check out.
2. Select SourceSafe.
3. Select Undo check out.
The item’s status changes from Checked out to Checked in.
Deploying translators
The Deploy Translators utility allows you to move compiled translators, either existing or new
translators, from one server to another. A typical use for Deploying Translators is to move translators
from a development server to a production environment. In this chapter, the source server is the
server that the translator moves from.
The target server is the server that receives the translator. Deploy Translators reduces downtime
when upgrading or creating servers. A common Deploy Translator scenario is as follows:
1. A user creates or modifies a new translator on a test server
2. After testing is complete, the translator is ready to deploy
3. The Deploy Translator utility moves the translator to the target server
4. The system administrator schedules a short down time for the target server
5. The translator stops momentarily on the target server
6. The newly deployed translator installs on the target server
7. The translators restart on the target server
Note: The Sunrise eLink 4.5 release introduced the Deploy Translator
feature. It is not a backup or restore feature and it does not replace that
feature built into the Designer. The user cannot backup translators with
this utility. The Deploy translator feature assists copying translators from
one server to another only.
The procedures listed in this chapter assume that the user has either created or modified,
successfully compiled, and tested thoroughly a translator that is now ready for deployment. You
can successfully deploy compiled translators only.
Options
In the Options area, you can designate the deployment options using the check boxes. If you do
not select any check box, eLink disables the OK icon.
Compiled translators
The Compiled Translator check box enables all the files associated with a compiled translator
readied for deployment. Typically, 3 files move for each translator. The files are:
> <translator_name>.cdl
> <translator_name>DLL.dll
> <translator_name>.exe or <translator_name>.dll
These files copy to the target server at the directory of bin\<user> and are ready for installation.
By default, eLink enables and checks this option.
Important: When enabled, this option permits the new code to overwrite
the original source code of the translator on the target. Before deployment,
back up the original source code.
By default, Sunrise eLink enables and selects this option. If you clear the Source Code option,
the following message is displayed:
Warning - your compiled translators will be out of sync with the source
code on the target server, making it impossible to debug translators on
the target machine.
Note: Verify that Sunrise eLink checked the Source Code option for the
translator on the target server.
Derived functions
The Derived Functions option enables all functions, referenced either directly or indirectly by the
selected translators, to copy to the target server. If you use the Derived Function option, be sure
to back up the original derived functions because this option overwrites them.
Note: You must deploy the source code with the derived functions because
these 2 components are interdependent.
By default, Sunrise eLink enables and selects this option.
Code types
The Code Types option enables all referenced code types, either directly or indirectly used by the
selected translators, to copy to the target server. If you select the Code Types option, be sure to
back up the original code types because this option overwrites them.
Note: You must deploy the source code with the code types because
these 2 components are interdependent.
By default, Sunrise eLink enables and clears this option.
Deploy translators
Before starting the Deploy Translator utility, the Designer must be running on both the source and
the target server. In the Designer, select the Main Menu and search under Tools to locate the
Deploy Translators option. You can access the option with the accelerator key D.
You can also access Deploy Translators by using the context menu (right-click) a translator name
in the Translator Name area.
If you select a translator, you can use the accelerator key T to access Deploy Translator.
If the target server uses eLink security, Target Server Logon opens.
If the target server uses Helios Security Services (HSS), Target Server Logon opens.
Upgrade translators
Use the steps below to upgrade an existing translator or multiple translators. Ensure the upgraded
translator compiles and is ready deploy. Use the following steps to upgrade translators.
1. Launch Deploy Translator, and then log on to the target server as described in “Initiating a
translator deployment”.
2. Select the modified translator.
By default, the Compiled Translators and Source Code options are selected. If you want
the host properties overwritten for the existing translators, select Host Properties.
3. Select the other options as required.
4. Add other files, as needed.
5. Click OK to deploy.
A status bar displays the translator deployment progress.
When complete, a notification displays to inform you that the deployment is complete and
error free.
6. Click OK.
The Deploy Translator utility closes.
Related information
Initiate a translator deployment on page 441
Move translators
Sometimes you may need to move a translator from one development server to another
development server. You must compile the translator before the Deploy Translator utility can
move it. Use the following steps to move a translator from one development server to another.
1. Launch Deploy Translator, and then log onto the other development server.
2. Select the translators you want to move.
3. Clear the Source Code option.
A window opens to indicate that the source code will not deploy.
4. Click OK to continue.
5. If not already selected, select the Compiled Translators option.
6. If required, check the Host Properties options.
7. Add other files, as required.
8. Click OK in the Translator Deployment window to continue.
9. Click OK in the confirmation window to deploy the translators.
A progress bar displays to display the progress of the translator deployment.
When complete, a notification displays to inform you that the deployment is complete and
error free.
10. Click OK.
The Deploy Translator utility closes.
In case of deployment failure the Translator Deployment Failure window opens with an
option for a roll back.
11. Click Yes to roll back.
The roll back restores the server to its original configuration.
Backup
Backup strategies protect data from accidental loss if the system experiences hardware or storage
media failure. You can use backup utilities to create a duplicate copy of the data from hard disk
and then archive that data on another storage device such as a hard disk or a tape.
If the original data on the hard disk is accidentally erased or overwritten, or becomes inaccessible
because of a hard disk malfunction, the data can easily be restored from the archived copy.
Use backup utilities to:
> Archive selected files and folders from hard disk
> Restore the archived files and folders to hard disk or any accessible disk
> Create an Emergency Repair Disk (ERD), which helps repair system files if they get corrupted
or are accidentally erased
> Make a copy of remote storage data and data stored in mounted drives
> Make a copy of a computer’s system state, which includes the registry, the Active Directory
database, and the Certificate Services database
> Schedule regular backups to keep archived data up-to-date
eLink backup
Sunrise eLink utilizes the following directories:
> Main directory (\eLink): Stores all binaries and temporary files used for creating translators.
It includes the bin, compile, derived, samples, and shared DLL directories.
> Log directory (\eLink\log): Built-in logs that are written by the product. It is also not required
that the log directory is stored on the Sunrise eLink main directory.
Note: If the Sunrise eLink system was an upgrade from version 4.0 or
before, the Sunrise eLink installation directory may be named "ewebit"
instead of eLink.
Sunrise eLink stores critical data in following locations:
> The translator information is stored in the Tlkernel database and the \eLink\Config folder.
> The Sunrise eLink queue data is stored in the ELinkQueues database.
> The configuration information is stored in the ELinkCore database.
Storage of the data saved in the following locations must be incorporated in a Sunrise eLink disaster
recovery plan to ensure the organization is able to either maintain or quickly resume mission-critical
functions in the event of equipment failure or other catastrophe:
®
> Tlkernel SQL Server database
®
> ELinkQueues SQL Server database
1. Navigate to Start > Programs > Microsoft SQL Server > Management Studio.
2. Locate the server housing Tlkernel, the master eLink SQL server database, in the directory
structure. Click the plus sign next to the server name to expand the server’s contents.
Important: To restore the database to the current state, have your DBA
perform this task. The following steps describe how to restore a database
1. Navigate to Start > Programs > Microsoft SQL Server > Management Studio.
2. Locate the server housing Tlkernel, the master eLink SQL server database, in the directory
structure. Click the plus sign next to the server name to expand the server’s contents.
3. Expand the contents of the Databases folder.
4. Select Tlkernel from the database list.
Tlkernel database information opens in the right-hand pane.
5. Right-click the Tlkernel database name. Choose Tasks > Restore Database.
The General tab is active by default.
6. Ensure that the Tlkernel opens in the Restore as database drop-down.
This step displays the database to restore.
7. Select Database from the Restore section of the window.
This option is selected by default.
8. Ensure that the Tlkernel displays in the Show backups of database drop-down located in
the Parameters section of the window.
This action displays the backups of the selected database.
9. Ensure the data displayed in the First backup to restore drop-down indicates the backup to
restore first.
This option opens only if you select to restore a database.
10. Use the Point in time restore option to choose the restore a backup from a selected point
in time. Use the (…) icon to view the selected backups.
This option opens only if you select to restore a database.
11. Ensure a check is placed in the Restore check box located in the restore summary window.
This action specifies to restore the selected backup.
12. Click OK to restore the Tlkernel database.
Use the following steps to backup and restore the ElinkQueues database.
1. Navigate to Start > Programs > Microsoft SQL Server > Management Studio.
2. Locate the server housing ELinkQueues in the directory structure.
3. Click the + sign next to the server name to expand the server’s contents.
4. Expand the contents of the Databases folder.
5. Select ELinkQueues from the database listing.
ELinkQueues database information opens in the right-hand pane.
6. Right-click the ELinkQueues database name, choose Tasks > Backup Database.
The General tab is active by default.
7. Ensure ELinkQueues opens in the Database drop-down.
This action specifies the database to be backed up.
8. Accept the default name displayed in the Name text field.
The name in the Name text field specifies the name to give to the database backup. Default
data can be changed by placing the cursor in the text field and making the desired modification.
9. Select the Database - complete option in the Backup section of the window.
This action specifies performance of a complete database backup. A complete database
backup records the full contents of the database. The Database - differential option records
only data changes made to the database after the last full database backup. This option is
selected by default.
10. Click Add in the Destination section of the window to choose the desired backup destination.
11. Use the option icons to select the desired backup method (file or backup device). Next use
the browse option icons to choose the desired backup destination.
12. Click OK.
The destination location opens in the Destination list.
13. Select Append to media in the Overwrite section of the window.
This option specifies to append the backup to an existing media. This means the previous
contents of the media remains intact and the new backup is written after the end of the last
backup on the media.
The Overwrite existing media option overwrites any existing media. By overwriting backups
on media, the existing contents of the backup media are overwritten with the new backup and
are no longer available.
14. Click Schedule to automate ELinkQueues database backup.
15. Click (…) to view or change the current database backup schedule.
16. Click OK to initiate a backup of the ELinkQueues database.
1. Navigate to Start > Programs > Microsoft SQL Server > Management Studio.
2. Locate the server housing ELinkQueues in the directory structure.
3. Click the plus sign next to the server name to expand the server’s contents.
4. Expand the contents of the Databases folder.
5. Select ELinkQueues from the database list.
The ELinkQueues database information opens in the right-hand pane.
6. Right-click the ELinkQueues database name, choose All Tasks, and then choose Restore
Database.
The General tab is active by default.
7. Ensure that the ELinkQueues opens in the Restore as database drop-down.
This action specifies the database to restore.
8. Select the Database from the Restore section of the window.
This option is selected by default.
9. Ensure that the ELinkQueues opens in the Show backups of database drop-down located
in the Parameters section of the window.
This action displays the backups of the selected database.
10. Ensure the data opens in the first backup to restore drop-down indicates the backup to restore
first.
This option opens only if you select to restore a database.
The Point in time restore option is used to choose to restore a backup from a selected point
in time. The (…) icon is used to view the selected backups. These options appear only if you
have select to restore a database.
11. Ensure that the Restore check box located in the restore summary window is selected.
This action specifies to restore the selected backup.
12. Click OK to restore the ELinkQueues database.
®
> Make sure to first restore the Microsoft Visual SourceSafe database files.
1. Open the Queues tab and note how many records there are for the queues you want to
backup.
This information is required in the later steps.
2. Log on to the Web Console and choose Search > Queues from the main menu.
3. Click User-defined and ensure All is selected in the list of queues.
4. Enter the number of records you noted earlier in the Max Records text box. Because you
must select all records in the queue search screen to back up, you must show all of them on
one screen.
5. Select all records in the Queue Search Results window.
6. Click Backup menu.
A temporary file is created on the server. A prompt opens to download the file to the location
of your choice.
7. Click Save.
8. Choose a location for the file.
4. Click Restore.
The restored files appear in the queue search window.
Note: Run this utility on the server, not on a client desktop. This utility
does not back up internal queues.
Command line switches associated with the QueueUtil program are listed as follows. Typing
AutoBackup.exe /? provides examples of how to run the utility, such as:
> -U = eLink user name or, if eLink uses Helios Security Services, the network user name
> -P = eLink password or, if eLink uses Helios Security Services, the network password
> -E = Helios Environment Name (if eLink uses Helios Security Services, this parameter is
mandatory)
> -M = SQL server machine where the ELinkQueues database resides
> -all = tells the utility to back up all queues
> -L = list of projects to back up (queues only, not translators)
> -Q = list of 1+ queue names to back up
> -D = places the output files in a different directory than the default (\eLink)
> -F = when backing up just one queue, allows the user to choose the file name for output,
overriding the default <QueueName>.<CCYYMMDD-HHMISS>.rbp
Further notes about the switches:
The default file name that an individual queue is backed up to is in the format:
<QueueName>.<CCYYMMDD-HHMISS>.rbp
The -all, -L, -Q, -D and -F parameters are optional. With these four parameters, you can provide
a list of projects to back up (-L), a list of queue names to backup (-Q) override the output directory
(-D) or override the output file name (-F). The -all parameter is optional. This parameter instructs
the utility to back up all queues using the default file names. The -L and -F parameters are ignored
if this parameter is specified.
The -L parameter allows the user to give a comma-delimited list of projects to back up (just the
queues, not the translators). When this parameter is specified, the -Q and -F parameters are
ignored. If any project name contains spaces, the entire parameter must be surrounded by double
quotes (see examples below).
> The -Q parameter allows the user to give a comma-delimited list of specific queue names to
back up.
> If the -D parameter is not specified, the file is placed in the \eLink folder.
> If the -F parameter is not specified, the file name is: <QueueName>.<Date-Time>.rbp
> The -L parameter allows the user to provide a comma delimited list of projects to back up.
Note: For projects with a space in the name, use double quotes around
the parameter (see example below).
FullBackup.<CCYYMMDD>-<HHMISS>.rbp
A typical example of the parameters used to launch the QueueUtil program from the command
line opens below. Use the default directory and the following file names, QueueUtil -UmyUser
-PmyPassword -all.
Other examples include:
> Back up all queues, use default file names, choose output directory (root of K drive) QueueUtil
-UmyUser -PmyPassword -all -Dk:\
> Back up all queues in two projects “All Servers” and “All Clients” QueueUtil -UmyUser
-PmyPassword “-LAll Servers,All Clients”
> Back up one queue (name = FirstQ) and override the default file name QueueUtil -UmyUser
-PmyPassword -QFirstQ -FFirstQ.rbp")
> Back up two queues (names = FirstQ and SecondQ) using default file names QueueUtil
-UmyUser -PmyPassword -QFirstQ,SecondQ
This action launches QueueUtil.exe, the eLink utility used to back up production-level
queue data from the command line. Contents of the specified queue are saved to the
designated file.
— Use default directory but choose TLK file name (FullProdBackup.tlk): AutoBackup
-UmyUser -PmyPassword -MmyMachine -FFullProdBackup.tlk
— Use default output file name but choose output directory (root of K drive): AutoBackup
-UmyUser -PmyPassword -MmyMachine -Dk:\
— Determine both the output directory and TLK file name: AutoBackup -UmyUser
-PmyPassword -MmyMachine -Dk:\ -FFullProdBackup.tlk
> Switch names are case-sensitive, so -u does not work for -U.
> The directory name passed to the utility must already exist.
> The file name must be a valid file name. It cannot contain any of the following characters:
> “ (double quote)
> / (forward slash)
> \ (backslash)
> [ (open bracket)
> ] (closed bracket)
> : (colon)
> ; (semicolon)
> = (equals sign)
> Are messages corrupted in any way? Missing HL7 envelope characters (hex 0B, hex 1C0D).
Incomplete messages.
> What queues are affected? Are records missing from a queue? If there are missing records the
OutputQueue parameter for a translator may be incorrect.
> What error messages are appearing? Report the specific error text in any popup window or
eLink logs. Report the source of error (application).
> Are there any related errors in the Windows Application or System Event Viewers?
> Where can I locate a diagnostics list?
The eLink Log file is one of the most important sources of information for diagnostics, not just error
messages.
Related information
Before you contact Customer Support on page 466
> If Log on as a Local System account and Allow Service to interact with Desktop are checked,
the service is using a local system account and it interacts with the desktop
> If Log on as a This Account is selected with a user name and password, the service uses a user
account.
Note: A pop-up error message from the eLink Web Console or a .exe
®
file should be reported to Allscripts Customer Support.
1. In eLink Designer, select the translator of interest (individually) in the project tree.
2. Right-click, and then select Modify Properties.
3. Select the Host Properties tab and change the MessageLog and InternalLog Host Properties
to True.
4. Close the Host Properties box, then right-click.
5. Select Close the Host Properties.
6. Open the Web Console, start and stop the translator to apply the changes in the host
properties.
What to do next
After you have collected additional information, set the MessageLog and InternalLog Host Properties
to False, then stop and start the translators again. These settings adversely affect performance
and should not be used in production environments.
Next, use Notepad or another editor to browse this file, which will contain records similar to:
Active Connections
Proto Local Address Foreign Address State
TCP ros2k-eLinkdev2:epmap ros2k-eLinkdev2.eclipsnet.com:0 LISTENING
TCP ros2k-eLinkdev2:microsoft-ds ros2k-eLinkdev2.eclipsnet.com:0 LISTENING
TCP ros2k-eLinkdev2:1028 ros2k-eLinkdev2.eclipsnet.com:0 LISTENING
TCP ros2k-eLinkdev2:1031 ros2k-eLinkdev2.eclipsnet.com:0 LISTENING
TCP ros2k-eLinkdev2:1760 NJNTCSCMHL7:7107 ESTABLISHED
TCP ros2k-eLinkdev2:1961 SHANAMAN-M-W2K:1637 ESTABLISHED
TCP ros2k-eLinkdev2:2211 64.12.27.126:5190 ESTABLISHED
TCP ros2k-eLinkdev2:2363 ELINKDEV:netbios-ssn TIME_WAIT
Search the netstat.txt file for the host address and socket of the application that has a connection
problem. If you do not see it, try the ping command.
Ping
Ping is used to verify connectivity to a specific host name or IP address. To use the ping command,
select Start > Accessories > Command Prompt. In the Command Prompt window, enter:
You should receive 4 replies to the ping. This verifies that you can communicate with your partner.
If you see a Destination host unreachable message, it indicates the other computer cannot
be contacted at all. If you see a Request timed out message, it indicates the computer can
be contacted, but has some policy applied that is blocking communication (from Windows Help)
or the computer is unable to respond to the ping or there are TCP/IP packet routing problems.
If the ping is successful, the telnet command can be used to verify the availability of a particular
port number. The translator that is configured to send to the address and port number being
investigated must be stopped before executing this command.
If you receive the response of a completely clear screen, which indicates a successful connection,
the translator should be able to successfully connect as well. Exit the telnet application to make
the port available to the translator.
If the text Connecting To hostname...Could not open a connection to host on
port [port#]: Connect failed displays, the receiving application is not listening for
connections on the specified port.
list, instead of the system environment variable list. Verify that the include and lib variables for
the FrameworkSDK folder are in the system environment variable list.
® ®
> Visual C++ or Visual Studio .NET is moved to a different drive and the user does not have
rights to that drive.
®
> Older version of Visual C++ are used.
Note: Store large log files in a .ZIP file and send the files as an email
attachment. This method preserves all of the characters in the logs.
Pasting the contents of log files into an email or a Clarify field might
alter the delimiters.
> Provide the messages being processed that induced the problem.
> Provide the date and time of the problem.
Optional items
> Translator version
> Operating System
> Group/environment (clinical, training, development, production, test, and so on)
> Patient (indicate name and internal ID or medical record number)
> Host address and port number
> Enexity access information
> Computer Name or Cluster Name
> Cluster SQL Server Instance Name
Index
3270 screen scrape adding auto repeating fields
172 245
5250 screen scrape 174 adding auto repeating fields using an imported
record
A 251
adding internal queues to a project
about 164
eLink adding manual fields
128 240
window adding objects
32 229
about eLink adding statements
128 265
accessing databases directly adding to SourceSafe
375 429
accessing eLink queues adding translators to a project
372 158
add adding user queue to a project
internal queues to a project 162
164 administration
manual fields 42, 87, 99
240 administration menu
statements 42
265 alarm
user queues to a project 108
162 add
adding 109
connection blackout
24 121
adding a blackout to an eLink alarm clone
123 110
adding an alarm delete
109 110
adding auto field definitions using imported disable
records 111
247 enable
adding auto fields 111
242 keyword
118
F format (continued)
text
field 398
calling an object X12
259 402
field change formatting the field wizard
tab 287
389 function
field types derived
237 341
field types and characteristics functions
237 derived 335
fields
236–237, 242, 245, 268
G
delete
259 generic screen scrape
export 182
256 global designer
import 138
257 global designer explorer
menu 155
239 global object
modify 234, 354
258 group
using the auto population source assign
260 100
fields and statements assign permissions
236 101
fields tab create
328 103
file import delete existing
170 102
find update
408 100
finding error messages group administration options
462 99
fixed values group membership
356 update 97
format
delimted H
400
hex HCFA-1500 form wizard
397 334
HL7 help
401 43
P project (continued)
configure
parameters 87
262, 405 working folder
parameters tab 425
327 projects
parse 133
verbs projects tab
367 49
parsing communication verbs properties
367 60, 62
parsing input data options purge a queue
357 65
parsing input date purging a queue 65
357
password
Q
change
127 query
configuration delete
105 309
password configuration insert
105 300
PC 3270 screen scrape select
192 291
permissions stored procedure
96 313
save test
101 318
pinging update
464 304
placement of the DLL files queue
DLL 64–68
363 cleaning
planning eLink backup cycles 106
449 internal
preferences 90
149 properties
user 67
126 records
preferences tab 66
29 user defined
problem list 89
44 queue menu
project 41
133
T tools menu
43
tab menu
translator 130
210 touch time
tabs 214
43 translator
tcp/ip communications 40, 46, 48–50, 52–54, 88, 136, 208,
troubleshooting 210, 221, 361, 438
463 (tlk)backup command line utility
TCP/IP protocol client 458
host connection clone
196 56
TCP/IP protocol multi-threaded server cloning
199 223
TCP/IP protocol server coding DLL
198 362
testing a instrumented translator compile
417 414
testing an alarm creating
111 215
testing and compiling translators debug
creating an object report 382
421 delete
testing queries 225
318 deployment
text 441
397–398 DLL
thresholds 362
90 editing
timer 220
200 install
times 53
214 instrumented
timing a translator's statement execution 417
361 logging mechanisms
tlkernel database backup and restore 351
449 menu
tools 130
43, 126 MPBatch-multiplatform batch
tools for diagnosing tcp socket and network 167
problems NTDB-multiplatform realtime
464 168
tools for logging additional information NTDLL-translator as a DLL
463 167