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 subfolders.
- 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 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 preferences.
- 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 the selection, either make a selection from the drop-down on the right or enter text in the Search field and press Enter. Folders and files containing that text are displayed.
- To search within Data, expand the Data subpanel and click 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. Only datasets containing that text display as text is entered.
- Right-click 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 the layout, access Editor Help, and delete.
- View Data and Metadata
Right-click 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 the 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 automatically displays files opened in a previous session.
Create a New File
New files can be created in the SCE Editor.
- Click the New File (plus sign) icon in the left navigation to the right of Files, or to the right of a folder if the appropriate privilege is granted.
- Enter the Name of the file.
- The name of the file can include the extension (e.g., .sas, .r, or .py). The window expands adding the Language, and Language Version when applicable.
- 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. The My Workspace folder is selected by default; this is your private workspace. When the New File icon is selected from within the folder tree, the default is the selected folder. Click a folder name or use the Search field to locate 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 also opens as a new tab in the File Viewer pane.
View Files and Data in the Editor
Visualize programs, files, outputs, data, and metadata directly in the elluminate interface using the SCE File Viewer. The viewer supports a range of file types, including program files (SAS, R), program logs and list files, PDFs, images, and elluminate data tables.
Note: Files larger than 50MB cannot be viewed in the SCE Editor. A prompt to download the file appears instead. Users with a SAS Studio or RStudio license can launch large files to a Studio session to view them in an interactive environment. This restriction applies only applies to files, not datasets.
- To open a file directly in the File Viewer, double-click a file from the Files panel in the left navigation, or double-click a domain in the Data panel to open its data. To open metadata for a domain, hover over a domain name and click the Open Metadata (arrow) icon.
- Use the icons in the master header to:
-
- Split Screen: View two files side by side.
- Stack Screen: View two files horizontally.
- Single Screen: The default view. When multiple files are open, use the tabs at the top to move between files.
- Full Screen: Expand the file view to fill the entire screen, hiding the left and right navigation panels.
- Notifications: View your notifications from within elluminate.
- elluminate Help: Access the elluminate Help menu.
Tip: Click 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, or between the file viewer and the right navigation, to resize window sections.
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)
- .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 data entry. Other open files are displayed in separate tabs across the top of the window. When a file type that cannot be viewed is selected, a message displays in the window prompting to download the file, along with a 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 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 the 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 the current version. A confirmation window opens; click 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 is 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 the 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 the 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 a private My Workspace folder.
- Layout: Hover over Layout for additional layout options such as themes, font size, line numbers, and Gutters. Click 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 linked to elluminate can launch a program from SCE by right-clicking the program and selecting either Launch in RStudio or Launch in SAS Studio from the context menu. This action launches the program along with all its dependent datasets in SAS Studio / RStudio.
Users can right-click a dataset in the Data subpanel to open it directly in SAS Studio / RStudio, either for use in an existing program or a new one.
IDE Sessions
Users with a SAS Studio or RStudio license can access the IDE Sessions subpanel. This subpanel allows for centralized management of Studio session files and data. After completing a Studio session, users can commit their changes back to SCE. To commit all session changes, click the Commit icon in the subpanel toolbar. Alternatively, to commit changes to individual files, use the Commit icon next to the specific file. Files with uncommitted changes are italicized and marked with an *.
From the IDE Sessions subpanel, use the icons to:
- Commit file changes (all or individual files).
- Remove files from the session (all or individual files).
- Rename the session.
- Open the session directly in the Studio.
- Search for sessions by content Name, Status, Version, Has Dependencies, Is Dependent, or Uncommitted Changes.
- Refresh the IDE Sessions subpanel.
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 changes to the file have not been saved, a Change file status window opens with the message "You have unsaved changes to this file that will be lost. Are you sure you want to move this file to In Review?" Click 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: She 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 a text-based file in the Browser and click Compare.
- Click the Compare icon.
- In the Select File window, select the file to compare. The selected file is highlighted. Use the scrollbar to locate the file for comparison or use the Search field. Enter text in the Search field and press Enter. If the selected file is a program In Development, select the same file name. A prompt appears in the next window to select the version for comparison.
- 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 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 with 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 a version In Production. Should a file that is 'In Production' be moved to 'In Development' for editing, the version number becomes 1.1.
In Development, numbers continue to be 0.2, 0.3, 1.2, 1.3, etc.
In Production, version numbers continue in whole numbers, 2.0, 3.0, etc.
Create a New Version
- From the Versions subpanel, click the Create New Version (plus sign) icon to 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 the actions.
The new version opens in the Viewer window In Development and ready for editing. The new version is 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 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 the 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 must be associated with input datasets and any dependent files (input files or included programs) so elluminate can fully track data lineage. When program files are saved in SCE, the system automatically identifies most file and dataset dependencies based on program syntax, including libraries defined in SAS program code. As a result, users no longer need to add all dependencies manually.
Visual feedback is provided for any dependencies identified in the syntax but not found in the system. From the Dependencies subpanel in the right navigation, users can navigate directly to 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 are 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 (plus sign) icon. 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 a file name. To select multiple files, hold the Ctrl key and select file names.
- Optionally, use the Search field to search for files. Enter text and press Enter, and any files with that text display (including the folder structure).
- Click Save if the selected file is the only 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 adds all domains within the datastore and dynamically includes any future domains.
- Optionally, use the Search field to locate a dataset. As text is entered, datasets containing the text display.
- Optionally, use the Search field to locate a dataset. As text is entered, datasets containing the 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. Refreshing can also be performed if files have been moved or created to resolve any missing dependencies.
Click 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.
- In the Dependencies subpanel, click the dependent file or dataset name to remove. To remove multiple files or datasets, hold the Ctrl key and click each file or dataset name.
- Click the Remove Dependency (trashcan) icon.
- From the confirmation popout, 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 is created in the same directory as the executed program. If a program generates any output files, they appear in the Outputs subpanel of the right navigation.
Outputs are viewed in the Outputs subpanel to the right of the window. Click the side arrow to expand the subpanel if it is not already expanded.
If outputs exist for the selected file, they are listed in this subpanel. The file name and size (in kilobytes for files, number of rows and columns for datasets) are displayed. Hover over the output file name 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 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 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 the link to open the source program in the editor.
Log files, whether uploaded, created manually, or generated as a user-defined program output, are parsed for errors, warnings, and notes. The Properties panel displays a count of each log finding, providing a summary of the number of errors, warnings, and notes encountered during code execution.
Clicking a value in 'Count of Errors', 'Count of Warnings', or 'Count of Notes' within the Properties window opens the corresponding location where the issue is reported. This feature enables quick navigation to the specific line or section of code that generated message.
View and edit properties from this subpanel. Use the scrollbar to see all properties.
Edit Properties
The file's name and description can be edited within the Edit Properties window. Users have the option to automate the execution of a file, allowing it to run automatically in Production when a dependent dataset is updated due to a new import or a mapping change. By default, this feature is enabled for all SCE programs.
- Click the Edit Properties (pencil) icon 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 it off.
- Click Save to save the changes or Cancel to cancel the 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 to open by clicking the Search icon and entering a search term, or using the Study drop-down to select a study.
- Click the side arrow to expand a data store (for example, Clinical).
- Double-click the domain name to open it. 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 to open by clicking the Search icon and entering a search term, or by 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 datasets are temporary and are not part of the formal program output, which is directed to an elluminate datastore. While the source is open in the Editor, users can view and open the SAS Work Library datasets and interact with them in the same way as other datasets in the SCE Editor. This feature can be enabled or disabled.
Icons for managing the Work Library:
- Pause / Resume Work Library: Enables or disables new datasets from being added to the SAS Work Library
- Clear Work Library: Clears all datasets from the library.