Use the Editor in the SCE

Create and maintain SAS, R, and Python programs directly in the elluminate web interface. Syntax-specific formatting displays the programming language with a familiar look and feel. The interactive code editor provides flexibility in appearance and layout, allowing programmers to customize their experience.

Use the left navigation to:

Access existing folders and files
- XML and HTML files are rendered with relative links to supporting documents.
Add new sub folders.
Rename folders.
Create a new file.
Access Data Stores for a study.
Access the context menu to perform actions on a file / folder (right-click on a file / folder).
Access the SAS Work Library following program execution. Users can see and open work library datasets that were created during program execution and can interact with those datasets as they can with other datasets in the Editor. Users can enable or disable the return of Work datasets based on their preference.
Use the Search by Feature option in Files and Data.
- Click the Search icon to open the search fields.
- Within the Files search, use the Search drop-down to search by Name, Status, Version, Execution Output, Locked By, Has Dependencies, Is Dependency, Modified By, or Review Comment. Depending on your selection, either make your selection from the drop-down on the right, or enter text in the Search field and press Enter. Folders and files with that text display.
- To search within Data, expand the Data subpanel, and click on the Search icon to open the search fields. Use the Search drop-down to search by Name, Label, Created By, Last Modified By, Field Name, or Field Description. Enter text in the Search field. As you enter text, only datasets with that text display.
Right-click on a program to select an action from the context menu. Actions may include Download, Copy, Move, Edit Properties, view Properties, Compare, Run Program, Launch in RStudio, Launch in SAS Studio, Change Status, and Delete.
- Users with an RStudio license tied to their elluminate account can launch SCE programs in an RStudio session for a fully interactive development experience. The RStudio Workbench environment is isolated from the production SCE area, allowing for exploratory work and package installation and development without affecting other workflows. Changes to programs in RStudio can be synchronized back to SCE.
- Users with a SAS Studio license tied to their elluminate account can launch SCE programs in a SAS Studio session for a fully interactive development experience. The SAS Studio environment is isolated from the production SCE area, allowing for exploratory work, library management, and development without affecting other workflows. Changes to programs in SAS Studio can be synchronized back to SCE.

Tip: For additional details on Browser functionality, go to Use the Browser in the SCE page.

Use the file viewer (center) window to:

View one or more selected files
Edit programs / files
Save changes
Cancel edits
Create new versions
Upload
Lock for editing
Download
Run programs
Use filters
Access options to run history, create and view issues, edit properties, compare text-based files (e.g., programs, log files), change status, modify layout, access Editor Help, and delete.
View Data and Metadata
Right-click on a tab to perform bulk operations: Close / Close All Other Tabs / Close All Tabs

Tip: Hove over tabs to view informative tooltips and user dialog messaging

Use the right navigation to:

Access icons in the Master Header to customize your view in the file viewer: Split Screen, Stack Screen, Single Screen, and Full Screen.
View, add, and remove Dependencies for a program
View Outputs for a program
View and edit file Properties
View and manage file Versions

Tip: The File Viewer will automatically display files that were opened in a previous session.

Create a New File

New files can be created in the SCE Editor.

Click the New File icon (the plus sign) in the left navigation at the right of Files, or at the right of a folder if you have the appropriate privilege.
Enter the Name of the file.
1. The name of the file can include the extension (e.g., .sas, .r, or .py). The window will expand adding the Language, and Language Version when applicable.
2. Click the Language Version drop-down to select the version (if multiple versions are installed).
Enter an optional Description of the program.
Select the Parent Folder where the program will reside. By default, the My Workspace folder is selected, this is your private workspace. If you selected the New File icon from within the folder tree, the default will be the selected folder. Click on a folder name or use the search field to find a folder. Enter text in the search field and press Enter.
Click Create. The new file is added to the folder in the left navigation. The new file will also open as a new tab in the File Viewer pane.

View Files and Data in the Editor

Visualize programs, other files, outputs, data, and metadata directly in the elluminate interface using the SCE File Viewer. A range of file types can be handled, including program files (SAS, R), program logs and list files, PDFs, images, and elluminate data tables.

Note: Files larger than 50MB are restricted from viewing in the SCE Editor. You will instead be prompted to download the file. Users with a SAS Studio or RStudio license can also launch a large file to a Studio session to view it in an interactive environment. This only applies to files and not datasets.

To open a file directly in the File Viewer, double-click a file from the Files panel in the left navigation, or on a domain in the Data panel to open the data. To open metadata for a domain, hover over a domain name and click on the Open Metadata icon (the arrow).
Use the icons in the top right of the Master Header to:

- Split Screen: View two files side by side.
- Stack Screen: View two files horizontally.
- Single Screen: This is the default view. When multiple files are open, use the tabs at the top to move from one file to another.
- Full Screen: Click to expand the file view across the entire screen, hiding the left and right navigation.
- elluminate Help: click to access the elluminate Help menu.

Tip: Click on a file name at the top of the file viewer and drag it to another location.

Tip: Hover over the grab bars between the left navigation and the center file viewer, and between the file viewer and the right navigation to expand parts of the window.

Update and Manage Programs or Other Files

Program or file text can be added or edited directly in the viewer, or a new version can be uploaded using the Upload icon. All programs begin in the In Development status as version 0.1.

Viewable and editable file types:

.sas
.XPT
.lst
.log
.txt
.dat
.r
.rmd
.py
.sql

Viewable file types:

MS file types (doc, docx, rtf, xls, xlsx, csv, ppt, pptx)
pdf
.htm/.html
.xml
Image files (jpg, jpeg, png, svg, tiff).

Other file types that cannot be viewed in the file viewer can be downloaded.

Double-click a file to open it in the viewer. The file opens and the workspace is ready for your entry. Other open files display in separate tabs across the top of the window. When you click on a file type that is not viewable, a message displays in the window asking if you want to download the file and provides the link.

When text is added to the viewer, the name of the program in the header becomes highlighted and toolbar icons become active.

Tip: Use the context menu by right-clicking on a file in the left navigation to perform actions without opening the file.

Toolbar actions include:

Save: Click to Save to current version, or Save as new version. Visible only when changes have been made.
- When saving as a new version, a Create New Version window opens with file details and the option to add comments. Click Create to save as a new version, or Close to cancel your action.
  
  Tip: Use keyboard shortcuts to save changes to a current version or to save as a new version.
Discard Changes: Click to discard changes to current version. A confirmation window opens, click to Confirm, or Cancel. Visible only when changes have been made.
Compare: Click to compare the text-based file in view to another version or another file. Use this feature to track changes made across file versions or understand variances across files.
Issues: Click to select Create Issue or View Issues.
Run Program: Click to execute the program. Visible only for executable program files.

Note: SCE programs in the Global folder area can be added to any Task through the 'Run SCE Program' action. This is available in both the study-specific view of Tasks and the global elluminate Tasks module. A program from the Global folder must be in a Production state to be added to a Task workflow.
Remove Edit Lock: When a user viewing their locked file, or a user with the SCE Configure / Administer privilege is viewing a file locked by another user, click to remove the edit lock. Visible only for editable files that are in Development status.
- A Confirm Unlock pop-up opens with a question. Select option to Save and Unlock, Discard and Unlock, or Cancel.
Lock for Editing: This is available if the file is unlocked for editing. Select option to Lock, or Lock and Download. Visible only for files that are in Development status.
Change Status: Hover over to see option for changing status. Status options depend on the current state of the file.
Edit Properties: Click to open the Edit Properties window. Update the Name, Description, or Language Version. Click Save, or Cancel.
Download: Click to download to your computer.
Upload: Click to upload a new version of the file. Available only when files are unlocked and in Development status.
- A confirmation window opens, click Confirm to continue uploading, or Cancel.
- A Create New Version window opens with version details and the ability to add a file by dropping a file or browse to select. Add optional comments.
- Click Create, or Close.
Run History: Opens the Jobs > Run History window.
Delete: Delete the file.

Tip: Submit a ticket to the elluminate service desk to recover deleted files. Include the file ID (found in the audit trail) and the elluminate URL. Deleted files can be recovered to the original file location or to your private My Workspace folder.
Layout: Hover over Layout for additional layout options such as themes, font size, line numbers and Gutters. Click on the desired changes.
Editor Help: Click to Access SCE Editor Help.

Launch SAS or R Programs in a SAS Studio / RStudio Workbench environment

Users with an RStudio Workbench or SAS Studio license tied to elluminate can launch a program from SCE by right-clicking on the program and selecting Launch in RStudio or Launch in SAS Studio from the context menu.

Updates can be synchronized back to SCE by clicking the Commit icon.

Maintain File Status Workflow

Maintain and track the status of files (programs, outputs, and supporting files) and progress them through a document lifecycle. Programs begin in a development state and can be moved to review, approval, and ultimately placed in production. All status changes are fully audited to provide complete traceability.

Use the Change Status option to change the status of a file.

If In Development: Submit for Review. If you have not saved your changes to the file, a Change file status window opens stating, "You have unsaved changes to this file that will be lost. Are you sure you want to move this file to In Review?" Click to Confirm or Cancel.
If In Review:
- Failed Review: when selected, a Failed Review window opens with version details and allows the user to add comments. Click OK, or Cancel. The status is changed to In Development.
- Submit for Approval: changes the status to For Approval.
If For Approval:
- Failed Approval: when selected, a Failed Approval window opens with version details and allows the user to add comments. Click OK, or Cancel. A failed approval file returns the status to In Development.
- Move to Production: the status becomes In Production.
In In Production:
- Return to Development: select Return to Development to make edits. A new version of the file is created, and the status is set to In Development.
- Retire: select Retire to archive the program (programs that were in development cannot be deleted).
In Program Output:
- Make Manual Edits: A new version of the file is created, and the status is set to In Development.
- Submit for Review: the status becomes In Review.

Tip: To edit a file that is In Production, change the status to Return to Development.

Compare Files

Text-based files, such as programs and log files, can be compared, allowing users to quickly track changes made across file versions or understand variances across files.

In the Editor, open a file in the viewer. Another option to compare files is to right-click on a text-based file in the Browser and click Compare.
Click the Compare icon.
In the Select File window, select the file you want to compare. The chosen file is highlighted; use the scrollbar to locate the file for comparison, or use the search. Enter text in the search field and press Enter. If the selected file is a program In Development, select the same file name. You will be prompted in the next window to select the version to compare.
Click Continue. The Compare Files window opens.
To compare other versions of the selected file, use the Version drop-downs below each file name. The screenshot below displays Version 0.4 on the left and Version 0.2 on the right, with red and green highlights indicating the differences between the two versions.
To compare other files, click the Browse Files buttons and select additional files to compare.
Click the 'x' in in the top right corner to close the window.

Utilize Version Control

Within the SCE, all files (programs, outputs, and supporting documents) are fully version controlled in a validated, compliant system. Users can see the version history of a file, view previous versions, compare versions (of text-based files), revert to a previous version, and even see multiple versions of a file side by side.

Versions are managed from the Versions subpanel at the bottom right of the window.

New files begin in development and version number 0.1. That numbering continues until the file moves to In Production. In production, the version number begins with 1.0*. The asterisk indicates it is an In Production version. Should a file that is In Production move to In Development for editing, the version number becomes 1.1.

In Development numbers continue as 0.2, 0.3, 1.2, 1.3, etc.

In Production version numbers continue in whole number, 2.0, 3.0, etc.

Create a New Version

From the Versions subpanel, click the Create New Version icon (the plus sign) at the right of Versions.
A Create New Version window opens with version details. Optionally, add comments.
Click Create to create the new version, or Close to cancel your actions.
The new version opens in the Viewer window In Development and ready for editing. The new version will be listed in the Versions subpanel.

Compare Versions

From the Versions subpanel, click the Compare Versions icon. The Compare Files window opens, highlighting the latest version with the previous version.
To compare other versions, use the drop-downs under the file name.
Click the 'x' in the top right corner to close the window.

Revert to a Previous Version

From the Versions subpanel, click to highlight the version you wish to revert to.
Click the Revert to the Selected version icon.
A Confirm Revert window opens with a question to confirm. In this example the question is, "Do you want to revert 'xxx.sas' from version x.x to x.x? This will create version x.x?" Click OK to confirm, or Cancel to cancel your action.
In the Create New Version window, add an optional comment and click Create.
When reverting to a previous version, a new In Development version is created.

View, Add, Refresh, and Remove Dependencies

Programs need to be associated with input datasets and any dependent files (input files or included programs) so elluminate can fully track data lineage. Upon saving program files in SCE, the system will automatically identify most file and dataset dependencies based on program syntax, as well as libraries defined in SAS program code. As a result, users will no longer have to add all dependencies manually. The user will be shown visual feedback on any dependencies that are identified in the syntax but not found in the system. From the Dependencies subpanel in the right navigation users can navigate to specific lines of code that reference the listed dependency.

View Existing Dependencies

To view existing dependencies, click the down arrow to expand the subpanel if not already expanded.

If there are dependencies for the selected file, they will be listed in this subpanel. Hover over a dependent file name to view details such as the file path and whether it was identified by the system or the user's name.

Add Dependencies

Click the Add Dependency icon (the plus sign). The Add Dependencies window opens.
From Select Files, select a Study (or Global, or My Workspace) from the drop-down. The folder structure for that study displays.
Click on a file name. To select multiple files, hold the Ctrl key and select file names.
1. Optionally, use the Search field to search for files. Enter text and press Enter, any files with that text display (including the folder structure).
Click Save if only the selected file is the dependency.
From Select Datasets, select a Study or Global Data Store from the drop-down. The folder structure for that study / global data store displays.
Select a datastore, or expand a folder and select a dataset. To select multiple datasets, hold the Ctrl key and select datasets.

Tip: Selecting a datastore as a dependency will add all domains within that datastore and dynamically include any future domains.
1. Optionally, use the Search field to search for a dataset. As you enter text, any datasets with that text display.
Click Save.

Refresh Dependencies

Dependency parsing can be refreshed at any time, independent of automatic parsing triggered by saving or version updates. Before a program is moved to In Production, dependencies should be refreshed to ensure accurate input definitions. Additionally, refreshing can be performed if files have been moved or created to resolve any missing dependencies.

Click on the Refresh Dependencies icon in the Dependencies subpanel.

Remove Dependencies

Manually added dependencies can be removed. Dependencies that are automatically identified from program syntax cannot be removed. Removing a dependency only removes it as a dependency and does not delete the actual file.

Click on the dependent file or dataset name to be removed in the Dependencies subpanel. To remove multiple files or datasets, hold the Ctrl key and click on each file or dataset name.
Click the Remove Dependency icon (the trashcan).
From the confirmation pop-up, click OK.

View Outputs

Outputs are files created by the execution of a program. This can include files written to the SCE folder structure, or datasets written to elluminate study Data Marts. By default, the SAS, R, or Python log file will be created in the same directory as the executed program. If a program generates any output files, they will appear in the Outputs subpanel of the right navigation.

Outputs are viewed in the Outputs subpanel at the right of the window. Click the side arrow to expand the subpanel if not already expanded.

If there are outputs for the selected file, they will be listed in this subpanel. The file name and the size (size in kilobytes for files, number of rows and columns for datasets) are displayed. Hover over the name of the output file to view details such as the full path, version, and status of the file or dataset in a tooltip. To open an output for viewing, double-click on the output row.

View and Edit Properties

Properties include the Name of the file, full Path, Description, Version, Status, Automate Execution (Y/N), Execution Output (Y/N), Is Dependency (Y/N), file Size (KB), Language, Language Version, Created By, Created Date (and time), Last Modified By, and Last Modified Date (and time).

Tip: Use the file path to easily copy and paste it into program code.
When Is Dependency is 'Y', click on the 'Y' to open a window to view the full tree where it is being used by any other programs.

Output files have a link to the Source Program. Click on the link to open the source program in the editor.

Log files, whether uploaded, created manually, or generated as a user-defined program output, will be parsed for errors, warnings, and notes. This includes providing a count of each log finding in the properties of the log file. These counts provide a summary of the number of errors, warnings, and notes encountered during the execution of the code. If you click on the number in the 'Count of Errors', 'Count of Warnings', or 'Count of Notes' in the Properties window, you are taken to the corresponding location in the output where the error or warning is reported. This feature allows you to quickly navigate to the specific line or section of code that generated the error or warning message.

View and edit properties from this subpanel. Use the scrollbar to see all properties.

Edit Properties

Within the Edit Properties window, the name and description of the file can be edited. Users can also choose to automate the execution of a file to automatically run while In Production when a dependent dataset is updated by a new import or a mapping triggered by an import (This does not include mapping executions that are not initiated by an import.). By default, all SCE programs have this feature turned on.

Click the Edit Properties icon (the pencil) to open the Edit Properties window.
Name: Update if needed.
Description: Update if needed.
Automate Execution: Yes is selected by default. Select No to turn off.
Click Save to save your changes, or Cancel to cancel your action.

Access Data Store Datasets and Metadata

Open datasets or metadata within the file viewer.

Open a Dataset

Expand Data in the left navigation (if not already expanded).
Locate the data store and domain you wish to open by clicking on the Search icon and searching, or using the study drop-down to select a study.
Click the side arrow to expand a data store, for example Clinical.
Double-click on the domain name you wish to open. The listing opens in the file viewer window.

Open Metadata

Expand Data in the left navigation (if not already expanded).
Locate the data store and domain you wish to open by clicking on the Search icon and searching, or using the study drop-down to select a study.
Click the side arrow to expand a data store, for example Clinical.
Hover over a domain name until the Open Metadata icon displays.
Click the Open Metadata icon. The metadata opens in the file viewer window.

Use the SAS Work Library

The contents of the SAS Work Library are returned to SCE during SAS program execution. These are temporary datasets; they are not part of the formal program output, which would be directed to an elluminate datastore. While the source is open in the Editor, users can see and open the SAS Work Library datasets and can interact with them as they can with other datasets in the SCE Editor. Users can enable or disable this feature.

The icons can be used to manage the work library:

Pause / Resume Work Library - enable or disable new datasets being added to the SAS Work Library
Clear Work Library - click to clear the library.